No Description
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Telerik.Windows.Documents.Spreadsheet.FormatProviders.Xls.xml 2.7MB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769217702177121772217732177421775217762177721778217792178021781217822178321784217852178621787217882178921790217912179221793217942179521796217972179821799218002180121802218032180421805218062180721808218092181021811218122181321814218152181621817218182181921820218212182221823218242182521826218272182821829218302183121832218332183421835218362183721838218392184021841218422184321844218452184621847218482184921850218512185221853218542185521856218572185821859218602186121862218632186421865218662186721868218692187021871218722187321874218752187621877218782187921880218812188221883218842188521886218872188821889218902189121892218932189421895218962189721898218992190021901219022190321904219052190621907219082190921910219112191221913219142191521916219172191821919219202192121922219232192421925219262192721928219292193021931219322193321934219352193621937219382193921940219412194221943219442194521946219472194821949219502195121952219532195421955219562195721958219592196021961219622196321964219652196621967219682196921970219712197221973219742197521976219772197821979219802198121982219832198421985219862198721988219892199021991219922199321994219952199621997219982199922000220012200222003220042200522006220072200822009220102201122012220132201422015220162201722018220192202022021220222202322024220252202622027220282202922030220312203222033220342203522036220372203822039220402204122042220432204422045220462204722048220492205022051220522205322054220552205622057220582205922060220612206222063220642206522066220672206822069220702207122072220732207422075220762207722078220792208022081220822208322084220852208622087220882208922090220912209222093220942209522096220972209822099221002210122102221032210422105221062210722108221092211022111221122211322114221152211622117221182211922120221212212222123221242212522126221272212822129221302213122132221332213422135221362213722138221392214022141221422214322144221452214622147221482214922150221512215222153221542215522156221572215822159221602216122162221632216422165221662216722168221692217022171221722217322174221752217622177221782217922180221812218222183221842218522186221872218822189221902219122192221932219422195221962219722198221992220022201222022220322204222052220622207222082220922210222112221222213222142221522216222172221822219222202222122222222232222422225222262222722228222292223022231222322223322234222352223622237222382223922240222412224222243222442224522246222472224822249222502225122252222532225422255222562225722258222592226022261222622226322264222652226622267222682226922270222712227222273222742227522276222772227822279222802228122282222832228422285222862228722288222892229022291222922229322294222952229622297222982229922300223012230222303223042230522306223072230822309223102231122312223132231422315223162231722318223192232022321223222232322324223252232622327223282232922330223312233222333223342233522336223372233822339223402234122342223432234422345223462234722348223492235022351223522235322354223552235622357223582235922360223612236222363223642236522366223672236822369223702237122372223732237422375223762237722378223792238022381223822238322384223852238622387223882238922390223912239222393223942239522396223972239822399224002240122402224032240422405224062240722408224092241022411224122241322414224152241622417224182241922420224212242222423224242242522426224272242822429224302243122432224332243422435224362243722438224392244022441224422244322444224452244622447224482244922450224512245222453224542245522456224572245822459224602246122462224632246422465224662246722468224692247022471224722247322474224752247622477224782247922480224812248222483224842248522486224872248822489224902249122492224932249422495224962249722498224992250022501225022250322504225052250622507225082250922510225112251222513225142251522516225172251822519225202252122522225232252422525225262252722528225292253022531225322253322534225352253622537225382253922540225412254222543225442254522546225472254822549225502255122552225532255422555225562255722558225592256022561225622256322564225652256622567225682256922570225712257222573225742257522576225772257822579225802258122582225832258422585225862258722588225892259022591225922259322594225952259622597225982259922600226012260222603226042260522606226072260822609226102261122612226132261422615226162261722618226192262022621226222262322624226252262622627226282262922630226312263222633226342263522636226372263822639226402264122642226432264422645226462264722648226492265022651226522265322654226552265622657226582265922660226612266222663226642266522666226672266822669226702267122672226732267422675226762267722678226792268022681226822268322684226852268622687226882268922690226912269222693226942269522696226972269822699227002270122702227032270422705227062270722708227092271022711227122271322714227152271622717227182271922720227212272222723227242272522726227272272822729227302273122732227332273422735227362273722738227392274022741227422274322744227452274622747227482274922750227512275222753227542275522756227572275822759227602276122762227632276422765227662276722768227692277022771227722277322774227752277622777227782277922780227812278222783227842278522786227872278822789227902279122792227932279422795227962279722798227992280022801228022280322804228052280622807228082280922810228112281222813228142281522816228172281822819228202282122822228232282422825228262282722828228292283022831228322283322834228352283622837228382283922840228412284222843228442284522846228472284822849228502285122852228532285422855228562285722858228592286022861228622286322864228652286622867228682286922870228712287222873228742287522876228772287822879228802288122882228832288422885228862288722888228892289022891228922289322894228952289622897228982289922900229012290222903229042290522906229072290822909229102291122912229132291422915229162291722918229192292022921229222292322924229252292622927229282292922930229312293222933229342293522936229372293822939229402294122942229432294422945229462294722948229492295022951229522295322954229552295622957229582295922960229612296222963229642296522966229672296822969229702297122972229732297422975229762297722978229792298022981229822298322984229852298622987229882298922990229912299222993229942299522996229972299822999230002300123002230032300423005230062300723008230092301023011230122301323014230152301623017230182301923020230212302223023230242302523026230272302823029230302303123032230332303423035230362303723038230392304023041230422304323044230452304623047230482304923050230512305223053230542305523056230572305823059230602306123062230632306423065230662306723068230692307023071230722307323074230752307623077230782307923080230812308223083230842308523086230872308823089230902309123092230932309423095230962309723098230992310023101231022310323104231052310623107231082310923110231112311223113231142311523116231172311823119231202312123122231232312423125231262312723128231292313023131231322313323134231352313623137231382313923140231412314223143231442314523146231472314823149231502315123152231532315423155231562315723158231592316023161231622316323164231652316623167231682316923170231712317223173231742317523176231772317823179231802318123182231832318423185231862318723188231892319023191231922319323194231952319623197231982319923200232012320223203232042320523206232072320823209232102321123212232132321423215232162321723218232192322023221232222322323224232252322623227232282322923230232312323223233232342323523236232372323823239232402324123242232432324423245232462324723248232492325023251232522325323254232552325623257232582325923260232612326223263232642326523266232672326823269232702327123272232732327423275232762327723278232792328023281232822328323284232852328623287232882328923290232912329223293232942329523296232972329823299233002330123302233032330423305233062330723308233092331023311233122331323314233152331623317233182331923320233212332223323233242332523326233272332823329233302333123332233332333423335233362333723338233392334023341233422334323344233452334623347233482334923350233512335223353233542335523356233572335823359233602336123362233632336423365233662336723368233692337023371233722337323374233752337623377233782337923380233812338223383233842338523386233872338823389233902339123392233932339423395233962339723398233992340023401234022340323404234052340623407234082340923410234112341223413234142341523416234172341823419234202342123422234232342423425234262342723428234292343023431234322343323434234352343623437234382343923440234412344223443234442344523446234472344823449234502345123452234532345423455234562345723458234592346023461234622346323464234652346623467234682346923470234712347223473234742347523476234772347823479234802348123482234832348423485234862348723488234892349023491234922349323494234952349623497234982349923500235012350223503235042350523506235072350823509235102351123512235132351423515235162351723518235192352023521235222352323524235252352623527235282352923530235312353223533235342353523536235372353823539235402354123542235432354423545235462354723548235492355023551235522355323554235552355623557235582355923560235612356223563235642356523566235672356823569235702357123572235732357423575235762357723578235792358023581235822358323584235852358623587235882358923590235912359223593235942359523596235972359823599236002360123602236032360423605236062360723608236092361023611236122361323614236152361623617236182361923620236212362223623236242362523626236272362823629236302363123632236332363423635236362363723638236392364023641236422364323644236452364623647236482364923650236512365223653236542365523656236572365823659236602366123662236632366423665236662366723668236692367023671236722367323674236752367623677236782367923680236812368223683236842368523686236872368823689236902369123692236932369423695236962369723698236992370023701237022370323704237052370623707237082370923710237112371223713237142371523716237172371823719237202372123722237232372423725237262372723728237292373023731237322373323734237352373623737237382373923740237412374223743237442374523746237472374823749237502375123752237532375423755237562375723758237592376023761237622376323764237652376623767237682376923770237712377223773237742377523776237772377823779237802378123782237832378423785237862378723788237892379023791237922379323794237952379623797237982379923800238012380223803238042380523806238072380823809238102381123812238132381423815238162381723818238192382023821238222382323824238252382623827238282382923830238312383223833238342383523836238372383823839238402384123842238432384423845238462384723848238492385023851238522385323854238552385623857238582385923860238612386223863238642386523866238672386823869238702387123872238732387423875238762387723878238792388023881238822388323884238852388623887238882388923890238912389223893238942389523896238972389823899239002390123902239032390423905239062390723908239092391023911239122391323914239152391623917239182391923920239212392223923239242392523926239272392823929239302393123932239332393423935239362393723938239392394023941239422394323944239452394623947239482394923950239512395223953239542395523956239572395823959239602396123962239632396423965239662396723968239692397023971239722397323974239752397623977239782397923980239812398223983239842398523986239872398823989239902399123992239932399423995239962399723998239992400024001240022400324004240052400624007240082400924010240112401224013240142401524016240172401824019240202402124022240232402424025240262402724028240292403024031240322403324034240352403624037240382403924040240412404224043240442404524046240472404824049240502405124052240532405424055240562405724058240592406024061240622406324064240652406624067240682406924070240712407224073240742407524076240772407824079240802408124082240832408424085240862408724088240892409024091240922409324094240952409624097240982409924100241012410224103241042410524106241072410824109241102411124112241132411424115241162411724118241192412024121241222412324124241252412624127241282412924130241312413224133241342413524136241372413824139241402414124142241432414424145241462414724148241492415024151241522415324154241552415624157241582415924160241612416224163241642416524166241672416824169241702417124172241732417424175241762417724178241792418024181241822418324184241852418624187241882418924190241912419224193241942419524196241972419824199242002420124202242032420424205242062420724208242092421024211242122421324214242152421624217242182421924220242212422224223242242422524226242272422824229242302423124232242332423424235242362423724238242392424024241242422424324244242452424624247242482424924250242512425224253242542425524256242572425824259242602426124262242632426424265242662426724268242692427024271242722427324274242752427624277242782427924280242812428224283242842428524286242872428824289242902429124292242932429424295242962429724298242992430024301243022430324304243052430624307243082430924310243112431224313243142431524316243172431824319243202432124322243232432424325243262432724328243292433024331243322433324334243352433624337243382433924340243412434224343243442434524346243472434824349243502435124352243532435424355243562435724358243592436024361243622436324364243652436624367243682436924370243712437224373243742437524376243772437824379243802438124382243832438424385243862438724388243892439024391243922439324394243952439624397243982439924400244012440224403244042440524406244072440824409244102441124412244132441424415244162441724418244192442024421244222442324424244252442624427244282442924430244312443224433244342443524436244372443824439244402444124442244432444424445244462444724448244492445024451244522445324454244552445624457244582445924460244612446224463244642446524466244672446824469244702447124472244732447424475244762447724478244792448024481244822448324484244852448624487244882448924490244912449224493244942449524496244972449824499245002450124502245032450424505245062450724508245092451024511245122451324514245152451624517245182451924520245212452224523245242452524526245272452824529245302453124532245332453424535245362453724538245392454024541245422454324544245452454624547245482454924550245512455224553245542455524556245572455824559245602456124562245632456424565245662456724568245692457024571245722457324574245752457624577245782457924580245812458224583245842458524586245872458824589245902459124592245932459424595245962459724598245992460024601246022460324604246052460624607246082460924610246112461224613246142461524616246172461824619246202462124622246232462424625246262462724628246292463024631246322463324634246352463624637246382463924640246412464224643246442464524646246472464824649246502465124652246532465424655246562465724658246592466024661246622466324664246652466624667246682466924670246712467224673246742467524676246772467824679246802468124682246832468424685246862468724688246892469024691246922469324694246952469624697246982469924700247012470224703247042470524706247072470824709247102471124712247132471424715247162471724718247192472024721247222472324724247252472624727247282472924730247312473224733247342473524736247372473824739247402474124742247432474424745247462474724748247492475024751247522475324754247552475624757247582475924760247612476224763247642476524766247672476824769247702477124772247732477424775247762477724778247792478024781247822478324784247852478624787247882478924790247912479224793247942479524796247972479824799248002480124802248032480424805248062480724808248092481024811248122481324814248152481624817248182481924820248212482224823248242482524826248272482824829248302483124832248332483424835248362483724838248392484024841248422484324844248452484624847248482484924850248512485224853248542485524856248572485824859248602486124862248632486424865248662486724868248692487024871248722487324874248752487624877248782487924880248812488224883248842488524886248872488824889248902489124892248932489424895248962489724898248992490024901249022490324904249052490624907249082490924910249112491224913249142491524916249172491824919249202492124922249232492424925249262492724928249292493024931249322493324934249352493624937249382493924940249412494224943249442494524946249472494824949249502495124952249532495424955249562495724958249592496024961249622496324964249652496624967249682496924970249712497224973249742497524976249772497824979249802498124982249832498424985249862498724988249892499024991249922499324994249952499624997249982499925000250012500225003250042500525006250072500825009250102501125012250132501425015250162501725018250192502025021250222502325024250252502625027250282502925030250312503225033250342503525036250372503825039250402504125042250432504425045250462504725048250492505025051250522505325054250552505625057250582505925060250612506225063250642506525066250672506825069250702507125072250732507425075250762507725078250792508025081250822508325084250852508625087250882508925090250912509225093250942509525096250972509825099251002510125102251032510425105251062510725108251092511025111251122511325114251152511625117251182511925120251212512225123251242512525126251272512825129251302513125132251332513425135251362513725138251392514025141251422514325144251452514625147251482514925150251512515225153251542515525156251572515825159251602516125162251632516425165251662516725168251692517025171251722517325174251752517625177251782517925180251812518225183251842518525186251872518825189251902519125192251932519425195251962519725198251992520025201252022520325204252052520625207252082520925210252112521225213252142521525216252172521825219252202522125222252232522425225252262522725228252292523025231252322523325234252352523625237252382523925240252412524225243252442524525246252472524825249252502525125252252532525425255252562525725258252592526025261252622526325264252652526625267252682526925270252712527225273252742527525276252772527825279252802528125282252832528425285252862528725288252892529025291252922529325294252952529625297252982529925300253012530225303253042530525306253072530825309253102531125312253132531425315253162531725318253192532025321253222532325324253252532625327253282532925330253312533225333253342533525336253372533825339253402534125342253432534425345253462534725348253492535025351253522535325354253552535625357253582535925360253612536225363253642536525366253672536825369253702537125372253732537425375253762537725378253792538025381253822538325384253852538625387253882538925390253912539225393253942539525396253972539825399254002540125402254032540425405254062540725408254092541025411254122541325414254152541625417254182541925420254212542225423254242542525426254272542825429254302543125432254332543425435254362543725438254392544025441254422544325444254452544625447254482544925450254512545225453254542545525456254572545825459254602546125462254632546425465254662546725468254692547025471254722547325474254752547625477254782547925480254812548225483254842548525486254872548825489254902549125492254932549425495254962549725498254992550025501255022550325504255052550625507255082550925510255112551225513255142551525516255172551825519255202552125522255232552425525255262552725528255292553025531255322553325534255352553625537255382553925540255412554225543255442554525546255472554825549255502555125552255532555425555255562555725558255592556025561255622556325564255652556625567255682556925570255712557225573255742557525576255772557825579255802558125582255832558425585255862558725588255892559025591255922559325594255952559625597255982559925600256012560225603256042560525606256072560825609256102561125612256132561425615256162561725618256192562025621256222562325624256252562625627256282562925630256312563225633256342563525636256372563825639256402564125642256432564425645256462564725648256492565025651256522565325654256552565625657256582565925660256612566225663256642566525666256672566825669256702567125672256732567425675256762567725678256792568025681256822568325684256852568625687256882568925690256912569225693256942569525696256972569825699257002570125702257032570425705257062570725708257092571025711257122571325714257152571625717257182571925720257212572225723257242572525726257272572825729257302573125732257332573425735257362573725738257392574025741257422574325744257452574625747257482574925750257512575225753257542575525756257572575825759257602576125762257632576425765257662576725768257692577025771257722577325774257752577625777257782577925780257812578225783257842578525786257872578825789257902579125792257932579425795257962579725798257992580025801258022580325804258052580625807258082580925810258112581225813258142581525816258172581825819258202582125822258232582425825258262582725828258292583025831258322583325834258352583625837258382583925840258412584225843258442584525846258472584825849258502585125852258532585425855258562585725858258592586025861258622586325864258652586625867258682586925870258712587225873258742587525876258772587825879258802588125882258832588425885258862588725888258892589025891258922589325894258952589625897258982589925900259012590225903259042590525906259072590825909259102591125912259132591425915259162591725918259192592025921259222592325924259252592625927259282592925930259312593225933259342593525936259372593825939259402594125942259432594425945259462594725948259492595025951259522595325954259552595625957259582595925960259612596225963259642596525966259672596825969259702597125972259732597425975259762597725978259792598025981259822598325984259852598625987259882598925990259912599225993259942599525996259972599825999260002600126002260032600426005260062600726008260092601026011260122601326014260152601626017260182601926020260212602226023260242602526026260272602826029260302603126032260332603426035260362603726038260392604026041260422604326044260452604626047260482604926050260512605226053260542605526056260572605826059260602606126062260632606426065260662606726068260692607026071260722607326074260752607626077260782607926080260812608226083260842608526086260872608826089260902609126092260932609426095260962609726098260992610026101261022610326104261052610626107261082610926110261112611226113261142611526116261172611826119261202612126122261232612426125261262612726128261292613026131261322613326134261352613626137261382613926140261412614226143261442614526146261472614826149261502615126152261532615426155261562615726158261592616026161261622616326164261652616626167261682616926170261712617226173261742617526176261772617826179261802618126182261832618426185261862618726188261892619026191261922619326194261952619626197261982619926200262012620226203262042620526206262072620826209262102621126212262132621426215262162621726218262192622026221262222622326224262252622626227262282622926230262312623226233262342623526236262372623826239262402624126242262432624426245262462624726248262492625026251262522625326254262552625626257262582625926260262612626226263262642626526266262672626826269262702627126272262732627426275262762627726278262792628026281262822628326284262852628626287262882628926290262912629226293262942629526296262972629826299263002630126302263032630426305263062630726308263092631026311263122631326314263152631626317263182631926320263212632226323263242632526326263272632826329263302633126332263332633426335263362633726338263392634026341263422634326344263452634626347263482634926350263512635226353263542635526356263572635826359263602636126362263632636426365263662636726368263692637026371263722637326374263752637626377263782637926380263812638226383263842638526386263872638826389263902639126392263932639426395263962639726398263992640026401264022640326404264052640626407264082640926410264112641226413264142641526416264172641826419264202642126422264232642426425264262642726428264292643026431264322643326434264352643626437264382643926440264412644226443264442644526446264472644826449264502645126452264532645426455264562645726458264592646026461264622646326464264652646626467264682646926470264712647226473264742647526476264772647826479264802648126482264832648426485264862648726488264892649026491264922649326494264952649626497264982649926500265012650226503265042650526506265072650826509265102651126512265132651426515265162651726518265192652026521265222652326524265252652626527265282652926530265312653226533265342653526536265372653826539265402654126542265432654426545265462654726548265492655026551265522655326554265552655626557265582655926560265612656226563265642656526566265672656826569265702657126572265732657426575265762657726578265792658026581265822658326584265852658626587265882658926590265912659226593265942659526596265972659826599266002660126602266032660426605266062660726608266092661026611266122661326614266152661626617266182661926620266212662226623266242662526626266272662826629266302663126632266332663426635266362663726638266392664026641266422664326644266452664626647266482664926650266512665226653266542665526656266572665826659266602666126662266632666426665266662666726668266692667026671266722667326674266752667626677266782667926680266812668226683266842668526686266872668826689266902669126692266932669426695266962669726698266992670026701267022670326704267052670626707267082670926710267112671226713267142671526716267172671826719267202672126722267232672426725267262672726728267292673026731267322673326734267352673626737267382673926740267412674226743267442674526746267472674826749267502675126752267532675426755267562675726758267592676026761267622676326764267652676626767267682676926770267712677226773267742677526776267772677826779267802678126782267832678426785267862678726788267892679026791267922679326794267952679626797267982679926800268012680226803268042680526806268072680826809268102681126812268132681426815268162681726818268192682026821268222682326824268252682626827268282682926830268312683226833268342683526836268372683826839268402684126842268432684426845268462684726848268492685026851268522685326854268552685626857268582685926860268612686226863268642686526866268672686826869268702687126872268732687426875268762687726878268792688026881268822688326884268852688626887268882688926890268912689226893268942689526896268972689826899269002690126902269032690426905269062690726908269092691026911269122691326914269152691626917269182691926920269212692226923269242692526926269272692826929269302693126932269332693426935269362693726938269392694026941269422694326944269452694626947269482694926950269512695226953269542695526956269572695826959269602696126962269632696426965269662696726968269692697026971269722697326974269752697626977269782697926980269812698226983269842698526986269872698826989269902699126992269932699426995269962699726998269992700027001270022700327004270052700627007270082700927010270112701227013270142701527016270172701827019270202702127022270232702427025270262702727028270292703027031270322703327034270352703627037270382703927040270412704227043270442704527046270472704827049270502705127052270532705427055270562705727058270592706027061270622706327064270652706627067270682706927070270712707227073270742707527076270772707827079270802708127082270832708427085270862708727088270892709027091270922709327094270952709627097270982709927100271012710227103271042710527106271072710827109271102711127112271132711427115271162711727118271192712027121271222712327124271252712627127271282712927130271312713227133271342713527136271372713827139271402714127142271432714427145271462714727148271492715027151271522715327154271552715627157271582715927160271612716227163271642716527166271672716827169271702717127172271732717427175271762717727178271792718027181271822718327184271852718627187271882718927190271912719227193271942719527196271972719827199272002720127202272032720427205272062720727208272092721027211272122721327214272152721627217272182721927220272212722227223272242722527226272272722827229272302723127232272332723427235272362723727238272392724027241272422724327244272452724627247272482724927250272512725227253272542725527256272572725827259272602726127262272632726427265272662726727268272692727027271272722727327274272752727627277272782727927280272812728227283272842728527286272872728827289272902729127292272932729427295272962729727298272992730027301273022730327304273052730627307273082730927310273112731227313273142731527316273172731827319273202732127322273232732427325273262732727328273292733027331273322733327334273352733627337273382733927340273412734227343273442734527346273472734827349273502735127352273532735427355273562735727358273592736027361273622736327364273652736627367273682736927370273712737227373273742737527376273772737827379273802738127382273832738427385273862738727388273892739027391273922739327394273952739627397273982739927400274012740227403274042740527406274072740827409274102741127412274132741427415274162741727418274192742027421274222742327424274252742627427274282742927430274312743227433274342743527436274372743827439274402744127442274432744427445274462744727448274492745027451274522745327454274552745627457274582745927460274612746227463274642746527466274672746827469274702747127472274732747427475274762747727478274792748027481274822748327484274852748627487274882748927490274912749227493274942749527496274972749827499275002750127502275032750427505275062750727508275092751027511275122751327514275152751627517275182751927520275212752227523275242752527526275272752827529275302753127532275332753427535275362753727538275392754027541275422754327544275452754627547275482754927550275512755227553275542755527556275572755827559275602756127562275632756427565275662756727568275692757027571275722757327574275752757627577275782757927580275812758227583275842758527586275872758827589275902759127592275932759427595275962759727598275992760027601276022760327604276052760627607276082760927610276112761227613276142761527616276172761827619276202762127622276232762427625276262762727628276292763027631276322763327634276352763627637276382763927640276412764227643276442764527646276472764827649276502765127652276532765427655276562765727658276592766027661276622766327664276652766627667276682766927670276712767227673276742767527676276772767827679276802768127682276832768427685276862768727688276892769027691276922769327694276952769627697276982769927700277012770227703277042770527706277072770827709277102771127712277132771427715277162771727718277192772027721277222772327724277252772627727277282772927730277312773227733277342773527736277372773827739277402774127742277432774427745277462774727748277492775027751277522775327754277552775627757277582775927760277612776227763277642776527766277672776827769277702777127772277732777427775277762777727778277792778027781277822778327784277852778627787277882778927790277912779227793277942779527796277972779827799278002780127802278032780427805278062780727808278092781027811278122781327814278152781627817278182781927820278212782227823278242782527826278272782827829278302783127832278332783427835278362783727838278392784027841278422784327844278452784627847278482784927850278512785227853278542785527856278572785827859278602786127862278632786427865278662786727868278692787027871278722787327874278752787627877278782787927880278812788227883278842788527886278872788827889278902789127892278932789427895278962789727898278992790027901279022790327904279052790627907279082790927910279112791227913279142791527916279172791827919279202792127922279232792427925279262792727928279292793027931279322793327934279352793627937279382793927940279412794227943279442794527946279472794827949279502795127952279532795427955279562795727958279592796027961279622796327964279652796627967279682796927970279712797227973279742797527976279772797827979279802798127982279832798427985279862798727988279892799027991279922799327994279952799627997279982799928000280012800228003280042800528006280072800828009280102801128012280132801428015280162801728018280192802028021280222802328024280252802628027280282802928030280312803228033280342803528036280372803828039280402804128042280432804428045280462804728048280492805028051280522805328054280552805628057280582805928060280612806228063280642806528066280672806828069280702807128072280732807428075280762807728078280792808028081280822808328084280852808628087280882808928090280912809228093280942809528096280972809828099281002810128102281032810428105281062810728108281092811028111281122811328114281152811628117281182811928120281212812228123281242812528126281272812828129281302813128132281332813428135281362813728138281392814028141281422814328144281452814628147281482814928150281512815228153281542815528156281572815828159281602816128162281632816428165281662816728168281692817028171281722817328174281752817628177281782817928180281812818228183281842818528186281872818828189281902819128192281932819428195281962819728198281992820028201282022820328204282052820628207282082820928210282112821228213282142821528216282172821828219282202822128222282232822428225282262822728228282292823028231282322823328234282352823628237282382823928240282412824228243282442824528246282472824828249282502825128252282532825428255282562825728258282592826028261282622826328264282652826628267282682826928270282712827228273282742827528276282772827828279282802828128282282832828428285282862828728288282892829028291282922829328294282952829628297282982829928300283012830228303283042830528306283072830828309283102831128312283132831428315283162831728318283192832028321283222832328324283252832628327283282832928330283312833228333283342833528336283372833828339283402834128342283432834428345283462834728348283492835028351283522835328354283552835628357283582835928360283612836228363283642836528366283672836828369283702837128372283732837428375283762837728378283792838028381283822838328384283852838628387283882838928390283912839228393283942839528396283972839828399284002840128402284032840428405284062840728408284092841028411284122841328414284152841628417284182841928420284212842228423284242842528426284272842828429284302843128432284332843428435284362843728438284392844028441284422844328444284452844628447284482844928450284512845228453284542845528456284572845828459284602846128462284632846428465284662846728468284692847028471284722847328474284752847628477284782847928480284812848228483284842848528486284872848828489284902849128492284932849428495284962849728498284992850028501285022850328504285052850628507285082850928510285112851228513285142851528516285172851828519285202852128522285232852428525285262852728528285292853028531285322853328534285352853628537285382853928540285412854228543285442854528546285472854828549285502855128552285532855428555285562855728558285592856028561285622856328564285652856628567285682856928570285712857228573285742857528576285772857828579285802858128582285832858428585285862858728588285892859028591285922859328594285952859628597285982859928600286012860228603286042860528606286072860828609286102861128612286132861428615286162861728618286192862028621286222862328624286252862628627286282862928630286312863228633286342863528636286372863828639286402864128642286432864428645286462864728648286492865028651286522865328654286552865628657286582865928660286612866228663286642866528666286672866828669286702867128672286732867428675286762867728678286792868028681286822868328684286852868628687286882868928690286912869228693286942869528696286972869828699287002870128702287032870428705287062870728708287092871028711287122871328714287152871628717287182871928720287212872228723287242872528726287272872828729287302873128732287332873428735287362873728738287392874028741287422874328744287452874628747287482874928750287512875228753287542875528756287572875828759287602876128762287632876428765287662876728768287692877028771287722877328774287752877628777287782877928780287812878228783287842878528786287872878828789287902879128792287932879428795287962879728798287992880028801288022880328804288052880628807288082880928810288112881228813288142881528816288172881828819288202882128822288232882428825288262882728828288292883028831288322883328834288352883628837288382883928840288412884228843288442884528846288472884828849288502885128852288532885428855288562885728858288592886028861288622886328864288652886628867288682886928870288712887228873288742887528876288772887828879288802888128882288832888428885288862888728888288892889028891288922889328894288952889628897288982889928900289012890228903289042890528906289072890828909289102891128912289132891428915289162891728918289192892028921289222892328924289252892628927289282892928930289312893228933289342893528936289372893828939289402894128942289432894428945289462894728948289492895028951289522895328954289552895628957289582895928960289612896228963289642896528966289672896828969289702897128972289732897428975289762897728978289792898028981289822898328984289852898628987289882898928990289912899228993289942899528996289972899828999290002900129002290032900429005290062900729008290092901029011290122901329014290152901629017290182901929020290212902229023290242902529026290272902829029290302903129032290332903429035290362903729038290392904029041290422904329044290452904629047290482904929050290512905229053290542905529056290572905829059290602906129062290632906429065290662906729068290692907029071290722907329074290752907629077290782907929080290812908229083290842908529086290872908829089290902909129092290932909429095290962909729098290992910029101291022910329104291052910629107291082910929110291112911229113291142911529116291172911829119291202912129122291232912429125291262912729128291292913029131291322913329134291352913629137291382913929140291412914229143291442914529146291472914829149291502915129152291532915429155291562915729158291592916029161291622916329164291652916629167291682916929170291712917229173291742917529176291772917829179291802918129182291832918429185291862918729188291892919029191291922919329194291952919629197291982919929200292012920229203292042920529206292072920829209292102921129212292132921429215292162921729218292192922029221292222922329224292252922629227292282922929230292312923229233292342923529236292372923829239292402924129242292432924429245292462924729248292492925029251292522925329254292552925629257292582925929260292612926229263292642926529266292672926829269292702927129272292732927429275292762927729278292792928029281292822928329284292852928629287292882928929290292912929229293292942929529296292972929829299293002930129302293032930429305293062930729308293092931029311293122931329314293152931629317293182931929320293212932229323293242932529326293272932829329293302933129332293332933429335293362933729338293392934029341293422934329344293452934629347293482934929350293512935229353293542935529356293572935829359293602936129362293632936429365293662936729368293692937029371293722937329374293752937629377293782937929380293812938229383293842938529386293872938829389293902939129392293932939429395293962939729398293992940029401294022940329404294052940629407294082940929410294112941229413294142941529416294172941829419294202942129422294232942429425294262942729428294292943029431294322943329434294352943629437294382943929440294412944229443294442944529446294472944829449294502945129452294532945429455294562945729458294592946029461294622946329464294652946629467294682946929470294712947229473294742947529476294772947829479294802948129482294832948429485294862948729488294892949029491294922949329494294952949629497294982949929500295012950229503295042950529506295072950829509295102951129512295132951429515295162951729518295192952029521295222952329524295252952629527295282952929530295312953229533295342953529536295372953829539295402954129542295432954429545295462954729548295492955029551295522955329554295552955629557295582955929560295612956229563295642956529566295672956829569295702957129572295732957429575295762957729578295792958029581295822958329584295852958629587295882958929590295912959229593295942959529596295972959829599296002960129602296032960429605296062960729608296092961029611296122961329614296152961629617296182961929620296212962229623296242962529626296272962829629296302963129632296332963429635296362963729638296392964029641296422964329644296452964629647296482964929650296512965229653296542965529656296572965829659296602966129662296632966429665296662966729668296692967029671296722967329674296752967629677296782967929680296812968229683296842968529686296872968829689296902969129692296932969429695296962969729698296992970029701297022970329704297052970629707297082970929710297112971229713297142971529716297172971829719297202972129722297232972429725297262972729728297292973029731297322973329734297352973629737297382973929740297412974229743297442974529746297472974829749297502975129752297532975429755297562975729758297592976029761297622976329764297652976629767297682976929770297712977229773297742977529776297772977829779297802978129782297832978429785297862978729788297892979029791297922979329794297952979629797297982979929800298012980229803298042980529806298072980829809298102981129812298132981429815298162981729818298192982029821298222982329824298252982629827298282982929830298312983229833298342983529836298372983829839298402984129842298432984429845298462984729848298492985029851298522985329854298552985629857298582985929860298612986229863298642986529866298672986829869298702987129872298732987429875298762987729878298792988029881298822988329884298852988629887298882988929890298912989229893298942989529896298972989829899299002990129902299032990429905299062990729908299092991029911299122991329914299152991629917299182991929920299212992229923299242992529926299272992829929299302993129932299332993429935299362993729938299392994029941299422994329944299452994629947299482994929950299512995229953299542995529956299572995829959299602996129962299632996429965299662996729968299692997029971299722997329974299752997629977299782997929980299812998229983299842998529986299872998829989299902999129992299932999429995299962999729998299993000030001300023000330004300053000630007300083000930010300113001230013300143001530016300173001830019300203002130022300233002430025300263002730028300293003030031300323003330034300353003630037300383003930040300413004230043300443004530046300473004830049300503005130052300533005430055300563005730058300593006030061300623006330064300653006630067300683006930070300713007230073300743007530076300773007830079300803008130082300833008430085300863008730088300893009030091300923009330094300953009630097300983009930100301013010230103301043010530106301073010830109301103011130112301133011430115301163011730118301193012030121301223012330124301253012630127301283012930130301313013230133301343013530136301373013830139301403014130142301433014430145301463014730148301493015030151301523015330154301553015630157301583015930160301613016230163301643016530166301673016830169301703017130172301733017430175301763017730178301793018030181301823018330184301853018630187301883018930190301913019230193301943019530196301973019830199302003020130202302033020430205302063020730208302093021030211302123021330214302153021630217302183021930220302213022230223302243022530226302273022830229302303023130232302333023430235302363023730238302393024030241302423024330244302453024630247302483024930250302513025230253302543025530256302573025830259302603026130262302633026430265302663026730268302693027030271302723027330274302753027630277302783027930280302813028230283302843028530286302873028830289302903029130292302933029430295302963029730298302993030030301303023030330304303053030630307303083030930310303113031230313303143031530316303173031830319303203032130322303233032430325303263032730328303293033030331303323033330334303353033630337303383033930340303413034230343303443034530346303473034830349303503035130352303533035430355303563035730358303593036030361303623036330364303653036630367303683036930370303713037230373303743037530376303773037830379303803038130382303833038430385303863038730388303893039030391303923039330394303953039630397303983039930400304013040230403304043040530406304073040830409304103041130412304133041430415304163041730418304193042030421304223042330424304253042630427304283042930430304313043230433304343043530436304373043830439304403044130442304433044430445304463044730448304493045030451304523045330454304553045630457304583045930460304613046230463304643046530466304673046830469304703047130472304733047430475304763047730478304793048030481304823048330484304853048630487304883048930490304913049230493304943049530496304973049830499305003050130502305033050430505305063050730508305093051030511305123051330514305153051630517305183051930520305213052230523305243052530526305273052830529305303053130532305333053430535305363053730538305393054030541305423054330544305453054630547305483054930550305513055230553305543055530556305573055830559305603056130562305633056430565305663056730568305693057030571305723057330574305753057630577305783057930580305813058230583305843058530586305873058830589305903059130592305933059430595305963059730598305993060030601306023060330604306053060630607306083060930610306113061230613306143061530616306173061830619306203062130622306233062430625306263062730628306293063030631306323063330634306353063630637306383063930640306413064230643306443064530646306473064830649306503065130652306533065430655306563065730658306593066030661306623066330664306653066630667306683066930670306713067230673306743067530676306773067830679306803068130682306833068430685306863068730688306893069030691306923069330694306953069630697306983069930700307013070230703307043070530706307073070830709307103071130712307133071430715307163071730718307193072030721307223072330724307253072630727307283072930730307313073230733307343073530736307373073830739307403074130742307433074430745307463074730748307493075030751307523075330754307553075630757307583075930760307613076230763307643076530766307673076830769307703077130772307733077430775307763077730778307793078030781307823078330784307853078630787307883078930790307913079230793307943079530796307973079830799308003080130802308033080430805308063080730808308093081030811308123081330814308153081630817308183081930820308213082230823308243082530826308273082830829308303083130832308333083430835308363083730838308393084030841308423084330844308453084630847308483084930850308513085230853308543085530856308573085830859308603086130862308633086430865308663086730868308693087030871308723087330874308753087630877308783087930880308813088230883308843088530886308873088830889308903089130892308933089430895308963089730898308993090030901309023090330904309053090630907309083090930910309113091230913309143091530916309173091830919309203092130922309233092430925309263092730928309293093030931309323093330934309353093630937309383093930940309413094230943309443094530946309473094830949309503095130952309533095430955309563095730958309593096030961309623096330964309653096630967309683096930970309713097230973309743097530976309773097830979309803098130982309833098430985309863098730988309893099030991309923099330994309953099630997309983099931000310013100231003310043100531006310073100831009310103101131012310133101431015310163101731018310193102031021310223102331024310253102631027310283102931030310313103231033310343103531036310373103831039310403104131042310433104431045310463104731048310493105031051310523105331054310553105631057310583105931060310613106231063310643106531066310673106831069310703107131072310733107431075310763107731078310793108031081310823108331084310853108631087310883108931090310913109231093310943109531096310973109831099311003110131102311033110431105311063110731108311093111031111311123111331114311153111631117311183111931120311213112231123311243112531126311273112831129311303113131132311333113431135311363113731138311393114031141311423114331144311453114631147311483114931150311513115231153311543115531156311573115831159311603116131162311633116431165311663116731168311693117031171311723117331174311753117631177311783117931180311813118231183311843118531186311873118831189311903119131192311933119431195311963119731198311993120031201312023120331204312053120631207312083120931210312113121231213312143121531216312173121831219312203122131222312233122431225312263122731228312293123031231312323123331234312353123631237312383123931240312413124231243312443124531246312473124831249312503125131252312533125431255312563125731258312593126031261312623126331264312653126631267312683126931270312713127231273312743127531276312773127831279312803128131282312833128431285312863128731288312893129031291312923129331294312953129631297312983129931300313013130231303313043130531306313073130831309313103131131312313133131431315313163131731318313193132031321313223132331324313253132631327313283132931330313313133231333313343133531336313373133831339313403134131342313433134431345313463134731348313493135031351313523135331354313553135631357313583135931360313613136231363313643136531366313673136831369313703137131372313733137431375313763137731378313793138031381313823138331384313853138631387313883138931390313913139231393313943139531396313973139831399314003140131402314033140431405314063140731408314093141031411314123141331414314153141631417314183141931420314213142231423314243142531426314273142831429314303143131432314333143431435314363143731438314393144031441314423144331444314453144631447314483144931450314513145231453314543145531456314573145831459314603146131462314633146431465314663146731468314693147031471314723147331474314753147631477314783147931480314813148231483314843148531486314873148831489314903149131492314933149431495314963149731498314993150031501315023150331504315053150631507315083150931510315113151231513315143151531516315173151831519315203152131522315233152431525315263152731528315293153031531315323153331534315353153631537315383153931540315413154231543315443154531546315473154831549315503155131552315533155431555315563155731558315593156031561315623156331564315653156631567315683156931570315713157231573315743157531576315773157831579315803158131582315833158431585315863158731588315893159031591315923159331594315953159631597315983159931600316013160231603316043160531606316073160831609316103161131612316133161431615316163161731618316193162031621316223162331624316253162631627316283162931630316313163231633316343163531636316373163831639316403164131642316433164431645316463164731648316493165031651316523165331654316553165631657316583165931660316613166231663316643166531666316673166831669316703167131672316733167431675316763167731678316793168031681316823168331684316853168631687316883168931690316913169231693316943169531696316973169831699317003170131702317033170431705317063170731708317093171031711317123171331714317153171631717317183171931720317213172231723317243172531726317273172831729317303173131732317333173431735317363173731738317393174031741317423174331744317453174631747317483174931750317513175231753317543175531756317573175831759317603176131762317633176431765317663176731768317693177031771317723177331774317753177631777317783177931780317813178231783317843178531786317873178831789317903179131792317933179431795317963179731798317993180031801318023180331804318053180631807318083180931810318113181231813318143181531816318173181831819318203182131822318233182431825318263182731828318293183031831318323183331834318353183631837318383183931840318413184231843318443184531846318473184831849318503185131852318533185431855318563185731858318593186031861318623186331864318653186631867318683186931870318713187231873318743187531876318773187831879318803188131882318833188431885318863188731888318893189031891318923189331894318953189631897318983189931900319013190231903319043190531906319073190831909319103191131912319133191431915319163191731918319193192031921319223192331924319253192631927319283192931930319313193231933319343193531936319373193831939319403194131942319433194431945319463194731948319493195031951319523195331954319553195631957319583195931960319613196231963319643196531966319673196831969319703197131972319733197431975319763197731978319793198031981319823198331984319853198631987319883198931990319913199231993319943199531996319973199831999320003200132002320033200432005320063200732008320093201032011320123201332014320153201632017320183201932020320213202232023320243202532026320273202832029320303203132032320333203432035320363203732038320393204032041320423204332044320453204632047320483204932050320513205232053320543205532056320573205832059320603206132062320633206432065320663206732068320693207032071320723207332074320753207632077320783207932080320813208232083320843208532086320873208832089320903209132092320933209432095320963209732098320993210032101321023210332104321053210632107321083210932110321113211232113321143211532116321173211832119321203212132122321233212432125321263212732128321293213032131321323213332134321353213632137321383213932140321413214232143321443214532146321473214832149321503215132152321533215432155321563215732158321593216032161321623216332164321653216632167321683216932170321713217232173321743217532176321773217832179321803218132182321833218432185321863218732188321893219032191321923219332194321953219632197321983219932200322013220232203322043220532206322073220832209322103221132212322133221432215322163221732218322193222032221322223222332224322253222632227322283222932230322313223232233322343223532236322373223832239322403224132242322433224432245322463224732248322493225032251322523225332254322553225632257322583225932260322613226232263322643226532266322673226832269322703227132272322733227432275322763227732278322793228032281322823228332284322853228632287322883228932290322913229232293322943229532296322973229832299323003230132302323033230432305323063230732308323093231032311323123231332314323153231632317323183231932320323213232232323323243232532326323273232832329323303233132332323333233432335323363233732338323393234032341323423234332344323453234632347323483234932350323513235232353323543235532356323573235832359323603236132362323633236432365323663236732368323693237032371323723237332374323753237632377323783237932380323813238232383323843238532386323873238832389323903239132392323933239432395323963239732398323993240032401324023240332404324053240632407324083240932410324113241232413324143241532416324173241832419324203242132422324233242432425324263242732428324293243032431324323243332434324353243632437324383243932440324413244232443324443244532446324473244832449324503245132452324533245432455324563245732458324593246032461324623246332464324653246632467324683246932470324713247232473324743247532476324773247832479324803248132482324833248432485324863248732488324893249032491324923249332494324953249632497324983249932500325013250232503325043250532506325073250832509325103251132512325133251432515325163251732518325193252032521325223252332524325253252632527325283252932530325313253232533325343253532536325373253832539325403254132542325433254432545325463254732548325493255032551325523255332554325553255632557325583255932560325613256232563325643256532566325673256832569325703257132572325733257432575325763257732578325793258032581325823258332584325853258632587325883258932590325913259232593325943259532596325973259832599326003260132602326033260432605326063260732608326093261032611326123261332614326153261632617326183261932620326213262232623326243262532626326273262832629326303263132632326333263432635326363263732638326393264032641326423264332644326453264632647326483264932650326513265232653326543265532656326573265832659326603266132662326633266432665326663266732668326693267032671326723267332674326753267632677326783267932680326813268232683326843268532686326873268832689326903269132692326933269432695326963269732698326993270032701327023270332704327053270632707327083270932710327113271232713327143271532716327173271832719327203272132722327233272432725327263272732728327293273032731327323273332734327353273632737327383273932740327413274232743327443274532746327473274832749327503275132752327533275432755327563275732758327593276032761327623276332764327653276632767327683276932770327713277232773327743277532776327773277832779327803278132782327833278432785327863278732788327893279032791327923279332794327953279632797327983279932800328013280232803328043280532806328073280832809328103281132812328133281432815328163281732818328193282032821328223282332824328253282632827328283282932830328313283232833328343283532836328373283832839328403284132842328433284432845328463284732848328493285032851328523285332854328553285632857328583285932860328613286232863328643286532866328673286832869328703287132872328733287432875328763287732878328793288032881328823288332884328853288632887328883288932890328913289232893328943289532896328973289832899329003290132902329033290432905329063290732908329093291032911329123291332914329153291632917329183291932920329213292232923329243292532926329273292832929329303293132932329333293432935329363293732938329393294032941329423294332944329453294632947329483294932950329513295232953329543295532956329573295832959329603296132962329633296432965329663296732968329693297032971329723297332974329753297632977329783297932980329813298232983329843298532986329873298832989329903299132992329933299432995329963299732998329993300033001330023300333004330053300633007330083300933010330113301233013330143301533016330173301833019330203302133022330233302433025330263302733028330293303033031330323303333034330353303633037330383303933040330413304233043330443304533046330473304833049330503305133052330533305433055330563305733058330593306033061330623306333064330653306633067330683306933070330713307233073330743307533076330773307833079330803308133082330833308433085330863308733088330893309033091330923309333094330953309633097330983309933100331013310233103331043310533106331073310833109331103311133112331133311433115331163311733118331193312033121331223312333124331253312633127331283312933130331313313233133331343313533136331373313833139331403314133142331433314433145331463314733148331493315033151331523315333154331553315633157331583315933160331613316233163331643316533166331673316833169331703317133172331733317433175331763317733178331793318033181331823318333184331853318633187331883318933190331913319233193331943319533196331973319833199332003320133202332033320433205332063320733208332093321033211332123321333214332153321633217332183321933220332213322233223332243322533226332273322833229332303323133232332333323433235332363323733238332393324033241332423324333244332453324633247332483324933250332513325233253332543325533256332573325833259332603326133262332633326433265332663326733268332693327033271332723327333274332753327633277332783327933280332813328233283332843328533286332873328833289332903329133292332933329433295332963329733298332993330033301333023330333304333053330633307333083330933310333113331233313333143331533316333173331833319333203332133322333233332433325333263332733328333293333033331333323333333334333353333633337333383333933340333413334233343333443334533346333473334833349333503335133352333533335433355333563335733358333593336033361333623336333364333653336633367333683336933370333713337233373333743337533376333773337833379333803338133382333833338433385333863338733388333893339033391333923339333394333953339633397333983339933400334013340233403334043340533406334073340833409334103341133412334133341433415334163341733418334193342033421334223342333424334253342633427334283342933430334313343233433334343343533436334373343833439334403344133442334433344433445334463344733448334493345033451334523345333454334553345633457334583345933460334613346233463334643346533466334673346833469334703347133472334733347433475334763347733478334793348033481334823348333484334853348633487334883348933490334913349233493334943349533496334973349833499335003350133502335033350433505335063350733508335093351033511335123351333514335153351633517335183351933520335213352233523335243352533526335273352833529335303353133532335333353433535335363353733538335393354033541335423354333544335453354633547335483354933550335513355233553335543355533556335573355833559335603356133562335633356433565335663356733568335693357033571335723357333574335753357633577335783357933580335813358233583335843358533586335873358833589335903359133592335933359433595335963359733598335993360033601336023360333604336053360633607336083360933610336113361233613336143361533616336173361833619336203362133622336233362433625336263362733628336293363033631336323363333634336353363633637336383363933640336413364233643336443364533646336473364833649336503365133652336533365433655336563365733658336593366033661336623366333664336653366633667336683366933670336713367233673336743367533676336773367833679336803368133682336833368433685336863368733688336893369033691336923369333694336953369633697336983369933700337013370233703337043370533706337073370833709337103371133712337133371433715337163371733718337193372033721337223372333724337253372633727337283372933730337313373233733337343373533736337373373833739337403374133742337433374433745337463374733748337493375033751337523375333754337553375633757337583375933760337613376233763337643376533766337673376833769337703377133772337733377433775337763377733778337793378033781337823378333784337853378633787337883378933790337913379233793337943379533796337973379833799338003380133802338033380433805338063380733808338093381033811338123381333814338153381633817338183381933820338213382233823338243382533826338273382833829338303383133832338333383433835338363383733838338393384033841338423384333844338453384633847338483384933850338513385233853338543385533856338573385833859338603386133862338633386433865338663386733868338693387033871338723387333874338753387633877338783387933880338813388233883338843388533886338873388833889338903389133892338933389433895338963389733898338993390033901339023390333904339053390633907339083390933910339113391233913339143391533916339173391833919339203392133922339233392433925339263392733928339293393033931339323393333934339353393633937339383393933940339413394233943339443394533946339473394833949339503395133952339533395433955339563395733958339593396033961339623396333964339653396633967339683396933970339713397233973339743397533976339773397833979339803398133982339833398433985339863398733988339893399033991339923399333994339953399633997339983399934000340013400234003340043400534006340073400834009340103401134012340133401434015340163401734018340193402034021340223402334024340253402634027340283402934030340313403234033340343403534036340373403834039340403404134042340433404434045340463404734048340493405034051340523405334054340553405634057340583405934060340613406234063340643406534066340673406834069340703407134072340733407434075340763407734078340793408034081340823408334084340853408634087340883408934090340913409234093340943409534096340973409834099341003410134102341033410434105341063410734108341093411034111341123411334114341153411634117341183411934120341213412234123341243412534126341273412834129341303413134132341333413434135341363413734138341393414034141341423414334144341453414634147341483414934150341513415234153341543415534156341573415834159341603416134162341633416434165341663416734168341693417034171341723417334174341753417634177341783417934180341813418234183341843418534186341873418834189341903419134192341933419434195341963419734198341993420034201342023420334204342053420634207342083420934210342113421234213342143421534216342173421834219342203422134222342233422434225342263422734228342293423034231342323423334234342353423634237342383423934240342413424234243342443424534246342473424834249342503425134252342533425434255342563425734258342593426034261342623426334264342653426634267342683426934270342713427234273342743427534276342773427834279342803428134282342833428434285342863428734288342893429034291342923429334294342953429634297342983429934300343013430234303343043430534306343073430834309343103431134312343133431434315343163431734318343193432034321343223432334324343253432634327343283432934330343313433234333343343433534336343373433834339343403434134342343433434434345343463434734348343493435034351343523435334354343553435634357343583435934360343613436234363343643436534366343673436834369343703437134372343733437434375343763437734378343793438034381343823438334384343853438634387343883438934390343913439234393343943439534396343973439834399344003440134402344033440434405344063440734408344093441034411344123441334414344153441634417344183441934420344213442234423344243442534426344273442834429344303443134432344333443434435344363443734438344393444034441344423444334444344453444634447344483444934450344513445234453344543445534456344573445834459344603446134462344633446434465344663446734468344693447034471344723447334474344753447634477344783447934480344813448234483344843448534486344873448834489344903449134492344933449434495344963449734498344993450034501345023450334504345053450634507345083450934510345113451234513345143451534516345173451834519345203452134522345233452434525345263452734528345293453034531345323453334534345353453634537345383453934540345413454234543345443454534546345473454834549345503455134552345533455434555345563455734558345593456034561345623456334564345653456634567345683456934570345713457234573345743457534576345773457834579345803458134582345833458434585345863458734588345893459034591345923459334594345953459634597345983459934600346013460234603346043460534606346073460834609346103461134612346133461434615346163461734618346193462034621346223462334624346253462634627346283462934630346313463234633346343463534636346373463834639346403464134642346433464434645346463464734648346493465034651346523465334654346553465634657346583465934660346613466234663346643466534666346673466834669346703467134672346733467434675346763467734678346793468034681346823468334684346853468634687346883468934690346913469234693346943469534696346973469834699347003470134702347033470434705347063470734708347093471034711347123471334714347153471634717347183471934720347213472234723347243472534726347273472834729347303473134732347333473434735347363473734738347393474034741347423474334744347453474634747347483474934750347513475234753347543475534756347573475834759347603476134762347633476434765347663476734768347693477034771347723477334774347753477634777347783477934780347813478234783347843478534786347873478834789347903479134792347933479434795347963479734798347993480034801348023480334804348053480634807348083480934810348113481234813348143481534816348173481834819348203482134822348233482434825348263482734828348293483034831348323483334834348353483634837348383483934840348413484234843348443484534846348473484834849348503485134852348533485434855348563485734858348593486034861348623486334864348653486634867348683486934870348713487234873348743487534876348773487834879348803488134882348833488434885348863488734888348893489034891348923489334894348953489634897348983489934900349013490234903349043490534906349073490834909349103491134912349133491434915349163491734918349193492034921349223492334924349253492634927349283492934930349313493234933349343493534936349373493834939349403494134942349433494434945349463494734948349493495034951349523495334954349553495634957349583495934960349613496234963349643496534966349673496834969349703497134972349733497434975349763497734978349793498034981349823498334984349853498634987349883498934990349913499234993349943499534996349973499834999350003500135002350033500435005350063500735008350093501035011350123501335014350153501635017350183501935020350213502235023350243502535026350273502835029350303503135032350333503435035350363503735038350393504035041350423504335044350453504635047350483504935050350513505235053350543505535056350573505835059350603506135062350633506435065350663506735068350693507035071350723507335074350753507635077350783507935080350813508235083350843508535086350873508835089350903509135092350933509435095350963509735098350993510035101351023510335104351053510635107351083510935110351113511235113351143511535116351173511835119351203512135122351233512435125351263512735128351293513035131351323513335134351353513635137351383513935140351413514235143351443514535146351473514835149351503515135152351533515435155351563515735158351593516035161351623516335164351653516635167351683516935170351713517235173351743517535176351773517835179351803518135182351833518435185351863518735188351893519035191351923519335194351953519635197351983519935200352013520235203352043520535206352073520835209352103521135212352133521435215352163521735218352193522035221352223522335224352253522635227352283522935230352313523235233352343523535236352373523835239352403524135242352433524435245352463524735248352493525035251352523525335254352553525635257352583525935260352613526235263352643526535266352673526835269352703527135272352733527435275352763527735278352793528035281352823528335284352853528635287352883528935290352913529235293352943529535296352973529835299353003530135302353033530435305353063530735308353093531035311353123531335314353153531635317353183531935320353213532235323353243532535326353273532835329353303533135332353333533435335353363533735338353393534035341353423534335344353453534635347353483534935350353513535235353353543535535356353573535835359353603536135362353633536435365353663536735368353693537035371353723537335374353753537635377353783537935380353813538235383353843538535386353873538835389353903539135392353933539435395353963539735398353993540035401354023540335404354053540635407354083540935410354113541235413354143541535416354173541835419354203542135422354233542435425354263542735428354293543035431354323543335434354353543635437354383543935440354413544235443354443544535446354473544835449354503545135452354533545435455354563545735458354593546035461354623546335464354653546635467354683546935470354713547235473354743547535476354773547835479354803548135482354833548435485354863548735488354893549035491354923549335494354953549635497354983549935500355013550235503355043550535506355073550835509355103551135512355133551435515355163551735518355193552035521355223552335524355253552635527355283552935530355313553235533355343553535536355373553835539355403554135542355433554435545355463554735548355493555035551355523555335554355553555635557355583555935560355613556235563355643556535566355673556835569355703557135572355733557435575355763557735578355793558035581355823558335584355853558635587355883558935590355913559235593355943559535596355973559835599356003560135602356033560435605356063560735608356093561035611356123561335614356153561635617356183561935620356213562235623356243562535626356273562835629356303563135632356333563435635356363563735638356393564035641356423564335644356453564635647356483564935650356513565235653356543565535656356573565835659356603566135662356633566435665356663566735668356693567035671356723567335674356753567635677356783567935680356813568235683356843568535686356873568835689356903569135692356933569435695356963569735698356993570035701357023570335704357053570635707357083570935710357113571235713357143571535716357173571835719357203572135722357233572435725357263572735728357293573035731357323573335734357353573635737357383573935740357413574235743357443574535746357473574835749357503575135752357533575435755357563575735758357593576035761357623576335764357653576635767357683576935770357713577235773357743577535776357773577835779357803578135782357833578435785357863578735788357893579035791357923579335794357953579635797357983579935800358013580235803358043580535806358073580835809358103581135812358133581435815358163581735818358193582035821358223582335824358253582635827358283582935830358313583235833358343583535836358373583835839358403584135842358433584435845358463584735848358493585035851358523585335854358553585635857358583585935860358613586235863358643586535866358673586835869358703587135872358733587435875358763587735878358793588035881358823588335884358853588635887358883588935890358913589235893358943589535896358973589835899359003590135902359033590435905359063590735908359093591035911359123591335914359153591635917359183591935920359213592235923359243592535926359273592835929359303593135932359333593435935359363593735938359393594035941359423594335944359453594635947359483594935950359513595235953359543595535956359573595835959359603596135962359633596435965359663596735968359693597035971359723597335974359753597635977359783597935980359813598235983359843598535986359873598835989359903599135992359933599435995359963599735998359993600036001360023600336004360053600636007360083600936010360113601236013360143601536016360173601836019360203602136022360233602436025360263602736028360293603036031360323603336034360353603636037360383603936040360413604236043360443604536046360473604836049360503605136052360533605436055360563605736058360593606036061360623606336064360653606636067360683606936070360713607236073360743607536076360773607836079360803608136082360833608436085360863608736088360893609036091360923609336094360953609636097360983609936100361013610236103361043610536106361073610836109361103611136112361133611436115361163611736118361193612036121361223612336124361253612636127361283612936130361313613236133361343613536136361373613836139361403614136142361433614436145361463614736148361493615036151361523615336154361553615636157361583615936160361613616236163361643616536166361673616836169361703617136172361733617436175361763617736178361793618036181361823618336184361853618636187361883618936190361913619236193361943619536196361973619836199362003620136202362033620436205362063620736208362093621036211362123621336214362153621636217362183621936220362213622236223362243622536226362273622836229362303623136232362333623436235362363623736238362393624036241362423624336244362453624636247362483624936250362513625236253362543625536256362573625836259362603626136262362633626436265362663626736268362693627036271362723627336274362753627636277362783627936280362813628236283362843628536286362873628836289362903629136292362933629436295362963629736298362993630036301363023630336304363053630636307363083630936310363113631236313363143631536316363173631836319363203632136322363233632436325363263632736328363293633036331363323633336334363353633636337363383633936340363413634236343363443634536346363473634836349363503635136352363533635436355363563635736358363593636036361363623636336364363653636636367363683636936370363713637236373363743637536376363773637836379363803638136382363833638436385363863638736388363893639036391363923639336394363953639636397363983639936400364013640236403364043640536406364073640836409364103641136412364133641436415364163641736418364193642036421364223642336424364253642636427364283642936430364313643236433364343643536436364373643836439364403644136442364433644436445364463644736448364493645036451364523645336454364553645636457364583645936460364613646236463364643646536466364673646836469364703647136472364733647436475364763647736478364793648036481364823648336484364853648636487364883648936490364913649236493364943649536496364973649836499365003650136502365033650436505365063650736508365093651036511365123651336514365153651636517365183651936520365213652236523365243652536526365273652836529365303653136532365333653436535365363653736538365393654036541365423654336544365453654636547365483654936550365513655236553365543655536556365573655836559365603656136562365633656436565365663656736568365693657036571365723657336574365753657636577365783657936580365813658236583365843658536586365873658836589365903659136592365933659436595365963659736598365993660036601366023660336604366053660636607366083660936610366113661236613366143661536616366173661836619366203662136622366233662436625366263662736628366293663036631366323663336634366353663636637366383663936640366413664236643366443664536646366473664836649366503665136652366533665436655366563665736658366593666036661366623666336664366653666636667366683666936670366713667236673366743667536676366773667836679366803668136682366833668436685366863668736688366893669036691366923669336694366953669636697366983669936700367013670236703367043670536706367073670836709367103671136712367133671436715367163671736718367193672036721367223672336724367253672636727367283672936730367313673236733367343673536736367373673836739367403674136742367433674436745367463674736748367493675036751367523675336754367553675636757367583675936760367613676236763367643676536766367673676836769367703677136772367733677436775367763677736778367793678036781367823678336784367853678636787367883678936790367913679236793367943679536796367973679836799368003680136802368033680436805368063680736808368093681036811368123681336814368153681636817368183681936820368213682236823368243682536826368273682836829368303683136832368333683436835368363683736838368393684036841368423684336844368453684636847368483684936850368513685236853368543685536856368573685836859368603686136862368633686436865368663686736868368693687036871368723687336874368753687636877368783687936880368813688236883368843688536886368873688836889368903689136892368933689436895368963689736898368993690036901369023690336904369053690636907369083690936910369113691236913369143691536916369173691836919369203692136922369233692436925369263692736928369293693036931369323693336934369353693636937369383693936940369413694236943369443694536946369473694836949369503695136952369533695436955369563695736958369593696036961369623696336964369653696636967369683696936970369713697236973369743697536976369773697836979369803698136982369833698436985369863698736988369893699036991369923699336994369953699636997369983699937000370013700237003370043700537006370073700837009370103701137012370133701437015370163701737018370193702037021370223702337024370253702637027370283702937030370313703237033370343703537036370373703837039370403704137042370433704437045370463704737048370493705037051370523705337054370553705637057370583705937060370613706237063370643706537066370673706837069370703707137072370733707437075370763707737078370793708037081370823708337084370853708637087370883708937090370913709237093370943709537096370973709837099371003710137102371033710437105371063710737108371093711037111371123711337114371153711637117371183711937120371213712237123371243712537126371273712837129371303713137132371333713437135371363713737138371393714037141371423714337144371453714637147371483714937150371513715237153371543715537156371573715837159371603716137162371633716437165371663716737168371693717037171371723717337174371753717637177371783717937180371813718237183371843718537186371873718837189371903719137192371933719437195371963719737198371993720037201372023720337204372053720637207372083720937210372113721237213372143721537216372173721837219372203722137222372233722437225372263722737228372293723037231372323723337234372353723637237372383723937240372413724237243372443724537246372473724837249372503725137252372533725437255372563725737258372593726037261372623726337264372653726637267372683726937270372713727237273372743727537276372773727837279372803728137282372833728437285372863728737288372893729037291372923729337294372953729637297372983729937300373013730237303373043730537306373073730837309373103731137312373133731437315373163731737318373193732037321373223732337324373253732637327373283732937330373313733237333373343733537336373373733837339373403734137342373433734437345373463734737348373493735037351373523735337354373553735637357373583735937360373613736237363373643736537366373673736837369373703737137372373733737437375373763737737378373793738037381373823738337384373853738637387373883738937390373913739237393373943739537396373973739837399374003740137402374033740437405374063740737408374093741037411374123741337414374153741637417374183741937420374213742237423374243742537426374273742837429374303743137432374333743437435374363743737438374393744037441374423744337444374453744637447374483744937450374513745237453374543745537456374573745837459374603746137462374633746437465374663746737468374693747037471374723747337474374753747637477374783747937480374813748237483374843748537486374873748837489374903749137492374933749437495374963749737498374993750037501375023750337504375053750637507375083750937510375113751237513375143751537516375173751837519375203752137522375233752437525375263752737528375293753037531375323753337534375353753637537375383753937540375413754237543375443754537546375473754837549375503755137552375533755437555375563755737558375593756037561375623756337564375653756637567375683756937570375713757237573375743757537576375773757837579375803758137582375833758437585375863758737588375893759037591375923759337594375953759637597375983759937600376013760237603376043760537606376073760837609376103761137612376133761437615376163761737618376193762037621376223762337624376253762637627376283762937630376313763237633376343763537636376373763837639376403764137642376433764437645376463764737648376493765037651376523765337654376553765637657376583765937660376613766237663376643766537666376673766837669376703767137672376733767437675376763767737678376793768037681376823768337684376853768637687376883768937690376913769237693376943769537696376973769837699377003770137702377033770437705377063770737708377093771037711377123771337714377153771637717377183771937720377213772237723377243772537726377273772837729377303773137732377333773437735377363773737738377393774037741377423774337744377453774637747377483774937750377513775237753377543775537756377573775837759377603776137762377633776437765377663776737768377693777037771377723777337774377753777637777377783777937780377813778237783377843778537786377873778837789377903779137792377933779437795377963779737798377993780037801378023780337804378053780637807378083780937810378113781237813378143781537816378173781837819378203782137822378233782437825378263782737828378293783037831378323783337834378353783637837378383783937840378413784237843378443784537846378473784837849378503785137852378533785437855378563785737858378593786037861378623786337864378653786637867378683786937870378713787237873378743787537876378773787837879378803788137882378833788437885378863788737888378893789037891378923789337894378953789637897378983789937900379013790237903379043790537906379073790837909379103791137912379133791437915379163791737918379193792037921379223792337924379253792637927379283792937930379313793237933379343793537936379373793837939379403794137942379433794437945379463794737948379493795037951379523795337954379553795637957379583795937960379613796237963379643796537966379673796837969379703797137972379733797437975379763797737978379793798037981379823798337984379853798637987379883798937990379913799237993379943799537996379973799837999380003800138002380033800438005380063800738008380093801038011380123801338014380153801638017380183801938020380213802238023380243802538026380273802838029380303803138032380333803438035380363803738038380393804038041380423804338044380453804638047380483804938050380513805238053380543805538056380573805838059380603806138062380633806438065380663806738068380693807038071380723807338074380753807638077380783807938080380813808238083380843808538086380873808838089380903809138092380933809438095380963809738098380993810038101381023810338104381053810638107381083810938110381113811238113381143811538116381173811838119381203812138122381233812438125381263812738128381293813038131381323813338134381353813638137381383813938140381413814238143381443814538146381473814838149381503815138152381533815438155381563815738158381593816038161381623816338164381653816638167381683816938170381713817238173381743817538176381773817838179381803818138182381833818438185381863818738188381893819038191381923819338194381953819638197381983819938200382013820238203382043820538206382073820838209382103821138212382133821438215382163821738218382193822038221382223822338224382253822638227382283822938230382313823238233382343823538236382373823838239382403824138242382433824438245382463824738248382493825038251382523825338254382553825638257382583825938260382613826238263382643826538266382673826838269382703827138272382733827438275382763827738278382793828038281382823828338284382853828638287382883828938290382913829238293382943829538296382973829838299383003830138302383033830438305383063830738308383093831038311383123831338314383153831638317383183831938320383213832238323383243832538326383273832838329383303833138332383333833438335383363833738338383393834038341383423834338344383453834638347383483834938350383513835238353383543835538356383573835838359383603836138362383633836438365383663836738368383693837038371383723837338374383753837638377383783837938380383813838238383383843838538386383873838838389383903839138392383933839438395383963839738398383993840038401384023840338404384053840638407384083840938410384113841238413384143841538416384173841838419384203842138422384233842438425384263842738428384293843038431384323843338434384353843638437384383843938440384413844238443384443844538446384473844838449384503845138452384533845438455384563845738458384593846038461384623846338464384653846638467384683846938470384713847238473384743847538476384773847838479384803848138482384833848438485384863848738488384893849038491384923849338494384953849638497384983849938500385013850238503385043850538506385073850838509385103851138512385133851438515385163851738518385193852038521385223852338524385253852638527385283852938530385313853238533385343853538536385373853838539385403854138542385433854438545385463854738548385493855038551385523855338554385553855638557385583855938560385613856238563385643856538566385673856838569385703857138572385733857438575385763857738578385793858038581385823858338584385853858638587385883858938590385913859238593385943859538596385973859838599386003860138602386033860438605386063860738608386093861038611386123861338614386153861638617386183861938620386213862238623386243862538626386273862838629386303863138632386333863438635386363863738638386393864038641386423864338644386453864638647386483864938650386513865238653386543865538656386573865838659386603866138662386633866438665386663866738668386693867038671386723867338674386753867638677386783867938680386813868238683386843868538686386873868838689386903869138692386933869438695386963869738698386993870038701387023870338704387053870638707387083870938710387113871238713387143871538716387173871838719387203872138722387233872438725387263872738728387293873038731387323873338734387353873638737387383873938740387413874238743387443874538746387473874838749387503875138752387533875438755387563875738758387593876038761387623876338764387653876638767387683876938770387713877238773387743877538776387773877838779387803878138782387833878438785387863878738788387893879038791387923879338794387953879638797387983879938800388013880238803388043880538806388073880838809388103881138812388133881438815388163881738818388193882038821388223882338824388253882638827388283882938830388313883238833388343883538836388373883838839388403884138842388433884438845388463884738848388493885038851388523885338854388553885638857388583885938860388613886238863388643886538866388673886838869388703887138872388733887438875388763887738878388793888038881388823888338884388853888638887388883888938890388913889238893388943889538896388973889838899389003890138902389033890438905389063890738908389093891038911389123891338914389153891638917389183891938920389213892238923389243892538926389273892838929389303893138932389333893438935389363893738938389393894038941389423894338944389453894638947389483894938950389513895238953389543895538956389573895838959389603896138962389633896438965389663896738968389693897038971389723897338974389753897638977389783897938980389813898238983389843898538986389873898838989389903899138992389933899438995389963899738998389993900039001390023900339004390053900639007390083900939010390113901239013390143901539016390173901839019390203902139022390233902439025390263902739028390293903039031390323903339034390353903639037390383903939040390413904239043390443904539046390473904839049390503905139052390533905439055390563905739058390593906039061390623906339064390653906639067390683906939070390713907239073390743907539076390773907839079390803908139082390833908439085390863908739088390893909039091390923909339094390953909639097390983909939100391013910239103391043910539106391073910839109391103911139112391133911439115391163911739118391193912039121391223912339124391253912639127391283912939130391313913239133391343913539136391373913839139391403914139142391433914439145391463914739148391493915039151391523915339154391553915639157391583915939160391613916239163391643916539166391673916839169391703917139172391733917439175391763917739178391793918039181391823918339184391853918639187391883918939190391913919239193391943919539196391973919839199392003920139202392033920439205392063920739208392093921039211392123921339214392153921639217392183921939220392213922239223392243922539226392273922839229392303923139232392333923439235392363923739238392393924039241392423924339244392453924639247392483924939250392513925239253392543925539256392573925839259392603926139262392633926439265392663926739268392693927039271392723927339274392753927639277392783927939280392813928239283392843928539286392873928839289392903929139292392933929439295392963929739298392993930039301393023930339304393053930639307393083930939310393113931239313393143931539316393173931839319393203932139322393233932439325393263932739328393293933039331393323933339334393353933639337393383933939340393413934239343393443934539346393473934839349393503935139352393533935439355393563935739358393593936039361393623936339364393653936639367393683936939370393713937239373393743937539376393773937839379393803938139382393833938439385393863938739388393893939039391393923939339394393953939639397393983939939400394013940239403394043940539406394073940839409394103941139412394133941439415394163941739418394193942039421394223942339424394253942639427394283942939430394313943239433394343943539436394373943839439394403944139442394433944439445394463944739448394493945039451394523945339454394553945639457394583945939460394613946239463394643946539466394673946839469394703947139472394733947439475394763947739478394793948039481394823948339484394853948639487394883948939490394913949239493394943949539496394973949839499395003950139502395033950439505395063950739508395093951039511395123951339514395153951639517395183951939520395213952239523395243952539526395273952839529395303953139532395333953439535395363953739538395393954039541395423954339544395453954639547395483954939550395513955239553395543955539556395573955839559395603956139562395633956439565395663956739568395693957039571395723957339574395753957639577395783957939580395813958239583395843958539586395873958839589395903959139592395933959439595395963959739598395993960039601396023960339604396053960639607396083960939610396113961239613396143961539616396173961839619396203962139622396233962439625396263962739628396293963039631396323963339634396353963639637396383963939640396413964239643396443964539646396473964839649396503965139652396533965439655396563965739658396593966039661396623966339664396653966639667396683966939670396713967239673396743967539676396773967839679396803968139682396833968439685396863968739688396893969039691396923969339694396953969639697396983969939700397013970239703397043970539706397073970839709397103971139712397133971439715397163971739718397193972039721397223972339724397253972639727397283972939730397313973239733397343973539736397373973839739397403974139742397433974439745397463974739748397493975039751397523975339754397553975639757397583975939760397613976239763397643976539766397673976839769397703977139772397733977439775397763977739778397793978039781397823978339784397853978639787397883978939790397913979239793397943979539796397973979839799398003980139802398033980439805398063980739808398093981039811398123981339814398153981639817398183981939820398213982239823398243982539826398273982839829398303983139832398333983439835398363983739838398393984039841398423984339844398453984639847398483984939850398513985239853398543985539856398573985839859398603986139862398633986439865398663986739868398693987039871398723987339874398753987639877398783987939880398813988239883398843988539886398873988839889398903989139892398933989439895398963989739898398993990039901399023990339904399053990639907399083990939910399113991239913399143991539916399173991839919399203992139922399233992439925399263992739928399293993039931399323993339934399353993639937399383993939940399413994239943399443994539946399473994839949399503995139952399533995439955399563995739958399593996039961399623996339964399653996639967399683996939970399713997239973399743997539976399773997839979399803998139982399833998439985399863998739988399893999039991399923999339994399953999639997399983999940000400014000240003400044000540006400074000840009400104001140012400134001440015400164001740018400194002040021400224002340024400254002640027400284002940030400314003240033400344003540036400374003840039400404004140042400434004440045400464004740048400494005040051400524005340054400554005640057400584005940060400614006240063400644006540066400674006840069400704007140072400734007440075400764007740078400794008040081400824008340084400854008640087400884008940090400914009240093400944009540096400974009840099401004010140102401034010440105401064010740108401094011040111401124011340114401154011640117401184011940120401214012240123401244012540126401274012840129401304013140132401334013440135401364013740138401394014040141401424014340144401454014640147401484014940150401514015240153401544015540156401574015840159401604016140162401634016440165401664016740168401694017040171401724017340174401754017640177401784017940180401814018240183401844018540186401874018840189401904019140192401934019440195401964019740198401994020040201402024020340204402054020640207402084020940210402114021240213402144021540216402174021840219402204022140222402234022440225402264022740228402294023040231402324023340234402354023640237402384023940240402414024240243402444024540246402474024840249402504025140252402534025440255402564025740258402594026040261402624026340264402654026640267402684026940270402714027240273402744027540276402774027840279402804028140282402834028440285402864028740288402894029040291402924029340294402954029640297402984029940300403014030240303403044030540306403074030840309403104031140312403134031440315403164031740318403194032040321403224032340324403254032640327403284032940330403314033240333403344033540336403374033840339403404034140342403434034440345403464034740348403494035040351403524035340354403554035640357403584035940360403614036240363403644036540366403674036840369403704037140372403734037440375403764037740378403794038040381403824038340384403854038640387403884038940390403914039240393403944039540396403974039840399404004040140402404034040440405404064040740408404094041040411404124041340414404154041640417404184041940420404214042240423404244042540426404274042840429404304043140432404334043440435404364043740438404394044040441404424044340444404454044640447404484044940450404514045240453404544045540456404574045840459404604046140462404634046440465404664046740468404694047040471404724047340474404754047640477404784047940480404814048240483404844048540486404874048840489404904049140492404934049440495404964049740498404994050040501405024050340504405054050640507405084050940510405114051240513405144051540516405174051840519405204052140522405234052440525405264052740528405294053040531405324053340534405354053640537405384053940540405414054240543405444054540546405474054840549405504055140552405534055440555405564055740558405594056040561405624056340564405654056640567405684056940570405714057240573405744057540576405774057840579405804058140582405834058440585405864058740588405894059040591405924059340594405954059640597405984059940600406014060240603406044060540606406074060840609406104061140612406134061440615406164061740618406194062040621406224062340624406254062640627406284062940630406314063240633406344063540636406374063840639406404064140642406434064440645406464064740648406494065040651406524065340654406554065640657406584065940660406614066240663406644066540666406674066840669406704067140672406734067440675406764067740678406794068040681406824068340684406854068640687406884068940690406914069240693406944069540696406974069840699407004070140702407034070440705407064070740708407094071040711407124071340714407154071640717407184071940720407214072240723407244072540726407274072840729407304073140732407334073440735407364073740738407394074040741407424074340744407454074640747407484074940750407514075240753407544075540756407574075840759407604076140762407634076440765407664076740768407694077040771407724077340774407754077640777407784077940780407814078240783407844078540786407874078840789407904079140792407934079440795407964079740798407994080040801408024080340804408054080640807408084080940810408114081240813408144081540816408174081840819408204082140822408234082440825408264082740828408294083040831408324083340834408354083640837408384083940840408414084240843408444084540846408474084840849408504085140852408534085440855408564085740858408594086040861408624086340864408654086640867408684086940870408714087240873408744087540876408774087840879408804088140882408834088440885408864088740888408894089040891408924089340894408954089640897408984089940900409014090240903409044090540906409074090840909409104091140912409134091440915409164091740918409194092040921409224092340924409254092640927409284092940930409314093240933409344093540936409374093840939409404094140942409434094440945409464094740948409494095040951409524095340954409554095640957409584095940960409614096240963409644096540966409674096840969409704097140972409734097440975409764097740978409794098040981409824098340984409854098640987409884098940990409914099240993409944099540996409974099840999410004100141002410034100441005410064100741008410094101041011410124101341014410154101641017410184101941020410214102241023410244102541026410274102841029410304103141032410334103441035410364103741038410394104041041410424104341044410454104641047410484104941050410514105241053410544105541056410574105841059410604106141062410634106441065410664106741068410694107041071410724107341074410754107641077410784107941080410814108241083410844108541086410874108841089410904109141092410934109441095410964109741098410994110041101411024110341104411054110641107411084110941110411114111241113411144111541116411174111841119411204112141122411234112441125411264112741128411294113041131411324113341134411354113641137411384113941140411414114241143411444114541146411474114841149411504115141152411534115441155411564115741158411594116041161411624116341164411654116641167411684116941170411714117241173411744117541176411774117841179411804118141182411834118441185411864118741188411894119041191411924119341194411954119641197411984119941200412014120241203412044120541206412074120841209412104121141212412134121441215412164121741218412194122041221412224122341224412254122641227412284122941230412314123241233412344123541236412374123841239412404124141242412434124441245412464124741248412494125041251412524125341254412554125641257412584125941260412614126241263412644126541266412674126841269412704127141272412734127441275412764127741278412794128041281412824128341284412854128641287412884128941290412914129241293412944129541296412974129841299413004130141302413034130441305413064130741308413094131041311413124131341314413154131641317413184131941320413214132241323413244132541326413274132841329413304133141332413334133441335413364133741338413394134041341413424134341344413454134641347413484134941350413514135241353413544135541356413574135841359413604136141362413634136441365413664136741368413694137041371413724137341374413754137641377413784137941380413814138241383413844138541386413874138841389413904139141392413934139441395413964139741398413994140041401414024140341404414054140641407414084140941410414114141241413414144141541416414174141841419414204142141422414234142441425414264142741428414294143041431414324143341434414354143641437414384143941440414414144241443414444144541446414474144841449414504145141452414534145441455414564145741458414594146041461414624146341464414654146641467414684146941470414714147241473414744147541476414774147841479414804148141482414834148441485414864148741488414894149041491414924149341494414954149641497414984149941500415014150241503415044150541506415074150841509415104151141512415134151441515415164151741518415194152041521415224152341524415254152641527415284152941530415314153241533415344153541536415374153841539415404154141542415434154441545415464154741548415494155041551415524155341554415554155641557415584155941560415614156241563415644156541566415674156841569415704157141572415734157441575415764157741578415794158041581415824158341584415854158641587415884158941590415914159241593415944159541596415974159841599416004160141602416034160441605416064160741608416094161041611416124161341614416154161641617416184161941620416214162241623416244162541626416274162841629416304163141632416334163441635416364163741638416394164041641416424164341644416454164641647416484164941650416514165241653416544165541656416574165841659416604166141662416634166441665416664166741668416694167041671416724167341674416754167641677416784167941680416814168241683416844168541686416874168841689416904169141692416934169441695416964169741698416994170041701417024170341704417054170641707417084170941710417114171241713417144171541716417174171841719417204172141722417234172441725417264172741728417294173041731417324173341734417354173641737417384173941740417414174241743417444174541746417474174841749417504175141752417534175441755417564175741758417594176041761417624176341764417654176641767417684176941770417714177241773417744177541776417774177841779417804178141782417834178441785417864178741788417894179041791417924179341794417954179641797417984179941800418014180241803418044180541806418074180841809418104181141812418134181441815418164181741818418194182041821418224182341824418254182641827418284182941830418314183241833418344183541836418374183841839418404184141842418434184441845418464184741848418494185041851418524185341854418554185641857418584185941860418614186241863418644186541866418674186841869418704187141872418734187441875418764187741878418794188041881418824188341884418854188641887418884188941890418914189241893418944189541896418974189841899419004190141902419034190441905419064190741908419094191041911419124191341914419154191641917419184191941920419214192241923419244192541926419274192841929419304193141932419334193441935419364193741938419394194041941419424194341944419454194641947419484194941950419514195241953419544195541956419574195841959419604196141962419634196441965419664196741968419694197041971419724197341974419754197641977419784197941980419814198241983419844198541986419874198841989419904199141992419934199441995419964199741998419994200042001420024200342004420054200642007420084200942010420114201242013420144201542016420174201842019420204202142022420234202442025420264202742028420294203042031420324203342034420354203642037420384203942040420414204242043420444204542046420474204842049420504205142052420534205442055420564205742058420594206042061420624206342064420654206642067420684206942070420714207242073420744207542076420774207842079420804208142082420834208442085420864208742088420894209042091420924209342094420954209642097420984209942100421014210242103421044210542106421074210842109421104211142112421134211442115421164211742118421194212042121421224212342124421254212642127421284212942130421314213242133421344213542136421374213842139421404214142142421434214442145421464214742148421494215042151421524215342154421554215642157421584215942160421614216242163421644216542166421674216842169421704217142172421734217442175421764217742178421794218042181421824218342184421854218642187421884218942190421914219242193421944219542196421974219842199422004220142202422034220442205422064220742208422094221042211422124221342214422154221642217422184221942220422214222242223422244222542226422274222842229422304223142232422334223442235422364223742238422394224042241422424224342244422454224642247422484224942250422514225242253422544225542256422574225842259422604226142262422634226442265422664226742268422694227042271422724227342274422754227642277422784227942280422814228242283422844228542286422874228842289422904229142292422934229442295422964229742298422994230042301423024230342304423054230642307423084230942310423114231242313423144231542316423174231842319423204232142322423234232442325423264232742328423294233042331423324233342334423354233642337423384233942340423414234242343423444234542346423474234842349423504235142352423534235442355423564235742358423594236042361423624236342364423654236642367423684236942370423714237242373423744237542376423774237842379423804238142382423834238442385423864238742388423894239042391423924239342394423954239642397423984239942400424014240242403424044240542406424074240842409424104241142412424134241442415424164241742418424194242042421424224242342424424254242642427424284242942430424314243242433424344243542436424374243842439424404244142442424434244442445424464244742448424494245042451424524245342454424554245642457424584245942460424614246242463424644246542466424674246842469424704247142472424734247442475424764247742478424794248042481424824248342484424854248642487424884248942490424914249242493424944249542496424974249842499425004250142502425034250442505425064250742508425094251042511425124251342514425154251642517425184251942520425214252242523425244252542526425274252842529425304253142532425334253442535425364253742538425394254042541425424254342544425454254642547425484254942550425514255242553425544255542556425574255842559425604256142562425634256442565425664256742568425694257042571425724257342574425754257642577425784257942580425814258242583425844258542586425874258842589425904259142592425934259442595425964259742598425994260042601426024260342604426054260642607426084260942610426114261242613426144261542616426174261842619426204262142622426234262442625426264262742628426294263042631426324263342634426354263642637426384263942640426414264242643426444264542646426474264842649426504265142652426534265442655426564265742658426594266042661426624266342664426654266642667426684266942670426714267242673426744267542676426774267842679426804268142682426834268442685426864268742688426894269042691426924269342694426954269642697426984269942700427014270242703427044270542706427074270842709427104271142712427134271442715427164271742718427194272042721427224272342724427254272642727427284272942730427314273242733427344273542736427374273842739427404274142742427434274442745427464274742748427494275042751427524275342754427554275642757427584275942760427614276242763427644276542766427674276842769427704277142772427734277442775427764277742778427794278042781427824278342784427854278642787427884278942790427914279242793427944279542796427974279842799428004280142802428034280442805428064280742808428094281042811428124281342814428154281642817428184281942820428214282242823428244282542826428274282842829428304283142832428334283442835428364283742838428394284042841428424284342844428454284642847428484284942850428514285242853428544285542856428574285842859428604286142862428634286442865428664286742868428694287042871428724287342874428754287642877428784287942880428814288242883428844288542886428874288842889428904289142892428934289442895428964289742898428994290042901429024290342904429054290642907429084290942910429114291242913429144291542916429174291842919429204292142922429234292442925429264292742928429294293042931429324293342934429354293642937429384293942940429414294242943429444294542946429474294842949429504295142952429534295442955429564295742958429594296042961429624296342964429654296642967429684296942970429714297242973429744297542976429774297842979429804298142982429834298442985429864298742988429894299042991429924299342994429954299642997429984299943000430014300243003430044300543006430074300843009430104301143012430134301443015430164301743018430194302043021430224302343024430254302643027430284302943030430314303243033430344303543036430374303843039430404304143042430434304443045430464304743048430494305043051430524305343054430554305643057430584305943060430614306243063430644306543066430674306843069430704307143072430734307443075430764307743078430794308043081430824308343084430854308643087430884308943090430914309243093430944309543096430974309843099431004310143102431034310443105431064310743108431094311043111431124311343114431154311643117431184311943120431214312243123431244312543126431274312843129431304313143132431334313443135431364313743138431394314043141431424314343144431454314643147431484314943150431514315243153431544315543156431574315843159431604316143162431634316443165431664316743168431694317043171431724317343174431754317643177431784317943180431814318243183431844318543186431874318843189431904319143192431934319443195431964319743198431994320043201432024320343204432054320643207432084320943210432114321243213432144321543216432174321843219432204322143222432234322443225432264322743228432294323043231432324323343234432354323643237432384323943240432414324243243432444324543246432474324843249432504325143252432534325443255432564325743258432594326043261432624326343264432654326643267432684326943270432714327243273432744327543276432774327843279432804328143282432834328443285432864328743288432894329043291432924329343294432954329643297432984329943300433014330243303433044330543306433074330843309433104331143312433134331443315433164331743318433194332043321433224332343324433254332643327433284332943330433314333243333433344333543336433374333843339433404334143342433434334443345433464334743348433494335043351433524335343354433554335643357433584335943360433614336243363433644336543366433674336843369433704337143372433734337443375433764337743378433794338043381433824338343384433854338643387433884338943390433914339243393433944339543396433974339843399434004340143402434034340443405434064340743408434094341043411434124341343414434154341643417434184341943420434214342243423434244342543426434274342843429434304343143432434334343443435434364343743438434394344043441434424344343444434454344643447434484344943450434514345243453434544345543456434574345843459434604346143462434634346443465434664346743468434694347043471434724347343474434754347643477434784347943480434814348243483434844348543486434874348843489434904349143492434934349443495434964349743498434994350043501435024350343504435054350643507435084350943510435114351243513435144351543516435174351843519435204352143522435234352443525435264352743528435294353043531435324353343534435354353643537435384353943540435414354243543435444354543546435474354843549435504355143552435534355443555435564355743558435594356043561435624356343564435654356643567435684356943570435714357243573435744357543576435774357843579435804358143582435834358443585435864358743588435894359043591435924359343594435954359643597435984359943600436014360243603436044360543606436074360843609436104361143612436134361443615436164361743618436194362043621436224362343624436254362643627436284362943630436314363243633436344363543636436374363843639436404364143642436434364443645436464364743648436494365043651436524365343654436554365643657436584365943660436614366243663436644366543666436674366843669436704367143672436734367443675436764367743678436794368043681436824368343684436854368643687436884368943690436914369243693436944369543696436974369843699437004370143702437034370443705437064370743708437094371043711437124371343714437154371643717437184371943720437214372243723437244372543726437274372843729437304373143732437334373443735437364373743738437394374043741437424374343744437454374643747437484374943750437514375243753437544375543756437574375843759437604376143762437634376443765437664376743768437694377043771437724377343774437754377643777437784377943780437814378243783437844378543786437874378843789437904379143792437934379443795437964379743798437994380043801438024380343804438054380643807438084380943810438114381243813438144381543816438174381843819438204382143822438234382443825438264382743828438294383043831438324383343834438354383643837438384383943840438414384243843438444384543846438474384843849438504385143852438534385443855438564385743858438594386043861438624386343864438654386643867438684386943870438714387243873438744387543876438774387843879438804388143882438834388443885438864388743888438894389043891438924389343894438954389643897438984389943900439014390243903439044390543906439074390843909439104391143912439134391443915439164391743918439194392043921439224392343924439254392643927439284392943930439314393243933439344393543936439374393843939439404394143942439434394443945439464394743948439494395043951439524395343954439554395643957439584395943960439614396243963439644396543966439674396843969439704397143972439734397443975439764397743978439794398043981439824398343984439854398643987439884398943990439914399243993439944399543996439974399843999440004400144002440034400444005440064400744008440094401044011440124401344014440154401644017440184401944020440214402244023440244402544026440274402844029440304403144032440334403444035440364403744038440394404044041440424404344044440454404644047440484404944050440514405244053440544405544056440574405844059440604406144062440634406444065440664406744068440694407044071440724407344074440754407644077440784407944080440814408244083440844408544086440874408844089440904409144092440934409444095440964409744098440994410044101441024410344104441054410644107441084410944110441114411244113441144411544116441174411844119441204412144122441234412444125441264412744128441294413044131441324413344134441354413644137441384413944140441414414244143441444414544146441474414844149441504415144152441534415444155441564415744158441594416044161441624416344164441654416644167441684416944170441714417244173441744417544176441774417844179441804418144182441834418444185441864418744188441894419044191441924419344194441954419644197441984419944200442014420244203442044420544206442074420844209442104421144212442134421444215442164421744218442194422044221442224422344224442254422644227442284422944230442314423244233442344423544236442374423844239442404424144242442434424444245442464424744248442494425044251442524425344254442554425644257442584425944260442614426244263442644426544266442674426844269442704427144272442734427444275442764427744278442794428044281442824428344284442854428644287442884428944290442914429244293442944429544296442974429844299443004430144302443034430444305443064430744308443094431044311443124431344314443154431644317443184431944320443214432244323443244432544326443274432844329443304433144332443334433444335443364433744338443394434044341443424434344344443454434644347443484434944350443514435244353443544435544356443574435844359443604436144362443634436444365443664436744368443694437044371443724437344374443754437644377443784437944380443814438244383443844438544386443874438844389443904439144392443934439444395443964439744398443994440044401444024440344404444054440644407444084440944410444114441244413444144441544416444174441844419444204442144422444234442444425444264442744428444294443044431444324443344434444354443644437444384443944440444414444244443444444444544446444474444844449444504445144452444534445444455444564445744458444594446044461444624446344464444654446644467444684446944470444714447244473444744447544476444774447844479444804448144482444834448444485444864448744488444894449044491444924449344494444954449644497444984449944500445014450244503445044450544506445074450844509445104451144512445134451444515445164451744518445194452044521445224452344524445254452644527445284452944530445314453244533445344453544536445374453844539445404454144542445434454444545445464454744548445494455044551445524455344554445554455644557445584455944560445614456244563445644456544566445674456844569445704457144572445734457444575445764457744578445794458044581445824458344584445854458644587445884458944590445914459244593445944459544596445974459844599446004460144602446034460444605446064460744608446094461044611446124461344614446154461644617446184461944620446214462244623446244462544626446274462844629446304463144632446334463444635446364463744638446394464044641446424464344644446454464644647446484464944650446514465244653446544465544656446574465844659446604466144662446634466444665446664466744668446694467044671446724467344674446754467644677446784467944680446814468244683446844468544686446874468844689446904469144692446934469444695446964469744698446994470044701447024470344704447054470644707447084470944710447114471244713447144471544716447174471844719447204472144722447234472444725447264472744728447294473044731447324473344734447354473644737447384473944740447414474244743447444474544746447474474844749447504475144752447534475444755447564475744758447594476044761447624476344764447654476644767447684476944770447714477244773447744477544776447774477844779447804478144782447834478444785447864478744788447894479044791447924479344794447954479644797447984479944800448014480244803448044480544806448074480844809448104481144812448134481444815448164481744818448194482044821448224482344824448254482644827448284482944830448314483244833448344483544836448374483844839448404484144842448434484444845448464484744848448494485044851448524485344854448554485644857448584485944860448614486244863448644486544866448674486844869448704487144872448734487444875448764487744878448794488044881448824488344884448854488644887448884488944890448914489244893448944489544896448974489844899449004490144902449034490444905449064490744908449094491044911449124491344914449154491644917449184491944920449214492244923449244492544926449274492844929449304493144932449334493444935449364493744938449394494044941449424494344944449454494644947449484494944950449514495244953449544495544956449574495844959449604496144962449634496444965449664496744968449694497044971449724497344974449754497644977449784497944980449814498244983449844498544986449874498844989449904499144992449934499444995449964499744998449994500045001450024500345004450054500645007450084500945010450114501245013450144501545016450174501845019450204502145022450234502445025450264502745028450294503045031450324503345034450354503645037450384503945040450414504245043450444504545046450474504845049450504505145052450534505445055450564505745058450594506045061450624506345064450654506645067450684506945070450714507245073450744507545076450774507845079450804508145082450834508445085450864508745088450894509045091450924509345094450954509645097450984509945100451014510245103451044510545106451074510845109451104511145112451134511445115451164511745118451194512045121451224512345124451254512645127451284512945130451314513245133451344513545136451374513845139451404514145142451434514445145451464514745148451494515045151451524515345154451554515645157451584515945160451614516245163451644516545166451674516845169451704517145172451734517445175451764517745178451794518045181451824518345184451854518645187451884518945190451914519245193451944519545196451974519845199452004520145202452034520445205452064520745208452094521045211452124521345214452154521645217452184521945220452214522245223452244522545226452274522845229452304523145232452334523445235452364523745238452394524045241452424524345244452454524645247452484524945250452514525245253452544525545256452574525845259452604526145262452634526445265452664526745268452694527045271452724527345274452754527645277452784527945280452814528245283452844528545286452874528845289452904529145292452934529445295452964529745298452994530045301453024530345304453054530645307453084530945310453114531245313453144531545316453174531845319453204532145322453234532445325453264532745328453294533045331453324533345334453354533645337453384533945340453414534245343453444534545346453474534845349453504535145352453534535445355453564535745358453594536045361453624536345364453654536645367453684536945370453714537245373453744537545376453774537845379453804538145382453834538445385453864538745388453894539045391453924539345394453954539645397453984539945400454014540245403454044540545406454074540845409454104541145412454134541445415454164541745418454194542045421454224542345424454254542645427454284542945430454314543245433454344543545436454374543845439454404544145442454434544445445454464544745448454494545045451454524545345454454554545645457454584545945460454614546245463454644546545466454674546845469454704547145472454734547445475454764547745478454794548045481454824548345484454854548645487454884548945490454914549245493454944549545496454974549845499455004550145502455034550445505455064550745508455094551045511455124551345514455154551645517455184551945520455214552245523455244552545526455274552845529455304553145532455334553445535455364553745538455394554045541455424554345544455454554645547455484554945550455514555245553455544555545556455574555845559455604556145562455634556445565455664556745568455694557045571455724557345574455754557645577455784557945580455814558245583455844558545586455874558845589455904559145592455934559445595455964559745598455994560045601456024560345604456054560645607456084560945610456114561245613456144561545616456174561845619456204562145622456234562445625456264562745628456294563045631456324563345634456354563645637456384563945640456414564245643456444564545646456474564845649456504565145652456534565445655456564565745658456594566045661456624566345664456654566645667456684566945670456714567245673456744567545676456774567845679456804568145682456834568445685456864568745688456894569045691456924569345694456954569645697456984569945700457014570245703457044570545706457074570845709457104571145712457134571445715457164571745718457194572045721457224572345724457254572645727457284572945730457314573245733457344573545736457374573845739457404574145742457434574445745457464574745748457494575045751457524575345754457554575645757457584575945760457614576245763457644576545766457674576845769457704577145772457734577445775457764577745778457794578045781457824578345784457854578645787457884578945790457914579245793457944579545796457974579845799458004580145802458034580445805458064580745808458094581045811458124581345814458154581645817458184581945820458214582245823458244582545826458274582845829458304583145832458334583445835458364583745838458394584045841458424584345844458454584645847458484584945850458514585245853458544585545856458574585845859458604586145862458634586445865458664586745868458694587045871458724587345874458754587645877458784587945880458814588245883458844588545886458874588845889458904589145892458934589445895458964589745898458994590045901459024590345904459054590645907459084590945910459114591245913459144591545916459174591845919459204592145922459234592445925459264592745928459294593045931459324593345934459354593645937459384593945940459414594245943459444594545946459474594845949459504595145952459534595445955459564595745958459594596045961459624596345964459654596645967459684596945970459714597245973459744597545976459774597845979459804598145982459834598445985459864598745988459894599045991459924599345994459954599645997459984599946000460014600246003460044600546006460074600846009460104601146012460134601446015460164601746018460194602046021460224602346024460254602646027460284602946030460314603246033460344603546036460374603846039460404604146042460434604446045460464604746048460494605046051460524605346054460554605646057460584605946060460614606246063460644606546066460674606846069460704607146072460734607446075460764607746078460794608046081460824608346084460854608646087460884608946090460914609246093460944609546096460974609846099461004610146102461034610446105461064610746108461094611046111461124611346114461154611646117461184611946120461214612246123461244612546126461274612846129461304613146132461334613446135461364613746138461394614046141461424614346144461454614646147461484614946150461514615246153461544615546156461574615846159461604616146162461634616446165461664616746168461694617046171461724617346174461754617646177461784617946180461814618246183461844618546186461874618846189461904619146192461934619446195461964619746198461994620046201462024620346204462054620646207462084620946210462114621246213462144621546216462174621846219462204622146222462234622446225462264622746228462294623046231462324623346234462354623646237462384623946240462414624246243462444624546246462474624846249462504625146252462534625446255462564625746258462594626046261462624626346264462654626646267462684626946270462714627246273462744627546276462774627846279462804628146282462834628446285462864628746288462894629046291462924629346294462954629646297462984629946300463014630246303463044630546306463074630846309463104631146312463134631446315463164631746318463194632046321463224632346324463254632646327463284632946330463314633246333463344633546336463374633846339463404634146342463434634446345463464634746348463494635046351463524635346354463554635646357463584635946360463614636246363463644636546366463674636846369463704637146372463734637446375463764637746378463794638046381463824638346384463854638646387463884638946390463914639246393463944639546396463974639846399464004640146402464034640446405464064640746408464094641046411464124641346414464154641646417464184641946420464214642246423464244642546426464274642846429464304643146432464334643446435464364643746438464394644046441464424644346444464454644646447464484644946450464514645246453464544645546456464574645846459464604646146462464634646446465464664646746468464694647046471464724647346474464754647646477464784647946480464814648246483464844648546486464874648846489464904649146492464934649446495464964649746498464994650046501465024650346504465054650646507465084650946510465114651246513465144651546516465174651846519465204652146522465234652446525465264652746528465294653046531465324653346534465354653646537465384653946540465414654246543465444654546546465474654846549465504655146552465534655446555465564655746558465594656046561465624656346564465654656646567465684656946570465714657246573465744657546576465774657846579465804658146582465834658446585465864658746588465894659046591465924659346594465954659646597465984659946600466014660246603466044660546606466074660846609466104661146612466134661446615466164661746618466194662046621466224662346624466254662646627466284662946630466314663246633466344663546636466374663846639466404664146642466434664446645466464664746648466494665046651466524665346654466554665646657466584665946660466614666246663466644666546666466674666846669466704667146672466734667446675466764667746678466794668046681466824668346684466854668646687466884668946690466914669246693466944669546696466974669846699467004670146702467034670446705467064670746708467094671046711467124671346714467154671646717467184671946720467214672246723467244672546726467274672846729467304673146732467334673446735467364673746738467394674046741467424674346744467454674646747467484674946750467514675246753467544675546756467574675846759467604676146762467634676446765467664676746768467694677046771467724677346774467754677646777467784677946780467814678246783467844678546786467874678846789467904679146792467934679446795467964679746798467994680046801468024680346804468054680646807468084680946810468114681246813468144681546816468174681846819468204682146822468234682446825468264682746828468294683046831468324683346834468354683646837468384683946840468414684246843468444684546846468474684846849468504685146852468534685446855468564685746858468594686046861468624686346864468654686646867468684686946870468714687246873468744687546876468774687846879468804688146882468834688446885468864688746888468894689046891468924689346894468954689646897468984689946900469014690246903469044690546906469074690846909469104691146912469134691446915469164691746918469194692046921469224692346924469254692646927469284692946930469314693246933469344693546936469374693846939469404694146942469434694446945469464694746948469494695046951469524695346954469554695646957469584695946960469614696246963469644696546966469674696846969469704697146972469734697446975469764697746978469794698046981469824698346984469854698646987469884698946990469914699246993469944699546996469974699846999470004700147002470034700447005470064700747008470094701047011470124701347014470154701647017470184701947020470214702247023470244702547026470274702847029470304703147032470334703447035470364703747038470394704047041470424704347044470454704647047470484704947050470514705247053470544705547056470574705847059470604706147062470634706447065470664706747068470694707047071470724707347074470754707647077470784707947080470814708247083470844708547086470874708847089470904709147092470934709447095470964709747098470994710047101471024710347104471054710647107471084710947110471114711247113471144711547116471174711847119471204712147122471234712447125471264712747128471294713047131471324713347134471354713647137471384713947140471414714247143471444714547146471474714847149471504715147152471534715447155471564715747158471594716047161471624716347164471654716647167471684716947170471714717247173471744717547176471774717847179471804718147182471834718447185471864718747188471894719047191471924719347194471954719647197471984719947200472014720247203472044720547206472074720847209472104721147212472134721447215472164721747218472194722047221472224722347224472254722647227472284722947230472314723247233472344723547236472374723847239472404724147242472434724447245472464724747248472494725047251472524725347254472554725647257472584725947260472614726247263472644726547266472674726847269472704727147272472734727447275472764727747278472794728047281472824728347284472854728647287472884728947290472914729247293472944729547296472974729847299473004730147302473034730447305473064730747308473094731047311473124731347314473154731647317473184731947320473214732247323473244732547326473274732847329473304733147332473334733447335473364733747338473394734047341473424734347344473454734647347473484734947350473514735247353473544735547356473574735847359473604736147362473634736447365473664736747368473694737047371473724737347374473754737647377473784737947380473814738247383473844738547386473874738847389473904739147392473934739447395473964739747398473994740047401474024740347404474054740647407474084740947410474114741247413474144741547416474174741847419474204742147422474234742447425474264742747428474294743047431474324743347434474354743647437474384743947440474414744247443474444744547446474474744847449474504745147452474534745447455474564745747458474594746047461474624746347464474654746647467474684746947470474714747247473474744747547476474774747847479474804748147482474834748447485474864748747488474894749047491474924749347494474954749647497474984749947500475014750247503475044750547506475074750847509475104751147512475134751447515475164751747518475194752047521475224752347524475254752647527475284752947530475314753247533475344753547536475374753847539475404754147542475434754447545475464754747548475494755047551475524755347554475554755647557475584755947560475614756247563475644756547566475674756847569475704757147572475734757447575475764757747578475794758047581475824758347584475854758647587475884758947590475914759247593475944759547596475974759847599476004760147602476034760447605476064760747608476094761047611476124761347614476154761647617476184761947620476214762247623476244762547626476274762847629476304763147632476334763447635476364763747638476394764047641476424764347644476454764647647476484764947650476514765247653476544765547656476574765847659476604766147662476634766447665476664766747668476694767047671476724767347674476754767647677476784767947680476814768247683476844768547686476874768847689476904769147692476934769447695476964769747698476994770047701477024770347704477054770647707477084770947710477114771247713477144771547716477174771847719477204772147722477234772447725477264772747728477294773047731477324773347734477354773647737477384773947740477414774247743477444774547746477474774847749477504775147752477534775447755477564775747758477594776047761477624776347764477654776647767477684776947770477714777247773477744777547776477774777847779477804778147782477834778447785477864778747788477894779047791477924779347794477954779647797477984779947800478014780247803478044780547806478074780847809478104781147812478134781447815478164781747818478194782047821478224782347824478254782647827478284782947830478314783247833478344783547836478374783847839478404784147842478434784447845478464784747848478494785047851478524785347854478554785647857478584785947860478614786247863478644786547866478674786847869478704787147872478734787447875478764787747878478794788047881478824788347884478854788647887478884788947890478914789247893478944789547896478974789847899479004790147902479034790447905479064790747908479094791047911479124791347914479154791647917479184791947920479214792247923479244792547926479274792847929479304793147932479334793447935479364793747938479394794047941479424794347944479454794647947479484794947950479514795247953479544795547956479574795847959479604796147962479634796447965479664796747968479694797047971479724797347974479754797647977479784797947980479814798247983479844798547986479874798847989479904799147992479934799447995479964799747998479994800048001480024800348004480054800648007480084800948010480114801248013480144801548016480174801848019480204802148022480234802448025480264802748028480294803048031480324803348034480354803648037480384803948040480414804248043480444804548046480474804848049480504805148052480534805448055480564805748058480594806048061480624806348064480654806648067480684806948070480714807248073480744807548076480774807848079480804808148082480834808448085480864808748088480894809048091480924809348094480954809648097480984809948100481014810248103481044810548106481074810848109481104811148112481134811448115481164811748118481194812048121481224812348124481254812648127481284812948130481314813248133481344813548136481374813848139481404814148142481434814448145481464814748148481494815048151481524815348154481554815648157481584815948160481614816248163481644816548166481674816848169481704817148172481734817448175481764817748178481794818048181481824818348184481854818648187481884818948190481914819248193481944819548196481974819848199482004820148202482034820448205482064820748208482094821048211482124821348214482154821648217482184821948220482214822248223482244822548226482274822848229482304823148232482334823448235482364823748238482394824048241482424824348244482454824648247482484824948250482514825248253482544825548256482574825848259482604826148262482634826448265482664826748268482694827048271482724827348274482754827648277482784827948280482814828248283482844828548286482874828848289482904829148292482934829448295482964829748298482994830048301483024830348304483054830648307483084830948310483114831248313483144831548316483174831848319483204832148322483234832448325483264832748328483294833048331483324833348334483354833648337483384833948340483414834248343483444834548346483474834848349483504835148352483534835448355483564835748358483594836048361483624836348364483654836648367483684836948370483714837248373483744837548376483774837848379483804838148382483834838448385483864838748388483894839048391483924839348394483954839648397483984839948400484014840248403484044840548406484074840848409484104841148412484134841448415484164841748418484194842048421484224842348424484254842648427484284842948430484314843248433484344843548436484374843848439484404844148442484434844448445484464844748448484494845048451484524845348454484554845648457484584845948460484614846248463484644846548466484674846848469484704847148472484734847448475484764847748478484794848048481484824848348484484854848648487484884848948490484914849248493484944849548496484974849848499485004850148502485034850448505485064850748508485094851048511485124851348514485154851648517485184851948520485214852248523485244852548526485274852848529485304853148532485334853448535485364853748538485394854048541485424854348544485454854648547485484854948550485514855248553485544855548556485574855848559485604856148562485634856448565485664856748568485694857048571485724857348574485754857648577485784857948580485814858248583485844858548586485874858848589485904859148592485934859448595485964859748598485994860048601486024860348604486054860648607486084860948610486114861248613486144861548616486174861848619486204862148622486234862448625486264862748628486294863048631486324863348634486354863648637486384863948640486414864248643486444864548646486474864848649486504865148652486534865448655486564865748658486594866048661486624866348664486654866648667486684866948670486714867248673486744867548676486774867848679486804868148682486834868448685486864868748688486894869048691486924869348694486954869648697486984869948700487014870248703487044870548706487074870848709487104871148712487134871448715487164871748718487194872048721487224872348724487254872648727487284872948730487314873248733487344873548736487374873848739487404874148742487434874448745487464874748748487494875048751487524875348754487554875648757487584875948760487614876248763487644876548766487674876848769487704877148772487734877448775487764877748778487794878048781487824878348784487854878648787487884878948790487914879248793487944879548796487974879848799488004880148802488034880448805488064880748808488094881048811488124881348814488154881648817488184881948820488214882248823488244882548826488274882848829488304883148832488334883448835488364883748838488394884048841488424884348844488454884648847488484884948850488514885248853488544885548856488574885848859488604886148862488634886448865488664886748868488694887048871488724887348874488754887648877488784887948880488814888248883488844888548886488874888848889488904889148892488934889448895488964889748898488994890048901489024890348904489054890648907489084890948910489114891248913489144891548916489174891848919489204892148922489234892448925489264892748928489294893048931489324893348934489354893648937489384893948940489414894248943489444894548946489474894848949489504895148952489534895448955489564895748958489594896048961489624896348964489654896648967489684896948970489714897248973489744897548976489774897848979489804898148982489834898448985489864898748988489894899048991489924899348994489954899648997489984899949000490014900249003490044900549006490074900849009490104901149012490134901449015490164901749018490194902049021490224902349024490254902649027490284902949030490314903249033490344903549036490374903849039490404904149042490434904449045490464904749048490494905049051490524905349054490554905649057490584905949060490614906249063490644906549066490674906849069490704907149072490734907449075490764907749078490794908049081490824908349084490854908649087490884908949090490914909249093490944909549096490974909849099491004910149102491034910449105491064910749108491094911049111491124911349114491154911649117491184911949120491214912249123491244912549126491274912849129491304913149132491334913449135491364913749138491394914049141491424914349144491454914649147491484914949150491514915249153491544915549156491574915849159491604916149162491634916449165491664916749168491694917049171491724917349174491754917649177491784917949180491814918249183491844918549186491874918849189491904919149192491934919449195491964919749198491994920049201492024920349204492054920649207492084920949210492114921249213492144921549216492174921849219492204922149222492234922449225492264922749228492294923049231492324923349234492354923649237492384923949240492414924249243492444924549246492474924849249492504925149252492534925449255492564925749258492594926049261492624926349264492654926649267492684926949270492714927249273492744927549276492774927849279492804928149282492834928449285492864928749288492894929049291492924929349294492954929649297492984929949300493014930249303493044930549306493074930849309493104931149312493134931449315493164931749318493194932049321493224932349324493254932649327493284932949330493314933249333493344933549336493374933849339493404934149342493434934449345493464934749348493494935049351493524935349354493554935649357493584935949360493614936249363493644936549366493674936849369493704937149372493734937449375493764937749378493794938049381493824938349384493854938649387493884938949390493914939249393493944939549396493974939849399494004940149402494034940449405494064940749408494094941049411494124941349414494154941649417494184941949420494214942249423494244942549426494274942849429494304943149432494334943449435494364943749438494394944049441494424944349444494454944649447494484944949450494514945249453494544945549456494574945849459494604946149462494634946449465494664946749468494694947049471494724947349474494754947649477494784947949480494814948249483494844948549486494874948849489494904949149492494934949449495494964949749498494994950049501495024950349504495054950649507495084950949510495114951249513495144951549516495174951849519495204952149522495234952449525495264952749528495294953049531495324953349534495354953649537495384953949540495414954249543495444954549546495474954849549495504955149552495534955449555495564955749558495594956049561495624956349564495654956649567495684956949570495714957249573495744957549576495774957849579495804958149582495834958449585495864958749588495894959049591495924959349594495954959649597495984959949600496014960249603496044960549606496074960849609496104961149612496134961449615496164961749618496194962049621496224962349624496254962649627496284962949630496314963249633496344963549636496374963849639496404964149642496434964449645496464964749648496494965049651496524965349654496554965649657496584965949660496614966249663496644966549666496674966849669496704967149672496734967449675496764967749678496794968049681496824968349684496854968649687496884968949690496914969249693496944969549696496974969849699497004970149702497034970449705497064970749708497094971049711497124971349714497154971649717497184971949720497214972249723497244972549726497274972849729497304973149732497334973449735497364973749738497394974049741497424974349744497454974649747497484974949750497514975249753497544975549756497574975849759497604976149762497634976449765497664976749768497694977049771497724977349774497754977649777497784977949780497814978249783497844978549786497874978849789497904979149792497934979449795497964979749798497994980049801498024980349804498054980649807498084980949810498114981249813498144981549816498174981849819498204982149822498234982449825498264982749828498294983049831498324983349834498354983649837498384983949840498414984249843498444984549846498474984849849498504985149852498534985449855498564985749858498594986049861498624986349864498654986649867498684986949870498714987249873498744987549876498774987849879498804988149882498834988449885498864988749888498894989049891498924989349894498954989649897498984989949900499014990249903499044990549906499074990849909499104991149912499134991449915499164991749918499194992049921499224992349924499254992649927499284992949930499314993249933499344993549936499374993849939499404994149942499434994449945499464994749948499494995049951499524995349954499554995649957499584995949960499614996249963499644996549966499674996849969499704997149972499734997449975499764997749978499794998049981499824998349984499854998649987499884998949990499914999249993499944999549996499974999849999500005000150002500035000450005500065000750008500095001050011500125001350014500155001650017500185001950020500215002250023500245002550026500275002850029500305003150032500335003450035500365003750038500395004050041500425004350044500455004650047500485004950050500515005250053500545005550056500575005850059500605006150062500635006450065500665006750068500695007050071500725007350074500755007650077500785007950080500815008250083500845008550086500875008850089500905009150092500935009450095500965009750098500995010050101501025010350104501055010650107501085010950110501115011250113501145011550116501175011850119501205012150122501235012450125501265012750128501295013050131501325013350134501355013650137501385013950140501415014250143501445014550146501475014850149501505015150152501535015450155501565015750158501595016050161501625016350164501655016650167501685016950170501715017250173501745017550176501775017850179501805018150182501835018450185501865018750188501895019050191501925019350194501955019650197501985019950200502015020250203502045020550206502075020850209502105021150212502135021450215502165021750218502195022050221502225022350224502255022650227502285022950230502315023250233502345023550236502375023850239502405024150242502435024450245502465024750248502495025050251502525025350254502555025650257502585025950260502615026250263502645026550266502675026850269502705027150272502735027450275502765027750278502795028050281502825028350284502855028650287502885028950290502915029250293502945029550296502975029850299503005030150302503035030450305503065030750308503095031050311503125031350314503155031650317503185031950320503215032250323503245032550326503275032850329503305033150332503335033450335503365033750338503395034050341503425034350344503455034650347503485034950350503515035250353503545035550356503575035850359503605036150362503635036450365503665036750368503695037050371503725037350374503755037650377503785037950380503815038250383503845038550386503875038850389503905039150392503935039450395503965039750398503995040050401504025040350404504055040650407504085040950410504115041250413504145041550416504175041850419504205042150422504235042450425504265042750428504295043050431504325043350434504355043650437504385043950440504415044250443504445044550446504475044850449504505045150452504535045450455504565045750458504595046050461504625046350464504655046650467504685046950470504715047250473504745047550476504775047850479504805048150482504835048450485504865048750488504895049050491504925049350494504955049650497504985049950500505015050250503505045050550506505075050850509505105051150512505135051450515505165051750518505195052050521505225052350524505255052650527505285052950530505315053250533505345053550536505375053850539505405054150542505435054450545505465054750548505495055050551505525055350554505555055650557505585055950560505615056250563505645056550566505675056850569505705057150572505735057450575505765057750578505795058050581505825058350584505855058650587505885058950590505915059250593505945059550596505975059850599506005060150602506035060450605506065060750608506095061050611506125061350614506155061650617506185061950620506215062250623506245062550626506275062850629506305063150632506335063450635506365063750638506395064050641506425064350644506455064650647506485064950650506515065250653506545065550656506575065850659506605066150662506635066450665506665066750668506695067050671506725067350674506755067650677506785067950680506815068250683506845068550686506875068850689506905069150692506935069450695506965069750698506995070050701507025070350704507055070650707507085070950710507115071250713507145071550716507175071850719507205072150722507235072450725507265072750728507295073050731507325073350734507355073650737507385073950740507415074250743507445074550746507475074850749507505075150752507535075450755507565075750758507595076050761507625076350764507655076650767507685076950770507715077250773507745077550776507775077850779507805078150782507835078450785507865078750788507895079050791507925079350794507955079650797507985079950800508015080250803508045080550806508075080850809508105081150812508135081450815508165081750818508195082050821508225082350824508255082650827508285082950830508315083250833508345083550836508375083850839508405084150842508435084450845508465084750848508495085050851508525085350854508555085650857508585085950860508615086250863508645086550866508675086850869508705087150872508735087450875508765087750878508795088050881508825088350884508855088650887508885088950890508915089250893508945089550896508975089850899509005090150902509035090450905509065090750908509095091050911509125091350914509155091650917509185091950920509215092250923509245092550926509275092850929509305093150932509335093450935509365093750938509395094050941509425094350944509455094650947509485094950950509515095250953509545095550956509575095850959509605096150962509635096450965509665096750968509695097050971509725097350974509755097650977509785097950980509815098250983509845098550986509875098850989509905099150992509935099450995509965099750998509995100051001510025100351004510055100651007510085100951010510115101251013510145101551016510175101851019510205102151022510235102451025510265102751028510295103051031510325103351034510355103651037510385103951040510415104251043510445104551046510475104851049510505105151052510535105451055510565105751058510595106051061510625106351064510655106651067510685106951070510715107251073510745107551076510775107851079510805108151082510835108451085510865108751088510895109051091510925109351094510955109651097510985109951100511015110251103511045110551106511075110851109511105111151112511135111451115511165111751118511195112051121511225112351124511255112651127511285112951130511315113251133511345113551136511375113851139511405114151142511435114451145511465114751148511495115051151511525115351154511555115651157511585115951160511615116251163511645116551166511675116851169511705117151172511735117451175511765117751178511795118051181511825118351184511855118651187511885118951190511915119251193511945119551196511975119851199512005120151202512035120451205512065120751208512095121051211512125121351214512155121651217512185121951220512215122251223512245122551226512275122851229512305123151232512335123451235512365123751238512395124051241512425124351244512455124651247512485124951250512515125251253512545125551256512575125851259512605126151262512635126451265512665126751268512695127051271512725127351274512755127651277512785127951280512815128251283512845128551286512875128851289512905129151292512935129451295512965129751298512995130051301513025130351304513055130651307513085130951310513115131251313513145131551316513175131851319513205132151322513235132451325513265132751328513295133051331513325133351334513355133651337513385133951340513415134251343513445134551346513475134851349513505135151352513535135451355513565135751358513595136051361513625136351364513655136651367513685136951370513715137251373513745137551376513775137851379513805138151382513835138451385513865138751388513895139051391513925139351394513955139651397513985139951400514015140251403514045140551406514075140851409514105141151412514135141451415514165141751418514195142051421514225142351424514255142651427514285142951430514315143251433514345143551436514375143851439514405144151442514435144451445514465144751448514495145051451514525145351454514555145651457514585145951460514615146251463514645146551466514675146851469514705147151472514735147451475514765147751478514795148051481514825148351484514855148651487514885148951490514915149251493514945149551496514975149851499515005150151502515035150451505515065150751508515095151051511515125151351514515155151651517515185151951520515215152251523515245152551526515275152851529515305153151532515335153451535515365153751538515395154051541515425154351544515455154651547515485154951550515515155251553515545155551556515575155851559515605156151562515635156451565515665156751568515695157051571515725157351574515755157651577515785157951580515815158251583515845158551586515875158851589515905159151592515935159451595515965159751598515995160051601516025160351604516055160651607516085160951610516115161251613516145161551616516175161851619516205162151622516235162451625516265162751628516295163051631516325163351634516355163651637516385163951640516415164251643516445164551646516475164851649516505165151652516535165451655516565165751658516595166051661516625166351664516655166651667516685166951670516715167251673516745167551676516775167851679516805168151682516835168451685516865168751688516895169051691516925169351694516955169651697516985169951700517015170251703517045170551706517075170851709517105171151712517135171451715517165171751718517195172051721517225172351724517255172651727517285172951730517315173251733517345173551736517375173851739517405174151742517435174451745517465174751748517495175051751517525175351754517555175651757517585175951760517615176251763517645176551766517675176851769517705177151772517735177451775517765177751778517795178051781517825178351784517855178651787517885178951790517915179251793517945179551796517975179851799518005180151802518035180451805518065180751808518095181051811518125181351814518155181651817518185181951820518215182251823518245182551826518275182851829518305183151832518335183451835518365183751838518395184051841518425184351844518455184651847518485184951850518515185251853518545185551856518575185851859518605186151862518635186451865518665186751868518695187051871518725187351874518755187651877518785187951880518815188251883518845188551886518875188851889518905189151892518935189451895518965189751898518995190051901519025190351904519055190651907519085190951910519115191251913519145191551916519175191851919519205192151922519235192451925519265192751928519295193051931519325193351934519355193651937519385193951940519415194251943519445194551946519475194851949519505195151952519535195451955519565195751958519595196051961519625196351964519655196651967519685196951970519715197251973519745197551976519775197851979519805198151982519835198451985519865198751988519895199051991519925199351994519955199651997519985199952000520015200252003520045200552006520075200852009520105201152012520135201452015520165201752018520195202052021520225202352024520255202652027520285202952030520315203252033520345203552036520375203852039520405204152042520435204452045520465204752048520495205052051520525205352054520555205652057520585205952060520615206252063520645206552066520675206852069520705207152072520735207452075520765207752078520795208052081520825208352084520855208652087520885208952090520915209252093520945209552096520975209852099521005210152102521035210452105521065210752108521095211052111521125211352114521155211652117521185211952120521215212252123521245212552126521275212852129521305213152132521335213452135521365213752138521395214052141521425214352144521455214652147521485214952150521515215252153521545215552156521575215852159521605216152162521635216452165521665216752168521695217052171521725217352174521755217652177521785217952180521815218252183521845218552186521875218852189521905219152192521935219452195521965219752198521995220052201522025220352204522055220652207522085220952210522115221252213522145221552216522175221852219522205222152222522235222452225522265222752228522295223052231522325223352234522355223652237522385223952240522415224252243522445224552246522475224852249522505225152252522535225452255522565225752258522595226052261522625226352264522655226652267522685226952270522715227252273522745227552276522775227852279522805228152282522835228452285522865228752288522895229052291522925229352294522955229652297522985229952300523015230252303523045230552306523075230852309523105231152312523135231452315523165231752318523195232052321523225232352324523255232652327523285232952330523315233252333523345233552336523375233852339523405234152342523435234452345523465234752348523495235052351523525235352354523555235652357523585235952360523615236252363523645236552366523675236852369523705237152372523735237452375523765237752378523795238052381523825238352384523855238652387523885238952390523915239252393523945239552396523975239852399524005240152402524035240452405524065240752408524095241052411524125241352414524155241652417524185241952420524215242252423524245242552426524275242852429524305243152432524335243452435524365243752438524395244052441524425244352444524455244652447524485244952450524515245252453524545245552456524575245852459524605246152462524635246452465524665246752468524695247052471524725247352474524755247652477524785247952480524815248252483524845248552486524875248852489524905249152492524935249452495524965249752498524995250052501525025250352504525055250652507525085250952510525115251252513525145251552516525175251852519525205252152522525235252452525525265252752528525295253052531525325253352534525355253652537525385253952540525415254252543525445254552546525475254852549525505255152552525535255452555525565255752558525595256052561525625256352564525655256652567525685256952570525715257252573525745257552576525775257852579525805258152582525835258452585525865258752588525895259052591525925259352594525955259652597525985259952600526015260252603526045260552606526075260852609526105261152612526135261452615526165261752618526195262052621526225262352624526255262652627526285262952630526315263252633526345263552636526375263852639526405264152642526435264452645526465264752648526495265052651526525265352654526555265652657526585265952660526615266252663526645266552666526675266852669526705267152672526735267452675526765267752678526795268052681526825268352684526855268652687526885268952690526915269252693526945269552696526975269852699527005270152702527035270452705527065270752708527095271052711527125271352714527155271652717527185271952720527215272252723527245272552726527275272852729527305273152732527335273452735527365273752738527395274052741527425274352744527455274652747527485274952750527515275252753527545275552756527575275852759527605276152762527635276452765527665276752768527695277052771527725277352774527755277652777527785277952780527815278252783527845278552786527875278852789527905279152792527935279452795527965279752798527995280052801528025280352804528055280652807528085280952810528115281252813528145281552816528175281852819528205282152822528235282452825528265282752828528295283052831528325283352834528355283652837528385283952840528415284252843528445284552846528475284852849528505285152852528535285452855528565285752858528595286052861528625286352864528655286652867528685286952870528715287252873528745287552876528775287852879528805288152882528835288452885528865288752888528895289052891528925289352894528955289652897528985289952900529015290252903529045290552906529075290852909529105291152912529135291452915529165291752918529195292052921529225292352924529255292652927529285292952930529315293252933529345293552936529375293852939529405294152942529435294452945529465294752948529495295052951529525295352954529555295652957529585295952960529615296252963529645296552966529675296852969529705297152972529735297452975529765297752978529795298052981529825298352984529855298652987529885298952990529915299252993529945299552996529975299852999530005300153002530035300453005530065300753008530095301053011530125301353014530155301653017530185301953020530215302253023530245302553026530275302853029530305303153032530335303453035530365303753038530395304053041530425304353044530455304653047530485304953050530515305253053530545305553056530575305853059530605306153062530635306453065530665306753068530695307053071530725307353074530755307653077530785307953080530815308253083530845308553086530875308853089530905309153092530935309453095530965309753098530995310053101531025310353104531055310653107531085310953110531115311253113531145311553116531175311853119531205312153122531235312453125531265312753128531295313053131531325313353134531355313653137531385313953140531415314253143531445314553146531475314853149531505315153152531535315453155531565315753158531595316053161531625316353164531655316653167531685316953170531715317253173531745317553176531775317853179531805318153182531835318453185531865318753188531895319053191531925319353194531955319653197531985319953200532015320253203532045320553206532075320853209532105321153212532135321453215532165321753218532195322053221532225322353224532255322653227532285322953230532315323253233532345323553236532375323853239532405324153242532435324453245532465324753248532495325053251532525325353254532555325653257532585325953260532615326253263532645326553266532675326853269532705327153272532735327453275532765327753278532795328053281532825328353284532855328653287532885328953290532915329253293532945329553296532975329853299533005330153302533035330453305533065330753308533095331053311533125331353314533155331653317533185331953320533215332253323533245332553326533275332853329533305333153332533335333453335533365333753338533395334053341533425334353344533455334653347533485334953350533515335253353533545335553356533575335853359533605336153362533635336453365533665336753368533695337053371533725337353374533755337653377533785337953380533815338253383533845338553386533875338853389533905339153392533935339453395533965339753398533995340053401534025340353404534055340653407534085340953410534115341253413534145341553416534175341853419534205342153422534235342453425534265342753428534295343053431534325343353434534355343653437534385343953440534415344253443534445344553446534475344853449534505345153452534535345453455534565345753458534595346053461534625346353464534655346653467534685346953470534715347253473534745347553476534775347853479534805348153482534835348453485534865348753488534895349053491534925349353494534955349653497534985349953500535015350253503535045350553506535075350853509535105351153512535135351453515535165351753518535195352053521535225352353524535255352653527535285352953530535315353253533535345353553536535375353853539535405354153542535435354453545535465354753548535495355053551535525355353554535555355653557535585355953560535615356253563535645356553566535675356853569535705357153572535735357453575535765357753578535795358053581535825358353584535855358653587535885358953590535915359253593535945359553596535975359853599536005360153602536035360453605536065360753608536095361053611536125361353614536155361653617536185361953620536215362253623536245362553626536275362853629536305363153632536335363453635536365363753638536395364053641536425364353644536455364653647536485364953650536515365253653536545365553656536575365853659536605366153662536635366453665536665366753668536695367053671536725367353674536755367653677536785367953680536815368253683536845368553686536875368853689536905369153692536935369453695536965369753698536995370053701537025370353704537055370653707537085370953710537115371253713537145371553716537175371853719537205372153722537235372453725537265372753728537295373053731537325373353734537355373653737537385373953740537415374253743537445374553746537475374853749537505375153752537535375453755537565375753758537595376053761537625376353764537655376653767537685376953770537715377253773537745377553776537775377853779537805378153782537835378453785537865378753788537895379053791537925379353794537955379653797537985379953800538015380253803538045380553806538075380853809538105381153812538135381453815538165381753818538195382053821538225382353824538255382653827538285382953830538315383253833538345383553836538375383853839538405384153842538435384453845538465384753848538495385053851538525385353854538555385653857538585385953860538615386253863538645386553866538675386853869538705387153872538735387453875538765387753878538795388053881538825388353884538855388653887538885388953890538915389253893538945389553896538975389853899539005390153902539035390453905539065390753908539095391053911539125391353914539155391653917539185391953920539215392253923539245392553926539275392853929539305393153932539335393453935539365393753938539395394053941539425394353944539455394653947539485394953950539515395253953539545395553956539575395853959539605396153962539635396453965539665396753968539695397053971539725397353974539755397653977539785397953980539815398253983539845398553986539875398853989539905399153992539935399453995539965399753998539995400054001540025400354004540055400654007540085400954010540115401254013540145401554016540175401854019540205402154022540235402454025540265402754028540295403054031540325403354034540355403654037540385403954040540415404254043540445404554046540475404854049540505405154052540535405454055540565405754058540595406054061540625406354064540655406654067540685406954070540715407254073540745407554076540775407854079540805408154082540835408454085540865408754088540895409054091540925409354094540955409654097540985409954100541015410254103541045410554106541075410854109541105411154112541135411454115541165411754118541195412054121541225412354124541255412654127541285412954130541315413254133541345413554136541375413854139541405414154142541435414454145541465414754148541495415054151541525415354154541555415654157541585415954160541615416254163541645416554166541675416854169541705417154172541735417454175541765417754178541795418054181541825418354184541855418654187541885418954190541915419254193541945419554196541975419854199542005420154202542035420454205542065420754208542095421054211542125421354214542155421654217542185421954220542215422254223542245422554226542275422854229542305423154232542335423454235542365423754238542395424054241542425424354244542455424654247542485424954250542515425254253542545425554256542575425854259542605426154262542635426454265542665426754268542695427054271542725427354274542755427654277542785427954280542815428254283542845428554286542875428854289542905429154292542935429454295542965429754298542995430054301543025430354304543055430654307543085430954310543115431254313543145431554316543175431854319543205432154322543235432454325543265432754328543295433054331543325433354334543355433654337543385433954340543415434254343543445434554346543475434854349543505435154352543535435454355543565435754358543595436054361543625436354364543655436654367543685436954370543715437254373543745437554376543775437854379543805438154382543835438454385543865438754388543895439054391543925439354394543955439654397543985439954400544015440254403544045440554406544075440854409544105441154412544135441454415544165441754418544195442054421544225442354424544255442654427544285442954430544315443254433544345443554436544375443854439544405444154442544435444454445544465444754448544495445054451544525445354454544555445654457544585445954460544615446254463544645446554466544675446854469544705447154472544735447454475544765447754478544795448054481544825448354484544855448654487544885448954490544915449254493544945449554496544975449854499545005450154502545035450454505545065450754508545095451054511545125451354514545155451654517545185451954520545215452254523545245452554526545275452854529545305453154532545335453454535545365453754538545395454054541545425454354544545455454654547545485454954550545515455254553545545455554556545575455854559545605456154562545635456454565545665456754568545695457054571545725457354574545755457654577545785457954580545815458254583545845458554586545875458854589545905459154592545935459454595545965459754598545995460054601546025460354604546055460654607546085460954610546115461254613546145461554616546175461854619546205462154622546235462454625546265462754628546295463054631546325463354634546355463654637546385463954640546415464254643546445464554646546475464854649546505465154652546535465454655546565465754658546595466054661546625466354664546655466654667546685466954670546715467254673546745467554676546775467854679546805468154682546835468454685546865468754688546895469054691546925469354694546955469654697546985469954700547015470254703547045470554706547075470854709547105471154712547135471454715547165471754718547195472054721547225472354724547255472654727547285472954730547315473254733547345473554736547375473854739547405474154742547435474454745547465474754748547495475054751547525475354754547555475654757547585475954760547615476254763547645476554766547675476854769547705477154772547735477454775547765477754778547795478054781547825478354784547855478654787547885478954790547915479254793547945479554796547975479854799548005480154802548035480454805548065480754808548095481054811548125481354814548155481654817548185481954820548215482254823548245482554826548275482854829548305483154832548335483454835548365483754838548395484054841548425484354844548455484654847548485484954850548515485254853548545485554856548575485854859548605486154862548635486454865548665486754868548695487054871548725487354874548755487654877548785487954880548815488254883548845488554886548875488854889548905489154892548935489454895548965489754898548995490054901549025490354904549055490654907549085490954910549115491254913549145491554916549175491854919549205492154922549235492454925549265492754928549295493054931549325493354934549355493654937549385493954940549415494254943549445494554946549475494854949549505495154952549535495454955549565495754958549595496054961549625496354964549655496654967549685496954970549715497254973549745497554976549775497854979549805498154982549835498454985549865498754988549895499054991549925499354994549955499654997549985499955000550015500255003550045500555006550075500855009550105501155012550135501455015550165501755018550195502055021550225502355024550255502655027550285502955030550315503255033550345503555036550375503855039550405504155042550435504455045550465504755048550495505055051550525505355054550555505655057550585505955060550615506255063550645506555066550675506855069550705507155072550735507455075550765507755078550795508055081550825508355084550855508655087550885508955090550915509255093550945509555096550975509855099551005510155102551035510455105551065510755108551095511055111551125511355114551155511655117551185511955120551215512255123551245512555126551275512855129551305513155132551335513455135551365513755138551395514055141551425514355144551455514655147551485514955150551515515255153551545515555156551575515855159551605516155162551635516455165551665516755168551695517055171551725517355174551755517655177551785517955180551815518255183551845518555186551875518855189551905519155192551935519455195551965519755198551995520055201552025520355204552055520655207552085520955210552115521255213552145521555216552175521855219552205522155222552235522455225552265522755228552295523055231552325523355234552355523655237552385523955240552415524255243552445524555246552475524855249552505525155252552535525455255552565525755258552595526055261552625526355264552655526655267552685526955270552715527255273552745527555276552775527855279552805528155282552835528455285552865528755288552895529055291552925529355294552955529655297552985529955300553015530255303553045530555306553075530855309553105531155312553135531455315553165531755318553195532055321553225532355324553255532655327553285532955330553315533255333553345533555336553375533855339553405534155342553435534455345553465534755348553495535055351553525535355354553555535655357553585535955360553615536255363553645536555366553675536855369553705537155372553735537455375553765537755378553795538055381553825538355384553855538655387553885538955390553915539255393553945539555396553975539855399554005540155402554035540455405554065540755408554095541055411554125541355414554155541655417554185541955420554215542255423554245542555426554275542855429554305543155432554335543455435554365543755438554395544055441554425544355444554455544655447554485544955450554515545255453554545545555456554575545855459554605546155462554635546455465554665546755468554695547055471554725547355474554755547655477554785547955480554815548255483554845548555486554875548855489554905549155492554935549455495554965549755498554995550055501555025550355504555055550655507555085550955510555115551255513555145551555516555175551855519555205552155522555235552455525555265552755528555295553055531555325553355534555355553655537555385553955540555415554255543555445554555546555475554855549555505555155552555535555455555555565555755558555595556055561555625556355564555655556655567555685556955570555715557255573555745557555576555775557855579555805558155582555835558455585555865558755588555895559055591555925559355594555955559655597555985559955600556015560255603556045560555606556075560855609556105561155612556135561455615556165561755618556195562055621556225562355624556255562655627556285562955630556315563255633556345563555636556375563855639556405564155642556435564455645556465564755648556495565055651556525565355654556555565655657556585565955660556615566255663556645566555666556675566855669556705567155672556735567455675556765567755678556795568055681556825568355684556855568655687556885568955690556915569255693556945569555696556975569855699557005570155702557035570455705557065570755708557095571055711557125571355714557155571655717557185571955720557215572255723557245572555726557275572855729557305573155732557335573455735557365573755738557395574055741557425574355744557455574655747557485574955750557515575255753557545575555756557575575855759557605576155762557635576455765557665576755768557695577055771557725577355774557755577655777557785577955780557815578255783557845578555786557875578855789557905579155792557935579455795557965579755798557995580055801558025580355804558055580655807
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Telerik.Windows.Documents.Spreadsheet.FormatProviders.Xls</name>
  5. </assembly>
  6. <members>
  7. <member name="M:Telerik.Windows.Documents.Spreadsheet.FormatProviders.Xls.Core.WorksheetConverterBase.TryConvertProperty(System.Action)">
  8. <summary>
  9. Some properties are not set in the underlying document and an NullReferenceException is thrown when accessing property.
  10. That is why we need to handle the exception.
  11. </summary>
  12. <param name="action"></param>
  13. </member>
  14. <member name="T:Telerik.Windows.Documents.Spreadsheet.FormatProviders.Xls.XlsFormatProvider">
  15. <summary>
  16. Binary format provider to export Spreadsheet data to XLS.
  17. </summary>
  18. </member>
  19. <member name="M:Telerik.Windows.Documents.Spreadsheet.FormatProviders.Xls.XlsFormatProvider.#ctor">
  20. <summary>
  21. Initializes a new instance of the <see cref="T:Telerik.Windows.Documents.Spreadsheet.FormatProviders.Xls.XlsFormatProvider" /> class.
  22. </summary>
  23. </member>
  24. <member name="P:Telerik.Windows.Documents.Spreadsheet.FormatProviders.Xls.XlsFormatProvider.Name">
  25. <summary>
  26. Gets the name.
  27. </summary>
  28. <value>The name of the provider.</value>
  29. </member>
  30. <member name="P:Telerik.Windows.Documents.Spreadsheet.FormatProviders.Xls.XlsFormatProvider.FilesDescription">
  31. <summary>
  32. Gets the files description.
  33. </summary>
  34. <value>The files description.</value>
  35. </member>
  36. <member name="P:Telerik.Windows.Documents.Spreadsheet.FormatProviders.Xls.XlsFormatProvider.SupportedExtensions">
  37. <summary>
  38. Gets the supported extensions.
  39. </summary>
  40. <value>The supported extensions.</value>
  41. </member>
  42. <member name="P:Telerik.Windows.Documents.Spreadsheet.FormatProviders.Xls.XlsFormatProvider.CanImport">
  43. <summary>
  44. Gets a value indicating whether can import.
  45. </summary>
  46. <value>The value indicating whether can import.</value>
  47. </member>
  48. <member name="P:Telerik.Windows.Documents.Spreadsheet.FormatProviders.Xls.XlsFormatProvider.CanExport">
  49. <summary>
  50. Gets a value indicating whether can export.
  51. </summary>
  52. <value>The value indicating whether can export.</value>
  53. </member>
  54. <member name="M:Telerik.Windows.Documents.Spreadsheet.FormatProviders.Xls.XlsFormatProvider.ImportOverride(System.IO.Stream)">
  55. <summary>
  56. Imports the specified input.
  57. </summary>
  58. <param name="input">The input.</param>
  59. <returns>The imported workbook.</returns>
  60. </member>
  61. <member name="M:Telerik.Windows.Documents.Spreadsheet.FormatProviders.Xls.XlsFormatProvider.ExportOverride(Telerik.Windows.Documents.Spreadsheet.Model.Workbook,System.IO.Stream)">
  62. <summary>
  63. Exports the specified workbook.
  64. </summary>
  65. <param name="workbook">The workbook.</param>
  66. <param name="output">The output.</param>
  67. </member>
  68. <member name="T:NPOI.DDF.AbstractEscherOptRecord">
  69. Common abstract class for {@link EscherOptRecord} and
  70. {@link EscherTertiaryOptRecord}
  71. @author Sergey Vladimirov (vlsergey {at} gmail {dot} com)
  72. @author Glen Stampoultzis
  73. </member>
  74. <member name="M:NPOI.DDF.AbstractEscherOptRecord.AddEscherProperty(NPOI.DDF.EscherProperty)">
  75. Add a property to this record.
  76. </member>
  77. <member name="P:NPOI.DDF.AbstractEscherOptRecord.EscherProperties">
  78. The list of properties stored by this record.
  79. </member>
  80. <member name="M:NPOI.DDF.AbstractEscherOptRecord.GetEscherProperty(System.Int32)">
  81. The list of properties stored by this record.
  82. </member>
  83. <member name="M:NPOI.DDF.AbstractEscherOptRecord.SortProperties">
  84. Records should be sorted by property number before being stored.
  85. </member>
  86. <member name="M:NPOI.DDF.AbstractEscherOptRecord.SetEscherProperty(NPOI.DDF.EscherProperty)">
  87. * Set an escher property. If a property with given propId already
  88. exists it is replaced.
  89. *
  90. * @param value the property to set.
  91. </member>
  92. <member name="M:NPOI.DDF.AbstractEscherOptRecord.ToString">
  93. Retrieve the string representation of this record.
  94. </member>
  95. <member name="T:NPOI.DDF.DefaultEscherRecordFactory">
  96. <summary>
  97. Generates escher records when provided the byte array containing those records.
  98. @author Glen Stampoultzis
  99. @author Nick Burch (nick at torchbox . com)
  100. </summary>
  101. </member>
  102. <member name="M:NPOI.DDF.DefaultEscherRecordFactory.#ctor">
  103. <summary>
  104. Initializes a new instance of the <see cref="T:NPOI.DDF.DefaultEscherRecordFactory"/> class.
  105. </summary>
  106. </member>
  107. <member name="M:NPOI.DDF.DefaultEscherRecordFactory.CreateRecord(System.Byte[],System.Int32)">
  108. <summary>
  109. Generates an escher record including the any children contained under that record.
  110. An exception is thrown if the record could not be generated.
  111. </summary>
  112. <param name="data">The byte array containing the records</param>
  113. <param name="offset">The starting offset into the byte array</param>
  114. <returns>The generated escher record</returns>
  115. </member>
  116. <member name="M:NPOI.DDF.DefaultEscherRecordFactory.RecordsToMap(System.Type[])">
  117. <summary>
  118. Converts from a list of classes into a map that Contains the record id as the key and
  119. the Constructor in the value part of the map. It does this by using reflection to look up
  120. the RECORD_ID field then using reflection again to find a reference to the constructor.
  121. </summary>
  122. <param name="records">The records to convert</param>
  123. <returns>The map containing the id/constructor pairs.</returns>
  124. </member>
  125. <member name="T:NPOI.DDF.EscherArrayProperty">
  126. <summary>
  127. Escher array properties are the most wierd construction ever invented
  128. with all sorts of special cases. I'm hopeful I've got them all.
  129. @author Glen Stampoultzis (glens at superlinksoftware.com)
  130. </summary>
  131. </member>
  132. <member name="F:NPOI.DDF.EscherArrayProperty.FIXED_SIZE">
  133. The size of the header that goes at the
  134. start of the array, before the data
  135. </member>
  136. <member name="F:NPOI.DDF.EscherArrayProperty.sizeIncludesHeaderSize">
  137. Normally, the size recorded in the simple data (for the complex
  138. data) includes the size of the header.
  139. There are a few cases when it doesn't though...
  140. </member>
  141. <member name="F:NPOI.DDF.EscherArrayProperty.emptyComplexPart">
  142. When Reading a property from data stream remeber if the complex part is empty and Set this flag.
  143. </member>
  144. <member name="M:NPOI.DDF.EscherArrayProperty.GetElement(System.Int32)">
  145. <summary>
  146. Gets the element.
  147. </summary>
  148. <param name="index">The index.</param>
  149. <returns></returns>
  150. </member>
  151. <member name="M:NPOI.DDF.EscherArrayProperty.SetElement(System.Int32,System.Byte[])">
  152. <summary>
  153. Sets the element.
  154. </summary>
  155. <param name="index">The index.</param>
  156. <param name="element">The element.</param>
  157. </member>
  158. <member name="M:NPOI.DDF.EscherArrayProperty.ToString">
  159. <summary>
  160. Retrieves the string representation for this property.
  161. </summary>
  162. <returns></returns>
  163. </member>
  164. <member name="M:NPOI.DDF.EscherArrayProperty.SetArrayData(System.Byte[],System.Int32)">
  165. <summary>
  166. We have this method because the way in which arrays in escher works
  167. is screwed for seemly arbitary reasons. While most properties are
  168. fairly consistent and have a predictable array size, escher arrays
  169. have special cases.
  170. </summary>
  171. <param name="data">The data array containing the escher array information</param>
  172. <param name="offset">The offset into the array to start Reading from.</param>
  173. <returns>the number of bytes used by this complex property.</returns>
  174. </member>
  175. <member name="M:NPOI.DDF.EscherArrayProperty.SerializeSimplePart(System.Byte[],System.Int32)">
  176. <summary>
  177. Serializes the simple part of this property. ie the first 6 bytes.
  178. Needs special code to handle the case when the size doesn't
  179. include the size of the header block
  180. </summary>
  181. <param name="data"></param>
  182. <param name="pos"></param>
  183. <returns></returns>
  184. </member>
  185. <member name="M:NPOI.DDF.EscherArrayProperty.GetActualSizeOfElements(System.Int16)">
  186. <summary>
  187. Sometimes the element size is stored as a negative number. We
  188. negate it and shift it to Get the real value.
  189. </summary>
  190. <param name="sizeOfElements">The size of elements.</param>
  191. <returns></returns>
  192. </member>
  193. <member name="T:NPOI.DDF.EscherBitmapBlip">
  194. <summary>
  195. @author Glen Stampoultzis
  196. @version $Id: EscherBitmapBlip.java 569827 2007-08-26 15:26:29Z yegor $
  197. </summary>
  198. </member>
  199. <member name="M:NPOI.DDF.EscherBitmapBlip.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  200. <summary>
  201. This method deSerializes the record from a byte array.
  202. </summary>
  203. <param name="data"> The byte array containing the escher record information</param>
  204. <param name="offset">The starting offset into </param>
  205. <param name="recordFactory">May be null since this is not a container record.</param>
  206. <returns>The number of bytes Read from the byte array.</returns>
  207. </member>
  208. <member name="M:NPOI.DDF.EscherBitmapBlip.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  209. <summary>
  210. Serializes the record to an existing byte array.
  211. </summary>
  212. <param name="offset">the offset within the byte array</param>
  213. <param name="data">the data array to Serialize to</param>
  214. <param name="listener">a listener for begin and end serialization events.</param>
  215. <returns>the number of bytes written.</returns>
  216. </member>
  217. <member name="P:NPOI.DDF.EscherBitmapBlip.RecordSize">
  218. <summary>
  219. Returns the number of bytes that are required to Serialize this record.
  220. </summary>
  221. <value> Number of bytes</value>
  222. </member>
  223. <member name="P:NPOI.DDF.EscherBitmapBlip.UID">
  224. <summary>
  225. Gets or sets the UID.
  226. </summary>
  227. <value>The UID.</value>
  228. </member>
  229. <member name="P:NPOI.DDF.EscherBitmapBlip.Marker">
  230. <summary>
  231. Gets or sets the marker.
  232. </summary>
  233. <value>The marker.</value>
  234. </member>
  235. <member name="M:NPOI.DDF.EscherBitmapBlip.ToString">
  236. <summary>
  237. Toes the string.
  238. </summary>
  239. <returns></returns>
  240. </member>
  241. <member name="T:NPOI.DDF.EscherBlipRecord">
  242. <summary>
  243. @author Glen Stampoultzis
  244. @version $Id: EscherBlipRecord.java 569827 2007-08-26 15:26:29Z yegor $
  245. </summary>
  246. </member>
  247. <member name="M:NPOI.DDF.EscherBlipRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  248. <summary>
  249. This method deSerializes the record from a byte array.
  250. </summary>
  251. <param name="data">The byte array containing the escher record information</param>
  252. <param name="offset">The starting offset into </param>
  253. <param name="recordFactory">May be null since this is not a container record.</param>
  254. <returns>The number of bytes Read from the byte array.</returns>
  255. </member>
  256. <member name="M:NPOI.DDF.EscherBlipRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  257. <summary>
  258. Serializes the record to an existing byte array.
  259. </summary>
  260. <param name="offset"> the offset within the byte array</param>
  261. <param name="data">the data array to Serialize to</param>
  262. <param name="listener">a listener for begin and end serialization events.</param>
  263. <returns>the number of bytes written.</returns>
  264. </member>
  265. <member name="P:NPOI.DDF.EscherBlipRecord.RecordSize">
  266. <summary>
  267. Returns the number of bytes that are required to Serialize this record.
  268. </summary>
  269. <value>Number of bytes</value>
  270. </member>
  271. <member name="P:NPOI.DDF.EscherBlipRecord.RecordName">
  272. <summary>
  273. The short name for this record
  274. </summary>
  275. <value></value>
  276. </member>
  277. <member name="P:NPOI.DDF.EscherBlipRecord.PictureData">
  278. <summary>
  279. Gets or sets the picture data.
  280. </summary>
  281. <value>The picture data.</value>
  282. </member>
  283. <member name="M:NPOI.DDF.EscherBlipRecord.ToString">
  284. <summary>
  285. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  286. </summary>
  287. <returns>
  288. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  289. </returns>
  290. </member>
  291. <member name="T:NPOI.DDF.EscherBoolProperty">
  292. <summary>
  293. Represents a bool property. The actual utility of this property is in doubt because many
  294. of the properties marked as bool seem to actually contain special values. In other words
  295. they're not true bools.
  296. @author Glen Stampoultzis
  297. </summary>
  298. </member>
  299. <member name="M:NPOI.DDF.EscherBoolProperty.#ctor(System.Int16,System.Int32)">
  300. <summary>
  301. Create an instance of an escher bool property.
  302. </summary>
  303. <param name="propertyNumber">The property number (or id)</param>
  304. <param name="value">The 32 bit value of this bool property</param>
  305. </member>
  306. <member name="P:NPOI.DDF.EscherBoolProperty.IsTrue">
  307. <summary>
  308. Whether this bool property is true
  309. </summary>
  310. <value><c>true</c> if this instance is true; otherwise, <c>false</c>.</value>
  311. </member>
  312. <member name="P:NPOI.DDF.EscherBoolProperty.IsFalse">
  313. <summary>
  314. Whether this bool property is false
  315. </summary>
  316. <value><c>true</c> if this instance is false; otherwise, <c>false</c>.</value>
  317. </member>
  318. <member name="T:NPOI.DDF.EscherBSERecord">
  319. <summary>
  320. The BSE record is related closely to the EscherBlipRecord and stores
  321. extra information about the blip. A blip record is actually stored inside
  322. the BSE record even though the BSE record isn't actually a container record.
  323. @author Glen Stampoultzis
  324. @see EscherBlipRecord
  325. </summary>
  326. </member>
  327. <member name="M:NPOI.DDF.EscherBSERecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  328. <summary>
  329. This method deSerializes the record from a byte array.
  330. </summary>
  331. <param name="data">The byte array containing the escher record information</param>
  332. <param name="offset">The starting offset into data</param>
  333. <param name="recordFactory">May be null since this is not a container record.</param>
  334. <returns>The number of bytes Read from the byte array.</returns>
  335. </member>
  336. <member name="M:NPOI.DDF.EscherBSERecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  337. <summary>
  338. This method Serializes this escher record into a byte array.
  339. </summary>
  340. <param name="offset">The offset into
  341. data to start writing the record data to</param>
  342. <param name="data">The byte array to Serialize to.</param>
  343. <param name="listener">a listener for begin and end serialization events.</param>
  344. <returns>The number of bytes written.</returns>
  345. </member>
  346. <member name="P:NPOI.DDF.EscherBSERecord.RecordSize">
  347. <summary>
  348. Returns the number of bytes that are required to Serialize this record.
  349. </summary>
  350. <value>Number of bytes</value>
  351. </member>
  352. <member name="P:NPOI.DDF.EscherBSERecord.RecordName">
  353. <summary>
  354. The short name for this record
  355. </summary>
  356. <value></value>
  357. </member>
  358. <member name="P:NPOI.DDF.EscherBSERecord.BlipTypeWin32">
  359. <summary>
  360. Gets or sets the expected blip type under windows (failure to match this blip type will result in
  361. Excel converting to this format).
  362. </summary>
  363. <value>The blip type win32.</value>
  364. </member>
  365. <member name="P:NPOI.DDF.EscherBSERecord.BlipTypeMacOS">
  366. <summary>
  367. Gets or sets the expected blip type under MacOS (failure to match this blip type will result in
  368. Excel converting to this format).
  369. </summary>
  370. <value>The blip type mac OS.</value>
  371. </member>
  372. <member name="P:NPOI.DDF.EscherBSERecord.UID">
  373. <summary>
  374. Gets or sets 16 byte MD4 checksum.
  375. </summary>
  376. <value>The UID.</value>
  377. </member>
  378. <member name="P:NPOI.DDF.EscherBSERecord.Tag">
  379. <summary>
  380. Gets or sets the tag. (Unused)
  381. </summary>
  382. <value>The tag.</value>
  383. </member>
  384. <member name="P:NPOI.DDF.EscherBSERecord.Size">
  385. <summary>
  386. Gets or sets Blip size in stream..
  387. </summary>
  388. <value>The size.</value>
  389. </member>
  390. <member name="P:NPOI.DDF.EscherBSERecord.Ref">
  391. <summary>
  392. Gets or sets the reference count of this blip.
  393. </summary>
  394. <value>The ref.</value>
  395. </member>
  396. <member name="P:NPOI.DDF.EscherBSERecord.Offset">
  397. <summary>
  398. Gets or sets the offset in the delay stream..
  399. </summary>
  400. <value>The offset.</value>
  401. </member>
  402. <member name="P:NPOI.DDF.EscherBSERecord.Usage">
  403. <summary>
  404. Defines the way this blip is used.
  405. </summary>
  406. <value>The usage.</value>
  407. </member>
  408. <member name="P:NPOI.DDF.EscherBSERecord.Name">
  409. <summary>
  410. Gets or sets the blip name.
  411. </summary>
  412. <value>The name.</value>
  413. </member>
  414. <member name="P:NPOI.DDF.EscherBSERecord.Unused2">
  415. <summary>
  416. Gets or sets the unused2.
  417. </summary>
  418. <value>The unused2.</value>
  419. </member>
  420. <member name="P:NPOI.DDF.EscherBSERecord.Unused3">
  421. <summary>
  422. Gets or sets the unused3.
  423. </summary>
  424. <value>The unused3.</value>
  425. </member>
  426. <member name="P:NPOI.DDF.EscherBSERecord.BlipRecord">
  427. <summary>
  428. Gets or sets the blip record.
  429. </summary>
  430. <value>The blip record.</value>
  431. </member>
  432. <member name="P:NPOI.DDF.EscherBSERecord.RemainingData">
  433. <summary>
  434. Gets or sets any remaining data in this record.
  435. </summary>
  436. <value>The remaining data.</value>
  437. </member>
  438. <member name="M:NPOI.DDF.EscherBSERecord.ToString">
  439. <summary>
  440. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  441. </summary>
  442. <returns>
  443. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  444. </returns>
  445. </member>
  446. <member name="M:NPOI.DDF.EscherBSERecord.GetBlipType(System.Byte)">
  447. <summary>
  448. Retrieve the string representation given a blip id.
  449. </summary>
  450. <param name="b">The b.</param>
  451. <returns></returns>
  452. </member>
  453. <member name="T:NPOI.DDF.EscherChildAnchorRecord">
  454. <summary>
  455. The escher child achor record is used to specify the position of a shape under an
  456. existing group. The first level of shape records use a EscherClientAnchor record instead.
  457. @author Glen Stampoultzis
  458. </summary>
  459. </member>
  460. <member name="M:NPOI.DDF.EscherChildAnchorRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  461. <summary>
  462. This method deSerializes the record from a byte array.
  463. </summary>
  464. <param name="data">The byte array containing the escher record information</param>
  465. <param name="offset">The starting offset into data</param>
  466. <param name="recordFactory">May be null since this is not a container record.</param>
  467. <returns>The number of bytes Read from the byte array.</returns>
  468. </member>
  469. <member name="M:NPOI.DDF.EscherChildAnchorRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  470. <summary>
  471. This method Serializes this escher record into a byte array.
  472. </summary>
  473. <param name="offset">The offset into data to start writing the record data to.</param>
  474. <param name="data">The byte array to Serialize to.</param>
  475. <param name="listener">a listener for begin and end serialization events.</param>
  476. <returns>The number of bytes written.</returns>
  477. </member>
  478. <member name="P:NPOI.DDF.EscherChildAnchorRecord.RecordSize">
  479. <summary>
  480. Returns the number of bytes that are required to Serialize this record.
  481. </summary>
  482. <value>Number of bytes</value>
  483. </member>
  484. <member name="P:NPOI.DDF.EscherChildAnchorRecord.RecordId">
  485. <summary>
  486. The record id for the EscherChildAnchorRecord.
  487. </summary>
  488. <value></value>
  489. </member>
  490. <member name="P:NPOI.DDF.EscherChildAnchorRecord.RecordName">
  491. <summary>
  492. The short name for this record
  493. </summary>
  494. <value></value>
  495. </member>
  496. <member name="M:NPOI.DDF.EscherChildAnchorRecord.ToString">
  497. <summary>
  498. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  499. </summary>
  500. <returns>
  501. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  502. </returns>
  503. </member>
  504. <member name="P:NPOI.DDF.EscherChildAnchorRecord.Dx1">
  505. <summary>
  506. Gets or sets offset within the parent coordinate space for the top left point.
  507. </summary>
  508. <value>The DX1.</value>
  509. </member>
  510. <member name="P:NPOI.DDF.EscherChildAnchorRecord.Dy1">
  511. <summary>
  512. Gets or sets the offset within the parent coordinate space for the top left point.
  513. </summary>
  514. <value>The dy1.</value>
  515. </member>
  516. <member name="P:NPOI.DDF.EscherChildAnchorRecord.Dx2">
  517. <summary>
  518. Gets or sets the offset within the parent coordinate space for the bottom right point.
  519. </summary>
  520. <value>The DX2.</value>
  521. </member>
  522. <member name="P:NPOI.DDF.EscherChildAnchorRecord.Dy2">
  523. <summary>
  524. Gets or sets the offset within the parent coordinate space for the bottom right point.
  525. </summary>
  526. <value>The dy2.</value>
  527. </member>
  528. <member name="T:NPOI.DDF.EscherClientAnchorRecord">
  529. <summary>
  530. The escher client anchor specifies which rows and cells the shape is bound to as well as
  531. the offsets within those cells. Each cell is 1024 units wide by 256 units long regardless
  532. of the actual size of the cell. The EscherClientAnchorRecord only applies to the top-most
  533. shapes. Shapes contained in groups are bound using the EscherChildAnchorRecords.
  534. @author Glen Stampoultzis
  535. </summary>
  536. </member>
  537. <member name="F:NPOI.DDF.EscherClientAnchorRecord.field_1_flag">
  538. bit[0] - fMove (1 bit): A bit that specifies whether the shape will be kept intact when the cells are moved.
  539. 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.
  540. bit[2-4] - reserved, MUST be 0 and MUST be ignored
  541. bit[5-15]- Undefined and MUST be ignored.
  542. it can take values: 0, 2, 3
  543. </member>
  544. <member name="M:NPOI.DDF.EscherClientAnchorRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  545. <summary>
  546. This method deSerializes the record from a byte array.
  547. </summary>
  548. <param name="data">The byte array containing the escher record information</param>
  549. <param name="offset">The starting offset into data</param>
  550. <param name="recordFactory">May be null since this is not a container record.</param>
  551. <returns>The number of bytes Read from the byte array.</returns>
  552. </member>
  553. <member name="M:NPOI.DDF.EscherClientAnchorRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  554. <summary>
  555. This method Serializes this escher record into a byte array.
  556. </summary>
  557. <param name="offset">The offset into data to start writing the record data to.</param>
  558. <param name="data">The byte array to Serialize to.</param>
  559. <param name="listener">a listener for begin and end serialization events.</param>
  560. <returns>The number of bytes written.</returns>
  561. </member>
  562. <member name="P:NPOI.DDF.EscherClientAnchorRecord.RecordSize">
  563. <summary>
  564. Returns the number of bytes that are required to Serialize this record.
  565. </summary>
  566. <value>Number of bytes</value>
  567. </member>
  568. <member name="P:NPOI.DDF.EscherClientAnchorRecord.RecordId">
  569. <summary>
  570. The record id for this record.
  571. </summary>
  572. <value></value>
  573. </member>
  574. <member name="P:NPOI.DDF.EscherClientAnchorRecord.RecordName">
  575. <summary>
  576. The short name for this record
  577. </summary>
  578. <value></value>
  579. </member>
  580. <member name="M:NPOI.DDF.EscherClientAnchorRecord.ToString">
  581. <summary>
  582. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  583. </summary>
  584. <returns>
  585. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  586. </returns>
  587. </member>
  588. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Flag">
  589. <summary>
  590. Gets or sets the flag.
  591. </summary>
  592. <value>0 = Move and size with Cells, 2 = Move but don't size with cells, 3 = Don't move or size with cells.</value>
  593. </member>
  594. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Col1">
  595. <summary>
  596. Gets or sets The column number for the top-left position. 0 based.
  597. </summary>
  598. <value>The col1.</value>
  599. </member>
  600. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Dx1">
  601. <summary>
  602. Gets or sets The x offset within the top-left cell. Range is from 0 to 1023.
  603. </summary>
  604. <value>The DX1.</value>
  605. </member>
  606. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Row1">
  607. <summary>
  608. Gets or sets The row number for the top-left corner of the shape.
  609. </summary>
  610. <value>The row1.</value>
  611. </member>
  612. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Dy1">
  613. <summary>
  614. Gets or sets The y offset within the top-left corner of the current shape.
  615. </summary>
  616. <value>The dy1.</value>
  617. </member>
  618. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Col2">
  619. <summary>
  620. Gets or sets The column of the bottom right corner of this shape.
  621. </summary>
  622. <value>The col2.</value>
  623. </member>
  624. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Dx2">
  625. <summary>
  626. Gets or sets The x offset withing the cell for the bottom-right corner of this shape.
  627. </summary>
  628. <value>The DX2.</value>
  629. </member>
  630. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Row2">
  631. <summary>
  632. Gets or sets The row number for the bottom-right corner of the current shape.
  633. </summary>
  634. <value>The row2.</value>
  635. </member>
  636. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Dy2">
  637. <summary>
  638. Gets or sets The y offset withing the cell for the bottom-right corner of this shape.
  639. </summary>
  640. <value>The dy2.</value>
  641. </member>
  642. <member name="P:NPOI.DDF.EscherClientAnchorRecord.RemainingData">
  643. <summary>
  644. Gets or sets the remaining data.
  645. </summary>
  646. <value>The remaining data.</value>
  647. </member>
  648. <member name="T:NPOI.DDF.EscherClientDataRecord">
  649. <summary>
  650. The EscherClientDataRecord is used to store client specific data about the position of a
  651. shape within a container.
  652. @author Glen Stampoultzis
  653. </summary>
  654. </member>
  655. <member name="M:NPOI.DDF.EscherClientDataRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  656. <summary>
  657. This method deSerializes the record from a byte array.
  658. </summary>
  659. <param name="data">The byte array containing the escher record information</param>
  660. <param name="offset">The starting offset into data</param>
  661. <param name="recordFactory">May be null since this is not a container record.</param>
  662. <returns>The number of bytes Read from the byte array.</returns>
  663. </member>
  664. <member name="M:NPOI.DDF.EscherClientDataRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  665. This method Serializes this escher record into a byte array.
  666. @param offset The offset into <c>data</c> to start writing the record data to.
  667. @param data The byte array to Serialize to.
  668. @param listener A listener to retrieve start and end callbacks. Use a <c>NullEscherSerailizationListener</c> to ignore these events.
  669. @return The number of bytes written.
  670. @see NullEscherSerializationListener
  671. </member>
  672. <member name="P:NPOI.DDF.EscherClientDataRecord.RecordSize">
  673. Returns the number of bytes that are required to Serialize this record.
  674. @return Number of bytes
  675. </member>
  676. <member name="P:NPOI.DDF.EscherClientDataRecord.RecordId">
  677. Returns the identifier of this record.
  678. </member>
  679. <member name="P:NPOI.DDF.EscherClientDataRecord.RecordName">
  680. The short name for this record
  681. </member>
  682. <member name="M:NPOI.DDF.EscherClientDataRecord.ToString">
  683. Returns the string representation of this record.
  684. </member>
  685. <member name="P:NPOI.DDF.EscherClientDataRecord.RemainingData">
  686. Any data recording this record.
  687. </member>
  688. <member name="T:NPOI.DDF.EscherComplexProperty">
  689. <summary>
  690. A complex property differs from a simple property in that the data can not fit inside a 32 bit
  691. integer. See the specification for more detailed information regarding exactly what is
  692. stored here.
  693. @author Glen Stampoultzis
  694. </summary>
  695. </member>
  696. <member name="M:NPOI.DDF.EscherComplexProperty.#ctor(System.Int16,System.Byte[])">
  697. <summary>
  698. Create a complex property using the property id and a byte array containing the complex
  699. data value.
  700. </summary>
  701. <param name="id"> The id consists of the property number, a flag indicating whether this is a blip id and a flag
  702. indicating that this is a complex property.</param>
  703. <param name="complexData">The value of this property.</param>
  704. </member>
  705. <member name="M:NPOI.DDF.EscherComplexProperty.#ctor(System.Int16,System.Boolean,System.Byte[])">
  706. <summary>
  707. Create a complex property using the property number, a flag to indicate whether this is a
  708. blip reference and the complex property data.
  709. </summary>
  710. <param name="propertyNumber">The property number.</param>
  711. <param name="isBlipId">Whether this is a blip id. Should be false.</param>
  712. <param name="complexData">The value of this complex property.</param>
  713. </member>
  714. <member name="M:NPOI.DDF.EscherComplexProperty.SerializeSimplePart(System.Byte[],System.Int32)">
  715. <summary>
  716. Serializes the simple part of this property. ie the first 6 bytes.
  717. </summary>
  718. <param name="data"></param>
  719. <param name="pos"></param>
  720. <returns></returns>
  721. </member>
  722. <member name="M:NPOI.DDF.EscherComplexProperty.SerializeComplexPart(System.Byte[],System.Int32)">
  723. <summary>
  724. Serializes the complex part of this property
  725. </summary>
  726. <param name="data">The data array to Serialize to</param>
  727. <param name="pos">The offset within data to start serializing to.</param>
  728. <returns>The number of bytes Serialized.</returns>
  729. </member>
  730. <member name="P:NPOI.DDF.EscherComplexProperty.ComplexData">
  731. <summary>
  732. Gets the complex data.
  733. </summary>
  734. <value>The complex data.</value>
  735. </member>
  736. <member name="M:NPOI.DDF.EscherComplexProperty.Equals(System.Object)">
  737. <summary>
  738. Determine whether this property is equal to another property.
  739. </summary>
  740. <param name="o">The object to compare to.</param>
  741. <returns>True if the objects are equal.</returns>
  742. </member>
  743. <member name="P:NPOI.DDF.EscherComplexProperty.PropertySize">
  744. <summary>
  745. Caclulates the number of bytes required to Serialize this property.
  746. </summary>
  747. <value>Number of bytes</value>
  748. </member>
  749. <member name="M:NPOI.DDF.EscherComplexProperty.GetHashCode">
  750. <summary>
  751. Serves as a hash function for a particular type.
  752. </summary>
  753. <returns>
  754. A hash code for the current <see cref="T:System.Object"/>.
  755. </returns>
  756. </member>
  757. <member name="M:NPOI.DDF.EscherComplexProperty.ToString">
  758. <summary>
  759. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  760. </summary>
  761. <returns>
  762. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  763. </returns>
  764. </member>
  765. <member name="T:NPOI.DDF.EscherContainerRecord">
  766. <summary>
  767. Escher container records store other escher records as children.
  768. The container records themselves never store any information beyond
  769. the standard header used by all escher records. This one record is
  770. used to represent many different types of records.
  771. @author Glen Stampoultzis
  772. </summary>
  773. </member>
  774. <member name="F:NPOI.DDF.EscherContainerRecord._remainingLength">
  775. in case if document contains any charts we have such document structure:
  776. BOF
  777. ...
  778. DrawingRecord
  779. ...
  780. ObjRecord|TxtObjRecord
  781. ...
  782. EOF
  783. ...
  784. BOF(Chart begin)
  785. ...
  786. DrawingRecord
  787. ...
  788. ObjRecord|TxtObjRecord
  789. ...
  790. EOF
  791. So, when we call EscherAggregate.createAggregate() we have not all needed data.
  792. When we got warning "WARNING: " + bytesRemaining + " bytes remaining but no space left"
  793. we should save value of bytesRemaining
  794. and add it to container size when we serialize it
  795. </member>
  796. <member name="M:NPOI.DDF.EscherContainerRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  797. <summary>
  798. The contract of this method is to deSerialize an escher record including
  799. it's children.
  800. </summary>
  801. <param name="data">The byte array containing the Serialized escher
  802. records.</param>
  803. <param name="offset">The offset into the byte array.</param>
  804. <param name="recordFactory">A factory for creating new escher records</param>
  805. <returns>The number of bytes written.</returns>
  806. </member>
  807. <member name="M:NPOI.DDF.EscherContainerRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  808. <summary>
  809. Serializes to an existing byte array without serialization listener.
  810. This is done by delegating to Serialize(int, byte[], EscherSerializationListener).
  811. </summary>
  812. <param name="offset">the offset within the data byte array.</param>
  813. <param name="data"> the data array to Serialize to.</param>
  814. <param name="listener">a listener for begin and end serialization events.</param>
  815. <returns>The number of bytes written.</returns>
  816. </member>
  817. <member name="P:NPOI.DDF.EscherContainerRecord.RecordSize">
  818. <summary>
  819. Subclasses should effeciently return the number of bytes required to
  820. Serialize the record.
  821. </summary>
  822. <value>number of bytes</value>
  823. </member>
  824. <member name="M:NPOI.DDF.EscherContainerRecord.HasChildOfType(System.Int16)">
  825. <summary>
  826. Do any of our (top level) children have the
  827. given recordId?
  828. </summary>
  829. <param name="recordId">The record id.</param>
  830. <returns>
  831. <c>true</c> if [has child of type] [the specified record id]; otherwise, <c>false</c>.
  832. </returns>
  833. </member>
  834. <member name="P:NPOI.DDF.EscherContainerRecord.ChildRecords">
  835. <summary>
  836. Returns a list of all the child (escher) records
  837. of the container.
  838. </summary>
  839. <value></value>
  840. </member>
  841. <member name="P:NPOI.DDF.EscherContainerRecord.ChildContainers">
  842. <summary>
  843. Returns all of our children which are also
  844. EscherContainers (may be 0, 1, or vary rarely
  845. 2 or 3)
  846. </summary>
  847. <value>The child containers.</value>
  848. </member>
  849. <member name="P:NPOI.DDF.EscherContainerRecord.RecordName">
  850. <summary>
  851. Subclasses should return the short name for this escher record.
  852. </summary>
  853. <value></value>
  854. </member>
  855. <member name="M:NPOI.DDF.EscherContainerRecord.Display(System.Int32)">
  856. <summary>
  857. The display methods allows escher variables to print the record names
  858. according to their hierarchy.
  859. </summary>
  860. <param name="indent">The current indent level.</param>
  861. </member>
  862. <member name="M:NPOI.DDF.EscherContainerRecord.AddChildRecord(NPOI.DDF.EscherRecord)">
  863. <summary>
  864. Adds the child record.
  865. </summary>
  866. <param name="record">The record.</param>
  867. </member>
  868. <member name="M:NPOI.DDF.EscherContainerRecord.ToString">
  869. <summary>
  870. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  871. </summary>
  872. <returns>
  873. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  874. </returns>
  875. </member>
  876. <member name="M:NPOI.DDF.EscherContainerRecord.GetChildById(System.Int16)">
  877. <summary>
  878. Gets the child by id.
  879. </summary>
  880. <param name="recordId">The record id.</param>
  881. <returns></returns>
  882. </member>
  883. <member name="M:NPOI.DDF.EscherContainerRecord.GetRecordsById(System.Int16,System.Collections.ArrayList@)">
  884. <summary>
  885. Recursively find records with the specified record ID
  886. </summary>
  887. <param name="recordId"></param>
  888. <param name="out1">list to store found records</param>
  889. </member>
  890. <member name="T:NPOI.DDF.EscherDggRecord">
  891. <summary>
  892. This record defines the drawing groups used for a particular sheet.
  893. </summary>
  894. </member>
  895. <member name="M:NPOI.DDF.EscherDggRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  896. <summary>
  897. This method deSerializes the record from a byte array.
  898. </summary>
  899. <param name="data">The byte array containing the escher record information</param>
  900. <param name="offset">The starting offset into data</param>
  901. <param name="recordFactory">May be null since this is not a container record.</param>
  902. <returns>The number of bytes Read from the byte array.</returns>
  903. </member>
  904. <member name="M:NPOI.DDF.EscherDggRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  905. <summary>
  906. This method Serializes this escher record into a byte array.
  907. </summary>
  908. <param name="offset">The offset into data to start writing the record data to.</param>
  909. <param name="data">The byte array to Serialize to.</param>
  910. <param name="listener">a listener for begin and end serialization events.</param>
  911. <returns>The number of bytes written.</returns>
  912. </member>
  913. <member name="P:NPOI.DDF.EscherDggRecord.RecordSize">
  914. <summary>
  915. Returns the number of bytes that are required to Serialize this record.
  916. </summary>
  917. <value>Number of bytes</value>
  918. </member>
  919. <member name="P:NPOI.DDF.EscherDggRecord.RecordId">
  920. <summary>
  921. Return the current record id.
  922. </summary>
  923. <value>The 16 bit record id.</value>
  924. </member>
  925. <member name="P:NPOI.DDF.EscherDggRecord.RecordName">
  926. <summary>
  927. The short name for this record
  928. </summary>
  929. <value></value>
  930. </member>
  931. <member name="M:NPOI.DDF.EscherDggRecord.ToString">
  932. <summary>
  933. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  934. </summary>
  935. <returns>
  936. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  937. </returns>
  938. </member>
  939. <member name="P:NPOI.DDF.EscherDggRecord.ShapeIdMax">
  940. <summary>
  941. Gets or sets the shape id max.
  942. </summary>
  943. <value>The shape id max.</value>
  944. </member>
  945. <member name="P:NPOI.DDF.EscherDggRecord.NumIdClusters">
  946. <summary>
  947. Gets the Number of id clusters + 1
  948. </summary>
  949. <value>The num id clusters.</value>
  950. </member>
  951. <member name="P:NPOI.DDF.EscherDggRecord.NumShapesSaved">
  952. <summary>
  953. Gets or sets the num shapes saved.
  954. </summary>
  955. <value>The num shapes saved.</value>
  956. </member>
  957. <member name="P:NPOI.DDF.EscherDggRecord.DrawingsSaved">
  958. <summary>
  959. Gets or sets the drawings saved.
  960. </summary>
  961. <value>The drawings saved.</value>
  962. </member>
  963. <member name="P:NPOI.DDF.EscherDggRecord.MaxDrawingGroupId">
  964. <summary>
  965. Gets or sets the max drawing group id.
  966. </summary>
  967. <value>The max drawing group id.</value>
  968. </member>
  969. <member name="P:NPOI.DDF.EscherDggRecord.FileIdClusters">
  970. <summary>
  971. Gets or sets the file id clusters.
  972. </summary>
  973. <value>The file id clusters.</value>
  974. </member>
  975. <member name="M:NPOI.DDF.EscherDggRecord.AddCluster(System.Int32,System.Int32)">
  976. <summary>
  977. Adds the cluster.
  978. </summary>
  979. <param name="dgId">The dg id.</param>
  980. <param name="numShapedUsed">The num shaped used.</param>
  981. </member>
  982. <member name="M:NPOI.DDF.EscherDggRecord.AddCluster(System.Int32,System.Int32,System.Boolean)">
  983. <summary>
  984. Adds the cluster.
  985. </summary>
  986. <param name="dgId">id of the drawing group (stored in the record options)</param>
  987. <param name="numShapedUsed">initial value of the numShapedUsed field</param>
  988. <param name="sort">if set to <c>true</c> if true then sort clusters by drawing group id.(
  989. In Excel the clusters are sorted but in PPT they are not).</param>
  990. </member>
  991. <member name="T:NPOI.DDF.EscherDgRecord">
  992. <summary>
  993. This record simply holds the number of shapes in the drawing group and the
  994. last shape id used for this drawing group.
  995. @author Glen Stampoultzis
  996. </summary>
  997. </member>
  998. <member name="M:NPOI.DDF.EscherDgRecord.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.EscherDgRecord.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. <returns>The number of bytes written.</returns>
  1014. <param name="listener">a listener for begin and end serialization events.</param>
  1015. </member>
  1016. <member name="P:NPOI.DDF.EscherDgRecord.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.EscherDgRecord.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.EscherDgRecord.RecordName">
  1029. <summary>
  1030. The short name for this record
  1031. </summary>
  1032. <value></value>
  1033. </member>
  1034. <member name="M:NPOI.DDF.EscherDgRecord.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.EscherDgRecord.NumShapes">
  1043. <summary>
  1044. Gets or sets The number of shapes in this drawing group.
  1045. </summary>
  1046. <value>The num shapes.</value>
  1047. </member>
  1048. <member name="P:NPOI.DDF.EscherDgRecord.LastMSOSPID">
  1049. <summary>
  1050. Gets or sets The last shape id used in this drawing group.
  1051. </summary>
  1052. <value>The last MSOSPID.</value>
  1053. </member>
  1054. <member name="P:NPOI.DDF.EscherDgRecord.DrawingGroupId">
  1055. <summary>
  1056. Gets the drawing group id for this record. This is encoded in the
  1057. instance part of the option record.
  1058. </summary>
  1059. <value>The drawing group id.</value>
  1060. </member>
  1061. <member name="M:NPOI.DDF.EscherDgRecord.IncrementShapeCount">
  1062. <summary>
  1063. Increments the shape count.
  1064. </summary>
  1065. </member>
  1066. <member name="T:NPOI.DDF.EscherMetafileBlip">
  1067. <summary>
  1068. @author Daniel Noll
  1069. </summary>
  1070. </member>
  1071. <member name="F:NPOI.DDF.EscherMetafileBlip.SIGNATURE_EMF">
  1072. BLIP signatures as defined in the escher spec
  1073. </member>
  1074. <member name="F:NPOI.DDF.EscherMetafileBlip.field_2_UID">
  1075. The primary UID is only saved to disk if (blip_instance ^ blip_signature == 1)
  1076. </member>
  1077. <member name="M:NPOI.DDF.EscherMetafileBlip.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  1078. <summary>
  1079. This method deSerializes the record from a byte array.
  1080. </summary>
  1081. <param name="data">The byte array containing the escher record information</param>
  1082. <param name="offset">The starting offset into</param>
  1083. <param name="recordFactory">May be null since this is not a container record.</param>
  1084. <returns>
  1085. The number of bytes Read from the byte array.
  1086. </returns>
  1087. </member>
  1088. <member name="M:NPOI.DDF.EscherMetafileBlip.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  1089. <summary>
  1090. Serializes the record to an existing byte array.
  1091. </summary>
  1092. <param name="offset">the offset within the byte array</param>
  1093. <param name="data">the data array to Serialize to</param>
  1094. <param name="listener">a listener for begin and end serialization events.</param>
  1095. <returns>the number of bytes written.</returns>
  1096. </member>
  1097. <member name="M:NPOI.DDF.EscherMetafileBlip.InflatePictureData(System.Byte[])">
  1098. <summary>
  1099. Decompresses the provided data, returning the inflated result.
  1100. </summary>
  1101. <param name="data">the deflated picture data.</param>
  1102. <returns>the inflated picture data.</returns>
  1103. </member>
  1104. <member name="P:NPOI.DDF.EscherMetafileBlip.RecordSize">
  1105. <summary>
  1106. Returns the number of bytes that are required to Serialize this record.
  1107. </summary>
  1108. <value>Number of bytes</value>
  1109. </member>
  1110. <member name="P:NPOI.DDF.EscherMetafileBlip.UID">
  1111. <summary>
  1112. Gets or sets the UID.
  1113. </summary>
  1114. <value>The UID.</value>
  1115. </member>
  1116. <member name="P:NPOI.DDF.EscherMetafileBlip.PrimaryUID">
  1117. <summary>
  1118. Gets or sets the primary UID.
  1119. </summary>
  1120. <value>The primary UID.</value>
  1121. </member>
  1122. <member name="P:NPOI.DDF.EscherMetafileBlip.UncompressedSize">
  1123. <summary>
  1124. Gets or sets the size of the uncompressed.
  1125. </summary>
  1126. <value>The size of the uncompressed.</value>
  1127. </member>
  1128. <member name="P:NPOI.DDF.EscherMetafileBlip.Bounds">
  1129. <summary>
  1130. Gets or sets the bounds.
  1131. </summary>
  1132. <value>The bounds.</value>
  1133. </member>
  1134. <member name="P:NPOI.DDF.EscherMetafileBlip.SizeEMU">
  1135. <summary>
  1136. Gets or sets the size EMU.
  1137. </summary>
  1138. <value>The size EMU.</value>
  1139. </member>
  1140. <member name="P:NPOI.DDF.EscherMetafileBlip.CompressedSize">
  1141. <summary>
  1142. Gets or sets the size of the compressed.
  1143. </summary>
  1144. <value>The size of the compressed.</value>
  1145. </member>
  1146. <member name="P:NPOI.DDF.EscherMetafileBlip.IsCompressed">
  1147. <summary>
  1148. Gets or sets a value indicating whether this instance is compressed.
  1149. </summary>
  1150. <value>
  1151. <c>true</c> if this instance is compressed; otherwise, <c>false</c>.
  1152. </value>
  1153. </member>
  1154. <member name="M:NPOI.DDF.EscherMetafileBlip.ToString">
  1155. <summary>
  1156. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1157. </summary>
  1158. <returns>
  1159. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1160. </returns>
  1161. </member>
  1162. <member name="P:NPOI.DDF.EscherMetafileBlip.Signature">
  1163. <summary>
  1164. Return the blip signature
  1165. </summary>
  1166. <value>the blip signature</value>
  1167. </member>
  1168. <member name="T:NPOI.DDF.EscherOptRecord">
  1169. <summary>
  1170. The opt record is used to store property values for a shape. It is the key to determining
  1171. the attributes of a shape. Properties can be of two types: simple or complex. Simple types
  1172. are fixed Length. Complex properties are variable Length.
  1173. @author Glen Stampoultzis
  1174. </summary>
  1175. </member>
  1176. <member name="P:NPOI.DDF.EscherOptRecord.Options">
  1177. <summary>
  1178. Automatically recalculate the correct option
  1179. </summary>
  1180. <value></value>
  1181. </member>
  1182. <member name="P:NPOI.DDF.EscherOptRecord.RecordName">
  1183. <summary>
  1184. The short name for this record
  1185. </summary>
  1186. <value></value>
  1187. </member>
  1188. <member name="T:NPOI.DDF.EscherProperties">
  1189. <summary>
  1190. Provides a list of all known escher properties including the description and
  1191. type.
  1192. @author Glen Stampoultzis (glens at apache.org)
  1193. </summary>
  1194. </member>
  1195. <member name="M:NPOI.DDF.EscherProperties.InitProps">
  1196. <summary>
  1197. Inits the props.
  1198. </summary>
  1199. </member>
  1200. <member name="M:NPOI.DDF.EscherProperties.AddProp(System.Int32,NPOI.DDF.EscherPropertyMetaData)">
  1201. <summary>
  1202. Adds the prop.
  1203. </summary>
  1204. <param name="s">The s.</param>
  1205. <param name="data">The data.</param>
  1206. </member>
  1207. <member name="M:NPOI.DDF.EscherProperties.GetData(System.String,System.Byte)">
  1208. <summary>
  1209. Gets the data.
  1210. </summary>
  1211. <param name="propName">Name of the prop.</param>
  1212. <param name="type">The type.</param>
  1213. <returns></returns>
  1214. </member>
  1215. <member name="M:NPOI.DDF.EscherProperties.GetData(System.String)">
  1216. <summary>
  1217. Gets the data.
  1218. </summary>
  1219. <param name="propName">Name of the prop.</param>
  1220. <returns></returns>
  1221. </member>
  1222. <member name="M:NPOI.DDF.EscherProperties.GetPropertyName(System.Int16)">
  1223. <summary>
  1224. Gets the name of the property.
  1225. </summary>
  1226. <param name="propertyId">The property id.</param>
  1227. <returns></returns>
  1228. </member>
  1229. <member name="M:NPOI.DDF.EscherProperties.GetPropertyType(System.Int16)">
  1230. <summary>
  1231. Gets the type of the property.
  1232. </summary>
  1233. <param name="propertyId">The property id.</param>
  1234. <returns></returns>
  1235. </member>
  1236. <member name="T:NPOI.DDF.EscherProperty">
  1237. <summary>
  1238. This is the abstract base class for all escher properties.
  1239. @see EscherOptRecord
  1240. @author Glen Stampoultzis (glens at apache.org)
  1241. </summary>
  1242. </member>
  1243. <member name="M:NPOI.DDF.EscherProperty.#ctor(System.Int16)">
  1244. <summary>
  1245. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherProperty"/> class.
  1246. </summary>
  1247. <param name="id">The id is distinct from the actual property number. The id includes the property number the blip id
  1248. flag and an indicator whether the property is complex or not.</param>
  1249. </member>
  1250. <member name="M:NPOI.DDF.EscherProperty.#ctor(System.Int16,System.Boolean,System.Boolean)">
  1251. <summary>
  1252. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherProperty"/> class.The three parameters are combined to form a property
  1253. id.
  1254. </summary>
  1255. <param name="propertyNumber">The property number.</param>
  1256. <param name="isComplex">if set to <c>true</c> [is complex].</param>
  1257. <param name="isBlipId">if set to <c>true</c> [is blip id].</param>
  1258. </member>
  1259. <member name="P:NPOI.DDF.EscherProperty.Id">
  1260. <summary>
  1261. Gets the id.
  1262. </summary>
  1263. <value>The id.</value>
  1264. </member>
  1265. <member name="P:NPOI.DDF.EscherProperty.PropertyNumber">
  1266. <summary>
  1267. Gets the property number.
  1268. </summary>
  1269. <value>The property number.</value>
  1270. </member>
  1271. <member name="P:NPOI.DDF.EscherProperty.IsComplex">
  1272. <summary>
  1273. Gets a value indicating whether this instance is complex.
  1274. </summary>
  1275. <value>
  1276. <c>true</c> if this instance is complex; otherwise, <c>false</c>.
  1277. </value>
  1278. </member>
  1279. <member name="P:NPOI.DDF.EscherProperty.IsBlipId">
  1280. <summary>
  1281. Gets a value indicating whether this instance is blip id.
  1282. </summary>
  1283. <value>
  1284. <c>true</c> if this instance is blip id; otherwise, <c>false</c>.
  1285. </value>
  1286. </member>
  1287. <member name="P:NPOI.DDF.EscherProperty.Name">
  1288. <summary>
  1289. Gets the name.
  1290. </summary>
  1291. <value>The name.</value>
  1292. </member>
  1293. <member name="P:NPOI.DDF.EscherProperty.PropertySize">
  1294. <summary>
  1295. Most properties are just 6 bytes in Length. Override this if we're
  1296. dealing with complex properties.
  1297. </summary>
  1298. <value>The size of the property.</value>
  1299. </member>
  1300. <member name="M:NPOI.DDF.EscherProperty.SerializeSimplePart(System.Byte[],System.Int32)">
  1301. <summary>
  1302. Escher properties consist of a simple fixed Length part and a complex variable Length part.
  1303. The fixed Length part is Serialized first.
  1304. </summary>
  1305. <param name="data">The data.</param>
  1306. <param name="pos">The pos.</param>
  1307. <returns></returns>
  1308. </member>
  1309. <member name="M:NPOI.DDF.EscherProperty.SerializeComplexPart(System.Byte[],System.Int32)">
  1310. <summary>
  1311. Escher properties consist of a simple fixed Length part and a complex variable Length part.
  1312. The fixed Length part is Serialized first.
  1313. </summary>
  1314. <param name="data">The data.</param>
  1315. <param name="pos">The pos.</param>
  1316. <returns></returns>
  1317. </member>
  1318. <member name="T:NPOI.DDF.EscherPropertyFactory">
  1319. <summary>
  1320. Generates a property given a reference into the byte array storing that property.
  1321. @author Glen Stampoultzis
  1322. </summary>
  1323. </member>
  1324. <member name="M:NPOI.DDF.EscherPropertyFactory.CreateProperties(System.Byte[],System.Int32,System.Int16)">
  1325. <summary>
  1326. Create new properties from a byte array.
  1327. </summary>
  1328. <param name="data">The byte array containing the property</param>
  1329. <param name="offset">The starting offset into the byte array</param>
  1330. <param name="numProperties">The new properties</param>
  1331. <returns></returns>
  1332. </member>
  1333. <member name="T:NPOI.DDF.EscherPropertyMetaData">
  1334. <summary>
  1335. This class stores the type and description of an escher property.
  1336. @author Glen Stampoultzis (glens at apache.org)
  1337. </summary>
  1338. </member>
  1339. <member name="M:NPOI.DDF.EscherPropertyMetaData.#ctor(System.String)">
  1340. <summary>
  1341. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherPropertyMetaData"/> class.
  1342. </summary>
  1343. <param name="description">The description of the escher property.</param>
  1344. </member>
  1345. <member name="M:NPOI.DDF.EscherPropertyMetaData.#ctor(System.String,System.Byte)">
  1346. <summary>
  1347. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherPropertyMetaData"/> class.
  1348. </summary>
  1349. <param name="description">The description of the escher property.</param>
  1350. <param name="type">The type of the property.</param>
  1351. </member>
  1352. <member name="P:NPOI.DDF.EscherPropertyMetaData.Description">
  1353. <summary>
  1354. Gets the description.
  1355. </summary>
  1356. <value>The description.</value>
  1357. </member>
  1358. <member name="P:NPOI.DDF.EscherPropertyMetaData.Type">
  1359. <summary>
  1360. Gets the type.
  1361. </summary>
  1362. <value>The type.</value>
  1363. </member>
  1364. <member name="T:NPOI.DDF.EscherRecord">
  1365. <summary>
  1366. The base abstract record from which all escher records are defined. Subclasses will need
  1367. to define methods for serialization/deserialization and for determining the record size.
  1368. </summary>
  1369. </member>
  1370. <member name="M:NPOI.DDF.EscherRecord.#ctor">
  1371. <summary>
  1372. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherRecord"/> class.
  1373. </summary>
  1374. </member>
  1375. <member name="M:NPOI.DDF.EscherRecord.FillFields(System.Byte[],NPOI.DDF.IEscherRecordFactory)">
  1376. <summary>
  1377. Delegates to FillFields(byte[], int, EscherRecordFactory)
  1378. </summary>
  1379. <param name="data">the bytes to serialize from</param>
  1380. <param name="f">the escher record factory</param>
  1381. <returns>The number of bytes written.</returns>
  1382. </member>
  1383. <member name="M:NPOI.DDF.EscherRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  1384. <summary>
  1385. The contract of this method is to deSerialize an escher record including
  1386. it's children.
  1387. </summary>
  1388. <param name="data">The byte array containing the Serialized escher
  1389. records.</param>
  1390. <param name="offset">The offset into the byte array.</param>
  1391. <param name="recordFactory">A factory for creating new escher records.</param>
  1392. <returns>The number of bytes written.</returns>
  1393. </member>
  1394. <member name="M:NPOI.DDF.EscherRecord.ReadHeader(System.Byte[],System.Int32)">
  1395. <summary>
  1396. Reads the 8 byte header information and populates the
  1397. <c>options</c>
  1398. and
  1399. <c>recordId</c>
  1400. records.
  1401. </summary>
  1402. <param name="data">the byte array to Read from</param>
  1403. <param name="offset">the offset to start Reading from</param>
  1404. <returns>the number of bytes remaining in this record. This</returns>
  1405. </member>
  1406. <member name="M:NPOI.DDF.EscherRecord.ReadInstance(System.Byte[],System.Int32)">
  1407. <summary>
  1408. Read the options field from header and return instance part of it.
  1409. </summary>
  1410. <param name="data">the byte array to read from</param>
  1411. <param name="offset">the offset to start reading from</param>
  1412. <returns>value of instance part of options field</returns>
  1413. </member>
  1414. <member name="P:NPOI.DDF.EscherRecord.IsContainerRecord">
  1415. <summary>
  1416. Determine whether this is a container record by inspecting the option
  1417. field.
  1418. </summary>
  1419. <value>
  1420. <c>true</c> if this instance is container record; otherwise, <c>false</c>.
  1421. </value>
  1422. </member>
  1423. <member name="P:NPOI.DDF.EscherRecord.Options">
  1424. <summary>
  1425. Gets or sets the options field for this record. All records have one
  1426. </summary>
  1427. <value>The options.</value>
  1428. </member>
  1429. <member name="M:NPOI.DDF.EscherRecord.Serialize">
  1430. <summary>
  1431. Serializes to a new byte array. This is done by delegating to
  1432. Serialize(int, byte[]);
  1433. </summary>
  1434. <returns>the Serialized record.</returns>
  1435. </member>
  1436. <member name="M:NPOI.DDF.EscherRecord.Serialize(System.Int32,System.Byte[])">
  1437. <summary>
  1438. Serializes to an existing byte array without serialization listener.
  1439. This is done by delegating to Serialize(int, byte[], EscherSerializationListener).
  1440. </summary>
  1441. <param name="offset">the offset within the data byte array.</param>
  1442. <param name="data">the data array to Serialize to.</param>
  1443. <returns>The number of bytes written.</returns>
  1444. </member>
  1445. <member name="M:NPOI.DDF.EscherRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  1446. <summary>
  1447. Serializes the record to an existing byte array.
  1448. </summary>
  1449. <param name="offset">the offset within the byte array.</param>
  1450. <param name="data">the offset within the byte array</param>
  1451. <param name="listener">a listener for begin and end serialization events. This.
  1452. is useful because the serialization is
  1453. hierarchical/recursive and sometimes you need to be able
  1454. break into that.
  1455. </param>
  1456. <returns></returns>
  1457. </member>
  1458. <member name="P:NPOI.DDF.EscherRecord.RecordSize">
  1459. <summary>
  1460. Subclasses should effeciently return the number of bytes required to
  1461. Serialize the record.
  1462. </summary>
  1463. <value>number of bytes</value>
  1464. </member>
  1465. <member name="P:NPOI.DDF.EscherRecord.RecordId">
  1466. <summary>
  1467. Return the current record id.
  1468. </summary>
  1469. <value>The 16 bit record id.</value>
  1470. </member>
  1471. <member name="P:NPOI.DDF.EscherRecord.ChildRecords">
  1472. <summary>
  1473. Gets or sets the child records.
  1474. </summary>
  1475. <value>Returns the children of this record. By default this will
  1476. be an empty list. EscherCotainerRecord is the only record that may contain children.</value>
  1477. </member>
  1478. <member name="M:NPOI.DDF.EscherRecord.Clone">
  1479. <summary>
  1480. Creates a new object that is a copy of the current instance.
  1481. </summary>
  1482. <returns>
  1483. A new object that is a copy of this instance.
  1484. </returns>
  1485. </member>
  1486. <member name="M:NPOI.DDF.EscherRecord.GetChild(System.Int32)">
  1487. <summary>
  1488. Returns the indexed child record.
  1489. </summary>
  1490. <param name="index">The index.</param>
  1491. <returns></returns>
  1492. </member>
  1493. <member name="M:NPOI.DDF.EscherRecord.Display(System.Int32)">
  1494. <summary>
  1495. The display methods allows escher variables to print the record names
  1496. according to their hierarchy.
  1497. </summary>
  1498. <param name="indent">The current indent level.</param>
  1499. </member>
  1500. <member name="P:NPOI.DDF.EscherRecord.RecordName">
  1501. <summary>
  1502. Gets the name of the record.
  1503. </summary>
  1504. <value>The name of the record.</value>
  1505. </member>
  1506. <member name="P:NPOI.DDF.EscherRecord.Instance">
  1507. <summary>
  1508. Get or set the instance part of the option record.
  1509. </summary>
  1510. </member>
  1511. <member name="P:NPOI.DDF.EscherRecord.Version">
  1512. <summary>
  1513. Get or set the version part of the option record.
  1514. </summary>
  1515. </member>
  1516. <member name="M:NPOI.DDF.EscherRecord.ToXml(System.String)">
  1517. @param tab - each children must be a right of his parent
  1518. @return xml representation of this record
  1519. </member>
  1520. <member name="T:NPOI.DDF.IEscherRecordFactory">
  1521. <summary>
  1522. The escher record factory interface allows for the creation of escher
  1523. records from a pointer into a data array.
  1524. @author Glen Stampoultzis (glens at apache.org)
  1525. </summary>
  1526. </member>
  1527. <member name="M:NPOI.DDF.IEscherRecordFactory.CreateRecord(System.Byte[],System.Int32)">
  1528. <summary>
  1529. Create a new escher record from the data provided. Does not attempt
  1530. to Fill the contents of the record however.
  1531. </summary>
  1532. <param name="data">The data.</param>
  1533. <param name="offset">The off set.</param>
  1534. <returns></returns>
  1535. </member>
  1536. <member name="T:NPOI.DDF.EscherRGBProperty">
  1537. <summary>
  1538. A color property.
  1539. @author Glen Stampoultzis (glens at apache.org)
  1540. </summary>
  1541. </member>
  1542. <member name="M:NPOI.DDF.EscherRGBProperty.#ctor(System.Int16,System.Int32)">
  1543. <summary>
  1544. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherRGBProperty"/> class.
  1545. </summary>
  1546. <param name="propertyNumber">The property number.</param>
  1547. <param name="rgbColor">Color of the RGB.</param>
  1548. </member>
  1549. <member name="P:NPOI.DDF.EscherRGBProperty.RgbColor">
  1550. <summary>
  1551. Gets the color of the RGB.
  1552. </summary>
  1553. <value>The color of the RGB.</value>
  1554. </member>
  1555. <member name="P:NPOI.DDF.EscherRGBProperty.Red">
  1556. <summary>
  1557. Gets the red.
  1558. </summary>
  1559. <value>The red.</value>
  1560. </member>
  1561. <member name="P:NPOI.DDF.EscherRGBProperty.Green">
  1562. <summary>
  1563. Gets the green.
  1564. </summary>
  1565. <value>The green.</value>
  1566. </member>
  1567. <member name="P:NPOI.DDF.EscherRGBProperty.Blue">
  1568. <summary>
  1569. Gets the blue.
  1570. </summary>
  1571. <value>The blue.</value>
  1572. </member>
  1573. <member name="T:NPOI.DDF.EscherSerializationListener">
  1574. Interface for listening to escher serialization events.
  1575. @author Glen Stampoultzis (glens at apache.org)
  1576. </member>
  1577. <member name="M:NPOI.DDF.EscherSerializationListener.BeforeRecordSerialize(System.Int32,System.Int16,NPOI.DDF.EscherRecord)">
  1578. Fired before a given escher record is Serialized.
  1579. @param offset The position in the data array at which the record will be Serialized.
  1580. @param recordId The id of the record about to be Serialized.
  1581. </member>
  1582. <member name="M:NPOI.DDF.EscherSerializationListener.AfterRecordSerialize(System.Int32,System.Int16,System.Int32,NPOI.DDF.EscherRecord)">
  1583. Fired after a record has been Serialized.
  1584. @param offset The position of the end of the Serialized record + 1
  1585. @param recordId The id of the record about to be Serialized
  1586. @param size The number of bytes written for this record. If it is a container
  1587. record then this will include the size of any included records.
  1588. </member>
  1589. <member name="T:NPOI.DDF.EscherShapePathProperty">
  1590. <summary>
  1591. Defines the constants for the various possible shape paths.
  1592. @author Glen Stampoultzis (glens at apache.org)
  1593. </summary>
  1594. </member>
  1595. <member name="M:NPOI.DDF.EscherShapePathProperty.#ctor(System.Int16,System.Int32)">
  1596. <summary>
  1597. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherShapePathProperty"/> class.
  1598. </summary>
  1599. <param name="propertyNumber">The property number.</param>
  1600. <param name="shapePath">The shape path.</param>
  1601. </member>
  1602. <member name="T:NPOI.DDF.EscherSimpleProperty">
  1603. <summary>
  1604. A simple property is of fixed Length and as a property number in Addition
  1605. to a 32-bit value. Properties that can't be stored in only 32-bits are
  1606. stored as EscherComplexProperty objects.
  1607. @author Glen Stampoultzis (glens at apache.org)
  1608. </summary>
  1609. </member>
  1610. <member name="M:NPOI.DDF.EscherSimpleProperty.#ctor(System.Int16,System.Int32)">
  1611. <summary>
  1612. The id is distinct from the actual property number. The id includes the property number the blip id
  1613. flag and an indicator whether the property is complex or not.
  1614. </summary>
  1615. <param name="id">The id.</param>
  1616. <param name="propertyValue">The property value.</param>
  1617. </member>
  1618. <member name="M:NPOI.DDF.EscherSimpleProperty.#ctor(System.Int16,System.Boolean,System.Boolean,System.Int32)">
  1619. <summary>
  1620. Constructs a new escher property. The three parameters are combined to form a property
  1621. id.
  1622. </summary>
  1623. <param name="propertyNumber">The property number.</param>
  1624. <param name="isComplex">if set to <c>true</c> [is complex].</param>
  1625. <param name="isBlipId">if set to <c>true</c> [is blip id].</param>
  1626. <param name="propertyValue">The property value.</param>
  1627. </member>
  1628. <member name="M:NPOI.DDF.EscherSimpleProperty.SerializeSimplePart(System.Byte[],System.Int32)">
  1629. <summary>
  1630. Serialize the simple part of the escher record.
  1631. </summary>
  1632. <param name="data">The data.</param>
  1633. <param name="offset">The off set.</param>
  1634. <returns>the number of bytes Serialized.</returns>
  1635. </member>
  1636. <member name="M:NPOI.DDF.EscherSimpleProperty.SerializeComplexPart(System.Byte[],System.Int32)">
  1637. <summary>
  1638. Escher properties consist of a simple fixed Length part and a complex variable Length part.
  1639. The fixed Length part is Serialized first.
  1640. </summary>
  1641. <param name="data"></param>
  1642. <param name="pos"></param>
  1643. <returns></returns>
  1644. </member>
  1645. <member name="P:NPOI.DDF.EscherSimpleProperty.PropertyValue">
  1646. <summary>
  1647. Return the 32 bit value of this property.
  1648. </summary>
  1649. <value>The property value.</value>
  1650. </member>
  1651. <member name="M:NPOI.DDF.EscherSimpleProperty.Equals(System.Object)">
  1652. <summary>
  1653. Returns true if one escher property is equal to another.
  1654. </summary>
  1655. <param name="o">The o.</param>
  1656. <returns></returns>
  1657. </member>
  1658. <member name="M:NPOI.DDF.EscherSimpleProperty.GetHashCode">
  1659. <summary>
  1660. Serves as a hash function for a particular type.
  1661. </summary>
  1662. <returns>
  1663. A hash code for the current <see cref="T:System.Object"/>.
  1664. </returns>
  1665. </member>
  1666. <member name="M:NPOI.DDF.EscherSimpleProperty.ToString">
  1667. <summary>
  1668. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1669. </summary>
  1670. <returns>
  1671. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1672. </returns>
  1673. </member>
  1674. <member name="T:NPOI.DDF.EscherSpgrRecord">
  1675. <summary>
  1676. The spgr record defines information about a shape group. Groups in escher
  1677. are simply another form of shape that you can't physically see.
  1678. @author Glen Stampoultzis (glens at apache.org)
  1679. </summary>
  1680. </member>
  1681. <member name="M:NPOI.DDF.EscherSpgrRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  1682. <summary>
  1683. This method deSerializes the record from a byte array.
  1684. </summary>
  1685. <param name="data">The byte array containing the escher record information</param>
  1686. <param name="offset">The starting offset into data</param>
  1687. <param name="recordFactory">May be null since this is not a container record.</param>
  1688. <returns>The number of bytes Read from the byte array.</returns>
  1689. </member>
  1690. <member name="M:NPOI.DDF.EscherSpgrRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  1691. <summary>
  1692. This method Serializes this escher record into a byte array
  1693. </summary>
  1694. <param name="offset">The offset into data
  1695. to start writing the record data to.</param>
  1696. <param name="data">The byte array to Serialize to.</param>
  1697. <param name="listener">a listener for begin and end serialization events.</param>
  1698. <returns>The number of bytes written.</returns>
  1699. </member>
  1700. <member name="P:NPOI.DDF.EscherSpgrRecord.RecordSize">
  1701. <summary>
  1702. Returns the number of bytes that are required to Serialize this record.
  1703. </summary>
  1704. <value>Number of bytes</value>
  1705. </member>
  1706. <member name="P:NPOI.DDF.EscherSpgrRecord.RecordId">
  1707. <summary>
  1708. Return the current record id.
  1709. </summary>
  1710. <value>The 16 bit identifier of this shape group record.</value>
  1711. </member>
  1712. <member name="P:NPOI.DDF.EscherSpgrRecord.RecordName">
  1713. <summary>
  1714. The short name for this record
  1715. </summary>
  1716. <value></value>
  1717. </member>
  1718. <member name="M:NPOI.DDF.EscherSpgrRecord.ToString">
  1719. <summary>
  1720. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1721. </summary>
  1722. <returns>
  1723. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1724. </returns>
  1725. </member>
  1726. <member name="P:NPOI.DDF.EscherSpgrRecord.RectX1">
  1727. <summary>
  1728. Gets or sets the starting top-left coordinate of child records.
  1729. </summary>
  1730. <value>The rect x1.</value>
  1731. </member>
  1732. <member name="P:NPOI.DDF.EscherSpgrRecord.RectX2">
  1733. <summary>
  1734. Gets or sets the starting bottom-right coordinate of child records.
  1735. </summary>
  1736. <value>The rect x2.</value>
  1737. </member>
  1738. <member name="P:NPOI.DDF.EscherSpgrRecord.RectY1">
  1739. <summary>
  1740. Gets or sets the starting top-left coordinate of child records.
  1741. </summary>
  1742. <value>The rect y1.</value>
  1743. </member>
  1744. <member name="P:NPOI.DDF.EscherSpgrRecord.RectY2">
  1745. <summary>
  1746. Gets or sets the starting bottom-right coordinate of child records.
  1747. </summary>
  1748. <value>The rect y2.</value>
  1749. </member>
  1750. <member name="T:NPOI.DDF.EscherSplitMenuColorsRecord">
  1751. <summary>
  1752. A list of the most recently used colours for the drawings contained in
  1753. this document.
  1754. @author Glen Stampoultzis (glens at apache.org)
  1755. </summary>
  1756. </member>
  1757. <member name="M:NPOI.DDF.EscherSplitMenuColorsRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  1758. <summary>
  1759. This method deSerializes the record from a byte array.
  1760. </summary>
  1761. <param name="data">The byte array containing the escher record information</param>
  1762. <param name="offset">The starting offset into data</param>
  1763. <param name="recordFactory">May be null since this is not a container record.</param>
  1764. <returns>The number of bytes Read from the byte array.</returns>
  1765. </member>
  1766. <member name="M:NPOI.DDF.EscherSplitMenuColorsRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  1767. <summary>
  1768. This method Serializes this escher record into a byte array
  1769. </summary>
  1770. <param name="offset">The offset into data
  1771. to start writing the record data to.</param>
  1772. <param name="data">The byte array to Serialize to.</param>
  1773. <param name="listener">a listener for begin and end serialization events.</param>
  1774. <returns>The number of bytes written.</returns>
  1775. </member>
  1776. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.RecordSize">
  1777. <summary>
  1778. Returns the number of bytes that are required to Serialize this record.
  1779. </summary>
  1780. <value>number of bytes</value>
  1781. </member>
  1782. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.RecordId">
  1783. <summary>
  1784. Return the current record id.
  1785. </summary>
  1786. <value>the 16 bit identifer for this record.</value>
  1787. </member>
  1788. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.RecordName">
  1789. <summary>
  1790. Gets the short name for this record
  1791. </summary>
  1792. <value>The name of the record.</value>
  1793. </member>
  1794. <member name="M:NPOI.DDF.EscherSplitMenuColorsRecord.ToString">
  1795. <summary>
  1796. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1797. </summary>
  1798. <returns>
  1799. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1800. </returns>
  1801. @return a string representation of this record.
  1802. </member>
  1803. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.Color1">
  1804. <summary>
  1805. Gets or sets the color1.
  1806. </summary>
  1807. <value>The color1.</value>
  1808. </member>
  1809. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.Color2">
  1810. <summary>
  1811. Gets or sets the color2.
  1812. </summary>
  1813. <value>The color2.</value>
  1814. </member>
  1815. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.Color3">
  1816. <summary>
  1817. Gets or sets the color3.
  1818. </summary>
  1819. <value>The color3.</value>
  1820. </member>
  1821. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.Color4">
  1822. <summary>
  1823. Gets or sets the color4.
  1824. </summary>
  1825. <value>The color4.</value>
  1826. </member>
  1827. <member name="T:NPOI.DDF.EscherSpRecord">
  1828. <summary>
  1829. ToGether the the EscherOptRecord this record defines some of the basic
  1830. properties of a shape.
  1831. @author Glen Stampoultzis (glens at apache.org)
  1832. </summary>
  1833. </member>
  1834. <member name="M:NPOI.DDF.EscherSpRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  1835. <summary>
  1836. The contract of this method is to deSerialize an escher record including
  1837. it's children.
  1838. </summary>
  1839. <param name="data">The byte array containing the Serialized escher
  1840. records.</param>
  1841. <param name="offset">The offset into the byte array.</param>
  1842. <param name="recordFactory">A factory for creating new escher records</param>
  1843. <returns>The number of bytes written.</returns>
  1844. </member>
  1845. <member name="M:NPOI.DDF.EscherSpRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  1846. <summary>
  1847. Serializes to an existing byte array without serialization listener.
  1848. This is done by delegating to Serialize(int, byte[], EscherSerializationListener).
  1849. </summary>
  1850. <param name="offset">the offset within the data byte array.</param>
  1851. <param name="data"> the data array to Serialize to.</param>
  1852. <param name="listener">a listener for begin and end serialization events.</param>
  1853. <returns>The number of bytes written.</returns>
  1854. </member>
  1855. <member name="P:NPOI.DDF.EscherSpRecord.RecordSize">
  1856. <summary>
  1857. Returns the number of bytes that are required to Serialize this record.
  1858. </summary>
  1859. <value>Number of bytes</value>
  1860. </member>
  1861. <member name="P:NPOI.DDF.EscherSpRecord.RecordId">
  1862. <summary>
  1863. @return the 16 bit identifier for this record.
  1864. </summary>
  1865. <value></value>
  1866. </member>
  1867. <member name="P:NPOI.DDF.EscherSpRecord.RecordName">
  1868. <summary>
  1869. The short name for this record
  1870. </summary>
  1871. <value></value>
  1872. </member>
  1873. <member name="M:NPOI.DDF.EscherSpRecord.ToString">
  1874. <summary>
  1875. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1876. </summary>
  1877. <returns>
  1878. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1879. </returns>
  1880. </member>
  1881. <member name="M:NPOI.DDF.EscherSpRecord.DecodeFlags(System.Int32)">
  1882. <summary>
  1883. Converts the shape flags into a more descriptive name.
  1884. </summary>
  1885. <param name="flags">The flags.</param>
  1886. <returns></returns>
  1887. </member>
  1888. <member name="P:NPOI.DDF.EscherSpRecord.ShapeId">
  1889. <summary>
  1890. Gets or sets A number that identifies this shape
  1891. </summary>
  1892. <value>The shape id.</value>
  1893. </member>
  1894. <member name="P:NPOI.DDF.EscherSpRecord.Flags">
  1895. <summary>
  1896. The flags that apply to this shape.
  1897. </summary>
  1898. <value>The flags.</value>
  1899. </member>
  1900. <member name="P:NPOI.DDF.EscherSpRecord.ShapeType">
  1901. <summary>
  1902. Get or set shape type. Must be one of MSOSPT values (see [MS-ODRAW] for details).
  1903. </summary>
  1904. </member>
  1905. <member name="T:NPOI.DDF.EscherTertiaryOptRecord">
  1906. "The OfficeArtTertiaryFOPT record specifies a table of OfficeArtRGFOPTE properties, as defined in section 2.3.1."
  1907. -- [MS-ODRAW] -- v20110608; Office Drawing Binary File Format
  1908. @author Sergey Vladimirov (vlsergey {at} gmail {dot} com)
  1909. </member>
  1910. <member name="T:NPOI.DDF.EscherTextboxRecord">
  1911. <summary>
  1912. Holds data from the parent application. Most commonly used to store
  1913. text in the format of the parent application, rather than in
  1914. Escher format. We don't attempt to understand the contents, since
  1915. they will be in the parent's format, not Escher format.
  1916. @author Glen Stampoultzis (glens at apache.org)
  1917. @author Nick Burch (nick at torchbox dot com)
  1918. </summary>
  1919. </member>
  1920. <member name="F:NPOI.DDF.EscherTextboxRecord._thedata">
  1921. The data for this record not including the the 8 byte header
  1922. </member>
  1923. <member name="M:NPOI.DDF.EscherTextboxRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  1924. This method deserializes the record from a byte array.
  1925. @param data The byte array containing the escher record information
  1926. @param offset The starting offset into <c>data</c>.
  1927. @param recordFactory May be null since this is not a container record.
  1928. @return The number of bytes Read from the byte array.
  1929. </member>
  1930. <member name="M:NPOI.DDF.EscherTextboxRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  1931. <summary>
  1932. Writes this record and any contained records to the supplied byte
  1933. </summary>
  1934. <param name="offset"></param>
  1935. <param name="data"></param>
  1936. <param name="listener">a listener for begin and end serialization events.</param>
  1937. <returns>the number of bytes written.</returns>
  1938. </member>
  1939. <member name="P:NPOI.DDF.EscherTextboxRecord.Data">
  1940. <summary>
  1941. Returns any extra data associated with this record. In practice excel
  1942. does not seem to put anything here, but with PowerPoint this will
  1943. contain the bytes that make up a TextHeaderAtom followed by a
  1944. TextBytesAtom/TextCharsAtom
  1945. </summary>
  1946. <value>The data.</value>
  1947. </member>
  1948. <member name="M:NPOI.DDF.EscherTextboxRecord.SetData(System.Byte[],System.Int32,System.Int32)">
  1949. <summary>
  1950. Sets the extra data (in the parent application's format) to be
  1951. contained by the record. Used when the parent application changes
  1952. the contents.
  1953. </summary>
  1954. <param name="b">The b.</param>
  1955. <param name="start">The start.</param>
  1956. <param name="length">The length.</param>
  1957. </member>
  1958. <member name="M:NPOI.DDF.EscherTextboxRecord.SetData(System.Byte[])">
  1959. <summary>
  1960. Sets the data.
  1961. </summary>
  1962. <param name="b">The b.</param>
  1963. </member>
  1964. <member name="P:NPOI.DDF.EscherTextboxRecord.RecordSize">
  1965. <summary>
  1966. Returns the number of bytes that are required to serialize this record.
  1967. </summary>
  1968. <value>Number of bytes</value>
  1969. </member>
  1970. <member name="P:NPOI.DDF.EscherTextboxRecord.RecordName">
  1971. <summary>
  1972. The short name for this record
  1973. </summary>
  1974. <value></value>
  1975. </member>
  1976. <member name="M:NPOI.DDF.EscherTextboxRecord.ToString">
  1977. <summary>
  1978. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1979. </summary>
  1980. <returns>
  1981. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1982. </returns>
  1983. </member>
  1984. <member name="T:NPOI.DDF.UnknownEscherRecord">
  1985. <summary>
  1986. This record is used whenever a escher record is encountered that
  1987. we do not explicitly support.
  1988. @author Glen Stampoultzis (glens at apache.org)
  1989. </summary>
  1990. </member>
  1991. <member name="F:NPOI.DDF.UnknownEscherRecord._thedata">
  1992. The data for this record not including the the 8 byte header
  1993. </member>
  1994. <member name="M:NPOI.DDF.UnknownEscherRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  1995. <summary>
  1996. This method deSerializes the record from a byte array.
  1997. </summary>
  1998. <param name="data"> The byte array containing the escher record information</param>
  1999. <param name="offset">The starting offset into data </param>
  2000. <param name="recordFactory">May be null since this is not a container record.</param>
  2001. <returns>The number of bytes Read from the byte array.</returns>
  2002. </member>
  2003. <member name="M:NPOI.DDF.UnknownEscherRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  2004. <summary>
  2005. Writes this record and any contained records to the supplied byte
  2006. array.
  2007. </summary>
  2008. <param name="offset"></param>
  2009. <param name="data"></param>
  2010. <param name="listener">a listener for begin and end serialization events.</param>
  2011. <returns>the number of bytes written.</returns>
  2012. </member>
  2013. <member name="P:NPOI.DDF.UnknownEscherRecord.Data">
  2014. <summary>
  2015. Gets the data.
  2016. </summary>
  2017. <value>The data.</value>
  2018. </member>
  2019. <member name="P:NPOI.DDF.UnknownEscherRecord.RecordSize">
  2020. <summary>
  2021. Returns the number of bytes that are required to Serialize this record.
  2022. </summary>
  2023. <value>Number of bytes</value>
  2024. </member>
  2025. <member name="P:NPOI.DDF.UnknownEscherRecord.ChildRecords">
  2026. <summary>
  2027. Returns the children of this record. By default this will
  2028. be an empty list. EscherCotainerRecord is the only record
  2029. that may contain children.
  2030. </summary>
  2031. <value></value>
  2032. </member>
  2033. <member name="P:NPOI.DDF.UnknownEscherRecord.RecordName">
  2034. <summary>
  2035. The short name for this record
  2036. </summary>
  2037. <value></value>
  2038. </member>
  2039. <member name="M:NPOI.DDF.UnknownEscherRecord.ToString">
  2040. <summary>
  2041. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  2042. </summary>
  2043. <returns>
  2044. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  2045. </returns>
  2046. </member>
  2047. <member name="M:NPOI.DDF.UnknownEscherRecord.AddChildRecord(NPOI.DDF.EscherRecord)">
  2048. <summary>
  2049. Adds the child record.
  2050. </summary>
  2051. <param name="childRecord">The child record.</param>
  2052. </member>
  2053. <member name="T:NPOI.HPSF.CustomProperties">
  2054. <summary>
  2055. Maintains the instances of {@link CustomProperty} that belong To a
  2056. {@link DocumentSummaryInformation}. The class maintains the names of the
  2057. custom properties in a dictionary. It implements the {@link Map} interface
  2058. and by this provides a simplified view on custom properties: A property's
  2059. name is the key that maps To a typed value. This implementation hides
  2060. property IDs from the developer and regards the property names as keys To
  2061. typed values.
  2062. While this class provides a simple API To custom properties, it ignores
  2063. the fact that not names, but IDs are the real keys To properties. Under the
  2064. hood this class maintains a 1:1 relationship between IDs and names. Therefore
  2065. you should not use this class To process property Sets with several IDs
  2066. mapping To the same name or with properties without a name: the result will
  2067. contain only a subSet of the original properties. If you really need To deal
  2068. such property Sets, use HPSF's low-level access methods.
  2069. An application can call the {@link #isPure} method To check whether a
  2070. property Set parsed by {@link CustomProperties} is still pure (i.e.
  2071. unmodified) or whether one or more properties have been dropped.
  2072. This class is not thRead-safe; concurrent access To instances of this
  2073. class must be syncronized.
  2074. @author Rainer Klute
  2075. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  2076. @since 2006-02-09
  2077. </summary>
  2078. </member>
  2079. <member name="F:NPOI.HPSF.CustomProperties.dictionaryIDToName">
  2080. Maps property IDs To property names.
  2081. </member>
  2082. <member name="F:NPOI.HPSF.CustomProperties.dictionaryNameToID">
  2083. Maps property names To property IDs.
  2084. </member>
  2085. <member name="F:NPOI.HPSF.CustomProperties.isPure">
  2086. Tells whether this object is pure or not.
  2087. </member>
  2088. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,NPOI.HPSF.CustomProperty)">
  2089. <summary>
  2090. Puts a {@link CustomProperty} into this map. It is assumed that the
  2091. {@link CustomProperty} alReady has a valid ID. Otherwise use
  2092. {@link #Put(CustomProperty)}.
  2093. </summary>
  2094. <param name="name">The name.</param>
  2095. <param name="cp">The custom property.</param>
  2096. <returns></returns>
  2097. </member>
  2098. <member name="M:NPOI.HPSF.CustomProperties.KeySet">
  2099. Returns a set of all the names of our
  2100. custom properties. Equivalent to
  2101. {@link #nameSet()}
  2102. </member>
  2103. <member name="M:NPOI.HPSF.CustomProperties.NameSet">
  2104. Returns a set of all the names of our
  2105. custom properties
  2106. </member>
  2107. <member name="M:NPOI.HPSF.CustomProperties.IdSet">
  2108. Returns a set of all the IDs of our
  2109. custom properties
  2110. </member>
  2111. <member name="M:NPOI.HPSF.CustomProperties.Put(NPOI.HPSF.CustomProperty)">
  2112. <summary>
  2113. Puts a {@link CustomProperty} that has not yet a valid ID into this
  2114. map. The method will allocate a suitable ID for the custom property:
  2115. <ul>
  2116. <li>If there is alReady a property with the same name, take the ID
  2117. of that property.</li>
  2118. <li>Otherwise Find the highest ID and use its value plus one.</li>
  2119. </ul>
  2120. </summary>
  2121. <param name="customProperty">The custom property.</param>
  2122. <returns>If the was alReady a property with the same name, the</returns>
  2123. </member>
  2124. <member name="M:NPOI.HPSF.CustomProperties.Remove(System.String)">
  2125. <summary>
  2126. Removes a custom property.
  2127. </summary>
  2128. <param name="name">The name of the custom property To Remove</param>
  2129. <returns>The Removed property or
  2130. <c>null</c>
  2131. if the specified property was not found.</returns>
  2132. </member>
  2133. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.String)">
  2134. <summary>
  2135. Adds a named string property.
  2136. </summary>
  2137. <param name="name">The property's name.</param>
  2138. <param name="value">The property's value.</param>
  2139. <returns>the property that was stored under the specified name before, or
  2140. <c>null</c>
  2141. if there was no such property before.</returns>
  2142. </member>
  2143. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.Int64)">
  2144. <summary>
  2145. Adds a named long property
  2146. </summary>
  2147. <param name="name">The property's name.</param>
  2148. <param name="value">The property's value.</param>
  2149. <returns>the property that was stored under the specified name before, or
  2150. <c>null</c>
  2151. if there was no such property before.</returns>
  2152. </member>
  2153. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.Double)">
  2154. <summary>
  2155. Adds a named double property.
  2156. </summary>
  2157. <param name="name">The property's name.</param>
  2158. <param name="value">The property's value.</param>
  2159. <returns>the property that was stored under the specified name before, or
  2160. <c>null</c>
  2161. if there was no such property before.</returns>
  2162. </member>
  2163. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.Int32)">
  2164. <summary>
  2165. Adds a named integer property.
  2166. </summary>
  2167. <param name="name">The property's name.</param>
  2168. <param name="value">The property's value.</param>
  2169. <returns>the property that was stored under the specified name before, or
  2170. <c>null</c>
  2171. if there was no such property before.</returns>
  2172. </member>
  2173. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.Boolean)">
  2174. <summary>
  2175. Adds a named bool property.
  2176. </summary>
  2177. <param name="name">The property's name.</param>
  2178. <param name="value">The property's value.</param>
  2179. <returns>the property that was stored under the specified name before, or
  2180. <c>null</c>
  2181. if there was no such property before.</returns>
  2182. </member>
  2183. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.DateTime)">
  2184. <summary>
  2185. Adds a named date property.
  2186. </summary>
  2187. <param name="name">The property's name.</param>
  2188. <param name="value">The property's value.</param>
  2189. <returns>the property that was stored under the specified name before, or
  2190. <c>null</c>
  2191. if there was no such property before.</returns>
  2192. </member>
  2193. <member name="P:NPOI.HPSF.CustomProperties.Item(System.String)">
  2194. <summary>
  2195. Gets the <see cref="T:System.Object"/> with the specified name.
  2196. </summary>
  2197. <value>the value or
  2198. <c>null</c>
  2199. if a value with the specified
  2200. name is not found in the custom properties.</value>
  2201. </member>
  2202. <member name="M:NPOI.HPSF.CustomProperties.ContainsKey(System.Object)">
  2203. Checks against both String Name and Long ID
  2204. </member>
  2205. <member name="M:NPOI.HPSF.CustomProperties.ContainsValue(System.Object)">
  2206. Checks against both the property, and its values.
  2207. </member>
  2208. <member name="P:NPOI.HPSF.CustomProperties.Dictionary">
  2209. <summary>
  2210. Gets the dictionary which Contains IDs and names of the named custom
  2211. properties.
  2212. </summary>
  2213. <value>The dictionary.</value>
  2214. </member>
  2215. <member name="P:NPOI.HPSF.CustomProperties.Codepage">
  2216. <summary>
  2217. Gets or sets the codepage.
  2218. </summary>
  2219. <value>The codepage.</value>
  2220. </member>
  2221. <member name="P:NPOI.HPSF.CustomProperties.IsPure">
  2222. <summary>
  2223. Tells whether this {@link CustomProperties} instance is pure or one or
  2224. more properties of the underlying low-level property Set has been
  2225. dropped.
  2226. </summary>
  2227. <value><c>true</c> if this instance is pure; otherwise, <c>false</c>.</value>
  2228. </member>
  2229. <member name="T:NPOI.HPSF.CustomProperty">
  2230. <summary>
  2231. This class represents custum properties in the document summary
  2232. information stream. The difference To normal properties is that custom
  2233. properties have an optional name. If the name is not <c>null</c> it
  2234. will be maintained in the section's dictionary.
  2235. @author Rainer Klute
  2236. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  2237. @since 2006-02-09
  2238. </summary>
  2239. </member>
  2240. <member name="M:NPOI.HPSF.CustomProperty.#ctor">
  2241. <summary>
  2242. Initializes a new instance of the <see cref="T:NPOI.HPSF.CustomProperty"/> class.
  2243. </summary>
  2244. </member>
  2245. <member name="M:NPOI.HPSF.CustomProperty.#ctor(NPOI.HPSF.Property)">
  2246. <summary>
  2247. Initializes a new instance of the <see cref="T:NPOI.HPSF.CustomProperty"/> class.
  2248. </summary>
  2249. <param name="property">the property To copy</param>
  2250. </member>
  2251. <member name="M:NPOI.HPSF.CustomProperty.#ctor(NPOI.HPSF.Property,System.String)">
  2252. <summary>
  2253. Initializes a new instance of the <see cref="T:NPOI.HPSF.CustomProperty"/> class.
  2254. </summary>
  2255. <param name="property">This property's attributes are copied To the new custom
  2256. property.</param>
  2257. <param name="name">The new custom property's name.</param>
  2258. </member>
  2259. <member name="P:NPOI.HPSF.CustomProperty.Name">
  2260. <summary>
  2261. Gets or sets the property's name.
  2262. </summary>
  2263. <value>the property's name.</value>
  2264. </member>
  2265. <member name="M:NPOI.HPSF.CustomProperty.EqualsContents(System.Object)">
  2266. <summary>
  2267. Compares two custom properties for equality. The method returns
  2268. <c>true</c> if all attributes of the two custom properties are
  2269. equal.
  2270. </summary>
  2271. <param name="o">The custom property To Compare with.</param>
  2272. <returns><c>true</c>
  2273. if both custom properties are equal, else
  2274. <c>false</c></returns>
  2275. </member>
  2276. <member name="M:NPOI.HPSF.CustomProperty.GetHashCode">
  2277. <summary>
  2278. </summary>
  2279. <returns></returns>
  2280. @see Object#GetHashCode()
  2281. </member>
  2282. <member name="T:NPOI.HPSF.DocumentSummaryInformation">
  2283. <summary>
  2284. Convenience class representing a DocumentSummary Information stream in a
  2285. Microsoft Office document.
  2286. @author Rainer Klute
  2287. klute@rainer-klute.de
  2288. @author Drew Varner (Drew.Varner cloSeto sc.edu)
  2289. @author robert_flaherty@hyperion.com
  2290. @since 2002-02-09
  2291. </summary>
  2292. </member>
  2293. <member name="F:NPOI.HPSF.DocumentSummaryInformation.DEFAULT_STREAM_NAME">
  2294. The document name a document summary information stream
  2295. usually has in a POIFS filesystem.
  2296. </member>
  2297. <member name="M:NPOI.HPSF.DocumentSummaryInformation.#ctor(NPOI.HPSF.PropertySet)">
  2298. <summary>
  2299. Initializes a new instance of the <see cref="T:NPOI.HPSF.DocumentSummaryInformation"/> class.
  2300. </summary>
  2301. <param name="ps">A property Set which should be Created from a
  2302. document summary information stream.</param>
  2303. </member>
  2304. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Category">
  2305. <summary>
  2306. Gets or sets the category.
  2307. </summary>
  2308. <value>The category value</value>
  2309. </member>
  2310. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveCategory">
  2311. <summary>
  2312. Removes the category.
  2313. </summary>
  2314. </member>
  2315. <member name="P:NPOI.HPSF.DocumentSummaryInformation.PresentationFormat">
  2316. <summary>
  2317. Gets or sets the presentation format (or null).
  2318. </summary>
  2319. <value>The presentation format value</value>
  2320. </member>
  2321. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemovePresentationFormat">
  2322. <summary>
  2323. Removes the presentation format.
  2324. </summary>
  2325. </member>
  2326. <member name="P:NPOI.HPSF.DocumentSummaryInformation.ByteCount">
  2327. <summary>
  2328. Gets or sets the byte count or 0 if the {@link
  2329. DocumentSummaryInformation} does not contain a byte count.
  2330. </summary>
  2331. <value>The byteCount value</value>
  2332. </member>
  2333. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveByteCount">
  2334. <summary>
  2335. Removes the byte count.
  2336. </summary>
  2337. </member>
  2338. <member name="P:NPOI.HPSF.DocumentSummaryInformation.LineCount">
  2339. <summary>
  2340. Gets or sets the line count or 0 if the {@link
  2341. DocumentSummaryInformation} does not contain a line count.
  2342. </summary>
  2343. <value>The line count value.</value>
  2344. </member>
  2345. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveLineCount">
  2346. <summary>
  2347. Removes the line count.
  2348. </summary>
  2349. </member>
  2350. <member name="P:NPOI.HPSF.DocumentSummaryInformation.ParCount">
  2351. <summary>
  2352. Gets or sets the par count or 0 if the {@link
  2353. DocumentSummaryInformation} does not contain a par count.
  2354. </summary>
  2355. <value>The par count value</value>
  2356. </member>
  2357. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveParCount">
  2358. <summary>
  2359. Removes the par count.
  2360. </summary>
  2361. </member>
  2362. <member name="P:NPOI.HPSF.DocumentSummaryInformation.SlideCount">
  2363. <summary>
  2364. Gets or sets the slide count or 0 if the {@link
  2365. DocumentSummaryInformation} does not contain a slide count.
  2366. </summary>
  2367. <value>The slide count value</value>
  2368. </member>
  2369. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveSlideCount">
  2370. <summary>
  2371. Removes the slide count.
  2372. </summary>
  2373. </member>
  2374. <member name="P:NPOI.HPSF.DocumentSummaryInformation.NoteCount">
  2375. <summary>
  2376. Gets or sets the note count or 0 if the {@link
  2377. DocumentSummaryInformation} does not contain a note count
  2378. </summary>
  2379. <value>The note count value</value>
  2380. </member>
  2381. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveNoteCount">
  2382. <summary>
  2383. Removes the note count.
  2384. </summary>
  2385. </member>
  2386. <member name="P:NPOI.HPSF.DocumentSummaryInformation.HiddenCount">
  2387. <summary>
  2388. Gets or sets the hidden count or 0 if the {@link
  2389. DocumentSummaryInformation} does not contain a hidden
  2390. count.
  2391. </summary>
  2392. <value>The hidden count value.</value>
  2393. </member>
  2394. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveHiddenCount">
  2395. <summary>
  2396. Removes the hidden count.
  2397. </summary>
  2398. </member>
  2399. <member name="P:NPOI.HPSF.DocumentSummaryInformation.MMClipCount">
  2400. <summary>
  2401. Returns the mmclip count or 0 if the {@link
  2402. DocumentSummaryInformation} does not contain a mmclip
  2403. count.
  2404. </summary>
  2405. <value>The mmclip count value.</value>
  2406. </member>
  2407. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveMMClipCount">
  2408. <summary>
  2409. Removes the MMClip count.
  2410. </summary>
  2411. </member>
  2412. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Scale">
  2413. <summary>
  2414. Gets or sets a value indicating whether this <see cref="T:NPOI.HPSF.DocumentSummaryInformation"/> is scale.
  2415. </summary>
  2416. <value><c>true</c> if cropping is desired; otherwise, <c>false</c>.</value>
  2417. </member>
  2418. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveScale">
  2419. <summary>
  2420. Removes the scale.
  2421. </summary>
  2422. </member>
  2423. <member name="P:NPOI.HPSF.DocumentSummaryInformation.HeadingPair">
  2424. <summary>
  2425. Gets or sets the heading pair (or null)
  2426. </summary>
  2427. <value>The heading pair value.</value>
  2428. </member>
  2429. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveHeadingPair">
  2430. <summary>
  2431. Removes the heading pair.
  2432. </summary>
  2433. </member>
  2434. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Docparts">
  2435. <summary>
  2436. Gets or sets the doc parts.
  2437. </summary>
  2438. <value>The doc parts value</value>
  2439. </member>
  2440. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveDocparts">
  2441. <summary>
  2442. Removes the doc parts.
  2443. </summary>
  2444. </member>
  2445. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Manager">
  2446. <summary>
  2447. Gets or sets the manager (or <c>null</c>).
  2448. </summary>
  2449. <value>The manager value</value>
  2450. </member>
  2451. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveManager">
  2452. <summary>
  2453. Removes the manager.
  2454. </summary>
  2455. </member>
  2456. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Company">
  2457. <summary>
  2458. Gets or sets the company (or <c>null</c>).
  2459. </summary>
  2460. <value>The company value</value>
  2461. </member>
  2462. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveCompany">
  2463. <summary>
  2464. Removes the company.
  2465. </summary>
  2466. </member>
  2467. <member name="P:NPOI.HPSF.DocumentSummaryInformation.LinksDirty">
  2468. <summary>
  2469. Gets or sets a value indicating whether [links dirty].
  2470. </summary>
  2471. <value><c>true</c> if the custom links are dirty.; otherwise, <c>false</c>.</value>
  2472. </member>
  2473. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveLinksDirty">
  2474. <summary>
  2475. Removes the links dirty.
  2476. </summary>
  2477. </member>
  2478. <member name="P:NPOI.HPSF.DocumentSummaryInformation.CharCountWithSpaces">
  2479. <p>Returns the character count including whitespace, or 0 if the
  2480. {@link DocumentSummaryInformation} does not contain this char count.</p>
  2481. This is the whitespace-including version of {@link SummaryInformation#getCharCount()}
  2482. @return The character count or <code>null</code>
  2483. </member>
  2484. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveCharCountWithSpaces">
  2485. Removes the character count
  2486. </member>
  2487. <member name="P:NPOI.HPSF.DocumentSummaryInformation.HyperlinksChanged">
  2488. <p>Get if the User Defined Property Set has been updated outside of the
  2489. Application.</p>
  2490. <p>If it has (true), the hyperlinks should be updated on document load.</p>
  2491. </member>
  2492. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveHyperlinksChanged">
  2493. Removes the flag for if the User Defined Property Set has been updated
  2494. outside of the Application.
  2495. </member>
  2496. <member name="P:NPOI.HPSF.DocumentSummaryInformation.ApplicationVersion">
  2497. <p>Gets the version of the Application which wrote the
  2498. Property set, stored with the two high order bytes having the major
  2499. version number, and the two low order bytes the minor version number.</p>
  2500. <p>This will be 0 if no version is set.</p>
  2501. </member>
  2502. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveApplicationVersion">
  2503. Removes the Application Version
  2504. </member>
  2505. <member name="P:NPOI.HPSF.DocumentSummaryInformation.VBADigitalSignature">
  2506. <p>Returns the VBA digital signature for the VBA project
  2507. embedded in the document (or <code>null</code>).</p>
  2508. </member>
  2509. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveVBADigitalSignature">
  2510. Removes the VBA Digital Signature
  2511. </member>
  2512. <member name="P:NPOI.HPSF.DocumentSummaryInformation.ContentType">
  2513. <p>Gets the content type of the file (or <code>null</code>).</p>
  2514. </member>
  2515. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveContentType">
  2516. Removes the content type of the file
  2517. </member>
  2518. <member name="P:NPOI.HPSF.DocumentSummaryInformation.ContentStatus">
  2519. <p>Gets the content status of the file (or <code>null</code>).</p>
  2520. </member>
  2521. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveContentStatus">
  2522. Removes the content status of the file
  2523. </member>
  2524. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Language">
  2525. <p>Gets the document language, which is normally unset and empty
  2526. (or <code>null</code>).</p>
  2527. </member>
  2528. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveLanguage">
  2529. Removes the document language
  2530. </member>
  2531. <member name="P:NPOI.HPSF.DocumentSummaryInformation.DocumentVersion">
  2532. <p>Gets the document version as a string, which is normally unset and empty
  2533. (or <code>null</code>).</p>
  2534. </member>
  2535. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveDocumentVersion">
  2536. Removes the document version string
  2537. </member>
  2538. <member name="P:NPOI.HPSF.DocumentSummaryInformation.CustomProperties">
  2539. <summary>
  2540. Gets or sets the custom properties.
  2541. </summary>
  2542. <value>The custom properties.</value>
  2543. </member>
  2544. <member name="M:NPOI.HPSF.DocumentSummaryInformation.EnsureSection2">
  2545. <summary>
  2546. Creates section 2 if it is not alReady present.
  2547. </summary>
  2548. </member>
  2549. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveCustomProperties">
  2550. <summary>
  2551. Removes the custom properties.
  2552. </summary>
  2553. </member>
  2554. <member name="T:NPOI.HPSF.HPSFException">
  2555. <summary>
  2556. This exception is the superclass of all other checked exceptions thrown
  2557. in this package. It supports a nested "reason" throwable, i.e. an exception
  2558. that caused this one To be thrown.
  2559. @author Rainer Klute
  2560. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  2561. @since 2002-02-09
  2562. </summary>
  2563. </member>
  2564. <member name="M:NPOI.HPSF.HPSFException.#ctor">
  2565. <summary>
  2566. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFException"/> class.
  2567. </summary>
  2568. </member>
  2569. <member name="M:NPOI.HPSF.HPSFException.#ctor(System.String)">
  2570. <summary>
  2571. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFException"/> class.
  2572. </summary>
  2573. <param name="msg">The message string.</param>
  2574. </member>
  2575. <member name="M:NPOI.HPSF.HPSFException.#ctor(System.Exception)">
  2576. <summary>
  2577. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFException"/> class.
  2578. </summary>
  2579. <param name="reason">The reason, i.e. a throwable that indirectly
  2580. caused this exception.</param>
  2581. </member>
  2582. <member name="M:NPOI.HPSF.HPSFException.#ctor(System.String,System.Exception)">
  2583. <summary>
  2584. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFException"/> class.
  2585. </summary>
  2586. <param name="msg">The message string.</param>
  2587. <param name="reason">The reason, i.e. a throwable that indirectly
  2588. caused this exception.</param>
  2589. </member>
  2590. <member name="P:NPOI.HPSF.HPSFException.Reason">
  2591. <summary>
  2592. Returns the {@link Exception} that caused this exception To
  2593. be thrown or null if there was no such {@link
  2594. Exception}.
  2595. </summary>
  2596. <value>The reason.</value>
  2597. </member>
  2598. <member name="T:NPOI.HPSF.HPSFRuntimeException">
  2599. <summary>
  2600. This exception is the superclass of all other unchecked
  2601. exceptions thrown in this package. It supports a nested "reason"
  2602. throwable, i.e. an exception that caused this one To be thrown.
  2603. @author Rainer Klute
  2604. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  2605. @since 2002-02-09
  2606. </summary>
  2607. </member>
  2608. <member name="M:NPOI.HPSF.HPSFRuntimeException.#ctor">
  2609. <summary>
  2610. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFRuntimeException"/> class.
  2611. </summary>
  2612. </member>
  2613. <member name="M:NPOI.HPSF.HPSFRuntimeException.#ctor(System.String)">
  2614. <summary>
  2615. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFRuntimeException"/> class.
  2616. </summary>
  2617. <param name="msg">The message string.</param>
  2618. </member>
  2619. <member name="M:NPOI.HPSF.HPSFRuntimeException.#ctor(System.Exception)">
  2620. <summary>
  2621. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFRuntimeException"/> class.
  2622. </summary>
  2623. <param name="reason">The reason, i.e. a throwable that indirectly
  2624. caused this exception.</param>
  2625. </member>
  2626. <member name="M:NPOI.HPSF.HPSFRuntimeException.#ctor(System.String,System.Exception)">
  2627. <summary>
  2628. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFRuntimeException"/> class.
  2629. </summary>
  2630. <param name="msg">The message string.</param>
  2631. <param name="reason">The reason, i.e. a throwable that indirectly
  2632. caused this exception.</param>
  2633. </member>
  2634. <member name="T:NPOI.HPSF.IllegalPropertySetDataException">
  2635. <summary>
  2636. This exception is thrown when there is an illegal value Set in a
  2637. {@link PropertySet}. For example, a {@link Variant#VT_BOOL} must
  2638. have a value of <c>-1 (true)</c> or <c>0 (false)</c>.
  2639. Any other value would trigger this exception. It supports a nested
  2640. "reason" throwable, i.e. an exception that caused this one To be
  2641. thrown.
  2642. @author Drew Varner(Drew.Varner atDomain sc.edu)
  2643. @since 2002-05-26
  2644. </summary>
  2645. </member>
  2646. <member name="M:NPOI.HPSF.IllegalPropertySetDataException.#ctor">
  2647. <summary>
  2648. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalPropertySetDataException"/> class.
  2649. </summary>
  2650. </member>
  2651. <member name="M:NPOI.HPSF.IllegalPropertySetDataException.#ctor(System.String)">
  2652. <summary>
  2653. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalPropertySetDataException"/> class.
  2654. </summary>
  2655. <param name="msg">The exception's message string</param>
  2656. </member>
  2657. <member name="M:NPOI.HPSF.IllegalPropertySetDataException.#ctor(System.Exception)">
  2658. <summary>
  2659. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalPropertySetDataException"/> class.
  2660. </summary>
  2661. <param name="reason">This exception's underlying reason</param>
  2662. </member>
  2663. <member name="M:NPOI.HPSF.IllegalPropertySetDataException.#ctor(System.String,System.Exception)">
  2664. <summary>
  2665. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalPropertySetDataException"/> class.
  2666. </summary>
  2667. <param name="msg"> The exception's message string</param>
  2668. <param name="reason">This exception's underlying reason</param>
  2669. </member>
  2670. <member name="T:NPOI.HPSF.MarkUnsupportedException">
  2671. <summary>
  2672. This exception is thrown if an {@link java.io.InputStream} does
  2673. not support the {@link java.io.InputStream#mark} operation.
  2674. @author Rainer Klute
  2675. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  2676. @since 2002-02-09
  2677. </summary>
  2678. </member>
  2679. <member name="M:NPOI.HPSF.MarkUnsupportedException.#ctor">
  2680. <summary>
  2681. Initializes a new instance of the <see cref="T:NPOI.HPSF.MarkUnsupportedException"/> class.
  2682. </summary>
  2683. </member>
  2684. <member name="M:NPOI.HPSF.MarkUnsupportedException.#ctor(System.String)">
  2685. <summary>
  2686. Initializes a new instance of the <see cref="T:NPOI.HPSF.MarkUnsupportedException"/> class.
  2687. </summary>
  2688. <param name="msg">The exception's message string.</param>
  2689. </member>
  2690. <member name="M:NPOI.HPSF.MarkUnsupportedException.#ctor(System.Exception)">
  2691. <summary>
  2692. Initializes a new instance of the <see cref="T:NPOI.HPSF.MarkUnsupportedException"/> class.
  2693. </summary>
  2694. <param name="reason">This exception's underlying reason.</param>
  2695. </member>
  2696. <member name="M:NPOI.HPSF.MarkUnsupportedException.#ctor(System.String,System.Exception)">
  2697. <summary>
  2698. Initializes a new instance of the <see cref="T:NPOI.HPSF.MarkUnsupportedException"/> class.
  2699. </summary>
  2700. <param name="msg">The exception's message string</param>
  2701. <param name="reason">This exception's underlying reason</param>
  2702. </member>
  2703. <member name="T:NPOI.HPSF.MissingSectionException">
  2704. <summary>
  2705. This exception is thrown if one of the {@link PropertySet}'s
  2706. convenience methods does not Find a required {@link Section}.
  2707. The constructors of this class are analogous To those of its
  2708. superclass and documented there.
  2709. @author Rainer Klute
  2710. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  2711. @since 2006-02-08
  2712. </summary>
  2713. </member>
  2714. <member name="M:NPOI.HPSF.MissingSectionException.#ctor">
  2715. <summary>
  2716. Initializes a new instance of the <see cref="T:NPOI.HPSF.MissingSectionException"/> class.
  2717. </summary>
  2718. </member>
  2719. <member name="M:NPOI.HPSF.MissingSectionException.#ctor(System.String)">
  2720. <summary>
  2721. Initializes a new instance of the <see cref="T:NPOI.HPSF.MissingSectionException"/> class.
  2722. </summary>
  2723. <param name="msg">The exception's message string</param>
  2724. </member>
  2725. <member name="M:NPOI.HPSF.MissingSectionException.#ctor(System.Exception)">
  2726. <summary>
  2727. Initializes a new instance of the <see cref="T:NPOI.HPSF.MissingSectionException"/> class.
  2728. </summary>
  2729. <param name="reason">This exception's underlying reason.</param>
  2730. </member>
  2731. <member name="M:NPOI.HPSF.MissingSectionException.#ctor(System.String,System.Exception)">
  2732. <summary>
  2733. Initializes a new instance of the <see cref="T:NPOI.HPSF.MissingSectionException"/> class.
  2734. </summary>
  2735. <param name="msg">The exception's message string</param>
  2736. <param name="reason">This exception's underlying reason</param>
  2737. </member>
  2738. <member name="T:NPOI.HPSF.MutableProperty">
  2739. <summary>
  2740. Adds writing capability To the {@link Property} class.
  2741. Please be aware that this class' functionality will be merged into the
  2742. {@link Property} class at a later time, so the API will Change.
  2743. @author Rainer Klute
  2744. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  2745. @since 2003-08-03
  2746. </summary>
  2747. </member>
  2748. <member name="M:NPOI.HPSF.MutableProperty.#ctor">
  2749. <summary>
  2750. Creates an empty property. It must be Filled using the Set method To
  2751. be usable.
  2752. </summary>
  2753. </member>
  2754. <member name="M:NPOI.HPSF.MutableProperty.#ctor(NPOI.HPSF.Property)">
  2755. <summary>
  2756. Initializes a new instance of the <see cref="T:NPOI.HPSF.MutableProperty"/> class.
  2757. </summary>
  2758. <param name="p">The property To copy.</param>
  2759. </member>
  2760. <member name="M:NPOI.HPSF.MutableProperty.Write(System.IO.Stream,System.Int32)">
  2761. <summary>
  2762. Writes the property To an output stream.
  2763. </summary>
  2764. <param name="out1">The output stream To Write To.</param>
  2765. <param name="codepage">The codepage To use for writing non-wide strings</param>
  2766. <returns>the number of bytes written To the stream</returns>
  2767. </member>
  2768. <member name="T:NPOI.HPSF.MutablePropertySet">
  2769. <summary>
  2770. Adds writing support To the {@link PropertySet} class.
  2771. Please be aware that this class' functionality will be merged into the
  2772. {@link PropertySet} class at a later time, so the API will Change.
  2773. @author Rainer Klute
  2774. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  2775. @since 2003-02-19
  2776. </summary>
  2777. </member>
  2778. <member name="M:NPOI.HPSF.MutablePropertySet.#ctor">
  2779. <summary>
  2780. Initializes a new instance of the <see cref="T:NPOI.HPSF.MutablePropertySet"/> class.
  2781. Its primary task is To initialize the immutable field with their proper
  2782. values. It also Sets fields that might Change To reasonable defaults.
  2783. </summary>
  2784. </member>
  2785. <member name="M:NPOI.HPSF.MutablePropertySet.#ctor(NPOI.HPSF.PropertySet)">
  2786. <summary>
  2787. Initializes a new instance of the <see cref="T:NPOI.HPSF.MutablePropertySet"/> class.
  2788. All nested elements, i.e.<c>Section</c>s and <c>Property</c> instances, will be their
  2789. mutable counterparts in the new <c>MutablePropertySet</c>.
  2790. </summary>
  2791. <param name="ps">The property Set To copy</param>
  2792. </member>
  2793. <member name="F:NPOI.HPSF.MutablePropertySet.OFFSET_HEADER">
  2794. The Length of the property Set stream header.
  2795. </member>
  2796. <member name="M:NPOI.HPSF.MutablePropertySet.ClearSections">
  2797. <summary>
  2798. Removes all sections from this property Set.
  2799. </summary>
  2800. </member>
  2801. <member name="M:NPOI.HPSF.MutablePropertySet.AddSection(NPOI.HPSF.Section)">
  2802. <summary>
  2803. Adds a section To this property Set.
  2804. </summary>
  2805. <param name="section">section The {@link Section} To Add. It will be Appended
  2806. after any sections that are alReady present in the property Set
  2807. and thus become the last section.</param>
  2808. </member>
  2809. <member name="M:NPOI.HPSF.MutablePropertySet.Write(System.IO.Stream)">
  2810. <summary>
  2811. Writes the property Set To an output stream.
  2812. </summary>
  2813. <param name="out1">the output stream To Write the section To</param>
  2814. </member>
  2815. <member name="M:NPOI.HPSF.MutablePropertySet.ToInputStream">
  2816. <summary>
  2817. Returns the contents of this property set stream as an input stream.
  2818. The latter can be used for example to write the property set into a POIFS
  2819. document. The input stream represents a snapshot of the property set.
  2820. If the latter is modified while the input stream is still being
  2821. read, the modifications will not be reflected in the input stream but in
  2822. the {@link MutablePropertySet} only.
  2823. </summary>
  2824. <returns>the contents of this property set stream</returns>
  2825. </member>
  2826. <member name="M:NPOI.HPSF.MutablePropertySet.Write(NPOI.POIFS.FileSystem.DirectoryEntry,System.String)">
  2827. <summary>
  2828. Writes a property Set To a document in a POI filesystem directory
  2829. </summary>
  2830. <param name="dir">The directory in the POI filesystem To Write the document To.</param>
  2831. <param name="name">The document's name. If there is alReady a document with the
  2832. same name in the directory the latter will be overwritten.</param>
  2833. </member>
  2834. <member name="T:NPOI.HPSF.MutableSection">
  2835. <summary>
  2836. Adds writing capability To the {@link Section} class.
  2837. Please be aware that this class' functionality will be merged into the
  2838. {@link Section} class at a later time, so the API will Change.
  2839. @since 2002-02-20
  2840. </summary>
  2841. </member>
  2842. <member name="F:NPOI.HPSF.MutableSection.dirty">
  2843. If the "dirty" flag is true, the section's size must be
  2844. (re-)calculated before the section is written.
  2845. </member>
  2846. <member name="F:NPOI.HPSF.MutableSection.preprops">
  2847. List To assemble the properties. Unfortunately a wrong
  2848. decision has been taken when specifying the "properties" field
  2849. as an Property[]. It should have been a {@link java.util.List}.
  2850. </member>
  2851. <member name="F:NPOI.HPSF.MutableSection.sectionBytes">
  2852. Contains the bytes making out the section. This byte array is
  2853. established when the section's size is calculated and can be reused
  2854. later. It is valid only if the "dirty" flag is false.
  2855. </member>
  2856. <member name="M:NPOI.HPSF.MutableSection.#ctor">
  2857. <summary>
  2858. Initializes a new instance of the <see cref="T:NPOI.HPSF.MutableSection"/> class.
  2859. </summary>
  2860. </member>
  2861. <member name="M:NPOI.HPSF.MutableSection.#ctor(NPOI.HPSF.Section)">
  2862. <summary>
  2863. Constructs a <c>MutableSection</c> by doing a deep copy of an
  2864. existing <c>Section</c>. All nested <c>Property</c>
  2865. instances, will be their mutable counterparts in the new
  2866. <c>MutableSection</c>.
  2867. </summary>
  2868. <param name="s">The section Set To copy</param>
  2869. </member>
  2870. <member name="M:NPOI.HPSF.MutableSection.SetFormatID(NPOI.Util.ClassID)">
  2871. <summary>
  2872. Sets the section's format ID.
  2873. </summary>
  2874. <param name="formatID">The section's format ID</param>
  2875. </member>
  2876. <member name="M:NPOI.HPSF.MutableSection.SetFormatID(System.Byte[])">
  2877. <summary>
  2878. Sets the section's format ID.
  2879. </summary>
  2880. <param name="formatID">The section's format ID as a byte array. It components
  2881. are in big-endian format.</param>
  2882. </member>
  2883. <member name="M:NPOI.HPSF.MutableSection.SetProperties(NPOI.HPSF.Property[])">
  2884. <summary>
  2885. Sets this section's properties. Any former values are overwritten.
  2886. </summary>
  2887. <param name="properties">This section's new properties.</param>
  2888. </member>
  2889. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.String)">
  2890. <summary>
  2891. Sets the string value of the property with the specified ID.
  2892. </summary>
  2893. <param name="id">The property's ID</param>
  2894. <param name="value">The property's value. It will be written as a Unicode
  2895. string.</param>
  2896. </member>
  2897. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.Int32)">
  2898. <summary>
  2899. Sets the int value of the property with the specified ID.
  2900. </summary>
  2901. <param name="id">The property's ID</param>
  2902. <param name="value">The property's value.</param>
  2903. </member>
  2904. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.Int64)">
  2905. <summary>
  2906. Sets the long value of the property with the specified ID.
  2907. </summary>
  2908. <param name="id">The property's ID</param>
  2909. <param name="value">The property's value.</param>
  2910. </member>
  2911. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.Boolean)">
  2912. <summary>
  2913. Sets the bool value of the property with the specified ID.
  2914. </summary>
  2915. <param name="id">The property's ID</param>
  2916. <param name="value">The property's value.</param>
  2917. </member>
  2918. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.Int64,System.Object)">
  2919. <summary>
  2920. Sets the value and the variant type of the property with the
  2921. specified ID. If a property with this ID is not yet present in
  2922. the section, it will be Added. An alReady present property with
  2923. the specified ID will be overwritten. A default mapping will be
  2924. used To choose the property's type.
  2925. </summary>
  2926. <param name="id">The property's ID.</param>
  2927. <param name="variantType">The property's variant type.</param>
  2928. <param name="value">The property's value.</param>
  2929. </member>
  2930. <member name="M:NPOI.HPSF.MutableSection.SetProperty(NPOI.HPSF.Property)">
  2931. <summary>
  2932. Sets the property.
  2933. </summary>
  2934. <param name="p">The property To be Set.</param>
  2935. </member>
  2936. <member name="M:NPOI.HPSF.MutableSection.RemoveProperty(System.Int64)">
  2937. <summary>
  2938. Removes the property.
  2939. </summary>
  2940. <param name="id">The ID of the property To be Removed</param>
  2941. </member>
  2942. <member name="M:NPOI.HPSF.MutableSection.SetPropertyBooleanValue(System.Int32,System.Boolean)">
  2943. <summary>
  2944. Sets the value of the bool property with the specified
  2945. ID.
  2946. </summary>
  2947. <param name="id">The property's ID</param>
  2948. <param name="value">The property's value</param>
  2949. </member>
  2950. <member name="P:NPOI.HPSF.MutableSection.Size">
  2951. <summary>
  2952. Returns the section's size in bytes.
  2953. </summary>
  2954. <value>The section's size in bytes.</value>
  2955. </member>
  2956. <member name="M:NPOI.HPSF.MutableSection.CalcSize">
  2957. <summary>
  2958. Calculates the section's size. It is the sum of the Lengths of the
  2959. section's header (8), the properties list (16 times the number of
  2960. properties) and the properties themselves.
  2961. </summary>
  2962. <returns>the section's Length in bytes.</returns>
  2963. </member>
  2964. <member name="M:NPOI.HPSF.MutableSection.Write(System.IO.Stream)">
  2965. <summary>
  2966. Writes this section into an output stream.
  2967. Internally this is done by writing into three byte array output
  2968. streams: one for the properties, one for the property list and one for
  2969. the section as such. The two former are Appended To the latter when they
  2970. have received all their data.
  2971. </summary>
  2972. <param name="out1">The stream To Write into.</param>
  2973. <returns>The number of bytes written, i.e. the section's size.</returns>
  2974. </member>
  2975. <member name="M:NPOI.HPSF.MutableSection.WriteDictionary(System.IO.Stream,System.Collections.IDictionary,System.Int32)">
  2976. <summary>
  2977. Writes the section's dictionary
  2978. </summary>
  2979. <param name="out1">The output stream To Write To.</param>
  2980. <param name="dictionary">The dictionary.</param>
  2981. <param name="codepage">The codepage to be used to Write the dictionary items.</param>
  2982. <returns>The number of bytes written</returns>
  2983. <remarks>
  2984. see MSDN KB: http://msdn.microsoft.com/en-us/library/aa380065(VS.85).aspx
  2985. </remarks>
  2986. </member>
  2987. <member name="P:NPOI.HPSF.MutableSection.PropertyCount">
  2988. <summary>
  2989. OverWrites the base class' method To cope with a redundancy:
  2990. the property count is maintained in a separate member variable, but
  2991. shouldn't.
  2992. </summary>
  2993. <value>The number of properties in this section.</value>
  2994. </member>
  2995. <member name="P:NPOI.HPSF.MutableSection.Properties">
  2996. <summary>
  2997. Returns this section's properties.
  2998. </summary>
  2999. <value>This section's properties.</value>
  3000. </member>
  3001. <member name="M:NPOI.HPSF.MutableSection.EnsureProperties">
  3002. <summary>
  3003. Ensures the properties.
  3004. </summary>
  3005. </member>
  3006. <member name="M:NPOI.HPSF.MutableSection.GetProperty(System.Int64)">
  3007. <summary>
  3008. Gets a property.
  3009. </summary>
  3010. <param name="id">The ID of the property To Get</param>
  3011. <returns>The property or null if there is no such property</returns>
  3012. </member>
  3013. <member name="P:NPOI.HPSF.MutableSection.Dictionary">
  3014. <summary>
  3015. Sets the section's dictionary. All keys in the dictionary must be
  3016. {@link java.lang.long} instances, all values must be
  3017. {@link java.lang.String}s. This method overWrites the properties with IDs
  3018. 0 and 1 since they are reserved for the dictionary and the dictionary's
  3019. codepage. Setting these properties explicitly might have surprising
  3020. effects. An application should never do this but always use this
  3021. method.
  3022. </summary>
  3023. <value>
  3024. the dictionary
  3025. </value>
  3026. </member>
  3027. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.Object)">
  3028. <summary>
  3029. Sets the property.
  3030. </summary>
  3031. <param name="id">The property ID.</param>
  3032. <param name="value">The property's value. The value's class must be one of those
  3033. supported by HPSF.</param>
  3034. </member>
  3035. <member name="M:NPOI.HPSF.MutableSection.Clear">
  3036. <summary>
  3037. Removes all properties from the section including 0 (dictionary) and
  3038. 1 (codepage).
  3039. </summary>
  3040. </member>
  3041. <member name="P:NPOI.HPSF.MutableSection.Codepage">
  3042. <summary>
  3043. Gets the section's codepage, if any.
  3044. </summary>
  3045. <value>The section's codepage if one is defined, else -1.</value>
  3046. </member>
  3047. <member name="T:NPOI.HPSF.NoFormatIDException">
  3048. <summary>
  3049. This exception is thrown if a {@link MutablePropertySet} is To be written
  3050. but does not have a formatID Set (see {@link
  3051. MutableSection#SetFormatID(ClassID)} or
  3052. {@link org.apache.poi.hpsf.MutableSection#SetFormatID(byte[])}.
  3053. @author Rainer Klute
  3054. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3055. @since 2002-09-03
  3056. </summary>
  3057. </member>
  3058. <member name="M:NPOI.HPSF.NoFormatIDException.#ctor">
  3059. <summary>
  3060. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoFormatIDException"/> class.
  3061. </summary>
  3062. </member>
  3063. <member name="M:NPOI.HPSF.NoFormatIDException.#ctor(System.String)">
  3064. <summary>
  3065. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoFormatIDException"/> class.
  3066. </summary>
  3067. <param name="msg">The exception's message string</param>
  3068. </member>
  3069. <member name="M:NPOI.HPSF.NoFormatIDException.#ctor(System.Exception)">
  3070. <summary>
  3071. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoFormatIDException"/> class.
  3072. </summary>
  3073. <param name="reason">This exception's underlying reason</param>
  3074. </member>
  3075. <member name="M:NPOI.HPSF.NoFormatIDException.#ctor(System.String,System.Exception)">
  3076. <summary>
  3077. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoFormatIDException"/> class.
  3078. </summary>
  3079. <param name="msg">The exception's message string</param>
  3080. <param name="reason">This exception's underlying reason</param>
  3081. </member>
  3082. <member name="T:NPOI.HPSF.NoPropertySetStreamException">
  3083. <summary>
  3084. This exception is thrown if a format error in a property Set stream Is
  3085. detected or when the input data do not constitute a property Set stream.
  3086. The constructors of this class are analogous To those of its superclass
  3087. and are documented there.
  3088. @author Rainer Klute
  3089. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3090. @since 2002-02-09
  3091. </summary>
  3092. </member>
  3093. <member name="M:NPOI.HPSF.NoPropertySetStreamException.#ctor">
  3094. <summary>
  3095. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoPropertySetStreamException"/> class.
  3096. </summary>
  3097. </member>
  3098. <member name="M:NPOI.HPSF.NoPropertySetStreamException.#ctor(System.String)">
  3099. <summary>
  3100. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoPropertySetStreamException"/> class.
  3101. </summary>
  3102. <param name="msg">The exception's message string</param>
  3103. </member>
  3104. <member name="M:NPOI.HPSF.NoPropertySetStreamException.#ctor(System.Exception)">
  3105. <summary>
  3106. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoPropertySetStreamException"/> class.
  3107. </summary>
  3108. <param name="reason">This exception's underlying reason</param>
  3109. </member>
  3110. <member name="M:NPOI.HPSF.NoPropertySetStreamException.#ctor(System.String,System.Exception)">
  3111. <summary>
  3112. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoPropertySetStreamException"/> class.
  3113. </summary>
  3114. <param name="msg">The exception's message string</param>
  3115. <param name="reason">This exception's underlying reason</param>
  3116. </member>
  3117. <member name="T:NPOI.HPSF.NoSingleSectionException">
  3118. <summary>
  3119. This exception is thrown if one of the {@link PropertySet}'s
  3120. convenience methods that require a single {@link Section} is called
  3121. and the {@link PropertySet} does not contain exactly one {@link
  3122. Section}.
  3123. The constructors of this class are analogous To those of its
  3124. superclass and documented there.
  3125. @author Rainer Klute
  3126. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3127. @since 2002-02-09
  3128. </summary>
  3129. </member>
  3130. <member name="M:NPOI.HPSF.NoSingleSectionException.#ctor">
  3131. <summary>
  3132. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoSingleSectionException"/> class.
  3133. </summary>
  3134. </member>
  3135. <member name="M:NPOI.HPSF.NoSingleSectionException.#ctor(System.String)">
  3136. <summary>
  3137. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoSingleSectionException"/> class.
  3138. </summary>
  3139. <param name="msg">The exception's message string</param>
  3140. </member>
  3141. <member name="M:NPOI.HPSF.NoSingleSectionException.#ctor(System.Exception)">
  3142. <summary>
  3143. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoSingleSectionException"/> class.
  3144. </summary>
  3145. <param name="reason">This exception's underlying reason</param>
  3146. </member>
  3147. <member name="M:NPOI.HPSF.NoSingleSectionException.#ctor(System.String,System.Exception)">
  3148. <summary>
  3149. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoSingleSectionException"/> class.
  3150. </summary>
  3151. <param name="msg">The exception's message string</param>
  3152. <param name="reason">This exception's underlying reason</param>
  3153. </member>
  3154. <member name="T:NPOI.HPSF.Property">
  3155. <summary>
  3156. A property in a {@link Section} of a {@link PropertySet}.
  3157. The property's ID gives the property a meaning
  3158. in the context of its {@link Section}. Each {@link Section} spans
  3159. its own name space of property IDs.
  3160. The property's type determines how its
  3161. value is interpreted. For example, if the type Is
  3162. {@link Variant#VT_LPSTR} (byte string), the value consists of a
  3163. DWord telling how many bytes the string Contains. The bytes follow
  3164. immediately, including any null bytes that terminate the
  3165. string. The type {@link Variant#VT_I4} denotes a four-byte integer
  3166. value, {@link Variant#VT_FILETIME} some DateTime and time (of a
  3167. file).
  3168. Please note that not all {@link Variant} types yet. This might Change
  3169. over time but largely depends on your feedback so that the POI team knows
  3170. which variant types are really needed. So please feel free To submit error
  3171. reports or patches for the types you need.
  3172. Microsoft documentation:
  3173. <a href="http://msdn.microsoft.com/library/en-us/stg/stg/property_Set_display_name_dictionary.asp?frame=true">
  3174. Property Set Display Name Dictionary</a>
  3175. .
  3176. @author Rainer Klute
  3177. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3178. @author Drew Varner (Drew.Varner InAndAround sc.edu)
  3179. @see Section
  3180. @see Variant
  3181. @since 2002-02-09
  3182. </summary>
  3183. </member>
  3184. <member name="F:NPOI.HPSF.Property.id">
  3185. The property's ID.
  3186. </member>
  3187. <member name="P:NPOI.HPSF.Property.ID">
  3188. Returns the property's ID.
  3189. @return The ID value
  3190. </member>
  3191. <member name="F:NPOI.HPSF.Property.type">
  3192. The property's type.
  3193. </member>
  3194. <member name="P:NPOI.HPSF.Property.Type">
  3195. Returns the property's type.
  3196. @return The type value
  3197. </member>
  3198. <member name="F:NPOI.HPSF.Property.value">
  3199. The property's value.
  3200. </member>
  3201. <member name="P:NPOI.HPSF.Property.Value">
  3202. <summary>
  3203. Gets the property's value.
  3204. </summary>
  3205. <value>The property's value</value>
  3206. </member>
  3207. <member name="M:NPOI.HPSF.Property.#ctor(System.Int64,System.Int64,System.Object)">
  3208. <summary>
  3209. Initializes a new instance of the <see cref="T:NPOI.HPSF.Property"/> class.
  3210. </summary>
  3211. <param name="id">the property's ID.</param>
  3212. <param name="type">the property's type, see {@link Variant}.</param>
  3213. <param name="value">the property's value. Only certain types are allowed, see
  3214. {@link Variant}.</param>
  3215. </member>
  3216. <member name="M:NPOI.HPSF.Property.#ctor(System.Int64,System.Byte[],System.Int64,System.Int32,System.Int32)">
  3217. <summary>
  3218. Initializes a new instance of the <see cref="T:NPOI.HPSF.Property"/> class.
  3219. </summary>
  3220. <param name="id">The property's ID.</param>
  3221. <param name="src">The bytes the property Set stream consists of.</param>
  3222. <param name="offset">The property's type/value pair's offset in the
  3223. section.</param>
  3224. <param name="Length">The property's type/value pair's Length in bytes.</param>
  3225. <param name="codepage">The section's and thus the property's
  3226. codepage. It is needed only when Reading string values</param>
  3227. </member>
  3228. <member name="M:NPOI.HPSF.Property.#ctor">
  3229. <summary>
  3230. Initializes a new instance of the <see cref="T:NPOI.HPSF.Property"/> class.
  3231. </summary>
  3232. </member>
  3233. <member name="M:NPOI.HPSF.Property.ReadDictionary(System.Byte[],System.Int64,System.Int32,System.Int32)">
  3234. <summary>
  3235. Reads the dictionary.
  3236. </summary>
  3237. <param name="src">The byte array containing the bytes making out the dictionary.</param>
  3238. <param name="offset">At this offset within src the dictionary starts.</param>
  3239. <param name="Length">The dictionary Contains at most this many bytes.</param>
  3240. <param name="codepage">The codepage of the string values.</param>
  3241. <returns>The dictonary</returns>
  3242. </member>
  3243. <member name="P:NPOI.HPSF.Property.Count">
  3244. <summary>
  3245. Gets the property's size in bytes. This is always a multiple of
  3246. 4.
  3247. </summary>
  3248. <value>the property's size in bytes</value>
  3249. </member>
  3250. <member name="M:NPOI.HPSF.Property.Equals(System.Object)">
  3251. <summary>
  3252. Compares two properties.
  3253. Please beware that a property with
  3254. ID == 0 is a special case: It does not have a type, and its value is the
  3255. section's dictionary. Another special case are strings: Two properties
  3256. may have the different types Variant.VT_LPSTR and Variant.VT_LPWSTR;
  3257. </summary>
  3258. <param name="o">The o.</param>
  3259. <returns></returns>
  3260. </member>
  3261. <member name="M:NPOI.HPSF.Property.TypesAreEqual(System.Int64,System.Int64)">
  3262. <summary>
  3263. Typeses the are equal.
  3264. </summary>
  3265. <param name="t1">The t1.</param>
  3266. <param name="t2">The t2.</param>
  3267. <returns></returns>
  3268. </member>
  3269. <member name="M:NPOI.HPSF.Property.GetHashCode">
  3270. <summary>
  3271. Serves as a hash function for a particular type.
  3272. </summary>
  3273. <returns>
  3274. A hash code for the current <see cref="T:System.Object"/>.
  3275. </returns>
  3276. </member>
  3277. <member name="M:NPOI.HPSF.Property.ToString">
  3278. <summary>
  3279. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  3280. </summary>
  3281. <returns>
  3282. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  3283. </returns>
  3284. </member>
  3285. <member name="T:NPOI.HPSF.PropertySet">
  3286. <summary>
  3287. Represents a property Set in the Horrible Property Set Format
  3288. (HPSF). These are usually metadata of a Microsoft Office
  3289. document.
  3290. An application that wants To access these metadata should Create
  3291. an instance of this class or one of its subclasses by calling the
  3292. factory method {@link PropertySetFactory#Create} and then retrieve
  3293. the information its needs by calling appropriate methods.
  3294. {@link PropertySetFactory#Create} does its work by calling one
  3295. of the constructors {@link PropertySet#PropertySet(InputStream)} or
  3296. {@link PropertySet#PropertySet(byte[])}. If the constructor's
  3297. argument is not in the Horrible Property Set Format, i.e. not a
  3298. property Set stream, or if any other error occurs, an appropriate
  3299. exception is thrown.
  3300. A {@link PropertySet} has a list of {@link Section}s, and each
  3301. {@link Section} has a {@link Property} array. Use {@link
  3302. #GetSections} To retrieve the {@link Section}s, then call {@link
  3303. Section#GetProperties} for each {@link Section} To Get hold of the
  3304. {@link Property} arrays. Since the vast majority of {@link
  3305. PropertySet}s Contains only a single {@link Section}, the
  3306. convenience method {@link #GetProperties} returns the properties of
  3307. a {@link PropertySet}'s {@link Section} (throwing a {@link
  3308. NoSingleSectionException} if the {@link PropertySet} Contains more
  3309. (or less) than exactly one {@link Section}).
  3310. @author Rainer Klute
  3311. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3312. @author Drew Varner (Drew.Varner hanginIn sc.edu)
  3313. @since 2002-02-09
  3314. </summary>
  3315. </member>
  3316. <member name="F:NPOI.HPSF.PropertySet.BYTE_ORDER_ASSERTION">
  3317. The "byteOrder" field must equal this value.
  3318. </member>
  3319. <member name="F:NPOI.HPSF.PropertySet.byteOrder">
  3320. Specifies this {@link PropertySet}'s byte order. See the
  3321. HPFS documentation for details!
  3322. </member>
  3323. <member name="P:NPOI.HPSF.PropertySet.ByteOrder">
  3324. <summary>
  3325. Gets or sets the property Set stream's low-level "byte order"
  3326. field. It is always <c>0xFFFE</c>
  3327. </summary>
  3328. <value>The property Set stream's low-level "byte order" field..</value>
  3329. </member>
  3330. <member name="F:NPOI.HPSF.PropertySet.FORMAT_ASSERTION">
  3331. The "format" field must equal this value.
  3332. </member>
  3333. <member name="F:NPOI.HPSF.PropertySet.format">
  3334. Specifies this {@link PropertySet}'s format. See the HPFS
  3335. documentation for details!
  3336. </member>
  3337. <member name="P:NPOI.HPSF.PropertySet.Format">
  3338. <summary>
  3339. Gets or sets the property Set stream's low-level "format"
  3340. field. It is always <c>0x0000</c>
  3341. </summary>
  3342. <value>The property Set stream's low-level "format" field.</value>
  3343. </member>
  3344. <member name="F:NPOI.HPSF.PropertySet.osVersion">
  3345. Specifies the version of the operating system that Created
  3346. this {@link PropertySet}. See the HPFS documentation for
  3347. details!
  3348. </member>
  3349. <member name="F:NPOI.HPSF.PropertySet.OS_WIN16">
  3350. If the OS version field holds this value the property Set stream Was
  3351. Created on a 16-bit Windows system.
  3352. </member>
  3353. <member name="F:NPOI.HPSF.PropertySet.OS_MACINTOSH">
  3354. If the OS version field holds this value the property Set stream Was
  3355. Created on a Macintosh system.
  3356. </member>
  3357. <member name="F:NPOI.HPSF.PropertySet.OS_WIN32">
  3358. If the OS version field holds this value the property Set stream Was
  3359. Created on a 32-bit Windows system.
  3360. </member>
  3361. <member name="P:NPOI.HPSF.PropertySet.OSVersion">
  3362. <summary>
  3363. Returns the property Set stream's low-level "OS version"
  3364. field.
  3365. </summary>
  3366. <value>The property Set stream's low-level "OS version" field.</value>
  3367. </member>
  3368. <member name="F:NPOI.HPSF.PropertySet.classID">
  3369. Specifies this {@link PropertySet}'s "classID" field. See
  3370. the HPFS documentation for details!
  3371. </member>
  3372. <member name="P:NPOI.HPSF.PropertySet.ClassID">
  3373. <summary>
  3374. Gets or sets the property Set stream's low-level "class ID"
  3375. </summary>
  3376. <value>The property Set stream's low-level "class ID" field.</value>
  3377. </member>
  3378. <member name="P:NPOI.HPSF.PropertySet.SectionCount">
  3379. <summary>
  3380. Returns the number of {@link Section}s in the property
  3381. Set.
  3382. </summary>
  3383. <value>The number of {@link Section}s in the property Set.</value>
  3384. </member>
  3385. <member name="F:NPOI.HPSF.PropertySet.sections">
  3386. The sections in this {@link PropertySet}.
  3387. </member>
  3388. <member name="P:NPOI.HPSF.PropertySet.Sections">
  3389. <summary>
  3390. Returns the {@link Section}s in the property Set.
  3391. </summary>
  3392. <value>{@link Section}s in the property Set.</value>
  3393. </member>
  3394. <member name="M:NPOI.HPSF.PropertySet.#ctor">
  3395. <summary>
  3396. Creates an empty (uninitialized) {@link PropertySet}
  3397. Please note: For the time being this
  3398. constructor is protected since it is used for internal purposes
  3399. only, but expect it To become public once the property Set's
  3400. writing functionality is implemented.
  3401. </summary>
  3402. </member>
  3403. <member name="M:NPOI.HPSF.PropertySet.#ctor(System.IO.Stream)">
  3404. <summary>
  3405. Creates a {@link PropertySet} instance from an {@link
  3406. InputStream} in the Horrible Property Set Format.
  3407. The constructor Reads the first few bytes from the stream
  3408. and determines whether it is really a property Set stream. If
  3409. it Is, it parses the rest of the stream. If it is not, it
  3410. Resets the stream To its beginning in order To let other
  3411. components mess around with the data and throws an
  3412. exception.
  3413. </summary>
  3414. <param name="stream">Holds the data making out the property Set
  3415. stream.</param>
  3416. </member>
  3417. <member name="M:NPOI.HPSF.PropertySet.#ctor(System.Byte[],System.Int32)">
  3418. <summary>
  3419. Creates a {@link PropertySet} instance from a byte array
  3420. that represents a stream in the Horrible Property Set
  3421. Format.
  3422. </summary>
  3423. <param name="stream">The byte array holding the stream data.</param>
  3424. <param name="offset">The offset in stream where the stream data begin.
  3425. If the stream data begin with the first byte in the
  3426. array, the offset is 0.</param>
  3427. </member>
  3428. <member name="M:NPOI.HPSF.PropertySet.#ctor(System.Byte[])">
  3429. <summary>
  3430. Creates a {@link PropertySet} instance from a byte array
  3431. that represents a stream in the Horrible Property Set
  3432. Format.
  3433. </summary>
  3434. <param name="stream">The byte array holding the stream data. The
  3435. complete byte array contents is the stream data.</param>
  3436. </member>
  3437. <member name="M:NPOI.HPSF.PropertySet.IsPropertySetStream(System.IO.Stream)">
  3438. <summary>
  3439. Checks whether an {@link InputStream} is in the Horrible
  3440. Property Set Format.
  3441. </summary>
  3442. <param name="stream">The {@link InputStream} To check. In order To
  3443. perform the check, the method Reads the first bytes from the
  3444. stream. After Reading, the stream is Reset To the position it
  3445. had before Reading. The {@link InputStream} must support the
  3446. {@link InputStream#mark} method.</param>
  3447. <returns>
  3448. <c>true</c> if the stream is a property Set
  3449. stream; otherwise, <c>false</c>.
  3450. </returns>
  3451. </member>
  3452. <member name="M:NPOI.HPSF.PropertySet.IsPropertySetStream(System.Byte[],System.Int32)">
  3453. <summary>
  3454. Checks whether a byte array is in the Horrible Property Set
  3455. Format.
  3456. </summary>
  3457. <param name="src">The byte array To check.</param>
  3458. <param name="offset">The offset in the byte array.</param>
  3459. <returns>
  3460. <c>true</c> if the byte array is a property Set
  3461. stream; otherwise, <c>false</c>.
  3462. </returns>
  3463. </member>
  3464. <member name="M:NPOI.HPSF.PropertySet.init(System.Byte[],System.Int32)">
  3465. <summary>
  3466. Initializes this {@link PropertySet} instance from a byte
  3467. array. The method assumes that it has been checked alReady that
  3468. the byte array indeed represents a property Set stream. It does
  3469. no more checks on its own.
  3470. </summary>
  3471. <param name="src">Byte array containing the property Set stream</param>
  3472. <param name="offset">The property Set stream starts at this offset</param>
  3473. </member>
  3474. <member name="P:NPOI.HPSF.PropertySet.IsSummaryInformation">
  3475. <summary>
  3476. Checks whether this {@link PropertySet} represents a Summary
  3477. Information.
  3478. </summary>
  3479. <value>
  3480. <c>true</c> Checks whether this {@link PropertySet} represents a Summary
  3481. Information; otherwise, <c>false</c>.
  3482. </value>
  3483. </member>
  3484. <member name="P:NPOI.HPSF.PropertySet.IsDocumentSummaryInformation">
  3485. <summary>
  3486. Gets a value indicating whether this instance is document summary information.
  3487. </summary>
  3488. <value>
  3489. <c>true</c> if this instance is document summary information; otherwise, <c>false</c>.
  3490. </value>
  3491. Checks whether this {@link PropertySet} is a Document
  3492. Summary Information.
  3493. @return
  3494. <c>true</c>
  3495. if this {@link PropertySet}
  3496. represents a Document Summary Information, else
  3497. <c>false</c>
  3498. </member>
  3499. <member name="P:NPOI.HPSF.PropertySet.Properties">
  3500. <summary>
  3501. Convenience method returning the {@link Property} array
  3502. contained in this property Set. It is a shortcut for Getting
  3503. the {@link PropertySet}'s {@link Section}s list and then
  3504. Getting the {@link Property} array from the first {@link
  3505. Section}.
  3506. </summary>
  3507. <value>The properties of the only {@link Section} of this
  3508. {@link PropertySet}.</value>
  3509. </member>
  3510. <member name="M:NPOI.HPSF.PropertySet.GetProperty(System.Int32)">
  3511. <summary>
  3512. Convenience method returning the value of the property with
  3513. the specified ID. If the property is not available,
  3514. <c>null</c> is returned and a subsequent call To {@link
  3515. #WasNull} will return <c>true</c> .
  3516. </summary>
  3517. <param name="id">The property ID</param>
  3518. <returns>The property value</returns>
  3519. </member>
  3520. <member name="M:NPOI.HPSF.PropertySet.GetPropertyBooleanValue(System.Int32)">
  3521. <summary>
  3522. Convenience method returning the value of a bool property
  3523. with the specified ID. If the property is not available,
  3524. <c>false</c> is returned. A subsequent call To {@link
  3525. #WasNull} will return <c>true</c> To let the caller
  3526. distinguish that case from a real property value of
  3527. <c>false</c>.
  3528. </summary>
  3529. <param name="id">The property ID</param>
  3530. <returns>The property value</returns>
  3531. </member>
  3532. <member name="M:NPOI.HPSF.PropertySet.GetPropertyIntValue(System.Int32)">
  3533. <summary>
  3534. Convenience method returning the value of the numeric
  3535. property with the specified ID. If the property is not
  3536. available, 0 is returned. A subsequent call To {@link #WasNull}
  3537. will return <c>true</c> To let the caller distinguish
  3538. that case from a real property value of 0.
  3539. </summary>
  3540. <param name="id">The property ID</param>
  3541. <returns>The propertyIntValue value</returns>
  3542. </member>
  3543. <member name="P:NPOI.HPSF.PropertySet.WasNull">
  3544. <summary>
  3545. Checks whether the property which the last call To {@link
  3546. #GetPropertyIntValue} or {@link #GetProperty} tried To access
  3547. Was available or not. This information might be important for
  3548. callers of {@link #GetPropertyIntValue} since the latter
  3549. returns 0 if the property does not exist. Using {@link
  3550. #WasNull}, the caller can distiguish this case from a
  3551. property's real value of 0.
  3552. </summary>
  3553. <value><c>true</c> if the last call To {@link
  3554. #GetPropertyIntValue} or {@link #GetProperty} tried To access a
  3555. property that Was not available; otherwise, <c>false</c>.</value>
  3556. </member>
  3557. <member name="P:NPOI.HPSF.PropertySet.FirstSection">
  3558. <summary>
  3559. Gets the first section.
  3560. </summary>
  3561. <value>The first section.</value>
  3562. </member>
  3563. <member name="P:NPOI.HPSF.PropertySet.SingleSection">
  3564. <summary>
  3565. If the {@link PropertySet} has only a single section this
  3566. method returns it.
  3567. </summary>
  3568. <value>The singleSection value</value>
  3569. </member>
  3570. <member name="M:NPOI.HPSF.PropertySet.Equals(System.Object)">
  3571. <summary>
  3572. Returns <c>true</c> if the <c>PropertySet</c> is equal
  3573. To the specified parameter, else <c>false</c>.
  3574. </summary>
  3575. <param name="o">the object To Compare this
  3576. <c>PropertySet</c>
  3577. with</param>
  3578. <returns><c>true</c>
  3579. if the objects are equal,
  3580. <c>false</c>
  3581. if not</returns>
  3582. </member>
  3583. <member name="M:NPOI.HPSF.PropertySet.GetHashCode">
  3584. <summary>
  3585. Serves as a hash function for a particular type.
  3586. </summary>
  3587. <returns>
  3588. A hash code for the current <see cref="T:System.Object"/>.
  3589. </returns>
  3590. </member>
  3591. <member name="M:NPOI.HPSF.PropertySet.ToString">
  3592. <summary>
  3593. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  3594. </summary>
  3595. <returns>
  3596. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  3597. </returns>
  3598. </member>
  3599. <member name="T:NPOI.HPSF.PropertySetFactory">
  3600. <summary>
  3601. Factory class To Create instances of {@link SummaryInformation},
  3602. {@link DocumentSummaryInformation} and {@link PropertySet}.
  3603. @author Rainer Klute
  3604. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3605. @since 2002-02-09
  3606. </summary>
  3607. </member>
  3608. <member name="M:NPOI.HPSF.PropertySetFactory.Create(NPOI.POIFS.FileSystem.DirectoryEntry,System.String)">
  3609. <p>Creates the most specific {@link PropertySet} from an entry
  3610. in the specified POIFS Directory. This is preferrably a {@link
  3611. DocumentSummaryInformation} or a {@link SummaryInformation}. If
  3612. the specified entry does not contain a property Set stream, an
  3613. exception is thrown. If no entry is found with the given name,
  3614. an exception is thrown.</p>
  3615. @param dir The directory to find the PropertySet in
  3616. @param name The name of the entry Containing the PropertySet
  3617. @return The Created {@link PropertySet}.
  3618. @if there is no entry with that name
  3619. @if the stream does not
  3620. contain a property Set.
  3621. @if some I/O problem occurs.
  3622. @exception EncoderFallbackException if the specified codepage is not
  3623. supported.
  3624. </member>
  3625. <member name="M:NPOI.HPSF.PropertySetFactory.Create(System.IO.Stream)">
  3626. <summary>
  3627. Creates the most specific {@link PropertySet} from an {@link
  3628. InputStream}. This is preferrably a {@link
  3629. DocumentSummaryInformation} or a {@link SummaryInformation}. If
  3630. the specified {@link InputStream} does not contain a property
  3631. Set stream, an exception is thrown and the {@link InputStream}
  3632. is repositioned at its beginning.
  3633. </summary>
  3634. <param name="stream">Contains the property set stream's data.</param>
  3635. <returns>The Created {@link PropertySet}.</returns>
  3636. </member>
  3637. <member name="M:NPOI.HPSF.PropertySetFactory.CreateSummaryInformation">
  3638. <summary>
  3639. Creates a new summary information
  3640. </summary>
  3641. <returns>the new summary information.</returns>
  3642. </member>
  3643. <member name="M:NPOI.HPSF.PropertySetFactory.CreateDocumentSummaryInformation">
  3644. <summary>
  3645. Creates a new document summary information.
  3646. </summary>
  3647. <returns>the new document summary information.</returns>
  3648. </member>
  3649. <member name="T:NPOI.HPSF.ReadingNotSupportedException">
  3650. <summary>
  3651. This exception is thrown when HPSF tries To Read a (yet) unsupported
  3652. variant type.
  3653. @see WritingNotSupportedException
  3654. @see UnsupportedVariantTypeException
  3655. @author Rainer Klute
  3656. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3657. @since 2003-08-08
  3658. </summary>
  3659. </member>
  3660. <member name="M:NPOI.HPSF.ReadingNotSupportedException.#ctor(System.Int64,System.Object)">
  3661. <summary>
  3662. Initializes a new instance of the <see cref="T:NPOI.HPSF.ReadingNotSupportedException"/> class.
  3663. </summary>
  3664. <param name="variantType">The unsupported variant type</param>
  3665. <param name="value">The value who's variant type is not yet supported</param>
  3666. </member>
  3667. <member name="T:NPOI.HPSF.Section">
  3668. <summary>
  3669. Represents a section in a {@link PropertySet}.
  3670. @author Rainer Klute
  3671. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3672. @author Drew Varner (Drew.Varner allUpIn sc.edu)
  3673. @since 2002-02-09
  3674. </summary>
  3675. </member>
  3676. <member name="F:NPOI.HPSF.Section.dictionary">
  3677. Maps property IDs To section-private PID strings. These
  3678. strings can be found in the property with ID 0.
  3679. </member>
  3680. <member name="F:NPOI.HPSF.Section.formatID">
  3681. The section's format ID, {@link #GetFormatID}.
  3682. </member>
  3683. <member name="P:NPOI.HPSF.Section.FormatID">
  3684. <summary>
  3685. Returns the format ID. The format ID is the "type" of the
  3686. section. For example, if the format ID of the first {@link
  3687. Section} Contains the bytes specified by
  3688. <c>org.apache.poi.hpsf.wellknown.SectionIDMap.SUMMARY_INFORMATION_ID</c>
  3689. the section (and thus the property Set) is a SummaryInformation.
  3690. </summary>
  3691. <value>The format ID.</value>
  3692. </member>
  3693. <member name="P:NPOI.HPSF.Section.OffSet">
  3694. <summary>
  3695. Gets the offset of the section in the stream.
  3696. </summary>
  3697. <value>The offset of the section in the stream</value>
  3698. </member>
  3699. <member name="P:NPOI.HPSF.Section.Size">
  3700. <summary>
  3701. Returns the section's size in bytes.
  3702. </summary>
  3703. <value>The section's size in bytes.</value>
  3704. </member>
  3705. <member name="P:NPOI.HPSF.Section.PropertyCount">
  3706. <summary>
  3707. Returns the number of properties in this section.
  3708. </summary>
  3709. <value>The number of properties in this section.</value>
  3710. </member>
  3711. <member name="P:NPOI.HPSF.Section.Properties">
  3712. <summary>
  3713. Returns this section's properties.
  3714. </summary>
  3715. <value>This section's properties.</value>
  3716. </member>
  3717. <member name="M:NPOI.HPSF.Section.#ctor">
  3718. <summary>
  3719. Creates an empty and uninitialized {@link Section}.
  3720. </summary>
  3721. </member>
  3722. <member name="M:NPOI.HPSF.Section.#ctor(System.Byte[],System.Int32)">
  3723. <summary>
  3724. Creates a {@link Section} instance from a byte array.
  3725. </summary>
  3726. <param name="src">Contains the complete property Set stream.</param>
  3727. <param name="offset">The position in the stream that points To the
  3728. section's format ID.</param>
  3729. </member>
  3730. <member name="T:NPOI.HPSF.Section.PropertyListEntry">
  3731. Represents an entry in the property list and holds a property's ID and
  3732. its offset from the section's beginning.
  3733. </member>
  3734. <member name="M:NPOI.HPSF.Section.PropertyListEntry.CompareTo(System.Object)">
  3735. Compares this {@link PropertyListEntry} with another one by their
  3736. offsets. A {@link PropertyListEntry} is "smaller" than another one if
  3737. its offset from the section's begin is smaller.
  3738. @see Comparable#CompareTo(java.lang.Object)
  3739. </member>
  3740. <member name="M:NPOI.HPSF.Section.GetProperty(System.Int64)">
  3741. Returns the value of the property with the specified ID. If
  3742. the property is not available, <c>null</c> is returned
  3743. and a subsequent call To {@link #wasNull} will return
  3744. <c>true</c>.
  3745. @param id The property's ID
  3746. @return The property's value
  3747. </member>
  3748. <member name="M:NPOI.HPSF.Section.GetPropertyIntValue(System.Int64)">
  3749. Returns the value of the numeric property with the specified
  3750. ID. If the property is not available, 0 is returned. A
  3751. subsequent call To {@link #wasNull} will return
  3752. <c>true</c> To let the caller distinguish that case from
  3753. a real property value of 0.
  3754. @param id The property's ID
  3755. @return The property's value
  3756. </member>
  3757. <member name="M:NPOI.HPSF.Section.GetPropertyBooleanValue(System.Int32)">
  3758. Returns the value of the bool property with the specified
  3759. ID. If the property is not available, <c>false</c> Is
  3760. returned. A subsequent call To {@link #wasNull} will return
  3761. <c>true</c> To let the caller distinguish that case from
  3762. a real property value of <c>false</c>.
  3763. @param id The property's ID
  3764. @return The property's value
  3765. </member>
  3766. <member name="F:NPOI.HPSF.Section.wasNull">
  3767. This member is <c>true</c> if the last call To {@link
  3768. #GetPropertyIntValue} or {@link #GetProperty} tried To access a
  3769. property that was not available, else <c>false</c>.
  3770. </member>
  3771. <member name="P:NPOI.HPSF.Section.WasNull">
  3772. <summary>
  3773. Checks whether the property which the last call To {@link
  3774. #GetPropertyIntValue} or {@link #GetProperty} tried To access
  3775. was available or not. This information might be important for
  3776. callers of {@link #GetPropertyIntValue} since the latter
  3777. returns 0 if the property does not exist. Using {@link
  3778. #wasNull} the caller can distiguish this case from a property's
  3779. real value of 0.
  3780. </summary>
  3781. <value><c>true</c> if the last call To {@link
  3782. #GetPropertyIntValue} or {@link #GetProperty} tried To access a
  3783. property that was not available; otherwise, <c>false</c>.</value>
  3784. </member>
  3785. <member name="M:NPOI.HPSF.Section.GetPIDString(System.Int64)">
  3786. <summary>
  3787. Returns the PID string associated with a property ID. The ID
  3788. is first looked up in the {@link Section}'s private
  3789. dictionary. If it is not found there, the method calls {@link
  3790. SectionIDMap#GetPIDString}.
  3791. </summary>
  3792. <param name="pid">The property ID.</param>
  3793. <returns>The property ID's string value</returns>
  3794. </member>
  3795. <member name="M:NPOI.HPSF.Section.Equals(System.Object)">
  3796. Checks whether this section is equal To another object. The result Is
  3797. <c>false</c> if one of the the following conditions holds:
  3798. <ul>
  3799. <li>The other object is not a {@link Section}.</li>
  3800. <li>The format IDs of the two sections are not equal.</li>
  3801. <li>The sections have a different number of properties. However,
  3802. properties with ID 1 (codepage) are not counted.</li>
  3803. <li>The other object is not a {@link Section}.</li>
  3804. <li>The properties have different values. The order of the properties
  3805. is irrelevant.</li>
  3806. </ul>
  3807. @param o The object To Compare this section with
  3808. @return <c>true</c> if the objects are equal, <c>false</c> if
  3809. not
  3810. </member>
  3811. <member name="M:NPOI.HPSF.Section.Remove(NPOI.HPSF.Property[],System.Int32)">
  3812. <summary>
  3813. Removes a field from a property array. The resulting array Is
  3814. compactified and returned.
  3815. </summary>
  3816. <param name="pa">The property array.</param>
  3817. <param name="i">The index of the field To be Removed.</param>
  3818. <returns>the compactified array.</returns>
  3819. </member>
  3820. <member name="M:NPOI.HPSF.Section.GetHashCode">
  3821. <summary>
  3822. Serves as a hash function for a particular type.
  3823. </summary>
  3824. <returns>
  3825. A hash code for the current <see cref="T:System.Object"/>.
  3826. </returns>
  3827. </member>
  3828. <member name="M:NPOI.HPSF.Section.ToString">
  3829. <summary>
  3830. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  3831. </summary>
  3832. <returns>
  3833. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  3834. </returns>
  3835. </member>
  3836. <member name="P:NPOI.HPSF.Section.Dictionary">
  3837. <summary>
  3838. Gets the section's dictionary. A dictionary allows an application To
  3839. use human-Readable property names instead of numeric property IDs. It
  3840. Contains mappings from property IDs To their associated string
  3841. values. The dictionary is stored as the property with ID 0. The codepage
  3842. for the strings in the dictionary is defined by property with ID 1.
  3843. </summary>
  3844. <value>the dictionary or null
  3845. if the section does not have
  3846. a dictionary.</value>
  3847. </member>
  3848. <member name="P:NPOI.HPSF.Section.Codepage">
  3849. <summary>
  3850. Gets the section's codepage, if any.
  3851. </summary>
  3852. <value>The section's codepage if one is defined, else -1.</value>
  3853. </member>
  3854. <member name="T:NPOI.HPSF.SpecialPropertySet">
  3855. <summary>
  3856. Abstract superclass for the convenience classes {@link
  3857. SummaryInformation} and {@link DocumentSummaryInformation}.
  3858. The motivation behind this class is quite nasty if you look
  3859. behind the scenes, but it serves the application programmer well by
  3860. providing him with the easy-to-use {@link SummaryInformation} and
  3861. {@link DocumentSummaryInformation} classes. When parsing the data a
  3862. property Set stream consists of (possibly coming from an {@link
  3863. java.io.Stream}) we want To Read and process each byte only
  3864. once. Since we don't know in advance which kind of property Set we
  3865. have, we can expect only the most general {@link
  3866. PropertySet}. Creating a special subclass should be as easy as
  3867. calling the special subclass' constructor and pass the general
  3868. {@link PropertySet} in. To make things easy internally, the special
  3869. class just holds a reference To the general {@link PropertySet} and
  3870. delegates all method calls To it.
  3871. A cleaner implementation would have been like this: The {@link
  3872. PropertySetFactory} parses the stream data into some internal
  3873. object first. Then it Finds out whether the stream is a {@link
  3874. SummaryInformation}, a {@link DocumentSummaryInformation} or a
  3875. general {@link PropertySet}. However, the current implementation
  3876. went the other way round historically: the convenience classes came
  3877. only late To my mind.
  3878. @author Rainer Klute
  3879. klute@rainer-klute.de
  3880. @since 2002-02-09
  3881. </summary>
  3882. </member>
  3883. <member name="P:NPOI.HPSF.SpecialPropertySet.PropertySetIDMap">
  3884. The id to name mapping of the properties
  3885. in this set.
  3886. </member>
  3887. <member name="F:NPOI.HPSF.SpecialPropertySet.delegate1">
  3888. The "real" property Set <c>SpecialPropertySet</c>
  3889. delegates To.
  3890. </member>
  3891. <member name="M:NPOI.HPSF.SpecialPropertySet.#ctor(NPOI.HPSF.PropertySet)">
  3892. <summary>
  3893. Initializes a new instance of the <see cref="T:NPOI.HPSF.SpecialPropertySet"/> class.
  3894. </summary>
  3895. <param name="ps">The property Set To be encapsulated by the <c>SpecialPropertySet</c></param>
  3896. </member>
  3897. <member name="M:NPOI.HPSF.SpecialPropertySet.#ctor(NPOI.HPSF.MutablePropertySet)">
  3898. <summary>
  3899. Initializes a new instance of the <see cref="T:NPOI.HPSF.SpecialPropertySet"/> class.
  3900. </summary>
  3901. <param name="ps">The mutable property Set To be encapsulated by the <c>SpecialPropertySet</c></param>
  3902. </member>
  3903. <member name="P:NPOI.HPSF.SpecialPropertySet.ByteOrder">
  3904. <summary>
  3905. gets or sets the "byteOrder" property.
  3906. </summary>
  3907. <value>the byteOrder value To Set</value>
  3908. </member>
  3909. <member name="P:NPOI.HPSF.SpecialPropertySet.Format">
  3910. <summary>
  3911. gets or sets the "format" property
  3912. </summary>
  3913. <value>the format value To Set</value>
  3914. </member>
  3915. <member name="P:NPOI.HPSF.SpecialPropertySet.ClassID">
  3916. <summary>
  3917. gets or sets the property Set stream's low-level "class ID"
  3918. field.
  3919. </summary>
  3920. <value>The property Set stream's low-level "class ID" field</value>
  3921. </member>
  3922. <member name="P:NPOI.HPSF.SpecialPropertySet.SectionCount">
  3923. <summary>
  3924. Returns the number of {@link Section}s in the property
  3925. Set.
  3926. </summary>
  3927. <value>The number of {@link Section}s in the property Set.</value>
  3928. </member>
  3929. <member name="P:NPOI.HPSF.SpecialPropertySet.IsSummaryInformation">
  3930. <summary>
  3931. Checks whether this {@link PropertySet} represents a Summary
  3932. Information.
  3933. </summary>
  3934. <value>
  3935. <c>true</c> Checks whether this {@link PropertySet} represents a Summary
  3936. Information; otherwise, <c>false</c>.
  3937. </value>
  3938. </member>
  3939. <member name="P:NPOI.HPSF.SpecialPropertySet.IsDocumentSummaryInformation">
  3940. <summary>
  3941. Gets a value indicating whether this instance is document summary information.
  3942. </summary>
  3943. <value>
  3944. <c>true</c> if this instance is document summary information; otherwise, <c>false</c>.
  3945. </value>
  3946. Checks whether this {@link PropertySet} is a Document
  3947. Summary Information.
  3948. @return
  3949. <c>true</c>
  3950. if this {@link PropertySet}
  3951. represents a Document Summary Information, else
  3952. <c>false</c>
  3953. </member>
  3954. <member name="P:NPOI.HPSF.SpecialPropertySet.FirstSection">
  3955. <summary>
  3956. Gets the PropertySet's first section.
  3957. </summary>
  3958. <value>The {@link PropertySet}'s first section.</value>
  3959. </member>
  3960. <member name="M:NPOI.HPSF.SpecialPropertySet.AddSection(NPOI.HPSF.Section)">
  3961. <summary>
  3962. Adds a section To this property set.
  3963. </summary>
  3964. <param name="section">The {@link Section} To Add. It will be Appended
  3965. after any sections that are alReady present in the property Set
  3966. and thus become the last section.</param>
  3967. </member>
  3968. <member name="M:NPOI.HPSF.SpecialPropertySet.ClearSections">
  3969. <summary>
  3970. Removes all sections from this property Set.
  3971. </summary>
  3972. </member>
  3973. <member name="P:NPOI.HPSF.SpecialPropertySet.OSVersion">
  3974. <summary>
  3975. gets or sets the "osVersion" property
  3976. </summary>
  3977. <value> the osVersion value To Set</value>
  3978. </member>
  3979. <member name="M:NPOI.HPSF.SpecialPropertySet.Write(NPOI.POIFS.FileSystem.DirectoryEntry,System.String)">
  3980. <summary>
  3981. Writes a property Set To a document in a POI filesystem directory.
  3982. </summary>
  3983. <param name="dir">The directory in the POI filesystem To Write the document To</param>
  3984. <param name="name">The document's name. If there is alReady a document with the
  3985. same name in the directory the latter will be overwritten.</param>
  3986. </member>
  3987. <member name="M:NPOI.HPSF.SpecialPropertySet.Write(System.IO.Stream)">
  3988. <summary>
  3989. Writes the property Set To an output stream.
  3990. </summary>
  3991. <param name="out1">the output stream To Write the section To</param>
  3992. </member>
  3993. <member name="M:NPOI.HPSF.SpecialPropertySet.Equals(System.Object)">
  3994. <summary>
  3995. Returns <c>true</c> if the <c>PropertySet</c> is equal
  3996. To the specified parameter, else <c>false</c>.
  3997. </summary>
  3998. <param name="o">the object To Compare this
  3999. <c>PropertySet</c>
  4000. with</param>
  4001. <returns>
  4002. <c>true</c>
  4003. if the objects are equal,
  4004. <c>false</c>
  4005. if not
  4006. </returns>
  4007. </member>
  4008. <member name="P:NPOI.HPSF.SpecialPropertySet.Properties">
  4009. <summary>
  4010. Convenience method returning the {@link Property} array
  4011. contained in this property Set. It is a shortcut for Getting
  4012. the {@link PropertySet}'s {@link Section}s list and then
  4013. Getting the {@link Property} array from the first {@link
  4014. Section}.
  4015. </summary>
  4016. <value>
  4017. The properties of the only {@link Section} of this
  4018. {@link PropertySet}.
  4019. </value>
  4020. </member>
  4021. <member name="M:NPOI.HPSF.SpecialPropertySet.GetProperty(System.Int32)">
  4022. <summary>
  4023. Convenience method returning the value of the property with
  4024. the specified ID. If the property is not available,
  4025. <c>null</c> is returned and a subsequent call To {@link
  4026. #WasNull} will return <c>true</c> .
  4027. </summary>
  4028. <param name="id">The property ID</param>
  4029. <returns>The property value</returns>
  4030. </member>
  4031. <member name="M:NPOI.HPSF.SpecialPropertySet.GetPropertyBooleanValue(System.Int32)">
  4032. <summary>
  4033. Convenience method returning the value of a bool property
  4034. with the specified ID. If the property is not available,
  4035. <c>false</c> is returned. A subsequent call To {@link
  4036. #WasNull} will return <c>true</c> To let the caller
  4037. distinguish that case from a real property value of
  4038. <c>false</c>.
  4039. </summary>
  4040. <param name="id">The property ID</param>
  4041. <returns>The property value</returns>
  4042. </member>
  4043. <member name="M:NPOI.HPSF.SpecialPropertySet.GetPropertyIntValue(System.Int32)">
  4044. <summary>
  4045. Convenience method returning the value of the numeric
  4046. property with the specified ID. If the property is not
  4047. available, 0 is returned. A subsequent call To {@link #WasNull}
  4048. will return <c>true</c> To let the caller distinguish
  4049. that case from a real property value of 0.
  4050. </summary>
  4051. <param name="id">The property ID</param>
  4052. <returns>The propertyIntValue value</returns>
  4053. </member>
  4054. <member name="M:NPOI.HPSF.SpecialPropertySet.GetPropertyStringValue(System.Int32)">
  4055. Fetches the property with the given ID, then does its
  4056. best to return it as a String
  4057. @return The property as a String, or null if unavailable
  4058. </member>
  4059. <member name="M:NPOI.HPSF.SpecialPropertySet.GetHashCode">
  4060. <summary>
  4061. Serves as a hash function for a particular type.
  4062. </summary>
  4063. <returns>
  4064. A hash code for the current <see cref="T:System.Object"/>.
  4065. </returns>
  4066. </member>
  4067. <member name="M:NPOI.HPSF.SpecialPropertySet.ToString">
  4068. <summary>
  4069. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4070. </summary>
  4071. <returns>
  4072. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4073. </returns>
  4074. </member>
  4075. <member name="P:NPOI.HPSF.SpecialPropertySet.WasNull">
  4076. <summary>
  4077. Checks whether the property which the last call To {@link
  4078. #GetPropertyIntValue} or {@link #GetProperty} tried To access
  4079. Was available or not. This information might be important for
  4080. callers of {@link #GetPropertyIntValue} since the latter
  4081. returns 0 if the property does not exist. Using {@link
  4082. #WasNull}, the caller can distiguish this case from a
  4083. property's real value of 0.
  4084. </summary>
  4085. <value>
  4086. <c>true</c> if the last call To {@link
  4087. #GetPropertyIntValue} or {@link #GetProperty} tried To access a
  4088. property that Was not available; otherwise, <c>false</c>.
  4089. </value>
  4090. </member>
  4091. <member name="T:NPOI.HPSF.SummaryInformation">
  4092. <summary>
  4093. Convenience class representing a Summary Information stream in a
  4094. Microsoft Office document.
  4095. @author Rainer Klute
  4096. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  4097. @see DocumentSummaryInformation
  4098. @since 2002-02-09
  4099. </summary>
  4100. </member>
  4101. <member name="F:NPOI.HPSF.SummaryInformation.DEFAULT_STREAM_NAME">
  4102. The document name a summary information stream usually has in a POIFS
  4103. filesystem.
  4104. </member>
  4105. <member name="M:NPOI.HPSF.SummaryInformation.#ctor(NPOI.HPSF.PropertySet)">
  4106. <summary>
  4107. Initializes a new instance of the <see cref="T:NPOI.HPSF.SummaryInformation"/> class.
  4108. </summary>
  4109. <param name="ps">A property Set which should be Created from a summary
  4110. information stream.</param>
  4111. </member>
  4112. <member name="P:NPOI.HPSF.SummaryInformation.Title">
  4113. <summary>
  4114. Gets or sets the title.
  4115. </summary>
  4116. <value>The title.</value>
  4117. </member>
  4118. <member name="M:NPOI.HPSF.SummaryInformation.RemoveTitle">
  4119. <summary>
  4120. Removes the title.
  4121. </summary>
  4122. </member>
  4123. <member name="P:NPOI.HPSF.SummaryInformation.Subject">
  4124. <summary>
  4125. Gets or sets the subject.
  4126. </summary>
  4127. <value>The subject.</value>
  4128. </member>
  4129. <member name="M:NPOI.HPSF.SummaryInformation.RemoveSubject">
  4130. <summary>
  4131. Removes the subject.
  4132. </summary>
  4133. </member>
  4134. <member name="P:NPOI.HPSF.SummaryInformation.Author">
  4135. <summary>
  4136. Gets or sets the author.
  4137. </summary>
  4138. <value>The author.</value>
  4139. </member>
  4140. <member name="M:NPOI.HPSF.SummaryInformation.RemoveAuthor">
  4141. <summary>
  4142. Removes the author.
  4143. </summary>
  4144. </member>
  4145. <member name="P:NPOI.HPSF.SummaryInformation.Keywords">
  4146. <summary>
  4147. Gets or sets the keywords.
  4148. </summary>
  4149. <value>The keywords.</value>
  4150. </member>
  4151. <member name="M:NPOI.HPSF.SummaryInformation.RemoveKeywords">
  4152. <summary>
  4153. Removes the keywords.
  4154. </summary>
  4155. </member>
  4156. <member name="P:NPOI.HPSF.SummaryInformation.Comments">
  4157. <summary>
  4158. Gets or sets the comments.
  4159. </summary>
  4160. <value>The comments.</value>
  4161. </member>
  4162. <member name="M:NPOI.HPSF.SummaryInformation.RemoveComments">
  4163. <summary>
  4164. Removes the comments.
  4165. </summary>
  4166. </member>
  4167. <member name="P:NPOI.HPSF.SummaryInformation.Template">
  4168. <summary>
  4169. Gets or sets the template.
  4170. </summary>
  4171. <value>The template.</value>
  4172. </member>
  4173. <member name="M:NPOI.HPSF.SummaryInformation.RemoveTemplate">
  4174. <summary>
  4175. Removes the template.
  4176. </summary>
  4177. </member>
  4178. <member name="P:NPOI.HPSF.SummaryInformation.LastAuthor">
  4179. <summary>
  4180. Gets or sets the last author.
  4181. </summary>
  4182. <value>The last author.</value>
  4183. </member>
  4184. <member name="M:NPOI.HPSF.SummaryInformation.RemoveLastAuthor">
  4185. <summary>
  4186. Removes the last author.
  4187. </summary>
  4188. </member>
  4189. <member name="P:NPOI.HPSF.SummaryInformation.RevNumber">
  4190. <summary>
  4191. Gets or sets the rev number.
  4192. </summary>
  4193. <value>The rev number.</value>
  4194. </member>
  4195. <member name="M:NPOI.HPSF.SummaryInformation.RemoveRevNumber">
  4196. <summary>
  4197. Removes the rev number.
  4198. </summary>
  4199. </member>
  4200. <member name="P:NPOI.HPSF.SummaryInformation.EditTime">
  4201. <summary>
  4202. Returns the Total time spent in editing the document (or 0).
  4203. </summary>
  4204. <value>The Total time spent in editing the document or 0 if the {@link
  4205. SummaryInformation} does not contain this information.</value>
  4206. </member>
  4207. <member name="M:NPOI.HPSF.SummaryInformation.RemoveEditTime">
  4208. <summary>
  4209. Removes the edit time.
  4210. </summary>
  4211. </member>
  4212. <member name="P:NPOI.HPSF.SummaryInformation.LastPrinted">
  4213. <summary>
  4214. Gets or sets the last printed time
  4215. </summary>
  4216. <value>The last printed time</value>
  4217. Returns the last printed time (or <c>null</c>).
  4218. </member>
  4219. <member name="M:NPOI.HPSF.SummaryInformation.RemoveLastPrinted">
  4220. <summary>
  4221. Removes the last printed.
  4222. </summary>
  4223. </member>
  4224. <member name="P:NPOI.HPSF.SummaryInformation.CreateDateTime">
  4225. <summary>
  4226. Gets or sets the create date time.
  4227. </summary>
  4228. <value>The create date time.</value>
  4229. </member>
  4230. <member name="M:NPOI.HPSF.SummaryInformation.RemoveCreateDateTime">
  4231. <summary>
  4232. Removes the create date time.
  4233. </summary>
  4234. </member>
  4235. <member name="P:NPOI.HPSF.SummaryInformation.LastSaveDateTime">
  4236. <summary>
  4237. Gets or sets the last save date time.
  4238. </summary>
  4239. <value>The last save date time.</value>
  4240. </member>
  4241. <member name="M:NPOI.HPSF.SummaryInformation.RemoveLastSaveDateTime">
  4242. <summary>
  4243. Removes the last save date time.
  4244. </summary>
  4245. </member>
  4246. <member name="P:NPOI.HPSF.SummaryInformation.PageCount">
  4247. <summary>
  4248. Gets or sets the page count or 0 if the {@link SummaryInformation} does
  4249. not contain a page count.
  4250. </summary>
  4251. <value>The page count or 0 if the {@link SummaryInformation} does not
  4252. contain a page count.</value>
  4253. </member>
  4254. <member name="M:NPOI.HPSF.SummaryInformation.RemovePageCount">
  4255. <summary>
  4256. Removes the page count.
  4257. </summary>
  4258. </member>
  4259. <member name="P:NPOI.HPSF.SummaryInformation.WordCount">
  4260. <summary>
  4261. Gets or sets the word count or 0 if the {@link SummaryInformation} does
  4262. not contain a word count.
  4263. </summary>
  4264. <value>The word count.</value>
  4265. </member>
  4266. <member name="M:NPOI.HPSF.SummaryInformation.RemoveWordCount">
  4267. <summary>
  4268. Removes the word count.
  4269. </summary>
  4270. </member>
  4271. <member name="P:NPOI.HPSF.SummaryInformation.CharCount">
  4272. <summary>
  4273. Gets or sets the character count or 0 if the {@link SummaryInformation}
  4274. does not contain a char count.
  4275. </summary>
  4276. <value>The character count.</value>
  4277. </member>
  4278. <member name="M:NPOI.HPSF.SummaryInformation.RemoveCharCount">
  4279. <summary>
  4280. Removes the char count.
  4281. </summary>
  4282. </member>
  4283. <member name="P:NPOI.HPSF.SummaryInformation.Thumbnail">
  4284. <summary>
  4285. Gets or sets the thumbnail (or <c>null</c>) <strong>when this
  4286. method is implemented. Please note that the return type is likely To
  4287. Change!</strong>
  4288. <p>To process this data, you may wish to make use of the
  4289. {@link Thumbnail} class. The raw data is generally
  4290. an image in WMF or Clipboard (BMP?) format</p>
  4291. </summary>
  4292. <value>The thumbnail.</value>
  4293. </member>
  4294. <member name="P:NPOI.HPSF.SummaryInformation.ThumbnailThumbnail">
  4295. <summary>
  4296. Returns the thumbnail or null, processed as an object
  4297. which is (largely) able to unpack the thumbnail image data.
  4298. </summary>
  4299. </member>
  4300. <member name="M:NPOI.HPSF.SummaryInformation.RemoveThumbnail">
  4301. <summary>
  4302. Removes the thumbnail.
  4303. </summary>
  4304. </member>
  4305. <member name="P:NPOI.HPSF.SummaryInformation.ApplicationName">
  4306. <summary>
  4307. Gets or sets the name of the application.
  4308. </summary>
  4309. <value>The name of the application.</value>
  4310. </member>
  4311. <member name="M:NPOI.HPSF.SummaryInformation.RemoveApplicationName">
  4312. <summary>
  4313. Removes the name of the application.
  4314. </summary>
  4315. </member>
  4316. <member name="P:NPOI.HPSF.SummaryInformation.Security">
  4317. <summary>
  4318. Gets or sets a security code which is one of the following values:
  4319. <ul>
  4320. <li>0 if the {@link SummaryInformation} does not contain a
  4321. security field or if there is no security on the document. Use
  4322. {@link PropertySet#wasNull()} To distinguish between the two
  4323. cases!</li>
  4324. <li>1 if the document is password protected</li>
  4325. <li>2 if the document is Read-only recommended</li>
  4326. <li>4 if the document is Read-only enforced</li>
  4327. <li>8 if the document is locked for annotations</li>
  4328. </ul>
  4329. </summary>
  4330. <value>The security code</value>
  4331. </member>
  4332. <member name="M:NPOI.HPSF.SummaryInformation.RemoveSecurity">
  4333. <summary>
  4334. Removes the security code.
  4335. </summary>
  4336. </member>
  4337. <member name="T:NPOI.HPSF.Thumbnail">
  4338. <summary>
  4339. Class To manipulate data in the Clipboard Variant (Variant#VT_CF VT_CF) format.
  4340. @author Drew Varner (Drew.Varner inOrAround sc.edu)
  4341. @since 2002-04-29
  4342. </summary>
  4343. </member>
  4344. <member name="F:NPOI.HPSF.Thumbnail.OFFSet_CFTAG">
  4345. <summary>
  4346. OffSet in bytes where the Clipboard Format Tag starts in the <c>byte[]</c> returned by SummaryInformation#GetThumbnail()
  4347. </summary>
  4348. </member>
  4349. <member name="F:NPOI.HPSF.Thumbnail.OFFSet_CF">
  4350. <summary>
  4351. OffSet in bytes where the Clipboard Format starts in the <c>byte[]</c> returned by SummaryInformation#GetThumbnail()
  4352. </summary>
  4353. <remarks>This is only valid if the Clipboard Format Tag is CFTAG_WINDOWS</remarks>
  4354. </member>
  4355. <member name="F:NPOI.HPSF.Thumbnail.OFFSet_WMFDATA">
  4356. <summary>
  4357. OffSet in bytes where the Windows Metafile (WMF) image data starts in the <c>byte[]</c> returned by SummaryInformation#GetThumbnail()
  4358. There is only WMF data at this point in the
  4359. <c>byte[]</c> if the Clipboard Format Tag is
  4360. CFTAG_WINDOWS and the Clipboard Format is
  4361. CF_METAFILEPICT.
  4362. </summary>
  4363. <remarks>Note: The <c>byte[]</c> that starts at
  4364. <c>OFFSet_WMFDATA</c> and ends at
  4365. <c>GetThumbnail().Length - 1</c> forms a complete WMF
  4366. image. It can be saved To disk with a <c>.wmf</c> file
  4367. type and Read using a WMF-capable image viewer.</remarks>
  4368. </member>
  4369. <member name="F:NPOI.HPSF.Thumbnail.CFTAG_WINDOWS">
  4370. <summary>
  4371. Clipboard Format Tag - Windows clipboard format
  4372. </summary>
  4373. <remarks>A <c>DWORD</c> indicating a built-in Windows clipboard format value</remarks>
  4374. </member>
  4375. <member name="F:NPOI.HPSF.Thumbnail.CFTAG_MACINTOSH">
  4376. <summary>
  4377. Clipboard Format Tag - Macintosh clipboard format
  4378. </summary>
  4379. <remarks>A <c>DWORD</c> indicating a Macintosh clipboard format value</remarks>
  4380. </member>
  4381. <member name="F:NPOI.HPSF.Thumbnail.CFTAG_FMTID">
  4382. <summary>
  4383. Clipboard Format Tag - Format ID
  4384. </summary>
  4385. <remarks>A GUID containing a format identifier (FMTID). This is rarely used.</remarks>
  4386. </member>
  4387. <member name="F:NPOI.HPSF.Thumbnail.CFTAG_NODATA">
  4388. <summary>
  4389. Clipboard Format Tag - No Data
  4390. </summary>
  4391. <remarks>A <c>DWORD</c> indicating No data. This is rarely used.</remarks>
  4392. </member>
  4393. <member name="F:NPOI.HPSF.Thumbnail.CF_METAFILEPICT">
  4394. <summary>
  4395. Clipboard Format - Windows metafile format. This is the recommended way To store thumbnails in Property Streams.
  4396. </summary>
  4397. <remarks>Note:This is not the same format used in
  4398. regular WMF images. The clipboard version of this format has an
  4399. extra clipboard-specific header.</remarks>
  4400. </member>
  4401. <member name="F:NPOI.HPSF.Thumbnail.CF_DIB">
  4402. <summary>
  4403. Clipboard Format - Device Independent Bitmap
  4404. </summary>
  4405. </member>
  4406. <member name="F:NPOI.HPSF.Thumbnail.CF_ENHMETAFILE">
  4407. <summary>
  4408. Clipboard Format - Enhanced Windows metafile format
  4409. </summary>
  4410. </member>
  4411. <member name="F:NPOI.HPSF.Thumbnail.CF_BITMAP">
  4412. <summary>
  4413. Clipboard Format - Bitmap
  4414. </summary>
  4415. <remarks>see msdn.microsoft.com/library/en-us/dnw98bk/html/clipboardoperations.asp</remarks>
  4416. </member>
  4417. <member name="F:NPOI.HPSF.Thumbnail.thumbnailData">
  4418. A <c>byte[]</c> To hold a thumbnail image in (
  4419. Variant#VT_CF VT_CF) format.
  4420. </member>
  4421. <member name="M:NPOI.HPSF.Thumbnail.#ctor">
  4422. <summary>
  4423. Default Constructor. If you use it then one you'll have To Add
  4424. the thumbnail <c>byte[]</c> from {@link
  4425. SummaryInformation#GetThumbnail()} To do any useful
  4426. manipulations, otherwise you'll Get a
  4427. <c>NullPointerException</c>.
  4428. </summary>
  4429. </member>
  4430. <member name="M:NPOI.HPSF.Thumbnail.#ctor(System.Byte[])">
  4431. <summary>
  4432. Initializes a new instance of the <see cref="T:NPOI.HPSF.Thumbnail"/> class.
  4433. </summary>
  4434. <param name="thumbnailData">The thumbnail data.</param>
  4435. </member>
  4436. <member name="P:NPOI.HPSF.Thumbnail.ThumbnailData">
  4437. <summary>
  4438. Gets or sets the thumbnail as a <c>byte[]</c> in {@link
  4439. Variant#VT_CF VT_CF} format.
  4440. </summary>
  4441. <value>The thumbnail value</value>
  4442. </member>
  4443. <member name="P:NPOI.HPSF.Thumbnail.ClipboardFormatTag">
  4444. <summary>
  4445. Returns an <c>int</c> representing the Clipboard
  4446. Format Tag
  4447. Possible return values are:
  4448. <ul>
  4449. <li>{@link #CFTAG_WINDOWS CFTAG_WINDOWS}</li>
  4450. <li>{@link #CFTAG_MACINTOSH CFTAG_MACINTOSH}</li>
  4451. <li>{@link #CFTAG_FMTID CFTAG_FMTID}</li>
  4452. <li>{@link #CFTAG_NODATA CFTAG_NODATA}</li>
  4453. </ul>
  4454. </summary>
  4455. <returns>A flag indicating the Clipboard Format Tag</returns>
  4456. </member>
  4457. <member name="M:NPOI.HPSF.Thumbnail.GetClipboardFormat">
  4458. <summary>
  4459. Returns an <c>int</c> representing the Clipboard
  4460. Format
  4461. Will throw an exception if the Thumbnail's Clipboard Format
  4462. Tag is not {@link Thumbnail#CFTAG_WINDOWS CFTAG_WINDOWS}.
  4463. Possible return values are:
  4464. <ul>
  4465. <li>{@link #CF_METAFILEPICT CF_METAFILEPICT}</li>
  4466. <li>{@link #CF_DIB CF_DIB}</li>
  4467. <li>{@link #CF_ENHMETAFILE CF_ENHMETAFILE}</li>
  4468. <li>{@link #CF_BITMAP CF_BITMAP}</li>
  4469. </ul>
  4470. </summary>
  4471. <returns>a flag indicating the Clipboard Format</returns>
  4472. </member>
  4473. <member name="M:NPOI.HPSF.Thumbnail.GetThumbnailAsWMF">
  4474. <summary>
  4475. Returns the Thumbnail as a <c>byte[]</c> of WMF data
  4476. if the Thumbnail's Clipboard Format Tag is {@link
  4477. #CFTAG_WINDOWS CFTAG_WINDOWS} and its Clipboard Format is
  4478. {@link #CF_METAFILEPICT CF_METAFILEPICT}
  4479. This
  4480. <c>byte[]</c> is in the traditional WMF file, not the
  4481. clipboard-specific version with special headers.
  4482. See <a href="http://www.wvware.com/caolan/ora-wmf.html" tarGet="_blank">http://www.wvware.com/caolan/ora-wmf.html</a>
  4483. for more information on the WMF image format.
  4484. @return A WMF image of the Thumbnail
  4485. @throws HPSFException if the Thumbnail isn't CFTAG_WINDOWS and
  4486. CF_METAFILEPICT
  4487. </summary>
  4488. <returns></returns>
  4489. </member>
  4490. <member name="T:NPOI.HPSF.TypeWriter">
  4491. <summary>
  4492. Class for writing little-endian data and more.
  4493. @author Rainer Klute
  4494. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  4495. @since 2003-02-20
  4496. </summary>
  4497. </member>
  4498. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,System.Int16)">
  4499. <summary>
  4500. Writes a two-byte value (short) To an output stream.
  4501. </summary>
  4502. <param name="out1">The stream To Write To..</param>
  4503. <param name="n">The number of bytes that have been written.</param>
  4504. <returns></returns>
  4505. </member>
  4506. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,System.Int32)">
  4507. Writes a four-byte value To an output stream.
  4508. @param out The stream To Write To.
  4509. @param n The value To Write.
  4510. @exception IOException if an I/O error occurs
  4511. @return The number of bytes written To the output stream.
  4512. </member>
  4513. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,System.UInt32)">
  4514. Writes a four-byte value To an output stream.
  4515. @param out The stream To Write To.
  4516. @param n The value To Write.
  4517. @exception IOException if an I/O error occurs
  4518. @return The number of bytes written To the output stream.
  4519. </member>
  4520. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,System.Int64)">
  4521. Writes a eight-byte value To an output stream.
  4522. @param out The stream To Write To.
  4523. @param n The value To Write.
  4524. @exception IOException if an I/O error occurs
  4525. @return The number of bytes written To the output stream.
  4526. </member>
  4527. <member name="M:NPOI.HPSF.TypeWriter.WriteUShortToStream(System.IO.Stream,System.Int32)">
  4528. Writes an unsigned two-byte value To an output stream.
  4529. @param out The stream To Write To
  4530. @param n The value To Write
  4531. @exception IOException if an I/O error occurs
  4532. </member>
  4533. <member name="M:NPOI.HPSF.TypeWriter.WriteUIntToStream(System.IO.Stream,System.UInt32)">
  4534. Writes an unsigned four-byte value To an output stream.
  4535. @param out The stream To Write To.
  4536. @param n The value To Write.
  4537. @return The number of bytes that have been written To the output stream.
  4538. @exception IOException if an I/O error occurs
  4539. </member>
  4540. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,NPOI.Util.ClassID)">
  4541. Writes a 16-byte {@link ClassID} To an output stream.
  4542. @param out The stream To Write To
  4543. @param n The value To Write
  4544. @return The number of bytes written
  4545. @exception IOException if an I/O error occurs
  4546. </member>
  4547. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,NPOI.HPSF.Property[],System.Int32)">
  4548. Writes an array of {@link Property} instances To an output stream
  4549. according To the Horrible Property Format.
  4550. @param out The stream To Write To
  4551. @param properties The array To Write To the stream
  4552. @param codepage The codepage number To use for writing strings
  4553. @exception IOException if an I/O error occurs
  4554. @throws UnsupportedVariantTypeException if HPSF does not support some
  4555. variant type.
  4556. </member>
  4557. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,System.Double)">
  4558. Writes a double value value To an output stream.
  4559. @param out The stream To Write To.
  4560. @param n The value To Write.
  4561. @exception IOException if an I/O error occurs
  4562. @return The number of bytes written To the output stream.
  4563. </member>
  4564. <member name="T:NPOI.HPSF.UnexpectedPropertySetTypeException">
  4565. <summary>
  4566. This exception is thrown if a certain type of property Set Is
  4567. expected (e.g. a Document Summary Information) but the provided
  4568. property Set is not of that type.
  4569. The constructors of this class are analogous To those of its
  4570. superclass and documented there.
  4571. @author Rainer Klute
  4572. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  4573. @since 2002-02-09
  4574. </summary>
  4575. </member>
  4576. <member name="M:NPOI.HPSF.UnexpectedPropertySetTypeException.#ctor">
  4577. <summary>
  4578. Initializes a new instance of the <see cref="T:NPOI.HPSF.UnexpectedPropertySetTypeException"/> class.
  4579. </summary>
  4580. </member>
  4581. <member name="M:NPOI.HPSF.UnexpectedPropertySetTypeException.#ctor(System.String)">
  4582. <summary>
  4583. Initializes a new instance of the <see cref="T:NPOI.HPSF.UnexpectedPropertySetTypeException"/> class.
  4584. </summary>
  4585. <param name="msg">The message string.</param>
  4586. </member>
  4587. <member name="M:NPOI.HPSF.UnexpectedPropertySetTypeException.#ctor(System.Exception)">
  4588. <summary>
  4589. Initializes a new instance of the <see cref="T:NPOI.HPSF.UnexpectedPropertySetTypeException"/> class.
  4590. </summary>
  4591. <param name="reason">The reason, i.e. a throwable that indirectly
  4592. caused this exception.</param>
  4593. </member>
  4594. <member name="M:NPOI.HPSF.UnexpectedPropertySetTypeException.#ctor(System.String,System.Exception)">
  4595. <summary>
  4596. Initializes a new instance of the <see cref="T:NPOI.HPSF.UnexpectedPropertySetTypeException"/> class.
  4597. </summary>
  4598. <param name="msg">The message string.</param>
  4599. <param name="reason">The reason, i.e. a throwable that indirectly
  4600. caused this exception.</param>
  4601. </member>
  4602. <member name="M:NPOI.HPSF.UnicodeString.validLength(System.Int32,System.Byte[],System.Int32)">
  4603. Checks to see if the specified length seems valid,
  4604. given the amount of data available still to read,
  4605. and the requirement that the string be NULL-terminated
  4606. </member>
  4607. <member name="T:NPOI.HPSF.UnsupportedVariantTypeException">
  4608. <summary>
  4609. This exception is thrown if HPSF encounters a variant type that isn't
  4610. supported yet. Although a variant type is unsupported the value can still be
  4611. retrieved using the {@link VariantTypeException#GetValue} method.
  4612. Obviously this class should disappear some day.
  4613. @author Rainer Klute
  4614. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  4615. @since 2003-08-05
  4616. </summary>
  4617. </member>
  4618. <member name="M:NPOI.HPSF.UnsupportedVariantTypeException.#ctor(System.Int64,System.Object)">
  4619. <summary>
  4620. Initializes a new instance of the <see cref="T:NPOI.HPSF.UnsupportedVariantTypeException"/> class.
  4621. </summary>
  4622. <param name="variantType">The unsupported variant type</param>
  4623. <param name="value">The value who's variant type is not yet supported</param>
  4624. </member>
  4625. <member name="T:NPOI.HPSF.Util">
  4626. <summary>
  4627. Provides various static utility methods.
  4628. @author Rainer Klute (klute@rainer-klute.de)
  4629. @since 2002-02-09
  4630. </summary>
  4631. </member>
  4632. <member name="M:NPOI.HPSF.Util.Copy(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
  4633. <summary>
  4634. Copies a part of a byte array into another byte array.
  4635. </summary>
  4636. <param name="src">The source byte array.</param>
  4637. <param name="srcOffSet">OffSet in the source byte array.</param>
  4638. <param name="Length">The number of bytes To Copy.</param>
  4639. <param name="dst">The destination byte array.</param>
  4640. <param name="dstOffSet">OffSet in the destination byte array.</param>
  4641. </member>
  4642. <member name="M:NPOI.HPSF.Util.Cat(System.Byte[][])">
  4643. <summary>
  4644. Concatenates the contents of several byte arrays into a
  4645. single one.
  4646. </summary>
  4647. <param name="byteArrays">The byte arrays To be conCatened.</param>
  4648. <returns>A new byte array containing the conCatenated byte arrays.</returns>
  4649. </member>
  4650. <member name="M:NPOI.HPSF.Util.Copy(System.Byte[],System.Int32,System.Int32)">
  4651. <summary>
  4652. Copies bytes from a source byte array into a new byte
  4653. array.
  4654. </summary>
  4655. <param name="src">Copy from this byte array.</param>
  4656. <param name="offset">Start Copying here.</param>
  4657. <param name="Length">Copy this many bytes.</param>
  4658. <returns>The new byte array. Its Length is number of copied bytes.</returns>
  4659. </member>
  4660. <member name="F:NPOI.HPSF.Util.EPOCH_DIFF">
  4661. The difference between the Windows epoch (1601-01-01
  4662. 00:00:00) and the Unix epoch (1970-01-01 00:00:00) in
  4663. milliseconds: 11644473600000L. (Use your favorite spReadsheet
  4664. program To verify the correctness of this value. By the way,
  4665. did you notice that you can tell from the epochs which
  4666. operating system is the modern one? :-))
  4667. </member>
  4668. <member name="M:NPOI.HPSF.Util.FiletimeToDate(System.Int32,System.Int32)">
  4669. <summary>
  4670. Converts a Windows FILETIME into a {@link DateTime}. The Windows
  4671. FILETIME structure holds a DateTime and time associated with a
  4672. file. The structure identifies a 64-bit integer specifying the
  4673. number of 100-nanosecond intervals which have passed since
  4674. January 1, 1601. This 64-bit value is split into the two double
  4675. words stored in the structure.
  4676. </summary>
  4677. <param name="high">The higher double word of the FILETIME structure.</param>
  4678. <param name="low">The lower double word of the FILETIME structure.</param>
  4679. <returns>The Windows FILETIME as a {@link DateTime}.</returns>
  4680. </member>
  4681. <member name="M:NPOI.HPSF.Util.FiletimeToDate(System.Int64)">
  4682. <summary>
  4683. Converts a Windows FILETIME into a {@link DateTime}. The Windows
  4684. FILETIME structure holds a DateTime and time associated with a
  4685. file. The structure identifies a 64-bit integer specifying the
  4686. number of 100-nanosecond intervals which have passed since
  4687. January 1, 1601.
  4688. </summary>
  4689. <param name="filetime">The filetime To Convert.</param>
  4690. <returns>The Windows FILETIME as a {@link DateTime}.</returns>
  4691. </member>
  4692. <member name="M:NPOI.HPSF.Util.DateToFileTime(System.DateTime)">
  4693. <summary>
  4694. Converts a {@link DateTime} into a filetime.
  4695. </summary>
  4696. <param name="dateTime">The DateTime To be Converted</param>
  4697. <returns>The filetime</returns>
  4698. </member>
  4699. <member name="M:NPOI.HPSF.Util.AreEqual(System.Collections.IList,System.Collections.IList)">
  4700. <summary>
  4701. Compares To object arrays with regarding the objects' order. For
  4702. example, [1, 2, 3] and [2, 1, 3] are equal.
  4703. </summary>
  4704. <param name="c1">The first object array.</param>
  4705. <param name="c2">The second object array.</param>
  4706. <returns><c>true</c>
  4707. if the object arrays are equal,
  4708. <c>false</c>
  4709. if they are not.</returns>
  4710. </member>
  4711. <member name="M:NPOI.HPSF.Util.internalEquals(System.Collections.IList,System.Collections.IList)">
  4712. <summary>
  4713. Internals the equals.
  4714. </summary>
  4715. <param name="c1">The c1.</param>
  4716. <param name="c2">The c2.</param>
  4717. <returns></returns>
  4718. </member>
  4719. <member name="M:NPOI.HPSF.Util.Pad4(System.Byte[])">
  4720. <summary>
  4721. Pads a byte array with 0x00 bytes so that its Length is a multiple of
  4722. 4.
  4723. </summary>
  4724. <param name="ba">The byte array To pad.</param>
  4725. <returns>The padded byte array.</returns>
  4726. </member>
  4727. <member name="M:NPOI.HPSF.Util.Pad4(System.Char[])">
  4728. <summary>
  4729. Pads a character array with 0x0000 characters so that its Length is a
  4730. multiple of 4.
  4731. </summary>
  4732. <param name="ca">The character array To pad.</param>
  4733. <returns>The padded character array.</returns>
  4734. </member>
  4735. <member name="M:NPOI.HPSF.Util.Pad4(System.String)">
  4736. <summary>
  4737. Pads a string with 0x0000 characters so that its Length is a
  4738. multiple of 4.
  4739. </summary>
  4740. <param name="s">The string To pad.</param>
  4741. <returns> The padded string as a character array.</returns>
  4742. </member>
  4743. <member name="T:NPOI.HPSF.Variant">
  4744. <summary>
  4745. The <em>Variant</em> types as defined by Microsoft's COM. I
  4746. found this information in <a href="http://www.marin.clara.net/COM/variant_type_definitions.htm">
  4747. http://www.marin.clara.net/COM/variant_type_definitions.htm</a>.
  4748. In the variant types descriptions the following shortcuts are
  4749. used: <strong> [V]</strong> - may appear in a VARIANT,
  4750. <strong>[T]</strong> - may appear in a TYPEDESC,
  4751. <strong>[P]</strong> - may appear in an OLE property Set,
  4752. <strong>[S]</strong> - may appear in a Safe Array.
  4753. @author Rainer Klute (klute@rainer-klute.de)
  4754. @since 2002-02-09
  4755. </summary>
  4756. </member>
  4757. <member name="F:NPOI.HPSF.Variant.VT_EMPTY">
  4758. [V][P] Nothing, i.e. not a single byte of data.
  4759. </member>
  4760. <member name="F:NPOI.HPSF.Variant.VT_NULL">
  4761. [V][P] SQL style Null.
  4762. </member>
  4763. <member name="F:NPOI.HPSF.Variant.VT_I2">
  4764. [V][T][P][S] 2 byte signed int.
  4765. </member>
  4766. <member name="F:NPOI.HPSF.Variant.VT_I4">
  4767. [V][T][P][S] 4 byte signed int.
  4768. </member>
  4769. <member name="F:NPOI.HPSF.Variant.VT_R4">
  4770. [V][T][P][S] 4 byte real.
  4771. </member>
  4772. <member name="F:NPOI.HPSF.Variant.VT_R8">
  4773. [V][T][P][S] 8 byte real.
  4774. </member>
  4775. <member name="F:NPOI.HPSF.Variant.VT_CY">
  4776. [V][T][P][S] currency. <span style="background-color:
  4777. #ffff00">How long is this? How is it To be
  4778. interpreted?</span>
  4779. </member>
  4780. <member name="F:NPOI.HPSF.Variant.VT_DATE">
  4781. [V][T][P][S] DateTime. <span style="background-color:
  4782. #ffff00">How long is this? How is it To be
  4783. interpreted?</span>
  4784. </member>
  4785. <member name="F:NPOI.HPSF.Variant.VT_BSTR">
  4786. [V][T][P][S] OLE Automation string. <span
  4787. style="background-color: #ffff00">How long is this? How is it
  4788. To be interpreted?</span>
  4789. </member>
  4790. <member name="F:NPOI.HPSF.Variant.VT_DISPATCH">
  4791. [V][T][P][S] IDispatch *. <span style="background-color:
  4792. #ffff00">How long is this? How is it To be
  4793. interpreted?</span>
  4794. </member>
  4795. <member name="F:NPOI.HPSF.Variant.VT_ERROR">
  4796. [V][T][S] SCODE. <span style="background-color: #ffff00">How
  4797. long is this? How is it To be interpreted?</span>
  4798. </member>
  4799. <member name="F:NPOI.HPSF.Variant.VT_BOOL">
  4800. [V][T][P][S] True=-1, False=0.
  4801. </member>
  4802. <member name="F:NPOI.HPSF.Variant.VT_VARIANT">
  4803. [V][T][P][S] VARIANT *. <span style="background-color:
  4804. #ffff00">How long is this? How is it To be
  4805. interpreted?</span>
  4806. </member>
  4807. <member name="F:NPOI.HPSF.Variant.VT_UNKNOWN">
  4808. [V][T][S] IUnknown *. <span style="background-color:
  4809. #ffff00">How long is this? How is it To be
  4810. interpreted?</span>
  4811. </member>
  4812. <member name="F:NPOI.HPSF.Variant.VT_DECIMAL">
  4813. [V][T][S] 16 byte fixed point.
  4814. </member>
  4815. <member name="F:NPOI.HPSF.Variant.VT_I1">
  4816. [T] signed char.
  4817. </member>
  4818. <member name="F:NPOI.HPSF.Variant.VT_UI1">
  4819. [V][T][P][S] unsigned char.
  4820. </member>
  4821. <member name="F:NPOI.HPSF.Variant.VT_UI2">
  4822. [T][P] unsigned short.
  4823. </member>
  4824. <member name="F:NPOI.HPSF.Variant.VT_UI4">
  4825. [T][P] unsigned int.
  4826. </member>
  4827. <member name="F:NPOI.HPSF.Variant.VT_I8">
  4828. [T][P] signed 64-bit int.
  4829. </member>
  4830. <member name="F:NPOI.HPSF.Variant.VT_UI8">
  4831. [T][P] unsigned 64-bit int.
  4832. </member>
  4833. <member name="F:NPOI.HPSF.Variant.VT_INT">
  4834. [T] signed machine int.
  4835. </member>
  4836. <member name="F:NPOI.HPSF.Variant.VT_UINT">
  4837. [T] unsigned machine int.
  4838. </member>
  4839. <member name="F:NPOI.HPSF.Variant.VT_VOID">
  4840. [T] C style void.
  4841. </member>
  4842. <member name="F:NPOI.HPSF.Variant.VT_HRESULT">
  4843. [T] Standard return type. <span style="background-color:
  4844. #ffff00">How long is this? How is it To be
  4845. interpreted?</span>
  4846. </member>
  4847. <member name="F:NPOI.HPSF.Variant.VT_PTR">
  4848. [T] pointer type. <span style="background-color:
  4849. #ffff00">How long is this? How is it To be
  4850. interpreted?</span>
  4851. </member>
  4852. <member name="F:NPOI.HPSF.Variant.VT_SAFEARRAY">
  4853. [T] (use VT_ARRAY in VARIANT).
  4854. </member>
  4855. <member name="F:NPOI.HPSF.Variant.VT_CARRAY">
  4856. [T] C style array. <span style="background-color:
  4857. #ffff00">How long is this? How is it To be
  4858. interpreted?</span>
  4859. </member>
  4860. <member name="F:NPOI.HPSF.Variant.VT_USERDEFINED">
  4861. [T] user defined type. <span style="background-color:
  4862. #ffff00">How long is this? How is it To be
  4863. interpreted?</span>
  4864. </member>
  4865. <member name="F:NPOI.HPSF.Variant.VT_LPSTR">
  4866. [T][P] null terminated string.
  4867. </member>
  4868. <member name="F:NPOI.HPSF.Variant.VT_LPWSTR">
  4869. [T][P] wide (Unicode) null terminated string.
  4870. </member>
  4871. <member name="F:NPOI.HPSF.Variant.VT_FILETIME">
  4872. [P] FILETIME. The FILETIME structure holds a DateTime and time
  4873. associated with a file. The structure identifies a 64-bit
  4874. integer specifying the number of 100-nanosecond intervals which
  4875. have passed since January 1, 1601. This 64-bit value is split
  4876. into the two dwords stored in the structure.
  4877. </member>
  4878. <member name="F:NPOI.HPSF.Variant.VT_BLOB">
  4879. [P] Length prefixed bytes.
  4880. </member>
  4881. <member name="F:NPOI.HPSF.Variant.VT_STREAM">
  4882. [P] Name of the stream follows.
  4883. </member>
  4884. <member name="F:NPOI.HPSF.Variant.VT_STORAGE">
  4885. [P] Name of the storage follows.
  4886. </member>
  4887. <member name="F:NPOI.HPSF.Variant.VT_STREAMED_OBJECT">
  4888. [P] Stream Contains an object. <span
  4889. style="background-color: #ffff00"> How long is this? How is it
  4890. To be interpreted?</span>
  4891. </member>
  4892. <member name="F:NPOI.HPSF.Variant.VT_STORED_OBJECT">
  4893. [P] Storage Contains an object. <span
  4894. style="background-color: #ffff00"> How long is this? How is it
  4895. To be interpreted?</span>
  4896. </member>
  4897. <member name="F:NPOI.HPSF.Variant.VT_BLOB_OBJECT">
  4898. [P] Blob Contains an object. <span style="background-color:
  4899. #ffff00">How long is this? How is it To be
  4900. interpreted?</span>
  4901. </member>
  4902. <member name="F:NPOI.HPSF.Variant.VT_CF">
  4903. [P] Clipboard format. <span style="background-color:
  4904. #ffff00">How long is this? How is it To be
  4905. interpreted?</span>
  4906. </member>
  4907. <member name="F:NPOI.HPSF.Variant.VT_CLSID">
  4908. [P] A Class ID.
  4909. It consists of a 32 bit unsigned integer indicating the size
  4910. of the structure, a 32 bit signed integer indicating (Clipboard
  4911. Format Tag) indicating the type of data that it Contains, and
  4912. then a byte array containing the data.
  4913. The valid Clipboard Format Tags are:
  4914. <ul>
  4915. <li>{@link Thumbnail#CFTAG_WINDOWS}</li>
  4916. <li>{@link Thumbnail#CFTAG_MACINTOSH}</li>
  4917. <li>{@link Thumbnail#CFTAG_NODATA}</li>
  4918. <li>{@link Thumbnail#CFTAG_FMTID}</li>
  4919. </ul>
  4920. <pre>typedef struct tagCLIPDATA {
  4921. // cbSize is the size of the buffer pointed To
  4922. // by pClipData, plus sizeof(ulClipFmt)
  4923. ULONG cbSize;
  4924. long ulClipFmt;
  4925. BYTE* pClipData;
  4926. } CLIPDATA;</pre>
  4927. See <a
  4928. href="msdn.microsoft.com/library/en-us/com/stgrstrc_0uwk.asp"
  4929. tarGet="_blank">
  4930. msdn.microsoft.com/library/en-us/com/stgrstrc_0uwk.asp</a>.
  4931. </member>
  4932. <member name="F:NPOI.HPSF.Variant.VT_VERSIONED_STREAM">
  4933. "MUST be a VersionedStream. The storage representing the (non-simple)
  4934. property set MUST have a stream element with the name in the StreamName
  4935. field." -- [MS-OLEPS] -- v20110920; Object Linking and Embedding (OLE)
  4936. Property Set Data Structures; page 24 / 63
  4937. </member>
  4938. <member name="F:NPOI.HPSF.Variant.VT_VECTOR">
  4939. [P] simple counted array. <span style="background-color:
  4940. #ffff00">How long is this? How is it To be
  4941. interpreted?</span>
  4942. </member>
  4943. <member name="F:NPOI.HPSF.Variant.VT_ARRAY">
  4944. [V] SAFEARRAY*. <span style="background-color: #ffff00">How
  4945. long is this? How is it To be interpreted?</span>
  4946. </member>
  4947. <member name="F:NPOI.HPSF.Variant.VT_BYREF">
  4948. [V] void* for local use. <span style="background-color:
  4949. #ffff00">How long is this? How is it To be
  4950. interpreted?</span>
  4951. </member>
  4952. <member name="F:NPOI.HPSF.Variant.VT_RESERVED">
  4953. FIXME (3): Document this!
  4954. </member>
  4955. <member name="F:NPOI.HPSF.Variant.VT_ILLEGAL">
  4956. FIXME (3): Document this!
  4957. </member>
  4958. <member name="F:NPOI.HPSF.Variant.VT_ILLEGALMASKED">
  4959. FIXME (3): Document this!
  4960. </member>
  4961. <member name="F:NPOI.HPSF.Variant.VT_TYPEMASK">
  4962. FIXME (3): Document this!
  4963. </member>
  4964. <member name="F:NPOI.HPSF.Variant.numberToName">
  4965. Maps the numbers denoting the variant types To their corresponding
  4966. variant type names.
  4967. </member>
  4968. <member name="F:NPOI.HPSF.Variant.Length_UNKNOWN">
  4969. Denotes a variant type with a Length that is unknown To HPSF yet.
  4970. </member>
  4971. <member name="F:NPOI.HPSF.Variant.Length_VARIABLE">
  4972. Denotes a variant type with a variable Length.
  4973. </member>
  4974. <member name="F:NPOI.HPSF.Variant.Length_0">
  4975. Denotes a variant type with a Length of 0 bytes.
  4976. </member>
  4977. <member name="F:NPOI.HPSF.Variant.Length_2">
  4978. Denotes a variant type with a Length of 2 bytes.
  4979. </member>
  4980. <member name="F:NPOI.HPSF.Variant.Length_4">
  4981. Denotes a variant type with a Length of 4 bytes.
  4982. </member>
  4983. <member name="F:NPOI.HPSF.Variant.Length_8">
  4984. Denotes a variant type with a Length of 8 bytes.
  4985. </member>
  4986. <member name="M:NPOI.HPSF.Variant.GetVariantName(System.Int64)">
  4987. <summary>
  4988. Returns the variant type name associated with a variant type
  4989. number.
  4990. </summary>
  4991. <param name="variantType">The variant type number.</param>
  4992. <returns>The variant type name or the string "unknown variant type"</returns>
  4993. </member>
  4994. <member name="M:NPOI.HPSF.Variant.GetVariantLength(System.Int64)">
  4995. <summary>
  4996. Returns a variant type's Length.
  4997. </summary>
  4998. <param name="variantType">The variant type number.</param>
  4999. <returns>The Length of the variant type's data in bytes. If the Length Is
  5000. variable, i.e. the Length of a string, -1 is returned. If HPSF does not
  5001. know the Length, -2 is returned. The latter usually indicates an
  5002. unsupported variant type.</returns>
  5003. </member>
  5004. <member name="T:NPOI.HPSF.VariantSupport">
  5005. <summary>
  5006. Supports Reading and writing of variant data.
  5007. <strong>FIXME (3):</strong>
  5008. Reading and writing should be made more
  5009. uniform than it is now. The following items should be resolved:
  5010. Reading requires a Length parameter that is 4 byte greater than the
  5011. actual data, because the variant type field is included.
  5012. Reading Reads from a byte array while writing Writes To an byte array
  5013. output stream.
  5014. @author Rainer Klute
  5015. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  5016. @since 2003-08-08
  5017. </summary>
  5018. </member>
  5019. <member name="P:NPOI.HPSF.VariantSupport.IsLogUnsupportedTypes">
  5020. <summary>
  5021. Checks whether logging of unsupported variant types warning is turned
  5022. on or off.
  5023. </summary>
  5024. <value>
  5025. <c>true</c> if logging is turned on; otherwise, <c>false</c>.
  5026. </value>
  5027. </member>
  5028. <member name="F:NPOI.HPSF.VariantSupport.unsupportedMessage">
  5029. Keeps a list of the variant types an "unsupported" message has alReady
  5030. been issued for.
  5031. </member>
  5032. <member name="M:NPOI.HPSF.VariantSupport.WriteUnsupportedTypeMessage(NPOI.HPSF.UnsupportedVariantTypeException)">
  5033. <summary>
  5034. Writes a warning To System.err that a variant type Is
  5035. unsupported by HPSF. Such a warning is written only once for each variant
  5036. type. Log messages can be turned on or off by
  5037. </summary>
  5038. <param name="ex">The exception To log</param>
  5039. </member>
  5040. <member name="F:NPOI.HPSF.VariantSupport.SUPPORTED_TYPES">
  5041. HPSF is able To Read these {@link Variant} types.
  5042. </member>
  5043. <member name="M:NPOI.HPSF.VariantSupport.IsSupportedType(System.Int32)">
  5044. <summary>
  5045. Checks whether HPSF supports the specified variant type. Unsupported
  5046. types should be implemented included in the {@link #SUPPORTED_TYPES}
  5047. array.
  5048. </summary>
  5049. <param name="variantType">the variant type To check</param>
  5050. <returns>
  5051. <c>true</c> if HPFS supports this type,otherwise, <c>false</c>.
  5052. </returns>
  5053. </member>
  5054. <member name="M:NPOI.HPSF.VariantSupport.Read(System.Byte[],System.Int32,System.Int32,System.Int64,System.Int32)">
  5055. <summary>
  5056. Reads a variant type from a byte array
  5057. </summary>
  5058. <param name="src">The byte array</param>
  5059. <param name="offset">The offset in the byte array where the variant starts</param>
  5060. <param name="length">The Length of the variant including the variant type field</param>
  5061. <param name="type">The variant type To Read</param>
  5062. <param name="codepage">The codepage To use for non-wide strings</param>
  5063. <returns>A Java object that corresponds best To the variant field. For
  5064. example, a VT_I4 is returned as a {@link long}, a VT_LPSTR as a
  5065. {@link String}.</returns>
  5066. </member>
  5067. <member name="M:NPOI.HPSF.VariantSupport.CodepageToEncoding(System.Int32)">
  5068. <p>Turns a codepage number into the equivalent character encoding's
  5069. name.</p>
  5070. @param codepage The codepage number
  5071. @return The character encoding's name. If the codepage number is 65001,
  5072. the encoding name is "UTF-8". All other positive numbers are mapped to
  5073. "cp" followed by the number, e.g. if the codepage number is 1252 the
  5074. returned character encoding name will be "cp1252".
  5075. @exception UnsupportedEncodingException if the specified codepage is
  5076. less than zero.
  5077. </member>
  5078. <member name="M:NPOI.HPSF.VariantSupport.Write(System.IO.Stream,System.Int64,System.Object,System.Int32)">
  5079. <summary>
  5080. Writes a variant value To an output stream. This method ensures that
  5081. always a multiple of 4 bytes is written.
  5082. If the codepage is UTF-16, which is encouraged, strings
  5083. <strong>must</strong> always be written as {@link Variant#VT_LPWSTR}
  5084. strings, not as {@link Variant#VT_LPSTR} strings. This method ensure this
  5085. by Converting strings appropriately, if needed.
  5086. </summary>
  5087. <param name="out1">The stream To Write the value To.</param>
  5088. <param name="type">The variant's type.</param>
  5089. <param name="value">The variant's value.</param>
  5090. <param name="codepage">The codepage To use To Write non-wide strings</param>
  5091. <returns>The number of entities that have been written. In many cases an
  5092. "entity" is a byte but this is not always the case.</returns>
  5093. </member>
  5094. <member name="T:NPOI.HPSF.VariantTypeException">
  5095. <summary>
  5096. This exception is thrown if HPSF encounters a problem with a variant type.
  5097. Concrete subclasses specifiy the problem further.
  5098. @author Rainer Klute
  5099. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  5100. @since 2004-06-21
  5101. </summary>
  5102. </member>
  5103. <member name="M:NPOI.HPSF.VariantTypeException.#ctor(System.Int64,System.Object,System.String)">
  5104. <summary>
  5105. Initializes a new instance of the <see cref="T:NPOI.HPSF.VariantTypeException"/> class.
  5106. </summary>
  5107. <param name="variantType">The variant type causing the problem</param>
  5108. <param name="value">The value who's variant type causes the problem</param>
  5109. <param name="msg">A message text describing the problem</param>
  5110. </member>
  5111. <member name="P:NPOI.HPSF.VariantTypeException.VariantType">
  5112. <summary>
  5113. Gets the offending variant type
  5114. </summary>
  5115. <value>the offending variant type.</value>
  5116. </member>
  5117. <member name="P:NPOI.HPSF.VariantTypeException.Value">
  5118. <summary>
  5119. Returns the value who's variant type caused the problem.
  5120. </summary>
  5121. <value>the value who's variant type caused the problem.</value>
  5122. </member>
  5123. <member name="T:NPOI.HPSF.Wellknown.PropertyIDMap">
  5124. <summary>
  5125. This is a dictionary which maps property ID values To property
  5126. ID strings.
  5127. The methods {@link #GetSummaryInformationProperties} and {@link
  5128. #GetDocumentSummaryInformationProperties} return singleton {@link
  5129. PropertyIDMap}s. An application that wants To extend these maps
  5130. should treat them as unmodifiable, copy them and modifiy the
  5131. copies.
  5132. @author Rainer Klute
  5133. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  5134. @since 2002-02-09
  5135. </summary>
  5136. </member>
  5137. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_TITLE">
  5138. ID of the property that denotes the document's title
  5139. </member>
  5140. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_SUBJECT">
  5141. ID of the property that denotes the document's subject
  5142. </member>
  5143. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_AUTHOR">
  5144. ID of the property that denotes the document's author
  5145. </member>
  5146. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_KEYWORDS">
  5147. ID of the property that denotes the document's keywords
  5148. </member>
  5149. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_COMMENTS">
  5150. ID of the property that denotes the document's comments
  5151. </member>
  5152. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_TEMPLATE">
  5153. ID of the property that denotes the document's template
  5154. </member>
  5155. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LASTAUTHOR">
  5156. ID of the property that denotes the document's last author
  5157. </member>
  5158. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_REVNUMBER">
  5159. ID of the property that denotes the document's revision number
  5160. </member>
  5161. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_EDITTIME">
  5162. ID of the property that denotes the document's edit time
  5163. </member>
  5164. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LASTPRINTED">
  5165. ID of the property that denotes the DateTime and time the document was
  5166. last printed
  5167. </member>
  5168. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_Create_DTM">
  5169. ID of the property that denotes the DateTime and time the document was
  5170. Created.
  5171. </member>
  5172. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LASTSAVE_DTM">
  5173. ID of the property that denotes the DateTime and time the document was
  5174. saved
  5175. </member>
  5176. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_PAGECOUNT">
  5177. ID of the property that denotes the number of pages in the
  5178. document
  5179. </member>
  5180. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_WORDCOUNT">
  5181. ID of the property that denotes the number of words in the
  5182. document
  5183. </member>
  5184. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_CHARCOUNT">
  5185. ID of the property that denotes the number of characters in the
  5186. document
  5187. </member>
  5188. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_THUMBNAIL">
  5189. ID of the property that denotes the document's thumbnail
  5190. </member>
  5191. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_APPNAME">
  5192. ID of the property that denotes the application that Created the
  5193. document
  5194. </member>
  5195. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_SECURITY">
  5196. ID of the property that denotes whether Read/Write access To the
  5197. document is allowed or whether is should be opened as Read-only. It can
  5198. have the following values:
  5199. <table>
  5200. <tbody>
  5201. <tr>
  5202. <th>Value</th>
  5203. <th>Description</th>
  5204. </tr>
  5205. <tr>
  5206. <th>0</th>
  5207. <th>No restriction</th>
  5208. </tr>
  5209. <tr>
  5210. <th>2</th>
  5211. <th>Read-only recommended</th>
  5212. </tr>
  5213. <tr>
  5214. <th>4</th>
  5215. <th>Read-only enforced</th>
  5216. </tr>
  5217. </tbody>
  5218. </table>
  5219. </member>
  5220. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_DICTIONARY">
  5221. The entry is a dictionary.
  5222. </member>
  5223. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_CODEPAGE">
  5224. The entry denotes a code page.
  5225. </member>
  5226. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_CATEGORY">
  5227. The entry is a string denoting the category the file belongs
  5228. To, e.g. review, memo, etc. This is useful To Find documents of
  5229. same type.
  5230. </member>
  5231. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_PRESFORMAT">
  5232. TarGet format for power point presentation, e.g. 35mm,
  5233. printer, video etc.
  5234. </member>
  5235. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_BYTECOUNT">
  5236. Number of bytes.
  5237. </member>
  5238. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LINECOUNT">
  5239. Number of lines.
  5240. </member>
  5241. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_PARCOUNT">
  5242. Number of paragraphs.
  5243. </member>
  5244. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_SLIDECOUNT">
  5245. Number of slides in a power point presentation.
  5246. </member>
  5247. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_NOTECOUNT">
  5248. Number of slides with notes.
  5249. </member>
  5250. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_HIDDENCOUNT">
  5251. Number of hidden slides.
  5252. </member>
  5253. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_MMCLIPCOUNT">
  5254. Number of multimedia clips, e.g. sound or video.
  5255. </member>
  5256. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_SCALE">
  5257. This entry is Set To -1 when scaling of the thumbnail Is
  5258. desired. Otherwise the thumbnail should be cropped.
  5259. </member>
  5260. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_HEADINGPAIR">
  5261. This entry denotes an internally used property. It is a
  5262. vector of variants consisting of pairs of a string (VT_LPSTR)
  5263. and a number (VT_I4). The string is a heading name, and the
  5264. number tells how many document parts are under that
  5265. heading.
  5266. </member>
  5267. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_DOCPARTS">
  5268. This entry Contains the names of document parts (word: names
  5269. of the documents in the master document, excel: sheet names,
  5270. power point: slide titles, binder: document names).
  5271. </member>
  5272. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_MANAGER">
  5273. This entry Contains the name of the project manager.
  5274. </member>
  5275. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_COMPANY">
  5276. This entry Contains the company name.
  5277. </member>
  5278. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LINKSDIRTY">
  5279. If this entry is -1 the links are dirty and should be
  5280. re-evaluated.
  5281. </member>
  5282. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_CCHWITHSPACES">
  5283. The entry specifies an estimate of the number of characters
  5284. in the document, including whitespace, as an integer
  5285. </member>
  5286. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_HYPERLINKSCHANGED">
  5287. This entry contains a boolean which marks if the User Defined
  5288. Property Set has been updated outside of the Application, if so the
  5289. hyperlinks should be updated on document load.
  5290. </member>
  5291. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_VERSION">
  5292. This entry contains the version of the Application which wrote the
  5293. Property set, stored with the two high order bytes having the major
  5294. version number, and the two low order bytes the minor version number.
  5295. </member>
  5296. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_DIGSIG">
  5297. This entry contains the VBA digital signature for the VBA project
  5298. embedded in the document.
  5299. </member>
  5300. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_CONTENTTYPE">
  5301. This entry contains a string of the content type of the file.
  5302. </member>
  5303. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_CONTENTSTATUS">
  5304. This entry contains a string of the document status.
  5305. </member>
  5306. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LANGUAGE">
  5307. This entry contains a string of the document language, but
  5308. normally should be empty.
  5309. </member>
  5310. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_DOCVERSION">
  5311. This entry contains a string of the document version, but
  5312. normally should be empty
  5313. </member>
  5314. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_MAX">
  5315. <p>The highest well-known property ID. Applications are free to use
  5316. higher values for custom purposes. (This value is based on Office 12,
  5317. earlier versions of Office had lower values)</p>
  5318. </member>
  5319. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.summaryInformationProperties">
  5320. Contains the summary information property ID values and
  5321. associated strings. See the overall HPSF documentation for
  5322. details!
  5323. </member>
  5324. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.documentSummaryInformationProperties">
  5325. Contains the summary information property ID values and
  5326. associated strings. See the overall HPSF documentation for
  5327. details!
  5328. </member>
  5329. <member name="M:NPOI.HPSF.Wellknown.PropertyIDMap.#ctor(System.Int32,System.Single)">
  5330. <summary>
  5331. Initializes a new instance of the <see cref="T:NPOI.HPSF.Wellknown.PropertyIDMap"/> class.
  5332. </summary>
  5333. <param name="initialCapacity">initialCapacity The initial capacity as defined for
  5334. {@link HashMap}</param>
  5335. <param name="loadFactor">The load factor as defined for {@link HashMap}</param>
  5336. </member>
  5337. <member name="M:NPOI.HPSF.Wellknown.PropertyIDMap.#ctor(System.Collections.IDictionary)">
  5338. <summary>
  5339. Initializes a new instance of the <see cref="T:NPOI.HPSF.Wellknown.PropertyIDMap"/> class.
  5340. </summary>
  5341. <param name="map">The instance To be Created is backed by this map.</param>
  5342. </member>
  5343. <member name="M:NPOI.HPSF.Wellknown.PropertyIDMap.Put(System.Int64,System.String)">
  5344. <summary>
  5345. Puts a ID string for an ID into the {@link
  5346. PropertyIDMap}.
  5347. </summary>
  5348. <param name="id">The ID string.</param>
  5349. <param name="idString">The id string.</param>
  5350. <returns>As specified by the {@link java.util.Map} interface, this method
  5351. returns the previous value associated with the specified id</returns>
  5352. </member>
  5353. <member name="M:NPOI.HPSF.Wellknown.PropertyIDMap.Get(System.Int64)">
  5354. <summary>
  5355. Gets the ID string for an ID from the {@link
  5356. PropertyIDMap}.
  5357. </summary>
  5358. <param name="id">The ID.</param>
  5359. <returns>The ID string associated with id</returns>
  5360. </member>
  5361. <member name="P:NPOI.HPSF.Wellknown.PropertyIDMap.SummaryInformationProperties">
  5362. <summary>
  5363. Gets the Summary Information properties singleton
  5364. </summary>
  5365. <returns></returns>
  5366. </member>
  5367. <member name="P:NPOI.HPSF.Wellknown.PropertyIDMap.DocumentSummaryInformationProperties">
  5368. <summary>
  5369. Gets the Document Summary Information properties
  5370. singleton.
  5371. </summary>
  5372. <returns>The Document Summary Information properties singleton.</returns>
  5373. </member>
  5374. <member name="T:NPOI.HPSF.Wellknown.SectionIDMap">
  5375. <summary>
  5376. Maps section format IDs To {@link PropertyIDMap}s. It Is
  5377. initialized with two well-known section format IDs: those of the
  5378. <c>\005SummaryInformation</c> stream and the
  5379. <c>\005DocumentSummaryInformation</c> stream.
  5380. If you have a section format ID you can use it as a key To query
  5381. this map. If you Get a {@link PropertyIDMap} returned your section
  5382. is well-known and you can query the {@link PropertyIDMap} for PID
  5383. strings. If you Get back <c>null</c> you are on your own.
  5384. This {@link java.util.Map} expects the byte arrays of section format IDs
  5385. as keys. A key maps To a {@link PropertyIDMap} describing the
  5386. property IDs in sections with the specified section format ID.
  5387. @author Rainer Klute (klute@rainer-klute.de)
  5388. @since 2002-02-09
  5389. </summary>
  5390. </member>
  5391. <member name="F:NPOI.HPSF.Wellknown.SectionIDMap.SUMMARY_INFORMATION_ID">
  5392. The SummaryInformation's section's format ID.
  5393. </member>
  5394. <member name="F:NPOI.HPSF.Wellknown.SectionIDMap.DOCUMENT_SUMMARY_INFORMATION_ID1">
  5395. The DocumentSummaryInformation's first and second sections' format
  5396. ID.
  5397. </member>
  5398. <member name="F:NPOI.HPSF.Wellknown.SectionIDMap.UNDEFINED">
  5399. A property without a known name is described by this string.
  5400. </member>
  5401. <member name="F:NPOI.HPSF.Wellknown.SectionIDMap.defaultMap">
  5402. The default section ID map. It maps section format IDs To
  5403. {@link PropertyIDMap}s.
  5404. </member>
  5405. <member name="M:NPOI.HPSF.Wellknown.SectionIDMap.GetInstance">
  5406. <summary>
  5407. Returns the singleton instance of the default {@link
  5408. SectionIDMap}.
  5409. </summary>
  5410. <returns>The instance value</returns>
  5411. </member>
  5412. <member name="M:NPOI.HPSF.Wellknown.SectionIDMap.GetPIDString(System.Byte[],System.Int64)">
  5413. <summary>
  5414. Returns the property ID string that is associated with a
  5415. given property ID in a section format ID's namespace.
  5416. </summary>
  5417. <param name="sectionFormatID">Each section format ID has its own name
  5418. space of property ID strings and thus must be specified.</param>
  5419. <param name="pid">The property ID</param>
  5420. <returns>The well-known property ID string associated with the
  5421. property ID pid in the name space spanned by sectionFormatID If the pid
  5422. sectionFormatID combination is not well-known, the
  5423. string "[undefined]" is returned.
  5424. </returns>
  5425. </member>
  5426. <member name="M:NPOI.HPSF.Wellknown.SectionIDMap.Get(System.Byte[])">
  5427. <summary>
  5428. Returns the {@link PropertyIDMap} for a given section format
  5429. ID.
  5430. </summary>
  5431. <param name="sectionFormatID">The section format ID.</param>
  5432. <returns>the property ID map</returns>
  5433. </member>
  5434. <member name="M:NPOI.HPSF.Wellknown.SectionIDMap.Put(System.Byte[],NPOI.HPSF.Wellknown.PropertyIDMap)">
  5435. <summary>
  5436. Associates a section format ID with a {@link
  5437. PropertyIDMap}.
  5438. </summary>
  5439. <param name="sectionFormatID">the section format ID</param>
  5440. <param name="propertyIDMap">The property ID map.</param>
  5441. <returns></returns>
  5442. </member>
  5443. <member name="T:NPOI.HPSF.WritingNotSupportedException">
  5444. <summary>
  5445. This exception is thrown when trying To Write a (yet) unsupported variant
  5446. type.
  5447. @see ReadingNotSupportedException
  5448. @see UnsupportedVariantTypeException
  5449. @author Rainer Klute
  5450. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  5451. @since 2003-08-08
  5452. </summary>
  5453. </member>
  5454. <member name="M:NPOI.HPSF.WritingNotSupportedException.#ctor(System.Int64,System.Object)">
  5455. <summary>
  5456. Initializes a new instance of the <see cref="T:NPOI.HPSF.WritingNotSupportedException"/> class.
  5457. </summary>
  5458. <param name="variantType">The unsupported variant type.</param>
  5459. <param name="value">The value</param>
  5460. </member>
  5461. <member name="T:NPOI.HSSF.Model.DrawingManager2">
  5462. <summary>
  5463. Provides utilities to manage drawing Groups.
  5464. </summary>
  5465. <remarks>
  5466. Glen Stampoultzis (glens at apache.org)
  5467. </remarks>
  5468. </member>
  5469. <member name="M:NPOI.HSSF.Model.DrawingManager2.ClearDrawingGroups">
  5470. <summary>
  5471. Clears the cached list of drawing Groups
  5472. </summary>
  5473. </member>
  5474. <member name="M:NPOI.HSSF.Model.DrawingManager2.AllocateShapeId(System.Int16)">
  5475. <summary>
  5476. Allocates new shape id for the new drawing Group id.
  5477. </summary>
  5478. <param name="drawingGroupId"></param>
  5479. <returns>a new shape id.</returns>
  5480. </member>
  5481. <member name="M:NPOI.HSSF.Model.DrawingManager2.AllocateShapeId(System.Int16,NPOI.DDF.EscherDgRecord)">
  5482. <summary>
  5483. Allocates new shape id for the new drawing group id.
  5484. </summary>
  5485. <param name="drawingGroupId"></param>
  5486. <param name="dg"></param>
  5487. <returns>a new shape id.</returns>
  5488. </member>
  5489. <member name="M:NPOI.HSSF.Model.DrawingManager2.FindNewDrawingGroupId">
  5490. <summary>
  5491. Finds the next available (1 based) drawing Group id
  5492. </summary>
  5493. <returns></returns>
  5494. </member>
  5495. <member name="T:NPOI.HSSF.Model.HSSFFormulaParser">
  5496. HSSF wrapper for the {@link FormulaParser} and {@link FormulaRenderer}
  5497. @author Josh Micich
  5498. </member>
  5499. <member name="M:NPOI.HSSF.Model.HSSFFormulaParser.Parse(System.String,NPOI.HSSF.UserModel.HSSFWorkbook)">
  5500. Convenience method for parsing cell formulas. see {@link #parse(String, HSSFWorkbook, int)}
  5501. </member>
  5502. <member name="M:NPOI.HSSF.Model.HSSFFormulaParser.Parse(System.String,NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.SS.Formula.FormulaType)">
  5503. @param formulaType a constant from {@link FormulaType}
  5504. @return the parsed formula tokens
  5505. </member>
  5506. <member name="M:NPOI.HSSF.Model.HSSFFormulaParser.Parse(System.String,NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.SS.Formula.FormulaType,System.Int32)">
  5507. @param formula the formula to parse
  5508. @param workbook the parent workbook
  5509. @param formulaType a constant from {@link FormulaType}
  5510. @param sheetIndex the 0-based index of the sheet this formula belongs to.
  5511. The sheet index is required to resolve sheet-level names. <code>-1</code> means that
  5512. the scope of the name will be ignored and the parser will match named ranges only by name
  5513. @return the parsed formula tokens
  5514. </member>
  5515. <member name="M:NPOI.HSSF.Model.HSSFFormulaParser.ToFormulaString(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.SS.Formula.PTG.Ptg[])">
  5516. Static method to convert an array of {@link Ptg}s in RPN order
  5517. to a human readable string format in infix mode.
  5518. @param book used for defined names and 3D references
  5519. @param ptgs must not be <c>null</c>
  5520. @return a human readable String
  5521. </member>
  5522. <member name="T:NPOI.HSSF.Model.InternalSheet">
  5523. <summary>
  5524. Low level model implementation of a Sheet (one workbook Contains many sheets)
  5525. This file Contains the low level binary records starting at the sheets BOF and
  5526. ending with the sheets EOF. Use HSSFSheet for a high level representation.
  5527. The structures of the highlevel API use references to this to perform most of their
  5528. operations. Its probably Unwise to use these low level structures directly Unless you
  5529. really know what you're doing. I recommend you Read the Microsoft Excel 97 Developer's
  5530. Kit (Microsoft Press) and the documentation at http://sc.openoffice.org/excelfileformat.pdf
  5531. before even attempting to use this.
  5532. </summary>
  5533. <remarks>
  5534. @author Andrew C. Oliver (acoliver at apache dot org)
  5535. @author Glen Stampoultzis (glens at apache.org)
  5536. @author Shawn Laubach (slaubach at apache dot org) Gridlines, Headers, Footers, PrintSetup, and Setting Default Column Styles
  5537. @author Jason Height (jheight at chariot dot net dot au) Clone support. DBCell and Index Record writing support
  5538. @author Brian Sanders (kestrel at burdell dot org) Active Cell support
  5539. @author Jean-Pierre Paris (jean-pierre.paris at m4x dot org) (Just a little)
  5540. </remarks>
  5541. </member>
  5542. <member name="F:NPOI.HSSF.Model.InternalSheet._mergedCellsTable">
  5543. java object always present, but if empty no BIFF records are written
  5544. </member>
  5545. <member name="F:NPOI.HSSF.Model.InternalSheet._dimensions">
  5546. the DimensionsRecord is always present
  5547. </member>
  5548. <member name="F:NPOI.HSSF.Model.InternalSheet._isUncalced">
  5549. Add an UncalcedRecord if not true indicating formulas have not been calculated
  5550. </member>
  5551. <member name="M:NPOI.HSSF.Model.InternalSheet.CloneSheet">
  5552. <summary>
  5553. Clones the low level records of this sheet and returns the new sheet instance.
  5554. This method is implemented by Adding methods for deep cloning to all records that
  5555. can be Added to a sheet. The Record object does not implement Cloneable.
  5556. When Adding a new record, implement a public Clone method if and only if the record
  5557. belongs to a sheet.
  5558. </summary>
  5559. <returns></returns>
  5560. </member>
  5561. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateSheet(NPOI.HSSF.Model.RecordStream)">
  5562. <summary>
  5563. Creates the sheet.
  5564. </summary>
  5565. <param name="rs">The stream.</param>
  5566. <returns></returns>
  5567. </member>
  5568. <member name="M:NPOI.HSSF.Model.InternalSheet.#ctor(NPOI.HSSF.Model.RecordStream)">
  5569. <summary>
  5570. Initializes a new instance of the <see cref="T:NPOI.HSSF.Model.InternalSheet"/> class.
  5571. </summary>
  5572. <param name="rs">The stream.</param>
  5573. </member>
  5574. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateSheet">
  5575. <summary>
  5576. Creates a sheet with all the usual records minus values and the "index"
  5577. record (not required). Sets the location pointer to where the first value
  5578. records should go. Use this to Create a sheet from "scratch".
  5579. </summary>
  5580. <returns>Sheet object with all values Set to defaults</returns>
  5581. </member>
  5582. <member name="M:NPOI.HSSF.Model.InternalSheet.AddMergedRegion(System.Int32,System.Int32,System.Int32,System.Int32)">
  5583. <summary>
  5584. Adds the merged region.
  5585. </summary>
  5586. <param name="rowFrom">the row index From </param>
  5587. <param name="colFrom">The column index From.</param>
  5588. <param name="rowTo">The row index To</param>
  5589. <param name="colTo">The column To.</param>
  5590. <returns></returns>
  5591. </member>
  5592. <member name="M:NPOI.HSSF.Model.InternalSheet.RemoveMergedRegion(System.Int32)">
  5593. <summary>
  5594. Removes the merged region.
  5595. </summary>
  5596. <param name="index">The index.</param>
  5597. </member>
  5598. <member name="P:NPOI.HSSF.Model.InternalSheet.ColumnInfos">
  5599. <summary>
  5600. Gets the column infos.
  5601. </summary>
  5602. <value>The column infos.</value>
  5603. </member>
  5604. <member name="M:NPOI.HSSF.Model.InternalSheet.GetMergedRegionAt(System.Int32)">
  5605. <summary>
  5606. Gets the merged region at.
  5607. </summary>
  5608. <param name="index">The index.</param>
  5609. <returns></returns>
  5610. </member>
  5611. <member name="P:NPOI.HSSF.Model.InternalSheet.NumMergedRegions">
  5612. <summary>
  5613. Gets the number of merged regions.
  5614. </summary>
  5615. <value>The number merged regions.</value>
  5616. </member>
  5617. <member name="P:NPOI.HSSF.Model.InternalSheet.NumConditionalFormattings">
  5618. <summary>
  5619. Gets the number of conditional formattings.
  5620. </summary>
  5621. <value>The number of conditional formattings.</value>
  5622. </member>
  5623. <member name="M:NPOI.HSSF.Model.InternalSheet.SetDimensions(System.Int32,System.Int16,System.Int32,System.Int16)">
  5624. <summary>
  5625. Per an earlier reported bug in working with Andy Khan's excel Read library. This
  5626. Sets the values in the sheet's DimensionsRecord object to be correct. Excel doesn't
  5627. really care, but we want to play nice with other libraries.
  5628. </summary>
  5629. <param name="firstrow">The first row.</param>
  5630. <param name="firstcol">The first column.</param>
  5631. <param name="lastrow">The last row.</param>
  5632. <param name="lastcol">The last column.</param>
  5633. </member>
  5634. <member name="P:NPOI.HSSF.Model.InternalSheet.PreOffset">
  5635. <summary>
  5636. Gets or Sets the preoffset when using DBCELL records (currently Unused) - this Is
  5637. the position of this sheet within the whole file.
  5638. </summary>
  5639. <value>the offset of the sheet's BOF within the file.</value>
  5640. </member>
  5641. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateRow(System.Int32)">
  5642. <summary>
  5643. Create a row record. (does not Add it to the records contained in this sheet)
  5644. </summary>
  5645. <param name="row">row number</param>
  5646. <returns>RowRecord Created for the passed in row number</returns>
  5647. </member>
  5648. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateLabelSST(System.Int32,System.Int16,System.Int32)">
  5649. <summary>
  5650. Create a LABELSST Record (does not Add it to the records contained in this sheet)
  5651. </summary>
  5652. <param name="row">the row the LabelSST Is a member of</param>
  5653. <param name="col">the column the LabelSST defines</param>
  5654. <param name="index">the index of the string within the SST (use workbook AddSSTString method)</param>
  5655. <returns>LabelSSTRecord newly Created containing your SST Index, row,col.</returns>
  5656. </member>
  5657. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateNumber(System.Int32,System.Int16,System.Double)">
  5658. <summary>
  5659. Create a NUMBER Record (does not Add it to the records contained in this sheet)
  5660. </summary>
  5661. <param name="row">the row the NumberRecord is a member of</param>
  5662. <param name="col">the column the NumberRecord defines</param>
  5663. <param name="value">value for the number record</param>
  5664. <returns>NumberRecord for that row, col containing that value as Added to the sheet</returns>
  5665. </member>
  5666. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateBlank(System.Int32,System.Int16)">
  5667. <summary>
  5668. Create a BLANK record (does not Add it to the records contained in this sheet)
  5669. </summary>
  5670. <param name="row">the row the BlankRecord is a member of</param>
  5671. <param name="col">the column the BlankRecord is a member of</param>
  5672. <returns></returns>
  5673. </member>
  5674. <member name="M:NPOI.HSSF.Model.InternalSheet.AddValueRecord(System.Int32,NPOI.HSSF.Record.CellValueRecordInterface)">
  5675. <summary>
  5676. Adds a value record to the sheet's contained binary records
  5677. (i.e. LabelSSTRecord or NumberRecord).
  5678. This method is "loc" sensitive. Meaning you need to Set LOC to where you
  5679. want it to start searching. If you don't know do this: SetLoc(GetDimsLoc).
  5680. When Adding several rows you can just start at the last one by leaving loc
  5681. at what this Sets it to.
  5682. </summary>
  5683. <param name="row">the row to Add the cell value to</param>
  5684. <param name="col">the cell value record itself.</param>
  5685. </member>
  5686. <member name="M:NPOI.HSSF.Model.InternalSheet.RemoveValueRecord(System.Int32,NPOI.HSSF.Record.CellValueRecordInterface)">
  5687. <summary>
  5688. Remove a value record from the records array.
  5689. This method is not loc sensitive, it Resets loc to = dimsloc so no worries.
  5690. </summary>
  5691. <param name="row">the row of the value record you wish to Remove</param>
  5692. <param name="col">a record supporting the CellValueRecordInterface.</param>
  5693. </member>
  5694. <member name="M:NPOI.HSSF.Model.InternalSheet.ReplaceValueRecord(NPOI.HSSF.Record.CellValueRecordInterface)">
  5695. <summary>
  5696. Replace a value record from the records array.
  5697. This method is not loc sensitive, it Resets loc to = dimsloc so no worries.
  5698. </summary>
  5699. <param name="newval">a record supporting the CellValueRecordInterface. this will Replace
  5700. the cell value with the same row and column. If there Isn't one, one will
  5701. be Added.</param>
  5702. </member>
  5703. <member name="M:NPOI.HSSF.Model.InternalSheet.AddRow(NPOI.HSSF.Record.RowRecord)">
  5704. <summary>
  5705. Adds a row record to the sheet
  5706. This method is "loc" sensitive. Meaning you need to Set LOC to where you
  5707. want it to start searching. If you don't know do this: SetLoc(GetDimsLoc).
  5708. When Adding several rows you can just start at the last one by leaving loc
  5709. at what this Sets it to.
  5710. </summary>
  5711. <param name="row">the row record to be Added</param>
  5712. </member>
  5713. <member name="M:NPOI.HSSF.Model.InternalSheet.RemoveRow(NPOI.HSSF.Record.RowRecord)">
  5714. <summary>
  5715. Removes a row record
  5716. This method is not loc sensitive, it Resets loc to = dimsloc so no worries.
  5717. </summary>
  5718. <param name="row">the row record to Remove</param>
  5719. </member>
  5720. <member name="M:NPOI.HSSF.Model.InternalSheet.GetCellValueIterator">
  5721. Get all the value records (from LOC). Records will be returned from the first
  5722. record (starting at LOC) which is a value record.
  5723. This method is "loc" sensitive. Meaning you need to set LOC to where you
  5724. want it to start searching. If you don't know do this: setLoc(getDimsLoc).
  5725. When adding several rows you can just start at the last one by leaving loc
  5726. at what this sets it to. For this method, set loc to dimsloc to start with,
  5727. subsequent calls will return values in (physical) sequence or NULL when you get to the end.
  5728. @return Iterator of CellValueRecordInterface representing the value records
  5729. </member>
  5730. <member name="P:NPOI.HSSF.Model.InternalSheet.NextRow">
  5731. <summary>
  5732. Get the NEXT RowRecord (from LOC). The first record that is a Row record
  5733. (starting at LOC) will be returned.
  5734. This method is "loc" sensitive. Meaning you need to Set LOC to where you
  5735. want it to start searching. If you don't know do this: SetLoc(GetDimsLoc).
  5736. When Adding several rows you can just start at the last one by leaving loc
  5737. at what this Sets it to. For this method, Set loc to dimsloc to start with.
  5738. subsequent calls will return rows in (physical) sequence or NULL when you Get to the end.
  5739. </summary>
  5740. <value>RowRecord representing the next row record or NULL if there are no more</value>
  5741. </member>
  5742. <member name="M:NPOI.HSSF.Model.InternalSheet.GetRow(System.Int32)">
  5743. <summary>
  5744. Get the NEXT (from LOC) RowRecord where rownumber matches the given rownum.
  5745. The first record that is a Row record (starting at LOC) that has the
  5746. same rownum as the given rownum will be returned.
  5747. This method is "loc" sensitive. Meaning you need to Set LOC to where you
  5748. want it to start searching. If you don't know do this: SetLoc(GetDimsLoc).
  5749. When Adding several rows you can just start at the last one by leaving loc
  5750. at what this Sets it to. For this method, Set loc to dimsloc to start with.
  5751. subsequent calls will return rows in (physical) sequence or NULL when you Get to the end.
  5752. </summary>
  5753. <param name="rownum">which row to return (careful with LOC)</param>
  5754. <returns>RowRecord representing the next row record or NULL if there are no more</returns>
  5755. </member>
  5756. <member name="P:NPOI.HSSF.Model.InternalSheet.PageSettings">
  5757. <summary>
  5758. Gets the page settings.
  5759. </summary>
  5760. <returns></returns>
  5761. </member>
  5762. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateBOF">
  5763. <summary>
  5764. Creates the BOF record
  5765. </summary>
  5766. <returns>record containing a BOFRecord</returns>
  5767. </member>
  5768. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateIndex">
  5769. <summary>
  5770. Creates the Index record - not currently used
  5771. </summary>
  5772. <returns>record containing a IndexRecord</returns>
  5773. </member>
  5774. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateCalcMode">
  5775. <summary>
  5776. Creates the CalcMode record and Sets it to 1 (automatic formula caculation)
  5777. </summary>
  5778. <returns>record containing a CalcModeRecord</returns>
  5779. </member>
  5780. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateCalcCount">
  5781. <summary>
  5782. Creates the CalcCount record and Sets it to 0x64 (default number of iterations)
  5783. </summary>
  5784. <returns>record containing a CalcCountRecord</returns>
  5785. </member>
  5786. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateRefMode">
  5787. <summary>
  5788. Creates the RefMode record and Sets it to A1 Mode (default reference mode)
  5789. </summary>
  5790. <returns>record containing a RefModeRecord</returns>
  5791. </member>
  5792. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateIteration">
  5793. <summary>
  5794. Creates the Iteration record and Sets it to false (don't iteratively calculate formulas)
  5795. </summary>
  5796. <returns>record containing a IterationRecord</returns>
  5797. </member>
  5798. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateDelta">
  5799. <summary>
  5800. Creates the Delta record and Sets it to 0.0010 (default accuracy)
  5801. </summary>
  5802. <returns>record containing a DeltaRecord</returns>
  5803. </member>
  5804. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateSaveRecalc">
  5805. <summary>
  5806. Creates the SaveRecalc record and Sets it to true (recalculate before saving)
  5807. </summary>
  5808. <returns>record containing a SaveRecalcRecord</returns>
  5809. </member>
  5810. <member name="M:NPOI.HSSF.Model.InternalSheet.CreatePrintHeaders">
  5811. <summary>
  5812. Creates the PrintHeaders record and Sets it to false (we don't Create headers yet so why print them)
  5813. </summary>
  5814. <returns>record containing a PrintHeadersRecord</returns>
  5815. </member>
  5816. <member name="M:NPOI.HSSF.Model.InternalSheet.CreatePrintGridlines">
  5817. <summary>
  5818. Creates the PrintGridlines record and Sets it to false (that makes for ugly sheets). As far as I can
  5819. tell this does the same thing as the GridsetRecord
  5820. </summary>
  5821. <returns>record containing a PrintGridlinesRecord</returns>
  5822. </member>
  5823. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateGridset">
  5824. <summary>
  5825. Creates the GridSet record and Sets it to true (user has mucked with the gridlines)
  5826. </summary>
  5827. <returns>record containing a GridsetRecord</returns>
  5828. </member>
  5829. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateGuts">
  5830. <summary>
  5831. Creates the Guts record and Sets leftrow/topcol guttter and rowlevelmax/collevelmax to 0
  5832. </summary>
  5833. <returns>record containing a GutsRecordRecord</returns>
  5834. </member>
  5835. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateDefaultRowHeight">
  5836. <summary>
  5837. Creates the DefaultRowHeight Record and Sets its options to 0 and rowheight to 0xff
  5838. </summary>
  5839. <see cref="T:NPOI.HSSF.Record.DefaultRowHeightRecord"/>
  5840. <see cref="T:NPOI.HSSF.Record.Record"/>
  5841. <returns>record containing a DefaultRowHeightRecord</returns>
  5842. </member>
  5843. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateWSBool">
  5844. Creates the WSBoolRecord and Sets its values to defaults
  5845. @see org.apache.poi.hssf.record.WSBoolRecord
  5846. @see org.apache.poi.hssf.record.Record
  5847. @return record containing a WSBoolRecord
  5848. </member>
  5849. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateHCenter">
  5850. Creates the HCenter Record and Sets it to false (don't horizontally center)
  5851. @see org.apache.poi.hssf.record.HCenterRecord
  5852. @see org.apache.poi.hssf.record.Record
  5853. @return record containing a HCenterRecord
  5854. </member>
  5855. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateVCenter">
  5856. Creates the VCenter Record and Sets it to false (don't horizontally center)
  5857. @see org.apache.poi.hssf.record.VCenterRecord
  5858. @see org.apache.poi.hssf.record.Record
  5859. @return record containing a VCenterRecord
  5860. </member>
  5861. <member name="M:NPOI.HSSF.Model.InternalSheet.CreatePrintSetup">
  5862. Creates the PrintSetup Record and Sets it to defaults and marks it invalid
  5863. @see org.apache.poi.hssf.record.PrintSetupRecord
  5864. @see org.apache.poi.hssf.record.Record
  5865. @return record containing a PrintSetupRecord
  5866. </member>
  5867. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateDefaultColWidth">
  5868. Creates the DefaultColWidth Record and Sets it to 8
  5869. @see org.apache.poi.hssf.record.DefaultColWidthRecord
  5870. @see org.apache.poi.hssf.record.Record
  5871. @return record containing a DefaultColWidthRecord
  5872. </member>
  5873. <member name="P:NPOI.HSSF.Model.InternalSheet.DefaultColumnWidth">
  5874. Get the default column width for the sheet (if the columns do not define their own width)
  5875. @return default column width
  5876. </member>
  5877. <member name="P:NPOI.HSSF.Model.InternalSheet.DefaultRowHeight">
  5878. Get the default row height for the sheet (if the rows do not define their own height)
  5879. @return default row height
  5880. </member>
  5881. <member name="M:NPOI.HSSF.Model.InternalSheet.GetColumnWidth(System.Int32)">
  5882. Get the width of a given column in Units of 1/256th of a Char width
  5883. @param column index
  5884. @see org.apache.poi.hssf.record.DefaultColWidthRecord
  5885. @see org.apache.poi.hssf.record.ColumnInfoRecord
  5886. @see #SetColumnWidth(short,short)
  5887. @return column width in Units of 1/256th of a Char width
  5888. </member>
  5889. <member name="M:NPOI.HSSF.Model.InternalSheet.GetXFIndexForColAt(System.Int16)">
  5890. Get the index to the ExtendedFormatRecord "associated" with
  5891. the column at specified 0-based index. (In this case, an
  5892. ExtendedFormatRecord index is actually associated with a
  5893. ColumnInfoRecord which spans 1 or more columns)
  5894. <br/>
  5895. Returns the index to the default ExtendedFormatRecord (0xF)
  5896. if no ColumnInfoRecord exists that includes the column
  5897. index specified.
  5898. @param column
  5899. @return index of ExtendedFormatRecord associated with
  5900. ColumnInfoRecord that includes the column index or the
  5901. index of the default ExtendedFormatRecord (0xF)
  5902. </member>
  5903. <member name="M:NPOI.HSSF.Model.InternalSheet.SetColumnWidth(System.Int32,System.Int32)">
  5904. Set the width for a given column in 1/256th of a Char width Units
  5905. @param column - the column number
  5906. @param width (in Units of 1/256th of a Char width)
  5907. </member>
  5908. <member name="M:NPOI.HSSF.Model.InternalSheet.IsColumnHidden(System.Int32)">
  5909. Get the hidden property for a given column.
  5910. @param column index
  5911. @see org.apache.poi.hssf.record.DefaultColWidthRecord
  5912. @see org.apache.poi.hssf.record.ColumnInfoRecord
  5913. @see #SetColumnHidden(short,bool)
  5914. @return whether the column is hidden or not.
  5915. </member>
  5916. <member name="M:NPOI.HSSF.Model.InternalSheet.SetColumnHidden(System.Int32,System.Boolean)">
  5917. Get the hidden property for a given column.
  5918. @param column - the column number
  5919. @param hidden - whether the column is hidden or not
  5920. </member>
  5921. <member name="M:NPOI.HSSF.Model.InternalSheet.GroupColumnRange(System.Int32,System.Int32,System.Boolean)">
  5922. Creates an outline Group for the specified columns.
  5923. @param fromColumn Group from this column (inclusive)
  5924. @param toColumn Group to this column (inclusive)
  5925. @param indent if true the Group will be indented by one level,
  5926. if false indenting will be Removed by one level.
  5927. </member>
  5928. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateDimensions">
  5929. Creates the Dimensions Record and Sets it to bogus values (you should Set this yourself
  5930. or let the high level API do it for you)
  5931. @see org.apache.poi.hssf.record.DimensionsRecord
  5932. @see org.apache.poi.hssf.record.Record
  5933. @return record containing a DimensionsRecord
  5934. </member>
  5935. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateWindowTwo">
  5936. Creates the WindowTwo Record and Sets it to:
  5937. options = 0x6b6
  5938. toprow = 0
  5939. leftcol = 0
  5940. headercolor = 0x40
  5941. pagebreakzoom = 0x0
  5942. normalzoom = 0x0
  5943. @see org.apache.poi.hssf.record.WindowTwoRecord
  5944. @see org.apache.poi.hssf.record.Record
  5945. @return record containing a WindowTwoRecord
  5946. </member>
  5947. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateSelection">
  5948. <summary>
  5949. Creates the Selection record and Sets it to nothing selected
  5950. </summary>
  5951. <returns>record containing a SelectionRecord</returns>
  5952. </member>
  5953. <member name="P:NPOI.HSSF.Model.InternalSheet.TopRow">
  5954. <summary>
  5955. Gets or sets the top row.
  5956. </summary>
  5957. <value>The top row.</value>
  5958. </member>
  5959. <member name="P:NPOI.HSSF.Model.InternalSheet.LeftCol">
  5960. <summary>
  5961. Gets or sets the left col.
  5962. </summary>
  5963. <value>The left col.</value>
  5964. </member>
  5965. <member name="M:NPOI.HSSF.Model.InternalSheet.SetActiveCell(System.Int32,System.Int32)">
  5966. <summary>
  5967. Sets the active cell.
  5968. </summary>
  5969. <param name="row">The row.</param>
  5970. <param name="column">The column.</param>
  5971. </member>
  5972. <member name="M:NPOI.HSSF.Model.InternalSheet.SetActiveCellRange(System.Int32,System.Int32,System.Int32,System.Int32)">
  5973. <summary>
  5974. Sets the active cell range.
  5975. </summary>
  5976. <param name="firstRow">The firstrow.</param>
  5977. <param name="lastRow">The lastrow.</param>
  5978. <param name="firstColumn">The firstcolumn.</param>
  5979. <param name="lastColumn">The lastcolumn.</param>
  5980. </member>
  5981. <member name="M:NPOI.HSSF.Model.InternalSheet.SetActiveCellRange(System.Collections.Generic.List{NPOI.SS.Util.CellRangeAddress8Bit},System.Int32,System.Int32,System.Int32,NPOI.SS.UserModel.PanePosition)">
  5982. <summary>
  5983. Sets the active cell range.
  5984. </summary>
  5985. <param name="cellranges">The cellranges.</param>
  5986. <param name="activeRange">The index of the active range.</param>
  5987. <param name="activeRow">The active row in the active range.</param>
  5988. <param name="activeColumn">The active column in the active range.</param>
  5989. <param name="pane">The position of the pane.</param>
  5990. </member>
  5991. <member name="P:NPOI.HSSF.Model.InternalSheet.ActiveCellRow">
  5992. <summary>
  5993. Returns the active row
  5994. </summary>
  5995. <value>the active row index</value>
  5996. @see org.apache.poi.hssf.record.SelectionRecord
  5997. </member>
  5998. <member name="P:NPOI.HSSF.Model.InternalSheet.ActiveCellCol">
  5999. <summary>
  6000. Gets the active cell col.
  6001. </summary>
  6002. <value>the active column index</value>
  6003. @see org.apache.poi.hssf.record.SelectionRecord
  6004. </member>
  6005. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateEOF">
  6006. <summary>
  6007. Creates the EOF record
  6008. </summary>
  6009. <returns>record containing a EOFRecord</returns>
  6010. </member>
  6011. <member name="P:NPOI.HSSF.Model.InternalSheet.GridsetRecord">
  6012. <summary>
  6013. Gets the gridset record for this sheet.
  6014. </summary>
  6015. <value>The gridset record.</value>
  6016. </member>
  6017. <member name="M:NPOI.HSSF.Model.InternalSheet.FindFirstRecordBySid(System.Int16)">
  6018. <summary>
  6019. Returns the first occurance of a record matching a particular sid.
  6020. </summary>
  6021. <param name="sid">The sid.</param>
  6022. <returns></returns>
  6023. </member>
  6024. <member name="M:NPOI.HSSF.Model.InternalSheet.SetSCLRecord(NPOI.HSSF.Record.SCLRecord)">
  6025. <summary>
  6026. Sets the SCL record or Creates it in the correct place if it does not
  6027. already exist.
  6028. </summary>
  6029. <param name="sclRecord">The record to set.</param>
  6030. </member>
  6031. <member name="M:NPOI.HSSF.Model.InternalSheet.FindFirstRecordLocBySid(System.Int16)">
  6032. Finds the first occurance of a record matching a particular sid and
  6033. returns it's position.
  6034. @param sid the sid to search for
  6035. @return the record position of the matching record or -1 if no match
  6036. is made.
  6037. </member>
  6038. <member name="P:NPOI.HSSF.Model.InternalSheet.Header">
  6039. <summary>
  6040. Gets or sets the header.
  6041. </summary>
  6042. <value>the HeaderRecord.</value>
  6043. </member>
  6044. <member name="P:NPOI.HSSF.Model.InternalSheet.IsAutoTabColor">
  6045. <summary>
  6046. Gets or sets a value indicating whether this instance is auto tab color.
  6047. </summary>
  6048. <value>
  6049. <c>true</c> if this instance is auto tab color; otherwise, <c>false</c>.
  6050. </value>
  6051. </member>
  6052. <member name="P:NPOI.HSSF.Model.InternalSheet.Footer">
  6053. <summary>
  6054. Gets or sets the footer.
  6055. </summary>
  6056. <value>FooterRecord for the sheet.</value>
  6057. </member>
  6058. <member name="P:NPOI.HSSF.Model.InternalSheet.PrintSetup">
  6059. Returns the PrintSetupRecord.
  6060. @return PrintSetupRecord for the sheet.
  6061. </member>
  6062. <member name="P:NPOI.HSSF.Model.InternalSheet.IsGridsPrinted">
  6063. @return <c>true</c> if gridlines are printed
  6064. </member>
  6065. <member name="P:NPOI.HSSF.Model.InternalSheet.PrintGridlines">
  6066. Returns the PrintGridlinesRecord.
  6067. @return PrintGridlinesRecord for the sheet.
  6068. </member>
  6069. <member name="P:NPOI.HSSF.Model.InternalSheet.PrintHeaders">
  6070. Returns the PrintHeadersRecord.
  6071. @return PrintHeadersRecord for the sheet.
  6072. </member>
  6073. <member name="M:NPOI.HSSF.Model.InternalSheet.SetSelected(System.Boolean)">
  6074. Sets whether the sheet is selected
  6075. @param sel True to select the sheet, false otherwise.
  6076. </member>
  6077. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateFreezePane(System.Int32,System.Int32,System.Int32,System.Int32)">
  6078. Creates a split (freezepane). Any existing freezepane or split pane Is overwritten.
  6079. @param colSplit Horizonatal position of split.
  6080. @param rowSplit Vertical position of split.
  6081. @param topRow Top row visible in bottom pane
  6082. @param leftmostColumn Left column visible in right pane.
  6083. </member>
  6084. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateSplitPane(System.Int32,System.Int32,System.Int32,System.Int32,NPOI.SS.UserModel.PanePosition)">
  6085. Creates a split pane. Any existing freezepane or split pane is overwritten.
  6086. @param xSplitPos Horizonatal position of split (in 1/20th of a point).
  6087. @param ySplitPos Vertical position of split (in 1/20th of a point).
  6088. @param topRow Top row visible in bottom pane
  6089. @param leftmostColumn Left column visible in right pane.
  6090. @param activePane Active pane. One of: PANE_LOWER_RIGHT,
  6091. PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFT
  6092. @see #PANE_LOWER_LEFT
  6093. @see #PANE_LOWER_RIGHT
  6094. @see #PANE_UPPER_LEFT
  6095. @see #PANE_UPPER_RIGHT
  6096. </member>
  6097. <member name="P:NPOI.HSSF.Model.InternalSheet.PaneInformation">
  6098. Returns the information regarding the currently configured pane (split or freeze).
  6099. @return null if no pane configured, or the pane information.
  6100. </member>
  6101. <member name="M:NPOI.HSSF.Model.InternalSheet.CreatePassword">
  6102. creates a Password record with password set to 00.
  6103. </member>
  6104. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateProtect">
  6105. creates a Protect record with protect set to false.
  6106. </member>
  6107. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateObjectProtect">
  6108. Creates an ObjectProtect record with protect Set to false.
  6109. @see org.apache.poi.hssf.record.ObjectProtectRecord
  6110. @see org.apache.poi.hssf.record.Record
  6111. @return an ObjectProtectRecord
  6112. </member>
  6113. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateScenarioProtect">
  6114. Creates a ScenarioProtect record with protect Set to false.
  6115. @see org.apache.poi.hssf.record.ScenarioProtectRecord
  6116. @see org.apache.poi.hssf.record.Record
  6117. @return a ScenarioProtectRecord
  6118. </member>
  6119. <member name="P:NPOI.HSSF.Model.InternalSheet.DisplayGridlines">
  6120. Returns if gridlines are Displayed.
  6121. @return whether gridlines are Displayed
  6122. </member>
  6123. <member name="P:NPOI.HSSF.Model.InternalSheet.DisplayFormulas">
  6124. Returns if formulas are Displayed.
  6125. @return whether formulas are Displayed
  6126. </member>
  6127. <member name="P:NPOI.HSSF.Model.InternalSheet.DisplayRowColHeadings">
  6128. Returns if RowColHeadings are Displayed.
  6129. @return whether RowColHeadings are Displayed
  6130. </member>
  6131. <member name="P:NPOI.HSSF.Model.InternalSheet.IsPrintRowColHeadings">
  6132. Returns if RowColHeadings are displayed.
  6133. @return whether RowColHeadings are displayed
  6134. </member>
  6135. <member name="P:NPOI.HSSF.Model.InternalSheet.IsUncalced">
  6136. @return whether an Uncalced record must be Inserted or not at generation
  6137. </member>
  6138. <member name="M:NPOI.HSSF.Model.InternalSheet.AggregateDrawingRecords(NPOI.HSSF.Model.DrawingManager2,System.Boolean)">
  6139. <summary>
  6140. Finds the DrawingRecord for our sheet, and attaches it to the DrawingManager (which knows about
  6141. the overall DrawingGroup for our workbook).
  6142. If requested, will Create a new DrawRecord if none currently exist
  6143. </summary>
  6144. <param name="drawingManager">The DrawingManager2 for our workbook</param>
  6145. <param name="CreateIfMissing">Should one be Created if missing?</param>
  6146. <returns>location of EscherAggregate record. if no EscherAggregate record is found return -1</returns>
  6147. </member>
  6148. <member name="M:NPOI.HSSF.Model.InternalSheet.Preserialize">
  6149. Perform any work necessary before the sheet is about to be Serialized.
  6150. For instance the escher aggregates size needs to be calculated before
  6151. serialization so that the dgg record (which occurs first) can be written.
  6152. </member>
  6153. <member name="M:NPOI.HSSF.Model.InternalSheet.ShiftBreaks(NPOI.HSSF.Record.PageBreakRecord,System.Int16,System.Int16,System.Int32)">
  6154. Shifts all the page breaks in the range "count" number of rows/columns
  6155. @param breaks The page record to be Shifted
  6156. @param start Starting "main" value to Shift breaks
  6157. @param stop Ending "main" value to Shift breaks
  6158. @param count number of Units (rows/columns) to Shift by
  6159. </member>
  6160. <member name="M:NPOI.HSSF.Model.InternalSheet.ShiftRowBreaks(System.Int32,System.Int32,System.Int32)">
  6161. Shifts the horizontal page breaks for the indicated count
  6162. @param startingRow
  6163. @param endingRow
  6164. @param count
  6165. </member>
  6166. <member name="M:NPOI.HSSF.Model.InternalSheet.ShiftColumnBreaks(System.Int16,System.Int16,System.Int16)">
  6167. Shifts the vertical page breaks for the indicated count
  6168. @param startingCol
  6169. @param endingCol
  6170. @param count
  6171. </member>
  6172. <member name="M:NPOI.HSSF.Model.InternalSheet.UpdateFormulasAfterCellShift(NPOI.SS.Formula.FormulaShifter,System.Int32)">
  6173. Updates formulas in cells and conditional formats due to moving of cells
  6174. @param externSheetIndex the externSheet index of this sheet
  6175. </member>
  6176. <member name="M:NPOI.HSSF.Model.InternalSheet.GetSizeOfInitialSheetRecords(System.Int32)">
  6177. 'initial sheet records' are between INDEX and the 'Row Blocks'
  6178. @param bofRecordIndex index of record after which INDEX record is to be placed
  6179. @return count of bytes from end of INDEX record to first ROW record.
  6180. </member>
  6181. <member name="M:NPOI.HSSF.Model.InternalSheet.GetNoteRecords">
  6182. Get the {@link NoteRecord}s (related to cell comments) for this sheet
  6183. @return never <code>null</code>, typically empty array
  6184. </member>
  6185. <member name="T:NPOI.HSSF.Model.InternalWorkbook">
  6186. Low level model implementation of a Workbook. Provides creational methods
  6187. for Settings and objects contained in the workbook object.
  6188. This file Contains the low level binary records starting at the workbook's BOF and
  6189. ending with the workbook's EOF. Use HSSFWorkbook for a high level representation.
  6190. The structures of the highlevel API use references to this to perform most of their
  6191. operations. Its probably Unwise to use these low level structures directly Unless you
  6192. really know what you're doing. I recommend you Read the Microsoft Excel 97 Developer's
  6193. Kit (Microsoft Press) and the documentation at http://sc.openoffice.org/excelfileformat.pdf
  6194. before even attempting to use this.
  6195. @author Luc Girardin (luc dot girardin at macrofocus dot com)
  6196. @author Sergei Kozello (sergeikozello at mail.ru)
  6197. @author Shawn Laubach (slaubach at apache dot org) (Data Formats)
  6198. @author Andrew C. Oliver (acoliver at apache dot org)
  6199. @author Brian Sanders (bsanders at risklabs dot com) - custom palette
  6200. @author Dan Sherman (dsherman at Isisph.com)
  6201. @author Glen Stampoultzis (glens at apache.org)
  6202. @see org.apache.poi.hssf.usermodel.HSSFWorkbook
  6203. @version 1.0-pre
  6204. </member>
  6205. <member name="F:NPOI.HSSF.Model.InternalWorkbook.MAX_SENSITIVE_SHEET_NAME_LEN">
  6206. Excel silently truncates long sheet names to 31 chars.
  6207. This constant is used to ensure uniqueness in the first 31 chars
  6208. </member>
  6209. <member name="F:NPOI.HSSF.Model.InternalWorkbook.WORKBOOK_DIR_ENTRY_NAMES">
  6210. Normally, the Workbook will be in a POIFS Stream
  6211. called "Workbook". However, some weird XLS generators use "WORKBOOK"
  6212. </member>
  6213. <member name="F:NPOI.HSSF.Model.InternalWorkbook.OLD_WORKBOOK_DIR_ENTRY_NAME">
  6214. Name of older (pre-Excel 97) Workbook streams, which
  6215. aren't supported by HSSFWorkbook, only by
  6216. {@link OldExcelExtractor}
  6217. </member>
  6218. <member name="F:NPOI.HSSF.Model.InternalWorkbook.CODEPAGE">
  6219. constant used to Set the "codepage" wherever "codepage" is Set in records
  6220. (which is duplciated in more than one record)
  6221. </member>
  6222. <member name="F:NPOI.HSSF.Model.InternalWorkbook.records">
  6223. this Contains the Worksheet record objects
  6224. </member>
  6225. <member name="F:NPOI.HSSF.Model.InternalWorkbook.sst">
  6226. this Contains a reference to the SSTRecord so that new stings can be Added
  6227. to it.
  6228. </member>
  6229. <member name="F:NPOI.HSSF.Model.InternalWorkbook.boundsheets">
  6230. holds the "boundsheet" records (aka bundlesheet) so that they can have their
  6231. reference to their "BOF" marker
  6232. </member>
  6233. <member name="M:NPOI.HSSF.Model.InternalWorkbook.#ctor">
  6234. Creates new Workbook with no intitialization --useless right now
  6235. @see #CreateWorkbook(List)
  6236. </member>
  6237. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateWorkbook(System.Collections.Generic.List{NPOI.HSSF.Record.Record})">
  6238. Read support for low level
  6239. API. Pass in an array of Record objects, A Workbook
  6240. object is constructed and passed back with all of its initialization Set
  6241. to the passed in records and references to those records held. Unlike Sheet
  6242. workbook does not use an offset (its assumed to be 0) since its first in a file.
  6243. If you need an offset then construct a new array with a 0 offset or Write your
  6244. own ;-p.
  6245. @param recs an array of Record objects
  6246. @return Workbook object
  6247. </member>
  6248. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetNameCommentRecord(NPOI.HSSF.Record.NameRecord)">
  6249. gets the name comment record
  6250. @param nameRecord name record who's comment is required.
  6251. @return name comment record or <code>null</code> if there isn't one for the given name.
  6252. </member>
  6253. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateWorkbook">
  6254. Creates an empty workbook object with three blank sheets and all the empty
  6255. fields. Use this to Create a workbook from scratch.
  6256. </member>
  6257. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetSpecificBuiltinRecord(System.Byte,System.Int32)">
  6258. Retrieves the Builtin NameRecord that matches the name and index
  6259. There shouldn't be too many names to make the sequential search too slow
  6260. @param name byte representation of the builtin name to match
  6261. @param sheetIndex Index to match
  6262. @return null if no builtin NameRecord matches
  6263. </member>
  6264. <member name="M:NPOI.HSSF.Model.InternalWorkbook.RemoveBuiltinRecord(System.Byte,System.Int32)">
  6265. Removes the specified Builtin NameRecord that matches the name and index
  6266. @param name byte representation of the builtin to match
  6267. @param sheetIndex zero-based sheet reference
  6268. </member>
  6269. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetFontRecordAt(System.Int32)">
  6270. Gets the font record at the given index in the font table. Remember
  6271. "There is No Four" (someone at M$ must have gone to Rocky Horror one too
  6272. many times)
  6273. @param idx the index to look at (0 or greater but NOT 4)
  6274. @return FontRecord located at the given index
  6275. </member>
  6276. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateNewFont">
  6277. Creates a new font record and Adds it to the "font table". This causes the
  6278. boundsheets to move down one, extended formats to move down (so this function moves
  6279. those pointers as well)
  6280. @return FontRecord that was just Created
  6281. </member>
  6282. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CloneDrawings(NPOI.HSSF.Model.InternalSheet)">
  6283. Check if the cloned sheet has drawings. If yes, then allocate a new drawing group ID and
  6284. re-generate shape IDs
  6285. @param sheet the cloned sheet
  6286. </member>
  6287. <member name="P:NPOI.HSSF.Model.InternalWorkbook.NumberOfFontRecords">
  6288. Gets the number of font records
  6289. @return number of font records in the "font table"
  6290. </member>
  6291. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetBof(System.Int32,System.Int32)">
  6292. Sets the BOF for a given sheet
  6293. @param sheetnum the number of the sheet to Set the positing of the bof for
  6294. @param pos the actual bof position
  6295. </member>
  6296. <member name="P:NPOI.HSSF.Model.InternalWorkbook.BackupRecord">
  6297. Returns the position of the backup record.
  6298. </member>
  6299. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetName(System.Int32,System.String)">
  6300. Sets the name for a given sheet. If the boundsheet record doesn't exist and
  6301. its only one more than we have, go ahead and Create it. If its > 1 more than
  6302. we have, except
  6303. @param sheetnum the sheet number (0 based)
  6304. @param sheetname the name for the sheet
  6305. </member>
  6306. <member name="M:NPOI.HSSF.Model.InternalWorkbook.ContainsSheetName(System.String,System.Int32)">
  6307. Determines whether a workbook Contains the provided sheet name.
  6308. @param name the name to test (case insensitive match)
  6309. @param excludeSheetIdx the sheet to exclude from the Check or -1 to include all sheets in the Check.
  6310. @return true if the sheet Contains the name, false otherwise.
  6311. </member>
  6312. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetName(System.Int32,System.String,System.Int16)">
  6313. Sets the name for a given sheet forcing the encoding. This is STILL A BAD IDEA.
  6314. Poi now automatically detects Unicode
  6315. @deprecated 3-Jan-06 Simply use SetSheetNam e(int sheetnum, String sheetname)
  6316. @param sheetnum the sheet number (0 based)
  6317. @param sheetname the name for the sheet
  6318. </member>
  6319. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetOrder(System.String,System.Int32)">
  6320. Sets the order of appearance for a given sheet.
  6321. @param sheetname the name of the sheet to reorder
  6322. @param pos the position that we want to Insert the sheet into (0 based)
  6323. </member>
  6324. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetSheetName(System.Int32)">
  6325. Gets the name for a given sheet.
  6326. @param sheetnum the sheet number (0 based)
  6327. @return sheetname the name for the sheet
  6328. </member>
  6329. <member name="M:NPOI.HSSF.Model.InternalWorkbook.IsSheetHidden(System.Int32)">
  6330. Gets the hidden flag for a given sheet.
  6331. @param sheetnum the sheet number (0 based)
  6332. @return True if sheet is hidden
  6333. </member>
  6334. <member name="M:NPOI.HSSF.Model.InternalWorkbook.IsSheetVeryHidden(System.Int32)">
  6335. Gets the hidden flag for a given sheet.
  6336. Note that a sheet could instead be
  6337. set to be very hidden, which is different
  6338. ({@link #isSheetVeryHidden(int)})
  6339. @param sheetnum the sheet number (0 based)
  6340. @return True if sheet is hidden
  6341. </member>
  6342. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetHidden(System.Int32,System.Boolean)">
  6343. Hide or Unhide a sheet
  6344. @param sheetnum The sheet number
  6345. @param hidden True to mark the sheet as hidden, false otherwise
  6346. </member>
  6347. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetHidden(System.Int32,System.Int32)">
  6348. Hide or unhide a sheet.
  6349. 0 = not hidden
  6350. 1 = hidden
  6351. 2 = very hidden.
  6352. @param sheetnum The sheet number
  6353. @param hidden 0 for not hidden, 1 for hidden, 2 for very hidden
  6354. </member>
  6355. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetSheetIndex(System.String)">
  6356. Get the sheet's index
  6357. @param name sheet name
  6358. @return sheet index or -1 if it was not found.
  6359. </member>
  6360. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CheckSheets(System.Int32)">
  6361. if we're trying to Address one more sheet than we have, go ahead and Add it! if we're
  6362. trying to Address >1 more than we have throw an exception!
  6363. </member>
  6364. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FixTabIdRecord">
  6365. <summary>
  6366. make the tabid record look like the current situation.
  6367. </summary>
  6368. <returns>number of bytes written in the TabIdRecord</returns>
  6369. </member>
  6370. <member name="P:NPOI.HSSF.Model.InternalWorkbook.NumSheets">
  6371. returns the number of boundsheet objects contained in this workbook.
  6372. @return number of BoundSheet records
  6373. </member>
  6374. <member name="P:NPOI.HSSF.Model.InternalWorkbook.NumExFormats">
  6375. Get the number of ExtendedFormat records contained in this workbook.
  6376. @return int count of ExtendedFormat records
  6377. </member>
  6378. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetFontIndex(NPOI.HSSF.Record.FontRecord)">
  6379. Retrieves the index of the given font
  6380. </member>
  6381. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetStyleRecord(System.Int32)">
  6382. Returns the StyleRecord for the given
  6383. xfIndex, or null if that ExtendedFormat doesn't
  6384. have a Style set.
  6385. </member>
  6386. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetExFormatAt(System.Int32)">
  6387. Gets the ExtendedFormatRecord at the given 0-based index
  6388. @param index of the Extended format record (0-based)
  6389. @return ExtendedFormatRecord at the given index
  6390. </member>
  6391. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateCellXF">
  6392. Creates a new Cell-type Extneded Format Record and Adds it to the end of
  6393. ExtendedFormatRecords collection
  6394. @return ExtendedFormatRecord that was Created
  6395. </member>
  6396. <member name="M:NPOI.HSSF.Model.InternalWorkbook.AddSSTString(NPOI.HSSF.Record.UnicodeString)">
  6397. Adds a string to the SST table and returns its index (if its a duplicate
  6398. just returns its index and update the counts) ASSUMES compressed Unicode
  6399. (meaning 8bit)
  6400. @param string the string to be Added to the SSTRecord
  6401. @return index of the string within the SSTRecord
  6402. </member>
  6403. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetSSTString(System.Int32)">
  6404. given an index into the SST table, this function returns the corresponding String value
  6405. @return String containing the SST String
  6406. </member>
  6407. <member name="M:NPOI.HSSF.Model.InternalWorkbook.InsertSST">
  6408. use this function to Add a Shared String Table to an existing sheet (say
  6409. generated by a different java api) without an sst....
  6410. @see #CreateSST()
  6411. @see org.apache.poi.hssf.record.SSTRecord
  6412. </member>
  6413. <member name="M:NPOI.HSSF.Model.InternalWorkbook.Serialize(System.Int32,System.Byte[])">
  6414. Serializes all records int the worksheet section into a big byte array. Use
  6415. this to Write the Workbook out.
  6416. @param offset of the data to be written
  6417. @param data array of bytes to Write this to
  6418. </member>
  6419. <member name="M:NPOI.HSSF.Model.InternalWorkbook.PreSerialize">
  6420. Perform any work necessary before the workbook is about to be serialized.
  6421. Include in it ant code that modifies the workbook record stream and affects its size.
  6422. </member>
  6423. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateBOF">
  6424. Creates the BOF record
  6425. @see org.apache.poi.hssf.record.BOFRecord
  6426. @see org.apache.poi.hssf.record.Record
  6427. @return record containing a BOFRecord
  6428. </member>
  6429. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateInterfaceHdr">
  6430. Creates the InterfaceHdr record
  6431. @see org.apache.poi.hssf.record.InterfaceHdrRecord
  6432. @see org.apache.poi.hssf.record.Record
  6433. @return record containing a InterfaceHdrRecord
  6434. </member>
  6435. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateMMS">
  6436. Creates an MMS record
  6437. @see org.apache.poi.hssf.record.MMSRecord
  6438. @see org.apache.poi.hssf.record.Record
  6439. @return record containing a MMSRecord
  6440. </member>
  6441. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateInterfaceEnd">
  6442. Creates the InterfaceEnd record
  6443. @see org.apache.poi.hssf.record.InterfaceEndRecord
  6444. @see org.apache.poi.hssf.record.Record
  6445. @return record containing a InterfaceEndRecord
  6446. </member>
  6447. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateWriteAccess">
  6448. Creates the WriteAccess record containing the logged in user's name
  6449. @see org.apache.poi.hssf.record.WriteAccessRecord
  6450. @see org.apache.poi.hssf.record.Record
  6451. @return record containing a WriteAccessRecord
  6452. </member>
  6453. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateCodepage">
  6454. Creates the Codepage record containing the constant stored in CODEPAGE
  6455. @see org.apache.poi.hssf.record.CodepageRecord
  6456. @see org.apache.poi.hssf.record.Record
  6457. @return record containing a CodepageRecord
  6458. </member>
  6459. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateDSF">
  6460. Creates the DSF record containing a 0 since HSSF can't even Create Dual Stream Files
  6461. @see org.apache.poi.hssf.record.DSFRecord
  6462. @see org.apache.poi.hssf.record.Record
  6463. @return record containing a DSFRecord
  6464. </member>
  6465. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateTabId">
  6466. Creates the TabId record containing an array of 0,1,2. This release of HSSF
  6467. always has the default three sheets, no less, no more.
  6468. @see org.apache.poi.hssf.record.TabIdRecord
  6469. @see org.apache.poi.hssf.record.Record
  6470. @return record containing a TabIdRecord
  6471. </member>
  6472. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateFnGroupCount">
  6473. Creates the FnGroupCount record containing the Magic number constant of 14.
  6474. @see org.apache.poi.hssf.record.FnGroupCountRecord
  6475. @see org.apache.poi.hssf.record.Record
  6476. @return record containing a FnGroupCountRecord
  6477. </member>
  6478. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateWindowProtect">
  6479. Creates the WindowProtect record with protect Set to false.
  6480. @see org.apache.poi.hssf.record.WindowProtectRecord
  6481. @see org.apache.poi.hssf.record.Record
  6482. @return record containing a WindowProtectRecord
  6483. </member>
  6484. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateProtect">
  6485. Creates the Protect record with protect Set to false.
  6486. @see org.apache.poi.hssf.record.ProtectRecord
  6487. @see org.apache.poi.hssf.record.Record
  6488. @return record containing a ProtectRecord
  6489. </member>
  6490. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreatePassword">
  6491. Creates the Password record with password Set to 0.
  6492. @see org.apache.poi.hssf.record.PasswordRecord
  6493. @see org.apache.poi.hssf.record.Record
  6494. @return record containing a PasswordRecord
  6495. </member>
  6496. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateProtectionRev4">
  6497. Creates the ProtectionRev4 record with protect Set to false.
  6498. @see org.apache.poi.hssf.record.ProtectionRev4Record
  6499. @see org.apache.poi.hssf.record.Record
  6500. @return record containing a ProtectionRev4Record
  6501. </member>
  6502. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreatePasswordRev4">
  6503. Creates the PasswordRev4 record with password Set to 0.
  6504. @see org.apache.poi.hssf.record.PasswordRev4Record
  6505. @see org.apache.poi.hssf.record.Record
  6506. @return record containing a PasswordRev4Record
  6507. </member>
  6508. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateWindowOne">
  6509. Creates the WindowOne record with the following magic values:
  6510. horizontal hold - 0x168
  6511. vertical hold - 0x10e
  6512. width - 0x3a5c
  6513. height - 0x23be
  6514. options - 0x38
  6515. selected tab - 0
  6516. Displayed tab - 0
  6517. num selected tab- 0
  6518. tab width ratio - 0x258
  6519. @see org.apache.poi.hssf.record.WindowOneRecord
  6520. @see org.apache.poi.hssf.record.Record
  6521. @return record containing a WindowOneRecord
  6522. </member>
  6523. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateBackup">
  6524. Creates the Backup record with backup Set to 0. (loose the data, who cares)
  6525. @see org.apache.poi.hssf.record.BackupRecord
  6526. @see org.apache.poi.hssf.record.Record
  6527. @return record containing a BackupRecord
  6528. </member>
  6529. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateHideObj">
  6530. Creates the HideObj record with hide object Set to 0. (don't hide)
  6531. @see org.apache.poi.hssf.record.HideObjRecord
  6532. @see org.apache.poi.hssf.record.Record
  6533. @return record containing a HideObjRecord
  6534. </member>
  6535. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateDateWindow1904">
  6536. Creates the DateWindow1904 record with windowing Set to 0. (don't window)
  6537. @see org.apache.poi.hssf.record.DateWindow1904Record
  6538. @see org.apache.poi.hssf.record.Record
  6539. @return record containing a DateWindow1904Record
  6540. </member>
  6541. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreatePrecision">
  6542. Creates the Precision record with precision Set to true. (full precision)
  6543. @see org.apache.poi.hssf.record.PrecisionRecord
  6544. @see org.apache.poi.hssf.record.Record
  6545. @return record containing a PrecisionRecord
  6546. </member>
  6547. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateRefreshAll">
  6548. Creates the RefreshAll record with refreshAll Set to true. (refresh all calcs)
  6549. @see org.apache.poi.hssf.record.RefreshAllRecord
  6550. @see org.apache.poi.hssf.record.Record
  6551. @return record containing a RefreshAllRecord
  6552. </member>
  6553. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateBookBool">
  6554. Creates the BookBool record with saveLinkValues Set to 0. (don't save link values)
  6555. @see org.apache.poi.hssf.record.BookBoolRecord
  6556. @see org.apache.poi.hssf.record.Record
  6557. @return record containing a BookBoolRecord
  6558. </member>
  6559. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateFont">
  6560. Creates a Font record with the following magic values:
  6561. fontheight = 0xc8
  6562. attributes = 0x0
  6563. color palette index = 0x7fff
  6564. bold weight = 0x190
  6565. Font Name Length = 5
  6566. Font Name = Arial
  6567. @see org.apache.poi.hssf.record.FontRecord
  6568. @see org.apache.poi.hssf.record.Record
  6569. @return record containing a FontRecord
  6570. </member>
  6571. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateExtendedFormat(System.Int32)">
  6572. Creates an ExtendedFormatRecord object
  6573. @param id the number of the extended format record to Create (meaning its position in
  6574. a file as MS Excel would Create it.)
  6575. @return record containing an ExtendedFormatRecord
  6576. @see org.apache.poi.hssf.record.ExtendedFormatRecord
  6577. @see org.apache.poi.hssf.record.Record
  6578. </member>
  6579. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateExtendedFormat">
  6580. Creates an default cell type ExtendedFormatRecord object.
  6581. @return ExtendedFormatRecord with intial defaults (cell-type)
  6582. </member>
  6583. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateStyleRecord(System.Int32)">
  6584. Creates a new StyleRecord, for the given Extended
  6585. Format index, and adds it onto the end of the
  6586. records collection
  6587. </member>
  6588. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateStyle(System.Int32)">
  6589. Creates a StyleRecord object
  6590. @param id the number of the style record to Create (meaning its position in
  6591. a file as MS Excel would Create it.
  6592. @return record containing a StyleRecord
  6593. @see org.apache.poi.hssf.record.StyleRecord
  6594. @see org.apache.poi.hssf.record.Record
  6595. </member>
  6596. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreatePalette">
  6597. Creates a palette record initialized to the default palette
  6598. @return a PaletteRecord instance populated with the default colors
  6599. @see org.apache.poi.hssf.record.PaletteRecord
  6600. </member>
  6601. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateUseSelFS">
  6602. Creates the UseSelFS object with the use natural language flag Set to 0 (false)
  6603. @return record containing a UseSelFSRecord
  6604. @see org.apache.poi.hssf.record.UseSelFSRecord
  6605. @see org.apache.poi.hssf.record.Record
  6606. </member>
  6607. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateBoundSheet(System.Int32)">
  6608. Create a "bound sheet" or "bundlesheet" (depending who you ask) record
  6609. Always Sets the sheet's bof to 0. You'll need to Set that yourself.
  6610. @param id either sheet 0,1 or 2.
  6611. @return record containing a BoundSheetRecord
  6612. @see org.apache.poi.hssf.record.BoundSheetRecord
  6613. @see org.apache.poi.hssf.record.Record
  6614. </member>
  6615. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateCountry">
  6616. Creates the Country record with the default country Set to 1
  6617. and current country Set to 7 in case of russian locale ("ru_RU") and 1 otherwise
  6618. @return record containing a CountryRecord
  6619. @see org.apache.poi.hssf.record.CountryRecord
  6620. @see org.apache.poi.hssf.record.Record
  6621. </member>
  6622. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateExtendedSST">
  6623. Creates the ExtendedSST record with numstrings per bucket Set to 0x8. HSSF
  6624. doesn't yet know what to do with this thing, but we Create it with nothing in
  6625. it hardly just to make Excel happy and our sheets look like Excel's
  6626. @return record containing an ExtSSTRecord
  6627. @see org.apache.poi.hssf.record.ExtSSTRecord
  6628. @see org.apache.poi.hssf.record.Record
  6629. </member>
  6630. <member name="P:NPOI.HSSF.Model.InternalWorkbook.OrCreateLinkTable">
  6631. lazy initialization
  6632. Note - creating the link table causes creation of 1 EXTERNALBOOK and 1 EXTERNALSHEET record
  6633. </member>
  6634. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FindSheetFirstNameFromExternSheet(System.Int32)">
  6635. Finds the first sheet name by his extern sheet index
  6636. @param externSheetIndex extern sheet index
  6637. @return first sheet name.
  6638. </member>
  6639. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetFirstSheetIndexFromExternSheetIndex(System.Int32)">
  6640. Finds the (first) sheet index for a particular external sheet number.
  6641. @param externSheetNumber The external sheet number to convert
  6642. @return The index to the sheet found.
  6643. </member>
  6644. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetLastSheetIndexFromExternSheetIndex(System.Int32)">
  6645. Finds the last sheet index for a particular external sheet number,
  6646. which may be the same as the first (except for multi-sheet references)
  6647. @param externSheetNumber The external sheet number to convert
  6648. @return The index to the sheet found.
  6649. </member>
  6650. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CheckExternSheet(System.Int32)">
  6651. Returns the extern sheet number for specific sheet number.
  6652. If this sheet doesn't exist in extern sheet, add it
  6653. @param sheetNumber local sheet number
  6654. @return index to extern sheet
  6655. </member>
  6656. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CheckExternSheet(System.Int32,System.Int32)">
  6657. Returns the extern sheet number for specific range of sheets.
  6658. If this sheet range doesn't exist in extern sheet, add it
  6659. @param firstSheetNumber first local sheet number
  6660. @param lastSheetNumber last local sheet number
  6661. @return index to extern sheet
  6662. </member>
  6663. <member name="P:NPOI.HSSF.Model.InternalWorkbook.NumNames">
  6664. Gets the total number of names
  6665. @return number of names
  6666. </member>
  6667. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetNameXPtg(System.String,System.Int32,NPOI.SS.Formula.UDF.UDFFinder)">
  6668. @param name the name of an external function, typically a name of a UDF
  6669. @param sheetRefIndex the sheet ref index, or -1 if not known
  6670. @param udf locator of user-defiend functions to resolve names of VBA and Add-In functions
  6671. @return the external name or null
  6672. </member>
  6673. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetNameRecord(System.Int32)">
  6674. Gets the name record
  6675. @param index name index
  6676. @return name record
  6677. </member>
  6678. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateName">
  6679. Creates new name
  6680. @return new name record
  6681. </member>
  6682. <member name="M:NPOI.HSSF.Model.InternalWorkbook.AddName(NPOI.HSSF.Record.NameRecord)">
  6683. Creates new name
  6684. @return new name record
  6685. </member>
  6686. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateBuiltInName(System.Byte,System.Int32)">
  6687. Generates a NameRecord to represent a built-in region
  6688. @return a new NameRecord Unless the index is invalid
  6689. </member>
  6690. <member name="M:NPOI.HSSF.Model.InternalWorkbook.RemoveName(System.Int32)">
  6691. Removes the name
  6692. @param namenum name index
  6693. </member>
  6694. <member name="M:NPOI.HSSF.Model.InternalWorkbook.UpdateNameCommentRecordCache(NPOI.HSSF.Record.NameCommentRecord)">
  6695. If a {@link NameCommentRecord} is added or the name it references
  6696. is renamed, then this will update the lookup cache for it.
  6697. </member>
  6698. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetFormat(System.String,System.Boolean)">
  6699. Returns a format index that matches the passed in format. It does not tie into HSSFDataFormat.
  6700. @param format the format string
  6701. @param CreateIfNotFound Creates a new format if format not found
  6702. @return the format id of a format that matches or -1 if none found and CreateIfNotFound
  6703. </member>
  6704. <member name="P:NPOI.HSSF.Model.InternalWorkbook.Formats">
  6705. Returns the list of FormatRecords in the workbook.
  6706. @return ArrayList of FormatRecords in the notebook
  6707. </member>
  6708. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateFormat(System.String)">
  6709. Creates a FormatRecord, Inserts it, and returns the index code.
  6710. @param format the format string
  6711. @return the index code of the format record.
  6712. @see org.apache.poi.hssf.record.FormatRecord
  6713. @see org.apache.poi.hssf.record.Record
  6714. </member>
  6715. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateFormat(System.Int32)">
  6716. Creates a FormatRecord object
  6717. @param id the number of the format record to create (meaning its position in
  6718. a file as M$ Excel would create it.)
  6719. </member>
  6720. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FindFirstRecordBySid(System.Int16)">
  6721. Returns the first occurance of a record matching a particular sid.
  6722. </member>
  6723. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FindFirstRecordLocBySid(System.Int16)">
  6724. Returns the index of a record matching a particular sid.
  6725. @param sid The sid of the record to match
  6726. @return The index of -1 if no match made.
  6727. </member>
  6728. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FindNextRecordBySid(System.Int16,System.Int32)">
  6729. Returns the next occurance of a record matching a particular sid.
  6730. </member>
  6731. <member name="P:NPOI.HSSF.Model.InternalWorkbook.IsUsing1904DateWindowing">
  6732. Whether date windowing is based on 1/2/1904 or 1/1/1900.
  6733. Some versions of Excel (Mac) can save workbooks using 1904 date windowing.
  6734. @return true if using 1904 date windowing
  6735. </member>
  6736. <member name="P:NPOI.HSSF.Model.InternalWorkbook.CustomPalette">
  6737. Returns the custom palette in use for this workbook; if a custom palette record
  6738. does not exist, then it is Created.
  6739. </member>
  6740. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FindDrawingGroup">
  6741. Finds the primary drawing Group, if one already exists
  6742. </member>
  6743. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateDrawingGroup">
  6744. Creates a primary drawing Group record. If it already
  6745. exists then it's modified.
  6746. </member>
  6747. <member name="M:NPOI.HSSF.Model.InternalWorkbook.RemoveFontRecord(NPOI.HSSF.Record.FontRecord)">
  6748. Removes the given font record from the
  6749. file's list. This will make all
  6750. subsequent font indicies drop by one,
  6751. so you'll need to update those yourself!
  6752. </member>
  6753. <member name="M:NPOI.HSSF.Model.InternalWorkbook.RemoveExFormatRecord(NPOI.HSSF.Record.ExtendedFormatRecord)">
  6754. Removes the given ExtendedFormatRecord record from the
  6755. file's list. This will make all
  6756. subsequent font indicies drop by one,
  6757. so you'll need to update those yourself!
  6758. </member>
  6759. <member name="M:NPOI.HSSF.Model.InternalWorkbook.RemoveExFormatRecord(System.Int32)">
  6760. <summary>
  6761. Removes ExtendedFormatRecord record with given index from the file's list. This will make all
  6762. subsequent font indicies drop by one,so you'll need to update those yourself!
  6763. </summary>
  6764. <param name="index">index of the Extended format record (0-based)</param>
  6765. </member>
  6766. <member name="P:NPOI.HSSF.Model.InternalWorkbook.IsWriteProtected">
  6767. is the workbook protected with a password (not encrypted)?
  6768. </member>
  6769. <member name="M:NPOI.HSSF.Model.InternalWorkbook.UnwriteProtectWorkbook">
  6770. Removes the Write protect flag
  6771. </member>
  6772. <member name="M:NPOI.HSSF.Model.InternalWorkbook.ResolveNameXText(System.Int32,System.Int32)">
  6773. @param reFindex Index to REF entry in EXTERNSHEET record in the Link Table
  6774. @param definedNameIndex zero-based to DEFINEDNAME or EXTERNALNAME record
  6775. @return the string representation of the defined or external name
  6776. </member>
  6777. <member name="M:NPOI.HSSF.Model.InternalWorkbook.UpdateNamesAfterCellShift(NPOI.SS.Formula.FormulaShifter)">
  6778. Updates named ranges due to moving of cells
  6779. </member>
  6780. <member name="P:NPOI.HSSF.Model.InternalWorkbook.RecalcId">
  6781. Get or create RecalcIdRecord
  6782. @see org.apache.poi.hssf.usermodel.HSSFWorkbook#setForceFormulaRecalculation(boolean)
  6783. </member>
  6784. <member name="M:NPOI.HSSF.Model.InternalWorkbook.ChangeExternalReference(System.String,System.String)">
  6785. Changes an external referenced file to another file.
  6786. A formular in Excel which refers a cell in another file is saved in two parts:
  6787. The referenced file is stored in an reference table. the row/cell information is saved separate.
  6788. This method invokation will only change the reference in the lookup-table itself.
  6789. @param oldUrl The old URL to search for and which is to be replaced
  6790. @param newUrl The URL replacement
  6791. @return true if the oldUrl was found and replaced with newUrl. Otherwise false
  6792. </member>
  6793. <member name="T:NPOI.HSSF.Model.LinkTable">
  6794. Link Table (OOO pdf reference: 4.10.3 ) <p/>
  6795. The main data of all types of references is stored in the Link Table inside the Workbook Globals
  6796. Substream (4.2.5). The Link Table itself is optional and occurs only, if there are any
  6797. references in the document.
  6798. <p/>
  6799. In BIFF8 the Link Table consists of
  6800. <ul>
  6801. <li>zero or more EXTERNALBOOK Blocks<p/>
  6802. each consisting of
  6803. <ul>
  6804. <li>exactly one EXTERNALBOOK (0x01AE) record</li>
  6805. <li>zero or more EXTERNALNAME (0x0023) records</li>
  6806. <li>zero or more CRN Blocks<p/>
  6807. each consisting of
  6808. <ul>
  6809. <li>exactly one XCT (0x0059)record</li>
  6810. <li>zero or more CRN (0x005A) records (documentation says one or more)</li>
  6811. </ul>
  6812. </li>
  6813. </ul>
  6814. </li>
  6815. <li>zero or one EXTERNSHEET (0x0017) record</li>
  6816. <li>zero or more DEFINEDNAME (0x0018) records</li>
  6817. </ul>
  6818. @author Josh Micich
  6819. </member>
  6820. <member name="M:NPOI.HSSF.Model.LinkTable.ExternalBookBlock.#ctor">
  6821. Create a new block for registering add-in functions
  6822. @see org.apache.poi.hssf.model.LinkTable#addNameXPtg(String)
  6823. </member>
  6824. <member name="M:NPOI.HSSF.Model.LinkTable.ExternalBookBlock.#ctor(System.String,System.String[])">
  6825. Create a new block for external references.
  6826. </member>
  6827. <member name="M:NPOI.HSSF.Model.LinkTable.ExternalBookBlock.#ctor(System.Int32)">
  6828. Create a new block for internal references. It is called when constructing a new LinkTable.
  6829. @see org.apache.poi.hssf.model.LinkTable#LinkTable(int, WorkbookRecordList)
  6830. </member>
  6831. <member name="M:NPOI.HSSF.Model.LinkTable.ExternalBookBlock.GetIndexOfName(System.String)">
  6832. Performs case-insensitive search
  6833. @return -1 if not found
  6834. </member>
  6835. <member name="P:NPOI.HSSF.Model.LinkTable.RecordCount">
  6836. TODO - would not be required if calling code used RecordStream or similar
  6837. </member>
  6838. <member name="M:NPOI.HSSF.Model.LinkTable.GetFirstInternalSheetIndexForExtIndex(System.Int32)">
  6839. @param extRefIndex as from a {@link Ref3DPtg} or {@link Area3DPtg}
  6840. @return -1 if the reference is to an external book
  6841. </member>
  6842. <member name="M:NPOI.HSSF.Model.LinkTable.GetLastInternalSheetIndexForExtIndex(System.Int32)">
  6843. @param extRefIndex as from a {@link Ref3DPtg} or {@link Area3DPtg}
  6844. @return -1 if the reference is to an external book
  6845. </member>
  6846. <member name="M:NPOI.HSSF.Model.LinkTable.GetNameXPtg(System.String,System.Int32)">
  6847. Finds the external name definition for the given name,
  6848. optionally restricted by externsheet index, and returns
  6849. (if found) as a NameXPtg.
  6850. @param sheetRefIndex The Extern Sheet Index to look for, or -1 if any
  6851. </member>
  6852. <member name="M:NPOI.HSSF.Model.LinkTable.AddNameXPtg(System.String)">
  6853. Register an external name in this workbook
  6854. @param name the name to register
  6855. @return a NameXPtg describing this name
  6856. </member>
  6857. <member name="M:NPOI.HSSF.Model.LinkTable.FindFirstRecordLocBySid(System.Int16)">
  6858. copied from Workbook
  6859. </member>
  6860. <member name="M:NPOI.HSSF.Model.LinkTable.ChangeExternalReference(System.String,System.String)">
  6861. Changes an external referenced file to another file.
  6862. A formular in Excel which refers a cell in another file is saved in two parts:
  6863. The referenced file is stored in an reference table. the row/cell information is saved separate.
  6864. This method invokation will only change the reference in the lookup-table itself.
  6865. @param oldUrl The old URL to search for and which is to be replaced
  6866. @param newUrl The URL replacement
  6867. @return true if the oldUrl was found and replaced with newUrl. Otherwise false
  6868. </member>
  6869. <member name="T:NPOI.HSSF.Model.RecordOrderer">
  6870. Finds correct insert positions for records in workbook streams<p/>
  6871. See OOO excelfileformat.pdf sec. 4.2.5 'Record Order in a BIFF8 Workbook Stream'
  6872. @author Josh Micich
  6873. </member>
  6874. <member name="M:NPOI.HSSF.Model.RecordOrderer.AddNewSheetRecord(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase},NPOI.HSSF.Record.RecordBase)">
  6875. Adds the specified new record in the correct place in sheet records list
  6876. </member>
  6877. <member name="M:NPOI.HSSF.Model.RecordOrderer.GetWorksheetProtectionBlockInsertPos(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase})">
  6878. <summary>
  6879. Finds the index where the protection block should be inserted
  6880. </summary>
  6881. <param name="records">the records for this sheet</param>
  6882. <returns></returns>
  6883. <remark>
  6884. + BOF
  6885. o INDEX
  6886. o Calculation Settings Block
  6887. o PRINTHEADERS
  6888. o PRINTGRIDLINES
  6889. o GRIDSET
  6890. o GUTS
  6891. o DEFAULTROWHEIGHT
  6892. o SHEETPR
  6893. o Page Settings Block
  6894. o Worksheet Protection Block
  6895. o DEFCOLWIDTH
  6896. oo COLINFO
  6897. o SORT
  6898. + DIMENSION
  6899. </remark>
  6900. </member>
  6901. <member name="M:NPOI.HSSF.Model.RecordOrderer.IsProtectionSubsequentRecord(System.Object)">
  6902. <summary>
  6903. These records may occur between the 'Worksheet Protection Block' and DIMENSION:
  6904. </summary>
  6905. <param name="rb"></param>
  6906. <returns></returns>
  6907. <remarks>
  6908. o DEFCOLWIDTH
  6909. oo COLINFO
  6910. o SORT
  6911. </remarks>
  6912. </member>
  6913. <member name="M:NPOI.HSSF.Model.RecordOrderer.FindInsertPosForNewCondFormatTable(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase})">
  6914. <summary>
  6915. Find correct position to add new CFHeader record
  6916. </summary>
  6917. <param name="records"></param>
  6918. <returns></returns>
  6919. </member>
  6920. <member name="M:NPOI.HSSF.Model.RecordOrderer.FindDataValidationTableInsertPos(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase})">
  6921. Finds the index where the sheet validations header record should be inserted
  6922. @param records the records for this sheet
  6923. + WINDOW2
  6924. o SCL
  6925. o PANE
  6926. oo SELECTION
  6927. o STANDARDWIDTH
  6928. oo MERGEDCELLS
  6929. o LABELRANGES
  6930. o PHONETICPR
  6931. o Conditional Formatting Table
  6932. o Hyperlink Table
  6933. o Data Validity Table
  6934. o SHEETLAYOUT
  6935. o SHEETPROTECTION
  6936. o RANGEPROTECTION
  6937. + EOF
  6938. </member>
  6939. <member name="M:NPOI.HSSF.Model.RecordOrderer.GetDimensionsIndex(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase})">
  6940. DIMENSIONS record is always present
  6941. </member>
  6942. <member name="M:NPOI.HSSF.Model.RecordOrderer.IsEndOfRowBlock(System.Int32)">
  6943. <summary>
  6944. if the specified record ID terminates a sequence of Row block records
  6945. It is assumed that at least one row or cell value record has been found prior to the current
  6946. record
  6947. </summary>
  6948. <param name="sid"></param>
  6949. <returns></returns>
  6950. </member>
  6951. <member name="M:NPOI.HSSF.Model.RecordOrderer.IsRowBlockRecord(System.Int32)">
  6952. <summary>
  6953. Whether the specified record id normally appears in the row blocks section of the sheet records
  6954. </summary>
  6955. <param name="sid"></param>
  6956. <returns></returns>
  6957. </member>
  6958. <member name="T:NPOI.HSSF.Model.RecordStream">
  6959. <summary>
  6960. Simplifies iteration over a sequence of Record objects.
  6961. @author Josh Micich
  6962. </summary>
  6963. </member>
  6964. <member name="M:NPOI.HSSF.Model.RecordStream.HasNext">
  6965. <summary>
  6966. Determines whether this instance has next.
  6967. </summary>
  6968. <returns>
  6969. <c>true</c> if this instance has next; otherwise, <c>false</c>.
  6970. </returns>
  6971. </member>
  6972. <member name="M:NPOI.HSSF.Model.RecordStream.GetNext">
  6973. <summary>
  6974. Gets the next record
  6975. </summary>
  6976. <returns></returns>
  6977. </member>
  6978. <member name="M:NPOI.HSSF.Model.RecordStream.PeekNextSid">
  6979. <summary>
  6980. Peeks the next sid.
  6981. </summary>
  6982. <returns>-1 if at end of records</returns>
  6983. </member>
  6984. <member name="M:NPOI.HSSF.Model.RecordStream.PeekNextClass">
  6985. <summary>
  6986. Peeks the next class.
  6987. </summary>
  6988. <returns>the class of the next Record.return null if this stream Is exhausted.</returns>
  6989. </member>
  6990. <member name="T:NPOI.HSSF.Model.RowBlocksReader">
  6991. Segregates the 'Row Blocks' section of a single sheet into plain row/cell records and
  6992. shared formula records.
  6993. @author Josh Micich
  6994. </member>
  6995. <member name="M:NPOI.HSSF.Model.RowBlocksReader.#ctor(NPOI.HSSF.Model.RecordStream)">
  6996. Also collects any loose MergeCellRecords and puts them in the supplied
  6997. mergedCellsTable
  6998. </member>
  6999. <member name="P:NPOI.HSSF.Model.RowBlocksReader.LooseMergedCells">
  7000. Some unconventional apps place {@link MergeCellsRecord}s within the row block. They
  7001. actually should be in the {@link MergedCellsTable} which is much later (see bug 45699).
  7002. @return any loose <c>MergeCellsRecord</c>s found
  7003. </member>
  7004. <member name="P:NPOI.HSSF.Model.RowBlocksReader.PlainRecordStream">
  7005. @return a {@link RecordStream} containing all the non-{@link SharedFormulaRecord}
  7006. non-{@link ArrayRecord} and non-{@link TableRecord} Records.
  7007. </member>
  7008. <member name="T:NPOI.HSSF.Model.WorkbookRecordList">
  7009. <summary>
  7010. List for records in Workbook
  7011. </summary>
  7012. </member>
  7013. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Records">
  7014. <summary>
  7015. Gets or sets the records.
  7016. </summary>
  7017. <value>The records.</value>
  7018. </member>
  7019. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Count">
  7020. <summary>
  7021. Gets the count.
  7022. </summary>
  7023. <value>The count.</value>
  7024. </member>
  7025. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Item(System.Int32)">
  7026. <summary>
  7027. Gets the <see cref="T:NPOI.HSSF.Record.Record"/> at the specified index.
  7028. </summary>
  7029. <value></value>
  7030. </member>
  7031. <member name="M:NPOI.HSSF.Model.WorkbookRecordList.Add(System.Int32,NPOI.HSSF.Record.Record)">
  7032. <summary>
  7033. Adds the specified pos.
  7034. </summary>
  7035. <param name="pos">The pos.</param>
  7036. <param name="r">The r.</param>
  7037. </member>
  7038. <member name="M:NPOI.HSSF.Model.WorkbookRecordList.Remove(NPOI.HSSF.Record.Record)">
  7039. <summary>
  7040. Removes the specified record.
  7041. </summary>
  7042. <param name="record">The record.</param>
  7043. </member>
  7044. <member name="M:NPOI.HSSF.Model.WorkbookRecordList.Remove(System.Int32)">
  7045. <summary>
  7046. Removes the specified position.
  7047. </summary>
  7048. <param name="pos">The position.</param>
  7049. </member>
  7050. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Protpos">
  7051. <summary>
  7052. Gets or sets the protpos.
  7053. </summary>
  7054. <value>The protpos.</value>
  7055. </member>
  7056. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Bspos">
  7057. <summary>
  7058. Gets or sets the bspos.
  7059. </summary>
  7060. <value>The bspos.</value>
  7061. </member>
  7062. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Tabpos">
  7063. <summary>
  7064. Gets or sets the tabpos.
  7065. </summary>
  7066. <value>The tabpos.</value>
  7067. </member>
  7068. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Fontpos">
  7069. <summary>
  7070. Gets or sets the fontpos.
  7071. </summary>
  7072. <value>The fontpos.</value>
  7073. </member>
  7074. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Xfpos">
  7075. <summary>
  7076. Gets or sets the xfpos.
  7077. </summary>
  7078. <value>The xfpos.</value>
  7079. </member>
  7080. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Backuppos">
  7081. <summary>
  7082. Gets or sets the backuppos.
  7083. </summary>
  7084. <value>The backuppos.</value>
  7085. </member>
  7086. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Palettepos">
  7087. <summary>
  7088. Gets or sets the palettepos.
  7089. </summary>
  7090. <value>The palettepos.</value>
  7091. </member>
  7092. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Namepos">
  7093. <summary>
  7094. Gets or sets the namepos.
  7095. </summary>
  7096. <value>The namepos.</value>
  7097. </member>
  7098. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Supbookpos">
  7099. <summary>
  7100. Gets or sets the supbookpos.
  7101. </summary>
  7102. <value>The supbookpos.</value>
  7103. </member>
  7104. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.ExternsheetPos">
  7105. <summary>
  7106. Gets or sets the externsheet pos.
  7107. </summary>
  7108. <value>The externsheet pos.</value>
  7109. </member>
  7110. <member name="T:NPOI.HSSF.Record.AbstractEscherHolderRecord">
  7111. The escher container record is used to hold escher records. It is abstract and
  7112. must be subclassed for maximum benefit.
  7113. @author Glen Stampoultzis (glens at apache.org)
  7114. @author Michael Zalewski (zalewski at optonline.net)
  7115. </member>
  7116. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  7117. Constructs a Bar record and Sets its fields appropriately.
  7118. @param in the RecordInputstream to Read the record from
  7119. </member>
  7120. <member name="P:NPOI.HSSF.Record.AbstractEscherHolderRecord.RecordSize">
  7121. Size of record (including 4 byte header)
  7122. </member>
  7123. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.AddEscherRecord(System.Int32,NPOI.DDF.EscherRecord)">
  7124. Clone the current record, via a call to serialise
  7125. it, and another to Create a new record from the
  7126. bytes.
  7127. May only be used for classes which don't have
  7128. internal counts / ids in them. For those which
  7129. do, a full record-aware serialise is needed, which
  7130. allocates new ids / counts as needed.
  7131. </member>
  7132. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.GetEscherContainer">
  7133. If we have a EscherContainerRecord as one of our
  7134. children (and most top level escher holders do),
  7135. then return that.
  7136. </member>
  7137. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.FindFirstWithId(System.Int16)">
  7138. Descends into all our children, returning the
  7139. first EscherRecord with the given id, or null
  7140. if none found
  7141. </member>
  7142. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.Join(NPOI.HSSF.Record.AbstractEscherHolderRecord)">
  7143. Big drawing Group records are split but it's easier to deal with them
  7144. as a whole Group so we need to join them toGether.
  7145. </member>
  7146. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.Decode">
  7147. Convert raw data to escher records.
  7148. </member>
  7149. <member name="T:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate">
  7150. <summary>
  7151. </summary>
  7152. CFRecordsAggregate - aggregates Conditional Formatting records CFHeaderRecord
  7153. and number of up to three CFRuleRecord records toGether to simplify
  7154. access to them.
  7155. @author Dmitriy Kumshayev
  7156. </member>
  7157. <member name="F:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.MAX_97_2003_CONDTIONAL_FORMAT_RULES">
  7158. Excel allows up to 3 conditional formating rules
  7159. </member>
  7160. <member name="F:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.rules">
  7161. List of CFRuleRecord objects
  7162. </member>
  7163. <member name="M:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.CreateCFAggregate(NPOI.HSSF.Model.RecordStream)">
  7164. <summary>
  7165. Create CFRecordsAggregate from a list of CF Records
  7166. </summary>
  7167. <param name="rs">list of Record objects</param>
  7168. </member>
  7169. <member name="M:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.CreateCFAggregate(System.Collections.IList,System.Int32)">
  7170. <summary>
  7171. Create CFRecordsAggregate from a list of CF Records
  7172. </summary>
  7173. <param name="recs">list of Record objects</param>
  7174. <param name="pOffset">position of CFHeaderRecord object in the list of Record objects</param>
  7175. </member>
  7176. <member name="M:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.CloneCFAggregate">
  7177. <summary>
  7178. Create a deep Clone of the record
  7179. </summary>
  7180. </member>
  7181. <member name="M:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.Serialize(System.Int32,System.Byte[])">
  7182. <summary>
  7183. called by the class that is responsible for writing this sucker.
  7184. Subclasses should implement this so that their data is passed back in a
  7185. byte array.
  7186. </summary>
  7187. <param name="offset">The offset to begin writing at</param>
  7188. <param name="data">The data byte array containing instance data</param>
  7189. <returns> number of bytes written</returns>
  7190. </member>
  7191. <member name="M:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.UpdateFormulasAfterCellShift(NPOI.SS.Formula.FormulaShifter,System.Int32)">
  7192. @return <c>false</c> if this whole {@link CFHeaderRecord} / {@link CFRuleRecord}s should be deleted
  7193. </member>
  7194. <member name="T:NPOI.HSSF.Record.Aggregates.ChartSubstreamRecordAggregate">
  7195. Manages the all the records associated with a chart sub-stream.<br/>
  7196. Includes the Initial {@link BOFRecord} and {@link EOFRecord}.
  7197. @author Josh Micich
  7198. </member>
  7199. <member name="F:NPOI.HSSF.Record.Aggregates.ChartSubstreamRecordAggregate._recs">
  7200. All the records between BOF and EOF
  7201. </member>
  7202. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.AttachedLabelAggregate">
  7203. <summary>
  7204. ATTACHEDLABEL = Text Begin Pos [FontX] [AlRuns] AI [FRAME] [ObjectLink] [DataLabExtContents] [CrtLayout12] [TEXTPROPS] [CRTMLFRT] End
  7205. AI = BRAI [SeriesText]
  7206. </summary>
  7207. </member>
  7208. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.AxesAggregate">
  7209. <summary>
  7210. AXES = [IVAXIS DVAXIS [SERIESAXIS] / DVAXIS DVAXIS] *3ATTACHEDLABEL [PlotArea FRAME]
  7211. </summary>
  7212. </member>
  7213. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.AxisParentAggregate">
  7214. <summary>
  7215. AXISPARENT = AxisParent Begin Pos [AXES] 1*4CRT End
  7216. </summary>
  7217. </member>
  7218. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.AXMAggregate">
  7219. <summary>
  7220. AXM = YMult StartObject ATTACHEDLABEL EndObject
  7221. </summary>
  7222. </member>
  7223. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.AXSAggregate">
  7224. <summary>
  7225. AXS = [IFmtRecord] [Tick] [FontX] *4(AxisLine LineFormat) [AreaFormat]
  7226. [GELFRAME] *4SHAPEPROPS [TextPropsStream *ContinueFrt12]
  7227. </summary>
  7228. </member>
  7229. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.ChartFormatsAggregate">
  7230. <summary>
  7231. CHARTFOMATS = Chart Begin *2FONTLIST Scl PlotGrowth [FRAME] *SERIESFORMAT *SS ShtProps
  7232. *2DFTTEXT AxesUsed 1*2AXISPARENT [CrtLayout12A] [DAT] *ATTACHEDLABEL [CRTMLFRT]
  7233. *([DataLabExt StartObject] ATTACHEDLABEL [EndObject]) [TEXTPROPS] *2CRTMLFRT End
  7234. </summary>
  7235. </member>
  7236. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.ChartSheetAggregate">
  7237. <summary>
  7238. CHARTSHEET = BOF CHARTSHEETCONTENT
  7239. CHARTSHEETCONTENT = [WriteProtect] [SheetExt] [WebPub] *HFPicture PAGESETUP PrintSize
  7240. [HeaderFooter] [BACKGROUND] *Fbi *Fbi2 [ClrtClient] [PROTECTION] [Palette] [SXViewLink]
  7241. [PivotChartBits] [SBaseRef] [MsoDrawingGroup] OBJECTS Units CHARTFOMATS SERIESDATA
  7242. *WINDOW *CUSTOMVIEW [CodeName] [CRTMLFRT] EOF
  7243. </summary>
  7244. </member>
  7245. <member name="F:NPOI.HSSF.Record.Aggregates.Chart.ChartSheetAggregate._recs">
  7246. All the records between BOF and EOF
  7247. </member>
  7248. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.CRTAggregate">
  7249. <summary>
  7250. CRT = ChartFormat Begin (Bar / Line / (BopPop [BopPopCustom]) / Pie / Area / Scatter / Radar /
  7251. RadarArea / Surf) CrtLink [SeriesList] [Chart3d] [LD] [2DROPBAR] *4(CrtLine LineFormat)
  7252. *2DFTTEXT [DataLabExtContents] [SS] *4SHAPEPROPS End
  7253. </summary>
  7254. </member>
  7255. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.CrtMlFrtAggregate">
  7256. <summary>
  7257. CRTMLFRT = CrtMlFrt *CrtMlFrtContinue
  7258. </summary>
  7259. </member>
  7260. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.DatAggregate">
  7261. <summary>
  7262. DAT = Dat Begin LD End
  7263. </summary>
  7264. </member>
  7265. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.DFTTextAggregate">
  7266. <summary>
  7267. DFTTEXT = [DataLabExt StartObject] DefaultText ATTACHEDLABEL [EndObject]
  7268. </summary>
  7269. </member>
  7270. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.DropBarAggregate">
  7271. <summary>
  7272. DROPBAR = DropBar Begin LineFormat AreaFormat [GELFRAME] [SHAPEPROPS] End
  7273. </summary>
  7274. </member>
  7275. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.DVAxisAggregate">
  7276. <summary>
  7277. DVAXIS = Axis Begin [ValueRange] [AXM] AXS [CRTMLFRT] End
  7278. </summary>
  7279. </member>
  7280. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.FontListAggregate">
  7281. <summary>
  7282. FONTLIST = FrtFontList StartObject *(Font [Fbi]) EndObject
  7283. </summary>
  7284. </member>
  7285. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.FrameAggregate">
  7286. <summary>
  7287. FRAME = Frame Begin LineFormat AreaFormat [GELFRAME] [SHAPEPROPS] End
  7288. </summary>
  7289. </member>
  7290. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.GelFrameAggregate">
  7291. <summary>
  7292. GELFRAME = 1*2GelFrame *Continue [PICF]
  7293. PICF = Begin PicF End
  7294. </summary>
  7295. </member>
  7296. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.IVAxisAggregate">
  7297. <summary>
  7298. IVAXIS = Axis Begin [CatSerRange] AxcExt [CatLab] AXS [CRTMLFRT] End
  7299. </summary>
  7300. </member>
  7301. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.LDAggregate">
  7302. <summary>
  7303. LD = Legend Begin Pos ATTACHEDLABEL [FRAME] [CrtLayout12] [TEXTPROPS] [CRTMLFRT] End
  7304. </summary>
  7305. </member>
  7306. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.SeriesAxisAggregate">
  7307. <summary>
  7308. SERIESAXIS = Axis Begin [CatSerRange] AXS [CRTMLFRT] End
  7309. </summary>
  7310. </member>
  7311. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.SeriesDataAggregate">
  7312. <summary>
  7313. SERIESDATA = Dimensions 3(SIIndex *(Number / BoolErr / Blank / Label))
  7314. </summary>
  7315. </member>
  7316. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.SeriesFormatAggregate">
  7317. <summary>
  7318. SERIESFORMAT = Series Begin 4AI *SS (SerToCrt / (SerParent (SerAuxTrend / SerAuxErrBar)))
  7319. *(LegendException [Begin ATTACHEDLABEL [TEXTPROPS] End]) End
  7320. </summary>
  7321. </member>
  7322. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.SeriesFormatAggregate.LegendExceptionAggregate">
  7323. <summary>
  7324. LegendException [Begin ATTACHEDLABEL [TEXTPROPS] End]
  7325. </summary>
  7326. </member>
  7327. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.ShapePropsAggregate">
  7328. <summary>
  7329. SHAPEPROPS = ShapePropsStream *ContinueFrt12
  7330. </summary>
  7331. </member>
  7332. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.SSAggregate">
  7333. <summary>
  7334. SS = DataFormat Begin [Chart3DBarShape] [LineFormat AreaFormat PieFormat] [SerFmt]
  7335. [GELFRAME] [MarkerFormat] [AttachedLabel] *2SHAPEPROPS [CRTMLFRT] End
  7336. </summary>
  7337. </member>
  7338. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.TextPropsAggregate">
  7339. <summary>
  7340. TEXTPROPS = (RichTextStream / TextPropsStream) *ContinueFrt12
  7341. </summary>
  7342. </member>
  7343. <member name="T:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate">
  7344. <summary>
  7345. @author Glen Stampoultzis
  7346. </summary>
  7347. </member>
  7348. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.#ctor">
  7349. <summary>
  7350. Initializes a new instance of the <see cref="T:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate"/> class.
  7351. </summary>
  7352. </member>
  7353. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.#ctor(NPOI.HSSF.Model.RecordStream)">
  7354. <summary>
  7355. Initializes a new instance of the <see cref="T:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate"/> class.
  7356. </summary>
  7357. <param name="rs">The rs.</param>
  7358. </member>
  7359. <member name="P:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.Sid">
  7360. It's an aggregate... just made something up
  7361. </member>
  7362. <member name="P:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.NumColumns">
  7363. <summary>
  7364. Gets the num columns.
  7365. </summary>
  7366. <value>The num columns.</value>
  7367. </member>
  7368. <member name="P:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.RecordSize">
  7369. <summary>
  7370. Gets the size of the record.
  7371. </summary>
  7372. <value>The size of the record.</value>
  7373. </member>
  7374. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.Clone">
  7375. Performs a deep Clone of the record
  7376. </member>
  7377. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.InsertColumn(NPOI.HSSF.Record.ColumnInfoRecord)">
  7378. <summary>
  7379. Inserts a column into the aggregate (at the end of the list).
  7380. </summary>
  7381. <param name="col">The column.</param>
  7382. </member>
  7383. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.InsertColumn(System.Int32,NPOI.HSSF.Record.ColumnInfoRecord)">
  7384. <summary>
  7385. Inserts a column into the aggregate (at the position specified
  7386. by index
  7387. </summary>
  7388. <param name="idx">The index.</param>
  7389. <param name="col">The columninfo.</param>
  7390. </member>
  7391. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.Serialize(System.Int32,System.Byte[])">
  7392. <summary>
  7393. called by the class that is responsible for writing this sucker.
  7394. Subclasses should implement this so that their data is passed back in a
  7395. byte array.
  7396. </summary>
  7397. <param name="offset">offset to begin writing at</param>
  7398. <param name="data">byte array containing instance data</param>
  7399. <returns>number of bytes written</returns>
  7400. </member>
  7401. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.VisitContainedRecords(NPOI.HSSF.Record.Aggregates.RecordVisitor)">
  7402. <summary>
  7403. Visit each of the atomic BIFF records contained in this {@link RecordAggregate} in the order
  7404. that they should be written to file. Implementors may or may not return the actual
  7405. Records being used to manage POI's internal implementation. Callers should not
  7406. assume either way, and therefore only attempt to modify those Records after cloning
  7407. </summary>
  7408. <param name="rv"></param>
  7409. </member>
  7410. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.FindStartOfColumnOutlineGroup(System.Int32)">
  7411. <summary>
  7412. Finds the start of column outline group.
  7413. </summary>
  7414. <param name="idx">The idx.</param>
  7415. <returns></returns>
  7416. </member>
  7417. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.FindEndOfColumnOutlineGroup(System.Int32)">
  7418. <summary>
  7419. Finds the end of column outline group.
  7420. </summary>
  7421. <param name="idx">The idx.</param>
  7422. <returns></returns>
  7423. </member>
  7424. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.GetColInfo(System.Int32)">
  7425. <summary>
  7426. Gets the col info.
  7427. </summary>
  7428. <param name="idx">The idx.</param>
  7429. <returns></returns>
  7430. </member>
  7431. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.IsColumnGroupCollapsed(System.Int32)">
  7432. <summary>
  7433. Determines whether [is column group collapsed] [the specified idx].
  7434. </summary>
  7435. <param name="idx">The idx.</param>
  7436. <returns>
  7437. <c>true</c> if [is column group collapsed] [the specified idx]; otherwise, <c>false</c>.
  7438. </returns>
  7439. </member>
  7440. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.IsColumnGroupHiddenByParent(System.Int32)">
  7441. <summary>
  7442. Determines whether [is column group hidden by parent] [the specified idx].
  7443. </summary>
  7444. <param name="idx">The idx.</param>
  7445. <returns>
  7446. <c>true</c> if [is column group hidden by parent] [the specified idx]; otherwise, <c>false</c>.
  7447. </returns>
  7448. </member>
  7449. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.CollapseColumn(System.Int32)">
  7450. <summary>
  7451. Collapses the column.
  7452. </summary>
  7453. <param name="columnNumber">The column number.</param>
  7454. </member>
  7455. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.ExpandColumn(System.Int32)">
  7456. <summary>
  7457. Expands the column.
  7458. </summary>
  7459. <param name="columnNumber">The column number.</param>
  7460. </member>
  7461. <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})">
  7462. Sets all non null fields into the <c>ci</c> parameter.
  7463. </member>
  7464. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.AttemptMergeColInfoRecords(System.Int32)">
  7465. <summary>
  7466. Attempts to merge the col info record at the specified index
  7467. with either or both of its neighbours
  7468. </summary>
  7469. <param name="colInfoIx">The col info ix.</param>
  7470. </member>
  7471. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.MergeColInfoRecords(NPOI.HSSF.Record.ColumnInfoRecord,NPOI.HSSF.Record.ColumnInfoRecord)">
  7472. merges two column info records (if they are adjacent and have the same formatting, etc)
  7473. @return <c>false</c> if the two column records could not be merged
  7474. </member>
  7475. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.SetGroupHidden(System.Int32,System.Int32,System.Boolean)">
  7476. <summary>
  7477. Sets all adjacent columns of the same outline level to the specified hidden status.
  7478. </summary>
  7479. <param name="pIdx">the col info index of the start of the outline group.</param>
  7480. <param name="level">The level.</param>
  7481. <param name="hidden">The hidden.</param>
  7482. <returns>the column index of the last column in the outline group</returns>
  7483. </member>
  7484. <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})">
  7485. <summary>
  7486. Sets the column.
  7487. </summary>
  7488. <param name="targetColumnIx">The target column ix.</param>
  7489. <param name="xfIndex">Index of the xf.</param>
  7490. <param name="width">The width.</param>
  7491. <param name="level">The level.</param>
  7492. <param name="hidden">The hidden.</param>
  7493. <param name="collapsed">The collapsed.</param>
  7494. </member>
  7495. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.SetColumnInfoFields(NPOI.HSSF.Record.ColumnInfoRecord,System.Int16,System.Int16,System.Int32,System.Boolean,System.Boolean)">
  7496. Sets all non null fields into the <c>ci</c> parameter.
  7497. </member>
  7498. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.CollapseColInfoRecords(System.Int32)">
  7499. <summary>
  7500. Collapses the col info records.
  7501. </summary>
  7502. <param name="columnIdx">The column index.</param>
  7503. </member>
  7504. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.GroupColumnRange(System.Int32,System.Int32,System.Boolean)">
  7505. <summary>
  7506. Creates an outline Group for the specified columns.
  7507. </summary>
  7508. <param name="fromColumnIx">Group from this column (inclusive)</param>
  7509. <param name="toColumnIx">Group to this column (inclusive)</param>
  7510. <param name="indent">if true the Group will be indented by one level;if false indenting will be Removed by one level.</param>
  7511. </member>
  7512. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.FindColumnInfo(System.Int32)">
  7513. <summary>
  7514. Finds the ColumnInfoRecord
  7515. which contains the specified columnIndex
  7516. </summary>
  7517. <param name="columnIndex">index of the column (not the index of the ColumnInfoRecord)</param>
  7518. <returns> /// <c>null</c>
  7519. if no column info found for the specified column
  7520. </returns>
  7521. </member>
  7522. <member name="P:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.MaxOutlineLevel">
  7523. <summary>
  7524. Gets the max outline level.
  7525. </summary>
  7526. <value>The max outline level.</value>
  7527. </member>
  7528. <member name="T:NPOI.HSSF.Record.Aggregates.ConditionalFormattingTable">
  7529. Holds all the conditional formatting for a workbook sheet.<p/>
  7530. See OOO exelfileformat.pdf sec 4.12 'Conditional Formatting Table'
  7531. @author Josh Micich
  7532. </member>
  7533. <member name="M:NPOI.HSSF.Record.Aggregates.ConditionalFormattingTable.#ctor">
  7534. Creates an empty ConditionalFormattingTable
  7535. </member>
  7536. <member name="M:NPOI.HSSF.Record.Aggregates.ConditionalFormattingTable.Add(NPOI.HSSF.Record.Aggregates.CFRecordsAggregate)">
  7537. @return index of the newly added CF header aggregate
  7538. </member>
  7539. <member name="T:NPOI.HSSF.Record.Aggregates.CustomViewSettingsRecordAggregate">
  7540. Manages the all the records associated with a 'Custom View Settings' sub-stream.<br/>
  7541. Includes the Initial USERSVIEWBEGIN(0x01AA) and USERSVIEWEND(0x01AB).
  7542. @author Josh Micich
  7543. </member>
  7544. <member name="F:NPOI.HSSF.Record.Aggregates.CustomViewSettingsRecordAggregate._recs">
  7545. All the records between BOF and EOF
  7546. </member>
  7547. <member name="T:NPOI.HSSF.Record.Aggregates.DataValidityTable">
  7548. <summary>
  7549. Manages the DVALRecord and DVRecords for a single sheet
  7550. See OOO excelfileformat.pdf section 4.14
  7551. @author Josh Micich
  7552. </summary>
  7553. </member>
  7554. <member name="F:NPOI.HSSF.Record.Aggregates.DataValidityTable._validationList">
  7555. The list of data validations for the current sheet.
  7556. Note - this may be empty (contrary to OOO documentation)
  7557. </member>
  7558. <member name="T:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate">
  7559. <summary>
  7560. The formula record aggregate is used to join toGether the formula record and it's
  7561. (optional) string record and (optional) Shared Formula Record (template Reads, excel optimization).
  7562. @author Glen Stampoultzis (glens at apache.org)
  7563. </summary>
  7564. </member>
  7565. <member name="F:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate._stringRecord">
  7566. caches the calculated result of the formula
  7567. </member>
  7568. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.#ctor(NPOI.HSSF.Record.FormulaRecord,NPOI.HSSF.Record.StringRecord,NPOI.HSSF.Record.Aggregates.SharedValueManager)">
  7569. <summary>
  7570. Initializes a new instance of the <see cref="T:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate"/> class.
  7571. </summary>
  7572. <param name="formulaRec">The formula rec.</param>
  7573. <param name="stringRec">The string rec.</param>
  7574. <param name="svm">The SVM.</param>
  7575. </member>
  7576. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.NotifyFormulaChanging">
  7577. Should be called by any code which is either deleting this formula cell, or changing
  7578. its type. This method gives the aggregate a chance to unlink any shared formula
  7579. that may be involved with this cell formula.
  7580. </member>
  7581. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.Serialize(System.Int32,System.Byte[])">
  7582. <summary>
  7583. called by the class that is responsible for writing this sucker.
  7584. Subclasses should implement this so that their data is passed back in a
  7585. byte array.
  7586. </summary>
  7587. <param name="offset">offset to begin writing at</param>
  7588. <param name="data">byte array containing instance data.</param>
  7589. <returns>number of bytes written</returns>
  7590. </member>
  7591. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.VisitContainedRecords(NPOI.HSSF.Record.Aggregates.RecordVisitor)">
  7592. <summary>
  7593. Visit each of the atomic BIFF records contained in this {@link RecordAggregate} in the order
  7594. that they should be written to file. Implementors may or may not return the actual
  7595. {@link Record}s being used to manage POI's internal implementation. Callers should not
  7596. assume either way, and therefore only attempt to modify those {@link Record}s after cloning
  7597. </summary>
  7598. <param name="rv"></param>
  7599. </member>
  7600. <member name="P:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.RecordSize">
  7601. <summary>
  7602. Get the current Serialized size of the record. Should include the sid and recLength (4 bytes).
  7603. </summary>
  7604. <value>The size of the record.</value>
  7605. </member>
  7606. <member name="P:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.Sid">
  7607. <summary>
  7608. return the non static version of the id for this record.
  7609. </summary>
  7610. <value>The sid.</value>
  7611. </member>
  7612. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.HandleMissingSharedFormulaRecord(NPOI.HSSF.Record.FormulaRecord)">
  7613. <summary>
  7614. Sometimes the shared formula flag "seems" to be erroneously set (because the corresponding
  7615. SharedFormulaRecord does not exist). Normally this would leave no way of determining
  7616. the Ptg tokens for the formula. However as it turns out in these
  7617. cases, Excel encodes the unshared Ptg tokens in the right place (inside the FormulaRecord).
  7618. So the the only thing that needs to be done is to ignore the erroneous
  7619. shared formula flag.
  7620. This method may also be used for setting breakpoints to help diagnose issues regarding the
  7621. abnormally-set 'shared formula' flags.
  7622. </summary>
  7623. <param name="formula">The formula.</param>
  7624. </member>
  7625. <member name="P:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.FormulaRecord">
  7626. <summary>
  7627. Gets or sets the formula record.
  7628. </summary>
  7629. <value>The formula record.</value>
  7630. </member>
  7631. <member name="P:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.StringRecord">
  7632. <summary>
  7633. Gets or sets the string record.
  7634. </summary>
  7635. <value>The string record.</value>
  7636. </member>
  7637. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.Equals(System.Object)">
  7638. <summary>
  7639. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
  7640. </summary>
  7641. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
  7642. <returns>
  7643. true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
  7644. </returns>
  7645. <exception cref="T:System.NullReferenceException">
  7646. The <paramref name="obj"/> parameter is null.
  7647. </exception>
  7648. </member>
  7649. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.ToString">
  7650. <summary>
  7651. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  7652. </summary>
  7653. <returns>
  7654. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  7655. </returns>
  7656. </member>
  7657. <member name="P:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.StringValue">
  7658. <summary>
  7659. Gets the string value.
  7660. </summary>
  7661. <value>The string value.</value>
  7662. </member>
  7663. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.SetCachedStringResult(System.String)">
  7664. <summary>
  7665. Sets the cached string result.
  7666. </summary>
  7667. <param name="value">The value.</param>
  7668. </member>
  7669. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.SetCachedBooleanResult(System.Boolean)">
  7670. <summary>
  7671. Sets the cached boolean result.
  7672. </summary>
  7673. <param name="value">if set to <c>true</c> [value].</param>
  7674. </member>
  7675. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.SetCachedErrorResult(System.Int32)">
  7676. <summary>
  7677. Sets the cached error result.
  7678. </summary>
  7679. <param name="errorCode">The error code.</param>
  7680. </member>
  7681. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.SetParsedExpression(NPOI.SS.Formula.PTG.Ptg[])">
  7682. Also checks for a related shared formula and unlinks it if found
  7683. </member>
  7684. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.RemoveArrayFormula(System.Int32,System.Int32)">
  7685. Removes an array formula
  7686. @return the range of the array formula containing the specified cell. Never <code>null</code>
  7687. </member>
  7688. <member name="T:NPOI.HSSF.Record.Aggregates.MergedCellsTable">
  7689. @author Josh Micich
  7690. </member>
  7691. <member name="M:NPOI.HSSF.Record.Aggregates.MergedCellsTable.#ctor">
  7692. <summary>
  7693. Creates an empty aggregate
  7694. </summary>
  7695. </member>
  7696. <member name="M:NPOI.HSSF.Record.Aggregates.MergedCellsTable.Read(NPOI.HSSF.Model.RecordStream)">
  7697. Reads zero or more consecutive {@link MergeCellsRecord}s
  7698. @param rs
  7699. </member>
  7700. <member name="T:NPOI.HSSF.Record.Aggregates.PageSettingsBlock">
  7701. Groups the page settings records for a worksheet.<p/>
  7702. See OOO excelfileformat.pdf sec 4.4 'Page Settings Block'
  7703. @author Josh Micich
  7704. </member>
  7705. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.#ctor">
  7706. Creates a PageSettingsBlock with default settings
  7707. </member>
  7708. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.IsComponentRecord(System.Int32)">
  7709. @return <c>true</c> if the specified Record sid is one belonging to the
  7710. 'Page Settings Block'.
  7711. </member>
  7712. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.SetColumnBreak(System.Int32,System.Int32,System.Int32)">
  7713. Sets a page break at the indicated column
  7714. </member>
  7715. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.RemoveColumnBreak(System.Int32)">
  7716. Removes a page break at the indicated column
  7717. </member>
  7718. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.CreateHCenter">
  7719. Creates the HCenter Record and sets it to false (don't horizontally center)
  7720. </member>
  7721. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.CreateVCenter">
  7722. Creates the VCenter Record and sets it to false (don't horizontally center)
  7723. </member>
  7724. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.CreatePrintSetup">
  7725. Creates the PrintSetup Record and sets it to defaults and marks it invalid
  7726. @see org.apache.poi.hssf.record.PrintSetupRecord
  7727. @see org.apache.poi.hssf.record.Record
  7728. @return record containing a PrintSetupRecord
  7729. </member>
  7730. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.Header">
  7731. Returns the HeaderRecord.
  7732. @return HeaderRecord for the sheet.
  7733. </member>
  7734. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.Footer">
  7735. Returns the FooterRecord.
  7736. @return FooterRecord for the sheet.
  7737. </member>
  7738. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.PrintSetup">
  7739. Returns the PrintSetupRecord.
  7740. @return PrintSetupRecord for the sheet.
  7741. </member>
  7742. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.GetMargin(NPOI.SS.UserModel.MarginType)">
  7743. Gets the size of the margin in inches.
  7744. @param margin which margin to Get
  7745. @return the size of the margin
  7746. </member>
  7747. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.SetMargin(NPOI.SS.UserModel.MarginType,System.Double)">
  7748. Sets the size of the margin in inches.
  7749. @param margin which margin to Get
  7750. @param size the size of the margin
  7751. </member>
  7752. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.ShiftBreaks(NPOI.HSSF.Record.PageBreakRecord,System.Int32,System.Int32,System.Int32)">
  7753. Shifts all the page breaks in the range "count" number of rows/columns
  7754. @param breaks The page record to be shifted
  7755. @param start Starting "main" value to shift breaks
  7756. @param stop Ending "main" value to shift breaks
  7757. @param count number of units (rows/columns) to shift by
  7758. </member>
  7759. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.SetRowBreak(System.Int32,System.Int16,System.Int16)">
  7760. Sets a page break at the indicated row
  7761. @param row
  7762. </member>
  7763. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.RemoveRowBreak(System.Int32)">
  7764. Removes a page break at the indicated row
  7765. @param row
  7766. </member>
  7767. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.IsRowBroken(System.Int32)">
  7768. Queries if the specified row has a page break
  7769. @param row
  7770. @return true if the specified row has a page break
  7771. </member>
  7772. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.IsColumnBroken(System.Int32)">
  7773. Queries if the specified column has a page break
  7774. @return <c>true</c> if the specified column has a page break
  7775. </member>
  7776. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.ShiftRowBreaks(System.Int32,System.Int32,System.Int32)">
  7777. Shifts the horizontal page breaks for the indicated count
  7778. @param startingRow
  7779. @param endingRow
  7780. @param count
  7781. </member>
  7782. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.ShiftColumnBreaks(System.Int16,System.Int16,System.Int16)">
  7783. Shifts the vertical page breaks for the indicated count
  7784. @param startingCol
  7785. @param endingCol
  7786. @param count
  7787. </member>
  7788. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.RowBreaks">
  7789. @return all the horizontal page breaks, never <c>null</c>
  7790. </member>
  7791. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.NumRowBreaks">
  7792. @return the number of row page breaks
  7793. </member>
  7794. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.ColumnBreaks">
  7795. @return all the column page breaks, never <c>null</c>
  7796. </member>
  7797. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.NumColumnBreaks">
  7798. @return the number of column page breaks
  7799. </member>
  7800. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.AddLateHeaderFooter(NPOI.HSSF.Record.HeaderFooterRecord)">
  7801. <summary>
  7802. HEADERFOOTER is new in 2007. Some apps seem to have scattered this record long after
  7803. the PageSettingsBlock where it belongs.
  7804. </summary>
  7805. <param name="rec"></param>
  7806. </member>
  7807. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.AddLateRecords(NPOI.HSSF.Model.RecordStream)">
  7808. <summary>
  7809. This method reads PageSettingsBlock records from the supplied RecordStream until the first non-PageSettingsBlock record is encountered.
  7810. As each record is read, it is incorporated into this PageSettingsBlock.
  7811. </summary>
  7812. <param name="rs"></param>
  7813. </member>
  7814. <member name="F:NPOI.HSSF.Record.Aggregates.PLSAggregate._plsContinues">
  7815. holds any continue records found after the PLS record.<br/>
  7816. This would not be required if PLS was properly interpreted.
  7817. Currently, PLS is an {@link UnknownRecord} and does not automatically
  7818. include any trailing {@link ContinueRecord}s.
  7819. </member>
  7820. <member name="M:NPOI.HSSF.Record.Aggregates.RecordVisitor.VisitRecord(NPOI.HSSF.Record.Record)">
  7821. Implementors may call non-mutating methods on Record r.
  7822. @param r must not be <c>null</c>
  7823. </member>
  7824. <member name="T:NPOI.HSSF.Record.Aggregates.RecordAggregate">
  7825. <c>RecordAggregate</c>s are groups of of BIFF <c>Record</c>s that are typically stored
  7826. together and/or updated together. Workbook / Sheet records are typically stored in a sequential
  7827. list, which does not provide much structure to coordinate updates.
  7828. @author Josh Micich
  7829. </member>
  7830. <member name="M:NPOI.HSSF.Record.Aggregates.RecordAggregate.VisitContainedRecords(NPOI.HSSF.Record.Aggregates.RecordVisitor)">
  7831. Visit each of the atomic BIFF records contained in this {@link RecordAggregate} in the order
  7832. that they should be written to file. Implementors may or may not return the actual
  7833. {@link Record}s being used to manage POI's internal implementation. Callers should not
  7834. assume either way, and therefore only attempt to modify those {@link Record}s after cloning
  7835. </member>
  7836. <member name="T:NPOI.HSSF.Record.Aggregates.PositionTrackingVisitor">
  7837. A wrapper for {@link RecordVisitor} which accumulates the sizes of all
  7838. records visited.
  7839. </member>
  7840. <member name="T:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate">
  7841. @author andy
  7842. @author Jason Height (jheight at chariot dot net dot au)
  7843. </member>
  7844. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.#ctor">
  7845. Creates a new instance of ValueRecordsAggregate
  7846. </member>
  7847. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.#ctor(NPOI.HSSF.Model.RecordStream,NPOI.HSSF.Record.Aggregates.SharedValueManager)">
  7848. @param rs record stream with all {@link SharedFormulaRecord}
  7849. {@link ArrayRecord}, {@link TableRecord} {@link MergeCellsRecord} Records removed
  7850. </member>
  7851. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.AddUnknownRecord(NPOI.HSSF.Record.Record)">
  7852. Handles UnknownRecords which appear within the row/cell records
  7853. </member>
  7854. <member name="P:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.RowBlockCount">
  7855. Returns the number of row blocks.
  7856. <p/>The row blocks are goupings of rows that contain the DBCell record
  7857. after them
  7858. </member>
  7859. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.GetRowCountForBlock(System.Int32)">
  7860. Returns the number of physical rows within a block
  7861. </member>
  7862. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.GetStartRowNumberForBlock(System.Int32)">
  7863. Returns the physical row number of the first row in a block
  7864. </member>
  7865. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.GetEndRowNumberForBlock(System.Int32)">
  7866. Returns the physical row number of the end row in a block
  7867. </member>
  7868. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.CreateRow(System.Int32)">
  7869. Create a row record.
  7870. @param row number
  7871. @return RowRecord Created for the passed in row number
  7872. @see org.apache.poi.hssf.record.RowRecord
  7873. </member>
  7874. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.GetCellValueEnumerator">
  7875. Returns an iterator for the cell values
  7876. </member>
  7877. <member name="T:NPOI.HSSF.Record.Aggregates.SharedValueManager">
  7878. <summary>
  7879. Manages various auxiliary records while constructing a RowRecordsAggregate
  7880. @author Josh Micich
  7881. </summary>
  7882. </member>
  7883. <member name="F:NPOI.HSSF.Record.Aggregates.SharedValueManager.SharedFormulaGroup._firstCell">
  7884. Coordinates of the first cell having a formula that uses this shared formula.
  7885. This is often <i>but not always</i> the top left cell in the range covered by
  7886. {@link #_sfr}
  7887. </member>
  7888. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.SharedFormulaGroup.IsFirstCell(System.Int32,System.Int32)">
  7889. Note - the 'first cell' of a shared formula group is not always the top-left cell
  7890. of the enclosing range.
  7891. @return <c>true</c> if the specified coordinates correspond to the 'first cell'
  7892. of this shared formula group.
  7893. </member>
  7894. <member name="F:NPOI.HSSF.Record.Aggregates.SharedValueManager._groupsCache">
  7895. cached for optimization purposes
  7896. </member>
  7897. <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})">
  7898. @param firstCells
  7899. @param recs list of sheet records (possibly Contains records for other parts of the Excel file)
  7900. @param startIx index of first row/cell record for current sheet
  7901. @param endIx one past index of last row/cell record for current sheet. It is important
  7902. that this code does not inadvertently collect <c>SharedFormulaRecord</c>s from any other
  7903. sheet (which could happen if endIx is chosen poorly). (see bug 44449)
  7904. </member>
  7905. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.LinkSharedFormulaRecord(NPOI.SS.Util.CellReference,NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate)">
  7906. @param firstCell as extracted from the {@link ExpPtg} from the cell's formula.
  7907. @return never <code>null</code>
  7908. </member>
  7909. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.GetRecordForFirstCell(NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate)">
  7910. Gets the {@link SharedValueRecordBase} record if it should be encoded immediately after the
  7911. formula record Contained in the specified {@link FormulaRecordAggregate} agg. Note - the
  7912. shared value record always appears after the first formula record in the group. For arrays
  7913. and tables the first formula is always the in the top left cell. However, since shared
  7914. formula groups can be sparse and/or overlap, the first formula may not actually be in the
  7915. top left cell.
  7916. @return the SHRFMLA, TABLE or ARRAY record for the formula cell, if it is the first cell of
  7917. a table or array region. <code>null</code> if the formula cell is not shared/array/table,
  7918. or if the specified formula is not the the first in the group.
  7919. </member>
  7920. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.Unlink(NPOI.HSSF.Record.SharedFormulaRecord)">
  7921. Converts all {@link FormulaRecord}s handled by <c>sharedFormulaRecord</c>
  7922. to plain unshared formulas
  7923. </member>
  7924. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.AddArrayRecord(NPOI.HSSF.Record.ArrayRecord)">
  7925. Add specified Array Record.
  7926. </member>
  7927. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.RemoveArrayFormula(System.Int32,System.Int32)">
  7928. Removes the {@link ArrayRecord} for the cell group containing the specified cell.
  7929. The caller should clear (set blank) all cells in the returned range.
  7930. @return the range of the array formula which was just removed. Never <code>null</code>.
  7931. </member>
  7932. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.GetArrayRecord(System.Int32,System.Int32)">
  7933. @return the shared ArrayRecord identified by (firstRow, firstColumn). never <code>null</code>.
  7934. </member>
  7935. <member name="T:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate">
  7936. Aggregate value records toGether. Things are easier to handle that way.
  7937. @author andy
  7938. @author Glen Stampoultzis (glens at apache.org)
  7939. @author Jason Height (jheight at chariot dot net dot au)
  7940. </member>
  7941. <member name="M:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate.#ctor">
  7942. Creates a new instance of ValueRecordsAggregate
  7943. </member>
  7944. <member name="M:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate.HandleMissingSharedFormulaRecord(NPOI.HSSF.Record.FormulaRecord)">
  7945. Sometimes the shared formula flag "seems" to be erroneously Set, in which case there is no
  7946. call to <c>SharedFormulaRecord.ConvertSharedFormulaRecord</c> and hence the
  7947. <c>ParsedExpression</c> field of this <c>FormulaRecord</c> will not Get updated.<br/>
  7948. As it turns out, this is not a problem, because in these circumstances, the existing value
  7949. for <c>ParsedExpression</c> is perfectly OK.<p/>
  7950. This method may also be used for Setting breakpoints to help diagnose Issues regarding the
  7951. abnormally-Set 'shared formula' flags.
  7952. (see TestValueRecordsAggregate.testSpuriousSharedFormulaFlag()).<p/>
  7953. The method currently does nothing but do not delete it without Finding a nice home for this
  7954. comment.
  7955. </member>
  7956. <member name="M:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate.GetRowCellBlockSize(System.Int32,System.Int32)">
  7957. Tallies a count of the size of the cell records
  7958. that are attached to the rows in the range specified.
  7959. </member>
  7960. <member name="M:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate.RowHasCells(System.Int32)">
  7961. Returns true if the row has cells attached to it
  7962. </member>
  7963. <member name="M:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate.SerializeCellRow(System.Int32,System.Int32,System.Byte[])">
  7964. Serializes the cells that are allocated to a certain row range
  7965. </member>
  7966. <member name="T:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock">
  7967. Groups the sheet protection records for a worksheet.
  7968. <p/>
  7969. See OOO excelfileformat.pdf sec 4.18.2 'Sheet Protection in a Workbook
  7970. (BIFF5-BIFF8)'
  7971. @author Josh Micich
  7972. </member>
  7973. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.#ctor">
  7974. Creates an empty WorksheetProtectionBlock
  7975. </member>
  7976. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.IsComponentRecord(System.Int32)">
  7977. @return <c>true</c> if the specified Record sid is one belonging to
  7978. the 'Page Settings Block'.
  7979. </member>
  7980. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.AddRecords(NPOI.HSSF.Model.RecordStream)">
  7981. This method Reads {@link WorksheetProtectionBlock} records from the supplied RecordStream
  7982. until the first non-WorksheetProtectionBlock record is encountered. As each record is Read,
  7983. it is incorporated into this WorksheetProtectionBlock.
  7984. <p/>
  7985. As per the OOO documentation, the protection block records can be expected to be written
  7986. toGether (with no intervening records), but earlier versions of POI (prior to Jun 2009)
  7987. didn't do this. Workbooks with sheet protection Created by those earlier POI versions
  7988. seemed to be valid (Excel opens them OK). So PO allows continues to support Reading of files
  7989. with non continuous worksheet protection blocks.
  7990. <p/>
  7991. <b>Note</b> - when POI Writes out this WorksheetProtectionBlock, the records will always be
  7992. written in one consolidated block (in the standard ordering) regardless of how scattered the
  7993. records were when they were originally Read.
  7994. </member>
  7995. <member name="P:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.Protect">
  7996. <summary>
  7997. the ProtectRecord. If one is not contained in the sheet, then one is created.
  7998. </summary>
  7999. </member>
  8000. <member name="P:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.Password">
  8001. <summary>
  8002. the PasswordRecord. If one is not Contained in the sheet, then one is Created.
  8003. </summary>
  8004. </member>
  8005. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.CreateObjectProtect">
  8006. <summary>
  8007. Creates an ObjectProtect record with protect set to false.
  8008. </summary>
  8009. <returns></returns>
  8010. </member>
  8011. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.CreateScenarioProtect">
  8012. <summary>
  8013. Creates a ScenarioProtect record with protect set to false.
  8014. </summary>
  8015. <returns></returns>
  8016. </member>
  8017. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.CreatePassword">
  8018. <summary>
  8019. Creates a Password record with password set to 0x0000.
  8020. </summary>
  8021. <returns></returns>
  8022. </member>
  8023. <member name="T:NPOI.HSSF.Record.ArrayRecord">
  8024. ARRAY (0x0221)<p/>
  8025. Treated in a similar way to SharedFormulaRecord
  8026. @author Josh Micich
  8027. </member>
  8028. <member name="T:NPOI.HSSF.Record.AutoFilter.DOPERRecord">
  8029. <summary>
  8030. DOPER Structure for AutoFilter record
  8031. </summary>
  8032. <remarks>author: Tony Qu</remarks>
  8033. </member>
  8034. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.RK">
  8035. <summary>
  8036. get or set the RK record
  8037. </summary>
  8038. </member>
  8039. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.LengthOfString">
  8040. <summary>
  8041. Gets or sets Length of the string (the string is stored in the rgch field that follows the DOPER structures)
  8042. </summary>
  8043. </member>
  8044. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.IsBooleanValue">
  8045. <summary>
  8046. Whether the bBoolErr field contains a Boolean value
  8047. </summary>
  8048. </member>
  8049. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.IsErrorValue">
  8050. <summary>
  8051. Whether the bBoolErr field contains a Error value
  8052. </summary>
  8053. </member>
  8054. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.BooleanValue">
  8055. <summary>
  8056. Get or sets the boolean value
  8057. </summary>
  8058. </member>
  8059. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.ErrorValue">
  8060. <summary>
  8061. Get or sets the boolean value
  8062. </summary>
  8063. </member>
  8064. <member name="T:NPOI.HSSF.Record.BackupRecord">
  8065. Title: Backup Record
  8066. Description: bool specifying whether
  8067. the GUI should store a backup of the file.
  8068. REFERENCE: PG 287 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  8069. @author Andrew C. Oliver (acoliver at apache dot org)
  8070. @version 2.0-pre
  8071. </member>
  8072. <member name="M:NPOI.HSSF.Record.BackupRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8073. Constructs a BackupRecord and Sets its fields appropriately
  8074. @param in the RecordInputstream to Read the record from
  8075. </member>
  8076. <member name="P:NPOI.HSSF.Record.BackupRecord.Backup">
  8077. Get the backup flag
  8078. @return short 0/1 (off/on)
  8079. </member>
  8080. <member name="M:NPOI.HSSF.Record.BiffHeaderInput.ReadRecordSID">
  8081. Read an unsigned short from the stream without decrypting
  8082. </member>
  8083. <member name="M:NPOI.HSSF.Record.BiffHeaderInput.ReadDataSize">
  8084. Read an unsigned short from the stream without decrypting
  8085. </member>
  8086. <member name="T:NPOI.HSSF.Record.BlankRecord">
  8087. Title: Blank cell record
  8088. Description: Represents a column in a row with no value but with styling.
  8089. REFERENCE: PG 287 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  8090. @author Andrew C. Oliver (acoliver at apache dot org)
  8091. @author Jason Height (jheight at chariot dot net dot au)
  8092. @version 2.0-pre
  8093. </member>
  8094. <member name="M:NPOI.HSSF.Record.BlankRecord.#ctor">
  8095. Creates a new instance of BlankRecord
  8096. </member>
  8097. <member name="M:NPOI.HSSF.Record.BlankRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8098. Constructs a BlankRecord and Sets its fields appropriately
  8099. @param in the RecordInputstream to Read the record from
  8100. </member>
  8101. <member name="P:NPOI.HSSF.Record.BlankRecord.Row">
  8102. Get the row this cell occurs on
  8103. @return the row
  8104. </member>
  8105. <member name="P:NPOI.HSSF.Record.BlankRecord.Column">
  8106. Get the column this cell defines within the row
  8107. @return the column
  8108. </member>
  8109. <member name="P:NPOI.HSSF.Record.BlankRecord.XFIndex">
  8110. Set the index of the extended format record to style this cell with
  8111. @param xf - the 0-based index of the extended format
  8112. @see org.apache.poi.hssf.record.ExtendedFormatRecord
  8113. </member>
  8114. <member name="P:NPOI.HSSF.Record.BlankRecord.Sid">
  8115. return the non static version of the id for this record.
  8116. </member>
  8117. <member name="M:NPOI.HSSF.Record.BlankRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  8118. called by the class that is responsible for writing this sucker.
  8119. Subclasses should implement this so that their data is passed back in a
  8120. byte array.
  8121. @return byte array containing instance data
  8122. </member>
  8123. <member name="T:NPOI.HSSF.Record.BOFRecord">
  8124. Title: Beginning Of File
  8125. Description: Somewhat of a misnomer, its used for the beginning of a Set of
  8126. records that have a particular pupose or subject.
  8127. Used in sheets and workbooks.
  8128. REFERENCE: PG 289 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  8129. @author Andrew C. Oliver
  8130. @author Jason Height (jheight at chariot dot net dot au)
  8131. @version 2.0-pre
  8132. </member>
  8133. <member name="F:NPOI.HSSF.Record.BOFRecord.sid">
  8134. for BIFF8 files the BOF is 0x809. For earlier versions see
  8135. {@link #biff2_sid} {@link #biff3_sid} {@link #biff4_sid}
  8136. {@link #biff5_sid}
  8137. </member>
  8138. <member name="F:NPOI.HSSF.Record.BOFRecord.VERSION">
  8139. suggested default (0x06 - BIFF8)
  8140. </member>
  8141. <member name="F:NPOI.HSSF.Record.BOFRecord.BUILD">
  8142. suggested default 0x10d3
  8143. </member>
  8144. <member name="F:NPOI.HSSF.Record.BOFRecord.BUILD_YEAR">
  8145. suggested default 0x07CC (1996)
  8146. </member>
  8147. <member name="F:NPOI.HSSF.Record.BOFRecord.HISTORY_MASK">
  8148. suggested default for a normal sheet (0x41)
  8149. </member>
  8150. <member name="M:NPOI.HSSF.Record.BOFRecord.#ctor">
  8151. Constructs an empty BOFRecord with no fields Set.
  8152. </member>
  8153. <member name="M:NPOI.HSSF.Record.BOFRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8154. Constructs a BOFRecord and Sets its fields appropriately
  8155. @param in the RecordInputstream to Read the record from
  8156. </member>
  8157. <member name="P:NPOI.HSSF.Record.BOFRecord.Version">
  8158. Version number - for BIFF8 should be 0x06
  8159. @see #VERSION
  8160. @param version version to be Set
  8161. </member>
  8162. <member name="P:NPOI.HSSF.Record.BOFRecord.HistoryBitMask">
  8163. Set the history bit mask (not very useful)
  8164. @see #HISTORY_MASK
  8165. @param bitmask bitmask to Set for the history
  8166. </member>
  8167. <member name="P:NPOI.HSSF.Record.BOFRecord.RequiredVersion">
  8168. Set the minimum version required to Read this file
  8169. @see #VERSION
  8170. @param version version to Set
  8171. </member>
  8172. <member name="P:NPOI.HSSF.Record.BOFRecord.Type">
  8173. type of object this marks
  8174. @see #TYPE_WORKBOOK
  8175. @see #TYPE_VB_MODULE
  8176. @see #TYPE_WORKSHEET
  8177. @see #TYPE_CHART
  8178. @see #TYPE_EXCEL_4_MACRO
  8179. @see #TYPE_WORKSPACE_FILE
  8180. @return short type of object
  8181. </member>
  8182. <member name="P:NPOI.HSSF.Record.BOFRecord.Build">
  8183. Get the build that wrote this file
  8184. @see #BUILD
  8185. @return short build number of the generator of this file
  8186. </member>
  8187. <member name="P:NPOI.HSSF.Record.BOFRecord.BuildYear">
  8188. Year of the build that wrote this file
  8189. @see #BUILD_YEAR
  8190. @return short build year of the generator of this file
  8191. </member>
  8192. <member name="T:NPOI.HSSF.Record.BookBoolRecord">
  8193. Title: Save External Links record (BookBool)
  8194. Description: Contains a flag specifying whether the Gui should save externally
  8195. linked values from other workbooks.
  8196. REFERENCE: PG 289 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  8197. @author Andrew C. Oliver (acoliver at apache dot org)
  8198. @version 2.0-pre
  8199. </member>
  8200. <member name="M:NPOI.HSSF.Record.BookBoolRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8201. Constructs a BookBoolRecord and Sets its fields appropriately
  8202. @param in the RecordInputstream to Read the record from
  8203. </member>
  8204. <member name="P:NPOI.HSSF.Record.BookBoolRecord.SaveLinkValues">
  8205. Get the save ext links flag
  8206. @return short 0/1 (off/on)
  8207. </member>
  8208. <member name="T:NPOI.HSSF.Record.BoolErrRecord">
  8209. Creates new BoolErrRecord.
  8210. REFERENCE: PG ??? Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  8211. @author Michael P. Harhen
  8212. @author Jason Height (jheight at chariot dot net dot au)
  8213. @version 2.0-pre
  8214. </member>
  8215. <member name="F:NPOI.HSSF.Record.BoolErrRecord._isError">
  8216. If <code>true</code>, this record represents an error cell value, otherwise this record represents a boolean cell value
  8217. </member>
  8218. <member name="M:NPOI.HSSF.Record.BoolErrRecord.#ctor">
  8219. Creates new BoolErrRecord
  8220. </member>
  8221. <member name="M:NPOI.HSSF.Record.BoolErrRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8222. Constructs a BoolErr record and Sets its fields appropriately.
  8223. @param in the RecordInputstream to Read the record from
  8224. </member>
  8225. <member name="M:NPOI.HSSF.Record.BoolErrRecord.SetValue(System.Boolean)">
  8226. Set the bool value for the cell
  8227. @param value representing the bool value
  8228. </member>
  8229. <member name="M:NPOI.HSSF.Record.BoolErrRecord.SetValue(System.Byte)">
  8230. set the error value for the cell. See {@link FormulaError} for valid codes.
  8231. @param value error representing the error value
  8232. this value can only be 0,7,15,23,29,36 or 42
  8233. see bugzilla bug 16560 for an explanation
  8234. </member>
  8235. <member name="M:NPOI.HSSF.Record.BoolErrRecord.SetValue(NPOI.SS.UserModel.FormulaError)">
  8236. Set the error value for the cell
  8237. @param value error representing the error value
  8238. this value can only be 0,7,15,23,29,36 or 42
  8239. see bugzilla bug 16560 for an explanation
  8240. </member>
  8241. <member name="P:NPOI.HSSF.Record.BoolErrRecord.BooleanValue">
  8242. Get the value for the cell
  8243. @return bool representing the bool value
  8244. </member>
  8245. <member name="P:NPOI.HSSF.Record.BoolErrRecord.ErrorValue">
  8246. Get the error value for the cell
  8247. @return byte representing the error value
  8248. </member>
  8249. <member name="P:NPOI.HSSF.Record.BoolErrRecord.IsBoolean">
  8250. Indicates whether the call holds a boolean value
  8251. @return boolean true if the cell holds a boolean value
  8252. </member>
  8253. <member name="P:NPOI.HSSF.Record.BoolErrRecord.IsError">
  8254. Indicates whether the call holds an error value
  8255. @return bool true if the cell holds an error value
  8256. </member>
  8257. <member name="T:NPOI.HSSF.Record.BottomMarginRecord">
  8258. Record for the bottom margin.
  8259. NOTE: This source was automatically generated.
  8260. @author Shawn Laubach (slaubach at apache dot org)
  8261. </member>
  8262. <member name="M:NPOI.HSSF.Record.BottomMarginRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8263. Constructs a BottomMargin record and Sets its fields appropriately.
  8264. @param in the RecordInputstream to Read the record from
  8265. </member>
  8266. <member name="P:NPOI.HSSF.Record.BottomMarginRecord.Margin">
  8267. Get the margin field for the BottomMargin record.
  8268. </member>
  8269. <member name="T:NPOI.HSSF.Record.BoundSheetRecord">
  8270. Title: Bound Sheet Record (aka BundleSheet)
  8271. Description: Defines a sheet within a workbook. Basically stores the sheetname
  8272. and tells where the Beginning of file record Is within the HSSF
  8273. file.
  8274. REFERENCE: PG 291 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  8275. @author Andrew C. Oliver (acoliver at apache dot org)
  8276. @author Sergei Kozello (sergeikozello at mail.ru)
  8277. </member>
  8278. <member name="M:NPOI.HSSF.Record.BoundSheetRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8279. Constructs a BoundSheetRecord and Sets its fields appropriately
  8280. @param in the RecordInputstream to Read the record from
  8281. </member>
  8282. <member name="P:NPOI.HSSF.Record.BoundSheetRecord.PositionOfBof">
  8283. Get the offset in bytes of the Beginning of File Marker within the HSSF Stream part of the POIFS file
  8284. @return offset in bytes
  8285. </member>
  8286. <member name="P:NPOI.HSSF.Record.BoundSheetRecord.IsVeryHidden">
  8287. Is the sheet very hidden? Different from (normal) hidden
  8288. </member>
  8289. <member name="P:NPOI.HSSF.Record.BoundSheetRecord.Sheetname">
  8290. Get the sheetname for this sheet. (this appears in the tabs at the bottom)
  8291. @return sheetname the name of the sheet
  8292. </member>
  8293. <member name="M:NPOI.HSSF.Record.BoundSheetRecord.OrderByBofPosition(System.Collections.Generic.List{NPOI.HSSF.Record.BoundSheetRecord})">
  8294. Converts a List of {@link BoundSheetRecord}s to an array and sorts by the position of their
  8295. BOFs.
  8296. </member>
  8297. <member name="T:NPOI.HSSF.Record.CalcCountRecord">
  8298. Title: Calc Count Record
  8299. Description: Specifies the maximum times the gui should perform a formula
  8300. recalculation. For instance: in the case a formula includes
  8301. cells that are themselves a result of a formula and a value
  8302. Changes. This Is essentially a failsafe against an infinate
  8303. loop in the event the formulas are not independant.
  8304. REFERENCE: PG 292 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  8305. @author Andrew C. Oliver (acoliver at apache dot org)
  8306. @author Jason Height (jheight at chariot dot net dot au)
  8307. @version 2.0-pre
  8308. @see org.apache.poi.hssf.record.CalcModeRecord
  8309. </member>
  8310. <member name="M:NPOI.HSSF.Record.CalcCountRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8311. Constructs a CalcCountRecord and Sets its fields appropriately
  8312. @param in the RecordInputstream to Read the record from
  8313. </member>
  8314. <member name="P:NPOI.HSSF.Record.CalcCountRecord.Iterations">
  8315. Get the number of iterations to perform
  8316. @return iterations
  8317. </member>
  8318. <member name="T:NPOI.HSSF.Record.CalcModeRecord">
  8319. Title: Calc Mode Record
  8320. Description: Tells the gui whether to calculate formulas
  8321. automatically, manually or automatically
  8322. except for tables.
  8323. REFERENCE: PG 292 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  8324. @author Andrew C. Oliver (acoliver at apache dot org)
  8325. @author Jason Height (jheight at chariot dot net dot au)
  8326. @version 2.0-pre
  8327. @see org.apache.poi.hssf.record.CalcCountRecord
  8328. </member>
  8329. <member name="F:NPOI.HSSF.Record.CalcModeRecord.MANUAL">
  8330. manually calculate formulas (0)
  8331. </member>
  8332. <member name="F:NPOI.HSSF.Record.CalcModeRecord.AUTOMATIC">
  8333. automatically calculate formulas (1)
  8334. </member>
  8335. <member name="F:NPOI.HSSF.Record.CalcModeRecord.AUTOMATIC_EXCEPT_TABLES">
  8336. automatically calculate formulas except for tables (-1)
  8337. </member>
  8338. <member name="M:NPOI.HSSF.Record.CalcModeRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8339. Constructs a CalcModeRecord and Sets its fields appropriately
  8340. @param in the RecordInputstream to Read the record from
  8341. </member>
  8342. <member name="M:NPOI.HSSF.Record.CalcModeRecord.SetCalcMode(System.Int16)">
  8343. Set the calc mode flag for formulas
  8344. @see #MANUAL
  8345. @see #AUTOMATIC
  8346. @see #AUTOMATIC_EXCEPT_TABLES
  8347. @param calcmode one of the three flags above
  8348. </member>
  8349. <member name="M:NPOI.HSSF.Record.CalcModeRecord.GetCalcMode">
  8350. Get the calc mode flag for formulas
  8351. @see #MANUAL
  8352. @see #AUTOMATIC
  8353. @see #AUTOMATIC_EXCEPT_TABLES
  8354. @return calcmode one of the three flags above
  8355. </member>
  8356. <member name="P:NPOI.HSSF.Record.CellRecord.XFIndex">
  8357. get the index to the ExtendedFormat
  8358. @see org.apache.poi.hssf.record.ExtendedFormatRecord
  8359. @return index to the XF record
  8360. </member>
  8361. <member name="M:NPOI.HSSF.Record.CellRecord.AppendValueText(System.Text.StringBuilder)">
  8362. Append specific debug info (used by {@link #toString()} for the value
  8363. contained in this record. Trailing new-line should not be Appended
  8364. (superclass does that).
  8365. </member>
  8366. <member name="P:NPOI.HSSF.Record.CellRecord.RecordName">
  8367. Gets the debug info BIFF record type name (used by {@link #toString()}.
  8368. </member>
  8369. <member name="M:NPOI.HSSF.Record.CellRecord.SerializeValue(NPOI.Util.ILittleEndianOutput)">
  8370. writes out the value data for this cell record
  8371. </member>
  8372. <member name="P:NPOI.HSSF.Record.CellRecord.ValueDataSize">
  8373. @return the size (in bytes) of the value data for this cell record
  8374. </member>
  8375. <member name="T:NPOI.HSSF.Record.CellValueRecordInterface">
  8376. The cell value record interface Is implemented by all classes of type Record that
  8377. contain cell values. It allows the containing sheet to move through them and Compare
  8378. them.
  8379. @author Andrew C. Oliver (acoliver at apache dot org)
  8380. @author Jason Height (jheight at chariot dot net dot au)
  8381. @see org.apache.poi.hssf.model.Sheet
  8382. @see org.apache.poi.hssf.record.Record
  8383. @see org.apache.poi.hssf.record.RecordFactory
  8384. </member>
  8385. <member name="P:NPOI.HSSF.Record.CellValueRecordInterface.Row">
  8386. Get the row this cell occurs on
  8387. @return the row
  8388. </member>
  8389. <member name="P:NPOI.HSSF.Record.CellValueRecordInterface.Column">
  8390. Get the column this cell defines within the row
  8391. @return the column
  8392. </member>
  8393. <member name="T:NPOI.HSSF.Record.CFHeader12Record">
  8394. Conditional Formatting Header v12 record CFHEADER12 (0x0879),
  8395. for conditional formattings introduced in Excel 2007 and newer.
  8396. </member>
  8397. <member name="M:NPOI.HSSF.Record.CFHeader12Record.#ctor">
  8398. Creates new CFHeaderRecord
  8399. </member>
  8400. <member name="T:NPOI.HSSF.Record.CFHeaderBase">
  8401. Parent of Conditional Formatting Header records,
  8402. {@link CFHeaderRecord} and {@link CFHeader12Record}.
  8403. </member>
  8404. <member name="M:NPOI.HSSF.Record.CFHeaderBase.#ctor">
  8405. Creates new CFHeaderBase
  8406. </member>
  8407. <member name="P:NPOI.HSSF.Record.CFHeaderBase.CellRanges">
  8408. Set cell ranges list to a single cell range and
  8409. modify the enclosing cell range accordingly.
  8410. @param cellRanges - list of CellRange objects
  8411. </member>
  8412. <member name="T:NPOI.HSSF.Record.CFHeaderRecord">
  8413. Conditional Formatting Header record CFHEADER (0x01B0).
  8414. Used to describe a {@link CFRuleRecord}.
  8415. @see CFHeader12Record
  8416. </member>
  8417. <member name="M:NPOI.HSSF.Record.CFHeaderRecord.#ctor">
  8418. Creates new CFHeaderRecord
  8419. </member>
  8420. <!-- Badly formed XML comment ignored for member "T:NPOI.HSSF.Record.CFRule12Record" -->
  8421. <member name="M:NPOI.HSSF.Record.CFRule12Record.#ctor(System.Byte,System.Byte)">
  8422. Creates new CFRuleRecord
  8423. </member>
  8424. <member name="M:NPOI.HSSF.Record.CFRule12Record.Create(NPOI.HSSF.UserModel.HSSFSheet,System.String)">
  8425. Creates a new comparison operation rule
  8426. </member>
  8427. <member name="M:NPOI.HSSF.Record.CFRule12Record.Create(NPOI.HSSF.UserModel.HSSFSheet,System.Byte,System.String,System.String)">
  8428. Creates a new comparison operation rule
  8429. </member>
  8430. <member name="M:NPOI.HSSF.Record.CFRule12Record.Create(NPOI.HSSF.UserModel.HSSFSheet,System.Byte,System.String,System.String,System.String)">
  8431. Creates a new comparison operation rule
  8432. </member>
  8433. <member name="M:NPOI.HSSF.Record.CFRule12Record.Create(NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.Record.Common.ExtendedColor)">
  8434. Creates a new Data Bar formatting
  8435. </member>
  8436. <member name="M:NPOI.HSSF.Record.CFRule12Record.Create(NPOI.HSSF.UserModel.HSSFSheet,NPOI.SS.UserModel.IconSet)">
  8437. Creates a new Icon Set / Multi-State formatting
  8438. </member>
  8439. <member name="M:NPOI.HSSF.Record.CFRule12Record.CreateColorScale(NPOI.HSSF.UserModel.HSSFSheet)">
  8440. Creates a new Color Scale / Color Gradient formatting
  8441. </member>
  8442. <member name="P:NPOI.HSSF.Record.CFRule12Record.ParsedExpressionScale">
  8443. Get the stack of the scale expression as a list
  8444. @return list of tokens (casts stack to a list and returns it!)
  8445. this method can return null is we are unable to create Ptgs from
  8446. existing excel file
  8447. callers should check for null!
  8448. </member>
  8449. <member name="M:NPOI.HSSF.Record.CFRule12Record.Serialize(NPOI.Util.ILittleEndianOutput)">
  8450. called by the class that is responsible for writing this sucker.
  8451. Subclasses should implement this so that their data is passed back in a
  8452. byte array.
  8453. @param out the stream to write to
  8454. </member>
  8455. <!-- Badly formed XML comment ignored for member "T:NPOI.HSSF.Record.CFRuleBase" -->
  8456. <member name="M:NPOI.HSSF.Record.CFRuleBase.#ctor(System.Byte,System.Byte)">
  8457. Creates new CFRuleRecord
  8458. </member>
  8459. <member name="P:NPOI.HSSF.Record.CFRuleBase.Options">
  8460. Get the option flags
  8461. @return bit mask
  8462. </member>
  8463. <member name="P:NPOI.HSSF.Record.CFRuleBase.ParsedExpression1">
  8464. Get the stack of the 1st expression as a list
  8465. @return list of tokens (casts stack to a list and returns it!)
  8466. this method can return null is we are unable to create Ptgs from
  8467. existing excel file
  8468. callers should check for null!
  8469. </member>
  8470. <member name="P:NPOI.HSSF.Record.CFRuleBase.ParsedExpression2">
  8471. Get the stack of the 2nd expression as a list
  8472. @return array of {@link Ptg}s, possibly <code>null</code>
  8473. </member>
  8474. <member name="M:NPOI.HSSF.Record.CFRuleBase.GetFormulaSize(NPOI.SS.Formula.Formula)">
  8475. @param formula must not be <code>null</code>
  8476. @return encoded size of the formula tokens (does not include 2 bytes for ushort length)
  8477. </member>
  8478. <!-- Badly formed XML comment ignored for member "M:NPOI.HSSF.Record.CFRuleBase.ParseFormula(System.String,NPOI.HSSF.UserModel.HSSFSheet)" -->
  8479. <!-- Badly formed XML comment ignored for member "T:NPOI.HSSF.Record.CFRuleRecord" -->
  8480. <member name="M:NPOI.HSSF.Record.CFRuleRecord.#ctor(System.Byte,System.Byte)">
  8481. Creates new CFRuleRecord
  8482. </member>
  8483. <member name="M:NPOI.HSSF.Record.CFRuleRecord.Create(NPOI.HSSF.UserModel.HSSFSheet,System.String)">
  8484. Creates a new comparison operation rule
  8485. </member>
  8486. <member name="M:NPOI.HSSF.Record.CFRuleRecord.Create(NPOI.HSSF.UserModel.HSSFSheet,System.Byte,System.String,System.String)">
  8487. Creates a new comparison operation rule
  8488. </member>
  8489. <member name="M:NPOI.HSSF.Record.CFRuleRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  8490. called by the class that is responsible for writing this sucker.
  8491. Subclasses should implement this so that their data is passed back in a
  8492. byte array.
  8493. @param out the stream to write to
  8494. </member>
  8495. <member name="T:NPOI.HSSF.Record.CF.BorderFormatting">
  8496. Border Formatting Block of the Conditional Formatting Rule Record.
  8497. @author Dmitriy Kumshayev
  8498. </member>
  8499. <member name="M:NPOI.HSSF.Record.CF.BorderFormatting.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8500. Creates new FontFormatting
  8501. </member>
  8502. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BorderLeft">
  8503. <summary>
  8504. Get the type of border to use for the left border of the cell
  8505. </summary>
  8506. </member>
  8507. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BorderRight">
  8508. <summary>
  8509. Get the type of border to use for the right border of the cell
  8510. </summary>
  8511. </member>
  8512. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BorderTop">
  8513. <summary>
  8514. Get the type of border to use for the top border of the cell
  8515. </summary>
  8516. </member>
  8517. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BorderBottom">
  8518. <summary>
  8519. Get the type of border to use for the bottom border of the cell
  8520. </summary>
  8521. </member>
  8522. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BorderDiagonal">
  8523. <summary>
  8524. Get the type of border to use for the diagonal border of the cell
  8525. </summary>
  8526. </member>
  8527. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.LeftBorderColor">
  8528. <summary>
  8529. Get the color to use for the left border
  8530. </summary>
  8531. </member>
  8532. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.RightBorderColor">
  8533. <summary>
  8534. Get the color to use for the right border
  8535. </summary>
  8536. </member>
  8537. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.TopBorderColor">
  8538. <summary>
  8539. Get the color to use for the top border
  8540. </summary>
  8541. </member>
  8542. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BottomBorderColor">
  8543. <summary>
  8544. Get the color to use for the bottom border
  8545. </summary>
  8546. </member>
  8547. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.DiagonalBorderColor">
  8548. <summary>
  8549. Get the color to use for the diagonal border
  8550. </summary>
  8551. </member>
  8552. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.IsForwardDiagonalOn">
  8553. <summary>
  8554. true if forward diagonal is on
  8555. </summary>
  8556. </member>
  8557. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.IsBackwardDiagonalOn">
  8558. <summary>
  8559. true if backward diagonal Is on
  8560. </summary>
  8561. </member>
  8562. <member name="T:NPOI.HSSF.Record.CF.ColorGradientFormatting">
  8563. Color Gradient / Color Scale Conditional Formatting Rule Record.
  8564. (Called Color Gradient in the file format docs, but more commonly
  8565. Color Scale in the UI)
  8566. </member>
  8567. <member name="T:NPOI.HSSF.Record.CF.ColorGradientThreshold">
  8568. Color Gradient / Color Scale specific Threshold / value (CFVO),
  8569. for Changes in Conditional Formatting
  8570. </member>
  8571. <member name="M:NPOI.HSSF.Record.CF.ColorGradientThreshold.#ctor(NPOI.Util.ILittleEndianInput)">
  8572. Creates new Color Gradient Threshold
  8573. </member>
  8574. <member name="T:NPOI.HSSF.Record.CF.DataBarFormatting">
  8575. Data Bar Conditional Formatting Rule Record.
  8576. </member>
  8577. <member name="T:NPOI.HSSF.Record.CF.DataBarThreshold">
  8578. Data Bar specific Threshold / value (CFVO),
  8579. for Changes in Conditional Formatting
  8580. </member>
  8581. <member name="M:NPOI.HSSF.Record.CF.DataBarThreshold.#ctor(NPOI.Util.ILittleEndianInput)">
  8582. Creates new Data Bar Threshold
  8583. </member>
  8584. <member name="T:NPOI.HSSF.Record.CF.FontFormatting">
  8585. Font Formatting Block of the Conditional Formatting Rule Record.
  8586. @author Dmitriy Kumshayev
  8587. </member>
  8588. <member name="F:NPOI.HSSF.Record.CF.FontFormatting.FONT_WEIGHT_NORMAL">
  8589. Normal boldness (not bold)
  8590. </member>
  8591. <member name="F:NPOI.HSSF.Record.CF.FontFormatting.FONT_WEIGHT_BOLD">
  8592. Bold boldness (bold)
  8593. </member>
  8594. <member name="M:NPOI.HSSF.Record.CF.FontFormatting.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8595. Creates new FontFormatting
  8596. </member>
  8597. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.FontHeight">
  8598. Gets the height of the font in 1/20th point Units
  8599. @return fontheight (in points/20); or -1 if not modified
  8600. </member>
  8601. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.IsItalic">
  8602. Get whether the font Is to be italics or not
  8603. @return italics - whether the font Is italics or not
  8604. @see #GetAttributes()
  8605. </member>
  8606. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.IsStruckout">
  8607. Get whether the font Is to be stricken out or not
  8608. @return strike - whether the font Is stricken out or not
  8609. @see #GetAttributes()
  8610. </member>
  8611. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.FontWeight">
  8612. <summary>
  8613. Get or set the font weight for this font (100-1000dec or 0x64-0x3e8).
  8614. Default Is 0x190 for normal and 0x2bc for bold
  8615. </summary>
  8616. </member>
  8617. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.IsBold">
  8618. <summary>
  8619. Get or set whether the font weight is set to bold or not
  8620. </summary>
  8621. </member>
  8622. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.EscapementType">
  8623. Get the type of base or subscript for the font
  8624. @return base or subscript option
  8625. @see org.apache.poi.hssf.usermodel.HSSFFontFormatting#SS_NONE
  8626. @see org.apache.poi.hssf.usermodel.HSSFFontFormatting#SS_SUPER
  8627. @see org.apache.poi.hssf.usermodel.HSSFFontFormatting#SS_SUB
  8628. </member>
  8629. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.UnderlineType">
  8630. Get the type of Underlining for the font
  8631. @return font Underlining type
  8632. </member>
  8633. <member name="T:NPOI.HSSF.Record.CF.IconMultiStateFormatting">
  8634. Icon / Multi-State Conditional Formatting Rule Record.
  8635. </member>
  8636. <member name="T:NPOI.HSSF.Record.CF.IconMultiStateThreshold">
  8637. Icon / Multi-State specific Threshold / value (CFVO),
  8638. for Changes in Conditional Formatting
  8639. </member>
  8640. <member name="F:NPOI.HSSF.Record.CF.IconMultiStateThreshold.EQUALS_EXCLUDE">
  8641. Cell values that are equal to the threshold value do not pass the threshold
  8642. </member>
  8643. <member name="F:NPOI.HSSF.Record.CF.IconMultiStateThreshold.EQUALS_INCLUDE">
  8644. Cell values that are equal to the threshold value pass the threshold.
  8645. </member>
  8646. <member name="M:NPOI.HSSF.Record.CF.IconMultiStateThreshold.#ctor(NPOI.Util.ILittleEndianInput)">
  8647. Creates new Ico Multi-State Threshold
  8648. </member>
  8649. <member name="T:NPOI.HSSF.Record.CF.PatternFormatting">
  8650. Pattern Formatting Block of the Conditional Formatting Rule Record.
  8651. @author Dmitriy Kumshayev
  8652. </member>
  8653. <member name="M:NPOI.HSSF.Record.CF.PatternFormatting.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8654. Creates new FontFormatting
  8655. </member>
  8656. <member name="P:NPOI.HSSF.Record.CF.PatternFormatting.FillPattern">
  8657. Get the Fill pattern
  8658. @return Fill pattern
  8659. </member>
  8660. <member name="P:NPOI.HSSF.Record.CF.PatternFormatting.FillBackgroundColor">
  8661. Get the background Fill color
  8662. @see org.apache.poi.hssf.usermodel.HSSFPalette#GetColor(short)
  8663. @return Fill color
  8664. </member>
  8665. <member name="P:NPOI.HSSF.Record.CF.PatternFormatting.FillForegroundColor">
  8666. Get the foreground Fill color
  8667. @see org.apache.poi.hssf.usermodel.HSSFPalette#GetColor(short)
  8668. @return Fill color
  8669. </member>
  8670. <member name="T:NPOI.HSSF.Record.CF.Threshold">
  8671. Threshold / value (CFVO) for Changes in Conditional Formatting
  8672. </member>
  8673. <member name="M:NPOI.HSSF.Record.CF.Threshold.#ctor(NPOI.Util.ILittleEndianInput)">
  8674. Creates new Threshold
  8675. </member>
  8676. <member name="T:NPOI.HSSF.Record.Chart.AlRunsRecord">
  8677. <summary>
  8678. The AlRuns record specifies Rich Text Formatting within chart
  8679. titles (section 2.2.3.3), trendline (section 2.2.3.12), and
  8680. data labels (section 2.2.3.11).
  8681. </summary>
  8682. </member>
  8683. <member name="T:NPOI.HSSF.Record.Chart.AreaFormatRecord">
  8684. * The area format record is used to define the colours and patterns for an area.
  8685. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  8686. * Remove the record in src/records/definitions.
  8687. * @author Glen Stampoultzis (glens at apache.org)
  8688. </member>
  8689. <member name="M:NPOI.HSSF.Record.Chart.AreaFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8690. Constructs a AreaFormat record and s its fields appropriately.
  8691. @param in the RecordInputstream to Read the record from
  8692. </member>
  8693. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.DataSize">
  8694. Size of record (exluding 4 byte header)
  8695. </member>
  8696. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.ForegroundColor">
  8697. the foreground color field for the AreaFormat record.
  8698. </member>
  8699. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.BackgroundColor">
  8700. the background color field for the AreaFormat record.
  8701. </member>
  8702. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.Pattern">
  8703. the pattern field for the AreaFormat record.
  8704. </member>
  8705. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.FormatFlags">
  8706. the format flags field for the AreaFormat record.
  8707. </member>
  8708. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.ForecolorIndex">
  8709. the forecolor index field for the AreaFormat record.
  8710. </member>
  8711. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.BackcolorIndex">
  8712. the backcolor index field for the AreaFormat record.
  8713. </member>
  8714. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.IsAutomatic">
  8715. automatic formatting
  8716. @return the automatic field value.
  8717. </member>
  8718. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.IsInvert">
  8719. swap foreground and background colours when data is negative
  8720. @return the invert field value.
  8721. </member>
  8722. <member name="T:NPOI.HSSF.Record.Chart.AreaRecord">
  8723. * The area record is used to define a area chart.
  8724. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  8725. * Remove the record in src/records/definitions.
  8726. * @author Glen Stampoultzis (glens at apache.org)
  8727. </member>
  8728. <member name="M:NPOI.HSSF.Record.Chart.AreaRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8729. Constructs a Area record and s its fields appropriately.
  8730. @param in the RecordInputstream to Read the record from
  8731. </member>
  8732. <member name="P:NPOI.HSSF.Record.Chart.AreaRecord.DataSize">
  8733. Size of record (exluding 4 byte header)
  8734. </member>
  8735. <member name="P:NPOI.HSSF.Record.Chart.AreaRecord.FormatFlags">
  8736. the format flags field for the Area record.
  8737. </member>
  8738. <member name="P:NPOI.HSSF.Record.Chart.AreaRecord.IsStacked">
  8739. series is stacked
  8740. @return the stacked field value.
  8741. </member>
  8742. <member name="P:NPOI.HSSF.Record.Chart.AreaRecord.IsDisplayAsPercentage">
  8743. results Displayed as percentages
  8744. @return the Display as percentage field value.
  8745. </member>
  8746. <member name="P:NPOI.HSSF.Record.Chart.AreaRecord.IsShadow">
  8747. Display a shadow for the chart
  8748. @return the shadow field value.
  8749. </member>
  8750. <member name="T:NPOI.HSSF.Record.Chart.AttachedLabelRecord">
  8751. * The series label record defines the type of label associated with the data format record.
  8752. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  8753. * Remove the record in src/records/definitions.
  8754. * @author Glen Stampoultzis (glens at apache.org)
  8755. </member>
  8756. <member name="M:NPOI.HSSF.Record.Chart.AttachedLabelRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8757. Constructs a SeriesLabels record and Sets its fields appropriately.
  8758. @param in the RecordInputstream to Read the record from
  8759. </member>
  8760. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.DataSize">
  8761. Size of record (exluding 4 byte header)
  8762. </member>
  8763. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.FormatFlags">
  8764. Get the format flags field for the SeriesLabels record.
  8765. </member>
  8766. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsShowActual">
  8767. show actual value of the data point
  8768. @return the show actual field value.
  8769. </member>
  8770. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsShowPercent">
  8771. show value as percentage of total (pie charts only)
  8772. @return the show percent field value.
  8773. </member>
  8774. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsLabelAsPercentage">
  8775. show category label/value as percentage (pie charts only)
  8776. @return the label as percentage field value.
  8777. </member>
  8778. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsSmoothedLine">
  8779. show smooth line
  8780. @return the smoothed line field value.
  8781. </member>
  8782. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsShowLabel">
  8783. Display category label
  8784. @return the show label field value.
  8785. </member>
  8786. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsShowBubbleSizes">
  8787. ??
  8788. @return the show bubble sizes field value.
  8789. </member>
  8790. <member name="T:NPOI.HSSF.Record.Chart.AxcExtRecord">
  8791. <summary>
  8792. The AxcExt record specifies additional extension properties of a date axis (section 2.2.3.6),
  8793. along with a CatSerRange record (section 2.4.39).
  8794. </summary>
  8795. </member>
  8796. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.MajorInterval">
  8797. <summary>
  8798. specifies the interval at which the major tick marks are displayed on the axis (section 2.2.3.6),
  8799. in the unit defined by duMajor.
  8800. </summary>
  8801. </member>
  8802. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.MajorUnit">
  8803. <summary>
  8804. 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).
  8805. If fDateAxis is set to 0, MUST be ignored.
  8806. </summary>
  8807. </member>
  8808. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.MinorInterval">
  8809. <summary>
  8810. specifies the interval at which the minor tick marks are displayed on the axis (section 2.2.3.6),
  8811. in a unit defined by duMinor.
  8812. </summary>
  8813. </member>
  8814. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.BaseUnit">
  8815. <summary>
  8816. specifies the smallest unit of time used by the axis (section 2.2.3.6).
  8817. </summary>
  8818. </member>
  8819. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.CrossDate">
  8820. <summary>
  8821. specifies at which date, as a date in the date system specified by the Date1904 record (section 2.4.77),
  8822. in the units defined by duBase, the value axis (section 2.2.3.6) crosses this axis (section 2.2.3.6).
  8823. </summary>
  8824. </member>
  8825. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.IsAutoMin">
  8826. <summary>
  8827. specifies whether MinimumDate is calculated automatically.
  8828. </summary>
  8829. </member>
  8830. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.IsAutoMax">
  8831. <summary>
  8832. specifies whether MaximumDate is calculated automatically.
  8833. </summary>
  8834. </member>
  8835. <member name="T:NPOI.HSSF.Record.Chart.AxesUsedRecord">
  8836. * The number of axes used on a chart.
  8837. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  8838. * Remove the record in src/records/definitions.
  8839. * @author Glen Stampoultzis (glens at apache.org)
  8840. </member>
  8841. <member name="M:NPOI.HSSF.Record.Chart.AxesUsedRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8842. Constructs a AxisUsed record and Sets its fields appropriately.
  8843. @param in the RecordInputstream to Read the record from
  8844. </member>
  8845. <member name="P:NPOI.HSSF.Record.Chart.AxesUsedRecord.DataSize">
  8846. Size of record (exluding 4 byte header)
  8847. </member>
  8848. <member name="P:NPOI.HSSF.Record.Chart.AxesUsedRecord.NumAxis">
  8849. Get the num axis field for the AxisUsed record.
  8850. </member>
  8851. <member name="F:NPOI.HSSF.Record.Chart.AxisLineType.AxisLine">
  8852. <summary>
  8853. The axis (section 2.2.3.6) line itself.
  8854. </summary>
  8855. </member>
  8856. <member name="F:NPOI.HSSF.Record.Chart.AxisLineType.MajorGridLine">
  8857. <summary>
  8858. The major gridlines along the axis
  8859. </summary>
  8860. </member>
  8861. <member name="F:NPOI.HSSF.Record.Chart.AxisLineType.MinorGridLine">
  8862. <summary>
  8863. The minor gridlines along the axis
  8864. </summary>
  8865. </member>
  8866. <member name="F:NPOI.HSSF.Record.Chart.AxisLineType.WallsOrFloorOf3D">
  8867. <summary>
  8868. The walls or floor of a 3-D chart
  8869. </summary>
  8870. </member>
  8871. <member name="T:NPOI.HSSF.Record.Chart.AxisLineFormatRecord">
  8872. <summary>
  8873. The AxisLine record specifies which part of the axis (section 2.2.3.6) is
  8874. specified by the LineFormat record (section 2.4.156) that follows.
  8875. Excel Binary File Format (.xls) Structure Specification
  8876. </summary>
  8877. </member>
  8878. <member name="M:NPOI.HSSF.Record.Chart.AxisLineFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8879. Constructs a AxisLineFormat record and Sets its fields appropriately.
  8880. @param in the RecordInputstream to Read the record from
  8881. </member>
  8882. <member name="P:NPOI.HSSF.Record.Chart.AxisLineFormatRecord.DataSize">
  8883. Size of record (exluding 4 byte header)
  8884. </member>
  8885. <member name="P:NPOI.HSSF.Record.Chart.AxisLineFormatRecord.AxisType">
  8886. <summary>
  8887. </summary>
  8888. </member>
  8889. <member name="T:NPOI.HSSF.Record.Chart.AxisOptionsRecord">
  8890. The axis options record provides unit information and other various tidbits about the axis.<p/>
  8891. @author Andrew C. Oliver(acoliver at apache.org)
  8892. </member>
  8893. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.MinimumCategory">
  8894. Get the minimum category field for the AxisOptions record.
  8895. </member>
  8896. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.MaximumCategory">
  8897. Get the maximum category field for the AxisOptions record.
  8898. </member>
  8899. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.MajorUnitValue">
  8900. Get the major unit value field for the AxisOptions record.
  8901. </member>
  8902. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.MajorUnit">
  8903. Get the major unit field for the AxisOptions record.
  8904. </member>
  8905. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.MinorUnitValue">
  8906. Get the minor unit value field for the AxisOptions record.
  8907. </member>
  8908. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.MinorUnit">
  8909. Get the minor unit field for the AxisOptions record.
  8910. </member>
  8911. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.BaseUnit">
  8912. Get the base unit field for the AxisOptions record.
  8913. </member>
  8914. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.CrossingPoint">
  8915. Get the crossing point field for the AxisOptions record.
  8916. </member>
  8917. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.Options">
  8918. Get the options field for the AxisOptions record.
  8919. </member>
  8920. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.IsDefaultMinimum">
  8921. use the default minimum category
  8922. @return the default minimum field value.
  8923. </member>
  8924. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.IsDefaultMaximum">
  8925. use the default maximum category
  8926. @return the default maximum field value.
  8927. </member>
  8928. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.IsDefaultMajor">
  8929. use the default major unit
  8930. @return the default major field value.
  8931. </member>
  8932. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.IsDefaultMinorUnit">
  8933. use the default minor unit
  8934. @return the default minor unit field value.
  8935. </member>
  8936. <member name="M:NPOI.HSSF.Record.Chart.AxisOptionsRecord.SetIsDate(System.Boolean)">
  8937. Sets the isDate field value.
  8938. this is a date axis
  8939. </member>
  8940. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.IsIsDate">
  8941. this is a date axis
  8942. @return the isDate field value.
  8943. </member>
  8944. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.IsDefaultBase">
  8945. use the default base unit
  8946. @return the default base field value.
  8947. </member>
  8948. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.IsDefaultCross">
  8949. use the default crossing point
  8950. @return the default cross field value.
  8951. </member>
  8952. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.IsDefaultDateSettings">
  8953. use default date Setttings for this axis
  8954. @return the default date Settings field value.
  8955. </member>
  8956. <member name="T:NPOI.HSSF.Record.Chart.AxisParentRecord">
  8957. * The axis size and location
  8958. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  8959. * Remove the record in src/records/definitions.
  8960. * @author Glen Stampoultzis (glens at apache.org)
  8961. </member>
  8962. <member name="M:NPOI.HSSF.Record.Chart.AxisParentRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8963. Constructs a AxisParent record and s its fields appropriately.
  8964. @param in the RecordInputstream to Read the record from
  8965. </member>
  8966. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.DataSize">
  8967. Size of record (exluding 4 byte header)
  8968. </member>
  8969. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.AxisType">
  8970. the axis type field for the AxisParent record.
  8971. @return One of
  8972. AXIS_TYPE_MAIN
  8973. AXIS_TYPE_SECONDARY
  8974. </member>
  8975. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.X">
  8976. the x field for the AxisParent record.
  8977. </member>
  8978. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.Y">
  8979. the y field for the AxisParent record.
  8980. </member>
  8981. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.Width">
  8982. the width field for the AxisParent record.
  8983. </member>
  8984. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.Height">
  8985. the height field for the AxisParent record.
  8986. </member>
  8987. <member name="T:NPOI.HSSF.Record.Chart.AxisRecord">
  8988. * The axis record defines the type of an axis.
  8989. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  8990. * Remove the record in src/records/definitions.
  8991. * @author Glen Stampoultzis (glens at apache.org)
  8992. </member>
  8993. <member name="M:NPOI.HSSF.Record.Chart.AxisRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8994. Constructs a Axis record and Sets its fields appropriately.
  8995. @param in the RecordInputstream to Read the record from
  8996. </member>
  8997. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.DataSize">
  8998. Size of record (exluding 4 byte header)
  8999. </member>
  9000. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.AxisType">
  9001. Get the axis type field for the Axis record.
  9002. @return One of
  9003. AXIS_TYPE_CATEGORY_OR_X_AXIS
  9004. AXIS_TYPE_VALUE_AXIS
  9005. AXIS_TYPE_SERIES_AXIS
  9006. </member>
  9007. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.Reserved1">
  9008. Get the reserved1 field for the Axis record.
  9009. </member>
  9010. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.Reserved2">
  9011. Get the reserved2 field for the Axis record.
  9012. </member>
  9013. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.Reserved3">
  9014. Get the reserved3 field for the Axis record.
  9015. </member>
  9016. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.Reserved4">
  9017. Get the reserved4 field for the Axis record.
  9018. </member>
  9019. <member name="T:NPOI.HSSF.Record.Chart.AxisUsedRecord">
  9020. * The number of axes used on a chart.
  9021. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  9022. * Remove the record in src/records/definitions.
  9023. * @author Glen Stampoultzis (glens at apache.org)
  9024. </member>
  9025. <member name="M:NPOI.HSSF.Record.Chart.AxisUsedRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9026. Constructs a AxisUsed record and Sets its fields appropriately.
  9027. @param in the RecordInputstream to Read the record from
  9028. </member>
  9029. <member name="P:NPOI.HSSF.Record.Chart.AxisUsedRecord.DataSize">
  9030. Size of record (exluding 4 byte header)
  9031. </member>
  9032. <member name="P:NPOI.HSSF.Record.Chart.AxisUsedRecord.NumAxis">
  9033. Get the num axis field for the AxisUsed record.
  9034. </member>
  9035. <member name="T:NPOI.HSSF.Record.Chart.BarRecord">
  9036. * The bar record is used to define a bar chart.
  9037. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  9038. * Remove the record in src/records/definitions.
  9039. * @author Glen Stampoultzis (glens at apache.org)
  9040. </member>
  9041. <member name="M:NPOI.HSSF.Record.Chart.BarRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9042. Constructs a Bar record and s its fields appropriately.
  9043. @param in the RecordInputstream to Read the record from
  9044. </member>
  9045. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.DataSize">
  9046. Size of record (exluding 4 byte header)
  9047. </member>
  9048. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.BarSpace">
  9049. the bar space field for the Bar record.
  9050. </member>
  9051. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.CategorySpace">
  9052. the category space field for the Bar record.
  9053. </member>
  9054. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.FormatFlags">
  9055. the format flags field for the Bar record.
  9056. </member>
  9057. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.IsHorizontal">
  9058. true to Display horizontal bar charts, false for vertical
  9059. @return the horizontal field value.
  9060. </member>
  9061. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.IsStacked">
  9062. stack Displayed values
  9063. @return the stacked field value.
  9064. </member>
  9065. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.IsDisplayAsPercentage">
  9066. Display chart values as a percentage
  9067. @return the Display as percentage field value.
  9068. </member>
  9069. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.IsShadow">
  9070. Display a shadow for the chart
  9071. @return the shadow field value.
  9072. </member>
  9073. <member name="T:NPOI.HSSF.Record.Chart.BeginRecord">
  9074. The begin record defines the start of a block of records for a (grpahing
  9075. data object. This record is matched with a corresponding EndRecord.
  9076. @see EndRecord
  9077. @author Glen Stampoultzis (glens at apache.org)
  9078. </member>
  9079. <member name="M:NPOI.HSSF.Record.Chart.BeginRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9080. Constructs a BeginRecord record and Sets its fields appropriately.
  9081. @param in the RecordInputstream to Read the record from
  9082. </member>
  9083. <member name="T:NPOI.HSSF.Record.Chart.BopPopCustomRecord">
  9084. <summary>
  9085. The BopPopCustom record specifies which data points in the series are contained
  9086. in the secondary bar/pie instead of the primary pie. MUST follow a BopPop record
  9087. that has its split field set to Custom (0x0003).
  9088. </summary>
  9089. <remarks>
  9090. author: Antony liu (antony.apollo at gmail.com)
  9091. </remarks>
  9092. </member>
  9093. <member name="T:NPOI.HSSF.Record.Chart.BopPopRecord">
  9094. <summary>
  9095. The BopPop record specifies that the chart group is a bar of pie chart group or
  9096. a pie of pie chart group and specifies the chart group attributes.
  9097. </summary>
  9098. <remarks>
  9099. author: Antony liu (antony.apollo at gmail.com)
  9100. </remarks>
  9101. </member>
  9102. <member name="T:NPOI.HSSF.Record.Chart.BRAIRecord">
  9103. <summary>
  9104. The BRAI record specifies a reference to data in a sheet (1) that is used by a part of a series,
  9105. legend entry, trendline or error bars.
  9106. </summary>
  9107. </member>
  9108. <member name="F:NPOI.HSSF.Record.Chart.BRAIRecord.field_5_formulaOfLink">
  9109. <summary>
  9110. A ChartParsedFormula structure that specifies the formula (section 2.2.2) that specifies the reference.
  9111. </summary>
  9112. </member>
  9113. <member name="M:NPOI.HSSF.Record.Chart.BRAIRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9114. Constructs a LinkedData record and Sets its fields appropriately.
  9115. @param in the RecordInputstream to Read the record from
  9116. </member>
  9117. <member name="P:NPOI.HSSF.Record.Chart.BRAIRecord.DataSize">
  9118. Size of record (exluding 4 byte header)
  9119. </member>
  9120. <member name="P:NPOI.HSSF.Record.Chart.BRAIRecord.LinkType">
  9121. <summary>
  9122. specifies the part of the series, trendline, or error bars the referenced data specifies.
  9123. </summary>
  9124. </member>
  9125. <member name="P:NPOI.HSSF.Record.Chart.BRAIRecord.IndexNumberFmtRecord">
  9126. <summary>
  9127. specifies the number format to use for the data.
  9128. </summary>
  9129. </member>
  9130. <member name="T:NPOI.HSSF.Record.Chart.CategorySeriesAxisRecord">
  9131. This record refers to a category or series axis and is used to specify label/tickmark frequency.<p/>
  9132. @author Glen Stampoultzis (glens at apache.org)
  9133. </member>
  9134. <member name="P:NPOI.HSSF.Record.Chart.CategorySeriesAxisRecord.CrossingPoint">
  9135. Get the crossing point field for the CategorySeriesAxis record.
  9136. </member>
  9137. <member name="P:NPOI.HSSF.Record.Chart.CategorySeriesAxisRecord.LabelFrequency">
  9138. Get the label frequency field for the CategorySeriesAxis record.
  9139. </member>
  9140. <member name="P:NPOI.HSSF.Record.Chart.CategorySeriesAxisRecord.TickMarkFrequency">
  9141. Get the tick mark frequency field for the CategorySeriesAxis record.
  9142. </member>
  9143. <member name="P:NPOI.HSSF.Record.Chart.CategorySeriesAxisRecord.Options">
  9144. Get the options field for the CategorySeriesAxis record.
  9145. </member>
  9146. <member name="P:NPOI.HSSF.Record.Chart.CategorySeriesAxisRecord.IsValueAxisCrossing">
  9147. Set true to indicate axis crosses between categories and false to cross axis midway
  9148. @return the value axis crossing field value.
  9149. </member>
  9150. <member name="P:NPOI.HSSF.Record.Chart.CategorySeriesAxisRecord.IsCrossesFarRight">
  9151. axis crosses at the far right
  9152. @return the crosses far right field value.
  9153. </member>
  9154. <member name="P:NPOI.HSSF.Record.Chart.CategorySeriesAxisRecord.IsReversed">
  9155. categories are displayed in reverse order
  9156. @return the reversed field value.
  9157. </member>
  9158. <member name="T:NPOI.HSSF.Record.Chart.CatLabRecord">
  9159. CATLAB - Category Labels (0x0856)<br/>
  9160. @author Patrick Cheng
  9161. </member>
  9162. <member name="T:NPOI.HSSF.Record.Chart.CatSerRangeRecord">
  9163. <summary>
  9164. specifies the properties of a category (3) axis, a date axis, or a series axis.
  9165. </summary>
  9166. </member>
  9167. <member name="M:NPOI.HSSF.Record.Chart.CatSerRangeRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9168. Constructs a CategorySeriesAxis record and Sets its fields appropriately.
  9169. @param in the RecordInputstream to Read the record from
  9170. </member>
  9171. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.DataSize">
  9172. Size of record (exluding 4 byte header)
  9173. </member>
  9174. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.CrossPoint">
  9175. <summary>
  9176. specifies where the value axis crosses this axis, based on the following table.
  9177. If fMaxCross is set to 1, the value this field MUST be ignored.
  9178. Category (3) axis This field specifies the category (3) at which the value axis crosses.
  9179. For example, if this field is 2, the value axis crosses this axis at the second category (3)
  9180. on this axis. MUST be greater than or equal to 1 and less than or equal to 31999.
  9181. Series axis MUST be 0.
  9182. Date axis catCross MUST be equal to the value given by the following formula:
  9183. catCross = catCrossDate ¨C catMin + 1
  9184. Where catCrossDate is the catCrossDate field of the AxcExt record
  9185. and catMin is the catMin field of the AxcExt record.
  9186. </summary>
  9187. </member>
  9188. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.LabelInterval">
  9189. <summary>
  9190. specifies the interval between axis labels on this axis. MUST be greater than or equal to 1 and
  9191. less than or equal to 31999. MUST be ignored for a date axis.
  9192. </summary>
  9193. </member>
  9194. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.MarkInterval">
  9195. <summary>
  9196. specifies the interval at which major tick marks and minor tick marks are displayed on the axis.
  9197. Major tick marks and minor tick marks that would have been visible are hidden unless they are
  9198. located at a multiple of this field.
  9199. </summary>
  9200. </member>
  9201. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.IsBetween">
  9202. <summary>
  9203. specifies whether the value axis crosses this axis between major tick marks. MUST be a value from to following table:
  9204. 0 The value axis crosses this axis on a major tick mark.
  9205. 1 The value axis crosses this axis between major tick marks.
  9206. </summary>
  9207. </member>
  9208. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.IsMaxCross">
  9209. <summary>
  9210. specifies whether the value axis crosses this axis at the last category (3), the last series,
  9211. or the maximum date. MUST be a value from the following table:
  9212. 0 The value axis crosses this axis at the value specified by catCross.
  9213. 1 The value axis crosses this axis at the last category (3), the last series, or the maximum date.
  9214. </summary>
  9215. </member>
  9216. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.IsReverse">
  9217. <summary>
  9218. specifies whether the axis is displayed in reverse order. MUST be a value from the following table:
  9219. 0 The axis is displayed in order.
  9220. 1 The axis is display in reverse order.
  9221. </summary>
  9222. </member>
  9223. <member name="P:NPOI.HSSF.Record.Chart.Chart3DBarShapeRecord.Riser">
  9224. <summary>
  9225. the shape of the base of the data points in a bar or column chart group.
  9226. MUST be a value from the following table
  9227. 0x00 The base of the data point is a rectangle.
  9228. 0x01 The base of the data point is an ellipse.
  9229. </summary>
  9230. </member>
  9231. <member name="P:NPOI.HSSF.Record.Chart.Chart3DBarShapeRecord.Taper">
  9232. <summary>
  9233. how the data points in a bar or column chart group taper from base to tip.
  9234. MUST be a value from the following
  9235. 0x00 The data points of the bar or column chart group do not taper.
  9236. The shape at the maximum value of the data point is the same as the shape at the base.:
  9237. 0x01 The data points of the bar or column chart group taper to a point at the maximum value of each data point.
  9238. 0x02 The data points of the bar or column chart group taper towards a projected point at the position of
  9239. the maximum value of all of the data points in the chart group, but are clipped at the value of each data point.
  9240. </summary>
  9241. </member>
  9242. <member name="T:NPOI.HSSF.Record.Chart.Chart3dRecord">
  9243. <summary>
  9244. The Chart3d record specifies that the plot area of the chart group is rendered in a 3-D scene
  9245. and also specifies the attributes of the 3-D plot area. The preceding chart group type MUST be
  9246. of type bar, pie, line, area, or surface.
  9247. </summary>
  9248. <remarks>
  9249. author: Antony liu (antony.apollo at gmail.com)
  9250. </remarks>
  9251. </member>
  9252. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Rotation">
  9253. <summary>
  9254. A signed integer that specifies the clockwise rotation, in degrees, of the 3-D plot area
  9255. around a vertical line through the center of the 3-D plot area. MUST be greater than or
  9256. equal to 0 and MUST be less than or equal to 360.
  9257. </summary>
  9258. </member>
  9259. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Elev">
  9260. <summary>
  9261. A signed integer that specifies the rotation, in degrees, of the 3-D plot area around
  9262. a horizontal line through the center of the 3-D plot area.MUST be greater than or equal
  9263. to -90 and MUST be less than or equal to 90.
  9264. </summary>
  9265. </member>
  9266. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Dist">
  9267. <summary>
  9268. A signed integer that specifies the field of view angle for the 3-D plot area.
  9269. MUST be greater than or equal to zero and less than 200.
  9270. </summary>
  9271. </member>
  9272. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Height">
  9273. <summary>
  9274. If fNotPieChart is 0, then this is an unsigned integer that specifies the thickness of the pie for a pie chart group.
  9275. 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.
  9276. </summary>
  9277. </member>
  9278. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Depth">
  9279. <summary>
  9280. A signed integer that specifies the depth of the 3-D plot area as a percentage of its width.
  9281. MUST be greater than or equal to 1 and less than or equal to 2000.
  9282. </summary>
  9283. </member>
  9284. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Gap">
  9285. <summary>
  9286. An unsigned integer that specifies the width of the gap between the series and the front and
  9287. back edges of the 3-D plot area as a percentage of the data point depth divided by 2.
  9288. If fCluster is not 1 and chart group type is not a bar then pcGap also specifies distance
  9289. between adjacent series as a percentage of the data point depth. MUST be less than or equal to 500.
  9290. </summary>
  9291. </member>
  9292. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.IsPerspective">
  9293. <summary>
  9294. A bit that specifies whether the 3-D plot area is rendered with a vanishing point.
  9295. If fNotPieChart is 0 the value MUST be 0. If fNotPieChart is 1 then the value
  9296. MUST be a value from the following
  9297. true Perspective vanishing point applied based on value of pcDist.
  9298. false No vanishing point applied.
  9299. </summary>
  9300. </member>
  9301. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.IsCluster">
  9302. <summary>
  9303. specifies whether data points are clustered together in a bar chart group.
  9304. If chart group type is not bar or pie, value MUST be ignored. If chart group type is pie,
  9305. value MUST be 0. If chart group type is bar, then the value MUST be a value from the following
  9306. true Data points are clustered.
  9307. false Data points are not clustered.
  9308. </summary>
  9309. </member>
  9310. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Is3DScaling">
  9311. <summary>
  9312. A bit that specifies whether the height of the 3-D plot area is automatically determined.
  9313. If fNotPieChart is 0 then this MUST be 0. If fNotPieChart is 1 then the value MUST be a value from the following table:
  9314. false The value of pcHeight is used to determine the height of the 3-D plot area
  9315. true The height of the 3-D plot area is automatically determined
  9316. </summary>
  9317. </member>
  9318. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.IsNotPieChart">
  9319. <summary>
  9320. A bit that specifies whether the chart group type is pie. MUST be a value from the following :
  9321. false Chart group type MUST be pie.
  9322. true Chart group type MUST not be pie.
  9323. </summary>
  9324. </member>
  9325. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.IsWalls2D">
  9326. <summary>
  9327. Whether the walls are rendered in 2-D. If fPerspective is 1 then this MUST be ignored.
  9328. If the chart group type is not bar, area or pie this MUST be ignored.
  9329. If the chart group is of type bar and fCluster is 0, then this MUST be ignored.
  9330. If the chart group type is pie this MUST be 0 and MUST be ignored.
  9331. If the chart group type is bar or area, then the value MUST be a value from the following
  9332. false Chart walls and floor are rendered in 3D.
  9333. true Chart walls are rendered in 2D and the chart floor is not rendered.
  9334. </summary>
  9335. </member>
  9336. <member name="T:NPOI.HSSF.Record.Chart.ChartEndBlockRecord">
  9337. ENDBLOCK - Chart Future Record Type End Block (0x0853)<br/>
  9338. @author Patrick Cheng
  9339. </member>
  9340. <member name="T:NPOI.HSSF.Record.Chart.ChartEndObjectRecord">
  9341. ENDOBJECT - Chart Future Record Type End Object (0x0855)<br/>
  9342. @author Patrick Cheng
  9343. </member>
  9344. <member name="T:NPOI.HSSF.Record.Chart.ChartFRTInfoRecord">
  9345. <summary>
  9346. The ChartFrtInfo record specifies the versions of the application that originally created and last saved the file.
  9347. </summary>
  9348. </member>
  9349. <member name="T:NPOI.HSSF.Record.Chart.ChartRecord">
  9350. * The chart record is used to define the location and size of a chart.
  9351. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  9352. * Remove the record in src/records/definitions.
  9353. * @author Glen Stampoultzis (glens at apache.org)
  9354. </member>
  9355. <member name="M:NPOI.HSSF.Record.Chart.ChartRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9356. Constructs a Chart record and Sets its fields appropriately.
  9357. @param in the RecordInputstream to Read the record from
  9358. </member>
  9359. <member name="P:NPOI.HSSF.Record.Chart.ChartRecord.DataSize">
  9360. Size of record (exluding 4 byte header)
  9361. </member>
  9362. <member name="P:NPOI.HSSF.Record.Chart.ChartRecord.X">
  9363. Get the x field for the Chart record.
  9364. </member>
  9365. <member name="P:NPOI.HSSF.Record.Chart.ChartRecord.Y">
  9366. Get the y field for the Chart record.
  9367. </member>
  9368. <member name="P:NPOI.HSSF.Record.Chart.ChartRecord.Width">
  9369. Get the width field for the Chart record.
  9370. </member>
  9371. <member name="P:NPOI.HSSF.Record.Chart.ChartRecord.Height">
  9372. Get the height field for the Chart record.
  9373. </member>
  9374. <member name="T:NPOI.HSSF.Record.Chart.ChartStartBlockRecord">
  9375. STARTBLOCK - Chart Future Record Type Start Block (0x0852)<br/>
  9376. @author Patrick Cheng
  9377. </member>
  9378. <member name="T:NPOI.HSSF.Record.Chart.ChartStartObjectRecord">
  9379. STARTOBJECT - Chart Future Record Type Start Object (0x0854)<br/>
  9380. @author Patrick Cheng
  9381. </member>
  9382. <member name="T:NPOI.HSSF.Record.Chart.ChartTitleFormatRecord">
  9383. Describes the formatting runs associated with a chart title.
  9384. </member>
  9385. <member name="T:NPOI.HSSF.Record.Chart.CrtLayout12ARecord">
  9386. <summary>
  9387. The CrtLayout12A record specifies layout information for a plot area.
  9388. </summary>
  9389. <remarks>
  9390. author: Antony liu (antony.apollo at gmail.com)
  9391. </remarks>
  9392. </member>
  9393. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.IsLayoutTargetInner">
  9394. <summary>
  9395. specifies the type of plot area for the layout target.
  9396. false Outer plot area - The bounding rectangle that includes the axis labels, axis titles, data table (2) and plot area of the chart.
  9397. true Inner plot area – The rectangle bounded by the chart axes.
  9398. </summary>
  9399. </member>
  9400. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.CheckSum">
  9401. <summary>
  9402. specifies the checksum
  9403. </summary>
  9404. </member>
  9405. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.XTL">
  9406. <summary>
  9407. specifies the horizontal offset of the plot area’s upper-left corner, relative to the upper-left corner of the chart area
  9408. </summary>
  9409. </member>
  9410. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.YTL">
  9411. <summary>
  9412. specifies the vertical offset of the plot area’s upper-left corner, relative to the upper-left corner of the chart area
  9413. </summary>
  9414. </member>
  9415. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.XBR">
  9416. <summary>
  9417. specifies the width of the plot area
  9418. </summary>
  9419. </member>
  9420. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.YBR">
  9421. <summary>
  9422. specifies the height of the plot area
  9423. </summary>
  9424. </member>
  9425. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.XMode">
  9426. <summary>
  9427. A CrtLayout12Mode structure that specifies the meaning of x.
  9428. </summary>
  9429. </member>
  9430. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.YMode">
  9431. <summary>
  9432. A CrtLayout12Mode structure that specifies the meaning of y.
  9433. </summary>
  9434. </member>
  9435. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.WidthMode">
  9436. <summary>
  9437. A CrtLayout12Mode structure that specifies the meaning of dx.
  9438. </summary>
  9439. </member>
  9440. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.HeightMode">
  9441. <summary>
  9442. A CrtLayout12Mode structure that specifies the meaning of dy.
  9443. </summary>
  9444. </member>
  9445. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.X">
  9446. <summary>
  9447. An Xnum (section 2.5.342) value that specifies a horizontal offset. The meaning is determined by wXMode.
  9448. </summary>
  9449. </member>
  9450. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.Y">
  9451. <summary>
  9452. An Xnum value that specifies a vertical offset. The meaning is determined by wYMode.
  9453. </summary>
  9454. </member>
  9455. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.DX">
  9456. <summary>
  9457. An Xnum value that specifies a width or an horizontal offset. The meaning is determined by wWidthMode.
  9458. </summary>
  9459. </member>
  9460. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.DY">
  9461. <summary>
  9462. An Xnum value that specifies a height or an vertical offset. The meaning is determined by wHeightMode.
  9463. </summary>
  9464. </member>
  9465. <member name="T:NPOI.HSSF.Record.Chart.CrtLayout12Mode">
  9466. <summary>
  9467. The CrtLayout12Mode specifies a layout mode. Each layout mode specifies a different
  9468. meaning of the x, y, dx, and dy fields of CrtLayout12 and CrtLayout12A.
  9469. </summary>
  9470. </member>
  9471. <member name="F:NPOI.HSSF.Record.Chart.CrtLayout12Mode.L12MAUTO">
  9472. <summary>
  9473. Position and dimension (2) are determined by the application. x, y, dx and dy MUST be ignored.
  9474. </summary>
  9475. </member>
  9476. <member name="F:NPOI.HSSF.Record.Chart.CrtLayout12Mode.L12MFACTOR">
  9477. <summary>
  9478. x and y specify the offset of the top left corner, relative to its default position,
  9479. as a fraction of the chart area. MUST be greater than or equal to -1.0 and MUST be
  9480. less than or equal to 1.0. dx and dy specify the width and height, as a fraction of
  9481. the chart area, MUST be greater than or equal to 0.0, and MUST be less than or equal to 1.0.
  9482. </summary>
  9483. </member>
  9484. <member name="F:NPOI.HSSF.Record.Chart.CrtLayout12Mode.L12MEDGE">
  9485. <summary>
  9486. x and y specify the offset of the upper-left corner; dx and dy specify the offset of the bottom-right corner.
  9487. x, y, dx and dy are specified relative to the upper-left corner of the chart area as a fraction of the chart area.
  9488. x, y, dx and dy MUST be greater than or equal to 0.0, and MUST be less than or equal to 1.0.
  9489. </summary>
  9490. </member>
  9491. <member name="T:NPOI.HSSF.Record.Chart.CrtLayout12Record">
  9492. <summary>
  9493. The CrtLayout12 record specifies the layout information for attached label, when contained
  9494. in the sequence of records that conforms to the ATTACHEDLABEL rule,
  9495. or legend, when contained in the sequence of records that conforms to the LD rule.
  9496. </summary>
  9497. </member>
  9498. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.AutoLayoutType">
  9499. <summary>
  9500. automatic layout type of the legend.
  9501. MUST be ignored when this record is in the sequence of records that conforms to the ATTACHEDLABEL rule.
  9502. MUST be a value from the following table:
  9503. 0x0 Align to the bottom
  9504. 0x1 Align to top right corner
  9505. 0x2 Align to the top
  9506. 0x3 Align to the right
  9507. 0x4 Align to the left
  9508. </summary>
  9509. </member>
  9510. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.CheckSum">
  9511. <summary>
  9512. specifies the checksum of the values in the order as follows,
  9513. </summary>
  9514. </member>
  9515. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.XMode">
  9516. <summary>
  9517. A CrtLayout12Mode structure that specifies the meaning of x.
  9518. </summary>
  9519. </member>
  9520. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.YMode">
  9521. <summary>
  9522. A CrtLayout12Mode structure that specifies the meaning of y.
  9523. </summary>
  9524. </member>
  9525. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.WidthMode">
  9526. <summary>
  9527. A CrtLayout12Mode structure that specifies the meaning of dx.
  9528. </summary>
  9529. </member>
  9530. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.HeightMode">
  9531. <summary>
  9532. A CrtLayout12Mode structure that specifies the meaning of dy.
  9533. </summary>
  9534. </member>
  9535. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.X">
  9536. <summary>
  9537. An Xnum (section 2.5.342) value that specifies a horizontal offset. The meaning is determined by wXMode.
  9538. </summary>
  9539. </member>
  9540. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.Y">
  9541. <summary>
  9542. An Xnum value that specifies a vertical offset. The meaning is determined by wYMode.
  9543. </summary>
  9544. </member>
  9545. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.DX">
  9546. <summary>
  9547. An Xnum value that specifies a width or an horizontal offset. The meaning is determined by wWidthMode.
  9548. </summary>
  9549. </member>
  9550. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.DY">
  9551. <summary>
  9552. An Xnum value that specifies a height or an vertical offset. The meaning is determined by wHeightMode.
  9553. </summary>
  9554. </member>
  9555. <member name="T:NPOI.HSSF.Record.Chart.CrtLineRecord">
  9556. <summary>
  9557. The CrtLine record specifies the presence of drop lines, high-low lines, series lines
  9558. or leader lines on the chart group. This record is followed by a LineFormat record
  9559. which specifies the format of the lines.
  9560. </summary>
  9561. <remarks>
  9562. author: Antony liu (antony.apollo at gmail.com)
  9563. </remarks>
  9564. </member>
  9565. <member name="T:NPOI.HSSF.Record.Chart.CrtLinkRecord">
  9566. <summary>
  9567. The CrtLink record is written but unused.
  9568. </summary>
  9569. </member>
  9570. <member name="T:NPOI.HSSF.Record.Chart.CrtMlFrtContinueRecord">
  9571. <summary>
  9572. The CrtMlFrtContinue record specifies additional data for a CrtMlFrt record, as specified in the CrtMlFrt record.
  9573. </summary>
  9574. <remarks>
  9575. author: Antony liu (antony.apollo at gmail.com)
  9576. </remarks>
  9577. </member>
  9578. <member name="T:NPOI.HSSF.Record.Chart.CrtMlFrtRecord">
  9579. <summary>
  9580. The CrtMlFrt record specifies additional properties for chart elements, as specified by
  9581. the Chart Sheet Substream ABNF. These properties complement the record to which they
  9582. correspond, and are stored as a structure chain defined in XmlTkChain. An application
  9583. can ignore this record without loss of functionality, except for the additional properties.
  9584. If this record is longer than 8224 bytes, it MUST be split into several records. The first
  9585. section of the data appears in this record and subsequent sections appear in one or more
  9586. CrtMlFrtContinue records that follow this record.
  9587. </summary>
  9588. <remarks>
  9589. author: Antony liu (antony.apollo at gmail.com)
  9590. </remarks>
  9591. </member>
  9592. <member name="T:NPOI.HSSF.Record.Chart.DataFormatRecord">
  9593. * The data format record is used to index into a series.
  9594. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  9595. * Remove the record in src/records/definitions.
  9596. * @author Glen Stampoultzis (glens at apache.org)
  9597. </member>
  9598. <member name="M:NPOI.HSSF.Record.Chart.DataFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9599. Constructs a DataFormat record and Sets its fields appropriately.
  9600. @param in the RecordInputstream to Read the record from
  9601. </member>
  9602. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.DataSize">
  9603. Size of record (exluding 4 byte header)
  9604. </member>
  9605. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.PointNumber">
  9606. Get the point number field for the DataFormat record.
  9607. </member>
  9608. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.SeriesIndex">
  9609. Get the series index field for the DataFormat record.
  9610. </member>
  9611. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.SeriesNumber">
  9612. Get the series number field for the DataFormat record.
  9613. </member>
  9614. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.FormatFlags">
  9615. Get the format flags field for the DataFormat record.
  9616. </member>
  9617. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.UseExcel4Colors">
  9618. Set true to use excel 4 colors.
  9619. @return the use excel 4 colors field value.
  9620. </member>
  9621. <member name="T:NPOI.HSSF.Record.Chart.DataLabelExtensionRecord">
  9622. DATALABEXT - Chart Data Label Extension (0x086A) <br/>
  9623. @author Patrick Cheng
  9624. </member>
  9625. <member name="T:NPOI.HSSF.Record.Chart.DataLabExtContentsRecord">
  9626. <summary>
  9627. The DataLabExtContents record specifies the contents of an extended data label.
  9628. </summary>
  9629. </member>
  9630. <member name="T:NPOI.HSSF.Record.Chart.DataLabExtRecord">
  9631. DATALABEXT - Chart Data Label Extension (0x086A) <br/>
  9632. @author Patrick Cheng
  9633. </member>
  9634. <member name="T:NPOI.HSSF.Record.Chart.DatRecord">
  9635. * The dat record is used to store options for the chart.
  9636. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  9637. * Remove the record in src/records/definitions.
  9638. * @author Glen Stampoultzis (glens at apache.org)
  9639. </member>
  9640. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9641. Constructs a Dat record and Sets its fields appropriately.
  9642. @param in the RecordInputstream to Read the record from
  9643. </member>
  9644. <member name="P:NPOI.HSSF.Record.Chart.DatRecord.DataSize">
  9645. Size of record (exluding 4 byte header)
  9646. </member>
  9647. <member name="P:NPOI.HSSF.Record.Chart.DatRecord.Options">
  9648. Get the options field for the Dat record.
  9649. </member>
  9650. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.SetHorizontalBorder(System.Boolean)">
  9651. Sets the horizontal border field value.
  9652. has a horizontal border
  9653. </member>
  9654. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.IsHorizontalBorder">
  9655. has a horizontal border
  9656. @return the horizontal border field value.
  9657. </member>
  9658. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.SetVerticalBorder(System.Boolean)">
  9659. Sets the vertical border field value.
  9660. has vertical border
  9661. </member>
  9662. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.IsVerticalBorder">
  9663. has vertical border
  9664. @return the vertical border field value.
  9665. </member>
  9666. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.SetBorder(System.Boolean)">
  9667. Sets the border field value.
  9668. data table has a border
  9669. </member>
  9670. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.IsBorder">
  9671. data table has a border
  9672. @return the border field value.
  9673. </member>
  9674. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.SetShowSeriesKey(System.Boolean)">
  9675. Sets the show series key field value.
  9676. shows the series key
  9677. </member>
  9678. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.IsShowSeriesKey">
  9679. shows the series key
  9680. @return the show series key field value.
  9681. </member>
  9682. <member name="T:NPOI.HSSF.Record.Chart.DefaultDataLabelTextPropertiesRecord">
  9683. The default data label text properties record identifies the text characteristics of the preceding text record.<p/>
  9684. @author Glen Stampoultzis (glens at apache.org)
  9685. </member>
  9686. <member name="P:NPOI.HSSF.Record.Chart.DefaultDataLabelTextPropertiesRecord.CategoryDataType">
  9687. Get the category data type field for the DefaultDataLabelTextProperties record.
  9688. @return One of
  9689. CATEGORY_DATA_TYPE_SHOW_LABELS_CHARACTERISTIC
  9690. CATEGORY_DATA_TYPE_VALUE_AND_PERCENTAGE_CHARACTERISTIC
  9691. CATEGORY_DATA_TYPE_ALL_TEXT_CHARACTERISTIC
  9692. </member>
  9693. <member name="T:NPOI.HSSF.Record.Chart.TextFormatInfo">
  9694. <summary>
  9695. specifies the text elements that are formatted using the position and appearance information
  9696. specified by the Text record immediately following this record.
  9697. </summary>
  9698. </member>
  9699. <member name="F:NPOI.HSSF.Record.Chart.TextFormatInfo.ShowPercentOrValueNotSet">
  9700. <summary>
  9701. Format all Text records in the chart group where fShowPercent is equal to 0 or fShowValue is equal to 0.
  9702. </summary>
  9703. </member>
  9704. <member name="F:NPOI.HSSF.Record.Chart.TextFormatInfo.ShowPercentOrValueSet">
  9705. <summary>
  9706. Format all Text records in the chart group where fShowPercent is equal to 1 or fShowValue is equal to 1.
  9707. </summary>
  9708. </member>
  9709. <member name="F:NPOI.HSSF.Record.Chart.TextFormatInfo.FontScaleNotSet">
  9710. <summary>
  9711. Format all Text records in the chart where the value of fScaled of the associated FontInfo structure is equal to 0.
  9712. </summary>
  9713. </member>
  9714. <member name="F:NPOI.HSSF.Record.Chart.TextFormatInfo.FontScaleSet">
  9715. <summary>
  9716. Format all Text records in the chart where the value of fScaled of the associated FontInfo structure is equal to 1.
  9717. </summary>
  9718. </member>
  9719. <member name="T:NPOI.HSSF.Record.Chart.DefaultTextRecord">
  9720. <summary>
  9721. specifies the text elements that are formatted using the information specified by
  9722. the Text record immediately following this record.
  9723. </summary>
  9724. </member>
  9725. <member name="M:NPOI.HSSF.Record.Chart.DefaultTextRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9726. Constructs a DefaultDataLabelTextProperties record and Sets its fields appropriately.
  9727. @param in the RecordInputstream to Read the record from
  9728. </member>
  9729. <member name="P:NPOI.HSSF.Record.Chart.DefaultTextRecord.DataSize">
  9730. Size of record (exluding 4 byte header)
  9731. </member>
  9732. <member name="P:NPOI.HSSF.Record.Chart.DefaultTextRecord.FormatType">
  9733. <summary>
  9734. specifies the text elements that are formatted using the position and appearance
  9735. information specified by the Text record immediately following this record.
  9736. </summary>
  9737. </member>
  9738. <member name="T:NPOI.HSSF.Record.Chart.DropBarRecord">
  9739. <summary>
  9740. The DropBar record specifies the attributes of the up bars or the down bars between multiple
  9741. series of a line chart group and specifies the beginning of a collection of records as
  9742. defined by the Chart Sheet Substream ABNF. The first of these collections in the line chart
  9743. group specifies the attributes of the up bars. The second specifies the attributes of the
  9744. down bars. If this record exists, then the chart group type MUST be line and the field cSer
  9745. in the record SeriesList MUST be greater than 1.
  9746. </summary>
  9747. <remarks>
  9748. author: Antony liu (antony.apollo at gmail.com)
  9749. </remarks>
  9750. </member>
  9751. <member name="T:NPOI.HSSF.Record.Chart.EndBlockRecord">
  9752. ENDBLOCK - Chart Future Record Type End Block (0x0853)<br/>
  9753. @author Patrick Cheng
  9754. </member>
  9755. <member name="T:NPOI.HSSF.Record.Chart.EndRecord">
  9756. The end record defines the end of a block of records for a (Graphing)
  9757. data object. This record is matched with a corresponding BeginRecord.
  9758. @see BeginRecord
  9759. @author Glen Stampoultzis (glens at apache.org)
  9760. </member>
  9761. <member name="M:NPOI.HSSF.Record.Chart.EndRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9762. Constructs a EndRecord record and Sets its fields appropriately.
  9763. @param in the RecordInputstream to Read the record from
  9764. </member>
  9765. <member name="T:NPOI.HSSF.Record.Chart.Fbi2Record">
  9766. <summary>
  9767. The Fbi2 record specifies the font information at the time the scalable font is added to the chart.
  9768. </summary>
  9769. <remarks>
  9770. author: Antony liu (antony.apollo at gmail.com)
  9771. </remarks>
  9772. </member>
  9773. <member name="T:NPOI.HSSF.Record.Chart.FbiRecord">
  9774. <summary>
  9775. The Fbi record specifies the font information at the time the scalable font is added to the chart.
  9776. </summary>
  9777. </member>
  9778. <member name="M:NPOI.HSSF.Record.Chart.FbiRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9779. Constructs a FontBasis record and Sets its fields appropriately.
  9780. @param in the RecordInputstream to Read the record from
  9781. </member>
  9782. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.DataSize">
  9783. Size of record (exluding 4 byte header)
  9784. </member>
  9785. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.XBasis">
  9786. Get the x Basis field for the FontBasis record.
  9787. </member>
  9788. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.YBasis">
  9789. Get the y Basis field for the FontBasis record.
  9790. </member>
  9791. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.HeightBasis">
  9792. Get the height basis field for the FontBasis record.
  9793. </member>
  9794. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.Scale">
  9795. Get the scale field for the FontBasis record.
  9796. </member>
  9797. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.IndexToFontTable">
  9798. Get the index to font table field for the FontBasis record.
  9799. </member>
  9800. <member name="T:NPOI.HSSF.Record.Chart.FontBasisRecord">
  9801. * The font basis record stores various font metrics.
  9802. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  9803. * Remove the record in src/records/definitions.
  9804. * @author Glen Stampoultzis (glens at apache.org)
  9805. </member>
  9806. <member name="M:NPOI.HSSF.Record.Chart.FontBasisRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9807. Constructs a FontBasis record and Sets its fields appropriately.
  9808. @param in the RecordInputstream to Read the record from
  9809. </member>
  9810. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.DataSize">
  9811. Size of record (exluding 4 byte header)
  9812. </member>
  9813. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.XBasis">
  9814. Get the x Basis field for the FontBasis record.
  9815. </member>
  9816. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.YBasis">
  9817. Get the y Basis field for the FontBasis record.
  9818. </member>
  9819. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.HeightBasis">
  9820. Get the height basis field for the FontBasis record.
  9821. </member>
  9822. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.Scale">
  9823. Get the scale field for the FontBasis record.
  9824. </member>
  9825. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.IndexToFontTable">
  9826. Get the index to font table field for the FontBasis record.
  9827. </member>
  9828. <member name="T:NPOI.HSSF.Record.Chart.FontIndexRecord">
  9829. <summary>
  9830. The FontX record specifies the font for a given text element.
  9831. The Font record referenced by iFont can exist in this chart sheet substream or the workbook.
  9832. </summary>
  9833. </member>
  9834. <member name="M:NPOI.HSSF.Record.Chart.FontIndexRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9835. Constructs a FontIndex record and Sets its fields appropriately.
  9836. @param in the RecordInputstream to Read the record from
  9837. </member>
  9838. <member name="P:NPOI.HSSF.Record.Chart.FontIndexRecord.DataSize">
  9839. Size of record (exluding 4 byte header)
  9840. </member>
  9841. <member name="P:NPOI.HSSF.Record.Chart.FontIndexRecord.FontIndex">
  9842. <summary>
  9843. specifies the font to use for subsequent records.
  9844. This font can either be the default font of the chart, part of the collection of Font records following
  9845. the FrtFontList record, or part of the collection of Font records in the globals substream.
  9846. If iFont is 0x0000, this record specifies the default font of the chart.
  9847. If iFont is less than or equal to the number of Font records in the globals substream,
  9848. iFont is a one-based index to a Font record in the globals substream.
  9849. Otherwise iFont is a one-based index into the collection of Font records in this chart sheet substream
  9850. where the index is equal to iFont ¨C n, where n is the number of Font records in the globals substream.
  9851. </summary>
  9852. </member>
  9853. <member name="T:NPOI.HSSF.Record.Chart.FrameRecord">
  9854. * The frame record indicates whether there is a border around the Displayed text of a chart.
  9855. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  9856. * Remove the record in src/records/definitions.
  9857. * @author Glen Stampoultzis (glens at apache.org)
  9858. </member>
  9859. <member name="M:NPOI.HSSF.Record.Chart.FrameRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9860. Constructs a Frame record and Sets its fields appropriately.
  9861. @param in the RecordInputstream to Read the record from
  9862. </member>
  9863. <member name="P:NPOI.HSSF.Record.Chart.FrameRecord.DataSize">
  9864. Size of record (exluding 4 byte header)
  9865. </member>
  9866. <member name="P:NPOI.HSSF.Record.Chart.FrameRecord.BorderType">
  9867. Get the border type field for the Frame record.
  9868. @return One of
  9869. BORDER_TYPE_REGULAR
  9870. BORDER_TYPE_SHADOW
  9871. </member>
  9872. <member name="P:NPOI.HSSF.Record.Chart.FrameRecord.Options">
  9873. Get the options field for the Frame record.
  9874. </member>
  9875. <member name="P:NPOI.HSSF.Record.Chart.FrameRecord.IsAutoSize">
  9876. excel calculates the size automatically if true
  9877. @return the auto size field value.
  9878. </member>
  9879. <member name="P:NPOI.HSSF.Record.Chart.FrameRecord.IsAutoPosition">
  9880. excel calculates the position automatically
  9881. @return the auto position field value.
  9882. </member>
  9883. <member name="T:NPOI.HSSF.Record.Chart.FrtFontListRecord">
  9884. <summary>
  9885. The FrtFontList record specifies font information used on the chart and specifies the
  9886. beginning of a collection of Font records as defined by the Chart Sheet Substream ABNF.
  9887. </summary>
  9888. <remarks>
  9889. author: Antony liu (antony.apollo at gmail.com)
  9890. </remarks>
  9891. </member>
  9892. <member name="T:NPOI.HSSF.Record.Chart.GelFrameRecord">
  9893. <summary>
  9894. specifies the properties of a fill pattern for parts of a chart.
  9895. </summary>
  9896. <remarks>
  9897. author: Antony liu (antony.apollo at gmail.com)
  9898. </remarks>
  9899. </member>
  9900. <member name="T:NPOI.HSSF.Record.Chart.IFmtRecordRecord">
  9901. <summary>
  9902. The IFmtRecord record specifies the number format to use for the text on an axis.
  9903. </summary>
  9904. </member>
  9905. <member name="M:NPOI.HSSF.Record.Chart.IFmtRecordRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9906. Constructs a NumberFormatIndex record and Sets its fields appropriately.
  9907. @param in the RecordInputstream to Read the record from
  9908. </member>
  9909. <member name="P:NPOI.HSSF.Record.Chart.IFmtRecordRecord.DataSize">
  9910. Size of record (exluding 4 byte header)
  9911. </member>
  9912. <member name="P:NPOI.HSSF.Record.Chart.IFmtRecordRecord.FormatIndex">
  9913. Get the format index field for the NumberFormatIndex record.
  9914. </member>
  9915. <member name="T:NPOI.HSSF.Record.Chart.LegendExceptionRecord">
  9916. <summary>
  9917. The LegendException record specifies information about a legend entry which was
  9918. changed from the default legend entry settings, and specifies the beginning of
  9919. a collection of records as defined by the Chart Sheet Substream ABNF.
  9920. The collection of records specifies legend entry formatting. On a chart where
  9921. the legend contains legend entries for the series and trendlines, as defined
  9922. in the legend overview, there MUST be zero instances or one instance of this
  9923. record in the sequence of records that conform to the SERIESFORMAT rule.
  9924. </summary>
  9925. <remarks>
  9926. author: Antony liu (antony.apollo at gmail.com)
  9927. </remarks>
  9928. </member>
  9929. <member name="T:NPOI.HSSF.Record.Chart.LegendRecord">
  9930. * Defines a legend for a chart.
  9931. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  9932. * Remove the record in src/records/definitions.
  9933. * @author Andrew C. Oliver (acoliver at apache.org)
  9934. </member>
  9935. <member name="M:NPOI.HSSF.Record.Chart.LegendRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9936. Constructs a Legend record and Sets its fields appropriately.
  9937. @param in the RecordInputstream to Read the record from
  9938. </member>
  9939. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.DataSize">
  9940. Size of record (exluding 4 byte header)
  9941. </member>
  9942. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.XAxisUpperLeft">
  9943. Get the x axis upper left field for the Legend record.
  9944. </member>
  9945. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.YAxisUpperLeft">
  9946. Get the y axis upper left field for the Legend record.
  9947. </member>
  9948. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.XSize">
  9949. Get the x size field for the Legend record.
  9950. </member>
  9951. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.YSize">
  9952. Get the y size field for the Legend record.
  9953. </member>
  9954. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.Type">
  9955. Get the type field for the Legend record.
  9956. @return One of
  9957. TYPE_BOTTOM
  9958. TYPE_CORNER
  9959. TYPE_TOP
  9960. TYPE_RIGHT
  9961. TYPE_LEFT
  9962. TYPE_UNDOCKED
  9963. </member>
  9964. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.Spacing">
  9965. Get the spacing field for the Legend record.
  9966. @return One of
  9967. SPACING_CLOSE
  9968. SPACING_MEDIUM
  9969. SPACING_OPEN
  9970. </member>
  9971. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.Options">
  9972. Get the options field for the Legend record.
  9973. </member>
  9974. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsAutoPosition">
  9975. automatic positioning (1=docked)
  9976. @return the auto position field value.
  9977. </member>
  9978. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsAutoSeries">
  9979. excel 5 only (true)
  9980. @return the auto series field value.
  9981. </member>
  9982. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsAutoXPositioning">
  9983. position of legend on the x axis is automatic
  9984. @return the auto x positioning field value.
  9985. </member>
  9986. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsAutoYPositioning">
  9987. position of legend on the y axis is automatic
  9988. @return the auto y positioning field value.
  9989. </member>
  9990. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsVertical">
  9991. vertical or horizontal legend (1 or 0 respectively). Always 0 if not automatic.
  9992. @return the vertical field value.
  9993. </member>
  9994. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsDataTable">
  9995. 1 if chart Contains data table
  9996. @return the data table field value.
  9997. </member>
  9998. <member name="T:NPOI.HSSF.Record.Chart.LineFormatRecord">
  9999. * Describes a line format record. The line format record controls how a line on a chart appears.
  10000. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10001. * Remove the record in src/records/definitions.
  10002. * @author Glen Stampoultzis (glens at apache.org)
  10003. </member>
  10004. <member name="M:NPOI.HSSF.Record.Chart.LineFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10005. Constructs a LineFormat record and Sets its fields appropriately.
  10006. @param in the RecordInputstream to Read the record from
  10007. </member>
  10008. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.DataSize">
  10009. Size of record (exluding 4 byte header)
  10010. </member>
  10011. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.LineColor">
  10012. Get the line color field for the LineFormat record.
  10013. </member>
  10014. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.LinePattern">
  10015. Get the line pattern field for the LineFormat record.
  10016. @return One of
  10017. LINE_PATTERN_SOLID
  10018. LINE_PATTERN_DASH
  10019. LINE_PATTERN_DOT
  10020. LINE_PATTERN_DASH_DOT
  10021. LINE_PATTERN_DASH_DOT_DOT
  10022. LINE_PATTERN_NONE
  10023. LINE_PATTERN_DARK_GRAY_PATTERN
  10024. LINE_PATTERN_MEDIUM_GRAY_PATTERN
  10025. LINE_PATTERN_LIGHT_GRAY_PATTERN
  10026. </member>
  10027. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.Weight">
  10028. Get the weight field for the LineFormat record.
  10029. specifies the thickness of the line.
  10030. @return One of
  10031. WEIGHT_HAIRLINE
  10032. WEIGHT_NARROW
  10033. WEIGHT_MEDIUM
  10034. WEIGHT_WIDE
  10035. </member>
  10036. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.Format">
  10037. Get the format field for the LineFormat record.
  10038. </member>
  10039. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.ColourPaletteIndex">
  10040. Get the colour palette index field for the LineFormat record.
  10041. </member>
  10042. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.IsAuto">
  10043. automatic format
  10044. @return the auto field value.
  10045. </member>
  10046. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.IsDrawTicks">
  10047. draw tick marks
  10048. @return the draw ticks field value.
  10049. </member>
  10050. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.IsUnknown">
  10051. book marks this as reserved = 0 but it seems to do something
  10052. @return the Unknown field value.
  10053. </member>
  10054. <member name="T:NPOI.HSSF.Record.Chart.LinkedDataRecord">
  10055. Describes a linked data record. This record refers to the series data or text.<p/>
  10056. @author Glen Stampoultzis (glens at apache.org)
  10057. </member>
  10058. <member name="P:NPOI.HSSF.Record.Chart.LinkedDataRecord.LinkType">
  10059. Get the link type field for the LinkedData record.
  10060. @return One of
  10061. LINK_TYPE_TITLE_OR_TEXT
  10062. LINK_TYPE_VALUES
  10063. LINK_TYPE_CATEGORIES
  10064. </member>
  10065. <member name="P:NPOI.HSSF.Record.Chart.LinkedDataRecord.ReferenceType">
  10066. Get the reference type field for the LinkedData record.
  10067. @return One of
  10068. REFERENCE_TYPE_DEFAULT_CATEGORIES
  10069. REFERENCE_TYPE_DIRECT
  10070. REFERENCE_TYPE_WORKSHEET
  10071. REFERENCE_TYPE_NOT_USED
  10072. REFERENCE_TYPE_ERROR_REPORTED
  10073. </member>
  10074. <member name="P:NPOI.HSSF.Record.Chart.LinkedDataRecord.Options">
  10075. Get the options field for the LinkedData record.
  10076. </member>
  10077. <member name="P:NPOI.HSSF.Record.Chart.LinkedDataRecord.IndexNumberFmtRecord">
  10078. Get the index number fmt record field for the LinkedData record.
  10079. </member>
  10080. <member name="P:NPOI.HSSF.Record.Chart.LinkedDataRecord.FormulaOfLink">
  10081. Get the formula of link field for the LinkedData record.
  10082. </member>
  10083. <member name="P:NPOI.HSSF.Record.Chart.LinkedDataRecord.IsCustomNumberFormat">
  10084. true if this object has a custom number format
  10085. @return the custom number format field value.
  10086. </member>
  10087. <member name="T:NPOI.HSSF.Record.Chart.MarkerFormatRecord">
  10088. <summary>
  10089. specifies the color, size, and shape of the associated data markers that appear on line, radar,
  10090. and scatter chart groups. The associated data markers are specified by the preceding DataFormat record.
  10091. </summary>
  10092. <remarks>
  10093. author: Antony liu (antony.apollo at gmail.com)
  10094. </remarks>
  10095. </member>
  10096. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.RGBFore">
  10097. <summary>
  10098. the border color of the data marker.
  10099. </summary>
  10100. </member>
  10101. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.RGBBack">
  10102. <summary>
  10103. the interior color of the data marker.
  10104. </summary>
  10105. </member>
  10106. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.DataMarkerType">
  10107. <summary>
  10108. the type of data marker.
  10109. </summary>
  10110. </member>
  10111. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.Auto">
  10112. <summary>
  10113. whether the data marker is automatically generated.
  10114. false The data marker is not automatically generated.
  10115. true The data marker type, size, and color are automatically generated and the values are set accordingly in this record.
  10116. </summary>
  10117. </member>
  10118. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.NotShowInt">
  10119. <summary>
  10120. whether to show the data marker interior.
  10121. false The data marker interior is shown.
  10122. true The data marker interior is not shown.
  10123. </summary>
  10124. </member>
  10125. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.NotShowBorder">
  10126. <summary>
  10127. whether to show the data marker border.
  10128. false The data marker border is shown.
  10129. true The data marker border is not shown.
  10130. </summary>
  10131. </member>
  10132. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.IcvFore">
  10133. <summary>
  10134. the border color of the data marker.
  10135. </summary>
  10136. </member>
  10137. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.IcvBack">
  10138. <summary>
  10139. the interior color of the data marker.
  10140. </summary>
  10141. </member>
  10142. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.Size">
  10143. <summary>
  10144. specifies the size in twips of the data marker.
  10145. </summary>
  10146. </member>
  10147. <member name="T:NPOI.HSSF.Record.Chart.NumberFormatIndexRecord">
  10148. * The number format index record indexes format table. This applies to an axis.
  10149. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10150. * Remove the record in src/records/definitions.
  10151. * @author Glen Stampoultzis (glens at apache.org)
  10152. </member>
  10153. <member name="M:NPOI.HSSF.Record.Chart.NumberFormatIndexRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10154. Constructs a NumberFormatIndex record and Sets its fields appropriately.
  10155. @param in the RecordInputstream to Read the record from
  10156. </member>
  10157. <member name="P:NPOI.HSSF.Record.Chart.NumberFormatIndexRecord.DataSize">
  10158. Size of record (exluding 4 byte header)
  10159. </member>
  10160. <member name="P:NPOI.HSSF.Record.Chart.NumberFormatIndexRecord.FormatIndex">
  10161. Get the format index field for the NumberFormatIndex record.
  10162. </member>
  10163. <member name="T:NPOI.HSSF.Record.Chart.ObjectLinkRecord">
  10164. * Links text to an object on the chart or identifies it as the title.
  10165. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10166. * Remove the record in src/records/definitions.
  10167. * @author Andrew C. Oliver (acoliver at apache.org)
  10168. </member>
  10169. <member name="M:NPOI.HSSF.Record.Chart.ObjectLinkRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10170. Constructs a ObjectLink record and Sets its fields appropriately.
  10171. @param in the RecordInputstream to Read the record from
  10172. </member>
  10173. <member name="P:NPOI.HSSF.Record.Chart.ObjectLinkRecord.DataSize">
  10174. Size of record (exluding 4 byte header)
  10175. </member>
  10176. <member name="P:NPOI.HSSF.Record.Chart.ObjectLinkRecord.AnchorId">
  10177. Get the anchor id field for the ObjectLink record.
  10178. @return One of
  10179. ANCHOR_ID_CHART_TITLE
  10180. ANCHOR_ID_Y_AXIS
  10181. ANCHOR_ID_X_AXIS
  10182. ANCHOR_ID_SERIES_OR_POINT
  10183. ANCHOR_ID_Z_AXIS
  10184. </member>
  10185. <member name="P:NPOI.HSSF.Record.Chart.ObjectLinkRecord.Link1">
  10186. Get the link 1 field for the ObjectLink record.
  10187. </member>
  10188. <member name="P:NPOI.HSSF.Record.Chart.ObjectLinkRecord.Link2">
  10189. Get the link 2 field for the ObjectLink record.
  10190. </member>
  10191. <member name="T:NPOI.HSSF.Record.Chart.PicFRecord">
  10192. <summary>
  10193. The PicF record specifies the layout of a picture that is attached to a picture-filled chart element.
  10194. </summary>
  10195. <remarks>
  10196. author: Antony liu (antony.apollo at gmail.com)
  10197. </remarks>
  10198. </member>
  10199. <member name="T:NPOI.HSSF.Record.Chart.PieFormatRecord">
  10200. <summary>
  10201. The PieFormat record specifies the distance of a data point or data points in a series from the center of one of the following:
  10202. The plot area for a doughnut or pie chart group.
  10203. The primary pie in a pie of pie or bar of pie chart group.
  10204. The secondary bar/pie of a pie of pie chart group.
  10205. </summary>
  10206. <remarks>
  10207. author: Antony liu (antony.apollo at gmail.com)
  10208. </remarks>
  10209. </member>
  10210. <member name="P:NPOI.HSSF.Record.Chart.PieFormatRecord.Explode">
  10211. <summary>
  10212. 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:
  10213. The plot area for a doughnut or pie chart group.
  10214. The primary pie in a pie of pie or bar of pie chart group.
  10215. The secondary bar/pie of a pie of pie chart group.
  10216. </summary>
  10217. </member>
  10218. <member name="T:NPOI.HSSF.Record.Chart.PieRecord">
  10219. <summary>
  10220. The Pie record specifies that the chart group is a pie chart group or
  10221. a doughnut chart group, and specifies the chart group attributes.
  10222. </summary>
  10223. <remarks>
  10224. author: Antony liu (antony.apollo at gmail.com)
  10225. </remarks>
  10226. </member>
  10227. <member name="P:NPOI.HSSF.Record.Chart.PieRecord.Start">
  10228. <summary>
  10229. An unsigned integer that specifies the starting angle of the first data point,
  10230. clockwise from the top of the circle. MUST be less than or equal to 360.
  10231. </summary>
  10232. </member>
  10233. <member name="P:NPOI.HSSF.Record.Chart.PieRecord.Dount">
  10234. <summary>
  10235. An unsigned integer that specifies the size of the center hole in a doughnut chart group
  10236. as a percentage of the plot area size. MUST be a value from the following table:
  10237. 0 Pie chart group.
  10238. 10 to 90 Doughnut chart group.
  10239. </summary>
  10240. </member>
  10241. <member name="P:NPOI.HSSF.Record.Chart.PieRecord.HasShadow">
  10242. <summary>
  10243. A bit that specifies whether one data point or more data points in the chart group have shadows.
  10244. </summary>
  10245. </member>
  10246. <member name="P:NPOI.HSSF.Record.Chart.PieRecord.ShowLdrLines">
  10247. <summary>
  10248. A bit that specifies whether the leader lines to the data labels are shown.
  10249. </summary>
  10250. </member>
  10251. <member name="T:NPOI.HSSF.Record.Chart.PlotAreaRecord">
  10252. * preceeds and identifies a frame as belonging to the plot area.
  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 Andrew C. Oliver (acoliver at apache.org)
  10256. </member>
  10257. <member name="M:NPOI.HSSF.Record.Chart.PlotAreaRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10258. Constructs a PlotArea 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.PlotAreaRecord.DataSize">
  10262. Size of record (exluding 4 byte header)
  10263. </member>
  10264. <member name="T:NPOI.HSSF.Record.Chart.PlotGrowthRecord">
  10265. * The plot growth record specifies the scaling factors used when a font is scaled.
  10266. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10267. * Remove the record in src/records/definitions.
  10268. * @author Glen Stampoultzis (glens at apache.org)
  10269. </member>
  10270. <member name="M:NPOI.HSSF.Record.Chart.PlotGrowthRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10271. Constructs a PlotGrowth record and Sets its fields appropriately.
  10272. @param in the RecordInputstream to Read the record from
  10273. </member>
  10274. <member name="P:NPOI.HSSF.Record.Chart.PlotGrowthRecord.DataSize">
  10275. Size of record (exluding 4 byte header)
  10276. </member>
  10277. <member name="P:NPOI.HSSF.Record.Chart.PlotGrowthRecord.HorizontalScale">
  10278. Get the horizontalScale field for the PlotGrowth record.
  10279. </member>
  10280. <member name="P:NPOI.HSSF.Record.Chart.PlotGrowthRecord.VerticalScale">
  10281. Get the verticalScale field for the PlotGrowth record.
  10282. </member>
  10283. <member name="T:NPOI.HSSF.Record.Chart.PositionMode">
  10284. <summary>
  10285. pecifies positioning mode for position information saved in a Pos record.
  10286. </summary>
  10287. </member>
  10288. <member name="F:NPOI.HSSF.Record.Chart.PositionMode.MDFX">
  10289. <summary>
  10290. Relative position to the chart, in points.
  10291. </summary>
  10292. </member>
  10293. <member name="F:NPOI.HSSF.Record.Chart.PositionMode.MDABS">
  10294. <summary>
  10295. Absolute width and height in points. It can only be applied to the mdBotRt field of Pos.
  10296. </summary>
  10297. </member>
  10298. <member name="F:NPOI.HSSF.Record.Chart.PositionMode.MDPARENT">
  10299. <summary>
  10300. Owner of Pos determines how to interpret the position data.
  10301. </summary>
  10302. </member>
  10303. <member name="F:NPOI.HSSF.Record.Chart.PositionMode.MDKTH">
  10304. <summary>
  10305. Offset to default position, in 1/1000th of the plot area size.
  10306. </summary>
  10307. </member>
  10308. <member name="F:NPOI.HSSF.Record.Chart.PositionMode.MDCHART">
  10309. <summary>
  10310. Relative position to the chart, in SPRC.
  10311. </summary>
  10312. </member>
  10313. <member name="T:NPOI.HSSF.Record.Chart.PosRecord">
  10314. <summary>
  10315. specifies the size and position for a legend, an attached label, or the plot area, as specified by the primary axis group.
  10316. </summary>
  10317. </member>
  10318. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.MDTopLt">
  10319. <summary>
  10320. specifies the positioning mode for the upper-left corner of a legend, an attached label, or the plot area.
  10321. </summary>
  10322. </member>
  10323. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.MdBotRt">
  10324. <summary>
  10325. specifies the positioning mode for the lower-right corner of a legend, an attached label, or the plot area
  10326. </summary>
  10327. </member>
  10328. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.X1">
  10329. <summary>
  10330. specifies a position. The meaning is specified in the earlier table showing the valid combinations mdTopLt and mdBotRt by type.
  10331. </summary>
  10332. </member>
  10333. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.X2">
  10334. <summary>
  10335. specifies a width. The meaning is specified in the earlier table showing the valid combinations mdTopLt and mdBotRt by type.
  10336. </summary>
  10337. </member>
  10338. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.Y1">
  10339. <summary>
  10340. specifies a position. The meaning is specified in the earlier table showing the valid combinations mdTopLt and mdBotRt by type.
  10341. </summary>
  10342. </member>
  10343. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.Y2">
  10344. <summary>
  10345. specifies a height. The meaning is specified in the earlier table showing the valid combinations mdTopLt and mdBotRt by type.
  10346. </summary>
  10347. </member>
  10348. <member name="T:NPOI.HSSF.Record.Chart.RadarAreaRecord">
  10349. <summary>
  10350. The RadarArea record specifies that the chart group is a filled radar chart group and specifies the chart group attributes.
  10351. </summary>
  10352. <remarks>
  10353. author: Antony liu (antony.apollo at gmail.com)
  10354. </remarks>
  10355. </member>
  10356. <member name="T:NPOI.HSSF.Record.Chart.RadarRecord">
  10357. <summary>
  10358. The Radar record specifies that the chart group is a radar chart group and specifies the chart group attributes.
  10359. </summary>
  10360. <remarks>
  10361. author: Antony liu (antony.apollo at gmail.com)
  10362. </remarks>
  10363. </member>
  10364. <member name="T:NPOI.HSSF.Record.Chart.RichTextStreamRecord">
  10365. <summary>
  10366. The RichTextStream record specifies additional text properties for the text in
  10367. the entire chart, text in the current legend, text in the current legend entry,
  10368. or text in the attached label. These text properties are a superset of the
  10369. properties stored in the Text, Font, FontX, BRAI, and ObjectLink records based
  10370. on the following table, as specified by the Chart Sheet Substream ABNF. In each
  10371. case, the associated Font record is specified by the associated FontX record.
  10372. </summary>
  10373. <remarks>
  10374. author: Antony liu (antony.apollo at gmail.com)
  10375. </remarks>
  10376. </member>
  10377. <member name="T:NPOI.HSSF.Record.Chart.ScatterRecord">
  10378. <summary>
  10379. The Scatter record specifies that the chart group is a scatter chart group or
  10380. a bubble chart group, and specifies the chart group attributes.
  10381. </summary>
  10382. <remarks>
  10383. author: Antony liu (antony.apollo at gmail.com)
  10384. </remarks>
  10385. </member>
  10386. <member name="T:NPOI.HSSF.Record.Chart.SerAuxErrBarRecord">
  10387. <summary>
  10388. The SerAuxErrBar record specifies properties of an error bar.
  10389. </summary>
  10390. <remarks>
  10391. author: Antony liu (antony.apollo at gmail.com)
  10392. </remarks>
  10393. </member>
  10394. <member name="T:NPOI.HSSF.Record.Chart.SerAuxTrendRecord">
  10395. <summary>
  10396. The SerAuxTrend record specifies a trendline.
  10397. </summary>
  10398. <remarks>
  10399. author: Antony liu (antony.apollo at gmail.com)
  10400. </remarks>
  10401. </member>
  10402. <member name="T:NPOI.HSSF.Record.Chart.SerFmtRecord">
  10403. <summary>
  10404. The SerFmt record specifies properties of the associated data points, data markers,
  10405. or lines of the series. The associated data points, data markers, or lines of the
  10406. series are specified by the preceding DataFormat record. If this record is not
  10407. present in the sequence of records that conforms to the SS rule of the Chart Sheet
  10408. Substream ABNF, then the properties of the associated data points, data markers,
  10409. or lines of the series are specified by the default values of the fields of this record.
  10410. </summary>
  10411. <remarks>
  10412. author: Antony liu (antony.apollo at gmail.com)
  10413. </remarks>
  10414. </member>
  10415. <member name="T:NPOI.HSSF.Record.Chart.SeriesChartGroupIndexRecord">
  10416. * The series chart Group index record stores the index to the CHARTFORMAT record (0 based).
  10417. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10418. * Remove the record in src/records/definitions.
  10419. * @author Glen Stampoultzis (glens at apache.org)
  10420. </member>
  10421. <member name="M:NPOI.HSSF.Record.Chart.SeriesChartGroupIndexRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10422. Constructs a SeriesChartGroupIndex record and Sets its fields appropriately.
  10423. @param in the RecordInputstream to Read the record from
  10424. </member>
  10425. <member name="P:NPOI.HSSF.Record.Chart.SeriesChartGroupIndexRecord.DataSize">
  10426. Size of record (exluding 4 byte header)
  10427. </member>
  10428. <member name="P:NPOI.HSSF.Record.Chart.SeriesChartGroupIndexRecord.ChartGroupIndex">
  10429. Get the chart Group index field for the SeriesChartGroupIndex record.
  10430. </member>
  10431. <member name="T:NPOI.HSSF.Record.Chart.SeriesIndexRecord">
  10432. * links a series to its position in the series list.
  10433. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10434. * Remove the record in src/records/definitions.
  10435. * @author Andrew C. Oliver (acoliver at apache.org)
  10436. </member>
  10437. <member name="M:NPOI.HSSF.Record.Chart.SeriesIndexRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10438. Constructs a SeriesIndex record and Sets its fields appropriately.
  10439. @param in the RecordInputstream to Read the record from
  10440. </member>
  10441. <member name="P:NPOI.HSSF.Record.Chart.SeriesIndexRecord.DataSize">
  10442. Size of record (exluding 4 byte header)
  10443. </member>
  10444. <member name="P:NPOI.HSSF.Record.Chart.SeriesIndexRecord.Index">
  10445. Get the index field for the SeriesIndex record.
  10446. </member>
  10447. <member name="T:NPOI.HSSF.Record.Chart.SeriesLabelsRecord">
  10448. * The series label record defines the type of label associated with the data format record.
  10449. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10450. * Remove the record in src/records/definitions.
  10451. * @author Glen Stampoultzis (glens at apache.org)
  10452. </member>
  10453. <member name="M:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10454. Constructs a SeriesLabels record and Sets its fields appropriately.
  10455. @param in the RecordInputstream to Read the record from
  10456. </member>
  10457. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.DataSize">
  10458. Size of record (exluding 4 byte header)
  10459. </member>
  10460. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.FormatFlags">
  10461. Get the format flags field for the SeriesLabels record.
  10462. </member>
  10463. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsShowActual">
  10464. show actual value of the data point
  10465. @return the show actual field value.
  10466. </member>
  10467. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsShowPercent">
  10468. show value as percentage of total (pie charts only)
  10469. @return the show percent field value.
  10470. </member>
  10471. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsLabelAsPercentage">
  10472. show category label/value as percentage (pie charts only)
  10473. @return the label as percentage field value.
  10474. </member>
  10475. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsSmoothedLine">
  10476. show smooth line
  10477. @return the smoothed line field value.
  10478. </member>
  10479. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsShowLabel">
  10480. Display category label
  10481. @return the show label field value.
  10482. </member>
  10483. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsShowBubbleSizes">
  10484. ??
  10485. @return the show bubble sizes field value.
  10486. </member>
  10487. <member name="T:NPOI.HSSF.Record.Chart.SeriesListRecord">
  10488. * The series list record defines the series Displayed as an overlay to the main chart record.
  10489. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10490. * Remove the record in src/records/definitions.
  10491. * @author Glen Stampoultzis (glens at apache.org)
  10492. </member>
  10493. <member name="M:NPOI.HSSF.Record.Chart.SeriesListRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10494. Constructs a SeriesList record and Sets its fields appropriately.
  10495. @param in the RecordInputstream to Read the record from
  10496. </member>
  10497. <member name="P:NPOI.HSSF.Record.Chart.SeriesListRecord.DataSize">
  10498. Size of record (exluding 4 byte header)
  10499. </member>
  10500. <member name="P:NPOI.HSSF.Record.Chart.SeriesListRecord.SeriesNumbers">
  10501. Get the series numbers field for the SeriesList record.
  10502. </member>
  10503. <member name="T:NPOI.HSSF.Record.Chart.SeriesRecord">
  10504. * The series record describes the overall data for a series.
  10505. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10506. * Remove the record in src/records/definitions.
  10507. * @author Glen Stampoultzis (glens at apache.org)
  10508. </member>
  10509. <member name="M:NPOI.HSSF.Record.Chart.SeriesRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10510. Constructs a Series record and Sets its fields appropriately.
  10511. @param in the RecordInputstream to Read the record from
  10512. </member>
  10513. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.DataSize">
  10514. Size of record (exluding 4 byte header)
  10515. </member>
  10516. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.CategoryDataType">
  10517. Get the category data type field for the Series record.
  10518. @return One of
  10519. CATEGORY_DATA_TYPE_DATES
  10520. CATEGORY_DATA_TYPE_NUMERIC
  10521. CATEGORY_DATA_TYPE_SEQUENCE
  10522. CATEGORY_DATA_TYPE_TEXT
  10523. </member>
  10524. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.ValuesDataType">
  10525. Get the values data type field for the Series record.
  10526. @return One of
  10527. VALUES_DATA_TYPE_DATES
  10528. VALUES_DATA_TYPE_NUMERIC
  10529. VALUES_DATA_TYPE_SEQUENCE
  10530. VALUES_DATA_TYPE_TEXT
  10531. </member>
  10532. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.NumCategories">
  10533. Get the num categories field for the Series record.
  10534. </member>
  10535. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.NumValues">
  10536. Get the num values field for the Series record.
  10537. </member>
  10538. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.BubbleSeriesType">
  10539. Get the bubble series type field for the Series record.
  10540. @return One of
  10541. BUBBLE_SERIES_TYPE_DATES
  10542. BUBBLE_SERIES_TYPE_NUMERIC
  10543. BUBBLE_SERIES_TYPE_SEQUENCE
  10544. BUBBLE_SERIES_TYPE_TEXT
  10545. </member>
  10546. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.NumBubbleValues">
  10547. Get the num bubble values field for the Series record.
  10548. </member>
  10549. <member name="T:NPOI.HSSF.Record.Chart.SeriesTextRecord">
  10550. * Defines a series name
  10551. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10552. * Remove the record in src/records/definitions.
  10553. * @author Andrew C. Oliver (acoliver at apache.org)
  10554. </member>
  10555. <member name="F:NPOI.HSSF.Record.Chart.SeriesTextRecord.MAX_LEN">
  10556. the actual text cannot be longer than 255 characters
  10557. </member>
  10558. <member name="M:NPOI.HSSF.Record.Chart.SeriesTextRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10559. Constructs a SeriesText record and Sets its fields appropriately.
  10560. @param in the RecordInputstream to Read the record from
  10561. </member>
  10562. <member name="P:NPOI.HSSF.Record.Chart.SeriesTextRecord.DataSize">
  10563. Size of record (exluding 4 byte header)
  10564. </member>
  10565. <member name="P:NPOI.HSSF.Record.Chart.SeriesTextRecord.Id">
  10566. Get the id field for the SeriesText record.
  10567. </member>
  10568. <member name="P:NPOI.HSSF.Record.Chart.SeriesTextRecord.Text">
  10569. Get the text field for the SeriesText record.
  10570. </member>
  10571. <member name="T:NPOI.HSSF.Record.Chart.SeriesToChartGroupRecord">
  10572. * 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)
  10573. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10574. * Remove the record in src/records/definitions.
  10575. * @author Andrew C. Oliver (acoliver at apache.org)
  10576. </member>
  10577. <member name="M:NPOI.HSSF.Record.Chart.SeriesToChartGroupRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10578. Constructs a SeriesToChartGroup record and Sets its fields appropriately.
  10579. @param in the RecordInputstream to Read the record from
  10580. </member>
  10581. <member name="P:NPOI.HSSF.Record.Chart.SeriesToChartGroupRecord.DataSize">
  10582. Size of record (exluding 4 byte header)
  10583. </member>
  10584. <member name="P:NPOI.HSSF.Record.Chart.SeriesToChartGroupRecord.ChartGroupIndex">
  10585. Get the chart Group index field for the SeriesToChartGroup record.
  10586. </member>
  10587. <member name="T:NPOI.HSSF.Record.Chart.SerParentRecord">
  10588. <summary>
  10589. The SerParent record specifies the series to which the current trendline or error bar corresponds.
  10590. </summary>
  10591. <remarks>
  10592. author: Antony liu (antony.apollo at gmail.com)
  10593. </remarks>
  10594. </member>
  10595. <member name="T:NPOI.HSSF.Record.Chart.SerToCrtRecord">
  10596. <summary>
  10597. The SerToCrt record specifies the chart group for the current series.
  10598. </summary>
  10599. </member>
  10600. <member name="M:NPOI.HSSF.Record.Chart.SerToCrtRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10601. Constructs a SeriesChartGroupIndex record and Sets its fields appropriately.
  10602. @param in the RecordInputstream to Read the record from
  10603. </member>
  10604. <member name="P:NPOI.HSSF.Record.Chart.SerToCrtRecord.DataSize">
  10605. Size of record (exluding 4 byte header)
  10606. </member>
  10607. <member name="P:NPOI.HSSF.Record.Chart.SerToCrtRecord.ChartGroupIndex">
  10608. Get the chart Group index field for the SeriesChartGroupIndex record.
  10609. </member>
  10610. <member name="T:NPOI.HSSF.Record.Chart.ShapePropsStreamRecord">
  10611. <summary>
  10612. The ShapePropsStream record specifies the shape formatting properties for chart elements.
  10613. These shape formatting properties are a superset of the properties stored in the LineFormat,
  10614. AreaFormat, MarkerFormat, and GelFrame records. They are stored in the rgb field, which is an
  10615. XML stream (section 2.1.7.22), as defined in [ECMA-376] Part 4, section 5.7.2.198.
  10616. </summary>
  10617. <remarks>
  10618. author: Antony liu (antony.apollo at gmail.com)
  10619. </remarks>
  10620. </member>
  10621. <member name="T:NPOI.HSSF.Record.Chart.ShtPropsRecord">
  10622. * Describes a chart sheet properties record.
  10623. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10624. * Remove the record in src/records/definitions.
  10625. * @author Glen Stampoultzis (glens at apache.org)
  10626. <summary>
  10627. specifies properties of a chart as defined by the Chart Sheet Substream ABNF
  10628. </summary>
  10629. </member>
  10630. <member name="M:NPOI.HSSF.Record.Chart.ShtPropsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10631. Constructs a SheetProperties record and Sets its fields appropriately.
  10632. @param in the RecordInputstream to Read the record from
  10633. </member>
  10634. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.DataSize">
  10635. Size of record (exluding 4 byte header)
  10636. </member>
  10637. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.Flags">
  10638. Get the flags field for the SheetProperties record.
  10639. </member>
  10640. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.Blank">
  10641. Get the empty field for the SheetProperties record.
  10642. @return One of
  10643. EMPTY_NOT_PLOTTED
  10644. EMPTY_ZERO
  10645. EMPTY_INTERPOLATED
  10646. <summary>
  10647. specifies how the empty cells are plotted be a value from the following table:
  10648. 0x00 Empty cells are not plotted.
  10649. 0x01 Empty cells are plotted as zero.
  10650. 0x02 Empty cells are plotted as interpolated.
  10651. </summary>
  10652. </member>
  10653. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.IsManSerAlloc">
  10654. <summary>
  10655. whether series are automatically allocated for the chart.
  10656. </summary>
  10657. </member>
  10658. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.IsPlotVisibleOnly">
  10659. <summary>
  10660. whether to plot visible cells only.
  10661. </summary>
  10662. </member>
  10663. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.IsNotSizeWithWindow">
  10664. <summary>
  10665. whether to size the chart with the window.
  10666. </summary>
  10667. </member>
  10668. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.IsManPlotArea">
  10669. <summary>
  10670. If fAlwaysAutoPlotArea is 1, then this field MUST be 1.
  10671. If fAlwaysAutoPlotArea is 0, then this field MUST be ignored.
  10672. </summary>
  10673. </member>
  10674. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.IsAlwaysAutoPlotArea">
  10675. <summary>
  10676. specifies whether the default plot area dimension (2) is used.
  10677. 0 Use the default plot area dimension (2) regardless of the Pos record information.
  10678. 1 Use the plot area dimension (2) of the Pos record; and fManPlotArea MUST be 1.
  10679. </summary>
  10680. </member>
  10681. <member name="T:NPOI.HSSF.Record.Chart.StartBlockRecord">
  10682. STARTBLOCK - Chart Future Record Type Start Block (0x0852)<br/>
  10683. @author Patrick Cheng
  10684. </member>
  10685. <member name="T:NPOI.HSSF.Record.Chart.SurfRecord">
  10686. <summary>
  10687. The Surf record specifies that the chart group is a surface chart group and specifies the chart group attributes.
  10688. </summary>
  10689. <remarks>
  10690. author: Antony liu (antony.apollo at gmail.com)
  10691. </remarks>
  10692. </member>
  10693. <member name="T:NPOI.HSSF.Record.Chart.TextPropsStreamRecord">
  10694. <summary>
  10695. The RichTextStream record specifies additional text properties for the text
  10696. in the entire chart, text in the current legend, text in the current legend
  10697. entry, or text in the attached label. These text properties are a superset
  10698. of the properties stored in the Text, Font, FontX, BRAI, and ObjectLink records
  10699. based on the following table, as specified by the Chart Sheet Substream ABNF.
  10700. In each case, the associated Font record is specified by the associated FontX record.
  10701. </summary>
  10702. <remarks>
  10703. author: Antony liu (antony.apollo at gmail.com)
  10704. </remarks>
  10705. </member>
  10706. <member name="T:NPOI.HSSF.Record.Chart.ValueRangeRecord">
  10707. * The value range record defines the range of the value axis.
  10708. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10709. * Remove the record in src/records/definitions.
  10710. * @author Glen Stampoultzis (glens at apache.org)
  10711. </member>
  10712. <member name="M:NPOI.HSSF.Record.Chart.ValueRangeRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10713. Constructs a ValueRange record and Sets its fields appropriately.
  10714. @param in the RecordInputstream to Read the record from
  10715. </member>
  10716. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.DataSize">
  10717. Size of record (exluding 4 byte header)
  10718. </member>
  10719. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.MinimumAxisValue">
  10720. Get the minimum axis value field for the ValueRange record.
  10721. </member>
  10722. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.MaximumAxisValue">
  10723. Get the maximum axis value field for the ValueRange record.
  10724. </member>
  10725. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.MajorIncrement">
  10726. Get the major increment field for the ValueRange record.
  10727. </member>
  10728. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.MinorIncrement">
  10729. Get the minor increment field for the ValueRange record.
  10730. </member>
  10731. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.CategoryAxisCross">
  10732. Get the category axis cross field for the ValueRange record.
  10733. </member>
  10734. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.Options">
  10735. Get the options field for the ValueRange record.
  10736. </member>
  10737. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsAutomaticMinimum">
  10738. automatic minimum value selected
  10739. @return the automatic minimum field value.
  10740. </member>
  10741. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsAutomaticMaximum">
  10742. automatic maximum value selected
  10743. @return the automatic maximum field value.
  10744. </member>
  10745. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsAutomaticMajor">
  10746. automatic major Unit selected
  10747. @return the automatic major field value.
  10748. </member>
  10749. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsAutomaticMinor">
  10750. automatic minor Unit selected
  10751. @return the automatic minor field value.
  10752. </member>
  10753. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsAutomaticCategoryCrossing">
  10754. category crossing point is automatically selected
  10755. @return the automatic category crossing field value.
  10756. </member>
  10757. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsLogarithmicScale">
  10758. use logarithmic scale
  10759. @return the logarithmic scale field value.
  10760. </member>
  10761. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsValuesInReverse">
  10762. values are reverses in graph
  10763. @return the values in reverse field value.
  10764. </member>
  10765. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsCrossCategoryAxisAtMaximum">
  10766. category axis to cross at maximum value
  10767. @return the cross category axis at maximum field value.
  10768. </member>
  10769. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsReserved">
  10770. reserved, must equal 1 (excel dev. guide says otherwise)
  10771. @return the reserved field value.
  10772. </member>
  10773. <member name="T:NPOI.HSSF.Record.Chart.YMultRecord">
  10774. <summary>
  10775. The YMult record specifies properties of the value multiplier for a value axis and
  10776. that specifies the beginning of a collection of records as defined by the Chart Sheet
  10777. substream ABNF. The collection of records specifies a display units label.
  10778. </summary>
  10779. <remarks>
  10780. author: Antony liu (antony.apollo at gmail.com)
  10781. </remarks>
  10782. </member>
  10783. <member name="T:NPOI.HSSF.Record.ChartFormatRecord">
  10784. Class ChartFormatRecord
  10785. @author Glen Stampoultzis (glens at apache.org)
  10786. @version %I%, %G%
  10787. </member>
  10788. <member name="M:NPOI.HSSF.Record.ChartFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10789. Constructs a ChartFormatRecord record and Sets its fields appropriately.
  10790. @param in the RecordInputstream to Read the record from
  10791. </member>
  10792. <member name="T:NPOI.HSSF.Record.TextRecord">
  10793. <summary>
  10794. Section [2.4.324]. The Text record specifies the properties of an attached label and specifies the beginning of
  10795. a collection of records as defined by the chart sheet substream ABNF. This collection of records specifies an attached label.
  10796. </summary>
  10797. </member>
  10798. <member name="F:NPOI.HSSF.Record.TextRecord.HORIZONTAL_ALIGNMENT_LEFT">
  10799. <summary>
  10800. Left-alignment if iReadingOrder specifies left-to-right reading order; otherwise, right-alignment
  10801. </summary>
  10802. </member>
  10803. <member name="F:NPOI.HSSF.Record.TextRecord.HORIZONTAL_ALIGNMENT_CENTER">
  10804. <summary>
  10805. Center-alignment
  10806. </summary>
  10807. </member>
  10808. <member name="F:NPOI.HSSF.Record.TextRecord.HORIZONTAL_ALIGNMENT_BOTTOM">
  10809. <summary>
  10810. Right-alignment if iReadingOrder specifies left-to-right reading order; otherwise, left-alignment
  10811. </summary>
  10812. </member>
  10813. <member name="F:NPOI.HSSF.Record.TextRecord.HORIZONTAL_ALIGNMENT_JUSTIFY">
  10814. <summary>
  10815. Justify-alignment
  10816. </summary>
  10817. </member>
  10818. <member name="F:NPOI.HSSF.Record.TextRecord.HORIZONTAL_ALIGNMENT_DISTRIBUTED">
  10819. <summary>
  10820. distributed alignment
  10821. </summary>
  10822. </member>
  10823. <member name="F:NPOI.HSSF.Record.TextRecord.VERTICAL_ALIGNMENT_DISTRIBUTED">
  10824. <summary>
  10825. distributed alignment
  10826. </summary>
  10827. </member>
  10828. <member name="F:NPOI.HSSF.Record.TextRecord.DISPLAY_MODE_TRANSPARENT">
  10829. <summary>
  10830. Transparent background
  10831. </summary>
  10832. </member>
  10833. <member name="F:NPOI.HSSF.Record.TextRecord.DISPLAY_MODE_OPAQUE">
  10834. <summary>
  10835. Opaque background
  10836. </summary>
  10837. </member>
  10838. <member name="M:NPOI.HSSF.Record.TextRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10839. Constructs a Text record and Sets its fields appropriately.
  10840. @param in the RecordInputstream to Read the record from
  10841. </member>
  10842. <member name="P:NPOI.HSSF.Record.TextRecord.DataSize">
  10843. Size of record (exluding 4 byte header)
  10844. </member>
  10845. <member name="P:NPOI.HSSF.Record.TextRecord.HorizontalAlignment">
  10846. Get the horizontal alignment field for the Text record.
  10847. @return One of
  10848. HORIZONTAL_ALIGNMENT_LEFT
  10849. HORIZONTAL_ALIGNMENT_CENTER
  10850. HORIZONTAL_ALIGNMENT_BOTTOM
  10851. HORIZONTAL_ALIGNMENT_JUSTIFY
  10852. </member>
  10853. <member name="P:NPOI.HSSF.Record.TextRecord.VerticalAlignment">
  10854. Get the vertical alignment field for the Text record.
  10855. @return One of
  10856. VERTICAL_ALIGNMENT_TOP
  10857. VERTICAL_ALIGNMENT_CENTER
  10858. VERTICAL_ALIGNMENT_BOTTOM
  10859. VERTICAL_ALIGNMENT_JUSTIFY
  10860. </member>
  10861. <member name="P:NPOI.HSSF.Record.TextRecord.DisplayMode">
  10862. Get the Display mode field for the Text record.
  10863. @return One of
  10864. DISPLAY_MODE_TRANSPARENT
  10865. DISPLAY_MODE_OPAQUE
  10866. </member>
  10867. <member name="P:NPOI.HSSF.Record.TextRecord.RgbColor">
  10868. Get the rgbColor field for the Text record.
  10869. </member>
  10870. <member name="P:NPOI.HSSF.Record.TextRecord.X">
  10871. Get the x field for the Text record.
  10872. </member>
  10873. <member name="P:NPOI.HSSF.Record.TextRecord.Y">
  10874. Get the y field for the Text record.
  10875. </member>
  10876. <member name="P:NPOI.HSSF.Record.TextRecord.Width">
  10877. Set the width field for the Text record.
  10878. </member>
  10879. <member name="P:NPOI.HSSF.Record.TextRecord.Height">
  10880. Get the height field for the Text record.
  10881. </member>
  10882. <member name="P:NPOI.HSSF.Record.TextRecord.Options1">
  10883. Get the options1 field for the Text record.
  10884. </member>
  10885. <member name="P:NPOI.HSSF.Record.TextRecord.IndexOfColorValue">
  10886. Get the index of color value field for the Text record.
  10887. </member>
  10888. <member name="P:NPOI.HSSF.Record.TextRecord.Options2">
  10889. Get the options2 field for the Text record.
  10890. </member>
  10891. <member name="P:NPOI.HSSF.Record.TextRecord.TextRotation">
  10892. Get the text rotation field for the Text record.
  10893. </member>
  10894. <member name="P:NPOI.HSSF.Record.TextRecord.IsAutoColor">
  10895. true = automaticly selected colour, false = user-selected
  10896. @return the auto color field value.
  10897. </member>
  10898. <member name="P:NPOI.HSSF.Record.TextRecord.ShowKey">
  10899. true = draw legend
  10900. @return the show key field value.
  10901. </member>
  10902. <member name="P:NPOI.HSSF.Record.TextRecord.ShowValue">
  10903. false = text is category label
  10904. @return the show value field value.
  10905. </member>
  10906. <member name="P:NPOI.HSSF.Record.TextRecord.IsAutoGeneratedText">
  10907. @return the auto generated text field value.
  10908. </member>
  10909. <member name="P:NPOI.HSSF.Record.TextRecord.IsGenerated">
  10910. @return the generated field value.
  10911. </member>
  10912. <member name="P:NPOI.HSSF.Record.TextRecord.IsAutoLabelDeleted">
  10913. @return the auto label deleted field value.
  10914. </member>
  10915. <member name="P:NPOI.HSSF.Record.TextRecord.IsAutoBackground">
  10916. @return the auto background field value.
  10917. </member>
  10918. <member name="P:NPOI.HSSF.Record.TextRecord.ShowCategoryLabelAsPercentage">
  10919. @return the show category label as percentage field value.
  10920. </member>
  10921. <member name="P:NPOI.HSSF.Record.TextRecord.ShowValueAsPercentage">
  10922. @return the show value as percentage field value.
  10923. </member>
  10924. <member name="P:NPOI.HSSF.Record.TextRecord.ShowBubbleSizes">
  10925. @return the show bubble sizes field value.
  10926. </member>
  10927. <member name="P:NPOI.HSSF.Record.TextRecord.ShowLabel">
  10928. @return the show label field value.
  10929. </member>
  10930. <member name="P:NPOI.HSSF.Record.TextRecord.DataLabelPlacement">
  10931. @return the data label placement field value.
  10932. </member>
  10933. <member name="T:NPOI.HSSF.Record.TickRecord">
  10934. * The Tick record defines how tick marks and label positioning/formatting
  10935. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10936. * Remove the record in src/records/definitions.
  10937. * @author Andrew C. Oliver(acoliver at apache.org)
  10938. </member>
  10939. <member name="M:NPOI.HSSF.Record.TickRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10940. Constructs a Tick record and Sets its fields appropriately.
  10941. @param in the RecordInputstream to Read the record from
  10942. </member>
  10943. <member name="P:NPOI.HSSF.Record.TickRecord.DataSize">
  10944. Size of record (exluding 4 byte header)
  10945. </member>
  10946. <member name="P:NPOI.HSSF.Record.TickRecord.MajorTickType">
  10947. Get the major tick type field for the Tick record.
  10948. </member>
  10949. <member name="P:NPOI.HSSF.Record.TickRecord.MinorTickType">
  10950. Get the minor tick type field for the Tick record.
  10951. </member>
  10952. <member name="P:NPOI.HSSF.Record.TickRecord.LabelPosition">
  10953. Get the label position field for the Tick record.
  10954. </member>
  10955. <member name="P:NPOI.HSSF.Record.TickRecord.Background">
  10956. Get the background field for the Tick record.
  10957. </member>
  10958. <member name="P:NPOI.HSSF.Record.TickRecord.LabelColorRgb">
  10959. Get the label color rgb field for the Tick record.
  10960. </member>
  10961. <member name="P:NPOI.HSSF.Record.TickRecord.Zero1">
  10962. Get the zero 1 field for the Tick record.
  10963. </member>
  10964. <member name="P:NPOI.HSSF.Record.TickRecord.Zero2">
  10965. Get the zero 2 field for the Tick record.
  10966. </member>
  10967. <member name="P:NPOI.HSSF.Record.TickRecord.Options">
  10968. Get the options field for the Tick record.
  10969. </member>
  10970. <member name="P:NPOI.HSSF.Record.TickRecord.TickColor">
  10971. Get the tick color field for the Tick record.
  10972. </member>
  10973. <member name="P:NPOI.HSSF.Record.TickRecord.Zero3">
  10974. Get the zero 3 field for the Tick record.
  10975. </member>
  10976. <member name="P:NPOI.HSSF.Record.TickRecord.IsAutoTextColor">
  10977. use the quote Unquote automatic color for text
  10978. @return the auto text color field value.
  10979. </member>
  10980. <member name="P:NPOI.HSSF.Record.TickRecord.IsAutoTextBackground">
  10981. use the quote Unquote automatic color for text background
  10982. @return the auto text background field value.
  10983. </member>
  10984. <member name="P:NPOI.HSSF.Record.TickRecord.Rotation">
  10985. rotate text (0=none, 1=normal, 2=90 degrees counterclockwise, 3=90 degrees clockwise)
  10986. @return the rotation field value.
  10987. </member>
  10988. <member name="P:NPOI.HSSF.Record.TickRecord.IsAutorotate">
  10989. automatically rotate the text
  10990. @return the autorotate field value.
  10991. </member>
  10992. <member name="T:NPOI.HSSF.Record.UnitsRecord">
  10993. * The Units record describes Units.
  10994. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10995. * Remove the record in src/records/definitions.
  10996. * @author Glen Stampoultzis (glens at apache.org)
  10997. </member>
  10998. <member name="M:NPOI.HSSF.Record.UnitsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10999. Constructs a Units record and Sets its fields appropriately.
  11000. @param in the RecordInputstream to Read the record from
  11001. </member>
  11002. <member name="P:NPOI.HSSF.Record.UnitsRecord.DataSize">
  11003. Size of record (exluding 4 byte header)
  11004. </member>
  11005. <member name="P:NPOI.HSSF.Record.UnitsRecord.Units">
  11006. Get the Units field for the Units record.
  11007. </member>
  11008. <member name="T:NPOI.HSSF.Record.CodepageRecord">
  11009. Title: Codepage Record
  11010. <p>Description: the default characterset. for the workbook</p>
  11011. <p>REFERENCE: PG 293 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)</p>
  11012. <p>Use {@link CodePageUtil} to turn these values into Java code pages
  11013. to encode/decode strings.</p>
  11014. @version 2.0-pre
  11015. </member>
  11016. <member name="F:NPOI.HSSF.Record.CodepageRecord.CODEPAGE">
  11017. Excel 97+ (Biff 8) should always store strings as UTF-16LE or
  11018. compressed versions of that. As such, this should always be
  11019. 0x4b0 = UTF_16, except for files coming from older versions.
  11020. </member>
  11021. <member name="M:NPOI.HSSF.Record.CodepageRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11022. Constructs a CodepageRecord and Sets its fields appropriately
  11023. @param in the RecordInputstream to Read the record from
  11024. </member>
  11025. <member name="P:NPOI.HSSF.Record.CodepageRecord.Codepage">
  11026. Get the codepage for this workbook
  11027. @see #CODEPAGE
  11028. @return codepage - the codepage to Set
  11029. </member>
  11030. <member name="T:NPOI.HSSF.Record.ColumnInfoRecord">
  11031. Title: COLINFO Record<p/>
  11032. Description: Defines with width and formatting for a range of columns<p/>
  11033. REFERENCE: PG 293 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<p/>
  11034. @author Andrew C. Oliver (acoliver at apache dot org)
  11035. @version 2.0-pre
  11036. </member>
  11037. <member name="M:NPOI.HSSF.Record.ColumnInfoRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11038. Constructs a ColumnInfo record and Sets its fields appropriately
  11039. @param in the RecordInputstream to Read the record from
  11040. </member>
  11041. <member name="M:NPOI.HSSF.Record.ColumnInfoRecord.FormatMatches(NPOI.HSSF.Record.ColumnInfoRecord)">
  11042. @return true if the format, options and column width match
  11043. </member>
  11044. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.FirstColumn">
  11045. Get the first column this record defines formatting info for
  11046. @return the first column index (0-based)
  11047. </member>
  11048. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.LastColumn">
  11049. Get the last column this record defines formatting info for
  11050. @return the last column index (0-based)
  11051. </member>
  11052. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.ColumnWidth">
  11053. Get the columns' width in 1/256 of a Char width
  11054. @return column width
  11055. </member>
  11056. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.XFIndex">
  11057. Get the columns' default format info
  11058. @return the extended format index
  11059. @see org.apache.poi.hssf.record.ExtendedFormatRecord
  11060. </member>
  11061. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.Options">
  11062. Get the options bitfield - use the bitSetters instead
  11063. @return the bitfield raw value
  11064. </member>
  11065. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.IsHidden">
  11066. Get whether or not these cells are hidden
  11067. @return whether the cells are hidden.
  11068. @see #SetOptions(short)
  11069. </member>
  11070. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.OutlineLevel">
  11071. Get the outline level for the cells
  11072. @see #SetOptions(short)
  11073. @return outline level for the cells
  11074. </member>
  11075. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.IsCollapsed">
  11076. Get whether the cells are collapsed
  11077. @return wether the cells are collapsed
  11078. @see #SetOptions(short)
  11079. </member>
  11080. <member name="T:NPOI.HSSF.Record.CommonObjectType">
  11081. * The common object data record is used to store all common preferences for an excel object.
  11082. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11083. * Remove the record in src/records/definitions.
  11084. * @author Glen Stampoultzis (glens at apache.org)
  11085. </member>
  11086. <member name="M:NPOI.HSSF.Record.CommonObjectDataSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32)">
  11087. Constructs a CommonObjectData record and Sets its fields appropriately.
  11088. @param in the RecordInputstream to Read the record from
  11089. </member>
  11090. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.DataSize">
  11091. Size of record (exluding 4 byte header)
  11092. </member>
  11093. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.ObjectType">
  11094. Get the object type field for the CommonObjectData record.
  11095. </member>
  11096. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.ObjectId">
  11097. Get the object id field for the CommonObjectData record.
  11098. </member>
  11099. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.Option">
  11100. Get the option field for the CommonObjectData record.
  11101. </member>
  11102. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.Reserved1">
  11103. Get the reserved1 field for the CommonObjectData record.
  11104. </member>
  11105. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.Reserved2">
  11106. Get the reserved2 field for the CommonObjectData record.
  11107. </member>
  11108. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.Reserved3">
  11109. Get the reserved3 field for the CommonObjectData record.
  11110. </member>
  11111. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.IsLocked">
  11112. true if object is locked when sheet has been protected
  11113. @return the locked field value.
  11114. </member>
  11115. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.IsPrintable">
  11116. object appears when printed
  11117. @return the printable field value.
  11118. </member>
  11119. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.IsAutoFill">
  11120. whether object uses an automatic Fill style
  11121. @return the autoFill field value.
  11122. </member>
  11123. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.IsAutoline">
  11124. whether object uses an automatic line style
  11125. @return the autoline field value.
  11126. </member>
  11127. <!-- Badly formed XML comment ignored for member "T:NPOI.HSSF.Record.Common.ExtendedColor" -->
  11128. <member name="P:NPOI.HSSF.Record.Common.ExtendedColor.ColorIndex">
  11129. @return Palette color index, if type is {@link #TYPE_INDEXED}
  11130. </member>
  11131. <member name="P:NPOI.HSSF.Record.Common.ExtendedColor.RGBA">
  11132. @return Red Green Blue Alpha, if type is {@link #TYPE_RGB}
  11133. </member>
  11134. <member name="P:NPOI.HSSF.Record.Common.ExtendedColor.ThemeIndex">
  11135. @return Theme color type index, eg {@link #THEME_DARK_1}, if type is {@link #TYPE_THEMED}
  11136. </member>
  11137. <member name="P:NPOI.HSSF.Record.Common.ExtendedColor.Tint">
  11138. @return Tint and Shade value, between -1 and +1
  11139. </member>
  11140. <member name="T:NPOI.HSSF.Record.Common.FeatFormulaErr2">
  11141. FeatFormulaErr2 (Formula Evaluation Shared Feature) common record part
  11142. This record part specifies Formula Evaluation &amp; Error Ignoring data
  11143. for a sheet, stored as part of a Shared Feature. It can be found in
  11144. records such as {@link FeatRecord}.
  11145. For the full meanings of the flags, see pages 669 and 670
  11146. of the Excel binary file format documentation.
  11147. </member>
  11148. <member name="F:NPOI.HSSF.Record.Common.FeatFormulaErr2.errorCheck">
  11149. What errors we should ignore
  11150. </member>
  11151. <member name="T:NPOI.HSSF.Record.Common.FeatProtection">
  11152. Title: FeatProtection (Protection Shared Feature) common record part
  11153. This record part specifies Protection data for a sheet, stored
  11154. as part of a Shared Feature. It can be found in records such
  11155. as {@link FeatRecord}
  11156. </member>
  11157. <member name="F:NPOI.HSSF.Record.Common.FeatProtection.passwordVerifier">
  11158. 0 means no password. Otherwise indicates the
  11159. password verifier algorithm (same kind as
  11160. {@link PasswordRecord} and
  11161. {@link PasswordRev4Record})
  11162. </member>
  11163. <member name="T:NPOI.HSSF.Record.Common.FeatSmartTag">
  11164. Title: FeatSmartTag (Smart Tag Shared Feature) common record part
  11165. This record part specifies Smart Tag data for a sheet, stored as part
  11166. of a Shared Feature. It can be found in records such as {@link FeatRecord}.
  11167. It is made up of a hash, and a Set of Factoid Data that Makes up
  11168. the smart tags.
  11169. For more details, see page 669 of the Excel binary file
  11170. format documentation.
  11171. </member>
  11172. <member name="T:NPOI.HSSF.Record.Common.FtrHeader">
  11173. Title: FtrHeader (Future Record Header) common record part
  11174. This record part specifies a header for a Ftr (Future)
  11175. style record, which includes extra attributes above and
  11176. beyond those of a traditional record.
  11177. </member>
  11178. <member name="F:NPOI.HSSF.Record.Common.FtrHeader.recordType">
  11179. This MUST match the type on the Containing record
  11180. </member>
  11181. <member name="F:NPOI.HSSF.Record.Common.FtrHeader.grbitFrt">
  11182. This is a FrtFlags
  11183. </member>
  11184. <member name="F:NPOI.HSSF.Record.Common.FtrHeader.associatedRange">
  11185. The range of cells the parent record applies to, or 0 if N/A
  11186. </member>
  11187. <member name="T:NPOI.HSSF.Record.Common.IFutureRecord">
  11188. Title: Future Record, a newer (largely Excel 2007+) record
  11189. which Contains a Future Record Header ({@link FtrHeader})
  11190. </member>
  11191. <member name="T:NPOI.HSSF.Record.Common.SharedFeature">
  11192. Common Interface for all Shared Features
  11193. </member>
  11194. <member name="T:NPOI.HSSF.Record.UnicodeString">
  11195. Title: Unicode String<p/>
  11196. Description: Unicode String - just standard fields that are in several records.
  11197. It is considered more desirable then repeating it in all of them.<p/>
  11198. This is often called a XLUnicodeRichExtendedString in MS documentation.<p/>
  11199. REFERENCE: PG 264 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<p/>
  11200. REFERENCE: PG 951 Excel Binary File Format (.xls) Structure Specification v20091214
  11201. </member>
  11202. <member name="P:NPOI.HSSF.Record.UnicodeString.ExtRst.DataSize">
  11203. Returns our size, excluding our
  11204. 4 byte header
  11205. </member>
  11206. <member name="M:NPOI.HSSF.Record.UnicodeString.Equals(System.Object)">
  11207. Our handling of Equals is inconsistent with CompareTo. The trouble is because we don't truely understand
  11208. rich text fields yet it's difficult to make a sound comparison.
  11209. @param o The object to Compare.
  11210. @return true if the object is actually Equal.
  11211. </member>
  11212. <member name="M:NPOI.HSSF.Record.UnicodeString.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11213. construct a unicode string record and fill its fields, ID is ignored
  11214. @param in the RecordInputstream to read the record from
  11215. </member>
  11216. <member name="P:NPOI.HSSF.Record.UnicodeString.CharCount">
  11217. get the number of characters in the string,
  11218. as an un-wrapped int
  11219. @return number of characters
  11220. </member>
  11221. <member name="P:NPOI.HSSF.Record.UnicodeString.OptionFlags">
  11222. Get the option flags which among other things return if this is a 16-bit or
  11223. 8 bit string
  11224. @return optionflags bitmask
  11225. </member>
  11226. <member name="P:NPOI.HSSF.Record.UnicodeString.String">
  11227. @return the actual string this Contains as a java String object
  11228. </member>
  11229. <member name="M:NPOI.HSSF.Record.UnicodeString.AddFormatRun(NPOI.HSSF.Record.UnicodeString.FormatRun)">
  11230. Adds a font run to the formatted string.
  11231. If a font run exists at the current charcter location, then it is
  11232. Replaced with the font run to be Added.
  11233. </member>
  11234. <member name="M:NPOI.HSSF.Record.UnicodeString.SwapFontUse(System.Int16,System.Int16)">
  11235. Swaps all use in the string of one font index
  11236. for use of a different font index.
  11237. Normally only called when fonts have been
  11238. Removed / re-ordered
  11239. </member>
  11240. <member name="M:NPOI.HSSF.Record.UnicodeString.ToString">
  11241. unlike the real records we return the same as "getString()" rather than debug info
  11242. @see #getDebugInfo()
  11243. @return String value of the record
  11244. </member>
  11245. <member name="M:NPOI.HSSF.Record.UnicodeString.GetDebugInfo">
  11246. return a character representation of the fields of this record
  11247. @return String of output for biffviewer etc.
  11248. </member>
  11249. <member name="M:NPOI.HSSF.Record.UnicodeString.Serialize(NPOI.HSSF.Record.Cont.ContinuableRecordOutput)">
  11250. Serialises out the String. There are special rules
  11251. about where we can and can't split onto
  11252. Continue records.
  11253. </member>
  11254. <member name="T:NPOI.HSSF.Record.ContinueFrt12Record">
  11255. <summary>
  11256. The ContinueFrt12 record specifies a continuation of the data in a preceding Future Record
  11257. Type record that has data longer than 8,224 bytes. Such records are split into several records.
  11258. The first section of the data appears in the base record and subsequent sections appear in
  11259. one or more ContinueFrt12 records that appear after the base record. The preceding base record
  11260. MUST contain a FrtRefHeader or a FrtHeader field.
  11261. </summary>
  11262. <remarks>
  11263. author: Antony liu (antony.apollo at gmail.com)
  11264. </remarks>
  11265. </member>
  11266. <member name="T:NPOI.HSSF.Record.ContinueRecord">
  11267. Title: Continue Record - Helper class used primarily for SST Records
  11268. Description: handles overflow for prior record in the input
  11269. stream; content Is tailored to that prior record
  11270. @author Marc Johnson (mjohnson at apache dot org)
  11271. @author Andrew C. Oliver (acoliver at apache dot org)
  11272. @author Csaba Nagy (ncsaba at yahoo dot com)
  11273. @version 2.0-pre
  11274. </member>
  11275. <member name="M:NPOI.HSSF.Record.ContinueRecord.#ctor">
  11276. default constructor
  11277. </member>
  11278. <member name="M:NPOI.HSSF.Record.ContinueRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11279. Main constructor -- kinda dummy because we don't validate or fill fields
  11280. @param in the RecordInputstream to Read the record from
  11281. </member>
  11282. <member name="M:NPOI.HSSF.Record.ContinueRecord.Write(System.Byte[],System.Int32,System.Nullable{System.Byte},System.Byte[])">
  11283. Writes the full encoding of a Continue record without making an instance
  11284. </member>
  11285. <member name="M:NPOI.HSSF.Record.ContinueRecord.Write(System.Byte[],System.Int32,System.Nullable{System.Byte},System.Byte[],System.Int32,System.Int32)">
  11286. @param initialDataByte (optional - often used for unicode flag).
  11287. If supplied, this will be written before srcData
  11288. @return the total number of bytes written
  11289. </member>
  11290. <member name="P:NPOI.HSSF.Record.ContinueRecord.Data">
  11291. Get the data for continuation
  11292. @return byte array containing all of the continued data
  11293. </member>
  11294. <member name="M:NPOI.HSSF.Record.ContinueRecord.ToString">
  11295. Debugging toString
  11296. @return string representation
  11297. </member>
  11298. <member name="M:NPOI.HSSF.Record.ContinueRecord.Clone">
  11299. Clone this record.
  11300. </member>
  11301. <member name="T:NPOI.HSSF.Record.Cont.ContinuableRecord">
  11302. Common superclass of all records that can produce {@link ContinueRecord}s while being Serialized.
  11303. @author Josh Micich
  11304. </member>
  11305. <member name="M:NPOI.HSSF.Record.Cont.ContinuableRecord.Serialize(NPOI.HSSF.Record.Cont.ContinuableRecordOutput)">
  11306. Serializes this record's content to the supplied data output.<br/>
  11307. The standard BIFF header (ushort sid, ushort size) has been handled by the superclass, so
  11308. only BIFF data should be written by this method. Simple data types can be written with the
  11309. standard {@link LittleEndianOutput} methods. Methods from {@link ContinuableRecordOutput}
  11310. can be used to Serialize strings (with {@link ContinueRecord}s being written as required).
  11311. If necessary, implementors can explicitly start {@link ContinueRecord}s (regardless of the
  11312. amount of remaining space).
  11313. @param out a data output stream
  11314. </member>
  11315. <member name="P:NPOI.HSSF.Record.Cont.ContinuableRecord.RecordSize">
  11316. @return the total Length of the encoded record(s)
  11317. (Note - if any {@link ContinueRecord} is required, this result includes the
  11318. size of those too)
  11319. </member>
  11320. <member name="T:NPOI.HSSF.Record.Cont.ContinuableRecordInput">
  11321. A decorated {@link RecordInputStream} that can read primitive data types
  11322. (short, int, long, etc.) spanned across a {@link ContinueRecord } boundary.
  11323. <p>
  11324. Most records construct themselves from {@link RecordInputStream}.
  11325. This class assumes that a {@link ContinueRecord} record break always occurs at the type boundary,
  11326. however, it is not always so.
  11327. </p>
  11328. Two attachments to <a href="https://issues.apache.org/bugzilla/Show_bug.cgi?id=50779">Bugzilla 50779</a>
  11329. demonstrate that a CONTINUE break can appear right in between two bytes of a unicode character
  11330. or between two bytes of a <code>short</code>. The problematic portion of the data is
  11331. in a Asian Phonetic Settings Block (ExtRst) of a UnicodeString.
  11332. <p>
  11333. {@link RecordInputStream} greedily requests the bytes to be read and stumbles on such files with a
  11334. "Not enough data (1) to read requested (2) bytes" exception. The <code>ContinuableRecordInput</code>
  11335. class circumvents this "type boundary" rule and Reads data byte-by-byte rolling over CONTINUE if necessary.
  11336. </p>
  11337. <p>
  11338. YK: For now (March 2011) this class is only used to read
  11339. @link NPOI.HSSF.Record.Common.UnicodeString.ExtRst} blocks of a UnicodeString.
  11340. </p>
  11341. @author Yegor Kozlov
  11342. </member>
  11343. <member name="T:NPOI.HSSF.Record.Cont.ContinuableRecordOutput">
  11344. An augmented {@link LittleEndianOutput} used for serialization of {@link ContinuableRecord}s.
  11345. This class keeps track of how much remaining space is available in the current BIFF record and
  11346. can start new {@link ContinueRecord}s as required.
  11347. @author Josh Micich
  11348. </member>
  11349. <member name="P:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.TotalSize">
  11350. @return total number of bytes written so far (including all BIFF headers)
  11351. </member>
  11352. <member name="M:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.Terminate">
  11353. Terminates the last record (also updates its 'ushort size' field)
  11354. </member>
  11355. <member name="P:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.AvailableSpace">
  11356. @return number of remaining bytes of space in current record
  11357. </member>
  11358. <member name="M:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.WriteContinue">
  11359. Terminates the current record and starts a new {@link ContinueRecord} (regardless
  11360. of how much space is still available in the current record).
  11361. </member>
  11362. <member name="M:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.WriteStringData(System.String)">
  11363. Writes the 'optionFlags' byte and encoded character data of a unicode string. This includes:
  11364. <ul>
  11365. <li>byte optionFlags</li>
  11366. <li>encoded character data (in "ISO-8859-1" or "UTF-16LE" encoding)</li>
  11367. </ul>
  11368. Notes:
  11369. <ul>
  11370. <li>The value of the 'is16bitEncoded' flag is determined by the actual character data
  11371. of <c>text</c></li>
  11372. <li>The string options flag is never separated (by a {@link ContinueRecord}) from the
  11373. first chunk of character data it refers to.</li>
  11374. <li>The 'ushort Length' field is assumed to have been explicitly written earlier. Hence,
  11375. there may be an intervening {@link ContinueRecord}</li>
  11376. </ul>
  11377. </member>
  11378. <member name="M:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.WriteString(System.String,System.Int32,System.Int32)">
  11379. Writes a unicode string complete with header and character data. This includes:
  11380. <ul>
  11381. <li>ushort Length</li>
  11382. <li>byte optionFlags</li>
  11383. <li>ushort numberOfRichTextRuns (optional)</li>
  11384. <li>ushort extendedDataSize (optional)</li>
  11385. <li>encoded character data (in "ISO-8859-1" or "UTF-16LE" encoding)</li>
  11386. </ul>
  11387. The following bits of the 'optionFlags' byte will be set as appropriate:
  11388. <table border='1'>
  11389. <tr><th>Mask</th><th>Description</th></tr>
  11390. <tr><td>0x01</td><td>is16bitEncoded</td></tr>
  11391. <tr><td>0x04</td><td>hasExtendedData</td></tr>
  11392. <tr><td>0x08</td><td>isRichText</td></tr>
  11393. </table>
  11394. Notes:
  11395. <ul>
  11396. <li>The value of the 'is16bitEncoded' flag is determined by the actual character data
  11397. of <c>text</c></li>
  11398. <li>The string header fields are never separated (by a {@link ContinueRecord}) from the
  11399. first chunk of character data (i.e. the first character is always encoded in the same
  11400. record as the string header).</li>
  11401. </ul>
  11402. </member>
  11403. <member name="F:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.NOPOutput">
  11404. **
  11405. </member>
  11406. <member name="T:NPOI.HSSF.Record.Cont.UnknownLengthRecordOutput">
  11407. Allows the writing of BIFF records when the 'ushort size' header field is not known in advance.
  11408. When the client is finished writing data, it calls {@link #terminate()}, at which point this
  11409. class updates the 'ushort size' with its value.
  11410. @author Josh Micich
  11411. </member>
  11412. <member name="F:NPOI.HSSF.Record.Cont.UnknownLengthRecordOutput._dataSizeOutput">
  11413. for writing the 'ushort size' field once its value is known
  11414. </member>
  11415. <member name="P:NPOI.HSSF.Record.Cont.UnknownLengthRecordOutput.TotalSize">
  11416. includes 4 byte header
  11417. </member>
  11418. <member name="M:NPOI.HSSF.Record.Cont.UnknownLengthRecordOutput.Terminate">
  11419. Finishes writing the current record and updates 'ushort size' field.<br/>
  11420. After this method is called, only {@link #getTotalSize()} may be called.
  11421. </member>
  11422. <member name="T:NPOI.HSSF.Record.CountryRecord">
  11423. Title: Country Record (aka WIN.INI country)
  11424. Description: used for localization. Currently HSSF always Sets this to 1
  11425. and it seems to work fine even in Germany. (es geht's auch fuer Deutschland)
  11426. REFERENCE: PG 298 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  11427. @author Andrew C. Oliver (acoliver at apache dot org)
  11428. @version 2.0-pre
  11429. </member>
  11430. <member name="M:NPOI.HSSF.Record.CountryRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11431. Constructs a CountryRecord and Sets its fields appropriately
  11432. @param in the RecordInputstream to Read the record from
  11433. </member>
  11434. <member name="P:NPOI.HSSF.Record.CountryRecord.DefaultCountry">
  11435. Gets the default country
  11436. @return country ID (1 = US)
  11437. </member>
  11438. <member name="P:NPOI.HSSF.Record.CountryRecord.CurrentCountry">
  11439. Gets the current country
  11440. @return country ID (1 = US)
  11441. </member>
  11442. <member name="T:NPOI.HSSF.Record.CRNCountRecord">
  11443. XCT ?CRN Count
  11444. REFERENCE: 5.114
  11445. @author Josh Micich
  11446. </member>
  11447. <member name="P:NPOI.HSSF.Record.CRNCountRecord.Sid">
  11448. return the non static version of the id for this record.
  11449. </member>
  11450. <member name="T:NPOI.HSSF.Record.CRNRecord">
  11451. Title: CRN
  11452. Description: This record stores the contents of an external cell or cell range
  11453. REFERENCE: 5.23
  11454. @author josh micich
  11455. </member>
  11456. <member name="P:NPOI.HSSF.Record.CRNRecord.Sid">
  11457. return the non static version of the id for this record.
  11458. </member>
  11459. <member name="T:NPOI.HSSF.Record.Crypto.Biff8DecryptingStream">
  11460. @author Josh Micich
  11461. </member>
  11462. <member name="M:NPOI.HSSF.Record.Crypto.Biff8DecryptingStream.ReadRecordSID">
  11463. Reads an unsigned short value without decrypting
  11464. </member>
  11465. <member name="M:NPOI.HSSF.Record.Crypto.Biff8DecryptingStream.ReadDataSize">
  11466. Reads an unsigned short value without decrypting
  11467. </member>
  11468. <member name="M:NPOI.HSSF.Record.Crypto.Biff8EncryptionKey.Create(System.Byte[])">
  11469. Create using the default password and a specified docId
  11470. @param docId 16 bytes
  11471. </member>
  11472. <member name="M:NPOI.HSSF.Record.Crypto.Biff8EncryptionKey.Validate(System.Byte[],System.Byte[])">
  11473. @return <c>true</c> if the keyDigest is compatible with the specified saltData and saltHash
  11474. </member>
  11475. <member name="M:NPOI.HSSF.Record.Crypto.Biff8EncryptionKey.CreateRC4(System.Int32)">
  11476. The {@link RC4} instance needs to be Changed every 1024 bytes.
  11477. @param keyBlockNo used to seed the newly Created {@link RC4}
  11478. </member>
  11479. <member name="F:NPOI.HSSF.Record.Crypto.Biff8EncryptionKey._userPasswordTLS">
  11480. Stores the BIFF8 encryption/decryption password for the current thread. This has been done
  11481. using a {@link ThreadLocal} in order to avoid further overloading the various public APIs
  11482. (e.g. {@link HSSFWorkbook}) that need this functionality.
  11483. </member>
  11484. <member name="P:NPOI.HSSF.Record.Crypto.Biff8EncryptionKey.CurrentUserPassword">
  11485. @return the BIFF8 encryption/decryption password for the current thread.
  11486. <code>null</code> if it is currently unSet.
  11487. </member>
  11488. <member name="T:NPOI.HSSF.Record.Crypto.Biff8RC4">
  11489. Used for both encrypting and decrypting BIFF8 streams. The internal
  11490. {@link RC4} instance is renewed (re-keyed) every 1024 bytes.
  11491. @author Josh Micich
  11492. </member>
  11493. <member name="F:NPOI.HSSF.Record.Crypto.Biff8RC4._streamPos">
  11494. This field is used to keep track of when to change the {@link RC4}
  11495. instance. The change occurs every 1024 bytes. Every byte passed over is
  11496. counted.
  11497. </member>
  11498. <member name="M:NPOI.HSSF.Record.Crypto.Biff8RC4.IsNeverEncryptedRecord(System.Int32)">
  11499. TODO: Additionally, the lbPlyPos (position_of_BOF) field of the BoundSheet8 record MUST NOT be encrypted.
  11500. @return <c>true</c> if record type specified by <c>sid</c> is never encrypted
  11501. </member>
  11502. <member name="M:NPOI.HSSF.Record.Crypto.Biff8RC4.SkipTwoBytes">
  11503. Used when BIFF header fields (sid, size) are being Read. The internal
  11504. {@link RC4} instance must step even when unencrypted bytes are read
  11505. </member>
  11506. <member name="T:NPOI.HSSF.Record.Crypto.RC4">
  11507. Simple implementation of the alleged RC4 algorithm.
  11508. Inspired by <A HREF="http://en.wikipedia.org/wiki/RC4">wikipedia's RC4 article</A>
  11509. @author Josh Micich
  11510. </member>
  11511. <member name="P:NPOI.HSSF.Record.CustomField.Size">
  11512. @return The size of this field in bytes. This operation Is not valid
  11513. Until after the call to <c>FillField()</c>
  11514. </member>
  11515. <member name="M:NPOI.HSSF.Record.CustomField.FillField(NPOI.HSSF.Record.RecordInputStream)">
  11516. Populates this fields data from the byte array passed in1.
  11517. @param in the RecordInputstream to Read the record from
  11518. </member>
  11519. <member name="M:NPOI.HSSF.Record.CustomField.ToString(System.Text.StringBuilder)">
  11520. Appends the string representation of this field to the supplied
  11521. StringBuilder.
  11522. @param str The string buffer to Append to.
  11523. </member>
  11524. <member name="M:NPOI.HSSF.Record.CustomField.SerializeField(System.Int32,System.Byte[])">
  11525. Converts this field to it's byte array form.
  11526. @param offset The offset into the byte array to start writing to.
  11527. @param data The data array to Write to.
  11528. @return The number of bytes written.
  11529. </member>
  11530. <member name="T:NPOI.HSSF.Record.DateWindow1904Record">
  11531. Title: Date Window 1904 Flag record
  11532. Description: Flag specifying whether 1904 date windowing Is used.
  11533. (tick toc tick toc...BOOM!)
  11534. REFERENCE: PG 280 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  11535. @author Andrew C. Oliver (acoliver at apache dot org)
  11536. @version 2.0-pre
  11537. </member>
  11538. <member name="M:NPOI.HSSF.Record.DateWindow1904Record.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11539. Constructs a DateWindow1904 record and Sets its fields appropriately.
  11540. @param in the RecordInputstream to Read the record from
  11541. </member>
  11542. <member name="P:NPOI.HSSF.Record.DateWindow1904Record.Windowing">
  11543. Gets whether or not to use 1904 date windowing (which means you'll be screwed in 2004)
  11544. @return window flag - 0/1 (false,true)
  11545. </member>
  11546. <member name="T:NPOI.HSSF.Record.DBCellRecord">
  11547. Title: DBCell Record
  11548. Description: Used by Excel and other MS apps to quickly Find rows in the sheets.
  11549. REFERENCE: PG 299/440 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  11550. @author Andrew C. Oliver (acoliver at apache dot org)
  11551. @author Jason Height
  11552. @version 2.0-pre
  11553. </member>
  11554. <member name="M:NPOI.HSSF.Record.DBCellRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11555. Constructs a DBCellRecord and Sets its fields appropriately
  11556. @param in the RecordInputstream to Read the record from
  11557. </member>
  11558. <member name="M:NPOI.HSSF.Record.DBCellRecord.#ctor(System.Int32,System.Int16[])">
  11559. offset from the start of this DBCellRecord to the start of the first cell in
  11560. the next DBCell block.
  11561. </member>
  11562. <member name="P:NPOI.HSSF.Record.DBCellRecord.RowOffset">
  11563. Gets offset from the start of this DBCellRecord to the start of the first cell in
  11564. the next DBCell block.
  11565. @return rowoffset to the start of the first cell in the next DBCell block
  11566. </member>
  11567. <member name="M:NPOI.HSSF.Record.DBCellRecord.GetCellOffsetAt(System.Int32)">
  11568. return the cell offset in the array
  11569. @param index of the cell offset to retrieve
  11570. @return celloffset from the celloffset array
  11571. </member>
  11572. <member name="P:NPOI.HSSF.Record.DBCellRecord.NumCellOffsets">
  11573. Get the number of cell offsets in the celloffset array
  11574. @return number of cell offsets
  11575. </member>
  11576. <member name="M:NPOI.HSSF.Record.DBCellRecord.CalculateSizeOfRecords(System.Int32,System.Int32)">
  11577. @returns the size of the Group of <c>DBCellRecord</c>s needed to encode
  11578. the specified number of blocks and rows
  11579. </member>
  11580. <member name="T:NPOI.HSSF.Record.DConRefRecord">
  11581. DConRef records specify a range in a workbook (internal or external) that serves as a data source
  11582. for pivot tables or data consolidation.
  11583. Represents a <code>DConRef</code> Structure
  11584. <a href="http://msdn.microsoft.com/en-us/library/dd923854(office.12).aspx">[MS-XLS s.
  11585. 2.4.86]</a>, and the contained <code>DConFile</code> structure
  11586. <a href="http://msdn.microsoft.com/en-us/library/dd950157(office.12).aspx">
  11587. [MS-XLS s. 2.5.69]</a>. This in turn contains a <code>XLUnicodeStringNoCch</code>
  11588. <a href="http://msdn.microsoft.com/en-us/library/dd910585(office.12).aspx">
  11589. [MS-XLS s. 2.5.296]</a>.
  11590. <pre>
  11591. _______________________________
  11592. | DConRef |
  11593. (bytes) +-+-+-+-+-+-+-+-+-+-+...+-+-+-+-+
  11594. | ref |cch| stFile | un|
  11595. +-+-+-+-+-+-+-+-+-+-+...+-+-+-+-+
  11596. |
  11597. _________|_____________________
  11598. |DConFile / XLUnicodeStringNoCch|
  11599. +-+-+-+-+-+-+-+-+-+-+-+...+-+-+-+
  11600. (bits) |h| reserved | rgb |
  11601. +-+-+-+-+-+-+-+-+-+-+-+...+-+-+-+
  11602. </pre>
  11603. Where
  11604. <ul>
  11605. <li><code>DConFile.h = 0x00</code> if the characters in<code>rgb</code> are single byte, and
  11606. <code>DConFile.h = 0x01</code> if they are double byte. <br/>
  11607. If they are double byte, then<br/>
  11608. <ul>
  11609. <li> If it exists, the length of <code>DConRef.un = 2</code>. Otherwise it is 1.</li>
  11610. <li> The length of <code>DConFile.rgb = (2 * DConRef.cch)</code>. Otherwise it is equal to
  11611. <code>DConRef.cch</code></li>.
  11612. </ul>
  11613. </li>
  11614. <li><code>DConRef.rgb</code> starts with <code>0x01</code> if it is an external reference,
  11615. and with <code>0x02</code> if it is a self-reference.</li>
  11616. </ul>
  11617. At the moment this class is read-only.
  11618. @author Niklas Rehfeld
  11619. </member>
  11620. <member name="F:NPOI.HSSF.Record.DConRefRecord.sid">
  11621. The id of the record type,
  11622. <code>sid = {@value}</code>
  11623. </member>
  11624. <member name="F:NPOI.HSSF.Record.DConRefRecord.firstRow">
  11625. A RefU structure specifying the range of cells if this record is part of an SXTBL.
  11626. <a href="http://msdn.microsoft.com/en-us/library/dd920420(office.12).aspx">
  11627. [MS XLS s.2.5.211]</a>
  11628. </member>
  11629. <member name="F:NPOI.HSSF.Record.DConRefRecord.lastRow">
  11630. A RefU structure specifying the range of cells if this record is part of an SXTBL.
  11631. <a href="http://msdn.microsoft.com/en-us/library/dd920420(office.12).aspx">
  11632. [MS XLS s.2.5.211]</a>
  11633. </member>
  11634. <member name="F:NPOI.HSSF.Record.DConRefRecord.firstCol">
  11635. A RefU structure specifying the range of cells if this record is part of an SXTBL.
  11636. <a href="http://msdn.microsoft.com/en-us/library/dd920420(office.12).aspx">
  11637. [MS XLS s.2.5.211]</a>
  11638. </member>
  11639. <member name="F:NPOI.HSSF.Record.DConRefRecord.lastCol">
  11640. A RefU structure specifying the range of cells if this record is part of an SXTBL.
  11641. <a href="http://msdn.microsoft.com/en-us/library/dd920420(office.12).aspx">
  11642. [MS XLS s.2.5.211]</a>
  11643. </member>
  11644. <member name="F:NPOI.HSSF.Record.DConRefRecord.charCount">
  11645. the number of chars in the link
  11646. </member>
  11647. <member name="F:NPOI.HSSF.Record.DConRefRecord.charType">
  11648. the type of characters (single or double byte)
  11649. </member>
  11650. <member name="F:NPOI.HSSF.Record.DConRefRecord.path">
  11651. The link's path string. This is the <code>rgb</code> field of a
  11652. <code>XLUnicodeStringNoCch</code>. Therefore it will contain at least one leading special
  11653. character (0x01 or 0x02) and probably other ones.<p/>
  11654. @see <a href="http://msdn.microsoft.com/en-us/library/dd923491(office.12).aspx">
  11655. DConFile [MS-XLS s. 2.5.77]</a> and
  11656. <a href="http://msdn.microsoft.com/en-us/library/dd950157(office.12).aspx">
  11657. VirtualPath [MS-XLS s. 2.5.69]</a>
  11658. <p/>
  11659. </member>
  11660. <member name="F:NPOI.HSSF.Record.DConRefRecord._unused">
  11661. unused bits at the end, must be set to 0.
  11662. </member>
  11663. <member name="M:NPOI.HSSF.Record.DConRefRecord.#ctor(System.Byte[])">
  11664. Read constructor.
  11665. @param data byte array containing a DConRef Record, including the header.
  11666. </member>
  11667. <member name="M:NPOI.HSSF.Record.DConRefRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11668. Read Constructor.
  11669. @param inStream RecordInputStream containing a DConRefRecord structure.
  11670. </member>
  11671. <member name="P:NPOI.HSSF.Record.DConRefRecord.FirstColumn">
  11672. @return The first column of the range.
  11673. </member>
  11674. <member name="P:NPOI.HSSF.Record.DConRefRecord.FirstRow">
  11675. @return The first row of the range.
  11676. </member>
  11677. <member name="P:NPOI.HSSF.Record.DConRefRecord.LastColumn">
  11678. @return The last column of the range.
  11679. </member>
  11680. <member name="P:NPOI.HSSF.Record.DConRefRecord.LastRow">
  11681. @return The last row of the range.
  11682. </member>
  11683. <member name="M:NPOI.HSSF.Record.DConRefRecord.GetPath">
  11684. @return raw path byte array.
  11685. </member>
  11686. <member name="P:NPOI.HSSF.Record.DConRefRecord.ReadablePath">
  11687. @return the link's path, with the special characters stripped/replaced. May be null.
  11688. See MS-XLS 2.5.277 (VirtualPath)
  11689. </member>
  11690. <member name="P:NPOI.HSSF.Record.DConRefRecord.IsExternalRef">
  11691. Checks if the data source in this reference record is external to this sheet or internal.
  11692. @return true iff this is an external reference.
  11693. </member>
  11694. <member name="T:NPOI.HSSF.Record.DefaultColWidthRecord">
  11695. Title: Default Column Width Record
  11696. Description: Specifies the default width for columns that have no specific
  11697. width Set.
  11698. REFERENCE: PG 302 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  11699. @author Andrew C. Oliver (acoliver at apache dot org)
  11700. @author Jason Height (jheight at chariot dot net dot au)
  11701. @version 2.0-pre
  11702. </member>
  11703. <member name="F:NPOI.HSSF.Record.DefaultColWidthRecord.DEFAULT_COLUMN_WIDTH">
  11704. The default column width is 8 characters
  11705. </member>
  11706. <member name="M:NPOI.HSSF.Record.DefaultColWidthRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11707. Constructs a DefaultColumnWidth record and Sets its fields appropriately.
  11708. @param in the RecordInputstream to Read the record from
  11709. </member>
  11710. <member name="P:NPOI.HSSF.Record.DefaultColWidthRecord.ColWidth">
  11711. Get the default column width
  11712. @return defaultwidth for columns
  11713. </member>
  11714. <member name="T:NPOI.HSSF.Record.DefaultRowHeightRecord">
  11715. Title: Default Row Height Record
  11716. Description: Row height for rows with Undefined or not explicitly defined
  11717. heights.
  11718. REFERENCE: PG 301 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  11719. @author Andrew C. Oliver (acoliver at apache dot org)
  11720. @author Jason Height (jheight at chariot dot net dot au)
  11721. @version 2.0-pre
  11722. </member>
  11723. <member name="F:NPOI.HSSF.Record.DefaultRowHeightRecord.DEFAULT_ROW_HEIGHT">
  11724. The default row height for empty rows is 255 twips (255 / 20 == 12.75 points)
  11725. </member>
  11726. <member name="M:NPOI.HSSF.Record.DefaultRowHeightRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11727. <summary>
  11728. Constructs a DefaultRowHeight record and Sets its fields appropriately.
  11729. </summary>
  11730. <param name="in1">the RecordInputstream to Read the record from</param>
  11731. </member>
  11732. <member name="P:NPOI.HSSF.Record.DefaultRowHeightRecord.RowHeight">
  11733. <summary>
  11734. Get the default row height
  11735. </summary>
  11736. </member>
  11737. <member name="T:NPOI.HSSF.Record.DeltaRecord">
  11738. Title: Delta Record
  11739. Description: controls the accuracy of the calculations
  11740. REFERENCE: PG 303 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  11741. @author Andrew C. Oliver (acoliver at apache dot org)
  11742. @author Jason Height (jheight at chariot dot net dot au)
  11743. @version 2.0-pre
  11744. </member>
  11745. <member name="M:NPOI.HSSF.Record.DeltaRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11746. Constructs a Delta record and Sets its fields appropriately.
  11747. @param in the RecordInputstream to Read the record from
  11748. </member>
  11749. <member name="P:NPOI.HSSF.Record.DeltaRecord.MaxChange">
  11750. Get the maximum Change
  11751. @return maxChange - maximum rounding error
  11752. </member>
  11753. <member name="T:NPOI.HSSF.Record.DimensionsRecord">
  11754. Title: Dimensions Record
  11755. Description: provides the minumum and maximum bounds
  11756. of a sheet.
  11757. REFERENCE: PG 303 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  11758. @author Andrew C. Oliver (acoliver at apache dot org)
  11759. @author Jason Height (jheight at chariot dot net dot au)
  11760. @version 2.0-pre
  11761. </member>
  11762. <member name="M:NPOI.HSSF.Record.DimensionsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11763. Constructs a Dimensions record and Sets its fields appropriately.
  11764. @param in the RecordInputstream to Read the record from
  11765. </member>
  11766. <member name="P:NPOI.HSSF.Record.DimensionsRecord.FirstRow">
  11767. Get the first row number for the sheet
  11768. @return row - first row on the sheet
  11769. </member>
  11770. <member name="P:NPOI.HSSF.Record.DimensionsRecord.LastRow">
  11771. Get the last row number for the sheet
  11772. @return row - last row on the sheet
  11773. </member>
  11774. <member name="P:NPOI.HSSF.Record.DimensionsRecord.FirstCol">
  11775. Get the first column number for the sheet
  11776. @return column - first column on the sheet
  11777. </member>
  11778. <member name="P:NPOI.HSSF.Record.DimensionsRecord.LastCol">
  11779. Get the last col number for the sheet
  11780. @return column - last column on the sheet
  11781. </member>
  11782. <member name="M:NPOI.HSSF.Record.DrawingGroupRecord.ProcessChildRecords">
  11783. Process the bytes into escher records.
  11784. (Not done by default in case we break things,
  11785. Unless you Set the "poi.deSerialize.escher"
  11786. system property)
  11787. </member>
  11788. <member name="P:NPOI.HSSF.Record.DrawingGroupRecord.RecordSize">
  11789. Size of record (including 4 byte headers for all sections)
  11790. </member>
  11791. <member name="T:NPOI.HSSF.Record.DrawingRecord">
  11792. DrawingRecord (0x00EC)<p/>
  11793. </member>
  11794. <member name="M:NPOI.HSSF.Record.DrawingRecord.Clone">
  11795. Cloning of drawing records must be executed through HSSFPatriarch, because all id's must be changed
  11796. @return cloned drawing records
  11797. </member>
  11798. <member name="T:NPOI.HSSF.Record.DrawingRecordForBiffViewer">
  11799. This Is purely for the biff viewer. During normal operations we don't want
  11800. to be seeing this.
  11801. </member>
  11802. <member name="T:NPOI.HSSF.Record.Drawing.OfficeArtFOPTEOPID">
  11803. <summary>
  11804. specifies the header for an entry in a property table
  11805. </summary>
  11806. </member>
  11807. <member name="P:NPOI.HSSF.Record.Drawing.OfficeArtFOPTEOPID.OpId">
  11808. <summary>
  11809. specifies the identifier of the property in this entry.
  11810. </summary>
  11811. </member>
  11812. <member name="P:NPOI.HSSF.Record.Drawing.OfficeArtFOPTEOPID.IsBlipId">
  11813. <summary>
  11814. whether the value in the op field is a BLIP identifier.
  11815. If this value equals 0x1, the value in the op field specifies the BLIP identifier
  11816. in the OfficeArtBStoreContainer record, as defined in section 2.2.20. If fComplex equals 0x1, this bit MUST be ignored.
  11817. </summary>
  11818. </member>
  11819. <member name="P:NPOI.HSSF.Record.Drawing.OfficeArtFOPTEOPID.IsComplex">
  11820. <summary>
  11821. specifies whether this property is a complex property.
  11822. If this value equals 0x1, the op field specifies the size of the data for this property, rather than the property data itself.
  11823. </summary>
  11824. </member>
  11825. <member name="T:NPOI.HSSF.Record.Drawing.OfficeArtRecordHeader">
  11826. <summary>
  11827. specifies the common record header for all the OfficeArt records.
  11828. </summary>
  11829. <remarks>
  11830. author: Antony liu (antony.apollo at gmail.com)
  11831. </remarks>
  11832. </member>
  11833. <member name="P:NPOI.HSSF.Record.Drawing.OfficeArtRecordHeader.Ver">
  11834. <summary>
  11835. specifies the version if the record is an atom. If the record is a container, this field MUST contain 0xF.
  11836. </summary>
  11837. </member>
  11838. <member name="P:NPOI.HSSF.Record.Drawing.OfficeArtRecordHeader.Instance">
  11839. <summary>
  11840. An unsigned integer that differentiates an atom from the other atoms that are contained in the record.
  11841. </summary>
  11842. </member>
  11843. <member name="P:NPOI.HSSF.Record.Drawing.OfficeArtRecordHeader.Type">
  11844. <summary>
  11845. specifies the type of the record. This value MUST be from 0xF000 through 0xFFFF, inclusive.
  11846. </summary>
  11847. </member>
  11848. <member name="P:NPOI.HSSF.Record.Drawing.OfficeArtRecordHeader.Len">
  11849. <summary>
  11850. that specifies the length, in bytes, of the record.
  11851. If the record is an atom, this value specifies the length of the atom, excluding the header.
  11852. If the record is a container, this value specifies the sum of the lengths of the atoms that
  11853. the record contains, plus the length of the record header for each atom.
  11854. </summary>
  11855. </member>
  11856. <member name="T:NPOI.HSSF.Record.DSFRecord">
  11857. Title: double Stream Flag Record
  11858. Description: tells if this Is a double stream file. (always no for HSSF generated files)
  11859. double Stream files contain both BIFF8 and BIFF7 workbooks.
  11860. REFERENCE: PG 305 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  11861. @author Andrew C. Oliver (acoliver at apache dot org)
  11862. @version 2.0-pre
  11863. </member>
  11864. <member name="M:NPOI.HSSF.Record.DSFRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11865. Constructs a DBCellRecord and Sets its fields appropriately.
  11866. @param in the RecordInputstream to Read the record from
  11867. </member>
  11868. <member name="T:NPOI.HSSF.Record.DVALRecord">
  11869. Title: DATAVALIDATIONS Record
  11870. Description: used in data validation ;
  11871. This record Is the list header of all data validation records (0x01BE) in the current sheet.
  11872. @author Dragos Buleandra (dragos.buleandra@trade2b.ro)
  11873. </member>
  11874. <member name="F:NPOI.HSSF.Record.DVALRecord.field_1_options">
  11875. Options of the DVAL
  11876. </member>
  11877. <member name="F:NPOI.HSSF.Record.DVALRecord.field_2_horiz_pos">
  11878. Horizontal position of the dialog
  11879. </member>
  11880. <member name="F:NPOI.HSSF.Record.DVALRecord.field_3_vert_pos">
  11881. Vertical position of the dialog
  11882. </member>
  11883. <member name="F:NPOI.HSSF.Record.DVALRecord.field_cbo_id">
  11884. Object ID of the drop down arrow object for list boxes ;
  11885. in our case this will be always FFFF , Until
  11886. MSODrawingGroup and MSODrawing records are implemented
  11887. </member>
  11888. <member name="F:NPOI.HSSF.Record.DVALRecord.field_5_dv_no">
  11889. Number of following DV Records
  11890. </member>
  11891. <member name="M:NPOI.HSSF.Record.DVALRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11892. Constructs a DVAL record and Sets its fields appropriately.
  11893. @param in the RecordInputstream to Read the record from
  11894. </member>
  11895. <member name="P:NPOI.HSSF.Record.DVALRecord.Options">
  11896. @return the field_1_options
  11897. </member>
  11898. <member name="P:NPOI.HSSF.Record.DVALRecord.HorizontalPos">
  11899. @return the Horizontal position of the dialog
  11900. </member>
  11901. <member name="P:NPOI.HSSF.Record.DVALRecord.VerticalPos">
  11902. @return the the Vertical position of the dialog
  11903. </member>
  11904. <member name="P:NPOI.HSSF.Record.DVALRecord.ObjectID">
  11905. Get Object ID of the drop down arrow object for list boxes
  11906. </member>
  11907. <member name="P:NPOI.HSSF.Record.DVALRecord.DVRecNo">
  11908. Get number of following DV records
  11909. </member>
  11910. <member name="T:NPOI.HSSF.Record.DVRecord">
  11911. Title: DATAVALIDATION Record (0x01BE)<p/>
  11912. Description: This record stores data validation Settings and a list of cell ranges
  11913. which contain these Settings. The data validation Settings of a sheet
  11914. are stored in a sequential list of DV records. This list Is followed by
  11915. DVAL record(s)
  11916. @author Dragos Buleandra (dragos.buleandra@trade2b.ro)
  11917. @version 2.0-pre
  11918. </member>
  11919. <member name="F:NPOI.HSSF.Record.DVRecord._option_flags">
  11920. Option flags
  11921. </member>
  11922. <member name="F:NPOI.HSSF.Record.DVRecord._promptTitle">
  11923. Title of the prompt box
  11924. </member>
  11925. <member name="F:NPOI.HSSF.Record.DVRecord._errorTitle">
  11926. Title of the error box
  11927. </member>
  11928. <member name="F:NPOI.HSSF.Record.DVRecord._promptText">
  11929. Text of the prompt box
  11930. </member>
  11931. <member name="F:NPOI.HSSF.Record.DVRecord._errorText">
  11932. Text of the error box
  11933. </member>
  11934. <member name="F:NPOI.HSSF.Record.DVRecord._not_used_1">
  11935. Not used - Excel seems to always write 0x3FE0
  11936. </member>
  11937. <member name="F:NPOI.HSSF.Record.DVRecord._formula1">
  11938. Formula data for first condition (RPN token array without size field)
  11939. </member>
  11940. <member name="F:NPOI.HSSF.Record.DVRecord._not_used_2">
  11941. Not used - Excel seems to always write 0x0000
  11942. </member>
  11943. <member name="F:NPOI.HSSF.Record.DVRecord._formula2">
  11944. Formula data for second condition (RPN token array without size field)
  11945. </member>
  11946. <member name="F:NPOI.HSSF.Record.DVRecord._regions">
  11947. Cell range address list with all affected ranges
  11948. </member>
  11949. <member name="F:NPOI.HSSF.Record.DVRecord.opt_data_type">
  11950. Option flags field
  11951. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  11952. </member>
  11953. <member name="M:NPOI.HSSF.Record.DVRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11954. Constructs a DV record and Sets its fields appropriately.
  11955. @param in the RecordInputstream to Read the record from
  11956. </member>
  11957. <member name="M:NPOI.HSSF.Record.DVRecord.ResolveTitleText(System.String)">
  11958. When entered via the UI, Excel translates empty string into "\0"
  11959. While it is possible to encode the title/text as empty string (Excel doesn't exactly crash),
  11960. the resulting tool-tip text / message box looks wrong. It is best to do the same as the
  11961. Excel UI and encode 'not present' as "\0".
  11962. </member>
  11963. <member name="P:NPOI.HSSF.Record.DVRecord.DataType">
  11964. Get the condition data type
  11965. @return the condition data type
  11966. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  11967. </member>
  11968. <member name="P:NPOI.HSSF.Record.DVRecord.ErrorStyle">
  11969. Get the condition error style
  11970. @return the condition error style
  11971. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  11972. </member>
  11973. <member name="P:NPOI.HSSF.Record.DVRecord.ListExplicitFormula">
  11974. return true if in list validations the string list Is explicitly given in the formula, false otherwise
  11975. @return true if in list validations the string list Is explicitly given in the formula, false otherwise
  11976. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  11977. </member>
  11978. <member name="P:NPOI.HSSF.Record.DVRecord.EmptyCellAllowed">
  11979. return true if empty values are allowed in cells, false otherwise
  11980. @return if empty values are allowed in cells, false otherwise
  11981. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  11982. </member>
  11983. <member name="P:NPOI.HSSF.Record.DVRecord.SuppressDropdownArrow">
  11984. @return <code>true</code> if drop down arrow should be suppressed when list validation is
  11985. used, <code>false</code> otherwise
  11986. </member>
  11987. <member name="P:NPOI.HSSF.Record.DVRecord.ShowPromptOnCellSelected">
  11988. return true if a prompt window should appear when cell Is selected, false otherwise
  11989. @return if a prompt window should appear when cell Is selected, false otherwise
  11990. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  11991. </member>
  11992. <member name="P:NPOI.HSSF.Record.DVRecord.ShowErrorOnInvalidValue">
  11993. return true if an error window should appear when an invalid value Is entered in the cell, false otherwise
  11994. @return if an error window should appear when an invalid value Is entered in the cell, false otherwise
  11995. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  11996. </member>
  11997. <member name="P:NPOI.HSSF.Record.DVRecord.ConditionOperator">
  11998. Get the condition operator
  11999. @return the condition operator
  12000. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  12001. </member>
  12002. <member name="P:NPOI.HSSF.Record.DVRecord.OptionFlags">
  12003. Gets the option flags field.
  12004. @return options - the option flags field
  12005. </member>
  12006. <member name="M:NPOI.HSSF.Record.DVRecord.Clone">
  12007. Clones the object. Uses serialisation, as the
  12008. contents are somewhat complex
  12009. </member>
  12010. <member name="T:NPOI.HSSF.Record.EmbeddedObjectRefSubRecord">
  12011. A sub-record within the OBJ record which stores a reference to an object
  12012. stored in a Separate entry within the OLE2 compound file.
  12013. @author Daniel Noll
  12014. </member>
  12015. <member name="F:NPOI.HSSF.Record.EmbeddedObjectRefSubRecord.field_2_refPtg">
  12016. either an area or a cell ref
  12017. </member>
  12018. <member name="F:NPOI.HSSF.Record.EmbeddedObjectRefSubRecord.field_4_unknownByte">
  12019. Formulas often have a single non-zero trailing byte.
  12020. This is in a similar position to he pre-streamId padding
  12021. It is unknown if the value is important (it seems to mirror a value a few bytes earlier)
  12022. </member>
  12023. <member name="M:NPOI.HSSF.Record.EmbeddedObjectRefSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32)">
  12024. Constructs an EmbeddedObjectRef record and Sets its fields appropriately.
  12025. @param in the record input stream.
  12026. </member>
  12027. <member name="P:NPOI.HSSF.Record.EmbeddedObjectRefSubRecord.StreamId">
  12028. Gets the stream ID containing the actual data. The data itself
  12029. can be found under a top-level directory entry in the OLE2 filesystem
  12030. under the name "MBD<var>xxxxxxxx</var>" where <var>xxxxxxxx</var> is
  12031. this ID converted into hex (in big endian order, funnily enough.)
  12032. @return the data stream ID. Possibly <c>null</c>
  12033. </member>
  12034. <member name="T:NPOI.HSSF.Record.EndSubRecord">
  12035. * The end data record is used to denote the end of the subrecords.
  12036. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  12037. * Remove the record in src/records/definitions.
  12038. * @author Glen Stampoultzis (glens at apache.org)
  12039. </member>
  12040. <member name="M:NPOI.HSSF.Record.EndSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32)">
  12041. Constructs a End record and Sets its fields appropriately.
  12042. @param in the RecordInputstream to Read the record from
  12043. </member>
  12044. <member name="P:NPOI.HSSF.Record.EndSubRecord.DataSize">
  12045. Size of record (exluding 4 byte header)
  12046. </member>
  12047. <member name="T:NPOI.HSSF.Record.EOFRecord">
  12048. End Of File record.
  12049. Description: Marks the end of records belonging to a particular object in the
  12050. HSSF File
  12051. REFERENCE: PG 307 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12052. @author Andrew C. Oliver (acoliver at apache dot org)
  12053. @author Jason Height (jheight at chariot dot net dot au)
  12054. @version 2.0-pre
  12055. </member>
  12056. <member name="M:NPOI.HSSF.Record.EOFRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12057. Constructs a EOFRecord record and Sets its fields appropriately.
  12058. @param in the RecordInputstream to Read the record from
  12059. </member>
  12060. <member name="T:NPOI.HSSF.Record.EscherAggregate">
  12061. This class Is used to aggregate the MSODRAWING and OBJ record
  12062. combinations. This Is necessary due to the bizare way in which
  12063. these records are Serialized. What happens Is that you Get a
  12064. combination of MSODRAWING -> OBJ -> MSODRAWING -> OBJ records
  12065. but the escher records are Serialized _across_ the MSODRAWING
  12066. records.
  12067. It Gets even worse when you start looking at TXO records.
  12068. So what we do with this class Is aggregate lazily. That Is
  12069. we don't aggregate the MSODRAWING -> OBJ records Unless we
  12070. need to modify them.
  12071. At first document contains 4 types of records which belong to drawing layer.
  12072. There are can be such sequence of record:
  12073. <p/>
  12074. DrawingRecord
  12075. ContinueRecord
  12076. ...
  12077. ContinueRecord
  12078. ObjRecord | TextObjectRecord
  12079. .....
  12080. ContinueRecord
  12081. ...
  12082. ContinueRecord
  12083. ObjRecord | TextObjectRecord
  12084. NoteRecord
  12085. ...
  12086. NoteRecord
  12087. <p/>
  12088. To work with shapes we have to read data from Drawing and Continue records into single array of bytes and
  12089. build escher(office art) records tree from this array.
  12090. Each shape in drawing layer matches corresponding ObjRecord
  12091. Each textbox matches corresponding TextObjectRecord
  12092. <p/>
  12093. ObjRecord contains information about shape. Thus each ObjRecord corresponds EscherContainerRecord(SPGR)
  12094. <p/>
  12095. EscherAggrefate contains also NoteRecords
  12096. NoteRecords must be serial
  12097. @author Glen Stampoultzis (glens at apache.org)
  12098. </member>
  12099. <member name="F:NPOI.HSSF.Record.EscherAggregate.shapeToObj">
  12100. Maps shape container objects to their OBJ records
  12101. </member>
  12102. <member name="F:NPOI.HSSF.Record.EscherAggregate.tailRec">
  12103. list of "tail" records that need to be Serialized after all drawing Group records
  12104. </member>
  12105. <member name="P:NPOI.HSSF.Record.EscherAggregate.Sid">
  12106. @return Returns the current sid.
  12107. </member>
  12108. <member name="M:NPOI.HSSF.Record.EscherAggregate.ToString">
  12109. Calculates the string representation of this record. This Is
  12110. simply a dump of all the records.
  12111. </member>
  12112. <member name="M:NPOI.HSSF.Record.EscherAggregate.ToXml(System.String)">
  12113. Calculates the xml representation of this record. This is
  12114. simply a dump of all the records.
  12115. @param tab - string which must be added before each line (used by default '\t')
  12116. @return xml representation of the all aggregated records
  12117. </member>
  12118. <member name="M:NPOI.HSSF.Record.EscherAggregate.IsDrawingLayerRecord(System.Int16)">
  12119. @param sid - record sid we want to check if it belongs to drawing layer
  12120. @return true if record is instance of DrawingRecord or ContinueRecord or ObjRecord or TextObjRecord
  12121. </member>
  12122. <member name="M:NPOI.HSSF.Record.EscherAggregate.CreateAggregate(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase},System.Int32)">
  12123. Collapses the drawing records into an aggregate.
  12124. read Drawing, Obj, TxtObj, Note and Continue records into single byte array,
  12125. create Escher tree from byte array, create map &lt;EscherRecord, Record&gt;
  12126. @param records - list of all records inside sheet
  12127. @param locFirstDrawingRecord - location of the first DrawingRecord inside sheet
  12128. @return new EscherAggregate create from all aggregated records which belong to drawing layer
  12129. </member>
  12130. <member name="M:NPOI.HSSF.Record.EscherAggregate.Serialize(System.Int32,System.Byte[])">
  12131. Serializes this aggregate to a byte array. Since this Is an aggregate
  12132. record it will effectively Serialize the aggregated records.
  12133. @param offset The offset into the start of the array.
  12134. @param data The byte array to Serialize to.
  12135. @return The number of bytes Serialized.
  12136. </member>
  12137. <member name="M:NPOI.HSSF.Record.EscherAggregate.WriteDataIntoDrawingRecord(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
  12138. @param drawingData - escher records saved into single byte array
  12139. @param writtenEscherBytes - count of bytes already saved into drawing records (we should know it to decide create
  12140. drawing or continue record)
  12141. @param pos current position of data array
  12142. @param data - array of bytes where drawing records must be serialized
  12143. @param i - number of shape, saved into data array
  12144. @return offset of data array after serialization
  12145. </member>
  12146. <member name="M:NPOI.HSSF.Record.EscherAggregate.GetEscherRecordSize(System.Collections.Generic.List{NPOI.DDF.EscherRecord})">
  12147. How many bytes do the raw escher records contain.
  12148. @param records List of escher records
  12149. @return the number of bytes
  12150. </member>
  12151. <member name="M:NPOI.HSSF.Record.EscherAggregate.GetSid(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase},System.Int32)">
  12152. @param records list of records to look into
  12153. @param loc - location of the record which sid must be returned
  12154. @return sid of the record with selected location
  12155. </member>
  12156. <member name="P:NPOI.HSSF.Record.EscherAggregate.RecordSize">
  12157. @return record size, including header size of obj, text, note, drawing, continue records
  12158. </member>
  12159. <member name="M:NPOI.HSSF.Record.EscherAggregate.BuildBaseTree">
  12160. create base tree with such structure:
  12161. EscherDgContainer
  12162. -EscherSpgrContainer
  12163. --EscherSpContainer
  12164. ---EscherSpRecord
  12165. ---EscherSpgrRecord
  12166. ---EscherSpRecord
  12167. -EscherDgRecord
  12168. id of DgRecord and SpRecord are empty and must be set later by HSSFPatriarch
  12169. </member>
  12170. <member name="M:NPOI.HSSF.Record.EscherAggregate.Children(System.Byte[],System.Int16,System.Int32)">
  12171. Unused since this Is an aggregate record. Use CreateAggregate().
  12172. @see #CreateAggregate
  12173. </member>
  12174. <member name="M:NPOI.HSSF.Record.EscherAggregate.GetEscherChild(NPOI.DDF.EscherContainerRecord,System.Int32)">
  12175. Converts the Records into UserModel
  12176. objects on the bound HSSFPatriarch
  12177. </member>
  12178. <member name="M:NPOI.HSSF.Record.EscherAggregate.AssociateShapeToObjRecord(NPOI.DDF.EscherRecord,NPOI.HSSF.Record.Record)">
  12179. <summary>
  12180. Associates an escher record to an OBJ record or a TXO record.
  12181. </summary>
  12182. <param name="r">ClientData or Textbox record</param>
  12183. <param name="objRecord">Obj or TextObj record</param>
  12184. </member>
  12185. <member name="M:NPOI.HSSF.Record.EscherAggregate.RemoveShapeToObjRecord(NPOI.DDF.EscherRecord)">
  12186. <summary>
  12187. Remove echerRecord and associated to it Obj or TextObj record
  12188. </summary>
  12189. <param name="rec">clientData or textbox record to be removed</param>
  12190. </member>
  12191. <member name="P:NPOI.HSSF.Record.EscherAggregate.TailRecords">
  12192. @return unmodifiable copy of tail records. We need to access them when building shapes.
  12193. Every HSSFComment shape has a link to a NoteRecord from the tailRec collection.
  12194. </member>
  12195. <member name="M:NPOI.HSSF.Record.EscherAggregate.GetNoteRecordByObj(NPOI.HSSF.Record.ObjRecord)">
  12196. @param obj - ObjRecord with id == NoteRecord.id
  12197. @return null if note record is not found else returns note record with id == obj.id
  12198. </member>
  12199. <member name="T:NPOI.HSSF.Record.ExtendedFormatRecord">
  12200. Title: Extended Format Record
  12201. Description: Probably one of the more complex records. There are two breeds:
  12202. Style and Cell.
  12203. It should be noted that fields in the extended format record are
  12204. somewhat arbitrary. Almost all of the fields are bit-level, but
  12205. we name them as best as possible by functional Group. In some
  12206. places this Is better than others.
  12207. REFERENCE: PG 426 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12208. @author Andrew C. Oliver (acoliver at apache dot org)
  12209. @version 2.0-pre
  12210. </member>
  12211. <member name="M:NPOI.HSSF.Record.ExtendedFormatRecord.#ctor">
  12212. Constructor ExtendedFormatRecord
  12213. </member>
  12214. <member name="M:NPOI.HSSF.Record.ExtendedFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12215. Constructs an ExtendedFormat record and Sets its fields appropriately.
  12216. @param in the RecordInputstream to Read the record from
  12217. </member>
  12218. <member name="M:NPOI.HSSF.Record.ExtendedFormatRecord.CloneStyleFrom(NPOI.HSSF.Record.ExtendedFormatRecord)">
  12219. Clones all the style information from another
  12220. ExtendedFormatRecord, onto this one. This
  12221. will then hold all the same style options.
  12222. If The source ExtendedFormatRecord comes from
  12223. a different Workbook, you will need to sort
  12224. out the font and format indicies yourself!
  12225. </member>
  12226. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.FontIndex">
  12227. <summary>
  12228. Get the index to the FONT record (which font to use 0 based)
  12229. </summary>
  12230. </member>
  12231. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.FormatIndex">
  12232. <summary>
  12233. Get the index to the Format record (which FORMAT to use 0-based)
  12234. </summary>
  12235. </member>
  12236. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.CellOptions">
  12237. <summary>
  12238. Gets the options bitmask - you can also use corresponding option bit Getters
  12239. (see other methods that reference this one)
  12240. </summary>
  12241. </member>
  12242. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsLocked">
  12243. <summary>
  12244. Get whether the cell Is locked or not
  12245. </summary>
  12246. </member>
  12247. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsHidden">
  12248. <summary>
  12249. Get whether the cell Is hidden or not
  12250. </summary>
  12251. </member>
  12252. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.XFType">
  12253. <summary>
  12254. Get whether the cell Is a cell or style XFRecord
  12255. </summary>
  12256. </member>
  12257. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord._123Prefix">
  12258. <summary>
  12259. Get some old holdover from lotus 123. Who cares, its all over for Lotus.
  12260. RIP Lotus.
  12261. </summary>
  12262. </member>
  12263. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.ParentIndex">
  12264. <summary>
  12265. for cell XF types this Is the parent style (usually 0/normal). For
  12266. style this should be NULL.
  12267. </summary>
  12268. </member>
  12269. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.AlignmentOptions">
  12270. <summary>
  12271. Get the alignment options bitmask. See corresponding bitGetter methods
  12272. that reference this one.
  12273. </summary>
  12274. </member>
  12275. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.Alignment">
  12276. <summary>
  12277. Get the horizontal alignment of the cell.
  12278. </summary>
  12279. </member>
  12280. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.WrapText">
  12281. <summary>
  12282. Get whether to wrap the text in the cell
  12283. </summary>
  12284. </member>
  12285. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.VerticalAlignment">
  12286. <summary>
  12287. Get the vertical alignment of text in the cell
  12288. </summary>
  12289. </member>
  12290. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.JustifyLast">
  12291. <summary>
  12292. Docs just say this Is for far east versions.. (I'm guessing it
  12293. justifies for right-to-left Read languages)
  12294. </summary>
  12295. </member>
  12296. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.Rotation">
  12297. <summary>
  12298. Get the degree of rotation. (I've not actually seen this used anywhere)
  12299. </summary>
  12300. </member>
  12301. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IndentionOptions">
  12302. <summary>
  12303. Get the indent options bitmask (see corresponding bit Getters that reference
  12304. this field)
  12305. </summary>
  12306. </member>
  12307. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.Indent">
  12308. <summary>
  12309. Get indention (not sure of the Units, think its spaces)
  12310. </summary>
  12311. </member>
  12312. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.ShrinkToFit">
  12313. <summary>
  12314. Get whether to shrink the text to fit
  12315. </summary>
  12316. </member>
  12317. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.MergeCells">
  12318. <summary>
  12319. Get whether to merge cells
  12320. </summary>
  12321. </member>
  12322. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.ReadingOrder">
  12323. <summary>
  12324. Get the Reading order for far east versions (0 - Context, 1 - Left to right,
  12325. 2 - right to left) - We could use some help with support for the far east.
  12326. </summary>
  12327. </member>
  12328. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentFormat">
  12329. <summary>
  12330. Get whether or not to use the format in this XF instead of the parent XF.
  12331. </summary>
  12332. </member>
  12333. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentFont">
  12334. <summary>
  12335. Get whether or not to use the font in this XF instead of the parent XF.
  12336. </summary>
  12337. </member>
  12338. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentAlignment">
  12339. <summary>
  12340. Get whether or not to use the alignment in this XF instead of the parent XF.
  12341. </summary>
  12342. </member>
  12343. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentBorder">
  12344. <summary>
  12345. Get whether or not to use the border in this XF instead of the parent XF.
  12346. </summary>
  12347. </member>
  12348. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentPattern">
  12349. <summary>
  12350. Get whether or not to use the pattern in this XF instead of the parent XF.
  12351. (foregrount/background)
  12352. </summary>
  12353. </member>
  12354. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentCellOptions">
  12355. <summary>
  12356. Get whether or not to use the locking/hidden in this XF instead of the parent XF.
  12357. </summary>
  12358. </member>
  12359. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BorderOptions">
  12360. <summary>
  12361. Get the border options bitmask (see the corresponding bit Getter methods
  12362. that reference back to this one)
  12363. </summary>
  12364. </member>
  12365. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BorderLeft">
  12366. <summary>
  12367. Get the borderline style for the left border
  12368. </summary>
  12369. </member>
  12370. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BorderRight">
  12371. <summary>
  12372. Get the borderline style for the right border
  12373. </summary>
  12374. </member>
  12375. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BorderTop">
  12376. <summary>
  12377. Get the borderline style for the top border
  12378. </summary>
  12379. </member>
  12380. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BorderBottom">
  12381. <summary>
  12382. Get the borderline style for the bottom border
  12383. </summary>
  12384. </member>
  12385. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.PaletteOptions">
  12386. <summary>
  12387. Get the palette options bitmask (see the individual bit Getter methods that
  12388. reference this one)
  12389. </summary>
  12390. </member>
  12391. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.LeftBorderPaletteIdx">
  12392. <summary>
  12393. Get the palette index for the left border color
  12394. </summary>
  12395. </member>
  12396. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.RightBorderPaletteIdx">
  12397. <summary>
  12398. Get the palette index for the right border color
  12399. </summary>
  12400. </member>
  12401. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.AdtlPaletteOptions">
  12402. <summary>
  12403. Get the Additional palette options bitmask (see individual bit Getter methods
  12404. that reference this method)
  12405. </summary>
  12406. </member>
  12407. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.TopBorderPaletteIdx">
  12408. <summary>
  12409. Get the palette index for the top border
  12410. </summary>
  12411. </member>
  12412. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BottomBorderPaletteIdx">
  12413. <summary>
  12414. Get the palette index for the bottom border
  12415. </summary>
  12416. </member>
  12417. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.AdtlDiagBorderPaletteIdx">
  12418. <summary>
  12419. Get for diagonal borders
  12420. </summary>
  12421. </member>
  12422. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.AdtlDiagLineStyle">
  12423. <summary>
  12424. Get the diagonal border line style
  12425. </summary>
  12426. </member>
  12427. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.Diagonal">
  12428. <summary>
  12429. Not sure what this Is for (maybe Fill lines?) 1 = down, 2 = up, 3 = both, 0 for none..
  12430. </summary>
  12431. </member>
  12432. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.AdtlFillPattern">
  12433. <summary>
  12434. Get the Additional Fill pattern
  12435. </summary>
  12436. </member>
  12437. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.FillPaletteOptions">
  12438. <summary>
  12439. Get the Fill palette options bitmask (see indivdual bit Getters that
  12440. reference this method)
  12441. </summary>
  12442. </member>
  12443. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.FillForeground">
  12444. <summary>
  12445. Get the foreground palette color index
  12446. </summary>
  12447. </member>
  12448. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.FillBackground">
  12449. <summary>
  12450. Get the background palette color index
  12451. </summary>
  12452. </member>
  12453. <member name="M:NPOI.HSSF.Record.ExtendedFormatRecord.Equals(System.Object)">
  12454. Will consider two different records with the same
  12455. contents as Equals, as the various indexes
  12456. that matter are embedded in the records
  12457. </member>
  12458. <member name="T:NPOI.HSSF.Record.ExternalNameRecord">
  12459. EXTERNALNAME<p/>
  12460. @author Josh Micich
  12461. </member>
  12462. <member name="F:NPOI.HSSF.Record.ExternalNameRecord._ddeValues">
  12463. 'rgoper' / 'Last received results of the DDE link'
  12464. (seems to be only applicable to DDE links)<br/>
  12465. Logically this is a 2-D array, which has been flattened into 1-D array here.
  12466. </member>
  12467. <member name="F:NPOI.HSSF.Record.ExternalNameRecord._nColumns">
  12468. (logical) number of columns in the {@link #_ddeValues} array
  12469. </member>
  12470. <member name="F:NPOI.HSSF.Record.ExternalNameRecord._nRows">
  12471. (logical) number of rows in the {@link #_ddeValues} array
  12472. </member>
  12473. <member name="P:NPOI.HSSF.Record.ExternalNameRecord.IsBuiltInName">
  12474. Convenience Function to determine if the name Is a built-in name
  12475. </member>
  12476. <member name="P:NPOI.HSSF.Record.ExternalNameRecord.IsAutomaticLink">
  12477. For OLE and DDE, links can be either 'automatic' or 'manual'
  12478. </member>
  12479. <member name="P:NPOI.HSSF.Record.ExternalNameRecord.IsPicureLink">
  12480. only for OLE and DDE
  12481. </member>
  12482. <member name="P:NPOI.HSSF.Record.ExternalNameRecord.IsStdDocumentNameIdentifier">
  12483. DDE links only. If <c>true</c>, this denotes the 'StdDocumentName'
  12484. </member>
  12485. <member name="P:NPOI.HSSF.Record.ExternalNameRecord.Text">
  12486. @return the standard String representation of this name
  12487. </member>
  12488. <member name="F:NPOI.HSSF.Record.RefSubRecord._extBookIndex">
  12489. index to External Book Block (which starts with a EXTERNALBOOK record)
  12490. </member>
  12491. <member name="M:NPOI.HSSF.Record.RefSubRecord.#ctor(System.Int32,System.Int32,System.Int32)">
  12492. a Constructor for making new sub record
  12493. </member>
  12494. <member name="M:NPOI.HSSF.Record.RefSubRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12495. @param in the RecordInputstream to Read the record from
  12496. </member>
  12497. <member name="M:NPOI.HSSF.Record.RefSubRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  12498. called by the class that is responsible for writing this sucker.
  12499. Subclasses should implement this so that their data is passed back in a
  12500. byte array.
  12501. @param offset to begin writing at
  12502. @param data byte array containing instance data
  12503. @return number of bytes written
  12504. </member>
  12505. <member name="T:NPOI.HSSF.Record.ExternSheetRecord">
  12506. Title: Extern Sheet
  12507. Description: A List of Inndexes to SupBook
  12508. REFERENCE:
  12509. @author Libin Roman (Vista Portal LDT. Developer)
  12510. @version 1.0-pre
  12511. </member>
  12512. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12513. Constructs a Extern Sheet record and Sets its fields appropriately.
  12514. @param in the RecordInputstream to Read the record from
  12515. </member>
  12516. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.AddRef(System.Int32,System.Int32,System.Int32)">
  12517. Add a zero-based reference to a {@link org.apache.poi.hssf.record.SupBookRecord}.
  12518. <p>
  12519. If the type of the SupBook record is same-sheet referencing, Add-In referencing,
  12520. DDE data source referencing, or OLE data source referencing,
  12521. then no scope is specified and this value <em>MUST</em> be -2. Otherwise,
  12522. the scope must be set as follows:
  12523. <ol>
  12524. <li><code>-2</code> Workbook-level reference that applies to the entire workbook.</li>
  12525. <li><code>-1</code> Sheet-level reference. </li>
  12526. <li><code>&gt;=0</code> Sheet-level reference. This specifies the first sheet in the reference.
  12527. <p>
  12528. If the SupBook type is unused or external workbook referencing,
  12529. then this value specifies the zero-based index of an external sheet name,
  12530. see {@link org.apache.poi.hssf.record.SupBookRecord#getSheetNames()}.
  12531. This referenced string specifies the name of the first sheet within the external workbook that is in scope.
  12532. This sheet MUST be a worksheet or macro sheet.
  12533. </p>
  12534. <p>
  12535. If the supporting link type is self-referencing, then this value specifies the zero-based index of a
  12536. {@link org.apache.poi.hssf.record.BoundSheetRecord} record in the workbook stream that specifies
  12537. the first sheet within the scope of this reference. This sheet MUST be a worksheet or a macro sheet.
  12538. </p>
  12539. </li>
  12540. </ol></p>
  12541. @param firstSheetIndex the scope, must be -2 for add-in references
  12542. @param lastSheetIndex the scope, must be -2 for add-in references
  12543. @return index of newly added ref
  12544. </member>
  12545. <member name="P:NPOI.HSSF.Record.ExternSheetRecord.NumOfREFRecords">
  12546. returns the number of REF Records, which is in model
  12547. @return number of REF records
  12548. </member>
  12549. <member name="P:NPOI.HSSF.Record.ExternSheetRecord.NumOfRefs">
  12550. @return number of REF structures
  12551. </member>
  12552. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.AddREFRecord(NPOI.HSSF.Record.RefSubRecord)">
  12553. Adds REF struct (ExternSheetSubRecord)
  12554. @param rec REF struct
  12555. </member>
  12556. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.GetExtbookIndexFromRefIndex(System.Int32)">
  12557. Returns the index of the SupBookRecord for this index
  12558. </member>
  12559. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.FindRefIndexFromExtBookIndex(System.Int32)">
  12560. @return -1 if not found
  12561. </member>
  12562. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.GetFirstSheetIndexFromRefIndex(System.Int32)">
  12563. Returns the first sheet that the reference applies to, or
  12564. -1 if the referenced sheet can't be found, or -2 if the
  12565. reference is workbook scoped.
  12566. </member>
  12567. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.GetLastSheetIndexFromRefIndex(System.Int32)">
  12568. Returns the last sheet that the reference applies to, or
  12569. -1 if the referenced sheet can't be found, or -2 if the
  12570. reference is workbook scoped.
  12571. For a single sheet reference, the first and last should be
  12572. the same.
  12573. </member>
  12574. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  12575. called by the class that Is responsible for writing this sucker.
  12576. Subclasses should implement this so that their data Is passed back in a
  12577. byte array.
  12578. @param offset to begin writing at
  12579. @param data byte array containing instance data
  12580. @return number of bytes written
  12581. </member>
  12582. <member name="P:NPOI.HSSF.Record.ExternSheetRecord.Sid">
  12583. return the non static version of the id for this record.
  12584. </member>
  12585. <member name="T:NPOI.HSSF.Record.ExternSheetSubRecord">
  12586. Title: A sub Record for Extern Sheet
  12587. Description: Defines a named range within a workbook.
  12588. REFERENCE:
  12589. @author Libin Roman (Vista Portal LDT. Developer)
  12590. @version 1.0-pre
  12591. </member>
  12592. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.#ctor">
  12593. a Constractor for making new sub record
  12594. </member>
  12595. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12596. Constructs a Extern Sheet Sub Record record and Sets its fields appropriately.
  12597. @param in the RecordInputstream to Read the record from
  12598. </member>
  12599. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.SetIndexToSupBook(System.Int16)">
  12600. Sets the Index to the sup book
  12601. @param index sup book index
  12602. </member>
  12603. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.GetIndexToSupBook">
  12604. Gets the index to sup book
  12605. @return sup book index
  12606. </member>
  12607. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.SetIndexToFirstSupBook(System.Int16)">
  12608. Sets the index to first sheet in supbook
  12609. @param index index to first sheet
  12610. </member>
  12611. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.GetIndexToFirstSupBook">
  12612. Gets the index to first sheet from supbook
  12613. @return index to first supbook
  12614. </member>
  12615. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.SetIndexToLastSupBook(System.Int16)">
  12616. Sets the index to last sheet in supbook
  12617. @param index index to last sheet
  12618. </member>
  12619. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.GetIndexToLastSupBook">
  12620. Gets the index to last sheet in supbook
  12621. @return index to last supbook
  12622. </member>
  12623. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.Serialize(System.Int32,System.Byte[])">
  12624. called by the class that Is responsible for writing this sucker.
  12625. Subclasses should implement this so that their data Is passed back in a
  12626. byte array.
  12627. @param offset to begin writing at
  12628. @param data byte array containing instance data
  12629. @return number of bytes written
  12630. </member>
  12631. <member name="P:NPOI.HSSF.Record.ExternSheetSubRecord.RecordSize">
  12632. returns the record size
  12633. </member>
  12634. <member name="P:NPOI.HSSF.Record.ExternSheetSubRecord.Sid">
  12635. return the non static version of the id for this record.
  12636. </member>
  12637. <member name="T:NPOI.HSSF.Record.InfoSubRecord">
  12638. Extended SST table info subrecord
  12639. Contains the elements of "info" in the SST's array field
  12640. @author Andrew C. Oliver (acoliver at apache dot org)
  12641. @version 2.0-pre
  12642. @see org.apache.poi.hssf.record.ExtSSTRecord
  12643. </member>
  12644. <member name="M:NPOI.HSSF.Record.InfoSubRecord.#ctor(System.Int32,System.Int32)">
  12645. Creates new ExtSSTInfoSubRecord
  12646. </member>
  12647. <member name="T:NPOI.HSSF.Record.ExtSSTRecord">
  12648. Title: Extended Static String Table
  12649. Description: This record Is used for a quick Lookup into the SST record. This
  12650. record breaks the SST table into a Set of buckets. The offsets
  12651. to these buckets within the SST record are kept as well as the
  12652. position relative to the start of the SST record.
  12653. REFERENCE: PG 313 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12654. @author Andrew C. Oliver (acoliver at apache dot org)
  12655. @author Jason Height (jheight at apache dot org)
  12656. @version 2.0-pre
  12657. @see org.apache.poi.hssf.record.ExtSSTInfoSubRecord
  12658. </member>
  12659. <member name="M:NPOI.HSSF.Record.ExtSSTRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12660. Constructs a EOFRecord record and Sets its fields appropriately.
  12661. @param in the RecordInputstream to Read the record from
  12662. </member>
  12663. <member name="P:NPOI.HSSF.Record.ExtSSTRecord.DataSize">
  12664. Returns the size of this record
  12665. </member>
  12666. <member name="M:NPOI.HSSF.Record.ExtSSTRecord.GetRecordSizeForStrings(System.Int32)">
  12667. Given a number of strings (in the sst), returns the size of the extsst record
  12668. </member>
  12669. <member name="T:NPOI.HSSF.Record.FeatHdrRecord">
  12670. Title: FeatHdr (Feature Header) Record
  12671. This record specifies common information for Shared Features, and
  12672. specifies the beginning of a collection of records to define them.
  12673. The collection of data (Globals Substream ABNF, macro sheet substream
  12674. ABNF or worksheet substream ABNF) specifies Shared Feature data.
  12675. </member>
  12676. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.SHAREDFEATURES_ISFPROTECTION">
  12677. Specifies the enhanced protection type. Used to protect a
  12678. shared workbook by restricting access to some areas of it
  12679. </member>
  12680. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.SHAREDFEATURES_ISFFEC2">
  12681. Specifies that formula errors should be ignored
  12682. </member>
  12683. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.SHAREDFEATURES_ISFFACTOID">
  12684. Specifies the smart tag type. Recognises certain
  12685. types of entries (proper names, dates/times etc) and
  12686. flags them for action
  12687. </member>
  12688. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.SHAREDFEATURES_ISFLIST">
  12689. Specifies the shared list type. Used for a table
  12690. within a sheet
  12691. </member>
  12692. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.cbHdrData">
  12693. 0x00000000 = rgbHdrData not present
  12694. 0xffffffff = rgbHdrData present
  12695. </member>
  12696. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.rgbHdrData">
  12697. We need a BOFRecord to make sense of this...
  12698. </member>
  12699. <member name="T:NPOI.HSSF.Record.FeatRecord">
  12700. Title: Feat (Feature) Record
  12701. This record specifies Shared Features data. It is normally paired
  12702. up with a {@link FeatHdrRecord}.
  12703. </member>
  12704. <member name="F:NPOI.HSSF.Record.FeatRecord.isf_sharedFeatureType">
  12705. See SHAREDFEATURES_* on {@link FeatHdrRecord}
  12706. </member>
  12707. <member name="F:NPOI.HSSF.Record.FeatRecord.cbFeatData">
  12708. Only matters if type is ISFFEC2
  12709. </member>
  12710. <member name="F:NPOI.HSSF.Record.FeatRecord.sharedFeature">
  12711. Contents depends on isf_sharedFeatureType :
  12712. ISFPROTECTION -> FeatProtection
  12713. ISFFEC2 -> FeatFormulaErr2
  12714. ISFFACTOID -> FeatSmartTag
  12715. </member>
  12716. <!-- Badly formed XML comment ignored for member "T:NPOI.HSSF.Record.FilePassRecord" -->
  12717. <member name="M:NPOI.HSSF.Record.FilePassRecord.Rc4KeyData.Clone">
  12718. <summary>
  12719. </summary>
  12720. <returns>Rc4KeyData</returns>
  12721. </member>
  12722. <member name="F:NPOI.HSSF.Record.FilePassRecord.XorKeyData._key">
  12723. key (2 bytes): An unsigned integer that specifies the obfuscation key.
  12724. See [MS-OFFCRYPTO], 2.3.6.2 section, the first step of Initializing XOR
  12725. array where it describes the generation of 16-bit XorKey value.
  12726. </member>
  12727. <member name="F:NPOI.HSSF.Record.FilePassRecord.XorKeyData._verifier">
  12728. verificationBytes (2 bytes): An unsigned integer that specifies
  12729. the password verification identifier.
  12730. </member>
  12731. <member name="M:NPOI.HSSF.Record.FilePassRecord.XorKeyData.Clone">
  12732. <summary>
  12733. </summary>
  12734. <returns>XorKeyData</returns>
  12735. </member>
  12736. <member name="M:NPOI.HSSF.Record.FilePassRecord.Clone">
  12737. <summary>
  12738. </summary>
  12739. <returns>FilePassRecord</returns>
  12740. </member>
  12741. <member name="T:NPOI.HSSF.Record.FileSharingRecord">
  12742. Title: FILESHARING
  12743. Description: stores the encrypted Readonly for a workbook (Write protect)
  12744. This functionality Is accessed from the options dialog box available when performing 'Save As'.<p/>
  12745. REFERENCE: PG 314 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<p/>
  12746. @author Andrew C. Oliver (acoliver at apache dot org)
  12747. </member>
  12748. <member name="M:NPOI.HSSF.Record.FileSharingRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12749. Constructs a FileSharing record and Sets its fields appropriately.
  12750. @param in the RecordInputstream to Read the record from
  12751. </member>
  12752. <member name="P:NPOI.HSSF.Record.FileSharingRecord.ReadOnly">
  12753. Get the Readonly
  12754. @return short representing if this Is Read only (1 = true)
  12755. </member>
  12756. <member name="P:NPOI.HSSF.Record.FileSharingRecord.Password">
  12757. @returns password hashed with hashPassword() (very lame)
  12758. </member>
  12759. <member name="P:NPOI.HSSF.Record.FileSharingRecord.Username">
  12760. @returns username of the user that Created the file
  12761. </member>
  12762. <member name="M:NPOI.HSSF.Record.FileSharingRecord.Clone">
  12763. Clone this record.
  12764. </member>
  12765. <member name="T:NPOI.HSSF.Record.FnGroupCountRecord">
  12766. Title: Function Group Count Record
  12767. Description: Number of built in function Groups in the current version of the
  12768. SpReadsheet (probably only used on Windoze)
  12769. REFERENCE: PG 315 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12770. @author Andrew C. Oliver (acoliver at apache dot org)
  12771. @version 2.0-pre
  12772. </member>
  12773. <member name="F:NPOI.HSSF.Record.FnGroupCountRecord.COUNT">
  12774. suggested default (14 dec)
  12775. </member>
  12776. <member name="M:NPOI.HSSF.Record.FnGroupCountRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12777. Constructs a FnGroupCount record and Sets its fields appropriately.
  12778. @param in the RecordInputstream to Read the record from
  12779. </member>
  12780. <member name="P:NPOI.HSSF.Record.FnGroupCountRecord.Count">
  12781. Get the number of built-in functions
  12782. @return number of built-in functions
  12783. </member>
  12784. <member name="T:NPOI.HSSF.Record.FontRecord">
  12785. Title: Font Record - descrbes a font in the workbook (index = 0-3,5-infinity - skip 4)
  12786. Description: An element in the Font Table
  12787. REFERENCE: PG 315 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12788. @author Andrew C. Oliver (acoliver at apache dot org)
  12789. @version 2.0-pre
  12790. </member>
  12791. <member name="M:NPOI.HSSF.Record.FontRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12792. Constructs a Font record and Sets its fields appropriately.
  12793. @param in the RecordInputstream to Read the record from
  12794. </member>
  12795. <member name="M:NPOI.HSSF.Record.FontRecord.CloneStyleFrom(NPOI.HSSF.Record.FontRecord)">
  12796. Clones all the font style information from another
  12797. FontRecord, onto this one. This
  12798. will then hold all the same font style options.
  12799. </member>
  12800. <member name="P:NPOI.HSSF.Record.FontRecord.IsItalic">
  12801. Set the font to be italics or not
  12802. @param italics - whether the font Is italics or not
  12803. @see #SetAttributes(short)
  12804. </member>
  12805. <member name="P:NPOI.HSSF.Record.FontRecord.IsStrikeout">
  12806. Set the font to be stricken out or not
  12807. @param strike - whether the font Is stricken out or not
  12808. @see #SetAttributes(short)
  12809. </member>
  12810. <member name="P:NPOI.HSSF.Record.FontRecord.IsMacoutlined">
  12811. whether to use the mac outline font style thing (mac only) - Some mac person
  12812. should comment this instead of me doing it (since I have no idea)
  12813. @param mac - whether to do that mac font outline thing or not
  12814. @see #SetAttributes(short)
  12815. </member>
  12816. <member name="P:NPOI.HSSF.Record.FontRecord.IsMacshadowed">
  12817. whether to use the mac shado font style thing (mac only) - Some mac person
  12818. should comment this instead of me doing it (since I have no idea)
  12819. @param mac - whether to do that mac font shadow thing or not
  12820. @see #SetAttributes(short)
  12821. </member>
  12822. <member name="P:NPOI.HSSF.Record.FontRecord.Underline">
  12823. Set the type of Underlining for the font
  12824. </member>
  12825. <member name="P:NPOI.HSSF.Record.FontRecord.Family">
  12826. Set the font family (TODO)
  12827. @param f family
  12828. </member>
  12829. <member name="P:NPOI.HSSF.Record.FontRecord.Charset">
  12830. Set the Char Set
  12831. @param charSet - CharSet
  12832. </member>
  12833. <member name="P:NPOI.HSSF.Record.FontRecord.FontName">
  12834. Set the name of the font
  12835. @param fn - name of the font (i.e. "Arial")
  12836. </member>
  12837. <member name="P:NPOI.HSSF.Record.FontRecord.FontHeight">
  12838. Gets the height of the font in 1/20th point Units
  12839. @return fontheight (in points/20)
  12840. </member>
  12841. <member name="P:NPOI.HSSF.Record.FontRecord.Attributes">
  12842. Get the font attributes (see individual bit Getters that reference this method)
  12843. @return attribute - the bitmask
  12844. </member>
  12845. <member name="P:NPOI.HSSF.Record.FontRecord.ColorPaletteIndex">
  12846. Get the font's color palette index
  12847. @return cpi - font color index
  12848. </member>
  12849. <member name="P:NPOI.HSSF.Record.FontRecord.BoldWeight">
  12850. Get the bold weight for this font (100-1000dec or 0x64-0x3e8). Default Is
  12851. 0x190 for normal and 0x2bc for bold
  12852. @return bw - a number between 100-1000 for the fonts "boldness"
  12853. </member>
  12854. <member name="P:NPOI.HSSF.Record.FontRecord.SuperSubScript">
  12855. Get the type of base or subscript for the font
  12856. @return base or subscript option
  12857. </member>
  12858. <member name="M:NPOI.HSSF.Record.FontRecord.SameProperties(NPOI.HSSF.Record.FontRecord)">
  12859. Does this FontRecord have all the same font
  12860. properties as the supplied FontRecord?
  12861. Note that {@link #equals(Object)} will check
  12862. for exact objects, while this will check
  12863. for exact contents, because normally the
  12864. font record's position makes a big
  12865. difference too.
  12866. </member>
  12867. <member name="M:NPOI.HSSF.Record.FontRecord.Equals(System.Object)">
  12868. Only returns two for the same exact object -
  12869. creating a second FontRecord with the same
  12870. properties won't be considered equal, as
  12871. the record's position in the record stream
  12872. matters.
  12873. </member>
  12874. <member name="T:NPOI.HSSF.Record.FooterRecord">
  12875. Title: Footer Record
  12876. Description: Specifies the footer for a sheet
  12877. REFERENCE: PG 317 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12878. @author Andrew C. Oliver (acoliver at apache dot org)
  12879. @author Shawn Laubach (slaubach at apache dot org) Modified 3/14/02
  12880. @author Jason Height (jheight at chariot dot net dot au)
  12881. @version 2.0-pre
  12882. </member>
  12883. <member name="M:NPOI.HSSF.Record.FooterRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12884. <summary>
  12885. Initializes a new instance of the <see cref="T:NPOI.HSSF.Record.FooterRecord"/> class.
  12886. </summary>
  12887. <param name="in1">the RecordInputstream to Read the record from</param>
  12888. </member>
  12889. <member name="M:NPOI.HSSF.Record.FooterRecord.ToString">
  12890. <summary>
  12891. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  12892. </summary>
  12893. <returns>
  12894. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  12895. </returns>
  12896. </member>
  12897. <member name="P:NPOI.HSSF.Record.FooterRecord.Sid">
  12898. <summary>
  12899. </summary>
  12900. <value></value>
  12901. return the non static version of the id for this record.
  12902. </member>
  12903. <member name="T:NPOI.HSSF.Record.FormatRecord">
  12904. Title: Format Record
  12905. Description: describes a number format -- those goofy strings like $(#,###)
  12906. REFERENCE: PG 317 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12907. @author Andrew C. Oliver (acoliver at apache dot org)
  12908. @author Shawn M. Laubach (slaubach at apache dot org)
  12909. @version 2.0-pre
  12910. </member>
  12911. <member name="M:NPOI.HSSF.Record.FormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12912. Constructs a Format record and Sets its fields appropriately.
  12913. @param in the RecordInputstream to Read the record from
  12914. </member>
  12915. <member name="P:NPOI.HSSF.Record.FormatRecord.IndexCode">
  12916. Get the format index code (for built in formats)
  12917. @return the format index code
  12918. @see org.apache.poi.hssf.model.Workbook
  12919. </member>
  12920. <member name="P:NPOI.HSSF.Record.FormatRecord.FormatString">
  12921. Get the format string
  12922. @return the format string
  12923. </member>
  12924. <member name="T:NPOI.HSSF.Record.SpecialCachedValue">
  12925. Manages the cached formula result values of other types besides numeric.
  12926. Excel encodes the same 8 bytes that would be field_4_value with various NaN
  12927. values that are decoded/encoded by this class.
  12928. </member>
  12929. <member name="F:NPOI.HSSF.Record.SpecialCachedValue.BIT_MARKER">
  12930. deliberately chosen by Excel in order to encode other values within Double NaNs
  12931. </member>
  12932. <member name="M:NPOI.HSSF.Record.SpecialCachedValue.Create(System.Int64)">
  12933. @return <c>null</c> if the double value encoded by <c>valueLongBits</c>
  12934. is a normal (non NaN) double value.
  12935. </member>
  12936. <member name="T:NPOI.HSSF.Record.FormulaRecord">
  12937. Formula Record.
  12938. REFERENCE: PG 317/444 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12939. @author Andrew C. Oliver (acoliver at apache dot org)
  12940. @author Jason Height (jheight at chariot dot net dot au)
  12941. @version 2.0-pre
  12942. </member>
  12943. <member name="F:NPOI.HSSF.Record.FormulaRecord.specialCachedValue">
  12944. Since the NaN support seems sketchy (different constants) we'll store and spit it out directly
  12945. </member>
  12946. <member name="M:NPOI.HSSF.Record.FormulaRecord.#ctor">
  12947. Creates new FormulaRecord
  12948. </member>
  12949. <member name="M:NPOI.HSSF.Record.FormulaRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12950. Constructs a Formula record and Sets its fields appropriately.
  12951. Note - id must be 0x06 (NOT 0x406 see MSKB #Q184647 for an
  12952. "explanation of this bug in the documentation) or an exception
  12953. will be throw upon validation
  12954. @param in the RecordInputstream to Read the record from
  12955. </member>
  12956. <member name="P:NPOI.HSSF.Record.FormulaRecord.HasCachedResultString">
  12957. @return <c>true</c> if this {@link FormulaRecord} is followed by a
  12958. {@link StringRecord} representing the cached text result of the formula
  12959. evaluation.
  12960. </member>
  12961. <member name="P:NPOI.HSSF.Record.FormulaRecord.Value">
  12962. Get the calculated value of the formula
  12963. @return calculated value
  12964. </member>
  12965. <member name="P:NPOI.HSSF.Record.FormulaRecord.Options">
  12966. Get the option flags
  12967. @return bitmask
  12968. </member>
  12969. <member name="P:NPOI.HSSF.Record.FormulaRecord.ParsedExpression">
  12970. Get the stack as a list
  12971. @return list of tokens (casts stack to a list and returns it!)
  12972. this method can return null Is we are Unable to Create Ptgs from
  12973. existing excel file
  12974. callers should Check for null!
  12975. </member>
  12976. <member name="M:NPOI.HSSF.Record.FtCblsSubRecord.#ctor">
  12977. Construct a new <code>FtCblsSubRecord</code> and
  12978. fill its data with the default values
  12979. </member>
  12980. <member name="M:NPOI.HSSF.Record.FtCblsSubRecord.ToString">
  12981. Convert this record to string.
  12982. Used by BiffViewer and other utilities.
  12983. </member>
  12984. <member name="M:NPOI.HSSF.Record.FtCblsSubRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  12985. Serialize the record data into the supplied array of bytes
  12986. @param out the stream to serialize into
  12987. </member>
  12988. <member name="P:NPOI.HSSF.Record.FtCblsSubRecord.Sid">
  12989. @return id of this record.
  12990. </member>
  12991. <member name="T:NPOI.HSSF.Record.FtCfSubRecord">
  12992. The FtCf structure specifies the clipboard format of the picture-type Obj record Containing this FtCf.
  12993. </member>
  12994. <member name="F:NPOI.HSSF.Record.FtCfSubRecord.METAFILE_BIT">
  12995. Specifies the format of the picture is an enhanced metafile.
  12996. </member>
  12997. <member name="F:NPOI.HSSF.Record.FtCfSubRecord.BITMAP_BIT">
  12998. Specifies the format of the picture is a bitmap.
  12999. </member>
  13000. <member name="F:NPOI.HSSF.Record.FtCfSubRecord.UNSPECIFIED_BIT">
  13001. Specifies the picture is in an unspecified format that is
  13002. neither and enhanced metafile nor a bitmap.
  13003. </member>
  13004. <member name="M:NPOI.HSSF.Record.FtCfSubRecord.#ctor">
  13005. Construct a new <code>FtPioGrbitSubRecord</code> and
  13006. fill its data with the default values
  13007. </member>
  13008. <member name="M:NPOI.HSSF.Record.FtCfSubRecord.ToString">
  13009. Convert this record to string.
  13010. Used by BiffViewer and other utilities.
  13011. </member>
  13012. <member name="M:NPOI.HSSF.Record.FtCfSubRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  13013. Serialize the record data into the supplied array of bytes
  13014. @param out the stream to serialize into
  13015. </member>
  13016. <member name="P:NPOI.HSSF.Record.FtCfSubRecord.Sid">
  13017. @return id of this record.
  13018. </member>
  13019. <member name="T:NPOI.HSSF.Record.FtPioGrbitSubRecord">
  13020. This structure appears as part of an Obj record that represents image display properties.
  13021. </member>
  13022. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.AUTO_PICT_BIT">
  13023. A bit that specifies whether the picture's aspect ratio is preserved when rendered in
  13024. different views (Normal view, Page Break Preview view, Page Layout view and printing).
  13025. </member>
  13026. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.DDE_BIT">
  13027. A bit that specifies whether the pictFmla field of the Obj record that Contains
  13028. this FtPioGrbit specifies a DDE reference.
  13029. </member>
  13030. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.PRINT_CALC_BIT">
  13031. A bit that specifies whether this object is expected to be updated on print to
  13032. reflect the values in the cell associated with the object.
  13033. </member>
  13034. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.ICON_BIT">
  13035. A bit that specifies whether the picture is displayed as an icon.
  13036. </member>
  13037. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.CTL_BIT">
  13038. A bit that specifies whether this object is an ActiveX control.
  13039. It MUST NOT be the case that both fCtl and fDde are equal to 1.
  13040. </member>
  13041. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.PRSTM_BIT">
  13042. A bit that specifies whether the object data are stored in an
  13043. embedding storage (= 0) or in the controls stream (ctls) (= 1).
  13044. </member>
  13045. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.CAMERA_BIT">
  13046. A bit that specifies whether this is a camera picture.
  13047. </member>
  13048. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.DEFAULT_SIZE_BIT">
  13049. A bit that specifies whether this picture's size has been explicitly Set.
  13050. 0 = picture size has been explicitly Set, 1 = has not been Set
  13051. </member>
  13052. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.AUTO_LOAD_BIT">
  13053. A bit that specifies whether the OLE server for the object is called
  13054. to load the object's data automatically when the parent workbook is opened.
  13055. </member>
  13056. <member name="M:NPOI.HSSF.Record.FtPioGrbitSubRecord.#ctor">
  13057. Construct a new <code>FtPioGrbitSubRecord</code> and
  13058. fill its data with the default values
  13059. </member>
  13060. <member name="M:NPOI.HSSF.Record.FtPioGrbitSubRecord.SetFlagByBit(System.Int32,System.Boolean)">
  13061. Use one of the bitmasks MANUAL_ADVANCE_BIT ... CURSOR_VISIBLE_BIT
  13062. @param bitmask
  13063. @param enabled
  13064. </member>
  13065. <member name="M:NPOI.HSSF.Record.FtPioGrbitSubRecord.ToString">
  13066. Convert this record to string.
  13067. Used by BiffViewer and other utilities.
  13068. </member>
  13069. <member name="M:NPOI.HSSF.Record.FtPioGrbitSubRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  13070. Serialize the record data into the supplied array of bytes
  13071. @param out the stream to serialize into
  13072. </member>
  13073. <member name="P:NPOI.HSSF.Record.FtPioGrbitSubRecord.Sid">
  13074. @return id of this record.
  13075. </member>
  13076. <member name="T:NPOI.HSSF.Record.GridsetRecord">
  13077. Title: GridSet Record.
  13078. Description: flag denoting whether the user specified that gridlines are used when
  13079. printing.
  13080. REFERENCE: PG 320 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13081. @author Andrew C. Oliver (acoliver at apache dot org)
  13082. @author Glen Stampoultzis (glens at apache.org)
  13083. @author Jason Height (jheight at chariot dot net dot au)
  13084. @version 2.0-pre
  13085. </member>
  13086. <member name="M:NPOI.HSSF.Record.GridsetRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13087. Constructs a GridSet record and Sets its fields appropriately.
  13088. @param in the RecordInputstream to Read the record from
  13089. </member>
  13090. <member name="P:NPOI.HSSF.Record.GridsetRecord.Gridset">
  13091. Get whether the gridlines are shown during printing.
  13092. @return gridSet - true if gridlines are NOT printed, false if they are.
  13093. </member>
  13094. <member name="T:NPOI.HSSF.Record.GroupMarkerSubRecord">
  13095. * The Group marker record is used as a position holder for Groups.
  13096. * @author Glen Stampoultzis (glens at apache.org)
  13097. </member>
  13098. <member name="M:NPOI.HSSF.Record.GroupMarkerSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32)">
  13099. Constructs a Group marker record and Sets its fields appropriately.
  13100. @param in the RecordInputstream to Read the record from
  13101. </member>
  13102. <member name="P:NPOI.HSSF.Record.GroupMarkerSubRecord.DataSize">
  13103. Size of record (exluding 4 byte header)
  13104. </member>
  13105. <member name="T:NPOI.HSSF.Record.GutsRecord">
  13106. Title: Guts Record
  13107. Description: Row/column gutter sizes
  13108. REFERENCE: PG 320 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13109. @author Andrew C. Oliver (acoliver at apache dot org)
  13110. @author Jason Height (jheight at chariot dot net dot au)
  13111. @version 2.0-pre
  13112. </member>
  13113. <member name="M:NPOI.HSSF.Record.GutsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13114. Constructs a Guts record and Sets its fields appropriately.
  13115. @param in the RecordInputstream to Read the record from
  13116. </member>
  13117. <member name="P:NPOI.HSSF.Record.GutsRecord.LeftRowGutter">
  13118. Get the size of the gutter that appears at the left of the rows
  13119. @return gutter size in screen Units
  13120. </member>
  13121. <member name="P:NPOI.HSSF.Record.GutsRecord.TopColGutter">
  13122. Get the size of the gutter that appears at the above the columns
  13123. @return gutter size in screen Units
  13124. </member>
  13125. <member name="P:NPOI.HSSF.Record.GutsRecord.RowLevelMax">
  13126. Get the maximum outline level for the row gutter.
  13127. @return maximum outline level
  13128. </member>
  13129. <member name="P:NPOI.HSSF.Record.GutsRecord.ColLevelMax">
  13130. Get the maximum outline level for the col gutter.
  13131. @return maximum outline level
  13132. </member>
  13133. <member name="T:NPOI.HSSF.Record.HCenterRecord">
  13134. Title: HCenter record
  13135. Description: whether to center between horizontal margins
  13136. REFERENCE: PG 320 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13137. @author Andrew C. Oliver (acoliver at apache dot org)
  13138. @author Jason Height (jheight at chariot dot net dot au)
  13139. @version 2.0-pre
  13140. </member>
  13141. <member name="M:NPOI.HSSF.Record.HCenterRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13142. Constructs an HCenter record and Sets its fields appropriately.
  13143. @param in the RecordInputstream to Read the record from
  13144. </member>
  13145. <member name="P:NPOI.HSSF.Record.HCenterRecord.HCenter">
  13146. Get whether or not to horizonatally center this sheet.
  13147. @return center - t/f
  13148. </member>
  13149. <member name="T:NPOI.HSSF.Record.HeaderFooterBase">
  13150. Common header/footer base class
  13151. @author Josh Micich
  13152. </member>
  13153. <member name="P:NPOI.HSSF.Record.HeaderFooterBase.TextLength">
  13154. get the length of the footer string
  13155. @return length of the footer string
  13156. </member>
  13157. <member name="T:NPOI.HSSF.Record.HeaderFooterRecord">
  13158. The HEADERFOOTER record stores information Added in Office Excel 2007 for headers/footers.
  13159. @author Yegor Kozlov
  13160. </member>
  13161. <member name="M:NPOI.HSSF.Record.HeaderFooterRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13162. construct a HeaderFooterRecord record. No fields are interpreted and the record will
  13163. be Serialized in its original form more or less
  13164. @param in the RecordInputstream to read the record from
  13165. </member>
  13166. <member name="M:NPOI.HSSF.Record.HeaderFooterRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  13167. spit the record out AS IS. no interpretation or identification
  13168. </member>
  13169. <member name="P:NPOI.HSSF.Record.HeaderFooterRecord.Guid">
  13170. If this header belongs to a specific sheet view , the sheet view?s GUID will be saved here.
  13171. If it is zero, it means the current sheet. Otherwise, this field MUST match the guid field
  13172. of the preceding {@link UserSViewBegin} record.
  13173. @return the sheet view's GUID
  13174. </member>
  13175. <member name="P:NPOI.HSSF.Record.HeaderFooterRecord.IsCurrentSheet">
  13176. @return whether this record belongs to the current sheet
  13177. </member>
  13178. <member name="T:NPOI.HSSF.Record.HeaderRecord">
  13179. Title: Header Record
  13180. Description: Specifies a header for a sheet
  13181. REFERENCE: PG 321 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13182. @author Andrew C. Oliver (acoliver at apache dot org)
  13183. @author Shawn Laubach (slaubach at apache dot org) Modified 3/14/02
  13184. @author Jason Height (jheight at chariot dot net dot au)
  13185. @version 2.0-pre
  13186. </member>
  13187. <member name="M:NPOI.HSSF.Record.HeaderRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13188. Constructs an Header record and Sets its fields appropriately.
  13189. @param in the RecordInputstream to Read the record from
  13190. </member>
  13191. <member name="T:NPOI.HSSF.Record.HideObjRecord">
  13192. Title: Hide Object Record
  13193. Description: flag defines whether to hide placeholders and object
  13194. REFERENCE: PG 321 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13195. @author Andrew C. Oliver (acoliver at apache dot org)
  13196. @version 2.0-pre
  13197. </member>
  13198. <member name="M:NPOI.HSSF.Record.HideObjRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13199. Constructs an HideObj record and Sets its fields appropriately.
  13200. @param in the RecordInputstream to Read the record from
  13201. </member>
  13202. <member name="M:NPOI.HSSF.Record.HideObjRecord.SetHideObj(System.Int16)">
  13203. Set hide object options
  13204. @param hide options
  13205. @see #HIDE_ALL
  13206. @see #SHOW_PLACEHOLDERS
  13207. @see #SHOW_ALL
  13208. </member>
  13209. <member name="M:NPOI.HSSF.Record.HideObjRecord.GetHideObj">
  13210. Get hide object options
  13211. @return hide options
  13212. @see #HIDE_ALL
  13213. @see #SHOW_PLACEHOLDERS
  13214. @see #SHOW_ALL
  13215. </member>
  13216. <member name="T:NPOI.HSSF.Record.HorizontalPageBreakRecord">
  13217. HorizontalPageBreak record that stores page breaks at rows
  13218. This class Is just used so that SID Compares work properly in the RecordFactory
  13219. @see PageBreakRecord
  13220. @author Danny Mui (dmui at apache dot org)
  13221. </member>
  13222. <member name="M:NPOI.HSSF.Record.HorizontalPageBreakRecord.#ctor">
  13223. </member>
  13224. <member name="M:NPOI.HSSF.Record.HorizontalPageBreakRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13225. @param in the RecordInputstream to Read the record from
  13226. </member>
  13227. <member name="T:NPOI.HSSF.Record.HyperlinkRecord">
  13228. The <c>HyperlinkRecord</c> wraps an HLINK-record
  13229. from the Excel-97 format.
  13230. Supports only external links for now (eg http://)
  13231. @author Mark Hissink Muller <a href="mailto:mark@hissinkmuller.nl">mark@hissinkmuller.nl</a>
  13232. @author Yegor Kozlov (yegor at apache dot org)
  13233. </member>
  13234. <member name="F:NPOI.HSSF.Record.HyperlinkRecord.HLINK_URL">
  13235. Link flags
  13236. </member>
  13237. <member name="F:NPOI.HSSF.Record.HyperlinkRecord.URL_uninterpretedTail">
  13238. Tail of a URL link
  13239. </member>
  13240. <member name="F:NPOI.HSSF.Record.HyperlinkRecord.FILE_uninterpretedTail">
  13241. Tail of a file link
  13242. </member>
  13243. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._range">
  13244. cell range of this hyperlink
  13245. </member>
  13246. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._guid">
  13247. 16-byte GUID
  13248. </member>
  13249. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._fileOpts">
  13250. Some sort of options for file links.
  13251. </member>
  13252. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._linkOpts">
  13253. Link options. Can include any of HLINK_* flags.
  13254. </member>
  13255. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._label">
  13256. Test label
  13257. </member>
  13258. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._moniker">
  13259. Moniker. Makes sense only for URL and file links
  13260. </member>
  13261. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._shortFilename">
  13262. in 8:3 DOS format No Unicode string header,
  13263. always 8-bit characters, zero-terminated
  13264. </member>
  13265. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._address">
  13266. Link
  13267. </member>
  13268. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._textMark">
  13269. Text describing a place in document. In Excel UI, this is appended to the
  13270. address, (after a '#' delimiter).<br/>
  13271. This field is optional. If present, the {@link #HLINK_PLACE} must be set.
  13272. </member>
  13273. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._uninterpretedTail">
  13274. Remaining bytes
  13275. </member>
  13276. <member name="M:NPOI.HSSF.Record.HyperlinkRecord.#ctor">
  13277. Create a new hyperlink
  13278. </member>
  13279. <member name="M:NPOI.HSSF.Record.HyperlinkRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13280. Read hyperlink from input stream
  13281. @param in the stream to Read from
  13282. </member>
  13283. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.FirstColumn">
  13284. Return the column of the first cell that Contains the hyperlink
  13285. @return the 0-based column of the first cell that Contains the hyperlink
  13286. </member>
  13287. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.LastColumn">
  13288. Set the column of the last cell that Contains the hyperlink
  13289. @return the 0-based column of the last cell that Contains the hyperlink
  13290. </member>
  13291. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.FirstRow">
  13292. Return the row of the first cell that Contains the hyperlink
  13293. @return the 0-based row of the first cell that Contains the hyperlink
  13294. </member>
  13295. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.LastRow">
  13296. Return the row of the last cell that Contains the hyperlink
  13297. @return the 0-based row of the last cell that Contains the hyperlink
  13298. </member>
  13299. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.Guid">
  13300. Returns a 16-byte guid identifier. Seems to always equal {@link STD_MONIKER}
  13301. @return 16-byte guid identifier
  13302. </member>
  13303. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.Moniker">
  13304. Returns a 16-byte moniker.
  13305. @return 16-byte moniker
  13306. </member>
  13307. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.Label">
  13308. Return text label for this hyperlink
  13309. @return text to Display
  13310. </member>
  13311. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.Address">
  13312. Hypelink Address. Depending on the hyperlink type it can be URL, e-mail, patrh to a file, etc.
  13313. @return the Address of this hyperlink
  13314. </member>
  13315. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.LinkOptions">
  13316. Link options. Must be a combination of HLINK_* constants.
  13317. </member>
  13318. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.LabelOptions">
  13319. Label options
  13320. </member>
  13321. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.FileOptions">
  13322. Options for a file link
  13323. </member>
  13324. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.IsUrlLink">
  13325. Based on the link options, is this a url?
  13326. </member>
  13327. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.IsFileLink">
  13328. Based on the link options, is this a file?
  13329. </member>
  13330. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.IsDocumentLink">
  13331. Based on the link options, is this a document?
  13332. </member>
  13333. <member name="M:NPOI.HSSF.Record.HyperlinkRecord.CreateUrlLink">
  13334. <summary>
  13335. Initialize a new url link
  13336. </summary>
  13337. </member>
  13338. <member name="M:NPOI.HSSF.Record.HyperlinkRecord.CreateFileLink">
  13339. <summary>
  13340. Initialize a new file link
  13341. </summary>
  13342. </member>
  13343. <member name="M:NPOI.HSSF.Record.HyperlinkRecord.CreateDocumentLink">
  13344. <summary>
  13345. Initialize a new document link
  13346. </summary>
  13347. </member>
  13348. <member name="T:NPOI.HSSF.Record.IndexRecord">
  13349. Title: Index Record
  13350. Description: Occurs right after BOF, tells you where the DBCELL records are for a sheet
  13351. Important for locating cells
  13352. NOT USED IN THIS RELEASE
  13353. REFERENCE: PG 323 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13354. @author Andrew C. Oliver (acoliver at apache dot org)
  13355. @author Jason Height (jheight at chariot dot net dot au)
  13356. @version 2.0-pre
  13357. </member>
  13358. <member name="M:NPOI.HSSF.Record.IndexRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13359. Constructs an Index record and Sets its fields appropriately.
  13360. @param in the RecordInputstream to Read the record from
  13361. </member>
  13362. <member name="M:NPOI.HSSF.Record.IndexRecord.GetRecordSizeForBlockCount(System.Int32)">
  13363. Returns the size of an INdexRecord when it needs to index the specified number of blocks
  13364. </member>
  13365. <member name="T:NPOI.HSSF.Record.InterfaceEndRecord">
  13366. Title: Interface End Record
  13367. Description: Shows where the Interface Records end (MMS)
  13368. (has no fields)
  13369. REFERENCE: PG 324 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13370. @author Andrew C. Oliver (acoliver at apache dot org)
  13371. @version 2.0-pre
  13372. </member>
  13373. <member name="M:NPOI.HSSF.Record.InterfaceEndRecord.Create(NPOI.HSSF.Record.RecordInputStream)">
  13374. Constructs an InterfaceEnd record and Sets its fields appropriately.
  13375. @param in the RecordInputstream to Read the record from
  13376. </member>
  13377. <member name="M:NPOI.HSSF.Record.InterfaceEndRecord.GetDataSize">
  13378. <summary>
  13379. for test TestInterfaceEndRecord.TestCreate()
  13380. </summary>
  13381. <returns></returns>
  13382. </member>
  13383. <member name="T:NPOI.HSSF.Record.InterfaceHdrRecord">
  13384. Title: Interface Header Record
  13385. Description: Defines the beginning of Interface records (MMS)
  13386. REFERENCE: PG 324 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13387. @author Andrew C. Oliver (acoliver at apache dot org)
  13388. @version 2.0-pre
  13389. </member>
  13390. <member name="F:NPOI.HSSF.Record.InterfaceHdrRecord.CODEPAGE">
  13391. suggested (and probably correct) default
  13392. </member>
  13393. <member name="M:NPOI.HSSF.Record.InterfaceHdrRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13394. Constructs an Codepage record and Sets its fields appropriately.
  13395. @param in the RecordInputstream to Read the record from
  13396. </member>
  13397. <member name="T:NPOI.HSSF.Record.IterationRecord">
  13398. Title: Iteration Record
  13399. Description: Tells whether to iterate over forumla calculations or not
  13400. (if a formula Is dependant upon another formula's result)
  13401. (odd feature for something that can only have 32 elements in
  13402. a formula!)
  13403. REFERENCE: PG 325 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13404. @author Andrew C. Oliver (acoliver at apache dot org)
  13405. @author Jason Height (jheight at chariot dot net dot au)
  13406. @version 2.0-pre
  13407. </member>
  13408. <member name="M:NPOI.HSSF.Record.IterationRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13409. Constructs an Iteration record and Sets its fields appropriately.
  13410. @param in the RecordInputstream to Read the record from
  13411. </member>
  13412. <member name="P:NPOI.HSSF.Record.IterationRecord.Iteration">
  13413. Get whether or not to iterate for calculations
  13414. @return whether iterative calculations are turned off or on
  13415. </member>
  13416. <member name="T:NPOI.HSSF.Record.LabelRecord">
  13417. Label Record - Read only support for strings stored directly in the cell.. Don't
  13418. use this (except to Read), use LabelSST instead
  13419. REFERENCE: PG 325 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13420. @see org.apache.poi.hssf.record.LabelSSTRecord
  13421. </member>
  13422. <member name="M:NPOI.HSSF.Record.LabelRecord.#ctor">
  13423. Creates new LabelRecord
  13424. </member>
  13425. <member name="M:NPOI.HSSF.Record.LabelRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13426. Constructs an Label record and Sets its fields appropriately.
  13427. @param in the RecordInputstream to Read the record from
  13428. </member>
  13429. <member name="P:NPOI.HSSF.Record.LabelRecord.StringLength">
  13430. Get the number of Chars this string Contains
  13431. @return number of Chars
  13432. </member>
  13433. <member name="P:NPOI.HSSF.Record.LabelRecord.IsUncompressedUnicode">
  13434. Is this Uncompressed Unicode (16bit)? Or just 8-bit compressed?
  13435. @return IsUnicode - True for 16bit- false for 8bit
  13436. </member>
  13437. <member name="P:NPOI.HSSF.Record.LabelRecord.Value">
  13438. Get the value
  13439. @return the text string
  13440. @see #GetStringLength
  13441. </member>
  13442. <member name="M:NPOI.HSSF.Record.LabelRecord.Serialize(System.Int32,System.Byte[])">
  13443. THROWS A RUNTIME EXCEPTION.. USE LABELSSTRecords. YOU HAVE NO REASON to use LABELRecord!!
  13444. </member>
  13445. <member name="T:NPOI.HSSF.Record.LabelSSTRecord">
  13446. Title: Label SST Record
  13447. Description: Refers to a string in the shared string table and Is a column
  13448. value.
  13449. REFERENCE: PG 325 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13450. @author Andrew C. Oliver (acoliver at apache dot org)
  13451. @author Jason Height (jheight at chariot dot net dot au)
  13452. @version 2.0-pre
  13453. </member>
  13454. <member name="M:NPOI.HSSF.Record.LabelSSTRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13455. Constructs an LabelSST record and Sets its fields appropriately.
  13456. @param in the RecordInputstream to Read the record from
  13457. </member>
  13458. <member name="P:NPOI.HSSF.Record.LabelSSTRecord.SSTIndex">
  13459. Get the index to the string in the SSTRecord
  13460. @return index of string in the SST Table
  13461. @see org.apache.poi.hssf.record.SSTRecord
  13462. </member>
  13463. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._cbFContinued">
  13464. From [MS-XLS].pdf 2.5.147 FtLbsData:
  13465. An unsigned integer that indirectly specifies whether
  13466. some of the data in this structure appear in a subsequent Continue record.
  13467. If _cbFContinued is 0x00, all of the fields in this structure except sid and _cbFContinued
  13468. MUST NOT exist. If this entire structure is Contained within the same record,
  13469. then _cbFContinued MUST be greater than or equal to the size, in bytes,
  13470. of this structure, not including the four bytes for the ft and _cbFContinued fields
  13471. </member>
  13472. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._unknownPreFormulaInt">
  13473. a formula that specifies the range of cell values that are the items in this list.
  13474. </member>
  13475. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._cLines">
  13476. An unsigned integer that specifies the number of items in the list.
  13477. </member>
  13478. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._iSel">
  13479. An unsigned integer that specifies the one-based index of the first selected item in this list.
  13480. A value of 0x00 specifies there is no currently selected item.
  13481. </member>
  13482. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._flags">
  13483. flags that tell what data follows
  13484. </member>
  13485. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._idEdit">
  13486. An ObjId that specifies the edit box associated with this list.
  13487. A value of 0x00 specifies that there is no edit box associated with this list.
  13488. </member>
  13489. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._dropData">
  13490. An optional LbsDropData that specifies properties for this dropdown control.
  13491. This field MUST exist if and only if the Containing Obj?s cmo.ot is equal to 0x14.
  13492. </member>
  13493. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._rgLines">
  13494. An optional array of strings where each string specifies an item in the list.
  13495. The number of elements in this array, if it exists, MUST be {@link #_cLines}
  13496. </member>
  13497. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._bsels">
  13498. An optional array of bools that specifies
  13499. which items in the list are part of a multiple selection
  13500. </member>
  13501. <member name="M:NPOI.HSSF.Record.LbsDataSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32,System.Int32)">
  13502. @param in the stream to read data from
  13503. @param cbFContinued the seconf short in the record header
  13504. @param cmoOt the Containing Obj's {@link CommonObjectDataSubRecord#field_1_objectType}
  13505. </member>
  13506. <member name="P:NPOI.HSSF.Record.LbsDataSubRecord.Formula">
  13507. @return the formula that specifies the range of cell values that are the items in this list.
  13508. </member>
  13509. <member name="P:NPOI.HSSF.Record.LbsDataSubRecord.NumberOfItems">
  13510. @return the number of items in the list
  13511. </member>
  13512. <member name="M:NPOI.HSSF.Record.LbsDataSubRecord.CreateAutoFilterInstance">
  13513. @return a new instance of LbsDataSubRecord to construct auto-filters
  13514. @see org.apache.poi.hssf.model.ComboboxShape#createObjRecord(org.apache.poi.hssf.usermodel.HSSFSimpleShape, int)
  13515. </member>
  13516. <member name="T:NPOI.HSSF.Record.LbsDropData">
  13517. This structure specifies properties of the dropdown list control
  13518. </member>
  13519. <member name="F:NPOI.HSSF.Record.LbsDropData.STYLE_COMBO_DROPDOWN">
  13520. Combo dropdown control
  13521. </member>
  13522. <member name="F:NPOI.HSSF.Record.LbsDropData.STYLE_COMBO_EDIT_DROPDOWN">
  13523. Combo Edit dropdown control
  13524. </member>
  13525. <member name="F:NPOI.HSSF.Record.LbsDropData.STYLE_COMBO_SIMPLE_DROPDOWN">
  13526. Simple dropdown control (just the dropdown button)
  13527. </member>
  13528. <member name="F:NPOI.HSSF.Record.LbsDropData._wStyle">
  13529. An unsigned integer that specifies the style of this dropdown.
  13530. </member>
  13531. <member name="F:NPOI.HSSF.Record.LbsDropData._cLine">
  13532. An unsigned integer that specifies the number of lines to be displayed in the dropdown.
  13533. </member>
  13534. <member name="F:NPOI.HSSF.Record.LbsDropData._dxMin">
  13535. An unsigned integer that specifies the smallest width in pixels allowed for the dropdown window
  13536. </member>
  13537. <member name="F:NPOI.HSSF.Record.LbsDropData._str">
  13538. a string that specifies the current string value in the dropdown
  13539. </member>
  13540. <member name="F:NPOI.HSSF.Record.LbsDropData._unused">
  13541. Optional, undefined and MUST be ignored.
  13542. This field MUST exist if and only if the size of str in bytes is an odd number
  13543. </member>
  13544. <member name="T:NPOI.HSSF.Record.LeftMarginRecord">
  13545. Record for the left margin.
  13546. NOTE: This source was automatically generated.
  13547. @author Shawn Laubach (slaubach at apache dot org)
  13548. </member>
  13549. <member name="M:NPOI.HSSF.Record.LeftMarginRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13550. Constructs a LeftMargin record and Sets its fields appropriately.
  13551. @param in the RecordInputstream to Read the record from
  13552. </member>
  13553. <member name="P:NPOI.HSSF.Record.LeftMarginRecord.Margin">
  13554. Get the margin field for the LeftMargin record.
  13555. </member>
  13556. <member name="T:NPOI.HSSF.Record.LinkedDataFormulaField">
  13557. Not implemented yet. May commit it anyway just so people can see
  13558. where I'm heading.
  13559. @author Glen Stampoultzis (glens at apache.org)
  13560. </member>
  13561. <member name="T:NPOI.HSSF.Record.IMargin">
  13562. The margin interface Is a parent used to define left, right, top and bottom margins.
  13563. This allows much of the code to be generic when it comes to handling margins.
  13564. NOTE: This source wass automatically generated.
  13565. @author Shawn Laubach (slaubach at apache dot org)
  13566. </member>
  13567. <member name="P:NPOI.HSSF.Record.IMargin.Margin">
  13568. Get the margin field for the Margin.
  13569. </member>
  13570. <member name="T:NPOI.HSSF.Record.MergeCellsRecord">
  13571. Title: Merged Cells Record
  13572. Description: Optional record defining a square area of cells to "merged" into
  13573. one cell.
  13574. REFERENCE: NONE (UNDOCUMENTED PRESENTLY)
  13575. @author Andrew C. Oliver (acoliver at apache dot org)
  13576. @version 2.0-pre
  13577. </member>
  13578. <member name="F:NPOI.HSSF.Record.MergeCellsRecord._regions">
  13579. sometimes the regions array is shared with other MergedCellsRecords
  13580. </member>
  13581. <member name="M:NPOI.HSSF.Record.MergeCellsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13582. Constructs a MergedCellsRecord and Sets its fields appropriately
  13583. @param in the RecordInputstream to Read the record from
  13584. </member>
  13585. <member name="P:NPOI.HSSF.Record.MergeCellsRecord.NumAreas">
  13586. Get the number of merged areas. If this drops down to 0 you should just go
  13587. ahead and delete the record.
  13588. @return number of areas
  13589. </member>
  13590. <member name="M:NPOI.HSSF.Record.MergeCellsRecord.GetAreaAt(System.Int32)">
  13591. @return MergedRegion at the given index representing the area that is Merged (r1,c1 - r2,c2)
  13592. </member>
  13593. <member name="T:NPOI.HSSF.Record.MMSRecord">
  13594. Title: MMS Record
  13595. Description: defines how many Add menu and del menu options are stored
  13596. in the file. Should always be Set to 0 for HSSF workbooks
  13597. REFERENCE: PG 328 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13598. @author Andrew C. Oliver (acoliver at apache dot org)
  13599. @version 2.0-pre
  13600. </member>
  13601. <member name="M:NPOI.HSSF.Record.MMSRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13602. Constructs a MMS record and Sets its fields appropriately.
  13603. @param in the RecordInputstream to Read the record from
  13604. </member>
  13605. <member name="P:NPOI.HSSF.Record.MMSRecord.AddMenuCount">
  13606. Set number of Add menu options (Set to 0)
  13607. @param am number of Add menu options
  13608. </member>
  13609. <member name="P:NPOI.HSSF.Record.MMSRecord.DelMenuCount">
  13610. Set number of del menu options (Set to 0)
  13611. @param dm number of del menu options
  13612. </member>
  13613. <member name="T:NPOI.HSSF.Record.MulBlankRecord">
  13614. Title: Mulitple Blank cell record
  13615. Description: Represents a Set of columns in a row with no value but with styling.
  13616. In this release we have Read-only support for this record type.
  13617. The RecordFactory Converts this to a Set of BlankRecord objects.
  13618. REFERENCE: PG 329 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13619. @author Andrew C. Oliver (acoliver at apache dot org)
  13620. @author Glen Stampoultzis (glens at apache.org)
  13621. @version 2.0-pre
  13622. @see org.apache.poi.hssf.record.BlankRecord
  13623. </member>
  13624. <member name="M:NPOI.HSSF.Record.MulBlankRecord.#ctor">
  13625. Creates new MulBlankRecord
  13626. </member>
  13627. <member name="M:NPOI.HSSF.Record.MulBlankRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13628. Constructs a MulBlank record and Sets its fields appropriately.
  13629. @param in the RecordInputstream to Read the record from
  13630. </member>
  13631. <member name="P:NPOI.HSSF.Record.MulBlankRecord.Row">
  13632. Get the row number of the cells this represents
  13633. @return row number
  13634. </member>
  13635. <member name="P:NPOI.HSSF.Record.MulBlankRecord.FirstColumn">
  13636. starting column (first cell this holds in the row)
  13637. @return first column number
  13638. </member>
  13639. <member name="P:NPOI.HSSF.Record.MulBlankRecord.LastColumn">
  13640. ending column (last cell this holds in the row)
  13641. @return first column number
  13642. </member>
  13643. <member name="P:NPOI.HSSF.Record.MulBlankRecord.NumColumns">
  13644. Get the number of columns this Contains (last-first +1)
  13645. @return number of columns (last - first +1)
  13646. </member>
  13647. <member name="M:NPOI.HSSF.Record.MulBlankRecord.GetXFAt(System.Int32)">
  13648. returns the xf index for column (coffset = column - field_2_first_col)
  13649. @param coffset the column (coffset = column - field_2_first_col)
  13650. @return the XF index for the column
  13651. </member>
  13652. <member name="T:NPOI.HSSF.Record.MulRKRecord">
  13653. Used to store multiple RK numbers on a row. 1 MulRk = Multiple Cell values.
  13654. HSSF just Converts this into multiple NUMBER records. Read-ONLY SUPPORT!
  13655. REFERENCE: PG 330 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13656. @author Andrew C. Oliver (acoliver at apache dot org)
  13657. @version 2.0-pre
  13658. </member>
  13659. <member name="M:NPOI.HSSF.Record.MulRKRecord.#ctor">
  13660. Creates new MulRKRecord
  13661. </member>
  13662. <member name="M:NPOI.HSSF.Record.MulRKRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13663. Constructs a MulRK record and Sets its fields appropriately.
  13664. @param in the RecordInputstream to Read the record from
  13665. </member>
  13666. <member name="P:NPOI.HSSF.Record.MulRKRecord.FirstColumn">
  13667. starting column (first cell this holds in the row)
  13668. @return first column number
  13669. </member>
  13670. <member name="P:NPOI.HSSF.Record.MulRKRecord.LastColumn">
  13671. ending column (last cell this holds in the row)
  13672. @return first column number
  13673. </member>
  13674. <member name="P:NPOI.HSSF.Record.MulRKRecord.NumColumns">
  13675. Get the number of columns this Contains (last-first +1)
  13676. @return number of columns (last - first +1)
  13677. </member>
  13678. <member name="M:NPOI.HSSF.Record.MulRKRecord.GetXFAt(System.Int32)">
  13679. returns the xf index for column (coffset = column - field_2_first_col)
  13680. @return the XF index for the column
  13681. </member>
  13682. <member name="M:NPOI.HSSF.Record.MulRKRecord.GetRKNumberAt(System.Int32)">
  13683. returns the rk number for column (coffset = column - field_2_first_col)
  13684. @return the value (decoded into a double)
  13685. </member>
  13686. <member name="T:NPOI.HSSF.Record.NameCommentRecord">
  13687. Title: NAMECMT Record (0x0894)
  13688. Description: Defines a comment associated with a specified name.
  13689. REFERENCE:
  13690. @author Andrew Shirley (aks at corefiling.co.uk)
  13691. </member>
  13692. <member name="M:NPOI.HSSF.Record.NameCommentRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13693. @param ris the RecordInputstream to read the record from
  13694. </member>
  13695. <member name="P:NPOI.HSSF.Record.NameCommentRecord.Sid">
  13696. return the non static version of the id for this record.
  13697. </member>
  13698. <member name="P:NPOI.HSSF.Record.NameCommentRecord.NameText">
  13699. @return the name of the NameRecord to which this comment applies.
  13700. </member>
  13701. <member name="P:NPOI.HSSF.Record.NameCommentRecord.CommentText">
  13702. @return the text of the comment.
  13703. </member>
  13704. <member name="T:NPOI.HSSF.Record.NameRecord">
  13705. Title: Name Record (aka Named Range)
  13706. Description: Defines a named range within a workbook.
  13707. REFERENCE:
  13708. @author Libin Roman (Vista Portal LDT. Developer)
  13709. @author Sergei Kozello (sergeikozello at mail.ru)
  13710. @author Glen Stampoultzis (glens at apache.org)
  13711. @version 1.0-pre
  13712. </member>
  13713. <member name="F:NPOI.HSSF.Record.NameRecord.sid">
  13714. </member>
  13715. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_CONSOLIDATE_AREA">
  13716. Included for completeness sake, not implemented
  13717. </member>
  13718. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_AUTO_OPEN">
  13719. Included for completeness sake, not implemented
  13720. </member>
  13721. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_AUTO_CLOSE">
  13722. Included for completeness sake, not implemented
  13723. </member>
  13724. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_DATABASE">
  13725. Included for completeness sake, not implemented
  13726. </member>
  13727. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_CRITERIA">
  13728. Included for completeness sake, not implemented
  13729. </member>
  13730. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_RECORDER">
  13731. Included for completeness sake, not implemented
  13732. </member>
  13733. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_DATA_FORM">
  13734. Included for completeness sake, not implemented
  13735. </member>
  13736. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_AUTO_ACTIVATE">
  13737. Included for completeness sake, not implemented
  13738. </member>
  13739. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_AUTO_DEACTIVATE">
  13740. Included for completeness sake, not implemented
  13741. </member>
  13742. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_SHEET_TITLE">
  13743. Included for completeness sake, not implemented
  13744. </member>
  13745. <member name="F:NPOI.HSSF.Record.NameRecord.field_5_externSheetIndex_plus1">
  13746. One-based extern index of sheet (resolved via LinkTable). Zero if this is a global name
  13747. </member>
  13748. <member name="F:NPOI.HSSF.Record.NameRecord.field_6_sheetNumber">
  13749. the one based sheet number.
  13750. </member>
  13751. <member name="M:NPOI.HSSF.Record.NameRecord.#ctor">
  13752. Creates new NameRecord
  13753. </member>
  13754. <member name="M:NPOI.HSSF.Record.NameRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13755. Constructs a Name record and Sets its fields appropriately.
  13756. @param in the RecordInputstream to Read the record from
  13757. </member>
  13758. <member name="M:NPOI.HSSF.Record.NameRecord.#ctor(System.Byte,System.Int32)">
  13759. Constructor to Create a built-in named region
  13760. @param builtin Built-in byte representation for the name record, use the public constants
  13761. @param index
  13762. </member>
  13763. <member name="P:NPOI.HSSF.Record.NameRecord.FnGroup">
  13764. @return function Group
  13765. @see FnGroupCountRecord
  13766. </member>
  13767. <member name="P:NPOI.HSSF.Record.NameRecord.OptionFlag">
  13768. Gets the option flag
  13769. @return option flag
  13770. </member>
  13771. <member name="P:NPOI.HSSF.Record.NameRecord.KeyboardShortcut">
  13772. returns the keyboard shortcut
  13773. @return keyboard shortcut
  13774. </member>
  13775. <member name="P:NPOI.HSSF.Record.NameRecord.NameTextLength">
  13776. **
  13777. </member>
  13778. <member name="M:NPOI.HSSF.Record.NameRecord.SetFunction(System.Boolean)">
  13779. Indicates that the defined name refers to a user-defined function.
  13780. This attribute is used when there is an add-in or other code project associated with the file.
  13781. @param function <c>true</c> indicates the name refers to a function.
  13782. </member>
  13783. <member name="P:NPOI.HSSF.Record.NameRecord.HasFormula">
  13784. @return <c>true</c> if name has a formula (named range or defined value)
  13785. </member>
  13786. <member name="P:NPOI.HSSF.Record.NameRecord.IsHiddenName">
  13787. @return true if name Is hidden
  13788. </member>
  13789. <member name="P:NPOI.HSSF.Record.NameRecord.IsFunctionName">
  13790. @return true if name Is a function
  13791. </member>
  13792. <member name="P:NPOI.HSSF.Record.NameRecord.IsCommandName">
  13793. @return true if name Is a command
  13794. </member>
  13795. <member name="P:NPOI.HSSF.Record.NameRecord.IsMacro">
  13796. @return true if function macro or command macro
  13797. </member>
  13798. <member name="P:NPOI.HSSF.Record.NameRecord.IsComplexFunction">
  13799. @return true if array formula or user defined
  13800. </member>
  13801. <member name="P:NPOI.HSSF.Record.NameRecord.IsBuiltInName">
  13802. Convenience Function to determine if the name Is a built-in name
  13803. </member>
  13804. <member name="P:NPOI.HSSF.Record.NameRecord.NameText">
  13805. Gets the name
  13806. @return name
  13807. </member>
  13808. <member name="P:NPOI.HSSF.Record.NameRecord.BuiltInName">
  13809. Gets the Built In Name
  13810. @return the built in Name
  13811. </member>
  13812. <member name="P:NPOI.HSSF.Record.NameRecord.NameDefinition">
  13813. Gets the definition, reference (Formula)
  13814. @return definition -- can be null if we cant Parse ptgs
  13815. </member>
  13816. <member name="P:NPOI.HSSF.Record.NameRecord.CustomMenuText">
  13817. Get the custom menu text
  13818. @return custom menu text
  13819. </member>
  13820. <member name="P:NPOI.HSSF.Record.NameRecord.DescriptionText">
  13821. Gets the description text
  13822. @return description text
  13823. </member>
  13824. <member name="P:NPOI.HSSF.Record.NameRecord.HelpTopicText">
  13825. Get the help topic text
  13826. @return gelp topic text
  13827. </member>
  13828. <member name="P:NPOI.HSSF.Record.NameRecord.StatusBarText">
  13829. Gets the status bar text
  13830. @return status bar text
  13831. </member>
  13832. <member name="P:NPOI.HSSF.Record.NameRecord.SheetNumber">
  13833. For named ranges, and built-in names
  13834. @return the 1-based sheet number.
  13835. </member>
  13836. <member name="M:NPOI.HSSF.Record.NameRecord.Serialize(NPOI.HSSF.Record.Cont.ContinuableRecordOutput)">
  13837. called by the class that Is responsible for writing this sucker.
  13838. Subclasses should implement this so that their data Is passed back in a
  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.NameRecord.ExternSheetNumber">
  13844. Gets the extern sheet number
  13845. @return extern sheet index
  13846. </member>
  13847. <member name="P:NPOI.HSSF.Record.NameRecord.Sid">
  13848. return the non static version of the id for this record.
  13849. </member>
  13850. <member name="M:NPOI.HSSF.Record.NameRecord.ToString">
  13851. @see Object#ToString()
  13852. </member>
  13853. <member name="M:NPOI.HSSF.Record.NameRecord.TranslateBuiltInName(System.Byte)">
  13854. Creates a human Readable name for built in types
  13855. @return Unknown if the built-in name cannot be translated
  13856. </member>
  13857. <member name="T:NPOI.HSSF.Record.NoteRecord">
  13858. NOTE: Comment Associated with a Cell (1Ch)
  13859. @author Yegor Kozlov
  13860. </member>
  13861. <member name="F:NPOI.HSSF.Record.NoteRecord.NOTE_HIDDEN">
  13862. Flag indicating that the comment Is hidden (default)
  13863. </member>
  13864. <member name="F:NPOI.HSSF.Record.NoteRecord.NOTE_VISIBLE">
  13865. Flag indicating that the comment Is visible
  13866. </member>
  13867. <member name="F:NPOI.HSSF.Record.NoteRecord.field_7_padding">
  13868. Saves padding byte value to reduce delta during round-trip serialization.<br/>
  13869. The documentation is not clear about how padding should work. In any case
  13870. Excel(2007) does something different.
  13871. </member>
  13872. <member name="M:NPOI.HSSF.Record.NoteRecord.#ctor">
  13873. Construct a new <c>NoteRecord</c> and
  13874. Fill its data with the default values
  13875. </member>
  13876. <member name="M:NPOI.HSSF.Record.NoteRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13877. Constructs a <c>NoteRecord</c> and Fills its fields
  13878. from the supplied <c>RecordInputStream</c>.
  13879. @param in the stream to Read from
  13880. </member>
  13881. <member name="P:NPOI.HSSF.Record.NoteRecord.Sid">
  13882. @return id of this record.
  13883. </member>
  13884. <member name="M:NPOI.HSSF.Record.NoteRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  13885. Serialize the record data into the supplied array of bytes
  13886. @param offset offset in the <c>data</c>
  13887. @param data the data to Serialize into
  13888. @return size of the record
  13889. </member>
  13890. <member name="P:NPOI.HSSF.Record.NoteRecord.DataSize">
  13891. Size of record
  13892. </member>
  13893. <member name="M:NPOI.HSSF.Record.NoteRecord.ToString">
  13894. Convert this record to string.
  13895. Used by BiffViewer and other utulities.
  13896. </member>
  13897. <member name="P:NPOI.HSSF.Record.NoteRecord.Row">
  13898. Return the row that Contains the comment
  13899. @return the row that Contains the comment
  13900. </member>
  13901. <member name="P:NPOI.HSSF.Record.NoteRecord.Column">
  13902. Return the column that Contains the comment
  13903. @return the column that Contains the comment
  13904. </member>
  13905. <member name="P:NPOI.HSSF.Record.NoteRecord.Flags">
  13906. Options flags.
  13907. @return the options flag
  13908. @see #NOTE_VISIBLE
  13909. @see #NOTE_HIDDEN
  13910. </member>
  13911. <member name="P:NPOI.HSSF.Record.NoteRecord.ShapeId">
  13912. Object id for OBJ record that Contains the comment
  13913. </member>
  13914. <member name="P:NPOI.HSSF.Record.NoteRecord.Author">
  13915. Name of the original comment author
  13916. @return the name of the original author of the comment
  13917. </member>
  13918. <member name="P:NPOI.HSSF.Record.NoteRecord.AuthorIsMultibyte">
  13919. For unit testing only!
  13920. </member>
  13921. <member name="T:NPOI.HSSF.Record.NoteStructureSubRecord">
  13922. Represents a NoteStructure (0xD) sub record.
  13923. The docs say nothing about it. The Length of this record is always 26 bytes.
  13924. @author Yegor Kozlov
  13925. </member>
  13926. <member name="M:NPOI.HSSF.Record.NoteStructureSubRecord.#ctor">
  13927. Construct a new <c>NoteStructureSubRecord</c> and
  13928. Fill its data with the default values
  13929. </member>
  13930. <member name="M:NPOI.HSSF.Record.NoteStructureSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32)">
  13931. Constructs a NoteStructureSubRecord and Sets its fields appropriately.
  13932. </member>
  13933. <member name="M:NPOI.HSSF.Record.NoteStructureSubRecord.ToString">
  13934. Convert this record to string.
  13935. Used by BiffViewer and other utulities.
  13936. </member>
  13937. <member name="M:NPOI.HSSF.Record.NoteStructureSubRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  13938. Serialize the record data into the supplied array of bytes
  13939. @param offset offset in the <c>data</c>
  13940. @param data the data to Serialize into
  13941. @return size of the record
  13942. </member>
  13943. <member name="P:NPOI.HSSF.Record.NoteStructureSubRecord.DataSize">
  13944. Size of record
  13945. </member>
  13946. <member name="P:NPOI.HSSF.Record.NoteStructureSubRecord.Sid">
  13947. @return id of this record.
  13948. </member>
  13949. <member name="T:NPOI.HSSF.Record.NumberRecord">
  13950. Contains a numeric cell value.
  13951. REFERENCE: PG 334 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13952. @author Andrew C. Oliver (acoliver at apache dot org)
  13953. @author Jason Height (jheight at chariot dot net dot au)
  13954. @version 2.0-pre
  13955. </member>
  13956. <member name="M:NPOI.HSSF.Record.NumberRecord.#ctor">
  13957. Creates new NumberRecord
  13958. </member>
  13959. <member name="M:NPOI.HSSF.Record.NumberRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13960. Constructs a Number record and Sets its fields appropriately.
  13961. @param in the RecordInputstream to Read the record from
  13962. </member>
  13963. <member name="P:NPOI.HSSF.Record.NumberRecord.Value">
  13964. Get the value for the cell
  13965. @return double representing the value
  13966. </member>
  13967. <member name="T:NPOI.HSSF.Record.ObjectProtectRecord">
  13968. Title: Object Protect Record
  13969. Description: Protect embedded object with the lamest "security" ever invented.
  13970. This record tells "I want to protect my objects" with lame security. It
  13971. appears in conjunction with the PASSWORD and PROTECT records as well as its
  13972. scenario protect cousin.
  13973. REFERENCE: PG 368 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13974. @author Andrew C. Oliver (acoliver at apache dot org)
  13975. </member>
  13976. <member name="M:NPOI.HSSF.Record.ObjectProtectRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13977. Constructs a Protect record and Sets its fields appropriately.
  13978. @param in the RecordInputstream to Read the record from
  13979. </member>
  13980. <member name="P:NPOI.HSSF.Record.ObjectProtectRecord.Protect">
  13981. Get whether the sheet Is protected or not
  13982. @return whether to protect the sheet or not
  13983. </member>
  13984. <member name="T:NPOI.HSSF.Record.ObjRecord">
  13985. The obj record is used to hold various graphic objects and controls.
  13986. @author Glen Stampoultzis (glens at apache.org)
  13987. </member>
  13988. <member name="F:NPOI.HSSF.Record.ObjRecord._uninterpretedData">
  13989. used when POI has no idea what is going on
  13990. </member>
  13991. <member name="F:NPOI.HSSF.Record.ObjRecord._isPaddedToQuadByteMultiple">
  13992. Excel seems to tolerate padding to quad or double byte length
  13993. </member>
  13994. <member name="M:NPOI.HSSF.Record.ObjRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13995. Constructs a OBJ record and Sets its fields appropriately.
  13996. @param in the RecordInputstream to Read the record from
  13997. </member>
  13998. <member name="M:NPOI.HSSF.Record.ObjRecord.CanPaddingBeDiscarded(System.Byte[],System.Int32)">
  13999. Some XLS files have ObjRecords with nearly 8Kb of excessive padding. These were probably
  14000. written by a version of POI (around 3.1) which incorrectly interpreted the second short of
  14001. the ftLbs subrecord (0x1FEE) as a length, and read that many bytes as padding (other bugs
  14002. helped allow this to occur).
  14003. Excel reads files with this excessive padding OK, truncating the over-sized ObjRecord back
  14004. to the its proper size. POI does the same.
  14005. </member>
  14006. <member name="P:NPOI.HSSF.Record.ObjRecord.RecordSize">
  14007. Size of record (excluding 4 byte header)
  14008. </member>
  14009. <member name="T:NPOI.HSSF.Record.OldCellRecord">
  14010. Base class for all old (Biff 2 - Biff 4) cell value records
  14011. (implementors of {@link CellValueRecordInterface}).
  14012. Subclasses are expected to manage the cell data values (of various types).
  14013. </member>
  14014. <member name="P:NPOI.HSSF.Record.OldCellRecord.XFIndex">
  14015. Get the index to the ExtendedFormat, for non-Biff2
  14016. @see NPOI.HSSF.Record.ExtendedFormatRecord
  14017. @return index to the XF record
  14018. </member>
  14019. <member name="P:NPOI.HSSF.Record.OldCellRecord.IsBiff2">
  14020. Is this a Biff2 record, or newer?
  14021. </member>
  14022. <member name="M:NPOI.HSSF.Record.OldCellRecord.AppendValueText(System.Text.StringBuilder)">
  14023. Append specific debug info (used by {@link #ToString()} for the value
  14024. Contained in this record. Trailing new-line should not be Appended
  14025. (superclass does that).
  14026. </member>
  14027. <member name="P:NPOI.HSSF.Record.OldCellRecord.RecordName">
  14028. Gets the debug info BIFF record type name (used by {@link #ToString()}.
  14029. </member>
  14030. <member name="T:NPOI.HSSF.Record.OldFormulaRecord">
  14031. Formula Record (0x0006 / 0x0206 / 0x0406) - holds a formula in
  14032. encoded form, along with the value if a number
  14033. </member>
  14034. <member name="P:NPOI.HSSF.Record.OldFormulaRecord.Value">
  14035. Get the calculated value of the formula
  14036. @return calculated value
  14037. </member>
  14038. <member name="P:NPOI.HSSF.Record.OldFormulaRecord.Options">
  14039. Get the option flags
  14040. @return bitmask
  14041. </member>
  14042. <member name="P:NPOI.HSSF.Record.OldFormulaRecord.ParsedExpression">
  14043. @return the formula tokens. never <code>null</code>
  14044. </member>
  14045. <member name="T:NPOI.HSSF.Record.OldLabelRecord">
  14046. Biff2 - Biff 4 Label Record (0x0004 / 0x0204) - read only support for
  14047. strings stored directly in the cell, from the older file formats that
  14048. didn't use {@link LabelSSTRecord}
  14049. </member>
  14050. <member name="M:NPOI.HSSF.Record.OldLabelRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14051. @param in the RecordInputstream to read the record from
  14052. </member>
  14053. <member name="P:NPOI.HSSF.Record.OldLabelRecord.StringLength">
  14054. Get the number of characters this string Contains
  14055. @return number of characters
  14056. </member>
  14057. <member name="P:NPOI.HSSF.Record.OldLabelRecord.Value">
  14058. Get the String of the cell
  14059. </member>
  14060. <member name="M:NPOI.HSSF.Record.OldLabelRecord.Serialize(System.Int32,System.Byte[])">
  14061. Not supported
  14062. </member>
  14063. <member name="T:NPOI.HSSF.Record.OldSheetRecord">
  14064. Title: Bound Sheet Record (aka BundleSheet) (0x0085) for BIFF 5<br/>
  14065. Description: Defines a sheet within a workbook. Basically stores the sheet name
  14066. and tells where the Beginning of file record is within the HSSF
  14067. file.
  14068. </member>
  14069. <member name="P:NPOI.HSSF.Record.OldSheetRecord.PositionOfBof">
  14070. Get the offset in bytes of the Beginning of File Marker within the HSSF Stream part of the POIFS file
  14071. @return offset in bytes
  14072. </member>
  14073. <member name="P:NPOI.HSSF.Record.OldSheetRecord.Sheetname">
  14074. Get the sheetname for this sheet. (this appears in the tabs at the bottom)
  14075. @return sheetname the name of the sheet
  14076. </member>
  14077. <member name="T:NPOI.HSSF.Record.OldStringRecord">
  14078. Biff2 - Biff 4 Label Record (0x0007 / 0x0207) - read only support for
  14079. formula string results.
  14080. </member>
  14081. <member name="M:NPOI.HSSF.Record.OldStringRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14082. @param in the RecordInputstream to read the record from
  14083. </member>
  14084. <member name="M:NPOI.HSSF.Record.OldStringRecord.GetString">
  14085. @return The string represented by this record.
  14086. </member>
  14087. <member name="T:NPOI.HSSF.Record.PageBreakRecord">
  14088. Record that Contains the functionality page _breaks (horizontal and vertical)
  14089. The other two classes just specifically Set the SIDS for record creation.
  14090. REFERENCE: Microsoft Excel SDK page 322 and 420
  14091. @see HorizontalPageBreakRecord
  14092. @see VerticalPageBreakRecord
  14093. @author Danny Mui (dmui at apache dot org)
  14094. </member>
  14095. <member name="T:NPOI.HSSF.Record.PageBreakRecord.Break">
  14096. Since both records store 2byte integers (short), no point in
  14097. differentiating it in the records.
  14098. The subs (rows or columns, don't seem to be able to Set but excel Sets
  14099. them automatically)
  14100. </member>
  14101. <member name="M:NPOI.HSSF.Record.PageBreakRecord.AddBreak(System.Int32,System.Int32,System.Int32)">
  14102. Adds the page break at the specified parameters
  14103. @param main Depending on sid, will determine row or column to put page break (zero-based)
  14104. @param subFrom No user-interface to Set (defaults to minumum, 0)
  14105. @param subTo No user-interface to Set
  14106. </member>
  14107. <member name="M:NPOI.HSSF.Record.PageBreakRecord.RemoveBreak(System.Int32)">
  14108. Removes the break indicated by the parameter
  14109. @param main (zero-based)
  14110. </member>
  14111. <member name="M:NPOI.HSSF.Record.PageBreakRecord.GetBreak(System.Int32)">
  14112. Retrieves the region at the row/column indicated
  14113. @param main FIXME: Document this!
  14114. @return The Break or null if no break exists at the row/col specified.
  14115. </member>
  14116. <member name="T:NPOI.HSSF.Record.PaletteRecord">
  14117. PaletteRecord - Supports custom palettes.
  14118. @author Andrew C. Oliver (acoliver at apache dot org)
  14119. @author Brian Sanders (bsanders at risklabs dot com) - custom palette editing
  14120. @version 2.0-pre
  14121. </member>
  14122. <member name="F:NPOI.HSSF.Record.PaletteRecord.STANDARD_PALETTE_SIZE">
  14123. The standard size of an XLS palette
  14124. </member>
  14125. <member name="F:NPOI.HSSF.Record.PaletteRecord.FIRST_COLOR_INDEX">
  14126. The byte index of the first color
  14127. </member>
  14128. <member name="M:NPOI.HSSF.Record.PaletteRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14129. Constructs a PaletteRecord record and Sets its fields appropriately.
  14130. @param in the RecordInputstream to Read the record from
  14131. </member>
  14132. <member name="M:NPOI.HSSF.Record.PaletteRecord.ClearColors">
  14133. <summary>
  14134. Dangerous! Only call this if you intend to replace the colors!
  14135. </summary>
  14136. </member>
  14137. <member name="M:NPOI.HSSF.Record.PaletteRecord.GetColor(System.Int16)">
  14138. Returns the color value at a given index
  14139. @return the RGB triplet for the color, or null if the specified index
  14140. does not exist
  14141. </member>
  14142. <member name="M:NPOI.HSSF.Record.PaletteRecord.SetColor(System.Int16,System.Byte,System.Byte,System.Byte)">
  14143. Sets the color value at a given index
  14144. If the given index Is greater than the current last color index,
  14145. then black Is Inserted at every index required to make the palette continuous.
  14146. @param byteIndex the index to Set; if this index Is less than 0x8 or greater than
  14147. 0x40, then no modification Is made
  14148. </member>
  14149. <member name="M:NPOI.HSSF.Record.PaletteRecord.CreateDefaultPalette">
  14150. Creates the default palette as PaletteRecord binary data
  14151. @see org.apache.poi.hssf.model.Workbook#createPalette
  14152. </member>
  14153. <member name="T:NPOI.HSSF.Record.PColor">
  14154. PColor - element in the list of colors - consider it a "struct"
  14155. </member>
  14156. <member name="T:NPOI.HSSF.Record.PaneRecord">
  14157. * Describes the frozen and Unfozen panes.
  14158. * NOTE: This source Is automatically generated please do not modify this file. Either subclass or
  14159. * Remove the record in src/records/definitions.
  14160. * @author Glen Stampoultzis (glens at apache.org)
  14161. </member>
  14162. <member name="M:NPOI.HSSF.Record.PaneRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14163. Constructs a Pane record and Sets its fields appropriately.
  14164. @param in the RecordInputstream to Read the record from
  14165. </member>
  14166. <member name="P:NPOI.HSSF.Record.PaneRecord.X">
  14167. Get the x field for the Pane record.
  14168. </member>
  14169. <member name="P:NPOI.HSSF.Record.PaneRecord.Y">
  14170. Get the y field for the Pane record.
  14171. </member>
  14172. <member name="P:NPOI.HSSF.Record.PaneRecord.TopRow">
  14173. Get the top row field for the Pane record.
  14174. </member>
  14175. <member name="P:NPOI.HSSF.Record.PaneRecord.LeftColumn">
  14176. Get the left column field for the Pane record.
  14177. </member>
  14178. <member name="P:NPOI.HSSF.Record.PaneRecord.ActivePane">
  14179. Get the active pane field for the Pane record.
  14180. @return One of
  14181. ACTIVE_PANE_LOWER_RIGHT
  14182. ACTIVE_PANE_UPPER_RIGHT
  14183. ACTIVE_PANE_LOWER_LEFT
  14184. ACTIVE_PANE_UPPER_LEFT
  14185. </member>
  14186. <member name="T:NPOI.HSSF.Record.PasswordRecord">
  14187. Title: Password Record
  14188. Description: stores the encrypted password for a sheet or workbook (HSSF doesn't support encryption)
  14189. REFERENCE: PG 371 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14190. @author Andrew C. Oliver (acoliver at apache dot org)
  14191. @version 2.0-pre
  14192. </member>
  14193. <member name="M:NPOI.HSSF.Record.PasswordRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14194. Constructs a Password record and Sets its fields appropriately.
  14195. @param in the RecordInputstream to Read the record from
  14196. </member>
  14197. <member name="P:NPOI.HSSF.Record.PasswordRecord.Password">
  14198. Get the password
  14199. @return short representing the password
  14200. </member>
  14201. <member name="M:NPOI.HSSF.Record.PasswordRecord.Clone">
  14202. Clone this record.
  14203. </member>
  14204. <member name="T:NPOI.HSSF.Record.PasswordRev4Record">
  14205. Title: Protection Revision 4 password Record
  14206. Description: Stores the (2 byte??!!) encrypted password for a shared
  14207. workbook
  14208. REFERENCE: PG 374 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14209. @author Andrew C. Oliver (acoliver at apache dot org)
  14210. @version 2.0-pre
  14211. </member>
  14212. <member name="M:NPOI.HSSF.Record.PasswordRev4Record.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14213. Constructs a PasswordRev4 (PROT4REVPASS) record and Sets its fields appropriately.
  14214. @param in the RecordInputstream to Read the record from
  14215. </member>
  14216. <member name="M:NPOI.HSSF.Record.PasswordRev4Record.SetPassword(System.Int16)">
  14217. set the password
  14218. @param pw representing the password
  14219. </member>
  14220. <member name="T:NPOI.HSSF.Record.PivotTable.DataItemRecord">
  14221. SXDI - Data Item (0x00C5)<br/>
  14222. @author Patrick Cheng
  14223. </member>
  14224. <member name="T:NPOI.HSSF.Record.PivotTable.ExtendedPivotTableViewFieldsRecord">
  14225. SXVDEX - Extended PivotTable View Fields (0x0100)<br/>
  14226. @author Patrick Cheng
  14227. </member>
  14228. <member name="F:NPOI.HSSF.Record.PivotTable.ExtendedPivotTableViewFieldsRecord.STRING_NOT_PRESENT_LEN">
  14229. the value of the <c>cchSubName</c> field when the subName is not present
  14230. </member>
  14231. <member name="T:NPOI.HSSF.Record.PivotTable.PageItemRecord">
  14232. SXPI - Page Item (0x00B6)<br/>
  14233. @author Patrick Cheng
  14234. </member>
  14235. <member name="F:NPOI.HSSF.Record.PivotTable.PageItemRecord.FieldInfo._isxvi">
  14236. Index to the View Item SXVI(0x00B2) record
  14237. </member>
  14238. <member name="F:NPOI.HSSF.Record.PivotTable.PageItemRecord.FieldInfo._isxvd">
  14239. Index to the {@link ViewFieldsRecord} SXVD(0x00B1) record
  14240. </member>
  14241. <member name="F:NPOI.HSSF.Record.PivotTable.PageItemRecord.FieldInfo._idObj">
  14242. Object ID for the drop-down arrow
  14243. </member>
  14244. <member name="T:NPOI.HSSF.Record.PivotTable.StreamIDRecord">
  14245. SXIDSTM - Stream ID (0x00D5)<br/>
  14246. @author Patrick Cheng
  14247. </member>
  14248. <member name="T:NPOI.HSSF.Record.PivotTable.ViewDefinitionRecord">
  14249. SXVIEW - View Definition (0x00B0)<br/>
  14250. @author Patrick Cheng
  14251. </member>
  14252. <member name="T:NPOI.HSSF.Record.PivotTable.ViewFieldsRecord">
  14253. SXVD - View Fields (0x00B1)<br/>
  14254. @author Patrick Cheng
  14255. </member>
  14256. <member name="T:NPOI.HSSF.Record.PivotTable.ViewFieldsRecord.Axis">
  14257. values for the {@link ViewFieldsRecord#sxaxis} field
  14258. </member>
  14259. <member name="F:NPOI.HSSF.Record.PivotTable.ViewFieldsRecord.STRING_NOT_PRESENT_LEN">
  14260. the value of the <c>cchName</c> field when the name is not present
  14261. </member>
  14262. <member name="F:NPOI.HSSF.Record.PivotTable.ViewFieldsRecord.BASE_SIZE">
  14263. 5 shorts
  14264. </member>
  14265. <member name="T:NPOI.HSSF.Record.PivotTable.ViewSourceRecord">
  14266. SXVS - View Source (0x00E3)<br/>
  14267. @author Patrick Cheng
  14268. </member>
  14269. <member name="T:NPOI.HSSF.Record.PrecisionRecord">
  14270. Title: Precision Record
  14271. Description: defines whether to store with full precision or what's Displayed by the gui
  14272. (meaning have really screwed up and skewed figures or only think you do!)
  14273. REFERENCE: PG 372 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14274. @author Andrew C. Oliver (acoliver at apache dot org)
  14275. @version 2.0-pre
  14276. </member>
  14277. <member name="M:NPOI.HSSF.Record.PrecisionRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14278. Constructs a Precision record and Sets its fields appropriately.
  14279. @param in the RecordInputstream to Read the record from
  14280. </member>
  14281. <member name="P:NPOI.HSSF.Record.PrecisionRecord.FullPrecision">
  14282. Get whether to use full precision or just skew all you figures all to hell.
  14283. @return fullprecision - or not
  14284. </member>
  14285. <member name="T:NPOI.HSSF.Record.PrintGridlinesRecord">
  14286. Title: Print Gridlines Record
  14287. Description: whether to print the gridlines when you enjoy you spReadsheet on paper.
  14288. REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14289. @author Andrew C. Oliver (acoliver at apache dot org)
  14290. @author Jason Height (jheight at chariot dot net dot au)
  14291. @version 2.0-pre
  14292. </member>
  14293. <member name="M:NPOI.HSSF.Record.PrintGridlinesRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14294. Constructs a PrintGridlines record and Sets its fields appropriately.
  14295. @param in the RecordInputstream to Read the record from
  14296. </member>
  14297. <member name="P:NPOI.HSSF.Record.PrintGridlinesRecord.PrintGridlines">
  14298. Get whether or not to print the gridlines (and make your spReadsheet ugly)
  14299. @return make spReadsheet ugly - Y/N
  14300. </member>
  14301. <member name="T:NPOI.HSSF.Record.PrintHeadersRecord">
  14302. Title: Print Headers Record
  14303. Description: Whether or not to print the row/column headers when you
  14304. enjoy your spReadsheet in the physical form.
  14305. REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14306. @author Andrew C. Oliver (acoliver at apache dot org)
  14307. @author Jason Height (jheight at chariot dot net dot au)
  14308. @version 2.0-pre
  14309. </member>
  14310. <member name="M:NPOI.HSSF.Record.PrintHeadersRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14311. Constructs a PrintHeaders record and Sets its fields appropriately.
  14312. @param in the RecordInputstream to Read the record from
  14313. </member>
  14314. <member name="P:NPOI.HSSF.Record.PrintHeadersRecord.PrintHeaders">
  14315. <summary>
  14316. Get whether to print the headers - y/n
  14317. </summary>
  14318. <value><c>true</c> if [print headers]; otherwise, <c>false</c>.</value>
  14319. </member>
  14320. <member name="T:NPOI.HSSF.Record.PrintSetupRecord">
  14321. Title: Print Setup Record
  14322. Description: Stores print Setup options -- bogus for HSSF (and marked as such)
  14323. REFERENCE: PG 385 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14324. @author Andrew C. Oliver (acoliver at apache dot org)
  14325. @author Jason Height (jheight at chariot dot net dot au)
  14326. @version 2.0-pre
  14327. </member>
  14328. <member name="M:NPOI.HSSF.Record.PrintSetupRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14329. Constructs a PrintSetup (SetUP) record and Sets its fields appropriately.
  14330. @param in the RecordInputstream to Read the record from
  14331. </member>
  14332. <member name="T:NPOI.HSSF.Record.ProtectionRev4Record">
  14333. Title: Protection Revision 4 Record
  14334. Description: describes whether this is a protected shared/tracked workbook
  14335. ( HSSF does not support encryption because we don't feel like going to jail )
  14336. REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14337. @author Andrew C. Oliver (acoliver at apache dot org)
  14338. @version 2.0-pre
  14339. </member>
  14340. <member name="M:NPOI.HSSF.Record.ProtectionRev4Record.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14341. Constructs a ProtectionRev4 record and Sets its fields appropriately.
  14342. @param in the RecordInputstream to Read the record from
  14343. </member>
  14344. <member name="P:NPOI.HSSF.Record.ProtectionRev4Record.Protect">
  14345. Get whether the this is protected shared/tracked workbook or not
  14346. @return whether to protect the workbook or not
  14347. </member>
  14348. <member name="T:NPOI.HSSF.Record.ProtectRecord">
  14349. Title: Protect Record
  14350. Description: defines whether a sheet or workbook is protected (HSSF DOES NOT SUPPORT ENCRYPTION)
  14351. (kindly ask the US government to stop having arcane stupid encryption laws and we'll support it)
  14352. (after all terrorists will all use US-legal encrypton right??)
  14353. HSSF now supports the simple "protected" sheets (where they are not encrypted and open office et al
  14354. ignore the password record entirely).
  14355. REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14356. @author Andrew C. Oliver (acoliver at apache dot org)
  14357. </member>
  14358. <member name="M:NPOI.HSSF.Record.ProtectRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14359. Constructs a Protect record and Sets its fields appropriately.
  14360. @param in the RecordInputstream to Read the record from
  14361. </member>
  14362. <member name="P:NPOI.HSSF.Record.ProtectRecord.Protect">
  14363. Get whether the sheet is protected or not
  14364. @return whether to protect the sheet or not
  14365. </member>
  14366. <member name="T:NPOI.HSSF.Record.RecalcIdRecord">
  14367. Title: Recalc Id Record
  14368. Description: This record Contains an ID that marks when a worksheet was last
  14369. recalculated. It's an optimization Excel uses to determine if it
  14370. needs to recalculate the spReadsheet when it's opened. So far, only
  14371. the two values <c>0xC1 0x01 0x00 0x00 0x80 0x38 0x01 0x00</c>
  14372. (do not recalculate) and <c>0xC1 0x01 0x00 0x00 0x60 0x69 0x01
  14373. 0x00</c> have been seen. If the field <c>isNeeded</c> Is
  14374. Set to false (default), then this record Is swallowed during the
  14375. serialization Process
  14376. REFERENCE: http://chicago.sourceforge.net/devel/docs/excel/biff8.html
  14377. @author Luc Girardin (luc dot girardin at macrofocus dot com)
  14378. @version 2.0-pre
  14379. @see org.apache.poi.hssf.model.Workbook
  14380. </member>
  14381. <member name="F:NPOI.HSSF.Record.RecalcIdRecord._engineId">
  14382. An unsigned integer that specifies the recalculation engine identifier
  14383. of the recalculation engine that performed the last recalculation.
  14384. If the value is less than the recalculation engine identifier associated with the application,
  14385. the application will recalculate the results of all formulas on
  14386. this workbook immediately after loading the file
  14387. </member>
  14388. <member name="M:NPOI.HSSF.Record.RecalcIdRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14389. Constructs a RECALCID record and Sets its fields appropriately.
  14390. @param in the RecordInputstream to Read the record from
  14391. </member>
  14392. <member name="T:NPOI.HSSF.Record.Record">
  14393. Title: Record
  14394. Description: All HSSF Records inherit from this class. It
  14395. populates the fields common to all records (id, size and data).
  14396. Subclasses should be sure to validate the id,
  14397. Company:
  14398. @author Andrew C. Oliver
  14399. @author Marc Johnson (mjohnson at apache dot org)
  14400. @author Jason Height (jheight at chariot dot net dot au)
  14401. @version 2.0-pre
  14402. </member>
  14403. <member name="M:NPOI.HSSF.Record.Record.#ctor">
  14404. instantiates a blank record strictly for ID matching
  14405. </member>
  14406. <member name="M:NPOI.HSSF.Record.Record.Serialize">
  14407. called by the class that is responsible for writing this sucker.
  14408. Subclasses should implement this so that their data is passed back in a
  14409. byte array.
  14410. @return byte array containing instance data
  14411. </member>
  14412. <member name="P:NPOI.HSSF.Record.Record.Sid">
  14413. return the non static version of the id for this record.
  14414. </member>
  14415. <member name="T:NPOI.HSSF.Record.RecordBase">
  14416. Common base class of {@link Record} and {@link RecordAggregate}
  14417. @author Josh Micich
  14418. </member>
  14419. <member name="M:NPOI.HSSF.Record.RecordBase.Serialize(System.Int32,System.Byte[])">
  14420. called by the class that is responsible for writing this sucker.
  14421. Subclasses should implement this so that their data is passed back in a
  14422. byte array.
  14423. @param offset to begin writing at
  14424. @param data byte array containing instance data
  14425. @return number of bytes written
  14426. </member>
  14427. <member name="P:NPOI.HSSF.Record.RecordBase.RecordSize">
  14428. gives the current serialized size of the record. Should include the sid
  14429. and reclength (4 bytes).
  14430. </member>
  14431. <member name="T:NPOI.HSSF.Record.RecordFactory">
  14432. Title: Record Factory
  14433. Description: Takes a stream and outputs an array of Record objects.
  14434. @deprecated use {@link org.apache.poi.hssf.eventmodel.EventRecordFactory} instead
  14435. @see org.apache.poi.hssf.eventmodel.EventRecordFactory
  14436. @author Andrew C. Oliver (acoliver at apache dot org)
  14437. @author Marc Johnson (mjohnson at apache dot org)
  14438. @author Glen Stampoultzis (glens at apache.org)
  14439. @author Csaba Nagy (ncsaba at yahoo dot com)
  14440. </member>
  14441. <member name="T:NPOI.HSSF.Record.RecordFactory.ReflectionMethodRecordCreator">
  14442. A "create" method is used instead of the usual constructor if the created record might
  14443. be of a different class to the declaring class.
  14444. </member>
  14445. <member name="F:NPOI.HSSF.Record.RecordFactory._recordCreatorsById">
  14446. cache of the recordsToMap();
  14447. </member>
  14448. <member name="M:NPOI.HSSF.Record.RecordFactory.GetRecordClass(System.Int32)">
  14449. Debug / diagnosis method<br/>
  14450. Gets the POI implementation class for a given <tt>sid</tt>. Only a subset of the any BIFF
  14451. records are actually interpreted by POI. A few others are known but not interpreted
  14452. (see {@link UnknownRecord#getBiffName(int)}).
  14453. @return the POI implementation class for the specified record <tt>sid</tt>.
  14454. <code>null</code> if the specified record is not interpreted by POI.
  14455. </member>
  14456. <member name="M:NPOI.HSSF.Record.RecordFactory.SetCapacity(System.Int32)">
  14457. Changes the default capacity (10000) to handle larger files
  14458. </member>
  14459. <member name="M:NPOI.HSSF.Record.RecordFactory.CreateRecords(System.IO.Stream)">
  14460. Create an array of records from an input stream
  14461. @param in the InputStream from which the records will be
  14462. obtained
  14463. @return an array of Records Created from the InputStream
  14464. @exception RecordFormatException on error Processing the
  14465. InputStream
  14466. </member>
  14467. <member name="M:NPOI.HSSF.Record.RecordFactory.ConvertBlankRecords(NPOI.HSSF.Record.MulBlankRecord)">
  14468. Converts a {@link MulBlankRecord} into an equivalent array of {@link BlankRecord}s
  14469. </member>
  14470. <member name="M:NPOI.HSSF.Record.RecordFactory.ConvertToNumberRecord(NPOI.HSSF.Record.RKRecord)">
  14471. <summary>
  14472. RK record is a slightly smaller alternative to NumberRecord
  14473. POI likes NumberRecord better
  14474. </summary>
  14475. <param name="rk">The rk.</param>
  14476. <returns></returns>
  14477. </member>
  14478. <member name="M:NPOI.HSSF.Record.RecordFactory.ConvertRKRecords(NPOI.HSSF.Record.MulRKRecord)">
  14479. <summary>
  14480. Converts a MulRKRecord into an equivalent array of NumberRecords
  14481. </summary>
  14482. <param name="mrk">The MRK.</param>
  14483. <returns></returns>
  14484. </member>
  14485. <member name="T:NPOI.HSSF.Record.RecordFactoryInputStream">
  14486. A stream based way to get at complete records, with
  14487. as low a memory footprint as possible.
  14488. This handles Reading from a RecordInputStream, turning
  14489. the data into full records, processing continue records
  14490. etc.
  14491. Most users should use {@link HSSFEventFactory} /
  14492. {@link HSSFListener} and have new records pushed to
  14493. them, but this does allow for a "pull" style of coding.
  14494. </member>
  14495. <member name="T:NPOI.HSSF.Record.RecordFactoryInputStream.StreamEncryptionInfo">
  14496. Keeps track of the sizes of the Initial records up to and including {@link FilePassRecord}
  14497. Needed for protected files because each byte is encrypted with respect to its absolute
  14498. position from the start of the stream.
  14499. </member>
  14500. <member name="P:NPOI.HSSF.Record.RecordFactoryInputStream.StreamEncryptionInfo.LastRecord">
  14501. @return last record scanned while looking for encryption info.
  14502. This will typically be the first or second record Read. Possibly <code>null</code>
  14503. if stream was empty
  14504. </member>
  14505. <member name="P:NPOI.HSSF.Record.RecordFactoryInputStream.StreamEncryptionInfo.HasBOFRecord">
  14506. <c>false</c> in some test cases
  14507. </member>
  14508. <member name="F:NPOI.HSSF.Record.RecordFactoryInputStream._unreadRecordBuffer">
  14509. Temporarily stores a group of {@link Record}s, for future return by {@link #nextRecord()}.
  14510. This is used at the start of the workbook stream, and also when the most recently read
  14511. underlying record is a {@link MulRKRecord}
  14512. </member>
  14513. <member name="F:NPOI.HSSF.Record.RecordFactoryInputStream._unreadRecordIndex">
  14514. used to help iterating over the unread records
  14515. </member>
  14516. <member name="F:NPOI.HSSF.Record.RecordFactoryInputStream._lastRecord">
  14517. The most recent record that we gave to the user
  14518. </member>
  14519. <member name="F:NPOI.HSSF.Record.RecordFactoryInputStream._lastDrawingRecord">
  14520. The most recent DrawingRecord seen
  14521. </member>
  14522. <member name="M:NPOI.HSSF.Record.RecordFactoryInputStream.#ctor(System.IO.Stream,System.Boolean)">
  14523. @param shouldIncludeContinueRecords caller can pass <c>false</c> if loose
  14524. {@link ContinueRecord}s should be skipped (this is sometimes useful in event based
  14525. processing).
  14526. </member>
  14527. <member name="M:NPOI.HSSF.Record.RecordFactoryInputStream.NextRecord">
  14528. Returns the next (complete) record from the
  14529. stream, or null if there are no more.
  14530. </member>
  14531. <member name="M:NPOI.HSSF.Record.RecordFactoryInputStream.GetNextUnreadRecord">
  14532. @return the next {@link Record} from the multiple record group as expanded from
  14533. a recently read {@link MulRKRecord}. <code>null</code> if not present.
  14534. </member>
  14535. <member name="M:NPOI.HSSF.Record.RecordFactoryInputStream.ReadNextRecord">
  14536. @return the next available record, or <code>null</code> if
  14537. this pass didn't return a record that's
  14538. suitable for returning (eg was a continue record).
  14539. </member>
  14540. <member name="T:NPOI.HSSF.Record.RecordInputStream">
  14541. Title: Record Input Stream
  14542. Description: Wraps a stream and provides helper methods for the construction of records.
  14543. @author Jason Height (jheight @ apache dot org)
  14544. </member>
  14545. <member name="F:NPOI.HSSF.Record.RecordInputStream.MAX_RECORD_DATA_SIZE">
  14546. Maximum size of a single record (minus the 4 byte header) without a continue
  14547. </member>
  14548. <member name="F:NPOI.HSSF.Record.RecordInputStream._bhi">
  14549. Header {@link LittleEndianInput} facet of the wrapped {@link InputStream}
  14550. </member>
  14551. <member name="F:NPOI.HSSF.Record.RecordInputStream._dataInput">
  14552. Data {@link LittleEndianInput} facet of the wrapped {@link InputStream}
  14553. </member>
  14554. <member name="M:NPOI.HSSF.Record.RecordInputStream.#ctor(System.IO.Stream)">
  14555. the record identifier of the BIFF record currently being read
  14556. </member>
  14557. <member name="M:NPOI.HSSF.Record.RecordInputStream.Read">
  14558. This method will Read a byte from the current record
  14559. </member>
  14560. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadNextSid">
  14561. @return the sid of the next record or {@link #INVALID_SID_VALUE} if at end of stream
  14562. </member>
  14563. <member name="M:NPOI.HSSF.Record.RecordInputStream.NextRecord">
  14564. Moves to the next record in the stream.
  14565. <i>Note: The auto continue flag is Reset to true</i>
  14566. </member>
  14567. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadByte">
  14568. Reads an 8 bit, signed value
  14569. </member>
  14570. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadShort">
  14571. Reads a 16 bit, signed value
  14572. </member>
  14573. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadUByte">
  14574. Reads an 8 bit, Unsigned value
  14575. </member>
  14576. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadUShort">
  14577. Reads a 16 bit,un- signed value.
  14578. @return
  14579. </member>
  14580. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadUnicodeLEString(System.Int32)">
  14581. given a byte array of 16-bit Unicode Chars, compress to 8-bit and
  14582. return a string
  14583. { 0x16, 0x00 } -0x16
  14584. @param Length the Length of the string
  14585. @return the Converted string
  14586. @exception ArgumentException if len is too large (i.e.,
  14587. there is not enough data in string to Create a String of that
  14588. Length)
  14589. </member>
  14590. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadRemainder">
  14591. Returns the remaining bytes for the current record.
  14592. @return The remaining bytes of the current record.
  14593. </member>
  14594. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadAllContinuedRemainder">
  14595. Reads all byte data for the current record, including any
  14596. that overlaps into any following continue records.
  14597. @deprecated Best to write a input stream that wraps this one where there Is
  14598. special sub record that may overlap continue records.
  14599. </member>
  14600. <member name="P:NPOI.HSSF.Record.RecordInputStream.Remaining">
  14601. The remaining number of bytes in the <i>current</i> record.
  14602. @return The number of bytes remaining in the current record
  14603. </member>
  14604. <member name="P:NPOI.HSSF.Record.RecordInputStream.IsContinueNext">
  14605. Returns true iif a Continue record is next in the excel stream _currentDataOffset
  14606. @return True when a ContinueRecord is next.
  14607. </member>
  14608. <member name="M:NPOI.HSSF.Record.RecordInputStream.GetNextSid">
  14609. @return sid of next record. Can be called after hasNextRecord()
  14610. </member>
  14611. <member name="T:NPOI.HSSF.Record.RefModeRecord">
  14612. Title: RefMode Record
  14613. Description: Describes which reference mode to use
  14614. REFERENCE: PG 376 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14615. @author Andrew C. Oliver (acoliver at apache dot org)
  14616. @author Jason Height (jheight at chariot dot net dot au)
  14617. @version 2.0-pre
  14618. </member>
  14619. <member name="M:NPOI.HSSF.Record.RefModeRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14620. Constructs a RefMode record and Sets its fields appropriately.
  14621. @param in the RecordInputstream to Read the record from
  14622. </member>
  14623. <member name="P:NPOI.HSSF.Record.RefModeRecord.Mode">
  14624. Get the reference mode to use (HSSF uses/assumes A1)
  14625. @return mode to use
  14626. @see #USE_A1_MODE
  14627. @see #USE_R1C1_MODE
  14628. </member>
  14629. <member name="T:NPOI.HSSF.Record.RefreshAllRecord">
  14630. Title: Refresh All Record
  14631. Description: Flag whether to refresh all external data when loading a sheet.
  14632. (which hssf doesn't support anyhow so who really cares?)
  14633. REFERENCE: PG 376 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14634. @author Andrew C. Oliver (acoliver at apache dot org)
  14635. @version 2.0-pre
  14636. </member>
  14637. <member name="M:NPOI.HSSF.Record.RefreshAllRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14638. Constructs a RefreshAll record and Sets its fields appropriately.
  14639. @param in the RecordInputstream to Read the record from
  14640. </member>
  14641. <member name="P:NPOI.HSSF.Record.RefreshAllRecord.RefreshAll">
  14642. Get whether to refresh all external data when loading a sheet
  14643. @return refreshall or not
  14644. </member>
  14645. <member name="T:NPOI.HSSF.Record.RightMarginRecord">
  14646. Record for the right margin. * NOTE: This source was automatically generated. * @author Shawn Laubach (slaubach at apache dot org)
  14647. </member>
  14648. <member name="M:NPOI.HSSF.Record.RightMarginRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14649. 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)
  14650. </member>
  14651. <member name="P:NPOI.HSSF.Record.RightMarginRecord.Margin">
  14652. Get the margin field for the RightMargin record.
  14653. </member>
  14654. <member name="T:NPOI.HSSF.Record.RKRecord">
  14655. Title: RK Record
  14656. Description: An internal 32 bit number with the two most significant bits
  14657. storing the type. This is part of a bizarre scheme to save disk
  14658. space and memory (gee look at all the other whole records that
  14659. are in the file just "cause"..,far better to waste Processor
  14660. cycles on this then leave on of those "valuable" records out).
  14661. We support this in Read-ONLY mode. HSSF Converts these to NUMBER records
  14662. REFERENCE: PG 376 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14663. @author Andrew C. Oliver (acoliver at apache dot org)
  14664. @author Jason Height (jheight at chariot dot net dot au)
  14665. @version 2.0-pre
  14666. @see org.apache.poi.hssf.record.NumberRecord
  14667. </member>
  14668. <member name="M:NPOI.HSSF.Record.RKRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14669. Constructs a RK record and Sets its fields appropriately.
  14670. @param in the RecordInputstream to Read the record from
  14671. </member>
  14672. <member name="P:NPOI.HSSF.Record.RKRecord.RKType">
  14673. Get the type of the number
  14674. @return one of these values:
  14675. <OL START="0">
  14676. <LI>RK_IEEE_NUMBER</LI>
  14677. <LI>RK_IEEE_NUMBER_TIMES_100</LI>
  14678. <LI>RK_INTEGER</LI>
  14679. <LI>RK_INTEGER_TIMES_100</LI>
  14680. </OL>
  14681. </member>
  14682. <member name="P:NPOI.HSSF.Record.RKRecord.RKNumber">
  14683. Extract the value of the number
  14684. The mechanism for determining the value is dependent on the two
  14685. low order bits of the raw number. If bit 1 is Set, the number
  14686. is an integer and can be cast directly as a double, otherwise,
  14687. it's apparently the exponent and mantissa of a double (and the
  14688. remaining low-order bits of the double's mantissa are 0's).
  14689. If bit 0 is Set, the result of the conversion to a double Is
  14690. divided by 100; otherwise, the value is left alone.
  14691. [Insert picture of Screwy Squirrel in full Napoleonic regalia]
  14692. @return the value as a proper double (hey, it <B>could</B>
  14693. happen)
  14694. </member>
  14695. <member name="T:NPOI.HSSF.Record.RowDataRecord">
  14696. <summary>
  14697. this record only used for record that has name and not implemented.
  14698. </summary>
  14699. </member>
  14700. <member name="T:NPOI.HSSF.Record.RowRecord">
  14701. Title: Row Record
  14702. Description: stores the row information for the sheet.
  14703. REFERENCE: PG 379 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14704. @author Andrew C. Oliver (acoliver at apache dot org)
  14705. @author Jason Height (jheight at chariot dot net dot au)
  14706. @version 2.0-pre
  14707. </member>
  14708. <member name="F:NPOI.HSSF.Record.RowRecord.MAX_ROW_NUMBER">
  14709. The maximum row number that excel can handle (zero based) ie 65536 rows Is
  14710. max number of rows.
  14711. </member>
  14712. <member name="F:NPOI.HSSF.Record.RowRecord.field_7_option_flags">
  14713. 16 bit options flags
  14714. </member>
  14715. <member name="M:NPOI.HSSF.Record.RowRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14716. Constructs a Row record and Sets its fields appropriately.
  14717. @param in the RecordInputstream to Read the record from
  14718. </member>
  14719. <member name="P:NPOI.HSSF.Record.RowRecord.IsEmpty">
  14720. Get the logical row number for this row (0 based index)
  14721. @return row - the row number
  14722. </member>
  14723. <member name="P:NPOI.HSSF.Record.RowRecord.FirstCol">
  14724. Get the logical col number for the first cell this row (0 based index)
  14725. @return col - the col number
  14726. </member>
  14727. <member name="P:NPOI.HSSF.Record.RowRecord.LastCol">
  14728. Get the logical col number for the last cell this row plus one (0 based index)
  14729. @return col - the last col number + 1
  14730. </member>
  14731. <member name="P:NPOI.HSSF.Record.RowRecord.Height">
  14732. Get the height of the row
  14733. @return height of the row
  14734. </member>
  14735. <member name="P:NPOI.HSSF.Record.RowRecord.Optimize">
  14736. Get whether to optimize or not (Set to 0)
  14737. @return optimize (Set to 0)
  14738. </member>
  14739. <member name="P:NPOI.HSSF.Record.RowRecord.OptionFlags">
  14740. Gets the option bitmask. (use the individual bit Setters that refer to this
  14741. method)
  14742. @return options - the bitmask
  14743. </member>
  14744. <member name="P:NPOI.HSSF.Record.RowRecord.OutlineLevel">
  14745. Get the outline level of this row
  14746. @return ol - the outline level
  14747. @see #GetOptionFlags()
  14748. </member>
  14749. <member name="P:NPOI.HSSF.Record.RowRecord.Colapsed">
  14750. Get whether or not to colapse this row
  14751. @return c - colapse or not
  14752. @see #GetOptionFlags()
  14753. </member>
  14754. <member name="P:NPOI.HSSF.Record.RowRecord.ZeroHeight">
  14755. Get whether or not to Display this row with 0 height
  14756. @return - z height is zero or not.
  14757. @see #GetOptionFlags()
  14758. </member>
  14759. <member name="P:NPOI.HSSF.Record.RowRecord.BadFontHeight">
  14760. Get whether the font and row height are not compatible
  14761. @return - f -true if they aren't compatible (damn not logic)
  14762. @see #GetOptionFlags()
  14763. </member>
  14764. <member name="P:NPOI.HSSF.Record.RowRecord.Formatted">
  14765. Get whether the row has been formatted (even if its got all blank cells)
  14766. @return formatted or not
  14767. @see #GetOptionFlags()
  14768. </member>
  14769. <member name="P:NPOI.HSSF.Record.RowRecord.XFIndex">
  14770. if the row is formatted then this is the index to the extended format record
  14771. @see org.apache.poi.hssf.record.ExtendedFormatRecord
  14772. @return index to the XF record or bogus value (undefined) if Isn't formatted
  14773. </member>
  14774. <member name="P:NPOI.HSSF.Record.RowRecord.TopBorder">
  14775. bit that specifies whether any cell in the row has a thick top border, or any
  14776. cell in the row directly above the current row has a thick bottom border.
  14777. @param f has thick top border
  14778. </member>
  14779. <member name="P:NPOI.HSSF.Record.RowRecord.BottomBorder">
  14780. A bit that specifies whether any cell in the row has a medium or thick
  14781. bottom border, or any cell in the row directly below the current row has
  14782. a medium or thick top border.
  14783. @param f has thick bottom border
  14784. </member>
  14785. <member name="P:NPOI.HSSF.Record.RowRecord.PhoeneticGuide">
  14786. A bit that specifies whether the phonetic guide feature is enabled for
  14787. any cell in this row.
  14788. @param f use phoenetic guide
  14789. </member>
  14790. <member name="T:NPOI.HSSF.Record.SaveRecalcRecord">
  14791. Title: Save Recalc Record
  14792. Description: defines whether to recalculate before saving (Set to true)
  14793. REFERENCE: PG 381 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14794. @author Andrew C. Oliver (acoliver at apache dot org)
  14795. @author Jason Height (jheight at chariot dot net dot au)
  14796. @version 2.0-pre
  14797. </member>
  14798. <member name="M:NPOI.HSSF.Record.SaveRecalcRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14799. Constructs an SaveRecalc record and Sets its fields appropriately.
  14800. @param in the RecordInputstream to Read the record from
  14801. </member>
  14802. <member name="P:NPOI.HSSF.Record.SaveRecalcRecord.Recalc">
  14803. Get whether to recalculate formulas/etc before saving or not
  14804. @return recalc - whether to recalculate or not
  14805. </member>
  14806. <member name="T:NPOI.HSSF.Record.ScenarioProtectRecord">
  14807. Title: Scenario Protect Record
  14808. Description: I have no idea what a Scenario is or why on would want to
  14809. protect it with the lamest "security" ever invented. However this record tells
  14810. excel "I want to protect my scenarios" (0xAF) with lame security. It appears
  14811. in conjunction with the PASSWORD and PROTECT records as well as its object
  14812. protect cousin.
  14813. REFERENCE: PG 383 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14814. @author Andrew C. Oliver (acoliver at apache dot org)
  14815. </member>
  14816. <member name="M:NPOI.HSSF.Record.ScenarioProtectRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14817. Constructs a Protect record and Sets its fields appropriately.
  14818. @param in the RecordInputstream to Read the record from
  14819. </member>
  14820. <member name="P:NPOI.HSSF.Record.ScenarioProtectRecord.Protect">
  14821. Get whether the sheet is protected or not
  14822. @return whether to protect the sheet or not
  14823. </member>
  14824. <member name="T:NPOI.HSSF.Record.SCLRecord">
  14825. * Specifies the window's zoom magnification. If this record Isn't present then the windows zoom is 100%. see p384 Excel Dev Kit
  14826. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14827. * Remove the record in src/records/definitions.
  14828. * @author Andrew C. Oliver (acoliver at apache.org)
  14829. </member>
  14830. <member name="M:NPOI.HSSF.Record.SCLRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14831. Constructs a SCL record and Sets its fields appropriately.
  14832. @param in the RecordInputstream to Read the record from
  14833. </member>
  14834. <member name="P:NPOI.HSSF.Record.SCLRecord.DataSize">
  14835. Size of record (exluding 4 byte header)
  14836. </member>
  14837. <member name="P:NPOI.HSSF.Record.SCLRecord.Numerator">
  14838. Get the numerator field for the SCL record.
  14839. </member>
  14840. <member name="P:NPOI.HSSF.Record.SCLRecord.Denominator">
  14841. Get the denominator field for the SCL record.
  14842. </member>
  14843. <member name="T:NPOI.HSSF.Record.SelectionRecord">
  14844. Title: Selection Record
  14845. Description: shows the user's selection on the sheet
  14846. for Write Set num refs to 0
  14847. TODO : Fully implement reference subrecords.
  14848. REFERENCE: PG 291 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14849. @author Andrew C. Oliver (acoliver at apache dot org)
  14850. @author Jason Height (jheight at chariot dot net dot au)
  14851. @author Glen Stampoultzis (glens at apache.org)
  14852. </member>
  14853. <member name="M:NPOI.HSSF.Record.SelectionRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14854. <summary>
  14855. Constructs a Selection record and Sets its fields appropriately.
  14856. </summary>
  14857. <param name="in1">the RecordInputstream to Read the record from</param>
  14858. </member>
  14859. <member name="P:NPOI.HSSF.Record.SelectionRecord.Pane">
  14860. <summary>
  14861. Gets or sets the pane this is for.
  14862. </summary>
  14863. <value>The pane.</value>
  14864. </member>
  14865. <member name="P:NPOI.HSSF.Record.SelectionRecord.ActiveCellRow">
  14866. <summary>
  14867. Gets or sets the active cell row.
  14868. </summary>
  14869. <value>row number of active cell</value>
  14870. </member>
  14871. <member name="P:NPOI.HSSF.Record.SelectionRecord.ActiveCellCol">
  14872. <summary>
  14873. Gets or sets the active cell's col
  14874. </summary>
  14875. <value>number of active cell</value>
  14876. </member>
  14877. <member name="P:NPOI.HSSF.Record.SelectionRecord.ActiveCellRef">
  14878. <summary>
  14879. Gets or sets the active cell's reference number
  14880. </summary>
  14881. <value>ref number of active cell</value>
  14882. </member>
  14883. <member name="T:NPOI.HSSF.Record.SharedFormulaRecord">
  14884. Title: SharedFormulaRecord
  14885. Description: Primarily used as an excel optimization so that multiple similar formulas
  14886. are not written out too many times. We should recognize this record and
  14887. Serialize as Is since this Is used when Reading templates.
  14888. Note: the documentation says that the SID Is BC where biffviewer reports 4BC. The hex dump shows
  14889. that the two byte sid representation to be 'BC 04' that Is consistent with the other high byte
  14890. record types.
  14891. @author Danny Mui at apache dot org
  14892. </member>
  14893. <member name="M:NPOI.HSSF.Record.SharedFormulaRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14894. @param in the RecordInputstream to Read the record from
  14895. </member>
  14896. <member name="M:NPOI.HSSF.Record.SharedFormulaRecord.ToString">
  14897. print a sort of string representation ([SHARED FORMULA RECORD] id = x [/SHARED FORMULA RECORD])
  14898. </member>
  14899. <member name="M:NPOI.HSSF.Record.SharedFormulaRecord.GetFormulaTokens(NPOI.HSSF.Record.FormulaRecord)">
  14900. @return the equivalent {@link Ptg} array that the formula would have, were it not shared.
  14901. </member>
  14902. <member name="T:NPOI.HSSF.Record.SharedValueRecordBase">
  14903. Common base class for {@link SharedFormulaRecord}, {@link ArrayRecord} and
  14904. {@link TableRecord} which are have similarities.
  14905. @author Josh Micich
  14906. </member>
  14907. <member name="M:NPOI.HSSF.Record.SharedValueRecordBase.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14908. reads only the range (1 {@link CellRangeAddress8Bit}) from the stream
  14909. </member>
  14910. <member name="M:NPOI.HSSF.Record.SharedValueRecordBase.IsInRange(System.Int32,System.Int32)">
  14911. @return <c>true</c> if (rowIx, colIx) is within the range ({@link #Range})
  14912. of this shared value object.
  14913. </member>
  14914. <member name="M:NPOI.HSSF.Record.SharedValueRecordBase.IsFirstCell(System.Int32,System.Int32)">
  14915. @return <c>true</c> if (rowIx, colIx) describes the first cell in this shared value
  14916. object's range ({@link #Range})
  14917. </member>
  14918. <member name="T:NPOI.HSSF.Record.SheetExtRecord">
  14919. <summary>
  14920. </summary>
  14921. </member>
  14922. <member name="T:NPOI.HSSF.Record.SSTDeserializer">
  14923. Handles the task of deserializing a SST string. The two main entry points are
  14924. @author Glen Stampoultzis (glens at apache.org)
  14925. @author Jason Height (jheight at apache.org)
  14926. </member>
  14927. <member name="M:NPOI.HSSF.Record.SSTDeserializer.ManufactureStrings(System.Int32,NPOI.HSSF.Record.RecordInputStream)">
  14928. This Is the starting point where strings are constructed. Note that
  14929. strings may span across multiple continuations. Read the SST record
  14930. carefully before beginning to hack.
  14931. </member>
  14932. <member name="T:NPOI.HSSF.Record.SSTRecord">
  14933. Title: Static String Table Record
  14934. Description: This holds all the strings for LabelSSTRecords.
  14935. REFERENCE: PG 389 Microsoft Excel 97 Developer's Kit (ISBN:
  14936. 1-57231-498-2)
  14937. @author Andrew C. Oliver (acoliver at apache dot org)
  14938. @author Marc Johnson (mjohnson at apache dot org)
  14939. @author Glen Stampoultzis (glens at apache.org)
  14940. @see org.apache.poi.hssf.record.LabelSSTRecord
  14941. @see org.apache.poi.hssf.record.ContinueRecord
  14942. </member>
  14943. <member name="F:NPOI.HSSF.Record.SSTRecord.MAX_RECORD_SIZE">
  14944. how big can an SST record be? As big as any record can be: 8228 bytes
  14945. </member>
  14946. <member name="F:NPOI.HSSF.Record.SSTRecord.STD_RECORD_OVERHEAD">
  14947. standard record overhead: two shorts (record id plus data space size)
  14948. </member>
  14949. <member name="F:NPOI.HSSF.Record.SSTRecord.SST_RECORD_OVERHEAD">
  14950. SST overhead: the standard record overhead, plus the number of strings and the number of Unique strings -- two ints
  14951. </member>
  14952. <member name="F:NPOI.HSSF.Record.SSTRecord.MAX_DATA_SPACE">
  14953. how much data can we stuff into an SST record? That would be _max minus the standard SST record overhead
  14954. </member>
  14955. <member name="F:NPOI.HSSF.Record.SSTRecord.field_1_num_strings">
  14956. Union of strings in the SST and EXTSST
  14957. </member>
  14958. <member name="F:NPOI.HSSF.Record.SSTRecord.field_2_num_unique_strings">
  14959. according to docs ONLY SST
  14960. </member>
  14961. <member name="F:NPOI.HSSF.Record.SSTRecord.bucketAbsoluteOffsets">
  14962. Offsets from the beginning of the SST record (even across continuations)
  14963. </member>
  14964. <member name="F:NPOI.HSSF.Record.SSTRecord.bucketRelativeOffsets">
  14965. Offsets relative the start of the current SST or continue record
  14966. </member>
  14967. <member name="M:NPOI.HSSF.Record.SSTRecord.#ctor">
  14968. default constructor
  14969. </member>
  14970. <member name="M:NPOI.HSSF.Record.SSTRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14971. Constructs an SST record and Sets its fields appropriately.
  14972. @param in the RecordInputstream to Read the record from
  14973. </member>
  14974. <member name="M:NPOI.HSSF.Record.SSTRecord.AddString(NPOI.HSSF.Record.UnicodeString)">
  14975. Add a string.
  14976. @param string string to be Added
  14977. @return the index of that string in the table
  14978. </member>
  14979. <member name="P:NPOI.HSSF.Record.SSTRecord.NumStrings">
  14980. @return number of strings
  14981. </member>
  14982. <member name="P:NPOI.HSSF.Record.SSTRecord.NumUniqueStrings">
  14983. @return number of Unique strings
  14984. </member>
  14985. <member name="M:NPOI.HSSF.Record.SSTRecord.GetString(System.Int32)">
  14986. Get a particular string by its index
  14987. @param id index into the array of strings
  14988. @return the desired string
  14989. </member>
  14990. <member name="M:NPOI.HSSF.Record.SSTRecord.ToString">
  14991. Return a debugging string representation
  14992. @return string representation
  14993. </member>
  14994. <member name="P:NPOI.HSSF.Record.SSTRecord.Sid">
  14995. @return sid
  14996. </member>
  14997. <member name="M:NPOI.HSSF.Record.SSTRecord.GetHashCode">
  14998. @return hashcode
  14999. </member>
  15000. <member name="M:NPOI.HSSF.Record.SSTRecord.GetStrings">
  15001. @return an iterator of the strings we hold. All instances are
  15002. UnicodeStrings
  15003. </member>
  15004. <member name="P:NPOI.HSSF.Record.SSTRecord.CountStrings">
  15005. @return count of the strings we hold.
  15006. </member>
  15007. <member name="M:NPOI.HSSF.Record.SSTRecord.Serialize(NPOI.HSSF.Record.Cont.ContinuableRecordOutput)">
  15008. called by the class that Is responsible for writing this sucker.
  15009. Subclasses should implement this so that their data Is passed back in a
  15010. byte array.
  15011. @return size
  15012. </member>
  15013. <member name="M:NPOI.HSSF.Record.SSTRecord.CreateExtSSTRecord(System.Int32)">
  15014. Creates an extended string record based on the current contents of
  15015. the current SST record. The offset within the stream to the SST record
  15016. Is required because the extended string record points directly to the
  15017. strings in the SST record.
  15018. NOTE: THIS FUNCTION MUST ONLY BE CALLED AFTER THE SST RECORD HAS BEEN
  15019. SERIALIZED.
  15020. @param sstOffset The offset in the stream to the start of the
  15021. SST record.
  15022. @return The new SST record.
  15023. </member>
  15024. <member name="M:NPOI.HSSF.Record.SSTRecord.CalcExtSSTRecordSize">
  15025. Calculates the size in bytes of the EXTSST record as it would be if the
  15026. record was Serialized.
  15027. @return The size of the ExtSST record in bytes.
  15028. </member>
  15029. <member name="T:NPOI.HSSF.Record.SSTSerializer">
  15030. This class handles serialization of SST records. It utilizes the record processor
  15031. class write individual records. This has been refactored from the SSTRecord class.
  15032. @author Glen Stampoultzis (glens at apache.org)
  15033. </member>
  15034. <member name="F:NPOI.HSSF.Record.SSTSerializer.bucketAbsoluteOffsets">
  15035. OffSets from the beginning of the SST record (even across continuations)
  15036. </member>
  15037. <member name="F:NPOI.HSSF.Record.SSTSerializer.bucketRelativeOffsets">
  15038. OffSets relative the start of the current SST or continue record
  15039. </member>
  15040. <member name="T:NPOI.HSSF.Record.StandardRecord">
  15041. Subclasses of this class (the majority of BIFF records) are non-continuable. This allows for
  15042. some simplification of serialization logic
  15043. @author Josh Micich
  15044. </member>
  15045. <member name="M:NPOI.HSSF.Record.StandardRecord.Serialize(System.Int32,System.Byte[])">
  15046. <summary>
  15047. Write the data content of this BIFF record including the sid and record length.
  15048. The subclass must write the exact number of bytes as reported by Record#getRecordSize()
  15049. </summary>
  15050. <param name="offset">offset</param>
  15051. <param name="data">data</param>
  15052. <returns></returns>
  15053. </member>
  15054. <member name="M:NPOI.HSSF.Record.StandardRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  15055. Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields
  15056. have already been written by the superclass.<br/>
  15057. The number of bytes written must equal the record size reported by
  15058. {@link Record#getDataSize()} minus four
  15059. ( record header consiting of a 'ushort sid' and 'ushort reclength' has already been written
  15060. by thye superclass).
  15061. </member>
  15062. <member name="T:NPOI.HSSF.Record.StringRecord">
  15063. Supports the STRING record structure.
  15064. @author Glen Stampoultzis (glens at apache.org)
  15065. </member>
  15066. <member name="M:NPOI.HSSF.Record.StringRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15067. Constructs a String record and Sets its fields appropriately.
  15068. @param in the RecordInputstream to Read the record from
  15069. </member>
  15070. <member name="M:NPOI.HSSF.Record.StringRecord.Serialize(NPOI.HSSF.Record.Cont.ContinuableRecordOutput)">
  15071. called by the class that Is responsible for writing this sucker.
  15072. Subclasses should implement this so that their data Is passed back in a
  15073. byte array.
  15074. @param offset to begin writing at
  15075. @param data byte array containing instance data
  15076. @return number of bytes written
  15077. </member>
  15078. <member name="P:NPOI.HSSF.Record.StringRecord.Sid">
  15079. return the non static version of the id for this record.
  15080. </member>
  15081. <member name="P:NPOI.HSSF.Record.StringRecord.String">
  15082. @return The string represented by this record.
  15083. </member>
  15084. <member name="T:NPOI.HSSF.Record.StyleRecord">
  15085. Title: Style Record
  15086. Description: Describes a builtin to the gui or user defined style
  15087. REFERENCE: PG 390 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15088. @author Andrew C. Oliver (acoliver at apache dot org)
  15089. @author aviks : string fixes for UserDefined Style
  15090. @version 2.0-pre
  15091. </member>
  15092. <member name="M:NPOI.HSSF.Record.StyleRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15093. Constructs a Style record and Sets its fields appropriately.
  15094. @param in the RecordInputstream to Read the record from
  15095. </member>
  15096. <member name="M:NPOI.HSSF.Record.StyleRecord.SetBuiltinStyle(System.Int32)">
  15097. if this is a builtin style set the number of the built in style
  15098. @param builtinStyleId style number (0-7)
  15099. </member>
  15100. <member name="P:NPOI.HSSF.Record.StyleRecord.XFIndex">
  15101. Get the actual index of the style extended format record
  15102. @see #Index
  15103. @return index of the xf record
  15104. </member>
  15105. <member name="P:NPOI.HSSF.Record.StyleRecord.Name">
  15106. Get the style's name
  15107. @return name of the style
  15108. @see #NameLength
  15109. </member>
  15110. <member name="P:NPOI.HSSF.Record.StyleRecord.OutlineStyleLevel">
  15111. Get the row or column level of the style (if builtin 1||2)
  15112. </member>
  15113. <member name="T:NPOI.HSSF.Record.ScrollableObjectSubRecord">
  15114. <summary>
  15115. FtSbs structure
  15116. </summary>
  15117. </member>
  15118. <member name="T:NPOI.HSSF.Record.SubRecord">
  15119. Subrecords are part of the OBJ class.
  15120. </member>
  15121. <member name="P:NPOI.HSSF.Record.SubRecord.IsTerminating">
  15122. Wether this record terminates the sub-record stream.
  15123. There are two cases when this method must be overridden and return <c>true</c>
  15124. - EndSubRecord (sid = 0x00)
  15125. - LbsDataSubRecord (sid = 0x12)
  15126. @return whether this record is the last in the sub-record stream
  15127. </member>
  15128. <member name="T:NPOI.HSSF.Record.SupBookRecord">
  15129. Title: Sup Book (EXTERNALBOOK)
  15130. Description: A External Workbook Description (Suplemental Book)
  15131. Its only a dummy record for making new ExternSheet Record
  15132. REFERENCE: 5.38
  15133. @author Libin Roman (Vista Portal LDT. Developer)
  15134. @author Andrew C. Oliver (acoliver@apache.org)
  15135. </member>
  15136. <member name="M:NPOI.HSSF.Record.SupBookRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15137. Constructs a Extern Sheet record and Sets its fields appropriately.
  15138. @param id id must be 0x16 or an exception will be throw upon validation
  15139. @param size the size of the data area of the record
  15140. @param data data of the record (should not contain sid/len)
  15141. </member>
  15142. <member name="T:NPOI.HSSF.Record.TabIdRecord">
  15143. Title: Sheet Tab Index Array Record
  15144. Description: Contains an array of sheet id's. Sheets always keep their ID
  15145. regardless of what their name Is.
  15146. REFERENCE: PG 412 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15147. @author Andrew C. Oliver (acoliver at apache dot org)
  15148. @version 2.0-pre
  15149. </member>
  15150. <member name="M:NPOI.HSSF.Record.TabIdRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15151. Constructs a TabID record and Sets its fields appropriately.
  15152. @param in the RecordInputstream to Read the record from
  15153. </member>
  15154. <member name="M:NPOI.HSSF.Record.TabIdRecord.SetTabIdArray(System.Int16[])">
  15155. Set the tab array. (0,1,2).
  15156. @param array of tab id's {0,1,2}
  15157. </member>
  15158. <member name="M:NPOI.HSSF.Record.TabIdRecord.ToString">
  15159. Get the tab array. (0,1,2).
  15160. @return array of tab id's {0,1,2}
  15161. </member>
  15162. <member name="T:NPOI.HSSF.Record.TableRecord">
  15163. DATATABLE (0x0236)<p/>
  15164. TableRecord - The record specifies a data table.
  15165. This record Is preceded by a single Formula record that
  15166. defines the first cell in the data table, which should
  15167. only contain a single Ptg, {@link TblPtg}.
  15168. See p536 of the June 08 binary docs
  15169. </member>
  15170. <member name="T:NPOI.HSSF.Record.TableStylesRecord">
  15171. TABLESTYLES (0x088E)<br/>
  15172. @author Patrick Cheng
  15173. </member>
  15174. <member name="F:NPOI.HSSF.Record.TextObjectRecord._linkRefPtg">
  15175. expect tRef, tRef3D, tArea, tArea3D or tName
  15176. </member>
  15177. <member name="F:NPOI.HSSF.Record.TextObjectRecord._unknownPostFormulaByte">
  15178. Not clear if needed . Excel seems to be OK if this byte is not present.
  15179. Value is often the same as the earlier firstColumn byte.
  15180. </member>
  15181. <member name="P:NPOI.HSSF.Record.TextObjectRecord.TextOrientation">
  15182. Get the text orientation field for the TextObjectBase record.
  15183. @return a TextOrientation
  15184. </member>
  15185. <member name="P:NPOI.HSSF.Record.TextObjectRecord.HorizontalTextAlignment">
  15186. @return the Horizontal text alignment field value.
  15187. </member>
  15188. <member name="P:NPOI.HSSF.Record.TextObjectRecord.VerticalTextAlignment">
  15189. @return the Vertical text alignment field value.
  15190. </member>
  15191. <member name="P:NPOI.HSSF.Record.TextObjectRecord.IsTextLocked">
  15192. Text has been locked
  15193. @return the text locked field value.
  15194. </member>
  15195. <member name="T:NPOI.HSSF.Record.TopMarginRecord">
  15196. Record for the top margin.
  15197. NOTE: This source was automatically generated.
  15198. @author Shawn Laubach (slaubach at apache dot org)
  15199. </member>
  15200. <member name="M:NPOI.HSSF.Record.TopMarginRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15201. Constructs a TopMargin record and Sets its fields appropriately.
  15202. @param in the RecordInputstream to Read the record from
  15203. </member>
  15204. <member name="P:NPOI.HSSF.Record.TopMarginRecord.Margin">
  15205. Get the margin field for the TopMargin record.
  15206. </member>
  15207. <member name="T:NPOI.HSSF.Record.UncalcedRecord">
  15208. Title: Uncalced Record
  15209. If this record occurs in the Worksheet Substream, it indicates that the formulas have not
  15210. been recalculated before the document was saved.
  15211. @author Olivier Leprince
  15212. </member>
  15213. <member name="M:NPOI.HSSF.Record.UncalcedRecord.#ctor">
  15214. Default constructor
  15215. </member>
  15216. <member name="M:NPOI.HSSF.Record.UncalcedRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15217. Read constructor
  15218. </member>
  15219. <member name="T:NPOI.HSSF.Record.UnknownRecord">
  15220. Title: Unknown Record (for debugging)
  15221. Description: Unknown record just tells you the sid so you can figure out
  15222. what records you are missing. Also helps us Read/modify sheets we
  15223. don't know all the records to. (HSSF leaves these alone!)
  15224. Company: SuperLink Software, Inc.
  15225. @author Andrew C. Oliver (acoliver at apache dot org)
  15226. @author Jason Height (jheight at chariot dot net dot au)
  15227. @author Glen Stampoultzis (glens at apache.org)
  15228. </member>
  15229. <member name="M:NPOI.HSSF.Record.UnknownRecord.#ctor(System.Int32,System.Byte[])">
  15230. @param id id of the record -not Validated, just stored for serialization
  15231. @param data the data
  15232. </member>
  15233. <member name="M:NPOI.HSSF.Record.UnknownRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15234. construct an Unknown record. No fields are interperated and the record will
  15235. be Serialized in its original form more or less
  15236. @param in the RecordInputstream to Read the record from
  15237. </member>
  15238. <member name="M:NPOI.HSSF.Record.UnknownRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  15239. spit the record out AS IS. no interpretation or identification
  15240. </member>
  15241. <member name="M:NPOI.HSSF.Record.UnknownRecord.ToString">
  15242. print a sort of string representation ([UNKNOWN RECORD] id = x [/UNKNOWN RECORD])
  15243. </member>
  15244. <member name="M:NPOI.HSSF.Record.UnknownRecord.GetBiffName(System.Int32)">
  15245. These BIFF record types are known but still uninterpreted by POI
  15246. @return the documented name of this BIFF record type, <code>null</code> if unknown to POI
  15247. </member>
  15248. <member name="M:NPOI.HSSF.Record.UnknownRecord.IsObservedButUnknown(System.Int32)">
  15249. @return <c>true</c> if the unknown record id has been observed in POI unit tests
  15250. </member>
  15251. <member name="M:NPOI.HSSF.Record.UnknownRecord.Clone">
  15252. Unlike the other Record.Clone methods this Is a shallow Clone
  15253. </member>
  15254. <member name="T:NPOI.HSSF.Record.UserSViewBegin">
  15255. The UserSViewBegin record specifies Settings for a custom view associated with the sheet.
  15256. This record also marks the start of custom view records, which save custom view Settings.
  15257. Records between {@link UserSViewBegin} and {@link UserSViewEnd} contain Settings for the custom view,
  15258. not Settings for the sheet itself.
  15259. @author Yegor Kozlov
  15260. </member>
  15261. <member name="M:NPOI.HSSF.Record.UserSViewBegin.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15262. construct an UserSViewBegin record. No fields are interpreted and the record will
  15263. be Serialized in its original form more or less
  15264. @param in the RecordInputstream to read the record from
  15265. </member>
  15266. <member name="M:NPOI.HSSF.Record.UserSViewBegin.Serialize(NPOI.Util.ILittleEndianOutput)">
  15267. spit the record out AS IS. no interpretation or identification
  15268. </member>
  15269. <member name="P:NPOI.HSSF.Record.UserSViewBegin.Guid">
  15270. @return Globally unique identifier for the custom view
  15271. </member>
  15272. <member name="T:NPOI.HSSF.Record.UserSViewEnd">
  15273. The UserSViewEnd record marks the end of the Settings for a custom view associated with the sheet
  15274. @author Yegor Kozlov
  15275. </member>
  15276. <member name="M:NPOI.HSSF.Record.UserSViewEnd.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15277. construct an UserSViewEnd record. No fields are interpreted and the record will
  15278. be Serialized in its original form more or less
  15279. @param in the RecordInputstream to read the record from
  15280. </member>
  15281. <member name="M:NPOI.HSSF.Record.UserSViewEnd.Serialize(NPOI.Util.ILittleEndianOutput)">
  15282. spit the record out AS IS. no interpretation or identification
  15283. </member>
  15284. <member name="T:NPOI.HSSF.Record.UseSelFSRecord">
  15285. Title: Use Natural Language Formulas Flag
  15286. Description: Tells the GUI if this was written by something that can use
  15287. "natural language" formulas. HSSF can't.
  15288. REFERENCE: PG 420 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15289. @author Andrew C. Oliver (acoliver at apache dot org)
  15290. @version 2.0-pre
  15291. </member>
  15292. <member name="M:NPOI.HSSF.Record.UseSelFSRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15293. Constructs a UseSelFS record and Sets its fields appropriately.
  15294. @param in the RecordInputstream to Read the record from
  15295. </member>
  15296. <member name="T:NPOI.HSSF.Record.VCenterRecord">
  15297. Title: VCenter record
  15298. Description: tells whether to center the sheet between vertical margins
  15299. REFERENCE: PG 420 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15300. @author Andrew C. Oliver (acoliver at apache dot org)
  15301. @author Jason Height (jheight at chariot dot net dot au)
  15302. @version 2.0-pre
  15303. </member>
  15304. <member name="M:NPOI.HSSF.Record.VCenterRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15305. Constructs a VCENTER record and Sets its fields appropriately.
  15306. @param in the RecordInputstream to Read the record from
  15307. </member>
  15308. <member name="P:NPOI.HSSF.Record.VCenterRecord.VCenter">
  15309. Get whether to center vertically or not
  15310. @return vcenter or not
  15311. </member>
  15312. <member name="T:NPOI.HSSF.Record.VerticalPageBreakRecord">
  15313. VerticalPageBreak record that stores page breaks at columns
  15314. This class Is just used so that SID Compares work properly in the RecordFactory
  15315. @see PageBreakRecord
  15316. @author Danny Mui (dmui at apache dot org)
  15317. </member>
  15318. <member name="M:NPOI.HSSF.Record.VerticalPageBreakRecord.#ctor">
  15319. </member>
  15320. <member name="M:NPOI.HSSF.Record.VerticalPageBreakRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15321. @param in the RecordInputstream to Read the record from
  15322. </member>
  15323. <member name="T:NPOI.HSSF.Record.WindowOneRecord">
  15324. Title: Window1 Record
  15325. Description: Stores the attributes of the workbook window. This Is basically
  15326. so the gui knows how big to make the window holding the spReadsheet
  15327. document.
  15328. REFERENCE: PG 421 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15329. @author Andrew C. Oliver (acoliver at apache dot org)
  15330. @version 2.0-pre
  15331. </member>
  15332. <member name="M:NPOI.HSSF.Record.WindowOneRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15333. Constructs a WindowOne record and Sets its fields appropriately.
  15334. @param in the RecordInputstream to Read the record from
  15335. </member>
  15336. <member name="P:NPOI.HSSF.Record.WindowOneRecord.HorizontalHold">
  15337. Get the horizontal position of the window (in 1/20ths of a point)
  15338. @return h - horizontal location
  15339. </member>
  15340. <member name="P:NPOI.HSSF.Record.WindowOneRecord.VerticalHold">
  15341. Get the vertical position of the window (in 1/20ths of a point)
  15342. @return v - vertical location
  15343. </member>
  15344. <member name="P:NPOI.HSSF.Record.WindowOneRecord.Width">
  15345. Get the width of the window
  15346. @return width
  15347. </member>
  15348. <member name="P:NPOI.HSSF.Record.WindowOneRecord.Height">
  15349. Get the height of the window
  15350. @return height
  15351. </member>
  15352. <member name="P:NPOI.HSSF.Record.WindowOneRecord.Options">
  15353. Get the options bitmask (see bit Setters)
  15354. @return o - the bitmask
  15355. </member>
  15356. <member name="P:NPOI.HSSF.Record.WindowOneRecord.Hidden">
  15357. Get whether the window Is hidden or not
  15358. @return Ishidden or not
  15359. </member>
  15360. <member name="P:NPOI.HSSF.Record.WindowOneRecord.Iconic">
  15361. Get whether the window has been iconized or not
  15362. @return iconize or not
  15363. </member>
  15364. <member name="P:NPOI.HSSF.Record.WindowOneRecord.DisplayHorizontalScrollbar">
  15365. Get whether to Display the horizontal scrollbar or not
  15366. @return Display or not
  15367. </member>
  15368. <member name="P:NPOI.HSSF.Record.WindowOneRecord.DisplayVerticalScrollbar">
  15369. Get whether to Display the vertical scrollbar or not
  15370. @return Display or not
  15371. </member>
  15372. <member name="P:NPOI.HSSF.Record.WindowOneRecord.DisplayTabs">
  15373. Get whether to Display the tabs or not
  15374. @return Display or not
  15375. </member>
  15376. <member name="P:NPOI.HSSF.Record.WindowOneRecord.ActiveSheetIndex">
  15377. @return the index of the currently Displayed sheet
  15378. </member>
  15379. <member name="P:NPOI.HSSF.Record.WindowOneRecord.FirstVisibleTab">
  15380. @return the first visible sheet in the worksheet tab-bar.
  15381. I.E. the scroll position of the tab-bar.
  15382. </member>
  15383. <member name="P:NPOI.HSSF.Record.WindowOneRecord.NumSelectedTabs">
  15384. Get the number of selected tabs
  15385. @return number of tabs
  15386. </member>
  15387. <member name="P:NPOI.HSSF.Record.WindowOneRecord.TabWidthRatio">
  15388. ratio of the width of the tabs to the horizontal scrollbar
  15389. @return ratio
  15390. </member>
  15391. <member name="T:NPOI.HSSF.Record.WindowProtectRecord">
  15392. Title: Window Protect Record
  15393. Description: flags whether workbook windows are protected
  15394. REFERENCE: PG 424 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15395. @author Andrew C. Oliver (acoliver at apache dot org)
  15396. @version 2.0-pre
  15397. </member>
  15398. <member name="M:NPOI.HSSF.Record.WindowProtectRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15399. Constructs a WindowProtect record and Sets its fields appropriately.
  15400. @param in the RecordInputstream to Read the record from
  15401. </member>
  15402. <member name="P:NPOI.HSSF.Record.WindowProtectRecord.Protect">
  15403. Is this window protected or not
  15404. @return protected or not
  15405. </member>
  15406. <member name="T:NPOI.HSSF.Record.WindowTwoRecord">
  15407. Title: Window Two Record
  15408. Description: sheet window Settings
  15409. REFERENCE: PG 422 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15410. @author Andrew C. Oliver (acoliver at apache dot org)
  15411. @author Jason Height (jheight at chariot dot net dot au)
  15412. @version 2.0-pre
  15413. </member>
  15414. <member name="M:NPOI.HSSF.Record.WindowTwoRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15415. Constructs a WindowTwo record and Sets its fields appropriately.
  15416. @param in the RecordInputstream to Read the record from
  15417. </member>
  15418. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.Options">
  15419. Get the options bitmask or just use the bit Setters.
  15420. @return options
  15421. </member>
  15422. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DisplayFormulas">
  15423. Get whether the window should Display formulas
  15424. @return formulas or not
  15425. </member>
  15426. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DisplayGridlines">
  15427. Get whether the window should Display gridlines
  15428. @return gridlines or not
  15429. </member>
  15430. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DisplayRowColHeadings">
  15431. Get whether the window should Display row and column headings
  15432. @return headings or not
  15433. </member>
  15434. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.FreezePanes">
  15435. Get whether the window should freeze panes
  15436. @return freeze panes or not
  15437. </member>
  15438. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DisplayZeros">
  15439. Get whether the window should Display zero values
  15440. @return zeros or not
  15441. </member>
  15442. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DefaultHeader">
  15443. Get whether the window should Display a default header
  15444. @return header or not
  15445. </member>
  15446. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.Arabic">
  15447. Is this arabic?
  15448. @return arabic or not
  15449. </member>
  15450. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DisplayGuts">
  15451. Get whether the outline symbols are displaed
  15452. @return symbols or not
  15453. </member>
  15454. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.FreezePanesNoSplit">
  15455. freeze Unsplit panes or not
  15456. @return freeze or not
  15457. </member>
  15458. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.IsSelected">
  15459. sheet tab Is selected
  15460. @return selected or not
  15461. </member>
  15462. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.IsActive">
  15463. Is the sheet currently Displayed in the window
  15464. @return Displayed or not
  15465. </member>
  15466. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.SavedInPageBreakPreview">
  15467. was the sheet saved in page break view
  15468. @return pagebreaksaved or not
  15469. </member>
  15470. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.TopRow">
  15471. Get the top row visible in the window
  15472. @return toprow
  15473. </member>
  15474. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.LeftCol">
  15475. Get the leftmost column Displayed in the window
  15476. @return leftmost
  15477. </member>
  15478. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.HeaderColor">
  15479. Get the palette index for the header color
  15480. @return color
  15481. </member>
  15482. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.PageBreakZoom">
  15483. zoom magification in page break view
  15484. @return zoom
  15485. </member>
  15486. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.NormalZoom">
  15487. Get the zoom magnification in normal view
  15488. @return zoom
  15489. </member>
  15490. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.Reserved">
  15491. Get the reserved bits - why would you do this?
  15492. @return reserved stuff -probably garbage
  15493. </member>
  15494. <member name="T:NPOI.HSSF.Record.WriteAccessRecord">
  15495. Title: Write Access Record
  15496. Description: Stores the username of that who owns the spReadsheet generator
  15497. (on Unix the user's login, on Windoze its the name you typed when
  15498. you installed the thing)
  15499. REFERENCE: PG 424 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15500. @author Andrew C. Oliver (acoliver at apache dot org)
  15501. @version 2.0-pre
  15502. </member>
  15503. <member name="F:NPOI.HSSF.Record.WriteAccessRecord.PADDING">
  15504. this record is always padded to a constant length
  15505. </member>
  15506. <member name="M:NPOI.HSSF.Record.WriteAccessRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15507. Constructs a WriteAccess record and Sets its fields appropriately.
  15508. @param in the RecordInputstream to Read the record from
  15509. </member>
  15510. <member name="P:NPOI.HSSF.Record.WriteAccessRecord.Username">
  15511. Get the username for the user that Created the report. HSSF uses the logged in user. On
  15512. natively Created M$ Excel sheet this would be the name you typed in when you installed it
  15513. in most cases.
  15514. @return username of the user who Is logged in (probably "tomcat" or "apache")
  15515. </member>
  15516. <member name="T:NPOI.HSSF.Record.WriteProtectRecord">
  15517. Title: Write Protect Record
  15518. Description: Indicated that the sheet/workbook Is Write protected.
  15519. REFERENCE: PG 425 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15520. @version 3.0-pre
  15521. </member>
  15522. <member name="M:NPOI.HSSF.Record.WriteProtectRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15523. Constructs a WriteAccess record and Sets its fields appropriately.
  15524. @param in the RecordInputstream to Read the record from
  15525. </member>
  15526. <member name="T:NPOI.HSSF.Record.WSBoolRecord">
  15527. Title: WSBool Record.
  15528. Description: stores workbook Settings (aka its a big "everything we didn't
  15529. put somewhere else")
  15530. REFERENCE: PG 425 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15531. @author Andrew C. Oliver (acoliver at apache dot org)
  15532. @author Glen Stampoultzis (gstamp@iprimus.com.au)
  15533. @author Jason Height (jheight at chariot dot net dot au)
  15534. @version 2.0-pre
  15535. </member>
  15536. <member name="M:NPOI.HSSF.Record.WSBoolRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15537. Constructs a WSBool record and Sets its fields appropriately.
  15538. @param in the RecordInputstream to Read the record from
  15539. </member>
  15540. <member name="P:NPOI.HSSF.Record.WSBoolRecord.WSBool1">
  15541. Get first byte (see bit Getters)
  15542. </member>
  15543. <member name="P:NPOI.HSSF.Record.WSBoolRecord.Autobreaks">
  15544. <summary>
  15545. Whether to show automatic page breaks or not
  15546. </summary>
  15547. </member>
  15548. <member name="P:NPOI.HSSF.Record.WSBoolRecord.Dialog">
  15549. <summary>
  15550. Whether sheet is a dialog sheet or not
  15551. </summary>
  15552. </member>
  15553. <member name="P:NPOI.HSSF.Record.WSBoolRecord.RowSumsBelow">
  15554. <summary>
  15555. Get if row summaries appear below detail in the outline
  15556. </summary>
  15557. </member>
  15558. <member name="P:NPOI.HSSF.Record.WSBoolRecord.RowSumsRight">
  15559. <summary>
  15560. Get if col summaries appear right of the detail in the outline
  15561. </summary>
  15562. </member>
  15563. <member name="P:NPOI.HSSF.Record.WSBoolRecord.WSBool2">
  15564. <summary>
  15565. Get the second byte (see bit Getters)
  15566. </summary>
  15567. </member>
  15568. <member name="P:NPOI.HSSF.Record.WSBoolRecord.FitToPage">
  15569. <summary>
  15570. fit to page option is on
  15571. </summary>
  15572. </member>
  15573. <member name="P:NPOI.HSSF.Record.WSBoolRecord.DisplayGuts">
  15574. <summary>
  15575. Whether to display the guts or not
  15576. </summary>
  15577. </member>
  15578. <member name="P:NPOI.HSSF.Record.WSBoolRecord.AlternateExpression">
  15579. <summary>
  15580. whether alternate expression evaluation is on
  15581. </summary>
  15582. </member>
  15583. <member name="P:NPOI.HSSF.Record.WSBoolRecord.AlternateFormula">
  15584. <summary>
  15585. whether alternative formula entry is on
  15586. </summary>
  15587. </member>
  15588. <member name="F:NPOI.HSSF.XmlTkBlob.xtHeader">
  15589. <summary>
  15590. The xtHeader.drType field MUST be equal to 0x07.
  15591. </summary>
  15592. </member>
  15593. <member name="F:NPOI.HSSF.XmlTkBool.xtHeader">
  15594. <summary>
  15595. The xtHeader.drType field MUST be equal to 0x02.
  15596. </summary>
  15597. </member>
  15598. <member name="F:NPOI.HSSF.XmlTkDouble.xtHeader">
  15599. <summary>
  15600. The xtHeader.drType field MUST be equal to 0x03.
  15601. </summary>
  15602. </member>
  15603. <member name="F:NPOI.HSSF.XmlTkDWord.xtHeader">
  15604. <summary>
  15605. The xtHeader.drType field MUST be equal to 0x04.
  15606. </summary>
  15607. </member>
  15608. <member name="F:NPOI.HSSF.XmlTkEnd.xtHeader">
  15609. <summary>
  15610. The xtHeader.drType field MUST be equal to 0x01.
  15611. </summary>
  15612. </member>
  15613. <member name="F:NPOI.HSSF.XmlTkString.xtHeader">
  15614. <summary>
  15615. The xtHeader.drType field MUST be equal to 0x05.
  15616. </summary>
  15617. </member>
  15618. <member name="F:NPOI.HSSF.XmlTkString.rgbValue">
  15619. <summary>
  15620. An array of Unicode characters. The size of the array, in characters, is specified
  15621. by the cchValue field. The size of the field, in bytes, MUST equal the result of
  15622. the following formula:cchValue * 2.
  15623. </summary>
  15624. </member>
  15625. <member name="F:NPOI.HSSF.XmlTkStyle.chartStyle">
  15626. <summary>
  15627. The chartStyle.xtHeader.xmlTkTag MUST be equal to 0x0003.
  15628. </summary>
  15629. </member>
  15630. <member name="F:NPOI.HSSF.XmlTkTickMarkSkipFrt.nInterval">
  15631. <summary>
  15632. The nInterval.xtHeader.xmlTkTag field MUST be equal to 0x0052.
  15633. </summary>
  15634. </member>
  15635. <member name="T:NPOI.HSSF.UserModel.DVConstraint">
  15636. @author Josh Micich
  15637. </member>
  15638. <member name="M:NPOI.HSSF.UserModel.DVConstraint.#ctor(System.String,System.String[])">
  15639. Creates a list constraint
  15640. </member>
  15641. <member name="M:NPOI.HSSF.UserModel.DVConstraint.CreateNumericConstraint(System.Int32,System.Int32,System.String,System.String)">
  15642. Creates a number based data validation constraint. The text values entered for expr1 and expr2
  15643. can be either standard Excel formulas or formatted number values. If the expression starts
  15644. with '=' it is Parsed as a formula, otherwise it is Parsed as a formatted number.
  15645. @param validationType one of {@link NPOI.SS.UserModel.DataValidationConstraint.ValidationType#ANY},
  15646. {@link NPOI.SS.UserModel.DataValidationConstraint.ValidationType#DECIMAL},
  15647. {@link NPOI.SS.UserModel.DataValidationConstraint.ValidationType#INTEGER},
  15648. {@link NPOI.SS.UserModel.DataValidationConstraint.ValidationType#TEXT_LENGTH}
  15649. @param comparisonOperator any constant from {@link NPOI.SS.UserModel.DataValidationConstraint.OperatorType} enum
  15650. @param expr1 date formula (when first char is '=') or formatted number value
  15651. @param expr2 date formula (when first char is '=') or formatted number value
  15652. </member>
  15653. <member name="M:NPOI.HSSF.UserModel.DVConstraint.CreateTimeConstraint(System.Int32,System.String,System.String)">
  15654. Creates a time based data validation constraint. The text values entered for expr1 and expr2
  15655. can be either standard Excel formulas or formatted time values. If the expression starts
  15656. with '=' it is Parsed as a formula, otherwise it is Parsed as a formatted time. To parse
  15657. formatted times, two formats are supported: "HH:MM" or "HH:MM:SS". This is contrary to
  15658. Excel which uses the default time format from the OS.
  15659. @param comparisonOperator constant from {@link NPOI.SS.UserModel.DataValidationConstraint.OperatorType} enum
  15660. @param expr1 date formula (when first char is '=') or formatted time value
  15661. @param expr2 date formula (when first char is '=') or formatted time value
  15662. </member>
  15663. <member name="M:NPOI.HSSF.UserModel.DVConstraint.CreateDateConstraint(System.Int32,System.String,System.String,System.String)">
  15664. Creates a date based data validation constraint. The text values entered for expr1 and expr2
  15665. can be either standard Excel formulas or formatted date values. If the expression starts
  15666. with '=' it is Parsed as a formula, otherwise it is Parsed as a formatted date (Excel uses
  15667. the same convention). To parse formatted dates, a date format needs to be specified. This
  15668. is contrary to Excel which uses the default short date format from the OS.
  15669. @param comparisonOperator constant from {@link NPOI.SS.UserModel.DataValidationConstraint.OperatorType} enum
  15670. @param expr1 date formula (when first char is '=') or formatted date value
  15671. @param expr2 date formula (when first char is '=') or formatted date value
  15672. @param dateFormat ignored if both expr1 and expr2 are formulas. Default value is "YYYY/MM/DD"
  15673. otherwise any other valid argument for <c>SimpleDateFormat</c> can be used
  15674. @see <a href='http://java.sun.com/j2se/1.5.0/docs/api/java/text/DateFormat.html'>SimpleDateFormat</a>
  15675. </member>
  15676. <member name="M:NPOI.HSSF.UserModel.DVConstraint.GetFormulaFromTextExpression(System.String)">
  15677. Distinguishes formula expressions from simple value expressions. This logic is only
  15678. required by a few factory methods in this class that create data validation constraints
  15679. from more or less the same parameters that would have been entered in the Excel UI. The
  15680. data validation dialog box uses the convention that formulas begin with '='. Other methods
  15681. in this class follow the POI convention (formulas and values are distinct), so the '='
  15682. convention is not used there.
  15683. @param textExpr a formula or value expression
  15684. @return all text After '=' if textExpr begins with '='. Otherwise <code>null</code> if textExpr does not begin with '='
  15685. </member>
  15686. <member name="M:NPOI.HSSF.UserModel.DVConstraint.ConvertNumber(System.String)">
  15687. @return <code>null</code> if numberStr is <code>null</code>
  15688. </member>
  15689. <member name="M:NPOI.HSSF.UserModel.DVConstraint.ConvertTime(System.String)">
  15690. @return <code>null</code> if timeStr is <code>null</code>
  15691. </member>
  15692. <member name="M:NPOI.HSSF.UserModel.DVConstraint.ConvertDate(System.String,NPOI.SS.Util.SimpleDateFormat)">
  15693. @param dateFormat pass <code>null</code> for default YYYYMMDD
  15694. @return <code>null</code> if timeStr is <code>null</code>
  15695. </member>
  15696. <member name="P:NPOI.HSSF.UserModel.DVConstraint.IsListValidationType">
  15697. Convenience method
  15698. @return <c>true</c> if this constraint is a 'list' validation
  15699. </member>
  15700. <member name="P:NPOI.HSSF.UserModel.DVConstraint.IsExplicitList">
  15701. Convenience method
  15702. @return <c>true</c> if this constraint is a 'list' validation with explicit values
  15703. </member>
  15704. <member name="P:NPOI.HSSF.UserModel.DVConstraint.Value1">
  15705. @return the numeric value for expression 1. May be <c>null</c>
  15706. </member>
  15707. <member name="P:NPOI.HSSF.UserModel.DVConstraint.Value2">
  15708. @return the numeric value for expression 2. May be <c>null</c>
  15709. </member>
  15710. <member name="M:NPOI.HSSF.UserModel.DVConstraint.CreateFormulas(NPOI.HSSF.UserModel.HSSFSheet)">
  15711. @return both Parsed formulas (for expression 1 and 2).
  15712. </member>
  15713. <member name="M:NPOI.HSSF.UserModel.DVConstraint.ConvertDoubleFormula(System.String,System.Double,NPOI.HSSF.UserModel.HSSFSheet)">
  15714. @return The Parsed token array representing the formula or value specified.
  15715. Empty array if both formula and value are <code>null</code>
  15716. </member>
  15717. <member name="T:NPOI.HSSF.UserModel.HeaderFooter">
  15718. <summary>
  15719. Common class for HSSFHeader and HSSFFooter
  15720. </summary>
  15721. </member>
  15722. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.RawText">
  15723. @return the internal text representation (combining center, left and right parts).
  15724. Possibly empty string if no header or footer is set. Never <c>null</c>.
  15725. </member>
  15726. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.UpdateHeaderFooterText(System.String[])">
  15727. <summary>
  15728. Creates the complete footer string based on the left, center, and middle
  15729. strings.
  15730. </summary>
  15731. <param name="parts">The parts.</param>
  15732. </member>
  15733. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.SetHeaderFooterText(System.String)">
  15734. <summary>
  15735. Sets the header footer text.
  15736. </summary>
  15737. <param name="text">the new header footer text (contains mark-up tags). Possibly
  15738. empty string never </param>
  15739. </member>
  15740. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Left">
  15741. <summary>
  15742. Get the left side of the header or footer.
  15743. </summary>
  15744. <value>The string representing the left side.</value>
  15745. </member>
  15746. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Center">
  15747. <summary>
  15748. Get the center of the header or footer.
  15749. </summary>
  15750. <value>The string representing the center.</value>
  15751. </member>
  15752. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Right">
  15753. <summary>
  15754. Get the right side of the header or footer.
  15755. </summary>
  15756. <value>The string representing the right side..</value>
  15757. </member>
  15758. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.FontSize(System.Int16)">
  15759. <summary>
  15760. Returns the string that represents the change in font size.
  15761. </summary>
  15762. <param name="size">the new font size.</param>
  15763. <returns>The special string to represent a new font size</returns>
  15764. </member>
  15765. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.Font(System.String,System.String)">
  15766. <summary>
  15767. Returns the string that represents the change in font.
  15768. </summary>
  15769. <param name="font">the new font.</param>
  15770. <param name="style">the fonts style, one of regular, italic, bold, italic bold or bold italic.</param>
  15771. <returns>The special string to represent a new font size</returns>
  15772. </member>
  15773. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Page">
  15774. <summary>
  15775. Returns the string representing the current page number
  15776. </summary>
  15777. <value>The special string for page number.</value>
  15778. </member>
  15779. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.NumPages">
  15780. <summary>
  15781. Returns the string representing the number of pages.
  15782. </summary>
  15783. <value>The special string for the number of pages.</value>
  15784. </member>
  15785. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Date">
  15786. <summary>
  15787. Returns the string representing the current date
  15788. </summary>
  15789. <value>The special string for the date</value>
  15790. </member>
  15791. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Time">
  15792. <summary>
  15793. Gets the time.
  15794. </summary>
  15795. <value>The time.</value>
  15796. Returns the string representing the current time
  15797. @return The special string for the time
  15798. </member>
  15799. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.File">
  15800. <summary>
  15801. Returns the string representing the current file name
  15802. </summary>
  15803. <value>The special string for the file name.</value>
  15804. </member>
  15805. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Tab">
  15806. <summary>
  15807. Returns the string representing the current tab (sheet) name
  15808. </summary>
  15809. <value>The special string for tab name.</value>
  15810. </member>
  15811. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.StartBold">
  15812. <summary>
  15813. Returns the string representing the start bold
  15814. </summary>
  15815. <returns>The special string for start bold</returns>
  15816. </member>
  15817. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.EndBold">
  15818. <summary>
  15819. Returns the string representing the end bold
  15820. </summary>
  15821. <value>The special string for end bold.</value>
  15822. </member>
  15823. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.StartUnderline">
  15824. <summary>
  15825. Returns the string representing the start underline
  15826. </summary>
  15827. <value>The special string for start underline.</value>
  15828. </member>
  15829. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.EndUnderline">
  15830. <summary>
  15831. Returns the string representing the end underline
  15832. </summary>
  15833. <value>The special string for end underline.</value>
  15834. </member>
  15835. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.StartDoubleUnderline">
  15836. <summary>
  15837. Returns the string representing the start double underline
  15838. </summary>
  15839. <value>The special string for start double underline.</value>
  15840. </member>
  15841. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.EndDoubleUnderline">
  15842. <summary>
  15843. Returns the string representing the end double underline
  15844. </summary>
  15845. <value>The special string for end double underline.</value>
  15846. </member>
  15847. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.StripFields(System.String)">
  15848. <summary>
  15849. Removes any fields (eg macros, page markers etc)
  15850. from the string.
  15851. Normally used to make some text suitable for showing
  15852. to humans, and the resultant text should not normally
  15853. be saved back into the document!
  15854. </summary>
  15855. <param name="text">The text.</param>
  15856. <returns></returns>
  15857. </member>
  15858. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.AreFieldsStripped">
  15859. <summary>
  15860. Are fields currently being Stripped from
  15861. the text that this {@link HeaderStories} returns?
  15862. Default is false, but can be changed
  15863. </summary>
  15864. <value><c>true</c> if [are fields stripped]; otherwise, <c>false</c>.</value>
  15865. </member>
  15866. <member name="T:NPOI.HSSF.UserModel.HeaderFooter.Field">
  15867. <summary>
  15868. Represents a special field in a header or footer,
  15869. eg the page number
  15870. </summary>
  15871. </member>
  15872. <member name="F:NPOI.HSSF.UserModel.HeaderFooter.Field.sequence">
  15873. The character sequence that marks this field
  15874. </member>
  15875. <member name="T:NPOI.HSSF.UserModel.HeaderFooter.PairField">
  15876. <summary>
  15877. A special field that normally comes in a pair, eg
  15878. turn on underline / turn off underline
  15879. </summary>
  15880. </member>
  15881. <member name="F:NPOI.HSSF.UserModel.HeaderFooter.Fields.instance">
  15882. <summary>
  15883. Instance to this class.
  15884. </summary>
  15885. </member>
  15886. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.Fields.#cctor">
  15887. <summary>
  15888. Explicit static constructor to tell C# compiler not to mark type as beforefieldinit.
  15889. </summary>
  15890. </member>
  15891. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.Fields.#ctor">
  15892. <summary>
  15893. Initialize AllFields.
  15894. </summary>
  15895. </member>
  15896. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Fields.Instance">
  15897. <summary>
  15898. Accessing the initialized instance.
  15899. </summary>
  15900. </member>
  15901. <member name="T:NPOI.HSSF.UserModel.helpers.HSSFRowShifter">
  15902. Helper for Shifting rows up or down
  15903. When possible, code should be implemented in the RowShifter abstract class to avoid duplication with {@link NPOI.XSSF.UserModel.helpers.XSSFRowShifter}
  15904. </member>
  15905. <member name="T:NPOI.HSSF.UserModel.HSSFAnchor">
  15906. <summary>
  15907. An anchor Is what specifics the position of a shape within a client object
  15908. or within another containing shape.
  15909. @author Glen Stampoultzis (glens at apache.org)
  15910. </summary>
  15911. </member>
  15912. <member name="M:NPOI.HSSF.UserModel.HSSFAnchor.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
  15913. <summary>
  15914. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFAnchor"/> class.
  15915. </summary>
  15916. <param name="dx1">The DX1.</param>
  15917. <param name="dy1">The dy1.</param>
  15918. <param name="dx2">The DX2.</param>
  15919. <param name="dy2">The dy2.</param>
  15920. </member>
  15921. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.Dx1">
  15922. <summary>
  15923. Gets or sets the DX1.
  15924. </summary>
  15925. <value>The DX1.</value>
  15926. </member>
  15927. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.Dy1">
  15928. <summary>
  15929. Gets or sets the dy1.
  15930. </summary>
  15931. <value>The dy1.</value>
  15932. </member>
  15933. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.Dy2">
  15934. <summary>
  15935. Gets or sets the dy2.
  15936. </summary>
  15937. <value>The dy2.</value>
  15938. </member>
  15939. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.Dx2">
  15940. <summary>
  15941. Gets or sets the DX2.
  15942. </summary>
  15943. <value>The DX2.</value>
  15944. </member>
  15945. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.IsHorizontallyFlipped">
  15946. <summary>
  15947. Gets a value indicating whether this instance is horizontally flipped.
  15948. </summary>
  15949. <value>
  15950. <c>true</c> if this instance is horizontally flipped; otherwise, <c>false</c>.
  15951. </value>
  15952. </member>
  15953. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.IsVerticallyFlipped">
  15954. <summary>
  15955. Gets a value indicating whether this instance is vertically flipped.
  15956. </summary>
  15957. <value>
  15958. <c>true</c> if this instance is vertically flipped; otherwise, <c>false</c>.
  15959. </value>
  15960. </member>
  15961. <member name="T:NPOI.HSSF.UserModel.HSSFBorderFormatting">
  15962. High level representation for Border Formatting component
  15963. of Conditional Formatting Settings
  15964. @author Dmitriy Kumshayev
  15965. </member>
  15966. <member name="T:NPOI.HSSF.UserModel.HSSFCell">
  15967. <summary>
  15968. High level representation of a cell in a row of a spReadsheet.
  15969. Cells can be numeric, formula-based or string-based (text). The cell type
  15970. specifies this. String cells cannot conatin numbers and numeric cells cannot
  15971. contain strings (at least according to our model). Client apps should do the
  15972. conversions themselves. Formula cells have the formula string, as well as
  15973. the formula result, which can be numeric or string.
  15974. Cells should have their number (0 based) before being Added to a row. Only
  15975. cells that have values should be Added.
  15976. </summary>
  15977. <remarks>
  15978. @author Andrew C. Oliver (acoliver at apache dot org)
  15979. @author Dan Sherman (dsherman at Isisph.com)
  15980. @author Brian Sanders (kestrel at burdell dot org) Active Cell support
  15981. @author Yegor Kozlov cell comments support
  15982. </remarks>
  15983. </member>
  15984. <member name="M:NPOI.HSSF.UserModel.HSSFCell.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,System.Int32,System.Int16)">
  15985. <summary>
  15986. Creates new Cell - Should only be called by HSSFRow. This Creates a cell
  15987. from scratch.
  15988. When the cell is initially Created it is Set to CellType.Blank. Cell types
  15989. can be Changed/overwritten by calling SetCellValue with the appropriate
  15990. type as a parameter although conversions from one type to another may be
  15991. prohibited.
  15992. </summary>
  15993. <param name="book">Workbook record of the workbook containing this cell</param>
  15994. <param name="sheet">Sheet record of the sheet containing this cell</param>
  15995. <param name="row">the row of this cell</param>
  15996. <param name="col">the column for this cell</param>
  15997. </member>
  15998. <member name="M:NPOI.HSSF.UserModel.HSSFCell.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,System.Int32,System.Int16,NPOI.SS.UserModel.CellType)">
  15999. <summary>
  16000. Creates new Cell - Should only be called by HSSFRow. This Creates a cell
  16001. from scratch.
  16002. </summary>
  16003. <param name="book">Workbook record of the workbook containing this cell</param>
  16004. <param name="sheet">Sheet record of the sheet containing this cell</param>
  16005. <param name="row">the row of this cell</param>
  16006. <param name="col">the column for this cell</param>
  16007. <param name="type">CellType.Numeric, CellType.String, CellType.Formula, CellType.Blank,
  16008. CellType.Boolean, CellType.Error</param>
  16009. </member>
  16010. <member name="M:NPOI.HSSF.UserModel.HSSFCell.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.Record.CellValueRecordInterface)">
  16011. <summary>
  16012. Creates an Cell from a CellValueRecordInterface. HSSFSheet uses this when
  16013. reading in cells from an existing sheet.
  16014. </summary>
  16015. <param name="book">Workbook record of the workbook containing this cell</param>
  16016. <param name="sheet">Sheet record of the sheet containing this cell</param>
  16017. <param name="cval">the Cell Value Record we wish to represent</param>
  16018. </member>
  16019. <member name="M:NPOI.HSSF.UserModel.HSSFCell.#ctor">
  16020. private constructor to prevent blank construction
  16021. </member>
  16022. <member name="M:NPOI.HSSF.UserModel.HSSFCell.DetermineType(NPOI.HSSF.Record.CellValueRecordInterface)">
  16023. used internally -- given a cell value record, figure out its type
  16024. </member>
  16025. <member name="P:NPOI.HSSF.UserModel.HSSFCell.BoundWorkbook">
  16026. <summary>
  16027. the Workbook that this Cell is bound to
  16028. </summary>
  16029. </member>
  16030. <member name="P:NPOI.HSSF.UserModel.HSSFCell.Row">
  16031. <summary>
  16032. the HSSFRow this cell belongs to
  16033. </summary>
  16034. </member>
  16035. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellType(NPOI.SS.UserModel.CellType)">
  16036. <summary>
  16037. Set the cells type (numeric, formula or string)
  16038. </summary>
  16039. <param name="cellType">Type of the cell.</param>
  16040. </member>
  16041. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellType(NPOI.SS.UserModel.CellType,System.Boolean,System.Int32,System.Int32,System.Int16)">
  16042. <summary>
  16043. Sets the cell type. The SetValue flag indicates whether to bother about
  16044. trying to preserve the current value in the new record if one is Created.
  16045. The SetCellValue method will call this method with false in SetValue
  16046. since it will overWrite the cell value later
  16047. </summary>
  16048. <param name="cellType">Type of the cell.</param>
  16049. <param name="setValue">if set to <c>true</c> [set value].</param>
  16050. <param name="row">The row.</param>
  16051. <param name="col">The col.</param>
  16052. <param name="styleIndex">Index of the style.</param>
  16053. </member>
  16054. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CellType">
  16055. <summary>
  16056. Get the cells type (numeric, formula or string)
  16057. </summary>
  16058. <value>The type of the cell.</value>
  16059. </member>
  16060. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellValue(System.Double)">
  16061. <summary>
  16062. Set a numeric value for the cell
  16063. </summary>
  16064. <param name="value">the numeric value to Set this cell to. For formulas we'll Set the
  16065. precalculated value, for numerics we'll Set its value. For other types we
  16066. will Change the cell to a numeric cell and Set its value.</param>
  16067. </member>
  16068. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellValue(System.DateTime)">
  16069. <summary>
  16070. Set a date value for the cell. Excel treats dates as numeric so you will need to format the cell as
  16071. a date.
  16072. </summary>
  16073. <param name="value">the date value to Set this cell to. For formulas we'll Set the
  16074. precalculated value, for numerics we'll Set its value. For other types we
  16075. will Change the cell to a numeric cell and Set its value.</param>
  16076. </member>
  16077. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellValue(System.String)">
  16078. <summary>
  16079. Set a string value for the cell. Please note that if you are using
  16080. full 16 bit Unicode you should call SetEncoding() first.
  16081. </summary>
  16082. <param name="value">value to Set the cell to. For formulas we'll Set the formula
  16083. string, for String cells we'll Set its value. For other types we will
  16084. Change the cell to a string cell and Set its value.
  16085. If value is null then we will Change the cell to a Blank cell.</param>
  16086. </member>
  16087. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellErrorValue(System.Byte)">
  16088. set a error value for the cell
  16089. @param errorCode the error value to set this cell to. For formulas we'll set the
  16090. precalculated value , for errors we'll set
  16091. its value. For other types we will change the cell to an error
  16092. cell and set its value.
  16093. </member>
  16094. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellErrorValue(NPOI.SS.UserModel.FormulaError)">
  16095. set a error value for the cell
  16096. @param error the error value to set this cell to. For formulas we'll set the
  16097. precalculated value , for errors we'll set
  16098. its value. For other types we will change the cell to an error
  16099. cell and set its value.
  16100. </member>
  16101. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellValue(NPOI.SS.UserModel.IRichTextString)">
  16102. <summary>
  16103. Set a string value for the cell. Please note that if you are using
  16104. full 16 bit Unicode you should call SetEncoding() first.
  16105. </summary>
  16106. <param name="value">value to Set the cell to. For formulas we'll Set the formula
  16107. string, for String cells we'll Set its value. For other types we will
  16108. Change the cell to a string cell and Set its value.
  16109. If value is null then we will Change the cell to a Blank cell.</param>
  16110. </member>
  16111. <member name="M:NPOI.HSSF.UserModel.HSSFCell.NotifyFormulaChanging">
  16112. Should be called any time that a formula could potentially be deleted.
  16113. Does nothing if this cell currently does not hold a formula
  16114. </member>
  16115. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CellFormula">
  16116. <summary>
  16117. Gets or sets the cell formula.
  16118. </summary>
  16119. <value>The cell formula.</value>
  16120. </member>
  16121. <member name="P:NPOI.HSSF.UserModel.HSSFCell.NumericCellValue">
  16122. <summary>
  16123. Get the value of the cell as a number. For strings we throw an exception.
  16124. For blank cells we return a 0.
  16125. </summary>
  16126. <value>The numeric cell value.</value>
  16127. </member>
  16128. <member name="M:NPOI.HSSF.UserModel.HSSFCell.GetCellTypeName(NPOI.SS.UserModel.CellType)">
  16129. <summary>
  16130. Used to help format error messages
  16131. </summary>
  16132. <param name="cellTypeCode">The cell type code.</param>
  16133. <returns></returns>
  16134. </member>
  16135. <member name="M:NPOI.HSSF.UserModel.HSSFCell.TypeMismatch(NPOI.SS.UserModel.CellType,NPOI.SS.UserModel.CellType,System.Boolean)">
  16136. <summary>
  16137. Types the mismatch.
  16138. </summary>
  16139. <param name="expectedTypeCode">The expected type code.</param>
  16140. <param name="actualTypeCode">The actual type code.</param>
  16141. <param name="isFormulaCell">if set to <c>true</c> [is formula cell].</param>
  16142. <returns></returns>
  16143. </member>
  16144. <member name="M:NPOI.HSSF.UserModel.HSSFCell.CheckFormulaCachedValueType(NPOI.SS.UserModel.CellType,NPOI.HSSF.Record.FormulaRecord)">
  16145. <summary>
  16146. Checks the type of the formula cached value.
  16147. </summary>
  16148. <param name="expectedTypeCode">The expected type code.</param>
  16149. <param name="fr">The fr.</param>
  16150. </member>
  16151. <member name="P:NPOI.HSSF.UserModel.HSSFCell.DateCellValue">
  16152. <summary>
  16153. Get the value of the cell as a date. For strings we throw an exception.
  16154. For blank cells we return a null.
  16155. </summary>
  16156. <value>The date cell value.</value>
  16157. </member>
  16158. <member name="P:NPOI.HSSF.UserModel.HSSFCell.StringCellValue">
  16159. <summary>
  16160. Get the value of the cell as a string - for numeric cells we throw an exception.
  16161. For blank cells we return an empty string.
  16162. For formulaCells that are not string Formulas, we return empty String
  16163. </summary>
  16164. <value>The string cell value.</value>
  16165. </member>
  16166. <member name="P:NPOI.HSSF.UserModel.HSSFCell.RichStringCellValue">
  16167. <summary>
  16168. Get the value of the cell as a string - for numeric cells we throw an exception.
  16169. For blank cells we return an empty string.
  16170. For formulaCells that are not string Formulas, we return empty String
  16171. </summary>
  16172. <value>The rich string cell value.</value>
  16173. </member>
  16174. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellValue(System.Boolean)">
  16175. <summary>
  16176. Set a bool value for the cell
  16177. </summary>
  16178. <param name="value">the bool value to Set this cell to. For formulas we'll Set the
  16179. precalculated value, for bools we'll Set its value. For other types we
  16180. will Change the cell to a bool cell and Set its value.</param>
  16181. </member>
  16182. <member name="M:NPOI.HSSF.UserModel.HSSFCell.ConvertCellValueToBoolean">
  16183. <summary>
  16184. Chooses a new bool value for the cell when its type is changing.
  16185. Usually the caller is calling SetCellType() with the intention of calling
  16186. SetCellValue(bool) straight afterwards. This method only exists to give
  16187. the cell a somewhat reasonable value until the SetCellValue() call (if at all).
  16188. TODO - perhaps a method like SetCellTypeAndValue(int, Object) should be introduced to avoid this
  16189. </summary>
  16190. <returns></returns>
  16191. </member>
  16192. <member name="P:NPOI.HSSF.UserModel.HSSFCell.BooleanCellValue">
  16193. <summary>
  16194. Get the value of the cell as a bool. For strings, numbers, and errors, we throw an exception.
  16195. For blank cells we return a false.
  16196. </summary>
  16197. <value><c>true</c> if [boolean cell value]; otherwise, <c>false</c>.</value>
  16198. </member>
  16199. <member name="P:NPOI.HSSF.UserModel.HSSFCell.ErrorCellValue">
  16200. <summary>
  16201. Get the value of the cell as an error code. For strings, numbers, and bools, we throw an exception.
  16202. For blank cells we return a 0.
  16203. </summary>
  16204. <value>The error cell value.</value>
  16205. </member>
  16206. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CellStyle">
  16207. <summary>
  16208. Get the style for the cell. This is a reference to a cell style contained in the workbook
  16209. object.
  16210. </summary>
  16211. <value>The cell style.</value>
  16212. </member>
  16213. <member name="M:NPOI.HSSF.UserModel.HSSFCell.ApplyUserCellStyle(NPOI.HSSF.UserModel.HSSFCellStyle)">
  16214. Applying a user-defined style (UDS) is special. Excel does not directly reference user-defined styles, but
  16215. instead create a 'proxy' ExtendedFormatRecord referencing the UDS as parent.
  16216. The proceudre to apply a UDS is as follows:
  16217. 1. search for a ExtendedFormatRecord with parentIndex == style.getIndex()
  16218. and xfType == ExtendedFormatRecord.XF_CELL.
  16219. 2. if not found then create a new ExtendedFormatRecord and copy all attributes from the user-defined style
  16220. and set the parentIndex to be style.getIndex()
  16221. 3. return the index of the ExtendedFormatRecord, this will be assigned to the parent cell record
  16222. @param style the user style to apply
  16223. @return the index of a ExtendedFormatRecord record that will be referenced by the cell
  16224. </member>
  16225. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CellValueRecord">
  16226. <summary>
  16227. Should only be used by HSSFSheet and friends. Returns the low level CellValueRecordInterface record
  16228. </summary>
  16229. <value>the cell via the low level api.</value>
  16230. </member>
  16231. <member name="M:NPOI.HSSF.UserModel.HSSFCell.CheckBounds(System.Int32)">
  16232. <summary>
  16233. Checks the bounds.
  16234. </summary>
  16235. <param name="cellIndex">The cell num.</param>
  16236. <exception cref="T:System.Exception">if the bounds are exceeded.</exception>
  16237. </member>
  16238. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetAsActiveCell">
  16239. <summary>
  16240. Sets this cell as the active cell for the worksheet
  16241. </summary>
  16242. </member>
  16243. <member name="M:NPOI.HSSF.UserModel.HSSFCell.ToString">
  16244. <summary>
  16245. Returns a string representation of the cell
  16246. This method returns a simple representation,
  16247. anthing more complex should be in user code, with
  16248. knowledge of the semantics of the sheet being Processed.
  16249. Formula cells return the formula string,
  16250. rather than the formula result.
  16251. Dates are Displayed in dd-MMM-yyyy format
  16252. Errors are Displayed as #ERR&lt;errIdx&gt;
  16253. </summary>
  16254. </member>
  16255. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CellComment">
  16256. <summary>
  16257. Returns comment associated with this cell
  16258. </summary>
  16259. <value>The cell comment associated with this cell.</value>
  16260. </member>
  16261. <member name="M:NPOI.HSSF.UserModel.HSSFCell.RemoveCellComment">
  16262. <summary>
  16263. Removes the comment for this cell, if
  16264. there is one.
  16265. </summary>
  16266. <remarks>WARNING - some versions of excel will loose
  16267. all comments after performing this action!</remarks>
  16268. </member>
  16269. <member name="P:NPOI.HSSF.UserModel.HSSFCell.ColumnIndex">
  16270. <summary>
  16271. Gets the index of the column.
  16272. </summary>
  16273. <value>The index of the column.</value>
  16274. </member>
  16275. <member name="M:NPOI.HSSF.UserModel.HSSFCell.UpdateCellNum(System.Int32)">
  16276. Updates the cell record's idea of what
  16277. column it belongs in (0 based)
  16278. @param num the new cell number
  16279. </member>
  16280. <member name="P:NPOI.HSSF.UserModel.HSSFCell.RowIndex">
  16281. <summary>
  16282. Gets the (zero based) index of the row containing this cell
  16283. </summary>
  16284. <value>The index of the row.</value>
  16285. </member>
  16286. <member name="P:NPOI.HSSF.UserModel.HSSFCell.Hyperlink">
  16287. <summary>
  16288. Get or set hyperlink associated with this cell
  16289. If the supplied hyperlink is null on setting, the hyperlink for this cell will be removed.
  16290. </summary>
  16291. <value>The hyperlink associated with this cell or null if not found</value>
  16292. </member>
  16293. <member name="M:NPOI.HSSF.UserModel.HSSFCell.RemoveHyperlink">
  16294. <summary>
  16295. Removes the hyperlink for this cell, if there is one.
  16296. </summary>
  16297. </member>
  16298. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CachedFormulaResultType">
  16299. <summary>
  16300. Only valid for formula cells
  16301. </summary>
  16302. <value>one of (CellType.Numeric,CellType.String, CellType.Boolean, CellType.Error) depending
  16303. on the cached value of the formula</value>
  16304. </member>
  16305. <member name="M:NPOI.HSSF.UserModel.HSSFCell.NotifyArrayFormulaChanging(System.String)">
  16306. <summary>
  16307. The purpose of this method is to validate the cell state prior to modification
  16308. </summary>
  16309. <param name="msg"></param>
  16310. </member>
  16311. <member name="M:NPOI.HSSF.UserModel.HSSFCell.NotifyArrayFormulaChanging">
  16312. <summary>
  16313. Called when this cell is modified.
  16314. The purpose of this method is to validate the cell state prior to modification.
  16315. </summary>
  16316. </member>
  16317. <member name="T:NPOI.HSSF.UserModel.HSSFCellStyle">
  16318. <summary>
  16319. High level representation of the style of a cell in a sheet of a workbook.
  16320. @author Andrew C. Oliver (acoliver at apache dot org)
  16321. @author Jason Height (jheight at chariot dot net dot au)
  16322. </summary>
  16323. </member>
  16324. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.#ctor(System.Int16,NPOI.HSSF.Record.ExtendedFormatRecord,NPOI.HSSF.UserModel.HSSFWorkbook)">
  16325. <summary>
  16326. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFCellStyle"/> class.
  16327. </summary>
  16328. <param name="index">The index.</param>
  16329. <param name="rec">The record.</param>
  16330. <param name="workbook">The workbook.</param>
  16331. </member>
  16332. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.#ctor(System.Int16,NPOI.HSSF.Record.ExtendedFormatRecord,NPOI.HSSF.Model.InternalWorkbook)">
  16333. <summary>
  16334. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFCellStyle"/> class.
  16335. </summary>
  16336. <param name="index">The index.</param>
  16337. <param name="rec">The record.</param>
  16338. <param name="workbook">The workbook.</param>
  16339. </member>
  16340. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.Index">
  16341. <summary>
  16342. Get the index within the HSSFWorkbook (sequence within the collection of ExtnededFormat objects)
  16343. </summary>
  16344. <value>Unique index number of the Underlying record this style represents (probably you don't care
  16345. Unless you're comparing which one is which)</value>
  16346. </member>
  16347. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.ParentStyle">
  16348. <summary>
  16349. Gets the parent style.
  16350. </summary>
  16351. <value>the parent style for this cell style.
  16352. In most cases this will be null, but in a few
  16353. cases there'll be a fully defined parent.</value>
  16354. </member>
  16355. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.DataFormat">
  16356. <summary>
  16357. Get the index of the format
  16358. </summary>
  16359. <value>The data format.</value>
  16360. </member>
  16361. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.GetDataFormatString">
  16362. <summary>
  16363. Get the contents of the format string, by looking up
  16364. the DataFormat against the bound workbook
  16365. </summary>
  16366. <returns></returns>
  16367. </member>
  16368. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.GetDataFormatString(NPOI.SS.UserModel.IWorkbook)">
  16369. <summary>
  16370. Get the contents of the format string, by looking up the DataFormat against the supplied workbook
  16371. </summary>
  16372. <param name="workbook">The workbook</param>
  16373. <returns>the format string or "General" if not found</returns>
  16374. </member>
  16375. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.GetDataFormatString(NPOI.HSSF.Model.InternalWorkbook)">
  16376. <summary>
  16377. Get the contents of the format string, by looking up
  16378. the DataFormat against the supplied workbook
  16379. </summary>
  16380. <param name="workbook">The internal workbook.</param>
  16381. <returns></returns>
  16382. </member>
  16383. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.SetFont(NPOI.SS.UserModel.IFont)">
  16384. <summary>
  16385. Set the font for this style
  16386. </summary>
  16387. <param name="font">a font object Created or retreived from the HSSFWorkbook object</param>
  16388. </member>
  16389. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.FontIndex">
  16390. <summary>
  16391. Gets the index of the font for this style.
  16392. </summary>
  16393. <value>The index of the font.</value>
  16394. </member>
  16395. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.GetFont(NPOI.SS.UserModel.IWorkbook)">
  16396. <summary>
  16397. Gets the font for this style
  16398. </summary>
  16399. <param name="parentWorkbook">The parent workbook that this style belongs to.</param>
  16400. <returns></returns>
  16401. </member>
  16402. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.IsHidden">
  16403. <summary>
  16404. Get whether the cell's using this style are to be hidden
  16405. </summary>
  16406. <value>whether the cell using this style should be hidden</value>
  16407. </member>
  16408. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.IsLocked">
  16409. <summary>
  16410. Get whether the cell's using this style are to be locked
  16411. </summary>
  16412. <value>whether the cell using this style should be locked</value>
  16413. </member>
  16414. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.Alignment">
  16415. <summary>
  16416. Get the type of horizontal alignment for the cell
  16417. </summary>
  16418. <value> the type of alignment</value>
  16419. </member>
  16420. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.WrapText">
  16421. <summary>
  16422. Gets or sets a value indicating whether the text should be wrapped
  16423. </summary>
  16424. <value><c>true</c> if [wrap text]; otherwise, <c>false</c>.</value>
  16425. </member>
  16426. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.VerticalAlignment">
  16427. <summary>
  16428. Gets or sets the vertical alignment for the cell.
  16429. </summary>
  16430. <value>the type of alignment</value>
  16431. </member>
  16432. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.Rotation">
  16433. <summary>
  16434. Gets or sets the degree of rotation for the text in the cell
  16435. Note: HSSF uses values from -90 to 90 degrees, whereas XSSF
  16436. uses values from 0 to 180 degrees.The implementations of this method will map between these two value-ranges
  16437. accordingly, however the corresponding getter is returning values in the range mandated by the current type
  16438. of Excel file-format that this CellStyle is applied to.
  16439. </summary>
  16440. <value>The rotation degrees (between -90 and 90 degrees).</value>
  16441. </member>
  16442. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.VerifyBelongsToWorkbook(NPOI.HSSF.UserModel.HSSFWorkbook)">
  16443. <summary>
  16444. Verifies that this style belongs to the supplied Workbook.
  16445. Will throw an exception if it belongs to a different one.
  16446. This is normally called when trying to assign a style to a
  16447. cell, to ensure the cell and the style are from the same
  16448. workbook (if they're not, it won't work)
  16449. </summary>
  16450. <param name="wb">The workbook.</param>
  16451. </member>
  16452. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.Indention">
  16453. <summary>
  16454. Gets or sets the number of spaces to indent the text in the cell
  16455. </summary>
  16456. <value>number of spaces</value>
  16457. </member>
  16458. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderLeft">
  16459. <summary>
  16460. Gets or sets the type of border to use for the left border of the cell
  16461. </summary>
  16462. <value>The border type.</value>
  16463. </member>
  16464. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderRight">
  16465. <summary>
  16466. Gets or sets the type of border to use for the right border of the cell
  16467. </summary>
  16468. <value>The border type.</value>
  16469. </member>
  16470. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderTop">
  16471. <summary>
  16472. Gets or sets the type of border to use for the top border of the cell
  16473. </summary>
  16474. <value>The border type.</value>
  16475. </member>
  16476. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderBottom">
  16477. <summary>
  16478. Gets or sets the type of border to use for the bottom border of the cell
  16479. </summary>
  16480. <value>The border type.</value>
  16481. </member>
  16482. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.LeftBorderColor">
  16483. <summary>
  16484. Gets or sets the color to use for the left border
  16485. </summary>
  16486. <value>The index of the color definition</value>
  16487. </member>
  16488. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.RightBorderColor">
  16489. <summary>
  16490. Gets or sets the color to use for the left border.
  16491. </summary>
  16492. <value>The index of the color definition</value>
  16493. </member>
  16494. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.TopBorderColor">
  16495. <summary>
  16496. Gets or sets the color to use for the top border
  16497. </summary>
  16498. <value>The index of the color definition.</value>
  16499. </member>
  16500. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BottomBorderColor">
  16501. <summary>
  16502. Gets or sets the color to use for the left border
  16503. </summary>
  16504. <value>The index of the color definition.</value>
  16505. </member>
  16506. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderDiagonalColor">
  16507. <summary>
  16508. Gets or sets the color to use for the diagional border
  16509. </summary>
  16510. <value>The index of the color definition.</value>
  16511. </member>
  16512. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderDiagonalLineStyle">
  16513. <summary>
  16514. Gets or sets the line type to use for the diagional border
  16515. </summary>
  16516. <value>The line type.</value>
  16517. </member>
  16518. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderDiagonal">
  16519. <summary>
  16520. Gets or sets the type of diagional border
  16521. </summary>.
  16522. <value>The border diagional type.</value>
  16523. </member>
  16524. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.ShrinkToFit">
  16525. <summary>
  16526. Gets or sets whether the cell is shrink-to-fit
  16527. </summary>
  16528. </member>
  16529. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.ReadingOrder">
  16530. Get or set the reading order, for RTL/LTR ordering of
  16531. the text.
  16532. <p>0 means Context (Default), 1 means Left To Right,
  16533. and 2 means Right to Left</p>
  16534. @return order - the reading order (0,1,2)
  16535. </member>
  16536. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.FillPattern">
  16537. <summary>
  16538. Gets or sets the fill pattern. - Set to 1 to Fill with foreground color
  16539. </summary>
  16540. <value>The fill pattern.</value>
  16541. </member>
  16542. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.CheckDefaultBackgroundFills">
  16543. <summary>
  16544. Checks if the background and foreground Fills are Set correctly when one
  16545. or the other is Set to the default color.
  16546. Works like the logic table below:
  16547. BACKGROUND FOREGROUND
  16548. NONE AUTOMATIC
  16549. 0x41 0x40
  16550. NONE RED/ANYTHING
  16551. 0x40 0xSOMETHING
  16552. </summary>
  16553. </member>
  16554. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.CloneStyleFrom(NPOI.SS.UserModel.ICellStyle)">
  16555. Clones all the style information from another
  16556. HSSFCellStyle, onto this one. This
  16557. HSSFCellStyle will then have all the same
  16558. properties as the source, but the two may
  16559. be edited independently.
  16560. Any stylings on this HSSFCellStyle will be lost!
  16561. The source HSSFCellStyle could be from another
  16562. HSSFWorkbook if you like. This allows you to
  16563. copy styles from one HSSFWorkbook to another.
  16564. </member>
  16565. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.CloneStyleFrom(NPOI.HSSF.UserModel.HSSFCellStyle)">
  16566. <summary>
  16567. Clones all the style information from another
  16568. HSSFCellStyle, onto this one. This
  16569. HSSFCellStyle will then have all the same
  16570. properties as the source, but the two may
  16571. be edited independently.
  16572. Any stylings on this HSSFCellStyle will be lost!
  16573. The source HSSFCellStyle could be from another
  16574. HSSFWorkbook if you like. This allows you to
  16575. copy styles from one HSSFWorkbook to another.
  16576. </summary>
  16577. <param name="source">The source.</param>
  16578. </member>
  16579. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.FillBackgroundColor">
  16580. <summary>
  16581. Gets or sets the color of the fill background.
  16582. </summary>
  16583. <value>The color of the fill background.</value>
  16584. Set the background Fill color.
  16585. <example>
  16586. cs.SetFillPattern(HSSFCellStyle.FINE_DOTS );
  16587. cs.SetFillBackgroundColor(new HSSFColor.RED().Index);
  16588. optionally a Foreground and background Fill can be applied:
  16589. Note: Ensure Foreground color is Set prior to background
  16590. cs.SetFillPattern(HSSFCellStyle.FINE_DOTS );
  16591. cs.SetFillForegroundColor(new HSSFColor.BLUE().Index);
  16592. cs.SetFillBackgroundColor(new HSSFColor.RED().Index);
  16593. or, for the special case of SOLID_Fill:
  16594. cs.SetFillPattern(HSSFCellStyle.SOLID_FOREGROUND );
  16595. cs.SetFillForegroundColor(new HSSFColor.RED().Index);
  16596. It is necessary to Set the Fill style in order
  16597. for the color to be shown in the cell.
  16598. </example>
  16599. </member>
  16600. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.FillForegroundColor">
  16601. <summary>
  16602. Gets or sets the foreground Fill color
  16603. </summary>
  16604. <value>Fill color.</value>
  16605. @see org.apache.poi.hssf.usermodel.HSSFPalette#GetColor(short)
  16606. </member>
  16607. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.UserStyleName">
  16608. Gets the name of the user defined style.
  16609. Returns null for built in styles, and
  16610. styles where no name has been defined
  16611. </member>
  16612. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.GetHashCode">
  16613. <summary>
  16614. Serves as a hash function for a particular type.
  16615. </summary>
  16616. <returns>
  16617. A hash code for the current <see cref="T:System.Object"/>.
  16618. </returns>
  16619. </member>
  16620. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.Equals(System.Object)">
  16621. <summary>
  16622. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
  16623. </summary>
  16624. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
  16625. <returns>
  16626. true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
  16627. </returns>
  16628. <exception cref="T:System.NullReferenceException">
  16629. The <paramref name="obj"/> parameter is null.
  16630. </exception>
  16631. </member>
  16632. <member name="M:NPOI.HSSF.UserModel.HSSFChildAnchor.#ctor(NPOI.DDF.EscherChildAnchorRecord)">
  16633. create anchor from existing file
  16634. @param escherChildAnchorRecord
  16635. </member>
  16636. <member name="M:NPOI.HSSF.UserModel.HSSFChildAnchor.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
  16637. create anchor from scratch
  16638. @param dx1 x coordinate of the left up corner
  16639. @param dy1 y coordinate of the left up corner
  16640. @param dx2 x coordinate of the right down corner
  16641. @param dy2 y coordinate of the right down corner
  16642. </member>
  16643. <member name="M:NPOI.HSSF.UserModel.HSSFChildAnchor.SetAnchor(System.Int32,System.Int32,System.Int32,System.Int32)">
  16644. @param dx1 x coordinate of the left up corner
  16645. @param dy1 y coordinate of the left up corner
  16646. @param dx2 x coordinate of the right down corner
  16647. @param dy2 y coordinate of the right down corner
  16648. </member>
  16649. <member name="T:NPOI.HSSF.UserModel.HSSFClientAnchor">
  16650. <summary>
  16651. A client anchor Is attached to an excel worksheet. It anchors against a
  16652. top-left and buttom-right cell.
  16653. @author Glen Stampoultzis (glens at apache.org)
  16654. </summary>
  16655. </member>
  16656. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.#ctor">
  16657. <summary>
  16658. Creates a new client anchor and defaults all the anchor positions to 0.
  16659. </summary>
  16660. </member>
  16661. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  16662. <summary>
  16663. Creates a new client anchor and Sets the top-left and bottom-right
  16664. coordinates of the anchor.
  16665. Note: Microsoft Excel seems to sometimes disallow
  16666. higher y1 than y2 or higher x1 than x2 in the anchor, you might need to
  16667. reverse them and draw shapes vertically or horizontally flipped!
  16668. </summary>
  16669. <param name="dx1">the x coordinate within the first cell.</param>
  16670. <param name="dy1">the y coordinate within the first cell.</param>
  16671. <param name="dx2">the x coordinate within the second cell.</param>
  16672. <param name="dy2">the y coordinate within the second cell.</param>
  16673. <param name="col1">the column (0 based) of the first cell.</param>
  16674. <param name="row1">the row (0 based) of the first cell.</param>
  16675. <param name="col2">the column (0 based) of the second cell.</param>
  16676. <param name="row2">the row (0 based) of the second cell.</param>
  16677. </member>
  16678. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.GetAnchorHeightInPoints(NPOI.SS.UserModel.ISheet)">
  16679. <summary>
  16680. Calculates the height of a client anchor in points.
  16681. </summary>
  16682. <param name="sheet">the sheet the anchor will be attached to</param>
  16683. <returns>the shape height.</returns>
  16684. </member>
  16685. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.GetRowHeightInPoints(NPOI.SS.UserModel.ISheet,System.Int32)">
  16686. <summary>
  16687. Gets the row height in points.
  16688. </summary>
  16689. <param name="sheet">The sheet.</param>
  16690. <param name="rowNum">The row num.</param>
  16691. <returns></returns>
  16692. </member>
  16693. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.Col1">
  16694. <summary>
  16695. Gets or sets the col1.
  16696. </summary>
  16697. <value>The col1.</value>
  16698. </member>
  16699. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.Col2">
  16700. <summary>
  16701. Gets or sets the col2.
  16702. </summary>
  16703. <value>The col2.</value>
  16704. </member>
  16705. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.Row1">
  16706. <summary>
  16707. Gets or sets the row1.
  16708. </summary>
  16709. <value>The row1.</value>
  16710. </member>
  16711. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.Row2">
  16712. <summary>
  16713. Gets or sets the row2.
  16714. </summary>
  16715. <value>The row2.</value>
  16716. </member>
  16717. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.SetAnchor(System.Int16,System.Int32,System.Int32,System.Int32,System.Int16,System.Int32,System.Int32,System.Int32)">
  16718. <summary>
  16719. Sets the top-left and bottom-right
  16720. coordinates of the anchor
  16721. Note: Microsoft Excel seems to sometimes disallow
  16722. higher y1 than y2 or higher x1 than x2 in the anchor, you might need to
  16723. reverse them and draw shapes vertically or horizontally flipped!
  16724. </summary>
  16725. <param name="col1">the column (0 based) of the first cell.</param>
  16726. <param name="row1"> the row (0 based) of the first cell.</param>
  16727. <param name="x1">the x coordinate within the first cell.</param>
  16728. <param name="y1">the y coordinate within the first cell.</param>
  16729. <param name="col2">the column (0 based) of the second cell.</param>
  16730. <param name="row2">the row (0 based) of the second cell.</param>
  16731. <param name="x2">the x coordinate within the second cell.</param>
  16732. <param name="y2">the y coordinate within the second cell.</param>
  16733. </member>
  16734. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.IsHorizontallyFlipped">
  16735. <summary>
  16736. Gets a value indicating whether this instance is horizontally flipped.
  16737. </summary>
  16738. <value>
  16739. <c>true</c> if the anchor goes from right to left; otherwise, <c>false</c>.
  16740. </value>
  16741. </member>
  16742. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.IsVerticallyFlipped">
  16743. <summary>
  16744. Gets a value indicating whether this instance is vertically flipped.
  16745. </summary>
  16746. <value>
  16747. <c>true</c> if the anchor goes from bottom to top.; otherwise, <c>false</c>.
  16748. </value>
  16749. </member>
  16750. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.AnchorType">
  16751. <summary>
  16752. Gets the anchor type
  16753. 0 = Move and size with Cells, 2 = Move but don't size with cells, 3 = Don't move or size with cells.
  16754. </summary>
  16755. <value>The type of the anchor.</value>
  16756. </member>
  16757. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.CheckRange(System.Int32,System.Int32,System.Int32,System.String)">
  16758. <summary>
  16759. Checks the range.
  16760. </summary>
  16761. <param name="value">The value.</param>
  16762. <param name="minRange">The min range.</param>
  16763. <param name="maxRange">The max range.</param>
  16764. <param name="varName">Name of the variable.</param>
  16765. </member>
  16766. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.unsignedValue(System.Int16)">
  16767. Given a 16-bit unsigned integer stored in a short, return the unsigned value.
  16768. @param s A 16-bit value intended to be interpreted as an unsigned integer.
  16769. @return The value represented by <code>s</code>.
  16770. </member>
  16771. <member name="T:NPOI.HSSF.UserModel.HSSFColorScaleFormatting">
  16772. High level representation for Color Scale / Color Gradient
  16773. Formatting component of Conditional Formatting Settings
  16774. </member>
  16775. <member name="T:NPOI.HSSF.UserModel.HSSFComment">
  16776. <summary>
  16777. Represents a cell comment - a sticky note associated with a cell.
  16778. @author Yegor Kozlov
  16779. </summary>
  16780. </member>
  16781. <member name="M:NPOI.HSSF.UserModel.HSSFComment.#ctor(NPOI.HSSF.UserModel.HSSFShape,NPOI.HSSF.UserModel.HSSFAnchor)">
  16782. <summary>
  16783. Construct a new comment with the given parent and anchor.
  16784. </summary>
  16785. <param name="parent"></param>
  16786. <param name="anchor">defines position of this anchor in the sheet</param>
  16787. </member>
  16788. <member name="M:NPOI.HSSF.UserModel.HSSFComment.#ctor(NPOI.HSSF.Record.NoteRecord,NPOI.HSSF.Record.TextObjectRecord)">
  16789. <summary>
  16790. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFComment"/> class.
  16791. </summary>
  16792. <param name="note">The note.</param>
  16793. <param name="txo">The txo.</param>
  16794. </member>
  16795. <member name="P:NPOI.HSSF.UserModel.HSSFComment.Visible">
  16796. <summary>
  16797. Gets or sets a value indicating whether this <see cref="T:NPOI.HSSF.UserModel.HSSFComment"/> is visible.
  16798. </summary>
  16799. <value><c>true</c> if visible; otherwise, <c>false</c>.</value>
  16800. Sets whether this comment Is visible.
  16801. @return
  16802. <c>true</c>
  16803. if the comment Is visible,
  16804. <c>false</c>
  16805. otherwise
  16806. </member>
  16807. <member name="P:NPOI.HSSF.UserModel.HSSFComment.Row">
  16808. <summary>
  16809. Gets or sets the row of the cell that Contains the comment
  16810. </summary>
  16811. <value>the 0-based row of the cell that Contains the comment</value>
  16812. </member>
  16813. <member name="P:NPOI.HSSF.UserModel.HSSFComment.Column">
  16814. <summary>
  16815. Gets or sets the column of the cell that Contains the comment
  16816. </summary>
  16817. <value>the 0-based column of the cell that Contains the comment</value>
  16818. </member>
  16819. <member name="P:NPOI.HSSF.UserModel.HSSFComment.Author">
  16820. <summary>
  16821. Gets or sets the name of the original comment author
  16822. </summary>
  16823. <value>the name of the original author of the comment</value>
  16824. </member>
  16825. <member name="P:NPOI.HSSF.UserModel.HSSFComment.NoteRecord">
  16826. <summary>
  16827. Gets the note record.
  16828. </summary>
  16829. <value>the underlying Note record.</value>
  16830. </member>
  16831. <member name="P:NPOI.HSSF.UserModel.HSSFComment.HasPosition">
  16832. Do we know which cell this comment belongs to?
  16833. </member>
  16834. <member name="T:NPOI.HSSF.UserModel.HSSFConditionalFormatting">
  16835. <summary>
  16836. HSSFConditionalFormatting class encapsulates all Settings of Conditional Formatting.
  16837. The class can be used to make a copy HSSFConditionalFormatting Settings
  16838. </summary>
  16839. <example>
  16840. HSSFConditionalFormatting cf = sheet.GetConditionalFormattingAt(index);
  16841. newSheet.AddConditionalFormatting(cf);
  16842. or to modify existing Conditional Formatting Settings (formatting regions and/or rules).
  16843. Use {@link HSSFSheet#GetConditionalFormattingAt(int)} to Get access to an instance of this class.
  16844. To Create a new Conditional Formatting Set use the following approach:
  16845. // Define a Conditional Formatting rule, which triggers formatting
  16846. // when cell's value Is greater or equal than 100.0 and
  16847. // applies patternFormatting defined below.
  16848. HSSFConditionalFormattingRule rule = sheet.CreateConditionalFormattingRule(
  16849. ComparisonOperator.GE,
  16850. "100.0", // 1st formula
  16851. null // 2nd formula Is not used for comparison operator GE
  16852. );
  16853. // Create pattern with red background
  16854. HSSFPatternFormatting patternFmt = rule.cretePatternFormatting();
  16855. patternFormatting.SetFillBackgroundColor(HSSFColor.RED.index);
  16856. // Define a region containing first column
  16857. Region [] regions =
  16858. {
  16859. new Region(1,(short)1,-1,(short)1)
  16860. };
  16861. // Apply Conditional Formatting rule defined above to the regions
  16862. sheet.AddConditionalFormatting(regions, rule);
  16863. </example>
  16864. <remarks>@author Dmitriy Kumshayev</remarks>
  16865. </member>
  16866. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.#ctor(NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.Record.Aggregates.CFRecordsAggregate)">
  16867. <summary>
  16868. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFConditionalFormatting"/> class.
  16869. </summary>
  16870. <param name="sheet">The workbook.</param>
  16871. <param name="cfAggregate">The cf aggregate.</param>
  16872. </member>
  16873. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormatting.CFRecordsAggregate">
  16874. <summary>
  16875. Gets the CF records aggregate.
  16876. </summary>
  16877. <returns></returns>
  16878. </member>
  16879. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.GetFormattingRanges">
  16880. <summary>
  16881. Gets array of CellRangeAddresses
  16882. </summary>
  16883. <returns></returns>
  16884. </member>
  16885. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.SetRule(System.Int32,NPOI.HSSF.UserModel.HSSFConditionalFormattingRule)">
  16886. <summary>
  16887. Replaces an existing Conditional Formatting rule at position idx.
  16888. Excel allows to Create up to 3 Conditional Formatting rules.
  16889. This method can be useful to modify existing Conditional Formatting rules.
  16890. </summary>
  16891. <param name="idx">position of the rule. Should be between 0 and 2.</param>
  16892. <param name="cfRule">Conditional Formatting rule</param>
  16893. </member>
  16894. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.AddRule(NPOI.HSSF.UserModel.HSSFConditionalFormattingRule)">
  16895. <summary>
  16896. Add a Conditional Formatting rule.
  16897. Excel allows to Create up to 3 Conditional Formatting rules.
  16898. </summary>
  16899. <param name="cfRule">Conditional Formatting rule</param>
  16900. </member>
  16901. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.GetRule(System.Int32)">
  16902. <summary>
  16903. Gets the Conditional Formatting rule at position idx
  16904. </summary>
  16905. <param name="idx">The index.</param>
  16906. <returns></returns>
  16907. </member>
  16908. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormatting.NumberOfRules">
  16909. <summary>
  16910. Gets the number of Conditional Formatting rules.
  16911. </summary>
  16912. <value>The number of rules.</value>
  16913. </member>
  16914. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.ToString">
  16915. <summary>
  16916. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  16917. </summary>
  16918. <returns>
  16919. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  16920. </returns>
  16921. </member>
  16922. <member name="T:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule">
  16923. High level representation of Conditional Formatting Rule.
  16924. It allows to specify formula based conditions for the Conditional Formatting
  16925. and the formatting Settings such as font, border and pattern.
  16926. @author Dmitriy Kumshayev
  16927. </member>
  16928. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.FontFormatting">
  16929. @return - font formatting object if defined, <c>null</c> otherwise
  16930. </member>
  16931. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.CreateFontFormatting">
  16932. Create a new font formatting structure if it does not exist,
  16933. otherwise just return existing object.
  16934. @return - font formatting object, never returns <c>null</c>.
  16935. </member>
  16936. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.BorderFormatting">
  16937. @return - border formatting object if defined, <c>null</c> otherwise
  16938. </member>
  16939. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.CreateBorderFormatting">
  16940. Create a new border formatting structure if it does not exist,
  16941. otherwise just return existing object.
  16942. @return - border formatting object, never returns <c>null</c>.
  16943. </member>
  16944. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.PatternFormatting">
  16945. @return - pattern formatting object if defined, <c>null</c> otherwise
  16946. </member>
  16947. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.CreatePatternFormatting">
  16948. Create a new pattern formatting structure if it does not exist,
  16949. otherwise just return existing object.
  16950. @return - pattern formatting object, never returns <c>null</c>.
  16951. </member>
  16952. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.DataBarFormatting">
  16953. @return databar / data-bar formatting object if defined, <code>null</code> otherwise
  16954. </member>
  16955. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.CreateDataBarFormatting">
  16956. create a new databar / data-bar formatting object if it does not exist,
  16957. otherwise just return the existing object.
  16958. </member>
  16959. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.MultiStateFormatting">
  16960. @return icon / multi-state formatting object if defined, <code>null</code> otherwise
  16961. </member>
  16962. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.CreateMultiStateFormatting">
  16963. create a new icon / multi-state formatting object if it does not exist,
  16964. otherwise just return the existing object.
  16965. </member>
  16966. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.ColorScaleFormatting">
  16967. @return color scale / gradient formatting object if defined, <code>null</code> otherwise
  16968. </member>
  16969. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.CreateColorScaleFormatting">
  16970. create a new color scale / gradient formatting object if it does not exist,
  16971. otherwise just return the existing object.
  16972. </member>
  16973. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.ConditionType">
  16974. @return - the conditiontype for the cfrule
  16975. </member>
  16976. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.ComparisonOperation">
  16977. @return - the comparisionoperatation for the cfrule
  16978. </member>
  16979. <member name="T:NPOI.HSSF.UserModel.HSSFConditionalFormattingThreshold">
  16980. High level representation for Icon / Multi-State / Databar /
  16981. Colour Scale change thresholds
  16982. </member>
  16983. <member name="M:NPOI.HSSF.UserModel.HSSFCreationHelper.CreateFormulaEvaluator">
  16984. Creates a HSSFFormulaEvaluator, the object that Evaluates formula cells.
  16985. @return a HSSFFormulaEvaluator instance
  16986. </member>
  16987. <member name="M:NPOI.HSSF.UserModel.HSSFCreationHelper.CreateClientAnchor">
  16988. Creates a HSSFClientAnchor. Use this object to position drawing object in a sheet
  16989. @return a HSSFClientAnchor instance
  16990. @see NPOI.SS.usermodel.Drawing
  16991. </member>
  16992. <member name="T:NPOI.HSSF.UserModel.HSSFDataBarFormatting">
  16993. High level representation for DataBar / Data-Bar Formatting
  16994. component of Conditional Formatting Settings
  16995. </member>
  16996. <member name="F:NPOI.HSSF.UserModel.HSSFDataFormat.FIRST_USER_DEFINED_FORMAT_INDEX">
  16997. The first user-defined format starts at 164.
  16998. </member>
  16999. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.#ctor(NPOI.HSSF.Model.InternalWorkbook)">
  17000. <summary>
  17001. Construncts a new data formatter. It takes a workbook to have
  17002. access to the workbooks format records.
  17003. </summary>
  17004. <param name="workbook">the workbook the formats are tied to.</param>
  17005. </member>
  17006. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.GetBuiltinFormat(System.String)">
  17007. <summary>
  17008. Get the format index that matches the given format string
  17009. Automatically Converts "text" to excel's format string to represent text.
  17010. </summary>
  17011. <param name="format">The format string matching a built in format.</param>
  17012. <returns>index of format or -1 if Undefined.</returns>
  17013. </member>
  17014. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.GetFormat(System.String)">
  17015. <summary>
  17016. Get the format index that matches the given format
  17017. string, creating a new format entry if required.
  17018. Aliases text to the proper format as required.
  17019. </summary>
  17020. <param name="pFormat">The format string matching a built in format.</param>
  17021. <returns>index of format.</returns>
  17022. </member>
  17023. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.GetFormat(System.Int16)">
  17024. <summary>
  17025. Get the format string that matches the given format index
  17026. </summary>
  17027. <param name="index">The index of a format.</param>
  17028. <returns>string represented at index of format or null if there Is not a format at that index</returns>
  17029. </member>
  17030. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.GetBuiltinFormat(System.Int16)">
  17031. <summary>
  17032. Get the format string that matches the given format index
  17033. </summary>
  17034. <param name="index">The index of a built in format.</param>
  17035. <returns>string represented at index of format or null if there Is not a builtin format at that index</returns>
  17036. </member>
  17037. <member name="P:NPOI.HSSF.UserModel.HSSFDataFormat.NumberOfBuiltinBuiltinFormats">
  17038. <summary>
  17039. Get the number of builtin and reserved builtinFormats
  17040. </summary>
  17041. <returns>number of builtin and reserved builtinFormats</returns>
  17042. </member>
  17043. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.EnsureFormatsSize(System.Int32)">
  17044. Ensures that the formats list can hold entries
  17045. up to and including the entry with this index
  17046. </member>
  17047. <member name="T:NPOI.HSSF.UserModel.HSSFDataValidation">
  17048. Utility class for creating data validation cells
  17049. @author Dragos Buleandra (dragos.buleandra@trade2b.ro)
  17050. </member>
  17051. <member name="M:NPOI.HSSF.UserModel.HSSFDataValidation.#ctor(NPOI.SS.Util.CellRangeAddressList,NPOI.SS.UserModel.IDataValidationConstraint)">
  17052. Constructor which Initializes the cell range on which this object will be
  17053. applied
  17054. @param constraint
  17055. </member>
  17056. <member name="T:NPOI.HSSF.UserModel.HSSFDataValidationHelper">
  17057. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  17058. </member>
  17059. <member name="T:NPOI.HSSF.UserModel.HSSFDateUtil">
  17060. Contains methods for dealing with Excel dates.
  17061. @author Michael Harhen
  17062. @author Glen Stampoultzis (glens at apache.org)
  17063. @author Dan Sherman (dsherman at isisph.com)
  17064. @author Hack Kampbjorn (hak at 2mba.dk)
  17065. @author Alex Jacoby (ajacoby at gmail.com)
  17066. @author Pavel Krupets (pkrupets at palmtreebusiness dot com)
  17067. </member>
  17068. <member name="T:NPOI.HSSF.UserModel.HSSFEvaluationCell">
  17069. <summary>
  17070. HSSF wrapper for a cell under evaluation
  17071. @author Josh Micich
  17072. </summary>
  17073. </member>
  17074. <member name="T:NPOI.HSSF.UserModel.HSSFEvaluationSheet">
  17075. HSSF wrapper for a sheet under evaluation
  17076. @author Josh Micich
  17077. </member>
  17078. <member name="T:NPOI.HSSF.UserModel.HSSFEvaluationWorkbook">
  17079. Internal POI use only
  17080. @author Josh Micich
  17081. </member>
  17082. <member name="M:NPOI.HSSF.UserModel.HSSFEvaluationWorkbook.GetNameXPtg(System.String,NPOI.SS.Formula.SheetIdentifier)">
  17083. <summary>
  17084. Return an external name (named range, function, user-defined function) Ptg
  17085. </summary>
  17086. <param name="name"></param>
  17087. <param name="sheet"></param>
  17088. <returns></returns>
  17089. </member>
  17090. <member name="T:NPOI.HSSF.UserModel.HSSFExtendedColor">
  17091. The HSSF file format normally stores Color information in the
  17092. Palette (see PaletteRecord), but for a few cases (eg Conditional
  17093. Formatting, Sheet Extensions), this XSSF-style color record
  17094. can be used.
  17095. </member>
  17096. <member name="T:NPOI.HSSF.UserModel.HSSFFont">
  17097. <summary>
  17098. Represents a Font used in a workbook.
  17099. @version 1.0-pre
  17100. @author Andrew C. Oliver
  17101. </summary>
  17102. </member>
  17103. <member name="M:NPOI.HSSF.UserModel.HSSFFont.#ctor(System.Int16,NPOI.HSSF.Record.FontRecord)">
  17104. <summary>
  17105. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFFont"/> class.
  17106. </summary>
  17107. <param name="index">The index.</param>
  17108. <param name="rec">The record.</param>
  17109. </member>
  17110. <member name="P:NPOI.HSSF.UserModel.HSSFFont.FontName">
  17111. <summary>
  17112. Get the name for the font (i.e. Arial)
  17113. </summary>
  17114. <value>the name of the font to use</value>
  17115. </member>
  17116. <member name="P:NPOI.HSSF.UserModel.HSSFFont.Index">
  17117. <summary>
  17118. Get the index within the HSSFWorkbook (sequence within the collection of Font objects)
  17119. </summary>
  17120. <value>Unique index number of the Underlying record this Font represents (probably you don't care
  17121. Unless you're comparing which one is which)</value>
  17122. </member>
  17123. <member name="P:NPOI.HSSF.UserModel.HSSFFont.FontHeight">
  17124. <summary>
  17125. Get or sets the font height in Unit's of 1/20th of a point. Maybe you might want to
  17126. use the GetFontHeightInPoints which matches to the familiar 10, 12, 14 etc..
  17127. </summary>
  17128. <value>height in 1/20ths of a point.</value>
  17129. </member>
  17130. <member name="P:NPOI.HSSF.UserModel.HSSFFont.FontHeightInPoints">
  17131. <summary>
  17132. Gets or sets the font height in points.
  17133. </summary>
  17134. <value>height in the familiar Unit of measure - points.</value>
  17135. </member>
  17136. <member name="P:NPOI.HSSF.UserModel.HSSFFont.IsItalic">
  17137. <summary>
  17138. Gets or sets whether to use italics or not
  17139. </summary>
  17140. <value><c>true</c> if this instance is italic; otherwise, <c>false</c>.</value>
  17141. </member>
  17142. <member name="P:NPOI.HSSF.UserModel.HSSFFont.IsStrikeout">
  17143. <summary>
  17144. Get whether to use a strikeout horizontal line through the text or not
  17145. </summary>
  17146. <value>
  17147. strikeout or not
  17148. </value>
  17149. </member>
  17150. <member name="P:NPOI.HSSF.UserModel.HSSFFont.Color">
  17151. <summary>
  17152. Gets or sets the color for the font.
  17153. </summary>
  17154. <value>The color to use.</value>
  17155. </member>
  17156. <member name="M:NPOI.HSSF.UserModel.HSSFFont.GetHSSFColor(NPOI.HSSF.UserModel.HSSFWorkbook)">
  17157. <summary>
  17158. get the color value for the font
  17159. </summary>
  17160. <param name="wb">HSSFWorkbook</param>
  17161. <returns></returns>
  17162. </member>
  17163. <member name="P:NPOI.HSSF.UserModel.HSSFFont.Boldweight">
  17164. <summary>
  17165. Gets or sets the boldness to use
  17166. </summary>
  17167. <value>The boldweight.</value>
  17168. </member>
  17169. <member name="P:NPOI.HSSF.UserModel.HSSFFont.IsBold">
  17170. get or set if the font bold style
  17171. </member>
  17172. <member name="P:NPOI.HSSF.UserModel.HSSFFont.TypeOffset">
  17173. <summary>
  17174. Gets or sets normal,base or subscript.
  17175. </summary>
  17176. <value>offset type to use (none,base,sub)</value>
  17177. </member>
  17178. <member name="P:NPOI.HSSF.UserModel.HSSFFont.Underline">
  17179. <summary>
  17180. Gets or sets the type of text Underlining to use
  17181. </summary>
  17182. <value>The Underlining type.</value>
  17183. </member>
  17184. <member name="P:NPOI.HSSF.UserModel.HSSFFont.Charset">
  17185. <summary>
  17186. Gets or sets the char set to use.
  17187. </summary>
  17188. <value>The char set.</value>
  17189. </member>
  17190. <member name="M:NPOI.HSSF.UserModel.HSSFFont.ToString">
  17191. <summary>
  17192. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  17193. </summary>
  17194. <returns>
  17195. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  17196. </returns>
  17197. </member>
  17198. <member name="M:NPOI.HSSF.UserModel.HSSFFont.GetHashCode">
  17199. <summary>
  17200. Serves as a hash function for a particular type.
  17201. </summary>
  17202. <returns>
  17203. A hash code for the current <see cref="T:System.Object"/>.
  17204. </returns>
  17205. </member>
  17206. <member name="M:NPOI.HSSF.UserModel.HSSFFont.Equals(System.Object)">
  17207. <summary>
  17208. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
  17209. </summary>
  17210. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
  17211. <returns>
  17212. true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
  17213. </returns>
  17214. <exception cref="T:System.NullReferenceException">
  17215. The <paramref name="obj"/> parameter is null.
  17216. </exception>
  17217. </member>
  17218. <member name="T:NPOI.HSSF.UserModel.HSSFFontFormatting">
  17219. High level representation for Font Formatting component
  17220. of Conditional Formatting Settings
  17221. @author Dmitriy Kumshayev
  17222. </member>
  17223. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.EscapementType">
  17224. Get the type of base or subscript for the font
  17225. @return base or subscript option
  17226. </member>
  17227. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.FontColorIndex">
  17228. @return font color index
  17229. </member>
  17230. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.FontHeight">
  17231. Gets the height of the font in 1/20th point Units
  17232. @return fontheight (in points/20); or -1 if not modified
  17233. </member>
  17234. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.FontWeight">
  17235. Get the font weight for this font (100-1000dec or 0x64-0x3e8). Default Is
  17236. 0x190 for normal and 0x2bc for bold
  17237. @return bw - a number between 100-1000 for the fonts "boldness"
  17238. </member>
  17239. <member name="M:NPOI.HSSF.UserModel.HSSFFontFormatting.GetRawRecord">
  17240. @return
  17241. @see org.apache.poi.hssf.record.cf.FontFormatting#GetRawRecord()
  17242. </member>
  17243. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.UnderlineType">
  17244. Get the type of Underlining for the font
  17245. @return font Underlining type
  17246. @see #U_NONE
  17247. @see #U_SINGLE
  17248. @see #U_DOUBLE
  17249. @see #U_SINGLE_ACCOUNTING
  17250. @see #U_DOUBLE_ACCOUNTING
  17251. </member>
  17252. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsBold">
  17253. Get whether the font weight Is Set to bold or not
  17254. @return bold - whether the font Is bold or not
  17255. </member>
  17256. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsEscapementTypeModified">
  17257. @return true if escapement type was modified from default
  17258. </member>
  17259. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsFontCancellationModified">
  17260. @return true if font cancellation was modified from default
  17261. </member>
  17262. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsFontOutlineModified">
  17263. @return true if font outline type was modified from default
  17264. </member>
  17265. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsFontShadowModified">
  17266. @return true if font shadow type was modified from default
  17267. </member>
  17268. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsFontStyleModified">
  17269. @return true if font style was modified from default
  17270. </member>
  17271. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsItalic">
  17272. @return true if font style was Set to <i>italic</i>
  17273. </member>
  17274. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsOutlineOn">
  17275. @return true if font outline Is on
  17276. </member>
  17277. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsShadowOn">
  17278. @return true if font shadow Is on
  17279. </member>
  17280. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsStrikeout">
  17281. @return true if font strikeout Is on
  17282. </member>
  17283. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsUnderlineTypeModified">
  17284. @return true if font Underline type was modified from default
  17285. </member>
  17286. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsFontWeightModified">
  17287. @return true if font weight was modified from default
  17288. </member>
  17289. <member name="M:NPOI.HSSF.UserModel.HSSFFontFormatting.SetFontStyle(System.Boolean,System.Boolean)">
  17290. Set font style options.
  17291. @param italic - if true, Set posture style to italic, otherwise to normal
  17292. @param bold- if true, Set font weight to bold, otherwise to normal
  17293. </member>
  17294. <member name="M:NPOI.HSSF.UserModel.HSSFFontFormatting.ResetFontStyle">
  17295. Set font style options to default values (non-italic, non-bold)
  17296. </member>
  17297. <member name="T:NPOI.HSSF.UserModel.HSSFFooter">
  17298. <summary>
  17299. Class to Read and manipulate the footer.
  17300. The footer works by having a left, center, and right side. The total cannot
  17301. be more that 255 bytes long. One uses this class by Getting the HSSFFooter
  17302. from HSSFSheet and then Getting or Setting the left, center, and right side.
  17303. For special things (such as page numbers and date), one can use a the methods
  17304. that return the Chars used to represent these. One can also Change the
  17305. fonts by using similar methods.
  17306. @author Shawn Laubach (slaubach at apache dot org)
  17307. </summary>
  17308. </member>
  17309. <member name="M:NPOI.HSSF.UserModel.HSSFFooter.#ctor(NPOI.HSSF.Record.Aggregates.PageSettingsBlock)">
  17310. <summary>
  17311. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFFooter"/> class.
  17312. </summary>
  17313. <param name="psb">Footer record to create the footer with</param>
  17314. </member>
  17315. <member name="P:NPOI.HSSF.UserModel.HSSFFooter.RawText">
  17316. <summary>
  17317. Gets the raw footer.
  17318. </summary>
  17319. <value>The raw footer.</value>
  17320. </member>
  17321. <member name="T:NPOI.HSSF.UserModel.HSSFFormulaEvaluator">
  17322. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  17323. </member>
  17324. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.#ctor(NPOI.SS.UserModel.IWorkbook,NPOI.SS.Formula.IStabilityClassifier)">
  17325. @param stabilityClassifier used to optimise caching performance. Pass <code>null</code>
  17326. for the (conservative) assumption that any cell may have its definition changed after
  17327. evaluation begins.
  17328. </member>
  17329. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.#ctor(NPOI.SS.UserModel.IWorkbook,NPOI.SS.Formula.IStabilityClassifier,NPOI.SS.Formula.UDF.UDFFinder)">
  17330. @param udfFinder pass <code>null</code> for default (AnalysisToolPak only)
  17331. </member>
  17332. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.Create(NPOI.SS.UserModel.IWorkbook,NPOI.SS.Formula.IStabilityClassifier,NPOI.SS.Formula.UDF.UDFFinder)">
  17333. @param stabilityClassifier used to optimise caching performance. Pass <code>null</code>
  17334. for the (conservative) assumption that any cell may have its definition changed after
  17335. evaluation begins.
  17336. @param udfFinder pass <code>null</code> for default (AnalysisToolPak only)
  17337. </member>
  17338. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.SetupEnvironment(System.String[],NPOI.HSSF.UserModel.HSSFFormulaEvaluator[])">
  17339. Coordinates several formula evaluators together so that formulas that involve external
  17340. references can be evaluated.
  17341. @param workbookNames the simple file names used to identify the workbooks in formulas
  17342. with external links (for example "MyData.xls" as used in a formula "[MyData.xls]Sheet1!A1")
  17343. @param evaluators all evaluators for the full set of workbooks required by the formulas.
  17344. </member>
  17345. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.NotifyUpdateCell(NPOI.SS.UserModel.ICell)">
  17346. Should be called to tell the cell value cache that the specified (value or formula) cell
  17347. has changed.
  17348. Failure to call this method after changing cell values will cause incorrect behaviour
  17349. of the evaluate~ methods of this class
  17350. </member>
  17351. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.NotifyDeleteCell(NPOI.SS.UserModel.ICell)">
  17352. Should be called to tell the cell value cache that the specified cell has just been
  17353. deleted.
  17354. Failure to call this method after changing cell values will cause incorrect behaviour
  17355. of the evaluate~ methods of this class
  17356. </member>
  17357. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.NotifySetFormula(NPOI.SS.UserModel.ICell)">
  17358. Should be called to tell the cell value cache that the specified (value or formula) cell
  17359. has changed.
  17360. Failure to call this method after changing cell values will cause incorrect behaviour
  17361. of the evaluate~ methods of this class
  17362. </member>
  17363. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.EvaluateFormulaCellValue(NPOI.SS.UserModel.ICell)">
  17364. Returns a CellValue wrapper around the supplied ValueEval instance.
  17365. @param cell
  17366. </member>
  17367. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.EvaluateInCell(NPOI.SS.UserModel.ICell)">
  17368. If cell Contains formula, it Evaluates the formula, and
  17369. puts the formula result back into the cell, in place
  17370. of the old formula.
  17371. Else if cell does not contain formula, this method leaves
  17372. the cell UnChanged.
  17373. Note that the same instance of Cell is returned to
  17374. allow chained calls like:
  17375. <pre>
  17376. int EvaluatedCellType = evaluator.EvaluateInCell(cell).CellType;
  17377. </pre>
  17378. Be aware that your cell value will be Changed to hold the
  17379. result of the formula. If you simply want the formula
  17380. value computed for you, use {@link #EvaluateFormulaCell(HSSFCell)}
  17381. @param cell
  17382. </member>
  17383. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.EvaluateAllFormulaCells(NPOI.HSSF.UserModel.HSSFWorkbook)">
  17384. Loops over all cells in all sheets of the supplied
  17385. workbook.
  17386. For cells that contain formulas, their formulas are
  17387. Evaluated, and the results are saved. These cells
  17388. remain as formula cells.
  17389. For cells that do not contain formulas, no Changes
  17390. are made.
  17391. This is a helpful wrapper around looping over all
  17392. cells, and calling EvaluateFormulaCell on each one.
  17393. </member>
  17394. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.EvaluateAllFormulaCells(NPOI.SS.UserModel.IWorkbook)">
  17395. Loops over all cells in all sheets of the supplied
  17396. workbook.
  17397. For cells that contain formulas, their formulas are
  17398. evaluated, and the results are saved. These cells
  17399. remain as formula cells.
  17400. For cells that do not contain formulas, no changes
  17401. are made.
  17402. This is a helpful wrapper around looping over all
  17403. cells, and calling evaluateFormulaCell on each one.
  17404. </member>
  17405. <member name="T:NPOI.HSSF.UserModel.HSSFHeader">
  17406. <summary>
  17407. Class to Read and manipulate the header.
  17408. The header works by having a left, center, and right side. The total cannot
  17409. be more that 255 bytes long. One uses this class by Getting the HSSFHeader
  17410. from HSSFSheet and then Getting or Setting the left, center, and right side.
  17411. For special things (such as page numbers and date), one can use a the methods
  17412. that return the Chars used to represent these. One can also Change the
  17413. fonts by using similar methods.
  17414. @author Shawn Laubach (slaubach at apache dot org)
  17415. </summary>
  17416. </member>
  17417. <member name="M:NPOI.HSSF.UserModel.HSSFHeader.#ctor(NPOI.HSSF.Record.Aggregates.PageSettingsBlock)">
  17418. <summary>
  17419. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFFooter"/> class.
  17420. </summary>
  17421. <param name="psb">Footer record to Create the footer with</param>
  17422. </member>
  17423. <member name="P:NPOI.HSSF.UserModel.HSSFHeader.RawText">
  17424. <summary>
  17425. Gets the raw footer.
  17426. </summary>
  17427. <value>The raw footer.</value>
  17428. </member>
  17429. <member name="T:NPOI.HSSF.UserModel.HSSFHyperlink">
  17430. <summary>
  17431. Represents an Excel hyperlink.
  17432. </summary>
  17433. <remarks>@author Yegor Kozlov (yegor at apache dot org)</remarks>
  17434. </member>
  17435. <member name="F:NPOI.HSSF.UserModel.HSSFHyperlink.record">
  17436. Low-level record object that stores the actual hyperlink data
  17437. </member>
  17438. <member name="F:NPOI.HSSF.UserModel.HSSFHyperlink.link_type">
  17439. If we Create a new hypelrink remember its type
  17440. </member>
  17441. <member name="M:NPOI.HSSF.UserModel.HSSFHyperlink.#ctor(NPOI.SS.UserModel.HyperlinkType)">
  17442. <summary>
  17443. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFHyperlink"/> class.
  17444. </summary>
  17445. <param name="type">The type of hyperlink to Create.</param>
  17446. </member>
  17447. <member name="M:NPOI.HSSF.UserModel.HSSFHyperlink.#ctor(NPOI.HSSF.Record.HyperlinkRecord)">
  17448. <summary>
  17449. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFHyperlink"/> class.
  17450. </summary>
  17451. <param name="record">The record.</param>
  17452. </member>
  17453. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.FirstRow">
  17454. <summary>
  17455. Gets or sets the row of the first cell that Contains the hyperlink
  17456. </summary>
  17457. <value>the 0-based row of the cell that Contains the hyperlink.</value>
  17458. </member>
  17459. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.LastRow">
  17460. <summary>
  17461. Gets or sets the row of the last cell that Contains the hyperlink
  17462. </summary>
  17463. <value>the 0-based row of the last cell that Contains the hyperlink</value>
  17464. </member>
  17465. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.FirstColumn">
  17466. <summary>
  17467. Gets or sets the column of the first cell that Contains the hyperlink
  17468. </summary>
  17469. <value>the 0-based column of the first cell that Contains the hyperlink</value>
  17470. </member>
  17471. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.LastColumn">
  17472. <summary>
  17473. Gets or sets the column of the last cell that Contains the hyperlink
  17474. </summary>
  17475. <value>the 0-based column of the last cell that Contains the hyperlink</value>
  17476. </member>
  17477. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.Address">
  17478. <summary>
  17479. Gets or sets Hypelink Address. Depending on the hyperlink type it can be URL, e-mail, patrh to a file, etc.
  17480. </summary>
  17481. <value>the Address of this hyperlink</value>
  17482. </member>
  17483. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.TextMark">
  17484. <summary>
  17485. Gets or sets the text mark.
  17486. </summary>
  17487. <value>The text mark.</value>
  17488. </member>
  17489. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.ShortFilename">
  17490. <summary>
  17491. Gets or sets the short filename.
  17492. </summary>
  17493. <value>The short filename.</value>
  17494. </member>
  17495. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.Label">
  17496. <summary>
  17497. Gets or sets the text label for this hyperlink
  17498. </summary>
  17499. <value>text to Display</value>
  17500. </member>
  17501. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.Type">
  17502. <summary>
  17503. Gets the type of this hyperlink
  17504. </summary>
  17505. <value>the type of this hyperlink</value>
  17506. </member>
  17507. <member name="M:NPOI.HSSF.UserModel.HSSFHyperlink.Equals(System.Object)">
  17508. @return whether the objects have the same HyperlinkRecord
  17509. </member>
  17510. <member name="T:NPOI.HSSF.UserModel.HSSFIconMultiStateFormatting">
  17511. High level representation for Icon / Multi-State Formatting
  17512. component of Conditional Formatting Settings
  17513. </member>
  17514. <member name="T:NPOI.HSSF.UserModel.HSSFName">
  17515. <summary>
  17516. High Level Represantion of Named Range
  17517. </summary>
  17518. <remarks>@author Libin Roman (Vista Portal LDT. Developer)</remarks>
  17519. </member>
  17520. <member name="M:NPOI.HSSF.UserModel.HSSFName.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.Record.NameRecord,NPOI.HSSF.Record.NameCommentRecord)">
  17521. <summary>
  17522. Creates new HSSFName - called by HSSFWorkbook to Create a sheet from
  17523. scratch.
  17524. </summary>
  17525. <param name="book">lowlevel Workbook object associated with the sheet.</param>
  17526. <param name="name">the Name Record</param>
  17527. <param name="comment"></param>
  17528. </member>
  17529. <member name="P:NPOI.HSSF.UserModel.HSSFName.SheetName">
  17530. <summary>
  17531. Gets or sets the sheets name which this named range is referenced to
  17532. </summary>
  17533. <value>sheet name, which this named range refered to</value>
  17534. </member>
  17535. <member name="P:NPOI.HSSF.UserModel.HSSFName.NameName">
  17536. <summary>
  17537. Gets or sets the name of the named range
  17538. </summary>
  17539. <value>named range name</value>
  17540. </member>
  17541. <member name="P:NPOI.HSSF.UserModel.HSSFName.SheetIndex">
  17542. Returns the sheet index this name applies to.
  17543. @return the sheet index this name applies to, -1 if this name applies to the entire workbook
  17544. </member>
  17545. <member name="M:NPOI.HSSF.UserModel.HSSFName.SetNameDefinition(NPOI.SS.Formula.PTG.Ptg[])">
  17546. <summary>
  17547. Sets the NameParsedFormula structure that specifies the formula for the defined name.
  17548. </summary>
  17549. <param name="ptgs">the sequence of {@link Ptg}s for the formula.</param>
  17550. </member>
  17551. <member name="P:NPOI.HSSF.UserModel.HSSFName.IsDeleted">
  17552. <summary>
  17553. Tests if this name points to a cell that no longer exists
  17554. </summary>
  17555. <value>
  17556. <c>true</c> if the name refers to a deleted cell; otherwise, <c>false</c>.
  17557. </value>
  17558. </member>
  17559. <member name="P:NPOI.HSSF.UserModel.HSSFName.IsFunctionName">
  17560. <summary>
  17561. Gets a value indicating whether this instance is function name.
  17562. </summary>
  17563. <value>
  17564. <c>true</c> if this instance is function name; otherwise, <c>false</c>.
  17565. </value>
  17566. </member>
  17567. <member name="M:NPOI.HSSF.UserModel.HSSFName.SetFunction(System.Boolean)">
  17568. Indicates that the defined name refers to a user-defined function.
  17569. This attribute is used when there is an add-in or other code project associated with the file.
  17570. @param value <c>true</c> indicates the name refers to a function.
  17571. </member>
  17572. <member name="M:NPOI.HSSF.UserModel.HSSFName.ToString">
  17573. <summary>
  17574. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  17575. </summary>
  17576. <returns>
  17577. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  17578. </returns>
  17579. </member>
  17580. <member name="T:NPOI.HSSF.UserModel.HSSFObjectData">
  17581. Represents binary object (i.e. OLE) data stored in the file. Eg. A GIF, JPEG etc...
  17582. @author Daniel Noll
  17583. </member>
  17584. <member name="F:NPOI.HSSF.UserModel.HSSFObjectData._root">
  17585. Reference to the filesystem root, required for retrieving the object data.
  17586. </member>
  17587. <member name="P:NPOI.HSSF.UserModel.HSSFObjectData.OLE2ClassName">
  17588. Returns the OLE2 Class Name of the object
  17589. </member>
  17590. <member name="M:NPOI.HSSF.UserModel.HSSFObjectData.GetDirectory">
  17591. Gets the object data. Only call for ones that have
  17592. data though. See {@link #hasDirectoryEntry()}
  17593. @return the object data as an OLE2 directory.
  17594. @ if there was an error Reading the data.
  17595. </member>
  17596. <member name="M:NPOI.HSSF.UserModel.HSSFObjectData.GetObjectData">
  17597. Returns the data portion, for an ObjectData
  17598. that doesn't have an associated POIFS Directory
  17599. Entry
  17600. </member>
  17601. <member name="M:NPOI.HSSF.UserModel.HSSFObjectData.HasDirectoryEntry">
  17602. Does this ObjectData have an associated POIFS
  17603. Directory Entry?
  17604. (Not all do, those that don't have a data portion)
  17605. </member>
  17606. <member name="M:NPOI.HSSF.UserModel.HSSFObjectData.FindObjectRecord">
  17607. Finds the EmbeddedObjectRefSubRecord, or throws an
  17608. Exception if there wasn't one
  17609. </member>
  17610. <member name="T:NPOI.HSSF.UserModel.HSSFPalette">
  17611. <summary>
  17612. Represents a workbook color palette.
  17613. Internally, the XLS format refers to colors using an offset into the palette
  17614. record. Thus, the first color in the palette has the index 0x8, the second
  17615. has the index 0x9, etc. through 0x40
  17616. @author Brian Sanders (bsanders at risklabs dot com)
  17617. </summary>
  17618. </member>
  17619. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.GetColor(System.Int16)">
  17620. <summary>
  17621. Retrieves the color at a given index
  17622. </summary>
  17623. <param name="index">the palette index, between 0x8 to 0x40 inclusive.</param>
  17624. <returns>the color, or null if the index Is not populated</returns>
  17625. </member>
  17626. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.FindColor(System.Byte,System.Byte,System.Byte)">
  17627. <summary>
  17628. Finds the first occurance of a given color
  17629. </summary>
  17630. <param name="red">the RGB red component, between 0 and 255 inclusive</param>
  17631. <param name="green">the RGB green component, between 0 and 255 inclusive</param>
  17632. <param name="blue">the RGB blue component, between 0 and 255 inclusive</param>
  17633. <returns>the color, or null if the color does not exist in this palette</returns>
  17634. </member>
  17635. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.FindSimilarColor(System.Byte,System.Byte,System.Byte)">
  17636. <summary>
  17637. Finds the closest matching color in the custom palette. The
  17638. method for Finding the distance between the colors Is fairly
  17639. primative.
  17640. </summary>
  17641. <param name="red">The red component of the color to match.</param>
  17642. <param name="green">The green component of the color to match.</param>
  17643. <param name="blue">The blue component of the color to match.</param>
  17644. <returns>The closest color or null if there are no custom
  17645. colors currently defined.</returns>
  17646. </member>
  17647. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.SetColorAtIndex(System.Int16,System.Byte,System.Byte,System.Byte)">
  17648. <summary>
  17649. Sets the color at the given offset
  17650. </summary>
  17651. <param name="index">the palette index, between 0x8 to 0x40 inclusive</param>
  17652. <param name="red">the RGB red component, between 0 and 255 inclusive</param>
  17653. <param name="green">the RGB green component, between 0 and 255 inclusive</param>
  17654. <param name="blue">the RGB blue component, between 0 and 255 inclusive</param>
  17655. </member>
  17656. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.AddColor(System.Byte,System.Byte,System.Byte)">
  17657. <summary>
  17658. Adds a new color into an empty color slot.
  17659. </summary>
  17660. <param name="red">The red component</param>
  17661. <param name="green">The green component</param>
  17662. <param name="blue">The blue component</param>
  17663. <returns>The new custom color.</returns>
  17664. </member>
  17665. <member name="T:NPOI.HSSF.UserModel.HSSFPalette.CustomColor">
  17666. <summary>
  17667. user custom color
  17668. </summary>
  17669. </member>
  17670. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.#ctor(System.Int16,System.Byte[])">
  17671. <summary>
  17672. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFPalette.CustomColor"/> class.
  17673. </summary>
  17674. <param name="byteOffset">The byte offset.</param>
  17675. <param name="colors">The colors.</param>
  17676. </member>
  17677. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.#ctor(System.Int16,System.Byte,System.Byte,System.Byte)">
  17678. <summary>
  17679. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFPalette.CustomColor"/> class.
  17680. </summary>
  17681. <param name="byteOffset">The byte offset.</param>
  17682. <param name="red">The red.</param>
  17683. <param name="green">The green.</param>
  17684. <param name="blue">The blue.</param>
  17685. </member>
  17686. <member name="P:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.Indexed">
  17687. <summary>
  17688. Gets index to the standard palette
  17689. </summary>
  17690. <value></value>
  17691. </member>
  17692. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.GetTriplet">
  17693. <summary>
  17694. Gets triplet representation like that in Excel
  17695. </summary>
  17696. <value></value>
  17697. </member>
  17698. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.GetHexString">
  17699. <summary>
  17700. Gets a hex string exactly like a gnumeric triplet
  17701. </summary>
  17702. <value></value>
  17703. </member>
  17704. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.GetGnumericPart(System.Byte)">
  17705. <summary>
  17706. Gets the gnumeric part.
  17707. </summary>
  17708. <param name="color">The color.</param>
  17709. <returns></returns>
  17710. </member>
  17711. <member name="T:NPOI.HSSF.UserModel.HSSFPatriarch">
  17712. <summary>
  17713. The patriarch is the toplevel container for shapes in a sheet. It does
  17714. little other than act as a container for other shapes and Groups.
  17715. @author Glen Stampoultzis (glens at apache.org)
  17716. </summary>
  17717. </member>
  17718. <member name="F:NPOI.HSSF.UserModel.HSSFPatriarch._boundAggregate">
  17719. The EscherAggregate we have been bound to.
  17720. (This will handle writing us out into records,
  17721. and building up our shapes from the records)
  17722. </member>
  17723. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.#ctor(NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.Record.EscherAggregate)">
  17724. <summary>
  17725. Creates the patriarch.
  17726. </summary>
  17727. <param name="sheet">the sheet this patriarch is stored in.</param>
  17728. <param name="boundAggregate">The bound aggregate.</param>
  17729. </member>
  17730. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.PreSerialize">
  17731. check if any shapes contain wrong data
  17732. At now(13.08.2010) check if patriarch contains 2 or more comments with same coordinates
  17733. </member>
  17734. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.RemoveShape(NPOI.HSSF.UserModel.HSSFShape)">
  17735. @param shape to be removed
  17736. @return true of shape is removed
  17737. </member>
  17738. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateGroup(NPOI.HSSF.UserModel.HSSFClientAnchor)">
  17739. <summary>
  17740. Creates a new Group record stored Under this patriarch.
  17741. </summary>
  17742. <param name="anchor">the client anchor describes how this Group is attached
  17743. to the sheet.</param>
  17744. <returns>the newly created Group.</returns>
  17745. </member>
  17746. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateSimpleShape(NPOI.HSSF.UserModel.HSSFClientAnchor)">
  17747. <summary>
  17748. Creates a simple shape. This includes such shapes as lines, rectangles,
  17749. and ovals.
  17750. Note: Microsoft Excel seems to sometimes disallow
  17751. higher y1 than y2 or higher x1 than x2 in the anchor, you might need to
  17752. reverse them and draw shapes vertically or horizontally flipped!
  17753. </summary>
  17754. <param name="anchor">the client anchor describes how this Group is attached
  17755. to the sheet.</param>
  17756. <returns>the newly created shape.</returns>
  17757. </member>
  17758. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreatePicture(NPOI.HSSF.UserModel.HSSFClientAnchor,System.Int32)">
  17759. <summary>
  17760. Creates a picture.
  17761. </summary>
  17762. <param name="anchor">the client anchor describes how this Group is attached
  17763. to the sheet.</param>
  17764. <param name="pictureIndex">Index of the picture.</param>
  17765. <returns>the newly created shape.</returns>
  17766. </member>
  17767. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreatePicture(NPOI.SS.UserModel.IClientAnchor,System.Int32)">
  17768. <summary>
  17769. CreatePicture
  17770. </summary>
  17771. <param name="anchor">the client anchor describes how this picture is attached to the sheet.</param>
  17772. <param name="pictureIndex">the index of the picture in the workbook collection of pictures.</param>
  17773. <returns>return newly created shape</returns>
  17774. </member>
  17775. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateObjectData(NPOI.HSSF.UserModel.HSSFClientAnchor,System.Int32,System.Int32)">
  17776. Adds a new OLE Package Shape
  17777. @param anchor the client anchor describes how this picture is
  17778. attached to the sheet.
  17779. @param storageId the storageId returned by {@Link HSSFWorkbook.AddOlePackage}
  17780. @param pictureIndex the index of the picture (used as preview image) in the
  17781. workbook collection of pictures.
  17782. @return newly Created shape
  17783. </member>
  17784. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreatePolygon(NPOI.SS.UserModel.IClientAnchor)">
  17785. <summary>
  17786. Creates a polygon
  17787. </summary>
  17788. <param name="anchor">the client anchor describes how this Group is attached
  17789. to the sheet.</param>
  17790. <returns>the newly Created shape.</returns>
  17791. </member>
  17792. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateTextbox(NPOI.SS.UserModel.IClientAnchor)">
  17793. <summary>
  17794. Constructs a textbox Under the patriarch.
  17795. </summary>
  17796. <param name="anchor">the client anchor describes how this Group is attached
  17797. to the sheet.</param>
  17798. <returns>the newly Created textbox.</returns>
  17799. </member>
  17800. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateComment(NPOI.HSSF.UserModel.HSSFAnchor)">
  17801. Constructs a cell comment.
  17802. @param anchor the client anchor describes how this comment is attached
  17803. to the sheet.
  17804. @return the newly created comment.
  17805. </member>
  17806. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateComboBox(NPOI.HSSF.UserModel.HSSFAnchor)">
  17807. YK: used to create autofilters
  17808. @see org.apache.poi.hssf.usermodel.HSSFSheet#setAutoFilter(int, int, int, int)
  17809. </member>
  17810. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateCellComment(NPOI.SS.UserModel.IClientAnchor)">
  17811. <summary>
  17812. Constructs a cell comment.
  17813. </summary>
  17814. <param name="anchor">the client anchor describes how this comment is attached
  17815. to the sheet.</param>
  17816. <returns>the newly created comment.</returns>
  17817. </member>
  17818. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.Children">
  17819. <summary>
  17820. Returns a list of all shapes contained by the patriarch.
  17821. </summary>
  17822. <value>The children.</value>
  17823. </member>
  17824. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.AddShape(NPOI.HSSF.UserModel.HSSFShape)">
  17825. add a shape to this drawing
  17826. </member>
  17827. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.CountOfAllChildren">
  17828. <summary>
  17829. Total count of all children and their children's children.
  17830. </summary>
  17831. <value>The count of all children.</value>
  17832. </member>
  17833. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.SetCoordinates(System.Int32,System.Int32,System.Int32,System.Int32)">
  17834. <summary>
  17835. Sets the coordinate space of this Group. All children are contrained
  17836. to these coordinates.
  17837. </summary>
  17838. <param name="x1">The x1.</param>
  17839. <param name="y1">The y1.</param>
  17840. <param name="x2">The x2.</param>
  17841. <param name="y2">The y2.</param>
  17842. </member>
  17843. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.ContainsChart">
  17844. <summary>
  17845. Does this HSSFPatriarch contain a chart?
  17846. (Technically a reference to a chart, since they
  17847. Get stored in a different block of records)
  17848. FIXME - detect chart in all cases (only seems
  17849. to work on some charts so far)
  17850. </summary>
  17851. <returns>
  17852. <c>true</c> if this instance contains chart; otherwise, <c>false</c>.
  17853. </returns>
  17854. </member>
  17855. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.X1">
  17856. <summary>
  17857. The top left x coordinate of this Group.
  17858. </summary>
  17859. <value>The x1.</value>
  17860. </member>
  17861. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.Y1">
  17862. <summary>
  17863. The top left y coordinate of this Group.
  17864. </summary>
  17865. <value>The y1.</value>
  17866. </member>
  17867. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.X2">
  17868. <summary>
  17869. The bottom right x coordinate of this Group.
  17870. </summary>
  17871. <value>The x2.</value>
  17872. </member>
  17873. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.Y2">
  17874. <summary>
  17875. The bottom right y coordinate of this Group.
  17876. </summary>
  17877. <value>The y2.</value>
  17878. </member>
  17879. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.GetBoundAggregate">
  17880. <summary>
  17881. Returns the aggregate escher record we're bound to
  17882. </summary>
  17883. <returns></returns>
  17884. </member>
  17885. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateAnchor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  17886. Creates a new client anchor and sets the top-left and bottom-right
  17887. coordinates of the anchor.
  17888. @param dx1 the x coordinate in EMU within the first cell.
  17889. @param dy1 the y coordinate in EMU within the first cell.
  17890. @param dx2 the x coordinate in EMU within the second cell.
  17891. @param dy2 the y coordinate in EMU within the second cell.
  17892. @param col1 the column (0 based) of the first cell.
  17893. @param row1 the row (0 based) of the first cell.
  17894. @param col2 the column (0 based) of the second cell.
  17895. @param row2 the row (0 based) of the second cell.
  17896. @return the newly created client anchor
  17897. </member>
  17898. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.BuildShapeTree">
  17899. create shape tree from existing escher records tree
  17900. </member>
  17901. <member name="T:NPOI.HSSF.UserModel.HSSFPatternFormatting">
  17902. <summary>
  17903. High level representation for Conditional Formatting Settings
  17904. @author Dmitriy Kumshayev
  17905. </summary>
  17906. </member>
  17907. <member name="M:NPOI.HSSF.UserModel.HSSFPatternFormatting.#ctor(NPOI.HSSF.Record.CFRuleBase,NPOI.HSSF.UserModel.HSSFWorkbook)">
  17908. <summary>
  17909. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFPatternFormatting"/> class.
  17910. </summary>
  17911. <param name="cfRuleRecord">The cf rule record.</param>
  17912. <param name="workbook"></param>
  17913. </member>
  17914. <member name="P:NPOI.HSSF.UserModel.HSSFPatternFormatting.PatternFormattingBlock">
  17915. <summary>
  17916. Gets the pattern formatting block.
  17917. </summary>
  17918. <value>The pattern formatting block.</value>
  17919. </member>
  17920. <member name="P:NPOI.HSSF.UserModel.HSSFPatternFormatting.FillBackgroundColor">
  17921. <summary>
  17922. Gets or sets the color of the fill background.
  17923. </summary>
  17924. <value>The color of the fill background.</value>
  17925. </member>
  17926. <member name="P:NPOI.HSSF.UserModel.HSSFPatternFormatting.FillForegroundColor">
  17927. <summary>
  17928. Gets or sets the color of the fill foreground.
  17929. </summary>
  17930. <value>The color of the fill foreground.</value>
  17931. </member>
  17932. <member name="P:NPOI.HSSF.UserModel.HSSFPatternFormatting.FillPattern">
  17933. <summary>
  17934. Gets or sets the fill pattern.
  17935. </summary>
  17936. <value>The fill pattern.</value>
  17937. </member>
  17938. <member name="T:NPOI.HSSF.UserModel.HSSFPicture">
  17939. <summary>
  17940. Represents a escher picture. Eg. A GIF, JPEG etc...
  17941. @author Glen Stampoultzis
  17942. @author Yegor Kozlov (yegor at apache.org)
  17943. </summary>
  17944. </member>
  17945. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.#ctor(NPOI.HSSF.UserModel.HSSFShape,NPOI.HSSF.UserModel.HSSFAnchor)">
  17946. <summary>
  17947. Constructs a picture object.
  17948. </summary>
  17949. <param name="parent">The parent.</param>
  17950. <param name="anchor">The anchor.</param>
  17951. </member>
  17952. <member name="P:NPOI.HSSF.UserModel.HSSFPicture.PictureIndex">
  17953. <summary>
  17954. Gets or sets the index of the picture.
  17955. </summary>
  17956. <value>The index of the picture.</value>
  17957. </member>
  17958. <member name="P:NPOI.HSSF.UserModel.HSSFPicture.PictureData">
  17959. Return picture data for this shape
  17960. @return picture data for this shape
  17961. </member>
  17962. <member name="P:NPOI.HSSF.UserModel.HSSFPicture.FileName">
  17963. The color applied to the lines of this shape.
  17964. </member>
  17965. <member name="P:NPOI.HSSF.UserModel.HSSFPicture.ClientAnchor">
  17966. @return the anchor that is used by this picture.
  17967. </member>
  17968. <member name="P:NPOI.HSSF.UserModel.HSSFPicture.Sheet">
  17969. @return the sheet which contains the picture shape
  17970. </member>
  17971. <member name="T:NPOI.HSSF.UserModel.HSSFPictureData">
  17972. <summary>
  17973. Represents binary data stored in the file. Eg. A GIF, JPEG etc...
  17974. @author Daniel Noll
  17975. </summary>
  17976. </member>
  17977. <member name="F:NPOI.HSSF.UserModel.HSSFPictureData.blip">
  17978. Underlying escher blip record containing the bitmap data.
  17979. </member>
  17980. <member name="M:NPOI.HSSF.UserModel.HSSFPictureData.#ctor(NPOI.DDF.EscherBlipRecord)">
  17981. <summary>
  17982. Constructs a picture object.
  17983. </summary>
  17984. <param name="blip">the underlying blip record containing the bitmap data.</param>
  17985. </member>
  17986. <member name="P:NPOI.HSSF.UserModel.HSSFPictureData.Data">
  17987. <summary>
  17988. Gets the picture data.
  17989. </summary>
  17990. <value>the picture data.</value>
  17991. </member>
  17992. <member name="P:NPOI.HSSF.UserModel.HSSFPictureData.Format">
  17993. <summary>
  17994. gets format of the picture.
  17995. </summary>
  17996. <value>The format.</value>
  17997. </member>
  17998. <member name="M:NPOI.HSSF.UserModel.HSSFPictureData.SuggestFileExtension">
  17999. <summary>
  18000. Suggests a file extension for this image.
  18001. </summary>
  18002. <returns>the file extension.</returns>
  18003. </member>
  18004. <member name="P:NPOI.HSSF.UserModel.HSSFPictureData.MimeType">
  18005. Returns the mime type for the image
  18006. </member>
  18007. <member name="P:NPOI.HSSF.UserModel.HSSFPictureData.PictureType">
  18008. @return the POI internal image type, -1 if not unknown image type
  18009. @see Workbook#PICTURE_TYPE_DIB
  18010. @see Workbook#PICTURE_TYPE_EMF
  18011. @see Workbook#PICTURE_TYPE_JPEG
  18012. @see Workbook#PICTURE_TYPE_PICT
  18013. @see Workbook#PICTURE_TYPE_PNG
  18014. @see Workbook#PICTURE_TYPE_WMF
  18015. </member>
  18016. <member name="T:NPOI.HSSF.UserModel.HSSFPolygon">
  18017. <summary>
  18018. @author Glen Stampoultzis (glens at baselinksoftware.com)
  18019. </summary>
  18020. </member>
  18021. <member name="M:NPOI.HSSF.UserModel.HSSFPolygon.CreateSpContainer">
  18022. Generates the shape records for this shape.
  18023. </member>
  18024. <member name="M:NPOI.HSSF.UserModel.HSSFPolygon.CreateObjRecord">
  18025. Creates the low level OBJ record for this shape.
  18026. </member>
  18027. <member name="P:NPOI.HSSF.UserModel.HSSFPolygon.XPoints">
  18028. @return array of x coordinates
  18029. </member>
  18030. <member name="P:NPOI.HSSF.UserModel.HSSFPolygon.YPoints">
  18031. @return array of y coordinates
  18032. </member>
  18033. <member name="M:NPOI.HSSF.UserModel.HSSFPolygon.SetPoints(System.Int32[],System.Int32[])">
  18034. @param xPoints - array of x coordinates
  18035. @param yPoints - array of y coordinates
  18036. </member>
  18037. <member name="M:NPOI.HSSF.UserModel.HSSFPolygon.SetPolygonDrawArea(System.Int32,System.Int32)">
  18038. Defines the width and height of the points in the polygon
  18039. @param width
  18040. @param height
  18041. </member>
  18042. <member name="P:NPOI.HSSF.UserModel.HSSFPolygon.DrawAreaWidth">
  18043. @return shape width
  18044. </member>
  18045. <member name="P:NPOI.HSSF.UserModel.HSSFPolygon.DrawAreaHeight">
  18046. @return shape height
  18047. </member>
  18048. <member name="T:NPOI.HSSF.UserModel.HSSFPrintSetup">
  18049. <summary>
  18050. Used to modify the print Setup.
  18051. @author Shawn Laubach (slaubach at apache dot org)
  18052. </summary>
  18053. </member>
  18054. <member name="M:NPOI.HSSF.UserModel.HSSFPrintSetup.#ctor(NPOI.HSSF.Record.PrintSetupRecord)">
  18055. <summary>
  18056. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFPrintSetup"/> class.
  18057. </summary>
  18058. <param name="printSetupRecord">Takes the low level print Setup record.</param>
  18059. </member>
  18060. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.PaperSize">
  18061. <summary>
  18062. Gets or sets the size of the paper.
  18063. </summary>
  18064. <value>The size of the paper.</value>
  18065. </member>
  18066. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Scale">
  18067. <summary>
  18068. Gets or sets the scale.
  18069. </summary>
  18070. <value>The scale.</value>
  18071. </member>
  18072. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.PageStart">
  18073. <summary>
  18074. Gets or sets the page start.
  18075. </summary>
  18076. <value>The page start.</value>
  18077. </member>
  18078. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.FitWidth">
  18079. <summary>
  18080. Gets or sets the number of pages wide to fit sheet in.
  18081. </summary>
  18082. <value>the number of pages wide to fit sheet in</value>
  18083. </member>
  18084. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.FitHeight">
  18085. <summary>
  18086. Gets or sets number of pages high to fit the sheet in
  18087. </summary>
  18088. <value>number of pages high to fit the sheet in.</value>
  18089. </member>
  18090. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Options">
  18091. <summary>
  18092. Gets or sets the bit flags for the options.
  18093. </summary>
  18094. <value>the bit flags for the options.</value>
  18095. </member>
  18096. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.LeftToRight">
  18097. <summary>
  18098. Gets or sets the left to right print order.
  18099. </summary>
  18100. <value>the left to right print order.</value>
  18101. </member>
  18102. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Landscape">
  18103. <summary>
  18104. Gets or sets the landscape mode.
  18105. </summary>
  18106. <value>the landscape mode.</value>
  18107. </member>
  18108. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.ValidSettings">
  18109. <summary>
  18110. Gets or sets the valid Settings.
  18111. </summary>
  18112. <value>the valid Settings.</value>
  18113. </member>
  18114. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.NoColor">
  18115. <summary>
  18116. Gets or sets the black and white Setting.
  18117. </summary>
  18118. <value>black and white Setting</value>
  18119. </member>
  18120. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Draft">
  18121. <summary>
  18122. Gets or sets the draft mode.
  18123. </summary>
  18124. <value>the draft mode.</value>
  18125. </member>
  18126. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Notes">
  18127. <summary>
  18128. Gets or sets the print notes.
  18129. </summary>
  18130. <value>the print notes.</value>
  18131. </member>
  18132. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.NoOrientation">
  18133. <summary>
  18134. Gets or sets a value indicating whether [no orientation].
  18135. </summary>
  18136. <value><c>true</c> if [no orientation]; otherwise, <c>false</c>.</value>
  18137. </member>
  18138. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.UsePage">
  18139. <summary>
  18140. Gets or sets the use page numbers.
  18141. </summary>
  18142. <value>use page numbers. </value>
  18143. </member>
  18144. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.HResolution">
  18145. <summary>
  18146. Gets or sets the horizontal resolution.
  18147. </summary>
  18148. <value>the horizontal resolution.</value>
  18149. </member>
  18150. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.VResolution">
  18151. <summary>
  18152. Gets or sets the vertical resolution.
  18153. </summary>
  18154. <value>the vertical resolution.</value>
  18155. </member>
  18156. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.HeaderMargin">
  18157. <summary>
  18158. Gets or sets the header margin.
  18159. </summary>
  18160. <value>The header margin.</value>
  18161. </member>
  18162. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.FooterMargin">
  18163. <summary>
  18164. Gets or sets the footer margin.
  18165. </summary>
  18166. <value>The footer margin.</value>
  18167. </member>
  18168. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Copies">
  18169. <summary>
  18170. Gets or sets the number of copies.
  18171. </summary>
  18172. <value>the number of copies.</value>
  18173. </member>
  18174. <member name="T:NPOI.HSSF.UserModel.HSSFRichTextString">
  18175. <summary>
  18176. Rich text Unicode string. These strings can have fonts applied to
  18177. arbitary parts of the string.
  18178. @author Glen Stampoultzis (glens at apache.org)
  18179. @author Jason Height (jheight at apache.org)
  18180. </summary>
  18181. </member>
  18182. <member name="F:NPOI.HSSF.UserModel.HSSFRichTextString.NO_FONT">
  18183. Place holder for indicating that NO_FONT has been applied here
  18184. </member>
  18185. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.#ctor">
  18186. <summary>
  18187. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFRichTextString"/> class.
  18188. </summary>
  18189. </member>
  18190. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.#ctor(System.String)">
  18191. <summary>
  18192. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFRichTextString"/> class.
  18193. </summary>
  18194. <param name="str">The string.</param>
  18195. </member>
  18196. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.#ctor(NPOI.HSSF.Model.InternalWorkbook,NPOI.HSSF.Record.LabelSSTRecord)">
  18197. <summary>
  18198. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFRichTextString"/> class.
  18199. </summary>
  18200. <param name="book">The workbook.</param>
  18201. <param name="record">The record.</param>
  18202. </member>
  18203. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.SetWorkbookReferences(NPOI.HSSF.Model.InternalWorkbook,NPOI.HSSF.Record.LabelSSTRecord)">
  18204. <summary>
  18205. This must be called to Setup the internal work book references whenever
  18206. a RichTextString Is Added to a cell
  18207. </summary>
  18208. <param name="book">The workbook.</param>
  18209. <param name="record">The record.</param>
  18210. </member>
  18211. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.CloneStringIfRequired">
  18212. <summary>
  18213. Called whenever the Unicode string Is modified. When it Is modified
  18214. we need to Create a new SST index, so that other LabelSSTRecords will not
  18215. be affected by Changes tat we make to this string.
  18216. </summary>
  18217. <returns></returns>
  18218. </member>
  18219. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.AddToSSTIfRequired">
  18220. <summary>
  18221. Adds to SST if required.
  18222. </summary>
  18223. </member>
  18224. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ApplyFont(System.Int32,System.Int32,System.Int16)">
  18225. <summary>
  18226. Applies a font to the specified Chars of a string.
  18227. </summary>
  18228. <param name="startIndex">The start index to apply the font to (inclusive).</param>
  18229. <param name="endIndex">The end index to apply the font to (exclusive).</param>
  18230. <param name="fontIndex">The font to use.</param>
  18231. </member>
  18232. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ApplyFont(System.Int32,System.Int32,NPOI.SS.UserModel.IFont)">
  18233. <summary>
  18234. Applies a font to the specified Chars of a string.
  18235. </summary>
  18236. <param name="startIndex">The start index to apply the font to (inclusive).</param>
  18237. <param name="endIndex"> The end index to apply to font to (exclusive).</param>
  18238. <param name="font">The index of the font to use.</param>
  18239. </member>
  18240. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ApplyFont(NPOI.SS.UserModel.IFont)">
  18241. <summary>
  18242. Sets the font of the entire string.
  18243. </summary>
  18244. <param name="font">The font to use.</param>
  18245. </member>
  18246. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ClearFormatting">
  18247. <summary>
  18248. Removes any formatting that may have been applied to the string.
  18249. </summary>
  18250. </member>
  18251. <member name="P:NPOI.HSSF.UserModel.HSSFRichTextString.String">
  18252. <summary>
  18253. Returns the plain string representation.
  18254. </summary>
  18255. <value>The string.</value>
  18256. </member>
  18257. <member name="P:NPOI.HSSF.UserModel.HSSFRichTextString.RawUnicodeString">
  18258. <summary>
  18259. Returns the raw, probably shared Unicode String.
  18260. Used when tweaking the styles, eg updating font
  18261. positions.
  18262. Changes to this string may well effect
  18263. other RichTextStrings too!
  18264. </summary>
  18265. <value>The raw unicode string.</value>
  18266. </member>
  18267. <member name="P:NPOI.HSSF.UserModel.HSSFRichTextString.UnicodeString">
  18268. <summary>
  18269. Gets or sets the unicode string.
  18270. </summary>
  18271. <value>The unicode string.</value>
  18272. </member>
  18273. <member name="P:NPOI.HSSF.UserModel.HSSFRichTextString.Length">
  18274. <summary>
  18275. Gets the number of Chars in the font..
  18276. </summary>
  18277. <value>The length.</value>
  18278. </member>
  18279. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.GetFontAtIndex(System.Int32)">
  18280. <summary>
  18281. Returns the font in use at a particular index.
  18282. </summary>
  18283. <param name="index">The index.</param>
  18284. <returns>The font that's currently being applied at that
  18285. index or null if no font Is being applied or the
  18286. index Is out of range.</returns>
  18287. </member>
  18288. <member name="P:NPOI.HSSF.UserModel.HSSFRichTextString.NumFormattingRuns">
  18289. <summary>
  18290. Gets the number of formatting runs used. There will always be at
  18291. least one of font NO_FONT.
  18292. </summary>
  18293. <value>The num formatting runs.</value>
  18294. </member>
  18295. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.GetIndexOfFormattingRun(System.Int32)">
  18296. <summary>
  18297. The index within the string to which the specified formatting run applies.
  18298. </summary>
  18299. <param name="index">the index of the formatting run</param>
  18300. <returns>the index within the string.</returns>
  18301. </member>
  18302. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.GetFontOfFormattingRun(System.Int32)">
  18303. <summary>
  18304. Gets the font used in a particular formatting run.
  18305. </summary>
  18306. <param name="index">the index of the formatting run.</param>
  18307. <returns>the font number used.</returns>
  18308. </member>
  18309. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.CompareTo(NPOI.HSSF.UserModel.HSSFRichTextString)">
  18310. <summary>
  18311. Compares one rich text string to another.
  18312. </summary>
  18313. <param name="other">The other rich text string.</param>
  18314. <returns></returns>
  18315. </member>
  18316. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.Equals(System.Object)">
  18317. <summary>
  18318. Equalses the specified o.
  18319. </summary>
  18320. <param name="o">The o.</param>
  18321. <returns></returns>
  18322. </member>
  18323. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ToString">
  18324. <summary>
  18325. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  18326. </summary>
  18327. <returns>
  18328. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  18329. </returns>
  18330. </member>
  18331. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ApplyFont(System.Int16)">
  18332. <summary>
  18333. Applies the specified font to the entire string.
  18334. </summary>
  18335. <param name="fontIndex">Index of the font to apply.</param>
  18336. </member>
  18337. <member name="T:NPOI.HSSF.UserModel.HSSFRow">
  18338. <summary>
  18339. High level representation of a row of a spReadsheet.
  18340. Only rows that have cells should be Added to a Sheet.
  18341. @author Andrew C. Oliver (acoliver at apache dot org)
  18342. @author Glen Stampoultzis (glens at apache.org)
  18343. </summary>
  18344. </member>
  18345. <member name="F:NPOI.HSSF.UserModel.HSSFRow.INITIAL_CAPACITY">
  18346. <summary>
  18347. used for collections
  18348. </summary>
  18349. </member>
  18350. <member name="F:NPOI.HSSF.UserModel.HSSFRow.row">
  18351. reference to low level representation
  18352. </member>
  18353. <member name="F:NPOI.HSSF.UserModel.HSSFRow.book">
  18354. reference to containing low level Workbook
  18355. </member>
  18356. <member name="F:NPOI.HSSF.UserModel.HSSFRow.sheet">
  18357. reference to containing Sheet
  18358. </member>
  18359. <member name="M:NPOI.HSSF.UserModel.HSSFRow.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,System.Int32)">
  18360. <summary>
  18361. Creates new HSSFRow from scratch. Only HSSFSheet should do this.
  18362. </summary>
  18363. <param name="book">low-level Workbook object containing the sheet that Contains this row</param>
  18364. <param name="sheet">low-level Sheet object that Contains this Row</param>
  18365. <param name="rowNum">the row number of this row (0 based)</param>
  18366. <see cref="M:NPOI.HSSF.UserModel.HSSFSheet.CreateRow(System.Int32)"/>
  18367. </member>
  18368. <member name="M:NPOI.HSSF.UserModel.HSSFRow.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.Record.RowRecord)">
  18369. <summary>
  18370. Creates an HSSFRow from a low level RowRecord object. Only HSSFSheet should do
  18371. this. HSSFSheet uses this when an existing file is Read in.
  18372. </summary>
  18373. <param name="book">low-level Workbook object containing the sheet that Contains this row</param>
  18374. <param name="sheet"> low-level Sheet object that Contains this Row</param>
  18375. <param name="record">the low level api object this row should represent</param>
  18376. <see cref="M:NPOI.HSSF.UserModel.HSSFSheet.CreateRow(System.Int32)"/>
  18377. </member>
  18378. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CreateCell(System.Int32)">
  18379. <summary>
  18380. Use this to create new cells within the row and return it.
  18381. 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"/>).
  18382. The type can be changed either through calling <c>SetCellValue</c> or <c>SetCellType</c>.
  18383. </summary>
  18384. <param name="column">the column number this cell represents</param>
  18385. <returns>a high level representation of the created cell.</returns>
  18386. </member>
  18387. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CreateCell(System.Int32,NPOI.SS.UserModel.CellType)">
  18388. <summary>
  18389. Use this to create new cells within the row and return it.
  18390. The cell that is returned is a CELL_TYPE_BLANK. The type can be changed
  18391. either through calling setCellValue or setCellType.
  18392. </summary>
  18393. <param name="columnIndex">the column number this cell represents</param>
  18394. <param name="type">a high level representation of the created cell.</param>
  18395. <returns></returns>
  18396. </member>
  18397. <member name="M:NPOI.HSSF.UserModel.HSSFRow.RemoveCell(NPOI.SS.UserModel.ICell)">
  18398. <summary>
  18399. Remove the Cell from this row.
  18400. </summary>
  18401. <param name="cell">The cell to Remove.</param>
  18402. </member>
  18403. <member name="M:NPOI.HSSF.UserModel.HSSFRow.RemoveCell(NPOI.SS.UserModel.ICell,System.Boolean)">
  18404. <summary>
  18405. Removes the cell.
  18406. </summary>
  18407. <param name="cell">The cell.</param>
  18408. <param name="alsoRemoveRecords">if set to <c>true</c> [also remove records].</param>
  18409. </member>
  18410. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CalculateNewLastCellPlusOne(System.Int32)">
  18411. used internally to refresh the "last cell plus one" when the last cell is removed.
  18412. @return 0 when row contains no cells
  18413. </member>
  18414. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CalculateNewFirstCell(System.Int32)">
  18415. used internally to refresh the "first cell" when the first cell is removed.
  18416. @return 0 when row contains no cells (also when first cell is occupied)
  18417. </member>
  18418. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CreateCellFromRecord(NPOI.HSSF.Record.CellValueRecordInterface)">
  18419. <summary>
  18420. Create a high level Cell object from an existing low level record. Should
  18421. only be called from HSSFSheet or HSSFRow itself.
  18422. </summary>
  18423. <param name="cell">The low level cell to Create the high level representation from</param>
  18424. <returns> the low level record passed in</returns>
  18425. </member>
  18426. <member name="P:NPOI.HSSF.UserModel.HSSFRow.IsHidden">
  18427. <summary>
  18428. true, when the row is invisible. This is the case when the height is zero.
  18429. </summary>
  18430. </member>
  18431. <member name="M:NPOI.HSSF.UserModel.HSSFRow.RemoveAllCells">
  18432. <summary>
  18433. Removes all the cells from the row, and their
  18434. records too.
  18435. </summary>
  18436. </member>
  18437. <member name="P:NPOI.HSSF.UserModel.HSSFRow.RowNum">
  18438. <summary>
  18439. Get row number this row represents
  18440. </summary>
  18441. <value>the row number (0 based)</value>
  18442. </member>
  18443. <member name="P:NPOI.HSSF.UserModel.HSSFRow.OutlineLevel">
  18444. <summary>
  18445. Returns the rows outline level. Increased as you
  18446. put it into more Groups (outlines), reduced as
  18447. you take it out of them.
  18448. </summary>
  18449. <value>The outline level.</value>
  18450. </member>
  18451. <member name="M:NPOI.HSSF.UserModel.HSSFRow.MoveCell(NPOI.SS.UserModel.ICell,System.Int32)">
  18452. <summary>
  18453. Moves the supplied cell to a new column, which
  18454. must not already have a cell there!
  18455. </summary>
  18456. <param name="cell">The cell to move</param>
  18457. <param name="newColumn">The new column number (0 based)</param>
  18458. </member>
  18459. <member name="P:NPOI.HSSF.UserModel.HSSFRow.Sheet">
  18460. Returns the HSSFSheet this row belongs to
  18461. @return the HSSFSheet that owns this row
  18462. </member>
  18463. <member name="M:NPOI.HSSF.UserModel.HSSFRow.AddCell(NPOI.SS.UserModel.ICell)">
  18464. <summary>
  18465. used internally to Add a cell.
  18466. </summary>
  18467. <param name="cell">The cell.</param>
  18468. </member>
  18469. <member name="M:NPOI.HSSF.UserModel.HSSFRow.RetrieveCell(System.Int32)">
  18470. <summary>
  18471. Get the hssfcell representing a given column (logical cell)
  18472. 0-based. If you ask for a cell that is not defined, then
  18473. you Get a null.
  18474. This is the basic call, with no policies applied
  18475. </summary>
  18476. <param name="cellnum">0 based column number</param>
  18477. <returns>Cell representing that column or null if Undefined.</returns>
  18478. </member>
  18479. <member name="M:NPOI.HSSF.UserModel.HSSFRow.GetCell(System.Int32)">
  18480. <summary>
  18481. Get the hssfcell representing a given column (logical cell)
  18482. 0-based. If you ask for a cell that is not defined then
  18483. you get a null, unless you have set a different
  18484. MissingCellPolicy on the base workbook.
  18485. </summary>
  18486. <param name="cellnum">0 based column number</param>
  18487. <returns>Cell representing that column or null if undefined.</returns>
  18488. </member>
  18489. <member name="M:NPOI.HSSF.UserModel.HSSFRow.GetCell(System.Int32,NPOI.SS.UserModel.MissingCellPolicy)">
  18490. <summary>
  18491. Get the hssfcell representing a given column (logical cell)
  18492. 0-based. If you ask for a cell that is not defined, then
  18493. your supplied policy says what to do
  18494. </summary>
  18495. <param name="cellnum">0 based column number</param>
  18496. <param name="policy">Policy on blank / missing cells</param>
  18497. <returns>that column or null if Undefined + policy allows.</returns>
  18498. </member>
  18499. <member name="P:NPOI.HSSF.UserModel.HSSFRow.FirstCellNum">
  18500. <summary>
  18501. Get the number of the first cell contained in this row.
  18502. </summary>
  18503. <value>the first logical cell in the row, or -1 if the row does not contain any cells.</value>
  18504. </member>
  18505. <member name="P:NPOI.HSSF.UserModel.HSSFRow.LastCellNum">
  18506. <summary>
  18507. Gets the index of the last cell contained in this row PLUS ONE
  18508. . The result also happens to be the 1-based column number of the last cell. This value can be used as a
  18509. standard upper bound when iterating over cells:
  18510. </summary>
  18511. <value>
  18512. short representing the last logical cell in the row PLUS ONE, or -1 if the
  18513. row does not contain any cells.
  18514. </value>
  18515. <example>
  18516. short minColIx = row.GetFirstCellNum();
  18517. short maxColIx = row.GetLastCellNum();
  18518. for(short colIx=minColIx; colIx&lt;maxColIx; colIx++) {
  18519. Cell cell = row.GetCell(colIx);
  18520. if(cell == null) {
  18521. continue;
  18522. }
  18523. //... do something with cell
  18524. }
  18525. </example>
  18526. </member>
  18527. <member name="P:NPOI.HSSF.UserModel.HSSFRow.PhysicalNumberOfCells">
  18528. <summary>
  18529. Gets the number of defined cells (NOT number of cells in the actual row!).
  18530. That is to say if only columns 0,4,5 have values then there would be 3.
  18531. </summary>
  18532. <value>the number of defined cells in the row.</value>
  18533. </member>
  18534. <member name="P:NPOI.HSSF.UserModel.HSSFRow.ZeroHeight">
  18535. <summary>
  18536. Gets or sets whether or not to Display this row with 0 height
  18537. </summary>
  18538. <value>height is zero or not.</value>
  18539. </member>
  18540. <member name="P:NPOI.HSSF.UserModel.HSSFRow.Height">
  18541. <summary>
  18542. Get or sets the row's height or ff (-1) for undefined/default-height in twips (1/20th of a point)
  18543. </summary>
  18544. <value>rowheight or 0xff for Undefined (use sheet default)</value>
  18545. </member>
  18546. <member name="P:NPOI.HSSF.UserModel.HSSFRow.IsFormatted">
  18547. <summary>
  18548. is this row formatted? Most aren't, but some rows
  18549. do have whole-row styles. For those that do, you
  18550. can get the formatting from {@link #getRowStyle()}
  18551. </summary>
  18552. <value>
  18553. <c>true</c> if this instance is formatted; otherwise, <c>false</c>.
  18554. </value>
  18555. </member>
  18556. <member name="P:NPOI.HSSF.UserModel.HSSFRow.RowStyle">
  18557. <summary>
  18558. Returns the whole-row cell styles. Most rows won't
  18559. have one of these, so will return null. Call IsFormmated to check first
  18560. </summary>
  18561. <value>The row style.</value>
  18562. </member>
  18563. <member name="P:NPOI.HSSF.UserModel.HSSFRow.HeightInPoints">
  18564. <summary>
  18565. Get the row's height or ff (-1) for Undefined/default-height in points (20*Height)
  18566. </summary>
  18567. <value>row height or 0xff for Undefined (use sheet default).</value>
  18568. </member>
  18569. <member name="P:NPOI.HSSF.UserModel.HSSFRow.RowRecord">
  18570. <summary>
  18571. Get the lowlevel RowRecord represented by this object - should only be called
  18572. by other parts of the high level API
  18573. </summary>
  18574. <value>RowRecord this row represents</value>
  18575. </member>
  18576. <member name="M:NPOI.HSSF.UserModel.HSSFRow.FindFirstCell(System.Int32)">
  18577. <summary>
  18578. used internally to refresh the "first cell" when the first cell is Removed.
  18579. </summary>
  18580. <param name="firstcell">The first cell index.</param>
  18581. <returns></returns>
  18582. </member>
  18583. <member name="P:NPOI.HSSF.UserModel.HSSFRow.Cells">
  18584. <summary>
  18585. Get cells in the row (existing cells only, no blanks)
  18586. </summary>
  18587. </member>
  18588. <member name="M:NPOI.HSSF.UserModel.HSSFRow.GetEnumerator">
  18589. <summary>
  18590. Gets the cell enumerator of the physically defined cells.
  18591. </summary>
  18592. <remarks>
  18593. Note that the 4th element might well not be cell 4, as the iterator
  18594. will not return Un-defined (null) cells.
  18595. Call CellNum on the returned cells to know which cell they are.
  18596. </remarks>
  18597. </member>
  18598. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CompareTo(NPOI.HSSF.UserModel.HSSFRow)">
  18599. <summary>
  18600. 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.
  18601. </summary>
  18602. <param name="other">An object to compare with this instance.</param>
  18603. <returns>
  18604. A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings:
  18605. Value
  18606. Meaning
  18607. Less than zero
  18608. This instance is less than <paramref name="other"/>.
  18609. Zero
  18610. This instance is equal to <paramref name="other"/>.
  18611. Greater than zero
  18612. This instance is greater than <paramref name="other"/>.
  18613. </returns>
  18614. <exception cref="T:System.ArgumentException">
  18615. <paramref name="other"/> is not the same type as this instance.
  18616. </exception>
  18617. </member>
  18618. <member name="M:NPOI.HSSF.UserModel.HSSFRow.Equals(System.Object)">
  18619. <summary>
  18620. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
  18621. </summary>
  18622. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
  18623. <returns>
  18624. true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
  18625. </returns>
  18626. <exception cref="T:System.NullReferenceException">
  18627. The <paramref name="obj"/> parameter is null.
  18628. </exception>
  18629. </member>
  18630. <member name="M:NPOI.HSSF.UserModel.HSSFRow.GetHashCode">
  18631. <summary>
  18632. Returns a hash code. In this case it is the number of the row.
  18633. </summary>
  18634. </member>
  18635. <member name="T:NPOI.HSSF.UserModel.HSSFShape">
  18636. <summary>
  18637. An abstract shape.
  18638. Note: Microsoft Excel seems to sometimes disallow
  18639. higher y1 than y2 or higher x1 than x2 in the anchor, you might need to
  18640. reverse them and draw shapes vertically or horizontally flipped!
  18641. </summary>
  18642. </member>
  18643. <member name="M:NPOI.HSSF.UserModel.HSSFShape.#ctor(NPOI.DDF.EscherContainerRecord,NPOI.HSSF.Record.ObjRecord)">
  18644. creates shapes from existing file
  18645. @param spContainer
  18646. @param objRecord
  18647. </member>
  18648. <member name="M:NPOI.HSSF.UserModel.HSSFShape.#ctor(NPOI.HSSF.UserModel.HSSFShape,NPOI.HSSF.UserModel.HSSFAnchor)">
  18649. <summary>
  18650. Create a new shape with the specified parent and anchor.
  18651. </summary>
  18652. <param name="parent">The parent.</param>
  18653. <param name="anchor">The anchor.</param>
  18654. </member>
  18655. <member name="P:NPOI.HSSF.UserModel.HSSFShape.Parent">
  18656. <summary>
  18657. Gets the parent shape.
  18658. </summary>
  18659. <value>The parent.</value>
  18660. </member>
  18661. <member name="P:NPOI.HSSF.UserModel.HSSFShape.Anchor">
  18662. <summary>
  18663. Gets or sets the anchor that is used by this shape.
  18664. </summary>
  18665. <value>The anchor.</value>
  18666. </member>
  18667. <member name="P:NPOI.HSSF.UserModel.HSSFShape.LineStyleColor">
  18668. <summary>
  18669. The color applied to the lines of this shape.
  18670. </summary>
  18671. <value>The color of the line style.</value>
  18672. </member>
  18673. <member name="M:NPOI.HSSF.UserModel.HSSFShape.SetLineStyleColor(System.Int32,System.Int32,System.Int32)">
  18674. <summary>
  18675. Sets the color applied to the lines of this shape
  18676. </summary>
  18677. <param name="red">The red.</param>
  18678. <param name="green">The green.</param>
  18679. <param name="blue">The blue.</param>
  18680. </member>
  18681. <member name="P:NPOI.HSSF.UserModel.HSSFShape.FillColor">
  18682. <summary>
  18683. Gets or sets the color used to fill this shape.
  18684. </summary>
  18685. <value>The color of the fill.</value>
  18686. </member>
  18687. <member name="M:NPOI.HSSF.UserModel.HSSFShape.SetFillColor(System.Int32,System.Int32,System.Int32)">
  18688. <summary>
  18689. Sets the color used to fill this shape.
  18690. </summary>
  18691. <param name="red">The red.</param>
  18692. <param name="green">The green.</param>
  18693. <param name="blue">The blue.</param>
  18694. </member>
  18695. <member name="P:NPOI.HSSF.UserModel.HSSFShape.LineWidth">
  18696. <summary>
  18697. Gets or sets with width of the line in EMUs. 12700 = 1 pt.
  18698. </summary>
  18699. <value>The width of the line.</value>
  18700. </member>
  18701. <member name="P:NPOI.HSSF.UserModel.HSSFShape.LineStyle">
  18702. <summary>
  18703. Gets or sets One of the constants in LINESTYLE_*
  18704. </summary>
  18705. <value>The line style.</value>
  18706. </member>
  18707. <member name="P:NPOI.HSSF.UserModel.HSSFShape.IsNoFill">
  18708. <summary>
  18709. Gets or sets a value indicating whether this instance is no fill.
  18710. </summary>
  18711. <value>
  18712. <c>true</c> if this shape Is not filled with a color; otherwise, <c>false</c>.
  18713. </value>
  18714. </member>
  18715. <member name="P:NPOI.HSSF.UserModel.HSSFShape.IsFlipVertical">
  18716. <summary>
  18717. whether this shape is vertically flipped.
  18718. </summary>
  18719. </member>
  18720. <member name="P:NPOI.HSSF.UserModel.HSSFShape.IsFlipHorizontal">
  18721. <summary>
  18722. whether this shape is horizontally flipped.
  18723. </summary>
  18724. </member>
  18725. <member name="P:NPOI.HSSF.UserModel.HSSFShape.RotationDegree">
  18726. <summary>
  18727. get or set the rotation, in degrees, that is applied to a shape.
  18728. Negative values specify rotation in the counterclockwise direction.
  18729. Rotation occurs around the center of the shape.
  18730. The default value for this property is 0x00000000
  18731. </summary>
  18732. </member>
  18733. <member name="P:NPOI.HSSF.UserModel.HSSFShape.CountOfAllChildren">
  18734. <summary>
  18735. Count of all children and their childrens children.
  18736. </summary>
  18737. <value>The count of all children.</value>
  18738. </member>
  18739. <member name="T:NPOI.HSSF.UserModel.HSSFShapeContainer">
  18740. <summary>
  18741. An interface that indicates whether a class can contain children.
  18742. @author Glen Stampoultzis (glens at apache.org)
  18743. </summary>
  18744. </member>
  18745. <member name="P:NPOI.HSSF.UserModel.HSSFShapeContainer.Children">
  18746. <summary>
  18747. Gets Any children contained by this shape.
  18748. </summary>
  18749. <value>The children.</value>
  18750. </member>
  18751. <member name="M:NPOI.HSSF.UserModel.HSSFShapeContainer.AddShape(NPOI.HSSF.UserModel.HSSFShape)">
  18752. <summary>
  18753. dd shape to the list of child records
  18754. </summary>
  18755. <param name="shape">shape</param>
  18756. </member>
  18757. <member name="M:NPOI.HSSF.UserModel.HSSFShapeContainer.SetCoordinates(System.Int32,System.Int32,System.Int32,System.Int32)">
  18758. <summary>
  18759. set coordinates of this group relative to the parent
  18760. </summary>
  18761. <param name="x1">x1</param>
  18762. <param name="y1">y1</param>
  18763. <param name="x2">x2</param>
  18764. <param name="y2">y2</param>
  18765. </member>
  18766. <member name="P:NPOI.HSSF.UserModel.HSSFShapeContainer.X1">
  18767. <summary>
  18768. Get the top left x coordinate of this group.
  18769. </summary>
  18770. </member>
  18771. <member name="P:NPOI.HSSF.UserModel.HSSFShapeContainer.Y1">
  18772. <summary>
  18773. Get the top left y coordinate of this group.
  18774. </summary>
  18775. </member>
  18776. <member name="P:NPOI.HSSF.UserModel.HSSFShapeContainer.X2">
  18777. <summary>
  18778. Get the bottom right x coordinate of this group.
  18779. </summary>
  18780. </member>
  18781. <member name="P:NPOI.HSSF.UserModel.HSSFShapeContainer.Y2">
  18782. <summary>
  18783. Get the bottom right y coordinate of this group.
  18784. </summary>
  18785. </member>
  18786. <member name="M:NPOI.HSSF.UserModel.HSSFShapeContainer.RemoveShape(NPOI.HSSF.UserModel.HSSFShape)">
  18787. remove first level shapes
  18788. @param shape to be removed
  18789. @return true if shape is removed else return false
  18790. </member>
  18791. <member name="T:NPOI.HSSF.UserModel.HSSFShapeFactory">
  18792. @author Evgeniy Berlog
  18793. date: 05.06.12
  18794. </member>
  18795. <member name="M:NPOI.HSSF.UserModel.HSSFShapeFactory.CreateShapeTree(NPOI.DDF.EscherContainerRecord,NPOI.HSSF.Record.EscherAggregate,NPOI.HSSF.UserModel.HSSFShapeContainer,NPOI.POIFS.FileSystem.DirectoryNode)">
  18796. build shape tree from escher container
  18797. @param container root escher container from which escher records must be taken
  18798. @param agg - EscherAggregate
  18799. @param out - shape container to which shapes must be added
  18800. @param root - node to create HSSFObjectData shapes
  18801. </member>
  18802. <member name="T:NPOI.HSSF.UserModel.HSSFShapeGroup">
  18803. <summary>
  18804. A shape Group may contain other shapes. It was no actual form on the
  18805. sheet.
  18806. @author Glen Stampoultzis (glens at apache.org)
  18807. </summary>
  18808. </member>
  18809. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.CreateGroup(NPOI.HSSF.UserModel.HSSFChildAnchor)">
  18810. <summary>
  18811. Create another Group Under this Group.
  18812. </summary>
  18813. <param name="anchor">the position of the new Group.</param>
  18814. <returns>the Group</returns>
  18815. </member>
  18816. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.CreateShape(NPOI.HSSF.UserModel.HSSFChildAnchor)">
  18817. <summary>
  18818. Create a new simple shape Under this Group.
  18819. </summary>
  18820. <param name="anchor">the position of the shape.</param>
  18821. <returns>the shape</returns>
  18822. </member>
  18823. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.CreateTextbox(NPOI.HSSF.UserModel.HSSFChildAnchor)">
  18824. <summary>
  18825. Create a new textbox Under this Group.
  18826. </summary>
  18827. <param name="anchor">the position of the shape.</param>
  18828. <returns>the textbox</returns>
  18829. </member>
  18830. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.CreatePolygon(NPOI.HSSF.UserModel.HSSFChildAnchor)">
  18831. <summary>
  18832. Creates a polygon
  18833. </summary>
  18834. <param name="anchor">the client anchor describes how this Group Is attached
  18835. to the sheet.</param>
  18836. <returns>the newly Created shape.</returns>
  18837. </member>
  18838. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.CreatePicture(NPOI.HSSF.UserModel.HSSFChildAnchor,System.Int32)">
  18839. <summary>
  18840. Creates a picture.
  18841. </summary>
  18842. <param name="anchor">the client anchor describes how this Group Is attached
  18843. to the sheet.</param>
  18844. <param name="pictureIndex">Index of the picture.</param>
  18845. <returns>the newly Created shape.</returns>
  18846. </member>
  18847. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.Children">
  18848. <summary>
  18849. Return all children contained by this shape.
  18850. </summary>
  18851. <value></value>
  18852. </member>
  18853. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.SetCoordinates(System.Int32,System.Int32,System.Int32,System.Int32)">
  18854. <summary>
  18855. Sets the coordinate space of this Group. All children are constrained
  18856. to these coordinates.
  18857. </summary>
  18858. <param name="x1">The x1.</param>
  18859. <param name="y1">The y1.</param>
  18860. <param name="x2">The x2.</param>
  18861. <param name="y2">The y2.</param>
  18862. </member>
  18863. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.X1">
  18864. <summary>
  18865. Gets The top left x coordinate of this Group.
  18866. </summary>
  18867. <value>The x1.</value>
  18868. </member>
  18869. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.Y1">
  18870. <summary>
  18871. Gets The top left y coordinate of this Group.
  18872. </summary>
  18873. <value>The y1.</value>
  18874. </member>
  18875. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.X2">
  18876. <summary>
  18877. Gets The bottom right x coordinate of this Group.
  18878. </summary>
  18879. <value>The x2.</value>
  18880. </member>
  18881. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.Y2">
  18882. <summary>
  18883. Gets the bottom right y coordinate of this Group.
  18884. </summary>
  18885. <value>The y2.</value>
  18886. </member>
  18887. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.CountOfAllChildren">
  18888. <summary>
  18889. Count of all children and their childrens children.
  18890. </summary>
  18891. <value></value>
  18892. </member>
  18893. <member name="T:NPOI.HSSF.UserModel.HSSFSheet">
  18894. <summary>
  18895. High level representation of a worksheet.
  18896. </summary>
  18897. <remarks>
  18898. @author Andrew C. Oliver (acoliver at apache dot org)
  18899. @author Glen Stampoultzis (glens at apache.org)
  18900. @author Libin Roman (romal at vistaportal.com)
  18901. @author Shawn Laubach (slaubach at apache dot org) (Just a little)
  18902. @author Jean-Pierre Paris (jean-pierre.paris at m4x dot org) (Just a little, too)
  18903. @author Yegor Kozlov (yegor at apache.org) (Autosizing columns)
  18904. </remarks>
  18905. </member>
  18906. <member name="F:NPOI.HSSF.UserModel.HSSFSheet.PX_DEFAULT">
  18907. width of 1px in columns with default width in units of 1/256 of a character width
  18908. </member>
  18909. <member name="F:NPOI.HSSF.UserModel.HSSFSheet.PX_MODIFIED">
  18910. width of 1px in columns with overridden width in units of 1/256 of a character width
  18911. </member>
  18912. <member name="F:NPOI.HSSF.UserModel.HSSFSheet.INITIAL_CAPACITY">
  18913. Used for compile-time optimization. This is the initial size for the collection of
  18914. rows. It is currently Set to 20. If you generate larger sheets you may benefit
  18915. by Setting this to a higher number and recompiling a custom edition of HSSFSheet.
  18916. </member>
  18917. <member name="F:NPOI.HSSF.UserModel.HSSFSheet._sheet">
  18918. reference to the low level Sheet object
  18919. </member>
  18920. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook)">
  18921. <summary>
  18922. Creates new HSSFSheet - called by HSSFWorkbook to create a _sheet from
  18923. scratch. You should not be calling this from application code (its protected anyhow).
  18924. </summary>
  18925. <param name="workbook">The HSSF Workbook object associated with the _sheet.</param>
  18926. <see cref="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateSheet"/>
  18927. </member>
  18928. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.Model.InternalSheet)">
  18929. <summary>
  18930. Creates an HSSFSheet representing the given Sheet object. Should only be
  18931. called by HSSFWorkbook when reading in an exisiting file.
  18932. </summary>
  18933. <param name="workbook">The HSSF Workbook object associated with the _sheet.</param>
  18934. <param name="sheet">lowlevel Sheet object this _sheet will represent</param>
  18935. <see cref="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(NPOI.POIFS.FileSystem.DirectoryNode,System.Boolean)"/>
  18936. </member>
  18937. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CloneSheet(NPOI.HSSF.UserModel.HSSFWorkbook)">
  18938. <summary>
  18939. Clones the _sheet.
  18940. </summary>
  18941. <param name="workbook">The _workbook.</param>
  18942. <returns>the cloned sheet</returns>
  18943. </member>
  18944. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CopyRow(System.Int32,System.Int32)">
  18945. <summary>
  18946. Copy one row to the target row
  18947. </summary>
  18948. <param name="sourceIndex">index of the source row</param>
  18949. <param name="targetIndex">index of the target row</param>
  18950. </member>
  18951. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetPropertiesFromSheet(NPOI.HSSF.Model.InternalSheet)">
  18952. <summary>
  18953. used internally to Set the properties given a Sheet object
  18954. </summary>
  18955. <param name="sheet">The _sheet.</param>
  18956. </member>
  18957. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DisplayZeros">
  18958. Gets the flag indicating whether the window should show 0 (zero) in cells containing zero value.
  18959. When false, cells with zero value appear blank instead of showing the number zero.
  18960. In Excel 2003 this option can be changed in the Options dialog on the View tab.
  18961. @return whether all zero values on the worksheet are displayed
  18962. </member>
  18963. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateRow(System.Int32)">
  18964. <summary>
  18965. Create a new row within the _sheet and return the high level representation
  18966. </summary>
  18967. <param name="rownum">The row number.</param>
  18968. <returns></returns>
  18969. @see org.apache.poi.hssf.usermodel.HSSFRow
  18970. @see #RemoveRow(HSSFRow)
  18971. </member>
  18972. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateRowFromRecord(NPOI.HSSF.Record.RowRecord)">
  18973. <summary>
  18974. Used internally to Create a high level Row object from a low level row object.
  18975. USed when Reading an existing file
  18976. </summary>
  18977. <param name="row">low level record to represent as a high level Row and Add to _sheet.</param>
  18978. <returns>HSSFRow high level representation</returns>
  18979. </member>
  18980. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveRow(NPOI.SS.UserModel.IRow)">
  18981. <summary>
  18982. Remove a row from this _sheet. All cells contained in the row are Removed as well
  18983. </summary>
  18984. <param name="row">the row to Remove.</param>
  18985. </member>
  18986. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.FindLastRow(System.Int32)">
  18987. <summary>
  18988. used internally to refresh the "last row" when the last row is Removed.
  18989. </summary>
  18990. <param name="lastrow">The last row.</param>
  18991. <returns></returns>
  18992. </member>
  18993. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.FindFirstRow(System.Int32)">
  18994. <summary>
  18995. used internally to refresh the "first row" when the first row is Removed.
  18996. </summary>
  18997. <param name="firstrow">The first row.</param>
  18998. <returns></returns>
  18999. </member>
  19000. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AddRow(NPOI.HSSF.UserModel.HSSFRow,System.Boolean)">
  19001. Add a row to the _sheet
  19002. @param AddLow whether to Add the row to the low level model - false if its already there
  19003. </member>
  19004. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetColumnStyle(System.Int32)">
  19005. <summary>
  19006. Returns the HSSFCellStyle that applies to the given
  19007. (0 based) column, or null if no style has been
  19008. set for that column
  19009. </summary>
  19010. <param name="column">The column.</param>
  19011. <returns></returns>
  19012. </member>
  19013. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetRow(System.Int32)">
  19014. <summary>
  19015. Returns the logical row (not physical) 0-based. If you ask for a row that is not
  19016. defined you get a null. This is to say row 4 represents the fifth row on a _sheet.
  19017. </summary>
  19018. <param name="rowIndex">Index of the row to get.</param>
  19019. <returns>the row number or null if its not defined on the _sheet</returns>
  19020. </member>
  19021. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.PhysicalNumberOfRows">
  19022. <summary>
  19023. Returns the number of phsyically defined rows (NOT the number of rows in the _sheet)
  19024. </summary>
  19025. <value>The physical number of rows.</value>
  19026. </member>
  19027. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.FirstRowNum">
  19028. <summary>
  19029. Gets the first row on the _sheet
  19030. </summary>
  19031. <value>the number of the first logical row on the _sheet</value>
  19032. </member>
  19033. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.LastRowNum">
  19034. <summary>
  19035. Gets the last row on the _sheet
  19036. </summary>
  19037. <value>last row contained n this _sheet.</value>
  19038. </member>
  19039. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AddValidationData(NPOI.SS.UserModel.IDataValidation)">
  19040. <summary>
  19041. Creates a data validation object
  19042. </summary>
  19043. <param name="dataValidation">The data validation object settings</param>
  19044. </member>
  19045. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetColumnHidden(System.Int32,System.Boolean)">
  19046. <summary>
  19047. Get the visibility state for a given column.F:\Gloria\�о�\�ļ���ʽ\NPOI\src\NPOI\HSSF\Util\HSSFDataValidation.cs
  19048. </summary>
  19049. <param name="column">the column to Get (0-based).</param>
  19050. <param name="hidden">the visiblity state of the column.</param>
  19051. </member>
  19052. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.IsColumnHidden(System.Int32)">
  19053. <summary>
  19054. Get the hidden state for a given column.
  19055. </summary>
  19056. <param name="column">the column to Set (0-based)</param>
  19057. <returns>the visiblity state of the column;
  19058. </returns>
  19059. </member>
  19060. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetColumnWidth(System.Int32,System.Int32)">
  19061. <summary>
  19062. Set the width (in Units of 1/256th of a Char width)
  19063. </summary>
  19064. <param name="column">the column to Set (0-based)</param>
  19065. <param name="width">the width in Units of 1/256th of a Char width</param>
  19066. </member>
  19067. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetColumnWidth(System.Int32)">
  19068. <summary>
  19069. Get the width (in Units of 1/256th of a Char width )
  19070. </summary>
  19071. <param name="column">the column to Set (0-based)</param>
  19072. <returns>the width in Units of 1/256th of a Char width</returns>
  19073. </member>
  19074. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DefaultColumnWidth">
  19075. <summary>
  19076. Gets or sets the default width of the column.
  19077. </summary>
  19078. <value>The default width of the column.</value>
  19079. </member>
  19080. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DefaultRowHeight">
  19081. <summary>
  19082. Get the default row height for the _sheet (if the rows do not define their own height) in
  19083. twips (1/20 of a point)
  19084. </summary>
  19085. <value>The default height of the row.</value>
  19086. </member>
  19087. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DefaultRowHeightInPoints">
  19088. <summary>
  19089. Get the default row height for the _sheet (if the rows do not define their own height) in
  19090. points.
  19091. </summary>
  19092. <value>The default row height in points.</value>
  19093. </member>
  19094. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsGridsPrinted">
  19095. <summary>
  19096. Get whether gridlines are printed.
  19097. </summary>
  19098. <value>
  19099. <c>true</c> if printed; otherwise, <c>false</c>.
  19100. </value>
  19101. </member>
  19102. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AddMergedRegion(NPOI.SS.Util.CellRangeAddress)">
  19103. <summary>
  19104. Adds a merged region of cells on a sheet.
  19105. </summary>
  19106. <param name="region">region to merge</param>
  19107. <returns>index of this region</returns>
  19108. <exception cref="T:System.ArgumentException">if region contains fewer than 2 cells</exception>
  19109. <exception cref="T:System.InvalidOperationException">if region intersects with an existing merged region
  19110. or multi-cell array formula on this sheet</exception>
  19111. </member>
  19112. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AddMergedRegionUnsafe(NPOI.SS.Util.CellRangeAddress)">
  19113. <summary>
  19114. Adds a merged region of cells (hence those cells form one).
  19115. Skips validation. It is possible to create overlapping merged regions
  19116. or create a merged region that intersects a multi-cell array formula
  19117. with this formula, which may result in a corrupt workbook.
  19118. To check for merged regions overlapping array formulas or other merged regions
  19119. after addMergedRegionUnsafe has been called, call {@link #validateMergedRegions()}, which runs in O(n^2) time.
  19120. </summary>
  19121. <param name="region">region to merge</param>
  19122. <returns>index of this region</returns>
  19123. <exception cref="T:System.ArgumentException">if region contains fewer than 2 cells</exception>
  19124. </member>
  19125. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ValidateMergedRegions">
  19126. <summary>
  19127. Verify that merged regions do not intersect multi-cell array formulas and
  19128. no merged regions intersect another merged region in this sheet.
  19129. </summary>
  19130. <exception cref="T:System.InvalidOperationException">if region intersects with an existing merged region
  19131. or multi-cell array formula on this sheet</exception>
  19132. </member>
  19133. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AddMergedRegion(NPOI.SS.Util.CellRangeAddress,System.Boolean)">
  19134. <summary>
  19135. adds a merged region of cells (hence those cells form one)
  19136. </summary>
  19137. <param name="region">region (rowfrom/colfrom-rowto/colto) to merge</param>
  19138. <param name="validate">whether to validate merged region</param>
  19139. <returns>index of this region</returns>
  19140. <exception cref="T:System.ArgumentException">if region contains fewer than 2 cells</exception>
  19141. <exception cref="T:System.InvalidOperationException">if region intersects with an existing merged region
  19142. or multi-cell array formula on this sheet</exception>
  19143. </member>
  19144. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CheckForMergedRegionsIntersectingArrayFormulas">
  19145. <summary>
  19146. Verify that none of the merged regions intersect a multi-cell array formula in this sheet
  19147. </summary>
  19148. <exception cref="!:NPOI.Util.InvalidOperationException">if candidate region intersects an existing array formula in this sheet</exception>
  19149. </member>
  19150. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CheckForIntersectingMergedRegions">
  19151. <summary>
  19152. Verify that no merged regions intersect another merged region in this sheet.
  19153. </summary>
  19154. <exception cref="T:System.InvalidOperationException">if at least one region intersects with another merged region in this sheet</exception>
  19155. </member>
  19156. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.ForceFormulaRecalculation">
  19157. <summary>
  19158. Whether a record must be Inserted or not at generation to indicate that
  19159. formula must be recalculated when _workbook is opened.
  19160. </summary>
  19161. <value>
  19162. <c>true</c> if [force formula recalculation]; otherwise, <c>false</c>.
  19163. </value>
  19164. @return true if an Uncalced record must be Inserted or not at generation
  19165. </member>
  19166. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.VerticallyCenter">
  19167. <summary>
  19168. Determine whether printed output for this _sheet will be vertically centered.
  19169. </summary>
  19170. <value><c>true</c> if [vertically center]; otherwise, <c>false</c>.</value>
  19171. </member>
  19172. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.HorizontallyCenter">
  19173. <summary>
  19174. Determine whether printed output for this _sheet will be horizontally centered.
  19175. </summary>
  19176. <value><c>true</c> if [horizontally center]; otherwise, <c>false</c>.</value>
  19177. </member>
  19178. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveMergedRegion(System.Int32)">
  19179. <summary>
  19180. Removes a merged region of cells (hence letting them free)
  19181. </summary>
  19182. <param name="index">index of the region to Unmerge</param>
  19183. </member>
  19184. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveMergedRegions(System.Collections.Generic.IList{System.Int32})">
  19185. <summary>
  19186. Removes a number of merged regions of cells (hence letting them free)
  19187. </summary>
  19188. <param name="indices">A set of the regions to unmerge</param>
  19189. </member>
  19190. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.NumMergedRegions">
  19191. <summary>
  19192. returns the number of merged regions
  19193. </summary>
  19194. <value>The number of merged regions</value>
  19195. </member>
  19196. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetRowEnumerator">
  19197. <summary>
  19198. Gets the row enumerator.
  19199. </summary>
  19200. <returns>
  19201. an iterator of the PHYSICAL rows. Meaning the 3rd element may not
  19202. be the third row if say for instance the second row is undefined.
  19203. Call <see cref="P:NPOI.SS.UserModel.IRow.RowNum"/> on each row
  19204. if you care which one it is.
  19205. </returns>
  19206. </member>
  19207. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetEnumerator">
  19208. <summary>
  19209. Alias for GetRowEnumerator() to allow <c>foreach</c> loops.
  19210. </summary>
  19211. <returns>
  19212. an iterator of the PHYSICAL rows. Meaning the 3rd element may not
  19213. be the third row if say for instance the second row is undefined.
  19214. Call <see cref="P:NPOI.SS.UserModel.IRow.RowNum"/> on each row
  19215. if you care which one it is.
  19216. </returns>
  19217. </member>
  19218. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Sheet">
  19219. <summary>
  19220. used internally in the API to Get the low level Sheet record represented by this
  19221. Object.
  19222. </summary>
  19223. <value>low level representation of this HSSFSheet.</value>
  19224. </member>
  19225. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetActiveCellRange(System.Collections.Generic.List{NPOI.SS.Util.CellRangeAddress8Bit},System.Int32,System.Int32,System.Int32,NPOI.SS.UserModel.PanePosition)">
  19226. <summary>
  19227. Sets the active cell range.
  19228. </summary>
  19229. <param name="cellranges">The cellranges.</param>
  19230. <param name="activeRange">The index of the active range.</param>
  19231. <param name="activeRow">The active row in the active range.</param>
  19232. <param name="activeColumn">The active column in the active range.</param>
  19233. <param name="pane">The position of the pane.</param>
  19234. </member>
  19235. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.AlternativeExpression">
  19236. <summary>
  19237. Gets or sets whether alternate expression evaluation is on
  19238. </summary>
  19239. <value>
  19240. <c>true</c> if [alternative expression]; otherwise, <c>false</c>.
  19241. </value>
  19242. </member>
  19243. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.AlternativeFormula">
  19244. <summary>
  19245. whether alternative formula entry is on
  19246. </summary>
  19247. <value><c>true</c> alternative formulas or not; otherwise, <c>false</c>.</value>
  19248. </member>
  19249. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Autobreaks">
  19250. <summary>
  19251. show automatic page breaks or not
  19252. </summary>
  19253. <value>whether to show auto page breaks</value>
  19254. </member>
  19255. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Dialog">
  19256. <summary>
  19257. Gets or sets a value indicating whether _sheet is a dialog _sheet
  19258. </summary>
  19259. <value><c>true</c> if is dialog; otherwise, <c>false</c>.</value>
  19260. </member>
  19261. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DisplayGuts">
  19262. <summary>
  19263. Gets or sets a value indicating whether to Display the guts or not.
  19264. </summary>
  19265. <value><c>true</c> if guts or no guts (or glory); otherwise, <c>false</c>.</value>
  19266. </member>
  19267. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.FitToPage">
  19268. <summary>
  19269. Gets or sets a value indicating whether fit to page option is on
  19270. </summary>
  19271. <value><c>true</c> if [fit to page]; otherwise, <c>false</c>.</value>
  19272. </member>
  19273. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.RowSumsBelow">
  19274. <summary>
  19275. Get if row summaries appear below detail in the outline
  19276. </summary>
  19277. <value><c>true</c> if below or not; otherwise, <c>false</c>.</value>
  19278. </member>
  19279. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.RowSumsRight">
  19280. <summary>
  19281. Get if col summaries appear right of the detail in the outline
  19282. </summary>
  19283. <value><c>true</c> right or not; otherwise, <c>false</c>.</value>
  19284. </member>
  19285. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsPrintGridlines">
  19286. <summary>
  19287. Gets or sets whether gridlines are printed.
  19288. </summary>
  19289. <value>
  19290. <c>true</c> Gridlines are printed; otherwise, <c>false</c>.
  19291. </value>
  19292. </member>
  19293. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsPrintRowAndColumnHeadings">
  19294. <summary>
  19295. get or set whether row and column headings are printed.
  19296. </summary>
  19297. <value>row and column headings are printed</value>
  19298. </member>
  19299. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.PrintSetup">
  19300. <summary>
  19301. Gets the print setup object.
  19302. </summary>
  19303. <value>The user model for the print setup object.</value>
  19304. </member>
  19305. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Header">
  19306. <summary>
  19307. Gets the user model for the document header.
  19308. </summary>
  19309. <value>The Document header.</value>
  19310. </member>
  19311. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Footer">
  19312. <summary>
  19313. Gets the user model for the document footer.
  19314. </summary>
  19315. <value>The Document footer.</value>
  19316. </member>
  19317. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsRightToLeft">
  19318. <summary>
  19319. Gets or sets whether the worksheet is displayed from right to left instead of from left to right.
  19320. </summary>
  19321. <value>true for right to left, false otherwise</value>
  19322. <remarks>poi bug 47970</remarks>
  19323. </member>
  19324. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsSelected">
  19325. <summary>
  19326. Note - this is not the same as whether the _sheet is focused (isActive)
  19327. </summary>
  19328. <value>
  19329. <c>true</c> if this _sheet is currently selected; otherwise, <c>false</c>.
  19330. </value>
  19331. </member>
  19332. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsActive">
  19333. <summary>
  19334. Gets or sets a value indicating if this _sheet is currently focused.
  19335. </summary>
  19336. <value><c>true</c> if this _sheet is currently focused; otherwise, <c>false</c>.</value>
  19337. </member>
  19338. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetActive(System.Boolean)">
  19339. <summary>
  19340. Sets whether sheet is selected.
  19341. </summary>
  19342. <param name="sel">Whether to select the sheet or deselect the sheet.</param>
  19343. </member>
  19344. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Protect">
  19345. <summary>
  19346. Answer whether protection is enabled or disabled
  19347. </summary>
  19348. <value><c>true</c> if protection enabled; otherwise, <c>false</c>.</value>
  19349. </member>
  19350. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Password">
  19351. <summary>
  19352. Gets the hashed password
  19353. </summary>
  19354. <value>The password.</value>
  19355. </member>
  19356. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.ObjectProtect">
  19357. <summary>
  19358. Answer whether object protection is enabled or disabled
  19359. </summary>
  19360. <value><c>true</c> if protection enabled; otherwise, <c>false</c>.</value>
  19361. </member>
  19362. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.ScenarioProtect">
  19363. <summary>
  19364. Answer whether scenario protection is enabled or disabled
  19365. </summary>
  19366. <value><c>true</c> if protection enabled; otherwise, <c>false</c>.</value>
  19367. </member>
  19368. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetZoom(System.Int32,System.Int32)">
  19369. <summary>
  19370. Sets the zoom magnication for the _sheet. The zoom is expressed as a
  19371. fraction. For example to express a zoom of 75% use 3 for the numerator
  19372. and 4 for the denominator.
  19373. </summary>
  19374. <param name="numerator">The numerator for the zoom magnification.</param>
  19375. <param name="denominator">The denominator for the zoom magnification.</param>
  19376. </member>
  19377. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetZoom(System.Int32)">
  19378. Window zoom magnification for current view representing percent values.
  19379. Valid values range from 10 to 400. Horizontal &amp; Vertical scale together.
  19380. For example:
  19381. <pre>
  19382. 10 - 10%
  19383. 20 - 20%
  19384. ...
  19385. 100 - 100%
  19386. ...
  19387. 400 - 400%
  19388. </pre>
  19389. @param scale window zoom magnification
  19390. @throws IllegalArgumentException if scale is invalid
  19391. </member>
  19392. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetEnclosedBorderOfRegion(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.BorderStyle,System.Int16)">
  19393. <summary>
  19394. Sets the enclosed border of region.
  19395. </summary>
  19396. <param name="region">The region.</param>
  19397. <param name="borderType">Type of the border.</param>
  19398. <param name="color">The color.</param>
  19399. </member>
  19400. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetBorderRightOfRegion(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.BorderStyle,System.Int16)">
  19401. <summary>
  19402. Sets the right border of region.
  19403. </summary>
  19404. <param name="region">The region.</param>
  19405. <param name="borderType">Type of the border.</param>
  19406. <param name="color">The color.</param>
  19407. </member>
  19408. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetBorderLeftOfRegion(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.BorderStyle,System.Int16)">
  19409. <summary>
  19410. Sets the left border of region.
  19411. </summary>
  19412. <param name="region">The region.</param>
  19413. <param name="borderType">Type of the border.</param>
  19414. <param name="color">The color.</param>
  19415. </member>
  19416. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetBorderTopOfRegion(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.BorderStyle,System.Int16)">
  19417. <summary>
  19418. Sets the top border of region.
  19419. </summary>
  19420. <param name="region">The region.</param>
  19421. <param name="borderType">Type of the border.</param>
  19422. <param name="color">The color.</param>
  19423. </member>
  19424. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetBorderBottomOfRegion(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.BorderStyle,System.Int16)">
  19425. <summary>
  19426. Sets the bottom border of region.
  19427. </summary>
  19428. <param name="region">The region.</param>
  19429. <param name="borderType">Type of the border.</param>
  19430. <param name="color">The color.</param>
  19431. </member>
  19432. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.TopRow">
  19433. <summary>
  19434. The top row in the visible view when the _sheet is
  19435. first viewed after opening it in a viewer
  19436. </summary>
  19437. <value>the rownum (0 based) of the top row</value>
  19438. </member>
  19439. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.LeftCol">
  19440. <summary>
  19441. The left col in the visible view when the _sheet Is
  19442. first viewed after opening it in a viewer
  19443. </summary>
  19444. <value>the rownum (0 based) of the top row</value>
  19445. </member>
  19446. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShowInPane(System.Int32,System.Int32)">
  19447. Sets desktop window pane display area, when the
  19448. file is first opened in a viewer.
  19449. @param toprow the top row to show in desktop window pane
  19450. @param leftcol the left column to show in desktop window pane
  19451. </member>
  19452. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShowInPane(System.Int16,System.Int16)">
  19453. <summary>
  19454. Sets desktop window pane display area, when the
  19455. file is first opened in a viewer.
  19456. </summary>
  19457. <param name="toprow">the top row to show in desktop window pane</param>
  19458. <param name="leftcol">the left column to show in desktop window pane</param>
  19459. </member>
  19460. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShiftMerged(System.Int32,System.Int32,System.Int32,System.Boolean)">
  19461. <summary>
  19462. Shifts the merged regions left or right depending on mode
  19463. TODO: MODE , this is only row specific
  19464. </summary>
  19465. <param name="startRow">The start row.</param>
  19466. <param name="endRow">The end row.</param>
  19467. <param name="n">The n.</param>
  19468. <param name="IsRow">if set to <c>true</c> [is row].</param>
  19469. </member>
  19470. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32)">
  19471. <summary>
  19472. Shifts rows between startRow and endRow n number of rows.
  19473. If you use a negative number, it will Shift rows up.
  19474. Code Ensures that rows don't wrap around.
  19475. Calls ShiftRows(startRow, endRow, n, false, false);
  19476. Additionally Shifts merged regions that are completely defined in these
  19477. rows (ie. merged 2 cells on a row to be Shifted).
  19478. </summary>
  19479. <param name="startRow">the row to start Shifting</param>
  19480. <param name="endRow">the row to end Shifting</param>
  19481. <param name="n">the number of rows to Shift</param>
  19482. </member>
  19483. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean)">
  19484. <summary>
  19485. Shifts rows between startRow and endRow n number of rows.
  19486. If you use a negative number, it will shift rows up.
  19487. Code ensures that rows don't wrap around
  19488. Additionally shifts merged regions that are completely defined in these
  19489. rows (ie. merged 2 cells on a row to be shifted).
  19490. TODO Might want to add bounds checking here
  19491. </summary>
  19492. <param name="startRow">the row to start shifting</param>
  19493. <param name="endRow">the row to end shifting</param>
  19494. <param name="n">the number of rows to shift</param>
  19495. <param name="copyRowHeight">whether to copy the row height during the shift</param>
  19496. <param name="resetOriginalRowHeight">whether to set the original row's height to the default</param>
  19497. </member>
  19498. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean,System.Boolean)">
  19499. <summary>
  19500. Shifts rows between startRow and endRow n number of rows.
  19501. If you use a negative number, it will Shift rows up.
  19502. Code Ensures that rows don't wrap around
  19503. Additionally Shifts merged regions that are completely defined in these
  19504. rows (ie. merged 2 cells on a row to be Shifted).
  19505. TODO Might want to Add bounds Checking here
  19506. </summary>
  19507. <param name="startRow">the row to start Shifting</param>
  19508. <param name="endRow">the row to end Shifting</param>
  19509. <param name="n">the number of rows to Shift</param>
  19510. <param name="copyRowHeight">whether to copy the row height during the Shift</param>
  19511. <param name="resetOriginalRowHeight">whether to Set the original row's height to the default</param>
  19512. <param name="moveComments">if set to <c>true</c> [move comments].</param>
  19513. </member>
  19514. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.InsertChartRecords(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase})">
  19515. <summary>
  19516. Inserts the chart records.
  19517. </summary>
  19518. <param name="records">The records.</param>
  19519. </member>
  19520. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateFreezePane(System.Int32,System.Int32,System.Int32,System.Int32)">
  19521. <summary>
  19522. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  19523. </summary>
  19524. <param name="colSplit">Horizonatal position of split.</param>
  19525. <param name="rowSplit">Vertical position of split.</param>
  19526. <param name="leftmostColumn">Top row visible in bottom pane</param>
  19527. <param name="topRow">Left column visible in right pane.</param>
  19528. </member>
  19529. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateFreezePane(System.Int32,System.Int32)">
  19530. <summary>
  19531. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  19532. </summary>
  19533. <param name="colSplit">Horizonatal position of split.</param>
  19534. <param name="rowSplit">Vertical position of split.</param>
  19535. </member>
  19536. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateSplitPane(System.Int32,System.Int32,System.Int32,System.Int32,NPOI.SS.UserModel.PanePosition)">
  19537. <summary>
  19538. Creates a split pane. Any existing freezepane or split pane is overwritten.
  19539. </summary>
  19540. <param name="xSplitPos">Horizonatal position of split (in 1/20th of a point).</param>
  19541. <param name="ySplitPos">Vertical position of split (in 1/20th of a point).</param>
  19542. <param name="leftmostColumn">Left column visible in right pane.</param>
  19543. <param name="topRow">Top row visible in bottom pane.</param>
  19544. <param name="activePane">Active pane. One of: PANE_LOWER_RIGHT,PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFT</param>
  19545. </member>
  19546. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.PaneInformation">
  19547. <summary>
  19548. Returns the information regarding the currently configured pane (split or freeze).
  19549. </summary>
  19550. <value>null if no pane configured, or the pane information.</value>
  19551. </member>
  19552. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DisplayGridlines">
  19553. <summary>
  19554. Gets or sets if gridlines are Displayed.
  19555. </summary>
  19556. <value>whether gridlines are Displayed</value>
  19557. </member>
  19558. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DisplayFormulas">
  19559. <summary>
  19560. Gets or sets a value indicating whether formulas are displayed.
  19561. </summary>
  19562. <value>whether formulas are Displayed</value>
  19563. </member>
  19564. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DisplayRowColHeadings">
  19565. <summary>
  19566. Gets or sets a value indicating whether RowColHeadings are displayed.
  19567. </summary>
  19568. <value>
  19569. whether RowColHeadings are displayed
  19570. </value>
  19571. </member>
  19572. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetMargin(NPOI.SS.UserModel.MarginType)">
  19573. <summary>
  19574. Gets the size of the margin in inches.
  19575. </summary>
  19576. <param name="margin">which margin to get.</param>
  19577. <returns>the size of the margin</returns>
  19578. </member>
  19579. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetMargin(NPOI.SS.UserModel.MarginType,System.Double)">
  19580. <summary>
  19581. Sets the size of the margin in inches.
  19582. </summary>
  19583. <param name="margin">which margin to get.</param>
  19584. <param name="size">the size of the margin</param>
  19585. </member>
  19586. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetRowBreak(System.Int32)">
  19587. <summary>
  19588. Sets a page break at the indicated row
  19589. </summary>
  19590. <param name="row">The row.</param>
  19591. </member>
  19592. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.IsRowBroken(System.Int32)">
  19593. <summary>
  19594. Determines if there is a page break at the indicated row
  19595. </summary>
  19596. <param name="row">The row.</param>
  19597. <returns>
  19598. <c>true</c> if [is row broken] [the specified row]; otherwise, <c>false</c>.
  19599. </returns>
  19600. </member>
  19601. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveRowBreak(System.Int32)">
  19602. <summary>
  19603. Removes the page break at the indicated row
  19604. </summary>
  19605. <param name="row">The row.</param>
  19606. </member>
  19607. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.RowBreaks">
  19608. <summary>
  19609. Retrieves all the horizontal page breaks
  19610. </summary>
  19611. <value>all the horizontal page breaks, or null if there are no row page breaks</value>
  19612. </member>
  19613. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.ColumnBreaks">
  19614. <summary>
  19615. Retrieves all the vertical page breaks
  19616. </summary>
  19617. <value>all the vertical page breaks, or null if there are no column page breaks</value>
  19618. </member>
  19619. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetColumnBreak(System.Int32)">
  19620. <summary>
  19621. Sets a page break at the indicated column
  19622. </summary>
  19623. <param name="column">The column.</param>
  19624. </member>
  19625. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.IsColumnBroken(System.Int32)">
  19626. <summary>
  19627. Determines if there is a page break at the indicated column
  19628. </summary>
  19629. <param name="column">The column.</param>
  19630. <returns>
  19631. <c>true</c> if [is column broken] [the specified column]; otherwise, <c>false</c>.
  19632. </returns>
  19633. </member>
  19634. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveColumnBreak(System.Int32)">
  19635. <summary>
  19636. Removes a page break at the indicated column
  19637. </summary>
  19638. <param name="column">The column.</param>
  19639. </member>
  19640. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ValidateRow(System.Int32)">
  19641. <summary>
  19642. Runs a bounds Check for row numbers
  19643. </summary>
  19644. <param name="row">The row.</param>
  19645. </member>
  19646. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ValidateColumn(System.Int32)">
  19647. <summary>
  19648. Runs a bounds Check for column numbers
  19649. </summary>
  19650. <param name="column">The column.</param>
  19651. </member>
  19652. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.DumpDrawingRecords(System.Boolean)">
  19653. <summary>
  19654. Aggregates the drawing records and dumps the escher record hierarchy
  19655. to the standard output.
  19656. </summary>
  19657. <param name="fat">if set to <c>true</c> [fat].</param>
  19658. </member>
  19659. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DrawingEscherAggregate">
  19660. <summary>
  19661. Returns the agregate escher records for this _sheet,
  19662. it there is one.
  19663. WARNING - calling this will trigger a parsing of the
  19664. associated escher records. Any that aren't supported
  19665. (such as charts and complex drawing types) will almost
  19666. certainly be lost or corrupted when written out.
  19667. </summary>
  19668. <value>The drawing escher aggregate.</value>
  19669. </member>
  19670. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DrawingPatriarch">
  19671. This will hold any graphics or charts for the sheet.
  19672. @return the top-level drawing patriarch, if there is one, else returns null
  19673. </member>
  19674. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateDrawingPatriarch">
  19675. Creates the top-level drawing patriarch. This will have
  19676. the effect of removing any existing drawings on this
  19677. sheet.
  19678. This may then be used to add graphics or charts
  19679. @return The new patriarch.
  19680. </member>
  19681. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.TabColorIndex">
  19682. <summary>
  19683. Gets or sets the tab color of the _sheet
  19684. </summary>
  19685. </member>
  19686. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsAutoTabColor">
  19687. <summary>
  19688. Gets or sets whether the tab color of _sheet is automatic
  19689. </summary>
  19690. </member>
  19691. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetColumnGroupCollapsed(System.Int32,System.Boolean)">
  19692. <summary>
  19693. Expands or collapses a column Group.
  19694. </summary>
  19695. <param name="columnNumber">One of the columns in the Group.</param>
  19696. <param name="collapsed">true = collapse Group, false = expand Group.</param>
  19697. </member>
  19698. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GroupColumn(System.Int32,System.Int32)">
  19699. <summary>
  19700. Create an outline for the provided column range.
  19701. </summary>
  19702. <param name="fromColumn">beginning of the column range.</param>
  19703. <param name="toColumn">end of the column range.</param>
  19704. </member>
  19705. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.UngroupColumn(System.Int32,System.Int32)">
  19706. <summary>
  19707. Ungroups the column.
  19708. </summary>
  19709. <param name="fromColumn">From column.</param>
  19710. <param name="toColumn">To column.</param>
  19711. </member>
  19712. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GroupRow(System.Int32,System.Int32)">
  19713. <summary>
  19714. Groups the row.
  19715. </summary>
  19716. <param name="fromRow">From row.</param>
  19717. <param name="toRow">To row.</param>
  19718. </member>
  19719. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveArrayFormula(NPOI.SS.UserModel.ICell)">
  19720. <summary>
  19721. Remove a Array Formula from this sheet. All cells contained in the Array Formula range are removed as well
  19722. </summary>
  19723. <param name="cell">any cell within Array Formula range</param>
  19724. <returns>the <see cref="T:NPOI.SS.UserModel.ICellRange`1"/> of cells affected by this change</returns>
  19725. </member>
  19726. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetCellRange(NPOI.SS.Util.CellRangeAddress)">
  19727. <summary>
  19728. Also creates cells if they don't exist.
  19729. </summary>
  19730. </member>
  19731. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetArrayFormula(System.String,NPOI.SS.Util.CellRangeAddress)">
  19732. <summary>
  19733. Sets array formula to specified region for result.
  19734. </summary>
  19735. <param name="formula">text representation of the formula</param>
  19736. <param name="range">Region of array formula for result</param>
  19737. <returns>the <see cref="T:NPOI.SS.UserModel.ICellRange`1"/> of cells affected by this change</returns>
  19738. </member>
  19739. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.UngroupRow(System.Int32,System.Int32)">
  19740. <summary>
  19741. Ungroups the row.
  19742. </summary>
  19743. <param name="fromRow">From row.</param>
  19744. <param name="toRow">To row.</param>
  19745. </member>
  19746. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetRowGroupCollapsed(System.Int32,System.Boolean)">
  19747. <summary>
  19748. Sets the row group collapsed.
  19749. </summary>
  19750. <param name="row">The row.</param>
  19751. <param name="collapse">if set to <c>true</c> [collapse].</param>
  19752. </member>
  19753. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetDefaultColumnStyle(System.Int32,NPOI.SS.UserModel.ICellStyle)">
  19754. <summary>
  19755. Sets the default column style for a given column. POI will only apply this style to new cells Added to the _sheet.
  19756. </summary>
  19757. <param name="column">the column index</param>
  19758. <param name="style">the style to set</param>
  19759. </member>
  19760. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.IsMergedRegion(NPOI.SS.Util.CellRangeAddress)">
  19761. <summary>
  19762. Checks if the provided region is part of the merged regions.
  19763. </summary>
  19764. <param name="mergedRegion">Region searched in the merged regions</param>
  19765. <returns><c>true</c>, when the region is contained in at least one of the merged regions</returns>
  19766. </member>
  19767. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetMergedRegion(System.Int32)">
  19768. <summary>
  19769. Gets the merged region at the specified index
  19770. </summary>
  19771. <param name="index">The index.</param>
  19772. <returns></returns>
  19773. </member>
  19774. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.MergedRegions">
  19775. <summary>
  19776. get the list of merged regions
  19777. </summary>
  19778. <returns>return the list of merged regions</returns>
  19779. </member>
  19780. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetCellComment(System.Int32,System.Int32)">
  19781. <summary>
  19782. Returns cell comment for the specified row and column
  19783. </summary>
  19784. <param name="row">The row.</param>
  19785. <param name="column">The column.</param>
  19786. <returns>cell comment or null if not found</returns>
  19787. </member>
  19788. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetCellComment(NPOI.SS.Util.CellAddress)">
  19789. <summary>
  19790. Returns cell comment for the specified row and column
  19791. </summary>
  19792. <param name="ref1">cell location</param>
  19793. <returns>return cell comment or null if not found</returns>
  19794. </member>
  19795. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetHyperlink(System.Int32,System.Int32)">
  19796. <summary>
  19797. Get a Hyperlink in this sheet anchored at row, column
  19798. </summary>
  19799. <param name="row">The index of the row of the hyperlink, zero-based</param>
  19800. <param name="column">the index of the column of the hyperlink, zero-based</param>
  19801. <returns>return hyperlink if there is a hyperlink anchored at row, column; otherwise returns null</returns>
  19802. </member>
  19803. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetHyperlink(NPOI.SS.Util.CellAddress)">
  19804. <summary>
  19805. Get a Hyperlink in this sheet located in a cell specified by {code addr}
  19806. </summary>
  19807. <param name="addr">The address of the cell containing the hyperlink</param>
  19808. <returns>return hyperlink if there is a hyperlink anchored at {@code addr}; otherwise returns {@code null}</returns>
  19809. </member>
  19810. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetHyperlinkList">
  19811. Get a list of Hyperlinks in this sheet
  19812. @return Hyperlinks for the sheet
  19813. </member>
  19814. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveHyperlink(NPOI.HSSF.UserModel.HSSFHyperlink)">
  19815. Remove the underlying HyperlinkRecord from this sheet.
  19816. If multiple HSSFHyperlinks refer to the same HyperlinkRecord, all HSSFHyperlinks will be removed.
  19817. @param link the HSSFHyperlink wrapper around the HyperlinkRecord to remove
  19818. </member>
  19819. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveHyperlink(NPOI.HSSF.Record.HyperlinkRecord)">
  19820. Remove the underlying HyperlinkRecord from this sheet
  19821. @param link the underlying HyperlinkRecord to remove from this sheet
  19822. </member>
  19823. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.SheetConditionalFormatting">
  19824. <summary>
  19825. Gets the sheet conditional formatting.
  19826. </summary>
  19827. <value>The sheet conditional formatting.</value>
  19828. </member>
  19829. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DVRecords">
  19830. <summary>
  19831. Get the DVRecords objects that are associated to this _sheet
  19832. </summary>
  19833. <value>a list of DVRecord instances</value>
  19834. </member>
  19835. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Workbook">
  19836. <summary>
  19837. Provide a reference to the parent workbook.
  19838. </summary>
  19839. </member>
  19840. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.SheetName">
  19841. <summary>
  19842. Returns the name of this _sheet
  19843. </summary>
  19844. </member>
  19845. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetDataValidationHelper">
  19846. <summary>
  19847. Create an instance of a DataValidationHelper.
  19848. </summary>
  19849. <returns>Instance of a DataValidationHelper</returns>
  19850. </member>
  19851. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetAutoFilter(NPOI.SS.Util.CellRangeAddress)">
  19852. <summary>
  19853. Enable filtering for a range of cells
  19854. </summary>
  19855. <param name="range">the range of cells to filter</param>
  19856. </member>
  19857. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetCellComments">
  19858. <summary>
  19859. Returns all cell comments on this sheet.
  19860. </summary>
  19861. <returns>return A Dictionary of each Comment in the sheet, keyed on the cell address where the comment is located.</returns>
  19862. </member>
  19863. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.FindCellCommentLocations(NPOI.HSSF.UserModel.HSSFShapeContainer,System.Collections.Generic.Dictionary{NPOI.SS.Util.CellAddress,NPOI.SS.UserModel.IComment})">
  19864. Finds all cell comments in this sheet and adds them to the specified locations map
  19865. @param container a container that may contain HSSFComments
  19866. @param locations the map to store the HSSFComments in
  19867. </member>
  19868. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetColumnOutlineLevel(System.Int32)">
  19869. <summary>
  19870. Returns the column outline level. Increased as you
  19871. put it into more groups (outlines), reduced as
  19872. you take it out of them.
  19873. </summary>
  19874. <param name="columnIndex"></param>
  19875. <returns></returns>
  19876. </member>
  19877. <member name="T:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting">
  19878. <summary>
  19879. The Conditional Formatting facet of HSSFSheet
  19880. @author Dmitriy Kumshayev
  19881. </summary>
  19882. </member>
  19883. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.ComparisonOperator,System.String,System.String)">
  19884. <summary>
  19885. A factory method allowing to Create a conditional formatting rule
  19886. with a cell comparison operator
  19887. TODO - formulas containing cell references are currently not Parsed properly
  19888. </summary>
  19889. <param name="comparisonOperation">a constant value from HSSFConditionalFormattingRule.ComparisonOperator</param>
  19890. <param name="formula1">formula for the valued, Compared with the cell</param>
  19891. <param name="formula2">second formula (only used with HSSFConditionalFormattingRule#COMPARISON_OPERATOR_BETWEEN
  19892. and HSSFConditionalFormattingRule#COMPARISON_OPERATOR_NOT_BETWEEN operations)</param>
  19893. <returns></returns>
  19894. </member>
  19895. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.CreateConditionalFormattingRule(System.String)">
  19896. <summary>
  19897. A factory method allowing to Create a conditional formatting rule with a formula.
  19898. The formatting rules are applied by Excel when the value of the formula not equal to 0.
  19899. TODO - formulas containing cell references are currently not Parsed properly
  19900. </summary>
  19901. <param name="formula">formula for the valued, Compared with the cell</param>
  19902. <returns></returns>
  19903. </member>
  19904. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.IconSet)">
  19905. A factory method allowing the creation of conditional formatting
  19906. rules using an Icon Set / Multi-State formatting.
  19907. The thresholds for it will be created, but will be empty
  19908. and require configuring with
  19909. {@link HSSFConditionalFormattingRule#getMultiStateFormatting()}
  19910. then
  19911. {@link HSSFIconMultiStateFormatting#getThresholds()}
  19912. </member>
  19913. <!-- Badly formed XML comment ignored for member "M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.HSSF.UserModel.HSSFExtendedColor)" -->
  19914. <!-- Badly formed XML comment ignored for member "M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.CreateConditionalFormattingColorScaleRule" -->
  19915. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.AddConditionalFormatting(NPOI.HSSF.UserModel.HSSFConditionalFormatting)">
  19916. <summary>
  19917. Adds a copy of HSSFConditionalFormatting object to the sheet
  19918. This method could be used to copy HSSFConditionalFormatting object
  19919. from one sheet to another.
  19920. </summary>
  19921. <param name="cf">HSSFConditionalFormatting object</param>
  19922. <returns>index of the new Conditional Formatting object</returns>
  19923. <example>
  19924. HSSFConditionalFormatting cf = sheet.GetConditionalFormattingAt(index);
  19925. newSheet.AddConditionalFormatting(cf);
  19926. </example>
  19927. </member>
  19928. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule[])">
  19929. <summary>
  19930. Allows to Add a new Conditional Formatting Set to the sheet.
  19931. </summary>
  19932. <param name="regions">list of rectangular regions to apply conditional formatting rules</param>
  19933. <param name="cfRules">Set of up to three conditional formatting rules</param>
  19934. <returns>index of the newly Created Conditional Formatting object</returns>
  19935. </member>
  19936. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule)">
  19937. <summary>
  19938. Adds the conditional formatting.
  19939. </summary>
  19940. <param name="regions">The regions.</param>
  19941. <param name="rule1">The rule1.</param>
  19942. <returns></returns>
  19943. </member>
  19944. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule,NPOI.SS.UserModel.IConditionalFormattingRule)">
  19945. <summary>
  19946. Adds the conditional formatting.
  19947. </summary>
  19948. <param name="regions">The regions.</param>
  19949. <param name="rule1">The rule1.</param>
  19950. <param name="rule2">The rule2.</param>
  19951. <returns></returns>
  19952. </member>
  19953. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.GetConditionalFormattingAt(System.Int32)">
  19954. <summary>
  19955. Gets Conditional Formatting object at a particular index
  19956. @param index
  19957. of the Conditional Formatting object to fetch
  19958. </summary>
  19959. <param name="index">Conditional Formatting object</param>
  19960. <returns></returns>
  19961. </member>
  19962. <member name="P:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.NumConditionalFormattings">
  19963. <summary>
  19964. the number of Conditional Formatting objects of the sheet
  19965. </summary>
  19966. <value>The num conditional formattings.</value>
  19967. </member>
  19968. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.RemoveConditionalFormatting(System.Int32)">
  19969. <summary>
  19970. Removes a Conditional Formatting object by index
  19971. </summary>
  19972. <param name="index">index of a Conditional Formatting object to Remove</param>
  19973. </member>
  19974. <member name="T:NPOI.HSSF.UserModel.HSSFSimpleShape">
  19975. <summary>
  19976. Represents a simple shape such as a line, rectangle or oval.
  19977. @author Glen Stampoultzis (glens at apache.org)
  19978. </summary>
  19979. </member>
  19980. <member name="M:NPOI.HSSF.UserModel.HSSFSimpleShape.#ctor(NPOI.HSSF.UserModel.HSSFShape,NPOI.HSSF.UserModel.HSSFAnchor)">
  19981. <summary>
  19982. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFSimpleShape"/> class.
  19983. </summary>
  19984. <param name="parent">The parent.</param>
  19985. <param name="anchor">The anchor.</param>
  19986. </member>
  19987. <member name="P:NPOI.HSSF.UserModel.HSSFSimpleShape.ShapeType">
  19988. <summary>
  19989. Gets the shape type.
  19990. </summary>
  19991. <value>One of the OBJECT_TYPE_* constants.</value>
  19992. @see #OBJECT_TYPE_LINE
  19993. @see #OBJECT_TYPE_OVAL
  19994. @see #OBJECT_TYPE_RECTANGLE
  19995. @see #OBJECT_TYPE_PICTURE
  19996. @see #OBJECT_TYPE_COMMENT
  19997. </member>
  19998. <member name="P:NPOI.HSSF.UserModel.HSSFSimpleShape.String">
  19999. <summary>
  20000. Get or set the rich text string used by this object.
  20001. </summary>
  20002. </member>
  20003. <member name="T:NPOI.HSSF.UserModel.HSSFTextbox">
  20004. <summary>
  20005. A textbox Is a shape that may hold a rich text string.
  20006. @author Glen Stampoultzis (glens at apache.org)
  20007. </summary>
  20008. </member>
  20009. <member name="M:NPOI.HSSF.UserModel.HSSFTextbox.#ctor(NPOI.HSSF.UserModel.HSSFShape,NPOI.HSSF.UserModel.HSSFAnchor)">
  20010. <summary>
  20011. Construct a new textbox with the given parent and anchor.
  20012. </summary>
  20013. <param name="parent">The parent.</param>
  20014. <param name="anchor">One of HSSFClientAnchor or HSSFChildAnchor</param>
  20015. </member>
  20016. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.MarginLeft">
  20017. <summary>
  20018. Gets or sets the left margin within the textbox.
  20019. </summary>
  20020. <value>The margin left.</value>
  20021. </member>
  20022. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.MarginRight">
  20023. <summary>
  20024. Gets or sets the right margin within the textbox.
  20025. </summary>
  20026. <value>The margin right.</value>
  20027. </member>
  20028. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.MarginTop">
  20029. <summary>
  20030. Gets or sets the top margin within the textbox
  20031. </summary>
  20032. <value>The top margin.</value>
  20033. </member>
  20034. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.MarginBottom">
  20035. <summary>
  20036. Gets or sets the bottom margin within the textbox.
  20037. </summary>
  20038. <value>The margin bottom.</value>
  20039. </member>
  20040. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.HorizontalAlignment">
  20041. <summary>
  20042. Gets or sets the horizontal alignment.
  20043. </summary>
  20044. <value>The horizontal alignment.</value>
  20045. </member>
  20046. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.VerticalAlignment">
  20047. <summary>
  20048. Gets or sets the vertical alignment.
  20049. </summary>
  20050. <value>The vertical alignment.</value>
  20051. </member>
  20052. <member name="T:NPOI.HSSF.UserModel.HSSFWorkbook">
  20053. <summary>
  20054. High level representation of a workbook. This is the first object most users
  20055. will construct whether they are reading or writing a workbook. It is also the
  20056. top level object for creating new sheets/etc.
  20057. </summary>
  20058. @author Andrew C. Oliver (acoliver at apache dot org)
  20059. @author Glen Stampoultzis (glens at apache.org)
  20060. @author Shawn Laubach (slaubach at apache dot org)
  20061. </member>
  20062. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.MAX_STYLES">
  20063. The maximum number of cell styles in a .xls workbook.
  20064. The 'official' limit is 4,000, but POI allows a slightly larger number.
  20065. This extra delta takes into account built-in styles that are automatically
  20066. created for new workbooks
  20067. See http://office.microsoft.com/en-us/excel-help/excel-specifications-and-limits-HP005199291.aspx
  20068. </member>
  20069. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.INITIAL_CAPACITY">
  20070. used for compile-time performance/memory optimization. This determines the
  20071. initial capacity for the sheet collection. Its currently Set to 3.
  20072. Changing it in this release will decrease performance
  20073. since you're never allowed to have more or less than three sheets!
  20074. </member>
  20075. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.workbook">
  20076. this Is the reference to the low level Workbook object
  20077. </member>
  20078. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook._sheets">
  20079. this holds the HSSFSheet objects attached to this workbook
  20080. </member>
  20081. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.names">
  20082. this holds the HSSFName objects attached to this workbook
  20083. </member>
  20084. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.preserveNodes">
  20085. holds whether or not to preserve other nodes in the POIFS. Used
  20086. for macros and embedded objects.
  20087. </member>
  20088. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.formatter">
  20089. Used to keep track of the data formatter so that all
  20090. CreateDataFormatter calls return the same one for a given
  20091. book. This Ensures that updates from one places Is visible
  20092. someplace else.
  20093. </member>
  20094. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.fonts">
  20095. this holds the HSSFFont objects attached to this workbook.
  20096. We only create these from the low level records as required.
  20097. </member>
  20098. <member name="T:NPOI.HSSF.UserModel.HSSFWorkbook.SheetRecordCollector">
  20099. <summary>
  20100. Totals the sizes of all sheet records and eventually serializes them
  20101. </summary>
  20102. </member>
  20103. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor">
  20104. <summary>
  20105. Creates new HSSFWorkbook from scratch (start here!)
  20106. </summary>
  20107. </member>
  20108. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  20109. Companion to HSSFWorkbook(POIFSFileSystem), this constructs the
  20110. POI filesystem around your inputstream, including all nodes.
  20111. This calls {@link #HSSFWorkbook(InputStream, boolean)} with
  20112. preserve nodes set to true.
  20113. @see #HSSFWorkbook(InputStream, boolean)
  20114. @see #HSSFWorkbook(POIFSFileSystem)
  20115. @see org.apache.poi.poifs.filesystem.POIFSFileSystem
  20116. @exception IOException if the stream cannot be read
  20117. </member>
  20118. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(NPOI.POIFS.FileSystem.NPOIFSFileSystem)">
  20119. Given a POI POIFSFileSystem object, read in its Workbook along
  20120. with all related nodes, and populate the high and low level models.
  20121. This calls {@link #HSSFWorkbook(POIFSFileSystem, boolean)} with
  20122. preserve nodes set to true.
  20123. @see #HSSFWorkbook(POIFSFileSystem, boolean)
  20124. @see org.apache.poi.poifs.filesystem.POIFSFileSystem
  20125. @exception IOException if the stream cannot be read
  20126. </member>
  20127. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(NPOI.POIFS.FileSystem.POIFSFileSystem,System.Boolean)">
  20128. <summary>
  20129. given a POI POIFSFileSystem object, Read in its Workbook and populate the high and
  20130. low level models. If you're Reading in a workbook...start here.
  20131. </summary>
  20132. <param name="fs">the POI filesystem that Contains the Workbook stream.</param>
  20133. <param name="preserveNodes">whether to preseve other nodes, such as
  20134. macros. This takes more memory, so only say yes if you
  20135. need to. If Set, will store all of the POIFSFileSystem
  20136. in memory</param>
  20137. </member>
  20138. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(NPOI.POIFS.FileSystem.DirectoryNode,NPOI.POIFS.FileSystem.POIFSFileSystem,System.Boolean)">
  20139. <summary>
  20140. given a POI POIFSFileSystem object, and a specific directory
  20141. within it, Read in its Workbook and populate the high and
  20142. low level models. If you're Reading in a workbook...start here.
  20143. </summary>
  20144. <param name="directory">the POI filesystem directory to Process from</param>
  20145. <param name="fs">the POI filesystem that Contains the Workbook stream.</param>
  20146. <param name="preserveNodes">whether to preseve other nodes, such as
  20147. macros. This takes more memory, so only say yes if you
  20148. need to. If Set, will store all of the POIFSFileSystem
  20149. in memory</param>
  20150. </member>
  20151. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(NPOI.POIFS.FileSystem.DirectoryNode,System.Boolean)">
  20152. given a POI POIFSFileSystem object, and a specific directory
  20153. within it, read in its Workbook and populate the high and
  20154. low level models. If you're reading in a workbook...start here.
  20155. @param directory the POI filesystem directory to process from
  20156. @param preserveNodes whether to preseve other nodes, such as
  20157. macros. This takes more memory, so only say yes if you
  20158. need to. If set, will store all of the POIFSFileSystem
  20159. in memory
  20160. @see org.apache.poi.poifs.filesystem.POIFSFileSystem
  20161. @exception IOException if the stream cannot be read
  20162. </member>
  20163. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(System.IO.Stream,System.Boolean)">
  20164. Companion to HSSFWorkbook(POIFSFileSystem), this constructs the POI filesystem around your
  20165. inputstream.
  20166. @param s the POI filesystem that Contains the Workbook stream.
  20167. @param preserveNodes whether to preseve other nodes, such as
  20168. macros. This takes more memory, so only say yes if you
  20169. need to.
  20170. @see org.apache.poi.poifs.filesystem.POIFSFileSystem
  20171. @see #HSSFWorkbook(POIFSFileSystem)
  20172. @exception IOException if the stream cannot be Read
  20173. </member>
  20174. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetPropertiesFromWorkbook(NPOI.HSSF.Model.InternalWorkbook)">
  20175. used internally to Set the workbook properties.
  20176. </member>
  20177. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.ConvertLabelRecords(System.Collections.IList,System.Int32)">
  20178. <summary>
  20179. This is basically a kludge to deal with the now obsolete Label records. If
  20180. you have to read in a sheet that contains Label records, be aware that the rest
  20181. of the API doesn't deal with them, the low level structure only provides Read-only
  20182. semi-immutable structures (the Sets are there for interface conformance with NO
  20183. impelmentation). In short, you need to call this function passing it a reference
  20184. to the Workbook object. All labels will be converted to LabelSST records and their
  20185. contained strings will be written to the Shared String tabel (SSTRecord) within
  20186. the Workbook.
  20187. </summary>
  20188. <param name="records">The records.</param>
  20189. <param name="offset">The offset.</param>
  20190. </member>
  20191. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.MissingCellPolicy">
  20192. <summary>
  20193. Retrieves the current policy on what to do when
  20194. getting missing or blank cells from a row.
  20195. The default is to return blank and null cells.
  20196. </summary>
  20197. <value>The missing cell policy.</value>
  20198. </member>
  20199. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSheetOrder(System.String,System.Int32)">
  20200. <summary>
  20201. Sets the order of appearance for a given sheet.
  20202. </summary>
  20203. <param name="sheetname">the name of the sheet to reorder</param>
  20204. <param name="pos">the position that we want to Insert the sheet into (0 based)</param>
  20205. </member>
  20206. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.ValidateSheetIndex(System.Int32)">
  20207. <summary>
  20208. Validates the index of the sheet.
  20209. </summary>
  20210. <param name="index">The index.</param>
  20211. </member>
  20212. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.InsertChartRecord">
  20213. Test only. Do not use
  20214. </member>
  20215. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSelectedTab(System.Int32)">
  20216. <summary>
  20217. Selects a single sheet. This may be different to
  20218. the 'active' sheet (which Is the sheet with focus).
  20219. </summary>
  20220. <param name="index">The index.</param>
  20221. </member>
  20222. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSelectedTabs(System.Int32[])">
  20223. <summary>
  20224. Sets the selected tabs.
  20225. </summary>
  20226. <param name="indexes">The indexes.</param>
  20227. </member>
  20228. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSelectedTabs(System.Collections.Generic.IList{System.Int32})">
  20229. Selects multiple sheets as a group. This is distinct from
  20230. the 'active' sheet (which is the sheet with focus).
  20231. Unselects sheets that are not in <code>indexes</code>.
  20232. @param indexes
  20233. </member>
  20234. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSelectedTabs">
  20235. Gets the selected sheets (if more than one, Excel calls these a [Group]).
  20236. @return indices of selected sheets
  20237. </member>
  20238. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.ActiveSheetIndex">
  20239. <summary>
  20240. Gets the tab whose data is actually seen when the sheet is opened.
  20241. This may be different from the "selected sheet" since excel seems to
  20242. allow you to show the data of one sheet when another Is seen "selected"
  20243. in the tabs (at the bottom).
  20244. </summary>
  20245. </member>
  20246. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetActiveSheet(System.Int32)">
  20247. <summary>
  20248. Sets the tab whose data is actually seen when the sheet is opened.
  20249. This may be different from the "selected sheet" since excel seems to
  20250. allow you to show the data of one sheet when another Is seen "selected"
  20251. in the tabs (at the bottom).
  20252. <param name="index">The sheet number(0 based).</param>
  20253. </summary>
  20254. </member>
  20255. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.FirstVisibleTab">
  20256. <summary>
  20257. Gets or sets the first tab that is displayed in the list of tabs
  20258. in excel. This method does <b>not</b> hide, select or focus sheets.
  20259. It just sets the scroll position in the tab-bar.
  20260. @param index the sheet index of the tab that will become the first in the tab-bar
  20261. </summary>
  20262. </member>
  20263. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.ENCODING_COMPRESSED_UNICODE">
  20264. @deprecated POI will now properly handle Unicode strings without
  20265. forceing an encoding
  20266. </member>
  20267. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.ENCODING_UTF_16">
  20268. @deprecated POI will now properly handle Unicode strings without
  20269. forceing an encoding
  20270. </member>
  20271. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSheetName(System.Int32,System.String)">
  20272. <summary>
  20273. Set the sheet name.
  20274. </summary>
  20275. <param name="sheetIx">The sheet number(0 based).</param>
  20276. <param name="name">The name.</param>
  20277. </member>
  20278. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheetName(System.Int32)">
  20279. <summary>
  20280. Get the sheet name
  20281. </summary>
  20282. <param name="sheetIx">The sheet index.</param>
  20283. <returns>Sheet name</returns>
  20284. </member>
  20285. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.IsSheetHidden(System.Int32)">
  20286. <summary>
  20287. Check whether a sheet is hidden
  20288. </summary>
  20289. <param name="sheetIx">The sheet index.</param>
  20290. <returns>
  20291. <c>true</c> if sheet is hidden; otherwise, <c>false</c>.
  20292. </returns>
  20293. </member>
  20294. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.IsSheetVeryHidden(System.Int32)">
  20295. <summary>
  20296. Check whether a sheet is very hidden.
  20297. This is different from the normal
  20298. hidden status
  20299. </summary>
  20300. <param name="sheetIx">The sheet index.</param>
  20301. <returns>
  20302. <c>true</c> if sheet is very hidden; otherwise, <c>false</c>.
  20303. </returns>
  20304. </member>
  20305. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSheetHidden(System.Int32,NPOI.SS.UserModel.SheetState)">
  20306. <summary>
  20307. Hide or Unhide a sheet
  20308. </summary>
  20309. <param name="sheetIx">The sheet index</param>
  20310. <param name="hidden">True to mark the sheet as hidden, false otherwise</param>
  20311. </member>
  20312. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSheetHidden(System.Int32,System.Int32)">
  20313. <summary>
  20314. Hide or unhide a sheet.
  20315. </summary>
  20316. <param name="sheetIx">The sheet number</param>
  20317. <param name="hidden">0 for not hidden, 1 for hidden, 2 for very hidden</param>
  20318. </member>
  20319. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheetIndex(System.String)">
  20320. <summary>
  20321. Returns the index of the sheet by his name
  20322. </summary>
  20323. <param name="name">the sheet name</param>
  20324. <returns>index of the sheet (0 based)</returns>
  20325. </member>
  20326. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheetIndex(NPOI.SS.UserModel.ISheet)">
  20327. <summary>
  20328. Returns the index of the given sheet
  20329. </summary>
  20330. <param name="sheet">the sheet to look up</param>
  20331. <returns>index of the sheet (0 based).-1
  20332. if not found </returns>
  20333. </member>
  20334. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateSheet">
  20335. <summary>
  20336. Create an HSSFSheet for this HSSFWorkbook, Adds it to the sheets and returns
  20337. the high level representation. Use this to Create new sheets.
  20338. </summary>
  20339. <returns>HSSFSheet representing the new sheet.</returns>
  20340. </member>
  20341. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CloneSheet(System.Int32)">
  20342. <summary>
  20343. Create an HSSFSheet from an existing sheet in the HSSFWorkbook.
  20344. </summary>
  20345. <param name="sheetIndex">the sheet index</param>
  20346. <returns>HSSFSheet representing the Cloned sheet.</returns>
  20347. </member>
  20348. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetUniqueSheetName(System.String)">
  20349. <summary>
  20350. Gets the name of the unique sheet.
  20351. </summary>
  20352. <param name="srcName">Name of the SRC.</param>
  20353. <returns></returns>
  20354. </member>
  20355. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateSheet(System.String)">
  20356. <summary>
  20357. Create an HSSFSheet for this HSSFWorkbook, Adds it to the sheets and
  20358. returns the high level representation. Use this to Create new sheets.
  20359. </summary>
  20360. <param name="sheetname">sheetname to set for the sheet.</param>
  20361. <returns>HSSFSheet representing the new sheet.</returns>
  20362. </member>
  20363. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.NumberOfSheets">
  20364. <summary>
  20365. Get the number of spreadsheets in the workbook (this will be three after serialization)
  20366. </summary>
  20367. <value>The number of sheets.</value>
  20368. </member>
  20369. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheets">
  20370. <summary>
  20371. Gets the sheets.
  20372. </summary>
  20373. <returns></returns>
  20374. </member>
  20375. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheetAt(System.Int32)">
  20376. <summary>
  20377. Get the HSSFSheet object at the given index.
  20378. </summary>
  20379. <param name="index">index of the sheet number (0-based)</param>
  20380. <returns>HSSFSheet at the provided index</returns>
  20381. </member>
  20382. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheet(System.String)">
  20383. <summary>
  20384. Get sheet with the given name (case insensitive match)
  20385. </summary>
  20386. <param name="name">name of the sheet</param>
  20387. <returns>HSSFSheet with the name provided or null if it does not exist</returns>
  20388. </member>
  20389. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.RemoveSheetAt(System.Int32)">
  20390. <summary>
  20391. Removes sheet at the given index.
  20392. </summary>
  20393. <param name="index">index of the sheet (0-based)</param>
  20394. <remarks>
  20395. Care must be taken if the Removed sheet Is the currently active or only selected sheet in
  20396. the workbook. There are a few situations when Excel must have a selection and/or active
  20397. sheet. (For example when printing - see Bug 40414).
  20398. This method makes sure that if the Removed sheet was active, another sheet will become
  20399. active in its place. Furthermore, if the Removed sheet was the only selected sheet, another
  20400. sheet will become selected. The newly active/selected sheet will have the same index, or
  20401. one less if the Removed sheet was the last in the workbook.
  20402. </remarks>
  20403. </member>
  20404. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.BackupFlag">
  20405. <summary>
  20406. determine whether the Excel GUI will backup the workbook when saving.
  20407. </summary>
  20408. <value>the current Setting for backups.</value>
  20409. </member>
  20410. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateFont">
  20411. <summary>
  20412. Create a new Font and Add it to the workbook's font table
  20413. </summary>
  20414. <returns>new font object</returns>
  20415. </member>
  20416. <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)">
  20417. <summary>
  20418. Finds a font that matches the one with the supplied attributes
  20419. </summary>
  20420. <param name="boldWeight">The bold weight.</param>
  20421. <param name="color">The color.</param>
  20422. <param name="fontHeight">Height of the font.</param>
  20423. <param name="name">The name.</param>
  20424. <param name="italic">if set to <c>true</c> [italic].</param>
  20425. <param name="strikeout">if set to <c>true</c> [strikeout].</param>
  20426. <param name="typeOffset">The type offset.</param>
  20427. <param name="underline">The underline.</param>
  20428. <returns></returns>
  20429. </member>
  20430. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.FindFont(System.Boolean,System.Int16,System.Int16,System.String,System.Boolean,System.Boolean,NPOI.SS.UserModel.FontSuperScript,NPOI.SS.UserModel.FontUnderlineType)">
  20431. <summary>
  20432. Finds a font that matches the one with the supplied attributes
  20433. </summary>
  20434. <param name="bold">The bold weight.</param>
  20435. <param name="color">The color.</param>
  20436. <param name="fontHeight">Height of the font.</param>
  20437. <param name="name">The name.</param>
  20438. <param name="italic">if set to <c>true</c> [italic].</param>
  20439. <param name="strikeout">if set to <c>true</c> [strikeout].</param>
  20440. <param name="typeOffset">The type offset.</param>
  20441. <param name="underline">The underline.</param>
  20442. <returns></returns>
  20443. </member>
  20444. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.FindFont(System.Boolean,NPOI.HSSF.Util.HSSFColor,System.Int16,System.String,System.Boolean,System.Boolean,NPOI.SS.UserModel.FontSuperScript,NPOI.SS.UserModel.FontUnderlineType)">
  20445. <summary>
  20446. Finds a font that matches the one with the supplied attributes
  20447. </summary>
  20448. <param name="bold">The bold weight.</param>
  20449. <param name="color">The color.</param>
  20450. <param name="fontHeight">Height of the font.</param>
  20451. <param name="name">The name.</param>
  20452. <param name="italic">if set to <c>true</c> [italic].</param>
  20453. <param name="strikeout">if set to <c>true</c> [strikeout].</param>
  20454. <param name="typeOffset">The type offset.</param>
  20455. <param name="underline">The underline.</param>
  20456. <returns></returns>
  20457. </member>
  20458. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.NumberOfFonts">
  20459. <summary>
  20460. Get the number of fonts in the font table
  20461. </summary>
  20462. <value>The number of fonts.</value>
  20463. </member>
  20464. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetFontAt(System.Int16)">
  20465. <summary>
  20466. Get the font at the given index number
  20467. </summary>
  20468. <param name="idx">The index number</param>
  20469. <returns>HSSFFont at the index</returns>
  20470. </member>
  20471. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.ResetFontCache">
  20472. <summary>
  20473. Reset the fonts cache, causing all new calls
  20474. to getFontAt() to create new objects.
  20475. Should only be called after deleting fonts,
  20476. and that's not something you should normally do
  20477. </summary>
  20478. </member>
  20479. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateCellStyle">
  20480. <summary>
  20481. Create a new Cell style and Add it to the workbook's style table
  20482. </summary>
  20483. <returns>the new Cell Style object</returns>
  20484. </member>
  20485. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.NumCellStyles">
  20486. <summary>
  20487. Get the number of styles the workbook Contains
  20488. </summary>
  20489. <value>count of cell styles</value>
  20490. </member>
  20491. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetCellStyleAt(System.Int32)">
  20492. <summary>
  20493. Get the cell style object at the given index
  20494. </summary>
  20495. <param name="idx">index within the Set of styles</param>
  20496. <returns>HSSFCellStyle object at the index</returns>
  20497. </member>
  20498. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.Close">
  20499. Closes the underlying {@link NPOIFSFileSystem} from which
  20500. the Workbook was read, if any. Has no effect on Workbooks
  20501. opened from an InputStream, or newly created ones.
  20502. Once {@link #close()} has been called, no further
  20503. operations, updates or reads should be performed on the
  20504. Workbook.
  20505. </member>
  20506. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.Write">
  20507. Write out this workbook to the currently open {@link File} via the
  20508. writeable {@link POIFSFileSystem} it was opened as.
  20509. This will fail (with an {@link InvalidOperationException} if the
  20510. Workbook was opened read-only, opened from an {@link InputStream}
  20511. instead of a File, or if this is not the root document. For those cases,
  20512. you must use {@link #write(OutputStream)} or {@link #write(File)} to
  20513. write to a brand new document.
  20514. </member>
  20515. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.Write(System.IO.FileInfo)">
  20516. Method write - write out this workbook to a new {@link File}. Constructs
  20517. a new POI POIFSFileSystem, passes in the workbook binary representation and
  20518. writes it out. If the file exists, it will be replaced, otherwise a new one
  20519. will be created.
  20520. Note that you cannot write to the currently open File using this method.
  20521. If you opened your Workbook from a File, you <i>must</i> use the {@link #write()}
  20522. method instead!
  20523. @param newFile - the new File you wish to write the XLS to
  20524. @exception IOException if anything can't be written.
  20525. @see org.apache.poi.poifs.filesystem.POIFSFileSystem
  20526. </member>
  20527. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.Write(System.IO.Stream)">
  20528. <summary>
  20529. Write out this workbook to an Outputstream. Constructs
  20530. a new POI POIFSFileSystem, passes in the workbook binary representation and
  20531. Writes it out.
  20532. If {@code stream} is a {@link java.io.FileOutputStream} on a networked drive
  20533. or has a high cost/latency associated with each written byte,
  20534. consider wrapping the OutputStream in a {@link java.io.BufferedOutputStream}
  20535. to improve write performance.
  20536. </summary>
  20537. <param name="stream">the java OutputStream you wish to Write the XLS to</param>
  20538. </member>
  20539. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.Write(NPOI.POIFS.FileSystem.NPOIFSFileSystem)">
  20540. Writes the workbook out to a brand new, empty POIFS
  20541. </member>
  20542. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetBytes">
  20543. <summary>
  20544. Get the bytes of just the HSSF portions of the XLS file.
  20545. Use this to construct a POI POIFSFileSystem yourself.
  20546. </summary>
  20547. <returns>byte[] array containing the binary representation of this workbook and all contained
  20548. sheets, rows, cells, etc.</returns>
  20549. </member>
  20550. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook._udfFinder">
  20551. The locator of user-defined functions.
  20552. By default includes functions from the Excel Analysis Toolpack
  20553. </member>
  20554. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.AddToolPack(NPOI.SS.Formula.UDF.UDFFinder)">
  20555. Register a new toolpack in this workbook.
  20556. @param toopack the toolpack to register
  20557. </member>
  20558. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.Workbook">
  20559. <summary>
  20560. Gets the workbook.
  20561. </summary>
  20562. <value>The workbook.</value>
  20563. </member>
  20564. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.NumberOfNames">
  20565. <summary>
  20566. Gets the total number of named ranges in the workboko
  20567. </summary>
  20568. <value>The number of named ranges</value>
  20569. </member>
  20570. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetNameAt(System.Int32)">
  20571. <summary>
  20572. Gets the Named range
  20573. </summary>
  20574. <param name="nameIndex">position of the named range</param>
  20575. <returns>named range high level</returns>
  20576. </member>
  20577. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetNameName(System.Int32)">
  20578. <summary>
  20579. Gets the named range name
  20580. </summary>
  20581. <param name="index">the named range index (0 based)</param>
  20582. <returns>named range name</returns>
  20583. </member>
  20584. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetPrintArea(System.Int32,System.String)">
  20585. <summary>
  20586. Sets the printarea for the sheet provided
  20587. i.e. Reference = $A$1:$B$2
  20588. </summary>
  20589. <param name="sheetIndex">Zero-based sheet index (0 Represents the first sheet to keep consistent with java)</param>
  20590. <param name="reference">Valid name Reference for the Print Area</param>
  20591. </member>
  20592. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetPrintArea(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  20593. <summary>
  20594. Sets the print area.
  20595. </summary>
  20596. <param name="sheetIndex">Zero-based sheet index (0 = First Sheet)</param>
  20597. <param name="startColumn">Column to begin printarea</param>
  20598. <param name="endColumn">Column to end the printarea</param>
  20599. <param name="startRow">Row to begin the printarea</param>
  20600. <param name="endRow">Row to end the printarea</param>
  20601. </member>
  20602. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetPrintArea(System.Int32)">
  20603. <summary>
  20604. Retrieves the reference for the printarea of the specified sheet, the sheet name Is Appended to the reference even if it was not specified.
  20605. </summary>
  20606. <param name="sheetIndex">Zero-based sheet index (0 Represents the first sheet to keep consistent with java)</param>
  20607. <returns>String Null if no print area has been defined</returns>
  20608. </member>
  20609. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.RemovePrintArea(System.Int32)">
  20610. <summary>
  20611. Delete the printarea for the sheet specified
  20612. </summary>
  20613. <param name="sheetIndex">Zero-based sheet index (0 = First Sheet)</param>
  20614. </member>
  20615. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateName">
  20616. <summary>
  20617. Creates a new named range and Add it to the model
  20618. </summary>
  20619. <returns>named range high level</returns>
  20620. </member>
  20621. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetNameIndex(System.String)">
  20622. <summary>
  20623. Gets the named range index by his name
  20624. Note:
  20625. Excel named ranges are case-insensitive and
  20626. this method performs a case-insensitive search.
  20627. </summary>
  20628. <param name="name">named range name</param>
  20629. <returns>named range index</returns>
  20630. </member>
  20631. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetNameIndex(NPOI.HSSF.UserModel.HSSFName)">
  20632. <summary>
  20633. As GetNameIndex(String) is not necessarily unique
  20634. (name + sheet index is unique), this method is more accurate.
  20635. </summary>
  20636. <param name="name">the name whose index in the list of names of this workbook should be looked up.</param>
  20637. <returns>an index value >= 0 if the name was found; -1, if the name was not found</returns>
  20638. </member>
  20639. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.RemoveName(System.Int32)">
  20640. <summary>
  20641. Remove the named range by his index
  20642. </summary>
  20643. <param name="index">The named range index (0 based)</param>
  20644. </member>
  20645. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateDataFormat">
  20646. <summary>
  20647. Creates the instance of HSSFDataFormat for this workbook.
  20648. </summary>
  20649. <returns>the HSSFDataFormat object</returns>
  20650. </member>
  20651. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.RemoveName(System.String)">
  20652. <summary>
  20653. Remove the named range by his name
  20654. </summary>
  20655. <param name="name">named range name</param>
  20656. </member>
  20657. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.RemoveName(NPOI.SS.UserModel.IName)">
  20658. <summary>
  20659. As #removeName(String) is not necessarily unique (name + sheet index is unique),
  20660. this method is more accurate.
  20661. </summary>
  20662. <param name="name">the name to remove.</param>
  20663. </member>
  20664. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.DumpDrawingGroupRecords(System.Boolean)">
  20665. <summary>
  20666. Spits out a list of all the drawing records in the workbook.
  20667. </summary>
  20668. <param name="fat">if set to <c>true</c> [fat].</param>
  20669. </member>
  20670. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.AddPicture(System.Byte[],NPOI.SS.UserModel.PictureType)">
  20671. <summary>
  20672. Adds a picture to the workbook.
  20673. </summary>
  20674. <param name="pictureData">The bytes of the picture</param>
  20675. <param name="format">The format of the picture. One of
  20676. PictureType.</param>
  20677. <returns>the index to this picture (1 based).</returns>
  20678. </member>
  20679. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetAllPictures">
  20680. <summary>
  20681. Gets all pictures from the Workbook.
  20682. </summary>
  20683. <returns>the list of pictures (a list of HSSFPictureData objects.)</returns>
  20684. </member>
  20685. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SearchForPictures(System.Collections.IList,System.Collections.Generic.List{NPOI.HSSF.UserModel.HSSFPictureData})">
  20686. <summary>
  20687. Performs a recursive search for pictures in the given list of escher records.
  20688. </summary>
  20689. <param name="escherRecords">the escher records.</param>
  20690. <param name="pictures">the list to populate with the pictures.</param>
  20691. </member>
  20692. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.LinkExternalWorkbook(System.String,NPOI.SS.UserModel.IWorkbook)">
  20693. <summary>
  20694. Adds the LinkTable records required to allow formulas referencing
  20695. the specified external workbook to be added to this one. Allows
  20696. formulas such as "[MyOtherWorkbook]Sheet3!$A$5" to be added to the
  20697. file, for workbooks not already referenced.
  20698. </summary>
  20699. <param name="name">The name the workbook will be referenced as in formulas</param>
  20700. <param name="workbook">The open workbook to fetch the link required information from</param>
  20701. <returns></returns>
  20702. </member>
  20703. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.IsWriteProtected">
  20704. <summary>
  20705. Is the workbook protected with a password (not encrypted)?
  20706. </summary>
  20707. <value>
  20708. <c>true</c> if this instance is write protected; otherwise, <c>false</c>.
  20709. </value>
  20710. </member>
  20711. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.UnwriteProtectWorkbook">
  20712. <summary>
  20713. Removes the Write protect flag
  20714. </summary>
  20715. </member>
  20716. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetAllEmbeddedObjects">
  20717. <summary>
  20718. Gets all embedded OLE2 objects from the Workbook.
  20719. </summary>
  20720. <returns>the list of embedded objects (a list of HSSFObjectData objects.)</returns>
  20721. </member>
  20722. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetAllEmbeddedObjects(NPOI.HSSF.UserModel.HSSFSheet,System.Collections.Generic.List{NPOI.HSSF.UserModel.HSSFObjectData})">
  20723. <summary>
  20724. Gets all embedded OLE2 objects from the Workbook.
  20725. </summary>
  20726. <param name="sheet">the list of records to search.</param>
  20727. <param name="objects">the list of embedded objects to populate.</param>
  20728. </member>
  20729. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetAllEmbeddedObjects(NPOI.HSSF.UserModel.HSSFShapeContainer,System.Collections.Generic.List{NPOI.HSSF.UserModel.HSSFObjectData})">
  20730. <summary>
  20731. Recursively iterates a shape container to get all embedded objects.
  20732. </summary>
  20733. <param name="parent">the parent.</param>
  20734. <param name="objects">the list of embedded objects to populate.</param>
  20735. </member>
  20736. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.NewUID">
  20737. <summary>
  20738. Gets the new UID.
  20739. </summary>
  20740. <value>The new UID.</value>
  20741. </member>
  20742. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetEnumerator">
  20743. <summary>
  20744. Support foreach ISheet, e.g.
  20745. HSSFWorkbook workbook = new HSSFWorkbook();
  20746. foreach(ISheet sheet in workbook) ...
  20747. </summary>
  20748. <returns>Enumeration of all the sheets of this workbook</returns>
  20749. </member>
  20750. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.ForceFormulaRecalculation">
  20751. <summary>
  20752. Whether the application shall perform a full recalculation when the workbook is opened.
  20753. Typically you want to force formula recalculation when you modify cell formulas or values
  20754. of a workbook previously created by Excel. When set to true, this flag will tell Excel
  20755. that it needs to recalculate all formulas in the workbook the next time the file is opened.
  20756. Note, that recalculation updates cached formula results and, thus, modifies the workbook.
  20757. Depending on the version, Excel may prompt you with "Do you want to save the changes in <em>filename</em>?"
  20758. on close.
  20759. Value is true if the application will perform a full recalculation of
  20760. workbook values when the workbook is opened.
  20761. since 3.8
  20762. </summary>
  20763. </member>
  20764. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.SpreadsheetVersion">
  20765. <summary>
  20766. Returns the spreadsheet version (EXCLE97) of this workbook
  20767. </summary>
  20768. </member>
  20769. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.ChangeExternalReference(System.String,System.String)">
  20770. Changes an external referenced file to another file.
  20771. A formular in Excel which refers a cell in another file is saved in two parts:
  20772. The referenced file is stored in an reference table. the row/cell information is saved separate.
  20773. This method invokation will only change the reference in the lookup-table itself.
  20774. @param oldUrl The old URL to search for and which is to be replaced
  20775. @param newUrl The URL replacement
  20776. @return true if the oldUrl was found and replaced with newUrl. Otherwise false
  20777. </member>
  20778. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.IsDate1904">
  20779. <summary>
  20780. Gets a bool value that indicates whether the date systems used in the workbook starts in 1904.
  20781. The default value is false, meaning that the workbook uses the 1900 date system,
  20782. where 1/1/1900 is the first day in the system.
  20783. </summary>
  20784. <returns>True if the date systems used in the workbook starts in 1904</returns>
  20785. </member>
  20786. <member name="F:NPOI.HSSF.Util.GUID._d1">
  20787. 4 bytes - little endian
  20788. </member>
  20789. <member name="F:NPOI.HSSF.Util.GUID._d2">
  20790. 2 bytes - little endian
  20791. </member>
  20792. <member name="F:NPOI.HSSF.Util.GUID._d3">
  20793. 2 bytes - little endian
  20794. </member>
  20795. <member name="F:NPOI.HSSF.Util.GUID._d4">
  20796. 8 bytes - serialized as big endian, stored with inverted endianness here
  20797. </member>
  20798. <member name="M:NPOI.HSSF.Util.GUID.Parse(System.String)">
  20799. Read a GUID in standard text form e.g.<br/>
  20800. 13579BDF-0246-8ACE-0123-456789ABCDEF
  20801. <br/> -&gt; <br/>
  20802. 0x13579BDF, 0x0246, 0x8ACE 0x0123456789ABCDEF
  20803. </member>
  20804. <member name="T:NPOI.HSSF.Util.HSSFCellUtil">
  20805. <summary>
  20806. Various utility functions that make working with a cells and rows easier. The various
  20807. methods that deal with style's allow you to Create your HSSFCellStyles as you need them.
  20808. When you apply a style change to a cell, the code will attempt to see if a style already
  20809. exists that meets your needs. If not, then it will Create a new style. This is to prevent
  20810. creating too many styles. there is an upper limit in Excel on the number of styles that
  20811. can be supported.
  20812. @author Eric Pugh epugh@upstate.com
  20813. </summary>
  20814. </member>
  20815. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.GetRow(System.Int32,NPOI.HSSF.UserModel.HSSFSheet)">
  20816. <summary>
  20817. Get a row from the spreadsheet, and Create it if it doesn't exist.
  20818. </summary>
  20819. <param name="rowIndex">The 0 based row number</param>
  20820. <param name="sheet">The sheet that the row is part of.</param>
  20821. <returns>The row indicated by the rowCounter</returns>
  20822. </member>
  20823. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.GetCell(NPOI.SS.UserModel.IRow,System.Int32)">
  20824. <summary>
  20825. Get a specific cell from a row. If the cell doesn't exist,
  20826. </summary>
  20827. <param name="row">The row that the cell is part of</param>
  20828. <param name="columnIndex">The column index that the cell is in.</param>
  20829. <returns>The cell indicated by the column.</returns>
  20830. </member>
  20831. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.CreateCell(NPOI.SS.UserModel.IRow,System.Int32,System.String,NPOI.HSSF.UserModel.HSSFCellStyle)">
  20832. <summary>
  20833. Creates a cell, gives it a value, and applies a style if provided
  20834. </summary>
  20835. <param name="row">the row to Create the cell in</param>
  20836. <param name="column">the column index to Create the cell in</param>
  20837. <param name="value">The value of the cell</param>
  20838. <param name="style">If the style is not null, then Set</param>
  20839. <returns>A new HSSFCell</returns>
  20840. </member>
  20841. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.CreateCell(NPOI.SS.UserModel.IRow,System.Int32,System.String)">
  20842. <summary>
  20843. Create a cell, and give it a value.
  20844. </summary>
  20845. <param name="row">the row to Create the cell in</param>
  20846. <param name="column">the column index to Create the cell in</param>
  20847. <param name="value">The value of the cell</param>
  20848. <returns>A new HSSFCell.</returns>
  20849. </member>
  20850. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.SetAlignment(NPOI.SS.UserModel.ICell,NPOI.HSSF.UserModel.HSSFWorkbook,System.Int16)">
  20851. <summary>
  20852. Take a cell, and align it.
  20853. </summary>
  20854. <param name="cell">the cell to Set the alignment for</param>
  20855. <param name="workbook">The workbook that is being worked with.</param>
  20856. <param name="align">the column alignment to use.</param>
  20857. </member>
  20858. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.SetFont(NPOI.SS.UserModel.ICell,NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFFont)">
  20859. <summary>
  20860. Take a cell, and apply a font to it
  20861. </summary>
  20862. <param name="cell">the cell to Set the alignment for</param>
  20863. <param name="workbook">The workbook that is being worked with.</param>
  20864. <param name="font">The HSSFFont that you want to Set...</param>
  20865. </member>
  20866. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.SetCellStyleProperty(NPOI.SS.UserModel.ICell,NPOI.HSSF.UserModel.HSSFWorkbook,System.String,System.Object)">
  20867. This method attempt to find an already existing HSSFCellStyle that matches
  20868. what you want the style to be. If it does not find the style, then it
  20869. Creates a new one. If it does Create a new one, then it applies the
  20870. propertyName and propertyValue to the style. This is necessary because
  20871. Excel has an upper limit on the number of Styles that it supports.
  20872. @param workbook The workbook that is being worked with.
  20873. @param propertyName The name of the property that is to be
  20874. changed.
  20875. @param propertyValue The value of the property that is to be
  20876. changed.
  20877. @param cell The cell that needs it's style changes
  20878. @exception NestableException Thrown if an error happens.
  20879. </member>
  20880. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.TranslateUnicodeValues(NPOI.SS.UserModel.ICell)">
  20881. <summary>
  20882. Looks for text in the cell that should be unicode, like alpha; and provides the
  20883. unicode version of it.
  20884. </summary>
  20885. <param name="cell">The cell to check for unicode values</param>
  20886. <returns>transalted to unicode</returns>
  20887. </member>
  20888. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.RemapCellStyle(NPOI.HSSF.UserModel.HSSFCellStyle,System.Collections.Generic.Dictionary{System.Int16,System.Int16})">
  20889. <summary>
  20890. Translate color palette entries from the source to the destination sheet
  20891. </summary>
  20892. </member>
  20893. <member name="T:NPOI.HSSF.Util.HSSFColor">
  20894. Intends to provide support for the very evil index to triplet Issue and
  20895. will likely replace the color constants interface for HSSF 2.0.
  20896. This class Contains static inner class members for representing colors.
  20897. Each color has an index (for the standard palette in Excel (tm) ),
  20898. native (RGB) triplet and string triplet. The string triplet Is as the
  20899. color would be represented by Gnumeric. Having (string) this here Is a bit of a
  20900. collusion of function between HSSF and the HSSFSerializer but I think its
  20901. a reasonable one in this case.
  20902. @author Andrew C. Oliver (acoliver at apache dot org)
  20903. @author Brian Sanders (bsanders at risklabs dot com) - full default color palette
  20904. </member>
  20905. <member name="M:NPOI.HSSF.Util.HSSFColor.#ctor">
  20906. Creates a new instance of HSSFColor
  20907. </member>
  20908. <member name="M:NPOI.HSSF.Util.HSSFColor.GetIndexHash">
  20909. this function returns all colors in a hastable. Its not implemented as a
  20910. static member/staticly initialized because that would be dirty in a
  20911. server environment as it Is intended. This means you'll eat the time
  20912. it takes to Create it once per request but you will not hold onto it
  20913. if you have none of those requests.
  20914. @return a hashtable containing all colors keyed by <c>int</c> excel-style palette indexes
  20915. </member>
  20916. <member name="M:NPOI.HSSF.Util.HSSFColor.GetMutableIndexHash">
  20917. This function returns all the Colours, stored in a Hashtable that
  20918. can be edited. No caching is performed. If you don't need to edit
  20919. the table, then call {@link #getIndexHash()} which returns a
  20920. statically cached imuatable map of colours.
  20921. </member>
  20922. <member name="M:NPOI.HSSF.Util.HSSFColor.GetTripletHash">
  20923. <summary>
  20924. this function returns all colors in a hastable. Its not implemented as a
  20925. static member/staticly initialized because that would be dirty in a
  20926. server environment as it Is intended. This means you'll eat the time
  20927. it takes to Create it once per request but you will not hold onto it
  20928. if you have none of those requests.
  20929. </summary>
  20930. <returns>a hashtable containing all colors keyed by String gnumeric-like triplets</returns>
  20931. </member>
  20932. <member name="P:NPOI.HSSF.Util.HSSFColor.Indexed">
  20933. @return index to the standard palette
  20934. </member>
  20935. <member name="M:NPOI.HSSF.Util.HSSFColor.GetTriplet">
  20936. @return triplet representation like that in Excel
  20937. </member>
  20938. <member name="M:NPOI.HSSF.Util.HSSFColor.GetHexString">
  20939. @return a hex string exactly like a gnumeric triplet
  20940. </member>
  20941. <member name="T:NPOI.HSSF.Util.HSSFColor.Black">
  20942. Class BLACK
  20943. </member>
  20944. <member name="T:NPOI.HSSF.Util.HSSFColor.Brown">
  20945. Class BROWN
  20946. </member>
  20947. <member name="T:NPOI.HSSF.Util.HSSFColor.OliveGreen">
  20948. Class OLIVE_GREEN
  20949. </member>
  20950. <member name="T:NPOI.HSSF.Util.HSSFColor.DarkGreen">
  20951. Class DARK_GREEN
  20952. </member>
  20953. <member name="T:NPOI.HSSF.Util.HSSFColor.DarkTeal">
  20954. Class DARK_TEAL
  20955. </member>
  20956. <member name="T:NPOI.HSSF.Util.HSSFColor.DarkBlue">
  20957. Class DARK_BLUE
  20958. </member>
  20959. <member name="T:NPOI.HSSF.Util.HSSFColor.Indigo">
  20960. Class INDIGO
  20961. </member>
  20962. <member name="T:NPOI.HSSF.Util.HSSFColor.Grey80Percent">
  20963. Class GREY_80_PERCENT
  20964. </member>
  20965. <member name="T:NPOI.HSSF.Util.HSSFColor.DarkRed">
  20966. Class DARK_RED
  20967. </member>
  20968. <member name="T:NPOI.HSSF.Util.HSSFColor.Orange">
  20969. Class ORANGE
  20970. </member>
  20971. <member name="T:NPOI.HSSF.Util.HSSFColor.DarkYellow">
  20972. Class DARK_YELLOW
  20973. </member>
  20974. <member name="T:NPOI.HSSF.Util.HSSFColor.Green">
  20975. Class GREEN
  20976. </member>
  20977. <member name="T:NPOI.HSSF.Util.HSSFColor.Teal">
  20978. Class TEAL
  20979. </member>
  20980. <member name="T:NPOI.HSSF.Util.HSSFColor.Blue">
  20981. Class BLUE
  20982. </member>
  20983. <member name="T:NPOI.HSSF.Util.HSSFColor.BlueGrey">
  20984. Class BLUE_GREY
  20985. </member>
  20986. <member name="T:NPOI.HSSF.Util.HSSFColor.Grey50Percent">
  20987. Class GREY_50_PERCENT
  20988. </member>
  20989. <member name="T:NPOI.HSSF.Util.HSSFColor.Red">
  20990. Class RED
  20991. </member>
  20992. <member name="T:NPOI.HSSF.Util.HSSFColor.LightOrange">
  20993. Class LIGHT_ORANGE
  20994. </member>
  20995. <member name="T:NPOI.HSSF.Util.HSSFColor.Lime">
  20996. Class LIME
  20997. </member>
  20998. <member name="T:NPOI.HSSF.Util.HSSFColor.SeaGreen">
  20999. Class SEA_GREEN
  21000. </member>
  21001. <member name="T:NPOI.HSSF.Util.HSSFColor.Aqua">
  21002. Class AQUA
  21003. </member>
  21004. <member name="T:NPOI.HSSF.Util.HSSFColor.Grey40Percent">
  21005. Class GREY_40_PERCENT
  21006. </member>
  21007. <member name="T:NPOI.HSSF.Util.HSSFColor.Turquoise">
  21008. Class TURQUOISE
  21009. </member>
  21010. <member name="T:NPOI.HSSF.Util.HSSFColor.SkyBlue">
  21011. Class SKY_BLUE
  21012. </member>
  21013. <member name="T:NPOI.HSSF.Util.HSSFColor.Plum">
  21014. Class PLUM
  21015. </member>
  21016. <member name="T:NPOI.HSSF.Util.HSSFColor.Grey25Percent">
  21017. Class GREY_25_PERCENT
  21018. </member>
  21019. <member name="T:NPOI.HSSF.Util.HSSFColor.Rose">
  21020. Class ROSE
  21021. </member>
  21022. <member name="T:NPOI.HSSF.Util.HSSFColor.Tan">
  21023. Class TAN
  21024. </member>
  21025. <member name="T:NPOI.HSSF.Util.HSSFColor.LightYellow">
  21026. Class LIGHT_YELLOW
  21027. </member>
  21028. <member name="T:NPOI.HSSF.Util.HSSFColor.LightGreen">
  21029. Class LIGHT_GREEN
  21030. </member>
  21031. <member name="T:NPOI.HSSF.Util.HSSFColor.LightTurquoise">
  21032. Class LIGHT_TURQUOISE
  21033. </member>
  21034. <member name="T:NPOI.HSSF.Util.HSSFColor.PaleBlue">
  21035. Class PALE_BLUE
  21036. </member>
  21037. <member name="T:NPOI.HSSF.Util.HSSFColor.Lavender">
  21038. Class LAVENDER
  21039. </member>
  21040. <member name="T:NPOI.HSSF.Util.HSSFColor.White">
  21041. Class WHITE
  21042. </member>
  21043. <member name="T:NPOI.HSSF.Util.HSSFColor.CornflowerBlue">
  21044. Class CORNFLOWER_BLUE
  21045. </member>
  21046. <member name="T:NPOI.HSSF.Util.HSSFColor.LemonChiffon">
  21047. Class LEMON_CHIFFON
  21048. </member>
  21049. <member name="T:NPOI.HSSF.Util.HSSFColor.Maroon">
  21050. Class MAROON
  21051. </member>
  21052. <member name="T:NPOI.HSSF.Util.HSSFColor.Orchid">
  21053. Class ORCHID
  21054. </member>
  21055. <member name="T:NPOI.HSSF.Util.HSSFColor.Coral">
  21056. Class CORAL
  21057. </member>
  21058. <member name="T:NPOI.HSSF.Util.HSSFColor.RoyalBlue">
  21059. Class ROYAL_BLUE
  21060. </member>
  21061. <member name="T:NPOI.HSSF.Util.HSSFColor.LightCornflowerBlue">
  21062. Class LIGHT_CORNFLOWER_BLUE
  21063. </member>
  21064. <member name="T:NPOI.HSSF.Util.HSSFColor.Automatic">
  21065. Special Default/Normal/Automatic color.
  21066. <i>Note:</i> This class Is NOT in the default HashTables returned by HSSFColor.
  21067. The index Is a special case which Is interpreted in the various SetXXXColor calls.
  21068. @author Jason
  21069. </member>
  21070. <member name="T:NPOI.HSSF.Util.HSSFRegionUtil">
  21071. <summary>
  21072. Various utility functions that make working with a region of cells easier.
  21073. @author Eric Pugh epugh@upstate.com
  21074. </summary>
  21075. </member>
  21076. <member name="T:NPOI.HSSF.Util.HSSFRegionUtil.CellPropertySetter">
  21077. <summary>
  21078. For setting the same property on many cells to the same value
  21079. </summary>
  21080. </member>
  21081. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetBorderLeft(NPOI.SS.UserModel.BorderStyle,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  21082. <summary>
  21083. Sets the left border for a region of cells by manipulating the cell style
  21084. of the individual cells on the left
  21085. </summary>
  21086. <param name="border">The new border</param>
  21087. <param name="region">The region that should have the border</param>
  21088. <param name="sheet">The sheet that the region is on.</param>
  21089. <param name="workbook">The workbook that the region is on.</param>
  21090. </member>
  21091. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetLeftBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  21092. <summary>
  21093. Sets the leftBorderColor attribute of the HSSFRegionUtil object
  21094. </summary>
  21095. <param name="color">The color of the border</param>
  21096. <param name="region">The region that should have the border</param>
  21097. <param name="sheet">The sheet that the region is on.</param>
  21098. <param name="workbook">The workbook that the region is on.</param>
  21099. </member>
  21100. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetBorderRight(NPOI.SS.UserModel.BorderStyle,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  21101. <summary>
  21102. Sets the borderRight attribute of the HSSFRegionUtil object
  21103. </summary>
  21104. <param name="border">The new border</param>
  21105. <param name="region">The region that should have the border</param>
  21106. <param name="sheet">The sheet that the region is on.</param>
  21107. <param name="workbook">The workbook that the region is on.</param>
  21108. </member>
  21109. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetRightBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  21110. <summary>
  21111. Sets the rightBorderColor attribute of the HSSFRegionUtil object
  21112. </summary>
  21113. <param name="color">The color of the border</param>
  21114. <param name="region">The region that should have the border</param>
  21115. <param name="sheet">The workbook that the region is on.</param>
  21116. <param name="workbook">The sheet that the region is on.</param>
  21117. </member>
  21118. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetBorderBottom(NPOI.SS.UserModel.BorderStyle,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  21119. <summary>
  21120. Sets the borderBottom attribute of the HSSFRegionUtil object
  21121. </summary>
  21122. <param name="border">The new border</param>
  21123. <param name="region">The region that should have the border</param>
  21124. <param name="sheet">The sheet that the region is on.</param>
  21125. <param name="workbook">The workbook that the region is on.</param>
  21126. </member>
  21127. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetBottomBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  21128. <summary>
  21129. Sets the bottomBorderColor attribute of the HSSFRegionUtil object
  21130. </summary>
  21131. <param name="color">The color of the border</param>
  21132. <param name="region">The region that should have the border</param>
  21133. <param name="sheet">The sheet that the region is on.</param>
  21134. <param name="workbook">The workbook that the region is on.</param>
  21135. </member>
  21136. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetBorderTop(NPOI.SS.UserModel.BorderStyle,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  21137. <summary>
  21138. Sets the borderBottom attribute of the HSSFRegionUtil object
  21139. </summary>
  21140. <param name="border">The new border</param>
  21141. <param name="region">The region that should have the border</param>
  21142. <param name="sheet">The sheet that the region is on.</param>
  21143. <param name="workbook">The workbook that the region is on.</param>
  21144. </member>
  21145. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetTopBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  21146. <summary>
  21147. Sets the topBorderColor attribute of the HSSFRegionUtil object
  21148. </summary>
  21149. <param name="color">The color of the border</param>
  21150. <param name="region">The region that should have the border</param>
  21151. <param name="sheet">The sheet that the region is on.</param>
  21152. <param name="workbook">The workbook that the region is on.</param>
  21153. </member>
  21154. <member name="T:NPOI.HSSF.Util.LazilyConcatenatedByteArray">
  21155. Utility for delaying the concatenation of multiple byte arrays. Doing this up-front
  21156. causes significantly more copying, which for a large number of byte arrays can cost
  21157. a large amount of time.
  21158. </member>
  21159. <member name="M:NPOI.HSSF.Util.LazilyConcatenatedByteArray.Clear">
  21160. Clears the array (sets the concatenated length back to zero.
  21161. </member>
  21162. <member name="M:NPOI.HSSF.Util.LazilyConcatenatedByteArray.Concatenate(System.Byte[])">
  21163. Concatenates an array onto the end of our array.
  21164. This is a relatively fast operation.
  21165. @param array the array to concatenate.
  21166. @throws ArgumentException if {@code array} is {@code null}.
  21167. </member>
  21168. <member name="M:NPOI.HSSF.Util.LazilyConcatenatedByteArray.ToArray">
  21169. Gets the concatenated contents as a single byte array.
  21170. This is a slower operation, but the concatenated array is stored off as a single
  21171. array again so that subsequent calls will not perform Additional copying.
  21172. @return the byte array. Returns {@code null} if no data has been placed into it.
  21173. </member>
  21174. <member name="T:NPOI.HSSF.Util.RKUtil">
  21175. Utility class for helping convert RK numbers.
  21176. @author Andrew C. Oliver (acoliver at apache dot org)
  21177. @author Glen Stampoultzis (glens at apache.org)
  21178. @author Rolf-Jürgen Moll
  21179. @see org.apache.poi.hssf.record.MulRKRecord
  21180. @see org.apache.poi.hssf.record.RKRecord
  21181. </member>
  21182. <member name="M:NPOI.HSSF.Util.RKUtil.DecodeNumber(System.Int32)">
  21183. Do the dirty work of decoding; made a private static method to
  21184. facilitate testing the algorithm
  21185. </member>
  21186. <member name="T:NPOI.POIDocument">
  21187. <summary>
  21188. This holds the common functionality for all POI
  21189. Document classes.
  21190. Currently, this relates to Document Information Properties
  21191. </summary>
  21192. <remarks>@author Nick Burch</remarks>
  21193. </member>
  21194. <member name="F:NPOI.POIDocument.sInf">
  21195. Holds metadata on our document
  21196. </member>
  21197. <member name="F:NPOI.POIDocument.dsInf">
  21198. Holds further metadata on our document
  21199. </member>
  21200. <member name="F:NPOI.POIDocument.directory">
  21201. The directory that our document lives in
  21202. </member>
  21203. <member name="M:NPOI.POIDocument.SetDirectoryNode(NPOI.POIFS.FileSystem.DirectoryNode)">
  21204. <summary>
  21205. just for test case TestPOIDocumentMain.TestWriteReadProperties
  21206. </summary>
  21207. </member>
  21208. <member name="F:NPOI.POIDocument.initialized">
  21209. For our own logging use
  21210. </member>
  21211. <member name="M:NPOI.POIDocument.#ctor(NPOI.POIFS.FileSystem.OPOIFSFileSystem)">
  21212. Constructs from an old-style OPOIFS
  21213. </member>
  21214. <member name="M:NPOI.POIDocument.#ctor(NPOI.POIFS.FileSystem.NPOIFSFileSystem)">
  21215. <summary>
  21216. Initializes a new instance of the <see cref="T:NPOI.POIDocument"/> class.
  21217. </summary>
  21218. <param name="fs">The fs.</param>
  21219. </member>
  21220. <member name="M:NPOI.POIDocument.#ctor(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  21221. Constructs from the default POIFS
  21222. </member>
  21223. <member name="M:NPOI.POIDocument.CreateInformationProperties">
  21224. Will create whichever of SummaryInformation
  21225. and DocumentSummaryInformation (HPSF) properties
  21226. are not already part of your document.
  21227. This is normally useful when creating a new
  21228. document from scratch.
  21229. If the information properties are already there,
  21230. then nothing will happen.
  21231. </member>
  21232. <member name="P:NPOI.POIDocument.DocumentSummaryInformation">
  21233. <summary>
  21234. Fetch the Document Summary Information of the document
  21235. </summary>
  21236. <value>The document summary information.</value>
  21237. </member>
  21238. <member name="P:NPOI.POIDocument.SummaryInformation">
  21239. <summary>
  21240. Fetch the Summary Information of the document
  21241. </summary>
  21242. <value>The summary information.</value>
  21243. </member>
  21244. <member name="M:NPOI.POIDocument.ReadProperties">
  21245. <summary>
  21246. Find, and Create objects for, the standard
  21247. Documment Information Properties (HPSF).
  21248. If a given property Set is missing or corrupt,
  21249. it will remain null;
  21250. </summary>
  21251. </member>
  21252. <member name="M:NPOI.POIDocument.GetPropertySet(System.String)">
  21253. <summary>
  21254. For a given named property entry, either return it or null if
  21255. if it wasn't found
  21256. </summary>
  21257. <param name="setName">The property to read</param>
  21258. <returns>The value of the given property or null if it wasn't found.</returns>
  21259. <exception cref="T:System.IO.IOException">If retrieving properties fails</exception>
  21260. </member>
  21261. <member name="M:NPOI.POIDocument.WriteProperties">
  21262. Writes out the updated standard Document Information Properties (HPSF)
  21263. into the currently open NPOIFSFileSystem
  21264. TODO Implement in-place update
  21265. @throws IOException if an error when writing to the open
  21266. {@link NPOIFSFileSystem} occurs
  21267. TODO throws exception if open from stream not file
  21268. </member>
  21269. <member name="M:NPOI.POIDocument.WriteProperties(NPOI.POIFS.FileSystem.NPOIFSFileSystem)">
  21270. <summary>
  21271. Writes out the standard Documment Information Properties (HPSF)
  21272. </summary>
  21273. <param name="outFS">the POIFSFileSystem to Write the properties into</param>
  21274. </member>
  21275. <member name="M:NPOI.POIDocument.WriteProperties(NPOI.POIFS.FileSystem.NPOIFSFileSystem,System.Collections.IList)">
  21276. <summary>
  21277. Writes out the standard Documment Information Properties (HPSF)
  21278. </summary>
  21279. <param name="outFS">the POIFSFileSystem to Write the properties into.</param>
  21280. <param name="writtenEntries">a list of POIFS entries to Add the property names too.</param>
  21281. </member>
  21282. <member name="M:NPOI.POIDocument.WritePropertySet(System.String,NPOI.HPSF.PropertySet,NPOI.POIFS.FileSystem.NPOIFSFileSystem)">
  21283. <summary>
  21284. Writes out a given ProperySet
  21285. </summary>
  21286. <param name="name">the (POIFS Level) name of the property to Write.</param>
  21287. <param name="Set">the PropertySet to Write out.</param>
  21288. <param name="outFS">the POIFSFileSystem to Write the property into.</param>
  21289. </member>
  21290. <member name="M:NPOI.POIDocument.ValidateInPlaceWritePossible">
  21291. Called during a {@link #write()} to ensure that the Document (and
  21292. associated {@link POIFSFileSystem}) was opened in a way compatible
  21293. with an in-place write.
  21294. @ if the document was opened suitably
  21295. </member>
  21296. <!-- Badly formed XML comment ignored for member "M:NPOI.POIDocument.Write" -->
  21297. <member name="M:NPOI.POIDocument.Write(System.IO.FileInfo)">
  21298. Writes the document out to the specified new {@link File}. If the file
  21299. exists, it will be replaced, otherwise a new one will be created
  21300. @param newFile The new File to write to.
  21301. @ thrown on errors writing to the file
  21302. </member>
  21303. <member name="M:NPOI.POIDocument.Write(System.IO.Stream)">
  21304. Writes the document out to the specified output stream. The
  21305. stream is not closed as part of this operation.
  21306. Note - if the Document was opened from a {@link File} rather
  21307. than an {@link InputStream}, you <b>must</b> write out using
  21308. {@link #write()} or to a different File. Overwriting the currently
  21309. open file via an OutputStream isn't possible.
  21310. If {@code stream} is a {@link java.io.FileOutputStream} on a networked drive
  21311. or has a high cost/latency associated with each written byte,
  21312. consider wrapping the OutputStream in a {@link java.io.BufferedOutputStream}
  21313. to improve write performance, or use {@link #write()} / {@link #write(File)}
  21314. if possible.
  21315. @param out The stream to write to.
  21316. @ thrown on errors writing to the stream
  21317. </member>
  21318. <member name="M:NPOI.POIDocument.Close">
  21319. Closes the underlying {@link NPOIFSFileSystem} from which
  21320. the document was read, if any. Has no effect on documents
  21321. opened from an InputStream, or newly created ones.
  21322. Once {@link #close()} has been called, no further operations
  21323. should be called on the document.
  21324. </member>
  21325. <member name="T:NPOI.POIFS.Common.POIFSBigBlockSize">
  21326. <p>A class describing attributes of the Big Block Size</p>
  21327. </member>
  21328. <member name="M:NPOI.POIFS.Common.POIFSBigBlockSize.GetHeaderValue">
  21329. Returns the value that Gets written into the
  21330. header.
  21331. Is the power of two that corresponds to the
  21332. size of the block, eg 512 => 9
  21333. </member>
  21334. <member name="T:NPOI.POIFS.Common.POIFSConstants">
  21335. <summary>
  21336. A repository for constants shared by POI classes.
  21337. @author Marc Johnson (mjohnson at apache dot org)
  21338. </summary>
  21339. </member>
  21340. <member name="F:NPOI.POIFS.Common.POIFSConstants.SMALLER_BIG_BLOCK_SIZE">
  21341. Most files use 512 bytes as their big block size
  21342. </member>
  21343. <member name="F:NPOI.POIFS.Common.POIFSConstants.LARGER_BIG_BLOCK_SIZE">
  21344. Some use 4096 bytes
  21345. </member>
  21346. <member name="F:NPOI.POIFS.Common.POIFSConstants.BIG_BLOCK_SIZE">
  21347. Most files use 512 bytes as their big block size
  21348. </member>
  21349. <member name="F:NPOI.POIFS.Common.POIFSConstants.MINI_BLOCK_SIZE">
  21350. Most files use 512 bytes as their big block size
  21351. </member>
  21352. <member name="F:NPOI.POIFS.Common.POIFSConstants.SMALL_BLOCK_SIZE">
  21353. How big a block in the small block stream is. Fixed size
  21354. </member>
  21355. <member name="F:NPOI.POIFS.Common.POIFSConstants.PROPERTY_SIZE">
  21356. How big a single property is
  21357. </member>
  21358. <member name="F:NPOI.POIFS.Common.POIFSConstants.BIG_BLOCK_MINIMUM_DOCUMENT_SIZE">
  21359. The minimum size of a document before it's stored using
  21360. Big Blocks (normal streams). Smaller documents go in the
  21361. Mini Stream (SBAT / Small Blocks)
  21362. </member>
  21363. <member name="F:NPOI.POIFS.Common.POIFSConstants.LARGEST_REGULAR_SECTOR_NUMBER">
  21364. The highest sector number you're allowed, 0xFFFFFFFA
  21365. </member>
  21366. <member name="F:NPOI.POIFS.Common.POIFSConstants.FAT_SECTOR_BLOCK">
  21367. Indicates the sector holds a FAT block (0xFFFFFFFD)
  21368. </member>
  21369. <member name="F:NPOI.POIFS.Common.POIFSConstants.DIFAT_SECTOR_BLOCK">
  21370. Indicates the sector holds a DIFAT block (0xFFFFFFFC)
  21371. </member>
  21372. <member name="F:NPOI.POIFS.Common.POIFSConstants.END_OF_CHAIN">
  21373. Indicates the sector is the end of a chain (0xFFFFFFFE)
  21374. </member>
  21375. <member name="F:NPOI.POIFS.Common.POIFSConstants.UNUSED_BLOCK">
  21376. Indicates the sector is not used (0xFFFFFFFF)
  21377. </member>
  21378. <member name="F:NPOI.POIFS.Common.POIFSConstants.OOXML_FILE_HEADER">
  21379. The first 4 bytes of an OOXML file, used in detection
  21380. </member>
  21381. <member name="F:NPOI.POIFS.Common.POIFSConstants.RAW_XML_FILE_HEADER">
  21382. The first 5 bytes of a raw XML file, used in detection
  21383. </member>
  21384. <member name="T:NPOI.POIFS.Dev.POIFSViewable">
  21385. <summary>
  21386. Interface for a drill-down viewable object. Such an object has
  21387. content that may or may not be displayed, at the discretion of the
  21388. viewer. The content is returned to the viewer as an array or as an
  21389. Iterator, and the object provides a clue as to which technique the
  21390. viewer should use to get its content.
  21391. A POIFSViewable object is also expected to provide a short
  21392. description of itself, that can be used by a viewer when the
  21393. viewable object is collapsed.
  21394. @author Marc Johnson (mjohnson at apache dot org)
  21395. </summary>
  21396. </member>
  21397. <member name="P:NPOI.POIFS.Dev.POIFSViewable.PreferArray">
  21398. <summary>
  21399. Provides a short description of the object to be used when a
  21400. POIFSViewable object has not provided its contents.
  21401. </summary>
  21402. <value><c>true</c> if [prefer array]; otherwise, <c>false</c>.</value>
  21403. </member>
  21404. <member name="P:NPOI.POIFS.Dev.POIFSViewable.ShortDescription">
  21405. <summary>
  21406. Gets the short description.
  21407. </summary>
  21408. <value>The short description.</value>
  21409. </member>
  21410. <member name="P:NPOI.POIFS.Dev.POIFSViewable.ViewableArray">
  21411. <summary>
  21412. Get an array of objects, some of which may implement POIFSViewable
  21413. </summary>
  21414. <value>The viewable array.</value>
  21415. </member>
  21416. <member name="P:NPOI.POIFS.Dev.POIFSViewable.ViewableIterator">
  21417. <summary>
  21418. Give viewers a hint as to whether to call ViewableArray or ViewableIterator
  21419. </summary>
  21420. <value>The viewable iterator.</value>
  21421. </member>
  21422. <member name="T:NPOI.POIFS.EventFileSystem.POIFSWriterEvent">
  21423. Class POIFSWriterEvent
  21424. @author Marc Johnson (mjohnson at apache dot org)
  21425. @version %I%, %G%
  21426. </member>
  21427. <member name="M:NPOI.POIFS.EventFileSystem.POIFSWriterEvent.#ctor(NPOI.POIFS.FileSystem.DocumentOutputStream,NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String,System.Int32)">
  21428. namespace scoped constructor
  21429. @param stream the DocumentOutputStream, freshly opened
  21430. @param path the path of the document
  21431. @param documentName the name of the document
  21432. @param limit the limit, in bytes, that can be written to the
  21433. stream
  21434. </member>
  21435. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEvent.Stream">
  21436. @return the DocumentOutputStream, freshly opened
  21437. </member>
  21438. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEvent.Path">
  21439. @return the document's path
  21440. </member>
  21441. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEvent.Name">
  21442. @return the document's name
  21443. </member>
  21444. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEvent.Limit">
  21445. @return the limit on writing, in bytes
  21446. </member>
  21447. <member name="T:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs">
  21448. <summary>
  21449. EventArgs for POIFSWriter
  21450. author: Tony Qu
  21451. </summary>
  21452. </member>
  21453. <member name="M:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs.#ctor(NPOI.POIFS.FileSystem.DocumentOutputStream,NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String,System.Int32)">
  21454. <summary>
  21455. Initializes a new instance of the <see cref="T:NPOI.POIFS.EventFileSystem.POIFSWriterEvent"/> class.
  21456. </summary>
  21457. <param name="stream">the POIFSDocumentWriter, freshly opened</param>
  21458. <param name="path">the path of the document</param>
  21459. <param name="documentName">the name of the document</param>
  21460. <param name="limit">the limit, in bytes, that can be written to the stream</param>
  21461. </member>
  21462. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs.Limit">
  21463. <summary>
  21464. Gets the limit on writing, in bytes
  21465. </summary>
  21466. <value>The limit.</value>
  21467. </member>
  21468. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs.Name">
  21469. <summary>
  21470. Gets the document's name
  21471. </summary>
  21472. <value>The name.</value>
  21473. </member>
  21474. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs.Path">
  21475. <summary>
  21476. Gets the document's path
  21477. </summary>
  21478. <value>The path.</value>
  21479. </member>
  21480. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs.Stream">
  21481. <summary>
  21482. the POIFSDocumentWriter, freshly opened
  21483. </summary>
  21484. <value>The stream.</value>
  21485. </member>
  21486. <member name="T:NPOI.POIFS.EventFileSystem.POIFSWriterListener">
  21487. Interface POIFSWriterListener
  21488. @author Marc Johnson (mjohnson at apache dot org)
  21489. @version %I%, %G%
  21490. </member>
  21491. <member name="M:NPOI.POIFS.EventFileSystem.POIFSWriterListener.ProcessPOIFSWriterEvent(NPOI.POIFS.EventFileSystem.POIFSWriterEvent)">
  21492. Process a POIFSWriterEvent that this listener had registered
  21493. for
  21494. @param event the POIFSWriterEvent
  21495. </member>
  21496. <member name="T:NPOI.POIFS.FileSystem.BATManaged">
  21497. <summary>
  21498. This interface defines behaviors for objects managed by the Block
  21499. Allocation Table (BAT).
  21500. @author Marc Johnson (mjohnson at apache dot org)
  21501. </summary>
  21502. </member>
  21503. <member name="P:NPOI.POIFS.FileSystem.BATManaged.CountBlocks">
  21504. <summary>
  21505. Gets the number of BigBlock's this instance uses
  21506. </summary>
  21507. <value>count of BigBlock instances</value>
  21508. </member>
  21509. <member name="P:NPOI.POIFS.FileSystem.BATManaged.StartBlock">
  21510. <summary>
  21511. Sets the start block for this instance
  21512. </summary>
  21513. <value>index into the array of BigBlock instances making up the the filesystem</value>
  21514. </member>
  21515. <member name="T:NPOI.POIFS.FileSystem.BlockStore">
  21516. <summary>
  21517. This abstract class describes a way to read, store, chain
  21518. and free a series of blocks (be they Big or Small ones)
  21519. </summary>
  21520. </member>
  21521. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetBlockStoreBlockSize">
  21522. <summary>
  21523. Returns the size of the blocks managed through the block store.
  21524. </summary>
  21525. <returns></returns>
  21526. </member>
  21527. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetBlockAt(System.Int32)">
  21528. <summary>
  21529. Load the block at the given offset.
  21530. </summary>
  21531. <param name="offset"></param>
  21532. <returns></returns>
  21533. </member>
  21534. <member name="M:NPOI.POIFS.FileSystem.BlockStore.CreateBlockIfNeeded(System.Int32)">
  21535. <summary>
  21536. Extends the file if required to hold blocks up to
  21537. the specified offset, and return the block from there.
  21538. </summary>
  21539. <param name="offset"></param>
  21540. <returns></returns>
  21541. </member>
  21542. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetBATBlockAndIndex(System.Int32)">
  21543. <summary>
  21544. Returns the BATBlock that handles the specified offset,
  21545. and the relative index within it
  21546. </summary>
  21547. <param name="offset"></param>
  21548. <returns></returns>
  21549. </member>
  21550. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetNextBlock(System.Int32)">
  21551. <summary>
  21552. Works out what block follows the specified one.
  21553. </summary>
  21554. <param name="offset"></param>
  21555. <returns></returns>
  21556. </member>
  21557. <member name="M:NPOI.POIFS.FileSystem.BlockStore.SetNextBlock(System.Int32,System.Int32)">
  21558. <summary>
  21559. Changes the record of what block follows the specified one.
  21560. </summary>
  21561. <param name="offset"></param>
  21562. <param name="nextBlock"></param>
  21563. </member>
  21564. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetFreeBlock">
  21565. <summary>
  21566. Finds a free block, and returns its offset.
  21567. This method will extend the file/stream if needed, and if doing
  21568. so, allocate new FAT blocks to address the extra space.
  21569. </summary>
  21570. <returns></returns>
  21571. </member>
  21572. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetChainLoopDetector">
  21573. <summary>
  21574. Creates a Detector for loops in the chain
  21575. </summary>
  21576. <returns></returns>
  21577. </member>
  21578. <member name="T:NPOI.POIFS.FileSystem.ChainLoopDetector">
  21579. <summary>
  21580. Used to detect if a chain has a loop in it, so
  21581. we can bail out with an error rather than
  21582. spinning away for ever...
  21583. </summary>
  21584. </member>
  21585. <member name="T:NPOI.POIFS.FileSystem.DirectoryEntry">
  21586. <summary>
  21587. This interface defines methods specific to Directory objects
  21588. managed by a Filesystem instance.
  21589. @author Marc Johnson (mjohnson at apache dot org)
  21590. </summary>
  21591. </member>
  21592. <member name="P:NPOI.POIFS.FileSystem.DirectoryEntry.Entries">
  21593. <summary>
  21594. get an iterator of the Entry instances contained directly in
  21595. this instance (in other words, children only; no grandchildren
  21596. etc.)
  21597. </summary>
  21598. <value>The entries.never null, but hasNext() may return false
  21599. immediately (i.e., this DirectoryEntry is empty). All
  21600. objects retrieved by next() are guaranteed to be
  21601. implementations of Entry.</value>
  21602. </member>
  21603. <member name="P:NPOI.POIFS.FileSystem.DirectoryEntry.EntryNames">
  21604. <summary>
  21605. get the names of all the Entries contained directly in this
  21606. instance (in other words, names of children only; no grandchildren etc).
  21607. </summary>
  21608. <value>the names of all the entries that may be retrieved with
  21609. getEntry(String), which may be empty (if this DirectoryEntry is empty
  21610. </value>
  21611. </member>
  21612. <member name="P:NPOI.POIFS.FileSystem.DirectoryEntry.IsEmpty">
  21613. <summary>
  21614. is this DirectoryEntry empty?
  21615. </summary>
  21616. <value><c>true</c> if this instance contains no Entry instances; otherwise, <c>false</c>.</value>
  21617. </member>
  21618. <member name="P:NPOI.POIFS.FileSystem.DirectoryEntry.EntryCount">
  21619. <summary>
  21620. find out how many Entry instances are contained directly within
  21621. this DirectoryEntry
  21622. </summary>
  21623. <value>number of immediately (no grandchildren etc.) contained
  21624. Entry instances</value>
  21625. </member>
  21626. <member name="M:NPOI.POIFS.FileSystem.DirectoryEntry.GetEntry(System.String)">
  21627. <summary>
  21628. get a specified Entry by name
  21629. </summary>
  21630. <param name="name">the name of the Entry to obtain.</param>
  21631. <returns>the specified Entry, if it is directly contained in
  21632. this DirectoryEntry</returns>
  21633. </member>
  21634. <member name="M:NPOI.POIFS.FileSystem.DirectoryEntry.CreateDocument(System.String,System.IO.Stream)">
  21635. <summary>
  21636. Create a new DocumentEntry
  21637. </summary>
  21638. <param name="name">the name of the new DocumentEntry</param>
  21639. <param name="stream">the Stream from which to Create the new DocumentEntry</param>
  21640. <returns>the new DocumentEntry</returns>
  21641. </member>
  21642. <member name="M:NPOI.POIFS.FileSystem.DirectoryEntry.CreateDocument(System.String,System.Int32,NPOI.POIFS.EventFileSystem.POIFSWriterListener)">
  21643. <summary>
  21644. Create a new DocumentEntry; the data will be provided later
  21645. </summary>
  21646. <param name="name">the name of the new DocumentEntry</param>
  21647. <param name="size">the size of the new DocumentEntry</param>
  21648. <param name="writer">BeforeWriting event handler</param>
  21649. <returns>the new DocumentEntry</returns>
  21650. </member>
  21651. <member name="M:NPOI.POIFS.FileSystem.DirectoryEntry.CreateDirectory(System.String)">
  21652. <summary>
  21653. Create a new DirectoryEntry
  21654. </summary>
  21655. <param name="name">the name of the new DirectoryEntry</param>
  21656. <returns>the name of the new DirectoryEntry</returns>
  21657. </member>
  21658. <member name="P:NPOI.POIFS.FileSystem.DirectoryEntry.StorageClsid">
  21659. <summary>
  21660. Gets or sets the storage ClassID.
  21661. </summary>
  21662. <value>The storage ClassID.</value>
  21663. </member>
  21664. <member name="M:NPOI.POIFS.FileSystem.DirectoryEntry.HasEntry(System.String)">
  21665. <summary>
  21666. Checks if entry with specified name present
  21667. </summary>
  21668. <param name="name">entry name</param>
  21669. <returns>true if have</returns>
  21670. </member>
  21671. <member name="T:NPOI.POIFS.FileSystem.DirectoryNode">
  21672. <summary>
  21673. Simple implementation of DirectoryEntry
  21674. @author Marc Johnson (mjohnson at apache dot org)
  21675. </summary>
  21676. </member>
  21677. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.#ctor(NPOI.POIFS.Properties.DirectoryProperty,NPOI.POIFS.FileSystem.OPOIFSFileSystem,NPOI.POIFS.FileSystem.DirectoryNode)">
  21678. <summary>
  21679. Create a DirectoryNode. This method Is not public by design; it
  21680. Is intended strictly for the internal use of this package
  21681. </summary>
  21682. <param name="property">the DirectoryProperty for this DirectoryEntry</param>
  21683. <param name="fileSystem">the OPOIFSFileSystem we belong to</param>
  21684. <param name="parent">the parent of this entry</param>
  21685. </member>
  21686. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.#ctor(NPOI.POIFS.Properties.DirectoryProperty,NPOI.POIFS.FileSystem.NPOIFSFileSystem,NPOI.POIFS.FileSystem.DirectoryNode)">
  21687. <summary>
  21688. Create a DirectoryNode. This method Is not public by design; it
  21689. Is intended strictly for the internal use of this package
  21690. </summary>
  21691. <param name="property">the DirectoryProperty for this DirectoryEntry</param>
  21692. <param name="nFileSystem">the POIFSFileSystem we belong to</param>
  21693. <param name="parent">the parent of this entry</param>
  21694. </member>
  21695. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.CreatePOIFSDocumentReader(System.String)">
  21696. <summary>
  21697. open a document in the directory's entry's list of entries
  21698. </summary>
  21699. <param name="documentName">the name of the document to be opened</param>
  21700. <returns>a newly opened DocumentStream</returns>
  21701. </member>
  21702. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.CreateDocument(NPOI.POIFS.FileSystem.OPOIFSDocument)">
  21703. <summary>
  21704. Create a new DocumentEntry; the data will be provided later
  21705. </summary>
  21706. <param name="document">the name of the new documentEntry</param>
  21707. <returns>the new DocumentEntry</returns>
  21708. </member>
  21709. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.ChangeName(System.String,System.String)">
  21710. <summary>
  21711. Change a contained Entry's name
  21712. </summary>
  21713. <param name="oldName">the original name</param>
  21714. <param name="newName">the new name</param>
  21715. <returns>true if the operation succeeded, else false</returns>
  21716. </member>
  21717. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.DeleteEntry(NPOI.POIFS.FileSystem.EntryNode)">
  21718. <summary>
  21719. Deletes the entry.
  21720. </summary>
  21721. <param name="entry">the EntryNode to be Deleted</param>
  21722. <returns>true if the entry was Deleted, else false</returns>
  21723. </member>
  21724. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.Path">
  21725. <summary>
  21726. Gets the path.
  21727. </summary>
  21728. <value>this directory's path representation</value>
  21729. </member>
  21730. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.FileSystem">
  21731. <summary>
  21732. return the filesystem that this belongs to
  21733. TODO: Temporary workaround during #56791
  21734. </summary>
  21735. </member>
  21736. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.OFileSystem">
  21737. <summary>
  21738. If this is OPOIFS based, return the NPOIFSFileSystem
  21739. that this belong to, otherwise Null if NPOIFS based
  21740. return the filesystem that this belongs to
  21741. </summary>
  21742. </member>
  21743. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.NFileSystem">
  21744. <summary>
  21745. If this is NPOIFS based, return the NPOIFSFileSystem
  21746. that this belong to, otherwise Null if OPOIFS based.
  21747. return the filesystem that this belongs to
  21748. </summary>
  21749. </member>
  21750. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.Entries">
  21751. <summary>
  21752. get an iterator of the Entry instances contained directly in
  21753. this instance (in other words, children only; no grandchildren
  21754. etc.)
  21755. </summary>
  21756. <value>
  21757. The entries.never null, but hasNext() may return false
  21758. immediately (i.e., this DirectoryEntry is empty). All
  21759. objects retrieved by next() are guaranteed to be
  21760. implementations of Entry.
  21761. </value>
  21762. </member>
  21763. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.EntryNames">
  21764. get the names of all the Entries contained directly in this
  21765. instance (in other words, names of children only; no grandchildren
  21766. etc).
  21767. @return the names of all the entries that may be retrieved with
  21768. getEntry(String), which may be empty (if this
  21769. DirectoryEntry is empty)
  21770. </member>
  21771. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.IsEmpty">
  21772. <summary>
  21773. is this DirectoryEntry empty?
  21774. </summary>
  21775. <value>
  21776. <c>true</c> if this instance contains no Entry instances; otherwise, <c>false</c>.
  21777. </value>
  21778. </member>
  21779. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.EntryCount">
  21780. <summary>
  21781. find out how many Entry instances are contained directly within
  21782. this DirectoryEntry
  21783. </summary>
  21784. <value>
  21785. number of immediately (no grandchildren etc.) contained
  21786. Entry instances
  21787. </value>
  21788. </member>
  21789. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.GetEntry(System.String)">
  21790. <summary>
  21791. get a specified Entry by name
  21792. </summary>
  21793. <param name="name">the name of the Entry to obtain.</param>
  21794. <returns>
  21795. the specified Entry, if it is directly contained in
  21796. this DirectoryEntry
  21797. </returns>
  21798. </member>
  21799. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.CreateDirectory(System.String)">
  21800. <summary>
  21801. Create a new DirectoryEntry
  21802. </summary>
  21803. <param name="name">the name of the new DirectoryEntry</param>
  21804. <returns>the name of the new DirectoryEntry</returns>
  21805. </member>
  21806. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.CreateOrUpdateDocument(System.String,System.IO.Stream)">
  21807. Set the contents of a document, creating if needed,
  21808. otherwise updating. Returns the created / updated DocumentEntry
  21809. @param name the name of the new or existing DocumentEntry
  21810. @param stream the InputStream from which to populate the DocumentEntry
  21811. @return the new or updated DocumentEntry
  21812. @exception IOException
  21813. </member>
  21814. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.StorageClsid">
  21815. <summary>
  21816. Gets or Sets the storage clsid for the directory entry
  21817. </summary>
  21818. <value>The storage ClassID.</value>
  21819. </member>
  21820. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.IsDirectoryEntry">
  21821. <summary>
  21822. Is this a DirectoryEntry?
  21823. </summary>
  21824. <value>true if the Entry Is a DirectoryEntry, else false</value>
  21825. </member>
  21826. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.IsDeleteOK">
  21827. <summary>
  21828. extensions use this method to verify internal rules regarding
  21829. deletion of the underlying store.
  21830. </summary>
  21831. <value> true if it's ok to Delete the underlying store, else
  21832. false</value>
  21833. </member>
  21834. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.ViewableArray">
  21835. <summary>
  21836. Get an array of objects, some of which may implement POIFSViewable
  21837. </summary>
  21838. <value>an array of Object; may not be null, but may be empty</value>
  21839. </member>
  21840. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.ViewableIterator">
  21841. <summary>
  21842. Get an Iterator of objects, some of which may implement
  21843. POIFSViewable
  21844. </summary>
  21845. <value>an Iterator; may not be null, but may have an empty
  21846. back end store</value>
  21847. </member>
  21848. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.PreferArray">
  21849. <summary>
  21850. Give viewers a hint as to whether to call GetViewableArray or
  21851. GetViewableIterator
  21852. </summary>
  21853. <value><c>true</c> if a viewer should call GetViewableArray; otherwise, <c>false</c>if
  21854. a viewer should call GetViewableIterator</value>
  21855. </member>
  21856. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.ShortDescription">
  21857. <summary>
  21858. Provides a short description of the object, to be used when a
  21859. POIFSViewable object has not provided its contents.
  21860. </summary>
  21861. <value>The short description.</value>
  21862. </member>
  21863. <member name="T:NPOI.POIFS.FileSystem.DocumentEntry">
  21864. <summary>
  21865. This interface defines methods specific to Document objects
  21866. managed by a Filesystem instance.
  21867. @author Marc Johnson (mjohnson at apache dot org)
  21868. </summary>
  21869. </member>
  21870. <member name="P:NPOI.POIFS.FileSystem.DocumentEntry.Size">
  21871. <summary>
  21872. get the size of the document, in bytes
  21873. </summary>
  21874. <value>size in bytes</value>
  21875. </member>
  21876. <member name="T:NPOI.POIFS.FileSystem.DocumentFactoryHelper">
  21877. <summary>
  21878. A small base class for the various factories, e.g. WorkbookFactory, SlideShowFactory to combine common code here.
  21879. </summary>
  21880. </member>
  21881. <member name="M:NPOI.POIFS.FileSystem.DocumentFactoryHelper.HasOOXMLHeader(System.IO.Stream)">
  21882. <summary>
  21883. Checks that the supplied InputStream (which MUST support mark and reset, or be a PushbackInputStream) has a OOXML (zip) header at the start of it.
  21884. If your InputStream does not support mark / reset, then wrap it in a PushBackInputStream, then be sure to always use that, and not the original!
  21885. </summary>
  21886. <param name="inp">An InputStream which supports either mark/reset, or is a PushbackInputStream</param>
  21887. <returns></returns>
  21888. </member>
  21889. <member name="T:NPOI.POIFS.FileSystem.DocumentInputStream">
  21890. This class provides methods to read a DocumentEntry managed by a
  21891. {@link POIFSFileSystem} or {@link NPOIFSFileSystem} instance.
  21892. It Creates the appropriate one, and delegates, allowing us to
  21893. work transparently with the two.
  21894. </member>
  21895. <member name="F:NPOI.POIFS.FileSystem.DocumentInputStream.EOF">
  21896. returned by read operations if we're at end of document
  21897. </member>
  21898. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.#ctor">
  21899. For use by downstream implementations
  21900. </member>
  21901. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.#ctor(NPOI.POIFS.FileSystem.DocumentEntry)">
  21902. Create an InputStream from the specified DocumentEntry
  21903. @param document the DocumentEntry to be read
  21904. @exception IOException if the DocumentEntry cannot be opened (like, maybe it has
  21905. been deleted?)
  21906. </member>
  21907. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.#ctor(NPOI.POIFS.FileSystem.OPOIFSDocument)">
  21908. Create an InputStream from the specified Document
  21909. @param document the Document to be read
  21910. </member>
  21911. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.#ctor(NPOI.POIFS.FileSystem.NPOIFSDocument)">
  21912. Create an InputStream from the specified Document
  21913. @param document the Document to be read
  21914. </member>
  21915. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.MarkSupported">
  21916. Tests if this input stream supports the mark and reset methods.
  21917. @return <code>true</code> always
  21918. </member>
  21919. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.Reset">
  21920. Repositions this stream to the position at the time the mark() method was
  21921. last called on this input stream. If mark() has not been called this
  21922. method repositions the stream to its beginning.
  21923. </member>
  21924. <member name="T:NPOI.POIFS.FileSystem.DocumentNode">
  21925. <summary>
  21926. Simple implementation of DocumentEntry
  21927. @author Marc Johnson (mjohnson at apache dot org)
  21928. </summary>
  21929. </member>
  21930. <member name="M:NPOI.POIFS.FileSystem.DocumentNode.#ctor(NPOI.POIFS.Properties.DocumentProperty,NPOI.POIFS.FileSystem.DirectoryNode)">
  21931. create a DocumentNode. This method Is not public by design; it
  21932. Is intended strictly for the internal use of this package
  21933. @param property the DocumentProperty for this DocumentEntry
  21934. @param parent the parent of this entry
  21935. </member>
  21936. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.Document">
  21937. get the POIFSDocument
  21938. @return the internal POIFSDocument
  21939. </member>
  21940. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.Size">
  21941. get the zize of the document, in bytes
  21942. @return size in bytes
  21943. </member>
  21944. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.IsDocumentEntry">
  21945. Is this a DocumentEntry?
  21946. @return true if the Entry Is a DocumentEntry, else false
  21947. </member>
  21948. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.IsDeleteOK">
  21949. extensions use this method to verify internal rules regarding
  21950. deletion of the underlying store.
  21951. @return true if it's ok to delete the underlying store, else
  21952. false
  21953. </member>
  21954. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.ViewableArray">
  21955. Get an array of objects, some of which may implement
  21956. POIFSViewable
  21957. @return an array of Object; may not be null, but may be empty
  21958. </member>
  21959. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.ViewableIterator">
  21960. Get an Iterator of objects, some of which may implement
  21961. POIFSViewable
  21962. @return an Iterator; may not be null, but may have an empty
  21963. back end store
  21964. </member>
  21965. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.PreferArray">
  21966. Give viewers a hint as to whether to call getViewableArray or
  21967. getViewableIterator
  21968. @return true if a viewer should call getViewableArray, false if
  21969. a viewer should call getViewableIterator
  21970. </member>
  21971. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.ShortDescription">
  21972. Provides a short description of the object, to be used when a
  21973. POIFSViewable object has not provided its contents.
  21974. @return short description
  21975. </member>
  21976. <member name="T:NPOI.POIFS.FileSystem.DocumentOutputStream">
  21977. This class provides a wrapper over an OutputStream so that Document
  21978. Writers can't accidently go over their size limits
  21979. @author Marc Johnson (mjohnson at apache dot org)
  21980. </member>
  21981. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.#ctor(System.IO.Stream,System.Int32)">
  21982. Create a DocumentOutputStream
  21983. @param stream the OutputStream to which the data is actually
  21984. read
  21985. @param limit the maximum number of bytes that can be written
  21986. </member>
  21987. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.Write(System.Int32)">
  21988. Writes the specified byte to this output stream. The general
  21989. contract for write is that one byte is written to the output
  21990. stream. The byte to be written is the eight low-order bits of
  21991. the argument b. The 24 high-order bits of b are ignored.
  21992. @param b the byte.
  21993. @exception IOException if an I/O error occurs. In particular,
  21994. an IOException may be thrown if the
  21995. output stream has been closed, or if the
  21996. Writer tries to write too much data.
  21997. </member>
  21998. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.Write(System.Byte[])">
  21999. Writes b.Length bytes from the specified byte array
  22000. to this output stream.
  22001. @param b the data.
  22002. @exception IOException if an I/O error occurs.
  22003. </member>
  22004. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.Write(System.Byte[],System.Int32,System.Int32)">
  22005. <summary>
  22006. Writes len bytes from the specified byte array starting at
  22007. offset off to this output stream. The general contract for
  22008. Write(b, off, len) is that some of the bytes in the array b are
  22009. written to the output stream in order; element b[off] is the
  22010. first byte written and b[off+len-1] is the last byte written by
  22011. this operation.
  22012. </summary>
  22013. <param name="b">the data.</param>
  22014. <param name="off">the start offset in the data.</param>
  22015. <param name="len">the number of bytes to Write.</param>
  22016. </member>
  22017. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.Flush">
  22018. <summary>
  22019. Flushes this output stream and forces any buffered output bytes to be written out
  22020. </summary>
  22021. </member>
  22022. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.Close">
  22023. Closes this output stream and releases any system resources
  22024. associated with this stream. The general contract of close is
  22025. that it closes the output stream. A closed stream cannot
  22026. perform output operations and cannot be reopened.
  22027. @exception IOException if an I/O error occurs.
  22028. </member>
  22029. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.WriteFiller(System.Int32,System.Byte)">
  22030. write the rest of the document's data (fill in at the end)
  22031. @param totalLimit the actual number of bytes the corresponding
  22032. document must fill
  22033. @param fill the byte to fill remaining space with
  22034. @exception IOException on I/O error
  22035. </member>
  22036. <member name="T:NPOI.POIFS.FileSystem.Entry">
  22037. <summary>
  22038. This interface provides access to an object managed by a Filesystem
  22039. instance. Entry objects are further divided into DocumentEntry and
  22040. DirectoryEntry instances.
  22041. @author Marc Johnson (mjohnson at apache dot org)
  22042. </summary>
  22043. </member>
  22044. <member name="P:NPOI.POIFS.FileSystem.Entry.Name">
  22045. <summary>
  22046. Get the name of the Entry
  22047. </summary>
  22048. <value>The name.</value>
  22049. </member>
  22050. <member name="P:NPOI.POIFS.FileSystem.Entry.IsDirectoryEntry">
  22051. <summary>
  22052. Is this a DirectoryEntry?
  22053. </summary>
  22054. <value>
  22055. <c>true</c> if the Entry Is a DirectoryEntry; otherwise, <c>false</c>.
  22056. </value>
  22057. </member>
  22058. <member name="P:NPOI.POIFS.FileSystem.Entry.IsDocumentEntry">
  22059. <summary>
  22060. Is this a DocumentEntry?
  22061. </summary>
  22062. <value>
  22063. <c>true</c> if the Entry Is a DocumentEntry; otherwise, <c>false</c>.
  22064. </value>
  22065. </member>
  22066. <member name="P:NPOI.POIFS.FileSystem.Entry.Parent">
  22067. <summary>
  22068. Get this Entry's parent (the DirectoryEntry that owns this
  22069. Entry). All Entry objects, except the root Entry, has a parent.
  22070. </summary>
  22071. <value>this Entry's parent; null iff this Is the root Entry</value>
  22072. This property is moved to EntryNode
  22073. </member>
  22074. <member name="M:NPOI.POIFS.FileSystem.Entry.Delete">
  22075. <summary>
  22076. Delete this Entry. ThIs operation should succeed, but there are
  22077. special circumstances when it will not:
  22078. If this Entry Is the root of the Entry tree, it cannot be
  22079. deleted, as there Is no way to Create another one.
  22080. If this Entry Is a directory, it cannot be deleted unless it Is
  22081. empty.
  22082. </summary>
  22083. <returns>true if the Entry was successfully deleted, else false</returns>
  22084. </member>
  22085. <member name="M:NPOI.POIFS.FileSystem.Entry.RenameTo(System.String)">
  22086. <summary>
  22087. Rename this Entry. ThIs operation will fail if:
  22088. There Is a sibling Entry (i.e., an Entry whose parent Is the
  22089. same as this Entry's parent) with the same name.
  22090. ThIs Entry Is the root of the Entry tree. Its name Is dictated
  22091. by the Filesystem and many not be Changed.
  22092. </summary>
  22093. <param name="newName">the new name for this Entry</param>
  22094. <returns>true if the operation succeeded, else false</returns>
  22095. </member>
  22096. <member name="T:NPOI.POIFS.FileSystem.EntryNode">
  22097. <summary>
  22098. Abstract implementation of Entry
  22099. Extending classes should override isDocument() or isDirectory(), as
  22100. appropriate
  22101. Extending classes must override isDeleteOK()
  22102. @author Marc Johnson (mjohnson at apache dot org)
  22103. </summary>
  22104. </member>
  22105. <member name="M:NPOI.POIFS.FileSystem.EntryNode.#ctor(NPOI.POIFS.Properties.Property,NPOI.POIFS.FileSystem.DirectoryNode)">
  22106. <summary>
  22107. Create a DocumentNode. ThIs method Is not public by design; it
  22108. Is intended strictly for the internal use of extending classes
  22109. </summary>
  22110. <param name="property">the Property for this Entry</param>
  22111. <param name="parent">the parent of this entry</param>
  22112. </member>
  22113. <member name="P:NPOI.POIFS.FileSystem.EntryNode.Property">
  22114. <summary>
  22115. grant access to the property
  22116. </summary>
  22117. <value>the property backing this entry</value>
  22118. </member>
  22119. <member name="P:NPOI.POIFS.FileSystem.EntryNode.IsRoot">
  22120. <summary>
  22121. Is this the root of the tree?
  22122. </summary>
  22123. <value><c>true</c> if this instance is root; otherwise, <c>false</c>.</value>
  22124. </member>
  22125. <member name="P:NPOI.POIFS.FileSystem.EntryNode.IsDeleteOK">
  22126. <summary>
  22127. extensions use this method to verify internal rules regarding
  22128. deletion of the underlying store.
  22129. </summary>
  22130. <value>
  22131. <c>true</c> if it's ok to Delete the underlying store; otherwise, <c>false</c>.
  22132. </value>
  22133. </member>
  22134. <member name="P:NPOI.POIFS.FileSystem.EntryNode.Name">
  22135. <summary>
  22136. Get the name of the Entry
  22137. </summary>
  22138. <value>The name.</value>
  22139. Get the name of the Entry
  22140. @return name
  22141. </member>
  22142. <member name="P:NPOI.POIFS.FileSystem.EntryNode.IsDirectoryEntry">
  22143. <summary>
  22144. Is this a DirectoryEntry?
  22145. </summary>
  22146. <value>
  22147. <c>true</c> if the Entry Is a DirectoryEntry; otherwise, <c>false</c>.
  22148. </value>
  22149. </member>
  22150. <member name="P:NPOI.POIFS.FileSystem.EntryNode.IsDocumentEntry">
  22151. <summary>
  22152. Is this a DocumentEntry?
  22153. </summary>
  22154. <value>
  22155. <c>true</c> if the Entry Is a DocumentEntry; otherwise, <c>false</c>.
  22156. </value>
  22157. </member>
  22158. <member name="P:NPOI.POIFS.FileSystem.EntryNode.Parent">
  22159. <summary>
  22160. Get this Entry's parent (the DocumentEntry that owns this
  22161. Entry). All Entry objects, except the root Entry, has a parent.
  22162. </summary>
  22163. <value>this Entry's parent; null iff this Is the root Entry</value>
  22164. </member>
  22165. <member name="M:NPOI.POIFS.FileSystem.EntryNode.Delete">
  22166. <summary>
  22167. Delete this Entry. ThIs operation should succeed, but there are
  22168. special circumstances when it will not:
  22169. If this Entry Is the root of the Entry tree, it cannot be
  22170. deleted, as there Is no way to Create another one.
  22171. If this Entry Is a directory, it cannot be deleted unless it Is
  22172. empty.
  22173. </summary>
  22174. <returns>
  22175. true if the Entry was successfully deleted, else false
  22176. </returns>
  22177. </member>
  22178. <member name="M:NPOI.POIFS.FileSystem.EntryNode.RenameTo(System.String)">
  22179. <summary>
  22180. Rename this Entry. ThIs operation will fail if:
  22181. There Is a sibling Entry (i.e., an Entry whose parent Is the
  22182. same as this Entry's parent) with the same name.
  22183. ThIs Entry Is the root of the Entry tree. Its name Is dictated
  22184. by the Filesystem and many not be Changed.
  22185. </summary>
  22186. <param name="newName">the new name for this Entry</param>
  22187. <returns>
  22188. true if the operation succeeded, else false
  22189. </returns>
  22190. </member>
  22191. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodeRecursively(NPOI.POIFS.FileSystem.Entry,NPOI.POIFS.FileSystem.DirectoryEntry)">
  22192. Copies an Entry into a target POIFS directory, recursively
  22193. </member>
  22194. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.DirectoryEntry,NPOI.POIFS.FileSystem.DirectoryEntry)">
  22195. Copies all the nodes from one POIFS Directory to another
  22196. @param sourceRoot
  22197. is the source Directory to copy from
  22198. @param targetRoot
  22199. is the target Directory to copy to
  22200. </member>
  22201. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.FilteringDirectoryNode,NPOI.POIFS.FileSystem.FilteringDirectoryNode)">
  22202. Copies nodes from one Directory to the other minus the excepts
  22203. @param filteredSource The filtering source Directory to copy from
  22204. @param filteredTarget The filtering target Directory to copy to
  22205. </member>
  22206. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.DirectoryEntry,NPOI.POIFS.FileSystem.DirectoryEntry,System.Collections.Generic.List{System.String})">
  22207. Copies nodes from one Directory to the other minus the excepts
  22208. @param sourceRoot
  22209. is the source Directory to copy from
  22210. @param targetRoot
  22211. is the target Directory to copy to
  22212. @param excepts
  22213. is a list of Strings specifying what nodes NOT to copy
  22214. @deprecated use {@link FilteringDirectoryNode} instead
  22215. </member>
  22216. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.OPOIFSFileSystem,NPOI.POIFS.FileSystem.OPOIFSFileSystem)">
  22217. Copies all nodes from one POIFS to the other
  22218. @param source
  22219. is the source POIFS to copy from
  22220. @param target
  22221. is the target POIFS to copy to
  22222. </member>
  22223. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.NPOIFSFileSystem,NPOI.POIFS.FileSystem.NPOIFSFileSystem)">
  22224. Copies all nodes from one POIFS to the other
  22225. @param source
  22226. is the source POIFS to copy from
  22227. @param target
  22228. is the target POIFS to copy to
  22229. </member>
  22230. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.OPOIFSFileSystem,NPOI.POIFS.FileSystem.OPOIFSFileSystem,System.Collections.Generic.List{System.String})">
  22231. Copies nodes from one POIFS to the other, minus the excepts.
  22232. This delegates the filtering work to {@link FilteringDirectoryNode},
  22233. so excepts can be of the form "NodeToExclude" or
  22234. "FilteringDirectory/ExcludedChildNode"
  22235. @param source is the source POIFS to copy from
  22236. @param target is the target POIFS to copy to
  22237. @param excepts is a list of Entry Names to be excluded from the copy
  22238. </member>
  22239. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.NPOIFSFileSystem,NPOI.POIFS.FileSystem.NPOIFSFileSystem,System.Collections.Generic.List{System.String})">
  22240. Copies nodes from one POIFS to the other, minus the excepts.
  22241. This delegates the filtering work to {@link FilteringDirectoryNode},
  22242. so excepts can be of the form "NodeToExclude" or
  22243. "FilteringDirectory/ExcludedChildNode"
  22244. @param source is the source POIFS to copy from
  22245. @param target is the target POIFS to copy to
  22246. @param excepts is a list of Entry Names to be excluded from the copy
  22247. </member>
  22248. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.AreDirectoriesIdentical(NPOI.POIFS.FileSystem.DirectoryEntry,NPOI.POIFS.FileSystem.DirectoryEntry)">
  22249. Checks to see if the two Directories hold the same contents.
  22250. For this to be true, they must have entries with the same names,
  22251. no entries in one but not the other, and the size+contents
  22252. of each entry must match, and they must share names.
  22253. To exclude certain parts of the Directory from being checked,
  22254. use a {@link FilteringDirectoryNode}
  22255. </member>
  22256. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.AreDocumentsIdentical(NPOI.POIFS.FileSystem.DocumentEntry,NPOI.POIFS.FileSystem.DocumentEntry)">
  22257. Checks to see if two Documents have the same name
  22258. and the same contents. (Their parent directories are
  22259. not checked)
  22260. </member>
  22261. <member name="T:NPOI.POIFS.FileSystem.FilteringDirectoryNode">
  22262. <summary>
  22263. A DirectoryEntry filter, which exposes another DirectoryEntry less certain parts.
  22264. This is typically used when copying or comparing Filesystems.
  22265. </summary>
  22266. </member>
  22267. <member name="M:NPOI.POIFS.FileSystem.FilteringDirectoryNode.#ctor(NPOI.POIFS.FileSystem.DirectoryEntry,System.Collections.Generic.ICollection{System.String})">
  22268. <summary>
  22269. Creates a filter round the specified directory, which will exclude entries such as
  22270. "MyNode" and "MyDir/IgnoreNode". The excludes can stretch into children, if they contain a /.
  22271. </summary>
  22272. <param name="directory">The Directory to filter</param>
  22273. <param name="excludes">The Entries to exclude</param>
  22274. </member>
  22275. <member name="T:NPOI.POIFS.FileSystem.NDocumentInputStream">
  22276. This class provides methods to read a DocumentEntry managed by a
  22277. {@link NPOIFSFileSystem} instance.
  22278. </member>
  22279. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._current_offset">
  22280. current offset into the Document
  22281. </member>
  22282. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._current_block_count">
  22283. current block count
  22284. </member>
  22285. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._marked_offset">
  22286. current marked offset into the Document (used by mark and Reset)
  22287. </member>
  22288. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._marked_offset_count">
  22289. and the block count for it
  22290. </member>
  22291. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._document_size">
  22292. the Document's size
  22293. </member>
  22294. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._closed">
  22295. have we been closed?
  22296. </member>
  22297. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._document">
  22298. the actual Document
  22299. </member>
  22300. <member name="M:NPOI.POIFS.FileSystem.NDocumentInputStream.#ctor(NPOI.POIFS.FileSystem.DocumentEntry)">
  22301. Create an InputStream from the specified DocumentEntry
  22302. @param document the DocumentEntry to be read
  22303. @exception IOException if the DocumentEntry cannot be opened (like, maybe it has
  22304. been deleted?)
  22305. </member>
  22306. <member name="M:NPOI.POIFS.FileSystem.NDocumentInputStream.#ctor(NPOI.POIFS.FileSystem.NPOIFSDocument)">
  22307. Create an InputStream from the specified Document
  22308. @param document the Document to be read
  22309. </member>
  22310. <member name="M:NPOI.POIFS.FileSystem.NDocumentInputStream.Reset">
  22311. Repositions this stream to the position at the time the mark() method was
  22312. last called on this input stream. If mark() has not been called this
  22313. method repositions the stream to its beginning.
  22314. </member>
  22315. <member name="T:NPOI.POIFS.FileSystem.NotOLE2FileException">
  22316. This exception is thrown when we try to open a file that doesn't
  22317. seem to actually be an OLE2 file After all
  22318. </member>
  22319. <member name="T:NPOI.POIFS.FileSystem.NPOIFSDocument">
  22320. This class manages a document in the NIO POIFS filesystem.
  22321. This is the {@link NPOIFSFileSystem} version.
  22322. </member>
  22323. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.#ctor(NPOI.POIFS.FileSystem.DocumentNode)">
  22324. Constructor for an existing Document
  22325. </member>
  22326. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.#ctor(NPOI.POIFS.Properties.DocumentProperty,NPOI.POIFS.FileSystem.NPOIFSFileSystem)">
  22327. Constructor for an existing Document
  22328. </member>
  22329. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.#ctor(System.String,NPOI.POIFS.FileSystem.NPOIFSFileSystem,System.IO.Stream)">
  22330. Constructor for a new Document
  22331. @param name the name of the POIFSDocument
  22332. @param stream the InputStream we read data from
  22333. </member>
  22334. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.Free">
  22335. Frees the underlying stream and property
  22336. </member>
  22337. <member name="P:NPOI.POIFS.FileSystem.NPOIFSDocument.Size">
  22338. @return size of the document
  22339. </member>
  22340. <member name="P:NPOI.POIFS.FileSystem.NPOIFSDocument.DocumentProperty">
  22341. @return the instance's DocumentProperty
  22342. </member>
  22343. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.GetViewableArray">
  22344. Get an array of objects, some of which may implement POIFSViewable
  22345. @return an array of Object; may not be null, but may be empty
  22346. </member>
  22347. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.GetViewableIterator">
  22348. Get an Iterator of objects, some of which may implement POIFSViewable
  22349. @return an Iterator; may not be null, but may have an empty back end
  22350. store
  22351. </member>
  22352. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.GetShortDescription">
  22353. Provides a short description of the object, to be used when a
  22354. POIFSViewable object has not provided its contents.
  22355. @return short description
  22356. </member>
  22357. <member name="T:NPOI.POIFS.FileSystem.NPOIFSFileSystem">
  22358. This is the main class of the POIFS system; it manages the entire
  22359. life cycle of the filesystem.
  22360. This is the new NIO version
  22361. </member>
  22362. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateNonClosingInputStream(System.IO.Stream)">
  22363. Convenience method for clients that want to avoid the auto-close behaviour of the constructor.
  22364. </member>
  22365. <member name="F:NPOI.POIFS.FileSystem.NPOIFSFileSystem.bigBlockSize">
  22366. What big block size the file uses. Most files
  22367. use 512 bytes, but a few use 4096
  22368. </member>
  22369. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.#ctor">
  22370. Constructor, intended for writing
  22371. </member>
  22372. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.#ctor(System.IO.FileInfo)">
  22373. <p>Creates a POIFSFileSystem from a <tt>File</tt>. This uses less memory than
  22374. creating from an <tt>InputStream</tt>. The File will be opened read-only</p>
  22375. <p>Note that with this constructor, you will need to call {@link #close()}
  22376. when you're done to have the underlying file closed, as the file is
  22377. kept open during normal operation to read the data out.</p>
  22378. @param file the File from which to read the data
  22379. @exception IOException on errors reading, or on invalid data
  22380. </member>
  22381. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.#ctor(System.IO.FileInfo,System.Boolean)">
  22382. <p>Creates a POIFSFileSystem from a <tt>File</tt>. This uses less memory than
  22383. creating from an <tt>InputStream</tt>.</p>
  22384. <p>Note that with this constructor, you will need to call {@link #close()}
  22385. when you're done to have the underlying file closed, as the file is
  22386. kept open during normal operation to read the data out.</p>
  22387. @param file the File from which to read or read/write the data
  22388. @param readOnly whether the POIFileSystem will only be used in read-only mode
  22389. @exception IOException on errors reading, or on invalid data
  22390. </member>
  22391. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.#ctor(System.IO.FileStream)">
  22392. * <p>Creates a POIFSFileSystem from an open <tt>FileChannel</tt>. This uses
  22393. * less memory than creating from an <tt>InputStream</tt>. The stream will
  22394. * be used in read-only mode.</p>
  22395. *
  22396. * <p>Note that with this constructor, you will need to call {@link #close()}
  22397. * when you're done to have the underlying Channel closed, as the channel is
  22398. * kept open during normal operation to read the data out.</p>
  22399. *
  22400. * @param channel the FileChannel from which to read the data
  22401. *
  22402. * @exception IOException on errors reading, or on invalid data
  22403. </member>
  22404. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.#ctor(System.IO.FileStream,System.Boolean)">
  22405. <p>Creates a POIFSFileSystem from an open <tt>FileChannel</tt>. This uses
  22406. less memory than creating from an <tt>InputStream</tt>.</p>
  22407. <p>Note that with this constructor, you will need to call {@link #close()}
  22408. when you're done to have the underlying Channel closed, as the channel is
  22409. kept open during normal operation to read the data out.</p>
  22410. @param channel the FileChannel from which to read or read/write the data
  22411. @param readOnly whether the POIFileSystem will only be used in read-only mode
  22412. @exception IOException on errors reading, or on invalid data
  22413. </member>
  22414. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.#ctor(System.IO.Stream)">
  22415. Create a POIFSFileSystem from an <tt>InputStream</tt>. Normally the stream is read until
  22416. EOF. The stream is always closed.<p/>
  22417. Some streams are usable After reaching EOF (typically those that return <code>true</code>
  22418. for <tt>markSupported()</tt>). In the unlikely case that the caller has such a stream
  22419. <i>and</i> needs to use it After this constructor completes, a work around is to wrap the
  22420. stream in order to trap the <tt>close()</tt> call. A convenience method (
  22421. <tt>CreateNonClosingInputStream()</tt>) has been provided for this purpose:
  22422. <pre>
  22423. InputStream wrappedStream = POIFSFileSystem.CreateNonClosingInputStream(is);
  22424. HSSFWorkbook wb = new HSSFWorkbook(wrappedStream);
  22425. is.Reset();
  22426. doSomethingElse(is);
  22427. </pre>
  22428. Note also the special case of <tt>MemoryStream</tt> for which the <tt>close()</tt>
  22429. method does nothing.
  22430. <pre>
  22431. MemoryStream bais = ...
  22432. HSSFWorkbook wb = new HSSFWorkbook(bais); // calls bais.Close() !
  22433. bais.Reset(); // no problem
  22434. doSomethingElse(bais);
  22435. </pre>
  22436. @param stream the InputStream from which to read the data
  22437. @exception IOException on errors Reading, or on invalid data
  22438. </member>
  22439. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CloseInputStream(System.IO.Stream,System.Boolean)">
  22440. @param stream the stream to be closed
  22441. @param success <code>false</code> if an exception is currently being thrown in the calling method
  22442. </member>
  22443. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.HasPOIFSHeader(System.IO.Stream)">
  22444. Checks that the supplied InputStream (which MUST
  22445. support mark and reset, or be a PushbackInputStream)
  22446. has a POIFS (OLE2) header at the start of it.
  22447. If your InputStream does not support mark / reset,
  22448. then wrap it in a PushBackInputStream, then be
  22449. sure to always use that, and not the original!
  22450. @param inp An InputStream which supports either mark/reset, or is a PushbackInputStream
  22451. </member>
  22452. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.HasPOIFSHeader(System.Byte[])">
  22453. Checks if the supplied first 8 bytes of a stream / file
  22454. has a POIFS (OLE2) header.
  22455. </member>
  22456. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.ReadCoreContents">
  22457. Read and process the PropertiesTable and the
  22458. FAT / XFAT blocks, so that we're Ready to
  22459. work with the file
  22460. </member>
  22461. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetBlockAt(System.Int32)">
  22462. Load the block at the given offset.
  22463. </member>
  22464. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateBlockIfNeeded(System.Int32)">
  22465. Load the block at the given offset,
  22466. extending the file if needed
  22467. </member>
  22468. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetBATBlockAndIndex(System.Int32)">
  22469. Returns the BATBlock that handles the specified offset,
  22470. and the relative index within it
  22471. </member>
  22472. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetNextBlock(System.Int32)">
  22473. Works out what block follows the specified one.
  22474. </member>
  22475. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.SetNextBlock(System.Int32,System.Int32)">
  22476. Changes the record of what block follows the specified one.
  22477. </member>
  22478. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetFreeBlock">
  22479. Finds a free block, and returns its offset.
  22480. This method will extend the file if needed, and if doing
  22481. so, allocate new FAT blocks to Address the extra space.
  22482. </member>
  22483. <member name="P:NPOI.POIFS.FileSystem.NPOIFSFileSystem.PropertyTable">
  22484. For unit Testing only! Returns the underlying
  22485. properties table
  22486. </member>
  22487. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetMiniStore">
  22488. Returns the MiniStore, which performs a similar low
  22489. level function to this, except for the small blocks.
  22490. </member>
  22491. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.AddDocument(NPOI.POIFS.FileSystem.NPOIFSDocument)">
  22492. add a new POIFSDocument to the FileSytem
  22493. @param document the POIFSDocument being Added
  22494. </member>
  22495. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.AddDirectory(NPOI.POIFS.Properties.DirectoryProperty)">
  22496. add a new DirectoryProperty to the FileSystem
  22497. @param directory the DirectoryProperty being Added
  22498. </member>
  22499. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateDocument(System.IO.Stream,System.String)">
  22500. Create a new document to be Added to the root directory
  22501. @param stream the InputStream from which the document's data
  22502. will be obtained
  22503. @param name the name of the new POIFSDocument
  22504. @return the new DocumentEntry
  22505. @exception IOException on error creating the new POIFSDocument
  22506. </member>
  22507. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateDocument(System.String,System.Int32,NPOI.POIFS.EventFileSystem.POIFSWriterListener)">
  22508. create a new DocumentEntry in the root entry; the data will be
  22509. provided later
  22510. @param name the name of the new DocumentEntry
  22511. @param size the size of the new DocumentEntry
  22512. @param Writer the Writer of the new DocumentEntry
  22513. @return the new DocumentEntry
  22514. @exception IOException
  22515. </member>
  22516. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateDirectory(System.String)">
  22517. create a new DirectoryEntry in the root directory
  22518. @param name the name of the new DirectoryEntry
  22519. @return the new DirectoryEntry
  22520. @exception IOException on name duplication
  22521. </member>
  22522. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateOrUpdateDocument(System.IO.Stream,System.String)">
  22523. Set the contents of a document in1 the root directory,
  22524. creating if needed, otherwise updating
  22525. @param stream the InputStream from which the document's data
  22526. will be obtained
  22527. @param name the name of the new or existing POIFSDocument
  22528. @return the new or updated DocumentEntry
  22529. @exception IOException on error populating the POIFSDocument
  22530. </member>
  22531. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.IsInPlaceWriteable">
  22532. Does the filesystem support an in-place write via
  22533. {@link #writeFilesystem()} ? If false, only writing out to
  22534. a brand new file via {@link #writeFilesystem(OutputStream)}
  22535. is supported.
  22536. </member>
  22537. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.WriteFileSystem">
  22538. Write the filesystem out to the open file. Will thrown an
  22539. {@link ArgumentException} if opened from an
  22540. {@link InputStream}.
  22541. @exception IOException thrown on errors writing to the stream
  22542. </member>
  22543. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.WriteFileSystem(System.IO.Stream)">
  22544. Write the filesystem out
  22545. @param stream the OutputStream to which the filesystem will be
  22546. written
  22547. @exception IOException thrown on errors writing to the stream
  22548. </member>
  22549. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.syncWithDataSource">
  22550. Has our in-memory objects write their state
  22551. to their backing blocks
  22552. </member>
  22553. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.Close">
  22554. Closes the FileSystem, freeing any underlying files, streams
  22555. and buffers. After this, you will be unable to read or
  22556. write from the FileSystem.
  22557. </member>
  22558. <member name="P:NPOI.POIFS.FileSystem.NPOIFSFileSystem.Root">
  22559. Get the root entry
  22560. @return the root entry
  22561. </member>
  22562. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateDocumentInputStream(System.String)">
  22563. open a document in the root entry's list of entries
  22564. @param documentName the name of the document to be opened
  22565. @return a newly opened DocumentInputStream
  22566. @exception IOException if the document does not exist or the
  22567. name is that of a DirectoryEntry
  22568. </member>
  22569. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.Remove(NPOI.POIFS.FileSystem.EntryNode)">
  22570. remove an entry
  22571. @param entry to be Removed
  22572. </member>
  22573. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetViewableArray">
  22574. Get an array of objects, some of which may implement
  22575. POIFSViewable
  22576. @return an array of Object; may not be null, but may be empty
  22577. </member>
  22578. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetViewableIterator">
  22579. Get an Iterator of objects, some of which may implement
  22580. POIFSViewable
  22581. @return an Iterator; may not be null, but may have an empty
  22582. back end store
  22583. </member>
  22584. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetShortDescription">
  22585. Provides a short description of the object, to be used when a
  22586. POIFSViewable object has not provided its contents.
  22587. @return short description
  22588. </member>
  22589. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetBigBlockSize">
  22590. @return The Big Block size, normally 512 bytes, sometimes 4096 bytes
  22591. </member>
  22592. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetBigBlockSizeDetails">
  22593. @return The Big Block size, normally 512 bytes, sometimes 4096 bytes
  22594. </member>
  22595. <member name="T:NPOI.POIFS.FileSystem.NPOIFSMiniStore">
  22596. This class handles the MiniStream (small block store)
  22597. in the NIO case for {@link NPOIFSFileSystem}
  22598. </member>
  22599. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.GetBlockAt(System.Int32)">
  22600. Load the block at the given offset.
  22601. </member>
  22602. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.CreateBlockIfNeeded(System.Int32)">
  22603. Load the block, extending the underlying stream if needed
  22604. </member>
  22605. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.GetBATBlockAndIndex(System.Int32)">
  22606. Returns the BATBlock that handles the specified offset,
  22607. and the relative index within it
  22608. </member>
  22609. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.GetNextBlock(System.Int32)">
  22610. Works out what block follows the specified one.
  22611. </member>
  22612. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.SetNextBlock(System.Int32,System.Int32)">
  22613. Changes the record of what block follows the specified one.
  22614. </member>
  22615. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.GetFreeBlock">
  22616. Finds a free block, and returns its offset.
  22617. This method will extend the file if needed, and if doing
  22618. so, allocate new FAT blocks to Address the extra space.
  22619. </member>
  22620. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.SyncWithDataSource">
  22621. <summary>
  22622. Writes the SBATs to their backing blocks, and updates
  22623. the mini-stream size in the properties. Stream size is
  22624. based on full blocks used, not the data within the streams
  22625. </summary>
  22626. </member>
  22627. <member name="T:NPOI.POIFS.FileSystem.NPOIFSStream">
  22628. This handles Reading and writing a stream within a
  22629. {@link NPOIFSFileSystem}. It can supply an iterator
  22630. to read blocks, and way to write out to existing and
  22631. new blocks.
  22632. Most users will want a higher level version of this,
  22633. which deals with properties to track which stream
  22634. this is.
  22635. This only works on big block streams, it doesn't
  22636. handle small block ones.
  22637. This uses the new NIO code
  22638. TODO Implement a streaming write method, and append
  22639. </member>
  22640. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.#ctor(NPOI.POIFS.FileSystem.BlockStore,System.Int32)">
  22641. Constructor for an existing stream. It's up to you
  22642. to know how to Get the start block (eg from a
  22643. {@link HeaderBlock} or a {@link Property})
  22644. </member>
  22645. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.#ctor(NPOI.POIFS.FileSystem.BlockStore)">
  22646. Constructor for a new stream. A start block won't
  22647. be allocated until you begin writing to it.
  22648. </member>
  22649. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.GetStartBlock">
  22650. What block does this stream start at?
  22651. Will be {@link POIFSConstants#END_OF_CHAIN} for a
  22652. new stream that hasn't been written to yet.
  22653. </member>
  22654. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.GetBlockIterator">
  22655. Returns an iterator that'll supply one {@link ByteBuffer}
  22656. per block in the stream.
  22657. </member>
  22658. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.UpdateContents(System.Byte[])">
  22659. Updates the contents of the stream to the new
  22660. Set of bytes.
  22661. Note - if this is property based, you'll still
  22662. need to update the size in the property yourself
  22663. </member>
  22664. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.Free">
  22665. Frees all blocks in the stream
  22666. </member>
  22667. <member name="T:NPOI.POIFS.FileSystem.ODocumentInputStream">
  22668. This class provides methods to read a DocumentEntry managed by a
  22669. {@link POIFSFileSystem} instance.
  22670. @author Marc Johnson (mjohnson at apache dot org)
  22671. </member>
  22672. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._current_offset">
  22673. current offset into the Document
  22674. </member>
  22675. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._marked_offset">
  22676. current marked offset into the Document (used by mark and Reset)
  22677. </member>
  22678. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._document_size">
  22679. the Document's size
  22680. </member>
  22681. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._closed">
  22682. have we been closed?
  22683. </member>
  22684. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._document">
  22685. the actual Document
  22686. </member>
  22687. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._currentBlock">
  22688. the data block Containing the current stream pointer
  22689. </member>
  22690. <member name="M:NPOI.POIFS.FileSystem.ODocumentInputStream.#ctor(NPOI.POIFS.FileSystem.DocumentEntry)">
  22691. Create an InputStream from the specified DocumentEntry
  22692. @param document the DocumentEntry to be read
  22693. @exception IOException if the DocumentEntry cannot be opened (like, maybe it has
  22694. been deleted?)
  22695. </member>
  22696. <member name="M:NPOI.POIFS.FileSystem.ODocumentInputStream.#ctor(NPOI.POIFS.FileSystem.OPOIFSDocument)">
  22697. Create an InputStream from the specified Document
  22698. @param document the Document to be read
  22699. </member>
  22700. <member name="M:NPOI.POIFS.FileSystem.ODocumentInputStream.Reset">
  22701. Repositions this stream to the position at the time the mark() method was
  22702. last called on this input stream. If mark() has not been called this
  22703. method repositions the stream to its beginning.
  22704. </member>
  22705. <member name="T:NPOI.POIFS.FileSystem.OfficeXmlFileException">
  22706. <summary>
  22707. This exception is thrown when we try to open a file that's actually
  22708. an Office 2007+ XML file, rather than an OLE2 file (which is what
  22709. POIFS works with)
  22710. </summary>
  22711. </member>
  22712. <member name="T:NPOI.POIFS.FileSystem.Ole10Native">
  22713. Represents an Ole10Native record which is wrapped around certain binary
  22714. files being embedded in OLE2 documents.
  22715. @author Rainer Schwarze
  22716. </member>
  22717. <member name="T:NPOI.POIFS.FileSystem.Ole10Native.EncodingMode">
  22718. the field encoding mode - merely a try-and-error guess ...
  22719. </member>
  22720. <member name="F:NPOI.POIFS.FileSystem.Ole10Native.EncodingMode.parsed">
  22721. the data is stored in parsed format - including label, command, etc.
  22722. </member>
  22723. <member name="F:NPOI.POIFS.FileSystem.Ole10Native.EncodingMode.unparsed">
  22724. the data is stored raw after the length field
  22725. </member>
  22726. <member name="F:NPOI.POIFS.FileSystem.Ole10Native.EncodingMode.compact">
  22727. the data is stored raw after the length field and the flags1 field
  22728. </member>
  22729. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.CreateFromEmbeddedOleObject(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  22730. <summary>
  22731. Creates an instance of this class from an embedded OLE Object. The OLE Object is expected
  22732. to include a stream &quot;{01}Ole10Native&quot; which Contains the actual
  22733. data relevant for this class.
  22734. </summary>
  22735. <param name="poifs">poifs POI Filesystem object</param>
  22736. <returns>Returns an instance of this class</returns>
  22737. </member>
  22738. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.CreateFromEmbeddedOleObject(NPOI.POIFS.FileSystem.DirectoryNode)">
  22739. <summary>
  22740. Creates an instance of this class from an embedded OLE Object. The OLE Object is expected
  22741. to include a stream &quot;{01}Ole10Native&quot; which contains the actual
  22742. data relevant for this class.
  22743. </summary>
  22744. <param name="directory">directory POI Filesystem object</param>
  22745. <returns>Returns an instance of this class</returns>
  22746. </member>
  22747. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.#ctor(System.String,System.String,System.String,System.Byte[])">
  22748. Creates an instance and fills the fields based on ... the fields
  22749. </member>
  22750. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.#ctor(System.Byte[],System.Int32)">
  22751. Creates an instance and Fills the fields based on the data in the given buffer.
  22752. @param data The buffer Containing the Ole10Native record
  22753. @param offset The start offset of the record in the buffer
  22754. @throws Ole10NativeException on invalid or unexcepted data format
  22755. </member>
  22756. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.TotalSize">
  22757. Returns the value of the totalSize field - the total length of the structure
  22758. is totalSize + 4 (value of this field + size of this field).
  22759. @return the totalSize
  22760. </member>
  22761. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.Flags1">
  22762. Returns flags1 - currently unknown - usually 0x0002.
  22763. @return the flags1
  22764. </member>
  22765. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.Label">
  22766. Returns the label field - usually the name of the file (without directory) but
  22767. probably may be any name specified during packaging/embedding the data.
  22768. @return the label
  22769. </member>
  22770. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.FileName">
  22771. Returns the fileName field - usually the name of the file being embedded
  22772. including the full path.
  22773. @return the fileName
  22774. </member>
  22775. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.Flags2">
  22776. Returns flags2 - currently unknown - mostly 0x0000.
  22777. @return the flags2
  22778. </member>
  22779. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.Unknown1">
  22780. Returns unknown1 field - currently unknown.
  22781. @return the unknown1
  22782. </member>
  22783. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.Command">
  22784. Returns the command field - usually the name of the file being embedded
  22785. including the full path, may be a command specified during embedding the file.
  22786. @return the command
  22787. </member>
  22788. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.DataSize">
  22789. Returns the size of the embedded file. If the size is 0 (zero), no data has been
  22790. embedded. To be sure, that no data has been embedded, check whether
  22791. {@link #getDataBuffer()} returns <code>null</code>.
  22792. @return the dataSize
  22793. </member>
  22794. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.DataBuffer">
  22795. Returns the buffer Containing the embedded file's data, or <code>null</code>
  22796. if no data was embedded. Note that an embedding may provide information about
  22797. the data, but the actual data is not included. (So label, filename etc. are
  22798. available, but this method returns <code>null</code>.)
  22799. @return the dataBuffer
  22800. </member>
  22801. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.Flags3">
  22802. Returns the flags3 - currently unknown.
  22803. @return the flags3
  22804. </member>
  22805. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.WriteOut(System.IO.Stream)">
  22806. Have the contents printer out into an OutputStream, used when writing a
  22807. file back out to disk (Normally, atom classes will keep their bytes
  22808. around, but non atom classes will just request the bytes from their
  22809. children, then chuck on their header and return)
  22810. </member>
  22811. <member name="T:NPOI.POIFS.FileSystem.OPOIFSDocument">
  22812. <summary>
  22813. This class manages a document in the POIFS filesystem.
  22814. @author Marc Johnson (mjohnson at apache dot org)
  22815. </summary>
  22816. </member>
  22817. <member name="M:NPOI.POIFS.FileSystem.OPOIFSDocument.#ctor(System.String,System.IO.Stream)">
  22818. <summary>
  22819. Initializes a new instance of the <see cref="T:NPOI.POIFS.FileSystem.OPOIFSDocument"/> class.
  22820. </summary>
  22821. <param name="name">the name of the POIFSDocument</param>
  22822. <param name="stream">the InputStream we read data from</param>
  22823. </member>
  22824. <member name="M:NPOI.POIFS.FileSystem.OPOIFSDocument.#ctor(System.String,NPOI.POIFS.Storage.ListManagedBlock[],System.Int32)">
  22825. <summary>
  22826. Constructor from small blocks
  22827. </summary>
  22828. <param name="name">the name of the POIFSDocument</param>
  22829. <param name="blocks">the small blocks making up the POIFSDocument</param>
  22830. <param name="length">the actual length of the POIFSDocument</param>
  22831. </member>
  22832. <member name="M:NPOI.POIFS.FileSystem.OPOIFSDocument.Read(System.Byte[],System.Int32)">
  22833. <summary>
  22834. read data from the internal stores
  22835. </summary>
  22836. <param name="buffer">the buffer to write to</param>
  22837. <param name="offset">the offset into our storage to read from</param>
  22838. </member>
  22839. <member name="M:NPOI.POIFS.FileSystem.OPOIFSDocument.WriteBlocks(System.IO.Stream)">
  22840. <summary>
  22841. Writes the blocks.
  22842. </summary>
  22843. <param name="stream">The stream.</param>
  22844. </member>
  22845. <member name="P:NPOI.POIFS.FileSystem.OPOIFSDocument.CountBlocks">
  22846. <summary>
  22847. Gets the number of BigBlock's this instance uses
  22848. </summary>
  22849. <value>count of BigBlock instances</value>
  22850. </member>
  22851. <member name="P:NPOI.POIFS.FileSystem.OPOIFSDocument.DocumentProperty">
  22852. <summary>
  22853. Gets the document property.
  22854. </summary>
  22855. <value>The document property.</value>
  22856. </member>
  22857. <member name="P:NPOI.POIFS.FileSystem.OPOIFSDocument.PreferArray">
  22858. <summary>
  22859. Provides a short description of the object to be used when a
  22860. POIFSViewable object has not provided its contents.
  22861. </summary>
  22862. <value><c>true</c> if [prefer array]; otherwise, <c>false</c>.</value>
  22863. </member>
  22864. <member name="P:NPOI.POIFS.FileSystem.OPOIFSDocument.ShortDescription">
  22865. <summary>
  22866. Gets the short description.
  22867. </summary>
  22868. <value>The short description.</value>
  22869. </member>
  22870. <member name="P:NPOI.POIFS.FileSystem.OPOIFSDocument.Size">
  22871. <summary>
  22872. Gets the size.
  22873. </summary>
  22874. <value>The size.</value>
  22875. </member>
  22876. <member name="P:NPOI.POIFS.FileSystem.OPOIFSDocument.SmallBlocks">
  22877. <summary>
  22878. Gets the small blocks.
  22879. </summary>
  22880. <value>The small blocks.</value>
  22881. </member>
  22882. <member name="P:NPOI.POIFS.FileSystem.OPOIFSDocument.StartBlock">
  22883. <summary>
  22884. Sets the start block for this instance
  22885. </summary>
  22886. <value>
  22887. index into the array of BigBlock instances making up the the filesystem
  22888. </value>
  22889. </member>
  22890. <member name="P:NPOI.POIFS.FileSystem.OPOIFSDocument.ViewableArray">
  22891. <summary>
  22892. Get an array of objects, some of which may implement POIFSViewable
  22893. </summary>
  22894. <value>The viewable array.</value>
  22895. </member>
  22896. <member name="P:NPOI.POIFS.FileSystem.OPOIFSDocument.ViewableIterator">
  22897. <summary>
  22898. Give viewers a hint as to whether to call ViewableArray or ViewableIterator
  22899. </summary>
  22900. <value>The viewable iterator.</value>
  22901. </member>
  22902. <member name="T:NPOI.POIFS.FileSystem.OPOIFSFileSystem">
  22903. <summary>
  22904. This is the main class of the POIFS system; it manages the entire
  22905. life cycle of the filesystem.
  22906. @author Marc Johnson (mjohnson at apache dot org)
  22907. </summary>
  22908. </member>
  22909. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.CreateNonClosingInputStream(System.IO.Stream)">
  22910. <summary>
  22911. Convenience method for clients that want to avoid the auto-Close behaviour of the constructor.
  22912. </summary>
  22913. <param name="stream">The stream.</param>
  22914. <example>
  22915. A convenience method (
  22916. CreateNonClosingInputStream()) has been provided for this purpose:
  22917. StreamwrappedStream = OPOIFSFileSystem.CreateNonClosingInputStream(is);
  22918. HSSFWorkbook wb = new HSSFWorkbook(wrappedStream);
  22919. is.reset();
  22920. doSomethingElse(is);
  22921. </example>
  22922. <returns></returns>
  22923. </member>
  22924. <member name="F:NPOI.POIFS.FileSystem.OPOIFSFileSystem.bigBlockSize">
  22925. What big block size the file uses. Most files
  22926. use 512 bytes, but a few use 4096
  22927. </member>
  22928. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.#ctor">
  22929. <summary>
  22930. Initializes a new instance of the <see cref="T:NPOI.POIFS.FileSystem.OPOIFSFileSystem"/> class. intended for writing
  22931. </summary>
  22932. </member>
  22933. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.#ctor(System.IO.Stream)">
  22934. <summary>
  22935. Create a OPOIFSFileSystem from an Stream. Normally the stream is Read until
  22936. EOF. The stream is always Closed. In the unlikely case that the caller has such a stream and
  22937. needs to use it after this constructor completes, a work around is to wrap the
  22938. stream in order to trap the Close() call.
  22939. </summary>
  22940. <param name="stream">the Streamfrom which to Read the data</param>
  22941. </member>
  22942. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.CloseInputStream(System.IO.Stream,System.Boolean)">
  22943. @param stream the stream to be Closed
  22944. @param success <c>false</c> if an exception is currently being thrown in the calling method
  22945. </member>
  22946. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.HasPOIFSHeader(NPOI.Util.InputStream)">
  22947. <summary>
  22948. Checks that the supplied Stream(which MUST
  22949. support mark and reset, or be a PushbackInputStream)
  22950. has a POIFS (OLE2) header at the start of it.
  22951. If your Streamdoes not support mark / reset,
  22952. then wrap it in a PushBackInputStream, then be
  22953. sure to always use that, and not the original!
  22954. </summary>
  22955. <param name="inp">An Streamwhich supports either mark/reset, or is a PushbackStream</param>
  22956. <returns>
  22957. <c>true</c> if [has POIFS header] [the specified inp]; otherwise, <c>false</c>.
  22958. </returns>
  22959. </member>
  22960. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.HasPOIFSHeader(System.Byte[])">
  22961. Checks if the supplied first 8 bytes of a stream / file
  22962. has a POIFS (OLE2) header.
  22963. </member>
  22964. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.CreateDocument(System.IO.Stream,System.String)">
  22965. <summary>
  22966. Create a new document to be Added to the root directory
  22967. </summary>
  22968. <param name="stream"> the Streamfrom which the document's data will be obtained</param>
  22969. <param name="name">the name of the new POIFSDocument</param>
  22970. <returns>the new DocumentEntry</returns>
  22971. </member>
  22972. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.CreateDocument(System.String,System.Int32,NPOI.POIFS.EventFileSystem.POIFSWriterListener)">
  22973. <summary>
  22974. Create a new DocumentEntry in the root entry; the data will be
  22975. provided later
  22976. </summary>
  22977. <param name="name">the name of the new DocumentEntry</param>
  22978. <param name="size">the size of the new DocumentEntry</param>
  22979. <param name="writer">the Writer of the new DocumentEntry</param>
  22980. <returns>the new DocumentEntry</returns>
  22981. </member>
  22982. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.CreateDirectory(System.String)">
  22983. <summary>
  22984. Create a new DirectoryEntry in the root directory
  22985. </summary>
  22986. <param name="name">the name of the new DirectoryEntry</param>
  22987. <returns>the new DirectoryEntry</returns>
  22988. </member>
  22989. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.CreateDocumentInputStream(System.String)">
  22990. open a document in the root entry's list of entries
  22991. @param documentName the name of the document to be opened
  22992. @return a newly opened DocumentInputStream
  22993. @exception IOException if the document does not exist or the
  22994. name is that of a DirectoryEntry
  22995. </member>
  22996. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.WriteFileSystem(System.IO.Stream)">
  22997. <summary>
  22998. Writes the file system.
  22999. </summary>
  23000. <param name="stream">the OutputStream to which the filesystem will be
  23001. written</param>
  23002. </member>
  23003. <member name="P:NPOI.POIFS.FileSystem.OPOIFSFileSystem.Root">
  23004. <summary>
  23005. Get the root entry
  23006. </summary>
  23007. <value>The root.</value>
  23008. </member>
  23009. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.AddDocument(NPOI.POIFS.FileSystem.OPOIFSDocument)">
  23010. <summary>
  23011. Add a new POIFSDocument
  23012. </summary>
  23013. <param name="document">the POIFSDocument being Added</param>
  23014. </member>
  23015. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.AddDirectory(NPOI.POIFS.Properties.DirectoryProperty)">
  23016. <summary>
  23017. Add a new DirectoryProperty
  23018. </summary>
  23019. <param name="directory">The directory.</param>
  23020. </member>
  23021. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.Remove(NPOI.POIFS.FileSystem.EntryNode)">
  23022. <summary>
  23023. Removes the specified entry.
  23024. </summary>
  23025. <param name="entry">The entry.</param>
  23026. </member>
  23027. <member name="P:NPOI.POIFS.FileSystem.OPOIFSFileSystem.ViewableArray">
  23028. <summary>
  23029. Get an array of objects, some of which may implement
  23030. POIFSViewable
  23031. </summary>
  23032. <value>an array of Object; may not be null, but may be empty</value>
  23033. </member>
  23034. <member name="P:NPOI.POIFS.FileSystem.OPOIFSFileSystem.ViewableIterator">
  23035. <summary>
  23036. Get an Iterator of objects, some of which may implement
  23037. POIFSViewable
  23038. </summary>
  23039. <value>an Iterator; may not be null, but may have an empty
  23040. back end store</value>
  23041. </member>
  23042. <member name="P:NPOI.POIFS.FileSystem.OPOIFSFileSystem.PreferArray">
  23043. <summary>
  23044. Give viewers a hint as to whether to call GetViewableArray or
  23045. GetViewableIterator
  23046. </summary>
  23047. <value><c>true</c> if a viewer should call GetViewableArray, <c>false</c> if
  23048. a viewer should call GetViewableIterator </value>
  23049. </member>
  23050. <member name="P:NPOI.POIFS.FileSystem.OPOIFSFileSystem.ShortDescription">
  23051. <summary>
  23052. Provides a short description of the object, to be used when a
  23053. POIFSViewable object has not provided its contents.
  23054. </summary>
  23055. <value>The short description.</value>
  23056. </member>
  23057. <member name="P:NPOI.POIFS.FileSystem.OPOIFSFileSystem.BigBlockSize">
  23058. <summary>
  23059. Gets The Big Block size, normally 512 bytes, sometimes 4096 bytes
  23060. </summary>
  23061. <value>The size of the big block.</value>
  23062. </member>
  23063. <member name="T:NPOI.POIFS.FileSystem.POIFSDocumentPath">
  23064. <summary>
  23065. Class POIFSDocumentPath
  23066. @author Marc Johnson (mjohnson at apache dot org)
  23067. </summary>
  23068. </member>
  23069. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.#ctor">
  23070. <summary>
  23071. simple constructor for the path of a document that is in the
  23072. root of the POIFSFileSystem. The constructor that takes an
  23073. array of Strings can also be used to create such a
  23074. POIFSDocumentPath by passing it a null or empty String array
  23075. </summary>
  23076. </member>
  23077. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.#ctor(System.String[])">
  23078. <summary>
  23079. constructor for the path of a document that is not in the root
  23080. of the POIFSFileSystem
  23081. </summary>
  23082. <param name="components">the Strings making up the path to a document.
  23083. The Strings must be ordered as they appear in
  23084. the directory hierarchy of the the document
  23085. -- the first string must be the name of a
  23086. directory in the root of the POIFSFileSystem,
  23087. and every Nth (for N &gt; 1) string thereafter
  23088. must be the name of a directory in the
  23089. directory identified by the (N-1)th string.
  23090. If the components parameter is null or has
  23091. zero length, the POIFSDocumentPath is
  23092. appropriate for a document that is in the
  23093. root of a POIFSFileSystem</param>
  23094. </member>
  23095. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.#ctor(NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String[])">
  23096. <summary>
  23097. constructor that adds additional subdirectories to an existing
  23098. path
  23099. </summary>
  23100. <param name="path">the existing path</param>
  23101. <param name="components">the additional subdirectory names to be added</param>
  23102. </member>
  23103. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.Equals(System.Object)">
  23104. <summary>
  23105. equality. Two POIFSDocumentPath instances are equal if they
  23106. have the same number of component Strings, and if each
  23107. component String is equal to its coresponding component String
  23108. </summary>
  23109. <param name="o">the object we're checking equality for</param>
  23110. <returns>true if the object is equal to this object</returns>
  23111. </member>
  23112. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.GetComponent(System.Int32)">
  23113. <summary>
  23114. get the specified component
  23115. </summary>
  23116. <param name="n">which component (0 ... length() - 1)</param>
  23117. <returns>the nth component;</returns>
  23118. </member>
  23119. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.GetHashCode">
  23120. <summary>
  23121. Serves as a hash function for a particular type.
  23122. </summary>
  23123. <returns>
  23124. A hash code for the current <see cref="T:System.Object"/>.
  23125. </returns>
  23126. </member>
  23127. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.ToString">
  23128. <summary>
  23129. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  23130. </summary>
  23131. <returns>
  23132. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  23133. </returns>
  23134. </member>
  23135. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentPath.Length">
  23136. <summary>
  23137. Gets the length.
  23138. </summary>
  23139. <value>the number of components</value>
  23140. </member>
  23141. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentPath.Parent">
  23142. <summary>
  23143. Returns the path's parent or <c>null</c> if this path
  23144. is the root path.
  23145. </summary>
  23146. <value>path of parent, or null if this path is the root path</value>
  23147. </member>
  23148. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentPath.Name">
  23149. <p>Returns the last name in the document path's name sequence.
  23150. If the document path's name sequence is empty, then the empty string is returned.</p>
  23151. @since 2016-04-09
  23152. @return The last name in the document path's name sequence, or empty string if this is the root path
  23153. </member>
  23154. <member name="T:NPOI.POIFS.FileSystem.POIFSFileSystem">
  23155. <summary>
  23156. This is the main class of the POIFS system; it manages the entire
  23157. life cycle of the filesystem.
  23158. @author Marc Johnson (mjohnson at apache dot org)
  23159. </summary>
  23160. </member>
  23161. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.CreateNonClosingInputStream(System.IO.Stream)">
  23162. <summary>
  23163. Convenience method for clients that want to avoid the auto-Close behaviour of the constructor.
  23164. </summary>
  23165. <param name="stream">The stream.</param>
  23166. <example>
  23167. A convenience method (
  23168. CreateNonClosingInputStream()) has been provided for this purpose:
  23169. StreamwrappedStream = POIFSFileSystem.CreateNonClosingInputStream(is);
  23170. HSSFWorkbook wb = new HSSFWorkbook(wrappedStream);
  23171. is.reset();
  23172. doSomethingElse(is);
  23173. </example>
  23174. <returns></returns>
  23175. </member>
  23176. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.#ctor">
  23177. <summary>
  23178. Initializes a new instance of the <see cref="T:NPOI.POIFS.FileSystem.POIFSFileSystem"/> class. intended for writing
  23179. </summary>
  23180. </member>
  23181. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.#ctor(System.IO.Stream)">
  23182. <summary>
  23183. Create a POIFSFileSystem from an Stream. Normally the stream is Read until
  23184. EOF. The stream is always Closed. In the unlikely case that the caller has such a stream and
  23185. needs to use it after this constructor completes, a work around is to wrap the
  23186. stream in order to trap the Close() call.
  23187. </summary>
  23188. <param name="stream">the Streamfrom which to Read the data</param>
  23189. </member>
  23190. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.#ctor(System.IO.FileInfo,System.Boolean)">
  23191. <p>Creates a POIFSFileSystem from a <tt>File</tt>. This uses less memory than
  23192. creating from an <tt>InputStream</tt>.</p>
  23193. <p>Note that with this constructor, you will need to call {@link #close()}
  23194. when you're done to have the underlying file closed, as the file is
  23195. kept open during normal operation to read the data out.</p>
  23196. @param readOnly whether the POIFileSystem will only be used in read-only mode
  23197. @param file the File from which to read the data
  23198. @exception IOException on errors reading, or on invalid data
  23199. </member>
  23200. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.#ctor(System.IO.FileInfo)">
  23201. <p>Creates a POIFSFileSystem from a <tt>File</tt>. This uses less memory than
  23202. creating from an <tt>InputStream</tt>. The File will be opened read-only</p>
  23203. <p>Note that with this constructor, you will need to call {@link #close()}
  23204. when you're done to have the underlying file closed, as the file is
  23205. kept open during normal operation to read the data out.</p>
  23206. @param file the File from which to read the data
  23207. @exception IOException on errors reading, or on invalid data
  23208. </member>
  23209. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.HasPOIFSHeader(System.IO.Stream)">
  23210. <summary>
  23211. Checks that the supplied Stream(which MUST
  23212. support mark and reset, or be a PushbackInputStream)
  23213. has a POIFS (OLE2) header at the start of it.
  23214. If your Streamdoes not support mark / reset,
  23215. then wrap it in a PushBackInputStream, then be
  23216. sure to always use that, and not the original!
  23217. </summary>
  23218. <param name="inp">An Streamwhich supports either mark/reset, or is a PushbackStream</param>
  23219. <returns>
  23220. <c>true</c> if [has POIFS header] [the specified inp]; otherwise, <c>false</c>.
  23221. </returns>
  23222. </member>
  23223. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.HasPOIFSHeader(System.Byte[])">
  23224. Checks if the supplied first 8 bytes of a stream / file
  23225. has a POIFS (OLE2) header.
  23226. </member>
  23227. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.Create(System.IO.FileInfo)">
  23228. Creates a new {@link POIFSFileSystem} in a new {@link File}.
  23229. Use {@link #POIFSFileSystem(File)} to open an existing File,
  23230. this should only be used to create a new empty filesystem.
  23231. @param file The file to create and open
  23232. @return The created and opened {@link POIFSFileSystem}
  23233. </member>
  23234. <member name="T:NPOI.POIFS.NIO.ByteArrayBackedDataSource">
  23235. <summary>
  23236. A POIFS <see cref="T:NPOI.POIFS.NIO.DataSource"/> backed by a byte array.
  23237. </summary>
  23238. </member>
  23239. <member name="T:NPOI.POIFS.NIO.DataSource">
  23240. <summary>
  23241. Common definition of how we read and write bytes
  23242. </summary>
  23243. </member>
  23244. <member name="M:NPOI.POIFS.NIO.DataSource.Close">
  23245. <summary>
  23246. Close the underlying stream
  23247. </summary>
  23248. </member>
  23249. <member name="M:NPOI.POIFS.NIO.DataSource.CopyTo(System.IO.Stream)">
  23250. <summary>
  23251. Copies the contents to the specified Stream
  23252. </summary>
  23253. <param name="stream"></param>
  23254. </member>
  23255. <member name="T:NPOI.POIFS.NIO.FileBackedDataSource">
  23256. <summary>
  23257. A POIFS DataSource backed by a File
  23258. TODO - Return the ByteBuffers in such a way that in RW mode,
  23259. changes to the buffer end up on the disk (will fix the HPSF TestWrite
  23260. currently failing unit test when done)
  23261. </summary>
  23262. </member>
  23263. <member name="M:NPOI.POIFS.NIO.FileBackedDataSource.Read(System.Int32,System.Int64)">
  23264. <summary>
  23265. Reads a sequence of bytes from this FileStream starting at the given file position.
  23266. </summary>
  23267. <param name="length"></param>
  23268. <param name="position">The file position at which the transfer is to begin;</param>
  23269. <returns></returns>
  23270. </member>
  23271. <member name="M:NPOI.POIFS.NIO.FileBackedDataSource.Write(NPOI.Util.ByteBuffer,System.Int64)">
  23272. <summary>
  23273. Writes a sequence of bytes to this FileStream from the given Stream,
  23274. starting at the given file position.
  23275. </summary>
  23276. <param name="src">The Stream from which bytes are to be transferred</param>
  23277. <param name="position">The file position at which the transfer is to begin;
  23278. must be non-negative</param>
  23279. </member>
  23280. <member name="T:NPOI.POIFS.Properties.Child">
  23281. <summary>
  23282. This interface defines methods for finding and setting sibling
  23283. Property instances
  23284. @author Marc Johnson (mjohnson at apache dot org)
  23285. </summary>
  23286. </member>
  23287. <member name="P:NPOI.POIFS.Properties.Child.PreviousChild">
  23288. <summary>
  23289. Gets or sets the previous child.
  23290. </summary>
  23291. <value>The previous child.</value>
  23292. </member>
  23293. <member name="P:NPOI.POIFS.Properties.Child.NextChild">
  23294. <summary>
  23295. Gets or sets the next child.
  23296. </summary>
  23297. <value>The next child.</value>
  23298. </member>
  23299. <member name="T:NPOI.POIFS.Properties.DirectoryProperty">
  23300. <summary>
  23301. Trivial extension of Property for POIFSDocuments
  23302. @author Marc Johnson (mjohnson at apache dot org)
  23303. </summary>
  23304. </member>
  23305. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.#ctor(System.String)">
  23306. <summary>
  23307. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.DirectoryProperty"/> class.
  23308. </summary>
  23309. <param name="name">the name of the directory</param>
  23310. </member>
  23311. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.#ctor(System.Int32,System.Byte[],System.Int32)">
  23312. <summary>
  23313. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.DirectoryProperty"/> class.
  23314. </summary>
  23315. <param name="index">index number</param>
  23316. <param name="array">byte data</param>
  23317. <param name="offset">offset into byte data</param>
  23318. </member>
  23319. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.ChangeName(NPOI.POIFS.Properties.Property,System.String)">
  23320. <summary>
  23321. Change a Property's name
  23322. </summary>
  23323. <param name="property">the Property whose name Is being Changed.</param>
  23324. <param name="newName">the new name for the Property</param>
  23325. <returns>true if the name Change could be made, else false</returns>
  23326. </member>
  23327. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.DeleteChild(NPOI.POIFS.Properties.Property)">
  23328. <summary>
  23329. Delete a Property
  23330. </summary>
  23331. <param name="property">the Property being Deleted</param>
  23332. <returns>true if the Property could be Deleted, else false</returns>
  23333. </member>
  23334. <member name="T:NPOI.POIFS.Properties.DirectoryProperty.PropertyComparator">
  23335. <summary>
  23336. Directory Property Comparer
  23337. </summary>
  23338. </member>
  23339. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.PropertyComparator.Equals(System.Object)">
  23340. <summary>
  23341. Object equality, implemented as object identity
  23342. </summary>
  23343. <param name="o">Object we're being Compared to</param>
  23344. <returns>true if identical, else false</returns>
  23345. </member>
  23346. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.PropertyComparator.Compare(NPOI.POIFS.Properties.Property,NPOI.POIFS.Properties.Property)">
  23347. <summary>
  23348. Compare method. Assumes both parameters are non-null
  23349. instances of Property. One property is less than another if
  23350. its name is shorter than the other property's name. If the
  23351. names are the same length, the property whose name comes
  23352. before the other property's name, alphabetically, is less
  23353. than the other property.
  23354. </summary>
  23355. <param name="o1">first object to compare, better be a Property</param>
  23356. <param name="o2">second object to compare, better be a Property</param>
  23357. <returns>negative value if o1 smaller than o2,
  23358. zero if o1 equals o2,
  23359. positive value if o1 bigger than o2.</returns>
  23360. </member>
  23361. <member name="P:NPOI.POIFS.Properties.DirectoryProperty.IsDirectory">
  23362. <summary>
  23363. Gets a value indicating whether this instance is directory.
  23364. </summary>
  23365. <value>
  23366. <c>true</c> if a directory type Property; otherwise, <c>false</c>.
  23367. </value>
  23368. </member>
  23369. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.PreWrite">
  23370. <summary>
  23371. Perform whatever activities need to be performed prior to
  23372. writing
  23373. </summary>
  23374. </member>
  23375. <member name="P:NPOI.POIFS.Properties.DirectoryProperty.Children">
  23376. <summary>
  23377. Get an iterator over the children of this Parent; all elements
  23378. are instances of Property.
  23379. </summary>
  23380. <value>Iterator of children; may refer to an empty collection</value>
  23381. </member>
  23382. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.AddChild(NPOI.POIFS.Properties.Property)">
  23383. <summary>
  23384. Add a new child to the collection of children
  23385. </summary>
  23386. <param name="property">the new child to be added; must not be null</param>
  23387. </member>
  23388. <member name="T:NPOI.POIFS.Properties.DocumentProperty">
  23389. <summary>
  23390. Trivial extension of Property for POIFSDocuments
  23391. @author Marc Johnson (mjohnson at apache dot org)
  23392. </summary>
  23393. </member>
  23394. <member name="M:NPOI.POIFS.Properties.DocumentProperty.#ctor(System.String,System.Int32)">
  23395. <summary>
  23396. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.DocumentProperty"/> class.
  23397. </summary>
  23398. <param name="name">POIFSDocument name</param>
  23399. <param name="size">POIFSDocument size</param>
  23400. </member>
  23401. <member name="M:NPOI.POIFS.Properties.DocumentProperty.#ctor(System.Int32,System.Byte[],System.Int32)">
  23402. <summary>
  23403. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.DocumentProperty"/> class.
  23404. </summary>
  23405. <param name="index">index number</param>
  23406. <param name="array">byte data</param>
  23407. <param name="offset">offset into byte data</param>
  23408. </member>
  23409. <member name="P:NPOI.POIFS.Properties.DocumentProperty.Document">
  23410. <summary>
  23411. Gets or sets the document.
  23412. </summary>
  23413. <value>the associated POIFSDocument</value>
  23414. </member>
  23415. <member name="P:NPOI.POIFS.Properties.DocumentProperty.IsDirectory">
  23416. <summary>
  23417. Determines whether this instance is directory.
  23418. </summary>
  23419. <returns>
  23420. <c>true</c> if this instance is directory; otherwise, <c>false</c>.
  23421. </returns>
  23422. </member>
  23423. <member name="M:NPOI.POIFS.Properties.DocumentProperty.PreWrite">
  23424. <summary>
  23425. Perform whatever activities need to be performed prior to
  23426. writing
  23427. </summary>
  23428. </member>
  23429. <member name="M:NPOI.POIFS.Properties.DocumentProperty.UpdateSize(System.Int32)">
  23430. Update the size of the property's data
  23431. </member>
  23432. <member name="M:NPOI.POIFS.Properties.NPropertyTable.PreWrite">
  23433. Prepare to be written
  23434. </member>
  23435. <member name="T:NPOI.POIFS.Properties.Parent">
  23436. <summary>
  23437. Behavior for parent (directory) properties
  23438. @author Marc Johnson27591@hotmail.com
  23439. </summary>
  23440. </member>
  23441. <member name="P:NPOI.POIFS.Properties.Parent.Children">
  23442. <summary>
  23443. Get an iterator over the children of this Parent
  23444. all elements are instances of Property.
  23445. </summary>
  23446. <returns></returns>
  23447. </member>
  23448. <member name="M:NPOI.POIFS.Properties.Parent.AddChild(NPOI.POIFS.Properties.Property)">
  23449. <summary>
  23450. Add a new child to the collection of children
  23451. </summary>
  23452. <param name="property">the new child to be added; must not be null</param>
  23453. </member>
  23454. <member name="P:NPOI.POIFS.Properties.Parent.PreviousChild">
  23455. <summary>
  23456. Sets the previous child.
  23457. </summary>
  23458. </member>
  23459. <member name="P:NPOI.POIFS.Properties.Parent.NextChild">
  23460. <summary>
  23461. Sets the next child.
  23462. </summary>
  23463. </member>
  23464. <member name="T:NPOI.POIFS.Properties.Property">
  23465. <summary>
  23466. This abstract base class is the ancestor of all classes
  23467. implementing POIFS Property behavior.
  23468. @author Marc Johnson (mjohnson at apache dot org)
  23469. </summary>
  23470. </member>
  23471. <member name="M:NPOI.POIFS.Properties.Property.#ctor">
  23472. <summary>
  23473. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.Property"/> class.
  23474. </summary>
  23475. </member>
  23476. <member name="M:NPOI.POIFS.Properties.Property.#ctor(System.Int32,System.Byte[],System.Int32)">
  23477. <summary>
  23478. Constructor from byte data
  23479. </summary>
  23480. <param name="index">index number</param>
  23481. <param name="array">byte data</param>
  23482. <param name="offset">offset into byte data</param>
  23483. </member>
  23484. <member name="M:NPOI.POIFS.Properties.Property.WriteData(System.IO.Stream)">
  23485. <summary>
  23486. Write the raw data to an OutputStream.
  23487. </summary>
  23488. <param name="stream">the OutputStream to which the data Should be
  23489. written.</param>
  23490. </member>
  23491. <member name="P:NPOI.POIFS.Properties.Property.StartBlock">
  23492. <summary>
  23493. Gets or sets the start block for the document referred to by this
  23494. Property.
  23495. </summary>
  23496. <value>the start block index</value>
  23497. </member>
  23498. <member name="P:NPOI.POIFS.Properties.Property.ShouldUseSmallBlocks">
  23499. <summary>
  23500. Based on the currently defined size, Should this property use
  23501. small blocks?
  23502. </summary>
  23503. <returns>true if the size Is less than _big_block_minimum_bytes</returns>
  23504. </member>
  23505. <member name="M:NPOI.POIFS.Properties.Property.IsSmall(System.Int32)">
  23506. <summary>
  23507. does the length indicate a small document?
  23508. </summary>
  23509. <param name="length">length in bytes</param>
  23510. <returns>
  23511. <c>true</c> if the length Is less than
  23512. _big_block_minimum_bytes; otherwise, <c>false</c>.
  23513. </returns>
  23514. </member>
  23515. <member name="P:NPOI.POIFS.Properties.Property.Name">
  23516. <summary>
  23517. Gets or sets the name of this property
  23518. </summary>
  23519. <value>property name</value>
  23520. </member>
  23521. <member name="P:NPOI.POIFS.Properties.Property.IsDirectory">
  23522. <summary>
  23523. Gets a value indicating whether this instance is directory.
  23524. </summary>
  23525. <value>
  23526. <c>true</c> if a directory type Property; otherwise, <c>false</c>.
  23527. </value>
  23528. </member>
  23529. <member name="P:NPOI.POIFS.Properties.Property.StorageClsid">
  23530. <summary>
  23531. Gets or sets the storage class ID for this property stream. ThIs Is the Class ID
  23532. of the COM object which can read and write this property stream </summary>
  23533. <value>Storage Class ID</value>
  23534. </member>
  23535. <member name="P:NPOI.POIFS.Properties.Property.PropertyType">
  23536. <summary>
  23537. Set the property type. Makes no attempt to validate the value.
  23538. </summary>
  23539. <value>the property type (root, file, directory)</value>
  23540. </member>
  23541. <member name="P:NPOI.POIFS.Properties.Property.NodeColor">
  23542. <summary>
  23543. Sets the color of the node.
  23544. </summary>
  23545. <value>the node color (red or black)</value>
  23546. </member>
  23547. <member name="P:NPOI.POIFS.Properties.Property.ChildProperty">
  23548. <summary>
  23549. Sets the child property.
  23550. </summary>
  23551. <value>the child property's index in the Property Table</value>
  23552. </member>
  23553. <member name="P:NPOI.POIFS.Properties.Property.ChildIndex">
  23554. <summary>
  23555. Get the child property (its index in the Property Table)
  23556. </summary>
  23557. <value>The index of the child.</value>
  23558. </member>
  23559. <member name="P:NPOI.POIFS.Properties.Property.Size">
  23560. <summary>
  23561. Gets or sets the size of the document associated with this Property
  23562. </summary>
  23563. <value>the size of the document, in bytes</value>
  23564. </member>
  23565. <member name="P:NPOI.POIFS.Properties.Property.Index">
  23566. <summary>
  23567. Gets or sets the index.
  23568. </summary>
  23569. <value>The index.</value>
  23570. Get the index for this Property
  23571. @return the index of this Property within its Property Table
  23572. </member>
  23573. <member name="M:NPOI.POIFS.Properties.Property.PreWrite">
  23574. <summary>
  23575. Perform whatever activities need to be performed prior to
  23576. writing
  23577. </summary>
  23578. </member>
  23579. <member name="P:NPOI.POIFS.Properties.Property.NextChildIndex">
  23580. <summary>
  23581. Gets the index of the next child.
  23582. </summary>
  23583. <value>The index of the next child.</value>
  23584. </member>
  23585. <member name="P:NPOI.POIFS.Properties.Property.PreviousChildIndex">
  23586. <summary>
  23587. Gets the index of the previous child.
  23588. </summary>
  23589. <value>The index of the previous child.</value>
  23590. </member>
  23591. <member name="M:NPOI.POIFS.Properties.Property.IsValidIndex(System.Int32)">
  23592. <summary>
  23593. Determines whether the specified index Is valid
  23594. </summary>
  23595. <param name="index">value to be checked</param>
  23596. <returns>
  23597. <c>true</c> if the index Is valid; otherwise, <c>false</c>.
  23598. </returns>
  23599. </member>
  23600. <member name="P:NPOI.POIFS.Properties.Property.PreviousChild">
  23601. <summary>
  23602. Gets or sets the previous child.
  23603. </summary>
  23604. <value>the new 'previous' child; may be null, which has
  23605. the effect of saying there Is no 'previous' child</value>
  23606. </member>
  23607. <member name="P:NPOI.POIFS.Properties.Property.NextChild">
  23608. <summary>
  23609. Gets or sets the next Child
  23610. </summary>
  23611. <value> the new 'next' child; may be null, which has the
  23612. effect of saying there Is no 'next' child</value>
  23613. </member>
  23614. <member name="P:NPOI.POIFS.Properties.Property.ViewableArray">
  23615. <summary>
  23616. Get an array of objects, some of which may implement
  23617. POIFSViewable
  23618. </summary>
  23619. <value>an array of Object; may not be null, but may be empty</value>
  23620. </member>
  23621. <member name="P:NPOI.POIFS.Properties.Property.ViewableIterator">
  23622. <summary>
  23623. Get an Iterator of objects, some of which may implement POIFSViewable
  23624. </summary>
  23625. <value> may not be null, but may have an empty
  23626. back end store</value>
  23627. </member>
  23628. <member name="P:NPOI.POIFS.Properties.Property.PreferArray">
  23629. <summary>
  23630. Give viewers a hint as to whether to call GetViewableArray or
  23631. GetViewableIterator
  23632. </summary>
  23633. <value><c>true</c> if a viewer Should call GetViewableArray; otherwise, <c>false</c>
  23634. if a viewer Should call GetViewableIterator
  23635. </value>
  23636. </member>
  23637. <member name="P:NPOI.POIFS.Properties.Property.ShortDescription">
  23638. <summary>
  23639. Provides a short description of the object, to be used when a
  23640. POIFSViewable object has not provided its contents.
  23641. </summary>
  23642. <value>The short description.</value>
  23643. </member>
  23644. <member name="T:NPOI.POIFS.Properties.PropertyConstants">
  23645. <summary>
  23646. Constants used by Properties namespace
  23647. </summary>
  23648. </member>
  23649. <member name="M:NPOI.POIFS.Properties.PropertyFactory.ConvertToProperties(NPOI.POIFS.Storage.ListManagedBlock[])">
  23650. <summary>
  23651. Convert raw data blocks to an array of Property's
  23652. </summary>
  23653. <param name="blocks">The blocks to be converted</param>
  23654. <returns>the converted List of Property objects. May contain
  23655. nulls, but will not be null</returns>
  23656. </member>
  23657. <member name="M:NPOI.POIFS.Properties.PropertyTable.#ctor(NPOI.POIFS.Storage.HeaderBlock)">
  23658. Default constructor
  23659. </member>
  23660. <member name="M:NPOI.POIFS.Properties.PropertyTable.#ctor(NPOI.POIFS.Storage.HeaderBlock,NPOI.POIFS.Storage.RawDataBlockList)">
  23661. reading constructor (used when we've read in a file and we want
  23662. to extract the property table from it). Populates the
  23663. properties thoroughly
  23664. @param startBlock the first block of the property table
  23665. @param blockList the list of blocks
  23666. @exception IOException if anything goes wrong (which should be
  23667. a result of the input being NFG)
  23668. </member>
  23669. <member name="M:NPOI.POIFS.Properties.PropertyTable.PreWrite">
  23670. Prepare to be written Leon
  23671. </member>
  23672. <member name="P:NPOI.POIFS.Properties.PropertyTable.CountBlocks">
  23673. Return the number of BigBlock's this instance uses
  23674. @return count of BigBlock instances
  23675. </member>
  23676. <member name="M:NPOI.POIFS.Properties.PropertyTable.WriteBlocks(System.IO.Stream)">
  23677. Write the storage to an Stream
  23678. @param stream the Stream to which the stored data should
  23679. be written
  23680. @exception IOException on problems writing to the specified
  23681. stream
  23682. </member>
  23683. <member name="M:NPOI.POIFS.Properties.RootProperty.#ctor(System.Int32,System.Byte[],System.Int32)">
  23684. <summary>
  23685. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.RootProperty"/> class.
  23686. </summary>
  23687. <param name="index">index number</param>
  23688. <param name="array">byte data</param>
  23689. <param name="offset">offset into byte data</param>
  23690. </member>
  23691. <member name="P:NPOI.POIFS.Properties.RootProperty.Size">
  23692. <summary>
  23693. Gets or sets the size of the document associated with this Property
  23694. </summary>
  23695. <value>the size of the document, in bytes</value>
  23696. </member>
  23697. <member name="T:NPOI.POIFS.Storage.BATBlock">
  23698. <summary>
  23699. A block of block allocation table entries. BATBlocks are created
  23700. only through a static factory method: createBATBlocks.
  23701. @author Marc Johnson (mjohnson at apache dot org)
  23702. </summary>
  23703. </member>
  23704. <member name="F:NPOI.POIFS.Storage.BATBlock._values">
  23705. For a regular fat block, these are 128 / 1024
  23706. next sector values.
  23707. For a XFat (DIFat) block, these are 127 / 1023
  23708. next sector values, then a chaining value.
  23709. </member>
  23710. <member name="F:NPOI.POIFS.Storage.BATBlock._has_free_sectors">
  23711. Does this BATBlock have any free sectors in it?
  23712. </member>
  23713. <member name="F:NPOI.POIFS.Storage.BATBlock.ourBlockIndex">
  23714. Where in the file are we?
  23715. </member>
  23716. <member name="M:NPOI.POIFS.Storage.BATBlock.#ctor">
  23717. <summary>
  23718. Create a single instance initialized with default values
  23719. </summary>
  23720. </member>
  23721. <member name="M:NPOI.POIFS.Storage.BATBlock.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32[],System.Int32,System.Int32)">
  23722. Create a single instance initialized (perhaps partially) with entries
  23723. @param entries the array of block allocation table entries
  23724. @param start_index the index of the first entry to be written
  23725. to the block
  23726. @param end_index the index, plus one, of the last entry to be
  23727. written to the block (writing is for all index
  23728. k, start_index &lt;= k &lt; end_index)
  23729. </member>
  23730. <member name="M:NPOI.POIFS.Storage.BATBlock.CreateBATBlock(NPOI.POIFS.Common.POIFSBigBlockSize,System.IO.BinaryReader)">
  23731. Create a single BATBlock from the byte buffer, which must hold at least
  23732. one big block of data to be read.
  23733. </member>
  23734. <member name="M:NPOI.POIFS.Storage.BATBlock.CreateEmptyBATBlock(NPOI.POIFS.Common.POIFSBigBlockSize,System.Boolean)">
  23735. **
  23736. </member>
  23737. <member name="M:NPOI.POIFS.Storage.BATBlock.CreateBATBlocks(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32[])">
  23738. <summary>
  23739. Create an array of BATBlocks from an array of int block
  23740. allocation table entries
  23741. </summary>
  23742. <param name="bigBlockSize">the poifs bigBlockSize</param>
  23743. <param name="entries">the array of int entries</param>
  23744. <returns>the newly created array of BATBlocks</returns>
  23745. </member>
  23746. <member name="M:NPOI.POIFS.Storage.BATBlock.CreateXBATBlocks(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32[],System.Int32)">
  23747. <summary>
  23748. Create an array of XBATBlocks from an array of int block
  23749. allocation table entries
  23750. </summary>
  23751. <param name="bigBlockSize"></param>
  23752. <param name="entries">the array of int entries</param>
  23753. <param name="startBlock">the start block of the array of XBAT blocks</param>
  23754. <returns>the newly created array of BATBlocks</returns>
  23755. </member>
  23756. <member name="M:NPOI.POIFS.Storage.BATBlock.CalculateStorageRequirements(System.Int32)">
  23757. <summary>
  23758. Calculate how many BATBlocks are needed to hold a specified
  23759. number of BAT entries.
  23760. </summary>
  23761. <param name="entryCount">the number of entries</param>
  23762. <returns>the number of BATBlocks needed</returns>
  23763. </member>
  23764. <member name="M:NPOI.POIFS.Storage.BATBlock.CalculateXBATStorageRequirements(System.Int32)">
  23765. <summary>
  23766. Calculate how many XBATBlocks are needed to hold a specified
  23767. number of BAT entries.
  23768. </summary>
  23769. <param name="entryCount">the number of entries</param>
  23770. <returns>the number of XBATBlocks needed</returns>
  23771. </member>
  23772. <member name="M:NPOI.POIFS.Storage.BATBlock.CalculateMaximumSize(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32)">
  23773. Calculates the maximum size of a file which is addressable given the
  23774. number of FAT (BAT) sectors specified. (We don't care if those BAT
  23775. blocks come from the 109 in the header, or from header + XBATS, it
  23776. won't affect the calculation)
  23777. The actual file size will be between [size of fatCount-1 blocks] and
  23778. [size of fatCount blocks].
  23779. For 512 byte block sizes, this means we may over-estimate by up to 65kb.
  23780. For 4096 byte block sizes, this means we may over-estimate by up to 4mb
  23781. </member>
  23782. <member name="P:NPOI.POIFS.Storage.BATBlock.EntriesPerBlock">
  23783. <summary>
  23784. Gets the entries per block.
  23785. </summary>
  23786. <value>The number of entries per block</value>
  23787. </member>
  23788. <member name="P:NPOI.POIFS.Storage.BATBlock.EntriesPerXBATBlock">
  23789. <summary>
  23790. Gets the entries per XBAT block.
  23791. </summary>
  23792. <value>number of entries per XBAT block</value>
  23793. </member>
  23794. <member name="P:NPOI.POIFS.Storage.BATBlock.XBATChainOffset">
  23795. <summary>
  23796. Gets the XBAT chain offset.
  23797. </summary>
  23798. <value>offset of chain index of XBAT block</value>
  23799. </member>
  23800. <member name="P:NPOI.POIFS.Storage.BATBlock.HasFreeSectors">
  23801. Does this BATBlock have any free sectors in it, or
  23802. is it full?
  23803. </member>
  23804. <member name="M:NPOI.POIFS.Storage.BATBlock.GetUsedSectors(System.Boolean)">
  23805. How many sectors in this block are taken?
  23806. Note that calling {@link #hasFreeSectors()} is much quicker
  23807. </member>
  23808. <member name="P:NPOI.POIFS.Storage.BATBlock.OurBlockIndex">
  23809. Retrieve where in the file we live
  23810. </member>
  23811. <member name="M:NPOI.POIFS.Storage.BATBlock.#ctor(System.Int32[],System.Int32,System.Int32)">
  23812. <summary>
  23813. Create a single instance initialized (perhaps partially) with entries
  23814. </summary>
  23815. <param name="entries">the array of block allocation table entries</param>
  23816. <param name="start_index">the index of the first entry to be written
  23817. to the block</param>
  23818. <param name="end_index">the index, plus one, of the last entry to be
  23819. written to the block (writing is for all index
  23820. k, start_index less than k less than end_index)
  23821. </param>
  23822. </member>
  23823. <member name="M:NPOI.POIFS.Storage.BATBlock.WriteData(System.IO.Stream)">
  23824. <summary>
  23825. Write the block's data to an Stream
  23826. </summary>
  23827. <param name="stream">the Stream to which the stored data should
  23828. be written</param>
  23829. </member>
  23830. <member name="T:NPOI.POIFS.Storage.BigBlock">
  23831. <summary>
  23832. Abstract base class of all POIFS block storage classes. All
  23833. extensions of BigBlock should write 512 bytes of data when
  23834. requested to write their data.
  23835. This class has package scope, as there is no reason at this time to
  23836. make the class public.
  23837. @author Marc Johnson (mjohnson at apache dot org)
  23838. </summary>
  23839. </member>
  23840. <member name="M:NPOI.POIFS.Storage.BigBlock.WriteData(System.IO.Stream,System.Byte[])">
  23841. <summary>
  23842. Default implementation of write for extending classes that
  23843. contain their data in a simple array of bytes.
  23844. </summary>
  23845. <param name="stream">the OutputStream to which the data should be written.</param>
  23846. <param name="data">the byte array of to be written.</param>
  23847. </member>
  23848. <member name="M:NPOI.POIFS.Storage.BigBlock.WriteBlocks(System.IO.Stream)">
  23849. <summary>
  23850. Write the block's data to an OutputStream
  23851. </summary>
  23852. <param name="stream">the OutputStream to which the stored data should be written</param>
  23853. </member>
  23854. <member name="M:NPOI.POIFS.Storage.BigBlock.WriteData(System.IO.Stream)">
  23855. <summary>
  23856. Write the storage to an OutputStream
  23857. </summary>
  23858. <param name="stream">the OutputStream to which the stored data should be written </param>
  23859. </member>
  23860. <member name="T:NPOI.POIFS.Storage.BlockAllocationTableReader">
  23861. <summary>
  23862. This class manages and creates the Block Allocation Table, which is
  23863. basically a set of linked lists of block indices.
  23864. Each block of the filesystem has an index. The first block, the
  23865. header, is skipped; the first block after the header is index 0,
  23866. the next is index 1, and so on.
  23867. A block's index is also its index into the Block Allocation
  23868. Table. The entry that it finds in the Block Allocation Table is the
  23869. index of the next block in the linked list of blocks making up a
  23870. file, or it is set to -2: end of list.
  23871. @author Marc Johnson (mjohnson at apache dot org)
  23872. </summary>
  23873. </member>
  23874. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32,System.Int32[],System.Int32,System.Int32,NPOI.POIFS.Storage.BlockList)">
  23875. <summary>
  23876. create a BlockAllocationTableReader for an existing filesystem. Side
  23877. effect: when this method finishes, the BAT blocks will have
  23878. been Removed from the raw block list, and any blocks labeled as
  23879. 'unused' in the block allocation table will also have been
  23880. Removed from the raw block list. </summary>
  23881. <param name="bigBlockSizse">the poifs bigBlockSize</param>
  23882. <param name="block_count">the number of BAT blocks making up the block allocation table</param>
  23883. <param name="block_array">the array of BAT block indices from the
  23884. filesystem's header</param>
  23885. <param name="xbat_count">the number of XBAT blocks</param>
  23886. <param name="xbat_index">the index of the first XBAT block</param>
  23887. <param name="raw_block_list">the list of RawDataBlocks</param>
  23888. </member>
  23889. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Storage.ListManagedBlock[],NPOI.POIFS.Storage.BlockList)">
  23890. <summary>
  23891. create a BlockAllocationTableReader from an array of raw data blocks
  23892. </summary>
  23893. <param name="bigBlockSize"></param>
  23894. <param name="blocks">the raw data</param>
  23895. <param name="raw_block_list">the list holding the managed blocks</param>
  23896. </member>
  23897. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize)">
  23898. <summary>
  23899. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.BlockAllocationTableReader"/> class.
  23900. </summary>
  23901. </member>
  23902. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.FetchBlocks(System.Int32,System.Int32,NPOI.POIFS.Storage.BlockList)">
  23903. <summary>
  23904. walk the entries from a specified point and return the
  23905. associated blocks. The associated blocks are Removed from the block list
  23906. </summary>
  23907. <param name="startBlock">the first block in the chain</param>
  23908. <param name="headerPropertiesStartBlock"></param>
  23909. <param name="blockList">the raw data block list</param>
  23910. <returns>array of ListManagedBlocks, in their correct order</returns>
  23911. </member>
  23912. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.IsUsed(System.Int32)">
  23913. <summary>
  23914. determine whether the block specified by index is used or not
  23915. </summary>
  23916. <param name="index">determine whether the block specified by index is used or not</param>
  23917. <returns>
  23918. <c>true</c> if the specified block is used; otherwise, <c>false</c>.
  23919. </returns>
  23920. </member>
  23921. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.GetNextBlockIndex(System.Int32)">
  23922. <summary>
  23923. return the next block index
  23924. </summary>
  23925. <param name="index">The index of the current block</param>
  23926. <returns>index of the next block (may be
  23927. POIFSConstants.END_OF_CHAIN, indicating end of chain
  23928. (duh))</returns>
  23929. </member>
  23930. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.SetEntries(NPOI.POIFS.Storage.ListManagedBlock[],NPOI.POIFS.Storage.BlockList)">
  23931. <summary>
  23932. Convert an array of blocks into a Set of integer indices
  23933. </summary>
  23934. <param name="blocks">the array of blocks containing the indices</param>
  23935. <param name="raw_blocks">the list of blocks being managed. Unused
  23936. blocks will be eliminated from the list</param>
  23937. </member>
  23938. <member name="T:NPOI.POIFS.Storage.BlockAllocationTableWriter">
  23939. <summary>
  23940. This class manages and creates the Block Allocation Table, which is
  23941. basically a set of linked lists of block indices.
  23942. Each block of the filesystem has an index. The first block, the
  23943. header, is skipped; the first block after the header is index 0,
  23944. the next is index 1, and so on.
  23945. A block's index is also its index into the Block Allocation
  23946. Table. The entry that it finds in the Block Allocation Table is the
  23947. index of the next block in the linked list of blocks making up a
  23948. file, or it is set to -2: end of list.
  23949. *
  23950. @author Marc Johnson (mjohnson at apache dot org)
  23951. </summary>
  23952. </member>
  23953. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableWriter.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize)">
  23954. <summary>
  23955. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.BlockAllocationTableWriter"/> class.
  23956. </summary>
  23957. </member>
  23958. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableWriter.CreateBlocks">
  23959. <summary>
  23960. Create the BATBlocks we need
  23961. </summary>
  23962. <returns>start block index of BAT blocks</returns>
  23963. </member>
  23964. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableWriter.AllocateSpace(System.Int32)">
  23965. <summary>
  23966. Allocate space for a block of indices
  23967. </summary>
  23968. <param name="blockCount">the number of blocks to allocate space for</param>
  23969. <returns>the starting index of the blocks</returns>
  23970. </member>
  23971. <member name="P:NPOI.POIFS.Storage.BlockAllocationTableWriter.StartBlock">
  23972. <summary>
  23973. Sets the start block for this instance
  23974. </summary>
  23975. <value>
  23976. index into the array of BigBlock instances making up the the filesystem
  23977. </value>
  23978. </member>
  23979. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableWriter.SimpleCreateBlocks">
  23980. <summary>
  23981. create the BATBlocks
  23982. </summary>
  23983. </member>
  23984. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableWriter.WriteBlocks(System.IO.Stream)">
  23985. <summary>
  23986. Write the storage to an OutputStream
  23987. </summary>
  23988. <param name="stream">the OutputStream to which the stored data should be written</param>
  23989. </member>
  23990. <member name="P:NPOI.POIFS.Storage.BlockAllocationTableWriter.CountBlocks">
  23991. <summary>
  23992. Gets the number of BigBlock's this instance uses
  23993. </summary>
  23994. <value>count of BigBlock instances</value>
  23995. </member>
  23996. <member name="T:NPOI.POIFS.Storage.BlockList">
  23997. <summary>
  23998. Interface for lists of blocks that are mapped by block allocation
  23999. tables
  24000. @author Marc Johnson (mjohnson at apache dot org)
  24001. </summary>
  24002. </member>
  24003. <member name="M:NPOI.POIFS.Storage.BlockList.Zap(System.Int32)">
  24004. <summary>
  24005. remove the specified block from the list
  24006. </summary>
  24007. <param name="index">the index of the specified block; if the index is
  24008. out of range, that's ok</param>
  24009. </member>
  24010. <member name="M:NPOI.POIFS.Storage.BlockList.Remove(System.Int32)">
  24011. <summary>
  24012. Remove and return the specified block from the list
  24013. </summary>
  24014. <param name="index">the index of the specified block</param>
  24015. <returns>the specified block</returns>
  24016. </member>
  24017. <member name="M:NPOI.POIFS.Storage.BlockList.FetchBlocks(System.Int32,System.Int32)">
  24018. <summary>
  24019. get the blocks making up a particular stream in the list. The
  24020. blocks are removed from the list.
  24021. </summary>
  24022. <param name="startBlock">the index of the first block in the stream</param>
  24023. <param name="headerPropertiesStartBlock"></param>
  24024. <returns>the stream as an array of correctly ordered blocks</returns>
  24025. </member>
  24026. <member name="P:NPOI.POIFS.Storage.BlockList.BAT">
  24027. <summary>
  24028. set the associated BlockAllocationTable
  24029. </summary>
  24030. <value>the associated BlockAllocationTable</value>
  24031. </member>
  24032. <member name="M:NPOI.POIFS.Storage.BlockListImpl.#ctor">
  24033. <summary>
  24034. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.BlockListImpl"/> class.
  24035. </summary>
  24036. </member>
  24037. <member name="M:NPOI.POIFS.Storage.BlockListImpl.SetBlocks(NPOI.POIFS.Storage.ListManagedBlock[])">
  24038. <summary>
  24039. provide blocks to manage
  24040. </summary>
  24041. <param name="blocks">blocks to be managed</param>
  24042. </member>
  24043. <member name="M:NPOI.POIFS.Storage.BlockListImpl.Zap(System.Int32)">
  24044. <summary>
  24045. remove the specified block from the list
  24046. </summary>
  24047. <param name="index">the index of the specified block; if the index is
  24048. out of range, that's ok</param>
  24049. </member>
  24050. <member name="M:NPOI.POIFS.Storage.BlockListImpl.Remove(System.Int32)">
  24051. <summary>
  24052. Remove and return the specified block from the list
  24053. </summary>
  24054. <param name="index">the index of the specified block</param>
  24055. <returns>the specified block</returns>
  24056. </member>
  24057. <member name="M:NPOI.POIFS.Storage.BlockListImpl.FetchBlocks(System.Int32,System.Int32)">
  24058. <summary>
  24059. get the blocks making up a particular stream in the list. The
  24060. blocks are removed from the list.
  24061. </summary>
  24062. <param name="startBlock">the index of the first block in the stream</param>
  24063. <param name="headerPropertiesStartBlock"></param>
  24064. <returns>
  24065. the stream as an array of correctly ordered blocks
  24066. </returns>
  24067. </member>
  24068. <member name="P:NPOI.POIFS.Storage.BlockListImpl.BAT">
  24069. <summary>
  24070. set the associated BlockAllocationTable
  24071. </summary>
  24072. <value>the associated BlockAllocationTable</value>
  24073. </member>
  24074. <member name="T:NPOI.POIFS.Storage.BlockWritable">
  24075. <summary>
  24076. An interface for persisting block storage of POIFS components.
  24077. @author Marc Johnson (mjohnson at apache dot org)
  24078. </summary>
  24079. </member>
  24080. <member name="M:NPOI.POIFS.Storage.BlockWritable.WriteBlocks(System.IO.Stream)">
  24081. <summary>
  24082. Writes the blocks.
  24083. </summary>
  24084. <param name="stream">The stream.</param>
  24085. </member>
  24086. <member name="T:NPOI.POIFS.Storage.DataInputBlock">
  24087. Wraps a <c>byte</c> array and provides simple data input access.
  24088. Internally, this class maintains a buffer read index, so that for the most part, primitive
  24089. data can be read in a data-input-stream-like manner.<p/>
  24090. Note - the calling class should call the {@link #available()} method to detect end-of-buffer
  24091. and Move to the next data block when the current is exhausted.
  24092. For optimisation reasons, no error handling is performed in this class. Thus, mistakes in
  24093. calling code ran may raise ugly exceptions here, like {@link ArrayIndexOutOfBoundsException},
  24094. etc .<p/>
  24095. The multi-byte primitive input methods ({@link #readUshortLE()}, {@link #readIntLE()} and
  24096. {@link #readLongLE()}) have corresponding 'spanning Read' methods which (when required) perform
  24097. a read across the block boundary. These spanning read methods take the previous
  24098. {@link DataInputBlock} as a parameter.
  24099. Reads of larger amounts of data (into <c>byte</c> array buffers) must be managed by the caller
  24100. since these could conceivably involve more than two blocks.
  24101. @author Josh Micich
  24102. </member>
  24103. <member name="F:NPOI.POIFS.Storage.DataInputBlock._buf">
  24104. Possibly any size (usually 512K or 64K). Assumed to be at least 8 bytes for all blocks
  24105. before the end of the stream. The last block in the stream can be any size except zero.
  24106. </member>
  24107. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadUshortLE">
  24108. Reads a <c>short</c> which was encoded in <em>little endian</em> format.
  24109. </member>
  24110. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadUshortLE(NPOI.POIFS.Storage.DataInputBlock)">
  24111. Reads a <c>short</c> which spans the end of <c>prevBlock</c> and the start of this block.
  24112. </member>
  24113. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadIntLE">
  24114. Reads an <c>int</c> which was encoded in <em>little endian</em> format.
  24115. </member>
  24116. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadIntLE(NPOI.POIFS.Storage.DataInputBlock,System.Int32)">
  24117. Reads an <c>int</c> which spans the end of <c>prevBlock</c> and the start of this block.
  24118. </member>
  24119. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadLongLE">
  24120. Reads a <c>long</c> which was encoded in <em>little endian</em> format.
  24121. </member>
  24122. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadLongLE(NPOI.POIFS.Storage.DataInputBlock,System.Int32)">
  24123. Reads a <c>long</c> which spans the end of <c>prevBlock</c> and the start of this block.
  24124. </member>
  24125. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadSpanning(NPOI.POIFS.Storage.DataInputBlock,System.Int32,System.Byte[])">
  24126. Reads a small amount of data from across the boundary between two blocks.
  24127. The {@link #_readIndex} of this (the second) block is updated accordingly.
  24128. Note- this method (and other code) assumes that the second {@link DataInputBlock}
  24129. always is big enough to complete the read without being exhausted.
  24130. </member>
  24131. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadFully(System.Byte[],System.Int32,System.Int32)">
  24132. Reads <c>len</c> bytes from this block into the supplied buffer.
  24133. </member>
  24134. <member name="M:NPOI.POIFS.Storage.DocumentBlock.#ctor(NPOI.POIFS.Storage.RawDataBlock)">
  24135. <summary>
  24136. create a document block from a raw data block
  24137. </summary>
  24138. <param name="block">The block.</param>
  24139. </member>
  24140. <member name="M:NPOI.POIFS.Storage.DocumentBlock.#ctor(System.IO.Stream,NPOI.POIFS.Common.POIFSBigBlockSize)">
  24141. <summary>
  24142. Create a single instance initialized with data.
  24143. </summary>
  24144. <param name="stream">the InputStream delivering the data.</param>
  24145. <param name="bigBlockSize">the poifs bigBlockSize</param>
  24146. </member>
  24147. <member name="P:NPOI.POIFS.Storage.DocumentBlock.Size">
  24148. <summary>
  24149. Get the number of bytes Read for this block.
  24150. </summary>
  24151. <value>bytes Read into the block</value>
  24152. </member>
  24153. <member name="P:NPOI.POIFS.Storage.DocumentBlock.PartiallyRead">
  24154. <summary>
  24155. Was this a partially Read block?
  24156. </summary>
  24157. <value><c>true</c> if the block was only partially filled with data</value>
  24158. </member>
  24159. <member name="P:NPOI.POIFS.Storage.DocumentBlock.FillByte">
  24160. <summary>
  24161. Gets the fill byte used
  24162. </summary>
  24163. <value>The fill byte.</value>
  24164. </member>
  24165. <member name="M:NPOI.POIFS.Storage.DocumentBlock.Convert(NPOI.POIFS.Common.POIFSBigBlockSize,System.Byte[],System.Int32)">
  24166. <summary>
  24167. convert a single long array into an array of DocumentBlock
  24168. instances
  24169. </summary>
  24170. <param name="bigBlockSize">the poifs bigBlockSize</param>
  24171. <param name="array">the byte array to be converted</param>
  24172. <param name="size">the intended size of the array (which may be smaller)</param>
  24173. <returns>an array of DocumentBlock instances, filled from the
  24174. input array</returns>
  24175. </member>
  24176. <member name="M:NPOI.POIFS.Storage.DocumentBlock.Read(NPOI.POIFS.Storage.DocumentBlock[],System.Byte[],System.Int32)">
  24177. <summary>
  24178. Read data from an array of DocumentBlocks
  24179. </summary>
  24180. <param name="blocks">the blocks to Read from</param>
  24181. <param name="buffer">the buffer to Write the data into</param>
  24182. <param name="offset">the offset into the array of blocks to Read from</param>
  24183. </member>
  24184. <member name="M:NPOI.POIFS.Storage.DocumentBlock.WriteData(System.IO.Stream)">
  24185. <summary>
  24186. Write the storage to an OutputStream
  24187. </summary>
  24188. <param name="stream">the OutputStream to which the stored data should
  24189. be written</param>
  24190. </member>
  24191. <member name="T:NPOI.POIFS.Storage.HeaderBlock">
  24192. <summary>
  24193. The block containing the archive header
  24194. @author Marc Johnson (mjohnson at apache dot org)
  24195. </summary>
  24196. </member>
  24197. <member name="F:NPOI.POIFS.Storage.HeaderBlock.bigBlockSize">
  24198. What big block Size the file uses. Most files
  24199. use 512 bytes, but a few use 4096
  24200. </member>
  24201. <member name="F:NPOI.POIFS.Storage.HeaderBlock._sbat_count">
  24202. Number of small block allocation table blocks (int)
  24203. (Number of MiniFAT Sectors in Microsoft parlance)
  24204. </member>
  24205. <member name="M:NPOI.POIFS.Storage.HeaderBlock.#ctor(System.IO.Stream)">
  24206. <summary>
  24207. create a new HeaderBlockReader from an Stream
  24208. </summary>
  24209. <param name="stream">the source Stream</param>
  24210. </member>
  24211. <member name="M:NPOI.POIFS.Storage.HeaderBlock.AlertShortRead(System.Int32,System.Int32)">
  24212. <summary>
  24213. Alerts the short read.
  24214. </summary>
  24215. <param name="read">The read.</param>
  24216. <param name="expectedReadSize">The expected size.</param>
  24217. </member>
  24218. <member name="P:NPOI.POIFS.Storage.HeaderBlock.PropertyStart">
  24219. <summary>
  24220. Get start of Property Table
  24221. </summary>
  24222. <value>the index of the first block of the Property Table</value>
  24223. </member>
  24224. <member name="P:NPOI.POIFS.Storage.HeaderBlock.SBATStart">
  24225. <summary>
  24226. Gets start of small block allocation table
  24227. </summary>
  24228. <value>The SBAT start.</value>
  24229. </member>
  24230. <member name="P:NPOI.POIFS.Storage.HeaderBlock.SBATCount">
  24231. <summary>
  24232. Gets number of BAT blocks
  24233. </summary>
  24234. <value>The BAT count.</value>
  24235. </member>
  24236. <member name="P:NPOI.POIFS.Storage.HeaderBlock.BATArray">
  24237. <summary>
  24238. Gets the BAT array.
  24239. </summary>
  24240. <value>The BAT array.</value>
  24241. </member>
  24242. <member name="P:NPOI.POIFS.Storage.HeaderBlock.XBATCount">
  24243. <summary>
  24244. Gets the XBAT count.
  24245. </summary>
  24246. <value>The XBAT count.</value>
  24247. @return XBAT count
  24248. </member>
  24249. <member name="P:NPOI.POIFS.Storage.HeaderBlock.XBATIndex">
  24250. <summary>
  24251. Gets the index of the XBAT.
  24252. </summary>
  24253. <value>The index of the XBAT.</value>
  24254. </member>
  24255. <member name="P:NPOI.POIFS.Storage.HeaderBlock.BigBlockSize">
  24256. <summary>
  24257. Gets The Big Block Size, normally 512 bytes, sometimes 4096 bytes
  24258. </summary>
  24259. <value>The size of the big block.</value>
  24260. @return
  24261. </member>
  24262. <member name="T:NPOI.POIFS.Storage.HeaderBlockConstants">
  24263. <summary>
  24264. Constants used in reading/writing the Header block
  24265. @author Marc Johnson (mjohnson at apache dot org)
  24266. </summary>
  24267. </member>
  24268. <member name="T:NPOI.POIFS.Storage.HeaderBlockWriter">
  24269. <summary>
  24270. The block containing the archive header
  24271. @author Marc Johnson (mjohnson at apache dot org)
  24272. </summary>
  24273. </member>
  24274. <member name="M:NPOI.POIFS.Storage.HeaderBlockWriter.SetBATBlocks(System.Int32,System.Int32)">
  24275. <summary>
  24276. Set BAT block parameters. Assumes that all BAT blocks are
  24277. contiguous. Will construct XBAT blocks if necessary and return
  24278. the array of newly constructed XBAT blocks.
  24279. </summary>
  24280. <param name="blockCount">count of BAT blocks</param>
  24281. <param name="startBlock">index of first BAT block</param>
  24282. <returns>array of XBAT blocks; may be zero Length, will not be
  24283. null</returns>
  24284. </member>
  24285. <member name="P:NPOI.POIFS.Storage.HeaderBlockWriter.PropertyStart">
  24286. <summary>
  24287. Set start of Property Table
  24288. </summary>
  24289. <value>the index of the first block of the Property
  24290. Table</value>
  24291. </member>
  24292. <member name="P:NPOI.POIFS.Storage.HeaderBlockWriter.SBAStart">
  24293. <summary>
  24294. Set start of small block allocation table
  24295. </summary>
  24296. <value>the index of the first big block of the small
  24297. block allocation table</value>
  24298. </member>
  24299. <member name="P:NPOI.POIFS.Storage.HeaderBlockWriter.SBATBlockCount">
  24300. <summary>
  24301. Set count of SBAT blocks
  24302. </summary>
  24303. <value>the number of SBAT blocks</value>
  24304. </member>
  24305. <member name="M:NPOI.POIFS.Storage.HeaderBlockWriter.CalculateXBATStorageRequirements(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32)">
  24306. <summary>
  24307. For a given number of BAT blocks, calculate how many XBAT
  24308. blocks will be needed
  24309. </summary>
  24310. <param name="bigBlockSize"></param>
  24311. <param name="blockCount">number of BAT blocks</param>
  24312. <returns>number of XBAT blocks needed</returns>
  24313. </member>
  24314. <member name="M:NPOI.POIFS.Storage.HeaderBlockWriter.WriteBlocks(System.IO.Stream)">
  24315. <summary>
  24316. Write the block's data to an Stream
  24317. </summary>
  24318. <param name="stream">the Stream to which the stored data should
  24319. be written
  24320. </param>
  24321. </member>
  24322. <member name="T:NPOI.POIFS.Storage.ListManagedBlock">
  24323. <summary>
  24324. An interface for blocks managed by a list that works with a
  24325. BlockAllocationTable to keep block sequences straight
  24326. @author Marc Johnson (mjohnson at apache dot org
  24327. </summary>
  24328. </member>
  24329. <member name="P:NPOI.POIFS.Storage.ListManagedBlock.Data">
  24330. <summary>
  24331. Get the data from the block
  24332. </summary>
  24333. <value>the block's data as a byte array</value>
  24334. </member>
  24335. <member name="T:NPOI.POIFS.Storage.PropertyBlock">
  24336. <summary>
  24337. A block of Property instances
  24338. @author Marc Johnson (mjohnson at apache dot org)
  24339. </summary>
  24340. </member>
  24341. <member name="M:NPOI.POIFS.Storage.PropertyBlock.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Properties.Property[],System.Int32)">
  24342. <summary>
  24343. Create a single instance initialized with default values
  24344. </summary>
  24345. <param name="bigBlockSize"></param>
  24346. <param name="properties">the properties to be inserted</param>
  24347. <param name="offset">the offset into the properties array</param>
  24348. </member>
  24349. <member name="M:NPOI.POIFS.Storage.PropertyBlock.CreatePropertyBlockArray(NPOI.POIFS.Common.POIFSBigBlockSize,System.Collections.Generic.List{NPOI.POIFS.Properties.Property})">
  24350. <summary>
  24351. Create an array of PropertyBlocks from an array of Property
  24352. instances, creating empty Property instances to make up any
  24353. shortfall
  24354. </summary>
  24355. <param name="bigBlockSize"></param>
  24356. <param name="properties">the Property instances to be converted into PropertyBlocks, in a java List</param>
  24357. <returns>the array of newly created PropertyBlock instances</returns>
  24358. </member>
  24359. <member name="M:NPOI.POIFS.Storage.PropertyBlock.WriteData(System.IO.Stream)">
  24360. <summary>
  24361. Write the block's data to an OutputStream
  24362. </summary>
  24363. <param name="stream">the OutputStream to which the stored data should be written</param>
  24364. </member>
  24365. <member name="T:NPOI.POIFS.Storage.RawDataBlock">
  24366. <summary>
  24367. A big block created from an InputStream, holding the raw data
  24368. @author Marc Johnson (mjohnson at apache dot org
  24369. </summary>
  24370. </member>
  24371. <member name="M:NPOI.POIFS.Storage.RawDataBlock.#ctor(System.IO.Stream)">
  24372. <summary>
  24373. Constructor RawDataBlock
  24374. </summary>
  24375. <param name="stream">the Stream from which the data will be read</param>
  24376. </member>
  24377. <member name="M:NPOI.POIFS.Storage.RawDataBlock.#ctor(System.IO.Stream,System.Int32)">
  24378. <summary>
  24379. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.RawDataBlock"/> class.
  24380. </summary>
  24381. <param name="stream">the Stream from which the data will be read</param>
  24382. <param name="blockSize">the size of the POIFS blocks, normally 512 bytes {@link POIFSConstants#BIG_BLOCK_SIZE}</param>
  24383. </member>
  24384. <member name="P:NPOI.POIFS.Storage.RawDataBlock.EOF">
  24385. <summary>
  24386. When we read the data, did we hit end of file?
  24387. </summary>
  24388. <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
  24389. it's possible to both have data, and also hit EoF...</value>
  24390. </member>
  24391. <member name="P:NPOI.POIFS.Storage.RawDataBlock.HasData">
  24392. <summary>
  24393. Did we actually find any data to read? It's possible,
  24394. in the event of a short last block, to both have hit
  24395. the EoF, but also to have data
  24396. </summary>
  24397. <value><c>true</c> if this instance has data; otherwise, <c>false</c>.</value>
  24398. </member>
  24399. <member name="P:NPOI.POIFS.Storage.RawDataBlock.Data">
  24400. <summary>
  24401. Get the data from the block
  24402. </summary>
  24403. <value>the block's data as a byte array</value>
  24404. </member>
  24405. <member name="T:NPOI.POIFS.Storage.RawDataBlockList">
  24406. <summary>
  24407. A list of RawDataBlocks instances, and methods to manage the list
  24408. @author Marc Johnson (mjohnson at apache dot org
  24409. </summary>
  24410. </member>
  24411. <member name="M:NPOI.POIFS.Storage.RawDataBlockList.#ctor(System.IO.Stream,NPOI.POIFS.Common.POIFSBigBlockSize)">
  24412. <summary>
  24413. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.RawDataBlockList"/> class.
  24414. </summary>
  24415. <param name="stream">the InputStream from which the data will be read</param>
  24416. <param name="bigBlockSize">The big block size, either 512 bytes or 4096 bytes</param>
  24417. </member>
  24418. <member name="T:NPOI.POIFS.Storage.SmallBlockTableReader">
  24419. <summary>
  24420. This class implements reading the small document block list from an
  24421. existing file
  24422. @author Marc Johnson (mjohnson at apache dot org)
  24423. </summary>
  24424. </member>
  24425. <member name="M:NPOI.POIFS.Storage.SmallBlockTableReader._getSmallDocumentBlockReader(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Storage.RawDataBlockList,NPOI.POIFS.Properties.RootProperty,System.Int32)">
  24426. <summary>
  24427. fetch the small document block list from an existing file, normally
  24428. needed for debugging and low level dumping. You should typically call
  24429. </summary>
  24430. <param name="bigBlockSize">the poifs bigBlockSize</param>
  24431. <param name="blockList">the raw data from which the small block table will be extracted</param>
  24432. <param name="root">the root property (which contains the start block and small block table size)</param>
  24433. <param name="sbatStart">the start block of the SBAT</param>
  24434. <returns>the small document block reader</returns>
  24435. </member>
  24436. <member name="M:NPOI.POIFS.Storage.SmallBlockTableReader.GetSmallDocumentBlocks(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Storage.RawDataBlockList,NPOI.POIFS.Properties.RootProperty,System.Int32)">
  24437. <summary>
  24438. fetch the small document block list from an existing file
  24439. </summary>
  24440. <param name="bigBlockSize">the poifs bigBlockSize</param>
  24441. <param name="blockList">the raw data from which the small block table will be extracted</param>
  24442. <param name="root">the root property (which contains the start block and small block table size)</param>
  24443. <param name="sbatStart">the start block of the SBAT</param>
  24444. <returns>the small document block list</returns>
  24445. </member>
  24446. <member name="T:NPOI.POIFS.Storage.SmallBlockTableWriter">
  24447. <summary>
  24448. This class implements reading the small document block list from an
  24449. existing file
  24450. @author Marc Johnson (mjohnson at apache dot org)
  24451. </summary>
  24452. </member>
  24453. <member name="M:NPOI.POIFS.Storage.SmallBlockTableWriter.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize,System.Collections.Generic.IList{NPOI.POIFS.FileSystem.OPOIFSDocument},NPOI.POIFS.Properties.RootProperty)">
  24454. <summary>
  24455. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.SmallBlockTableWriter"/> class.
  24456. </summary>
  24457. <param name="bigBlockSize">the poifs bigBlockSize</param>
  24458. <param name="documents">a IList of POIFSDocument instances</param>
  24459. <param name="root">the Filesystem's root property</param>
  24460. </member>
  24461. <member name="P:NPOI.POIFS.Storage.SmallBlockTableWriter.SBATBlockCount">
  24462. <summary>
  24463. Get the number of SBAT blocks
  24464. </summary>
  24465. <value>number of SBAT big blocks</value>
  24466. </member>
  24467. <member name="P:NPOI.POIFS.Storage.SmallBlockTableWriter.SBAT">
  24468. <summary>
  24469. Gets the SBAT.
  24470. </summary>
  24471. <value>the Small Block Allocation Table</value>
  24472. </member>
  24473. <member name="P:NPOI.POIFS.Storage.SmallBlockTableWriter.CountBlocks">
  24474. <summary>
  24475. Return the number of BigBlock's this instance uses
  24476. </summary>
  24477. <value>count of BigBlock instances</value>
  24478. </member>
  24479. <member name="P:NPOI.POIFS.Storage.SmallBlockTableWriter.StartBlock">
  24480. <summary>
  24481. Sets the start block.
  24482. </summary>
  24483. <value>The start block.</value>
  24484. </member>
  24485. <member name="M:NPOI.POIFS.Storage.SmallBlockTableWriter.WriteBlocks(System.IO.Stream)">
  24486. <summary>
  24487. Write the storage to an OutputStream
  24488. </summary>
  24489. <param name="stream">the OutputStream to which the stored data should be written</param>
  24490. </member>
  24491. <member name="T:NPOI.POIFS.Storage.SmallDocumentBlock">
  24492. <summary>
  24493. Storage for documents that are too small to use regular
  24494. DocumentBlocks for their data
  24495. @author Marc Johnson (mjohnson at apache dot org)
  24496. </summary>
  24497. </member>
  24498. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.Convert(NPOI.POIFS.Common.POIFSBigBlockSize,System.Byte[],System.Int32)">
  24499. <summary>
  24500. convert a single long array into an array of SmallDocumentBlock
  24501. instances
  24502. </summary>
  24503. <param name="bigBlockSize">the poifs bigBlockSize</param>
  24504. <param name="array">the byte array to be converted</param>
  24505. <param name="size">the intended size of the array (which may be smaller)</param>
  24506. <returns>an array of SmallDocumentBlock instances, filled from
  24507. the array</returns>
  24508. </member>
  24509. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.Fill(NPOI.POIFS.Common.POIFSBigBlockSize,System.Collections.Generic.IList{NPOI.POIFS.Storage.SmallDocumentBlock})">
  24510. <summary>
  24511. fill out a List of SmallDocumentBlocks so that it fully occupies
  24512. a Set of big blocks
  24513. </summary>
  24514. <param name="bigBlockSize"></param>
  24515. <param name="blocks">the List to be filled out.</param>
  24516. <returns>number of big blocks the list encompasses</returns>
  24517. </member>
  24518. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.Convert(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Storage.BlockWritable[],System.Int32)">
  24519. <summary>
  24520. Factory for creating SmallDocumentBlocks from DocumentBlocks
  24521. </summary>
  24522. <param name="bigBlocksSize"></param>
  24523. <param name="store">the original DocumentBlocks</param>
  24524. <param name="size">the total document size</param>
  24525. <returns>an array of new SmallDocumentBlocks instances</returns>
  24526. </member>
  24527. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.Extract(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Storage.ListManagedBlock[])">
  24528. <summary>
  24529. create a list of SmallDocumentBlock's from raw data
  24530. </summary>
  24531. <param name="bigBlockSize"></param>
  24532. <param name="blocks">the raw data containing the SmallDocumentBlock</param>
  24533. <returns>a List of SmallDocumentBlock's extracted from the input</returns>
  24534. </member>
  24535. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.Read(NPOI.POIFS.Storage.BlockWritable[],System.Byte[],System.Int32)">
  24536. <summary>
  24537. Read data from an array of SmallDocumentBlocks
  24538. </summary>
  24539. <param name="blocks">the blocks to Read from.</param>
  24540. <param name="buffer">the buffer to Write the data into.</param>
  24541. <param name="offset">the offset into the array of blocks to Read from</param>
  24542. </member>
  24543. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.CalcSize(System.Int32)">
  24544. <summary>
  24545. Calculate the storage size of a Set of SmallDocumentBlocks
  24546. </summary>
  24547. <param name="size"> number of SmallDocumentBlocks</param>
  24548. <returns>total size</returns>
  24549. </member>
  24550. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.MakeEmptySmallDocumentBlock(NPOI.POIFS.Common.POIFSBigBlockSize)">
  24551. <summary>
  24552. Makes the empty small document block.
  24553. </summary>
  24554. <returns></returns>
  24555. </member>
  24556. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.ConvertToBlockCount(System.Int32)">
  24557. <summary>
  24558. Converts to block count.
  24559. </summary>
  24560. <param name="size">The size.</param>
  24561. <returns></returns>
  24562. </member>
  24563. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.WriteBlocks(System.IO.Stream)">
  24564. <summary>
  24565. Write the storage to an OutputStream
  24566. </summary>
  24567. <param name="stream">the OutputStream to which the stored data should
  24568. be written</param>
  24569. </member>
  24570. <member name="P:NPOI.POIFS.Storage.SmallDocumentBlock.Data">
  24571. <summary>
  24572. Get the data from the block
  24573. </summary>
  24574. <value>the block's data as a byte array</value>
  24575. </member>
  24576. <member name="T:NPOI.POIFS.Storage.SmallDocumentBlockList">
  24577. <summary>
  24578. A list of SmallDocumentBlocks instances, and methods to manage the list
  24579. @author Marc Johnson (mjohnson at apache dot org)
  24580. </summary>
  24581. </member>
  24582. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlockList.#ctor(System.Collections.Generic.List{NPOI.POIFS.Storage.SmallDocumentBlock})">
  24583. <summary>
  24584. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.SmallDocumentBlockList"/> class.
  24585. </summary>
  24586. <param name="blocks">a list of SmallDocumentBlock instances</param>
  24587. </member>
  24588. <member name="T:NPOI.SS.Format.CellDateFormatter">
  24589. Formats a date value.
  24590. @author Ken Arnold, Industrious Media LLC
  24591. </member>
  24592. <member name="M:NPOI.SS.Format.CellDateFormatter.#ctor(System.String)">
  24593. Creates a new date formatter with the given specification.
  24594. @param format The format.
  24595. </member>
  24596. <member name="M:NPOI.SS.Format.CellDateFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  24597. {@inheritDoc}
  24598. </member>
  24599. <member name="M:NPOI.SS.Format.CellDateFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  24600. {@inheritDoc}
  24601. <p/>
  24602. For a date, this is <tt>"mm/d/y"</tt>.
  24603. </member>
  24604. <member name="T:NPOI.SS.Format.CellElapsedFormatter">
  24605. This class : printing out an elapsed time format.
  24606. @author Ken Arnold, Industrious Media LLC
  24607. </member>
  24608. <member name="M:NPOI.SS.Format.CellElapsedFormatter.#ctor(System.String)">
  24609. Creates a elapsed time formatter.
  24610. @param pattern The pattern to Parse.
  24611. </member>
  24612. <member name="M:NPOI.SS.Format.CellElapsedFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  24613. {@inheritDoc}
  24614. </member>
  24615. <member name="M:NPOI.SS.Format.CellElapsedFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  24616. {@inheritDoc}
  24617. <p/>
  24618. For a date, this is <tt>"mm/d/y"</tt>.
  24619. </member>
  24620. <!-- Badly formed XML comment ignored for member "T:NPOI.SS.Format.CellFormat" -->
  24621. <member name="T:NPOI.SS.Format.CellFormat.GeneralCellFormat">
  24622. Format a value as it would be were no format specified. This is also
  24623. used when the format specified is <tt>General</tt>.
  24624. </member>
  24625. <member name="F:NPOI.SS.Format.CellFormat.formatCache">
  24626. Maps a format string to its Parsed version for efficiencies sake.
  24627. </member>
  24628. <member name="M:NPOI.SS.Format.CellFormat.GetInstance(System.String)">
  24629. Returns a {@link CellFormat} that applies the given format. Two calls
  24630. with the same format may or may not return the same object.
  24631. @param format The format.
  24632. @return A {@link CellFormat} that applies the given format.
  24633. </member>
  24634. <member name="M:NPOI.SS.Format.CellFormat.#ctor(System.String)">
  24635. Creates a new object.
  24636. @param format The format.
  24637. </member>
  24638. <member name="M:NPOI.SS.Format.CellFormat.Apply(System.Object)">
  24639. Returns the result of Applying the format to the given value. If the
  24640. value is a number (a type of {@link Number} object), the correct number
  24641. format type is chosen; otherwise it is considered a text object.
  24642. @param value The value
  24643. @return The result, in a {@link CellFormatResult}.
  24644. </member>
  24645. <member name="M:NPOI.SS.Format.CellFormat.Apply(System.DateTime,System.Double)">
  24646. Returns the result of applying the format to the given date.
  24647. @param date The date.
  24648. @param numericValue The numeric value for the date.
  24649. @return The result, in a {@link CellFormatResult}.
  24650. </member>
  24651. <member name="M:NPOI.SS.Format.CellFormat.Apply(NPOI.SS.UserModel.ICell)">
  24652. Fetches the appropriate value from the cell, and returns the result of
  24653. Applying it to the appropriate format. For formula cells, the computed
  24654. value is what is used.
  24655. @param c The cell.
  24656. @return The result, in a {@link CellFormatResult}.
  24657. </member>
  24658. <member name="M:NPOI.SS.Format.CellFormat.GetApplicableFormatPart(System.Object)">
  24659. Returns the {@link CellFormatPart} that applies to the value. Result
  24660. depends on how many parts the cell format has, the cell value and any
  24661. conditions. The value must be a {@link Number}.
  24662. @param value The value.
  24663. @return The {@link CellFormatPart} that applies to the value.
  24664. </member>
  24665. <member name="M:NPOI.SS.Format.CellFormat.UltimateType(NPOI.SS.UserModel.ICell)">
  24666. Returns the ultimate cell type, following the results of formulas. If
  24667. the cell is a {@link Cell#CELL_TYPE_FORMULA}, this returns the result of
  24668. {@link Cell#getCachedFormulaResultType()}. Otherwise this returns the
  24669. result of {@link Cell#getCellType()}.
  24670. @param cell The cell.
  24671. @return The ultimate type of this cell.
  24672. </member>
  24673. <member name="M:NPOI.SS.Format.CellFormat.Equals(System.Object)">
  24674. Returns <tt>true</tt> if the other object is a {@link CellFormat} object
  24675. with the same format.
  24676. @param obj The other object.
  24677. @return <tt>true</tt> if the two objects are Equal.
  24678. </member>
  24679. <member name="M:NPOI.SS.Format.CellFormat.GetHashCode">
  24680. Returns a hash code for the format.
  24681. @return A hash code for the format.
  24682. </member>
  24683. <member name="T:NPOI.SS.Format.CellFormatCondition">
  24684. This object represents a condition in a cell format.
  24685. @author Ken Arnold, Industrious Media LLC
  24686. </member>
  24687. <member name="M:NPOI.SS.Format.CellFormatCondition.GetInstance(System.String,System.String)">
  24688. Returns an instance of a condition object.
  24689. @param opString The operator as a string. One of <tt>"&lt;"</tt>,
  24690. <tt>"&lt;="</tt>, <tt>">"</tt>, <tt>">="</tt>,
  24691. <tt>"="</tt>, <tt>"=="</tt>, <tt>"!="</tt>, or
  24692. <tt>"&lt;>"</tt>.
  24693. @param constStr The constant (such as <tt>"12"</tt>).
  24694. @return A condition object for the given condition.
  24695. </member>
  24696. <member name="M:NPOI.SS.Format.CellFormatCondition.Pass(System.Double)">
  24697. Returns <tt>true</tt> if the given value passes the constraint's test.
  24698. @param value The value to compare against.
  24699. @return <tt>true</tt> if the given value passes the constraint's test.
  24700. </member>
  24701. <member name="T:NPOI.SS.Format.CellFormatPart">
  24702. Objects of this class represent a single part of a cell format expression.
  24703. Each cell can have up to four of these for positive, zero, negative, and text
  24704. values.
  24705. <p/>
  24706. Each format part can contain a color, a condition, and will always contain a
  24707. format specification. For example <tt>"[Red][>=10]#"</tt> has a color
  24708. (<tt>[Red]</tt>), a condition (<tt>>=10</tt>) and a format specification
  24709. (<tt>#</tt>).
  24710. <p/>
  24711. This class also Contains patterns for matching the subparts of format
  24712. specification. These are used internally, but are made public in case other
  24713. code has use for them.
  24714. @author Ken Arnold, Industrious Media LLC
  24715. </member>
  24716. <member name="F:NPOI.SS.Format.CellFormatPart.COLOR_PAT">
  24717. Pattern for the color part of a cell format part.
  24718. </member>
  24719. <member name="F:NPOI.SS.Format.CellFormatPart.CONDITION_PAT">
  24720. Pattern for the condition part of a cell format part.
  24721. </member>
  24722. <member name="F:NPOI.SS.Format.CellFormatPart.SPECIFICATION_PAT">
  24723. Pattern for the format specification part of a cell format part.
  24724. </member>
  24725. <member name="F:NPOI.SS.Format.CellFormatPart.CURRENCY_PAT">
  24726. Pattern for the currency symbol part of a cell format part
  24727. </member>
  24728. <member name="F:NPOI.SS.Format.CellFormatPart.FORMAT_PAT">
  24729. Pattern for an entire cell single part.
  24730. </member>
  24731. <member name="F:NPOI.SS.Format.CellFormatPart.COLOR_GROUP">
  24732. Within {@link #FORMAT_PAT}, the group number for the matched color.
  24733. </member>
  24734. <member name="F:NPOI.SS.Format.CellFormatPart.CONDITION_OPERATOR_GROUP">
  24735. Within {@link #FORMAT_PAT}, the group number for the operator in the
  24736. condition.
  24737. </member>
  24738. <member name="F:NPOI.SS.Format.CellFormatPart.CONDITION_VALUE_GROUP">
  24739. Within {@link #FORMAT_PAT}, the group number for the value in the
  24740. condition.
  24741. </member>
  24742. <member name="F:NPOI.SS.Format.CellFormatPart.SPECIFICATION_GROUP">
  24743. Within {@link #FORMAT_PAT}, the group number for the format
  24744. specification.
  24745. </member>
  24746. <member name="M:NPOI.SS.Format.CellFormatPart.#ctor(System.String)">
  24747. Create an object to represent a format part.
  24748. @param desc The string to Parse.
  24749. </member>
  24750. <member name="M:NPOI.SS.Format.CellFormatPart.Applies(System.Object)">
  24751. Returns <tt>true</tt> if this format part applies to the given value. If
  24752. the value is a number and this is part has a condition, returns
  24753. <tt>true</tt> only if the number passes the condition. Otherwise, this
  24754. allways return <tt>true</tt>.
  24755. @param valueObject The value to Evaluate.
  24756. @return <tt>true</tt> if this format part applies to the given value.
  24757. </member>
  24758. <member name="M:NPOI.SS.Format.CellFormatPart.FindGroup(System.Text.RegularExpressions.Regex,System.String,System.String)">
  24759. Returns the number of the first group that is the same as the marker
  24760. string. Starts from group 1.
  24761. @param pat The pattern to use.
  24762. @param str The string to match against the pattern.
  24763. @param marker The marker value to find the group of.
  24764. @return The matching group number.
  24765. @throws ArgumentException No group matches the marker.
  24766. </member>
  24767. <member name="M:NPOI.SS.Format.CellFormatPart.GetColor(System.Text.RegularExpressions.Match)">
  24768. Returns the color specification from the matcher, or <tt>null</tt> if
  24769. there is none.
  24770. @param m The matcher for the format part.
  24771. @return The color specification or <tt>null</tt>.
  24772. </member>
  24773. <member name="M:NPOI.SS.Format.CellFormatPart.GetCondition(System.Text.RegularExpressions.Match)">
  24774. Returns the condition specification from the matcher, or <tt>null</tt> if
  24775. there is none.
  24776. @param m The matcher for the format part.
  24777. @return The condition specification or <tt>null</tt>.
  24778. </member>
  24779. <member name="M:NPOI.SS.Format.CellFormatPart.GetCellFormatType(System.Text.RegularExpressions.Match)">
  24780. Returns the CellFormatType object implied by the format specification for
  24781. the format part.
  24782. @param matcher The matcher for the format part.
  24783. @return The CellFormatType.
  24784. </member>
  24785. <member name="M:NPOI.SS.Format.CellFormatPart.GetFormatter(System.Text.RegularExpressions.Match)">
  24786. Returns the formatter object implied by the format specification for the
  24787. format part.
  24788. @param matcher The matcher for the format part.
  24789. @return The formatter.
  24790. </member>
  24791. <member name="M:NPOI.SS.Format.CellFormatPart.formatType(System.String)">
  24792. Returns the type of format.
  24793. @param fdesc The format specification
  24794. @return The type of format.
  24795. </member>
  24796. <member name="M:NPOI.SS.Format.CellFormatPart.QuoteSpecial(System.String,NPOI.SS.Format.CellFormatType)">
  24797. Returns a version of the original string that has any special characters
  24798. quoted (or escaped) as appropriate for the cell format type. The format
  24799. type object is queried to see what is special.
  24800. @param repl The original string.
  24801. @param type The format type representation object.
  24802. @return A version of the string with any special characters Replaced.
  24803. @see CellFormatType#isSpecial(char)
  24804. </member>
  24805. <member name="M:NPOI.SS.Format.CellFormatPart.Apply(System.Object)">
  24806. Apply this format part to the given value. This returns a {@link
  24807. CellFormatResult} object with the results.
  24808. @param value The value to apply this format part to.
  24809. @return A {@link CellFormatResult} object Containing the results of
  24810. Applying the format to the value.
  24811. </member>
  24812. <member name="P:NPOI.SS.Format.CellFormatPart.CellFormatType">
  24813. Returns the CellFormatType object implied by the format specification for
  24814. the format part.
  24815. @return The CellFormatType.
  24816. </member>
  24817. <member name="P:NPOI.SS.Format.CellFormatPart.HasCondition">
  24818. Returns <tt>true</tt> if this format part has a condition.
  24819. @return <tt>true</tt> if this format part has a condition.
  24820. </member>
  24821. <member name="M:NPOI.SS.Format.CellFormatPart.ExpandChar(System.String)">
  24822. Expands a character. This is only partly done, because we don't have the
  24823. correct info. In Excel, this would be expanded to fill the rest of the
  24824. cell, but we don't know, in general, what the "rest of the cell" is1.
  24825. @param part The character to be repeated is the second character in this
  24826. string.
  24827. @return The character repeated three times.
  24828. </member>
  24829. <member name="M:NPOI.SS.Format.CellFormatPart.Group(System.Text.RegularExpressions.Match,System.Int32)">
  24830. Returns the string from the group, or <tt>""</tt> if the group is
  24831. <tt>null</tt>.
  24832. @param m The matcher.
  24833. @param g The group number.
  24834. @return The group or <tt>""</tt>.
  24835. </member>
  24836. <member name="T:NPOI.SS.Format.CellFormatResult">
  24837. This object Contains the result of Applying a cell format or cell format part
  24838. to a value.
  24839. @author Ken Arnold, Industrious Media LLC
  24840. @see CellFormatPart#Apply(Object)
  24841. @see CellFormat#Apply(Object)
  24842. </member>
  24843. <member name="P:NPOI.SS.Format.CellFormatResult.Applies">
  24844. This is <tt>true</tt> if no condition was given that applied to the
  24845. value, or if the condition is satisfied. If a condition is relevant, and
  24846. when applied the value fails the test, this is <tt>false</tt>.
  24847. </member>
  24848. <member name="P:NPOI.SS.Format.CellFormatResult.Text">
  24849. The resulting text. This will never be <tt>null</tt>.
  24850. </member>
  24851. <member name="P:NPOI.SS.Format.CellFormatResult.TextColor">
  24852. The color the format Sets, or <tt>null</tt> if the format Sets no color.
  24853. This will always be <tt>null</tt> if {@link #applies} is <tt>false</tt>.
  24854. </member>
  24855. <member name="M:NPOI.SS.Format.CellFormatResult.#ctor(System.Boolean,System.String,System.Drawing.Color)">
  24856. Creates a new format result object.
  24857. @param applies The value for {@link #applies}.
  24858. @param text The value for {@link #text}.
  24859. @param textColor The value for {@link #textColor}.
  24860. </member>
  24861. <member name="T:NPOI.SS.Format.CellFormatter">
  24862. This is the abstract supertype for the various cell formatters.
  24863. @author Ken Arnold, Industrious Media LLC
  24864. </member>
  24865. <member name="F:NPOI.SS.Format.CellFormatter.format">
  24866. The original specified format.
  24867. </member>
  24868. <member name="F:NPOI.SS.Format.CellFormatter.LOCALE">
  24869. This is the locale used to Get a consistent format result from which to
  24870. work.
  24871. </member>
  24872. <member name="M:NPOI.SS.Format.CellFormatter.#ctor(System.String)">
  24873. Creates a new formatter object, storing the format in {@link #format}.
  24874. @param format The format.
  24875. </member>
  24876. <member name="M:NPOI.SS.Format.CellFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  24877. Format a value according the format string.
  24878. @param toAppendTo The buffer to append to.
  24879. @param value The value to format.
  24880. </member>
  24881. <member name="M:NPOI.SS.Format.CellFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  24882. Format a value according to the type, in the most basic way.
  24883. @param toAppendTo The buffer to append to.
  24884. @param value The value to format.
  24885. </member>
  24886. <member name="M:NPOI.SS.Format.CellFormatter.Format(System.Object)">
  24887. Formats the value, returning the resulting string.
  24888. @param value The value to format.
  24889. @return The value, formatted.
  24890. </member>
  24891. <member name="M:NPOI.SS.Format.CellFormatter.SimpleFormat(System.Object)">
  24892. Formats the value in the most basic way, returning the resulting string.
  24893. @param value The value to format.
  24894. @return The value, formatted.
  24895. </member>
  24896. <member name="M:NPOI.SS.Format.CellFormatter.Quote(System.String)">
  24897. Returns the input string, surrounded by quotes.
  24898. @param str The string to quote.
  24899. @return The input string, surrounded by quotes.
  24900. </member>
  24901. <member name="T:NPOI.SS.Format.CellFormatType">
  24902. The different kinds of formats that the formatter understands.
  24903. @author Ken Arnold, Industrious Media LLC
  24904. </member>
  24905. <member name="F:NPOI.SS.Format.CellFormatType.GENERAL">
  24906. The general (default) format; also used for <tt>"General"</tt>.
  24907. </member>
  24908. <member name="F:NPOI.SS.Format.CellFormatType.NUMBER">
  24909. A numeric format.
  24910. </member>
  24911. <member name="F:NPOI.SS.Format.CellFormatType.DATE">
  24912. A date format.
  24913. </member>
  24914. <member name="F:NPOI.SS.Format.CellFormatType.ELAPSED">
  24915. An elapsed time format.
  24916. </member>
  24917. <member name="F:NPOI.SS.Format.CellFormatType.TEXT">
  24918. A text format.
  24919. </member>
  24920. <member name="M:NPOI.SS.Format.CellFormatType.IsSpecial(System.Char)">
  24921. Returns <tt>true</tt> if the format is special and needs to be quoted.
  24922. @param ch The character to test.
  24923. @return <tt>true</tt> if the format is special and needs to be quoted.
  24924. </member>
  24925. <member name="M:NPOI.SS.Format.CellFormatType.Formatter(System.String)">
  24926. Returns a new formatter of the appropriate type, for the given pattern.
  24927. The pattern must be appropriate for the type.
  24928. @param pattern The pattern to use.
  24929. @return A new formatter of the appropriate type, for the given pattern.
  24930. </member>
  24931. <member name="T:NPOI.SS.Format.CellGeneralFormatter">
  24932. A formatter for the default "General" cell format.
  24933. @author Ken Arnold, Industrious Media LLC
  24934. </member>
  24935. <member name="M:NPOI.SS.Format.CellGeneralFormatter.#ctor">
  24936. Creates a new general formatter.
  24937. </member>
  24938. <member name="M:NPOI.SS.Format.CellGeneralFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  24939. The general style is not quite the same as any other, or any combination
  24940. of others.
  24941. @param toAppendTo The buffer to append to.
  24942. @param value The value to format.
  24943. </member>
  24944. <member name="M:NPOI.SS.Format.CellGeneralFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  24945. Equivalent to {@link #formatValue(StringBuilder,Object)}. {@inheritDoc}.
  24946. </member>
  24947. <member name="T:NPOI.SS.Format.CellNumberFormatter">
  24948. This class : printing out a value using a number format.
  24949. @author Ken Arnold, Industrious Media LLC
  24950. </member>
  24951. <member name="T:NPOI.SS.Format.CellNumberFormatter.GeneralNumberFormatter">
  24952. <summary>
  24953. The CellNumberFormatter.simpleValue() method uses the SIMPLE_NUMBER
  24954. CellFormatter defined here. The CellFormat.GENERAL_FORMAT CellFormat
  24955. no longer uses the SIMPLE_NUMBER CellFormatter.
  24956. Note that the simpleValue()/SIMPLE_NUMBER CellFormatter format
  24957. ("#" for integer values, and "#.#" for floating-point values) is
  24958. different from the 'General' format for numbers ("#" for integer
  24959. values and "#.#########" for floating-point values).
  24960. </summary>
  24961. </member>
  24962. <member name="M:NPOI.SS.Format.CellNumberFormatter.#ctor(System.String)">
  24963. Creates a new cell number formatter.
  24964. @param format The format to Parse.
  24965. </member>
  24966. <member name="M:NPOI.SS.Format.CellNumberFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  24967. {@inheritDoc}
  24968. </member>
  24969. <member name="M:NPOI.SS.Format.CellNumberFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  24970. {@inheritDoc}
  24971. <p/>
  24972. For a number, this is <tt>"#"</tt> for integer values, and <tt>"#.#"</tt>
  24973. for floating-point values.
  24974. </member>
  24975. <member name="T:NPOI.SS.Format.Special">
  24976. This class is used to mark where the special characters in the format
  24977. are, as opposed to the other characters that are simply printed.
  24978. </member>
  24979. <member name="T:NPOI.SS.Format.CellNumberPartHandler">
  24980. Internal helper class for CellNumberFormatter
  24981. </member>
  24982. <member name="T:NPOI.SS.Format.CellNumberStringMod">
  24983. Internal helper class for CellNumberFormatter
  24984. This class represents a single modification to a result string. The way
  24985. this works is complicated, but so is numeric formatting. In general, for
  24986. most formats, we use a DecimalFormat object that will Put the string out
  24987. in a known format, usually with all possible leading and trailing zeros.
  24988. We then walk through the result and the original format, and note any
  24989. modifications that need to be made. Finally, we go through and apply
  24990. them all, dealing with overlapping modifications.
  24991. </member>
  24992. <member name="T:NPOI.SS.Format.CellTextFormatter">
  24993. This class : printing out text.
  24994. @author Ken Arnold, Industrious Media LLC
  24995. </member>
  24996. <member name="M:NPOI.SS.Format.CellTextFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  24997. {@inheritDoc}
  24998. </member>
  24999. <member name="M:NPOI.SS.Format.CellTextFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  25000. {@inheritDoc}
  25001. <p/>
  25002. For text, this is just printing the text.
  25003. </member>
  25004. <member name="F:NPOI.SS.Format.SimpleFraction.denominator">
  25005. The denominator.
  25006. </member>
  25007. <member name="F:NPOI.SS.Format.SimpleFraction.numerator">
  25008. The numerator.
  25009. </member>
  25010. <member name="M:NPOI.SS.Format.SimpleFraction.BuildFractionExactDenominator(System.Double,System.Int32)">
  25011. Create a fraction given a double value and a denominator.
  25012. @param val double value of fraction
  25013. @param exactDenom the exact denominator
  25014. @return a SimpleFraction with the given values set.
  25015. </member>
  25016. <member name="M:NPOI.SS.Format.SimpleFraction.BuildFractionMaxDenominator(System.Double,System.Int32)">
  25017. Create a fraction given the double value and either the maximum error
  25018. allowed or the maximum number of denominator digits.
  25019. @param value the double value to convert to a fraction.
  25020. @param maxDenominator maximum denominator value allowed.
  25021. @throws RuntimeException if the continued fraction failed to
  25022. converge.
  25023. @throws IllegalArgumentException if value > Integer.MAX_VALUE
  25024. </member>
  25025. <member name="M:NPOI.SS.Format.SimpleFraction.BuildFractionMaxDenominator(System.Double,System.Double,System.Int32,System.Int32)">
  25026. Create a fraction given the double value and either the maximum error
  25027. allowed or the maximum number of denominator digits.
  25028. <p>
  25029. References:
  25030. <ul>
  25031. <li><a href="http://mathworld.wolfram.com/ContinuedFraction.html">
  25032. Continued Fraction</a> equations (11) and (22)-(26)</li>
  25033. </ul>
  25034. </p>
  25035. Based on org.apache.commons.math.fraction.Fraction from Apache Commons-Math.
  25036. YK: The only reason of having this class is to avoid dependency on the Commons-Math jar.
  25037. @param value the double value to convert to a fraction.
  25038. @param epsilon maximum error allowed. The resulting fraction is within
  25039. <code>epsilon</code> of <code>value</code>, in absolute terms.
  25040. @param maxDenominator maximum denominator value allowed.
  25041. @param maxIterations maximum number of convergents
  25042. @throws RuntimeException if the continued fraction failed to
  25043. converge.
  25044. @throws IllegalArgumentException if value > Integer.MAX_VALUE
  25045. </member>
  25046. <member name="M:NPOI.SS.Format.SimpleFraction.#ctor(System.Int32,System.Int32)">
  25047. Create a fraction given a numerator and denominator.
  25048. @param numerator
  25049. @param denominator maxDenominator The maximum allowed value for denominator
  25050. </member>
  25051. <member name="P:NPOI.SS.Format.SimpleFraction.Denominator">
  25052. Access the denominator.
  25053. @return the denominator.
  25054. </member>
  25055. <member name="P:NPOI.SS.Format.SimpleFraction.Numerator">
  25056. Access the numerator.
  25057. @return the numerator.
  25058. </member>
  25059. <member name="M:NPOI.SS.Formula.Atp.AnalysisToolPak.GetSupportedFunctionNames">
  25060. Returns a collection of ATP function names implemented by POI.
  25061. @return an array of supported functions
  25062. @since 3.8 beta6
  25063. </member>
  25064. <member name="M:NPOI.SS.Formula.Atp.AnalysisToolPak.GetNotSupportedFunctionNames">
  25065. Returns a collection of ATP function names NOT implemented by POI.
  25066. @return an array of not supported functions
  25067. @since 3.8 beta6
  25068. </member>
  25069. <member name="M:NPOI.SS.Formula.Atp.AnalysisToolPak.RegisterFunction(System.String,NPOI.SS.Formula.Functions.FreeRefFunction)">
  25070. Register a ATP function in runtime.
  25071. @param name the function name
  25072. @param func the functoin to register
  25073. @throws ArgumentException if the function is unknown or already registered.
  25074. @since 3.8 beta6
  25075. </member>
  25076. <member name="T:NPOI.SS.Formula.Atp.ArgumentsEvaluator">
  25077. Evaluator for formula arguments.
  25078. @author jfaenomoto@gmail.com
  25079. </member>
  25080. <member name="M:NPOI.SS.Formula.Atp.ArgumentsEvaluator.EvaluateDateArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  25081. Evaluate a generic {@link ValueEval} argument to a double value that represents a date in POI.
  25082. @param arg {@link ValueEval} an argument.
  25083. @param srcCellRow number cell row.
  25084. @param srcCellCol number cell column.
  25085. @return a double representing a date in POI.
  25086. @throws EvaluationException exception upon argument evaluation.
  25087. </member>
  25088. <member name="M:NPOI.SS.Formula.Atp.ArgumentsEvaluator.EvaluateDatesArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  25089. Evaluate a generic {@link ValueEval} argument to an array of double values that represents dates in POI.
  25090. @param arg {@link ValueEval} an argument.
  25091. @param srcCellRow number cell row.
  25092. @param srcCellCol number cell column.
  25093. @return an array of doubles representing dates in POI.
  25094. @throws EvaluationException exception upon argument evaluation.
  25095. </member>
  25096. <member name="M:NPOI.SS.Formula.Atp.ArgumentsEvaluator.EvaluateNumberArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  25097. Evaluate a generic {@link ValueEval} argument to a double value.
  25098. @param arg {@link ValueEval} an argument.
  25099. @param srcCellRow number cell row.
  25100. @param srcCellCol number cell column.
  25101. @return a double value.
  25102. @throws EvaluationException exception upon argument evaluation.
  25103. </member>
  25104. <member name="T:NPOI.SS.Formula.Atp.DateParser">
  25105. Parser for java dates.
  25106. @author jfaenomoto@gmail.com
  25107. </member>
  25108. <member name="M:NPOI.SS.Formula.Atp.DateParser.ParseDate(System.String)">
  25109. Parses a date from a string.
  25110. @param strVal a string with a date pattern.
  25111. @return a date parsed from argument.
  25112. @throws EvaluationException exception upon parsing.
  25113. </member>
  25114. <member name="M:NPOI.SS.Formula.Atp.DateParser.MakeDate(System.Int32,System.Int32,System.Int32)">
  25115. @param month 1-based
  25116. </member>
  25117. <member name="T:NPOI.SS.Formula.Atp.MRound">
  25118. Implementation of Excel 'Analysis ToolPak' function MROUND()<br/>
  25119. Returns a number rounded to the desired multiple.<p/>
  25120. <b>Syntax</b><br/>
  25121. <b>MROUND</b>(<b>number</b>, <b>multiple</b>)
  25122. <p/>
  25123. @author Yegor Kozlov
  25124. </member>
  25125. <member name="T:NPOI.SS.Formula.Atp.NetworkdaysFunction">
  25126. Implementation of Excel 'Analysis ToolPak' function NETWORKDAYS()<br/>
  25127. Returns the number of workdays given a starting and an ending date, considering an interval of holidays. A workday is any non
  25128. saturday/sunday date.
  25129. <p/>
  25130. <b>Syntax</b><br/>
  25131. <b>NETWORKDAYS</b>(<b>startDate</b>, <b>endDate</b>, holidays)
  25132. <p/>
  25133. @author jfaenomoto@gmail.com
  25134. </member>
  25135. <member name="M:NPOI.SS.Formula.Atp.NetworkdaysFunction.#ctor(NPOI.SS.Formula.Atp.ArgumentsEvaluator)">
  25136. Constructor.
  25137. @param anEvaluator an injected {@link ArgumentsEvaluator}.
  25138. </member>
  25139. <member name="M:NPOI.SS.Formula.Atp.NetworkdaysFunction.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],NPOI.SS.Formula.OperationEvaluationContext)">
  25140. Evaluate for NETWORKDAYS. Given two dates and a optional date or interval of holidays, determines how many working days are there
  25141. between those dates.
  25142. @return {@link ValueEval} for the number of days between two dates.
  25143. </member>
  25144. <member name="T:NPOI.SS.Formula.Atp.ParityFunction">
  25145. Implementation of Excel 'Analysis ToolPak' function ISEVEN() ISODD()<br/>
  25146. @author Josh Micich
  25147. </member>
  25148. <member name="T:NPOI.SS.Formula.Atp.RandBetween">
  25149. * Implementation of Excel 'Analysis ToolPak' function RANDBETWEEN()<br/>
  25150. *
  25151. * Returns a random integer number between the numbers you specify.<p/>
  25152. *
  25153. * <b>Syntax</b><br/>
  25154. * <b>RANDBETWEEN</b>(<b>bottom</b>, <b>top</b>)<p/>
  25155. *
  25156. * <b>bottom</b> is the smallest integer RANDBETWEEN will return.<br/>
  25157. * <b>top</b> is the largest integer RANDBETWEEN will return.<br/>
  25158. * @author Brendan Nolan
  25159. </member>
  25160. <member name="M:NPOI.SS.Formula.Atp.RandBetween.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],NPOI.SS.Formula.OperationEvaluationContext)">
  25161. Evaluate for RANDBETWEEN(). Must be given two arguments. Bottom must be greater than top.
  25162. Bottom is rounded up and top value is rounded down. After rounding top has to be set greater
  25163. than top.
  25164. @see org.apache.poi.ss.formula.functions.FreeRefFunction#evaluate(org.apache.poi.ss.formula.eval.ValueEval[], org.apache.poi.ss.formula.OperationEvaluationContext)
  25165. </member>
  25166. <member name="T:NPOI.SS.Formula.Atp.WorkdayCalculator">
  25167. A calculator for workdays, considering dates as excel representations.
  25168. @author jfaenomoto@gmail.com
  25169. </member>
  25170. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.#ctor">
  25171. Constructor.
  25172. </member>
  25173. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.CalculateWorkdays(System.Double,System.Double,System.Double[])">
  25174. Calculate how many workdays are there between a start and an end date, as excel representations, considering a range of holidays.
  25175. @param start start date.
  25176. @param end end date.
  25177. @param holidays an array of holidays.
  25178. @return number of workdays between start and end dates, including both dates.
  25179. </member>
  25180. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.CalculateWorkdays(System.Double,System.Int32,System.Double[])">
  25181. Calculate the workday past x workdays from a starting date, considering a range of holidays.
  25182. @param start start date.
  25183. @param workdays number of workdays to be past from starting date.
  25184. @param holidays an array of holidays.
  25185. @return date past x workdays.
  25186. </member>
  25187. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.PastDaysOfWeek(System.Double,System.Double,System.DayOfWeek)">
  25188. Calculates how many days of week past between a start and an end date.
  25189. @param start start date.
  25190. @param end end date.
  25191. @param dayOfWeek a day of week as represented by {@link Calendar} constants.
  25192. @return how many days of week past in this interval.
  25193. </member>
  25194. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.CalculateNonWeekendHolidays(System.Double,System.Double,System.Double[])">
  25195. Calculates how many holidays in a list are workdays, considering an interval of dates.
  25196. @param start start date.
  25197. @param end end date.
  25198. @param holidays an array of holidays.
  25199. @return number of holidays that occur in workdays, between start and end dates.
  25200. </member>
  25201. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.IsWeekend(System.Double)">
  25202. @param aDate a given date.
  25203. @return <code>true</code> if date is weekend, <code>false</code> otherwise.
  25204. </member>
  25205. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.IsHoliday(System.Double,System.Double[])">
  25206. @param aDate a given date.
  25207. @param holidays an array of holidays.
  25208. @return <code>true</code> if date is a holiday, <code>false</code> otherwise.
  25209. </member>
  25210. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.IsNonWorkday(System.Double,System.Double[])">
  25211. @param aDate a given date.
  25212. @param holidays an array of holidays.
  25213. @return <code>1</code> is not a workday, <code>0</code> otherwise.
  25214. </member>
  25215. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.IsInARange(System.Double,System.Double,System.Double)">
  25216. @param start start date.
  25217. @param end end date.
  25218. @param aDate a date to be analyzed.
  25219. @return <code>true</code> if aDate is between start and end dates, <code>false</code> otherwise.
  25220. </member>
  25221. <member name="T:NPOI.SS.Formula.Atp.WorkdayFunction">
  25222. Implementation of Excel 'Analysis ToolPak' function WORKDAY()<br/>
  25223. Returns the date past a number of workdays beginning at a start date, considering an interval of holidays. A workday is any non
  25224. saturday/sunday date.
  25225. <p/>
  25226. <b>Syntax</b><br/>
  25227. <b>WORKDAY</b>(<b>startDate</b>, <b>days</b>, holidays)
  25228. <p/>
  25229. @author jfaenomoto@gmail.com
  25230. </member>
  25231. <member name="M:NPOI.SS.Formula.Atp.WorkdayFunction.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],NPOI.SS.Formula.OperationEvaluationContext)">
  25232. Evaluate for WORKDAY. Given a date, a number of days and a optional date or interval of holidays, determines which date it is past
  25233. number of parametrized workdays.
  25234. @return {@link ValueEval} with date as its value.
  25235. </member>
  25236. <member name="T:NPOI.SS.Formula.Atp.YearFrac">
  25237. Implementation of Excel 'Analysis ToolPak' function YEARFRAC()<br/>
  25238. Returns the fraction of the year spanned by two dates.<p/>
  25239. <b>Syntax</b><br/>
  25240. <b>YEARFRAC</b>(<b>startDate</b>, <b>endDate</b>, basis)<p/>
  25241. The <b>basis</b> optionally specifies the behaviour of YEARFRAC as follows:
  25242. <table border="0" cellpadding="1" cellspacing="0" summary="basis parameter description">
  25243. <tr><th>Value</th><th>Days per Month</th><th>Days per Year</th></tr>
  25244. <tr align='center'><td>0 (default)</td><td>30</td><td>360</td></tr>
  25245. <tr align='center'><td>1</td><td>actual</td><td>actual</td></tr>
  25246. <tr align='center'><td>2</td><td>actual</td><td>360</td></tr>
  25247. <tr align='center'><td>3</td><td>actual</td><td>365</td></tr>
  25248. <tr align='center'><td>4</td><td>30</td><td>360</td></tr>
  25249. </table>
  25250. </member>
  25251. <member name="T:NPOI.SS.Formula.Atp.YearFracCalculator">
  25252. <summary>
  25253. Internal calculation methods for Excel 'Analysis ToolPak' function YEARFRAC()
  25254. Algorithm inspired by www.dwheeler.com/yearfrac
  25255. @author Josh Micich
  25256. </summary>
  25257. <remarks>
  25258. Date Count convention
  25259. http://en.wikipedia.org/wiki/Day_count_convention
  25260. </remarks>
  25261. <remarks>
  25262. Office Online Help on YEARFRAC
  25263. http://office.microsoft.com/en-us/excel/HP052093441033.aspx
  25264. </remarks>
  25265. </member>
  25266. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.MS_PER_HOUR">
  25267. use UTC time-zone to avoid daylight savings issues
  25268. </member>
  25269. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.LONG_MONTH_LEN">
  25270. the length of normal long months i.e. 31
  25271. </member>
  25272. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.SHORT_MONTH_LEN">
  25273. the length of normal short months i.e. 30
  25274. </member>
  25275. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Calculate(System.Double,System.Double,System.Int32)">
  25276. <summary>
  25277. Calculates YEARFRAC()
  25278. </summary>
  25279. <param name="pStartDateVal">The start date.</param>
  25280. <param name="pEndDateVal">The end date.</param>
  25281. <param name="basis">The basis value.</param>
  25282. <returns></returns>
  25283. </member>
  25284. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Basis0(System.Int32,System.Int32)">
  25285. <summary>
  25286. Basis 0, 30/360 date convention
  25287. </summary>
  25288. <param name="startDateVal">The start date value assumed to be less than or equal to endDateVal.</param>
  25289. <param name="endDateVal">The end date value assumed to be greater than or equal to startDateVal.</param>
  25290. <returns></returns>
  25291. </member>
  25292. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Basis1(System.Int32,System.Int32)">
  25293. <summary>
  25294. Basis 1, Actual/Actual date convention
  25295. </summary>
  25296. <param name="startDateVal">The start date value assumed to be less than or equal to endDateVal.</param>
  25297. <param name="endDateVal">The end date value assumed to be greater than or equal to startDateVal.</param>
  25298. <returns></returns>
  25299. </member>
  25300. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Basis2(System.Int32,System.Int32)">
  25301. <summary>
  25302. Basis 2, Actual/360 date convention
  25303. </summary>
  25304. <param name="startDateVal">The start date value assumed to be less than or equal to endDateVal.</param>
  25305. <param name="endDateVal">The end date value assumed to be greater than or equal to startDateVal.</param>
  25306. <returns></returns>
  25307. </member>
  25308. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Basis3(System.Double,System.Double)">
  25309. <summary>
  25310. Basis 3, Actual/365 date convention
  25311. </summary>
  25312. <param name="startDateVal">The start date value assumed to be less than or equal to endDateVal.</param>
  25313. <param name="endDateVal">The end date value assumed to be greater than or equal to startDateVal.</param>
  25314. <returns></returns>
  25315. </member>
  25316. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Basis4(System.Int32,System.Int32)">
  25317. <summary>
  25318. Basis 4, European 30/360 date convention
  25319. </summary>
  25320. <param name="startDateVal">The start date value assumed to be less than or equal to endDateVal.</param>
  25321. <param name="endDateVal">The end date value assumed to be greater than or equal to startDateVal.</param>
  25322. <returns></returns>
  25323. </member>
  25324. <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)">
  25325. <summary>
  25326. Calculates the adjusted.
  25327. </summary>
  25328. <param name="startDate">The start date.</param>
  25329. <param name="endDate">The end date.</param>
  25330. <param name="date1day">The date1day.</param>
  25331. <param name="date2day">The date2day.</param>
  25332. <returns></returns>
  25333. </member>
  25334. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.IsLastDayOfMonth(NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate)">
  25335. <summary>
  25336. Determines whether [is last day of month] [the specified date].
  25337. </summary>
  25338. <param name="date">The date.</param>
  25339. <returns>
  25340. <c>true</c> if [is last day of month] [the specified date]; otherwise, <c>false</c>.
  25341. </returns>
  25342. </member>
  25343. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.GetLastDayOfMonth(NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate)">
  25344. <summary>
  25345. Gets the last day of month.
  25346. </summary>
  25347. <param name="date">The date.</param>
  25348. <returns></returns>
  25349. </member>
  25350. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.ShouldCountFeb29(NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate,NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate)">
  25351. <summary>
  25352. Assumes dates are no more than 1 year apart.
  25353. </summary>
  25354. <param name="start">The start.</param>
  25355. <param name="end">The end.</param>
  25356. <returns><c>true</c>
  25357. if dates both within a leap year, or span a period including Feb 29</returns>
  25358. </member>
  25359. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.DateDiff(System.Int64,System.Int64)">
  25360. <summary>
  25361. return the whole number of days between the two time-stamps. Both time-stamps are
  25362. assumed to represent 12:00 midnight on the respective day.
  25363. </summary>
  25364. <param name="startDateTicks">The start date ticks.</param>
  25365. <param name="endDateTicks">The end date ticks.</param>
  25366. <returns></returns>
  25367. </member>
  25368. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.AverageYearLength(System.Int32,System.Int32)">
  25369. <summary>
  25370. Averages the length of the year.
  25371. </summary>
  25372. <param name="startYear">The start year.</param>
  25373. <param name="endYear">The end year.</param>
  25374. <returns></returns>
  25375. </member>
  25376. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.IsLeapYear(System.Int32)">
  25377. <summary>
  25378. determine Leap Year
  25379. </summary>
  25380. <param name="i">the year</param>
  25381. <returns></returns>
  25382. </member>
  25383. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.IsGreaterThanOneYear(NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate,NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate)">
  25384. <summary>
  25385. Determines whether [is greater than one year] [the specified start].
  25386. </summary>
  25387. <param name="start">The start date.</param>
  25388. <param name="end">The end date.</param>
  25389. <returns>
  25390. <c>true</c> if [is greater than one year] [the specified start]; otherwise, <c>false</c>.
  25391. </returns>
  25392. </member>
  25393. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.CreateDate(System.Int32)">
  25394. <summary>
  25395. Creates the date.
  25396. </summary>
  25397. <param name="dayCount">The day count.</param>
  25398. <returns></returns>
  25399. </member>
  25400. <member name="T:NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate">
  25401. <summary>
  25402. Simple Date Wrapper
  25403. </summary>
  25404. </member>
  25405. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate.month">
  25406. 1-based month
  25407. </member>
  25408. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate.day">
  25409. day of month
  25410. </member>
  25411. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate.ticks">
  25412. milliseconds since 1970
  25413. </member>
  25414. <member name="T:NPOI.SS.Formula.BaseFormulaEvaluator">
  25415. Common functionality across file formats for Evaluating formula cells.<p/>
  25416. </member>
  25417. <member name="M:NPOI.SS.Formula.BaseFormulaEvaluator.SetupEnvironment(System.String[],NPOI.SS.Formula.BaseFormulaEvaluator[])">
  25418. Coordinates several formula Evaluators together so that formulas that involve external
  25419. references can be Evaluated.
  25420. @param workbookNames the simple file names used to identify the workbooks in formulas
  25421. with external links (for example "MyData.xls" as used in a formula "[MyData.xls]Sheet1!A1")
  25422. @param Evaluators all Evaluators for the full Set of workbooks required by the formulas.
  25423. </member>
  25424. <member name="M:NPOI.SS.Formula.BaseFormulaEvaluator.ClearAllCachedResultValues">
  25425. Should be called whenever there are major Changes (e.g. moving sheets) to input cells
  25426. in the Evaluated workbook. If performance is not critical, a single call to this method
  25427. may be used instead of many specific calls to the Notify~ methods.
  25428. Failure to call this method After changing cell values will cause incorrect behaviour
  25429. of the Evaluate~ methods of this class
  25430. </member>
  25431. <member name="M:NPOI.SS.Formula.BaseFormulaEvaluator.Evaluate(NPOI.SS.UserModel.ICell)">
  25432. If cell Contains a formula, the formula is Evaluated and returned,
  25433. else the CellValue simply copies the appropriate cell value from
  25434. the cell and also its cell type. This method should be preferred over
  25435. EvaluateInCell() when the call should not modify the contents of the
  25436. original cell.
  25437. @param cell may be <code>null</code> signifying that the cell is not present (or blank)
  25438. @return <code>null</code> if the supplied cell is <code>null</code> or blank
  25439. </member>
  25440. <member name="M:NPOI.SS.Formula.BaseFormulaEvaluator.EvaluateInCell(NPOI.SS.UserModel.ICell)">
  25441. If cell Contains formula, it Evaluates the formula, and
  25442. Puts the formula result back into the cell, in place
  25443. of the old formula.
  25444. Else if cell does not contain formula, this method leaves
  25445. the cell unChanged.
  25446. Note that the same instance of HSSFCell is returned to
  25447. allow chained calls like:
  25448. <pre>
  25449. int EvaluatedCellType = Evaluator.EvaluateInCell(cell).CellType;
  25450. </pre>
  25451. Be aware that your cell value will be Changed to hold the
  25452. result of the formula. If you simply want the formula
  25453. value computed for you, use {@link #EvaluateFormulaCellEnum(Cell)}}
  25454. @param cell
  25455. @return the {@code cell} that was passed in, allowing for chained calls
  25456. </member>
  25457. <member name="M:NPOI.SS.Formula.BaseFormulaEvaluator.EvaluateFormulaCell(NPOI.SS.UserModel.ICell)">
  25458. If cell Contains formula, it Evaluates the formula, and saves the result of the formula. The
  25459. cell remains as a formula cell. If the cell does not contain formula, this method returns -1
  25460. and leaves the cell unChanged.
  25461. Note that the type of the <em>formula result</em> is returned, so you know what kind of
  25462. cached formula result is also stored with the formula.
  25463. <pre>
  25464. int EvaluatedCellType = Evaluator.EvaluateFormulaCell(cell);
  25465. </pre>
  25466. Be aware that your cell will hold both the formula, and the result. If you want the cell
  25467. Replaced with the result of the formula, use {@link #EvaluateInCell(NPOI.SS.UserModel.Cell)}
  25468. @param cell The cell to Evaluate
  25469. @return -1 for non-formula cells, or the type of the <em>formula result</em>
  25470. </member>
  25471. <member name="M:NPOI.SS.Formula.BaseFormulaEvaluator.EvaluateFormulaCellEnum(NPOI.SS.UserModel.ICell)">
  25472. If cell Contains formula, it Evaluates the formula,
  25473. and saves the result of the formula. The cell
  25474. remains as a formula cell.
  25475. Else if cell does not contain formula, this method leaves
  25476. the cell unChanged.
  25477. Note that the type of the formula result is returned,
  25478. so you know what kind of value is also stored with
  25479. the formula.
  25480. <pre>
  25481. ICellType EvaluatedCellType = Evaluator.EvaluateFormulaCellEnum(cell);
  25482. </pre>
  25483. Be aware that your cell will hold both the formula,
  25484. and the result. If you want the cell Replaced with
  25485. the result of the formula, use {@link #Evaluate(NPOI.SS.UserModel.Cell)} }
  25486. @param cell The cell to Evaluate
  25487. @return The type of the formula result (the cell's type remains as CellType.FORMULA however)
  25488. If cell is not a formula cell, returns {@link CellType#_NONE} rather than throwing an exception.
  25489. @since POI 3.15 beta 3
  25490. </member>
  25491. <member name="M:NPOI.SS.Formula.BaseFormulaEvaluator.EvaluateAllFormulaCells(NPOI.SS.UserModel.IWorkbook)">
  25492. Loops over all cells in all sheets of the supplied
  25493. workbook.
  25494. For cells that contain formulas, their formulas are
  25495. Evaluated, and the results are saved. These cells
  25496. remain as formula cells.
  25497. For cells that do not contain formulas, no Changes
  25498. are made.
  25499. This is a helpful wrapper around looping over all
  25500. cells, and calling EvaluateFormulaCell on each one.
  25501. </member>
  25502. <member name="P:NPOI.SS.Formula.BaseFormulaEvaluator.IgnoreMissingWorkbooks">
  25503. {@inheritDoc}
  25504. </member>
  25505. <member name="P:NPOI.SS.Formula.BaseFormulaEvaluator.DebugEvaluationOutputForNextEval">
  25506. {@inheritDoc}
  25507. </member>
  25508. <member name="T:NPOI.SS.Formula.CellCacheEntry">
  25509. Stores the parameters that identify the evaluation of one cell.<br/>
  25510. </member>
  25511. <member name="M:NPOI.SS.Formula.CellCacheEntry.RecurseClearCachedFormulaResults">
  25512. Calls formulaCell.SetFormulaResult(null, null) recursively all the way up the tree of
  25513. dependencies. Calls usedCell.ClearConsumingCell(fc) for each child of a cell that Is
  25514. Cleared along the way.
  25515. @param formulaCells
  25516. </member>
  25517. <member name="M:NPOI.SS.Formula.CellCacheEntry.RecurseClearCachedFormulaResults(NPOI.SS.Formula.IEvaluationListener,System.Int32)">
  25518. Identical To {@link #RecurseClearCachedFormulaResults()} except for the listener call-backs
  25519. </member>
  25520. <member name="T:NPOI.SS.Formula.CellEvaluationFrame">
  25521. Stores details about the current evaluation of a cell.<br/>
  25522. </member>
  25523. <member name="M:NPOI.SS.Formula.CellEvaluationFrame.AddSensitiveInputCell(NPOI.SS.Formula.CellCacheEntry)">
  25524. @param inputCell a cell directly used by the formula of this evaluation frame
  25525. </member>
  25526. <member name="M:NPOI.SS.Formula.CellEvaluationFrame.GetSensitiveInputCells">
  25527. @return never <c>null</c>, (possibly empty) array of all cells directly used while
  25528. evaluating the formula of this frame.
  25529. </member>
  25530. <member name="T:NPOI.SS.Formula.CollaboratingWorkbooksEnvironment">
  25531. Manages a collection of {@link WorkbookEvaluator}s, in order To support evaluation of formulas
  25532. across spreadsheets.<p/>
  25533. For POI internal use only
  25534. @author Josh Micich
  25535. </member>
  25536. <member name="M:NPOI.SS.Formula.CollaboratingWorkbooksEnvironment.Unhook">
  25537. </member>
  25538. <member name="T:NPOI.SS.Formula.Constant.ConstantValueParser">
  25539. To support Constant Values (2.5.7) as required by the CRN record.
  25540. This class is also used for two dimensional arrays which are encoded by
  25541. EXTERNALNAME (5.39) records and Array tokens.<p/>
  25542. @author Josh Micich
  25543. </member>
  25544. <member name="M:NPOI.SS.Formula.Constant.ConstantValueParser.GetEncodedSize(System.Object)">
  25545. @return encoded size without the 'type' code byte
  25546. </member>
  25547. <member name="T:NPOI.SS.Formula.Constant.ErrorConstant">
  25548. <summary>
  25549. Represents a constant error code value as encoded in a constant values array.
  25550. This class is a type-safe wrapper for a 16-bit int value performing a similar job to
  25551. <c>ErrorEval</c>
  25552. </summary>
  25553. <remarks> @author Josh Micich</remarks>
  25554. </member>
  25555. <member name="M:NPOI.SS.Formula.Constant.ErrorConstant.#ctor(System.Int32)">
  25556. <summary>
  25557. Initializes a new instance of the <see cref="T:NPOI.SS.Formula.Constant.ErrorConstant"/> class.
  25558. </summary>
  25559. <param name="errorCode">The error code.</param>
  25560. </member>
  25561. <member name="P:NPOI.SS.Formula.Constant.ErrorConstant.ErrorCode">
  25562. <summary>
  25563. Gets the error code.
  25564. </summary>
  25565. <value>The error code.</value>
  25566. </member>
  25567. <member name="P:NPOI.SS.Formula.Constant.ErrorConstant.Text">
  25568. <summary>
  25569. Gets the text.
  25570. </summary>
  25571. <value>The text.</value>
  25572. </member>
  25573. <member name="M:NPOI.SS.Formula.Constant.ErrorConstant.ValueOf(System.Int32)">
  25574. <summary>
  25575. Values the of.
  25576. </summary>
  25577. <param name="errorCode">The error code.</param>
  25578. <returns></returns>
  25579. </member>
  25580. <member name="M:NPOI.SS.Formula.Constant.ErrorConstant.ToString">
  25581. <summary>
  25582. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  25583. </summary>
  25584. <returns>
  25585. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  25586. </returns>
  25587. </member>
  25588. <member name="T:NPOI.SS.Formula.EvaluationCache">
  25589. Performance optimisation for {@link HSSFFormulaEvaluator}. This class stores previously
  25590. calculated values of already visited cells, To avoid unnecessary re-calculation when the
  25591. same cells are referenced multiple times
  25592. @author Josh Micich
  25593. </member>
  25594. <member name="F:NPOI.SS.Formula.EvaluationCache._evaluationListener">
  25595. only used for testing. <c>null</c> otherwise
  25596. </member>
  25597. <member name="M:NPOI.SS.Formula.EvaluationCache.Clear">
  25598. Should be called whenever there are Changes To input cells in the evaluated workbook.
  25599. </member>
  25600. <member name="T:NPOI.SS.Formula.IEvaluationCell">
  25601. Abstracts a cell for the purpose of formula evaluation. This interface represents both formula
  25602. and non-formula cells.<br/>
  25603. Implementors of this class must implement {@link #HashCode()} and {@link #Equals(Object)}
  25604. To provide an <em>identity</em> relationship based on the underlying HSSF or XSSF cell <p/>
  25605. For POI internal use only
  25606. @author Josh Micich
  25607. </member>
  25608. <member name="T:NPOI.SS.Formula.IEvaluationName">
  25609. Abstracts a name record for formula evaluation.<br/>
  25610. For POI internal use only
  25611. @author Josh Micich
  25612. </member>
  25613. <member name="T:NPOI.SS.Formula.IEvaluationSheet">
  25614. Abstracts a sheet for the purpose of formula evaluation.<br/>
  25615. For POI internal use only
  25616. @author Josh Micich
  25617. </member>
  25618. <member name="M:NPOI.SS.Formula.IEvaluationSheet.GetCell(System.Int32,System.Int32)">
  25619. @return <c>null</c> if there is no cell at the specified coordinates
  25620. </member>
  25621. <member name="M:NPOI.SS.Formula.IEvaluationSheet.ClearAllCachedResultValues">
  25622. Propagated from {@link EvaluationWorkbook#clearAllCachedResultValues()} to clear locally cached data.
  25623. @see WorkbookEvaluator#clearAllCachedResultValues()
  25624. @see EvaluationWorkbook#clearAllCachedResultValues()
  25625. </member>
  25626. <member name="T:NPOI.SS.Formula.EvaluationTracker">
  25627. <summary>
  25628. Instances of this class keep track of multiple dependent cell evaluations due
  25629. To recursive calls To <see cref="M:NPOI.SS.Formula.WorkbookEvaluator.Evaluate(NPOI.SS.Formula.IEvaluationCell)"/>
  25630. The main purpose of this class is To detect an attempt To evaluate a cell
  25631. that is already being evaluated. In other words, it detects circular
  25632. references in spreadsheet formulas.
  25633. </summary>
  25634. <remarks>
  25635. @author Josh Micich
  25636. </remarks>
  25637. </member>
  25638. <member name="M:NPOI.SS.Formula.EvaluationTracker.StartEvaluate(NPOI.SS.Formula.FormulaCellCacheEntry)">
  25639. Notifies this evaluation tracker that evaluation of the specified cell Is
  25640. about To start.<br/>
  25641. In the case of a <c>true</c> return code, the caller should
  25642. continue evaluation of the specified cell, and also be sure To call
  25643. <c>endEvaluate()</c> when complete.<br/>
  25644. In the case of a <c>null</c> return code, the caller should
  25645. return an evaluation result of
  25646. <c>ErrorEval.CIRCULAR_REF_ERROR</c>, and not call <c>endEvaluate()</c>.
  25647. <br/>
  25648. @return <c>false</c> if the specified cell is already being evaluated
  25649. </member>
  25650. <member name="M:NPOI.SS.Formula.EvaluationTracker.EndEvaluate(NPOI.SS.Formula.CellCacheEntry)">
  25651. Notifies this evaluation tracker that the evaluation of the specified cell is complete. <p/>
  25652. Every successful call To <c>startEvaluate</c> must be followed by a call To <c>endEvaluate</c> (recommended in a finally block) To enable
  25653. proper tracking of which cells are being evaluated at any point in time.<p/>
  25654. Assuming a well behaved client, parameters To this method would not be
  25655. required. However, they have been included To assert correct behaviour,
  25656. and form more meaningful error messages.
  25657. </member>
  25658. <member name="T:NPOI.SS.Formula.IEvaluationWorkbook">
  25659. Abstracts a workbook for the purpose of formula evaluation.<br/>
  25660. For POI internal use only
  25661. @author Josh Micich
  25662. </member>
  25663. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.GetSheetIndex(NPOI.SS.Formula.IEvaluationSheet)">
  25664. @return -1 if the specified sheet is from a different book
  25665. </member>
  25666. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.GetExternalSheet(System.Int32)">
  25667. HSSF Only - fetch the external-style sheet details
  25668. <p>Return will have no workbook set if it's actually in our own workbook</p>
  25669. </member>
  25670. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.GetExternalSheet(System.String,System.String,System.Int32)">
  25671. XSSF Only - fetch the external-style sheet details
  25672. <p>Return will have no workbook set if it's actually in our own workbook</p>
  25673. </member>
  25674. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.ConvertFromExternSheetIndex(System.Int32)">
  25675. HSSF Only - convert an external sheet index to an internal sheet index,
  25676. for an external-style reference to one of this workbook's own sheets
  25677. </member>
  25678. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.GetExternalName(System.Int32,System.Int32)">
  25679. HSSF Only - fetch the external-style name details
  25680. </member>
  25681. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.GetExternalName(System.String,System.String,System.Int32)">
  25682. XSSF Only - fetch the external-style name details
  25683. </member>
  25684. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.ClearAllCachedResultValues">
  25685. Propagated from {@link WorkbookEvaluator#clearAllCachedResultValues()} to clear locally cached data.
  25686. Implementations must call the same method on all referenced {@link EvaluationSheet} instances, as well as clearing local caches.
  25687. @see WorkbookEvaluator#clearAllCachedResultValues()
  25688. </member>
  25689. <member name="T:NPOI.SS.Formula.Eval.AreaEval">
  25690. Evaluation of 2D (Row+Column) and 3D (Sheet+Row+Column) areas
  25691. </member>
  25692. <member name="P:NPOI.SS.Formula.Eval.AreaEval.FirstRow">
  25693. returns the 0-based index of the first row in
  25694. this area.
  25695. </member>
  25696. <member name="P:NPOI.SS.Formula.Eval.AreaEval.LastRow">
  25697. returns the 0-based index of the last row in
  25698. this area.
  25699. </member>
  25700. <member name="P:NPOI.SS.Formula.Eval.AreaEval.FirstColumn">
  25701. returns the 0-based index of the first col in
  25702. this area.
  25703. </member>
  25704. <member name="P:NPOI.SS.Formula.Eval.AreaEval.LastColumn">
  25705. returns the 0-based index of the last col in
  25706. this area.
  25707. </member>
  25708. <member name="M:NPOI.SS.Formula.Eval.AreaEval.Contains(System.Int32,System.Int32)">
  25709. returns true if the cell at row and col specified
  25710. as absolute indexes in the sheet is contained in
  25711. this area.
  25712. @param row
  25713. @param col
  25714. </member>
  25715. <member name="M:NPOI.SS.Formula.Eval.AreaEval.ContainsColumn(System.Int32)">
  25716. returns true if the specified col is in range
  25717. @param col
  25718. </member>
  25719. <member name="M:NPOI.SS.Formula.Eval.AreaEval.ContainsRow(System.Int32)">
  25720. returns true if the specified row is in range
  25721. @param row
  25722. </member>
  25723. <member name="M:NPOI.SS.Formula.Eval.AreaEval.GetAbsoluteValue(System.Int32,System.Int32)">
  25724. @return the ValueEval from within this area at the specified row and col index. Never
  25725. <code>null</code> (possibly {@link BlankEval}). The specified indexes should be absolute
  25726. indexes in the sheet and not relative indexes within the area.
  25727. </member>
  25728. <member name="M:NPOI.SS.Formula.Eval.AreaEval.GetRelativeValue(System.Int32,System.Int32)">
  25729. @return the ValueEval from within this area at the specified relativeRowIndex and
  25730. relativeColumnIndex. Never <c>null</c> (possibly {@link BlankEval}). The
  25731. specified indexes should relative to the top left corner of this area.
  25732. </member>
  25733. <member name="M:NPOI.SS.Formula.Eval.AreaEval.Offset(System.Int32,System.Int32,System.Int32,System.Int32)">
  25734. Creates an {@link AreaEval} offset by a relative amount from from the upper left cell
  25735. of this area
  25736. </member>
  25737. <member name="T:NPOI.SS.Formula.Eval.AreaEvalBase">
  25738. @author Josh Micich
  25739. </member>
  25740. <member name="M:NPOI.SS.Formula.Eval.AreaEvalBase.IsSubTotal(System.Int32,System.Int32)">
  25741. @return whether cell at rowIndex and columnIndex is a subtotal.
  25742. By default return false which means 'don't care about subtotals'
  25743. </member>
  25744. <member name="T:NPOI.SS.Formula.Eval.BlankEval">
  25745. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt; This class is a
  25746. marker class. It is a special value for empty cells.
  25747. </member>
  25748. <member name="T:NPOI.SS.Formula.Eval.BoolEval">
  25749. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  25750. </member>
  25751. <member name="M:NPOI.SS.Formula.Eval.BoolEval.ValueOf(System.Boolean)">
  25752. Convenience method for the following:<br/>
  25753. <c>(b ? BoolEval.TRUE : BoolEval.FALSE)</c>
  25754. @return a <c>BoolEval</c> instance representing <c>b</c>.
  25755. </member>
  25756. <member name="T:NPOI.SS.Formula.Eval.ConcatEval">
  25757. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  25758. </member>
  25759. <member name="T:NPOI.SS.Formula.Eval.ErrorEval">
  25760. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  25761. </member>
  25762. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.NULL_INTERSECTION">
  25763. <b>#NULL!</b> - Intersection of two cell ranges is empty
  25764. </member>
  25765. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.DIV_ZERO">
  25766. <b>#DIV/0!</b> - Division by zero
  25767. </member>
  25768. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.VALUE_INVALID">
  25769. <b>#VALUE!</b> - Wrong type of operand
  25770. </member>
  25771. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.REF_INVALID">
  25772. <b>#REF!</b> - Illegal or deleted cell reference
  25773. </member>
  25774. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.NAME_INVALID">
  25775. <b>#NAME?</b> - Wrong function or range name
  25776. </member>
  25777. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.NUM_ERROR">
  25778. <b>#NUM!</b> - Value range overflow
  25779. </member>
  25780. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.NA">
  25781. <b>#N/A</b> - Argument or function not available
  25782. </member>
  25783. <member name="M:NPOI.SS.Formula.Eval.ErrorEval.ValueOf(System.Int32)">
  25784. Translates an Excel internal error code into the corresponding POI ErrorEval instance
  25785. @param errorCode
  25786. </member>
  25787. <member name="M:NPOI.SS.Formula.Eval.ErrorEval.GetText(System.Int32)">
  25788. Converts error codes to text. Handles non-standard error codes OK.
  25789. For debug/test purposes (and for formatting error messages).
  25790. @return the String representation of the specified Excel error code.
  25791. </member>
  25792. <member name="T:NPOI.SS.Formula.Eval.Eval">
  25793. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  25794. </member>
  25795. <member name="T:NPOI.SS.Formula.Eval.EvaluationException">
  25796. This class is used to simplify error handling logic <i>within</i> operator and function
  25797. implementations. Note - <c>OperationEval.Evaluate()</c> and <c>Function.Evaluate()</c>
  25798. method signatures do not throw this exception so it cannot propagate outside.<p/>
  25799. Here is an example coded without <c>EvaluationException</c>, to show how it can help:
  25800. <pre>
  25801. public Eval Evaluate(Eval[] args, int srcRow, short srcCol) {
  25802. // ...
  25803. Eval arg0 = args[0];
  25804. if(arg0 is ErrorEval) {
  25805. return arg0;
  25806. }
  25807. if(!(arg0 is AreaEval)) {
  25808. return ErrorEval.VALUE_INVALID;
  25809. }
  25810. double temp = 0;
  25811. AreaEval area = (AreaEval)arg0;
  25812. ValueEval[] values = area.LittleEndianConstants.BYTE_SIZE;
  25813. for (int i = 0; i &lt; values.Length; i++) {
  25814. ValueEval ve = values[i];
  25815. if(ve is ErrorEval) {
  25816. return ve;
  25817. }
  25818. if(!(ve is NumericValueEval)) {
  25819. return ErrorEval.VALUE_INVALID;
  25820. }
  25821. temp += ((NumericValueEval)ve).NumberValue;
  25822. }
  25823. // ...
  25824. }
  25825. </pre>
  25826. In this example, if any error is encountered while Processing the arguments, an error is
  25827. returned immediately. This code is difficult to refactor due to all the points where errors
  25828. are returned.<br/>
  25829. Using <c>EvaluationException</c> allows the error returning code to be consolidated to one
  25830. place.<p/>
  25831. <pre>
  25832. public Eval Evaluate(Eval[] args, int srcRow, short srcCol) {
  25833. try {
  25834. // ...
  25835. AreaEval area = GetAreaArg(args[0]);
  25836. double temp = sumValues(area.LittleEndianConstants.BYTE_SIZE);
  25837. // ...
  25838. } catch (EvaluationException e) {
  25839. return e.GetErrorEval();
  25840. }
  25841. }
  25842. private static AreaEval GetAreaArg(Eval arg0){
  25843. if (arg0 is ErrorEval) {
  25844. throw new EvaluationException((ErrorEval) arg0);
  25845. }
  25846. if (arg0 is AreaEval) {
  25847. return (AreaEval) arg0;
  25848. }
  25849. throw EvaluationException.InvalidValue();
  25850. }
  25851. private double sumValues(ValueEval[] values){
  25852. double temp = 0;
  25853. for (int i = 0; i &lt; values.Length; i++) {
  25854. ValueEval ve = values[i];
  25855. if (ve is ErrorEval) {
  25856. throw new EvaluationException((ErrorEval) ve);
  25857. }
  25858. if (!(ve is NumericValueEval)) {
  25859. throw EvaluationException.InvalidValue();
  25860. }
  25861. temp += ((NumericValueEval) ve).NumberValue;
  25862. }
  25863. return temp;
  25864. }
  25865. </pre>
  25866. It is not mandatory to use EvaluationException, doing so might give the following advantages:<br/>
  25867. - Methods can more easily be extracted, allowing for re-use.<br/>
  25868. - Type management (typecasting etc) is simpler because error conditions have been Separated from
  25869. intermediate calculation values.<br/>
  25870. - Fewer local variables are required. Local variables can have stronger types.<br/>
  25871. - It is easier to mimic common Excel error handling behaviour (exit upon encountering first
  25872. error), because exceptions conveniently propagate up the call stack regardless of execution
  25873. points or the number of levels of nested calls.<p/>
  25874. <b>Note</b> - Only standard evaluation errors are represented by <c>EvaluationException</c> (
  25875. i.e. conditions expected to be encountered when evaluating arbitrary Excel formulas). Conditions
  25876. that could never occur in an Excel spReadsheet should result in runtime exceptions. Care should
  25877. be taken to not translate any POI internal error into an Excel evaluation error code.
  25878. @author Josh Micich
  25879. </member>
  25880. <member name="M:NPOI.SS.Formula.Eval.EvaluationException.InvalidValue">
  25881. <b>#VALUE!</b> - Wrong type of operand
  25882. </member>
  25883. <member name="M:NPOI.SS.Formula.Eval.EvaluationException.InvalidRef">
  25884. <b>#REF!</b> - Illegal or deleted cell reference
  25885. </member>
  25886. <member name="M:NPOI.SS.Formula.Eval.EvaluationException.NumberError">
  25887. <b>#NUM!</b> - Value range overflow
  25888. </member>
  25889. <member name="T:NPOI.SS.Formula.Eval.ExternalNameEval">
  25890. Evaluation of a Name defined in a Sheet or Workbook scope
  25891. </member>
  25892. <member name="T:NPOI.SS.Formula.Eval.FunctionEval">
  25893. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  25894. </member>
  25895. <member name="T:NPOI.SS.Formula.Eval.FunctionEval.FunctionID">
  25896. Some function IDs that require special treatment
  25897. </member>
  25898. <member name="F:NPOI.SS.Formula.Eval.FunctionEval.FunctionID.IF">
  25899. 1
  25900. </member>
  25901. <member name="F:NPOI.SS.Formula.Eval.FunctionEval.FunctionID.OFFSET">
  25902. 78
  25903. </member>
  25904. <member name="F:NPOI.SS.Formula.Eval.FunctionEval.FunctionID.CHOOSE">
  25905. 100
  25906. </member>
  25907. <member name="F:NPOI.SS.Formula.Eval.FunctionEval.FunctionID.INDIRECT">
  25908. 148
  25909. </member>
  25910. <member name="F:NPOI.SS.Formula.Eval.FunctionEval.FunctionID.EXTERNAL_FUNC">
  25911. 255
  25912. </member>
  25913. <member name="M:NPOI.SS.Formula.Eval.FunctionEval.ProduceFunctions">
  25914. @see https://www.openoffice.org/sc/excelfileformat.pdf
  25915. </member>
  25916. <member name="M:NPOI.SS.Formula.Eval.FunctionEval.RegisterFunction(System.String,NPOI.SS.Formula.Functions.Function)">
  25917. Register a new function in runtime.
  25918. @param name the function name
  25919. @param func the functoin to register
  25920. @throws ArgumentException if the function is unknown or already registered.
  25921. @since 3.8 beta6
  25922. </member>
  25923. <member name="M:NPOI.SS.Formula.Eval.FunctionEval.GetSupportedFunctionNames">
  25924. Returns a collection of function names implemented by POI.
  25925. @return an array of supported functions
  25926. @since 3.8 beta6
  25927. </member>
  25928. <member name="M:NPOI.SS.Formula.Eval.FunctionEval.GetNotSupportedFunctionNames">
  25929. Returns an array of function names NOT implemented by POI.
  25930. @return an array of not supported functions
  25931. @since 3.8 beta6
  25932. </member>
  25933. <member name="T:NPOI.SS.Formula.Eval.FunctionNameEval">
  25934. @author Josh Micich
  25935. </member>
  25936. <member name="M:NPOI.SS.Formula.Eval.FunctionNameEval.#ctor(System.String)">
  25937. Creates a NameEval representing a function name
  25938. </member>
  25939. <member name="T:NPOI.SS.Formula.Eval.IntersectionEval">
  25940. @author Josh Micich
  25941. </member>
  25942. <member name="M:NPOI.SS.Formula.Eval.IntersectionEval.ResolveRange(NPOI.SS.Formula.Eval.AreaEval,NPOI.SS.Formula.Eval.AreaEval)">
  25943. @return simple rectangular {@link AreaEval} which represents the intersection of areas
  25944. <c>aeA</c> and <c>aeB</c>. If the two areas do not intersect, the result is <code>null</code>.
  25945. </member>
  25946. <member name="T:NPOI.SS.Formula.Eval.NotImplementedFunctionException">
  25947. An exception thrown by implementors of {@link FormulaEvaluator} when
  25948. attempting to evaluate a formula which requires a function that POI
  25949. does not (yet) support.
  25950. </member>
  25951. <member name="T:NPOI.SS.Formula.Eval.NumberEval">
  25952. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  25953. </member>
  25954. <member name="T:NPOI.SS.Formula.Eval.NumericValueEval">
  25955. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  25956. </member>
  25957. <member name="T:NPOI.SS.Formula.Eval.OperandResolver">
  25958. Provides functionality for evaluating arguments to functions and operators.
  25959. @author Josh Micich
  25960. </member>
  25961. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.GetSingleValue(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  25962. Retrieves a single value from a variety of different argument types according to standard
  25963. Excel rules. Does not perform any type conversion.
  25964. @param arg the Evaluated argument as passed to the function or operator.
  25965. @param srcCellRow used when arg is a single column AreaRef
  25966. @param srcCellCol used when arg is a single row AreaRef
  25967. @return a <c>NumberEval</c>, <c>StringEval</c>, <c>BoolEval</c> or <c>BlankEval</c>.
  25968. Never <c>null</c> or <c>ErrorEval</c>.
  25969. @throws EvaluationException(#VALUE!) if srcCellRow or srcCellCol do not properly index into
  25970. an AreaEval. If the actual value retrieved is an ErrorEval, a corresponding
  25971. EvaluationException is thrown.
  25972. </member>
  25973. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.ChooseSingleElementFromArea(NPOI.SS.Formula.Eval.AreaEval,System.Int32,System.Int32)">
  25974. Implements (some perhaps not well known) Excel functionality to select a single cell from an
  25975. area depending on the coordinates of the calling cell. Here is an example demonstrating
  25976. both selection from a single row area and a single column area in the same formula.
  25977. <table border="1" cellpAdding="1" cellspacing="1" summary="sample spReadsheet">
  25978. <tr><th> </th><th> A </th><th> B </th><th> C </th><th> D </th></tr>
  25979. <tr><th>1</th><td>15</td><td>20</td><td>25</td><td> </td></tr>
  25980. <tr><th>2</th><td> </td><td> </td><td> </td><td>200</td></tr>
  25981. <tr><th>3</th><td> </td><td> </td><td> </td><td>300</td></tr>
  25982. <tr><th>3</th><td> </td><td> </td><td> </td><td>400</td></tr>
  25983. </table>
  25984. If the formula "=1000+A1:B1+D2:D3" is put into the 9 cells from A2 to C4, the spReadsheet
  25985. will look like this:
  25986. <table border="1" cellpAdding="1" cellspacing="1" summary="sample spReadsheet">
  25987. <tr><th> </th><th> A </th><th> B </th><th> C </th><th> D </th></tr>
  25988. <tr><th>1</th><td>15</td><td>20</td><td>25</td><td> </td></tr>
  25989. <tr><th>2</th><td>1215</td><td>1220</td><td>#VALUE!</td><td>200</td></tr>
  25990. <tr><th>3</th><td>1315</td><td>1320</td><td>#VALUE!</td><td>300</td></tr>
  25991. <tr><th>4</th><td>#VALUE!</td><td>#VALUE!</td><td>#VALUE!</td><td>400</td></tr>
  25992. </table>
  25993. Note that the row area (A1:B1) does not include column C and the column area (D2:D3) does
  25994. not include row 4, so the values in C1(=25) and D4(=400) are not accessible to the formula
  25995. as written, but in the 4 cells A2:B3, the row and column selection works ok.<p/>
  25996. The same concept is extended to references across sheets, such that even multi-row,
  25997. multi-column areas can be useful.<p/>
  25998. Of course with carefully (or carelessly) chosen parameters, cyclic references can occur and
  25999. hence this method <b>can</b> throw a 'circular reference' EvaluationException. Note that
  26000. this method does not attempt to detect cycles. Every cell in the specified Area <c>ae</c>
  26001. has already been Evaluated prior to this method call. Any cell (or cell<b>s</b>) part of
  26002. <c>ae</c> that would incur a cyclic reference error if selected by this method, will
  26003. already have the value <c>ErrorEval.CIRCULAR_REF_ERROR</c> upon entry to this method. It
  26004. is assumed logic exists elsewhere to produce this behaviour.
  26005. @return whatever the selected cell's Evaluated value Is. Never <c>null</c>. Never
  26006. <c>ErrorEval</c>.
  26007. @if there is a problem with indexing into the area, or if the
  26008. Evaluated cell has an error.
  26009. </member>
  26010. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.ChooseSingleElementFromAreaInternal(NPOI.SS.Formula.Eval.AreaEval,System.Int32,System.Int32)">
  26011. @return possibly <c>ErrorEval</c>, and <c>null</c>
  26012. </member>
  26013. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.CoerceValueToInt(NPOI.SS.Formula.Eval.ValueEval)">
  26014. Applies some conversion rules if the supplied value is not already an integer.<br/>
  26015. Value is first Coerced to a <c>double</c> ( See <c>CoerceValueTodouble()</c> ).<p/>
  26016. Excel typically Converts doubles to integers by truncating toward negative infinity.<br/>
  26017. The equivalent java code Is:<br/>
  26018. <c>return (int)Math.floor(d);</c><br/>
  26019. <b>not</b>:<br/>
  26020. <c>return (int)d; // wrong - rounds toward zero</c>
  26021. </member>
  26022. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.CoerceValueToDouble(NPOI.SS.Formula.Eval.ValueEval)">
  26023. Applies some conversion rules if the supplied value is not already a number.
  26024. Note - <c>BlankEval</c> is not supported and must be handled by the caller.
  26025. @param ev must be a <c>NumberEval</c>, <c>StringEval</c> or <c>BoolEval</c>
  26026. @return actual, Parsed or interpreted double value (respectively).
  26027. @throws EvaluationException(#VALUE!) only if a StringEval is supplied and cannot be Parsed
  26028. as a double (See <c>Parsedouble()</c> for allowable formats).
  26029. @throws Exception if the supplied parameter is not <c>NumberEval</c>,
  26030. <c>StringEval</c> or <c>BoolEval</c>
  26031. </member>
  26032. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.ParseDouble(System.String)">
  26033. Converts a string to a double using standard rules that Excel would use.<br/>
  26034. Tolerates currency prefixes, commas, leading and trailing spaces.<p/>
  26035. Some examples:<br/>
  26036. " 123 " -&gt; 123.0<br/>
  26037. ".123" -&gt; 0.123<br/>
  26038. These not supported yet:<br/>
  26039. " $ 1,000.00 " -&gt; 1000.0<br/>
  26040. "$1.25E4" -&gt; 12500.0<br/>
  26041. "5**2" -&gt; 500<br/>
  26042. "250%" -&gt; 2.5<br/>
  26043. @param text
  26044. @return <c>null</c> if the specified text cannot be Parsed as a number
  26045. </member>
  26046. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.CoerceValueToString(NPOI.SS.Formula.Eval.ValueEval)">
  26047. @param ve must be a <c>NumberEval</c>, <c>StringEval</c>, <c>BoolEval</c>, or <c>BlankEval</c>
  26048. @return the Converted string value. never <c>null</c>
  26049. </member>
  26050. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.CoerceValueToBoolean(NPOI.SS.Formula.Eval.ValueEval,System.Boolean)">
  26051. @return <c>null</c> to represent blank values
  26052. @throws EvaluationException if ve is an ErrorEval, or if a string value cannot be converted
  26053. </member>
  26054. <member name="T:NPOI.SS.Formula.Eval.PercentEval">
  26055. Implementation of Excel formula token '%'. <p/>
  26056. @author Josh Micich
  26057. </member>
  26058. <member name="T:NPOI.SS.Formula.Eval.RangeEval">
  26059. @author Josh Micich
  26060. </member>
  26061. <member name="T:NPOI.SS.Formula.Eval.RefEval">
  26062. @author Amol S Deshmukh &lt; amolweb at ya hoo dot com &gt;
  26063. RefEval is the base interface for Ref2D and Ref3DEval. Basically a RefEval
  26064. impl should contain reference to the original ReferencePtg or Ref3DPtg as
  26065. well as the "value" resulting from the evaluation of the cell
  26066. reference. Thus if the HSSFCell has type CELL_TYPE_NUMERIC, the contained
  26067. value object should be of type NumberEval; if cell type is CELL_TYPE_STRING,
  26068. contained value object should be of type StringEval
  26069. </member>
  26070. <member name="M:NPOI.SS.Formula.Eval.RefEval.GetInnerValueEval(System.Int32)">
  26071. The (possibly Evaluated) ValueEval contained
  26072. in this RefEval. eg. if cell A1 Contains "test"
  26073. then in a formula referring to cell A1
  26074. the RefEval representing
  26075. A1 will return as the InnerValueEval the
  26076. object of concrete type StringEval
  26077. </member>
  26078. <member name="P:NPOI.SS.Formula.Eval.RefEval.Column">
  26079. returns the zero based column index.
  26080. </member>
  26081. <member name="P:NPOI.SS.Formula.Eval.RefEval.Row">
  26082. returns the zero based row index.
  26083. </member>
  26084. <member name="P:NPOI.SS.Formula.Eval.RefEval.NumberOfSheets">
  26085. returns the number of sheets this applies to
  26086. </member>
  26087. <member name="M:NPOI.SS.Formula.Eval.RefEval.Offset(System.Int32,System.Int32,System.Int32,System.Int32)">
  26088. Creates an {@link AreaEval} offset by a relative amount from this RefEval
  26089. </member>
  26090. <member name="T:NPOI.SS.Formula.Eval.EqualEval">
  26091. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  26092. </member>
  26093. <member name="T:NPOI.SS.Formula.Eval.GreaterEqualEval">
  26094. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  26095. </member>
  26096. <member name="T:NPOI.SS.Formula.Eval.GreaterThanEval">
  26097. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  26098. </member>
  26099. <member name="T:NPOI.SS.Formula.Eval.LessEqualEval">
  26100. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  26101. </member>
  26102. <member name="T:NPOI.SS.Formula.Eval.LessThanEval">
  26103. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  26104. </member>
  26105. <member name="T:NPOI.SS.Formula.Eval.NotEqualEval">
  26106. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  26107. </member>
  26108. <member name="T:NPOI.SS.Formula.Eval.RelationalOperationEval">
  26109. @author Amol S. Deshmukh &lt; amolweb at ya hoo Dot com &gt;
  26110. </member>
  26111. <member name="T:NPOI.SS.Formula.Eval.StringEval">
  26112. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  26113. </member>
  26114. <member name="T:NPOI.SS.Formula.Eval.StringValueEval">
  26115. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  26116. </member>
  26117. <member name="P:NPOI.SS.Formula.Eval.StringValueEval.StringValue">
  26118. @return never <code>null</code>, possibly empty string.
  26119. </member>
  26120. <member name="T:NPOI.SS.Formula.Eval.AddEval">
  26121. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  26122. This is a documentation of the observed behaviour of
  26123. the '+' operator in Excel:
  26124. - 1+TRUE = 2
  26125. - 1+FALSE = 1
  26126. - 1+"true" = #VALUE!
  26127. - 1+"1" = 2
  26128. - 1+A1 = #VALUE if A1 Contains "1"
  26129. - 1+A1 = 2 if A1 Contains ="1"
  26130. - 1+A1 = 2 if A1 Contains TRUE or =TRUE
  26131. - 1+A1 = #VALUE! if A1 Contains "TRUE" or ="TRUE"
  26132. </member>
  26133. <member name="T:NPOI.SS.Formula.Eval.DivideEval">
  26134. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  26135. </member>
  26136. <member name="T:NPOI.SS.Formula.Eval.MultiplyEval">
  26137. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  26138. </member>
  26139. <member name="T:NPOI.SS.Formula.Eval.PowerEval">
  26140. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  26141. </member>
  26142. <member name="T:NPOI.SS.Formula.Eval.SubtractEval">
  26143. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  26144. </member>
  26145. <member name="T:NPOI.SS.Formula.Eval.UnaryMinusEval">
  26146. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  26147. </member>
  26148. <member name="T:NPOI.SS.Formula.Eval.UnaryPlusEval">
  26149. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  26150. </member>
  26151. <member name="T:NPOI.SS.Formula.Eval.ValueEval">
  26152. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  26153. </member>
  26154. <member name="T:NPOI.SS.Formula.IExternSheetReferenceToken">
  26155. Should be implemented by any {@link Ptg} subclass that needs Has an extern sheet index <br/>
  26156. For POI internal use only
  26157. @author Josh Micich
  26158. </member>
  26159. <member name="T:NPOI.SS.Formula.Formula">
  26160. Encapsulates an encoded formula token array.
  26161. @author Josh Micich
  26162. </member>
  26163. <member name="F:NPOI.SS.Formula.Formula._byteEncoding">
  26164. immutable
  26165. </member>
  26166. <member name="M:NPOI.SS.Formula.Formula.Read(System.Int32,NPOI.Util.ILittleEndianInput)">
  26167. Convenience method for {@link #read(int, LittleEndianInput, int)}
  26168. </member>
  26169. <member name="M:NPOI.SS.Formula.Formula.Read(System.Int32,NPOI.Util.ILittleEndianInput,System.Int32)">
  26170. When there are no array constants present, <c>encodedTokenLen</c>==<c>totalEncodedLen</c>
  26171. @param encodedTokenLen number of bytes in the stream taken by the plain formula tokens
  26172. @param totalEncodedLen the total number of bytes in the formula (includes trailing encoding
  26173. for array constants, but does not include 2 bytes for initial <c>ushort encodedTokenLen</c> field.
  26174. @return A new formula object as read from the stream. Possibly empty, never <code>null</code>.
  26175. </member>
  26176. <member name="M:NPOI.SS.Formula.Formula.Serialize(NPOI.Util.ILittleEndianOutput)">
  26177. Writes The formula encoding is includes:
  26178. <ul>
  26179. <li>ushort tokenDataLen</li>
  26180. <li>tokenData</li>
  26181. <li>arrayConstantData (if present)</li>
  26182. </ul>
  26183. </member>
  26184. <member name="P:NPOI.SS.Formula.Formula.EncodedSize">
  26185. @return total formula encoding length. The formula encoding includes:
  26186. <ul>
  26187. <li>ushort tokenDataLen</li>
  26188. <li>tokenData</li>
  26189. <li>arrayConstantData (optional)</li>
  26190. </ul>
  26191. Note - this value is different to <c>tokenDataLength</c>
  26192. </member>
  26193. <member name="P:NPOI.SS.Formula.Formula.EncodedTokenSize">
  26194. This method is often used when the formula length does not appear immediately before
  26195. the encoded token data.
  26196. @return the encoded length of the plain formula tokens. This does <em>not</em> include
  26197. the leading ushort field, nor any trailing array constant data.
  26198. </member>
  26199. <member name="M:NPOI.SS.Formula.Formula.Create(NPOI.SS.Formula.PTG.Ptg[])">
  26200. Creates a {@link Formula} object from a supplied {@link Ptg} array.
  26201. Handles <code>null</code>s OK.
  26202. @param ptgs may be <code>null</code>
  26203. @return Never <code>null</code> (Possibly empty if the supplied <c>ptgs</c> is <code>null</code>)
  26204. </member>
  26205. <member name="M:NPOI.SS.Formula.Formula.GetTokens(NPOI.SS.Formula.Formula)">
  26206. Gets the {@link Ptg} array from the supplied {@link Formula}.
  26207. Handles <code>null</code>s OK.
  26208. @param formula may be <code>null</code>
  26209. @return possibly <code>null</code> (if the supplied <c>formula</c> is <code>null</code>)
  26210. </member>
  26211. <member name="P:NPOI.SS.Formula.Formula.ExpReference">
  26212. Gets the locator for the corresponding {@link SharedFormulaRecord}, {@link ArrayRecord} or
  26213. {@link TableRecord} if this formula belongs to such a grouping. The {@link CellReference}
  26214. returned by this method will match the top left corner of the range of that grouping.
  26215. The return value is usually not the same as the location of the cell containing this formula.
  26216. @return the firstRow &amp; firstColumn of an array formula or shared formula that this formula
  26217. belongs to. <code>null</code> if this formula is not part of an array or shared formula.
  26218. </member>
  26219. <member name="T:NPOI.SS.Formula.FormulaCellCache">
  26220. @author Josh Micich
  26221. </member>
  26222. <member name="M:NPOI.SS.Formula.FormulaCellCache.Get(NPOI.SS.Formula.IEvaluationCell)">
  26223. @return <c>null</c> if not found
  26224. </member>
  26225. <member name="T:NPOI.SS.Formula.FormulaCellCacheEntry">
  26226. Stores the cached result of a formula evaluation, along with the Set of sensititive input cells
  26227. </member>
  26228. <member name="F:NPOI.SS.Formula.FormulaCellCacheEntry._sensitiveInputCells">
  26229. Cells 'used' in the current evaluation of the formula corresponding To this cache entry
  26230. If any of the following cells Change, this cache entry needs To be Cleared
  26231. </member>
  26232. <member name="T:NPOI.SS.Formula.FormulaCellCacheEntrySet">
  26233. A custom implementation of {@link java.util.HashSet} in order To reduce memory consumption.
  26234. Profiling tests (Oct 2008) have shown that each element {@link FormulaCellCacheEntry} takes
  26235. around 32 bytes To store in a HashSet, but around 6 bytes To store here. For Spreadsheets with
  26236. thousands of formula cells with multiple interdependencies, the savings can be very significant.
  26237. @author Josh Micich
  26238. </member>
  26239. <member name="T:NPOI.SS.Formula.FormulaParseException">
  26240. <summary>
  26241. Specific exception thrown when a supplied formula does not Parse properly.
  26242. Primarily used by test cases when testing for specific parsing exceptions.
  26243. </summary>
  26244. </member>
  26245. <member name="M:NPOI.SS.Formula.FormulaParseException.#ctor(System.String)">
  26246. <summary>
  26247. This class was given package scope until it would become Clear that it is useful to general client code.
  26248. </summary>
  26249. <param name="msg"></param>
  26250. </member>
  26251. <member name="F:NPOI.SS.Formula.FormulaParser.look">
  26252. Lookahead Character.
  26253. Gets value '\0' when the input string is exhausted
  26254. </member>
  26255. <member name="F:NPOI.SS.Formula.FormulaParser._inIntersection">
  26256. Tracks whether the run of whitespace preceeding "look" could be an
  26257. intersection operator. See GetChar.
  26258. </member>
  26259. <member name="M:NPOI.SS.Formula.FormulaParser.#ctor(System.String,NPOI.SS.Formula.IFormulaParsingWorkbook,System.Int32,System.Int32)">
  26260. Create the formula Parser, with the string that is To be
  26261. Parsed against the supplied workbook.
  26262. A later call the Parse() method To return ptg list in
  26263. rpn order, then call the GetRPNPtg() To retrive the
  26264. Parse results.
  26265. This class is recommended only for single threaded use.
  26266. If you only have a usermodel.HSSFWorkbook, and not a
  26267. model.Workbook, then use the convenience method on
  26268. usermodel.HSSFFormulaEvaluator
  26269. </member>
  26270. <member name="M:NPOI.SS.Formula.FormulaParser.Parse(System.String,NPOI.SS.Formula.IFormulaParsingWorkbook,NPOI.SS.Formula.FormulaType,System.Int32,System.Int32)">
  26271. * Parse a formula into a array of tokens
  26272. * Side effect: creates name (Workbook.createName) if formula contains unrecognized names (names are likely UDFs)
  26273. *
  26274. * @param formula the formula to parse
  26275. * @param workbook the parent workbook
  26276. * @param formulaType the type of the formula, see {@link FormulaType}
  26277. * @param sheetIndex the 0-based index of the sheet this formula belongs to.
  26278. * @param rowIndex - the related cell's row index in 0-based form (-1 if the formula is not cell related)
  26279. * used to handle structured references that have the "#This Row" quantifier.
  26280. * The sheet index is required to resolve sheet-level names. <code>-1</code> means that
  26281. * the scope of the name will be ignored and the parser will match names only by name
  26282. *
  26283. * @return array of parsed tokens
  26284. * @throws FormulaParseException if the formula is unparsable
  26285. </member>
  26286. <member name="M:NPOI.SS.Formula.FormulaParser.ParseStructuredReference(System.String,NPOI.SS.Formula.IFormulaParsingWorkbook,System.Int32)">
  26287. Parse a structured reference. Converts the structured
  26288. reference to the area that represent it.
  26289. @param tableText - The structured reference text
  26290. @param workbook - the parent workbook
  26291. @param rowIndex - the 0-based cell's row index ( used to handle "#This Row" quantifiers )
  26292. @return the area that being represented by the structured reference.
  26293. </member>
  26294. <member name="M:NPOI.SS.Formula.FormulaParser.GetChar">
  26295. Read New Character From Input Stream
  26296. </member>
  26297. <member name="M:NPOI.SS.Formula.FormulaParser.expected(System.String)">
  26298. Report What Was Expected
  26299. </member>
  26300. <member name="M:NPOI.SS.Formula.FormulaParser.IsAlpha(System.Char)">
  26301. Recognize an Alpha Character
  26302. </member>
  26303. <member name="M:NPOI.SS.Formula.FormulaParser.IsDigit(System.Char)">
  26304. Recognize a Decimal Digit
  26305. </member>
  26306. <member name="M:NPOI.SS.Formula.FormulaParser.IsAlNum(System.Char)">
  26307. Recognize an Alphanumeric
  26308. </member>
  26309. <member name="M:NPOI.SS.Formula.FormulaParser.IsWhite(System.Char)">
  26310. Recognize White Space
  26311. </member>
  26312. <member name="M:NPOI.SS.Formula.FormulaParser.SkipWhite">
  26313. Skip Over Leading White Space
  26314. </member>
  26315. <member name="M:NPOI.SS.Formula.FormulaParser.Match(System.Char)">
  26316. Consumes the next input character if it is equal To the one specified otherwise throws an
  26317. unchecked exception. This method does <b>not</b> consume whitespace (before or after the
  26318. matched character).
  26319. </member>
  26320. <member name="M:NPOI.SS.Formula.FormulaParser.GetNum">
  26321. Get a Number
  26322. </member>
  26323. <member name="M:NPOI.SS.Formula.FormulaParser.NeedsMemFunc(NPOI.SS.Formula.ParseNode)">
  26324. From OOO doc: "Whenever one operand of the reference subexpression is a function,
  26325. a defined name, a 3D reference, or an external reference (and no error occurs),
  26326. a tMemFunc token is used"
  26327. </member>
  26328. <member name="M:NPOI.SS.Formula.FormulaParser.IsValidDefinedNameChar(System.Char)">
  26329. @return <c>true</c> if the specified character may be used in a defined name
  26330. </member>
  26331. <member name="M:NPOI.SS.Formula.FormulaParser.CheckValidRangeOperand(System.String,System.Int32,NPOI.SS.Formula.ParseNode)">
  26332. @param currentParsePosition used to format a potential error message
  26333. </member>
  26334. <member name="M:NPOI.SS.Formula.FormulaParser.IsValidRangeOperand(NPOI.SS.Formula.ParseNode)">
  26335. @return false if sub-expression represented the specified ParseNode definitely
  26336. cannot appear on either side of the range (':') operator
  26337. </member>
  26338. <member name="M:NPOI.SS.Formula.FormulaParser.ParseRangeable">
  26339. Parses area refs (things which could be the operand of ':') and simple factors
  26340. Examples
  26341. <pre>
  26342. A$1
  26343. $A$1 : $B1
  26344. A1 ....... C2
  26345. Sheet1 !$A1
  26346. a..b!A1
  26347. 'my sheet'!A1
  26348. .my.sheet!A1
  26349. 'my sheet':'my alt sheet'!A1
  26350. .my.sheet1:.my.sheet2!$B$2
  26351. my.named..range.
  26352. 'my sheet'!my.named.range
  26353. .my.sheet!my.named.range
  26354. foo.bar(123.456, "abc")
  26355. 123.456
  26356. "abc"
  26357. true
  26358. [Foo.xls]!$A$1
  26359. [Foo.xls]'my sheet'!$A$1
  26360. [Foo.xls]!my.named.range
  26361. </pre>
  26362. </member>
  26363. <member name="M:NPOI.SS.Formula.FormulaParser.ParseStructuredReference(System.String)">
  26364. Parses a structured reference, returns it as area reference.
  26365. Examples:
  26366. <pre>
  26367. Table1[col]
  26368. Table1[[#Totals],[col]]
  26369. Table1[#Totals]
  26370. Table1[#All]
  26371. Table1[#Data]
  26372. Table1[#Headers]
  26373. Table1[#Totals]
  26374. Table1[#This Row]
  26375. Table1[[#All],[col]]
  26376. Table1[[#Headers],[col]]
  26377. Table1[[#Totals],[col]]
  26378. Table1[[#All],[col1]:[col2]]
  26379. Table1[[#Data],[col1]:[col2]]
  26380. Table1[[#Headers],[col1]:[col2]]
  26381. Table1[[#Totals],[col1]:[col2]]
  26382. Table1[[#Headers],[#Data],[col2]]
  26383. Table1[[#This Row], [col1]]
  26384. Table1[ [col1]:[col2] ]
  26385. </pre>
  26386. @param tableName
  26387. @return
  26388. </member>
  26389. <member name="M:NPOI.SS.Formula.FormulaParser.ParseAsColumnQuantifier">
  26390. Tries to parse the next as column - can contain whitespace
  26391. Caller should save pointer.
  26392. @return
  26393. </member>
  26394. <member name="M:NPOI.SS.Formula.FormulaParser.ParseAsSpecialQuantifier">
  26395. Tries to parse the next as special quantifier
  26396. Caller should save pointer.
  26397. @return
  26398. </member>
  26399. <member name="M:NPOI.SS.Formula.FormulaParser.ParseNonRange(System.Int32)">
  26400. Parses simple factors that are not primitive ranges or range components
  26401. i.e. '!', ':'(and equiv '...') do not appear
  26402. Examples
  26403. <pre>
  26404. my.named...range.
  26405. foo.bar(123.456, "abc")
  26406. 123.456
  26407. "abc"
  26408. true
  26409. </pre>
  26410. </member>
  26411. <member name="M:NPOI.SS.Formula.FormulaParser.CreateAreaRefParseNode(NPOI.SS.Formula.SheetIdentifier,NPOI.SS.Formula.FormulaParser.SimpleRangePart,NPOI.SS.Formula.FormulaParser.SimpleRangePart)">
  26412. @param sheetIden may be <code>null</code>
  26413. @param part1
  26414. @param part2 may be <code>null</code>
  26415. </member>
  26416. <member name="M:NPOI.SS.Formula.FormulaParser.ParseSimpleRangePart">
  26417. Parses out a potential LHS or RHS of a ':' intended to produce a plain AreaRef. Normally these are
  26418. proper cell references but they could also be row or column refs like "$AC" or "10"
  26419. @return <code>null</code> (and leaves {@link #_pointer} unchanged if a proper range part does not parse out
  26420. </member>
  26421. <member name="M:NPOI.SS.Formula.FormulaParser.ReduceRangeExpression(NPOI.SS.Formula.PTG.Ptg,NPOI.SS.Formula.PTG.Ptg)">
  26422. "A1", "B3" -> "A1:B3"
  26423. "sheet1!A1", "B3" -> "sheet1!A1:B3"
  26424. @return <c>null</c> if the range expression cannot / shouldn't be reduced.
  26425. </member>
  26426. <member name="T:NPOI.SS.Formula.FormulaParser.SimpleRangePart">
  26427. A1, $A1, A$1, $A$1, A, 1
  26428. </member>
  26429. <member name="M:NPOI.SS.Formula.FormulaParser.SimpleRangePart.IsCompatibleForArea(NPOI.SS.Formula.FormulaParser.SimpleRangePart)">
  26430. @return <c>true</c> if the two range parts can be combined in an
  26431. {@link AreaPtg} ( Note - the explicit range operator (:) may still be valid
  26432. when this method returns <c>false</c> )
  26433. </member>
  26434. <member name="M:NPOI.SS.Formula.FormulaParser.ParseSheetName">
  26435. Note - caller should reset {@link #_pointer} upon <code>null</code> result
  26436. @return The sheet name as an identifier <code>null</code> if '!' is not found in the right place
  26437. </member>
  26438. <member name="M:NPOI.SS.Formula.FormulaParser.ParseSheetRange(System.String,NPOI.SS.Formula.NameIdentifier)">
  26439. If we have something that looks like [book]Sheet1: or
  26440. Sheet1, see if it's actually a range eg Sheet1:Sheet2!
  26441. </member>
  26442. <member name="M:NPOI.SS.Formula.FormulaParser.IsUnquotedSheetNameChar(System.Char)">
  26443. very similar to {@link SheetNameFormatter#isSpecialChar(char)}
  26444. </member>
  26445. <member name="M:NPOI.SS.Formula.FormulaParser.IsValidCellReference(System.String)">
  26446. @return <c>true</c> if the specified name is a valid cell reference
  26447. </member>
  26448. <member name="M:NPOI.SS.Formula.FormulaParser.Function(System.String)">
  26449. Note - Excel Function names are 'case aware but not case sensitive'. This method may end
  26450. up creating a defined name record in the workbook if the specified name is not an internal
  26451. Excel Function, and Has not been encountered before.
  26452. Side effect: creates workbook name if name is not recognized (name is probably a UDF)
  26453. @param name case preserved Function name (as it was entered/appeared in the formula).
  26454. </member>
  26455. <member name="M:NPOI.SS.Formula.FormulaParser.AddName(System.String)">
  26456. Adds a name (named range or user defined function) to underlying workbook's names table
  26457. @param functionName
  26458. </member>
  26459. <member name="M:NPOI.SS.Formula.FormulaParser.GetFunction(System.String,NPOI.SS.Formula.PTG.Ptg,NPOI.SS.Formula.ParseNode[])">
  26460. * Generates the variable Function ptg for the formula.
  26461. *
  26462. * For IF Formulas, Additional PTGs are Added To the Tokens
  26463. * @param name a {@link NamePtg} or {@link NameXPtg} or <code>null</code>
  26464. * @return Ptg a null is returned if we're in an IF formula, it needs extreme manipulation and is handled in this Function
  26465. </member>
  26466. <member name="M:NPOI.SS.Formula.FormulaParser.Arguments">
  26467. Get arguments To a Function
  26468. </member>
  26469. <member name="M:NPOI.SS.Formula.FormulaParser.PowerFactor">
  26470. Parse and Translate a Math Factor
  26471. </member>
  26472. <member name="M:NPOI.SS.Formula.FormulaParser.ParseSimpleFactor">
  26473. factors (without ^ or % )
  26474. </member>
  26475. <member name="M:NPOI.SS.Formula.FormulaParser.GetNumberPtgFromString(System.String,System.String,System.String)">
  26476. Get a PTG for an integer from its string representation.
  26477. return Int or Number Ptg based on size of input
  26478. </member>
  26479. <member name="M:NPOI.SS.Formula.FormulaParser.Term">
  26480. Parse and Translate a Math Term
  26481. </member>
  26482. <member name="M:NPOI.SS.Formula.FormulaParser.AdditiveExpression">
  26483. Parse and Translate an Expression
  26484. </member>
  26485. <member name="M:NPOI.SS.Formula.FormulaParser.Parse">
  26486. API call To execute the parsing of the formula
  26487. </member>
  26488. <member name="T:NPOI.SS.Formula.IFormulaParsingWorkbook">
  26489. Abstracts a workbook for the purpose of formula parsing.<br/>
  26490. For POI internal use only
  26491. @author Josh Micich
  26492. </member>
  26493. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetName(System.String,System.Int32)">
  26494. <summary>
  26495. named range name matching is case insensitive
  26496. </summary>
  26497. <param name="name">The name.</param>
  26498. <param name="sheetIndex">Index of the sheet.</param>
  26499. <returns></returns>
  26500. </member>
  26501. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.CreateName">
  26502. <summary>
  26503. Return the underlying workbook
  26504. </summary>
  26505. <returns></returns>
  26506. </member>
  26507. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetTable(System.String)">
  26508. <summary>
  26509. XSSF Only - gets a table that exists in the worksheet
  26510. </summary>
  26511. <param name="name"></param>
  26512. <returns></returns>
  26513. </member>
  26514. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetNameXPtg(System.String,NPOI.SS.Formula.SheetIdentifier)">
  26515. <summary>
  26516. Return an external name (named range, function, user-defined function) Ptg
  26517. </summary>
  26518. <param name="name">The name.</param>
  26519. <param name="sheet"></param>
  26520. <returns></returns>
  26521. </member>
  26522. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.Get3DReferencePtg(NPOI.SS.Util.CellReference,NPOI.SS.Formula.SheetIdentifier)">
  26523. <summary>
  26524. Produce the appropriate Ptg for a 3d cell reference
  26525. </summary>
  26526. <param name="cell"></param>
  26527. <param name="sheet"></param>
  26528. <returns></returns>
  26529. </member>
  26530. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.Get3DReferencePtg(NPOI.SS.Util.AreaReference,NPOI.SS.Formula.SheetIdentifier)">
  26531. <summary>
  26532. Produce the appropriate Ptg for a 3d area reference
  26533. </summary>
  26534. <param name="area"></param>
  26535. <param name="sheet"></param>
  26536. <returns></returns>
  26537. </member>
  26538. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetExternalSheetIndex(System.String)">
  26539. <summary>
  26540. Gets the externSheet index for a sheet from this workbook
  26541. </summary>
  26542. <param name="sheetName">Name of the sheet.</param>
  26543. <returns></returns>
  26544. </member>
  26545. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetExternalSheetIndex(System.String,System.String)">
  26546. <summary>
  26547. Gets the externSheet index for a sheet from an external workbook
  26548. </summary>
  26549. <param name="workbookName">Name of the workbook, e.g. "BudGet.xls"</param>
  26550. <param name="sheetName">a name of a sheet in that workbook</param>
  26551. <returns></returns>
  26552. </member>
  26553. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetSpreadsheetVersion">
  26554. <summary>
  26555. Returns an enum holding spReadhseet properties specific to an Excel version (
  26556. max column and row numbers, max arguments to a function, etc.)
  26557. </summary>
  26558. <returns></returns>
  26559. </member>
  26560. <member name="T:NPOI.SS.Formula.FormulaRenderer">
  26561. Common logic for rendering formulas.<br/>
  26562. For POI internal use only
  26563. @author Josh Micich
  26564. </member>
  26565. <member name="M:NPOI.SS.Formula.FormulaRenderer.ToFormulaString(NPOI.SS.Formula.IFormulaRenderingWorkbook,NPOI.SS.Formula.PTG.Ptg[])">
  26566. Static method To convert an array of {@link Ptg}s in RPN order
  26567. To a human readable string format in infix mode.
  26568. @param book used for defined names and 3D references
  26569. @param ptgs must not be <c>null</c>
  26570. @return a human readable String
  26571. </member>
  26572. <member name="T:NPOI.SS.Formula.IFormulaRenderingWorkbook">
  26573. Abstracts a workbook for the purpose of converting formula To text.<br/>
  26574. For POI internal use only
  26575. @author Josh Micich
  26576. </member>
  26577. <member name="M:NPOI.SS.Formula.IFormulaRenderingWorkbook.GetExternalSheet(System.Int32)">
  26578. @return <c>null</c> if externSheetIndex refers To a sheet inside the current workbook
  26579. </member>
  26580. <member name="M:NPOI.SS.Formula.IFormulaRenderingWorkbook.GetSheetFirstNameByExternSheet(System.Int32)">
  26581. @return the name of the (first) sheet referred to by the given external sheet index
  26582. </member>
  26583. <member name="M:NPOI.SS.Formula.IFormulaRenderingWorkbook.GetSheetLastNameByExternSheet(System.Int32)">
  26584. @return the name of the (last) sheet referred to by the given external sheet index
  26585. </member>
  26586. <member name="T:NPOI.SS.Formula.FormulaType">
  26587. Enumeration of various formula types.<br/>
  26588. For POI internal use only
  26589. @author Josh Micich
  26590. </member>
  26591. <member name="T:NPOI.SS.Formula.FormulaUsedBlankCellSet">
  26592. Optimisation - compacts many blank cell references used by a single formula.
  26593. @author Josh Micich
  26594. </member>
  26595. <member name="T:NPOI.SS.Formula.Functions.Address">
  26596. Creates a text reference as text, given specified row and column numbers.
  26597. @author Aniket Banerjee (banerjee@google.com)
  26598. </member>
  26599. <member name="P:NPOI.SS.Formula.Functions.SubtotalInstance.IsSubtotalCounted">
  26600. ignore nested subtotals.
  26601. </member>
  26602. <member name="T:NPOI.SS.Formula.Functions.Percentile">
  26603. Returns the k-th percentile of values in a range. You can use this function to establish a threshold of
  26604. acceptance. For example, you can decide to examine candidates who score above the 90th percentile.
  26605. PERCENTILE(array,k)
  26606. Array is the array or range of data that defines relative standing.
  26607. K is the percentile value in the range 0..1, inclusive.
  26608. <strong>Remarks</strong>
  26609. <ul>
  26610. <li>if array is empty or Contains more than 8,191 data points, PERCENTILE returns the #NUM! error value.</li>
  26611. <li>If k is nonnumeric, PERCENTILE returns the #VALUE! error value.</li>
  26612. <li>If k is &lt; 0 or if k &gt; 1, PERCENTILE returns the #NUM! error value.</li>
  26613. <li>If k is not a multiple of 1/(n - 1), PERCENTILE interpolates to determine the value at the k-th percentile.</li>
  26614. </ul>
  26615. </member>
  26616. <member name="T:NPOI.SS.Formula.Functions.AggregateFunction">
  26617. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  26618. </member>
  26619. <member name="T:NPOI.SS.Formula.Functions.AverageIf">
  26620. Implementation for the Excel function SUMIF<p>
  26621. Syntax : <br/>
  26622. AVERAGEIF ( <b>range</b>, <b>criteria</b>, avg_range ) <br/>
  26623. <table border="0" cellpadding="1" cellspacing="0" summary="Parameter descriptions">
  26624. <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>
  26625. <tr><th>criteria</th><td>The value or expression used to filter rows from <b>range</b></td></tr>
  26626. <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>
  26627. </table><br/>
  26628. </p>
  26629. @author Josh Micich
  26630. </member>
  26631. <member name="T:NPOI.SS.Formula.Functions.AverageIfs">
  26632. Implementation for the Excel function AverageIfs<br/>
  26633. <p>
  26634. Syntax : <br/>
  26635. AverageIfs ( <b>average_range</b>, <b>criteria_range1</b>, <b>criteria1</b>,
  26636. [<b>criteria_range2</b>, <b>criteria2</b>], ...) <br/>
  26637. <ul>
  26638. <li><b>average_range</b> Required. One or more cells to get the average, including numbers or names, ranges,
  26639. or cell references that contain numbers. Blank and text values are ignored.</li>
  26640. <li><b>criteria1_range</b> Required. The first range in which
  26641. to evaluate the associated criteria.</li>
  26642. <li><b>criteria1</b> Required. The criteria in the form of a number, expression,
  26643. cell reference, or text that define which cells in the criteria_range1
  26644. argument will be counted</li>
  26645. <li><b> criteria_range2, criteria2, ...</b> Optional. Additional ranges and their associated criteria.
  26646. Up to 127 range/criteria pairs are allowed.</li>
  26647. </ul>
  26648. </p>
  26649. @author Yegor Kozlov
  26650. </member>
  26651. <member name="M:NPOI.SS.Formula.Functions.AverageIfs.ValidateCriteriaRanges(NPOI.SS.Formula.Eval.AreaEval[],NPOI.SS.Formula.Eval.AreaEval)">
  26652. Verify that each <code>criteriaRanges</code> argument contains the same number of rows and columns
  26653. as the <code>avgRange</code> argument
  26654. @throws EvaluationException if
  26655. </member>
  26656. <member name="M:NPOI.SS.Formula.Functions.AverageIfs.GetAvgFromMatchingCells(NPOI.SS.Formula.Eval.AreaEval[],NPOI.SS.Formula.Functions.IMatchPredicate[],NPOI.SS.Formula.Eval.AreaEval)">
  26657. @param ranges criteria ranges, each range must be of the same dimensions as <code>aeAvg</code>
  26658. @param predicates array of predicates, a predicate for each value in <code>ranges</code>
  26659. @param aeAvg the range to calculate
  26660. @return the computed value
  26661. </member>
  26662. <member name="T:NPOI.SS.Formula.Functions.BaseNumberUtils">
  26663. <p>Some utils for Converting from and to any base</p>
  26664. @author cedric dot walter @ gmail dot com
  26665. </member>
  26666. <member name="T:NPOI.SS.Formula.Functions.Bin2Dec">
  26667. Implementation for Excel Bin2Dec() function.<p/>
  26668. <p/>
  26669. <b>Syntax</b>:<br/> <b>Bin2Dec </b>(<b>number</b>)<br/>
  26670. <p/>
  26671. Converts a binary number to decimal.
  26672. <p/>
  26673. Number is the binary number you want to convert. Number cannot contain more than 10 characters (10 bits).
  26674. The most significant bit of number is the sign bit. The remaining 9 bits are magnitude bits.
  26675. Negative numbers are represented using two's-complement notation.
  26676. <p/>
  26677. Remark
  26678. If number is not a valid binary number, or if number contains more than 10 characters (10 bits),
  26679. BIN2DEC returns the #NUM! error value.
  26680. @author cedric dot walter @ gmail dot com
  26681. </member>
  26682. <member name="T:NPOI.SS.Formula.Functions.BooleanFunction">
  26683. Here are the general rules concerning Boolean functions:
  26684. <ol>
  26685. <li> Blanks are ignored (not either true or false) </li>
  26686. <li> Strings are ignored if part of an area ref or cell ref, otherwise they must be 'true' or 'false'</li>
  26687. <li> Numbers: 0 is false. Any other number is TRUE </li>
  26688. <li> Areas: *all* cells in area are evaluated according to the above rules</li>
  26689. </ol>
  26690. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  26691. </member>
  26692. <member name="T:NPOI.SS.Formula.Functions.False">
  26693. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  26694. </member>
  26695. <member name="T:NPOI.SS.Formula.Functions.True">
  26696. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  26697. </member>
  26698. <member name="T:NPOI.SS.Formula.Functions.CalendarFieldFunction">
  26699. Implementation of Excel functions Date parsing functions:
  26700. Date - DAY, MONTH and YEAR
  26701. Time - HOUR, MINUTE and SECOND
  26702. @author Others (not mentioned in code)
  26703. @author Thies Wellpott
  26704. </member>
  26705. <member name="T:NPOI.SS.Formula.Functions.Ceiling">
  26706. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  26707. </member>
  26708. <member name="T:NPOI.SS.Formula.Functions.Choose">
  26709. @author Josh Micich
  26710. </member>
  26711. <member name="T:NPOI.SS.Formula.Functions.Code">
  26712. Implementation for Excel CODE () function.<p/>
  26713. <p/>
  26714. <b>Syntax</b>:<br/> <b>CODE </b>(<b>text</b> )<br/>
  26715. <p/>
  26716. Returns a numeric code for the first character in a text string. The returned code corresponds to the character set used by your computer.
  26717. <p/>
  26718. text The text for which you want the code of the first character.
  26719. @author cedric dot walter @ gmail dot com
  26720. </member>
  26721. <member name="T:NPOI.SS.Formula.Functions.Columns">
  26722. Implementation for Excel COLUMNS function.
  26723. @author Josh Micich
  26724. </member>
  26725. <member name="T:NPOI.SS.Formula.Functions.Combin">
  26726. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  26727. </member>
  26728. <member name="T:NPOI.SS.Formula.Functions.Complex">
  26729. Implementation for Excel COMPLEX () function.<p/>
  26730. <p/>
  26731. <b>Syntax</b>:<br/> <b>COMPLEX </b>(<b>real_num</b>,<b>i_num</b>,<b>suffix </b> )<br/>
  26732. <p/>
  26733. Converts real and imaginary coefficients into a complex number of the form x + yi or x + yj.
  26734. <p/>
  26735. <p/>
  26736. All complex number functions accept "i" and "j" for suffix, but neither "I" nor "J".
  26737. Using uppercase results in the #VALUE! error value. All functions that accept two
  26738. or more complex numbers require that all suffixes match.
  26739. <p/>
  26740. <b>real_num</b> The real coefficient of the complex number.
  26741. If this argument is nonnumeric, this function returns the #VALUE! error value.
  26742. <p/>
  26743. <p/>
  26744. <b>i_num</b> The imaginary coefficient of the complex number.
  26745. If this argument is nonnumeric, this function returns the #VALUE! error value.
  26746. <p/>
  26747. <p/>
  26748. <b>suffix</b> The suffix for the imaginary component of the complex number.
  26749. <ul>
  26750. <li>If omitted, suffix is assumed to be "i".</li>
  26751. <li>If suffix is neither "i" nor "j", COMPLEX returns the #VALUE! error value.</li>
  26752. </ul>
  26753. @author cedric dot walter @ gmail dot com
  26754. </member>
  26755. <member name="T:NPOI.SS.Formula.Functions.Count">
  26756. Counts the number of cells that contain numeric data within
  26757. the list of arguments.
  26758. Excel Syntax
  26759. COUNT(value1,value2,...)
  26760. Value1, value2, ... are 1 to 30 arguments representing the values or ranges to be Counted.
  26761. TODO: Check this properly Matches excel on edge cases
  26762. like formula cells, error cells etc
  26763. </member>
  26764. <member name="M:NPOI.SS.Formula.Functions.Count.SubtotalInstance">
  26765. Create an instance of Count to use in {@link Subtotal}
  26766. <p>
  26767. If there are other subtotals within argument refs (or nested subtotals),
  26768. these nested subtotals are ignored to avoid double counting.
  26769. </p>
  26770. @see Subtotal
  26771. </member>
  26772. <member name="T:NPOI.SS.Formula.Functions.Counta">
  26773. Counts the number of cells that contain data within the list of arguments.
  26774. Excel Syntax
  26775. COUNTA(value1,value2,...)
  26776. Value1, value2, ... are 1 to 30 arguments representing the values or ranges to be Counted.
  26777. @author Josh Micich
  26778. </member>
  26779. <member name="M:NPOI.SS.Formula.Functions.Counta.SubtotalPredicate.Matches(NPOI.SS.Formula.TwoDEval,System.Int32,System.Int32)">
  26780. don't count cells that are subtotals
  26781. </member>
  26782. <member name="T:NPOI.SS.Formula.Functions.Countblank">
  26783. Implementation for the function COUNTBLANK
  26784. <p>
  26785. Syntax: COUNTBLANK ( range )
  26786. <table border="0" cellpadding="1" cellspacing="0" summary="Parameter descriptions">
  26787. <tr><th>range </th><td>is the range of cells to count blanks</td></tr>
  26788. </table>
  26789. </p>
  26790. @author Mads Mohr Christensen
  26791. </member>
  26792. <member name="T:NPOI.SS.Formula.Functions.Countif">
  26793. Implementation for the function COUNTIF<p/>
  26794. Syntax: COUNTIF ( range, criteria )
  26795. <table border="0" cellpAdding="1" cellspacing="0" summary="Parameter descriptions">
  26796. <tr><th>range </th><td>is the range of cells to be Counted based on the criteria</td></tr>
  26797. <tr><th>criteria</th><td>is used to determine which cells to Count</td></tr>
  26798. </table>
  26799. <p/>
  26800. @author Josh Micich
  26801. </member>
  26802. <member name="M:NPOI.SS.Formula.Functions.Countif.CountMatchingCellsInArea(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Functions.IMatchPredicate)">
  26803. @return the number of evaluated cells in the range that match the specified criteria
  26804. </member>
  26805. <member name="M:NPOI.SS.Formula.Functions.Countif.EvaluateCriteriaArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  26806. @return the de-referenced criteria arg (possibly {@link ErrorEval})
  26807. </member>
  26808. <member name="M:NPOI.SS.Formula.Functions.Countif.CreateGeneralMatchPredicate(NPOI.SS.Formula.Eval.StringEval)">
  26809. When the second argument is a string, many things are possible
  26810. </member>
  26811. <member name="M:NPOI.SS.Formula.Functions.Countif.CreateCriteriaPredicate(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  26812. Creates a criteria predicate object for the supplied criteria arg
  26813. @return <code>null</code> if the arg evaluates to blank.
  26814. </member>
  26815. <member name="M:NPOI.SS.Formula.Functions.Countif.ParseBoolean(System.String)">
  26816. bool literals ('TRUE', 'FALSE') treated similarly but NOT same as numbers.
  26817. </member>
  26818. <member name="P:NPOI.SS.Formula.Functions.CmpOp.Length">
  26819. @return number of characters used to represent this operator
  26820. </member>
  26821. <member name="M:NPOI.SS.Formula.Functions.StringMatcher.GetWildCardPattern(System.String)">
  26822. <summary>
  26823. Translates Excel countif wildcard strings into .NET regex strings
  26824. </summary>
  26825. <param name="value">Excel wildcard expression</param>
  26826. <returns>return null if the specified value contains no special wildcard characters.</returns>
  26827. </member>
  26828. <member name="T:NPOI.SS.Formula.Functions.Countifs">
  26829. Implementation for the function COUNTIFS
  26830. <p>
  26831. Syntax: COUNTIFS(criteria_range1, criteria1, [criteria_range2, criteria2])
  26832. </p>
  26833. </member>
  26834. <member name="T:NPOI.SS.Formula.Functions.IMatchPredicate">
  26835. Common interface for the matching criteria.
  26836. </member>
  26837. <member name="T:NPOI.SS.Formula.Functions.CountUtils">
  26838. Common logic for COUNT, COUNTA and COUNTIF
  26839. @author Josh Micich
  26840. </member>
  26841. <member name="M:NPOI.SS.Formula.Functions.CountUtils.CountMatchingCellsInRef(NPOI.SS.Formula.Eval.RefEval,NPOI.SS.Formula.Functions.IMatchPredicate)">
  26842. @return the number of evaluated cells in the range that match the specified criteria
  26843. </member>
  26844. <member name="M:NPOI.SS.Formula.Functions.CountUtils.CountMatchingCellsInArea(NPOI.SS.Formula.ThreeDEval,NPOI.SS.Formula.Functions.IMatchPredicate)">
  26845. @return the number of evaluated cells in the range that match the specified criteria
  26846. </member>
  26847. <member name="T:NPOI.SS.Formula.Functions.DateFunc">
  26848. @author Pavel Krupets (pkrupets at palmtreebusiness dot com)
  26849. </member>
  26850. <member name="M:NPOI.SS.Formula.Functions.DateFunc.Evaluate(System.Int32,System.Int32,System.Int32)">
  26851. * Note - works with Java Calendar months, not Excel months
  26852. * Java Calendar month = Excel month + 1
  26853. </member>
  26854. <member name="T:NPOI.SS.Formula.Functions.Days360">
  26855. <p>Calculates the number of days between two dates based on a 360-day year
  26856. (twelve 30-day months), which is used in some accounting calculations. Use
  26857. this function to help compute payments if your accounting system is based on
  26858. twelve 30-day months.</p>
  26859. {@code DAYS360(start_date,end_date,[method])}
  26860. <ul>
  26861. <li>Start_date, end_date (required):<br/>
  26862. The two dates between which you want to know the number of days.<br/>
  26863. If start_date occurs after end_date, the DAYS360 function returns a negative number.</li>
  26864. <li>Method (optional):<br/>
  26865. A logical value that specifies whether to use the U.S. or European method in the calculation</li>
  26866. <li>Method set to false or omitted:<br/>
  26867. the DAYS360 function uses the U.S. (NASD) method. If the starting date is the 31st of a month,
  26868. it becomes equal to the 30th of the same month. If the ending date is the 31st of a month and
  26869. the starting date is earlier than the 30th of a month, the ending date becomes equal to the
  26870. 1st of the next month, otherwise the ending date becomes equal to the 30th of the same month.
  26871. The month February and leap years are handled in the following way:<br/>
  26872. On a non-leap year the function {@code =DAYS360("2/28/93", "3/1/93", FALSE)} returns 1 day
  26873. because the DAYS360 function ignores the extra days added to February.<br/>
  26874. On a leap year the function {@code =DAYS360("2/29/96","3/1/96", FALSE)} returns 1 day for
  26875. the same reason.</li>
  26876. <li>Method Set to true:<br/>
  26877. When you set the method parameter to TRUE, the DAYS360 function uses the European method.
  26878. Starting dates or ending dates that occur on the 31st of a month become equal to the 30th of
  26879. the same month. The month February and leap years are handled in the following way:<br/>
  26880. On a non-leap year the function {@code =DAYS360("2/28/93", "3/1/93", TRUE)} returns
  26881. 3 days because the DAYS360 function is counting the extra days added to February to give
  26882. February 30 days.<br/>
  26883. On a leap year the function {@code =DAYS360("2/29/96", "3/1/96", TRUE)} returns
  26884. 2 days for the same reason.</li>
  26885. </ul>
  26886. @see <a href="https://support.microsoft.com/en-us/kb/235575">DAYS360 Function Produces Different Values Depending on the Version of Excel</a>
  26887. </member>
  26888. <member name="T:NPOI.SS.Formula.Functions.Dec2Bin">
  26889. Implementation for Excel Bin2Dec() function.<p/>
  26890. <p/>
  26891. <b>Syntax</b>:<br/> <b>Bin2Dec </b>(<b>number</b>,<b>[places]</b> )<br/>
  26892. <p/>
  26893. Converts a decimal number to binary.
  26894. <p/>
  26895. The DEC2BIN function syntax has the following arguments:
  26896. <ul>
  26897. <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>
  26898. <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>
  26899. </ul>
  26900. <p/>
  26901. Remarks
  26902. <ul>
  26903. <li>If number &lt; -512 or if number &gt; 511, DEC2BIN returns the #NUM! error value.</li>
  26904. <li>If number is nonnumeric, DEC2BIN returns the #VALUE! error value.</li>
  26905. <li>If DEC2BIN requires more than places characters, it returns the #NUM! error value.</li>
  26906. <li>If places is not an integer, it is tRuncated.</li>
  26907. <li>If places is nonnumeric, DEC2BIN returns the #VALUE! error value.</li>
  26908. <li>If places is zero or negative, DEC2BIN returns the #NUM! error value.</li>
  26909. </ul>
  26910. @author cedric dot walter @ gmail dot com
  26911. </member>
  26912. <member name="T:NPOI.SS.Formula.Functions.Dec2Hex">
  26913. Implementation for Excel DELTA() function.<p/>
  26914. <p/>
  26915. <b>Syntax</b>:<br/> <b>DEC2HEX </b>(<b>number</b>,<b>places</b> )<br/>
  26916. <p/>
  26917. Converts a decimal number to hexadecimal.
  26918. The decimal integer you want to Convert. If number is negative, places is ignored
  26919. and this function returns a 10-character (40-bit) hexadecimal number in which the
  26920. most significant bit is the sign bit. The remaining 39 bits are magnitude bits.
  26921. Negative numbers are represented using two's-complement notation.
  26922. <ul>
  26923. <li>If number &lt; -549,755,813,888 or if number &gt; 549,755,813,887, this function returns the #NUM! error value.</li>
  26924. <li>If number is nonnumeric, this function returns the #VALUE! error value.</li>
  26925. </ul>
  26926. <h2>places</h2>
  26927. The number of characters to use. The places argument is useful for pAdding the
  26928. return value with leading 0s (zeros).
  26929. <ul>
  26930. <li>If this argument is omitted, this function uses the minimum number of characters necessary.</li>
  26931. <li>If this function requires more than places characters, it returns the #NUM! error value.</li>
  26932. <li>If this argument is nonnumeric, this function returns the #VALUE! error value.</li>
  26933. <li>If this argument is negative, this function returns the #NUM! error value.</li>
  26934. <li>If this argument Contains a decimal value, this function ignores the numbers to the right side of the decimal point.</li>
  26935. </ul>
  26936. @author cedric dot walter @ gmail dot com
  26937. </member>
  26938. <member name="T:NPOI.SS.Formula.Functions.Degrees">
  26939. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  26940. </member>
  26941. <member name="T:NPOI.SS.Formula.Functions.Delta">
  26942. Implementation for Excel DELTA() function.<p/>
  26943. <p/>
  26944. <b>Syntax</b>:<br/> <b>DELTA </b>(<b>number1</b>,<b>number2</b> )<br/>
  26945. <p/>
  26946. Tests whether two values are Equal. Returns 1 if number1 = number2; returns 0 otherwise.
  26947. Use this function to filter a Set of values. For example, by summing several DELTA functions
  26948. you calculate the count of equal pairs. This function is also known as the Kronecker Delta function.
  26949. <ul>
  26950. <li>If number1 is nonnumeric, DELTA returns the #VALUE! error value.</li>
  26951. <li>If number2 is nonnumeric, DELTA returns the #VALUE! error value.</li>
  26952. </ul>
  26953. @author cedric dot walter @ gmail dot com
  26954. </member>
  26955. <member name="T:NPOI.SS.Formula.Functions.DGet">
  26956. Implementation of the DGet function:
  26957. Finds the value of a column in an area with given conditions.
  26958. TODO:
  26959. - wildcards ? and * in string conditions
  26960. - functions as conditions
  26961. </member>
  26962. <member name="T:NPOI.SS.Formula.Functions.DMin">
  26963. Implementation of the DMin function:
  26964. Finds the minimum value of a column in an area with given conditions.
  26965. TODO:
  26966. - wildcards ? and * in string conditions
  26967. - functions as conditions
  26968. </member>
  26969. <member name="T:NPOI.SS.Formula.Functions.Dollar">
  26970. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  26971. </member>
  26972. <member name="T:NPOI.SS.Formula.Functions.DStarRunner">
  26973. This class performs a D* calculation. It takes an {@link IDStarAlgorithm} object and
  26974. uses it for calculating the result value. Iterating a database and Checking the
  26975. entries against the Set of conditions is done here.
  26976. </member>
  26977. <member name="M:NPOI.SS.Formula.Functions.DStarRunner.GetColumnForName(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Eval.AreaEval)">
  26978. @param nameValueEval Must not be a RefEval or AreaEval. Thus make sure resolveReference() is called on the value first!
  26979. @param db
  26980. @return
  26981. @throws EvaluationException
  26982. </member>
  26983. <member name="M:NPOI.SS.Formula.Functions.DStarRunner.GetColumnForString(NPOI.SS.Formula.Eval.AreaEval,System.String)">
  26984. For a given database returns the column number for a column heading.
  26985. @param db Database.
  26986. @param name Column heading.
  26987. @return Corresponding column number.
  26988. @If it's not possible to turn all headings into strings.
  26989. </member>
  26990. <member name="M:NPOI.SS.Formula.Functions.DStarRunner.FullFillsConditions(NPOI.SS.Formula.Eval.AreaEval,System.Int32,NPOI.SS.Formula.Eval.AreaEval)">
  26991. Checks a row in a database against a condition database.
  26992. @param db Database.
  26993. @param row The row in the database to Check.
  26994. @param cdb The condition database to use for Checking.
  26995. @return Whether the row matches the conditions.
  26996. @If references could not be Resolved or comparison
  26997. operators and operands didn't match.
  26998. </member>
  26999. <member name="M:NPOI.SS.Formula.Functions.DStarRunner.testNormalCondition(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Eval.ValueEval)">
  27000. Test a value against a simple (&lt; &gt; &lt;= &gt;= = starts-with) condition string.
  27001. @param value The value to Check.
  27002. @param condition The condition to check for.
  27003. @return Whether the condition holds.
  27004. @If comparison operator and operands don't match.
  27005. </member>
  27006. <member name="M:NPOI.SS.Formula.Functions.DStarRunner.testNumericCondition(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Functions.DStarRunner.Operator,System.String)">
  27007. Test whether a value matches a numeric condition.
  27008. @param valueEval Value to Check.
  27009. @param op Comparator to use.
  27010. @param condition Value to check against.
  27011. @return whether the condition holds.
  27012. @If it's impossible to turn the condition into a number.
  27013. </member>
  27014. <member name="M:NPOI.SS.Formula.Functions.DStarRunner.ResolveReference(NPOI.SS.Formula.Eval.AreaEval,System.Int32,System.Int32)">
  27015. Resolve a ValueEval that's in an AreaEval.
  27016. @param db AreaEval from which the cell to resolve is retrieved.
  27017. @param dbRow Relative row in the AreaEval.
  27018. @param dbCol Relative column in the AreaEval.
  27019. @return A ValueEval that is a NumberEval, StringEval, BoolEval, BlankEval or ErrorEval.
  27020. </member>
  27021. <member name="T:NPOI.SS.Formula.Functions.EDate">
  27022. Implementation of Excel 'Analysis ToolPak' function EDATE()<br/>
  27023. Adds a specified number of months to the specified date.<p/>
  27024. <b>Syntax</b><br/>
  27025. <b>EDATE</b>(<b>date</b>, <b>number</b>)
  27026. <p/>
  27027. @author Tomas Herceg
  27028. </member>
  27029. <member name="T:NPOI.SS.Formula.Functions.EOMonth">
  27030. Implementation for the Excel EOMONTH() function.<p/>
  27031. <p/>
  27032. EOMONTH() returns the date of the last day of a month..<p/>
  27033. <p/>
  27034. <b>Syntax</b>:<br/>
  27035. <b>EOMONTH</b>(<b>start_date</b>,<b>months</b>)<p/>
  27036. <p/>
  27037. <b>start_date</b> is the starting date of the calculation
  27038. <b>months</b> is the number of months to be Added to <b>start_date</b>,
  27039. to give a new date. For this new date, <b>EOMONTH</b> returns the date of
  27040. the last day of the month. <b>months</b> may be positive (in the future),
  27041. zero or negative (in the past).
  27042. </member>
  27043. <member name="T:NPOI.SS.Formula.Functions.Errortype">
  27044. Implementation for the ERROR.TYPE() Excel function.
  27045. <p>
  27046. <b>Syntax:</b><br/>
  27047. <b>ERROR.TYPE</b>(<b>errorValue</b>)</p>
  27048. <p>
  27049. Returns a number corresponding to the error type of the supplied argument.</p>
  27050. <p>
  27051. <table border="1" cellpadding="1" cellspacing="1" summary="Return values for ERROR.TYPE()">
  27052. <tr><td>errorValue</td><td>Return Value</td></tr>
  27053. <tr><td>#NULL!</td><td>1</td></tr>
  27054. <tr><td>#DIV/0!</td><td>2</td></tr>
  27055. <tr><td>#VALUE!</td><td>3</td></tr>
  27056. <tr><td>#REF!</td><td>4</td></tr>
  27057. <tr><td>#NAME?</td><td>5</td></tr>
  27058. <tr><td>#NUM!</td><td>6</td></tr>
  27059. <tr><td>#N/A!</td><td>7</td></tr>
  27060. <tr><td>everything else</td><td>#N/A!</td></tr>
  27061. </table>
  27062. Note - the results of ERROR.TYPE() are different to the constants defined in
  27063. <tt>ErrorConstants</tt>.
  27064. </p>
  27065. @author Josh Micich
  27066. </member>
  27067. <member name="T:NPOI.SS.Formula.Functions.Even">
  27068. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  27069. </member>
  27070. <member name="T:NPOI.SS.Formula.Functions.Exp">
  27071. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  27072. </member>
  27073. <member name="T:NPOI.SS.Formula.Functions.Fact">
  27074. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  27075. </member>
  27076. <member name="T:NPOI.SS.Formula.Functions.FactDouble">
  27077. Implementation for Excel FACTDOUBLE() function.<p/>
  27078. <p/>
  27079. <b>Syntax</b>:<br/> <b>FACTDOUBLE </b>(<b>number</b>)<br/>
  27080. <p/>
  27081. Returns the double factorial of a number.
  27082. <p/>
  27083. Number is the value for which to return the double factorial. If number is not an integer, it is truncated.
  27084. <p/>
  27085. Remarks
  27086. <ul>
  27087. <li>If number is nonnumeric, FACTDOUBLE returns the #VALUE! error value.</li>
  27088. <li>If number is negative, FACTDOUBLE returns the #NUM! error value.</li>
  27089. </ul>
  27090. Use a cache for more speed of previously calculated factorial
  27091. @author cedric dot walter @ gmail dot com
  27092. </member>
  27093. <member name="T:NPOI.SS.Formula.Functions.Finance">
  27094. Implementation of the financial functions pmt, fv, ppmt, ipmt.
  27095. @author Mike Argyriou micharg@gmail.com
  27096. </member>
  27097. <member name="M:NPOI.SS.Formula.Functions.Finance.PMT(System.Double,System.Int32,System.Double,System.Double,System.Int32)">
  27098. Emulates Excel/Calc's PMT(interest_rate, number_payments, PV, FV, Type)
  27099. function, which calculates the payments for a loan or the future value of an investment
  27100. @param r
  27101. - periodic interest rate represented as a decimal.
  27102. @param nper
  27103. - number of total payments / periods.
  27104. @param pv
  27105. - present value -- borrowed or invested principal.
  27106. @param fv
  27107. - future value of loan or annuity.
  27108. @param type
  27109. - when payment is made: beginning of period is 1; end, 0.
  27110. @return <code>double</code> representing periodic payment amount.
  27111. </member>
  27112. <member name="M:NPOI.SS.Formula.Functions.Finance.PMT(System.Double,System.Int32,System.Double,System.Double)">
  27113. Overloaded pmt() call omitting type, which defaults to 0.
  27114. @see #pmt(double, int, double, double, int)
  27115. </member>
  27116. <member name="M:NPOI.SS.Formula.Functions.Finance.PMT(System.Double,System.Int32,System.Double)">
  27117. Overloaded pmt() call omitting fv and type, which both default to 0.
  27118. @see #pmt(double, int, double, double, int)
  27119. </member>
  27120. <member name="M:NPOI.SS.Formula.Functions.Finance.IPMT(System.Double,System.Int32,System.Int32,System.Double,System.Double,System.Int32)">
  27121. Emulates Excel/Calc's IPMT(interest_rate, period, number_payments, PV,
  27122. FV, Type) function, which calculates the portion of the payment at a
  27123. given period that is the interest on previous balance.
  27124. @param r
  27125. - periodic interest rate represented as a decimal.
  27126. @param per
  27127. - period (payment number) to check value at.
  27128. @param nper
  27129. - number of total payments / periods.
  27130. @param pv
  27131. - present value -- borrowed or invested principal.
  27132. @param fv
  27133. - future value of loan or annuity.
  27134. @param type
  27135. - when payment is made: beginning of period is 1; end, 0.
  27136. @return <code>double</code> representing interest portion of payment.
  27137. @see #pmt(double, int, double, double, int)
  27138. @see #fv(double, int, double, double, int)
  27139. </member>
  27140. <member name="M:NPOI.SS.Formula.Functions.Finance.PPMT(System.Double,System.Int32,System.Int32,System.Double,System.Double,System.Int32)">
  27141. Emulates Excel/Calc's PPMT(interest_rate, period, number_payments, PV,
  27142. FV, Type) function, which calculates the portion of the payment at a
  27143. given period that will apply to principal.
  27144. @param r
  27145. - periodic interest rate represented as a decimal.
  27146. @param per
  27147. - period (payment number) to check value at.
  27148. @param nper
  27149. - number of total payments / periods.
  27150. @param pv
  27151. - present value -- borrowed or invested principal.
  27152. @param fv
  27153. - future value of loan or annuity.
  27154. @param type
  27155. - when payment is made: beginning of period is 1; end, 0.
  27156. @return <code>double</code> representing principal portion of payment.
  27157. @see #pmt(double, int, double, double, int)
  27158. @see #ipmt(double, int, int, double, double, bool)
  27159. </member>
  27160. <member name="M:NPOI.SS.Formula.Functions.Finance.FV(System.Double,System.Int32,System.Double,System.Double,System.Int32)">
  27161. Emulates Excel/Calc's FV(interest_rate, number_payments, payment, PV,
  27162. Type) function, which calculates future value or principal at period N.
  27163. @param r
  27164. - periodic interest rate represented as a decimal.
  27165. @param nper
  27166. - number of total payments / periods.
  27167. @param pmt
  27168. - periodic payment amount.
  27169. @param pv
  27170. - present value -- borrowed or invested principal.
  27171. @param type
  27172. - when payment is made: beginning of period is 1; end, 0.
  27173. @return <code>double</code> representing future principal value.
  27174. </member>
  27175. <member name="M:NPOI.SS.Formula.Functions.Finance.FV(System.Double,System.Int32,System.Double,System.Double)">
  27176. Overloaded fv() call omitting type, which defaults to 0.
  27177. @see #fv(double, int, double, double, int)
  27178. </member>
  27179. <member name="T:NPOI.SS.Formula.Functions.FinanceFunction">
  27180. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  27181. Super class for all Evals for financial function evaluation.
  27182. </member>
  27183. <member name="T:NPOI.SS.Formula.Functions.FinanceLib">
  27184. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  27185. This class Is a functon library for common fiscal functions.
  27186. <b>Glossary of terms/abbreviations:</b>
  27187. <br/>
  27188. <ul>
  27189. <li><em>FV:</em> Future Value</li>
  27190. <li><em>PV:</em> Present Value</li>
  27191. <li><em>NPV:</em> Net Present Value</li>
  27192. <li><em>PMT:</em> (Periodic) Payment</li>
  27193. </ul>
  27194. For more info on the terms/abbreviations please use the references below
  27195. (hyperlinks are subject to Change):
  27196. <br/>Online References:
  27197. <ol>
  27198. <li>GNU Emacs Calc 2.02 Manual: http://theory.uwinnipeg.ca/gnu/calc/calc_203.html</li>
  27199. <li>Yahoo Financial Glossary: http://biz.yahoo.com/f/g/nn.html#y</li>
  27200. <li>MS Excel function reference: http://office.microsoft.com/en-us/assistance/CH062528251033.aspx</li>
  27201. </ol>
  27202. <h3>Implementation Notes:</h3>
  27203. Symbols used in the formulae that follow:<br/>
  27204. <ul>
  27205. <li>p: present value</li>
  27206. <li>f: future value</li>
  27207. <li>n: number of periods</li>
  27208. <li>y: payment (in each period)</li>
  27209. <li>r: rate</li>
  27210. <li>^: the power operator (NOT the java bitwise XOR operator!)</li>
  27211. </ul>
  27212. [From MS Excel function reference] Following are some of the key formulas
  27213. that are used in this implementation:
  27214. <pre>
  27215. p(1+r)^n + y(1+rt)((1+r)^n-1)/r + f=0 ...{when r!=0}
  27216. ny + p + f=0 ...{when r=0}
  27217. </pre>
  27218. </member>
  27219. <member name="M:NPOI.SS.Formula.Functions.FinanceLib.fv(System.Double,System.Double,System.Double,System.Double,System.Boolean)">
  27220. Future value of an amount given the number of payments, rate, amount
  27221. of individual payment, present value and bool value indicating whether
  27222. payments are due at the beginning of period
  27223. (false => payments are due at end of period)
  27224. @param r rate
  27225. @param n num of periods
  27226. @param y pmt per period
  27227. @param p future value
  27228. @param t type (true=pmt at end of period, false=pmt at begining of period)
  27229. </member>
  27230. <member name="M:NPOI.SS.Formula.Functions.FinanceLib.pv(System.Double,System.Double,System.Double,System.Double,System.Boolean)">
  27231. Present value of an amount given the number of future payments, rate, amount
  27232. of individual payment, future value and bool value indicating whether
  27233. payments are due at the beginning of period
  27234. (false => payments are due at end of period)
  27235. @param r
  27236. @param n
  27237. @param y
  27238. @param f
  27239. @param t
  27240. </member>
  27241. <member name="M:NPOI.SS.Formula.Functions.FinanceLib.npv(System.Double,System.Double[])">
  27242. calculates the Net Present Value of a principal amount
  27243. given the disCount rate and a sequence of cash flows
  27244. (supplied as an array). If the amounts are income the value should
  27245. be positive, else if they are payments and not income, the
  27246. value should be negative.
  27247. @param r
  27248. @param cfs cashflow amounts
  27249. </member>
  27250. <member name="M:NPOI.SS.Formula.Functions.FinanceLib.pmt(System.Double,System.Double,System.Double,System.Double,System.Boolean)">
  27251. @param r
  27252. @param n
  27253. @param p
  27254. @param f
  27255. @param t
  27256. </member>
  27257. <member name="M:NPOI.SS.Formula.Functions.FinanceLib.nper(System.Double,System.Double,System.Double,System.Double,System.Boolean)">
  27258. @param r
  27259. @param y
  27260. @param p
  27261. @param f
  27262. @param t
  27263. </member>
  27264. <member name="T:NPOI.SS.Formula.Functions.Fixed0ArgFunction">
  27265. Convenience base class for functions that only take zero arguments.
  27266. @author Josh Micich
  27267. </member>
  27268. <member name="T:NPOI.SS.Formula.Functions.Fixed1ArgFunction">
  27269. Convenience base class for functions that must take exactly one argument.
  27270. @author Josh Micich
  27271. </member>
  27272. <member name="T:NPOI.SS.Formula.Functions.Fixed2ArgFunction">
  27273. Convenience base class for functions that must take exactly two arguments.
  27274. @author Josh Micich
  27275. </member>
  27276. <member name="T:NPOI.SS.Formula.Functions.Fixed3ArgFunction">
  27277. Convenience base class for functions that must take exactly three arguments.
  27278. @author Josh Micich
  27279. </member>
  27280. <member name="T:NPOI.SS.Formula.Functions.Floor">
  27281. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  27282. </member>
  27283. <member name="T:NPOI.SS.Formula.Functions.FreeRefFunction">
  27284. For most Excel functions, involving references ((cell, area), (2d, 3d)), the references are
  27285. passed in as arguments, and the exact location remains fixed. However, a select few Excel
  27286. functions have the ability to access cells that were not part of any reference passed as an
  27287. argument.<br/>
  27288. Two important functions with this feature are <b>INDIRECT</b> and <b>OFFSet</b><p/>
  27289. In POI, the <c>HSSFFormulaEvaluator</c> Evaluates every cell in each reference argument before
  27290. calling the function. This means that functions using fixed references do not need access to
  27291. the rest of the workbook to execute. Hence the <c>Evaluate()</c> method on the common
  27292. interface <c>Function</c> does not take a workbook parameter.
  27293. This interface recognises the requirement of some functions to freely Create and Evaluate
  27294. references beyond those passed in as arguments.
  27295. @author Josh Micich
  27296. </member>
  27297. <member name="M:NPOI.SS.Formula.Functions.FreeRefFunction.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],NPOI.SS.Formula.OperationEvaluationContext)">
  27298. @param args the pre-Evaluated arguments for this function. args is never <code>null</code>,
  27299. nor are any of its elements.
  27300. @param ec primarily used to identify the source cell Containing the formula being Evaluated.
  27301. may also be used to dynamically create reference evals.
  27302. @return never <code>null</code>. Possibly an instance of <c>ErrorEval</c> in the case of
  27303. a specified Excel error (Exceptions are never thrown to represent Excel errors).
  27304. </member>
  27305. <member name="T:NPOI.SS.Formula.Functions.Function">
  27306. <summary>
  27307. Function serves as a marker interface.
  27308. </summary>
  27309. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  27310. </member>
  27311. <member name="M:NPOI.SS.Formula.Functions.Function.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],System.Int32,System.Int32)">
  27312. <summary>
  27313. Evaluates the specified args.
  27314. </summary>
  27315. <param name="args">the evaluated function arguments. Empty values are represented with BlankEval or MissingArgEval</param>
  27316. <param name="srcRowIndex">row index of the cell containing the formula under evaluation</param>
  27317. <param name="srcColumnIndex">column index of the cell containing the formula under evaluation</param>
  27318. <returns></returns>
  27319. </member>
  27320. <member name="T:NPOI.SS.Formula.Functions.Function0Arg">
  27321. Implemented by all functions that can be called with zero arguments
  27322. @author Josh Micich
  27323. </member>
  27324. <member name="M:NPOI.SS.Formula.Functions.Function0Arg.Evaluate(System.Int32,System.Int32)">
  27325. see {@link Function#Evaluate(ValueEval[], int, int)}
  27326. </member>
  27327. <member name="T:NPOI.SS.Formula.Functions.Function1Arg">
  27328. Implemented by all functions that can be called with one argument
  27329. @author Josh Micich
  27330. </member>
  27331. <member name="M:NPOI.SS.Formula.Functions.Function1Arg.Evaluate(System.Int32,System.Int32,NPOI.SS.Formula.Eval.ValueEval)">
  27332. see {@link Function#Evaluate(ValueEval[], int, int)}
  27333. </member>
  27334. <member name="T:NPOI.SS.Formula.Functions.Function2Arg">
  27335. Implemented by all functions that can be called with two arguments
  27336. @author Josh Micich
  27337. </member>
  27338. <member name="M:NPOI.SS.Formula.Functions.Function2Arg.Evaluate(System.Int32,System.Int32,NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Eval.ValueEval)">
  27339. see {@link Function#Evaluate(ValueEval[], int, int)}
  27340. </member>
  27341. <member name="T:NPOI.SS.Formula.Functions.Function3Arg">
  27342. Implemented by all functions that can be called with three arguments
  27343. @author Josh Micich
  27344. </member>
  27345. <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)">
  27346. see {@link Function#Evaluate(ValueEval[], int, int)}
  27347. </member>
  27348. <member name="T:NPOI.SS.Formula.Functions.Function4Arg">
  27349. Implemented by all functions that can be called with four arguments
  27350. @author Josh Micich
  27351. </member>
  27352. <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)">
  27353. see {@link Function#Evaluate(ValueEval[], int, int)}
  27354. </member>
  27355. <member name="T:NPOI.SS.Formula.Functions.Hex2Dec">
  27356. Implementation for Excel HEX2DEC() function.<p/>
  27357. <p/>
  27358. <b>Syntax</b>:<br/> <b>HEX2DEC </b>(<b>number</b>)<br/>
  27359. <p/>
  27360. Converts a hexadecimal number to decimal.
  27361. <p/>
  27362. Number is the hexadecimal number you want to Convert. Number cannot contain more than 10 characters (40 bits).
  27363. The most significant bit of number is the sign bit.
  27364. The remaining 39 bits are magnitude bits. Negative numbers are represented using two's-complement notation.
  27365. Remark
  27366. If number is not a valid hexadecimal number, HEX2DEC returns the #NUM! error value.
  27367. @author cedric dot walter @ gmail dot com
  27368. </member>
  27369. <member name="T:NPOI.SS.Formula.Functions.Hlookup">
  27370. Implementation of the HLOOKUP() function.<p/>
  27371. HLOOKUP Finds a column in a lookup table by the first row value and returns the value from another row.<br/>
  27372. <b>Syntax</b>:<br/>
  27373. <b>HLOOKUP</b>(<b>lookup_value</b>, <b>table_array</b>, <b>row_index_num</b>, range_lookup)<p/>
  27374. <b>lookup_value</b> The value to be found in the first column of the table array.<br/>
  27375. <b>table_array</b> An area reference for the lookup data. <br/>
  27376. <b>row_index_num</b> a 1 based index specifying which row value of the lookup data will be returned.<br/>
  27377. <b>range_lookup</b> If TRUE (default), HLOOKUP Finds the largest value less than or equal to
  27378. the lookup_value. If FALSE, only exact Matches will be considered<br/>
  27379. @author Josh Micich
  27380. </member>
  27381. <member name="M:NPOI.SS.Formula.Functions.Hlookup.CreateResultColumnVector(NPOI.SS.Formula.Eval.AreaEval,System.Int32)">
  27382. Returns one column from an <c>AreaEval</c>
  27383. @(#VALUE!) if colIndex Is negative, (#REF!) if colIndex Is too high
  27384. </member>
  27385. <member name="T:NPOI.SS.Formula.Functions.Hyperlink">
  27386. Implementation of Excel HYPERLINK function.<p/>
  27387. In Excel this function has special behaviour - it causes the displayed cell value to behave like
  27388. a hyperlink in the GUI. From an evaluation perspective however, it is very simple.<p/>
  27389. <b>Syntax</b>:<br/>
  27390. <b>HYPERLINK</b>(<b>link_location</b>, friendly_name)<p/>
  27391. <b>link_location</b> The URL of the hyperlink <br/>
  27392. <b>friendly_name</b> (optional) the value to display<p/>
  27393. Returns last argument. Leaves type unchanged (does not convert to {@link org.apache.poi.ss.formula.eval.StringEval}).
  27394. @author Wayne Clingingsmith
  27395. </member>
  27396. <member name="T:NPOI.SS.Formula.Functions.IDStarAlgorithm">
  27397. Interface specifying how an algorithm to be used by {@link DStarRunner} should look like.
  27398. Each implementing class should correspond to one of the D* functions.
  27399. </member>
  27400. <member name="M:NPOI.SS.Formula.Functions.IDStarAlgorithm.ProcessMatch(NPOI.SS.Formula.Eval.ValueEval)">
  27401. Process a match that is found during a run through a database.
  27402. @param eval ValueEval of the cell in the matching row. References will already be Resolved.
  27403. @return Whether we should continue iterating through the database.
  27404. </member>
  27405. <member name="P:NPOI.SS.Formula.Functions.IDStarAlgorithm.Result">
  27406. Return a result ValueEval that will be the result of the calculation.
  27407. This is always called at the end of a run through the database.
  27408. @return a ValueEval
  27409. </member>
  27410. <member name="T:NPOI.SS.Formula.Functions.IfFunc">
  27411. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  27412. </member>
  27413. <member name="T:NPOI.SS.Formula.Functions.Imaginary">
  27414. Implementation for Excel IMAGINARY() function.<p/>
  27415. <p/>
  27416. <b>Syntax</b>:<br/> <b>IMAGINARY </b>(<b>Inumber</b>)<br/>
  27417. <p/>
  27418. Returns the imaginary coefficient of a complex number in x + yi or x + yj text format.
  27419. <p/>
  27420. Inumber is a complex number for which you want the imaginary coefficient.
  27421. <p/>
  27422. Remarks
  27423. <ul>
  27424. <li>Use COMPLEX to convert real and imaginary coefficients into a complex number.</li>
  27425. </ul>
  27426. @author cedric dot walter @ gmail dot com
  27427. </member>
  27428. <member name="T:NPOI.SS.Formula.Functions.ImReal">
  27429. Implementation for Excel ImReal() function.<p/>
  27430. <p/>
  27431. <b>Syntax</b>:<br/> <b>ImReal </b>(<b>Inumber</b>)<br/>
  27432. <p/>
  27433. Returns the real coefficient of a complex number in x + yi or x + yj text format.
  27434. <p/>
  27435. Inumber A complex number for which you want the real coefficient.
  27436. <p/>
  27437. Remarks
  27438. <ul>
  27439. <li>If inumber is not in the form x + yi or x + yj, this function returns the #NUM! error value.</li>
  27440. <li>Use COMPLEX to convert real and imaginary coefficients into a complex number.</li>
  27441. </ul>
  27442. @author cedric dot walter @ gmail dot com
  27443. </member>
  27444. <member name="T:NPOI.SS.Formula.Functions.Index">
  27445. Implementation for the Excel function INDEX
  27446. Syntax : <br/>
  27447. INDEX ( reference, row_num[, column_num [, area_num]])<br/>
  27448. INDEX ( array, row_num[, column_num])
  27449. <table border="0" cellpAdding="1" cellspacing="0" summary="Parameter descriptions">
  27450. <tr><th>reference</th><td>typically an area reference, possibly a union of areas</td></tr>
  27451. <tr><th>array</th><td>a literal array value (currently not supported)</td></tr>
  27452. <tr><th>row_num</th><td>selects the row within the array or area reference</td></tr>
  27453. <tr><th>column_num</th><td>selects column within the array or area reference. default Is 1</td></tr>
  27454. <tr><th>area_num</th><td>used when reference Is a union of areas</td></tr>
  27455. </table>
  27456. @author Josh Micich
  27457. </member>
  27458. <member name="M:NPOI.SS.Formula.Functions.Index.GetValueFromArea(NPOI.SS.Formula.Eval.AreaEval,System.Int32,System.Int32,System.Boolean,System.Int32,System.Int32)">
  27459. @param colArgWasPassed <c>false</c> if the INDEX argument lIst had just 2 items
  27460. (exactly 1 comma). If anything Is passed for the <c>column_num</c> argument
  27461. (including {@link BlankEval} or {@link MIssingArgEval}) this parameter will be
  27462. <c>true</c>. ThIs parameter is needed because error codes are slightly
  27463. different when only 2 args are passed.
  27464. </member>
  27465. <member name="M:NPOI.SS.Formula.Functions.Index.ResolveIndexArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  27466. @param arg a 1-based index.
  27467. @return the Resolved 1-based index. Zero if the arg was missing or blank
  27468. @throws EvaluationException if the arg Is an error value evaluates to a negative numeric value
  27469. </member>
  27470. <member name="T:NPOI.SS.Formula.Functions.Indirect">
  27471. Implementation for Excel function INDIRECT<p/>
  27472. INDIRECT() returns the cell or area reference denoted by the text argument.<p/>
  27473. <b>Syntax</b>:<br/>
  27474. <b>INDIRECT</b>(<b>ref_text</b>,isA1Style)<p/>
  27475. <b>ref_text</b> a string representation of the desired reference as it would normally be written
  27476. in a cell formula.<br/>
  27477. <b>isA1Style</b> (default TRUE) specifies whether the ref_text should be interpreted as A1-style
  27478. or R1C1-style.
  27479. @author Josh Micich
  27480. </member>
  27481. <member name="M:NPOI.SS.Formula.Functions.Indirect.ParseWorkbookAndSheetName(System.String)">
  27482. @return array of length 2: {workbookName, sheetName,}. Second element will always be
  27483. present. First element may be null if sheetName is unqualified.
  27484. Returns <code>null</code> if text cannot be parsed.
  27485. </member>
  27486. <member name="M:NPOI.SS.Formula.Functions.Indirect.UnescapeString(System.String)">
  27487. @return <code>null</code> if there is a syntax error in any escape sequence
  27488. (the typical syntax error is a single quote character not followed by another).
  27489. </member>
  27490. <member name="T:NPOI.SS.Formula.Functions.Int">
  27491. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  27492. </member>
  27493. <member name="T:NPOI.SS.Formula.Functions.Intercept">
  27494. Implementation of Excel function INTERCEPT()<p/>
  27495. Calculates the INTERCEPT of the linear regression line that is used to predict y values from x values<br/>
  27496. (http://introcs.cs.princeton.edu/java/97data/LinearRegression.java.html)
  27497. <b>Syntax</b>:<br/>
  27498. <b>INTERCEPT</b>(<b>arrayX</b>, <b>arrayY</b>)<p/>
  27499. @author Johan Karlsteen
  27500. </member>
  27501. <member name="T:NPOI.SS.Formula.Functions.Irr">
  27502. Calculates the internal rate of return.
  27503. Syntax is IRR(values) or IRR(values,guess)
  27504. @author Marcel May
  27505. @author Yegor Kozlov
  27506. @see <a href="http://en.wikipedia.org/wiki/Internal_rate_of_return#Numerical_solution">Wikipedia on IRR</a>
  27507. @see <a href="http://office.microsoft.com/en-us/excel-help/irr-HP005209146.aspx">Excel IRR</a>
  27508. </member>
  27509. <member name="M:NPOI.SS.Formula.Functions.Irr.irr(System.Double[])">
  27510. Computes the internal rate of return using an estimated irr of 10 percent.
  27511. @param income the income values.
  27512. @return the irr.
  27513. </member>
  27514. <member name="M:NPOI.SS.Formula.Functions.Irr.irr(System.Double[],System.Double)">
  27515. Calculates IRR using the Newton-Raphson Method.
  27516. <p>
  27517. Starting with the guess, the method cycles through the calculation until the result
  27518. is accurate within 0.00001 percent. If IRR can't find a result that works
  27519. after 20 tries, the Double.NaN is returned.
  27520. </p>
  27521. <p>
  27522. The implementation is inspired by the NewtonSolver from the Apache Commons-Math library,
  27523. @see <a href="http://commons.apache.org">http://commons.apache.org</a>
  27524. </p>
  27525. @param values the income values.
  27526. @param guess the initial guess of irr.
  27527. @return the irr value. The method returns <code>Double.NaN</code>
  27528. if the maximum iteration count is exceeded
  27529. @see <a href="http://en.wikipedia.org/wiki/Internal_rate_of_return#Numerical_solution">
  27530. http://en.wikipedia.org/wiki/Internal_rate_of_return#Numerical_solution</a>
  27531. @see <a href="http://en.wikipedia.org/wiki/Newton%27s_method">
  27532. http://en.wikipedia.org/wiki/Newton%27s_method</a>
  27533. </member>
  27534. <member name="T:NPOI.SS.Formula.Functions.LinearRegressionFunction">
  27535. Base class for linear regression functions.
  27536. Calculates the linear regression line that is used to predict y values from x values<br/>
  27537. (http://introcs.cs.princeton.edu/java/97data/LinearRegression.java.html)
  27538. <b>Syntax</b>:<br/>
  27539. <b>INTERCEPT</b>(<b>arrayX</b>, <b>arrayY</b>)<p/>
  27540. or
  27541. <b>SLOPE</b>(<b>arrayX</b>, <b>arrayY</b>)<p/>
  27542. @author Johan Karlsteen
  27543. </member>
  27544. <member name="T:NPOI.SS.Formula.Functions.Isblank">
  27545. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  27546. </member>
  27547. <member name="T:NPOI.SS.Formula.Functions.Iserr">
  27548. contribute by Pavel Egorov
  27549. https://github.com/xoposhiy/npoi/commit/27b34a2389030c7115a666ace65daafda40d61af
  27550. Implementation of Excel <tt>ISERR()</tt> function.<p/>
  27551. <b>Syntax</b>:<br/>
  27552. <b>ISERR</b>(<b>value</b>)<p/>
  27553. <b>value</b> The value to be tested<p/>
  27554. Returns the logical value <tt>TRUE</tt> if value refers to any error value except
  27555. <tt>'#N/A'</tt>; otherwise, it returns <tt>FALSE</tt>.
  27556. </member>
  27557. <member name="T:NPOI.SS.Formula.Functions.Iserror">
  27558. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  27559. </member>
  27560. <member name="T:NPOI.SS.Formula.Functions.Islogical">
  27561. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  27562. </member>
  27563. <member name="T:NPOI.SS.Formula.Functions.Isna">
  27564. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  27565. </member>
  27566. <member name="T:NPOI.SS.Formula.Functions.Isnontext">
  27567. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  27568. </member>
  27569. <member name="T:NPOI.SS.Formula.Functions.Isnumber">
  27570. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  27571. </member>
  27572. <member name="T:NPOI.SS.Formula.Functions.Isref">
  27573. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  27574. </member>
  27575. <member name="T:NPOI.SS.Formula.Functions.Istext">
  27576. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  27577. </member>
  27578. <member name="T:NPOI.SS.Formula.Functions.LogicalFunction">
  27579. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  27580. </member>
  27581. <member name="M:NPOI.SS.Formula.Functions.LogicalFunction.Evaluate(NPOI.SS.Formula.Eval.ValueEval)">
  27582. @param arg any {@link ValueEval}, potentially {@link BlankEval} or {@link ErrorEval}.
  27583. </member>
  27584. <member name="T:NPOI.SS.Formula.Functions.Lookup">
  27585. Implementation of Excel function LOOKUP.<p/>
  27586. LOOKUP Finds an index row in a lookup table by the first column value and returns the value from another column.
  27587. <b>Syntax</b>:<br/>
  27588. <b>VLOOKUP</b>(<b>lookup_value</b>, <b>lookup_vector</b>, result_vector)<p/>
  27589. <b>lookup_value</b> The value to be found in the lookup vector.<br/>
  27590. <b>lookup_vector</b> An area reference for the lookup data. <br/>
  27591. <b>result_vector</b> Single row or single column area reference from which the result value Is chosen.<br/>
  27592. @author Josh Micich
  27593. </member>
  27594. <member name="T:NPOI.SS.Formula.Functions.LookupUtils">
  27595. Common functionality used by VLOOKUP, HLOOKUP, LOOKUP and MATCH
  27596. @author Josh Micich
  27597. </member>
  27598. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.CreateVector(NPOI.SS.Formula.TwoDEval)">
  27599. @return <c>null</c> if the supplied area is neither a single row nor a single colum
  27600. </member>
  27601. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.ResolveRowOrColIndexArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  27602. Processes the third argument to VLOOKUP, or HLOOKUP (<b>col_index_num</b>
  27603. or <b>row_index_num</b> respectively).<br/>
  27604. Sample behaviour:
  27605. <table border="0" cellpAdding="1" cellspacing="2" summary="Sample behaviour">
  27606. <tr><th>Input Return</th><th>Value </th><th>Thrown Error</th></tr>
  27607. <tr><td>5</td><td>4</td><td> </td></tr>
  27608. <tr><td>2.9</td><td>2</td><td> </td></tr>
  27609. <tr><td>"5"</td><td>4</td><td> </td></tr>
  27610. <tr><td>"2.18e1"</td><td>21</td><td> </td></tr>
  27611. <tr><td>"-$2"</td><td>-3</td><td>*</td></tr>
  27612. <tr><td>FALSE</td><td>-1</td><td>*</td></tr>
  27613. <tr><td>TRUE</td><td>0</td><td> </td></tr>
  27614. <tr><td>"TRUE"</td><td> </td><td>#REF!</td></tr>
  27615. <tr><td>"abc"</td><td> </td><td>#REF!</td></tr>
  27616. <tr><td>""</td><td> </td><td>#REF!</td></tr>
  27617. <tr><td>&lt;blank&gt;</td><td> </td><td>#VALUE!</td></tr>
  27618. </table><br/>
  27619. * Note - out of range errors (both too high and too low) are handled by the caller.
  27620. @return column or row index as a zero-based value
  27621. </member>
  27622. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.ResolveTableArrayArg(NPOI.SS.Formula.Eval.ValueEval)">
  27623. The second argument (table_array) should be an area ref, but can actually be a cell ref, in
  27624. which case it Is interpreted as a 1x1 area ref. Other scalar values cause #VALUE! error.
  27625. </member>
  27626. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.ResolveRangeLookupArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  27627. Resolves the last (optional) parameter (<b>range_lookup</b>) to the VLOOKUP and HLOOKUP functions.
  27628. @param rangeLookupArg
  27629. @param srcCellRow
  27630. @param srcCellCol
  27631. @return
  27632. @throws EvaluationException
  27633. </member>
  27634. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.LookupIndexOfExactValue(NPOI.SS.Formula.Functions.LookupValueComparer,NPOI.SS.Formula.Functions.ValueVector)">
  27635. Finds first (lowest index) exact occurrence of specified value.
  27636. @param lookupComparer the value to be found in column or row vector
  27637. @param vector the values to be searched. For VLOOKUP this Is the first column of the
  27638. tableArray. For HLOOKUP this Is the first row of the tableArray.
  27639. @return zero based index into the vector, -1 if value cannot be found
  27640. </member>
  27641. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.PerformBinarySearch(NPOI.SS.Formula.Functions.ValueVector,NPOI.SS.Formula.Functions.LookupValueComparer)">
  27642. Excel has funny behaviour when the some elements in the search vector are the wrong type.
  27643. </member>
  27644. <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)">
  27645. Excel seems to handle mismatched types initially by just stepping 'mid' ix forward to the
  27646. first compatible value.
  27647. @param midIx 'mid' index (value which has the wrong type)
  27648. @return usually -1, signifying that the BinarySearchIndex has been narrowed to the new mid
  27649. index. Zero or greater signifies that an exact match for the lookup value was found
  27650. </member>
  27651. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.FindLastIndexInRunOfEqualValues(NPOI.SS.Formula.Functions.LookupValueComparer,NPOI.SS.Formula.Functions.ValueVector,System.Int32,System.Int32)">
  27652. Once the binary search has found a single match, (V/H)LOOKUP steps one by one over subsequent
  27653. values to choose the last matching item.
  27654. </member>
  27655. <member name="T:NPOI.SS.Formula.Functions.CompareResult">
  27656. Enumeration to support <b>4</b> valued comparison results.<p/>
  27657. Excel lookup functions have complex behaviour in the case where the lookup array has mixed
  27658. types, and/or Is Unordered. Contrary to suggestions in some Excel documentation, there
  27659. does not appear to be a Universal ordering across types. The binary search algorithm used
  27660. Changes behaviour when the Evaluated 'mid' value has a different type to the lookup value.<p/>
  27661. A simple int might have done the same job, but there Is risk in confusion with the well
  27662. known <c>Comparable.CompareTo()</c> and <c>Comparator.Compare()</c> which both use
  27663. a ubiquitous 3 value result encoding.
  27664. </member>
  27665. <member name="T:NPOI.SS.Formula.Functions.BinarySearchIndexes">
  27666. Encapsulates some standard binary search functionality so the Unusual Excel behaviour can
  27667. be clearly distinguished.
  27668. </member>
  27669. <member name="M:NPOI.SS.Formula.Functions.BinarySearchIndexes.GetMidIx">
  27670. @return -1 if the search range Is empty
  27671. </member>
  27672. <member name="T:NPOI.SS.Formula.Functions.ValueVector">
  27673. Represents a single row or column within an <c>AreaEval</c>.
  27674. </member>
  27675. <member name="M:NPOI.SS.Formula.Functions.LookupValueComparer.CompareTo(NPOI.SS.Formula.Eval.ValueEval)">
  27676. @return one of 4 instances or <c>CompareResult</c>: <c>LESS_THAN</c>, <c>EQUAL</c>,
  27677. <c>GREATER_THAN</c> or <c>TYPE_MISMATCH</c>
  27678. </member>
  27679. <member name="M:NPOI.SS.Formula.Functions.LookupValueComparerBase.GetValueAsString">
  27680. used only for debug purposes
  27681. </member>
  27682. <member name="T:NPOI.SS.Formula.Functions.Match">
  27683. Implementation for the MATCH() Excel function.<p/>
  27684. <b>Syntax:</b><br/>
  27685. <b>MATCH</b>(<b>lookup_value</b>, <b>lookup_array</b>, match_type)<p/>
  27686. Returns a 1-based index specifying at what position in the <b>lookup_array</b> the specified
  27687. <b>lookup_value</b> Is found.<p/>
  27688. Specific matching behaviour can be modified with the optional <b>match_type</b> parameter.
  27689. <table border="0" cellpAdding="1" cellspacing="0" summary="match_type parameter description">
  27690. <tr><th>Value</th><th>Matching Behaviour</th></tr>
  27691. <tr><td>1</td><td>(default) Find the largest value that Is less than or equal to lookup_value.
  27692. The lookup_array must be in ascending <i>order</i>*.</td></tr>
  27693. <tr><td>0</td><td>Find the first value that Is exactly equal to lookup_value.
  27694. The lookup_array can be in any order.</td></tr>
  27695. <tr><td>-1</td><td>Find the smallest value that Is greater than or equal to lookup_value.
  27696. The lookup_array must be in descending <i>order</i>*.</td></tr>
  27697. </table>
  27698. * Note regarding <i>order</i> - For the <b>match_type</b> cases that require the lookup_array to
  27699. be ordered, MATCH() can produce incorrect results if this requirement Is not met. Observed
  27700. behaviour in Excel Is to return the lowest index value for which every item after that index
  27701. breaks the match rule.<br/>
  27702. The (ascending) sort order expected by MATCH() Is:<br/>
  27703. numbers (low to high), strings (A to Z), bool (FALSE to TRUE)<br/>
  27704. MATCH() ignores all elements in the lookup_array with a different type to the lookup_value.
  27705. Type conversion of the lookup_array elements Is never performed.
  27706. @author Josh Micich
  27707. </member>
  27708. <member name="M:NPOI.SS.Formula.Functions.Match.FindIndexOfValue(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Functions.ValueVector,System.Boolean,System.Boolean)">
  27709. @return zero based index
  27710. </member>
  27711. <member name="T:NPOI.SS.Formula.Functions.MathX">
  27712. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  27713. This class Is an extension to the standard math library
  27714. provided by java.lang.Math class. It follows the Math class
  27715. in that it has a private constructor and all static methods.
  27716. </member>
  27717. <member name="M:NPOI.SS.Formula.Functions.MathX.Round(System.Double,System.Int32)">
  27718. Returns a value rounded to p digits after decimal.
  27719. If p Is negative, then the number Is rounded to
  27720. places to the left of the decimal point. eg.
  27721. 10.23 rounded to -1 will give: 10. If p Is zero,
  27722. the returned value Is rounded to the nearest integral
  27723. value.
  27724. If n Is negative, the resulting value Is obtained
  27725. as the round value of absolute value of n multiplied
  27726. by the sign value of n (@see MathX.sign(double d)).
  27727. Thus, -0.6666666 rounded to p=0 will give -1 not 0.
  27728. If n Is NaN, returned value Is NaN.
  27729. @param n
  27730. @param p
  27731. </member>
  27732. <member name="M:NPOI.SS.Formula.Functions.MathX.RoundUp(System.Double,System.Int32)">
  27733. Returns a value rounded-up to p digits after decimal.
  27734. If p Is negative, then the number Is rounded to
  27735. places to the left of the decimal point. eg.
  27736. 10.23 rounded to -1 will give: 20. If p Is zero,
  27737. the returned value Is rounded to the nearest integral
  27738. value.
  27739. If n Is negative, the resulting value Is obtained
  27740. as the round-up value of absolute value of n multiplied
  27741. by the sign value of n (@see MathX.sign(double d)).
  27742. Thus, -0.2 rounded-up to p=0 will give -1 not 0.
  27743. If n Is NaN, returned value Is NaN.
  27744. @param n
  27745. @param p
  27746. </member>
  27747. <member name="M:NPOI.SS.Formula.Functions.MathX.RoundDown(System.Double,System.Int32)">
  27748. Returns a value rounded to p digits after decimal.
  27749. If p Is negative, then the number Is rounded to
  27750. places to the left of the decimal point. eg.
  27751. 10.23 rounded to -1 will give: 10. If p Is zero,
  27752. the returned value Is rounded to the nearest integral
  27753. value.
  27754. If n Is negative, the resulting value Is obtained
  27755. as the round-up value of absolute value of n multiplied
  27756. by the sign value of n (@see MathX.sign(double d)).
  27757. Thus, -0.8 rounded-down to p=0 will give 0 not -1.
  27758. If n Is NaN, returned value Is NaN.
  27759. @param n
  27760. @param p
  27761. </member>
  27762. <member name="M:NPOI.SS.Formula.Functions.MathX.Average(System.Double[])">
  27763. average of all values
  27764. @param values
  27765. </member>
  27766. <member name="M:NPOI.SS.Formula.Functions.MathX.Sum(System.Double[])">
  27767. sum of all values
  27768. @param values
  27769. </member>
  27770. <member name="M:NPOI.SS.Formula.Functions.MathX.Sumsq(System.Double[])">
  27771. sum of squares of all values
  27772. @param values
  27773. </member>
  27774. <member name="M:NPOI.SS.Formula.Functions.MathX.Product(System.Double[])">
  27775. product of all values
  27776. @param values
  27777. </member>
  27778. <member name="M:NPOI.SS.Formula.Functions.MathX.Min(System.Double[])">
  27779. min of all values. If supplied array Is zero Length,
  27780. double.POSITIVE_INFINITY Is returned.
  27781. @param values
  27782. </member>
  27783. <member name="M:NPOI.SS.Formula.Functions.MathX.Max(System.Double[])">
  27784. min of all values. If supplied array Is zero Length,
  27785. double.NEGATIVE_INFINITY Is returned.
  27786. @param values
  27787. </member>
  27788. <member name="M:NPOI.SS.Formula.Functions.MathX.Floor(System.Double,System.Double)">
  27789. Note: this function Is different from java.lang.Math.floor(..).
  27790. When n and s are "valid" arguments, the returned value Is: Math.floor(n/s) * s;
  27791. <br/>
  27792. n and s are invalid if any of following conditions are true:
  27793. <ul>
  27794. <li>s Is zero</li>
  27795. <li>n Is negative and s Is positive</li>
  27796. <li>n Is positive and s Is negative</li>
  27797. </ul>
  27798. In all such cases, double.NaN Is returned.
  27799. @param n
  27800. @param s
  27801. </member>
  27802. <member name="M:NPOI.SS.Formula.Functions.MathX.Ceiling(System.Double,System.Double)">
  27803. Note: this function Is different from java.lang.Math.ceil(..).
  27804. When n and s are "valid" arguments, the returned value Is: Math.ceiling(n/s) * s;
  27805. <br/>
  27806. n and s are invalid if any of following conditions are true:
  27807. <ul>
  27808. <li>s Is zero</li>
  27809. <li>n Is negative and s Is positive</li>
  27810. <li>n Is positive and s Is negative</li>
  27811. </ul>
  27812. In all such cases, double.NaN Is returned.
  27813. @param n
  27814. @param s
  27815. </member>
  27816. <member name="M:NPOI.SS.Formula.Functions.MathX.Factorial(System.Int32)">
  27817. <br/> for all n >= 1; factorial n = n * (n-1) * (n-2) * ... * 1
  27818. <br/> else if n == 0; factorial n = 1
  27819. <br/> else if n &lt; 0; factorial n = double.NaN
  27820. <br/> Loss of precision can occur if n Is large enough.
  27821. If n Is large so that the resulting value would be greater
  27822. than double.MAX_VALUE; double.POSITIVE_INFINITY Is returned.
  27823. If n &lt; 0, double.NaN Is returned.
  27824. @param n
  27825. </member>
  27826. <member name="M:NPOI.SS.Formula.Functions.MathX.Mod(System.Double,System.Double)">
  27827. returns the remainder resulting from operation:
  27828. n / d.
  27829. <br/> The result has the sign of the divisor.
  27830. <br/> Examples:
  27831. <ul>
  27832. <li>mod(3.4, 2) = 1.4</li>
  27833. <li>mod(-3.4, 2) = 0.6</li>
  27834. <li>mod(-3.4, -2) = -1.4</li>
  27835. <li>mod(3.4, -2) = -0.6</li>
  27836. </ul>
  27837. If d == 0, result Is NaN
  27838. @param n
  27839. @param d
  27840. </member>
  27841. <member name="M:NPOI.SS.Formula.Functions.MathX.Acosh(System.Double)">
  27842. inverse hyperbolic cosine
  27843. @param d
  27844. </member>
  27845. <member name="M:NPOI.SS.Formula.Functions.MathX.Asinh(System.Double)">
  27846. inverse hyperbolic sine
  27847. @param d
  27848. </member>
  27849. <member name="M:NPOI.SS.Formula.Functions.MathX.Atanh(System.Double)">
  27850. inverse hyperbolic tangent
  27851. @param d
  27852. </member>
  27853. <member name="M:NPOI.SS.Formula.Functions.MathX.Cosh(System.Double)">
  27854. hyperbolic cosine
  27855. @param d
  27856. </member>
  27857. <member name="M:NPOI.SS.Formula.Functions.MathX.Sinh(System.Double)">
  27858. hyperbolic sine
  27859. @param d
  27860. </member>
  27861. <member name="M:NPOI.SS.Formula.Functions.MathX.Tanh(System.Double)">
  27862. hyperbolic tangent
  27863. @param d
  27864. </member>
  27865. <member name="M:NPOI.SS.Formula.Functions.MathX.SumProduct(System.Double[][])">
  27866. returns the sum of product of corresponding double value in each
  27867. subarray. It Is the responsibility of the caller to Ensure that
  27868. all the subarrays are of equal Length. If the subarrays are
  27869. not of equal Length, the return value can be Unpredictable.
  27870. @param arrays
  27871. </member>
  27872. <member name="M:NPOI.SS.Formula.Functions.MathX.Sumx2my2(System.Double[],System.Double[])">
  27873. returns the sum of difference of squares of corresponding double
  27874. value in each subarray: ie. sigma (xarr[i]^2-yarr[i]^2)
  27875. <br/>
  27876. It Is the responsibility of the caller
  27877. to Ensure that the two subarrays are of equal Length. If the
  27878. subarrays are not of equal Length, the return value can be
  27879. Unpredictable.
  27880. @param xarr
  27881. @param yarr
  27882. </member>
  27883. <member name="M:NPOI.SS.Formula.Functions.MathX.Sumx2py2(System.Double[],System.Double[])">
  27884. returns the sum of sum of squares of corresponding double
  27885. value in each subarray: ie. sigma (xarr[i]^2 + yarr[i]^2)
  27886. <br/>
  27887. It Is the responsibility of the caller
  27888. to Ensure that the two subarrays are of equal Length. If the
  27889. subarrays are not of equal Length, the return value can be
  27890. Unpredictable.
  27891. @param xarr
  27892. @param yarr
  27893. </member>
  27894. <member name="M:NPOI.SS.Formula.Functions.MathX.Sumxmy2(System.Double[],System.Double[])">
  27895. returns the sum of squares of difference of corresponding double
  27896. value in each subarray: ie. sigma ( (xarr[i]-yarr[i])^2 )
  27897. <br/>
  27898. It Is the responsibility of the caller
  27899. to Ensure that the two subarrays are of equal Length. If the
  27900. subarrays are not of equal Length, the return value can be
  27901. Unpredictable.
  27902. @param xarr
  27903. @param yarr
  27904. </member>
  27905. <member name="M:NPOI.SS.Formula.Functions.MathX.NChooseK(System.Int32,System.Int32)">
  27906. returns the total number of combinations possible when
  27907. k items are chosen out of total of n items. If the number
  27908. Is too large, loss of precision may occur (since returned
  27909. value Is double). If the returned value Is larger than
  27910. double.MAX_VALUE, double.POSITIVE_INFINITY Is returned.
  27911. If either of the parameters Is negative, double.NaN Is returned.
  27912. @param n
  27913. @param k
  27914. </member>
  27915. <member name="T:NPOI.SS.Formula.Functions.MinaMaxa">
  27916. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  27917. </member>
  27918. <member name="T:NPOI.SS.Formula.Functions.Mirr">
  27919. Calculates Modified internal rate of return. Syntax is MIRR(cash_flow_values, finance_rate, reinvest_rate)
  27920. <p>Returns the modified internal rate of return for a series of periodic cash flows. MIRR considers both the cost
  27921. of the investment and the interest received on reinvestment of cash.</p>
  27922. 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.
  27923. <ul>
  27924. <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>
  27925. <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>
  27926. </ul>
  27927. Finance_rate is the interest rate you pay on the money used in the cash flows.
  27928. Reinvest_rate is the interest rate you receive on the cash flows as you reinvest them.
  27929. @author Carlos Delgado (carlos dot del dot est at gmail dot com)
  27930. @author Cédric Walter (cedric dot walter at gmail dot com)
  27931. @see <a href="http://en.wikipedia.org/wiki/MIRR">Wikipedia on MIRR</a>
  27932. @see <a href="http://office.microsoft.com/en-001/excel-help/mirr-HP005209180.aspx">Excel MIRR</a>
  27933. @see {@link Irr}
  27934. </member>
  27935. <member name="T:NPOI.SS.Formula.Functions.Mod">
  27936. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  27937. </member>
  27938. <member name="T:NPOI.SS.Formula.Functions.Mode">
  27939. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  27940. </member>
  27941. <member name="M:NPOI.SS.Formula.Functions.Mode.Evaluate(System.Double[])">
  27942. if v is zero length or contains no duplicates, return value is
  27943. Double.NaN. Else returns the value that occurs most times and if there is
  27944. a tie, returns the first such value.
  27945. @param v
  27946. </member>
  27947. <member name="T:NPOI.SS.Formula.Functions.MultiOperandNumericFunction">
  27948. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  27949. This Is the base class for all excel function evaluator
  27950. classes that take variable number of operands, and
  27951. where the order of operands does not matter
  27952. </member>
  27953. <member name="P:NPOI.SS.Formula.Functions.MultiOperandNumericFunction.MaxNumOperands">
  27954. Maximum number of operands accepted by this function.
  27955. Subclasses may override to Change default value.
  27956. </member>
  27957. <member name="P:NPOI.SS.Formula.Functions.MultiOperandNumericFunction.IsSubtotalCounted">
  27958. Whether to count nested subtotals.
  27959. </member>
  27960. <member name="M:NPOI.SS.Formula.Functions.MultiOperandNumericFunction.CollectValues(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Functions.MultiOperandNumericFunction.DoubleList)">
  27961. Collects values from a single argument
  27962. </member>
  27963. <member name="M:NPOI.SS.Formula.Functions.MultiOperandNumericFunction.GetNumberArray(NPOI.SS.Formula.Eval.ValueEval[])">
  27964. Returns a double array that contains values for the numeric cells
  27965. from among the list of operands. Blanks and Blank equivalent cells
  27966. are ignored. Error operands or cells containing operands of type
  27967. that are considered invalid and would result in #VALUE! error in
  27968. excel cause this function to return <c>null</c>.
  27969. @return never <c>null</c>
  27970. </member>
  27971. <member name="M:NPOI.SS.Formula.Functions.MultiOperandNumericFunction.AreSubArraysConsistent(System.Double[][])">
  27972. Ensures that a two dimensional array has all sub-arrays present and the same Length
  27973. @return <c>false</c> if any sub-array Is missing, or Is of different Length
  27974. </member>
  27975. <member name="T:NPOI.SS.Formula.Functions.Na">
  27976. Implementation of Excel function NA()
  27977. @author Josh Micich
  27978. </member>
  27979. <member name="T:NPOI.SS.Formula.Functions.NotImplementedFunction">
  27980. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  27981. This Is the default implementation of a Function class.
  27982. The default behaviour Is to return a non-standard ErrorEval
  27983. "ErrorEval.FUNCTION_NOT_IMPLEMENTED". This error should alert
  27984. the user that the formula contained a function that Is not
  27985. yet implemented.
  27986. </member>
  27987. <member name="T:NPOI.SS.Formula.Functions.Now">
  27988. Implementation of Excel NOW() Function
  27989. @author Frank Taffelt
  27990. </member>
  27991. <member name="T:NPOI.SS.Formula.Functions.Abs">
  27992. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  27993. </member>
  27994. <member name="T:NPOI.SS.Formula.Functions.Acos">
  27995. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  27996. </member>
  27997. <member name="T:NPOI.SS.Formula.Functions.Acosh">
  27998. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  27999. Support for hyperbolic trig functions was Added as a part of
  28000. Java distribution only in JDK1.5. This class uses custom
  28001. naive implementation based on formulas at:
  28002. http://www.math2.org/math/trig/hyperbolics.htm
  28003. These formulas seem to agree with excel's implementation.
  28004. </member>
  28005. <member name="T:NPOI.SS.Formula.Functions.Asin">
  28006. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  28007. </member>
  28008. <member name="T:NPOI.SS.Formula.Functions.Asinh">
  28009. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  28010. Support for hyperbolic trig functions was Added as a part of
  28011. Java distribution only in JDK1.5. This class uses custom
  28012. naive implementation based on formulas at:
  28013. http://www.math2.org/math/trig/hyperbolics.htm
  28014. These formulas seem to agree with excel's implementation.
  28015. </member>
  28016. <member name="T:NPOI.SS.Formula.Functions.Atan">
  28017. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  28018. </member>
  28019. <member name="T:NPOI.SS.Formula.Functions.Atan2">
  28020. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  28021. </member>
  28022. <member name="T:NPOI.SS.Formula.Functions.Atanh">
  28023. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  28024. Support for hyperbolic trig functions was Added as a part of
  28025. Java distribution only in JDK1.5. This class uses custom
  28026. naive implementation based on formulas at:
  28027. http://www.math2.org/math/trig/hyperbolics.htm
  28028. These formulas seem to agree with excel's implementation.
  28029. </member>
  28030. <member name="T:NPOI.SS.Formula.Functions.Cos">
  28031. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  28032. </member>
  28033. <member name="T:NPOI.SS.Formula.Functions.Cosh">
  28034. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  28035. </member>
  28036. <member name="T:NPOI.SS.Formula.Functions.Ln">
  28037. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  28038. </member>
  28039. <member name="T:NPOI.SS.Formula.Functions.Log">
  28040. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  28041. Log: LOG(number,[base])
  28042. </member>
  28043. <member name="T:NPOI.SS.Formula.Functions.Log10">
  28044. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  28045. </member>
  28046. <member name="T:NPOI.SS.Formula.Functions.NumericFunction">
  28047. @author Amol S. Deshmukh &lt; amolweb at yahoo dot com &gt;
  28048. </member>
  28049. <member name="T:NPOI.SS.Formula.Functions.Pi">
  28050. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  28051. </member>
  28052. <member name="M:NPOI.SS.Formula.Functions.Poisson.IsDefaultResult(System.Double,System.Double)">
  28053. This checks is x = 0 and the mean = 0.
  28054. Excel currently returns the value 1 where as the
  28055. maths common implementation will error.
  28056. @param x The number.
  28057. @param mean The mean.
  28058. @return If a default value should be returned.
  28059. </member>
  28060. <member name="F:NPOI.SS.Formula.Functions.Poisson.FACTORIALS">
  28061. All long-representable factorials
  28062. </member>
  28063. <member name="T:NPOI.SS.Formula.Functions.Rand">
  28064. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  28065. </member>
  28066. <member name="T:NPOI.SS.Formula.Functions.Sin">
  28067. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  28068. </member>
  28069. <member name="T:NPOI.SS.Formula.Functions.Sinh">
  28070. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  28071. </member>
  28072. <member name="T:NPOI.SS.Formula.Functions.Sqrt">
  28073. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  28074. </member>
  28075. <member name="T:NPOI.SS.Formula.Functions.Tan">
  28076. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  28077. </member>
  28078. <member name="T:NPOI.SS.Formula.Functions.Tanh">
  28079. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  28080. </member>
  28081. <member name="T:NPOI.SS.Formula.Functions.Oct2Dec">
  28082. <p>Implementation for Excel Oct2Dec() function.</p>
  28083. <p>
  28084. Converts an octal number to decimal.
  28085. </p>
  28086. <p>
  28087. <b>Syntax</b>:<br/> <b>Oct2Dec </b>(<b>number</b> )
  28088. </p>
  28089. <p/>
  28090. Number is the octal number you want to Convert. Number may not contain more than 10 octal characters (30 bits).
  28091. The most significant bit of number is the sign bit. The remaining 29 bits are magnitude bits.
  28092. Negative numbers are represented using two's-complement notation..
  28093. <p/>
  28094. If number is not a valid octal number, OCT2DEC returns the #NUM! error value.
  28095. @author cedric dot walter @ gmail dot com
  28096. </member>
  28097. <member name="T:NPOI.SS.Formula.Functions.Odd">
  28098. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  28099. </member>
  28100. <member name="T:NPOI.SS.Formula.Functions.Offset">
  28101. Implementation for Excel function OFFSet()<p/>
  28102. OFFSet returns an area reference that Is a specified number of rows and columns from a
  28103. reference cell or area.<p/>
  28104. <b>Syntax</b>:<br/>
  28105. <b>OFFSet</b>(<b>reference</b>, <b>rows</b>, <b>cols</b>, height, width)<p/>
  28106. <b>reference</b> Is the base reference.<br/>
  28107. <b>rows</b> Is the number of rows up or down from the base reference.<br/>
  28108. <b>cols</b> Is the number of columns left or right from the base reference.<br/>
  28109. <b>height</b> (default same height as base reference) Is the row Count for the returned area reference.<br/>
  28110. <b>width</b> (default same width as base reference) Is the column Count for the returned area reference.<br/>
  28111. @author Josh Micich
  28112. </member>
  28113. <member name="T:NPOI.SS.Formula.Functions.Offset.EvalEx">
  28114. Exceptions are used within this class to help simplify flow control when error conditions
  28115. are enCountered
  28116. </member>
  28117. <member name="T:NPOI.SS.Formula.Functions.Offset.LinearOffsetRange">
  28118. A one dimensional base + offset. Represents either a row range or a column range.
  28119. Two instances of this class toGether specify an area range.
  28120. </member>
  28121. <member name="M:NPOI.SS.Formula.Functions.Offset.LinearOffsetRange.NormaliseAndTranslate(System.Int32)">
  28122. Moves the range by the specified translation amount.<p/>
  28123. This method also 'normalises' the range: Excel specifies that the width and height
  28124. parameters (Length field here) cannot be negative. However, OFFSet() does produce
  28125. sensible results in these cases. That behavior Is replicated here. <p/>
  28126. @param translationAmount may be zero negative or positive
  28127. @return the equivalent <c>LinearOffsetRange</c> with a positive Length, moved by the
  28128. specified translationAmount.
  28129. </member>
  28130. <member name="T:NPOI.SS.Formula.Functions.Offset.BaseRef">
  28131. Encapsulates either an area or cell reference which may be 2d or 3d.
  28132. </member>
  28133. <member name="M:NPOI.SS.Formula.Functions.Offset.EvaluateIntArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  28134. OFFSet's numeric arguments (2..5) have similar Processing rules
  28135. </member>
  28136. <member name="M:NPOI.SS.Formula.Functions.Offset.ConvertDoubleToInt(System.Double)">
  28137. Fractional values are silently truncated by Excel.
  28138. Truncation Is toward negative infinity.
  28139. </member>
  28140. <member name="T:NPOI.SS.Formula.Functions.Pmt">
  28141. Implementation for the PMT() Excel function.<p/>
  28142. <b>Syntax:</b><br/>
  28143. <b>PMT</b>(<b>rate</b>, <b>nper</b>, <b>pv</b>, fv, type)<p/>
  28144. Returns the constant repayment amount required for a loan assuming a constant interest rate.<p/>
  28145. <b>rate</b> the loan interest rate.<br/>
  28146. <b>nper</b> the number of loan repayments.<br/>
  28147. <b>pv</b> the present value of the future payments (or principle).<br/>
  28148. <b>fv</b> the future value (default zero) surplus cash at the end of the loan lifetime.<br/>
  28149. <b>type</b> whether payments are due at the beginning(1) or end(0 - default) of each payment period.<br/>
  28150. </member>
  28151. <member name="T:NPOI.SS.Formula.Functions.Power">
  28152. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  28153. </member>
  28154. <member name="T:NPOI.SS.Formula.Functions.PPMT">
  28155. Compute the interest portion of a payment.
  28156. @author Mike Argyriou micharg@gmail.com
  28157. </member>
  28158. <member name="T:NPOI.SS.Formula.Functions.Quotient">
  28159. <p>Implementation for Excel QUOTIENT () function.</p>
  28160. <p>
  28161. <b>Syntax</b>:<br/> <b>QUOTIENT</b>(<b>Numerator</b>,<b>Denominator</b>)<br/>
  28162. </p>
  28163. <p>
  28164. Numerator is the dividend.
  28165. Denominator is the divisor.
  28166. Returns the integer portion of a division. Use this function when you want to discard the remainder of a division.
  28167. </p>
  28168. If either enumerator/denominator is non numeric, QUOTIENT returns the #VALUE! error value.
  28169. If denominator is Equals to zero, QUOTIENT returns the #DIV/0! error value.
  28170. @author cedric dot walter @ gmail dot com
  28171. </member>
  28172. <member name="T:NPOI.SS.Formula.Functions.Radians">
  28173. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  28174. </member>
  28175. <member name="T:NPOI.SS.Formula.Functions.Rank">
  28176. * 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.
  28177. * Syntax:
  28178. * RANK(number,ref,order)
  28179. * Number is the number whose rank you want to find.
  28180. * Ref is an array of, or a reference to, a list of numbers. Nonnumeric values in ref are ignored.
  28181. * Order is a number specifying how to rank number.
  28182. * If order is 0 (zero) or omitted, Microsoft Excel ranks number as if ref were a list sorted in descending order.
  28183. * If order is any nonzero value, Microsoft Excel ranks number as if ref were a list sorted in ascending order.
  28184. *
  28185. * @author Rubin Wang
  28186. </member>
  28187. <member name="T:NPOI.SS.Formula.Functions.Rate">
  28188. Implements the Excel Rate function
  28189. </member>
  28190. <member name="M:NPOI.SS.Formula.Functions.Rate.CheckValue(System.Double)">
  28191. Excel does not support infinities and NaNs, rather, it gives a #NUM! error in these cases
  28192. @throws EvaluationException (#NUM!) if result is NaN or Infinity
  28193. </member>
  28194. <member name="T:NPOI.SS.Formula.Functions.Rept">
  28195. Implementation for Excel REPT () function.<p/>
  28196. <p/>
  28197. <b>Syntax</b>:<br/> <b>REPT </b>(<b>text</b>,<b>number_times</b> )<br/>
  28198. <p/>
  28199. Repeats text a given number of times. Use REPT to fill a cell with a number of instances of a text string.
  28200. text : text The text that you want to repeat.
  28201. number_times: A positive number specifying the number of times to repeat text.
  28202. If number_times is 0 (zero), REPT returns "" (empty text).
  28203. If this argument contains a decimal value, this function ignores the numbers to the right side of the decimal point.
  28204. The result of the REPT function cannot be longer than 32,767 characters, or REPT returns #VALUE!.
  28205. @author cedric dot walter @ gmail dot com
  28206. </member>
  28207. <member name="T:NPOI.SS.Formula.Functions.Roman">
  28208. Implementation for Excel WeekNum() function.<p/>
  28209. <p/>
  28210. <b>Syntax</b>:<br/> <b>WeekNum </b>(<b>Serial_num</b>,<b>Return_type</b>)<br/>
  28211. <p/>
  28212. Returns a number that indicates where the week falls numerically within a year.
  28213. <p/>
  28214. <p/>
  28215. Serial_num is a date within the week. Dates should be entered by using the DATE function,
  28216. or as results of other formulas or functions. For example, use DATE(2008,5,23)
  28217. for the 23rd day of May, 2008. Problems can occur if dates are entered as text.
  28218. Return_type is a number that determines on which day the week begins. The default is 1.
  28219. 1 Week begins on Sunday. Weekdays are numbered 1 through 7.
  28220. 2 Week begins on Monday. Weekdays are numbered 1 through 7.
  28221. @author cedric dot walter @ gmail dot com
  28222. </member>
  28223. <member name="M:NPOI.SS.Formula.Functions.Roman.integerToRoman(System.Int32)">
  28224. Classic conversion.
  28225. @param number
  28226. @return
  28227. </member>
  28228. <member name="M:NPOI.SS.Formula.Functions.Roman.MakeConcise(System.String,System.Int32)">
  28229. Use conversion rule to factor some parts and make them more concise
  28230. @param result
  28231. @param form
  28232. @return
  28233. </member>
  28234. <member name="T:NPOI.SS.Formula.Functions.Rows">
  28235. Implementation for Excel ROWS function.
  28236. @author Josh Micich
  28237. </member>
  28238. <member name="T:NPOI.SS.Formula.Functions.Slope">
  28239. Implementation of Excel function SLOPE()<p/>
  28240. Calculates the SLOPE of the linear regression line that is used to predict y values from x values<br/>
  28241. (http://introcs.cs.princeton.edu/java/97data/LinearRegression.java.html)
  28242. <b>Syntax</b>:<br/>
  28243. <b>SLOPE</b>(<b>arrayX</b>, <b>arrayY</b>)<p/>
  28244. @author Johan Karlsteen
  28245. </member>
  28246. <member name="T:NPOI.SS.Formula.Functions.StatsLib">
  28247. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  28248. Library for common statistics functions
  28249. </member>
  28250. <member name="M:NPOI.SS.Formula.Functions.StatsLib.avedev(System.Double[])">
  28251. returns the mean of deviations from mean.
  28252. @param v
  28253. </member>
  28254. <member name="M:NPOI.SS.Formula.Functions.StatsLib.mode(System.Double[])">
  28255. if v Is zero Length or Contains no duplicates, return value
  28256. Is double.NaN. Else returns the value that occurs most times
  28257. and if there Is a tie, returns the first such value.
  28258. @param v
  28259. </member>
  28260. <member name="T:NPOI.SS.Formula.Functions.Subtotal">
  28261. Implementation for the Excel function SUBTOTAL<p>
  28262. <b>Syntax :</b> <br/>
  28263. SUBTOTAL ( <b>functionCode</b>, <b>ref1</b>, ref2 ... ) <br/>
  28264. <table border="1" cellpadding="1" cellspacing="0" summary="Parameter descriptions">
  28265. <tr><td><b>functionCode</b></td><td>(1-11) Selects the underlying aggregate function to be used (see table below)</td></tr>
  28266. <tr><td><b>ref1</b>, ref2 ...</td><td>Arguments to be passed to the underlying aggregate function</td></tr>
  28267. </table><br/>
  28268. </p>
  28269. <table border="1" cellpadding="1" cellspacing="0" summary="Parameter descriptions">
  28270. <tr><th>functionCode</th><th>Aggregate Function</th></tr>
  28271. <tr align='center'><td>1</td><td>AVERAGE</td></tr>
  28272. <tr align='center'><td>2</td><td>COUNT</td></tr>
  28273. <tr align='center'><td>3</td><td>COUNTA</td></tr>
  28274. <tr align='center'><td>4</td><td>MAX</td></tr>
  28275. <tr align='center'><td>5</td><td>MIN</td></tr>
  28276. <tr align='center'><td>6</td><td>PRODUCT</td></tr>
  28277. <tr align='center'><td>7</td><td>STDEV</td></tr>
  28278. <tr align='center'><td>8</td><td>STDEVP *</td></tr>
  28279. <tr align='center'><td>9</td><td>SUM</td></tr>
  28280. <tr align='center'><td>10</td><td>VAR *</td></tr>
  28281. <tr align='center'><td>11</td><td>VARP *</td></tr>
  28282. <tr align='center'><td>101-111</td><td>*</td></tr>
  28283. </table><br/>
  28284. * Not implemented in POI yet. Functions 101-111 are the same as functions 1-11 but with
  28285. the option 'ignore hidden values'.
  28286. <p/>
  28287. @author Paul Tomlin &lt; pault at bulk sms dot com &gt;
  28288. </member>
  28289. <member name="T:NPOI.SS.Formula.Functions.Sumif">
  28290. Implementation for the Excel function SUMIF<p>
  28291. Syntax : <br/>
  28292. SUMIF ( <b>range</b>, <b>criteria</b>, sum_range ) <br/>
  28293. <table border="0" cellpadding="1" cellspacing="0" summary="Parameter descriptions">
  28294. <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>
  28295. <tr><th>criteria</th><td>The value or expression used to filter rows from <b>range</b></td></tr>
  28296. <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>
  28297. </table><br/>
  28298. </p>
  28299. @author Josh Micich
  28300. </member>
  28301. <member name="M:NPOI.SS.Formula.Functions.Sumif.CreateSumRange(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Eval.AreaEval)">
  28302. @return a range of the same dimensions as aeRange using eval to define the top left corner.
  28303. @throws EvaluationException if eval is not a reference
  28304. </member>
  28305. <member name="T:NPOI.SS.Formula.Functions.Sumifs">
  28306. Implementation for the Excel function SUMIFS<br/>
  28307. <p>
  28308. Syntax : <br/>
  28309. SUMIFS ( <b>sum_range</b>, <b>criteria_range1</b>, <b>criteria1</b>,
  28310. [<b>criteria_range2</b>, <b>criteria2</b>], ...) <br/>
  28311. <ul>
  28312. <li><b>sum_range</b> Required. One or more cells to sum, including numbers or names, ranges,
  28313. or cell references that contain numbers. Blank and text values are ignored.</li>
  28314. <li><b>criteria1_range</b> Required. The first range in which
  28315. to evaluate the associated criteria.</li>
  28316. <li><b>criteria1</b> Required. The criteria in the form of a number, expression,
  28317. cell reference, or text that define which cells in the criteria_range1
  28318. argument will be added</li>
  28319. <li><b> criteria_range2, criteria2, ...</b> Optional. Additional ranges and their associated criteria.
  28320. Up to 127 range/criteria pairs are allowed.</li>
  28321. </ul>
  28322. </p>
  28323. @author Yegor Kozlov
  28324. </member>
  28325. <member name="M:NPOI.SS.Formula.Functions.Sumifs.ValidateCriteria(NPOI.SS.Formula.Functions.IMatchPredicate[])">
  28326. Verify that each <code>criteria</code> predicate is valid, i.e. not an error
  28327. @throws EvaluationException if there are criteria which resulted in Errors.
  28328. </member>
  28329. <member name="M:NPOI.SS.Formula.Functions.Sumifs.ValidateCriteriaRanges(NPOI.SS.Formula.Eval.AreaEval[],NPOI.SS.Formula.Eval.AreaEval)">
  28330. Verify that each <code>criteriaRanges</code> argument contains the same number of rows and columns
  28331. as the <code>sumRange</code> argument
  28332. @throws EvaluationException if
  28333. </member>
  28334. <member name="M:NPOI.SS.Formula.Functions.Sumifs.SumMatchingCells(NPOI.SS.Formula.Eval.AreaEval[],NPOI.SS.Formula.Functions.IMatchPredicate[],NPOI.SS.Formula.Eval.AreaEval)">
  28335. @param ranges criteria ranges, each range must be of the same dimensions as <code>aeSum</code>
  28336. @param predicates array of predicates, a predicate for each value in <code>ranges</code>
  28337. @param aeSum the range to sum
  28338. @return the computed value
  28339. </member>
  28340. <member name="M:NPOI.SS.Formula.Functions.Sumproduct.GetProductTerm(NPOI.SS.Formula.Eval.ValueEval,System.Boolean)">
  28341. Determines a <c>double</c> value for the specified <c>ValueEval</c>.
  28342. @param IsScalarProduct <c>false</c> for SUMPRODUCTs over area refs.
  28343. @throws EvalEx if <c>ve</c> represents an error value.
  28344. <p/>
  28345. Note - string values and empty cells are interpreted differently depending on
  28346. <c>isScalarProduct</c>. For scalar products, if any term Is blank or a string, the
  28347. error (#VALUE!) Is raised. For area (sum)products, if any term Is blank or a string, the
  28348. result Is zero.
  28349. </member>
  28350. <member name="T:NPOI.SS.Formula.Functions.Concatenate">
  28351. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  28352. </member>
  28353. <member name="T:NPOI.SS.Formula.Functions.Exact">
  28354. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  28355. </member>
  28356. <member name="T:NPOI.SS.Formula.Functions.LeftRight">
  28357. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  28358. </member>
  28359. <member name="T:NPOI.SS.Formula.Functions.Len">
  28360. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  28361. </member>
  28362. <member name="T:NPOI.SS.Formula.Functions.Lower">
  28363. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  28364. </member>
  28365. <member name="T:NPOI.SS.Formula.Functions.Mid">
  28366. <summary>
  28367. An implementation of the MID function
  28368. MID returns a specific number of
  28369. Chars from a text string, starting at the specified position.
  28370. @author Manda Wilson &lt; wilson at c bio dot msk cc dot org;
  28371. </summary>
  28372. </member>
  28373. <member name="T:NPOI.SS.Formula.Functions.Proper">
  28374. <summary>
  28375. Implementation of the PROPER function:
  28376. Normalizes all words (separated by non-word characters) by
  28377. making the first letter upper and the rest lower case.
  28378. </summary>
  28379. </member>
  28380. <member name="T:NPOI.SS.Formula.Functions.Replace">
  28381. An implementation of the Replace function:
  28382. Replaces part of a text string based on the number of Chars
  28383. you specify, with another text string.
  28384. @author Manda Wilson &lt; wilson at c bio dot msk cc dot org &gt;
  28385. </member>
  28386. <member name="M:NPOI.SS.Formula.Functions.Replace.EvaluateFunc(NPOI.SS.Formula.Eval.ValueEval[],System.Int32,System.Int32)">
  28387. Replaces part of a text string based on the number of Chars
  28388. you specify, with another text string.
  28389. @see org.apache.poi.hssf.record.formula.eval.Eval
  28390. </member>
  28391. <member name="T:NPOI.SS.Formula.Functions.Substitute">
  28392. An implementation of the SUBSTITUTE function:
  28393. Substitutes text in a text string with new text, some number of times.
  28394. @author Manda Wilson &lt; wilson at c bio dot msk cc dot org &gt;
  28395. </member>
  28396. <member name="M:NPOI.SS.Formula.Functions.Substitute.EvaluateFunc(NPOI.SS.Formula.Eval.ValueEval[],System.Int32,System.Int32)">
  28397. Substitutes text in a text string with new text, some number of times.
  28398. @see org.apache.poi.hssf.record.formula.eval.Eval
  28399. </member>
  28400. <member name="T:NPOI.SS.Formula.Functions.Text">
  28401. An implementation of the TEXT function
  28402. TEXT returns a number value formatted with the given number formatting string.
  28403. This function is not a complete implementation of the Excel function, but
  28404. handles most of the common cases. All work is passed down to
  28405. {@link DataFormatter} to be done, as this works much the same as the
  28406. display focused work that that does.
  28407. </member>
  28408. <member name="T:NPOI.SS.Formula.Functions.TextFunction">
  28409. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  28410. </member>
  28411. <member name="F:NPOI.SS.Formula.Functions.TextFunction.TRIM">
  28412. @author Manda Wilson &lt; wilson at c bio dot msk cc dot org &gt;
  28413. <summary>
  28414. An implementation of the TRIM function:
  28415. <para>
  28416. Removes leading and trailing spaces from value if evaluated operand value is string.
  28417. </para>
  28418. </summary>
  28419. </member>
  28420. <member name="F:NPOI.SS.Formula.Functions.TextFunction.MID">
  28421. <summary>
  28422. An implementation of the MID function
  28423. MID returns a specific number of
  28424. characters from a text string, starting at the specified position.
  28425. Syntax: MID(text, start_num, num_chars)
  28426. </summary>
  28427. </member>
  28428. <member name="F:NPOI.SS.Formula.Functions.TextFunction.FIND">
  28429. @author Torstein Tauno Svendsen (torstei@officenet.no)
  28430. <summary>
  28431. Implementation of the FIND() function.
  28432. <para>
  28433. Syntax: FIND(Find_text, within_text, start_num)
  28434. </para>
  28435. <para> FIND returns the character position of the first (case sensitive) occurrence of
  28436. Find_text inside within_text. The third parameter,
  28437. start_num, is optional (default=1) and specifies where to start searching
  28438. from. Character positions are 1-based.</para>
  28439. </summary>
  28440. </member>
  28441. <member name="F:NPOI.SS.Formula.Functions.TextFunction.SEARCH">
  28442. <summary>
  28443. Implementation of the FIND() function. SEARCH is a case-insensitive version of FIND()
  28444. <para>
  28445. Syntax: SEARCH(Find_text, within_text, start_num)
  28446. </para>
  28447. </summary>
  28448. </member>
  28449. <member name="T:NPOI.SS.Formula.Functions.Trim">
  28450. An implementation of the TRIM function:
  28451. Removes leading and trailing spaces from value if Evaluated operand
  28452. value Is string.
  28453. @author Manda Wilson &lt; wilson at c bio dot msk cc dot org &gt;
  28454. </member>
  28455. <member name="T:NPOI.SS.Formula.Functions.Upper">
  28456. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  28457. </member>
  28458. <member name="T:NPOI.SS.Formula.Functions.TimeFunc">
  28459. Implementation for the Excel function TIME
  28460. @author Steven Butler (sebutler @ gmail dot com)
  28461. Based on POI {@link DateFunc}
  28462. </member>
  28463. <member name="M:NPOI.SS.Formula.Functions.TimeFunc.Evaluate(System.Int32,System.Int32,System.Int32)">
  28464. Converts the supplied hours, minutes and seconds to an Excel time value.
  28465. @param ds array of 3 doubles Containing hours, minutes and seconds.
  28466. Non-integer inputs are tRuncated to an integer before further calculation
  28467. of the time value.
  28468. @return An Excel representation of a time of day.
  28469. If the time value represents more than a day, the days are Removed from
  28470. the result, leaving only the time of day component.
  28471. @throws NPOI.SS.Formula.Eval.EvaluationException
  28472. If any of the arguments are greater than 32767 or the hours
  28473. minutes and seconds when combined form a time value less than 0, the function
  28474. Evaluates to an error.
  28475. </member>
  28476. <member name="F:NPOI.SS.Formula.Functions.Value.MIN_DISTANCE_BETWEEN_THOUSANDS_SEPARATOR">
  28477. "1,0000" is valid, "1,00" is not
  28478. </member>
  28479. <member name="M:NPOI.SS.Formula.Functions.Value.ConvertTextToNumber(System.String)">
  28480. TODO see if the same functionality is needed in {@link OperandResolver#parseDouble(String)}
  28481. @return <code>null</code> if there is any problem converting the text
  28482. </member>
  28483. <member name="T:NPOI.SS.Formula.Functions.Var1or2ArgFunction">
  28484. Convenience base class for any function which must take two or three
  28485. arguments
  28486. @author Josh Micich
  28487. </member>
  28488. <member name="T:NPOI.SS.Formula.Functions.Var2or3ArgFunction">
  28489. Convenience base class for any function which must take two or three
  28490. arguments
  28491. @author Josh Micich
  28492. </member>
  28493. <member name="T:NPOI.SS.Formula.Functions.Var3or4ArgFunction">
  28494. Convenience base class for any function which must take three or four
  28495. arguments
  28496. @author Josh Micich
  28497. </member>
  28498. <member name="T:NPOI.SS.Formula.Functions.Vlookup">
  28499. Implementation of the VLOOKUP() function.<p/>
  28500. VLOOKUP Finds a row in a lookup table by the first column value and returns the value from another column.<br/>
  28501. <b>Syntax</b>:<br/>
  28502. <b>VLOOKUP</b>(<b>lookup_value</b>, <b>table_array</b>, <b>col_index_num</b>, range_lookup)<p/>
  28503. <b>lookup_value</b> The value to be found in the first column of the table array.<br/>
  28504. <b>table_array</b> An area reference for the lookup data. <br/>
  28505. <b>col_index_num</b> a 1 based index specifying which column value of the lookup data will be returned.<br/>
  28506. <b>range_lookup</b> If TRUE (default), VLOOKUP Finds the largest value less than or equal to
  28507. the lookup_value. If FALSE, only exact Matches will be considered<br/>
  28508. @author Josh Micich
  28509. </member>
  28510. <member name="M:NPOI.SS.Formula.Functions.Vlookup.CreateResultColumnVector(NPOI.SS.Formula.TwoDEval,System.Int32)">
  28511. Returns one column from an <c>AreaEval</c>
  28512. @(#VALUE!) if colIndex Is negative, (#REF!) if colIndex Is too high
  28513. </member>
  28514. <member name="T:NPOI.SS.Formula.Functions.WeekdayFunc">
  28515. Implementation for the Excel function WEEKDAY
  28516. @author Thies Wellpott
  28517. </member>
  28518. <member name="M:NPOI.SS.Formula.Functions.WeekdayFunc.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],System.Int32,System.Int32)">
  28519. * Perform WEEKDAY(date, returnOption) function.
  28520. * Note: Parameter texts are from German EXCEL-2010 help.
  28521. * Parameters in args[]:
  28522. * args[0] serialDate
  28523. * EXCEL-date value
  28524. * Standardmaessig ist der 1. Januar 1900 die fortlaufende Zahl 1 und
  28525. * der 1. Januar 2008 die fortlaufende Zahl 39.448, da dieser Tag nach 39.448 Tagen
  28526. * auf den 01.01.1900 folgt.
  28527. * @return Option (optional)
  28528. * Bestimmt den Rueckgabewert:
  28529. 1 oder nicht angegeben Zahl 1 (Sonntag) bis 7 (Samstag). Verhaelt sich wie fruehere Microsoft Excel-Versionen.
  28530. 2 Zahl 1 (Montag) bis 7 (Sonntag).
  28531. 3 Zahl 0 (Montag) bis 6 (Sonntag).
  28532. 11 Die Zahlen 1 (Montag) bis 7 (Sonntag)
  28533. 12 Die Zahlen 1 (Dienstag) bis 7 (Montag)
  28534. 13 Die Zahlen 1 (Mittwoch) bis 7 (Dienstag)
  28535. 14 Die Zahlen 1 (Donnerstag) bis 7 (Mittwoch)
  28536. 15 Die Zahlen 1 (Freitag) bis 7 (Donnerstag)
  28537. 16 Die Zahlen 1 (Samstag) bis 7 (Freitag)
  28538. 17 Die Zahlen 1 (Sonntag) bis 7 (Samstag)
  28539. </member>
  28540. <member name="T:NPOI.SS.Formula.Functions.WeekNum">
  28541. Implementation for Excel WeekNum() function.<p/>
  28542. <p/>
  28543. <b>Syntax</b>:<br/> <b>WeekNum </b>(<b>Serial_num</b>,<b>Return_type</b>)<br/>
  28544. <p/>
  28545. Returns a number that indicates where the week falls numerically within a year.
  28546. <p/>
  28547. <p/>
  28548. Serial_num is a date within the week. Dates should be entered by using the DATE function,
  28549. or as results of other formulas or functions. For example, use DATE(2008,5,23)
  28550. for the 23rd day of May, 2008. Problems can occur if dates are entered as text.
  28551. Return_type is a number that determines on which day the week begins. The default is 1.
  28552. 1 Week begins on Sunday. Weekdays are numbered 1 through 7.
  28553. 2 Week begins on Monday. Weekdays are numbered 1 through 7.
  28554. @author cedric dot walter @ gmail dot com
  28555. </member>
  28556. <member name="T:NPOI.SS.Formula.Functions.XYNumericFunction">
  28557. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  28558. </member>
  28559. <member name="M:NPOI.SS.Formula.Functions.XYNumericFunction.CreateAccumulator">
  28560. Constructs a new instance of the Accumulator used to calculated this function
  28561. </member>
  28562. <member name="T:NPOI.SS.Formula.Function.FunctionDataBuilder">
  28563. Temporarily collects <c>FunctionMetadata</c> instances for creation of a
  28564. <c>FunctionMetadataRegistry</c>.
  28565. @author Josh Micich
  28566. </member>
  28567. <member name="F:NPOI.SS.Formula.Function.FunctionDataBuilder._mutatingFunctionIndexes">
  28568. stores indexes of all functions with footnotes (i.e. whose definitions might Change)
  28569. </member>
  28570. <member name="T:NPOI.SS.Formula.Function.FunctionMetadata">
  28571. Holds information about Excel built-in functions.
  28572. @author Josh Micich
  28573. </member>
  28574. <member name="T:NPOI.SS.Formula.Function.FunctionMetadataReader">
  28575. Converts the text meta-data file into a <c>FunctionMetadataRegistry</c>
  28576. @author Josh Micich
  28577. </member>
  28578. <member name="F:NPOI.SS.Formula.Function.FunctionMetadataReader.ELLIPSIS">
  28579. plain ASCII text metadata file uses three dots for ellipsis
  28580. </member>
  28581. <member name="M:NPOI.SS.Formula.Function.FunctionMetadataReader.ValidateFunctionName(System.String)">
  28582. Makes sure that footnote digits from the original OOO document have not been accidentally
  28583. left behind
  28584. </member>
  28585. <member name="T:NPOI.SS.Formula.Function.FunctionMetadataRegistry">
  28586. Allows clients to Get <c>FunctionMetadata</c> instances for any built-in function of Excel.
  28587. @author Josh Micich
  28588. </member>
  28589. <member name="F:NPOI.SS.Formula.Function.FunctionMetadataRegistry.FUNCTION_NAME_IF">
  28590. The name of the IF function (i.e. "IF"). Extracted as a constant for clarity.
  28591. </member>
  28592. <member name="M:NPOI.SS.Formula.Function.FunctionMetadataRegistry.LookupIndexByName(System.String)">
  28593. Resolves a built-in function index.
  28594. @param name uppercase function name
  28595. @return a negative value if the function name is not found.
  28596. This typically occurs for external functions.
  28597. </member>
  28598. <member name="T:NPOI.SS.Formula.ICacheEntry">
  28599. A (mostly) opaque interface To allow test clients To trace cache values
  28600. Each spreadsheet cell Gets one unique cache entry instance. These objects
  28601. are safe To use as keys in {@link java.util.HashMap}s
  28602. </member>
  28603. <member name="T:NPOI.SS.Formula.IEvaluationListener">
  28604. Tests can implement this class To track the internal working of the {@link WorkbookEvaluator}.<br/>
  28605. For POI internal testing use only
  28606. @author Josh Micich
  28607. </member>
  28608. <member name="M:NPOI.SS.Formula.IEvaluationListener.SortDependentCachedValues(NPOI.SS.Formula.ICacheEntry[])">
  28609. Internally, formula {@link ICacheEntry}s are stored in Sets which may Change ordering due
  28610. To seemingly trivial Changes. This method is provided To make the order of call-backs To
  28611. {@link #onClearDependentCachedValue(ICacheEntry, int)} more deterministic.
  28612. </member>
  28613. <member name="T:NPOI.SS.Formula.IStabilityClassifier">
  28614. Used to help optimise cell evaluation result caching by allowing applications to specify which
  28615. parts of a workbook are <em>final</em>.<br/>
  28616. The term <b>final</b> is introduced here to denote immutability or 'having constant definition'.
  28617. This classification refers to potential actions (on the evaluated workbook) by the evaluating
  28618. application. It does not refer to operations performed by the evaluator ({@link
  28619. WorkbookEvaluator}).<br/>
  28620. <br/>
  28621. <b>General guidelines</b>:
  28622. <ul>
  28623. <li>a plain value cell can be marked as 'final' if it will not be changed after the first call
  28624. to {@link WorkbookEvaluator#evaluate(EvaluationCell)}.
  28625. </li>
  28626. <li>a formula cell can be marked as 'final' if its formula will not be changed after the first
  28627. call to {@link WorkbookEvaluator#evaluate(EvaluationCell)}. This remains true even if changes
  28628. in dependent values may cause the evaluated value to change.</li>
  28629. <li>plain value cells should be marked as 'not final' if their plain value value may change.
  28630. </li>
  28631. <li>formula cells should be marked as 'not final' if their formula definition may change.</li>
  28632. <li>cells which may switch between plain value and formula should also be marked as 'not final'.
  28633. </li>
  28634. </ul>
  28635. <b>Notes</b>:
  28636. <ul>
  28637. <li>If none of the spreadsheet cells is expected to have its definition changed after evaluation
  28638. begins, every cell can be marked as 'final'. This is the most efficient / least resource
  28639. intensive option.</li>
  28640. <li>To retain freedom to change any cell definition at any time, an application may classify all
  28641. cells as 'not final'. This freedom comes at the expense of greater memory consumption.</li>
  28642. <li>For the purpose of these classifications, setting the cached formula result of a cell (for
  28643. example in {@link HSSFFormulaEvaluator#evaluateFormulaCell(org.apache.poi.ss.usermodel.Cell)})
  28644. does not constitute changing the definition of the cell.</li>
  28645. <li>Updating cells which have been classified as 'final' will cause the evaluator to behave
  28646. unpredictably (typically ignoring the update).</li>
  28647. </ul>
  28648. @author Josh Micich
  28649. </member>
  28650. <member name="F:NPOI.SS.Formula.IStabilityClassifier.TOTALLY_IMMUTABLE">
  28651. Convenience implementation for situations where all cell definitions remain fixed after
  28652. evaluation begins.
  28653. </member>
  28654. <member name="M:NPOI.SS.Formula.IStabilityClassifier.IsCellFinal(System.Int32,System.Int32,System.Int32)">
  28655. Checks if a cell's value(/formula) is fixed - in other words - not expected to be modified
  28656. between calls to the evaluator. (Note - this is an independent concept from whether a
  28657. formula cell's evaluated value may change during successive calls to the evaluator).
  28658. @param sheetIndex zero based index into workbook sheet list
  28659. @param rowIndex zero based row index of cell
  28660. @param columnIndex zero based column index of cell
  28661. @return <c>false</c> if the evaluating application may need to modify the specified
  28662. cell between calls to the evaluator.
  28663. </member>
  28664. <member name="T:NPOI.SS.Formula.LazyAreaEval">
  28665. Provides Lazy Evaluation to 3D Ranges
  28666. </member>
  28667. <member name="M:NPOI.SS.Formula.LazyAreaEval.IsSubTotal(System.Int32,System.Int32)">
  28668. @return whether cell at rowIndex and columnIndex is a subtotal
  28669. </member>
  28670. <member name="T:NPOI.SS.Formula.LazyRefEval">
  28671. Provides Lazy Evaluation to a 3D Reference
  28672. TODO Provide access to multiple sheets where present
  28673. </member>
  28674. <member name="T:NPOI.SS.Formula.OperandClassTransformer">
  28675. This class performs 'operand class' transformation. Non-base Tokens are classified into three
  28676. operand classes:
  28677. <ul>
  28678. <li>reference</li>
  28679. <li>value</li>
  28680. <li>array</li>
  28681. </ul>
  28682. <p/>
  28683. The operand class chosen for each Token depends on the formula type and the Token's place
  28684. in the formula. If POI Gets the operand class wrong, Excel <em>may</em> interpret the formula
  28685. incorrectly. This condition is typically manifested as a formula cell that displays as '#VALUE!',
  28686. but resolves correctly when the user presses F2, enter.<p/>
  28687. The logic implemented here was partially inspired by the description in
  28688. "OpenOffice.org's Documentation of the Microsoft Excel File Format". The model presented there
  28689. seems To be inconsistent with observed Excel behaviour (These differences have not been fully
  28690. investigated). The implementation in this class Has been heavily modified in order To satisfy
  28691. concrete examples of how Excel performs the same logic (see TestRVA).<p/>
  28692. Hopefully, as Additional important test cases are identified and Added To the test suite,
  28693. patterns might become more obvious in this code and allow for simplification.
  28694. @author Josh Micich
  28695. </member>
  28696. <member name="M:NPOI.SS.Formula.OperandClassTransformer.TransformFormula(NPOI.SS.Formula.ParseNode)">
  28697. Traverses the supplied formula parse tree, calling <c>Ptg.SetClass()</c> for each non-base
  28698. Token To Set its operand class.
  28699. </member>
  28700. <member name="M:NPOI.SS.Formula.OperandClassTransformer.TransformNode(NPOI.SS.Formula.ParseNode,System.Byte,System.Boolean)">
  28701. @param callerForceArrayFlag <c>true</c> if one of the current node's parents is a
  28702. function Ptg which Has been Changed from default 'V' To 'A' type (due To requirements on
  28703. the function return value).
  28704. </member>
  28705. <member name="T:NPOI.SS.Formula.OperationEvaluationContext">
  28706. Contains all the contextual information required to Evaluate an operation
  28707. within a formula
  28708. For POI internal use only
  28709. @author Josh Micich
  28710. </member>
  28711. <member name="M:NPOI.SS.Formula.OperationEvaluationContext.CreateExternSheetRefEvaluator(System.String,System.String)">
  28712. @return <code>null</code> if either workbook or sheet is not found
  28713. </member>
  28714. <member name="M:NPOI.SS.Formula.OperationEvaluationContext.GetDynamicReference(System.String,System.String,System.String,System.String,System.Boolean)">
  28715. Resolves a cell or area reference dynamically.
  28716. @param workbookName the name of the workbook Containing the reference. If <code>null</code>
  28717. the current workbook is assumed. Note - to Evaluate formulas which use multiple workbooks,
  28718. a {@link CollaboratingWorkbooksEnvironment} must be set up.
  28719. @param sheetName the name of the sheet Containing the reference. May be <code>null</code>
  28720. (when <c>workbookName</c> is also null) in which case the current workbook and sheet is
  28721. assumed.
  28722. @param refStrPart1 the single cell reference or first part of the area reference. Must not
  28723. be <code>null</code>.
  28724. @param refStrPart2 the second part of the area reference. For single cell references this
  28725. parameter must be <code>null</code>
  28726. @param isA1Style specifies the format for <c>refStrPart1</c> and <c>refStrPart2</c>.
  28727. Pass <c>true</c> for 'A1' style and <c>false</c> for 'R1C1' style.
  28728. TODO - currently POI only supports 'A1' reference style
  28729. @return a {@link RefEval} or {@link AreaEval}
  28730. </member>
  28731. <member name="T:NPOI.SS.Formula.OperationEvaluatorFactory">
  28732. This class Creates <c>OperationEval</c> instances To help evaluate <c>OperationPtg</c>
  28733. formula Tokens.
  28734. @author Josh Micich
  28735. </member>
  28736. <member name="M:NPOI.SS.Formula.OperationEvaluatorFactory.Evaluate(NPOI.SS.Formula.PTG.OperationPtg,NPOI.SS.Formula.Eval.ValueEval[],NPOI.SS.Formula.OperationEvaluationContext)">
  28737. returns the OperationEval concrete impl instance corresponding
  28738. to the supplied operationPtg
  28739. </member>
  28740. <member name="T:NPOI.SS.Formula.ParseNode">
  28741. Represents a syntactic element from a formula by encapsulating the corresponding <c>Ptg</c>
  28742. Token. Each <c>ParseNode</c> may have child <c>ParseNode</c>s in the case when the wrapped
  28743. <c>Ptg</c> is non-atomic.
  28744. </member>
  28745. <member name="M:NPOI.SS.Formula.ParseNode.ToTokenArray(NPOI.SS.Formula.ParseNode)">
  28746. Collects the array of <c>Ptg</c> Tokens for the specified tree.
  28747. </member>
  28748. <member name="M:NPOI.SS.Formula.ParseNode.CollectIfPtgs(NPOI.SS.Formula.ParseNode.TokenCollector)">
  28749. The IF() function Gets marked up with two or three tAttr Tokens.
  28750. Similar logic will be required for CHOOSE() when it is supported
  28751. See excelfileformat.pdf sec 3.10.5 "tAttr (19H)
  28752. </member>
  28753. <member name="T:NPOI.SS.Formula.PlainCellCache">
  28754. @author Josh Micich
  28755. </member>
  28756. <member name="T:NPOI.SS.Formula.PlainValueCellCacheEntry">
  28757. Used for non-formula cells, primarily To keep track of the referencing (formula) cells.
  28758. @author Josh Micich
  28759. </member>
  28760. <member name="T:NPOI.SS.Formula.PTG.AbstractFunctionPtg">
  28761. This class provides the base functionality for Excel sheet functions
  28762. There are two kinds of function Ptgs - tFunc and tFuncVar
  28763. Therefore, this class will have ONLY two subclasses
  28764. @author Avik Sengupta
  28765. @author Andrew C. Oliver (acoliver at apache dot org)
  28766. </member>
  28767. <member name="F:NPOI.SS.Formula.PTG.AbstractFunctionPtg.FUNCTION_NAME_IF">
  28768. The name of the IF function (i.e. "IF"). Extracted as a constant for clarity.
  28769. </member>
  28770. <member name="F:NPOI.SS.Formula.PTG.AbstractFunctionPtg.FUNCTION_INDEX_EXTERNAL">
  28771. All external functions have function index 255
  28772. </member>
  28773. <member name="P:NPOI.SS.Formula.PTG.AbstractFunctionPtg.IsExternalFunction">
  28774. external functions Get some special Processing
  28775. @return <c>true</c> if this is an external function
  28776. </member>
  28777. <member name="M:NPOI.SS.Formula.PTG.AbstractFunctionPtg.IsBuiltInFunctionName(System.String)">
  28778. Used to detect whether a function name found in a formula is one of the standard excel functions
  28779. The name matching is case insensitive.
  28780. @return <c>true</c> if the name specifies a standard worksheet function,
  28781. <c>false</c> if the name should be assumed to be an external function.
  28782. </member>
  28783. <member name="M:NPOI.SS.Formula.PTG.AbstractFunctionPtg.LookupIndex(System.String)">
  28784. Resolves internal function names into function indexes.
  28785. The name matching is case insensitive.
  28786. @return the standard worksheet function index if found, otherwise <c>FUNCTION_INDEX_EXTERNAL</c>
  28787. </member>
  28788. <member name="T:NPOI.SS.Formula.PTG.AddPtg">
  28789. Addition operator PTG the "+" binomial operator. If you need more
  28790. explanation than that then well...We really can't help you here.
  28791. @author Andrew C. Oliver (acoliver@apache.org)
  28792. @author Jason Height (jheight at chariot dot net dot au)
  28793. </member>
  28794. <member name="M:NPOI.SS.Formula.PTG.AddPtg.ToFormulaString(System.String[])">
  28795. implementation of method from OperationsPtg
  28796. </member>
  28797. <member name="T:NPOI.SS.Formula.PTG.Area2DPtgBase">
  28798. Common superclass of 2-D area refs
  28799. </member>
  28800. <member name="T:NPOI.SS.Formula.PTG.Area3DPtg">
  28801. <p>Title: Area 3D Ptg - 3D reference (Sheet + Area)</p>
  28802. <p>Description: Defined an area in Extern Sheet. </p>
  28803. <p>REFERENCE: </p>
  28804. This is HSSF only, as it matches the HSSF file format way of
  28805. referring to the sheet by an extern index. The XSSF equivalent
  28806. is {@link Area3DPxg}
  28807. </member>
  28808. <member name="M:NPOI.SS.Formula.PTG.Area3DPtg.ToFormulaString(NPOI.SS.Formula.IFormulaRenderingWorkbook)">
  28809. @return text representation of this area reference that can be used in text
  28810. formulas. The sheet name will get properly delimited if required.
  28811. </member>
  28812. <member name="T:NPOI.SS.Formula.PTG.Area3DPxg">
  28813. <p>Title: XSSF Area 3D Reference (Sheet + Area)</p>
  28814. <p>Description: Defined an area in an external or different sheet. </p>
  28815. <p>REFERENCE: </p>
  28816. <p>This is XSSF only, as it stores the sheet / book references
  28817. in String form. The HSSF equivalent using indexes is {@link Area3DPtg}</p>
  28818. </member>
  28819. <member name="T:NPOI.SS.Formula.PTG.AreaErrPtg">
  28820. AreaErr - handles deleted cell area references.
  28821. @author Daniel Noll (daniel at nuix dot com dot au)
  28822. </member>
  28823. <member name="T:NPOI.SS.Formula.PTG.AreaI">
  28824. Common interface for AreaPtg and Area3DPtg, and their
  28825. child classes.
  28826. </member>
  28827. <member name="P:NPOI.SS.Formula.PTG.AreaI.FirstRow">
  28828. @return the first row in the area
  28829. </member>
  28830. <member name="P:NPOI.SS.Formula.PTG.AreaI.LastRow">
  28831. @return last row in the range (x2 in x1,y1-x2,y2)
  28832. </member>
  28833. <member name="P:NPOI.SS.Formula.PTG.AreaI.FirstColumn">
  28834. @return the first column number in the area.
  28835. </member>
  28836. <member name="P:NPOI.SS.Formula.PTG.AreaI.LastColumn">
  28837. @return lastcolumn in the area
  28838. </member>
  28839. <member name="T:NPOI.SS.Formula.PTG.AreaNPtg">
  28840. Specifies a rectangular area of cells A1:A4 for instance.
  28841. @author Jason Height (jheight at chariot dot net dot au)
  28842. </member>
  28843. <member name="T:NPOI.SS.Formula.PTG.AreaPtg">
  28844. Specifies a rectangular area of cells A1:A4 for instance.
  28845. @author Jason Height (jheight at chariot dot net dot au)
  28846. </member>
  28847. <member name="T:NPOI.SS.Formula.PTG.AreaPtgBase">
  28848. Specifies a rectangular area of cells A1:A4 for instance.
  28849. @author andy
  28850. @author Jason Height (jheight at chariot dot net dot au)
  28851. </member>
  28852. <member name="M:NPOI.SS.Formula.PTG.AreaPtgBase.NotImplemented">
  28853. TODO - (May-2008) fix subclasses of AreaPtg 'AreaN~' which are used in shared formulas.
  28854. see similar comment in ReferencePtg
  28855. </member>
  28856. <member name="F:NPOI.SS.Formula.PTG.AreaPtgBase.field_1_first_row">
  28857. zero based, Unsigned 16 bit
  28858. </member>
  28859. <member name="F:NPOI.SS.Formula.PTG.AreaPtgBase.field_2_last_row">
  28860. zero based, Unsigned 16 bit
  28861. </member>
  28862. <member name="F:NPOI.SS.Formula.PTG.AreaPtgBase.field_3_first_column">
  28863. zero based, Unsigned 8 bit
  28864. </member>
  28865. <member name="F:NPOI.SS.Formula.PTG.AreaPtgBase.field_4_last_column">
  28866. zero based, Unsigned 8 bit
  28867. </member>
  28868. <member name="M:NPOI.SS.Formula.PTG.AreaPtgBase.SortTopLeftToBottomRight">
  28869. Sort the first and last row and columns in-place to the preferred (top left:bottom right) order
  28870. Note: Sort only occurs when an instance is constructed or when this method is called.
  28871. <p>For example, <code>$E5:B$10</code> becomes <code>B5:$E$10</code></p>
  28872. </member>
  28873. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.FirstRow">
  28874. @return the first row in the area
  28875. </member>
  28876. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.LastRow">
  28877. @return last row in the range (x2 in x1,y1-x2,y2)
  28878. </member>
  28879. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.FirstColumn">
  28880. @return the first column number in the area.
  28881. </member>
  28882. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.IsFirstRowRelative">
  28883. @return whether or not the first row is a relative reference or not.
  28884. </member>
  28885. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.IsFirstColRelative">
  28886. @return Isrelative first column to relative or not
  28887. </member>
  28888. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.LastColumn">
  28889. @return lastcolumn in the area
  28890. </member>
  28891. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.LastColumnRaw">
  28892. @return last column and bitmask (the raw field)
  28893. </member>
  28894. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.IsLastRowRelative">
  28895. @return last row relative or not
  28896. </member>
  28897. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.IsLastColRelative">
  28898. @return lastcol relative or not
  28899. </member>
  28900. <member name="M:NPOI.SS.Formula.PTG.AreaPtgBase.SetLastColumnRaw(System.Int16)">
  28901. Set the last column irrespective of the bitmasks
  28902. </member>
  28903. <member name="T:NPOI.SS.Formula.PTG.ArrayPtg">
  28904. ArrayPtg - handles arrays
  28905. The ArrayPtg is a little weird, the size of the Ptg when parsing initially only
  28906. includes the Ptg sid and the reserved bytes. The next Ptg in the expression then follows.
  28907. It is only after the "size" of all the Ptgs is met, that the ArrayPtg data is actually
  28908. held after this. So Ptg.CreateParsedExpression keeps track of the number of
  28909. ArrayPtg elements and need to Parse the data upto the FORMULA record size.
  28910. @author Jason Height (jheight at chariot dot net dot au)
  28911. </member>
  28912. <member name="F:NPOI.SS.Formula.PTG.ArrayPtg.PLAIN_TOKEN_SIZE">
  28913. The size of the plain tArray token written within the standard formula tokens
  28914. (not including the data which comes after all formula tokens)
  28915. </member>
  28916. <member name="M:NPOI.SS.Formula.PTG.ArrayPtg.#ctor(System.Object[][])">
  28917. @param values2d array values arranged in rows
  28918. </member>
  28919. <member name="M:NPOI.SS.Formula.PTG.ArrayPtg.GetValueIndex(System.Int32,System.Int32)">
  28920. Note - (2D) array elements are stored column by column
  28921. @return the index into the internal 1D array for the specified column and row
  28922. </member>
  28923. <member name="P:NPOI.SS.Formula.PTG.ArrayPtg.Size">
  28924. This size includes the size of the array Ptg plus the Array Ptg Token value size
  28925. </member>
  28926. <member name="T:NPOI.SS.Formula.PTG.ArrayPtg.Initial">
  28927. Represents the initial plain tArray token (without the constant data that trails the whole
  28928. formula). Objects of this class are only temporary and cannot be used as {@link Ptg}s.
  28929. These temporary objects get converted to {@link ArrayPtg} by the
  28930. {@link #finishReading(LittleEndianInput)} method.
  28931. </member>
  28932. <member name="M:NPOI.SS.Formula.PTG.ArrayPtg.Initial.FinishReading(NPOI.Util.ILittleEndianInput)">
  28933. Read in the actual token (array) values. This occurs
  28934. AFTER the last Ptg in the expression.
  28935. See page 304-305 of Excel97-2007BinaryFileFormat(xls)Specification.pdf
  28936. </member>
  28937. <member name="T:NPOI.SS.Formula.PTG.AttrPtg">
  28938. "Special Attributes"
  28939. This seems to be a Misc Stuff and Junk record. One function it serves Is
  28940. in SUM functions (i.e. SUM(A1:A3) causes an area PTG then an ATTR with the SUM option Set)
  28941. @author andy
  28942. @author Jason Height (jheight at chariot dot net dot au)
  28943. </member>
  28944. <member name="F:NPOI.SS.Formula.PTG.AttrPtg._jumpTable">
  28945. only used for tAttrChoose: table of offsets to starts of args
  28946. </member>
  28947. <member name="F:NPOI.SS.Formula.PTG.AttrPtg._chooseFuncOffset">
  28948. only used for tAttrChoose: offset to the tFuncVar for CHOOSE()
  28949. </member>
  28950. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.SpaceBefore">
  28951. 00H = Spaces before the next token (not allowed before tParen token)
  28952. </member>
  28953. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.CrBefore">
  28954. 01H = Carriage returns before the next token (not allowed before tParen token)
  28955. </member>
  28956. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.SpaceBeforeOpenParen">
  28957. 02H = Spaces before opening parenthesis (only allowed before tParen token)
  28958. </member>
  28959. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.CrBeforeOpenParen">
  28960. 03H = Carriage returns before opening parenthesis (only allowed before tParen token)
  28961. </member>
  28962. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.SpaceBeforeCloseParen">
  28963. 04H = Spaces before closing parenthesis (only allowed before tParen, tFunc, and tFuncVar tokens)
  28964. </member>
  28965. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.CrBeforeCloseParen">
  28966. 05H = Carriage returns before closing parenthesis (only allowed before tParen, tFunc, and tFuncVar tokens)
  28967. </member>
  28968. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.SpaceAfterEquality">
  28969. 06H = Spaces following the equality sign (only in macro sheets)
  28970. </member>
  28971. <member name="M:NPOI.SS.Formula.PTG.AttrPtg.CreateSpace(NPOI.SS.Formula.PTG.AttrPtg.SpaceType,System.Int32)">
  28972. <summary>
  28973. Creates the space.
  28974. </summary>
  28975. <param name="type">a constant from SpaceType</param>
  28976. <param name="count">The count.</param>
  28977. </member>
  28978. <member name="M:NPOI.SS.Formula.PTG.AttrPtg.CreateIf(System.Int32)">
  28979. <summary>
  28980. Creates if.
  28981. </summary>
  28982. <param name="dist">distance (in bytes) to start of either
  28983. tFuncVar(IF) token (when false parameter is not present).</param>
  28984. </member>
  28985. <member name="M:NPOI.SS.Formula.PTG.AttrPtg.CreateSkip(System.Int32)">
  28986. <summary>
  28987. Creates the skip.
  28988. </summary>
  28989. <param name="dist">distance (in bytes) to position behind tFuncVar(IF) token (minus 1).</param>
  28990. </member>
  28991. <member name="T:NPOI.SS.Formula.PTG.BoolPtg">
  28992. bool (bool)
  28993. Stores a (java) bool value in a formula.
  28994. @author Paul Krause (pkrause at soundbite dot com)
  28995. @author Andrew C. Oliver (acoliver at apache dot org)
  28996. @author Jason Height (jheight at chariot dot net dot au)
  28997. </member>
  28998. <member name="T:NPOI.SS.Formula.PTG.ConcatPtg">
  28999. @author andy
  29000. @author Jason Height (jheight at chariot dot net dot au)
  29001. </member>
  29002. <member name="T:NPOI.SS.Formula.PTG.ControlPtg">
  29003. Common baseclass for
  29004. tExp
  29005. tTbl
  29006. tParen
  29007. tNlr
  29008. tAttr
  29009. tSheet
  29010. tEndSheet
  29011. </member>
  29012. <member name="T:NPOI.SS.Formula.PTG.Deleted3DPxg">
  29013. An XSSF only representation of a reference to a deleted area
  29014. </member>
  29015. <member name="T:NPOI.SS.Formula.PTG.DeletedArea3DPtg">
  29016. Title: Deleted Area 3D Ptg - 3D referecnce (Sheet + Area)
  29017. Description: Defined a area in Extern Sheet.
  29018. REFERENCE:
  29019. @author Patrick Luby
  29020. @version 1.0-pre
  29021. </member>
  29022. <member name="T:NPOI.SS.Formula.PTG.DeletedRef3DPtg">
  29023. Title: Deleted Reference 3D Ptg
  29024. Description: Defined a cell in extern sheet.
  29025. REFERENCE:
  29026. @author Patrick Luby
  29027. @version 1.0-pre
  29028. </member>
  29029. <member name="M:NPOI.SS.Formula.PTG.DeletedRef3DPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  29030. Creates new DeletedRef3DPtg
  29031. </member>
  29032. <member name="T:NPOI.SS.Formula.PTG.DividePtg">
  29033. This PTG implements the standard binomial divide "/"
  29034. @author Andrew C. Oliver acoliver at apache dot org
  29035. @author Jason Height (jheight at chariot dot net dot au)
  29036. </member>
  29037. <member name="T:NPOI.SS.Formula.PTG.EqualPtg">
  29038. @author andy
  29039. </member>
  29040. <member name="T:NPOI.SS.Formula.PTG.ErrPtg">
  29041. @author Daniel Noll (daniel at nuix dot com dot au)
  29042. </member>
  29043. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.NULL_INTERSECTION">
  29044. <b>#NULL!</b> - Intersection of two cell ranges is empty
  29045. </member>
  29046. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.DIV_ZERO">
  29047. <b>#DIV/0!</b> - Division by zero
  29048. </member>
  29049. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.VALUE_INVALID">
  29050. <b>#VALUE!</b> - Wrong type of operand
  29051. </member>
  29052. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.REF_INVALID">
  29053. <b>#REF!</b> - Illegal or deleted cell reference
  29054. </member>
  29055. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.NAME_INVALID">
  29056. <b>#NAME?</b> - Wrong function or range name
  29057. </member>
  29058. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.NUM_ERROR">
  29059. <b>#NUM!</b> - Value range overflow
  29060. </member>
  29061. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.N_A">
  29062. <b>#N/A</b> - Argument or function not available
  29063. </member>
  29064. <member name="M:NPOI.SS.Formula.PTG.ErrPtg.#ctor(System.Int32)">
  29065. Creates new ErrPtg
  29066. </member>
  29067. <member name="T:NPOI.SS.Formula.PTG.ExpPtg">
  29068. @author andy
  29069. @author Jason Height (jheight at chariot dot net dot au)
  29070. @author dmui (save existing implementation)
  29071. </member>
  29072. <member name="T:NPOI.SS.Formula.PTG.FuncPtg">
  29073. @author aviks
  29074. @author Jason Height (jheight at chariot dot net dot au)
  29075. @author Danny Mui (dmui at apache dot org) (Leftover handling)
  29076. </member>
  29077. <member name="T:NPOI.SS.Formula.PTG.FuncVarPtg">
  29078. @author Jason Height (jheight at chariot dot net dot au)
  29079. </member>
  29080. <member name="F:NPOI.SS.Formula.PTG.FuncVarPtg.SUM">
  29081. Single instance of this token for 'sum() taking a single argument'
  29082. </member>
  29083. <member name="M:NPOI.SS.Formula.PTG.FuncVarPtg.Create(NPOI.Util.ILittleEndianInput)">
  29084. Creates new function pointer from a byte array
  29085. usually called while reading an excel file.
  29086. </member>
  29087. <member name="M:NPOI.SS.Formula.PTG.FuncVarPtg.Create(System.String,System.Int32)">
  29088. Create a function ptg from a string tokenised by the parser
  29089. </member>
  29090. <member name="T:NPOI.SS.Formula.PTG.GreaterEqualPtg">
  29091. PTG class to implement greater or equal to
  29092. @author fred at stsci dot edu
  29093. </member>
  29094. <member name="T:NPOI.SS.Formula.PTG.GreaterThanPtg">
  29095. Greater than operator PTG ">"
  29096. @author Cameron Riley (criley at ekmail.com)
  29097. </member>
  29098. <member name="P:NPOI.SS.Formula.PTG.GreaterThanPtg.NumberOfOperands">
  29099. Get the number of operands for the Less than operator
  29100. @return int the number of operands
  29101. </member>
  29102. <member name="M:NPOI.SS.Formula.PTG.GreaterThanPtg.ToFormulaString(System.String[])">
  29103. Implementation of method from OperationsPtg
  29104. @param operands a String array of operands
  29105. @return String the Formula as a String
  29106. </member>
  29107. <member name="T:NPOI.SS.Formula.PTG.IntersectionPtg">
  29108. @author Daniel Noll (daniel at nuix dot com dot au)
  29109. </member>
  29110. <member name="M:NPOI.SS.Formula.PTG.IntersectionPtg.ToFormulaString">
  29111. Implementation of method from Ptg
  29112. </member>
  29113. <member name="M:NPOI.SS.Formula.PTG.IntersectionPtg.ToFormulaString(System.String[])">
  29114. implementation of method from OperationsPtg
  29115. </member>
  29116. <member name="T:NPOI.SS.Formula.PTG.IntPtg">
  29117. Integer (unsigned short integer)
  29118. Stores an Unsigned short value (java int) in a formula
  29119. @author Andrew C. Oliver (acoliver at apache dot org)
  29120. @author Jason Height (jheight at chariot dot net dot au)
  29121. </member>
  29122. <member name="M:NPOI.SS.Formula.PTG.IntPtg.IsInRange(System.Int32)">
  29123. Excel represents integers 0..65535 with the tInt token.
  29124. @return <c>true</c> if the specified value is within the range of values
  29125. <c>IntPtg</c> can represent.
  29126. </member>
  29127. <member name="T:NPOI.SS.Formula.PTG.LessEqualPtg">
  29128. Ptg class to implement less than or equal
  29129. @author fred at stsci dot edu
  29130. </member>
  29131. <member name="T:NPOI.SS.Formula.PTG.LessThanPtg">
  29132. Less than operator PTG "&lt;". The SID is taken from the
  29133. Openoffice.orgs Documentation of the Excel File Format,
  29134. Table 3.5.7
  29135. @author Cameron Riley (criley at ekmail.com)
  29136. </member>
  29137. <member name="F:NPOI.SS.Formula.PTG.LessThanPtg.sid">
  29138. the sid for the less than operator as hex
  29139. </member>
  29140. <member name="F:NPOI.SS.Formula.PTG.LessThanPtg.LESSTHAN">
  29141. identifier for LESS THAN char
  29142. </member>
  29143. <member name="P:NPOI.SS.Formula.PTG.LessThanPtg.NumberOfOperands">
  29144. Get the number of operands for the Less than operator
  29145. @return int the number of operands
  29146. </member>
  29147. <member name="M:NPOI.SS.Formula.PTG.LessThanPtg.ToFormulaString(System.String[])">
  29148. Implementation of method from OperationsPtg
  29149. @param operands a String array of operands
  29150. @return String the Formula as a String
  29151. </member>
  29152. <member name="T:NPOI.SS.Formula.PTG.MemAreaPtg">
  29153. @author Daniel Noll (daniel at nuix dot com dot au)
  29154. </member>
  29155. <member name="M:NPOI.SS.Formula.PTG.MemAreaPtg.#ctor(System.Int32)">
  29156. Creates new MemAreaPtg
  29157. </member>
  29158. <member name="T:NPOI.SS.Formula.PTG.MemErrPtg">
  29159. @author andy
  29160. @author Jason Height (jheight at chariot dot net dot au)
  29161. @author Daniel Noll (daniel at nuix dot com dot au)
  29162. </member>
  29163. <member name="M:NPOI.SS.Formula.PTG.MemErrPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  29164. Creates new MemErrPtg
  29165. </member>
  29166. <member name="T:NPOI.SS.Formula.PTG.MemFuncPtg">
  29167. @author Glen Stampoultzis (glens at apache.org)
  29168. </member>
  29169. <member name="M:NPOI.SS.Formula.PTG.MemFuncPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  29170. Creates new function pointer from a byte array
  29171. usually called while Reading an excel file.
  29172. </member>
  29173. <member name="T:NPOI.SS.Formula.PTG.MissingArgPtg">
  29174. Missing Function Arguments
  29175. Avik Sengupta &lt;avik at apache.org&gt;
  29176. @author Jason Height (jheight at chariot dot net dot au)
  29177. </member>
  29178. <member name="T:NPOI.SS.Formula.PTG.MultiplyPtg">
  29179. Implements the standard mathmatical multiplication - *
  29180. @author Andrew C. Oliver (acoliver at apache dot org)
  29181. @author Jason Height (jheight at chariot dot net dot au)
  29182. </member>
  29183. <member name="T:NPOI.SS.Formula.PTG.NamePtg">
  29184. @author andy
  29185. @author Jason Height (jheight at chariot dot net dot au)
  29186. </member>
  29187. <member name="F:NPOI.SS.Formula.PTG.NamePtg.field_1_label_index">
  29188. one-based index to defined name record
  29189. </member>
  29190. <member name="M:NPOI.SS.Formula.PTG.NamePtg.#ctor(System.Int32)">
  29191. @param nameIndex zero-based index to name within workbook
  29192. </member>
  29193. <member name="M:NPOI.SS.Formula.PTG.NamePtg.#ctor(NPOI.Util.ILittleEndianInput)">
  29194. Creates new NamePtg
  29195. </member>
  29196. <member name="P:NPOI.SS.Formula.PTG.NamePtg.Index">
  29197. @return zero based index to a defined name record in the LinkTable
  29198. </member>
  29199. <member name="T:NPOI.SS.Formula.PTG.NameXPtg">
  29200. A Name, be that a Named Range or a Function / User Defined
  29201. Function, addressed in the HSSF External Sheet style.
  29202. This is HSSF only, as it matches the HSSF file format way of
  29203. referring to the sheet by an extern index. The XSSF equivalent
  29204. is {@link NameXPxg}
  29205. </member>
  29206. <member name="F:NPOI.SS.Formula.PTG.NameXPtg._sheetRefIndex">
  29207. index to REF entry in externsheet record
  29208. </member>
  29209. <member name="F:NPOI.SS.Formula.PTG.NameXPtg._nameNumber">
  29210. index to defined name or externname table(1 based)
  29211. </member>
  29212. <member name="F:NPOI.SS.Formula.PTG.NameXPtg._reserved">
  29213. reserved must be 0
  29214. </member>
  29215. <member name="M:NPOI.SS.Formula.PTG.NameXPtg.#ctor(System.Int32,System.Int32)">
  29216. @param sheetRefIndex index to REF entry in externsheet record
  29217. @param nameIndex index to defined name or externname table
  29218. </member>
  29219. <member name="T:NPOI.SS.Formula.PTG.NameXPxg">
  29220. A Name, be that a Named Range or a Function / User Defined
  29221. Function, Addressed in the HSSF External Sheet style.
  29222. <p>This is XSSF only, as it stores the sheet / book references
  29223. in String form. The HSSF equivalent using indexes is {@link NameXPtg}</p>
  29224. </member>
  29225. <member name="T:NPOI.SS.Formula.PTG.NotEqualPtg">
  29226. Ptg class to implement not equal
  29227. @author fred at stsci dot edu
  29228. </member>
  29229. <member name="T:NPOI.SS.Formula.PTG.NumberPtg">
  29230. Number
  29231. Stores a floating point value in a formula
  29232. value stored in a 8 byte field using IEEE notation
  29233. @author Avik Sengupta
  29234. @author Jason Height (jheight at chariot dot net dot au)
  29235. </member>
  29236. <member name="M:NPOI.SS.Formula.PTG.NumberPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  29237. Create a NumberPtg from a byte array Read from disk
  29238. </member>
  29239. <member name="M:NPOI.SS.Formula.PTG.NumberPtg.#ctor(System.String)">
  29240. Create a NumberPtg from a string representation of the number
  29241. Number format is not checked, it is expected to be validated in the parser
  29242. that calls this method.
  29243. @param value : String representation of a floating point number
  29244. </member>
  29245. <member name="T:NPOI.SS.Formula.PTG.OperandPtg">
  29246. @author Josh Micich
  29247. </member>
  29248. <member name="P:NPOI.SS.Formula.PTG.OperandPtg.IsBaseToken">
  29249. All Operand <c>Ptg</c>s are classifed ('relative', 'value', 'array')
  29250. </member>
  29251. <member name="T:NPOI.SS.Formula.PTG.OperationPtg">
  29252. defines a Ptg that is an operation instead of an operand
  29253. @author andy
  29254. </member>
  29255. <member name="M:NPOI.SS.Formula.PTG.OperationPtg.ToFormulaString(System.String[])">
  29256. returns a string representation of the operations
  29257. the Length of the input array should equal the number returned by
  29258. @see #GetNumberOfOperands
  29259. </member>
  29260. <member name="P:NPOI.SS.Formula.PTG.OperationPtg.NumberOfOperands">
  29261. The number of operands expected by the operations
  29262. </member>
  29263. <member name="T:NPOI.SS.Formula.PTG.ParenthesisPtg">
  29264. While formula tokens are stored in RPN order and thus do not need parenthesis for
  29265. precedence reasons, Parenthesis tokens ARE written to Ensure that user entered
  29266. parenthesis are Displayed as-is on Reading back
  29267. Avik Sengupta &lt;lists@aviksengupta.com&gt;
  29268. Andrew C. Oliver (acoliver at apache dot org)
  29269. @author Jason Height (jheight at chariot dot net dot au)
  29270. </member>
  29271. <member name="T:NPOI.SS.Formula.PTG.PercentPtg">
  29272. Percent PTG.
  29273. @author Daniel Noll (daniel at nuix.com.au)
  29274. </member>
  29275. <member name="T:NPOI.SS.Formula.PTG.PowerPtg">
  29276. @author andy
  29277. @author Jason Height (jheight at chariot dot net dot au)
  29278. </member>
  29279. <member name="T:NPOI.SS.Formula.PTG.Ptg">
  29280. <c>Ptg</c> represents a syntactic token in a formula. 'PTG' is an acronym for
  29281. '<b>p</b>arse <b>t</b>hin<b>g</b>'. Originally, the name referred to the single
  29282. byte identifier at the start of the token, but in POI, <c>Ptg</c> encapsulates
  29283. the whole formula token (initial byte + value data).
  29284. <c>Ptg</c>s are logically arranged in a tree representing the structure of the
  29285. Parsed formula. However, in BIFF files <c>Ptg</c>s are written/Read in
  29286. <em>Reverse-Polish Notation</em> order. The RPN ordering also simplifies formula
  29287. evaluation logic, so POI mostly accesses <c>Ptg</c>s in the same way.
  29288. @author andy
  29289. @author avik
  29290. @author Jason Height (jheight at chariot dot net dot au)
  29291. </member>
  29292. <member name="M:NPOI.SS.Formula.PTG.Ptg.ReadTokens(System.Int32,NPOI.Util.ILittleEndianInput)">
  29293. Reads <c>size</c> bytes of the input stream, to Create an array of <c>Ptg</c>s.
  29294. Extra data (beyond <c>size</c>) may be Read if and <c>ArrayPtg</c>s are present.
  29295. </member>
  29296. <member name="M:NPOI.SS.Formula.PTG.Ptg.Clone">
  29297. @return a distinct copy of this <c>Ptg</c> if the class is mutable, or the same instance
  29298. if the class is immutable.
  29299. </member>
  29300. <member name="M:NPOI.SS.Formula.PTG.Ptg.GetEncodedSize(NPOI.SS.Formula.PTG.Ptg[])">
  29301. This method will return the same result as {@link #getEncodedSizeWithoutArrayData(Ptg[])}
  29302. if there are no array tokens present.
  29303. @return the full size taken to encode the specified <c>Ptg</c>s
  29304. </member>
  29305. <member name="M:NPOI.SS.Formula.PTG.Ptg.GetEncodedSizeWithoutArrayData(NPOI.SS.Formula.PTG.Ptg[])">
  29306. Used to calculate value that should be encoded at the start of the encoded Ptg token array;
  29307. @return the size of the encoded Ptg tokens not including any trailing array data.
  29308. </member>
  29309. <member name="M:NPOI.SS.Formula.PTG.Ptg.SerializePtgs(NPOI.SS.Formula.PTG.Ptg[],System.Byte[],System.Int32)">
  29310. Writes the ptgs to the data buffer, starting at the specified offset.
  29311. <br/>
  29312. The 2 byte encode Length field is <b>not</b> written by this method.
  29313. @return number of bytes written
  29314. </member>
  29315. <member name="P:NPOI.SS.Formula.PTG.Ptg.Size">
  29316. @return the encoded Length of this Ptg, including the initial Ptg type identifier byte.
  29317. </member>
  29318. <member name="P:NPOI.SS.Formula.PTG.Ptg.IsBaseToken">
  29319. @return <c>false</c> if this token is classified as 'reference', 'value', or 'array'
  29320. </member>
  29321. <member name="M:NPOI.SS.Formula.PTG.Ptg.Write(NPOI.Util.ILittleEndianOutput)">
  29322. Write this Ptg to a byte array
  29323. </member>
  29324. <member name="M:NPOI.SS.Formula.PTG.Ptg.ToFormulaString">
  29325. return a string representation of this token alone
  29326. </member>
  29327. <member name="M:NPOI.SS.Formula.PTG.Ptg.ToString">
  29328. Overridden toString method to Ensure object hash is not printed.
  29329. This helps Get rid of gratuitous diffs when comparing two dumps
  29330. Subclasses may output more relevant information by overriding this method
  29331. </member>
  29332. <member name="P:NPOI.SS.Formula.PTG.Ptg.PtgClass">
  29333. @return the 'operand class' (REF/VALUE/ARRAY) for this Ptg
  29334. </member>
  29335. <member name="P:NPOI.SS.Formula.PTG.Ptg.RVAType">
  29336. Debug / diagnostic method to get this token's 'operand class' type.
  29337. @return 'R' for 'reference', 'V' for 'value', 'A' for 'array' and '.' for base tokens
  29338. </member>
  29339. <member name="T:NPOI.SS.Formula.PTG.Pxg">
  29340. An XSSF only special kind of Ptg, which stores the sheet / book
  29341. reference in string form.
  29342. </member>
  29343. <member name="T:NPOI.SS.Formula.PTG.Pxg3D">
  29344. An XSSF only special kind of Ptg, which stores a range of
  29345. sheet / book references in string form.
  29346. </member>
  29347. <member name="T:NPOI.SS.Formula.PTG.RangePtg">
  29348. @author Daniel Noll (daniel at nuix dot com dot au)
  29349. </member>
  29350. <member name="M:NPOI.SS.Formula.PTG.RangePtg.ToFormulaString(System.String[])">
  29351. implementation of method from OperationsPtg
  29352. </member>
  29353. <member name="T:NPOI.SS.Formula.PTG.Ref2DPtgBase">
  29354. @author Josh Micich
  29355. </member>
  29356. <member name="M:NPOI.SS.Formula.PTG.Ref2DPtgBase.#ctor(System.String)">
  29357. Takes in a String representation of a cell reference and fills out the
  29358. numeric fields.
  29359. </member>
  29360. <member name="T:NPOI.SS.Formula.PTG.Ref3DPtg">
  29361. Title: Reference 3D Ptg
  29362. Description: Defined a cell in extern sheet.
  29363. REFERENCE:
  29364. @author Libin Roman (Vista Portal LDT. Developer)
  29365. @author Jason Height (jheight at chariot dot net dot au)
  29366. @version 1.0-pre
  29367. </member>
  29368. <member name="F:NPOI.SS.Formula.PTG.Ref3DPtg.rowRelative">
  29369. Field 2
  29370. - lower 8 bits is the zero based Unsigned byte column index
  29371. - bit 16 - IsRowRelative
  29372. - bit 15 - IsColumnRelative
  29373. </member>
  29374. <member name="M:NPOI.SS.Formula.PTG.Ref3DPtg.#ctor">
  29375. Creates new AreaPtg
  29376. </member>
  29377. <member name="M:NPOI.SS.Formula.PTG.Ref3DPtg.ToFormulaString(NPOI.SS.Formula.IFormulaRenderingWorkbook)">
  29378. @return text representation of this cell reference that can be used in text
  29379. formulas. The sheet name will Get properly delimited if required.
  29380. </member>
  29381. <member name="T:NPOI.SS.Formula.PTG.Ref3DPxg">
  29382. <p>Title: XSSF 3D Reference</p>
  29383. <p>Description: Defines a cell in an external or different sheet.</p>
  29384. <p>REFERENCE: </p>
  29385. <p>This is XSSF only, as it stores the sheet / book references
  29386. in String form. The HSSF equivalent using indexes is {@link Ref3DPtg}</p>
  29387. </member>
  29388. <member name="T:NPOI.SS.Formula.PTG.RefErrorPtg">
  29389. RefError - handles deleted cell reference
  29390. @author Jason Height (jheight at chariot dot net dot au)
  29391. </member>
  29392. <member name="T:NPOI.SS.Formula.PTG.RefNPtg">
  29393. RefNPtg
  29394. @author Jason Height (jheight at apache dot com)
  29395. </member>
  29396. <member name="M:NPOI.SS.Formula.PTG.RefNPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  29397. Creates new ValueReferencePtg
  29398. </member>
  29399. <member name="T:NPOI.SS.Formula.PTG.RefPtg">
  29400. ReferencePtg - handles references (such as A1, A2, IA4)
  29401. @author Andrew C. Oliver (acoliver@apache.org)
  29402. @author Jason Height (jheight at chariot dot net dot au)
  29403. </member>
  29404. <member name="M:NPOI.SS.Formula.PTG.RefPtg.#ctor(System.String)">
  29405. Takes in a String representation of a cell reference and Fills out the
  29406. numeric fields.
  29407. </member>
  29408. <member name="T:NPOI.SS.Formula.PTG.RefPtgBase">
  29409. ReferencePtgBase - handles references (such as A1, A2, IA4)
  29410. @author Andrew C. Oliver (acoliver@apache.org)
  29411. @author Jason Height (jheight at chariot dot net dot au)
  29412. </member>
  29413. <member name="F:NPOI.SS.Formula.PTG.RefPtgBase.field_1_row">
  29414. The row index - zero based Unsigned 16 bit value
  29415. </member>
  29416. <member name="F:NPOI.SS.Formula.PTG.RefPtgBase.field_2_col">
  29417. Field 2
  29418. - lower 8 bits is the zero based Unsigned byte column index
  29419. - bit 16 - IsRowRelative
  29420. - bit 15 - IsColumnRelative
  29421. </member>
  29422. <member name="M:NPOI.SS.Formula.PTG.RefPtgBase.#ctor(System.String)">
  29423. Takes in a String representation of a cell reference and Fills out the
  29424. numeric fields.
  29425. </member>
  29426. <member name="P:NPOI.SS.Formula.PTG.RefPtgBase.Row">
  29427. Returns the row number as a short, which will be
  29428. wrapped (negative) for values between 32769 and 65535
  29429. </member>
  29430. <member name="P:NPOI.SS.Formula.PTG.RefPtgBase.RowAsInt">
  29431. Returns the row number as an int, between 0 and 65535
  29432. </member>
  29433. <member name="T:NPOI.SS.Formula.PTG.ScalarConstantPtg">
  29434. @author Josh Micich
  29435. </member>
  29436. <member name="T:NPOI.SS.Formula.PTG.StringPtg">
  29437. String Stores a String value in a formula value stored in the format
  29438. &lt;Length 2 bytes&gt;char[]
  29439. @author Werner Froidevaux
  29440. @author Jason Height (jheight at chariot dot net dot au)
  29441. @author Bernard Chesnoy
  29442. </member>
  29443. <member name="F:NPOI.SS.Formula.PTG.StringPtg.FORMULA_DELIMITER">
  29444. the Char (")used in formulas to delimit string literals
  29445. </member>
  29446. <member name="F:NPOI.SS.Formula.PTG.StringPtg.field_1_Length">
  29447. NOTE: OO doc says 16bit Length, but BiffViewer says 8 Book says something
  29448. totally different, so don't look there!
  29449. </member>
  29450. <member name="M:NPOI.SS.Formula.PTG.StringPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  29451. Create a StringPtg from a stream
  29452. </member>
  29453. <member name="M:NPOI.SS.Formula.PTG.StringPtg.#ctor(System.String)">
  29454. Create a StringPtg from a string representation of the number Number
  29455. format Is not Checked, it Is expected to be Validated in the Parser that
  29456. calls this method.
  29457. @param value :
  29458. String representation of a floating point number
  29459. </member>
  29460. <member name="T:NPOI.SS.Formula.PTG.SubtractPtg">
  29461. @author andy
  29462. @author Jason Height (jheight at chariot dot net dot au)
  29463. </member>
  29464. <member name="T:NPOI.SS.Formula.PTG.TblPtg">
  29465. This ptg indicates a data table.
  29466. It only occurs in a FORMULA record, never in an
  29467. ARRAY or NAME record. When ptgTbl occurs in a
  29468. formula, it is the only token in the formula.
  29469. This indicates that the cell containing the
  29470. formula is an interior cell in a data table;
  29471. the table description is found in a TABLE
  29472. record. Rows and columns which contain input
  29473. values to be substituted in the table do
  29474. not contain ptgTbl.
  29475. See page 811 of the june 08 binary docs.
  29476. </member>
  29477. <member name="F:NPOI.SS.Formula.PTG.TblPtg.field_1_first_row">
  29478. The row number of the upper left corner
  29479. </member>
  29480. <member name="F:NPOI.SS.Formula.PTG.TblPtg.field_2_first_col">
  29481. The column number of the upper left corner
  29482. </member>
  29483. <member name="T:NPOI.SS.Formula.PTG.UnaryMinusPtg">
  29484. Unary Plus operator
  29485. does not have any effect on the operand
  29486. @author Avik Sengupta
  29487. </member>
  29488. <member name="M:NPOI.SS.Formula.PTG.UnaryMinusPtg.ToFormulaString(System.String[])">
  29489. implementation of method from OperationsPtg
  29490. </member>
  29491. <member name="T:NPOI.SS.Formula.PTG.UnaryPlusPtg">
  29492. Unary Plus operator
  29493. does not have any effect on the operand
  29494. @author Avik Sengupta
  29495. </member>
  29496. <member name="M:NPOI.SS.Formula.PTG.UnaryPlusPtg.ToFormulaString(System.String[])">
  29497. implementation of method from OperationsPtg
  29498. </member>
  29499. <member name="T:NPOI.SS.Formula.PTG.UnionPtg">
  29500. @author Glen Stampoultzis (glens at apache.org)
  29501. </member>
  29502. <member name="M:NPOI.SS.Formula.PTG.UnionPtg.ToFormulaString(System.String[])">
  29503. implementation of method from OperationsPtg
  29504. </member>
  29505. <member name="T:NPOI.SS.Formula.PTG.UnknownPtg">
  29506. @author andy
  29507. @author Jason Height (jheight at chariot dot net dot au)
  29508. </member>
  29509. <member name="M:NPOI.SS.Formula.PTG.UnknownPtg.#ctor">
  29510. Creates new UnknownPtg
  29511. </member>
  29512. <member name="T:NPOI.SS.Formula.PTG.ValueOperatorPtg">
  29513. Common baseclass of all value operators.
  29514. Subclasses include all Unary and binary operators except for the reference operators (IntersectionPtg, RangePtg, UnionPtg)
  29515. @author Josh Micich
  29516. </member>
  29517. <member name="P:NPOI.SS.Formula.PTG.ValueOperatorPtg.IsBaseToken">
  29518. All Operator <c>Ptg</c>s are base tokens (i.e. are not RVA classified)
  29519. </member>
  29520. <member name="T:NPOI.SS.Formula.PTG.SharedFormula">
  29521. Encapsulates logic to convert shared formulaa into non shared equivalent
  29522. </member>
  29523. <member name="M:NPOI.SS.Formula.PTG.SharedFormula.ConvertSharedFormulas(NPOI.SS.Formula.PTG.Ptg[],System.Int32,System.Int32)">
  29524. Creates a non shared formula from the shared formula counterpart, i.e.
  29525. Converts the shared formula into the equivalent {@link org.apache.poi.ss.formula.ptg.Ptg} array that it would have,
  29526. were it not shared.
  29527. @param ptgs parsed tokens of the shared formula
  29528. @param formulaRow
  29529. @param formulaColumn
  29530. </member>
  29531. <member name="T:NPOI.SS.Formula.FormulaShifter">
  29532. @author Josh Micich
  29533. </member>
  29534. <member name="F:NPOI.SS.Formula.FormulaShifter._externSheetIndex">
  29535. Extern sheet index of sheet where moving is occurring
  29536. </member>
  29537. <member name="F:NPOI.SS.Formula.FormulaShifter._sheetName">
  29538. Sheet name of the sheet where moving is occurring,
  29539. used for updating XSSF style 3D references on row shifts.
  29540. </member>
  29541. <member name="M:NPOI.SS.Formula.FormulaShifter.#ctor(System.Int32,System.String,System.Int32,System.Int32,System.Int32,NPOI.SS.Formula.FormulaShifter.ShiftMode,NPOI.SS.SpreadsheetVersion)">
  29542. Create an instance for Shifting row.
  29543. For example, this will be called on {@link NPOI.HSSF.UserModel.HSSFSheet#ShiftRows(int, int, int)} }
  29544. </member>
  29545. <member name="M:NPOI.SS.Formula.FormulaShifter.#ctor(System.Int32,System.Int32)">
  29546. Create an instance for shifting sheets.
  29547. For example, this will be called on {@link org.apache.poi.hssf.usermodel.HSSFWorkbook#setSheetOrder(String, int)}
  29548. </member>
  29549. <member name="M:NPOI.SS.Formula.FormulaShifter.AdjustFormula(NPOI.SS.Formula.PTG.Ptg[],System.Int32)">
  29550. @param ptgs - if necessary, will get modified by this method
  29551. @param currentExternSheetIx - the extern sheet index of the sheet that contains the formula being adjusted
  29552. @return <c>true</c> if a change was made to the formula tokens
  29553. </member>
  29554. <member name="M:NPOI.SS.Formula.FormulaShifter.AdjustPtgDueToRowMove(NPOI.SS.Formula.PTG.Ptg,System.Int32)">
  29555. <summary>
  29556. </summary>
  29557. <param name="ptg"></param>
  29558. <param name="currentExternSheetIx"></param>
  29559. <returns>in-place modified ptg (if row move would cause Ptg to change),
  29560. deleted ref ptg (if row move causes an error),
  29561. or null (if no Ptg change is needed)</returns>
  29562. </member>
  29563. <member name="M:NPOI.SS.Formula.FormulaShifter.AdjustPtgDueToRowCopy(NPOI.SS.Formula.PTG.Ptg)">
  29564. Call this on any ptg reference contained in a row of cells that was copied.
  29565. If the ptg reference is relative, the references will be shifted by the distance
  29566. that the rows were copied.
  29567. In the future similar functions could be written due to column copying or
  29568. individual cell copying. Just make sure to only call adjustPtgDueToRowCopy on
  29569. formula cells that are copied (unless row shifting, where references outside
  29570. of the shifted region need to be updated to reflect the shift, a copy is self-contained).
  29571. @param ptg the ptg to shift
  29572. @return deleted ref ptg, in-place modified ptg, or null
  29573. If Ptg would be shifted off the first or last row of a sheet, return deleted ref
  29574. If Ptg needs to be changed, modifies Ptg in-place
  29575. If Ptg doesn't need to be changed, returns <code>null</code>
  29576. </member>
  29577. <member name="M:NPOI.SS.Formula.FormulaShifter.RowCopyRefPtg(NPOI.SS.Formula.PTG.RefPtgBase)">
  29578. Modifies rptg in-place and return a reference to rptg if the cell reference
  29579. would move due to a row copy operation
  29580. Returns <code>null</code> or {@link #RefErrorPtg} if no change was made
  29581. @param aptg
  29582. @return
  29583. </member>
  29584. <member name="M:NPOI.SS.Formula.FormulaShifter.RowCopyAreaPtg(NPOI.SS.Formula.PTG.AreaPtgBase)">
  29585. Modifies aptg in-place and return a reference to aptg if the first or last row of
  29586. of the Area reference would move due to a row copy operation
  29587. Returns <code>null</code> or {@link #AreaErrPtg} if no change was made
  29588. @param aptg
  29589. @return null, AreaErrPtg, or modified aptg
  29590. </member>
  29591. <member name="T:NPOI.SS.Formula.SheetNameFormatter">
  29592. Formats sheet names for use in formula expressions.
  29593. @author Josh Micich
  29594. </member>
  29595. <member name="M:NPOI.SS.Formula.SheetNameFormatter.Format(System.String)">
  29596. Used to format sheet names as they would appear in cell formula expressions.
  29597. @return the sheet name UnChanged if there is no need for delimiting. Otherwise the sheet
  29598. name is enclosed in single quotes ('). Any single quotes which were already present in the
  29599. sheet name will be converted to double single quotes ('').
  29600. </member>
  29601. <member name="M:NPOI.SS.Formula.SheetNameFormatter.AppendFormat(System.Text.StringBuilder,System.String)">
  29602. Convenience method for when a StringBuilder is already available
  29603. @param out - sheet name will be Appended here possibly with delimiting quotes
  29604. </member>
  29605. <member name="M:NPOI.SS.Formula.SheetNameFormatter.IsSpecialChar(System.Char)">
  29606. @return <c>true</c> if the presence of the specified Char in a sheet name would
  29607. require the sheet name to be delimited in formulas. This includes every non-alphanumeric
  29608. Char besides Underscore '_'.
  29609. </member>
  29610. <member name="M:NPOI.SS.Formula.SheetNameFormatter.CellReferenceIsWithinRange(System.String,System.String)">
  29611. Used to decide whether sheet names like 'AB123' need delimiting due to the fact that they
  29612. look like cell references.
  29613. <p/>
  29614. This code is currently being used for translating formulas represented with <code>Ptg</code>
  29615. tokens into human readable text form. In formula expressions, a sheet name always has a
  29616. trailing '!' so there is little chance for ambiguity. It doesn't matter too much what this
  29617. method returns but it is worth noting the likely consumers of these formula text strings:
  29618. <ol>
  29619. <li>POI's own formula parser</li>
  29620. <li>Visual reading by human</li>
  29621. <li>VBA automation entry into Excel cell contents e.g. ActiveCell.Formula = "=c64!A1"</li>
  29622. <li>Manual entry into Excel cell contents</li>
  29623. <li>Some third party formula parser</li>
  29624. </ol>
  29625. At the time of writing, POI's formula parser tolerates cell-like sheet names in formulas
  29626. with or without delimiters. The same goes for Excel(2007), both manual and automated entry.
  29627. <p/>
  29628. For better or worse this implementation attempts to replicate Excel's formula renderer.
  29629. Excel uses range checking on the apparent 'row' and 'column' components. Note however that
  29630. the maximum sheet size varies across versions.
  29631. @see org.apache.poi.hssf.util.CellReference
  29632. </member>
  29633. <member name="M:NPOI.SS.Formula.SheetNameFormatter.NameLooksLikePlainCellReference(System.String)">
  29634. Note - this method assumes the specified rawSheetName has only letters and digits. It
  29635. cannot be used to match absolute or range references (using the dollar or colon char).
  29636. Some notable cases:
  29637. <blockquote><table border="0" cellpAdding="1" cellspacing="0"
  29638. summary="Notable cases.">
  29639. <tr><th>Input </th><th>Result </th><th>Comments</th></tr>
  29640. <tr><td>"A1" </td><td>true</td><td> </td></tr>
  29641. <tr><td>"a111" </td><td>true</td><td> </td></tr>
  29642. <tr><td>"AA" </td><td>false</td><td> </td></tr>
  29643. <tr><td>"aa1" </td><td>true</td><td> </td></tr>
  29644. <tr><td>"A1A" </td><td>false</td><td> </td></tr>
  29645. <tr><td>"A1A1" </td><td>false</td><td> </td></tr>
  29646. <tr><td>"A$1:$C$20" </td><td>false</td><td>Not a plain cell reference</td></tr>
  29647. <tr><td>"SALES20080101" </td><td>true</td>
  29648. <td>Still needs delimiting even though well out of range</td></tr>
  29649. </table></blockquote>
  29650. @return <c>true</c> if there is any possible ambiguity that the specified rawSheetName
  29651. could be interpreted as a valid cell name.
  29652. </member>
  29653. <member name="T:NPOI.SS.Formula.SheetRangeEvaluator">
  29654. Evaluator for returning cells or sheets for a range of sheets
  29655. </member>
  29656. <member name="T:NPOI.SS.Formula.SheetRefEvaluator">
  29657. @author Josh Micich
  29658. </member>
  29659. <member name="M:NPOI.SS.Formula.SheetRefEvaluator.IsSubTotal(System.Int32,System.Int32)">
  29660. @return whether cell at rowIndex and columnIndex is a subtotal
  29661. @see org.apache.poi.ss.formula.functions.Subtotal
  29662. </member>
  29663. <member name="T:NPOI.SS.Formula.ThreeDEval">
  29664. Optional Extension to the likes of {@link AreaEval} and
  29665. {@link NPOI.SS.Formula.Eval.AreaEvalBase},
  29666. which allows for looking up 3D (sheet+row+column) Evaluations
  29667. </member>
  29668. <member name="M:NPOI.SS.Formula.ThreeDEval.GetValue(System.Int32,System.Int32,System.Int32)">
  29669. @param sheetIndex sheet index (zero based)
  29670. @param rowIndex relative row index (zero based)
  29671. @param columnIndex relative column index (zero based)
  29672. @return element at the specified row and column position
  29673. </member>
  29674. <member name="T:NPOI.SS.Formula.TwoDEval">
  29675. Common interface of {@link AreaEval} and {@link org.apache.poi.ss.formula.eval.AreaEvalBase},
  29676. for 2D (row+column) evaluations
  29677. </member>
  29678. <member name="M:NPOI.SS.Formula.TwoDEval.GetValue(System.Int32,System.Int32)">
  29679. @param rowIndex relative row index (zero based)
  29680. @param columnIndex relative column index (zero based)
  29681. @return element at the specified row and column position
  29682. </member>
  29683. <member name="P:NPOI.SS.Formula.TwoDEval.IsRow">
  29684. @return <c>true</c> if the area has just a single row, this also includes
  29685. the trivial case when the area has just a single cell.
  29686. </member>
  29687. <member name="P:NPOI.SS.Formula.TwoDEval.IsColumn">
  29688. @return <c>true</c> if the area has just a single column, this also includes
  29689. the trivial case when the area has just a single cell.
  29690. </member>
  29691. <member name="M:NPOI.SS.Formula.TwoDEval.GetRow(System.Int32)">
  29692. @param rowIndex relative row index (zero based)
  29693. @return a single row {@link TwoDEval}
  29694. </member>
  29695. <member name="M:NPOI.SS.Formula.TwoDEval.GetColumn(System.Int32)">
  29696. @param columnIndex relative column index (zero based)
  29697. @return a single column {@link TwoDEval}
  29698. </member>
  29699. <member name="M:NPOI.SS.Formula.TwoDEval.IsSubTotal(System.Int32,System.Int32)">
  29700. @return true if the cell at row and col is a subtotal
  29701. </member>
  29702. <member name="T:NPOI.SS.Formula.UDF.AggregatingUDFFinder">
  29703. Collects Add-in libraries and VB macro functions toGether into one UDF Finder
  29704. @author PUdalau
  29705. </member>
  29706. <member name="M:NPOI.SS.Formula.UDF.AggregatingUDFFinder.FindFunction(System.String)">
  29707. <summary>
  29708. Returns executor by specified name.
  29709. </summary>
  29710. <param name="name">Name of function.</param>
  29711. <returns>Function executor. null if not found</returns>
  29712. </member>
  29713. <member name="M:NPOI.SS.Formula.UDF.AggregatingUDFFinder.Add(NPOI.SS.Formula.UDF.UDFFinder)">
  29714. <summary>
  29715. Add a new toolpack
  29716. </summary>
  29717. <param name="toolPack"></param>
  29718. </member>
  29719. <member name="T:NPOI.SS.Formula.UDF.IndexedUDFFinder">
  29720. A UDFFinder that can retrieve functions both by name and by fake index.
  29721. @author Yegor Kozlov
  29722. </member>
  29723. <member name="T:NPOI.SS.Formula.UDF.UDFFinder">
  29724. Common interface for "Add-in" libraries and user defined function libraries.
  29725. @author PUdalau
  29726. </member>
  29727. <member name="M:NPOI.SS.Formula.UDF.UDFFinder.FindFunction(System.String)">
  29728. Returns executor by specified name. Returns <code>null</code> if the function name is unknown.
  29729. @param name Name of function.
  29730. @return Function executor.
  29731. </member>
  29732. <member name="T:NPOI.SS.Formula.WorkbookDependentFormula">
  29733. Should be implemented by any {@link Ptg} subclass that needs a workbook To render its formula.
  29734. <br/>
  29735. For POI internal use only
  29736. @author Josh Micich
  29737. </member>
  29738. <member name="T:NPOI.SS.Formula.WorkbookEvaluator">
  29739. Evaluates formula cells.<p/>
  29740. For performance reasons, this class keeps a cache of all previously calculated intermediate
  29741. cell values. Be sure To call {@link #ClearCache()} if any workbook cells are Changed between
  29742. calls To evaluate~ methods on this class.<br/>
  29743. For POI internal use only
  29744. @author Josh Micich
  29745. </member>
  29746. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetSheetName(System.Int32)">
  29747. also for debug use. Used in ToString methods
  29748. </member>
  29749. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.ClearAllCachedResultValues">
  29750. Should be called whenever there are Changes To input cells in the evaluated workbook.
  29751. Failure To call this method after changing cell values will cause incorrect behaviour
  29752. of the evaluate~ methods of this class
  29753. </member>
  29754. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.NotifyUpdateCell(NPOI.SS.Formula.IEvaluationCell)">
  29755. Should be called To tell the cell value cache that the specified (value or formula) cell
  29756. Has Changed.
  29757. </member>
  29758. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.NotifyDeleteCell(NPOI.SS.Formula.IEvaluationCell)">
  29759. Should be called To tell the cell value cache that the specified cell Has just been
  29760. deleted.
  29761. </member>
  29762. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetSheetIndex(System.String)">
  29763. Case-insensitive.
  29764. @return -1 if sheet with specified name does not exist
  29765. </member>
  29766. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.EvaluateAny(NPOI.SS.Formula.IEvaluationCell,System.Int32,System.Int32,System.Int32,NPOI.SS.Formula.EvaluationTracker)">
  29767. @return never <c>null</c>, never {@link BlankEval}
  29768. </member>
  29769. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.AddExceptionInfo(System.NotImplementedException,System.Int32,System.Int32,System.Int32)">
  29770. Adds the current cell reference to the exception for easier debugging.
  29771. Would be nice to get the formula text as well, but that seems to require
  29772. too much digging around and casting to get the FormulaRenderingWorkbook.
  29773. </member>
  29774. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetValueFromNonFormulaCell(NPOI.SS.Formula.IEvaluationCell)">
  29775. Gets the value from a non-formula cell.
  29776. @param cell may be <c>null</c>
  29777. @return {@link BlankEval} if cell is <c>null</c> or blank, never <c>null</c>
  29778. </member>
  29779. <member name="F:NPOI.SS.Formula.WorkbookEvaluator.dbgEvaluationOutputForNextEval">
  29780. whether print detailed messages about the next formula evaluation
  29781. </member>
  29782. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.CountTokensToBeSkipped(NPOI.SS.Formula.PTG.Ptg[],System.Int32,System.Int32)">
  29783. Calculates the number of tokens that the evaluator should skip upon reaching a tAttrSkip.
  29784. @return the number of tokens (starting from <c>startIndex+1</c>) that need to be skipped
  29785. to achieve the specified <c>distInBytes</c> skip distance.
  29786. </member>
  29787. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.DereferenceResult(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  29788. Dereferences a single value from any AreaEval or RefEval evaluation result.
  29789. If the supplied evaluationResult is just a plain value, it is returned as-is.
  29790. @return a <c>NumberEval</c>, <c>StringEval</c>, <c>BoolEval</c>,
  29791. <c>BlankEval</c> or <c>ErrorEval</c>. Never <c>null</c>.
  29792. </member>
  29793. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetEvalForPtg(NPOI.SS.Formula.PTG.Ptg,NPOI.SS.Formula.OperationEvaluationContext)">
  29794. returns an appropriate Eval impl instance for the Ptg. The Ptg must be
  29795. one of: Area3DPtg, AreaPtg, ReferencePtg, Ref3DPtg, IntPtg, NumberPtg,
  29796. StringPtg, BoolPtg <br/>special Note: OperationPtg subtypes cannot be
  29797. passed here!
  29798. </member>
  29799. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.EvaluateReference(NPOI.SS.Formula.IEvaluationSheet,System.Int32,System.Int32,System.Int32,NPOI.SS.Formula.EvaluationTracker)">
  29800. Used by the lazy ref evals whenever they need To Get the value of a contained cell.
  29801. </member>
  29802. <member name="P:NPOI.SS.Formula.WorkbookEvaluator.IgnoreMissingWorkbooks">
  29803. Whether to ignore missing references to external workbooks and
  29804. use cached formula results in the main workbook instead.
  29805. <p>
  29806. In some cases exetrnal workbooks referenced by formulas in the main workbook are not avaiable.
  29807. With this method you can control how POI handles such missing references:
  29808. <ul>
  29809. <li>by default ignoreMissingWorkbooks=false and POI throws {@link WorkbookNotFoundException}
  29810. if an external reference cannot be resolved</li>
  29811. <li>if ignoreMissingWorkbooks=true then POI uses cached formula result
  29812. that already exists in the main workbook</li>
  29813. </ul>
  29814. </p>
  29815. @param ignore whether to ignore missing references to external workbooks
  29816. @see <a href="https://issues.apache.org/bugzilla/show_bug.cgi?id=52575">Bug 52575 for details</a>
  29817. </member>
  29818. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetSupportedFunctionNames">
  29819. Return a collection of functions that POI can evaluate
  29820. @return names of functions supported by POI
  29821. </member>
  29822. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetNotSupportedFunctionNames">
  29823. Return a collection of functions that POI does not support
  29824. @return names of functions NOT supported by POI
  29825. </member>
  29826. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.RegisterFunction(System.String,NPOI.SS.Formula.Functions.FreeRefFunction)">
  29827. Register a ATP function in runtime.
  29828. @param name the function name
  29829. @param func the functoin to register
  29830. @throws IllegalArgumentException if the function is unknown or already registered.
  29831. @since 3.8 beta6
  29832. </member>
  29833. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.RegisterFunction(System.String,NPOI.SS.Formula.Functions.Function)">
  29834. Register a function in runtime.
  29835. @param name the function name
  29836. @param func the functoin to register
  29837. @throws IllegalArgumentException if the function is unknown or already registered.
  29838. @since 3.8 beta6
  29839. </member>
  29840. <member name="T:NPOI.SS.Formula.IWorkbookEvaluatorProvider">
  29841. Provides access to a {@link WorkbookEvaluator}, eg for use with
  29842. {@link CollaboratingWorkbooksEnvironment}
  29843. For POI internal use only
  29844. </member>
  29845. <member name="M:NPOI.SS.Formula.IWorkbookEvaluatorProvider.GetWorkbookEvaluator">
  29846. Provide the underlying WorkbookEvaluator
  29847. </member>
  29848. <member name="T:NPOI.SS.SpreadsheetVersion">
  29849. This enum allows spReadsheets from multiple Excel versions to be handled by the common code.
  29850. Properties of this enum correspond to attributes of the <i>spReadsheet</i> that are easily
  29851. discernable to the user. It is not intended to deal with low-level issues like file formats.
  29852. <p/>
  29853. @author Josh Micich
  29854. @author Yegor Kozlov
  29855. </member>
  29856. <member name="F:NPOI.SS.SpreadsheetVersion.EXCEL97">
  29857. Excel97 format aka BIFF8
  29858. <ul>
  29859. <li>The total number of available columns is 256 (2^8)</li>
  29860. <li>The total number of available rows is 64k (2^16)</li>
  29861. <li>The maximum number of arguments to a function is 30</li>
  29862. <li>Number of conditional format conditions on a cell is 3</li>
  29863. <li>Length of text cell contents is unlimited </li>
  29864. <li>Length of text cell contents is 32767</li>
  29865. </ul>
  29866. </member>
  29867. <member name="F:NPOI.SS.SpreadsheetVersion.EXCEL2007">
  29868. Excel2007
  29869. <ul>
  29870. <li>The total number of available columns is 16K (2^14)</li>
  29871. <li>The total number of available rows is 1M (2^20)</li>
  29872. <li>The maximum number of arguments to a function is 255</li>
  29873. <li>Number of conditional format conditions on a cell is unlimited
  29874. (actually limited by available memory in Excel)</li>
  29875. <li>Length of text cell contents is unlimited </li>
  29876. </ul>
  29877. </member>
  29878. <member name="P:NPOI.SS.SpreadsheetVersion.DefaultExtension">
  29879. @return the default file extension of spReadsheet
  29880. </member>
  29881. <member name="P:NPOI.SS.SpreadsheetVersion.MaxRows">
  29882. @return the maximum number of usable rows in each spReadsheet
  29883. </member>
  29884. <member name="P:NPOI.SS.SpreadsheetVersion.LastRowIndex">
  29885. @return the last (maximum) valid row index, equals to <code> GetMaxRows() - 1 </code>
  29886. </member>
  29887. <member name="P:NPOI.SS.SpreadsheetVersion.MaxColumns">
  29888. @return the maximum number of usable columns in each spReadsheet
  29889. </member>
  29890. <member name="P:NPOI.SS.SpreadsheetVersion.LastColumnIndex">
  29891. @return the last (maximum) valid column index, equals to <code> GetMaxColumns() - 1 </code>
  29892. </member>
  29893. <member name="P:NPOI.SS.SpreadsheetVersion.MaxFunctionArgs">
  29894. @return the maximum number arguments that can be passed to a multi-arg function (e.g. COUNTIF)
  29895. </member>
  29896. <member name="P:NPOI.SS.SpreadsheetVersion.MaxConditionalFormats">
  29897. @return the maximum number of conditional format conditions on a cell
  29898. </member>
  29899. <member name="P:NPOI.SS.SpreadsheetVersion.LastColumnName">
  29900. @return the last valid column index in a ALPHA-26 representation
  29901. (<code>IV</code> or <code>XFD</code>).
  29902. </member>
  29903. <member name="P:NPOI.SS.SpreadsheetVersion.MaxCellStyles">
  29904. @return the maximum number of cell styles per spreadsheet
  29905. </member>
  29906. <member name="P:NPOI.SS.SpreadsheetVersion.MaxTextLength">
  29907. @return the maximum length of a text cell
  29908. </member>
  29909. <member name="T:NPOI.SS.UserModel.IAutoFilter">
  29910. Represents autofiltering for the specified worksheet.
  29911. <p>
  29912. Filtering data is a quick and easy way to find and work with a subset of data in a range of cells or table.
  29913. For example, you can filter to see only the values that you specify, filter to see the top or bottom values,
  29914. or filter to quickly see duplicate values.
  29915. </p>
  29916. TODO YK: For now (Aug 2010) POI only supports Setting a basic autofilter on a range of cells.
  29917. In future, when we support more auto-filter functions like custom criteria, sort, etc. we will add
  29918. corresponding methods to this interface.
  29919. </member>
  29920. <member name="F:NPOI.SS.UserModel.BorderDiagonal.None">
  29921. <summary>
  29922. No diagional border
  29923. </summary>
  29924. </member>
  29925. <member name="F:NPOI.SS.UserModel.BorderDiagonal.Backward">
  29926. <summary>
  29927. Backward diagional border, from left-top to right-bottom
  29928. </summary>
  29929. </member>
  29930. <member name="F:NPOI.SS.UserModel.BorderDiagonal.Forward">
  29931. <summary>
  29932. Forward diagional border, from right-top to left-bottom
  29933. </summary>
  29934. </member>
  29935. <member name="F:NPOI.SS.UserModel.BorderDiagonal.Both">
  29936. <summary>
  29937. Both forward and backward diagional border
  29938. </summary>
  29939. </member>
  29940. <member name="T:NPOI.SS.UserModel.IBorderFormatting">
  29941. <summary>
  29942. High level representation for Border Formatting component
  29943. of Conditional Formatting settings
  29944. </summary>
  29945. </member>
  29946. <member name="T:NPOI.SS.UserModel.BorderStyle">
  29947. <summary>
  29948. The enumeration value indicating the line style of a border in a cell
  29949. </summary>
  29950. </member>
  29951. <member name="F:NPOI.SS.UserModel.BorderStyle.None">
  29952. <summary>
  29953. No border
  29954. </summary>
  29955. </member>
  29956. <member name="F:NPOI.SS.UserModel.BorderStyle.Thin">
  29957. <summary>
  29958. Thin border
  29959. </summary>
  29960. </member>
  29961. <member name="F:NPOI.SS.UserModel.BorderStyle.Medium">
  29962. <summary>
  29963. Medium border
  29964. </summary>
  29965. </member>
  29966. <member name="F:NPOI.SS.UserModel.BorderStyle.Dashed">
  29967. <summary>
  29968. dash border
  29969. </summary>
  29970. </member>
  29971. <member name="F:NPOI.SS.UserModel.BorderStyle.Dotted">
  29972. <summary>
  29973. dot border
  29974. </summary>
  29975. </member>
  29976. <member name="F:NPOI.SS.UserModel.BorderStyle.Thick">
  29977. <summary>
  29978. Thick border
  29979. </summary>
  29980. </member>
  29981. <member name="F:NPOI.SS.UserModel.BorderStyle.Double">
  29982. <summary>
  29983. double-line border
  29984. </summary>
  29985. </member>
  29986. <member name="F:NPOI.SS.UserModel.BorderStyle.Hair">
  29987. <summary>
  29988. hair-line border
  29989. </summary>
  29990. </member>
  29991. <member name="F:NPOI.SS.UserModel.BorderStyle.MediumDashed">
  29992. <summary>
  29993. Medium dashed border
  29994. </summary>
  29995. </member>
  29996. <member name="F:NPOI.SS.UserModel.BorderStyle.DashDot">
  29997. <summary>
  29998. dash-dot border
  29999. </summary>
  30000. </member>
  30001. <member name="F:NPOI.SS.UserModel.BorderStyle.MediumDashDot">
  30002. <summary>
  30003. medium dash-dot border
  30004. </summary>
  30005. </member>
  30006. <member name="F:NPOI.SS.UserModel.BorderStyle.DashDotDot">
  30007. <summary>
  30008. dash-dot-dot border
  30009. </summary>
  30010. </member>
  30011. <member name="F:NPOI.SS.UserModel.BorderStyle.MediumDashDotDot">
  30012. <summary>
  30013. medium dash-dot-dot border
  30014. </summary>
  30015. </member>
  30016. <member name="F:NPOI.SS.UserModel.BorderStyle.SlantedDashDot">
  30017. <summary>
  30018. slanted dash-dot border
  30019. </summary>
  30020. </member>
  30021. <member name="T:NPOI.SS.UserModel.BuiltinFormats">
  30022. Utility to identify built-in formats. The following is a list of the formats as
  30023. returned by this class.<p/>
  30024. <p/>
  30025. 0, "General"<br/>
  30026. 1, "0"<br/>
  30027. 2, "0.00"<br/>
  30028. 3, "#,##0"<br/>
  30029. 4, "#,##0.00"<br/>
  30030. 5, "$#,##0_);($#,##0)"<br/>
  30031. 6, "$#,##0_);[Red]($#,##0)"<br/>
  30032. 7, "$#,##0.00);($#,##0.00)"<br/>
  30033. 8, "$#,##0.00_);[Red]($#,##0.00)"<br/>
  30034. 9, "0%"<br/>
  30035. 0xa, "0.00%"<br/>
  30036. 0xb, "0.00E+00"<br/>
  30037. 0xc, "# ?/?"<br/>
  30038. 0xd, "# ??/??"<br/>
  30039. 0xe, "m/d/yy"<br/>
  30040. 0xf, "d-mmm-yy"<br/>
  30041. 0x10, "d-mmm"<br/>
  30042. 0x11, "mmm-yy"<br/>
  30043. 0x12, "h:mm AM/PM"<br/>
  30044. 0x13, "h:mm:ss AM/PM"<br/>
  30045. 0x14, "h:mm"<br/>
  30046. 0x15, "h:mm:ss"<br/>
  30047. 0x16, "m/d/yy h:mm"<br/>
  30048. <p/>
  30049. // 0x17 - 0x24 reserved for international and undocumented
  30050. 0x25, "#,##0_);(#,##0)"<br/>
  30051. 0x26, "#,##0_);[Red](#,##0)"<br/>
  30052. 0x27, "#,##0.00_);(#,##0.00)"<br/>
  30053. 0x28, "#,##0.00_);[Red](#,##0.00)"<br/>
  30054. 0x29, "_(*#,##0_);_(*(#,##0);_(* \"-\"_);_(@_)"<br/>
  30055. 0x2a, "_($*#,##0_);_($*(#,##0);_($* \"-\"_);_(@_)"<br/>
  30056. 0x2b, "_(*#,##0.00_);_(*(#,##0.00);_(*\"-\"??_);_(@_)"<br/>
  30057. 0x2c, "_($*#,##0.00_);_($*(#,##0.00);_($*\"-\"??_);_(@_)"<br/>
  30058. 0x2d, "mm:ss"<br/>
  30059. 0x2e, "[h]:mm:ss"<br/>
  30060. 0x2f, "mm:ss.0"<br/>
  30061. 0x30, "##0.0E+0"<br/>
  30062. 0x31, "@" - This is text format.<br/>
  30063. 0x31 "text" - Alias for "@"<br/>
  30064. <p/>
  30065. @author Yegor Kozlov
  30066. Modified 6/17/09 by Stanislav Shor - positive formats don't need starting '('
  30067. </member>
  30068. <member name="F:NPOI.SS.UserModel.BuiltinFormats.FIRST_USER_DEFINED_FORMAT_INDEX">
  30069. The first user-defined number format starts at 164.
  30070. </member>
  30071. <member name="M:NPOI.SS.UserModel.BuiltinFormats.GetAll">
  30072. @return array of built-in data formats
  30073. </member>
  30074. <member name="M:NPOI.SS.UserModel.BuiltinFormats.GetBuiltinFormat(System.Int32)">
  30075. Get the format string that matches the given format index
  30076. @param index of a built in format
  30077. @return string represented at index of format or <code>null</code> if there is not a built-in format at that index
  30078. </member>
  30079. <member name="M:NPOI.SS.UserModel.BuiltinFormats.GetBuiltinFormat(System.String)">
  30080. Get the format index that matches the given format string.
  30081. <p>
  30082. Automatically converts "text" to excel's format string to represent text.
  30083. </p>
  30084. @param pFmt string matching a built-in format
  30085. @return index of format or -1 if undefined.
  30086. </member>
  30087. <member name="T:NPOI.SS.UserModel.ICell">
  30088. High level representation of a cell in a row of a spreadsheet.
  30089. <p>
  30090. Cells can be numeric, formula-based or string-based (text). The cell type
  30091. specifies this. String cells cannot conatin numbers and numeric cells cannot
  30092. contain strings (at least according to our model). Client apps should do the
  30093. conversions themselves. Formula cells have the formula string, as well as
  30094. the formula result, which can be numeric or string.
  30095. </p>
  30096. <p>
  30097. Cells should have their number (0 based) before being Added to a row.
  30098. </p>
  30099. </member>
  30100. <member name="P:NPOI.SS.UserModel.ICell.ColumnIndex">
  30101. <summary>
  30102. zero-based column index of a column in a sheet.
  30103. </summary>
  30104. </member>
  30105. <member name="P:NPOI.SS.UserModel.ICell.RowIndex">
  30106. <summary>
  30107. zero-based row index of a row in the sheet that contains this cell
  30108. </summary>
  30109. </member>
  30110. <member name="P:NPOI.SS.UserModel.ICell.Sheet">
  30111. <summary>
  30112. the sheet this cell belongs to
  30113. </summary>
  30114. </member>
  30115. <member name="P:NPOI.SS.UserModel.ICell.Row">
  30116. <summary>
  30117. the row this cell belongs to
  30118. </summary>
  30119. </member>
  30120. <member name="P:NPOI.SS.UserModel.ICell.CellType">
  30121. <summary>
  30122. Set the cells type (numeric, formula or string)
  30123. </summary>
  30124. <p>If the cell currently contains a value, the value will
  30125. be converted to match the new type, if possible. Formatting
  30126. is generally lost in the process however.</p>
  30127. <p>If what you want to do is get a String value for your
  30128. numeric cell, <i>stop!</i>. This is not the way to do it.
  30129. Instead, for fetching the string value of a numeric or boolean
  30130. or date cell, use {@link DataFormatter} instead.</p>
  30131. </member>
  30132. <member name="M:NPOI.SS.UserModel.ICell.SetCellType(NPOI.SS.UserModel.CellType)">
  30133. <summary>
  30134. Set the cells type (numeric, formula or string)
  30135. </summary>
  30136. <param name="cellType"></param>
  30137. </member>
  30138. <member name="P:NPOI.SS.UserModel.ICell.CachedFormulaResultType">
  30139. <summary>
  30140. Only valid for formula cells
  30141. </summary>
  30142. </member>
  30143. <member name="M:NPOI.SS.UserModel.ICell.SetCellValue(System.Double)">
  30144. <summary>
  30145. Set a numeric value for the cell
  30146. </summary>
  30147. <param name="value">the numeric value to set this cell to. For formulas we'll set the
  30148. precalculated value, for numerics we'll set its value. For other types we will change
  30149. the cell to a numeric cell and set its value.
  30150. </param>
  30151. </member>
  30152. <member name="M:NPOI.SS.UserModel.ICell.SetCellErrorValue(System.Byte)">
  30153. <summary>
  30154. Set a error value for the cell
  30155. </summary>
  30156. <param name="value">the error value to set this cell to. For formulas we'll set the
  30157. precalculated value , for errors we'll set its value. For other types we will change
  30158. the cell to an error cell and set its value.
  30159. </param>
  30160. </member>
  30161. <member name="M:NPOI.SS.UserModel.ICell.SetCellValue(System.DateTime)">
  30162. <summary>
  30163. Converts the supplied date to its equivalent Excel numeric value and Sets that into the cell.
  30164. </summary>
  30165. <param name="value">the numeric value to set this cell to. For formulas we'll set the
  30166. precalculated value, for numerics we'll set its value. For other types we will change
  30167. the cell to a numerics cell and set its value.
  30168. </param>
  30169. </member>
  30170. <member name="M:NPOI.SS.UserModel.ICell.SetCellValue(NPOI.SS.UserModel.IRichTextString)">
  30171. <summary>
  30172. Set a rich string value for the cell.
  30173. </summary>
  30174. <param name="value">value to set the cell to. For formulas we'll set the formula
  30175. string, for String cells we'll set its value. For other types we will
  30176. change the cell to a string cell and set its value.
  30177. If value is null then we will change the cell to a Blank cell.
  30178. </param>
  30179. </member>
  30180. <member name="M:NPOI.SS.UserModel.ICell.SetCellValue(System.String)">
  30181. <summary>
  30182. Set a string value for the cell.
  30183. </summary>
  30184. <param name="value">value to set the cell to. For formulas we'll set the formula
  30185. string, for String cells we'll set its value. For other types we will
  30186. change the cell to a string cell and set its value.
  30187. If value is null then we will change the cell to a blank cell.
  30188. </param>
  30189. </member>
  30190. <member name="M:NPOI.SS.UserModel.ICell.CopyCellTo(System.Int32)">
  30191. <summary>
  30192. Copy the cell to the target index. If the target cell exists, a new cell will be inserted before the existing cell.
  30193. </summary>
  30194. <param name="targetIndex">target index</param>
  30195. <returns>the new copied cell object</returns>
  30196. </member>
  30197. <member name="P:NPOI.SS.UserModel.ICell.CellFormula">
  30198. <summary>
  30199. Return a formula for the cell
  30200. </summary>
  30201. <exception cref="T:System.InvalidOperationException">if the cell type returned by GetCellType() is not CELL_TYPE_FORMULA </exception>
  30202. </member>
  30203. <member name="M:NPOI.SS.UserModel.ICell.SetCellFormula(System.String)">
  30204. <summary>
  30205. Sets formula for this cell.
  30206. </summary>
  30207. <param name="formula">the formula to Set, e.g. <code>"SUM(C4:E4)"</code>.</param>
  30208. </member>
  30209. <member name="P:NPOI.SS.UserModel.ICell.NumericCellValue">
  30210. <summary>
  30211. Get the value of the cell as a number.
  30212. </summary>
  30213. <exception cref="T:System.InvalidOperationException">if the cell type returned by GetCellType() is CELL_TYPE_STRING</exception>
  30214. <exception cref="T:System.FormatException">if the cell value isn't a parsable double</exception>
  30215. </member>
  30216. <member name="P:NPOI.SS.UserModel.ICell.DateCellValue">
  30217. <summary>
  30218. Get the value of the cell as a date.
  30219. </summary>
  30220. <exception cref="T:System.InvalidOperationException">if the cell type returned by GetCellType() is CELL_TYPE_STRING</exception>
  30221. <exception cref="T:System.FormatException">if the cell value isn't a parsable double</exception>
  30222. </member>
  30223. <member name="P:NPOI.SS.UserModel.ICell.RichStringCellValue">
  30224. <summary>
  30225. Get the value of the cell RichTextString
  30226. </summary>
  30227. </member>
  30228. <member name="P:NPOI.SS.UserModel.ICell.ErrorCellValue">
  30229. <summary>
  30230. Get the value of the cell as an error code.
  30231. </summary>
  30232. </member>
  30233. <member name="P:NPOI.SS.UserModel.ICell.StringCellValue">
  30234. <summary>
  30235. Get the value of the cell as a string
  30236. </summary>
  30237. </member>
  30238. <member name="M:NPOI.SS.UserModel.ICell.SetCellValue(System.Boolean)">
  30239. <summary>
  30240. Set a bool value for the cell
  30241. </summary>
  30242. <param name="value"></param>
  30243. </member>
  30244. <member name="P:NPOI.SS.UserModel.ICell.BooleanCellValue">
  30245. <summary>
  30246. Get the value of the cell as a bool.
  30247. </summary>
  30248. </member>
  30249. <member name="P:NPOI.SS.UserModel.ICell.CellStyle">
  30250. <summary>
  30251. get or set the cell's style.
  30252. If set the style for the cell. The style should be an CellStyle created/retreived from the Workbook.
  30253. To change the style of a cell without affecting other cells that use the same style,
  30254. use CellUtil#setCellStyleProperties
  30255. </summary>
  30256. </member>
  30257. <member name="M:NPOI.SS.UserModel.ICell.SetAsActiveCell">
  30258. <summary>
  30259. Sets this cell as the active cell for the worksheet
  30260. </summary>
  30261. </member>
  30262. <member name="P:NPOI.SS.UserModel.ICell.Address">
  30263. Gets the address of this cell
  30264. @return <code>A1</code> style address of this cell
  30265. @since 3.14beta2
  30266. </member>
  30267. <member name="P:NPOI.SS.UserModel.ICell.CellComment">
  30268. <summary>
  30269. comment associated with this cell
  30270. </summary>
  30271. </member>
  30272. <member name="M:NPOI.SS.UserModel.ICell.RemoveCellComment">
  30273. <summary>
  30274. Removes the comment for this cell, if there is one.
  30275. </summary>
  30276. </member>
  30277. <member name="P:NPOI.SS.UserModel.ICell.Hyperlink">
  30278. <summary>
  30279. hyperlink associated with this cell
  30280. </summary>
  30281. </member>
  30282. <member name="M:NPOI.SS.UserModel.ICell.RemoveHyperlink">
  30283. <summary>
  30284. Removes the hyperlink for this cell, if there is one.
  30285. </summary>
  30286. </member>
  30287. <member name="P:NPOI.SS.UserModel.ICell.ArrayFormulaRange">
  30288. <summary>
  30289. Only valid for array formula cells
  30290. </summary>
  30291. <returns>range of the array formula group that the cell belongs to.</returns>
  30292. </member>
  30293. <member name="P:NPOI.SS.UserModel.ICell.IsPartOfArrayFormulaGroup">
  30294. <summary>
  30295. if this cell is part of group of cells having a common array formula.
  30296. </summary>
  30297. </member>
  30298. <member name="M:NPOI.SS.UserModel.CellCopyPolicy.#ctor">
  30299. Default CellCopyPolicy, uses default policy
  30300. For custom CellCopyPolicy, use {@link Builder} class
  30301. </member>
  30302. <member name="M:NPOI.SS.UserModel.CellCopyPolicy.#ctor(NPOI.SS.UserModel.CellCopyPolicy)">
  30303. Copy constructor
  30304. @param other policy to copy
  30305. </member>
  30306. <member name="M:NPOI.SS.UserModel.CellCopyPolicy.Builder.#ctor">
  30307. Builder class for CellCopyPolicy
  30308. </member>
  30309. <member name="P:NPOI.SS.UserModel.CellCopyPolicy.IsCopyCellValue">
  30310. @return the copyCellValue
  30311. </member>
  30312. <member name="P:NPOI.SS.UserModel.CellCopyPolicy.IsCopyCellStyle">
  30313. @return the copyCellStyle
  30314. </member>
  30315. <member name="P:NPOI.SS.UserModel.CellCopyPolicy.IsCopyCellFormula">
  30316. @return the copyCellFormula
  30317. </member>
  30318. <member name="P:NPOI.SS.UserModel.CellCopyPolicy.IsCopyHyperlink">
  30319. @return the copyHyperlink
  30320. </member>
  30321. <member name="P:NPOI.SS.UserModel.CellCopyPolicy.IsMergeHyperlink">
  30322. @return the mergeHyperlink
  30323. </member>
  30324. <member name="P:NPOI.SS.UserModel.CellCopyPolicy.IsCopyRowHeight">
  30325. @return the copyRowHeight
  30326. </member>
  30327. <member name="P:NPOI.SS.UserModel.CellCopyPolicy.IsCondenseRows">
  30328. If condenseRows is true, a discontinuities in srcRows will be Removed when copied to destination
  30329. For example:
  30330. Sheet.CopyRows({Row(1), Row(2), Row(5)}, 11, policy) results in rows 1, 2, and 5
  30331. being copied to rows 11, 12, and 13 if condenseRows is True, or rows 11, 11, 15 if condenseRows is false
  30332. @return the condenseRows
  30333. </member>
  30334. <member name="P:NPOI.SS.UserModel.CellCopyPolicy.IsCopyMergedRegions">
  30335. @return the copyMergedRegions
  30336. </member>
  30337. <member name="P:NPOI.SS.UserModel.ICellRange`1.Size">
  30338. Gets the number of cells in this range.
  30339. @return <tt>height * width </tt>
  30340. </member>
  30341. <member name="P:NPOI.SS.UserModel.ICellRange`1.ReferenceText">
  30342. @return the text format of this range. Single cell ranges are formatted
  30343. like single cell references (e.g. 'A1' instead of 'A1:A1').
  30344. </member>
  30345. <member name="P:NPOI.SS.UserModel.ICellRange`1.TopLeftCell">
  30346. @return the cell at relative coordinates (0,0). Never <code>null</code>.
  30347. </member>
  30348. <member name="M:NPOI.SS.UserModel.ICellRange`1.GetCell(System.Int32,System.Int32)">
  30349. @param relativeRowIndex must be between <tt>0</tt> and <tt>height-1</tt>
  30350. @param relativeColumnIndex must be between <tt>0</tt> and <tt>width-1</tt>
  30351. @return the cell at the specified coordinates. Never <code>null</code>.
  30352. </member>
  30353. <member name="P:NPOI.SS.UserModel.ICellRange`1.FlattenedCells">
  30354. @return a flattened array of all the cells in this {@link CellRange}
  30355. </member>
  30356. <member name="P:NPOI.SS.UserModel.ICellRange`1.Cells">
  30357. @return a 2-D array of all the cells in this {@link CellRange}. The first
  30358. array dimension is the row index (values <tt>0...height-1</tt>)
  30359. and the second dimension is the column index (values <tt>0...width-1</tt>)
  30360. </member>
  30361. <member name="P:NPOI.SS.UserModel.ICellStyle.ShrinkToFit">
  30362. <summary>
  30363. the Cell should be auto-sized to shrink to fit if the text is too long
  30364. </summary>
  30365. </member>
  30366. <member name="P:NPOI.SS.UserModel.ICellStyle.Index">
  30367. get the index within the Workbook (sequence within the collection of ExtnededFormat objects)
  30368. @return unique index number of the underlying record this style represents (probably you don't care
  30369. unless you're comparing which one is which)
  30370. </member>
  30371. <member name="P:NPOI.SS.UserModel.ICellStyle.DataFormat">
  30372. get the index of the format
  30373. @see DataFormat
  30374. </member>
  30375. <member name="M:NPOI.SS.UserModel.ICellStyle.GetDataFormatString">
  30376. Get the format string
  30377. </member>
  30378. <member name="M:NPOI.SS.UserModel.ICellStyle.SetFont(NPOI.SS.UserModel.IFont)">
  30379. set the font for this style
  30380. @param font a font object Created or retreived from the Workbook object
  30381. @see Workbook#CreateFont()
  30382. @see Workbook#GetFontAt(short)
  30383. </member>
  30384. <member name="P:NPOI.SS.UserModel.ICellStyle.FontIndex">
  30385. Gets the index of the font for this style
  30386. @see Workbook#GetFontAt(short)
  30387. </member>
  30388. <member name="P:NPOI.SS.UserModel.ICellStyle.IsHidden">
  30389. get whether the cell's using this style are to be hidden
  30390. @return hidden - whether the cell using this style should be hidden
  30391. </member>
  30392. <member name="P:NPOI.SS.UserModel.ICellStyle.IsLocked">
  30393. get whether the cell's using this style are to be locked
  30394. @return hidden - whether the cell using this style should be locked
  30395. </member>
  30396. <member name="P:NPOI.SS.UserModel.ICellStyle.Alignment">
  30397. get the type of horizontal alignment for the cell
  30398. @return align - the type of alignment
  30399. @see #ALIGN_GENERAL
  30400. @see #ALIGN_LEFT
  30401. @see #ALIGN_CENTER
  30402. @see #ALIGN_RIGHT
  30403. @see #ALIGN_FILL
  30404. @see #ALIGN_JUSTIFY
  30405. @see #ALIGN_CENTER_SELECTION
  30406. </member>
  30407. <member name="P:NPOI.SS.UserModel.ICellStyle.WrapText">
  30408. get whether the text should be wrapped
  30409. @return wrap text or not
  30410. </member>
  30411. <member name="P:NPOI.SS.UserModel.ICellStyle.VerticalAlignment">
  30412. get the type of vertical alignment for the cell
  30413. @return align the type of alignment
  30414. @see #VERTICAL_TOP
  30415. @see #VERTICAL_CENTER
  30416. @see #VERTICAL_BOTTOM
  30417. @see #VERTICAL_JUSTIFY
  30418. </member>
  30419. <member name="P:NPOI.SS.UserModel.ICellStyle.Rotation">
  30420. get the degree of rotation for the text in the cell
  30421. Note: HSSF uses values from -90 to 90 degrees, whereas XSSF
  30422. uses values from 0 to 180 degrees. The implementations of this method will map between these two value-ranges
  30423. accordingly, however the corresponding getter is returning values in the range mandated by the current type
  30424. of Excel file-format that this CellStyle is applied to.
  30425. @return rotation degrees (between -90 and 90 degrees)
  30426. </member>
  30427. <member name="P:NPOI.SS.UserModel.ICellStyle.Indention">
  30428. get the number of spaces to indent the text in the cell
  30429. @return indent - number of spaces
  30430. </member>
  30431. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderLeft">
  30432. get the type of border to use for the left border of the cell
  30433. @return border type
  30434. @see #BORDER_NONE
  30435. @see #BORDER_THIN
  30436. @see #BORDER_MEDIUM
  30437. @see #BORDER_DASHED
  30438. @see #BORDER_DOTTED
  30439. @see #BORDER_THICK
  30440. @see #BORDER_DOUBLE
  30441. @see #BORDER_HAIR
  30442. @see #BORDER_MEDIUM_DASHED
  30443. @see #BORDER_DASH_DOT
  30444. @see #BORDER_MEDIUM_DASH_DOT
  30445. @see #BORDER_DASH_DOT_DOT
  30446. @see #BORDER_MEDIUM_DASH_DOT_DOT
  30447. @see #BORDER_SLANTED_DASH_DOT
  30448. </member>
  30449. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderRight">
  30450. get the type of border to use for the right border of the cell
  30451. @return border type
  30452. @see #BORDER_NONE
  30453. @see #BORDER_THIN
  30454. @see #BORDER_MEDIUM
  30455. @see #BORDER_DASHED
  30456. @see #BORDER_DOTTED
  30457. @see #BORDER_THICK
  30458. @see #BORDER_DOUBLE
  30459. @see #BORDER_HAIR
  30460. @see #BORDER_MEDIUM_DASHED
  30461. @see #BORDER_DASH_DOT
  30462. @see #BORDER_MEDIUM_DASH_DOT
  30463. @see #BORDER_DASH_DOT_DOT
  30464. @see #BORDER_MEDIUM_DASH_DOT_DOT
  30465. @see #BORDER_SLANTED_DASH_DOT
  30466. </member>
  30467. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderTop">
  30468. get the type of border to use for the top border of the cell
  30469. @return border type
  30470. @see #BORDER_NONE
  30471. @see #BORDER_THIN
  30472. @see #BORDER_MEDIUM
  30473. @see #BORDER_DASHED
  30474. @see #BORDER_DOTTED
  30475. @see #BORDER_THICK
  30476. @see #BORDER_DOUBLE
  30477. @see #BORDER_HAIR
  30478. @see #BORDER_MEDIUM_DASHED
  30479. @see #BORDER_DASH_DOT
  30480. @see #BORDER_MEDIUM_DASH_DOT
  30481. @see #BORDER_DASH_DOT_DOT
  30482. @see #BORDER_MEDIUM_DASH_DOT_DOT
  30483. @see #BORDER_SLANTED_DASH_DOT
  30484. </member>
  30485. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderBottom">
  30486. get the type of border to use for the bottom border of the cell
  30487. @return border type
  30488. @see #BORDER_NONE
  30489. @see #BORDER_THIN
  30490. @see #BORDER_MEDIUM
  30491. @see #BORDER_DASHED
  30492. @see #BORDER_DOTTED
  30493. @see #BORDER_THICK
  30494. @see #BORDER_DOUBLE
  30495. @see #BORDER_HAIR
  30496. @see #BORDER_MEDIUM_DASHED
  30497. @see #BORDER_DASH_DOT
  30498. @see #BORDER_MEDIUM_DASH_DOT
  30499. @see #BORDER_DASH_DOT_DOT
  30500. @see #BORDER_MEDIUM_DASH_DOT_DOT
  30501. @see #BORDER_SLANTED_DASH_DOT
  30502. </member>
  30503. <member name="P:NPOI.SS.UserModel.ICellStyle.LeftBorderColor">
  30504. get the color to use for the left border
  30505. </member>
  30506. <member name="P:NPOI.SS.UserModel.ICellStyle.RightBorderColor">
  30507. get the color to use for the left border
  30508. @return the index of the color defInition
  30509. </member>
  30510. <member name="P:NPOI.SS.UserModel.ICellStyle.TopBorderColor">
  30511. get the color to use for the top border
  30512. @return hhe index of the color defInition
  30513. </member>
  30514. <member name="P:NPOI.SS.UserModel.ICellStyle.BottomBorderColor">
  30515. get the color to use for the left border
  30516. @return the index of the color defInition
  30517. </member>
  30518. <member name="P:NPOI.SS.UserModel.ICellStyle.FillPattern">
  30519. get the fill pattern (??) - set to 1 to fill with foreground color
  30520. @return fill pattern
  30521. </member>
  30522. <member name="P:NPOI.SS.UserModel.ICellStyle.FillBackgroundColor">
  30523. get the background fill color
  30524. @return fill color
  30525. </member>
  30526. <member name="P:NPOI.SS.UserModel.ICellStyle.FillForegroundColor">
  30527. get the foreground fill color
  30528. @return fill color
  30529. </member>
  30530. <member name="M:NPOI.SS.UserModel.ICellStyle.CloneStyleFrom(NPOI.SS.UserModel.ICellStyle)">
  30531. Clones all the style information from another
  30532. CellStyle, onto this one. This
  30533. CellStyle will then have all the same
  30534. properties as the source, but the two may
  30535. be edited independently.
  30536. Any stylings on this CellStyle will be lost!
  30537. The source CellStyle could be from another
  30538. Workbook if you like. This allows you to
  30539. copy styles from one Workbook to another.
  30540. However, both of the CellStyles will need
  30541. to be of the same type (HSSFCellStyle or
  30542. XSSFCellStyle)
  30543. </member>
  30544. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderDiagonalColor">
  30545. <summary>
  30546. Gets or sets the color to use for the diagional border
  30547. </summary>
  30548. <value>The index of the color definition.</value>
  30549. </member>
  30550. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderDiagonalLineStyle">
  30551. <summary>
  30552. Gets or sets the line type to use for the diagional border
  30553. </summary>
  30554. <value>The line type.</value>
  30555. </member>
  30556. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderDiagonal">
  30557. <summary>
  30558. Gets or sets the type of diagional border
  30559. </summary>.
  30560. <value>The border diagional type.</value>
  30561. </member>
  30562. <member name="P:NPOI.SS.UserModel.ICellStyle.FillBackgroundColorColor">
  30563. Gets the color object representing the current
  30564. background fill, resolving indexes using
  30565. the supplied workbook.
  30566. This will work for both indexed and rgb
  30567. defined colors.
  30568. </member>
  30569. <member name="P:NPOI.SS.UserModel.ICellStyle.FillForegroundColorColor">
  30570. Gets the color object representing the current
  30571. foreground fill, resolving indexes using
  30572. the supplied workbook.
  30573. This will work for both indexed and rgb
  30574. defined colors.
  30575. </member>
  30576. <member name="T:NPOI.SS.UserModel.CellValue">
  30577. Mimics the 'data view' of a cell. This allows formula Evaluator
  30578. to return a CellValue instead of precasting the value to String
  30579. or Number or bool type.
  30580. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  30581. </member>
  30582. <member name="P:NPOI.SS.UserModel.CellValue.BooleanValue">
  30583. @return Returns the boolValue.
  30584. </member>
  30585. <member name="P:NPOI.SS.UserModel.CellValue.NumberValue">
  30586. @return Returns the numberValue.
  30587. </member>
  30588. <member name="P:NPOI.SS.UserModel.CellValue.StringValue">
  30589. @return Returns the stringValue.
  30590. </member>
  30591. <member name="P:NPOI.SS.UserModel.CellValue.CellType">
  30592. @return Returns the cellType.
  30593. </member>
  30594. <member name="P:NPOI.SS.UserModel.CellValue.ErrorValue">
  30595. @return Returns the errorValue.
  30596. </member>
  30597. <member name="T:NPOI.SS.UserModel.IChart">
  30598. High level representation of a chart.
  30599. @author Roman Kashitsyn
  30600. </member>
  30601. <member name="P:NPOI.SS.UserModel.IChart.ChartDataFactory">
  30602. @return an appropriate ChartDataFactory implementation
  30603. </member>
  30604. <member name="P:NPOI.SS.UserModel.IChart.ChartAxisFactory">
  30605. @return an appropriate ChartAxisFactory implementation
  30606. </member>
  30607. <member name="M:NPOI.SS.UserModel.IChart.GetOrCreateLegend">
  30608. @return chart legend instance
  30609. </member>
  30610. <member name="M:NPOI.SS.UserModel.IChart.DeleteLegend">
  30611. Delete current chart legend.
  30612. </member>
  30613. <member name="M:NPOI.SS.UserModel.IChart.GetAxis">
  30614. @return list of all chart axis
  30615. </member>
  30616. <member name="M:NPOI.SS.UserModel.IChart.Plot(NPOI.SS.UserModel.Charts.IChartData,NPOI.SS.UserModel.Charts.IChartAxis[])">
  30617. Plots specified data on the chart.
  30618. @param data a data to plot
  30619. </member>
  30620. <member name="T:NPOI.SS.UserModel.Charts.AxisCrossBetween">
  30621. Specifies the possible crossing states of an axis.
  30622. @author Roman Kashitsyn
  30623. </member>
  30624. <member name="F:NPOI.SS.UserModel.Charts.AxisCrossBetween.Between">
  30625. Specifies the value axis shall cross the category axis
  30626. between data markers.
  30627. </member>
  30628. <member name="F:NPOI.SS.UserModel.Charts.AxisCrossBetween.MidpointCategory">
  30629. Specifies the value axis shall cross the category axis at
  30630. the midpoint of a category.
  30631. </member>
  30632. <member name="T:NPOI.SS.UserModel.Charts.AxisCrosses">
  30633. Specifies the possible crossing points for an axis.
  30634. @author Roman Kashitsyn
  30635. </member>
  30636. <member name="F:NPOI.SS.UserModel.Charts.AxisCrosses.AutoZero">
  30637. The category axis crosses at the zero point of the value axis (if
  30638. possible), or the minimum value (if the minimum is greater than zero) or
  30639. the maximum (if the maximum is less than zero).
  30640. </member>
  30641. <member name="F:NPOI.SS.UserModel.Charts.AxisCrosses.Min">
  30642. The axis crosses at the maximum value.
  30643. </member>
  30644. <member name="F:NPOI.SS.UserModel.Charts.AxisCrosses.Max">
  30645. Axis crosses at the minimum value of the chart.
  30646. </member>
  30647. <member name="T:NPOI.SS.UserModel.Charts.AxisOrientation">
  30648. Specifies the possible ways to place a picture on a data point, series, wall, or floor.
  30649. @author Roman Kashitsyn
  30650. </member>
  30651. <member name="F:NPOI.SS.UserModel.Charts.AxisOrientation.MaxToMin">
  30652. Specifies that the values on the axis shall be reversed
  30653. so they go from maximum to minimum.
  30654. </member>
  30655. <member name="F:NPOI.SS.UserModel.Charts.AxisOrientation.MinToMax">
  30656. Specifies that the axis values shall be in the usual
  30657. order, minimum to maximum.
  30658. </member>
  30659. <member name="T:NPOI.SS.UserModel.Charts.AxisPosition">
  30660. Enumeration of all possible axis positions.
  30661. @author Roman Kashitsyn
  30662. </member>
  30663. <member name="T:NPOI.SS.UserModel.Charts.IBarChartData`2">
  30664. <summary>
  30665. Data for a Bar Chart
  30666. </summary>
  30667. <typeparam name="Tx"></typeparam>
  30668. <typeparam name="Ty"></typeparam>
  30669. </member>
  30670. <member name="M:NPOI.SS.UserModel.Charts.IBarChartData`2.GetSeries">
  30671. @return list of all series.
  30672. </member>
  30673. <member name="M:NPOI.SS.UserModel.Charts.IBarChartSeries`2.GetCategoryAxisData">
  30674. @return data source used for category axis data.
  30675. </member>
  30676. <member name="M:NPOI.SS.UserModel.Charts.IBarChartSeries`2.GetValues">
  30677. @return data source used for value axis.
  30678. </member>
  30679. <member name="T:NPOI.SS.UserModel.Charts.IChartAxis">
  30680. High level representation of chart axis.
  30681. @author Roman Kashitsyn
  30682. </member>
  30683. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.Id">
  30684. @return axis id
  30685. </member>
  30686. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.Position">
  30687. get or set axis position
  30688. </member>
  30689. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.NumberFormat">
  30690. get or set axis number format
  30691. </member>
  30692. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.IsSetLogBase">
  30693. @return true if log base is defined, false otherwise
  30694. </member>
  30695. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.LogBase">
  30696. @param logBase a number between 2 and 1000 (inclusive)
  30697. @return axis log base or 0.0 if not Set
  30698. @throws ArgumentException if log base not within allowed range
  30699. </member>
  30700. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.IsSetMinimum">
  30701. @return true if minimum value is defined, false otherwise
  30702. </member>
  30703. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.Minimum">
  30704. get or set axis minimum
  30705. 0.0 if not Set
  30706. </member>
  30707. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.IsSetMaximum">
  30708. @return true if maximum value is defined, false otherwise
  30709. </member>
  30710. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.Maximum">
  30711. get or set axis maximum
  30712. 0.0 if not Set
  30713. </member>
  30714. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.Orientation">
  30715. get or set axis orientation
  30716. </member>
  30717. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.Crosses">
  30718. get or set axis cross type
  30719. </member>
  30720. <member name="M:NPOI.SS.UserModel.Charts.IChartAxis.CrossAxis(NPOI.SS.UserModel.Charts.IChartAxis)">
  30721. Declare this axis cross another axis.
  30722. @param axis that this axis should cross
  30723. </member>
  30724. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.IsVisible">
  30725. @return visibility of the axis.
  30726. </member>
  30727. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.MajorTickMark">
  30728. @return major tick mark.
  30729. </member>
  30730. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.MinorTickMark">
  30731. @return minor tick mark.
  30732. </member>
  30733. <member name="T:NPOI.SS.UserModel.Charts.IChartAxisFactory">
  30734. <summary>
  30735. A factory for different chart axis.
  30736. </summary>
  30737. <remarks>@author Roman Kashitsyn</remarks>
  30738. </member>
  30739. <member name="M:NPOI.SS.UserModel.Charts.IChartAxisFactory.CreateValueAxis(NPOI.SS.UserModel.Charts.AxisPosition)">
  30740. <summary>
  30741. returns new value axis
  30742. </summary>
  30743. <param name="pos"></param>
  30744. <returns></returns>
  30745. </member>
  30746. <member name="T:NPOI.SS.UserModel.Charts.IChartData">
  30747. <summary>
  30748. A base for all chart data types.
  30749. </summary>
  30750. <remarks>
  30751. @author Roman Kashitsyn
  30752. </remarks>
  30753. </member>
  30754. <member name="M:NPOI.SS.UserModel.Charts.IChartData.FillChart(NPOI.SS.UserModel.IChart,NPOI.SS.UserModel.Charts.IChartAxis[])">
  30755. <summary>
  30756. Fills a chart with data specified by implementation.
  30757. </summary>
  30758. <param name="chart">a chart to fill in</param>
  30759. <param name="axis">chart axis to use</param>
  30760. </member>
  30761. <member name="T:NPOI.SS.UserModel.Charts.IChartDataFactory">
  30762. <summary>
  30763. A factory for different chart data types.
  30764. </summary>
  30765. <remarks>
  30766. @author Roman Kashitsyn
  30767. </remarks>
  30768. </member>
  30769. <member name="M:NPOI.SS.UserModel.Charts.IChartDataFactory.CreateScatterChartData``2">
  30770. <summary>
  30771. returns an appropriate ScatterChartData instance
  30772. </summary>
  30773. <returns></returns>
  30774. </member>
  30775. <member name="P:NPOI.SS.UserModel.Charts.IChartDataSource`1.PointCount">
  30776. Return number of points contained by data source.
  30777. @return number of points contained by data source
  30778. </member>
  30779. <member name="M:NPOI.SS.UserModel.Charts.IChartDataSource`1.GetPointAt(System.Int32)">
  30780. Returns point value at specified index.
  30781. @param index index to value from
  30782. @return point value at specified index.
  30783. @throws {@code IndexOutOfBoundsException} if index
  30784. parameter not in range {@code 0 &lt;= index &lt;= pointCount}
  30785. </member>
  30786. <member name="P:NPOI.SS.UserModel.Charts.IChartDataSource`1.IsReference">
  30787. Returns {@code true} if charts data source is valid cell range.
  30788. @return {@code true} if charts data source is valid cell range
  30789. </member>
  30790. <member name="P:NPOI.SS.UserModel.Charts.IChartDataSource`1.IsNumeric">
  30791. Returns {@code true} if data source points should be treated as numbers.
  30792. @return {@code true} if data source points should be treated as numbers
  30793. </member>
  30794. <member name="P:NPOI.SS.UserModel.Charts.IChartDataSource`1.FormulaString">
  30795. Returns formula representation of the data source. It is only applicable
  30796. for data source that is valid cell range.
  30797. @return formula representation of the data source
  30798. @throws {@code UnsupportedOperationException} if the data source is not a
  30799. reference.
  30800. </member>
  30801. <member name="T:NPOI.SS.UserModel.Charts.IChartLegend">
  30802. <summary>
  30803. High level representation of chart legend.
  30804. </summary>
  30805. <remarks>@author Roman Kashitsyn</remarks>
  30806. </member>
  30807. <member name="P:NPOI.SS.UserModel.Charts.IChartLegend.Position">
  30808. <summary>
  30809. legend position
  30810. </summary>
  30811. <returns></returns>
  30812. </member>
  30813. <member name="P:NPOI.SS.UserModel.Charts.IChartLegend.IsOverlay">
  30814. <summary>
  30815. If true the legend is positioned over the chart area otherwise
  30816. the legend is displayed next to it.
  30817. Default is no overlay.
  30818. </summary>
  30819. </member>
  30820. <member name="M:NPOI.SS.UserModel.Charts.IChartSeries.SetTitle(System.String)">
  30821. Sets the title of the series as a string literal.
  30822. @param title
  30823. </member>
  30824. <member name="M:NPOI.SS.UserModel.Charts.IChartSeries.SetTitle(NPOI.SS.Util.CellReference)">
  30825. Sets the title of the series as a cell reference.
  30826. @param titleReference
  30827. </member>
  30828. <member name="M:NPOI.SS.UserModel.Charts.IChartSeries.GetTitleString">
  30829. @return title as string literal.
  30830. </member>
  30831. <member name="M:NPOI.SS.UserModel.Charts.IChartSeries.GetTitleCellReference">
  30832. @return title as cell reference.
  30833. </member>
  30834. <member name="M:NPOI.SS.UserModel.Charts.IChartSeries.GetTitleType">
  30835. @return title type.
  30836. </member>
  30837. <member name="T:NPOI.SS.UserModel.Charts.LayoutMode">
  30838. <summary>
  30839. Specifies the possible ways to store a chart element's position.
  30840. </summary>
  30841. <remarks>
  30842. @author Roman Kashitsyn
  30843. </remarks>
  30844. </member>
  30845. <member name="F:NPOI.SS.UserModel.Charts.LayoutMode.Edge">
  30846. <summary>
  30847. Specifies that the Width or Height shall be interpreted as the Right or Bottom of the chart element.
  30848. </summary>
  30849. </member>
  30850. <member name="F:NPOI.SS.UserModel.Charts.LayoutMode.Factor">
  30851. <summary>
  30852. Specifies that the Width or Height shall be interpreted as the width or Height of the chart element.
  30853. </summary>
  30854. </member>
  30855. <member name="T:NPOI.SS.UserModel.Charts.LayoutTarget">
  30856. <summary>
  30857. Specifies whether to layout the plot area by its inside (not including axis
  30858. and axis labels) or outside (including axis and axis labels).
  30859. </summary>
  30860. <remarks>
  30861. @author Roman Kashitsyn
  30862. </remarks>
  30863. </member>
  30864. <member name="F:NPOI.SS.UserModel.Charts.LayoutTarget.Inner">
  30865. <summary>
  30866. Specifies that the plot area size shall determine the size of the plot area, not including the tick marks and axis labels.
  30867. </summary>
  30868. </member>
  30869. <member name="F:NPOI.SS.UserModel.Charts.LayoutTarget.Outer">
  30870. <summary>
  30871. Specifies that the plot area size shall determine the
  30872. size of the plot area, the tick marks, and the axis
  30873. labels.
  30874. </summary>
  30875. </member>
  30876. <member name="T:NPOI.SS.UserModel.Charts.LegendPosition">
  30877. <summary>
  30878. Enumeration of all possible chart legend positions.
  30879. </summary>
  30880. <remarks>
  30881. @author Roman Kashitsyn
  30882. </remarks>
  30883. </member>
  30884. <member name="T:NPOI.SS.UserModel.Charts.ILineChartData`2">
  30885. <summary>
  30886. Data for a Line Chart
  30887. </summary>
  30888. <typeparam name="Tx"></typeparam>
  30889. <typeparam name="Ty"></typeparam>
  30890. </member>
  30891. <member name="M:NPOI.SS.UserModel.Charts.ILineChartData`2.GetSeries">
  30892. @return list of all series.
  30893. </member>
  30894. <member name="M:NPOI.SS.UserModel.Charts.ILineChartSeries`2.GetCategoryAxisData">
  30895. @return data source used for category axis data.
  30896. </member>
  30897. <member name="M:NPOI.SS.UserModel.Charts.ILineChartSeries`2.GetValues">
  30898. @return data source used for value axis.
  30899. </member>
  30900. <member name="T:NPOI.SS.UserModel.Charts.IManualLayout">
  30901. High level representation of chart element manual layout.
  30902. @author Roman Kashitsyn
  30903. </member>
  30904. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetTarget(NPOI.SS.UserModel.Charts.LayoutTarget)">
  30905. Sets the layout target.
  30906. @param target new layout target.
  30907. </member>
  30908. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetTarget">
  30909. Returns current layout target.
  30910. @return current layout target
  30911. </member>
  30912. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetXMode(NPOI.SS.UserModel.Charts.LayoutMode)">
  30913. Sets the x-coordinate layout mode.
  30914. @param mode new x-coordinate layout mode.
  30915. </member>
  30916. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetXMode">
  30917. Returns current x-coordinnate layout mode.
  30918. @return current x-coordinate layout mode.
  30919. </member>
  30920. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetYMode(NPOI.SS.UserModel.Charts.LayoutMode)">
  30921. Sets the y-coordinate layout mode.
  30922. @param mode new y-coordinate layout mode.
  30923. </member>
  30924. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetYMode">
  30925. Returns current y-coordinate layout mode.
  30926. @return current y-coordinate layout mode.
  30927. </member>
  30928. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetX">
  30929. Returns the x location of the chart element.
  30930. @return the x location (left) of the chart element or 0.0 if
  30931. not Set.
  30932. </member>
  30933. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetX(System.Double)">
  30934. Specifies the x location (left) of the chart element as a
  30935. fraction of the width of the chart. If Left Mode is Factor,
  30936. then the position is relative to the default position for the
  30937. chart element.
  30938. </member>
  30939. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetY">
  30940. Returns current y location of the chart element.
  30941. @return the y location (top) of the chart element or 0.0 if not
  30942. Set.
  30943. </member>
  30944. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetY(System.Double)">
  30945. Specifies the y location (top) of the chart element as a
  30946. fraction of the height of the chart. If Top Mode is Factor,
  30947. then the position is relative to the default position for the
  30948. chart element.
  30949. </member>
  30950. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetWidthMode(NPOI.SS.UserModel.Charts.LayoutMode)">
  30951. Specifies how to interpret the Width element for this manual
  30952. layout.
  30953. @param mode new width layout mode of this manual layout.
  30954. </member>
  30955. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetWidthMode">
  30956. Returns current width mode of this manual layout.
  30957. @return width mode of this manual layout.
  30958. </member>
  30959. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetHeightMode(NPOI.SS.UserModel.Charts.LayoutMode)">
  30960. Specifies how to interpret the Height element for this manual
  30961. layout.
  30962. @param mode new height mode of this manual layout.
  30963. </member>
  30964. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetHeightMode">
  30965. Returns current height mode of this
  30966. @return height mode of this manual layout.
  30967. </member>
  30968. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetWidthRatio(System.Double)">
  30969. Specifies the width (if Width Mode is Factor) or right (if
  30970. Width Mode is Edge) of the chart element as a fraction of the
  30971. width of the chart.
  30972. @param ratio a fraction of the width of the chart.
  30973. </member>
  30974. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetWidthRatio">
  30975. Returns current fraction of the width of the chart.
  30976. @return fraction of the width of the chart or 0.0 if not Set.
  30977. </member>
  30978. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetHeightRatio(System.Double)">
  30979. Specifies the height (if Height Mode is Factor) or bottom (if
  30980. Height Mode is edge) of the chart element as a fraction of the
  30981. height of the chart.
  30982. @param ratio a fraction of the height of the chart.
  30983. </member>
  30984. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetHeightRatio">
  30985. Returns current fraction of the height of the chart.
  30986. @return fraction of the height of the chart or 0.0 if not Set.
  30987. </member>
  30988. <member name="T:NPOI.SS.UserModel.Charts.ManuallyPositionable">
  30989. Abstraction of chart element that can be positioned with manual
  30990. layout.
  30991. @author Roman Kashitsyn
  30992. </member>
  30993. <member name="M:NPOI.SS.UserModel.Charts.ManuallyPositionable.GetManualLayout">
  30994. Returns manual layout for the chart element.
  30995. @return manual layout for the chart element.
  30996. </member>
  30997. <member name="T:NPOI.SS.UserModel.Charts.IScatterChartData`2">
  30998. Data for a Scatter Chart
  30999. </member>
  31000. <member name="M:NPOI.SS.UserModel.Charts.IScatterChartData`2.AddSeries(NPOI.SS.UserModel.Charts.IChartDataSource{`0},NPOI.SS.UserModel.Charts.IChartDataSource{`1})">
  31001. @param xs data source to be used for X axis values
  31002. @param ys data source to be used for Y axis values
  31003. @return a new scatter charts series
  31004. </member>
  31005. <member name="M:NPOI.SS.UserModel.Charts.IScatterChartData`2.GetSeries">
  31006. @return list of all series
  31007. </member>
  31008. <member name="T:NPOI.SS.UserModel.Charts.IScatterChartSeries`2">
  31009. Represents scatter charts serie.
  31010. @author Roman Kashitsyn
  31011. </member>
  31012. <member name="M:NPOI.SS.UserModel.Charts.IScatterChartSeries`2.GetXValues">
  31013. @return data source used for X axis values
  31014. </member>
  31015. <member name="M:NPOI.SS.UserModel.Charts.IScatterChartSeries`2.GetYValues">
  31016. @return data source used for Y axis values
  31017. </member>
  31018. <member name="T:NPOI.SS.UserModel.Charts.IValueAxis">
  31019. @author Roman Kashitsyn
  31020. </member>
  31021. <member name="M:NPOI.SS.UserModel.Charts.IValueAxis.GetCrossBetween">
  31022. @return cross between type
  31023. </member>
  31024. <member name="M:NPOI.SS.UserModel.Charts.IValueAxis.SetCrossBetween(NPOI.SS.UserModel.Charts.AxisCrossBetween)">
  31025. @param crossBetween cross between type
  31026. </member>
  31027. <member name="F:NPOI.SS.UserModel.AnchorType.MoveAndResize">
  31028. Move and Resize With Anchor Cells
  31029. <p>
  31030. Specifies that the current drawing shall move and
  31031. resize to maintain its row and column anchors (i.e. the
  31032. object is anchored to the actual from and to row and column)
  31033. </p>
  31034. </member>
  31035. <member name="F:NPOI.SS.UserModel.AnchorType.MoveDontResize">
  31036. Move With Cells but Do Not Resize
  31037. <p>
  31038. Specifies that the current drawing shall move with its
  31039. row and column (i.e. the object is anchored to the
  31040. actual from row and column), but that the size shall remain absolute.
  31041. </p>
  31042. <p>
  31043. If Additional rows/columns are Added between the from and to locations of the drawing,
  31044. the drawing shall move its to anchors as needed to maintain this same absolute size.
  31045. </p>
  31046. </member>
  31047. <member name="F:NPOI.SS.UserModel.AnchorType.DontMoveAndResize">
  31048. Do Not Move or Resize With Underlying Rows/Columns
  31049. <p>
  31050. Specifies that the current start and end positions shall
  31051. be maintained with respect to the distances from the
  31052. absolute start point of the worksheet.
  31053. </p>
  31054. <p>
  31055. If Additional rows/columns are Added before the
  31056. drawing, the drawing shall move its anchors as needed
  31057. to maintain this same absolute position.
  31058. </p>
  31059. </member>
  31060. <member name="T:NPOI.SS.UserModel.IClientAnchor">
  31061. A client anchor is attached to an excel worksheet. It anchors against a
  31062. top-left and bottom-right cell.
  31063. @author Yegor Kozlov
  31064. </member>
  31065. <member name="P:NPOI.SS.UserModel.IClientAnchor.Col1">
  31066. Returns the column (0 based) of the first cell.
  31067. @return 0-based column of the first cell.
  31068. </member>
  31069. <member name="P:NPOI.SS.UserModel.IClientAnchor.Col2">
  31070. Returns the column (0 based) of the second cell.
  31071. @return 0-based column of the second cell.
  31072. </member>
  31073. <member name="P:NPOI.SS.UserModel.IClientAnchor.Row1">
  31074. Returns the row (0 based) of the first cell.
  31075. @return 0-based row of the first cell.
  31076. </member>
  31077. <member name="P:NPOI.SS.UserModel.IClientAnchor.Row2">
  31078. Returns the row (0 based) of the second cell.
  31079. @return 0-based row of the second cell.
  31080. </member>
  31081. <member name="P:NPOI.SS.UserModel.IClientAnchor.Dx1">
  31082. Returns the x coordinate within the first cell
  31083. @return the x coordinate within the first cell
  31084. </member>
  31085. <member name="P:NPOI.SS.UserModel.IClientAnchor.Dy1">
  31086. Returns the y coordinate within the first cell
  31087. @return the y coordinate within the first cell
  31088. </member>
  31089. <member name="P:NPOI.SS.UserModel.IClientAnchor.Dy2">
  31090. Sets the y coordinate within the second cell
  31091. @return the y coordinate within the second cell
  31092. </member>
  31093. <member name="P:NPOI.SS.UserModel.IClientAnchor.Dx2">
  31094. Returns the x coordinate within the second cell
  31095. @return the x coordinate within the second cell
  31096. </member>
  31097. <member name="P:NPOI.SS.UserModel.IClientAnchor.AnchorType">
  31098. s the anchor type
  31099. <p>
  31100. 0 = Move and size with Cells, 2 = Move but don't size with cells, 3 = Don't move or size with cells.
  31101. </p>
  31102. @return the anchor type
  31103. @see #MOVE_AND_RESIZE
  31104. @see #MOVE_DONT_RESIZE
  31105. @see #DONT_MOVE_AND_RESIZE
  31106. </member>
  31107. <member name="T:NPOI.SS.UserModel.IColorScaleFormatting">
  31108. High level representation for the Color Scale / Colour Scale /
  31109. Color Gradient Formatting component of Conditional Formatting Settings
  31110. </member>
  31111. <!-- Badly formed XML comment ignored for member "P:NPOI.SS.UserModel.IColorScaleFormatting.NumControlPoints" -->
  31112. <member name="P:NPOI.SS.UserModel.IColorScaleFormatting.Colors">
  31113. get or sets the list of colours that are interpolated
  31114. between.The number must match {@link #getNumControlPoints()}
  31115. </member>
  31116. <member name="P:NPOI.SS.UserModel.IColorScaleFormatting.Thresholds">
  31117. Gets the list of thresholds
  31118. </member>
  31119. <member name="M:NPOI.SS.UserModel.IColorScaleFormatting.CreateThreshold">
  31120. Creates a new, empty Threshold
  31121. </member>
  31122. <member name="P:NPOI.SS.UserModel.IComment.Visible">
  31123. Sets whether this comment is visible.
  31124. @return <c>true</c> if the comment is visible, <c>false</c> otherwise
  31125. </member>
  31126. <member name="P:NPOI.SS.UserModel.IComment.Address">
  31127. <summary>
  31128. Get or set the address of the cell that this comment is attached to
  31129. </summary>
  31130. </member>
  31131. <member name="M:NPOI.SS.UserModel.IComment.SetAddress(System.Int32,System.Int32)">
  31132. Set the address of the cell that this comment is attached to
  31133. @param row
  31134. @param col
  31135. </member>
  31136. <member name="P:NPOI.SS.UserModel.IComment.Row">
  31137. Return the row of the cell that Contains the comment
  31138. @return the 0-based row of the cell that Contains the comment
  31139. </member>
  31140. <member name="P:NPOI.SS.UserModel.IComment.Column">
  31141. Return the column of the cell that Contains the comment
  31142. @return the 0-based column of the cell that Contains the comment
  31143. </member>
  31144. <member name="P:NPOI.SS.UserModel.IComment.Author">
  31145. Name of the original comment author
  31146. @return the name of the original author of the comment
  31147. </member>
  31148. <member name="P:NPOI.SS.UserModel.IComment.String">
  31149. Fetches the rich text string of the comment
  31150. </member>
  31151. <member name="P:NPOI.SS.UserModel.IComment.ClientAnchor">
  31152. Return defines position of this anchor in the sheet.
  31153. The anchor is the yellow box/balloon that is rendered on top of the sheets
  31154. when the comment is visible.
  31155. To associate a comment with a different cell, use {@link #setAddress}.
  31156. @return defines position of this anchor in the sheet
  31157. </member>
  31158. <member name="T:NPOI.SS.UserModel.ComparisonOperator">
  31159. The conditional format operators used for "Highlight Cells That Contain..." rules.
  31160. <p>
  31161. For example, "highlight cells that begin with "M2" and contain "Mountain Gear".
  31162. </p>
  31163. @author Dmitriy Kumshayev
  31164. @author Yegor Kozlov
  31165. </member>
  31166. <member name="F:NPOI.SS.UserModel.ComparisonOperator.Between">
  31167. 'Between' operator
  31168. </member>
  31169. <member name="F:NPOI.SS.UserModel.ComparisonOperator.NotBetween">
  31170. 'Not between' operator
  31171. </member>
  31172. <member name="F:NPOI.SS.UserModel.ComparisonOperator.Equal">
  31173. 'Equal to' operator
  31174. </member>
  31175. <member name="F:NPOI.SS.UserModel.ComparisonOperator.NotEqual">
  31176. 'Not equal to' operator
  31177. </member>
  31178. <member name="F:NPOI.SS.UserModel.ComparisonOperator.GreaterThan">
  31179. 'Greater than' operator
  31180. </member>
  31181. <member name="F:NPOI.SS.UserModel.ComparisonOperator.LessThan">
  31182. 'Less than' operator
  31183. </member>
  31184. <member name="F:NPOI.SS.UserModel.ComparisonOperator.GreaterThanOrEqual">
  31185. 'Greater than or equal to' operator
  31186. </member>
  31187. <member name="F:NPOI.SS.UserModel.ComparisonOperator.LessThanOrEqual">
  31188. 'Less than or equal to' operator
  31189. </member>
  31190. <member name="T:NPOI.SS.UserModel.IConditionalFormatting">
  31191. The ConditionalFormatting class encapsulates all Settings of Conditional Formatting.
  31192. The class can be used
  31193. <UL>
  31194. <LI>
  31195. to make a copy ConditionalFormatting Settings.
  31196. </LI>
  31197. For example:
  31198. <PRE>
  31199. ConditionalFormatting cf = sheet.GetConditionalFormattingAt(index);
  31200. newSheet.AddConditionalFormatting(cf);
  31201. </PRE>
  31202. <LI>
  31203. or to modify existing Conditional Formatting Settings (formatting regions and/or rules).
  31204. </LI>
  31205. </UL>
  31206. Use {@link NPOI.HSSF.UserModel.Sheet#getSheetConditionalFormatting()} to Get access to an instance of this class.
  31207. To create a new Conditional Formatting Set use the following approach:
  31208. <PRE>
  31209. // Define a Conditional Formatting rule, which triggers formatting
  31210. // when cell's value is greater or equal than 100.0 and
  31211. // applies patternFormatting defined below.
  31212. ConditionalFormattingRule rule = sheet.CreateConditionalFormattingRule(
  31213. ComparisonOperator.GE,
  31214. "100.0", // 1st formula
  31215. null // 2nd formula is not used for comparison operator GE
  31216. );
  31217. // Create pattern with red background
  31218. PatternFormatting patternFmt = rule.CretePatternFormatting();
  31219. patternFormatting.FillBackgroundColor(IndexedColor.RED.Index);
  31220. // Define a region Containing first column
  31221. Region [] regions =
  31222. {
  31223. new Region(1,(short)1,-1,(short)1)
  31224. };
  31225. // Apply Conditional Formatting rule defined above to the regions
  31226. sheet.AddConditionalFormatting(regions, rule);
  31227. </PRE>
  31228. @author Dmitriy Kumshayev
  31229. @author Yegor Kozlov
  31230. </member>
  31231. <member name="M:NPOI.SS.UserModel.IConditionalFormatting.GetFormattingRanges">
  31232. @return array of <c>CellRangeAddress</c>s. Never <code>null</code>
  31233. </member>
  31234. <member name="M:NPOI.SS.UserModel.IConditionalFormatting.SetRule(System.Int32,NPOI.SS.UserModel.IConditionalFormattingRule)">
  31235. Replaces an existing Conditional Formatting rule at position idx.
  31236. Excel allows to create up to 3 Conditional Formatting rules.
  31237. This method can be useful to modify existing Conditional Formatting rules.
  31238. @param idx position of the rule. Should be between 0 and 2.
  31239. @param cfRule - Conditional Formatting rule
  31240. </member>
  31241. <member name="M:NPOI.SS.UserModel.IConditionalFormatting.AddRule(NPOI.SS.UserModel.IConditionalFormattingRule)">
  31242. Add a Conditional Formatting rule.
  31243. Excel allows to create up to 3 Conditional Formatting rules.
  31244. @param cfRule - Conditional Formatting rule
  31245. </member>
  31246. <member name="M:NPOI.SS.UserModel.IConditionalFormatting.GetRule(System.Int32)">
  31247. @return the Conditional Formatting rule at position idx.
  31248. </member>
  31249. <member name="P:NPOI.SS.UserModel.IConditionalFormatting.NumberOfRules">
  31250. @return number of Conditional Formatting rules.
  31251. </member>
  31252. <member name="T:NPOI.SS.UserModel.IConditionalFormattingRule">
  31253. Represents a description of a conditional formatting rule
  31254. @author Dmitriy Kumshayev
  31255. @author Yegor Kozlov
  31256. </member>
  31257. <member name="M:NPOI.SS.UserModel.IConditionalFormattingRule.CreateBorderFormatting">
  31258. Create a new border formatting structure if it does not exist,
  31259. otherwise just return existing object.
  31260. @return - border formatting object, never returns <code>null</code>.
  31261. </member>
  31262. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.BorderFormatting">
  31263. @return - border formatting object if defined, <code>null</code> otherwise
  31264. </member>
  31265. <member name="M:NPOI.SS.UserModel.IConditionalFormattingRule.CreateFontFormatting">
  31266. Create a new font formatting structure if it does not exist,
  31267. otherwise just return existing object.
  31268. @return - font formatting object, never returns <code>null</code>.
  31269. </member>
  31270. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.FontFormatting">
  31271. @return - font formatting object if defined, <code>null</code> otherwise
  31272. </member>
  31273. <member name="M:NPOI.SS.UserModel.IConditionalFormattingRule.CreatePatternFormatting">
  31274. Create a new pattern formatting structure if it does not exist,
  31275. otherwise just return existing object.
  31276. @return - pattern formatting object, never returns <code>null</code>.
  31277. </member>
  31278. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.PatternFormatting">
  31279. @return - pattern formatting object if defined, <code>null</code> otherwise
  31280. </member>
  31281. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.DataBarFormatting">
  31282. @return - databar / data-bar formatting object if defined, <code>null</code> otherwise
  31283. </member>
  31284. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.MultiStateFormatting">
  31285. @return - icon / multi-state formatting object if defined, <code>null</code> otherwise
  31286. </member>
  31287. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.ColorScaleFormatting">
  31288. @return color scale / color grate formatting object if defined, <code>null</code> otherwise
  31289. </member>
  31290. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.ConditionType">
  31291. Type of conditional formatting rule.
  31292. <p>
  31293. MUST be either {@link #CONDITION_TYPE_CELL_VALUE_IS} or {@link #CONDITION_TYPE_FORMULA}
  31294. </p>
  31295. @return the type of condition
  31296. </member>
  31297. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.ComparisonOperation">
  31298. The comparison function used when the type of conditional formatting is Set to
  31299. {@link #CONDITION_TYPE_CELL_VALUE_IS}
  31300. <p>
  31301. MUST be a constant from {@link ComparisonOperator}
  31302. </p>
  31303. @return the conditional format operator
  31304. </member>
  31305. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.Formula1">
  31306. The formula used to Evaluate the first operand for the conditional formatting rule.
  31307. <p>
  31308. If the condition type is {@link #CONDITION_TYPE_CELL_VALUE_IS},
  31309. this field is the first operand of the comparison.
  31310. If type is {@link #CONDITION_TYPE_FORMULA}, this formula is used
  31311. to determine if the conditional formatting is applied.
  31312. </p>
  31313. <p>
  31314. If comparison type is {@link #CONDITION_TYPE_FORMULA} the formula MUST be a Boolean function
  31315. </p>
  31316. @return the first formula
  31317. </member>
  31318. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.Formula2">
  31319. The formula used to Evaluate the second operand of the comparison when
  31320. comparison type is {@link #CONDITION_TYPE_CELL_VALUE_IS} and operator
  31321. is either {@link ComparisonOperator#BETWEEN} or {@link ComparisonOperator#NOT_BETWEEN}
  31322. @return the second formula
  31323. </member>
  31324. <member name="T:NPOI.SS.UserModel.IConditionalFormattingThreshold">
  31325. The Threshold / CFVO / Conditional Formatting Value Object.
  31326. <p>This defines how to calculate the ranges for a conditional
  31327. formatting rule, eg which values Get a Green Traffic Light
  31328. icon and which Yellow or Red.</p>
  31329. </member>
  31330. <member name="P:NPOI.SS.UserModel.IConditionalFormattingThreshold.RangeType">
  31331. Get the Range Type used
  31332. </member>
  31333. <member name="P:NPOI.SS.UserModel.IConditionalFormattingThreshold.Formula">
  31334. Formula to use to calculate the threshold,
  31335. or <code>null</code> if no formula
  31336. </member>
  31337. <member name="P:NPOI.SS.UserModel.IConditionalFormattingThreshold.Value">
  31338. Gets the value used for the threshold, or
  31339. <code>null</code> if there isn't one.
  31340. </member>
  31341. <member name="T:NPOI.SS.UserModel.ConditionType">
  31342. Represents a type of a conditional formatting rule
  31343. </member>
  31344. <member name="F:NPOI.SS.UserModel.ConditionType.CellValueIs">
  31345. This conditional formatting rule compares a cell value
  31346. to a formula calculated result, using an operator
  31347. </member>
  31348. <member name="F:NPOI.SS.UserModel.ConditionType.Formula">
  31349. This conditional formatting rule contains a formula to evaluate.
  31350. When the formula result is true, the cell is highlighted.
  31351. </member>
  31352. <member name="F:NPOI.SS.UserModel.ConditionType.ColorScale">
  31353. This conditional formatting rule contains a color scale,
  31354. with the cell background set according to a gradient.
  31355. </member>
  31356. <member name="F:NPOI.SS.UserModel.ConditionType.DataBar">
  31357. This conditional formatting rule sets a data bar, with the
  31358. cell populated with bars based on their values
  31359. </member>
  31360. <member name="F:NPOI.SS.UserModel.ConditionType.Filter">
  31361. This conditional formatting rule that files the values
  31362. </member>
  31363. <member name="F:NPOI.SS.UserModel.ConditionType.IconSet">
  31364. This conditional formatting rule sets a data bar, with the
  31365. cell populated with bars based on their values
  31366. </member>
  31367. <member name="T:NPOI.SS.UserModel.ICreationHelper">
  31368. An object that handles instantiating concrete
  31369. classes of the various instances one needs for
  31370. HSSF and XSSF.
  31371. Works around a major shortcoming in Java, where we
  31372. can't have static methods on interfaces or abstract
  31373. classes.
  31374. This allows you to get the appropriate class for
  31375. a given interface, without you having to worry
  31376. about if you're dealing with HSSF or XSSF, despite
  31377. Java being quite rubbish.
  31378. </member>
  31379. <member name="M:NPOI.SS.UserModel.ICreationHelper.CreateRichTextString(System.String)">
  31380. Creates a new RichTextString instance
  31381. @param text The text to Initialise the RichTextString with
  31382. </member>
  31383. <member name="M:NPOI.SS.UserModel.ICreationHelper.CreateDataFormat">
  31384. Creates a new DataFormat instance
  31385. </member>
  31386. <member name="M:NPOI.SS.UserModel.ICreationHelper.CreateHyperlink(NPOI.SS.UserModel.HyperlinkType)">
  31387. Creates a new Hyperlink, of the given type
  31388. </member>
  31389. <member name="M:NPOI.SS.UserModel.ICreationHelper.CreateFormulaEvaluator">
  31390. Creates FormulaEvaluator - an object that Evaluates formula cells.
  31391. @return a FormulaEvaluator instance
  31392. </member>
  31393. <member name="M:NPOI.SS.UserModel.ICreationHelper.CreateExtendedColor">
  31394. Creates a XSSF-style Color object, used for extended sheet
  31395. formattings and conditional formattings
  31396. </member>
  31397. <member name="T:NPOI.SS.UserModel.IDataBarFormatting">
  31398. High level representation for the DataBar Formatting
  31399. component of Conditional Formatting Settings
  31400. </member>
  31401. <member name="P:NPOI.SS.UserModel.IDataBarFormatting.IsLeftToRight">
  31402. Is the bar Drawn from Left-to-Right, or from
  31403. Right-to-Left
  31404. </member>
  31405. <member name="P:NPOI.SS.UserModel.IDataBarFormatting.IsIconOnly">
  31406. Should Icon + Value be displayed, or only the Icon?
  31407. </member>
  31408. <member name="P:NPOI.SS.UserModel.IDataBarFormatting.WidthMin">
  31409. How much of the cell width, in %, should be given to
  31410. the min value?
  31411. </member>
  31412. <member name="P:NPOI.SS.UserModel.IDataBarFormatting.WidthMax">
  31413. How much of the cell width, in %, should be given to
  31414. the max value?
  31415. </member>
  31416. <member name="P:NPOI.SS.UserModel.IDataBarFormatting.MinThreshold">
  31417. The threshold that defines "everything from here down is minimum"
  31418. </member>
  31419. <member name="P:NPOI.SS.UserModel.IDataBarFormatting.MaxThreshold">
  31420. The threshold that defines "everything from here up is maximum"
  31421. </member>
  31422. <member name="T:NPOI.SS.UserModel.DataConsolidateFunction">
  31423. Enum mapping the values of STDataConsolidateFunction
  31424. </member>
  31425. <member name="M:NPOI.SS.UserModel.IDataFormat.GetFormat(System.String)">
  31426. get the format index that matches the given format string.
  31427. Creates a new format if one is not found. Aliases text to the proper format.
  31428. @param format string matching a built in format
  31429. @return index of format.
  31430. </member>
  31431. <member name="M:NPOI.SS.UserModel.IDataFormat.GetFormat(System.Int16)">
  31432. get the format string that matches the given format index
  31433. @param index of a format
  31434. @return string represented at index of format or null if there is not a format at that index
  31435. </member>
  31436. <!-- Badly formed XML comment ignored for member "T:NPOI.SS.UserModel.DataFormatter" -->
  31437. <member name="F:NPOI.SS.UserModel.DataFormatter.numPattern">
  31438. Pattern to find a number FormatBase: "0" or "#"
  31439. </member>
  31440. <member name="F:NPOI.SS.UserModel.DataFormatter.amPmPattern">
  31441. Pattern to find "AM/PM" marker
  31442. </member>
  31443. <member name="F:NPOI.SS.UserModel.DataFormatter.localePatternGroup">
  31444. A regex to find patterns like [$$-1009] and [$�-452].
  31445. Note that we don't currently process these into locales
  31446. </member>
  31447. <member name="F:NPOI.SS.UserModel.DataFormatter.fractionPattern">
  31448. A regex to identify a fraction pattern.
  31449. This requires that replaceAll("\\?", "#") has already been called
  31450. </member>
  31451. <member name="F:NPOI.SS.UserModel.DataFormatter.fractionStripper">
  31452. A regex to strip junk out of fraction formats
  31453. </member>
  31454. <member name="F:NPOI.SS.UserModel.DataFormatter.alternateGrouping">
  31455. A regex to detect if an alternate grouping character is used
  31456. in a numeric format
  31457. </member>
  31458. <member name="F:NPOI.SS.UserModel.DataFormatter.invalidDateTimeString">
  31459. Cells formatted with a date or time format and which contain invalid date or time values
  31460. show 255 pound signs ("#").
  31461. </member>
  31462. <member name="F:NPOI.SS.UserModel.DataFormatter.decimalSymbols">
  31463. The decimal symbols of the locale used for formatting values.
  31464. </member>
  31465. <member name="F:NPOI.SS.UserModel.DataFormatter.dateSymbols">
  31466. The date symbols of the locale used for formatting values.
  31467. </member>
  31468. <member name="F:NPOI.SS.UserModel.DataFormatter.defaultDateformat">
  31469. A default date format, if no date format was given
  31470. </member>
  31471. <member name="F:NPOI.SS.UserModel.DataFormatter.generalNumberFormat">
  31472. <em>General</em> FormatBase for whole numbers.
  31473. </member>
  31474. <member name="F:NPOI.SS.UserModel.DataFormatter.defaultNumFormat">
  31475. A default FormatBase to use when a number pattern cannot be Parsed.
  31476. </member>
  31477. <member name="F:NPOI.SS.UserModel.DataFormatter.logger">
  31478. For logging any problems we find
  31479. </member>
  31480. <member name="F:NPOI.SS.UserModel.DataFormatter.localeIsAdapting">
  31481. stores if the locale should change according to {@link LocaleUtil#getUserLocale()}
  31482. </member>
  31483. <member name="M:NPOI.SS.UserModel.DataFormatter.#ctor(System.Boolean)">
  31484. Creates a formatter using the {@link Locale#getDefault() default locale}.
  31485. @param emulateCSV whether to emulate CSV output.
  31486. </member>
  31487. <member name="M:NPOI.SS.UserModel.DataFormatter.#ctor(System.Globalization.CultureInfo)">
  31488. Creates a formatter using the given locale.
  31489. </member>
  31490. <member name="M:NPOI.SS.UserModel.DataFormatter.#ctor(System.Globalization.CultureInfo,System.Boolean)">
  31491. Creates a formatter using the given locale.
  31492. @param emulateCSV whether to emulate CSV output.
  31493. </member>
  31494. <member name="M:NPOI.SS.UserModel.DataFormatter.#ctor(System.Globalization.CultureInfo,System.Boolean,System.Boolean)">
  31495. Constructor
  31496. </member>
  31497. <member name="M:NPOI.SS.UserModel.DataFormatter.GetFormat(NPOI.SS.UserModel.ICell)">
  31498. Return a FormatBase for the given cell if one exists, otherwise try to
  31499. Create one. This method will return <c>null</c> if the any of the
  31500. following is true:
  31501. <ul>
  31502. <li>the cell's style is null</li>
  31503. <li>the style's data FormatBase string is null or empty</li>
  31504. <li>the FormatBase string cannot be recognized as either a number or date</li>
  31505. </ul>
  31506. @param cell The cell to retrieve a FormatBase for
  31507. @return A FormatBase for the FormatBase String
  31508. </member>
  31509. <member name="M:NPOI.SS.UserModel.DataFormatter.CreateFormat(NPOI.SS.UserModel.ICell)">
  31510. Create and return a FormatBase based on the FormatBase string from a cell's
  31511. style. If the pattern cannot be Parsed, return a default pattern.
  31512. @param cell The Excel cell
  31513. @return A FormatBase representing the excel FormatBase. May return null.
  31514. </member>
  31515. <member name="M:NPOI.SS.UserModel.DataFormatter.GetDefaultFormat(NPOI.SS.UserModel.ICell)">
  31516. Returns a default FormatBase for a cell.
  31517. @param cell The cell
  31518. @return a default FormatBase
  31519. </member>
  31520. <member name="M:NPOI.SS.UserModel.DataFormatter.GetFormattedDateString(NPOI.SS.UserModel.ICell)">
  31521. Returns the Formatted value of an Excel date as a <c>String</c> based
  31522. on the cell's <c>DataFormat</c>. i.e. "Thursday, January 02, 2003"
  31523. , "01/02/2003" , "02-Jan" , etc.
  31524. @param cell The cell
  31525. @return a Formatted date string
  31526. </member>
  31527. <member name="M:NPOI.SS.UserModel.DataFormatter.GetFormattedNumberString(NPOI.SS.UserModel.ICell)">
  31528. Returns the Formatted value of an Excel number as a <c>String</c>
  31529. based on the cell's <c>DataFormat</c>. Supported Formats include
  31530. currency, percents, decimals, phone number, SSN, etc.:
  31531. "61.54%", "$100.00", "(800) 555-1234".
  31532. @param cell The cell
  31533. @return a Formatted number string
  31534. </member>
  31535. <member name="M:NPOI.SS.UserModel.DataFormatter.FormatRawCellContents(System.Double,System.Int32,System.String)">
  31536. Formats the given raw cell value, based on the supplied
  31537. FormatBase index and string, according to excel style rules.
  31538. @see #FormatCellValue(Cell)
  31539. </member>
  31540. <member name="M:NPOI.SS.UserModel.DataFormatter.PerformDateFormatting(System.DateTime,NPOI.SS.Util.FormatBase)">
  31541. Performs Excel-style date formatting, using the
  31542. supplied Date and format
  31543. </member>
  31544. <member name="M:NPOI.SS.UserModel.DataFormatter.FormatRawCellContents(System.Double,System.Int32,System.String,System.Boolean)">
  31545. Formats the given raw cell value, based on the supplied
  31546. format index and string, according to excel style rules.
  31547. @see #formatCellValue(Cell)
  31548. </member>
  31549. <member name="M:NPOI.SS.UserModel.DataFormatter.FormatCellValue(NPOI.SS.UserModel.ICell)">
  31550. Returns the Formatted value of a cell as a <c>String</c> regardless
  31551. of the cell type. If the Excel FormatBase pattern cannot be Parsed then the
  31552. cell value will be Formatted using a default FormatBase.
  31553. When passed a null or blank cell, this method will return an empty
  31554. String (""). Formulas in formula type cells will not be evaluated.
  31555. @param cell The cell
  31556. @return the Formatted cell value as a String
  31557. </member>
  31558. <member name="M:NPOI.SS.UserModel.DataFormatter.FormatCellValue(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.IFormulaEvaluator)">
  31559. Returns the Formatted value of a cell as a <c>String</c> regardless
  31560. of the cell type. If the Excel FormatBase pattern cannot be Parsed then the
  31561. cell value will be Formatted using a default FormatBase.
  31562. When passed a null or blank cell, this method will return an empty
  31563. String (""). Formula cells will be evaluated using the given
  31564. {@link HSSFFormulaEvaluator} if the evaluator is non-null. If the
  31565. evaluator is null, then the formula String will be returned. The caller
  31566. is responsible for setting the currentRow on the evaluator
  31567. @param cell The cell (can be null)
  31568. @param evaluator The HSSFFormulaEvaluator (can be null)
  31569. @return a string value of the cell
  31570. </member>
  31571. <member name="M:NPOI.SS.UserModel.DataFormatter.SetDefaultNumberFormat(NPOI.SS.Util.FormatBase)">
  31572. Sets a default number FormatBase to be used when the Excel FormatBase cannot be
  31573. Parsed successfully. <b>Note:</b> This is a fall back for when an error
  31574. occurs while parsing an Excel number FormatBase pattern. This will not
  31575. affect cells with the <em>General</em> FormatBase.
  31576. The value that will be passed to the FormatBase's FormatBase method (specified
  31577. by <c>java.text.FormatBase#FormatBase</c>) will be a double value from a
  31578. numeric cell. Therefore the code in the FormatBase method should expect a
  31579. <c>Number</c> value.
  31580. @param FormatBase A FormatBase instance to be used as a default
  31581. @see java.text.FormatBase#FormatBase
  31582. </member>
  31583. <member name="M:NPOI.SS.UserModel.DataFormatter.AddFormat(System.String,NPOI.SS.Util.FormatBase)">
  31584. Adds a new FormatBase to the available formats.
  31585. The value that will be passed to the FormatBase's FormatBase method (specified
  31586. by <c>java.text.FormatBase#FormatBase</c>) will be a double value from a
  31587. numeric cell. Therefore the code in the FormatBase method should expect a
  31588. <c>Number</c> value.
  31589. @param excelformatStr The data FormatBase string
  31590. @param FormatBase A FormatBase instance
  31591. </member>
  31592. <member name="M:NPOI.SS.UserModel.DataFormatter.Update(System.IObservable{System.Object},System.Object)">
  31593. Update formats when locale has been changed
  31594. @param observable usually this is our own Observable instance
  31595. @param localeObj only reacts on Locale objects
  31596. </member>
  31597. <member name="T:NPOI.SS.UserModel.DataFormatter.CellFormatResultWrapper">
  31598. Workaround until we merge {@link DataFormatter} with {@link CellFormat}.
  31599. Constant, non-cachable wrapper around a {@link CellFormatResult}
  31600. </member>
  31601. <member name="T:NPOI.SS.UserModel.ERRORSTYLE">
  31602. Error style constants for error box
  31603. </member>
  31604. <member name="F:NPOI.SS.UserModel.ERRORSTYLE.STOP">
  31605. STOP style
  31606. </member>
  31607. <member name="F:NPOI.SS.UserModel.ERRORSTYLE.WARNING">
  31608. WARNING style
  31609. </member>
  31610. <member name="F:NPOI.SS.UserModel.ERRORSTYLE.INFO">
  31611. INFO style
  31612. </member>
  31613. <member name="P:NPOI.SS.UserModel.IDataValidation.ErrorStyle">
  31614. <summary>
  31615. get or set the error style for error box
  31616. </summary>
  31617. </member>
  31618. <member name="P:NPOI.SS.UserModel.IDataValidation.EmptyCellAllowed">
  31619. <summary>
  31620. Setting this allows an empty object as a valid value. Retrieve the settings for empty cells allowed.
  31621. @return True if this object should treats empty as valid value , false otherwise
  31622. </summary>
  31623. <value><c>true</c> if this object should treats empty as valid value, <c>false</c> otherwise</value>
  31624. </member>
  31625. <member name="P:NPOI.SS.UserModel.IDataValidation.SuppressDropDownArrow">
  31626. <summary>
  31627. Useful for list validation objects .
  31628. Useful only list validation objects . This method always returns false if the object isn't a list validation object
  31629. </summary>
  31630. </member>
  31631. <member name="P:NPOI.SS.UserModel.IDataValidation.ShowPromptBox">
  31632. Sets the behaviour when a cell which belongs to this object is selected
  31633. <value><c>true</c> if an prompt box should be displayed , <c>false</c> otherwise</value>
  31634. </member>
  31635. <member name="P:NPOI.SS.UserModel.IDataValidation.ShowErrorBox">
  31636. Sets the behaviour when an invalid value is entered
  31637. <value><c>true</c> if an error box should be displayed , <c>false</c> otherwise</value>
  31638. </member>
  31639. <member name="M:NPOI.SS.UserModel.IDataValidation.CreatePromptBox(System.String,System.String)">
  31640. Sets the title and text for the prompt box . Prompt box is displayed when
  31641. the user selects a cell which belongs to this validation object . In
  31642. order for a prompt box to be displayed you should also use method
  31643. SetShowPromptBox( bool show )
  31644. @param title The prompt box's title
  31645. @param text The prompt box's text
  31646. </member>
  31647. <member name="P:NPOI.SS.UserModel.IDataValidation.PromptBoxTitle">
  31648. @return Prompt box's title or <code>null</code>
  31649. </member>
  31650. <member name="P:NPOI.SS.UserModel.IDataValidation.PromptBoxText">
  31651. @return Prompt box's text or <code>null</code>
  31652. </member>
  31653. <member name="M:NPOI.SS.UserModel.IDataValidation.CreateErrorBox(System.String,System.String)">
  31654. Sets the title and text for the error box . Error box is displayed when
  31655. the user enters an invalid value int o a cell which belongs to this
  31656. validation object . In order for an error box to be displayed you should
  31657. also use method SetShowErrorBox( bool show )
  31658. @param title The error box's title
  31659. @param text The error box's text
  31660. </member>
  31661. <member name="P:NPOI.SS.UserModel.IDataValidation.ErrorBoxTitle">
  31662. @return Error box's title or <code>null</code>
  31663. </member>
  31664. <member name="P:NPOI.SS.UserModel.IDataValidation.ErrorBoxText">
  31665. @return Error box's text or <code>null</code>
  31666. </member>
  31667. <member name="M:NPOI.SS.UserModel.IDataValidationConstraint.GetValidationType">
  31668. <summary>
  31669. return data validation type of this constraint
  31670. </summary>
  31671. <returns></returns>
  31672. </member>
  31673. <member name="P:NPOI.SS.UserModel.IDataValidationConstraint.Operator">
  31674. <summary>
  31675. get or set then comparison operator for this constraint
  31676. </summary>
  31677. </member>
  31678. <member name="P:NPOI.SS.UserModel.IDataValidationConstraint.ExplicitListValues">
  31679. <summary>
  31680. If validation type is {@link ValidationType#LIST}
  31681. and <code>formula1</code> was comma-separated literal values rather than a range or named range,
  31682. returns list of literal values.
  31683. Otherwise returns <code>null</code>.
  31684. </summary>
  31685. </member>
  31686. <member name="P:NPOI.SS.UserModel.IDataValidationConstraint.Formula1">
  31687. <summary>
  31688. get or set the formula for expression 1. May be <code>null</code>
  31689. </summary>
  31690. </member>
  31691. <member name="P:NPOI.SS.UserModel.IDataValidationConstraint.Formula2">
  31692. <summary>
  31693. get or set the formula for expression 2. May be <code>null</code>
  31694. </summary>
  31695. </member>
  31696. <member name="T:NPOI.SS.UserModel.ValidationType">
  31697. ValidationType enum
  31698. </member>
  31699. <member name="F:NPOI.SS.UserModel.ValidationType.ANY">
  31700. 'Any value' type - value not restricted
  31701. </member>
  31702. <member name="F:NPOI.SS.UserModel.ValidationType.INTEGER">
  31703. int ('Whole number') type
  31704. </member>
  31705. <member name="F:NPOI.SS.UserModel.ValidationType.DECIMAL">
  31706. Decimal type
  31707. </member>
  31708. <member name="F:NPOI.SS.UserModel.ValidationType.LIST">
  31709. List type ( combo box type )
  31710. </member>
  31711. <member name="F:NPOI.SS.UserModel.ValidationType.DATE">
  31712. Date type
  31713. </member>
  31714. <member name="F:NPOI.SS.UserModel.ValidationType.TIME">
  31715. Time type
  31716. </member>
  31717. <member name="F:NPOI.SS.UserModel.ValidationType.TEXT_LENGTH">
  31718. String length type
  31719. </member>
  31720. <member name="F:NPOI.SS.UserModel.ValidationType.FORMULA">
  31721. Formula ( 'Custom' ) type
  31722. </member>
  31723. <member name="T:NPOI.SS.UserModel.OperatorType">
  31724. Condition operator enum
  31725. </member>
  31726. <member name="F:NPOI.SS.UserModel.OperatorType.IGNORED">
  31727. default value to supply when the operator type is not used
  31728. </member>
  31729. <member name="T:NPOI.SS.UserModel.IDataValidationHelper">
  31730. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  31731. </member>
  31732. <member name="T:NPOI.SS.UserModel.DateUtil">
  31733. <summary>
  31734. Contains methods for dealing with Excel dates.
  31735. @author Michael Harhen
  31736. @author Glen Stampoultzis (glens at apache.org)
  31737. @author Dan Sherman (dsherman at Isisph.com)
  31738. @author Hack Kampbjorn (hak at 2mba.dk)
  31739. @author Alex Jacoby (ajacoby at gmail.com)
  31740. @author Pavel Krupets (pkrupets at palmtreebusiness dot com)
  31741. @author Thies Wellpott
  31742. </summary>
  31743. </member>
  31744. <member name="F:NPOI.SS.UserModel.DateUtil.date_ptrn1">
  31745. The following patterns are used in {@link #isADateFormat(int, String)}
  31746. </member>
  31747. <member name="M:NPOI.SS.UserModel.DateUtil.absoluteDay(System.DateTime,System.Boolean)">
  31748. <summary>
  31749. Given a Calendar, return the number of days since 1899/12/31.
  31750. </summary>
  31751. <param name="cal">the date</param>
  31752. <param name="use1904windowing">if set to <c>true</c> [use1904windowing].</param>
  31753. <returns>number of days since 1899/12/31</returns>
  31754. </member>
  31755. <member name="M:NPOI.SS.UserModel.DateUtil.DaysInPriorYears(System.Int32,System.Boolean)">
  31756. <summary>
  31757. Return the number of days in prior years since 1900
  31758. </summary>
  31759. <param name="yr">a year (1900 &lt; yr &gt; 4000).</param>
  31760. <param name="use1904windowing"></param>
  31761. <returns>number of days in years prior to yr</returns>
  31762. </member>
  31763. <member name="M:NPOI.SS.UserModel.DateUtil.GetExcelDate(System.DateTime)">
  31764. <summary>
  31765. Given a Date, Converts it into a double representing its internal Excel representation,
  31766. which Is the number of days since 1/1/1900. Fractional days represent hours, minutes, and seconds.
  31767. </summary>
  31768. <param name="date">Excel representation of Date (-1 if error - test for error by Checking for less than 0.1)</param>
  31769. <returns>the Date</returns>
  31770. </member>
  31771. <member name="M:NPOI.SS.UserModel.DateUtil.GetExcelDate(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean)">
  31772. <summary>
  31773. Gets the excel date.
  31774. </summary>
  31775. <param name="year">The year.</param>
  31776. <param name="month">The month.</param>
  31777. <param name="day">The day.</param>
  31778. <param name="hour">The hour.</param>
  31779. <param name="minute">The minute.</param>
  31780. <param name="second">The second.</param>
  31781. <param name="use1904windowing">Should 1900 or 1904 date windowing be used?</param>
  31782. <returns></returns>
  31783. </member>
  31784. <member name="M:NPOI.SS.UserModel.DateUtil.GetExcelDate(System.DateTime,System.Boolean)">
  31785. <summary>
  31786. Given a Date, Converts it into a double representing its internal Excel representation,
  31787. which Is the number of days since 1/1/1900. Fractional days represent hours, minutes, and seconds.
  31788. </summary>
  31789. <param name="date">The date.</param>
  31790. <param name="use1904windowing">Should 1900 or 1904 date windowing be used?</param>
  31791. <returns>Excel representation of Date (-1 if error - test for error by Checking for less than 0.1)</returns>
  31792. </member>
  31793. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaDate(System.Double)">
  31794. <summary>
  31795. Given an Excel date with using 1900 date windowing, and converts it to a java.util.Date.
  31796. Excel Dates and Times are stored without any timezone
  31797. information. If you know (through other means) that your file
  31798. uses a different TimeZone to the system default, you can use
  31799. this version of the getJavaDate() method to handle it.
  31800. </summary>
  31801. <param name="date">The Excel date.</param>
  31802. <returns>null if date is not a valid Excel date</returns>
  31803. </member>
  31804. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaDate(System.Double,System.Boolean)">
  31805. Given an Excel date with either 1900 or 1904 date windowing,
  31806. Converts it to a Date.
  31807. NOTE: If the default <c>TimeZone</c> in Java uses Daylight
  31808. Saving Time then the conversion back to an Excel date may not give
  31809. the same value, that Is the comparison
  31810. <CODE>excelDate == GetExcelDate(GetJavaDate(excelDate,false))</CODE>
  31811. Is not always true. For example if default timezone Is
  31812. <c>Europe/Copenhagen</c>, on 2004-03-28 the minute after
  31813. 01:59 CET Is 03:00 CEST, if the excel date represents a time between
  31814. 02:00 and 03:00 then it Is Converted to past 03:00 summer time
  31815. @param date The Excel date.
  31816. @param use1904windowing true if date uses 1904 windowing,
  31817. or false if using 1900 date windowing.
  31818. @return Java representation of the date, or null if date Is not a valid Excel date
  31819. @see TimeZone
  31820. </member>
  31821. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaDate(System.Double,System.Boolean,System.TimeZoneInfo)">
  31822. Given an Excel date with either 1900 or 1904 date windowing,
  31823. converts it to a java.util.Date.
  31824. Excel Dates and Times are stored without any timezone
  31825. information. If you know (through other means) that your file
  31826. uses a different TimeZone to the system default, you can use
  31827. this version of the getJavaDate() method to handle it.
  31828. @param date The Excel date.
  31829. @param tz The TimeZone to evaluate the date in
  31830. @param use1904windowing true if date uses 1904 windowing,
  31831. or false if using 1900 date windowing.
  31832. @return Java representation of the date, or null if date is not a valid Excel date
  31833. </member>
  31834. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaDate(System.Double,System.Boolean,System.TimeZone)">
  31835. Given an Excel date with either 1900 or 1904 date windowing,
  31836. converts it to a java.util.Date.
  31837. Excel Dates and Times are stored without any timezone
  31838. information. If you know (through other means) that your file
  31839. uses a different TimeZone to the system default, you can use
  31840. this version of the getJavaDate() method to handle it.
  31841. @param date The Excel date.
  31842. @param tz The TimeZone to evaluate the date in
  31843. @param use1904windowing true if date uses 1904 windowing,
  31844. or false if using 1900 date windowing.
  31845. @return Java representation of the date, or null if date is not a valid Excel date
  31846. </member>
  31847. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaDate(System.Double,System.Boolean,System.TimeZoneInfo,System.Boolean)">
  31848. Given an Excel date with either 1900 or 1904 date windowing,
  31849. converts it to a java.util.Date.
  31850. Excel Dates and Times are stored without any timezone
  31851. information. If you know (through other means) that your file
  31852. uses a different TimeZone to the system default, you can use
  31853. this version of the getJavaDate() method to handle it.
  31854. @param date The Excel date.
  31855. @param tz The TimeZone to evaluate the date in
  31856. @param use1904windowing true if date uses 1904 windowing,
  31857. or false if using 1900 date windowing.
  31858. @param roundSeconds round to closest second
  31859. @return Java representation of the date, or null if date is not a valid Excel date
  31860. </member>
  31861. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaDate(System.Double,System.Boolean,System.TimeZone,System.Boolean)">
  31862. Given an Excel date with either 1900 or 1904 date windowing,
  31863. converts it to a java.util.Date.
  31864. Excel Dates and Times are stored without any timezone
  31865. information. If you know (through other means) that your file
  31866. uses a different TimeZone to the system default, you can use
  31867. this version of the getJavaDate() method to handle it.
  31868. @param date The Excel date.
  31869. @param tz The TimeZone to evaluate the date in
  31870. @param use1904windowing true if date uses 1904 windowing,
  31871. or false if using 1900 date windowing.
  31872. @param roundSeconds round to closest second
  31873. @return Java representation of the date, or null if date is not a valid Excel date
  31874. </member>
  31875. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaCalendar(System.Double,System.Boolean)">
  31876. Get EXCEL date as Java Calendar with given time zone.
  31877. @param date The Excel date.
  31878. @param use1904windowing true if date uses 1904 windowing,
  31879. or false if using 1900 date windowing.
  31880. @param timeZone The TimeZone to evaluate the date in
  31881. @return Java representation of the date, or null if date is not a valid Excel date
  31882. </member>
  31883. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaCalendar(System.Double,System.Boolean,System.TimeZoneInfo,System.Boolean)">
  31884. <summary>
  31885. Get EXCEL date as Java Calendar (with default time zone). This is like GetJavaDate(double, boolean) but returns a Calendar object.
  31886. </summary>
  31887. <param name="date">The Excel date.</param>
  31888. <param name="use1904windowing">true if date uses 1904 windowing, or false if using 1900 date windowing.</param>
  31889. <param name="timeZone"></param>
  31890. <param name="roundSeconds"></param>
  31891. <returns>null if date is not a valid Excel date</returns>
  31892. </member>
  31893. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaCalendar(System.Double,System.Boolean,System.TimeZone,System.Boolean)">
  31894. <summary>
  31895. Get EXCEL date as Java Calendar (with default time zone). This is like GetJavaDate(double, boolean) but returns a Calendar object.
  31896. </summary>
  31897. <param name="date">The Excel date.</param>
  31898. <param name="use1904windowing">true if date uses 1904 windowing, or false if using 1900 date windowing.</param>
  31899. <param name="timeZone"></param>
  31900. <param name="roundSeconds"></param>
  31901. <returns>null if date is not a valid Excel date</returns>
  31902. </member>
  31903. <member name="M:NPOI.SS.UserModel.DateUtil.ConvertTime(System.String)">
  31904. <summary>
  31905. Converts a string of format "HH:MM" or "HH:MM:SS" to its (Excel) numeric equivalent
  31906. </summary>
  31907. <param name="timeStr">The time STR.</param>
  31908. <returns> a double between 0 and 1 representing the fraction of the day</returns>
  31909. </member>
  31910. <member name="M:NPOI.SS.UserModel.DateUtil.ConvertTimeInternal(System.String)">
  31911. <summary>
  31912. Converts the time internal.
  31913. </summary>
  31914. <param name="timeStr">The time STR.</param>
  31915. <returns></returns>
  31916. </member>
  31917. <member name="M:NPOI.SS.UserModel.DateUtil.IsADateFormat(System.Int32,System.String)">
  31918. <summary>
  31919. Given a format ID and its format String, will Check to see if the
  31920. format represents a date format or not.
  31921. Firstly, it will Check to see if the format ID corresponds to an
  31922. internal excel date format (eg most US date formats)
  31923. If not, it will Check to see if the format string only Contains
  31924. date formatting Chars (ymd-/), which covers most
  31925. non US date formats.
  31926. </summary>
  31927. <param name="formatIndex">The index of the format, eg from ExtendedFormatRecord.GetFormatIndex</param>
  31928. <param name="formatString">The format string, eg from FormatRecord.GetFormatString</param>
  31929. <returns>
  31930. <c>true</c> if [is A date format] [the specified format index]; otherwise, <c>false</c>.
  31931. </returns>
  31932. </member>
  31933. <member name="M:NPOI.SS.UserModel.DateUtil.ParseYYYYMMDDDate(System.String)">
  31934. <summary>
  31935. Converts a string of format "YYYY/MM/DD" to its (Excel) numeric equivalent
  31936. </summary>
  31937. <param name="dateStr">The date STR.</param>
  31938. <returns>a double representing the (integer) number of days since the start of the Excel epoch</returns>
  31939. </member>
  31940. <member name="M:NPOI.SS.UserModel.DateUtil.ParseYYYYMMDDDateInternal(System.String)">
  31941. <summary>
  31942. Parses the YYYYMMDD date internal.
  31943. </summary>
  31944. <param name="timeStr">The time string.</param>
  31945. <returns></returns>
  31946. </member>
  31947. <member name="M:NPOI.SS.UserModel.DateUtil.ParseInt(System.String,System.String,System.Int32)">
  31948. <summary>
  31949. Parses the int.
  31950. </summary>
  31951. <param name="strVal">The string value.</param>
  31952. <param name="fieldName">Name of the field.</param>
  31953. <param name="rangeMax">The range max.</param>
  31954. <returns></returns>
  31955. </member>
  31956. <member name="M:NPOI.SS.UserModel.DateUtil.ParseInt(System.String,System.String,System.Int32,System.Int32)">
  31957. <summary>
  31958. Parses the int.
  31959. </summary>
  31960. <param name="strVal">The STR val.</param>
  31961. <param name="fieldName">Name of the field.</param>
  31962. <param name="lowerLimit">The lower limit.</param>
  31963. <param name="upperLimit">The upper limit.</param>
  31964. <returns></returns>
  31965. </member>
  31966. <member name="M:NPOI.SS.UserModel.DateUtil.IsInternalDateFormat(System.Int32)">
  31967. <summary>
  31968. Given a format ID this will Check whether the format represents an internal excel date format or not.
  31969. </summary>
  31970. <param name="format">The format.</param>
  31971. </member>
  31972. <member name="M:NPOI.SS.UserModel.DateUtil.IsCellDateFormatted(NPOI.SS.UserModel.ICell)">
  31973. <summary>
  31974. Check if a cell Contains a date
  31975. Since dates are stored internally in Excel as double values
  31976. we infer it Is a date if it Is formatted as such.
  31977. </summary>
  31978. <param name="cell">The cell.</param>
  31979. </member>
  31980. <member name="M:NPOI.SS.UserModel.DateUtil.IsCellInternalDateFormatted(NPOI.SS.UserModel.ICell)">
  31981. <summary>
  31982. Check if a cell contains a date, Checking only for internal excel date formats.
  31983. As Excel stores a great many of its dates in "non-internal" date formats, you will not normally want to use this method.
  31984. </summary>
  31985. <param name="cell">The cell.</param>
  31986. </member>
  31987. <member name="M:NPOI.SS.UserModel.DateUtil.IsValidExcelDate(System.Double)">
  31988. <summary>
  31989. Given a double, Checks if it Is a valid Excel date.
  31990. </summary>
  31991. <param name="value">the double value.</param>
  31992. <returns>
  31993. <c>true</c> if [is valid excel date] [the specified value]; otherwise, <c>false</c>.
  31994. </returns>
  31995. </member>
  31996. <member name="T:NPOI.SS.UserModel.IDrawing">
  31997. @author Yegor Kozlov
  31998. </member>
  31999. <member name="M:NPOI.SS.UserModel.IDrawing.CreatePicture(NPOI.SS.UserModel.IClientAnchor,System.Int32)">
  32000. Creates a picture.
  32001. @param anchor the client anchor describes how this picture is
  32002. attached to the sheet.
  32003. @param pictureIndex the index of the picture in the workbook collection
  32004. of pictures.
  32005. @return the newly created picture.
  32006. </member>
  32007. <member name="M:NPOI.SS.UserModel.IDrawing.CreateCellComment(NPOI.SS.UserModel.IClientAnchor)">
  32008. Creates a comment.
  32009. @param anchor the client anchor describes how this comment is attached
  32010. to the sheet.
  32011. @return the newly created comment.
  32012. </member>
  32013. <member name="M:NPOI.SS.UserModel.IDrawing.CreateChart(NPOI.SS.UserModel.IClientAnchor)">
  32014. Creates a chart.
  32015. @param anchor the client anchor describes how this chart is attached to
  32016. the sheet.
  32017. @return the newly created chart
  32018. </member>
  32019. <member name="M:NPOI.SS.UserModel.IDrawing.CreateAnchor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  32020. Creates a new client anchor and sets the top-left and bottom-right
  32021. coordinates of the anchor.
  32022. @param dx1 the x coordinate in EMU within the first cell.
  32023. @param dy1 the y coordinate in EMU within the first cell.
  32024. @param dx2 the x coordinate in EMU within the second cell.
  32025. @param dy2 the y coordinate in EMU within the second cell.
  32026. @param col1 the column (0 based) of the first cell.
  32027. @param row1 the row (0 based) of the first cell.
  32028. @param col2 the column (0 based) of the second cell.
  32029. @param row2 the row (0 based) of the second cell.
  32030. @return the newly created client anchor
  32031. </member>
  32032. <member name="T:NPOI.SS.UserModel.ExcelGeneralNumberFormat">
  32033. A format that formats a double as Excel would, ignoring FieldPosition.
  32034. All other operations are unsupported.
  32035. </member>
  32036. <member name="T:NPOI.SS.UserModel.ExcelStyleDateFormatter">
  32037. A wrapper around a {@link SimpleDateFormat} instance,
  32038. which handles a few Excel-style extensions that
  32039. are not supported by {@link SimpleDateFormat}.
  32040. Currently, the extensions are around the handling
  32041. of elapsed time, eg rendering 1 day 2 hours
  32042. as 26 hours.
  32043. </member>
  32044. <member name="M:NPOI.SS.UserModel.ExcelStyleDateFormatter.ProcessFormatPattern(System.String)">
  32045. Takes a format String, and Replaces Excel specific bits
  32046. with our detection sequences
  32047. </member>
  32048. <member name="M:NPOI.SS.UserModel.ExcelStyleDateFormatter.SetDateToBeFormatted(System.Double)">
  32049. Used to let us know what the date being
  32050. formatted is, in Excel terms, which we
  32051. may wish to use when handling elapsed
  32052. times.
  32053. </member>
  32054. <member name="T:NPOI.SS.UserModel.ExtendedColor">
  32055. Represents a XSSF-style color (based on either a
  32056. {@link NPOI.XSSF.UserModel.XSSFColor} or a
  32057. {@link NPOI.HSSF.Record.Common.ExtendedColor}
  32058. </member>
  32059. <member name="P:NPOI.SS.UserModel.ExtendedColor.IsAuto">
  32060. A bool value indicating the color is automatic
  32061. </member>
  32062. <member name="P:NPOI.SS.UserModel.ExtendedColor.IsIndexed">
  32063. A bool value indicating the color is indexed
  32064. </member>
  32065. <member name="P:NPOI.SS.UserModel.ExtendedColor.IsRGB">
  32066. A bool value indicating the color is RGB / ARGB
  32067. </member>
  32068. <member name="P:NPOI.SS.UserModel.ExtendedColor.IsThemed">
  32069. A bool value indicating the color is from a Theme
  32070. </member>
  32071. <member name="P:NPOI.SS.UserModel.ExtendedColor.Index">
  32072. Indexed Color value, if {@link #isIndexed()} is true
  32073. </member>
  32074. <member name="P:NPOI.SS.UserModel.ExtendedColor.Theme">
  32075. Index of Theme color, if {@link #isThemed()} is true
  32076. </member>
  32077. <member name="P:NPOI.SS.UserModel.ExtendedColor.RGB">
  32078. Standard Red Green Blue ctColor value (RGB).
  32079. If there was an A (Alpha) value, it will be stripped.
  32080. </member>
  32081. <member name="P:NPOI.SS.UserModel.ExtendedColor.ARGB">
  32082. Standard Alpha Red Green Blue ctColor value (ARGB).
  32083. </member>
  32084. <member name="P:NPOI.SS.UserModel.ExtendedColor.StoredRBG">
  32085. RGB or ARGB or null
  32086. </member>
  32087. <member name="P:NPOI.SS.UserModel.ExtendedColor.RGBWithTint">
  32088. Standard Red Green Blue ctColor value (RGB) with applied tint.
  32089. Alpha values are ignored.
  32090. </member>
  32091. <member name="P:NPOI.SS.UserModel.ExtendedColor.ARGBHex">
  32092. Return the ARGB value in hex format, eg FF00FF00.
  32093. Works for both regular and indexed colours.
  32094. Sets the ARGB value from hex format, eg FF0077FF.
  32095. Only works for regular (non-indexed) colours
  32096. </member>
  32097. <member name="P:NPOI.SS.UserModel.ExtendedColor.Tint">
  32098. Specifies the tint value applied to the ctColor.
  32099. <p>
  32100. If tint is supplied, then it is applied to the RGB value of the ctColor to determine the final
  32101. ctColor applied.
  32102. </p>
  32103. <p>
  32104. The tint value is stored as a double from -1.0 .. 1.0, where -1.0 means 100% darken and
  32105. 1.0 means 100% lighten. Also, 0.0 means no Change.
  32106. </p>
  32107. <p>
  32108. In loading the RGB value, it is Converted to HLS where HLS values are (0..HLSMAX), where
  32109. HLSMAX is currently 255.
  32110. </p>
  32111. Here are some examples of how to apply tint to ctColor:
  32112. <blockquote>
  32113. <pre>
  32114. If (tint &lt; 0)
  32115. Lum' = Lum * (1.0 + tint)
  32116. For example: Lum = 200; tint = -0.5; Darken 50%
  32117. Lum' = 200 * (0.5) =&gt; 100
  32118. For example: Lum = 200; tint = -1.0; Darken 100% (make black)
  32119. Lum' = 200 * (1.0-1.0) =&gt; 0
  32120. If (tint &gt; 0)
  32121. Lum' = Lum * (1.0-tint) + (HLSMAX - HLSMAX * (1.0-tint))
  32122. For example: Lum = 100; tint = 0.75; Lighten 75%
  32123. Lum' = 100 * (1-.75) + (HLSMAX - HLSMAX*(1-.75))
  32124. = 100 * .25 + (255 - 255 * .25)
  32125. = 25 + (255 - 63) = 25 + 192 = 217
  32126. For example: Lum = 100; tint = 1.0; Lighten 100% (make white)
  32127. Lum' = 100 * (1-1) + (HLSMAX - HLSMAX*(1-1))
  32128. = 100 * 0 + (255 - 255 * 0)
  32129. = 0 + (255 - 0) = 255
  32130. </pre>
  32131. </blockquote>
  32132. @return the tint value
  32133. </member>
  32134. <member name="T:NPOI.SS.UserModel.FillPattern">
  32135. The enumeration value indicating the style of fill pattern being used for a cell format.
  32136. </member>
  32137. <member name="F:NPOI.SS.UserModel.FillPattern.NoFill">
  32138. No background
  32139. </member>
  32140. <member name="F:NPOI.SS.UserModel.FillPattern.SolidForeground">
  32141. Solidly Filled
  32142. </member>
  32143. <member name="F:NPOI.SS.UserModel.FillPattern.FineDots">
  32144. Small fine dots
  32145. </member>
  32146. <member name="F:NPOI.SS.UserModel.FillPattern.AltBars">
  32147. Wide dots
  32148. </member>
  32149. <member name="F:NPOI.SS.UserModel.FillPattern.SparseDots">
  32150. Sparse dots
  32151. </member>
  32152. <member name="F:NPOI.SS.UserModel.FillPattern.ThickHorizontalBands">
  32153. Thick horizontal bands
  32154. </member>
  32155. <member name="F:NPOI.SS.UserModel.FillPattern.ThickVerticalBands">
  32156. Thick vertical bands
  32157. </member>
  32158. <member name="F:NPOI.SS.UserModel.FillPattern.ThickBackwardDiagonals">
  32159. Thick backward facing diagonals
  32160. </member>
  32161. <member name="F:NPOI.SS.UserModel.FillPattern.ThickForwardDiagonals">
  32162. Thick forward facing diagonals
  32163. </member>
  32164. <member name="F:NPOI.SS.UserModel.FillPattern.BigSpots">
  32165. Large spots
  32166. </member>
  32167. <member name="F:NPOI.SS.UserModel.FillPattern.Bricks">
  32168. Brick-like layout
  32169. </member>
  32170. <member name="F:NPOI.SS.UserModel.FillPattern.ThinHorizontalBands">
  32171. Thin horizontal bands
  32172. </member>
  32173. <member name="F:NPOI.SS.UserModel.FillPattern.ThinVerticalBands">
  32174. Thin vertical bands
  32175. </member>
  32176. <member name="F:NPOI.SS.UserModel.FillPattern.ThinBackwardDiagonals">
  32177. Thin backward diagonal
  32178. </member>
  32179. <member name="F:NPOI.SS.UserModel.FillPattern.ThinForwardDiagonals">
  32180. Thin forward diagonal
  32181. </member>
  32182. <member name="F:NPOI.SS.UserModel.FillPattern.Squares">
  32183. Squares
  32184. </member>
  32185. <member name="F:NPOI.SS.UserModel.FillPattern.Diamonds">
  32186. Diamonds
  32187. </member>
  32188. <member name="F:NPOI.SS.UserModel.FillPattern.LessDots">
  32189. Less Dots
  32190. </member>
  32191. <member name="F:NPOI.SS.UserModel.FillPattern.LeastDots">
  32192. Least Dots
  32193. </member>
  32194. <member name="F:NPOI.SS.UserModel.FontUnderlineType.None">
  32195. not underlined
  32196. </member>
  32197. <member name="F:NPOI.SS.UserModel.FontUnderlineType.Single">
  32198. single (normal) underline
  32199. </member>
  32200. <member name="F:NPOI.SS.UserModel.FontUnderlineType.Double">
  32201. double underlined
  32202. </member>
  32203. <member name="F:NPOI.SS.UserModel.FontUnderlineType.SingleAccounting">
  32204. accounting style single underline
  32205. </member>
  32206. <member name="F:NPOI.SS.UserModel.FontUnderlineType.DoubleAccounting">
  32207. accounting style double underline
  32208. </member>
  32209. <member name="F:NPOI.SS.UserModel.FontSuperScript.None">
  32210. no type Offsetting (not super or subscript)
  32211. </member>
  32212. <member name="F:NPOI.SS.UserModel.FontSuperScript.Super">
  32213. superscript
  32214. </member>
  32215. <member name="F:NPOI.SS.UserModel.FontSuperScript.Sub">
  32216. subscript
  32217. </member>
  32218. <member name="F:NPOI.SS.UserModel.FontColor.None">
  32219. <summary>
  32220. Allow accessing the Initial value.
  32221. </summary>
  32222. </member>
  32223. <member name="F:NPOI.SS.UserModel.FontColor.Normal">
  32224. normal type of black color.
  32225. </member>
  32226. <member name="F:NPOI.SS.UserModel.FontColor.Red">
  32227. Dark Red color
  32228. </member>
  32229. <member name="F:NPOI.SS.UserModel.FontBoldWeight.None">
  32230. <summary>
  32231. Allow accessing the Initial value.
  32232. </summary>
  32233. </member>
  32234. <member name="F:NPOI.SS.UserModel.FontBoldWeight.Normal">
  32235. Normal boldness (not bold)
  32236. </member>
  32237. <member name="F:NPOI.SS.UserModel.FontBoldWeight.Bold">
  32238. Bold boldness (bold)
  32239. </member>
  32240. <member name="P:NPOI.SS.UserModel.IFont.FontName">
  32241. <summary>
  32242. get the name for the font (i.e. Arial)
  32243. </summary>
  32244. </member>
  32245. <member name="P:NPOI.SS.UserModel.IFont.FontHeight">
  32246. <summary>
  32247. Get the font height in unit's of 1/20th of a point.
  32248. </summary>
  32249. <remarks>
  32250. Maybe you might want to use the GetFontHeightInPoints which matches to the familiar 10, 12, 14 etc..
  32251. </remarks>
  32252. <see cref="P:NPOI.SS.UserModel.IFont.FontHeightInPoints"/>
  32253. </member>
  32254. <member name="P:NPOI.SS.UserModel.IFont.FontHeightInPoints">
  32255. <summary>
  32256. Get the font height in points.
  32257. </summary>
  32258. <remarks>
  32259. This will return the same font height that is shown in Excel, such as 10 or 14 or 28.
  32260. </remarks>
  32261. <see cref="P:NPOI.SS.UserModel.IFont.FontHeight"/>
  32262. </member>
  32263. <member name="P:NPOI.SS.UserModel.IFont.IsItalic">
  32264. <summary>
  32265. get whether to use italics or not
  32266. </summary>
  32267. </member>
  32268. <member name="P:NPOI.SS.UserModel.IFont.IsStrikeout">
  32269. <summary>
  32270. get whether to use a strikeout horizontal line through the text or not
  32271. </summary>
  32272. </member>
  32273. <member name="P:NPOI.SS.UserModel.IFont.Color">
  32274. get the color for the font
  32275. @return color to use
  32276. @see #COLOR_NORMAL
  32277. @see #COLOR_RED
  32278. @see NPOI.HSSF.usermodel.HSSFPalette#GetColor(short)
  32279. </member>
  32280. <member name="P:NPOI.SS.UserModel.IFont.TypeOffset">
  32281. <summary>
  32282. get type of text underlining to use
  32283. </summary>
  32284. </member>
  32285. <member name="P:NPOI.SS.UserModel.IFont.Underline">
  32286. <summary>
  32287. get type of text underlining to use
  32288. </summary>
  32289. </member>
  32290. <member name="P:NPOI.SS.UserModel.IFont.Charset">
  32291. <summary>
  32292. get character-set to use.
  32293. </summary>
  32294. <value>ANSI_CHARSET,DEFAULT_CHARSET,SYMBOL_CHARSET </value>
  32295. </member>
  32296. <member name="P:NPOI.SS.UserModel.IFont.Index">
  32297. <summary>
  32298. get the index within the Workbook (sequence within the collection of Font objects)
  32299. </summary>
  32300. </member>
  32301. <member name="M:NPOI.SS.UserModel.IFont.CloneStyleFrom(NPOI.SS.UserModel.IFont)">
  32302. <summary>
  32303. Copies the style from another font into this one
  32304. </summary>
  32305. </member>
  32306. <member name="T:NPOI.SS.UserModel.FontCharset">
  32307. Charset represents the basic set of characters associated with a font (that it can display), and
  32308. corresponds to the ANSI codepage (8-bit or DBCS) of that character set used by a given language.
  32309. @author Gisella Bronzetti
  32310. </member>
  32311. <member name="P:NPOI.SS.UserModel.FontCharset.Value">
  32312. Returns value of this charset
  32313. @return value of this charset
  32314. </member>
  32315. <member name="T:NPOI.SS.UserModel.FontFamily">
  32316. The font family this font belongs to. A font family is a set of fonts having common stroke width and serif
  32317. characteristics. The font name overrides when there are conflicting values.
  32318. @author Gisella Bronzetti
  32319. </member>
  32320. <member name="P:NPOI.SS.UserModel.FontFamily.Value">
  32321. Returns index of this font family
  32322. @return index of this font family
  32323. </member>
  32324. <member name="T:NPOI.SS.UserModel.IFontFormatting">
  32325. High level representation for Font Formatting component
  32326. of Conditional Formatting Settings
  32327. @author Dmitriy Kumshayev
  32328. @author Yegor Kozlov
  32329. </member>
  32330. <member name="P:NPOI.SS.UserModel.IFontFormatting.EscapementType">
  32331. <summary>
  32332. get or set the type of super or subscript for the font
  32333. </summary>
  32334. </member>
  32335. <member name="P:NPOI.SS.UserModel.IFontFormatting.FontColorIndex">
  32336. <summary>
  32337. get or set font color index
  32338. </summary>
  32339. </member>
  32340. <member name="P:NPOI.SS.UserModel.IFontFormatting.FontColor">
  32341. <summary>
  32342. get or set the colour of the font, or null if no colour applied
  32343. </summary>
  32344. </member>
  32345. <member name="P:NPOI.SS.UserModel.IFontFormatting.FontHeight">
  32346. <summary>
  32347. get or set the height of the font in 1/20th point units
  32348. </summary>
  32349. </member>
  32350. <member name="P:NPOI.SS.UserModel.IFontFormatting.UnderlineType">
  32351. <summary>
  32352. get or set the type of underlining for the font
  32353. </summary>
  32354. </member>
  32355. <member name="P:NPOI.SS.UserModel.IFontFormatting.IsBold">
  32356. Get whether the font weight is Set to bold or not
  32357. @return bold - whether the font is bold or not
  32358. </member>
  32359. <member name="P:NPOI.SS.UserModel.IFontFormatting.IsItalic">
  32360. @return true if font style was Set to <i>italic</i>
  32361. </member>
  32362. <member name="M:NPOI.SS.UserModel.IFontFormatting.SetFontStyle(System.Boolean,System.Boolean)">
  32363. Set font style options.
  32364. @param italic - if true, Set posture style to italic, otherwise to normal
  32365. @param bold if true, Set font weight to bold, otherwise to normal
  32366. </member>
  32367. <member name="M:NPOI.SS.UserModel.IFontFormatting.ResetFontStyle">
  32368. Set font style options to default values (non-italic, non-bold)
  32369. </member>
  32370. <member name="T:NPOI.SS.UserModel.FontScheme">
  32371. Defines the font scheme to which this font belongs.
  32372. When a font defInition is part of a theme defInition, then the font is categorized as either a major or minor font scheme component.
  32373. 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
  32374. theme.
  32375. Usually major fonts are used for styles like headings, and minor fonts are used for body and paragraph text.
  32376. @author Gisella Bronzetti
  32377. </member>
  32378. <member name="T:NPOI.SS.UserModel.FontUnderline">
  32379. the different types of possible underline formatting
  32380. @author Gisella Bronzetti
  32381. </member>
  32382. <member name="F:NPOI.SS.UserModel.FontUnderline.SINGLE">
  32383. Single-line underlining under each character in the cell.
  32384. The underline is drawn through the descenders of
  32385. characters such as g and p..
  32386. </member>
  32387. <member name="F:NPOI.SS.UserModel.FontUnderline.DOUBLE">
  32388. Double-line underlining under each character in the
  32389. cell. underlines are drawn through the descenders of
  32390. characters such as g and p.
  32391. </member>
  32392. <member name="F:NPOI.SS.UserModel.FontUnderline.SINGLE_ACCOUNTING">
  32393. Single-line accounting underlining under each
  32394. character in the cell. The underline is drawn under the
  32395. descenders of characters such as g and p.
  32396. </member>
  32397. <member name="F:NPOI.SS.UserModel.FontUnderline.DOUBLE_ACCOUNTING">
  32398. Double-line accounting underlining under each
  32399. character in the cell. The underlines are drawn under
  32400. the descenders of characters such as g and p.
  32401. </member>
  32402. <member name="F:NPOI.SS.UserModel.FontUnderline.NONE">
  32403. No underline.
  32404. </member>
  32405. <member name="T:NPOI.SS.UserModel.IFooter">
  32406. <summary>
  32407. Common defInition of a HSSF or XSSF page footer.
  32408. For a list of all the different fields that can be
  32409. placed into a footer, such as page number,
  32410. bold, underline etc, see
  32411. </summary>
  32412. </member>
  32413. <member name="T:NPOI.SS.UserModel.FormulaErrorEnum">
  32414. Enumerates error values in SpreadsheetML formula calculations.
  32415. See also OOO's excelfileformat.pdf (2.5.6)
  32416. </member>
  32417. <member name="F:NPOI.SS.UserModel.FormulaError.NULL">
  32418. Intended to indicate when two areas are required to intersect, but do not.
  32419. <p>Example:
  32420. In the case of SUM(B1 C1), the space between B1 and C1 is treated as the binary
  32421. intersection operator, when a comma was intended. end example]
  32422. </p>
  32423. </member>
  32424. <member name="F:NPOI.SS.UserModel.FormulaError.DIV0">
  32425. Intended to indicate when any number, including zero, is divided by zero.
  32426. Note: However, any error code divided by zero results in that error code.
  32427. </member>
  32428. <member name="F:NPOI.SS.UserModel.FormulaError.VALUE">
  32429. Intended to indicate when an incompatible type argument is passed to a function, or
  32430. an incompatible type operand is used with an operator.
  32431. <p>Example:
  32432. In the case of a function argument, text was expected, but a number was provided
  32433. </p>
  32434. </member>
  32435. <member name="F:NPOI.SS.UserModel.FormulaError.REF">
  32436. Intended to indicate when a cell reference is invalid.
  32437. <p>Example:
  32438. If a formula Contains a reference to a cell, and then the row or column Containing that cell is deleted,
  32439. a #REF! error results. If a worksheet does not support 20,001 columns,
  32440. OFFSET(A1,0,20000) will result in a #REF! error.
  32441. </p>
  32442. </member>
  32443. <member name="F:NPOI.SS.UserModel.FormulaError.NUM">
  32444. Intended to indicate when an argument to a function has a compatible type, but has a
  32445. value that is outside the domain over which that function is defined. (This is known as
  32446. a domain error.)
  32447. <p>Example:
  32448. Certain calls to ASIN, ATANH, FACT, and SQRT might result in domain errors.
  32449. </p>
  32450. Intended to indicate that the result of a function cannot be represented in a value of
  32451. the specified type, typically due to extreme magnitude. (This is known as a range
  32452. error.)
  32453. <p>Example: FACT(1000) might result in a range error. </p>
  32454. </member>
  32455. <member name="F:NPOI.SS.UserModel.FormulaError.NA">
  32456. Intended to indicate when a designated value is not available.
  32457. <p>Example:
  32458. Some functions, such as SUMX2MY2, perform a series of operations on corresponding
  32459. elements in two arrays. If those arrays do not have the same number of elements, then
  32460. for some elements in the longer array, there are no corresponding elements in the
  32461. shorter one; that is, one or more values in the shorter array are not available.
  32462. </p>
  32463. This error value can be produced by calling the function NA
  32464. </member>
  32465. <member name="F:NPOI.SS.UserModel.FormulaError.CIRCULAR_REF">
  32466. POI specific code to indicate that there is a circular reference
  32467. in the formula
  32468. </member>
  32469. <member name="F:NPOI.SS.UserModel.FormulaError.FUNCTION_NOT_IMPLEMENTED">
  32470. POI specific code to indicate that the funcition required is
  32471. not implemented in POI
  32472. </member>
  32473. <member name="P:NPOI.SS.UserModel.FormulaError.Code">
  32474. @return numeric code of the error
  32475. </member>
  32476. <member name="P:NPOI.SS.UserModel.FormulaError.LongCode">
  32477. @return long (internal) numeric code of the error
  32478. </member>
  32479. <member name="P:NPOI.SS.UserModel.FormulaError.String">
  32480. @return string representation of the error
  32481. </member>
  32482. <member name="T:NPOI.SS.UserModel.IFormulaEvaluator">
  32483. Evaluates formula cells.<p/>
  32484. For performance reasons, this class keeps a cache of all previously calculated intermediate
  32485. cell values. Be sure to call {@link #ClearAllCachedResultValues()} if any workbook cells are Changed between
  32486. calls to Evaluate~ methods on this class.
  32487. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32488. @author Josh Micich
  32489. </member>
  32490. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.ClearAllCachedResultValues">
  32491. Should be called whenever there are Changes to input cells in the Evaluated workbook.
  32492. Failure to call this method after changing cell values will cause incorrect behaviour
  32493. of the Evaluate~ methods of this class
  32494. </member>
  32495. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.NotifySetFormula(NPOI.SS.UserModel.ICell)">
  32496. Should be called to tell the cell value cache that the specified (value or formula) cell
  32497. has Changed.
  32498. Failure to call this method after changing cell values will cause incorrect behaviour
  32499. of the Evaluate~ methods of this class
  32500. </member>
  32501. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.NotifyDeleteCell(NPOI.SS.UserModel.ICell)">
  32502. Should be called to tell the cell value cache that the specified cell has just become a
  32503. formula cell, or the formula text has Changed
  32504. </member>
  32505. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.NotifyUpdateCell(NPOI.SS.UserModel.ICell)">
  32506. Should be called to tell the cell value cache that the specified (value or formula) cell
  32507. has changed.
  32508. Failure to call this method after changing cell values will cause incorrect behaviour
  32509. of the evaluate~ methods of this class
  32510. </member>
  32511. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.Evaluate(NPOI.SS.UserModel.ICell)">
  32512. If cell Contains a formula, the formula is Evaluated and returned,
  32513. else the CellValue simply copies the appropriate cell value from
  32514. the cell and also its cell type. This method should be preferred over
  32515. EvaluateInCell() when the call should not modify the contents of the
  32516. original cell.
  32517. @param cell
  32518. </member>
  32519. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.EvaluateAll">
  32520. Loops over all cells in all sheets of the associated workbook.
  32521. For cells that contain formulas, their formulas are evaluated,
  32522. and the results are saved. These cells remain as formula cells.
  32523. For cells that do not contain formulas, no changes are made.
  32524. This is a helpful wrapper around looping over all cells, and
  32525. calling evaluateFormulaCell on each one.
  32526. </member>
  32527. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.EvaluateFormulaCell(NPOI.SS.UserModel.ICell)">
  32528. If cell Contains formula, it Evaluates the formula,
  32529. and saves the result of the formula. The cell
  32530. remains as a formula cell.
  32531. Else if cell does not contain formula, this method leaves
  32532. the cell unChanged.
  32533. Note that the type of the formula result is returned,
  32534. so you know what kind of value is also stored with
  32535. the formula.
  32536. <pre>
  32537. int EvaluatedCellType = Evaluator.evaluateFormulaCell(cell);
  32538. </pre>
  32539. Be aware that your cell will hold both the formula,
  32540. and the result. If you want the cell Replaced with
  32541. the result of the formula, use {@link #EvaluateInCell(Cell)}
  32542. @param cell The cell to Evaluate
  32543. @return The type of the formula result, i.e. -1 if the cell is not a formula,
  32544. or one of Cell.CELL_TYPE_NUMERIC, Cell.CELL_TYPE_STRING, Cell.CELL_TYPE_BOOLEAN, Cell.CELL_TYPE_ERROR
  32545. Note: the cell's type remains as Cell.CELL_TYPE_FORMULA however.
  32546. </member>
  32547. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.EvaluateInCell(NPOI.SS.UserModel.ICell)">
  32548. If cell Contains formula, it Evaluates the formula, and
  32549. Puts the formula result back into the cell, in place
  32550. of the old formula.
  32551. Else if cell does not contain formula, this method leaves
  32552. the cell unChanged.
  32553. Note that the same instance of Cell is returned to
  32554. allow chained calls like:
  32555. <pre>
  32556. int EvaluatedCellType = Evaluator.evaluateInCell(cell).getCellType();
  32557. </pre>
  32558. Be aware that your cell value will be Changed to hold the
  32559. result of the formula. If you simply want the formula
  32560. value comPuted for you, use {@link #EvaluateFormulaCell(Cell)}
  32561. @param cell
  32562. </member>
  32563. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.SetupReferencedWorkbooks(System.Collections.Generic.Dictionary{System.String,NPOI.SS.UserModel.IFormulaEvaluator})">
  32564. Sets up the Formula Evaluator to be able to reference and resolve
  32565. links to other workbooks, eg [Test.xls]Sheet1!A1.
  32566. For a workbook referenced as [Test.xls]Sheet1!A1, you should
  32567. supply a map containing the key Test.xls (no square brackets),
  32568. and an open FormulaEvaluator onto that Workbook.
  32569. @param otherWorkbooks Map of workbook names (no square brackets) to an evaluator on that workbook
  32570. </member>
  32571. <member name="P:NPOI.SS.UserModel.IFormulaEvaluator.IgnoreMissingWorkbooks">
  32572. Whether to ignore missing references to external workbooks and
  32573. use cached formula results in the main workbook instead.
  32574. <br/>
  32575. In some cases external workbooks referenced by formulas in the main workbook are not available.
  32576. With this method you can control how POI handles such missing references:
  32577. <ul>
  32578. <li>by default ignoreMissingWorkbooks=false and POI throws
  32579. {@link org.apache.poi.ss.formula.CollaboratingWorkbooksEnvironment.WorkbookNotFoundException}
  32580. if an external reference cannot be resolved</li>
  32581. <li>if ignoreMissingWorkbooks=true then POI uses cached formula result
  32582. that already exists in the main workbook</li>
  32583. </ul>
  32584. @param ignore whether to ignore missing references to external workbooks
  32585. </member>
  32586. <member name="P:NPOI.SS.UserModel.IFormulaEvaluator.DebugEvaluationOutputForNextEval">
  32587. * Perform detailed output of formula evaluation for next evaluation only?
  32588. * Is for developer use only (also developers using POI for their XLS files).
  32589. * Log-Level WARN is for basic info, INFO for detailed information. These quite
  32590. * high levels are used because you have to explicitly enable this specific logging.
  32591. * @param value whether to perform detailed output
  32592. </member>
  32593. <member name="T:NPOI.SS.UserModel.FractionFormat">
  32594. <p>Format class that handles Excel style fractions, such as "# #/#" and "#/###"</p>
  32595. <p>As of this writing, this is still not 100% accurate, but it does a reasonable job
  32596. of trying to mimic Excel's fraction calculations. It does not currently
  32597. maintain Excel's spacing.</p>
  32598. <p>This class relies on a method lifted nearly verbatim from org.apache.math.fraction.
  32599. If further uses for Commons Math are found, we will consider Adding it as a dependency.
  32600. For now, we have in-lined the one method to keep things simple.</p>
  32601. </member>
  32602. <member name="M:NPOI.SS.UserModel.FractionFormat.#ctor(System.String,System.String)">
  32603. Single parameter ctor
  32604. @param denomFormatString The format string for the denominator
  32605. </member>
  32606. <member name="T:NPOI.SS.UserModel.IHeader">
  32607. <summary>
  32608. Common defInition of a HSSF or XSSF page header.
  32609. For a list of all the different fields that can be
  32610. placed into a header, such as page number,
  32611. bold, underline etc, see
  32612. </summary>
  32613. </member>
  32614. <member name="T:NPOI.SS.UserModel.IHeaderFooter">
  32615. <summary>
  32616. Common interface for NPOI.SS.UserModel.Header and NPOI.SS.UserModel.Footer
  32617. </summary>
  32618. </member>
  32619. <member name="P:NPOI.SS.UserModel.IHeaderFooter.Left">
  32620. <summary>
  32621. Gets or sets the left side of the header or footer.
  32622. </summary>
  32623. <value>The string representing the left side.</value>
  32624. </member>
  32625. <member name="P:NPOI.SS.UserModel.IHeaderFooter.Center">
  32626. <summary>
  32627. Gets or sets the center of the header or footer.
  32628. </summary>
  32629. <value>The string representing the center.</value>
  32630. </member>
  32631. <member name="P:NPOI.SS.UserModel.IHeaderFooter.Right">
  32632. <summary>
  32633. Gets or sets the right side of the header or footer.
  32634. </summary>
  32635. <value>The string representing the right side.</value>
  32636. </member>
  32637. <member name="T:NPOI.SS.UserModel.Helpers.RowShifter">
  32638. Helper for Shifting rows up or down
  32639. This abstract class exists to consolidate duplicated code between XSSFRowShifter and HSSFRowShifter (currently methods sprinkled throughout HSSFSheet)
  32640. </member>
  32641. <member name="M:NPOI.SS.UserModel.Helpers.RowShifter.ShiftMergedRegions(System.Int32,System.Int32,System.Int32)">
  32642. Shifts, grows, or shrinks the merged regions due to a row Shift.
  32643. Merged regions that are completely overlaid by Shifting will be deleted.
  32644. @param startRow the row to start Shifting
  32645. @param endRow the row to end Shifting
  32646. @param n the number of rows to shift
  32647. @return an array of affected merged regions, doesn't contain deleted ones
  32648. </member>
  32649. <member name="M:NPOI.SS.UserModel.Helpers.RowShifter.UpdateNamedRanges(NPOI.SS.Formula.FormulaShifter)">
  32650. Updated named ranges
  32651. </member>
  32652. <member name="M:NPOI.SS.UserModel.Helpers.RowShifter.UpdateFormulas(NPOI.SS.Formula.FormulaShifter)">
  32653. Update formulas.
  32654. </member>
  32655. <member name="M:NPOI.SS.UserModel.Helpers.RowShifter.UpdateRowFormulas(NPOI.SS.UserModel.IRow,NPOI.SS.Formula.FormulaShifter)">
  32656. Update the formulas in specified row using the formula Shifting policy specified by Shifter
  32657. @param row the row to update the formulas on
  32658. @param Shifter the formula Shifting policy
  32659. </member>
  32660. <member name="M:NPOI.SS.UserModel.Helpers.RowShifter.UpdateHyperlinks(NPOI.SS.Formula.FormulaShifter)">
  32661. Shift the Hyperlink anchors (not the hyperlink text, even if the hyperlink
  32662. is of type LINK_DOCUMENT and refers to a cell that was Shifted). Hyperlinks
  32663. do not track the content they point to.
  32664. @param Shifter the formula Shifting policy
  32665. </member>
  32666. <member name="T:NPOI.SS.UserModel.HorizontalAlignment">
  32667. The enumeration value indicating horizontal alignment of a cell,
  32668. i.e., whether it is aligned general, left, right, horizontally centered, Filled (replicated),
  32669. justified, centered across multiple cells, or distributed.
  32670. </member>
  32671. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.General">
  32672. The horizontal alignment is general-aligned. Text data is left-aligned.
  32673. Numbers, dates, and times are rightaligned. Boolean types are centered.
  32674. Changing the alignment does not change the type of data.
  32675. </member>
  32676. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Left">
  32677. The horizontal alignment is left-aligned, even in Rightto-Left mode.
  32678. Aligns contents at the left edge of the cell. If an indent amount is specified, the contents of
  32679. the cell is indented from the left by the specified number of character spaces. The character spaces are
  32680. based on the default font and font size for the workbook.
  32681. </member>
  32682. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Center">
  32683. The horizontal alignment is centered, meaning the text is centered across the cell.
  32684. </member>
  32685. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Right">
  32686. The horizontal alignment is right-aligned, meaning that cell contents are aligned at the right edge of the cell,
  32687. even in Right-to-Left mode.
  32688. </member>
  32689. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Justify">
  32690. The horizontal alignment is justified (flush left and right).
  32691. For each line of text, aligns each line of the wrapped text in a cell to the right and left
  32692. (except the last line). If no single line of text wraps in the cell, then the text is not justified.
  32693. </member>
  32694. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Fill">
  32695. Indicates that the value of the cell should be Filled
  32696. across the entire width of the cell. If blank cells to the right also have the fill alignment,
  32697. they are also Filled with the value, using a convention similar to centerContinuous.
  32698. <p>
  32699. Additional rules:
  32700. <ol>
  32701. <li>Only whole values can be Appended, not partial values.</li>
  32702. <li>The column will not be widened to 'best fit' the Filled value</li>
  32703. <li>If Appending an Additional occurrence of the value exceeds the boundary of the cell
  32704. left/right edge, don't append the Additional occurrence of the value.</li>
  32705. <li>The display value of the cell is Filled, not the underlying raw number.</li>
  32706. </ol>
  32707. </p>
  32708. </member>
  32709. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.CenterSelection">
  32710. The horizontal alignment is centered across multiple cells.
  32711. The information about how many cells to span is expressed in the Sheet Part,
  32712. in the row of the cell in question. For each cell that is spanned in the alignment,
  32713. a cell element needs to be written out, with the same style Id which references the centerContinuous alignment.
  32714. </member>
  32715. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Distributed">
  32716. Indicates that each 'word' in each line of text inside the cell is evenly distributed
  32717. across the width of the cell, with flush right and left margins.
  32718. <p>
  32719. When there is also an indent value to apply, both the left and right side of the cell
  32720. are pAdded by the indent value.
  32721. </p>
  32722. <p> A 'word' is a set of characters with no space character in them. </p>
  32723. <p> Two lines inside a cell are Separated by a carriage return. </p>
  32724. </member>
  32725. <member name="F:NPOI.SS.UserModel.HyperlinkType.Url">
  32726. <summary>
  32727. Link to an existing file or web page
  32728. </summary>
  32729. </member>
  32730. <member name="F:NPOI.SS.UserModel.HyperlinkType.Document">
  32731. <summary>
  32732. Link to a place in this document
  32733. </summary>
  32734. </member>
  32735. <member name="F:NPOI.SS.UserModel.HyperlinkType.Email">
  32736. <summary>
  32737. Link to an E-mail Address
  32738. </summary>
  32739. </member>
  32740. <member name="F:NPOI.SS.UserModel.HyperlinkType.File">
  32741. <summary>
  32742. Link to a file
  32743. </summary>
  32744. </member>
  32745. <member name="T:NPOI.SS.UserModel.IHyperlink">
  32746. <summary>
  32747. Represents an Excel hyperlink.
  32748. </summary>
  32749. </member>
  32750. <member name="P:NPOI.SS.UserModel.IHyperlink.Address">
  32751. <summary>
  32752. Hyperlink address. Depending on the hyperlink type it can be URL, e-mail, patrh to a file, etc.
  32753. </summary>
  32754. </member>
  32755. <member name="P:NPOI.SS.UserModel.IHyperlink.Label">
  32756. <summary>
  32757. text label for this hyperlink
  32758. </summary>
  32759. </member>
  32760. <member name="P:NPOI.SS.UserModel.IHyperlink.Type">
  32761. <summary>
  32762. the type of this hyperlink
  32763. </summary>
  32764. </member>
  32765. <member name="P:NPOI.SS.UserModel.IHyperlink.FirstRow">
  32766. <summary>
  32767. the row of the first cell that Contains the hyperlink
  32768. </summary>
  32769. </member>
  32770. <member name="P:NPOI.SS.UserModel.IHyperlink.LastRow">
  32771. <summary>
  32772. the row of the last cell that Contains the hyperlink
  32773. </summary>
  32774. </member>
  32775. <member name="P:NPOI.SS.UserModel.IHyperlink.FirstColumn">
  32776. <summary>
  32777. the column of the first cell that Contains the hyperlink
  32778. </summary>
  32779. </member>
  32780. <member name="P:NPOI.SS.UserModel.IHyperlink.LastColumn">
  32781. <summary>
  32782. the column of the last cell that Contains the hyperlink
  32783. </summary>
  32784. </member>
  32785. <member name="P:NPOI.SS.UserModel.IIconMultiStateFormatting.IconSet">
  32786. <summary>
  32787. Get or set the Icon Set used
  32788. </summary>
  32789. </member>
  32790. <member name="P:NPOI.SS.UserModel.IIconMultiStateFormatting.IsIconOnly">
  32791. Changes the Icon Set used
  32792. <p>If the new Icon Set has a different number of
  32793. icons to the old one, you <em>must</em> update the
  32794. thresholds before saving!</p>
  32795. Should Icon + Value be displayed, or only the Icon?
  32796. </member>
  32797. <member name="P:NPOI.SS.UserModel.IIconMultiStateFormatting.Thresholds">
  32798. Gets the list of thresholds
  32799. Sets the of thresholds. The number must match
  32800. {@link IconSet#num} for the current {@link #getIconSet()}
  32801. </member>
  32802. <member name="M:NPOI.SS.UserModel.IIconMultiStateFormatting.CreateThreshold">
  32803. Creates a new, empty Threshold
  32804. </member>
  32805. <member name="F:NPOI.SS.UserModel.IconSet.GYR_3_ARROW">
  32806. Green Up / Yellow Side / Red Down arrows
  32807. </member>
  32808. <member name="F:NPOI.SS.UserModel.IconSet.GREY_3_ARROWS">
  32809. Grey Up / Side / Down arrows
  32810. </member>
  32811. <member name="F:NPOI.SS.UserModel.IconSet.GYR_3_FLAGS">
  32812. Green / Yellow / Red flags
  32813. </member>
  32814. <member name="F:NPOI.SS.UserModel.IconSet.GYR_3_TRAFFIC_LIGHTS">
  32815. Green / Yellow / Red traffic lights (no background). Default
  32816. </member>
  32817. <member name="F:NPOI.SS.UserModel.IconSet.GYR_3_TRAFFIC_LIGHTS_BOX">
  32818. Green / Yellow / Red traffic lights on a black square background.
  32819. Note, MS-XLS docs v20141018 say this is id=5 but seems to be id=4
  32820. </member>
  32821. <member name="F:NPOI.SS.UserModel.IconSet.GYR_3_SHAPES">
  32822. Green Circle / Yellow Triangle / Red Diamond.
  32823. Note, MS-XLS docs v20141018 say this is id=4 but seems to be id=5
  32824. </member>
  32825. <member name="F:NPOI.SS.UserModel.IconSet.GYR_3_SYMBOLS_CIRCLE">
  32826. Green Tick / Yellow ! / Red Cross on a circle background
  32827. </member>
  32828. <member name="F:NPOI.SS.UserModel.IconSet.GYR_3_SYMBOLS">
  32829. Green Tick / Yellow ! / Red Cross (no background)
  32830. </member>
  32831. <member name="F:NPOI.SS.UserModel.IconSet.GYR_4_ARROWS">
  32832. Green Up / Yellow NE / Yellow SE / Red Down arrows
  32833. </member>
  32834. <member name="F:NPOI.SS.UserModel.IconSet.GREY_4_ARROWS">
  32835. Grey Up / NE / SE / Down arrows
  32836. </member>
  32837. <member name="F:NPOI.SS.UserModel.IconSet.RB_4_TRAFFIC_LIGHTS">
  32838. Red / Light Red / Grey / Black traffic lights
  32839. </member>
  32840. <member name="F:NPOI.SS.UserModel.IconSet.GYRB_4_TRAFFIC_LIGHTS">
  32841. Green / Yellow / Red / Black traffic lights
  32842. </member>
  32843. <member name="F:NPOI.SS.UserModel.IconSet.id">
  32844. Numeric ID of the icon set
  32845. </member>
  32846. <member name="F:NPOI.SS.UserModel.IconSet.num">
  32847. How many icons in the set
  32848. </member>
  32849. <member name="F:NPOI.SS.UserModel.IconSet.name">
  32850. Name (system) of the set
  32851. </member>
  32852. <member name="T:NPOI.SS.UserModel.IgnoredErrorType">
  32853. Types of ignored workbook and worksheet error.
  32854. TODO Implement these for HSSF too, using FeatFormulaErr2,
  32855. see bugzilla bug #46136 for details
  32856. </member>
  32857. <member name="F:NPOI.SS.UserModel.IgnoredErrorType.CalculatedColumn">
  32858. ????. Probably XSSF-only.
  32859. </member>
  32860. <member name="F:NPOI.SS.UserModel.IgnoredErrorType.EmptyCellReference">
  32861. Whether to check for references to empty cells.
  32862. HSSF + XSSF.
  32863. </member>
  32864. <member name="F:NPOI.SS.UserModel.IgnoredErrorType.EvaluationError">
  32865. Whether to check for calculation/Evaluation errors.
  32866. HSSF + XSSF.
  32867. </member>
  32868. <member name="F:NPOI.SS.UserModel.IgnoredErrorType.Formula">
  32869. Whether to check formulas in the range of the shared feature
  32870. that are inconsistent with formulas in neighbouring cells.
  32871. HSSF + XSSF.
  32872. </member>
  32873. <member name="F:NPOI.SS.UserModel.IgnoredErrorType.FormulaRange">
  32874. Whether to check formulas in the range of the shared feature
  32875. with references to less than the entirety of a range Containing
  32876. continuous data.
  32877. HSSF + XSSF.
  32878. </member>
  32879. <member name="F:NPOI.SS.UserModel.IgnoredErrorType.ListDataValidation">
  32880. ????. Is this XSSF-specific the same as performDataValidation
  32881. in HSSF?
  32882. </member>
  32883. <member name="F:NPOI.SS.UserModel.IgnoredErrorType.NumberStoredAsText">
  32884. Whether to check the format of string values and warn
  32885. if they look to actually be numeric values.
  32886. HSSF + XSSF.
  32887. </member>
  32888. <member name="F:NPOI.SS.UserModel.IgnoredErrorType.TwoDigitTextYear">
  32889. ????. Is this XSSF-specific the same as CheckDateTimeFormats
  32890. in HSSF?
  32891. </member>
  32892. <member name="F:NPOI.SS.UserModel.IgnoredErrorType.UnlockedFormula">
  32893. Whether to check for unprotected formulas.
  32894. HSSF + XSSF.
  32895. </member>
  32896. <member name="T:NPOI.SS.UserModel.IndexedColors">
  32897. A deprecated indexing scheme for colours that is still required for some records, and for backwards
  32898. compatibility with OLE2 formats.
  32899. <p>
  32900. Each element corresponds to a color index (zero-based). When using the default indexed color palette,
  32901. the values are not written out, but instead are implied. When the color palette has been modified from default,
  32902. then the entire color palette is used.
  32903. </p>
  32904. @author Yegor Kozlov
  32905. </member>
  32906. <member name="M:NPOI.SS.UserModel.IndexedColors.FromInt(System.Int32)">
  32907. @param index the index of the color
  32908. @return the corresponding IndexedColors enum
  32909. @throws IllegalArgumentException if index is not a valid IndexedColors
  32910. @since 3.15-beta2
  32911. </member>
  32912. <member name="P:NPOI.SS.UserModel.IndexedColors.Index">
  32913. Returns index of this color
  32914. @return index of this color
  32915. </member>
  32916. <member name="T:NPOI.SS.UserModel.IName">
  32917. Represents a defined name for a range of cells.
  32918. A name is a meaningful shorthand that makes it easier to understand the purpose of a
  32919. cell reference, constant or a formula.
  32920. </member>
  32921. <member name="P:NPOI.SS.UserModel.IName.SheetName">
  32922. Get the sheets name which this named range is referenced to
  32923. @return sheet name, which this named range refered to
  32924. </member>
  32925. <member name="P:NPOI.SS.UserModel.IName.NameName">
  32926. Gets the name of the named range
  32927. @return named range name
  32928. </member>
  32929. <member name="P:NPOI.SS.UserModel.IName.RefersToFormula">
  32930. Returns the formula that the name is defined to refer to.
  32931. @return the reference for this name, <code>null</code> if it has not been set yet. Never empty string
  32932. @see #SetRefersToFormula(String)
  32933. </member>
  32934. <member name="P:NPOI.SS.UserModel.IName.IsFunctionName">
  32935. Checks if this name is a function name
  32936. @return true if this name is a function name
  32937. </member>
  32938. <member name="P:NPOI.SS.UserModel.IName.IsDeleted">
  32939. Checks if this name points to a cell that no longer exists
  32940. @return <c>true</c> if the name refers to a deleted cell, <c>false</c> otherwise
  32941. </member>
  32942. <member name="P:NPOI.SS.UserModel.IName.SheetIndex">
  32943. Returns the sheet index this name applies to.
  32944. @return the sheet index this name applies to, -1 if this name applies to the entire workbook
  32945. </member>
  32946. <member name="P:NPOI.SS.UserModel.IName.Comment">
  32947. Returns the comment the user provided when the name was Created.
  32948. @return the user comment for this named range
  32949. </member>
  32950. <member name="M:NPOI.SS.UserModel.IName.SetFunction(System.Boolean)">
  32951. Indicates that the defined name refers to a user-defined function.
  32952. This attribute is used when there is an add-in or other code project associated with the file.
  32953. @param value <c>true</c> indicates the name refers to a function.
  32954. </member>
  32955. <member name="T:NPOI.SS.UserModel.PageOrder">
  32956. Specifies printed page order.
  32957. @author Gisella Bronzetti
  32958. </member>
  32959. <member name="F:NPOI.SS.UserModel.PageOrder.DOWN_THEN_OVER">
  32960. Order pages vertically first, then move horizontally.
  32961. </member>
  32962. <member name="F:NPOI.SS.UserModel.PageOrder.OVER_THEN_DOWN">
  32963. Order pages horizontally first, then move vertically
  32964. </member>
  32965. <member name="T:NPOI.SS.UserModel.PaperSize">
  32966. The enumeration value indicating the possible paper size for a sheet
  32967. @author Daniele Montagni
  32968. </member>
  32969. <member name="F:NPOI.SS.UserModel.PaperSize.PRINTER_DEFAULT_PAPERSIZE">
  32970. <summary>
  32971. Allow accessing the Initial value.
  32972. </summary>
  32973. </member>
  32974. <member name="F:NPOI.SS.UserModel.PaperSize.A4_TRANSVERSE_PAPERSIZE">
  32975. <summary>
  32976. A4 Transverse - 210x297 mm
  32977. </summary>
  32978. </member>
  32979. <member name="F:NPOI.SS.UserModel.PaperSize.A4_PLUS_PAPERSIZE">
  32980. <summary>
  32981. A4 Plus - 210x330 mm
  32982. </summary>
  32983. </member>
  32984. <member name="F:NPOI.SS.UserModel.PaperSize.LETTER_ROTATED_PAPERSIZE">
  32985. <summary>
  32986. US Letter Rotated 11 x 8 1/2 in
  32987. </summary>
  32988. </member>
  32989. <member name="F:NPOI.SS.UserModel.PaperSize.A4_ROTATED_PAPERSIZE">
  32990. <summary>
  32991. A4 Rotated - 297x210 mm */
  32992. </summary>
  32993. </member>
  32994. <member name="T:NPOI.SS.UserModel.IPatternFormatting">
  32995. @author Yegor Kozlov
  32996. </member>
  32997. <member name="F:NPOI.SS.UserModel.PictureType.Unknown">
  32998. <summary>
  32999. Allow accessing the Initial value.
  33000. </summary>
  33001. </member>
  33002. <member name="F:NPOI.SS.UserModel.PictureType.EMF">
  33003. Extended windows meta file
  33004. </member>
  33005. <member name="F:NPOI.SS.UserModel.PictureType.WMF">
  33006. Windows Meta File
  33007. </member>
  33008. <member name="F:NPOI.SS.UserModel.PictureType.PICT">
  33009. Mac PICT format
  33010. </member>
  33011. <member name="F:NPOI.SS.UserModel.PictureType.JPEG">
  33012. JPEG format
  33013. </member>
  33014. <member name="F:NPOI.SS.UserModel.PictureType.PNG">
  33015. PNG format
  33016. </member>
  33017. <member name="F:NPOI.SS.UserModel.PictureType.DIB">
  33018. Device independent bitmap
  33019. </member>
  33020. <member name="F:NPOI.SS.UserModel.PictureType.GIF">
  33021. GIF image format
  33022. </member>
  33023. <member name="F:NPOI.SS.UserModel.PictureType.TIFF">
  33024. Tag Image File (.tiff)
  33025. </member>
  33026. <member name="F:NPOI.SS.UserModel.PictureType.EPS">
  33027. Encapsulated Postscript (.eps)
  33028. </member>
  33029. <member name="F:NPOI.SS.UserModel.PictureType.BMP">
  33030. Windows Bitmap (.bmp)
  33031. </member>
  33032. <member name="F:NPOI.SS.UserModel.PictureType.WPG">
  33033. WordPerfect graphics (.wpg)
  33034. </member>
  33035. <member name="T:NPOI.SS.UserModel.IPicture">
  33036. Repersents a picture in a SpreadsheetML document
  33037. @author Yegor Kozlov
  33038. </member>
  33039. <member name="P:NPOI.SS.UserModel.IPicture.PictureData">
  33040. Return picture data for this picture
  33041. @return picture data for this picture
  33042. </member>
  33043. <member name="P:NPOI.SS.UserModel.IPicture.ClientAnchor">
  33044. @return the anchor that is used by this picture
  33045. </member>
  33046. <member name="P:NPOI.SS.UserModel.IPictureData.Data">
  33047. Gets the picture data.
  33048. @return the picture data.
  33049. </member>
  33050. <member name="M:NPOI.SS.UserModel.IPictureData.SuggestFileExtension">
  33051. Suggests a file extension for this image.
  33052. @return the file extension.
  33053. </member>
  33054. <member name="P:NPOI.SS.UserModel.IPictureData.MimeType">
  33055. Returns the mime type for the image
  33056. </member>
  33057. <member name="P:NPOI.SS.UserModel.IPictureData.PictureType">
  33058. @return the POI internal image type, 0 if unknown image type
  33059. @see Workbook#PICTURE_TYPE_DIB
  33060. @see Workbook#PICTURE_TYPE_EMF
  33061. @see Workbook#PICTURE_TYPE_JPEG
  33062. @see Workbook#PICTURE_TYPE_PICT
  33063. @see Workbook#PICTURE_TYPE_PNG
  33064. @see Workbook#PICTURE_TYPE_WMF
  33065. </member>
  33066. <member name="T:NPOI.SS.UserModel.PrintCellComments">
  33067. These enumerations specify how cell comments shall be displayed for paper printing purposes.
  33068. @author Gisella Bronzetti
  33069. </member>
  33070. <member name="F:NPOI.SS.UserModel.PrintCellComments.NONE">
  33071. Do not print cell comments.
  33072. </member>
  33073. <member name="F:NPOI.SS.UserModel.PrintCellComments.AS_DISPLAYED">
  33074. Print cell comments as displayed.
  33075. </member>
  33076. <member name="F:NPOI.SS.UserModel.PrintCellComments.AT_END">
  33077. Print cell comments at end of document.
  33078. </member>
  33079. <member name="T:NPOI.SS.UserModel.PrintOrientation">
  33080. The enumeration value indicating the print orientation for a sheet.
  33081. @author Gisella Bronzetti
  33082. </member>
  33083. <member name="F:NPOI.SS.UserModel.PrintOrientation.DEFAULT">
  33084. orientation not specified
  33085. </member>
  33086. <member name="F:NPOI.SS.UserModel.PrintOrientation.PORTRAIT">
  33087. portrait orientation
  33088. </member>
  33089. <member name="F:NPOI.SS.UserModel.PrintOrientation.LANDSCAPE">
  33090. landscape orientations
  33091. </member>
  33092. <member name="T:NPOI.SS.UserModel.DisplayCellErrorType">
  33093. <summary>
  33094. Used by HSSFPrintSetup.CellError property
  33095. </summary>
  33096. </member>
  33097. <member name="P:NPOI.SS.UserModel.IPrintSetup.PaperSize">
  33098. Returns the paper size.
  33099. @return paper size
  33100. </member>
  33101. <member name="P:NPOI.SS.UserModel.IPrintSetup.Scale">
  33102. Returns the scale.
  33103. @return scale
  33104. </member>
  33105. <member name="P:NPOI.SS.UserModel.IPrintSetup.PageStart">
  33106. Returns the page start.
  33107. @return page start
  33108. </member>
  33109. <member name="P:NPOI.SS.UserModel.IPrintSetup.FitWidth">
  33110. Returns the number of pages wide to fit sheet in.
  33111. @return number of pages wide to fit sheet in
  33112. </member>
  33113. <member name="P:NPOI.SS.UserModel.IPrintSetup.FitHeight">
  33114. Returns the number of pages high to fit the sheet in.
  33115. @return number of pages high to fit the sheet in
  33116. </member>
  33117. <member name="P:NPOI.SS.UserModel.IPrintSetup.LeftToRight">
  33118. Returns the left to right print order.
  33119. @return left to right print order
  33120. </member>
  33121. <member name="P:NPOI.SS.UserModel.IPrintSetup.Landscape">
  33122. Returns the landscape mode.
  33123. @return landscape mode
  33124. </member>
  33125. <member name="P:NPOI.SS.UserModel.IPrintSetup.ValidSettings">
  33126. Returns the valid Settings.
  33127. @return valid Settings
  33128. </member>
  33129. <member name="P:NPOI.SS.UserModel.IPrintSetup.NoColor">
  33130. Returns the black and white Setting.
  33131. @return black and white Setting
  33132. </member>
  33133. <member name="P:NPOI.SS.UserModel.IPrintSetup.Draft">
  33134. Returns the draft mode.
  33135. @return draft mode
  33136. </member>
  33137. <member name="P:NPOI.SS.UserModel.IPrintSetup.Notes">
  33138. Returns the print notes.
  33139. @return print notes
  33140. </member>
  33141. <member name="P:NPOI.SS.UserModel.IPrintSetup.NoOrientation">
  33142. Returns the no orientation.
  33143. @return no orientation
  33144. </member>
  33145. <member name="P:NPOI.SS.UserModel.IPrintSetup.UsePage">
  33146. Returns the use page numbers.
  33147. @return use page numbers
  33148. </member>
  33149. <member name="P:NPOI.SS.UserModel.IPrintSetup.HResolution">
  33150. Returns the horizontal resolution.
  33151. @return horizontal resolution
  33152. </member>
  33153. <member name="P:NPOI.SS.UserModel.IPrintSetup.VResolution">
  33154. Returns the vertical resolution.
  33155. @return vertical resolution
  33156. </member>
  33157. <member name="P:NPOI.SS.UserModel.IPrintSetup.HeaderMargin">
  33158. Returns the header margin.
  33159. @return header margin
  33160. </member>
  33161. <member name="P:NPOI.SS.UserModel.IPrintSetup.FooterMargin">
  33162. Returns the footer margin.
  33163. @return footer margin
  33164. </member>
  33165. <member name="P:NPOI.SS.UserModel.IPrintSetup.Copies">
  33166. Returns the number of copies.
  33167. @return number of copies
  33168. </member>
  33169. <member name="T:NPOI.SS.UserModel.IRichTextString">
  33170. Rich text unicode string. These strings can have fonts
  33171. applied to arbitary parts of the string.
  33172. @author Glen Stampoultzis (glens at apache.org)
  33173. @author Jason Height (jheight at apache.org)
  33174. </member>
  33175. <member name="M:NPOI.SS.UserModel.IRichTextString.ApplyFont(System.Int32,System.Int32,System.Int16)">
  33176. Applies a font to the specified characters of a string.
  33177. @param startIndex The start index to apply the font to (inclusive)
  33178. @param endIndex The end index to apply the font to (exclusive)
  33179. @param fontIndex The font to use.
  33180. </member>
  33181. <member name="M:NPOI.SS.UserModel.IRichTextString.ApplyFont(System.Int32,System.Int32,NPOI.SS.UserModel.IFont)">
  33182. Applies a font to the specified characters of a string.
  33183. @param startIndex The start index to apply the font to (inclusive)
  33184. @param endIndex The end index to apply to font to (exclusive)
  33185. @param font The index of the font to use.
  33186. </member>
  33187. <member name="M:NPOI.SS.UserModel.IRichTextString.ApplyFont(NPOI.SS.UserModel.IFont)">
  33188. Sets the font of the entire string.
  33189. @param font The font to use.
  33190. </member>
  33191. <member name="M:NPOI.SS.UserModel.IRichTextString.ClearFormatting">
  33192. Removes any formatting that may have been applied to the string.
  33193. </member>
  33194. <member name="P:NPOI.SS.UserModel.IRichTextString.String">
  33195. Returns the plain string representation.
  33196. </member>
  33197. <member name="P:NPOI.SS.UserModel.IRichTextString.Length">
  33198. @return the number of characters in the font.
  33199. </member>
  33200. <member name="P:NPOI.SS.UserModel.IRichTextString.NumFormattingRuns">
  33201. @return The number of formatting Runs used.
  33202. </member>
  33203. <member name="M:NPOI.SS.UserModel.IRichTextString.GetIndexOfFormattingRun(System.Int32)">
  33204. The index within the string to which the specified formatting run applies.
  33205. @param index the index of the formatting run
  33206. @return the index within the string.
  33207. </member>
  33208. <member name="M:NPOI.SS.UserModel.IRichTextString.ApplyFont(System.Int16)">
  33209. Applies the specified font to the entire string.
  33210. @param fontIndex the font to apply.
  33211. </member>
  33212. <member name="T:NPOI.SS.UserModel.MissingCellPolicy">
  33213. Used to specify the different possible policies
  33214. if for the case of null and blank cells
  33215. </member>
  33216. <member name="T:NPOI.SS.UserModel.IRow">
  33217. <summary>
  33218. High level representation of a row of a spreadsheet.
  33219. </summary>
  33220. </member>
  33221. <member name="M:NPOI.SS.UserModel.IRow.CreateCell(System.Int32)">
  33222. <summary>
  33223. Use this to create new cells within the row and return it.
  33224. The cell that is returned is a <see cref="T:NPOI.SS.UserModel.ICell"/>/<see cref="F:NPOI.SS.UserModel.CellType.Blank"/>.
  33225. The type can be changed either through calling <c>SetCellValue</c> or <c>SetCellType</c>.
  33226. </summary>
  33227. <param name="column">the column number this cell represents</param>
  33228. <returns>Cell a high level representation of the created cell.</returns>
  33229. <throws>
  33230. ArgumentException if columnIndex &lt; 0 or greater than the maximum number of supported columns
  33231. (255 for *.xls, 1048576 for *.xlsx)
  33232. </throws>
  33233. </member>
  33234. <member name="M:NPOI.SS.UserModel.IRow.CreateCell(System.Int32,NPOI.SS.UserModel.CellType)">
  33235. <summary>
  33236. Use this to create new cells within the row and return it.
  33237. 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
  33238. either through calling <code>SetCellValue</code> or <code>SetCellType</code>.
  33239. </summary>
  33240. <param name="column">the column number this cell represents</param>
  33241. <param name="type"></param>
  33242. <returns>Cell a high level representation of the created cell.</returns>
  33243. <throws>ArgumentException if columnIndex &lt; 0 or greater than the maximum number of supported columns
  33244. (255 for *.xls, 1048576 for *.xlsx)
  33245. </throws>
  33246. </member>
  33247. <member name="M:NPOI.SS.UserModel.IRow.RemoveCell(NPOI.SS.UserModel.ICell)">
  33248. <summary>
  33249. Remove the Cell from this row.
  33250. </summary>
  33251. <param name="cell">the cell to remove</param>
  33252. </member>
  33253. <member name="P:NPOI.SS.UserModel.IRow.RowNum">
  33254. <summary>
  33255. Get row number this row represents
  33256. </summary>
  33257. <returns>the row number (0 based)</returns>
  33258. </member>
  33259. <member name="M:NPOI.SS.UserModel.IRow.GetCell(System.Int32)">
  33260. <summary>
  33261. Get the cell representing a given column (logical cell) 0-based. If you
  33262. ask for a cell that is not defined....you get a null.
  33263. </summary>
  33264. <param name="cellnum">0 based column number</param>
  33265. <returns>Cell representing that column or null if undefined.</returns>
  33266. <see cref="M:NPOI.SS.UserModel.IRow.GetCell(System.Int32,NPOI.SS.UserModel.MissingCellPolicy)"/>
  33267. </member>
  33268. <member name="M:NPOI.SS.UserModel.IRow.GetCell(System.Int32,NPOI.SS.UserModel.MissingCellPolicy)">
  33269. <summary>
  33270. Returns the cell at the given (0 based) index, with the specified {@link NPOI.SS.usermodel.Row.MissingCellPolicy}
  33271. </summary>
  33272. <returns>the cell at the given (0 based) index</returns>
  33273. <throws>ArgumentException if cellnum &lt; 0 or the specified MissingCellPolicy is invalid</throws>
  33274. <see cref="F:NPOI.SS.UserModel.MissingCellPolicy.RETURN_NULL_AND_BLANK"/>
  33275. <see cref="F:NPOI.SS.UserModel.MissingCellPolicy.RETURN_BLANK_AS_NULL"/>
  33276. <see cref="F:NPOI.SS.UserModel.MissingCellPolicy.CREATE_NULL_AS_BLANK"/>
  33277. </member>
  33278. <member name="P:NPOI.SS.UserModel.IRow.FirstCellNum">
  33279. <summary>
  33280. Get the number of the first cell Contained in this row.
  33281. </summary>
  33282. <returns>
  33283. short representing the first logical cell in the row,
  33284. or -1 if the row does not contain any cells.
  33285. </returns>
  33286. </member>
  33287. <member name="P:NPOI.SS.UserModel.IRow.LastCellNum">
  33288. <summary>
  33289. Gets the index of the last cell Contained in this row <b>PLUS ONE</b>. The result also
  33290. happens to be the 1-based column number of the last cell. This value can be used as a
  33291. standard upper bound when iterating over cells:
  33292. <pre>
  33293. short minColIx = row.GetFirstCellNum();
  33294. short maxColIx = row.GetLastCellNum();
  33295. for(short colIx=minColIx; colIx&lt;maxColIx; colIx++) {
  33296. Cell cell = row.GetCell(colIx);
  33297. if(cell == null) {
  33298. continue;
  33299. }
  33300. //... do something with cell
  33301. }
  33302. </pre>
  33303. </summary>
  33304. <returns>
  33305. short representing the last logical cell in the row <b>PLUS ONE</b>,
  33306. or -1 if the row does not contain any cells.
  33307. </returns>
  33308. </member>
  33309. <member name="P:NPOI.SS.UserModel.IRow.PhysicalNumberOfCells">
  33310. <summary>
  33311. Gets the number of defined cells (NOT number of cells in the actual row!).
  33312. That is to say if only columns 0,4,5 have values then there would be 3.
  33313. </summary>
  33314. <returns>int representing the number of defined cells in the row.</returns>
  33315. </member>
  33316. <member name="P:NPOI.SS.UserModel.IRow.ZeroHeight">
  33317. <summary>
  33318. Get whether or not to display this row with 0 height
  33319. </summary>
  33320. <returns>zHeight height is zero or not.</returns>
  33321. </member>
  33322. <member name="P:NPOI.SS.UserModel.IRow.Height">
  33323. <summary>
  33324. Get the row's height measured in twips (1/20th of a point).
  33325. If the height is not set, the default worksheet value is returned,
  33326. <see cref="P:NPOI.SS.UserModel.ISheet.DefaultRowHeightInPoints"/>
  33327. </summary>
  33328. <returns>row height measured in twips (1/20th of a point)</returns>
  33329. </member>
  33330. <member name="P:NPOI.SS.UserModel.IRow.HeightInPoints">
  33331. <summary>
  33332. Returns row height measured in point size.
  33333. If the height is not set, the default worksheet value is returned,
  33334. <see cref="P:NPOI.SS.UserModel.ISheet.DefaultRowHeightInPoints"/>
  33335. </summary>
  33336. <returns>row height measured in point size
  33337. <see cref="P:NPOI.SS.UserModel.ISheet.DefaultRowHeightInPoints"/>
  33338. </returns>
  33339. </member>
  33340. <member name="P:NPOI.SS.UserModel.IRow.IsFormatted">
  33341. <summary>
  33342. Is this row formatted? Most aren't, but some rows
  33343. do have whole-row styles. For those that do, you
  33344. can get the formatting from <see cref="P:NPOI.SS.UserModel.IRow.RowStyle"/>
  33345. </summary>
  33346. </member>
  33347. <member name="P:NPOI.SS.UserModel.IRow.Sheet">
  33348. <summary>
  33349. Returns the Sheet this row belongs to
  33350. </summary>
  33351. <returns>the Sheet that owns this row</returns>
  33352. </member>
  33353. <member name="P:NPOI.SS.UserModel.IRow.RowStyle">
  33354. <summary>
  33355. Returns the whole-row cell styles. Most rows won't
  33356. have one of these, so will return null. Call IsFormmated to check first
  33357. </summary>
  33358. <value>The row style.</value>
  33359. </member>
  33360. <member name="M:NPOI.SS.UserModel.IRow.MoveCell(NPOI.SS.UserModel.ICell,System.Int32)">
  33361. <summary>
  33362. Moves the supplied cell to a new column, which
  33363. must not already have a cell there!
  33364. </summary>
  33365. <param name="cell">The cell to move</param>
  33366. <param name="newColumn">The new column number (0 based)</param>
  33367. </member>
  33368. <member name="M:NPOI.SS.UserModel.IRow.CopyRowTo(System.Int32)">
  33369. <summary>
  33370. Copy the current row to the target row
  33371. </summary>
  33372. <param name="targetIndex">row index of the target row</param>
  33373. <returns>the new copied row object</returns>
  33374. </member>
  33375. <member name="M:NPOI.SS.UserModel.IRow.CopyCell(System.Int32,System.Int32)">
  33376. <summary>
  33377. Copy the source cell to the target cell. If the target cell exists, the new copied cell will be inserted before the existing one
  33378. </summary>
  33379. <param name="sourceIndex">index of the source cell</param>
  33380. <param name="targetIndex">index of the target cell</param>
  33381. <returns>the new copied cell object</returns>
  33382. </member>
  33383. <member name="P:NPOI.SS.UserModel.IRow.Cells">
  33384. <summary>
  33385. Get cells in the row
  33386. </summary>
  33387. </member>
  33388. <member name="P:NPOI.SS.UserModel.IRow.OutlineLevel">
  33389. <summary>
  33390. Returns the rows outline level. Increased as you
  33391. put it into more groups (outlines), reduced as
  33392. you take it out of them.
  33393. </summary>
  33394. </member>
  33395. <member name="T:NPOI.SS.UserModel.MarginType">
  33396. <summary>
  33397. Indicate the position of the margin. One of left, right, top and bottom.
  33398. </summary>
  33399. </member>
  33400. <member name="F:NPOI.SS.UserModel.MarginType.LeftMargin">
  33401. <summary>
  33402. referes to the left margin
  33403. </summary>
  33404. </member>
  33405. <member name="F:NPOI.SS.UserModel.MarginType.RightMargin">
  33406. <summary>
  33407. referes to the right margin
  33408. </summary>
  33409. </member>
  33410. <member name="F:NPOI.SS.UserModel.MarginType.TopMargin">
  33411. <summary>
  33412. referes to the top margin
  33413. </summary>
  33414. </member>
  33415. <member name="F:NPOI.SS.UserModel.MarginType.BottomMargin">
  33416. <summary>
  33417. referes to the bottom margin
  33418. </summary>
  33419. </member>
  33420. <member name="T:NPOI.SS.UserModel.PanePosition">
  33421. <summary>
  33422. Define the position of the pane. One of lower/right, upper/right, lower/left and upper/left.
  33423. </summary>
  33424. </member>
  33425. <member name="F:NPOI.SS.UserModel.PanePosition.LowerRight">
  33426. <summary>
  33427. referes to the lower/right corner
  33428. </summary>
  33429. </member>
  33430. <member name="F:NPOI.SS.UserModel.PanePosition.UpperRight">
  33431. <summary>
  33432. referes to the upper/right corner
  33433. </summary>
  33434. </member>
  33435. <member name="F:NPOI.SS.UserModel.PanePosition.LowerLeft">
  33436. <summary>
  33437. referes to the lower/left corner
  33438. </summary>
  33439. </member>
  33440. <member name="F:NPOI.SS.UserModel.PanePosition.UpperLeft">
  33441. <summary>
  33442. referes to the upper/left corner
  33443. </summary>
  33444. </member>
  33445. <member name="T:NPOI.SS.UserModel.ISheet">
  33446. <summary>
  33447. High level representation of a Excel worksheet.
  33448. </summary>
  33449. <remarks>
  33450. Sheets are the central structures within a workbook, and are where a user does most of his spreadsheet work.
  33451. The most common type of sheet is the worksheet, which is represented as a grid of cells. Worksheet cells can
  33452. contain text, numbers, dates, and formulas. Cells can also be formatted.
  33453. </remarks>
  33454. </member>
  33455. <member name="M:NPOI.SS.UserModel.ISheet.CreateRow(System.Int32)">
  33456. <summary>
  33457. Create a new row within the sheet and return the high level representation
  33458. </summary>
  33459. <param name="rownum">The row number.</param>
  33460. <returns>high level Row object representing a row in the sheet</returns>
  33461. <see>RemoveRow(Row)</see>
  33462. </member>
  33463. <member name="M:NPOI.SS.UserModel.ISheet.RemoveRow(NPOI.SS.UserModel.IRow)">
  33464. <summary>
  33465. Remove a row from this sheet. All cells Contained in the row are Removed as well
  33466. </summary>
  33467. <param name="row">a row to Remove.</param>
  33468. </member>
  33469. <member name="M:NPOI.SS.UserModel.ISheet.GetRow(System.Int32)">
  33470. <summary>
  33471. Returns the logical row (not physical) 0-based. If you ask for a row that is not
  33472. defined you get a null. This is to say row 4 represents the fifth row on a sheet.
  33473. </summary>
  33474. <param name="rownum">row to get (0-based).</param>
  33475. <returns>the rownumber or null if its not defined on the sheet</returns>
  33476. </member>
  33477. <member name="P:NPOI.SS.UserModel.ISheet.PhysicalNumberOfRows">
  33478. <summary>
  33479. Returns the number of physically defined rows (NOT the number of rows in the sheet)
  33480. </summary>
  33481. <value>the number of physically defined rows in this sheet.</value>
  33482. </member>
  33483. <member name="P:NPOI.SS.UserModel.ISheet.FirstRowNum">
  33484. <summary>
  33485. Gets the first row on the sheet
  33486. </summary>
  33487. <value>the number of the first logical row on the sheet (0-based).</value>
  33488. </member>
  33489. <member name="P:NPOI.SS.UserModel.ISheet.LastRowNum">
  33490. <summary>
  33491. Gets the last row on the sheet
  33492. </summary>
  33493. <value>last row contained n this sheet (0-based)</value>
  33494. </member>
  33495. <member name="P:NPOI.SS.UserModel.ISheet.ForceFormulaRecalculation">
  33496. <summary>
  33497. whether force formula recalculation.
  33498. </summary>
  33499. </member>
  33500. <member name="M:NPOI.SS.UserModel.ISheet.SetColumnHidden(System.Int32,System.Boolean)">
  33501. <summary>
  33502. Get the visibility state for a given column
  33503. </summary>
  33504. <param name="columnIndex">the column to get (0-based)</param>
  33505. <param name="hidden">the visiblity state of the column</param>
  33506. </member>
  33507. <member name="M:NPOI.SS.UserModel.ISheet.IsColumnHidden(System.Int32)">
  33508. <summary>
  33509. Get the hidden state for a given column
  33510. </summary>
  33511. <param name="columnIndex">the column to set (0-based)</param>
  33512. <returns>hidden - <c>false</c> if the column is visible</returns>
  33513. </member>
  33514. <member name="M:NPOI.SS.UserModel.ISheet.CopyRow(System.Int32,System.Int32)">
  33515. <summary>
  33516. Copy the source row to the target row. If the target row exists, the new copied row will be inserted before the existing one
  33517. </summary>
  33518. <param name="sourceIndex">source index</param>
  33519. <param name="targetIndex">target index</param>
  33520. <returns>the new copied row object</returns>
  33521. </member>
  33522. <member name="M:NPOI.SS.UserModel.ISheet.SetColumnWidth(System.Int32,System.Int32)">
  33523. <summary>
  33524. Set the width (in units of 1/256th of a character width)
  33525. </summary>
  33526. <param name="columnIndex">the column to set (0-based)</param>
  33527. <param name="width">the width in units of 1/256th of a character width</param>
  33528. <remarks>
  33529. The maximum column width for an individual cell is 255 characters.
  33530. This value represents the number of characters that can be displayed
  33531. in a cell that is formatted with the standard font.
  33532. </remarks>
  33533. </member>
  33534. <member name="M:NPOI.SS.UserModel.ISheet.GetColumnWidth(System.Int32)">
  33535. <summary>
  33536. get the width (in units of 1/256th of a character width )
  33537. </summary>
  33538. <param name="columnIndex">the column to get (0-based)</param>
  33539. <returns>the width in units of 1/256th of a character width</returns>
  33540. </member>
  33541. <member name="M:NPOI.SS.UserModel.ISheet.GetColumnWidthInPixels(System.Int32)">
  33542. <summary>
  33543. get the width in pixel
  33544. </summary>
  33545. <param name="columnIndex"></param>
  33546. <returns></returns>
  33547. <remarks>
  33548. Please note, that this method works correctly only for workbooks
  33549. with the default font size (Arial 10pt for .xls and Calibri 11pt for .xlsx).
  33550. If the default font is changed the column width can be streched
  33551. </remarks>
  33552. </member>
  33553. <member name="P:NPOI.SS.UserModel.ISheet.DefaultColumnWidth">
  33554. <summary>
  33555. Get the default column width for the sheet (if the columns do not define their own width)
  33556. in characters
  33557. </summary>
  33558. <value>default column width measured in characters.</value>
  33559. </member>
  33560. <member name="P:NPOI.SS.UserModel.ISheet.DefaultRowHeight">
  33561. <summary>
  33562. Get the default row height for the sheet (if the rows do not define their own height) in
  33563. twips (1/20 of a point)
  33564. </summary>
  33565. <value>default row height measured in twips (1/20 of a point)</value>
  33566. </member>
  33567. <member name="P:NPOI.SS.UserModel.ISheet.DefaultRowHeightInPoints">
  33568. <summary>
  33569. Get the default row height for the sheet (if the rows do not define their own height) in
  33570. points.
  33571. </summary>
  33572. <value>The default row height in points.</value>
  33573. </member>
  33574. <member name="M:NPOI.SS.UserModel.ISheet.GetColumnStyle(System.Int32)">
  33575. <summary>
  33576. Returns the CellStyle that applies to the given
  33577. (0 based) column, or null if no style has been
  33578. set for that column
  33579. </summary>
  33580. <param name="column">The column.</param>
  33581. </member>
  33582. <member name="M:NPOI.SS.UserModel.ISheet.AddMergedRegion(NPOI.SS.Util.CellRangeAddress)">
  33583. <summary>
  33584. Adds a merged region of cells (hence those cells form one)
  33585. </summary>
  33586. <param name="region">(rowfrom/colfrom-rowto/colto) to merge.</param>
  33587. <returns>index of this region</returns>
  33588. </member>
  33589. <member name="M:NPOI.SS.UserModel.ISheet.AddMergedRegionUnsafe(NPOI.SS.Util.CellRangeAddress)">
  33590. <summary>
  33591. Adds a merged region of cells (hence those cells form one).
  33592. Skips validation. It is possible to create overlapping merged regions
  33593. or create a merged region that intersects a multi-cell array formula
  33594. with this formula, which may result in a corrupt workbook.
  33595. To check for merged regions overlapping array formulas or other merged regions
  33596. after addMergedRegionUnsafe has been called, call {@link #validateMergedRegions()}, which runs in O(n^2) time.
  33597. </summary>
  33598. <param name="region">region to merge</param>
  33599. <returns>index of this region</returns>
  33600. <exception cref="T:System.ArgumentException">if region contains fewer than 2 cells</exception>
  33601. </member>
  33602. <member name="M:NPOI.SS.UserModel.ISheet.ValidateMergedRegions">
  33603. <summary>
  33604. Verify that merged regions do not intersect multi-cell array formulas and
  33605. no merged regions intersect another merged region in this sheet.
  33606. </summary>
  33607. <exception cref="!:NPOI.Util.InvalidOperationException">if region intersects with a multi-cell array formula</exception>
  33608. <exception cref="!:NPOI.Util.InvalidOperationException">if at least one region intersects with another merged region in this sheet</exception>
  33609. </member>
  33610. <member name="P:NPOI.SS.UserModel.ISheet.HorizontallyCenter">
  33611. <summary>
  33612. Determine whether printed output for this sheet will be horizontally centered.
  33613. </summary>
  33614. </member>
  33615. <member name="P:NPOI.SS.UserModel.ISheet.VerticallyCenter">
  33616. <summary>
  33617. Determine whether printed output for this sheet will be vertically centered.
  33618. </summary>
  33619. </member>
  33620. <member name="M:NPOI.SS.UserModel.ISheet.RemoveMergedRegion(System.Int32)">
  33621. <summary>
  33622. Removes a merged region of cells (hence letting them free)
  33623. </summary>
  33624. <param name="index">index of the region to unmerge</param>
  33625. </member>
  33626. <member name="M:NPOI.SS.UserModel.ISheet.RemoveMergedRegions(System.Collections.Generic.IList{System.Int32})">
  33627. <summary>
  33628. Removes a number of merged regions of cells (hence letting them free)
  33629. </summary>
  33630. <param name="indices">A set of the regions to unmerge</param>
  33631. </member>
  33632. <member name="P:NPOI.SS.UserModel.ISheet.NumMergedRegions">
  33633. <summary>
  33634. Returns the number of merged regions
  33635. </summary>
  33636. </member>
  33637. <member name="M:NPOI.SS.UserModel.ISheet.GetMergedRegion(System.Int32)">
  33638. <summary>
  33639. Returns the merged region at the specified index
  33640. </summary>
  33641. <param name="index">The index.</param>
  33642. </member>
  33643. <member name="P:NPOI.SS.UserModel.ISheet.MergedRegions">
  33644. <summary>
  33645. Returns the list of merged regions.
  33646. </summary>
  33647. </member>
  33648. <member name="M:NPOI.SS.UserModel.ISheet.GetRowEnumerator">
  33649. <summary>
  33650. Gets the row enumerator.
  33651. </summary>
  33652. <returns>
  33653. an iterator of the PHYSICAL rows. Meaning the 3rd element may not
  33654. be the third row if say for instance the second row is undefined.
  33655. Call <see cref="P:NPOI.SS.UserModel.IRow.RowNum"/> on each row
  33656. if you care which one it is.
  33657. </returns>
  33658. </member>
  33659. <member name="M:NPOI.SS.UserModel.ISheet.GetEnumerator">
  33660. <summary>
  33661. Get the row enumerator
  33662. </summary>
  33663. <returns></returns>
  33664. </member>
  33665. <member name="P:NPOI.SS.UserModel.ISheet.DisplayZeros">
  33666. <summary>
  33667. Gets the flag indicating whether the window should show 0 (zero) in cells Containing zero value.
  33668. When false, cells with zero value appear blank instead of showing the number zero.
  33669. </summary>
  33670. <value>whether all zero values on the worksheet are displayed.</value>
  33671. </member>
  33672. <member name="P:NPOI.SS.UserModel.ISheet.Autobreaks">
  33673. <summary>
  33674. Gets or sets a value indicating whether the sheet displays Automatic Page Breaks.
  33675. </summary>
  33676. </member>
  33677. <member name="P:NPOI.SS.UserModel.ISheet.DisplayGuts">
  33678. <summary>
  33679. Get whether to display the guts or not,
  33680. </summary>
  33681. <value>default value is true</value>
  33682. </member>
  33683. <member name="P:NPOI.SS.UserModel.ISheet.FitToPage">
  33684. <summary>
  33685. Flag indicating whether the Fit to Page print option is enabled.
  33686. </summary>
  33687. </member>
  33688. <member name="P:NPOI.SS.UserModel.ISheet.RowSumsBelow">
  33689. <summary>
  33690. Flag indicating whether summary rows appear below detail in an outline, when applying an outline.
  33691. When true a summary row is inserted below the detailed data being summarized and a
  33692. new outline level is established on that row.
  33693. When false a summary row is inserted above the detailed data being summarized and a new outline level
  33694. is established on that row.
  33695. </summary>
  33696. <returns><c>true</c> if row summaries appear below detail in the outline</returns>
  33697. </member>
  33698. <member name="P:NPOI.SS.UserModel.ISheet.RowSumsRight">
  33699. <summary>
  33700. Flag indicating whether summary columns appear to the right of detail in an outline, when applying an outline.
  33701. When true a summary column is inserted to the right of the detailed data being summarized
  33702. and a new outline level is established on that column.
  33703. When false a summary column is inserted to the left of the detailed data being
  33704. summarized and a new outline level is established on that column.
  33705. </summary>
  33706. <returns><c>true</c> if col summaries appear right of the detail in the outline</returns>
  33707. </member>
  33708. <member name="P:NPOI.SS.UserModel.ISheet.IsPrintGridlines">
  33709. <summary>
  33710. Gets the flag indicating whether this sheet displays the lines
  33711. between rows and columns to make editing and reading easier.
  33712. </summary>
  33713. <returns><c>true</c> if this sheet displays gridlines.</returns>
  33714. </member>
  33715. <member name="P:NPOI.SS.UserModel.ISheet.IsPrintRowAndColumnHeadings">
  33716. <summary>
  33717. Get or set the flag indicating whether this sheet prints the
  33718. row and column headings when printing.
  33719. return true if this sheet prints row and column headings.
  33720. </summary>
  33721. </member>
  33722. <member name="P:NPOI.SS.UserModel.ISheet.PrintSetup">
  33723. <summary>
  33724. Gets the print Setup object.
  33725. </summary>
  33726. <returns>The user model for the print Setup object.</returns>
  33727. </member>
  33728. <member name="P:NPOI.SS.UserModel.ISheet.Header">
  33729. <summary>
  33730. Gets the user model for the default document header.
  33731. <p/>
  33732. Note that XSSF offers more kinds of document headers than HSSF does
  33733. </summary>
  33734. <returns>the document header. Never <code>null</code></returns>
  33735. </member>
  33736. <member name="P:NPOI.SS.UserModel.ISheet.Footer">
  33737. <summary>
  33738. Gets the user model for the default document footer.
  33739. <p/>
  33740. Note that XSSF offers more kinds of document footers than HSSF does.
  33741. </summary>
  33742. <returns>the document footer. Never <code>null</code></returns>
  33743. </member>
  33744. <member name="M:NPOI.SS.UserModel.ISheet.GetMargin(NPOI.SS.UserModel.MarginType)">
  33745. <summary>
  33746. Gets the size of the margin in inches.
  33747. </summary>
  33748. <param name="margin">which margin to get</param>
  33749. <returns>the size of the margin</returns>
  33750. </member>
  33751. <member name="M:NPOI.SS.UserModel.ISheet.SetMargin(NPOI.SS.UserModel.MarginType,System.Double)">
  33752. <summary>
  33753. Sets the size of the margin in inches.
  33754. </summary>
  33755. <param name="margin">which margin to get</param>
  33756. <param name="size">the size of the margin</param>
  33757. </member>
  33758. <member name="P:NPOI.SS.UserModel.ISheet.Protect">
  33759. <summary>
  33760. Answer whether protection is enabled or disabled
  33761. </summary>
  33762. <returns>true => protection enabled; false => protection disabled</returns>
  33763. </member>
  33764. <member name="P:NPOI.SS.UserModel.ISheet.ScenarioProtect">
  33765. <summary>
  33766. Answer whether scenario protection is enabled or disabled
  33767. </summary>
  33768. <returns>true => protection enabled; false => protection disabled</returns>
  33769. </member>
  33770. <member name="P:NPOI.SS.UserModel.ISheet.TabColorIndex">
  33771. <summary>
  33772. Gets or sets the tab color of the _sheet
  33773. </summary>
  33774. </member>
  33775. <member name="P:NPOI.SS.UserModel.ISheet.DrawingPatriarch">
  33776. <summary>
  33777. Returns the top-level drawing patriach, if there is one.
  33778. This will hold any graphics or charts for the _sheet.
  33779. WARNING - calling this will trigger a parsing of the
  33780. associated escher records. Any that aren't supported
  33781. (such as charts and complex drawing types) will almost
  33782. certainly be lost or corrupted when written out. Only
  33783. use this with simple drawings, otherwise call
  33784. HSSFSheet#CreateDrawingPatriarch() and
  33785. start from scratch!
  33786. </summary>
  33787. <value>The drawing patriarch.</value>
  33788. </member>
  33789. <member name="M:NPOI.SS.UserModel.ISheet.SetZoom(System.Int32,System.Int32)">
  33790. <summary>
  33791. Sets the zoom magnication for the sheet. The zoom is expressed as a
  33792. fraction. For example to express a zoom of 75% use 3 for the numerator
  33793. and 4 for the denominator.
  33794. </summary>
  33795. <param name="numerator">The numerator for the zoom magnification.</param>
  33796. <param name="denominator">denominator for the zoom magnification.</param>
  33797. </member>
  33798. <!-- Badly formed XML comment ignored for member "M:NPOI.SS.UserModel.ISheet.SetZoom(System.Int32)" -->
  33799. <member name="P:NPOI.SS.UserModel.ISheet.TopRow">
  33800. <summary>
  33801. The top row in the visible view when the sheet is
  33802. first viewed after opening it in a viewer
  33803. </summary>
  33804. <value>the rownum (0 based) of the top row.</value>
  33805. </member>
  33806. <member name="P:NPOI.SS.UserModel.ISheet.LeftCol">
  33807. <summary>
  33808. The left col in the visible view when the sheet is
  33809. first viewed after opening it in a viewer
  33810. </summary>
  33811. <value>the rownum (0 based) of the top row</value>
  33812. </member>
  33813. <member name="M:NPOI.SS.UserModel.ISheet.ShowInPane(System.Int32,System.Int32)">
  33814. <summary>
  33815. Sets desktop window pane display area, when the file is first opened in a viewer.
  33816. </summary>
  33817. <param name="toprow">the top row to show in desktop window pane</param>
  33818. <param name="leftcol">the left column to show in desktop window pane</param>
  33819. </member>
  33820. <member name="M:NPOI.SS.UserModel.ISheet.ShiftRows(System.Int32,System.Int32,System.Int32)">
  33821. <summary>
  33822. Shifts rows between startRow and endRow n number of rows.
  33823. If you use a negative number, it will shift rows up.
  33824. Code ensures that rows don't wrap around.
  33825. Calls shiftRows(startRow, endRow, n, false, false);
  33826. Additionally shifts merged regions that are completely defined in these
  33827. rows (ie. merged 2 cells on a row to be shifted).
  33828. </summary>
  33829. <param name="startRow">the row to start shifting</param>
  33830. <param name="endRow">the row to end shifting</param>
  33831. <param name="n">the number of rows to shift</param>
  33832. </member>
  33833. <member name="M:NPOI.SS.UserModel.ISheet.ShiftRows(System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean)">
  33834. <summary>
  33835. Shifts rows between startRow and endRow n number of rows.
  33836. If you use a negative number, it will shift rows up.
  33837. Code ensures that rows don't wrap around
  33838. Additionally shifts merged regions that are completely defined in these
  33839. rows (ie. merged 2 cells on a row to be shifted).
  33840. </summary>
  33841. <param name="startRow">the row to start shifting</param>
  33842. <param name="endRow">the row to end shifting</param>
  33843. <param name="n">the number of rows to shift</param>
  33844. <param name="copyRowHeight">whether to copy the row height during the shift</param>
  33845. <param name="resetOriginalRowHeight">whether to set the original row's height to the default</param>
  33846. </member>
  33847. <member name="M:NPOI.SS.UserModel.ISheet.CreateFreezePane(System.Int32,System.Int32,System.Int32,System.Int32)">
  33848. <summary>
  33849. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  33850. </summary>
  33851. <param name="colSplit">Horizonatal position of split</param>
  33852. <param name="rowSplit">Vertical position of split</param>
  33853. <param name="leftmostColumn">Top row visible in bottom pane</param>
  33854. <param name="topRow">Left column visible in right pane</param>
  33855. </member>
  33856. <member name="M:NPOI.SS.UserModel.ISheet.CreateFreezePane(System.Int32,System.Int32)">
  33857. <summary>
  33858. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  33859. </summary>
  33860. <param name="colSplit">Horizonatal position of split.</param>
  33861. <param name="rowSplit">Vertical position of split.</param>
  33862. </member>
  33863. <member name="M:NPOI.SS.UserModel.ISheet.CreateSplitPane(System.Int32,System.Int32,System.Int32,System.Int32,NPOI.SS.UserModel.PanePosition)">
  33864. <summary>
  33865. Creates a split pane. Any existing freezepane or split pane is overwritten.
  33866. </summary>
  33867. <param name="xSplitPos">Horizonatal position of split (in 1/20th of a point)</param>
  33868. <param name="ySplitPos">Vertical position of split (in 1/20th of a point)</param>
  33869. <param name="leftmostColumn">Left column visible in right pane</param>
  33870. <param name="topRow">Top row visible in bottom pane</param>
  33871. <param name="activePane">Active pane. One of: PANE_LOWER_RIGHT, PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFT</param>
  33872. @see #PANE_LOWER_LEFT
  33873. @see #PANE_LOWER_RIGHT
  33874. @see #PANE_UPPER_LEFT
  33875. @see #PANE_UPPER_RIGHT
  33876. </member>
  33877. <member name="P:NPOI.SS.UserModel.ISheet.PaneInformation">
  33878. <summary>
  33879. Returns the information regarding the currently configured pane (split or freeze)
  33880. </summary>
  33881. <value>if no pane configured returns <c>null</c> else return the pane information.</value>
  33882. </member>
  33883. <member name="P:NPOI.SS.UserModel.ISheet.DisplayGridlines">
  33884. <summary>
  33885. Returns if gridlines are displayed
  33886. </summary>
  33887. </member>
  33888. <member name="P:NPOI.SS.UserModel.ISheet.DisplayFormulas">
  33889. <summary>
  33890. Returns if formulas are displayed
  33891. </summary>
  33892. </member>
  33893. <member name="P:NPOI.SS.UserModel.ISheet.DisplayRowColHeadings">
  33894. <summary>
  33895. Returns if RowColHeadings are displayed.
  33896. </summary>
  33897. </member>
  33898. <member name="P:NPOI.SS.UserModel.ISheet.IsActive">
  33899. <summary>
  33900. Returns if RowColHeadings are displayed.
  33901. </summary>
  33902. </member>
  33903. <member name="M:NPOI.SS.UserModel.ISheet.IsRowBroken(System.Int32)">
  33904. <summary>
  33905. Determines if there is a page break at the indicated row
  33906. </summary>
  33907. <param name="row">The row.</param>
  33908. </member>
  33909. <member name="M:NPOI.SS.UserModel.ISheet.RemoveRowBreak(System.Int32)">
  33910. <summary>
  33911. Removes the page break at the indicated row
  33912. </summary>
  33913. <param name="row">The row index.</param>
  33914. </member>
  33915. <member name="P:NPOI.SS.UserModel.ISheet.RowBreaks">
  33916. <summary>
  33917. Retrieves all the horizontal page breaks
  33918. </summary>
  33919. <value>all the horizontal page breaks, or null if there are no row page breaks</value>
  33920. </member>
  33921. <member name="P:NPOI.SS.UserModel.ISheet.ColumnBreaks">
  33922. <summary>
  33923. Retrieves all the vertical page breaks
  33924. </summary>
  33925. <value>all the vertical page breaks, or null if there are no column page breaks.</value>
  33926. </member>
  33927. <member name="M:NPOI.SS.UserModel.ISheet.GetSelectionState">
  33928. <summary>
  33929. Sets the active cell.
  33930. </summary>
  33931. <param name="row">The row.</param>
  33932. <param name="column">The column.</param>
  33933. </member>
  33934. <member name="M:NPOI.SS.UserModel.ISheet.SetActiveCellRange(System.Collections.Generic.List{NPOI.SS.Util.CellRangeAddress8Bit},System.Int32,System.Int32,System.Int32,NPOI.SS.UserModel.PanePosition)">
  33935. <summary>
  33936. Sets the active cell range.
  33937. </summary>
  33938. <param name="cellranges">The cellranges.</param>
  33939. <param name="activeRange">The index of the active range.</param>
  33940. <param name="activeRow">The active row in the active range.</param>
  33941. <param name="activeColumn">The active column in the active range.</param>
  33942. <param name="pane">The position of the pane.</param>
  33943. </member>
  33944. <member name="M:NPOI.SS.UserModel.ISheet.SetColumnBreak(System.Int32)">
  33945. <summary>
  33946. Sets a page break at the indicated column
  33947. </summary>
  33948. <param name="column">The column.</param>
  33949. </member>
  33950. <member name="M:NPOI.SS.UserModel.ISheet.SetRowBreak(System.Int32)">
  33951. <summary>
  33952. Sets the row break.
  33953. </summary>
  33954. <param name="row">The row.</param>
  33955. </member>
  33956. <member name="M:NPOI.SS.UserModel.ISheet.IsColumnBroken(System.Int32)">
  33957. <summary>
  33958. Determines if there is a page break at the indicated column
  33959. </summary>
  33960. <param name="column">The column index.</param>
  33961. </member>
  33962. <member name="M:NPOI.SS.UserModel.ISheet.RemoveColumnBreak(System.Int32)">
  33963. <summary>
  33964. Removes a page break at the indicated column
  33965. </summary>
  33966. <param name="column">The column.</param>
  33967. </member>
  33968. <member name="M:NPOI.SS.UserModel.ISheet.SetColumnGroupCollapsed(System.Int32,System.Boolean)">
  33969. <summary>
  33970. Expands or collapses a column group.
  33971. </summary>
  33972. <param name="columnNumber">One of the columns in the group.</param>
  33973. <param name="collapsed">if set to <c>true</c>collapse group.<c>false</c>expand group.</param>
  33974. </member>
  33975. <member name="M:NPOI.SS.UserModel.ISheet.GroupColumn(System.Int32,System.Int32)">
  33976. <summary>
  33977. Create an outline for the provided column range.
  33978. </summary>
  33979. <param name="fromColumn">beginning of the column range.</param>
  33980. <param name="toColumn">end of the column range.</param>
  33981. </member>
  33982. <member name="M:NPOI.SS.UserModel.ISheet.UngroupColumn(System.Int32,System.Int32)">
  33983. <summary>
  33984. Ungroup a range of columns that were previously groupped
  33985. </summary>
  33986. <param name="fromColumn">start column (0-based).</param>
  33987. <param name="toColumn">end column (0-based).</param>
  33988. </member>
  33989. <member name="M:NPOI.SS.UserModel.ISheet.GroupRow(System.Int32,System.Int32)">
  33990. <summary>
  33991. Tie a range of rows toGether so that they can be collapsed or expanded
  33992. </summary>
  33993. <param name="fromRow">start row (0-based)</param>
  33994. <param name="toRow">end row (0-based)</param>
  33995. </member>
  33996. <member name="M:NPOI.SS.UserModel.ISheet.UngroupRow(System.Int32,System.Int32)">
  33997. <summary>
  33998. Ungroup a range of rows that were previously groupped
  33999. </summary>
  34000. <param name="fromRow">start row (0-based)</param>
  34001. <param name="toRow">end row (0-based)</param>
  34002. </member>
  34003. <member name="M:NPOI.SS.UserModel.ISheet.SetRowGroupCollapsed(System.Int32,System.Boolean)">
  34004. <summary>
  34005. Set view state of a groupped range of rows
  34006. </summary>
  34007. <param name="row">start row of a groupped range of rows (0-based).</param>
  34008. <param name="collapse">whether to expand/collapse the detail rows.</param>
  34009. </member>
  34010. <member name="M:NPOI.SS.UserModel.ISheet.SetDefaultColumnStyle(System.Int32,NPOI.SS.UserModel.ICellStyle)">
  34011. <summary>
  34012. Sets the default column style for a given column. POI will only apply this style to new cells Added to the sheet.
  34013. </summary>
  34014. <param name="column">the column index</param>
  34015. <param name="style">the style to set</param>
  34016. </member>
  34017. <member name="M:NPOI.SS.UserModel.ISheet.GetCellComment(System.Int32,System.Int32)">
  34018. <summary>
  34019. Returns cell comment for the specified row and column
  34020. </summary>
  34021. <param name="row">The row.</param>
  34022. <param name="column">The column.</param>
  34023. </member>
  34024. <member name="M:NPOI.SS.UserModel.ISheet.GetCellComment(NPOI.SS.Util.CellAddress)">
  34025. <summary>
  34026. Returns cell comment for the specified location
  34027. </summary>
  34028. <param name="ref1">cell location</param>
  34029. <returns>return cell comment or null if not found</returns>
  34030. </member>
  34031. <member name="M:NPOI.SS.UserModel.ISheet.GetCellComments">
  34032. <summary>
  34033. Returns all cell comments on this sheet.
  34034. </summary>
  34035. <returns>return A Dictionary of each Comment in the sheet, keyed on the cell address where the comment is located.</returns>
  34036. </member>
  34037. <member name="M:NPOI.SS.UserModel.ISheet.CreateDrawingPatriarch">
  34038. <summary>
  34039. Creates the top-level drawing patriarch.
  34040. </summary>
  34041. </member>
  34042. <member name="P:NPOI.SS.UserModel.ISheet.Workbook">
  34043. <summary>
  34044. Gets the parent workbook.
  34045. </summary>
  34046. </member>
  34047. <member name="P:NPOI.SS.UserModel.ISheet.SheetName">
  34048. <summary>
  34049. Gets the name of the sheet.
  34050. </summary>
  34051. </member>
  34052. <member name="P:NPOI.SS.UserModel.ISheet.IsSelected">
  34053. <summary>
  34054. Gets or sets a value indicating whether this sheet is currently selected.
  34055. </summary>
  34056. </member>
  34057. <member name="M:NPOI.SS.UserModel.ISheet.SetActive(System.Boolean)">
  34058. <summary>
  34059. Sets whether sheet is selected.
  34060. </summary>
  34061. <param name="value">Whether to select the sheet or deselect the sheet.</param>
  34062. </member>
  34063. <member name="M:NPOI.SS.UserModel.ISheet.SetArrayFormula(System.String,NPOI.SS.Util.CellRangeAddress)">
  34064. <summary>
  34065. Sets array formula to specified region for result.
  34066. </summary>
  34067. <param name="formula">text representation of the formula</param>
  34068. <param name="range">Region of array formula for result</param>
  34069. <returns>the <see cref="T:NPOI.SS.UserModel.ICellRange`1"/> of cells affected by this change</returns>
  34070. </member>
  34071. <member name="M:NPOI.SS.UserModel.ISheet.RemoveArrayFormula(NPOI.SS.UserModel.ICell)">
  34072. <summary>
  34073. Remove a Array Formula from this sheet. All cells contained in the Array Formula range are removed as well
  34074. </summary>
  34075. <param name="cell">any cell within Array Formula range</param>
  34076. <returns>the <see cref="T:NPOI.SS.UserModel.ICellRange`1"/> of cells affected by this change</returns>
  34077. </member>
  34078. <member name="M:NPOI.SS.UserModel.ISheet.IsMergedRegion(NPOI.SS.Util.CellRangeAddress)">
  34079. <summary>
  34080. Checks if the provided region is part of the merged regions.
  34081. </summary>
  34082. <param name="mergedRegion">Region searched in the merged regions</param>
  34083. <returns><c>true</c>, when the region is contained in at least one of the merged regions</returns>
  34084. </member>
  34085. <member name="M:NPOI.SS.UserModel.ISheet.GetDataValidationHelper">
  34086. <summary>
  34087. Create an instance of a DataValidationHelper.
  34088. </summary>
  34089. <returns>Instance of a DataValidationHelper</returns>
  34090. </member>
  34091. <member name="M:NPOI.SS.UserModel.ISheet.GetDataValidations">
  34092. <summary>
  34093. Returns the list of DataValidation in the sheet.
  34094. </summary>
  34095. <returns>list of DataValidation in the sheet</returns>
  34096. </member>
  34097. <member name="M:NPOI.SS.UserModel.ISheet.AddValidationData(NPOI.SS.UserModel.IDataValidation)">
  34098. <summary>
  34099. Creates a data validation object
  34100. </summary>
  34101. <param name="dataValidation">The data validation object settings</param>
  34102. </member>
  34103. <member name="M:NPOI.SS.UserModel.ISheet.SetAutoFilter(NPOI.SS.Util.CellRangeAddress)">
  34104. <summary>
  34105. Enable filtering for a range of cells
  34106. </summary>
  34107. <param name="range">the range of cells to filter</param>
  34108. </member>
  34109. <member name="P:NPOI.SS.UserModel.ISheet.SheetConditionalFormatting">
  34110. <summary>
  34111. The 'Conditional Formatting' facet for this <c>Sheet</c>
  34112. </summary>
  34113. <returns>conditional formatting rule for this sheet</returns>
  34114. </member>
  34115. <member name="P:NPOI.SS.UserModel.ISheet.IsRightToLeft">
  34116. <summary>
  34117. Whether the text is displayed in right-to-left mode in the window
  34118. </summary>
  34119. </member>
  34120. <member name="P:NPOI.SS.UserModel.ISheet.RepeatingRows">
  34121. <summary>
  34122. Get or set the repeating rows used when printing the sheet, as found in File->PageSetup->Sheet.
  34123. <p/>
  34124. Repeating rows cover a range of contiguous rows, e.g.:
  34125. <pre>
  34126. Sheet1!$1:$1
  34127. Sheet2!$5:$8
  34128. </pre>
  34129. The {@link CellRangeAddress} returned contains a column part which spans
  34130. all columns, and a row part which specifies the contiguous range of
  34131. repeating rows.
  34132. <p/>
  34133. If the Sheet does not have any repeating rows defined, null is returned.
  34134. </summary>
  34135. </member>
  34136. <member name="P:NPOI.SS.UserModel.ISheet.RepeatingColumns">
  34137. <summary>
  34138. Gets or set the repeating columns used when printing the sheet, as found in File->PageSetup->Sheet.
  34139. <p/>
  34140. Repeating columns cover a range of contiguous columns, e.g.:
  34141. <pre>
  34142. Sheet1!$A:$A
  34143. Sheet2!$C:$F
  34144. </pre>
  34145. The {@link CellRangeAddress} returned contains a row part which spans all
  34146. rows, and a column part which specifies the contiguous range of
  34147. repeating columns.
  34148. <p/>
  34149. If the Sheet does not have any repeating columns defined, null is
  34150. returned.
  34151. </summary>
  34152. </member>
  34153. <member name="M:NPOI.SS.UserModel.ISheet.CopySheet(System.String)">
  34154. <summary>
  34155. Copy sheet with a new name
  34156. </summary>
  34157. <param name="Name">new sheet name</param>
  34158. <returns>cloned sheet</returns>
  34159. </member>
  34160. <member name="M:NPOI.SS.UserModel.ISheet.CopySheet(System.String,System.Boolean)">
  34161. <summary>
  34162. Copy sheet with a new name
  34163. </summary>
  34164. <param name="Name">new sheet name</param>
  34165. <param name="copyStyle">whether to copy styles</param>
  34166. <returns>cloned sheet</returns>
  34167. </member>
  34168. <member name="M:NPOI.SS.UserModel.ISheet.GetColumnOutlineLevel(System.Int32)">
  34169. <summary>
  34170. Returns the column outline level. Increased as you
  34171. put it into more groups (outlines), reduced as
  34172. you take it out of them.
  34173. </summary>
  34174. <param name="columnIndex"></param>
  34175. <returns></returns>
  34176. </member>
  34177. <member name="M:NPOI.SS.UserModel.ISheet.GetHyperlink(System.Int32,System.Int32)">
  34178. <summary>
  34179. Get a Hyperlink in this sheet anchored at row, column
  34180. </summary>
  34181. <param name="row"></param>
  34182. <param name="column"></param>
  34183. <returns>return hyperlink if there is a hyperlink anchored at row, column; otherwise returns null</returns>
  34184. </member>
  34185. <member name="M:NPOI.SS.UserModel.ISheet.GetHyperlink(NPOI.SS.Util.CellAddress)">
  34186. <summary>
  34187. Get a Hyperlink in this sheet located in a cell specified by {code addr}
  34188. </summary>
  34189. <param name="addr">The address of the cell containing the hyperlink</param>
  34190. <returns>return hyperlink if there is a hyperlink anchored at {@code addr}; otherwise returns {@code null}</returns>
  34191. </member>
  34192. <member name="M:NPOI.SS.UserModel.ISheet.GetHyperlinkList">
  34193. <summary>
  34194. Get a list of Hyperlinks in this sheet
  34195. </summary>
  34196. <returns>return Hyperlinks for the sheet</returns>
  34197. </member>
  34198. <member name="P:NPOI.SS.UserModel.ISheet.ActiveCell">
  34199. <summary>
  34200. get or set location of the active cell, e.g. <code>A1</code>.
  34201. </summary>
  34202. </member>
  34203. <member name="T:NPOI.SS.UserModel.ISheetConditionalFormatting">
  34204. The 'Conditional Formatting' facet of <c>Sheet</c>
  34205. @author Dmitriy Kumshayev
  34206. @author Yegor Kozlov
  34207. @since 3.8
  34208. </member>
  34209. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule)">
  34210. <summary>
  34211. Add a new Conditional Formatting to the sheet.
  34212. </summary>
  34213. <param name="regions">list of rectangular regions to apply conditional formatting rules</param>
  34214. <param name="rule">the rule to apply</param>
  34215. <returns>index of the newly Created Conditional Formatting object</returns>
  34216. </member>
  34217. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule,NPOI.SS.UserModel.IConditionalFormattingRule)">
  34218. <summary>
  34219. Add a new Conditional Formatting consisting of two rules.
  34220. </summary>
  34221. <param name="regions"> list of rectangular regions to apply conditional formatting rules</param>
  34222. <param name="rule1">the first rule</param>
  34223. <param name="rule2">the second rule</param>
  34224. <returns>index of the newly Created Conditional Formatting object</returns>
  34225. </member>
  34226. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule[])">
  34227. <summary>
  34228. Add a new Conditional Formatting Set to the sheet.
  34229. </summary>
  34230. <param name="regions">list of rectangular regions to apply conditional formatting rules</param>
  34231. <param name="cfRules">Set of up to three conditional formatting rules</param>
  34232. <returns>index of the newly Created Conditional Formatting object</returns>
  34233. </member>
  34234. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.UserModel.IConditionalFormatting)">
  34235. <summary>
  34236. Adds a copy of a ConditionalFormatting object to the sheet
  34237. </summary>
  34238. <param name="cf">the Conditional Formatting to clone</param>
  34239. <returns>index of the new Conditional Formatting object</returns>
  34240. <remarks>
  34241. This method could be used to copy ConditionalFormatting object
  34242. from one sheet to another. For example:
  34243. ConditionalFormatting cf = sheet.GetConditionalFormattingAt(index);
  34244. newSheet.AddConditionalFormatting(cf);
  34245. </remarks>
  34246. </member>
  34247. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.ComparisonOperator,System.String,System.String)">
  34248. A factory method allowing to create a conditional formatting rule
  34249. with a cell comparison operator
  34250. <p>
  34251. The Created conditional formatting rule Compares a cell value
  34252. to a formula calculated result, using the specified operator.
  34253. The type of the Created condition is {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS}
  34254. </p>
  34255. @param comparisonOperation - MUST be a constant value from
  34256. <c>{@link ComparisonOperator}</c>: <p>
  34257. <ul>
  34258. <li>BETWEEN</li>
  34259. <li>NOT_BETWEEN</li>
  34260. <li>EQUAL</li>
  34261. <li>NOT_EQUAL</li>
  34262. <li>GT</li>
  34263. <li>LT</li>
  34264. <li>GE</li>
  34265. <li>LE</li>
  34266. </ul>
  34267. </p>
  34268. @param formula1 - formula for the valued, Compared with the cell
  34269. @param formula2 - second formula (only used with
  34270. {@link ComparisonOperator#BETWEEN}) and {@link ComparisonOperator#NOT_BETWEEN} operations)
  34271. </member>
  34272. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.ComparisonOperator,System.String)">
  34273. <summary>
  34274. Create a conditional formatting rule that Compares a cell value to a formula calculated result, using an operator
  34275. </summary>
  34276. <param name="comparisonOperation">MUST be a constant value from ComparisonOperator except BETWEEN and NOT_BETWEEN</param>
  34277. <param name="formula">the formula to determine if the conditional formatting is applied</param>
  34278. <returns>a conditional formatting rule</returns>
  34279. </member>
  34280. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.CreateConditionalFormattingRule(System.String)">
  34281. <summary>
  34282. Create a conditional formatting rule based on a Boolean formula.
  34283. When the formula result is true, the cell is highlighted.
  34284. </summary>
  34285. <param name="formula">the formula to Evaluate. MUST be a Boolean function.</param>
  34286. <returns>conditional formatting rule</returns>
  34287. </member>
  34288. <!-- Badly formed XML comment ignored for member "M:NPOI.SS.UserModel.ISheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.ExtendedColor)" -->
  34289. <!-- Badly formed XML comment ignored for member "M:NPOI.SS.UserModel.ISheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.IconSet)" -->
  34290. <!-- Badly formed XML comment ignored for member "M:NPOI.SS.UserModel.ISheetConditionalFormatting.CreateConditionalFormattingColorScaleRule" -->
  34291. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.GetConditionalFormattingAt(System.Int32)">
  34292. <summary>
  34293. Gets Conditional Formatting object at a particular index
  34294. </summary>
  34295. <param name="index">0-based index of the Conditional Formatting object to fetch</param>
  34296. <returns>Conditional Formatting object or null if not found</returns>
  34297. <exception cref="T:System.ArgumentException">throws ArgumentException if the index is outside of the allowable range (0 ... numberOfFormats-1)</exception>
  34298. </member>
  34299. <member name="P:NPOI.SS.UserModel.ISheetConditionalFormatting.NumConditionalFormattings">
  34300. <summary>
  34301. get the number of conditional formats in this sheet
  34302. </summary>
  34303. </member>
  34304. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.RemoveConditionalFormatting(System.Int32)">
  34305. <summary>
  34306. Removes a Conditional Formatting object by index
  34307. </summary>
  34308. <param name="index">0-based index of the Conditional Formatting object to remove</param>
  34309. <exception cref="T:System.ArgumentException">throws ArgumentException if the index is outside of the allowable range (0 ... numberOfFormats-1)</exception>
  34310. </member>
  34311. <member name="F:NPOI.SS.UserModel.Table.IsStructuredReference">
  34312. Regular expression matching a Structured Reference (Table syntax) for XSSF table expressions.
  34313. Public for unit tests
  34314. @see <a href="https://support.office.com/en-us/article/Using-structured-references-with-Excel-tables-F5ED2452-2337-4F71-BED3-C8AE6D2B276E">
  34315. Excel Structured Reference Syntax
  34316. </a>
  34317. </member>
  34318. <member name="T:NPOI.SS.UserModel.ITable">
  34319. XSSF Only!
  34320. High level abstraction of table in a workbook.
  34321. </member>
  34322. <member name="P:NPOI.SS.UserModel.ITable.StartColIndex">
  34323. Get the top-left column index relative to the sheet
  34324. @return table start column index on sheet
  34325. </member>
  34326. <member name="P:NPOI.SS.UserModel.ITable.StartRowIndex">
  34327. Get the top-left row index on the sheet
  34328. @return table start row index on sheet
  34329. </member>
  34330. <member name="P:NPOI.SS.UserModel.ITable.EndColIndex">
  34331. Get the bottom-right column index on the sheet
  34332. @return table end column index on sheet
  34333. </member>
  34334. <member name="P:NPOI.SS.UserModel.ITable.EndRowIndex">
  34335. Get the bottom-right row index
  34336. @return table end row index on sheet
  34337. </member>
  34338. <member name="P:NPOI.SS.UserModel.ITable.Name">
  34339. Get the name of the table.
  34340. @return table name
  34341. </member>
  34342. <member name="M:NPOI.SS.UserModel.ITable.FindColumnIndex(System.String)">
  34343. Returns the index of a given named column in the table (names are case insensitive in XSSF).
  34344. Note this list is lazily loaded and cached for performance.
  34345. Changes to the underlying table structure are not reflected in later calls
  34346. unless <code>XSSFTable.UpdateHeaders()</code> is called to reset the cache.
  34347. @param columnHeader the column header name to Get the table column index of
  34348. @return column index corresponding to <code>columnHeader</code>
  34349. </member>
  34350. <member name="P:NPOI.SS.UserModel.ITable.SheetName">
  34351. Returns the sheet name that the table belongs to.
  34352. </member>
  34353. <member name="P:NPOI.SS.UserModel.ITable.IsHasTotalsRow">
  34354. Returns true iff the table has a 'Totals' row
  34355. </member>
  34356. <member name="T:NPOI.SS.UserModel.VerticalAlignment">
  34357. This enumeration value indicates the type of vertical alignment for a cell, i.e.,
  34358. whether it is aligned top, bottom, vertically centered, justified or distributed.
  34359. </member>
  34360. <member name="F:NPOI.SS.UserModel.VerticalAlignment.Top">
  34361. The vertical alignment is aligned-to-top.
  34362. </member>
  34363. <member name="F:NPOI.SS.UserModel.VerticalAlignment.Center">
  34364. The vertical alignment is centered across the height of the cell.
  34365. </member>
  34366. <member name="F:NPOI.SS.UserModel.VerticalAlignment.Bottom">
  34367. The vertical alignment is aligned-to-bottom.
  34368. </member>
  34369. <member name="F:NPOI.SS.UserModel.VerticalAlignment.Justify">
  34370. <p>
  34371. When text direction is horizontal: the vertical alignment of lines of text is distributed vertically,
  34372. where each line of text inside the cell is evenly distributed across the height of the cell,
  34373. with flush top and bottom margins.
  34374. </p>
  34375. <p>
  34376. When text direction is vertical: similar behavior as horizontal justification.
  34377. The alignment is justified (flush top and bottom in this case). For each line of text, each
  34378. line of the wrapped text in a cell is aligned to the top and bottom (except the last line).
  34379. If no single line of text wraps in the cell, then the text is not justified.
  34380. </p>
  34381. </member>
  34382. <member name="F:NPOI.SS.UserModel.VerticalAlignment.Distributed">
  34383. <p>
  34384. When text direction is horizontal: the vertical alignment of lines of text is distributed vertically,
  34385. where each line of text inside the cell is evenly distributed across the height of the cell,
  34386. with flush top
  34387. </p>
  34388. <p>
  34389. When text direction is vertical: behaves exactly as distributed horizontal alignment.
  34390. The first words in a line of text (appearing at the top of the cell) are flush
  34391. 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,
  34392. and the line of text is distributed evenly from top to bottom.
  34393. </p>
  34394. </member>
  34395. <member name="F:NPOI.SS.UserModel.SheetState.Visible">
  34396. <summary>
  34397. Indicates the sheet is visible.
  34398. </summary>
  34399. </member>
  34400. <member name="F:NPOI.SS.UserModel.SheetState.Hidden">
  34401. <summary>
  34402. Indicates the book window is hidden, but can be shown by the user via the user interface.
  34403. </summary>
  34404. </member>
  34405. <member name="F:NPOI.SS.UserModel.SheetState.VeryHidden">
  34406. <summary>
  34407. Indicates the sheet is hidden and cannot be shown in the user interface (UI).
  34408. </summary>
  34409. <remarks>
  34410. In Excel this state is only available programmatically in VBA:
  34411. ThisWorkbook.Sheets("MySheetName").Visible = xlSheetVeryHidden
  34412. </remarks>
  34413. </member>
  34414. <member name="T:NPOI.SS.UserModel.IWorkbook">
  34415. <summary>
  34416. High level interface of a Excel workbook. This is the first object most users
  34417. will construct whether they are reading or writing a workbook. It is also the
  34418. top level object for creating new sheets/etc.
  34419. This interface is shared between the implementation specific to xls and xlsx.
  34420. This way it is possible to access Excel workbooks stored in both formats.
  34421. </summary>
  34422. </member>
  34423. <member name="P:NPOI.SS.UserModel.IWorkbook.ActiveSheetIndex">
  34424. <summary>
  34425. get the active sheet. The active sheet is is the sheet
  34426. which is currently displayed when the workbook is viewed in Excel.
  34427. </summary>
  34428. </member>
  34429. <member name="P:NPOI.SS.UserModel.IWorkbook.FirstVisibleTab">
  34430. <summary>
  34431. Gets the first tab that is displayed in the list of tabs in excel.
  34432. </summary>
  34433. </member>
  34434. <member name="M:NPOI.SS.UserModel.IWorkbook.SetSheetOrder(System.String,System.Int32)">
  34435. <summary>
  34436. Sets the order of appearance for a given sheet.
  34437. </summary>
  34438. <param name="sheetname">the name of the sheet to reorder</param>
  34439. <param name="pos">the position that we want to insert the sheet into (0 based)</param>
  34440. </member>
  34441. <member name="M:NPOI.SS.UserModel.IWorkbook.SetSelectedTab(System.Int32)">
  34442. <summary>
  34443. Sets the tab whose data is actually seen when the sheet is opened.
  34444. This may be different from the "selected sheet" since excel seems to
  34445. allow you to show the data of one sheet when another is seen "selected"
  34446. in the tabs (at the bottom).
  34447. </summary>
  34448. <param name="index">the index of the sheet to select (0 based)</param>
  34449. </member>
  34450. <member name="M:NPOI.SS.UserModel.IWorkbook.SetActiveSheet(System.Int32)">
  34451. <summary>
  34452. set the active sheet. The active sheet is is the sheet
  34453. which is currently displayed when the workbook is viewed in Excel.
  34454. </summary>
  34455. <param name="sheetIndex">index of the active sheet (0-based)</param>
  34456. </member>
  34457. <member name="M:NPOI.SS.UserModel.IWorkbook.GetSheetName(System.Int32)">
  34458. <summary>
  34459. Set the sheet name
  34460. </summary>
  34461. <param name="sheet">sheet number (0 based)</param>
  34462. <returns>Sheet name</returns>
  34463. </member>
  34464. <member name="M:NPOI.SS.UserModel.IWorkbook.SetSheetName(System.Int32,System.String)">
  34465. <summary>
  34466. Set the sheet name.
  34467. </summary>
  34468. <param name="sheet">sheet number (0 based)</param>
  34469. <param name="name">sheet name</param>
  34470. </member>
  34471. <member name="M:NPOI.SS.UserModel.IWorkbook.GetSheetIndex(System.String)">
  34472. <summary>
  34473. Returns the index of the sheet by its name
  34474. </summary>
  34475. <param name="name">the sheet name</param>
  34476. <returns>index of the sheet (0 based)</returns>
  34477. </member>
  34478. <member name="M:NPOI.SS.UserModel.IWorkbook.GetSheetIndex(NPOI.SS.UserModel.ISheet)">
  34479. <summary>
  34480. Returns the index of the given sheet
  34481. </summary>
  34482. <param name="sheet">the sheet to look up</param>
  34483. <returns>index of the sheet (0 based)</returns>
  34484. </member>
  34485. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateSheet">
  34486. <summary>
  34487. Sreate an Sheet for this Workbook, Adds it to the sheets and returns
  34488. the high level representation. Use this to create new sheets.
  34489. </summary>
  34490. <returns></returns>
  34491. </member>
  34492. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateSheet(System.String)">
  34493. <summary>
  34494. Create an Sheet for this Workbook, Adds it to the sheets and returns
  34495. the high level representation. Use this to create new sheets.
  34496. </summary>
  34497. <param name="sheetname">sheetname to set for the sheet.</param>
  34498. <returns>Sheet representing the new sheet.</returns>
  34499. </member>
  34500. <member name="M:NPOI.SS.UserModel.IWorkbook.CloneSheet(System.Int32)">
  34501. <summary>
  34502. Create an Sheet from an existing sheet in the Workbook.
  34503. </summary>
  34504. <param name="sheetNum"></param>
  34505. <returns></returns>
  34506. </member>
  34507. <member name="P:NPOI.SS.UserModel.IWorkbook.NumberOfSheets">
  34508. <summary>
  34509. Get the number of spreadsheets in the workbook
  34510. </summary>
  34511. </member>
  34512. <member name="M:NPOI.SS.UserModel.IWorkbook.GetSheetAt(System.Int32)">
  34513. <summary>
  34514. Get the Sheet object at the given index.
  34515. </summary>
  34516. <param name="index">index of the sheet number (0-based physical &amp; logical)</param>
  34517. <returns>Sheet at the provided index</returns>
  34518. </member>
  34519. <member name="M:NPOI.SS.UserModel.IWorkbook.GetSheet(System.String)">
  34520. <summary>
  34521. Get sheet with the given name
  34522. </summary>
  34523. <param name="name">name of the sheet</param>
  34524. <returns>Sheet with the name provided or null if it does not exist</returns>
  34525. </member>
  34526. <member name="M:NPOI.SS.UserModel.IWorkbook.RemoveSheetAt(System.Int32)">
  34527. <summary>
  34528. Removes sheet at the given index
  34529. </summary>
  34530. <param name="index"></param>
  34531. </member>
  34532. <member name="M:NPOI.SS.UserModel.IWorkbook.GetEnumerator">
  34533. <summary>
  34534. Enumerate sheets
  34535. </summary>
  34536. <returns></returns>
  34537. </member>
  34538. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateFont">
  34539. <summary>
  34540. Create a new Font and add it to the workbook's font table
  34541. </summary>
  34542. <returns></returns>
  34543. </member>
  34544. <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)">
  34545. <summary>
  34546. Finds a font that matches the one with the supplied attributes
  34547. </summary>
  34548. <param name="boldWeight"></param>
  34549. <param name="color"></param>
  34550. <param name="fontHeight"></param>
  34551. <param name="name"></param>
  34552. <param name="italic"></param>
  34553. <param name="strikeout"></param>
  34554. <param name="typeOffset"></param>
  34555. <param name="underline"></param>
  34556. <returns>the font with the matched attributes or null</returns>
  34557. </member>
  34558. <member name="M:NPOI.SS.UserModel.IWorkbook.FindFont(System.Boolean,System.Int16,System.Int16,System.String,System.Boolean,System.Boolean,NPOI.SS.UserModel.FontSuperScript,NPOI.SS.UserModel.FontUnderlineType)">
  34559. <summary>
  34560. Finds a font that matches the one with the supplied attributes
  34561. </summary>
  34562. <param name="bold"></param>
  34563. <param name="color"></param>
  34564. <param name="fontHeight"></param>
  34565. <param name="name"></param>
  34566. <param name="italic"></param>
  34567. <param name="strikeout"></param>
  34568. <param name="typeOffset"></param>
  34569. <param name="underline"></param>
  34570. <returns>the font with the matched attributes or null</returns>
  34571. </member>
  34572. <member name="P:NPOI.SS.UserModel.IWorkbook.NumberOfFonts">
  34573. <summary>
  34574. Get the number of fonts in the font table
  34575. </summary>
  34576. </member>
  34577. <member name="M:NPOI.SS.UserModel.IWorkbook.GetFontAt(System.Int16)">
  34578. <summary>
  34579. Get the font at the given index number
  34580. </summary>
  34581. <param name="idx">index number (0-based)</param>
  34582. <returns>font at the index</returns>
  34583. </member>
  34584. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateCellStyle">
  34585. <summary>
  34586. Create a new Cell style and add it to the workbook's style table
  34587. </summary>
  34588. <returns>the new Cell Style object</returns>
  34589. </member>
  34590. <member name="P:NPOI.SS.UserModel.IWorkbook.NumCellStyles">
  34591. <summary>
  34592. Get the number of styles the workbook Contains
  34593. </summary>
  34594. </member>
  34595. <member name="M:NPOI.SS.UserModel.IWorkbook.GetCellStyleAt(System.Int32)">
  34596. <summary>
  34597. Get the cell style object at the given index
  34598. </summary>
  34599. <param name="idx">index within the set of styles (0-based)</param>
  34600. <returns>CellStyle object at the index</returns>
  34601. </member>
  34602. <member name="M:NPOI.SS.UserModel.IWorkbook.Write(System.IO.Stream)">
  34603. <summary>
  34604. Write out this workbook to an OutPutstream.
  34605. </summary>
  34606. <param name="stream">the stream you wish to write to</param>
  34607. </member>
  34608. <member name="P:NPOI.SS.UserModel.IWorkbook.NumberOfNames">
  34609. <summary>
  34610. the total number of defined names in this workbook
  34611. </summary>
  34612. </member>
  34613. <member name="M:NPOI.SS.UserModel.IWorkbook.GetName(System.String)">
  34614. <summary>
  34615. the defined name with the specified name.
  34616. </summary>
  34617. <param name="name">the name of the defined name</param>
  34618. <returns>the defined name with the specified name. null if not found</returns>
  34619. </member>
  34620. <member name="M:NPOI.SS.UserModel.IWorkbook.GetNames(System.String)">
  34621. <summary>
  34622. Returns all defined names with the given name.
  34623. </summary>
  34624. <param name="name">the name of the defined name</param>
  34625. <returns>a list of the defined names with the specified name. An empty list is returned if none is found.</returns>
  34626. </member>
  34627. <member name="M:NPOI.SS.UserModel.IWorkbook.GetAllNames">
  34628. <summary>
  34629. Returns all defined names.
  34630. </summary>
  34631. <returns>a list of the defined names. An empty list is returned if none is found.</returns>
  34632. </member>
  34633. <member name="M:NPOI.SS.UserModel.IWorkbook.GetNameAt(System.Int32)">
  34634. <summary>
  34635. the defined name at the specified index
  34636. </summary>
  34637. <param name="nameIndex">position of the named range (0-based)</param>
  34638. <returns></returns>
  34639. </member>
  34640. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateName">
  34641. <summary>
  34642. Creates a new (unInitialised) defined name in this workbook
  34643. </summary>
  34644. <returns>new defined name object</returns>
  34645. </member>
  34646. <member name="M:NPOI.SS.UserModel.IWorkbook.GetNameIndex(System.String)">
  34647. <summary>
  34648. Gets the defined name index by name
  34649. </summary>
  34650. <param name="name">the name of the defined name</param>
  34651. <returns>zero based index of the defined name.</returns>
  34652. </member>
  34653. <member name="M:NPOI.SS.UserModel.IWorkbook.RemoveName(System.Int32)">
  34654. <summary>
  34655. Remove the defined name at the specified index
  34656. </summary>
  34657. <param name="index">named range index (0 based)</param>
  34658. </member>
  34659. <member name="M:NPOI.SS.UserModel.IWorkbook.RemoveName(System.String)">
  34660. <summary>
  34661. Remove a defined name by name
  34662. </summary>
  34663. <param name="name">the name of the defined name</param>
  34664. </member>
  34665. <member name="M:NPOI.SS.UserModel.IWorkbook.RemoveName(NPOI.SS.UserModel.IName)">
  34666. <summary>
  34667. Remove a defined name
  34668. </summary>
  34669. <param name="name">the name of the defined name</param>
  34670. </member>
  34671. <member name="M:NPOI.SS.UserModel.IWorkbook.LinkExternalWorkbook(System.String,NPOI.SS.UserModel.IWorkbook)">
  34672. <summary>
  34673. Adds the linking required to allow formulas referencing the specified
  34674. external workbook to be added to this one. In order for formulas
  34675. such as "[MyOtherWorkbook]Sheet3!$A$5" to be added to the file,
  34676. some linking information must first be recorded. Once a given external
  34677. workbook has been linked, then formulas using it can added. Each workbook
  34678. needs linking only once. <br/>
  34679. This linking only applies for writing formulas.
  34680. To link things for evaluation, see {@link FormulaEvaluator#setupReferencedWorkbooks(java.util.Map)}
  34681. </summary>
  34682. <param name="name">The name the workbook will be referenced as in formulas</param>
  34683. <param name="workbook">The open workbook to fetch the link required information from</param>
  34684. <returns></returns>
  34685. </member>
  34686. <member name="M:NPOI.SS.UserModel.IWorkbook.SetPrintArea(System.Int32,System.String)">
  34687. <summary>
  34688. Sets the printarea for the sheet provided
  34689. </summary>
  34690. <param name="sheetIndex">Zero-based sheet index</param>
  34691. <param name="reference">Valid name Reference for the Print Area</param>
  34692. </member>
  34693. <member name="M:NPOI.SS.UserModel.IWorkbook.SetPrintArea(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  34694. <summary>
  34695. Sets the printarea for the sheet provided
  34696. </summary>
  34697. <param name="sheetIndex">Zero-based sheet index (0 = First Sheet)</param>
  34698. <param name="startColumn">Column to begin printarea</param>
  34699. <param name="endColumn">Column to end the printarea</param>
  34700. <param name="startRow">Row to begin the printarea</param>
  34701. <param name="endRow">Row to end the printarea</param>
  34702. </member>
  34703. <member name="M:NPOI.SS.UserModel.IWorkbook.GetPrintArea(System.Int32)">
  34704. <summary>
  34705. Retrieves the reference for the printarea of the specified sheet,
  34706. the sheet name is Appended to the reference even if it was not specified.
  34707. </summary>
  34708. <param name="sheetIndex">Zero-based sheet index</param>
  34709. <returns>Null if no print area has been defined</returns>
  34710. </member>
  34711. <member name="M:NPOI.SS.UserModel.IWorkbook.RemovePrintArea(System.Int32)">
  34712. <summary>
  34713. Delete the printarea for the sheet specified
  34714. </summary>
  34715. <param name="sheetIndex">Zero-based sheet index (0 = First Sheet)</param>
  34716. </member>
  34717. <member name="P:NPOI.SS.UserModel.IWorkbook.MissingCellPolicy">
  34718. <summary>
  34719. Retrieves the current policy on what to do when getting missing or blank cells from a row.
  34720. </summary>
  34721. </member>
  34722. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateDataFormat">
  34723. <summary>
  34724. Returns the instance of DataFormat for this workbook.
  34725. </summary>
  34726. <returns>the DataFormat object</returns>
  34727. </member>
  34728. <member name="M:NPOI.SS.UserModel.IWorkbook.AddPicture(System.Byte[],NPOI.SS.UserModel.PictureType)">
  34729. <summary>
  34730. Adds a picture to the workbook.
  34731. </summary>
  34732. <param name="pictureData">The bytes of the picture</param>
  34733. <param name="format">The format of the picture.</param>
  34734. <returns>the index to this picture (1 based).</returns>
  34735. </member>
  34736. <member name="M:NPOI.SS.UserModel.IWorkbook.GetAllPictures">
  34737. <summary>
  34738. Gets all pictures from the Workbook.
  34739. </summary>
  34740. <returns>the list of pictures (a list of link PictureData objects.)</returns>
  34741. </member>
  34742. <member name="M:NPOI.SS.UserModel.IWorkbook.GetCreationHelper">
  34743. <summary>
  34744. Return an object that handles instantiating concrete classes of
  34745. the various instances one needs for HSSF and XSSF.
  34746. </summary>
  34747. <returns></returns>
  34748. </member>
  34749. <member name="P:NPOI.SS.UserModel.IWorkbook.IsHidden">
  34750. <summary>
  34751. if this workbook is not visible in the GUI
  34752. </summary>
  34753. </member>
  34754. <member name="M:NPOI.SS.UserModel.IWorkbook.IsSheetHidden(System.Int32)">
  34755. <summary>
  34756. Check whether a sheet is hidden.
  34757. </summary>
  34758. <param name="sheetIx">number of sheet</param>
  34759. <returns>true if sheet is hidden</returns>
  34760. </member>
  34761. <member name="M:NPOI.SS.UserModel.IWorkbook.IsSheetVeryHidden(System.Int32)">
  34762. Check whether a sheet is very hidden.
  34763. <p>
  34764. This is different from the normal hidden status
  34765. ({@link #isSheetHidden(int)})
  34766. </p>
  34767. @param sheetIx sheet index to check
  34768. @return <code>true</code> if sheet is very hidden
  34769. </member>
  34770. <member name="M:NPOI.SS.UserModel.IWorkbook.SetSheetHidden(System.Int32,NPOI.SS.UserModel.SheetState)">
  34771. Hide or unhide a sheet
  34772. @param sheetIx the sheet index (0-based)
  34773. @param hidden True to mark the sheet as hidden, false otherwise
  34774. </member>
  34775. <member name="M:NPOI.SS.UserModel.IWorkbook.SetSheetHidden(System.Int32,System.Int32)">
  34776. Hide or unhide a sheet.
  34777. <pre>
  34778. 0 = not hidden
  34779. 1 = hidden
  34780. 2 = very hidden.
  34781. </pre>
  34782. @param sheetIx The sheet number
  34783. @param hidden 0 for not hidden, 1 for hidden, 2 for very hidden
  34784. </member>
  34785. <member name="M:NPOI.SS.UserModel.IWorkbook.AddToolPack(NPOI.SS.Formula.UDF.UDFFinder)">
  34786. <summary>
  34787. Register a new toolpack in this workbook.
  34788. </summary>
  34789. <param name="toopack">the toolpack to register</param>
  34790. </member>
  34791. <member name="M:NPOI.SS.UserModel.IWorkbook.IsDate1904">
  34792. <summary>
  34793. Gets a bool value that indicates whether the date systems used in the workbook starts in 1904.
  34794. The default value is false, meaning that the workbook uses the 1900 date system,
  34795. where 1/1/1900 is the first day in the system.
  34796. </summary>
  34797. <returns>True if the date systems used in the workbook starts in 1904</returns>
  34798. </member>
  34799. <member name="P:NPOI.SS.UserModel.IWorkbook.SpreadsheetVersion">
  34800. <summary>
  34801. Returns the spreadsheet version (EXCLE97) of this workbook
  34802. </summary>
  34803. </member>
  34804. <member name="F:NPOI.SS.Util.AreaReference.SHEET_NAME_DELIMITER">
  34805. The Char (!) that Separates sheet names from cell references
  34806. </member>
  34807. <member name="F:NPOI.SS.Util.AreaReference.CELL_DELIMITER">
  34808. The Char (:) that Separates the two cell references in a multi-cell area reference
  34809. </member>
  34810. <member name="F:NPOI.SS.Util.AreaReference.SPECIAL_NAME_DELIMITER">
  34811. The Char (') used to quote sheet names when they contain special Chars
  34812. </member>
  34813. <member name="M:NPOI.SS.Util.AreaReference.#ctor(System.String,NPOI.SS.SpreadsheetVersion)">
  34814. Create an area ref from a string representation. Sheet names containing special Chars should be
  34815. delimited and escaped as per normal syntax rules for formulas.<br/>
  34816. The area reference must be contiguous (i.e. represent a single rectangle, not a Union of rectangles)
  34817. </member>
  34818. <member name="M:NPOI.SS.Util.AreaReference.#ctor(NPOI.SS.Util.CellReference,NPOI.SS.Util.CellReference)">
  34819. Creates an area ref from a pair of Cell References.
  34820. </member>
  34821. <member name="M:NPOI.SS.Util.AreaReference.IsContiguous(System.String)">
  34822. is the reference for a contiguous (i.e.
  34823. Unbroken) area, or is it made up of
  34824. several different parts?
  34825. (If it Is, you will need to call
  34826. ....
  34827. </member>
  34828. <member name="M:NPOI.SS.Util.AreaReference.IsWholeColumnReference(NPOI.SS.SpreadsheetVersion,NPOI.SS.Util.CellReference,NPOI.SS.Util.CellReference)">
  34829. is the reference for a whole-column reference,
  34830. such as C:C or D:G ?
  34831. </member>
  34832. <member name="M:NPOI.SS.Util.AreaReference.GenerateContiguous(System.String)">
  34833. Takes a non-contiguous area reference, and
  34834. returns an array of contiguous area references.
  34835. </member>
  34836. <member name="P:NPOI.SS.Util.AreaReference.IsSingleCell">
  34837. @return <c>false</c> if this area reference involves more than one cell
  34838. </member>
  34839. <member name="P:NPOI.SS.Util.AreaReference.FirstCell">
  34840. @return the first cell reference which defines this area. Usually this cell is in the upper
  34841. left corner of the area (but this is not a requirement).
  34842. </member>
  34843. <member name="P:NPOI.SS.Util.AreaReference.LastCell">
  34844. Note - if this area reference refers to a single cell, the return value of this method will
  34845. be identical to that of <c>GetFirstCell()</c>
  34846. @return the second cell reference which defines this area. For multi-cell areas, this is
  34847. cell diagonally opposite the 'first cell'. Usually this cell is in the lower right corner
  34848. of the area (but this is not a requirement).
  34849. </member>
  34850. <member name="M:NPOI.SS.Util.AreaReference.GetAllReferencedCells">
  34851. Returns a reference to every cell covered by this area
  34852. </member>
  34853. <member name="M:NPOI.SS.Util.AreaReference.FormatAsString">
  34854. Example return values:
  34855. <table border="0" cellpAdding="1" cellspacing="0" summary="Example return values">
  34856. <tr><th align='left'>Result</th><th align='left'>Comment</th></tr>
  34857. <tr><td>A1:A1</td><td>Single cell area reference without sheet</td></tr>
  34858. <tr><td>A1:$C$1</td><td>Multi-cell area reference without sheet</td></tr>
  34859. <tr><td>Sheet1!A$1:B4</td><td>Standard sheet name</td></tr>
  34860. <tr><td>'O''Brien''s Sales'!B5:C6' </td><td>Sheet name with special Chars</td></tr>
  34861. </table>
  34862. @return the text representation of this area reference as it would appear in a formula.
  34863. </member>
  34864. <member name="M:NPOI.SS.Util.AreaReference.SeparateAreaRefs(System.String)">
  34865. Separates Area refs in two parts and returns them as Separate elements in a String array,
  34866. each qualified with the sheet name (if present)
  34867. @return array with one or two elements. never <c>null</c>
  34868. </member>
  34869. <member name="T:NPOI.SS.Util.CellAddress">
  34870. <p>This class is a Container for POI usermodel row=0 column=0 cell references.
  34871. It is barely a Container for these two coordinates. The implementation
  34872. of the Comparable interface sorts by "natural" order top left to bottom right.</p>
  34873. <p>Use <tt>CellAddress</tt> when you want to refer to the location of a cell in a sheet
  34874. when the concept of relative/absolute does not apply (such as the anchor location
  34875. of a cell comment). Use {@link CellReference} when the concept of
  34876. relative/absolute does apply (such as a cell reference in a formula).
  34877. <tt>CellAddress</tt>es do not have a concept of "sheet", while <tt>CellReference</tt>s do.</p>
  34878. </member>
  34879. <member name="F:NPOI.SS.Util.CellAddress.A1">
  34880. A constant for references to the first cell in a sheet.
  34881. </member>
  34882. <member name="M:NPOI.SS.Util.CellAddress.#ctor(System.Int32,System.Int32)">
  34883. Create a new CellAddress object.
  34884. @param row Row index (first row is 0)
  34885. @param column Column index (first column is 0)
  34886. </member>
  34887. <member name="M:NPOI.SS.Util.CellAddress.#ctor(System.String)">
  34888. Create a new CellAddress object.
  34889. @param Address a cell Address in A1 format. Address may not contain sheet name or dollar signs.
  34890. (that is, Address is not a cell reference. Use {@link #CellAddress(CellReference)} instead if
  34891. starting with a cell reference.)
  34892. </member>
  34893. <member name="M:NPOI.SS.Util.CellAddress.#ctor(NPOI.SS.Util.CellReference)">
  34894. Create a new CellAddress object.
  34895. @param reference a reference to a cell
  34896. </member>
  34897. <member name="M:NPOI.SS.Util.CellAddress.#ctor(NPOI.SS.UserModel.ICell)">
  34898. Create a new CellAddress object.
  34899. @param cell the Cell to Get the location of
  34900. </member>
  34901. <member name="P:NPOI.SS.Util.CellAddress.Row">
  34902. Get the cell Address row
  34903. @return row
  34904. </member>
  34905. <member name="P:NPOI.SS.Util.CellAddress.Column">
  34906. Get the cell Address column
  34907. @return column
  34908. </member>
  34909. <member name="M:NPOI.SS.Util.CellAddress.CompareTo(NPOI.SS.Util.CellAddress)">
  34910. Compare this CellAddress using the "natural" row-major, column-minor ordering.
  34911. That is, top-left to bottom-right ordering.
  34912. @param other
  34913. @return <ul>
  34914. <li>-1 if this CellAddress is before (above/left) of other</li>
  34915. <li>0 if Addresses are the same</li>
  34916. <li>1 if this CellAddress is After (below/right) of other</li>
  34917. </ul>
  34918. </member>
  34919. <member name="M:NPOI.SS.Util.CellAddress.FormatAsString">
  34920. Same as {@link #ToString()}
  34921. @return A1-style cell Address string representation
  34922. </member>
  34923. <member name="M:NPOI.SS.Util.CellRangeAddress.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
  34924. Creates new cell range. Indexes are zero-based.
  34925. @param firstRow Index of first row
  34926. @param lastRow Index of last row (inclusive), must be equal to or larger than {@code firstRow}
  34927. @param firstCol Index of first column
  34928. @param lastCol Index of last column (inclusive), must be equal to or larger than {@code firstCol}
  34929. </member>
  34930. <member name="M:NPOI.SS.Util.CellRangeAddress.FormatAsString(System.String,System.Boolean)">
  34931. @return the text format of this range using specified sheet name.
  34932. </member>
  34933. <member name="M:NPOI.SS.Util.CellRangeAddress.ValueOf(System.String)">
  34934. <summary>
  34935. Creates a CellRangeAddress from a cell range reference string.
  34936. </summary>
  34937. <param name="reference">
  34938. usually a standard area ref (e.g. "B1:D8"). May be a single
  34939. cell ref (e.g. "B5") in which case the result is a 1 x 1 cell
  34940. range. May also be a whole row range (e.g. "3:5"), or a whole
  34941. column range (e.g. "C:F")
  34942. </param>
  34943. <returns>a CellRangeAddress object</returns>
  34944. </member>
  34945. <member name="T:NPOI.SS.Util.CellRangeAddressBase">
  34946. See OOO documentation: excelfileformat.pdf sec 2.5.14 - 'Cell Range Address'<p/>
  34947. Common subclass of 8-bit and 16-bit versions
  34948. @author Josh Micich
  34949. </member>
  34950. <member name="M:NPOI.SS.Util.CellRangeAddressBase.Validate(NPOI.SS.SpreadsheetVersion)">
  34951. Validate the range limits against the supplied version of Excel
  34952. @param ssVersion the version of Excel to validate against
  34953. @throws IllegalArgumentException if the range limits are outside of the allowed range
  34954. </member>
  34955. <member name="M:NPOI.SS.Util.CellRangeAddressBase.ValidateRow(System.Int32,NPOI.SS.SpreadsheetVersion)">
  34956. Runs a bounds check for row numbers
  34957. @param row
  34958. </member>
  34959. <member name="M:NPOI.SS.Util.CellRangeAddressBase.ValidateColumn(System.Int32,NPOI.SS.SpreadsheetVersion)">
  34960. Runs a bounds check for column numbers
  34961. @param column
  34962. </member>
  34963. <member name="M:NPOI.SS.Util.CellRangeAddressBase.ContainsRow(System.Int32)">
  34964. Check if the row is in the specified cell range
  34965. @param rowInd the row to check
  34966. @return true if the range contains the row [rowInd]
  34967. </member>
  34968. <member name="M:NPOI.SS.Util.CellRangeAddressBase.ContainsColumn(System.Int32)">
  34969. Check if the column is in the specified cell range
  34970. @param colInd the column to check
  34971. @return true if the range contains the column [colInd]
  34972. </member>
  34973. <member name="M:NPOI.SS.Util.CellRangeAddressBase.Intersects(NPOI.SS.Util.CellRangeAddressBase)">
  34974. <summary>
  34975. Determines whether or not this CellRangeAddress and the specified CellRangeAddress intersect.
  34976. </summary>
  34977. <param name="other">a candidate cell range address to check for intersection with this range</param>
  34978. <returns>returns true if this range and other range have at least 1 cell in common</returns>
  34979. </member>
  34980. <member name="P:NPOI.SS.Util.CellRangeAddressBase.FirstColumn">
  34981. @return column number for the upper left hand corner
  34982. </member>
  34983. <member name="P:NPOI.SS.Util.CellRangeAddressBase.FirstRow">
  34984. @return row number for the upper left hand corner
  34985. </member>
  34986. <member name="P:NPOI.SS.Util.CellRangeAddressBase.LastColumn">
  34987. @return column number for the lower right hand corner
  34988. </member>
  34989. <member name="P:NPOI.SS.Util.CellRangeAddressBase.LastRow">
  34990. @return row number for the lower right hand corner
  34991. </member>
  34992. <member name="P:NPOI.SS.Util.CellRangeAddressBase.NumberOfCells">
  34993. @return the size of the range (number of cells in the area).
  34994. </member>
  34995. <member name="F:NPOI.SS.Util.CellRangeAddressList._list">
  34996. List of <c>CellRangeAddress</c>es. Each structure represents a cell range
  34997. </member>
  34998. <member name="M:NPOI.SS.Util.CellRangeAddressList.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
  34999. Convenience constructor for creating a <c>CellRangeAddressList</c> with a single
  35000. <c>CellRangeAddress</c>. Other <c>CellRangeAddress</c>es may be Added later.
  35001. </member>
  35002. <member name="M:NPOI.SS.Util.CellRangeAddressList.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  35003. @param in the RecordInputstream to read the record from
  35004. </member>
  35005. <member name="M:NPOI.SS.Util.CellRangeAddressList.CountRanges">
  35006. Get the number of following ADDR structures. The number of this
  35007. structures is automatically set when reading an Excel file and/or
  35008. increased when you manually Add a new ADDR structure . This is the reason
  35009. there isn't a set method for this field .
  35010. @return number of ADDR structures
  35011. </member>
  35012. <member name="M:NPOI.SS.Util.CellRangeAddressList.AddCellRangeAddress(System.Int32,System.Int32,System.Int32,System.Int32)">
  35013. Add a cell range structure.
  35014. @param firstRow - the upper left hand corner's row
  35015. @param firstCol - the upper left hand corner's col
  35016. @param lastRow - the lower right hand corner's row
  35017. @param lastCol - the lower right hand corner's col
  35018. @return the index of this ADDR structure
  35019. </member>
  35020. <member name="M:NPOI.SS.Util.CellRangeAddressList.GetCellRangeAddress(System.Int32)">
  35021. @return <c>CellRangeAddress</c> at the given index
  35022. </member>
  35023. <member name="M:NPOI.SS.Util.CellRangeAddressList.GetEncodedSize(System.Int32)">
  35024. @return the total size of for the specified number of ranges,
  35025. including the initial 2 byte range count
  35026. </member>
  35027. <member name="T:NPOI.SS.Util.CellRangeUtil">
  35028. Utility class that builds on {@link CellRangeAddress}
  35029. Portions of this class may be moved to {@link CellRangeAddressBase}
  35030. </member>
  35031. <member name="F:NPOI.SS.Util.CellRangeUtil.INSIDE">
  35032. first range is within the second range
  35033. </member>
  35034. <member name="F:NPOI.SS.Util.CellRangeUtil.ENCLOSES">
  35035. first range encloses or is equal to the second
  35036. </member>
  35037. <member name="M:NPOI.SS.Util.CellRangeUtil.Intersect(NPOI.SS.Util.CellRangeAddress,NPOI.SS.Util.CellRangeAddress)">
  35038. Get the type of intersection between two cell ranges
  35039. @param crB - the specified range
  35040. @return code which reflects how the specified range is related to this range.<br/>
  35041. Possible return codes are:
  35042. NO_INTERSECTION - the specified range is outside of this range;<br/>
  35043. OVERLAP - both ranges partially overlap;<br/>
  35044. INSIDE - the specified range is inside of this one<br/>
  35045. ENCLOSES - the specified range encloses (possibly exactly the same as) this range<br/>
  35046. </member>
  35047. <member name="M:NPOI.SS.Util.CellRangeUtil.MergeCellRanges(NPOI.SS.Util.CellRangeAddress[])">
  35048. Do all possible cell merges between cells of the list so that:
  35049. if a cell range is completely inside of another cell range, it s removed from the list
  35050. if two cells have a shared border, merge them into one bigger cell range
  35051. @param cellRangeList
  35052. @return updated List of cell ranges
  35053. </member>
  35054. <member name="M:NPOI.SS.Util.CellRangeUtil.MergeRanges(NPOI.SS.Util.CellRangeAddress,NPOI.SS.Util.CellRangeAddress)">
  35055. @return the new range(s) to replace the supplied ones. <c>null</c> if no merge is possible
  35056. </member>
  35057. <member name="M:NPOI.SS.Util.CellRangeUtil.ToArray(System.Collections.ArrayList)">
  35058. **
  35059. </member>
  35060. <member name="M:NPOI.SS.Util.CellRangeUtil.Contains(NPOI.SS.Util.CellRangeAddress,NPOI.SS.Util.CellRangeAddress)">
  35061. Check if the specified range is located inside of this cell range.
  35062. @param crB
  35063. @return true if this cell range Contains the argument range inside if it's area
  35064. </member>
  35065. <member name="M:NPOI.SS.Util.CellRangeUtil.HasExactSharedBorder(NPOI.SS.Util.CellRangeAddress,NPOI.SS.Util.CellRangeAddress)">
  35066. Check if the specified cell range has a shared border with the current range.
  35067. @return <c>true</c> if the ranges have a complete shared border (i.e.
  35068. the two ranges toher make a simple rectangular region.
  35069. </member>
  35070. <member name="M:NPOI.SS.Util.CellRangeUtil.CreateEnclosingCellRange(NPOI.SS.Util.CellRangeAddress,NPOI.SS.Util.CellRangeAddress)">
  35071. Create an enclosing CellRange for the two cell ranges.
  35072. @return enclosing CellRange
  35073. </member>
  35074. <member name="M:NPOI.SS.Util.CellRangeUtil.lt(System.Int32,System.Int32)">
  35075. @return true if a &lt; b
  35076. </member>
  35077. <member name="M:NPOI.SS.Util.CellRangeUtil.le(System.Int32,System.Int32)">
  35078. @return true if a &lt;= b
  35079. </member>
  35080. <member name="M:NPOI.SS.Util.CellRangeUtil.gt(System.Int32,System.Int32)">
  35081. @return true if a > b
  35082. </member>
  35083. <member name="M:NPOI.SS.Util.CellRangeUtil.ge(System.Int32,System.Int32)">
  35084. @return true if a >= b
  35085. </member>
  35086. <member name="F:NPOI.SS.Util.NameType.None">
  35087. <summary>
  35088. Allow accessing the Initial value.
  35089. </summary>
  35090. </member>
  35091. <member name="T:NPOI.SS.Util.CellReference">
  35092. <p>Common conversion functions between Excel style A1, C27 style
  35093. cell references, and POI usermodel style row=0, column=0
  35094. style references. Handles sheet-based and sheet-free references
  35095. as well, eg "Sheet1!A1" and "$B$72"</p>
  35096. <p>Use <tt>CellReference</tt> when the concept of
  35097. relative/absolute does apply (such as a cell reference in a formula).
  35098. Use {@link CellAddress} when you want to refer to the location of a cell in a sheet
  35099. when the concept of relative/absolute does not apply (such as the anchor location
  35100. of a cell comment).
  35101. <tt>CellReference</tt>s have a concept of "sheet", while <tt>CellAddress</tt>es do not.</p>
  35102. </member>
  35103. <member name="F:NPOI.SS.Util.CellReference.ABSOLUTE_REFERENCE_MARKER">
  35104. The character ($) that signifies a row or column value is absolute instead of relative
  35105. </member>
  35106. <member name="F:NPOI.SS.Util.CellReference.SHEET_NAME_DELIMITER">
  35107. The character (!) that Separates sheet names from cell references
  35108. </member>
  35109. <member name="F:NPOI.SS.Util.CellReference.SPECIAL_NAME_DELIMITER">
  35110. The character (') used to quote sheet names when they contain special characters
  35111. </member>
  35112. <member name="F:NPOI.SS.Util.CellReference.CELL_REF_PATTERN">
  35113. Matches a run of one or more letters followed by a run of one or more digits.
  35114. Both the letter and number groups are optional.
  35115. The run of letters is group 1 and the run of digits is group 2.
  35116. Each group may optionally be prefixed with a single '$'.
  35117. </member>
  35118. <member name="F:NPOI.SS.Util.CellReference.STRICTLY_CELL_REF_PATTERN">
  35119. Matches references only where row and column are included.
  35120. Matches a run of one or more letters followed by a run of one or more digits.
  35121. If a reference does not match this pattern, it might match COLUMN_REF_PATTERN or ROW_REF_PATTERN
  35122. References may optionally include a single '$' before each group, but these are excluded from the Matcher.group(int).
  35123. </member>
  35124. <member name="F:NPOI.SS.Util.CellReference.COLUMN_REF_PATTERN">
  35125. Matches a run of one or more letters. The run of letters is group 1.
  35126. References may optionally include a single '$' before the group, but these are excluded from the Matcher.group(int).
  35127. </member>
  35128. <member name="F:NPOI.SS.Util.CellReference.ROW_REF_PATTERN">
  35129. Matches a run of one or more letters. The run of numbers is group 1.
  35130. References may optionally include a single '$' before the group, but these are excluded from the Matcher.group(int).
  35131. </member>
  35132. <member name="F:NPOI.SS.Util.CellReference.NAMED_RANGE_NAME_PATTERN">
  35133. Named range names must start with a letter or underscore. Subsequent characters may include
  35134. digits or dot. (They can even end in dot).
  35135. </member>
  35136. <member name="M:NPOI.SS.Util.CellReference.#ctor(System.String)">
  35137. Create an cell ref from a string representation. Sheet names containing special characters should be
  35138. delimited and escaped as per normal syntax rules for formulas.
  35139. </member>
  35140. <member name="P:NPOI.SS.Util.CellReference.SheetName">
  35141. @return possibly <c>null</c> if this is a 2D reference. Special characters are not
  35142. escaped or delimited
  35143. </member>
  35144. <member name="M:NPOI.SS.Util.CellReference.ConvertColStringToIndex(System.String)">
  35145. takes in a column reference portion of a CellRef and converts it from
  35146. ALPHA-26 number format to 0-based base 10.
  35147. 'A' -> 0
  35148. 'Z' -> 25
  35149. 'AA' -> 26
  35150. 'IV' -> 255
  35151. @return zero based column index
  35152. </member>
  35153. <member name="M:NPOI.SS.Util.CellReference.ConvertNumToColString(System.Int32)">
  35154. Takes in a 0-based base-10 column and returns a ALPHA-26
  35155. representation.
  35156. eg column #3 -> D
  35157. </member>
  35158. <member name="M:NPOI.SS.Util.CellReference.SeparateRefParts(System.String)">
  35159. Separates the row from the columns and returns an array of three Strings. The first element
  35160. is the sheet name. Only the first element may be null. The second element in is the column
  35161. name still in ALPHA-26 number format. The third element is the row.
  35162. </member>
  35163. <member name="M:NPOI.SS.Util.CellReference.FormatAsString">
  35164. Example return values:
  35165. <table border="0" cellpAdding="1" cellspacing="0" summary="Example return values">
  35166. <tr><th align='left'>Result</th><th align='left'>Comment</th></tr>
  35167. <tr><td>A1</td><td>Cell reference without sheet</td></tr>
  35168. <tr><td>Sheet1!A1</td><td>Standard sheet name</td></tr>
  35169. <tr><td>'O''Brien''s Sales'!A1'</td><td>Sheet name with special characters</td></tr>
  35170. </table>
  35171. @return the text representation of this cell reference as it would appear in a formula.
  35172. </member>
  35173. <member name="P:NPOI.SS.Util.CellReference.CellRefParts">
  35174. Returns the three parts of the cell reference, the
  35175. Sheet name (or null if none supplied), the 1 based
  35176. row number, and the A based column letter.
  35177. This will not include any markers for absolute
  35178. references, so use {@link #formatAsString()}
  35179. to properly turn references into strings.
  35180. </member>
  35181. <member name="M:NPOI.SS.Util.CellReference.AppendCellReference(System.Text.StringBuilder)">
  35182. Appends cell reference with '$' markers for absolute values as required.
  35183. Sheet name is not included.
  35184. </member>
  35185. <member name="M:NPOI.SS.Util.CellReference.CellReferenceIsWithinRange(System.String,System.String,NPOI.SS.SpreadsheetVersion)">
  35186. Used to decide whether a name of the form "[A-Z]*[0-9]*" that appears in a formula can be
  35187. interpreted as a cell reference. Names of that form can be also used for sheets and/or
  35188. named ranges, and in those circumstances, the question of whether the potential cell
  35189. reference is valid (in range) becomes important.
  35190. <p/>
  35191. Note - that the maximum sheet size varies across Excel versions:
  35192. <p/>
  35193. <blockquote><table border="0" cellpadding="1" cellspacing="0"
  35194. summary="Notable cases.">
  35195. <tr><th>Version </th><th>File Format </th>
  35196. <th>Last Column </th><th>Last Row</th></tr>
  35197. <tr><td>97-2003</td><td>BIFF8</td><td>"IV" (2^8)</td><td>65536 (2^14)</td></tr>
  35198. <tr><td>2007</td><td>BIFF12</td><td>"XFD" (2^14)</td><td>1048576 (2^20)</td></tr>
  35199. </table></blockquote>
  35200. POI currently targets BIFF8 (Excel 97-2003), so the following behaviour can be observed for
  35201. this method:
  35202. <blockquote><table border="0" cellpadding="1" cellspacing="0"
  35203. summary="Notable cases.">
  35204. <tr><th>Input </th>
  35205. <th>Result </th></tr>
  35206. <tr><td>"A", "1"</td><td>true</td></tr>
  35207. <tr><td>"a", "111"</td><td>true</td></tr>
  35208. <tr><td>"A", "65536"</td><td>true</td></tr>
  35209. <tr><td>"A", "65537"</td><td>false</td></tr>
  35210. <tr><td>"iv", "1"</td><td>true</td></tr>
  35211. <tr><td>"IW", "1"</td><td>false</td></tr>
  35212. <tr><td>"AAA", "1"</td><td>false</td></tr>
  35213. <tr><td>"a", "111"</td><td>true</td></tr>
  35214. <tr><td>"Sheet", "1"</td><td>false</td></tr>
  35215. </table></blockquote>
  35216. @param colStr a string of only letter characters
  35217. @param rowStr a string of only digit characters
  35218. @return <c>true</c> if the row and col parameters are within range of a BIFF8 spreadsheet.
  35219. </member>
  35220. <member name="M:NPOI.SS.Util.CellReference.IsColumnWithnRange(System.String,NPOI.SS.SpreadsheetVersion)">
  35221. @deprecated 3.15 beta 2. Use {@link #isColumnWithinRange}.
  35222. </member>
  35223. <member name="T:NPOI.SS.Util.CellUtil">
  35224. Various utility functions that make working with a cells and rows easier. The various methods
  35225. that deal with style's allow you to create your CellStyles as you need them. When you apply a
  35226. style change to a cell, the code will attempt to see if a style already exists that meets your
  35227. needs. If not, then it will create a new style. This is to prevent creating too many styles.
  35228. there is an upper limit in Excel on the number of styles that can be supported.
  35229. @author Eric Pugh epugh@upstate.com
  35230. @author (secondary) Avinash Kewalramani akewalramani@accelrys.com
  35231. </member>
  35232. <member name="M:NPOI.SS.Util.CellUtil.GetRow(System.Int32,NPOI.SS.UserModel.ISheet)">
  35233. Get a row from the spreadsheet, and create it if it doesn't exist.
  35234. @param rowIndex The 0 based row number
  35235. @param sheet The sheet that the row is part of.
  35236. @return The row indicated by the rowCounter
  35237. </member>
  35238. <member name="M:NPOI.SS.Util.CellUtil.GetCell(NPOI.SS.UserModel.IRow,System.Int32)">
  35239. Get a specific cell from a row. If the cell doesn't exist, then create it.
  35240. @param row The row that the cell is part of
  35241. @param columnIndex The column index that the cell is in.
  35242. @return The cell indicated by the column.
  35243. </member>
  35244. <member name="M:NPOI.SS.Util.CellUtil.CreateCell(NPOI.SS.UserModel.IRow,System.Int32,System.String,NPOI.SS.UserModel.ICellStyle)">
  35245. Creates a cell, gives it a value, and applies a style if provided
  35246. @param row the row to create the cell in
  35247. @param column the column index to create the cell in
  35248. @param value The value of the cell
  35249. @param style If the style is not null, then set
  35250. @return A new Cell
  35251. </member>
  35252. <member name="M:NPOI.SS.Util.CellUtil.CreateCell(NPOI.SS.UserModel.IRow,System.Int32,System.String)">
  35253. Create a cell, and give it a value.
  35254. @param row the row to create the cell in
  35255. @param column the column index to create the cell in
  35256. @param value The value of the cell
  35257. @return A new Cell.
  35258. </member>
  35259. <member name="M:NPOI.SS.Util.CellUtil.SetAlignment(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.IWorkbook,System.Int16)">
  35260. Take a cell, and align it.
  35261. @param cell the cell to set the alignment for
  35262. @param workbook The workbook that is being worked with.
  35263. @param align the column alignment to use.
  35264. @see CellStyle for alignment options
  35265. </member>
  35266. <member name="M:NPOI.SS.Util.CellUtil.SetAlignment(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.HorizontalAlignment)">
  35267. Take a cell, and align it.
  35268. This is superior to cell.getCellStyle().setAlignment(align) because
  35269. this method will not modify the CellStyle object that may be referenced
  35270. by multiple cells. Instead, this method will search for existing CellStyles
  35271. that match the desired CellStyle, creating a new CellStyle with the desired
  35272. style if no match exists.
  35273. @param cell the cell to set the alignment for
  35274. @param align the horizontal alignment to use.
  35275. @see HorizontalAlignment for alignment options
  35276. @since POI 3.15 beta 3
  35277. </member>
  35278. <member name="M:NPOI.SS.Util.CellUtil.SetVerticalAlignment(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.VerticalAlignment)">
  35279. Take a cell, and vertically align it.
  35280. This is superior to cell.getCellStyle().setVerticalAlignment(align) because
  35281. this method will not modify the CellStyle object that may be referenced
  35282. by multiple cells. Instead, this method will search for existing CellStyles
  35283. that match the desired CellStyle, creating a new CellStyle with the desired
  35284. style if no match exists.
  35285. @param cell the cell to set the alignment for
  35286. @param align the vertical alignment to use.
  35287. @see VerticalAlignment for alignment options
  35288. @since POI 3.15 beta 3
  35289. </member>
  35290. <member name="M:NPOI.SS.Util.CellUtil.SetFont(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.IWorkbook,NPOI.SS.UserModel.IFont)">
  35291. Take a cell, and apply a font to it
  35292. @param cell the cell to set the alignment for
  35293. @param workbook The workbook that is being worked with.
  35294. @param font The Font that you want to set...
  35295. </member>
  35296. <member name="M:NPOI.SS.Util.CellUtil.SetFont(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.IFont)">
  35297. Take a cell, and apply a font to it
  35298. @param cell the cell to set the alignment for
  35299. @param font The Font that you want to set.
  35300. @throws IllegalArgumentException if <tt>font</tt> and <tt>cell</tt> do not belong to the same workbook
  35301. </member>
  35302. <member name="M:NPOI.SS.Util.CellUtil.SetCellStyleProperties(NPOI.SS.UserModel.ICell,System.Collections.Generic.Dictionary{System.String,System.Object})">
  35303. <p>This method attempts to find an existing CellStyle that matches the <code>cell</code>'s
  35304. current style plus styles properties in <code>properties</code>. A new style is created if the
  35305. workbook does not contain a matching style.</p>
  35306. <p>Modifies the cell style of <code>cell</code> without affecting other cells that use the
  35307. same style.</p>
  35308. <p>This is necessary because Excel has an upper limit on the number of styles that it supports.</p>
  35309. <p>This function is more efficient than multiple calls to
  35310. {@link #setCellStyleProperty(org.apache.poi.ss.usermodel.Cell, org.apache.poi.ss.usermodel.Workbook, String, Object)}
  35311. if adding multiple cell styles.</p>
  35312. <p>For performance reasons, if this is the only cell in a workbook that uses a cell style,
  35313. this method does NOT remove the old style from the workbook.
  35314. <!-- NOT IMPLEMENTED: Unused styles should be
  35315. pruned from the workbook with [@link #removeUnusedCellStyles(Workbook)] or
  35316. [@link #removeStyleFromWorkbookIfUnused(CellStyle, Workbook)]. -->
  35317. </p>
  35318. @param cell The cell to change the style of
  35319. @param properties The properties to be added to a cell style, as {propertyName: propertyValue}.
  35320. @since POI 3.14 beta 2
  35321. </member>
  35322. <member name="M:NPOI.SS.Util.CellUtil.SetCellStyleProperty(NPOI.SS.UserModel.ICell,System.String,System.Object)">
  35323. <p>This method attempts to find an existing CellStyle that matches the <code>cell</code>'s
  35324. current style plus a single style property <code>propertyName</code> with value
  35325. <code>propertyValue</code>.
  35326. A new style is created if the workbook does not contain a matching style.</p>
  35327. <p>Modifies the cell style of <code>cell</code> without affecting other cells that use the
  35328. same style.</p>
  35329. <p>If setting more than one cell style property on a cell, use
  35330. {@link #setCellStyleProperties(org.apache.poi.ss.usermodel.Cell, Map)},
  35331. which is faster and does not add unnecessary intermediate CellStyles to the workbook.</p>
  35332. @param cell The cell that is to be changed.
  35333. @param propertyName The name of the property that is to be changed.
  35334. @param propertyValue The value of the property that is to be changed.
  35335. </member>
  35336. <member name="M:NPOI.SS.Util.CellUtil.SetCellStyleProperty(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.IWorkbook,System.String,System.Object)">
  35337. <p>This method attempts to find an existing CellStyle that matches the <code>cell</code>'s
  35338. current style plus a single style property <code>propertyName</code> with value
  35339. <code>propertyValue</code>.
  35340. A new style is created if the workbook does not contain a matching style.</p>
  35341. <p>Modifies the cell style of <code>cell</code> without affecting other cells that use the
  35342. same style.</p>
  35343. <p>If setting more than one cell style property on a cell, use
  35344. {@link #setCellStyleProperties(Cell, Map)},
  35345. which is faster and does not add unnecessary intermediate CellStyles to the workbook.</p>
  35346. @param workbook The workbook that is being worked with.
  35347. @param propertyName The name of the property that is to be changed.
  35348. @param propertyValue The value of the property that is to be changed.
  35349. @param cell The cell that needs it's style changes
  35350. </member>
  35351. <member name="M:NPOI.SS.Util.CellUtil.PutAll(System.Collections.Generic.Dictionary{System.String,System.Object},System.Collections.Generic.Dictionary{System.String,System.Object})">
  35352. Copies the entries in src to dest, using the preferential data type
  35353. so that maps can be compared for equality
  35354. @param src the property map to copy from (read-only)
  35355. @param dest the property map to copy into
  35356. @since POI 3.15 beta 3
  35357. </member>
  35358. <member name="M:NPOI.SS.Util.CellUtil.GetFormatProperties(NPOI.SS.UserModel.ICellStyle)">
  35359. Returns a map containing the format properties of the given cell style.
  35360. The returned map is not tied to <code>style</code>, so subsequent changes
  35361. to <code>style</code> will not modify the map, and changes to the returned
  35362. map will not modify the cell style. The returned map is mutable.
  35363. @param style cell style
  35364. @return map of format properties (String -> Object)
  35365. @see #setFormatProperties(org.apache.poi.ss.usermodel.CellStyle, org.apache.poi.ss.usermodel.Workbook, java.util.Map)
  35366. </member>
  35367. <member name="M:NPOI.SS.Util.CellUtil.SetFormatProperties(NPOI.SS.UserModel.ICellStyle,NPOI.SS.UserModel.IWorkbook,System.Collections.Generic.Dictionary{System.String,System.Object})">
  35368. Sets the format properties of the given style based on the given map.
  35369. @param style cell style
  35370. @param workbook parent workbook
  35371. @param properties map of format properties (String -> Object)
  35372. @see #getFormatProperties(CellStyle)
  35373. </member>
  35374. <member name="M:NPOI.SS.Util.CellUtil.GetShort(System.Collections.Generic.Dictionary{System.String,System.Object},System.String)">
  35375. Utility method that returns the named short value form the given map.
  35376. @param properties map of named properties (String -> Object)
  35377. @param name property name
  35378. @return zero if the property does not exist, or is not a {@link Short}.
  35379. </member>
  35380. <member name="M:NPOI.SS.Util.CellUtil.GetInt(System.Collections.Generic.Dictionary{System.String,System.Object},System.String)">
  35381. Utility method that returns the named int value from the given map.
  35382. @param properties map of named properties (String -> Object)
  35383. @param name property name
  35384. @return zero if the property does not exist, or is not a {@link Integer}
  35385. otherwise the property value
  35386. </member>
  35387. <member name="M:NPOI.SS.Util.CellUtil.GetBorderStyle(System.Collections.Generic.Dictionary{System.String,System.Object},System.String)">
  35388. Utility method that returns the named BorderStyle value form the given map.
  35389. @param properties map of named properties (String -> Object)
  35390. @param name property name
  35391. @return Border style if set, otherwise {@link BorderStyle#NONE}
  35392. </member>
  35393. <member name="M:NPOI.SS.Util.CellUtil.GetFillPattern(System.Collections.Generic.Dictionary{System.String,System.Object},System.String)">
  35394. Utility method that returns the named FillPattern value from the given map.
  35395. @param properties map of named properties (String -> Object)
  35396. @param name property name
  35397. @return FillPattern style if set, otherwise {@link FillPattern#NO_FILL}
  35398. @since POI 3.15 beta 3
  35399. </member>
  35400. <member name="M:NPOI.SS.Util.CellUtil.GetHorizontalAlignment(System.Collections.Generic.Dictionary{System.String,System.Object},System.String)">
  35401. Utility method that returns the named HorizontalAlignment value from the given map.
  35402. @param properties map of named properties (String -> Object)
  35403. @param name property name
  35404. @return HorizontalAlignment style if set, otherwise {@link HorizontalAlignment#GENERAL}
  35405. @since POI 3.15 beta 3
  35406. </member>
  35407. <member name="M:NPOI.SS.Util.CellUtil.GetVerticalAlignment(System.Collections.Generic.Dictionary{System.String,System.Object},System.String)">
  35408. Utility method that returns the named VerticalAlignment value from the given map.
  35409. @param properties map of named properties (String -> Object)
  35410. @param name property name
  35411. @return VerticalAlignment style if set, otherwise {@link VerticalAlignment#BOTTOM}
  35412. @since POI 3.15 beta 3
  35413. </member>
  35414. <member name="M:NPOI.SS.Util.CellUtil.GetBoolean(System.Collections.Generic.Dictionary{System.String,System.Object},System.String)">
  35415. Utility method that returns the named boolean value form the given map.
  35416. @param properties map of properties (String -> Object)
  35417. @param name property name
  35418. @return false if the property does not exist, or is not a {@link Boolean}.
  35419. </member>
  35420. <member name="M:NPOI.SS.Util.CellUtil.Put(System.Collections.Generic.Dictionary{System.String,System.Object},System.String,System.Object)">
  35421. Utility method that puts the given value to the given map.
  35422. @param properties map of properties (String -> Object)
  35423. @param name property name
  35424. @param value property value
  35425. </member>
  35426. <member name="M:NPOI.SS.Util.CellUtil.PutShort(System.Collections.Generic.Dictionary{System.String,System.Object},System.String,System.Int16)">
  35427. Utility method that puts the named short value to the given map.
  35428. @param properties map of properties (String -> Object)
  35429. @param name property name
  35430. @param value property value
  35431. </member>
  35432. <member name="M:NPOI.SS.Util.CellUtil.PutEnum(System.Collections.Generic.Dictionary{System.String,System.Object},System.String,System.Enum)">
  35433. Utility method that puts the named short value to the given map.
  35434. @param properties map of properties (String -> Object)
  35435. @param name property name
  35436. @param value property value
  35437. </member>
  35438. <member name="M:NPOI.SS.Util.CellUtil.PutBoolean(System.Collections.Generic.Dictionary{System.String,System.Object},System.String,System.Boolean)">
  35439. Utility method that puts the named boolean value to the given map.
  35440. @param properties map of properties (String -> Object)
  35441. @param name property name
  35442. @param value property value
  35443. </member>
  35444. <member name="M:NPOI.SS.Util.CellUtil.TranslateUnicodeValues(NPOI.SS.UserModel.ICell)">
  35445. Looks for text in the cell that should be unicode, like an alpha and provides the
  35446. unicode version of it.
  35447. @param cell The cell to check for unicode values
  35448. @return translated to unicode
  35449. </member>
  35450. <member name="T:NPOI.SS.Util.DateFormatConverter">
  35451. Convert DateFormat patterns into Excel custom number formats.
  35452. For example, to format a date in excel using the "dd MMMM, yyyy" pattern and Japanese
  35453. locale, use the following code:
  35454. <pre><code>
  35455. // returns "[$-0411]dd MMMM, yyyy;@" where the [$-0411] prefix tells Excel to use the Japanese locale
  35456. String excelFormatPattern = DateFormatConverter.convert(Locale.JAPANESE, "dd MMMM, yyyy");
  35457. CellStyle cellStyle = workbook.createCellStyle();
  35458. DataFormat poiFormat = workbook.createDataFormat();
  35459. cellStyle.setDataFormat(poiFormat.getFormat(excelFormatPattern));
  35460. cell.setCellValue(new Date());
  35461. cell.setCellStyle(cellStyle); // formats date as '2012\u5e743\u670817\u65e5'
  35462. </code></pre>
  35463. </member>
  35464. <member name="F:NPOI.SS.Util.ExpandedDouble._significand">
  35465. Always 64 bits long (MSB, bit-63 is '1')
  35466. </member>
  35467. <member name="M:NPOI.SS.Util.ExpandedDouble.NormaliseBaseTen">
  35468. Convert to an equivalent {@link NormalisedDecimal} representation having 15 decimal digits of precision in the
  35469. non-fractional bits of the significand.
  35470. </member>
  35471. <member name="M:NPOI.SS.Util.ExpandedDouble.GetBinaryExponent">
  35472. @return the number of non-fractional bits after the MSB of the significand
  35473. </member>
  35474. <member name="T:NPOI.SS.Util.FormatBase">
  35475. <summary>
  35476. A substitute class for Format class in Java
  35477. </summary>
  35478. </member>
  35479. <member name="T:NPOI.SS.Util.SSNFormat">
  35480. Format class for Excel's SSN Format. This class mimics Excel's built-in
  35481. SSN Formatting.
  35482. @author James May
  35483. </member>
  35484. <member name="M:NPOI.SS.Util.SSNFormat.Format(System.Object,System.Globalization.CultureInfo)">
  35485. Format a number as an SSN
  35486. </member>
  35487. <member name="T:NPOI.SS.Util.ZipPlusFourFormat">
  35488. Format class for Excel Zip + 4 Format. This class mimics Excel's
  35489. built-in Formatting for Zip + 4.
  35490. @author James May
  35491. </member>
  35492. <member name="M:NPOI.SS.Util.ZipPlusFourFormat.Format(System.Object,System.Globalization.CultureInfo)">
  35493. Format a number as Zip + 4
  35494. </member>
  35495. <member name="T:NPOI.SS.Util.PhoneFormat">
  35496. Format class for Excel phone number Format. This class mimics Excel's
  35497. built-in phone number Formatting.
  35498. @author James May
  35499. </member>
  35500. <member name="M:NPOI.SS.Util.PhoneFormat.Format(System.Object,System.Globalization.CultureInfo)">
  35501. Format a number as a phone number
  35502. </member>
  35503. <member name="T:NPOI.SS.Util.ConstantStringFormat">
  35504. Format class that does nothing and always returns a constant string.
  35505. This format is used to simulate Excel's handling of a format string
  35506. of all # when the value is 0. Excel will output "", Java will output "0".
  35507. @see DataFormatter#createFormat(double, int, String)
  35508. </member>
  35509. <member name="F:NPOI.SS.Util.IEEEDouble.BIASED_EXPONENT_SPECIAL_VALUE">
  35510. The value the exponent field Gets for all <i>NaN</i> and <i>InfInity</i> values
  35511. </member>
  35512. <member name="M:NPOI.SS.Util.IEEEDouble.GetBiasedExponent(System.Int64)">
  35513. @param rawBits the 64 bit binary representation of the double value
  35514. @return the top 12 bits (sign and biased exponent value)
  35515. </member>
  35516. <member name="F:NPOI.SS.Util.MutableFPNumber.BI_MIN_BASE">
  35517. The minimum value in 'Base-10 normalised form'.<br/>
  35518. When {@link #_binaryExponent} == 46 this is the the minimum {@link #_frac} value
  35519. (10<sup>14</sup>-0.05) * 2^17
  35520. <br/>
  35521. Values between (10<sup>14</sup>-0.05) and 10<sup>14</sup> will be represented as '1'
  35522. followed by 14 zeros.
  35523. Values less than (10<sup>14</sup>-0.05) will get Shifted by one more power of 10
  35524. This frac value rounds to '1' followed by fourteen zeros with an incremented decimal exponent
  35525. </member>
  35526. <member name="F:NPOI.SS.Util.MutableFPNumber.BI_MAX_BASE">
  35527. For 'Base-10 normalised form'<br/>
  35528. The maximum {@link #_frac} value when {@link #_binaryExponent} == 49
  35529. (10^15-0.5) * 2^14
  35530. </member>
  35531. <member name="F:NPOI.SS.Util.MutableFPNumber.C_64">
  35532. Width of a long
  35533. </member>
  35534. <member name="F:NPOI.SS.Util.MutableFPNumber.MIN_PRECISION">
  35535. Minimum precision after discarding whole 32-bit words from the significand
  35536. </member>
  35537. <member name="M:NPOI.SS.Util.MutableFPNumber.Rounder.Round(NPOI.Util.BigInteger,System.Int32)">
  35538. @param nBits number of bits to shift right
  35539. </member>
  35540. <member name="T:NPOI.SS.Util.MutableFPNumber.TenPower">
  35541. Holds values for quick multiplication and division by 10
  35542. </member>
  35543. <member name="F:NPOI.SS.Util.NormalisedDecimal.EXPONENT_OFFSET">
  35544. Number of powers of ten Contained in the significand
  35545. </member>
  35546. <member name="F:NPOI.SS.Util.NormalisedDecimal.C_2_POW_19">
  35547. 2<sup>19</sup>
  35548. </member>
  35549. <member name="F:NPOI.SS.Util.NormalisedDecimal.FRAC_HALF">
  35550. the value of {@link #_fractionalPart} that represents 0.5
  35551. </member>
  35552. <member name="F:NPOI.SS.Util.NormalisedDecimal.MAX_REP_WHOLE_PART">
  35553. 10<sup>15</sup>
  35554. </member>
  35555. <member name="M:NPOI.SS.Util.NormalisedDecimal.RoundUnits">
  35556. Rounds at the digit with value 10<sup>decimalExponent</sup>
  35557. </member>
  35558. <member name="F:NPOI.SS.Util.NormalisedDecimal._relativeDecimalExponent">
  35559. The decimal exponent increased by one less than the digit count of {@link #_wholePart}
  35560. </member>
  35561. <member name="F:NPOI.SS.Util.NormalisedDecimal._wholePart">
  35562. The whole part of the significand (typically 15 digits).
  35563. 47-50 bits long (MSB may be anywhere from bit 46 to 49)
  35564. LSB is units bit.
  35565. </member>
  35566. <member name="F:NPOI.SS.Util.NormalisedDecimal._fractionalPart">
  35567. The fractional part of the significand.
  35568. 24 bits (only top 14-17 bits significant): a value between 0x000000 and 0xFFFF80
  35569. </member>
  35570. <member name="M:NPOI.SS.Util.NormalisedDecimal.NormaliseBaseTwo">
  35571. Convert to an equivalent {@link ExpandedDouble} representation (binary frac and exponent).
  35572. The resulting transformed object is easily Converted to a 64 bit IEEE double:
  35573. <ul>
  35574. <li>bits 2-53 of the {@link #GetSignificand()} become the 52 bit 'fraction'.</li>
  35575. <li>{@link #GetBinaryExponent()} is biased by 1023 to give the 'exponent'.</li>
  35576. </ul>
  35577. The sign bit must be obtained from somewhere else.
  35578. @return a new {@link NormalisedDecimal} normalised to base 2 representation.
  35579. </member>
  35580. <member name="M:NPOI.SS.Util.NormalisedDecimal.ComposeFrac">
  35581. @return the significand as a fixed point number (with 24 fraction bits and 47-50 whole bits)
  35582. </member>
  35583. <member name="M:NPOI.SS.Util.NormalisedDecimal.GetSignificantDecimalDigitsLastDigitRounded">
  35584. Rounds the first whole digit position (considers only units digit, not frational part).
  35585. Caller should check total digit count of result to see whether the rounding operation caused
  35586. a carry out of the most significant digit
  35587. </member>
  35588. <member name="M:NPOI.SS.Util.NormalisedDecimal.GetDecimalExponent">
  35589. @return the number of powers of 10 which have been extracted from the significand and binary exponent.
  35590. </member>
  35591. <member name="M:NPOI.SS.Util.NormalisedDecimal.CompareNormalised(NPOI.SS.Util.NormalisedDecimal)">
  35592. assumes both this and other are normalised
  35593. </member>
  35594. <member name="M:NPOI.SS.Util.NumberComparer.Compare(System.Double,System.Double)">
  35595. This class attempts to reproduce Excel's behaviour for comparing numbers. Results are
  35596. mostly the same as those from {@link Double#compare(double, double)} but with some
  35597. rounding. For numbers that are very close, this code converts to a format having 15
  35598. decimal digits of precision and a decimal exponent, before completing the comparison.
  35599. <p/>
  35600. In Excel formula evaluation, expressions like "(0.06-0.01)=0.05" evaluate to "TRUE" even
  35601. though the equivalent java expression is <c>false</c>. In examples like this,
  35602. Excel achieves the effect by having additional logic for comparison operations.
  35603. <p/>
  35604. <p/>
  35605. Note - Excel also gives special treatment to expressions like "0.06-0.01-0.05" which
  35606. evaluates to "0" (in java, rounding anomalies give a result of 6.9E-18). The special
  35607. behaviour here is for different reasons to the example above: If the last operator in a
  35608. cell formula is '+' or '-' and the result is less than 2<sup>50</sup> times smaller than
  35609. first operand, the result is rounded to zero.
  35610. Needless to say, the two rules are not consistent and it is relatively easy to find
  35611. examples that satisfy<br/>
  35612. "A=B" is "TRUE" but "A-B" is not "0"<br/>
  35613. and<br/>
  35614. "A=B" is "FALSE" but "A-B" is "0"<br/>
  35615. <br/>
  35616. This rule (for rounding the result of a final addition or subtraction), has not been
  35617. implemented in POI (as of Jul-2009).
  35618. @return <code>negative, 0, or positive</code> according to the standard Excel comparison
  35619. of values <c>a</c> and <c>b</c>.
  35620. </member>
  35621. <member name="M:NPOI.SS.Util.NumberComparer.CompareSubnormalNumbers(System.Int64,System.Int64,System.Boolean)">
  35622. If both numbers are subnormal, Excel seems to use standard comparison rules
  35623. </member>
  35624. <member name="M:NPOI.SS.Util.NumberComparer.CompareAcrossSubnormalThreshold(System.Int64,System.Int64,System.Boolean)">
  35625. Usually any normal number is greater (in magnitude) than any subnormal number.
  35626. However there are some anomalous cases around the threshold where Excel produces screwy results
  35627. @param isNegative both values are either negative or positive. This parameter affects the sign of the comparison result
  35628. @return usually <code>isNegative ? -1 : +1</code>
  35629. </member>
  35630. <member name="M:NPOI.SS.Util.NumberComparer.ToHex(System.Double)">
  35631. for formatting double values in error messages
  35632. </member>
  35633. <member name="M:NPOI.SS.Util.NumberToTextConverter.ToText(System.Double)">
  35634. Converts the supplied <c>value</c> to the text representation that Excel would give if
  35635. the value were to appear in an unformatted cell, or as a literal number in a formula.<br/>
  35636. Note - the results from this method differ slightly from those of <c>Double.ToString()</c>
  35637. In some special cases Excel behaves quite differently. This function attempts to reproduce
  35638. those results.
  35639. </member>
  35640. <member name="T:NPOI.SS.Util.PaneInformation">
  35641. Holds information regarding a split plane or freeze plane for a sheet.
  35642. </member>
  35643. <member name="F:NPOI.SS.Util.PaneInformation.PANE_LOWER_RIGHT">
  35644. Constant for active pane being the lower right
  35645. </member>
  35646. <member name="F:NPOI.SS.Util.PaneInformation.PANE_UPPER_RIGHT">
  35647. Constant for active pane being the upper right
  35648. </member>
  35649. <member name="F:NPOI.SS.Util.PaneInformation.PANE_LOWER_LEFT">
  35650. Constant for active pane being the lower left
  35651. </member>
  35652. <member name="F:NPOI.SS.Util.PaneInformation.PANE_UPPER_LEFT">
  35653. Constant for active pane being the upper left
  35654. </member>
  35655. <member name="P:NPOI.SS.Util.PaneInformation.VerticalSplitPosition">
  35656. Returns the vertical position of the split.
  35657. @return 0 if there is no vertical spilt,
  35658. or for a freeze pane the number of columns in the TOP pane,
  35659. or for a split plane the position of the split in 1/20th of a point.
  35660. </member>
  35661. <member name="P:NPOI.SS.Util.PaneInformation.HorizontalSplitPosition">
  35662. Returns the horizontal position of the split.
  35663. @return 0 if there is no horizontal spilt,
  35664. or for a freeze pane the number of rows in the LEFT pane,
  35665. or for a split plane the position of the split in 1/20th of a point.
  35666. </member>
  35667. <member name="P:NPOI.SS.Util.PaneInformation.HorizontalSplitTopRow">
  35668. For a horizontal split returns the top row in the BOTTOM pane.
  35669. @return 0 if there is no horizontal split, or the top row of the bottom pane.
  35670. </member>
  35671. <member name="P:NPOI.SS.Util.PaneInformation.VerticalSplitLeftColumn">
  35672. For a vertical split returns the left column in the RIGHT pane.
  35673. @return 0 if there is no vertical split, or the left column in the RIGHT pane.
  35674. </member>
  35675. <member name="P:NPOI.SS.Util.PaneInformation.ActivePane">
  35676. Returns the active pane
  35677. @see #PANE_LOWER_RIGHT
  35678. @see #PANE_UPPER_RIGHT
  35679. @see #PANE_LOWER_LEFT
  35680. @see #PANE_UPPER_LEFT
  35681. @return the active pane.
  35682. </member>
  35683. <member name="M:NPOI.SS.Util.PaneInformation.IsFreezePane">
  35684. Returns true if this is a Freeze pane, false if it is a split pane.
  35685. </member>
  35686. <member name="T:NPOI.SS.Util.SheetUtil">
  35687. Helper methods for when working with Usermodel sheets
  35688. @author Yegor Kozlov
  35689. </member>
  35690. <member name="F:NPOI.SS.Util.SheetUtil.dummyEvaluator">
  35691. Dummy formula Evaluator that does nothing.
  35692. YK: The only reason of having this class is that
  35693. {@link NPOI.SS.UserModel.DataFormatter#formatCellValue(NPOI.SS.UserModel.Cell)}
  35694. returns formula string for formula cells. Dummy Evaluator Makes it to format the cached formula result.
  35695. See Bugzilla #50021
  35696. </member>
  35697. <member name="M:NPOI.SS.Util.SheetUtil.CanComputeColumnWidth(NPOI.SS.UserModel.IFont)">
  35698. Check if the Fonts are installed correctly so that Java can compute the size of
  35699. columns.
  35700. If a Cell uses a Font which is not available on the operating system then Java may
  35701. fail to return useful Font metrics and thus lead to an auto-computed size of 0.
  35702. This method allows to check if computing the sizes for a given Font will succeed or not.
  35703. @param font The Font that is used in the Cell
  35704. @return true if computing the size for this Font will succeed, false otherwise
  35705. </member>
  35706. <member name="M:NPOI.SS.Util.SheetUtil.ContainsCell(NPOI.SS.Util.CellRangeAddress,System.Int32,System.Int32)">
  35707. <summary>
  35708. Check if the cell is in the specified cell range
  35709. </summary>
  35710. <param name="cr">the cell range to check in</param>
  35711. <param name="rowIx">the row to check</param>
  35712. <param name="colIx">the column to check</param>
  35713. <returns>return true if the range contains the cell [rowIx, colIx]</returns>
  35714. </member>
  35715. <member name="M:NPOI.SS.Util.SheetUtil.GetUniqueSheetName(NPOI.SS.UserModel.IWorkbook,System.String)">
  35716. Generate a valid sheet name based on the existing one. Used when cloning sheets.
  35717. @param srcName the original sheet name to
  35718. @return clone sheet name
  35719. </member>
  35720. <member name="M:NPOI.SS.Util.SheetUtil.GetCellWithMerges(NPOI.SS.UserModel.ISheet,System.Int32,System.Int32)">
  35721. Return the cell, taking account of merged regions. Allows you to find the
  35722. cell who's contents are Shown in a given position in the sheet.
  35723. <p>If the cell at the given co-ordinates is a merged cell, this will
  35724. return the primary (top-left) most cell of the merged region.</p>
  35725. <p>If the cell at the given co-ordinates is not in a merged region,
  35726. then will return the cell itself.</p>
  35727. <p>If there is no cell defined at the given co-ordinates, will return
  35728. null.</p>
  35729. </member>
  35730. <member name="T:NPOI.SS.Util.SSCellRange`1">
  35731. For POI internal use only
  35732. @author Josh Micich
  35733. </member>
  35734. <member name="T:NPOI.SS.Util.WorkbookUtil">
  35735. Helper methods for when working with Usermodel Workbooks
  35736. </member>
  35737. <member name="M:NPOI.SS.Util.WorkbookUtil.CreateSafeSheetName(System.String)">
  35738. Creates a valid sheet name, which is conform to the rules.
  35739. In any case, the result safely can be used for
  35740. {@link org.apache.poi.ss.usermodel.Workbook#setSheetName(int, String)}.
  35741. <br/>
  35742. Rules:
  35743. <ul>
  35744. <li>never null</li>
  35745. <li>minimum length is 1</li>
  35746. <li>maximum length is 31</li>
  35747. <li>doesn't contain special chars: 0x0000, 0x0003, / \ ? * ] [ </li>
  35748. <li>Sheet names must not begin or end with ' (apostrophe)</li>
  35749. </ul>
  35750. Invalid characters are replaced by one space character ' '.
  35751. @param nameProposal can be any string, will be truncated if necessary,
  35752. allowed to be null
  35753. @return a valid string, "empty" if to short, "null" if null
  35754. </member>
  35755. <member name="M:NPOI.SS.Util.WorkbookUtil.CreateSafeSheetName(System.String,System.Char)">
  35756. Creates a valid sheet name, which is conform to the rules.
  35757. In any case, the result safely can be used for
  35758. {@link org.apache.poi.ss.usermodel.Workbook#setSheetName(int, String)}.
  35759. <br />
  35760. Rules:
  35761. <ul>
  35762. <li>never null</li>
  35763. <li>minimum length is 1</li>
  35764. <li>maximum length is 31</li>
  35765. <li>doesn't contain special chars: : 0x0000, 0x0003, / \ ? * ] [ </li>
  35766. <li>Sheet names must not begin or end with ' (apostrophe)</li>
  35767. </ul>
  35768. @param nameProposal can be any string, will be truncated if necessary,
  35769. allowed to be null
  35770. @param replaceChar the char to replace invalid characters.
  35771. @return a valid string, "empty" if to short, "null" if null
  35772. </member>
  35773. <member name="M:NPOI.SS.Util.WorkbookUtil.ValidateSheetName(System.String)">
  35774. Validates sheet name.
  35775. <p>
  35776. The character count <c>MUST</c> be greater than or equal to 1 and less than or equal to 31.
  35777. The string MUST NOT contain the any of the following characters:
  35778. <ul>
  35779. <li> 0x0000 </li>
  35780. <li> 0x0003 </li>
  35781. <li> colon (:) </li>
  35782. <li> backslash (\) </li>
  35783. <li> asterisk (*) </li>
  35784. <li> question mark (?) </li>
  35785. <li> forward slash (/) </li>
  35786. <li> opening square bracket ([) </li>
  35787. <li> closing square bracket (]) </li>
  35788. </ul>
  35789. The string MUST NOT begin or end with the single quote (') character.
  35790. </p>
  35791. @param sheetName the name to validate
  35792. </member>
  35793. <member name="T:NPOI.UnsupportedFileFormatException">
  35794. Base class of all the exceptions that POI throws in the event
  35795. that it's given a file that isn't supported
  35796. </member>
  35797. <member name="M:NPOI.Util.Arrays.Fill(System.Byte[],System.Byte)">
  35798. <summary>
  35799. Fills the specified array.
  35800. </summary>
  35801. <param name="array">The array.</param>
  35802. <param name="defaultValue">The default value.</param>
  35803. </member>
  35804. <member name="M:NPOI.Util.Arrays.Fill(System.Byte[],System.Int32,System.Int32,System.Byte)">
  35805. <summary>
  35806. Assigns the specified byte value to each element of the specified
  35807. range of the specified array of bytes. The range to be filled
  35808. extends from index <tt>fromIndex</tt>, inclusive, to index
  35809. <tt>toIndex</tt>, exclusive. (If <tt>fromIndex==toIndex</tt>, the
  35810. range to be filled is empty.)
  35811. </summary>
  35812. <param name="a">the array to be filled</param>
  35813. <param name="fromIndex">the index of the first element (inclusive) to be filled with the specified value</param>
  35814. <param name="toIndex">the index of the last element (exclusive) to be filled with the specified value</param>
  35815. <param name="val">the value to be stored in all elements of the array</param>
  35816. <exception cref="T:System.ArgumentException">if <c>fromIndex &gt; toIndex</c></exception>
  35817. <exception cref="T:System.IndexOutOfRangeException"> if <c>fromIndex &lt; 0</c> or <c>toIndex &gt; a.length</c></exception>
  35818. </member>
  35819. <member name="M:NPOI.Util.Arrays.RangeCheck(System.Int32,System.Int32,System.Int32)">
  35820. <summary>
  35821. Checks that {@code fromIndex} and {@code toIndex} are in
  35822. the range and throws an appropriate exception, if they aren't.
  35823. </summary>
  35824. <param name="length"></param>
  35825. <param name="fromIndex"></param>
  35826. <param name="toIndex"></param>
  35827. </member>
  35828. <member name="M:NPOI.Util.Arrays.AsList(System.Array)">
  35829. <summary>
  35830. Convert Array to ArrayList
  35831. </summary>
  35832. <param name="arr">source array</param>
  35833. <returns></returns>
  35834. </member>
  35835. <member name="M:NPOI.Util.Arrays.Fill(System.Int32[],System.Byte)">
  35836. <summary>
  35837. Fills the specified array.
  35838. </summary>
  35839. <param name="array">The array.</param>
  35840. <param name="defaultValue">The default value.</param>
  35841. </member>
  35842. <member name="M:NPOI.Util.Arrays.Equals(System.Object,System.Object)">
  35843. <summary>
  35844. Equals the specified a1.
  35845. </summary>
  35846. <param name="a1">The a1.</param>
  35847. <param name="b1">The b1.</param>
  35848. <returns></returns>
  35849. </member>
  35850. <member name="M:NPOI.Util.Arrays.Equals(System.Object[],System.Object[])">
  35851. Returns <c>true</c> if the two specified arrays of Objects are
  35852. <i>equal</i> to one another. The two arrays are considered equal if
  35853. both arrays contain the same number of elements, and all corresponding
  35854. pairs of elements in the two arrays are equal. Two objects <c>e1</c>
  35855. and <c>e2</c> are considered <i>equal</i> if <c>(e1==null ? e2==null
  35856. : e1.equals(e2))</c>. In other words, the two arrays are equal if
  35857. they contain the same elements in the same order. Also, two array
  35858. references are considered equal if both are <c>null</c>.
  35859. @param a one array to be tested for equality
  35860. @param a2 the other array to be tested for equality
  35861. @return <c>true</c> if the two arrays are equal
  35862. </member>
  35863. <member name="M:NPOI.Util.Arrays.ArrayMoveWithin(System.Object[],System.Int32,System.Int32,System.Int32)">
  35864. <summary>
  35865. Moves a number of entries in an array to another point in the array, shifting those inbetween as required.
  35866. </summary>
  35867. <param name="array">The array to alter</param>
  35868. <param name="moveFrom">The (0 based) index of the first entry to move</param>
  35869. <param name="moveTo">The (0 based) index of the positition to move to</param>
  35870. <param name="numToMove">The number of entries to move</param>
  35871. </member>
  35872. <member name="M:NPOI.Util.Arrays.CopyOf(System.Byte[],System.Int32)">
  35873. <summary>
  35874. Copies the specified array, truncating or padding with zeros (if
  35875. necessary) so the copy has the specified length. This method is temporary
  35876. replace for Arrays.copyOf() until we start to require JDK 1.6.
  35877. </summary>
  35878. <param name="source">the array to be copied</param>
  35879. <param name="newLength">the length of the copy to be returned</param>
  35880. <returns>a copy of the original array, truncated or padded with zeros to obtain the specified length</returns>
  35881. </member>
  35882. <member name="M:NPOI.Util.Arrays.HashCode(System.Int64[])">
  35883. Returns a hash code based on the contents of the specified array.
  35884. For any two <tt>long</tt> arrays <tt>a</tt> and <tt>b</tt>
  35885. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  35886. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  35887. The value returned by this method is the same value that would be
  35888. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  35889. method on a {@link List} Containing a sequence of {@link Long}
  35890. instances representing the elements of <tt>a</tt> in the same order.
  35891. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  35892. @param a the array whose hash value to compute
  35893. @return a content-based hash code for <tt>a</tt>
  35894. @since 1.5
  35895. </member>
  35896. <member name="M:NPOI.Util.Arrays.HashCode(System.Int32[])">
  35897. Returns a hash code based on the contents of the specified array.
  35898. For any two non-null <tt>int</tt> arrays <tt>a</tt> and <tt>b</tt>
  35899. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  35900. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  35901. The value returned by this method is the same value that would be
  35902. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  35903. method on a {@link List} Containing a sequence of {@link int}
  35904. instances representing the elements of <tt>a</tt> in the same order.
  35905. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  35906. @param a the array whose hash value to compute
  35907. @return a content-based hash code for <tt>a</tt>
  35908. @since 1.5
  35909. </member>
  35910. <member name="M:NPOI.Util.Arrays.HashCode(System.Int16[])">
  35911. Returns a hash code based on the contents of the specified array.
  35912. For any two <tt>short</tt> arrays <tt>a</tt> and <tt>b</tt>
  35913. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  35914. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  35915. The value returned by this method is the same value that would be
  35916. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  35917. method on a {@link List} Containing a sequence of {@link short}
  35918. instances representing the elements of <tt>a</tt> in the same order.
  35919. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  35920. @param a the array whose hash value to compute
  35921. @return a content-based hash code for <tt>a</tt>
  35922. @since 1.5
  35923. </member>
  35924. <member name="M:NPOI.Util.Arrays.HashCode(System.Char[])">
  35925. Returns a hash code based on the contents of the specified array.
  35926. For any two <tt>char</tt> arrays <tt>a</tt> and <tt>b</tt>
  35927. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  35928. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  35929. The value returned by this method is the same value that would be
  35930. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  35931. method on a {@link List} Containing a sequence of {@link Character}
  35932. instances representing the elements of <tt>a</tt> in the same order.
  35933. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  35934. @param a the array whose hash value to compute
  35935. @return a content-based hash code for <tt>a</tt>
  35936. @since 1.5
  35937. </member>
  35938. <member name="M:NPOI.Util.Arrays.HashCode(System.Byte[])">
  35939. Returns a hash code based on the contents of the specified array.
  35940. For any two <tt>byte</tt> arrays <tt>a</tt> and <tt>b</tt>
  35941. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  35942. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  35943. The value returned by this method is the same value that would be
  35944. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  35945. method on a {@link List} Containing a sequence of {@link Byte}
  35946. instances representing the elements of <tt>a</tt> in the same order.
  35947. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  35948. @param a the array whose hash value to compute
  35949. @return a content-based hash code for <tt>a</tt>
  35950. @since 1.5
  35951. </member>
  35952. <member name="M:NPOI.Util.Arrays.HashCode(System.Boolean[])">
  35953. Returns a hash code based on the contents of the specified array.
  35954. For any two <tt>bool</tt> arrays <tt>a</tt> and <tt>b</tt>
  35955. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  35956. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  35957. The value returned by this method is the same value that would be
  35958. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  35959. method on a {@link List} Containing a sequence of {@link Boolean}
  35960. instances representing the elements of <tt>a</tt> in the same order.
  35961. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  35962. @param a the array whose hash value to compute
  35963. @return a content-based hash code for <tt>a</tt>
  35964. @since 1.5
  35965. </member>
  35966. <member name="M:NPOI.Util.Arrays.HashCode(System.Single[])">
  35967. Returns a hash code based on the contents of the specified array.
  35968. For any two <tt>float</tt> arrays <tt>a</tt> and <tt>b</tt>
  35969. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  35970. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  35971. The value returned by this method is the same value that would be
  35972. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  35973. method on a {@link List} Containing a sequence of {@link Float}
  35974. instances representing the elements of <tt>a</tt> in the same order.
  35975. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  35976. @param a the array whose hash value to compute
  35977. @return a content-based hash code for <tt>a</tt>
  35978. @since 1.5
  35979. </member>
  35980. <member name="M:NPOI.Util.Arrays.HashCode(System.Double[])">
  35981. Returns a hash code based on the contents of the specified array.
  35982. For any two <tt>double</tt> arrays <tt>a</tt> and <tt>b</tt>
  35983. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  35984. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  35985. The value returned by this method is the same value that would be
  35986. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  35987. method on a {@link List} Containing a sequence of {@link Double}
  35988. instances representing the elements of <tt>a</tt> in the same order.
  35989. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  35990. @param a the array whose hash value to compute
  35991. @return a content-based hash code for <tt>a</tt>
  35992. @since 1.5
  35993. </member>
  35994. <member name="M:NPOI.Util.Arrays.HashCode(System.Object[])">
  35995. Returns a hash code based on the contents of the specified array. If
  35996. the array Contains other arrays as elements, the hash code is based on
  35997. their identities rather than their contents. It is therefore
  35998. acceptable to invoke this method on an array that Contains itself as an
  35999. element, either directly or indirectly through one or more levels of
  36000. arrays.
  36001. For any two arrays <tt>a</tt> and <tt>b</tt> such that
  36002. <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  36003. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  36004. The value returned by this method is equal to the value that would
  36005. be returned by <tt>Arrays.AsList(a).HashCode()</tt>, unless <tt>a</tt>
  36006. is <tt>null</tt>, in which case <tt>0</tt> is returned.
  36007. @param a the array whose content-based hash code to compute
  36008. @return a content-based hash code for <tt>a</tt>
  36009. @see #deepHashCode(Object[])
  36010. @since 1.5
  36011. </member>
  36012. <member name="M:NPOI.Util.Arrays.DeepHashCode(System.Object[])">
  36013. Returns a hash code based on the "deep contents" of the specified
  36014. array. If the array Contains other arrays as elements, the
  36015. hash code is based on their contents and so on, ad infInitum.
  36016. It is therefore unacceptable to invoke this method on an array that
  36017. Contains itself as an element, either directly or indirectly through
  36018. one or more levels of arrays. The behavior of such an invocation is
  36019. undefined.
  36020. For any two arrays <tt>a</tt> and <tt>b</tt> such that
  36021. <tt>Arrays.DeepEquals(a, b)</tt>, it is also the case that
  36022. <tt>Arrays.DeepHashCode(a) == Arrays.DeepHashCode(b)</tt>.
  36023. The computation of the value returned by this method is similar to
  36024. that of the value returned by {@link List#hashCode()} on a list
  36025. Containing the same elements as <tt>a</tt> in the same order, with one
  36026. difference: If an element <tt>e</tt> of <tt>a</tt> is itself an array,
  36027. its hash code is computed not by calling <tt>e.HashCode()</tt>, but as
  36028. by calling the appropriate overloading of <tt>Arrays.HashCode(e)</tt>
  36029. if <tt>e</tt> is an array of a primitive type, or as by calling
  36030. <tt>Arrays.DeepHashCode(e)</tt> recursively if <tt>e</tt> is an array
  36031. of a reference type. If <tt>a</tt> is <tt>null</tt>, this method
  36032. returns 0.
  36033. @param a the array whose deep-content-based hash code to compute
  36034. @return a deep-content-based hash code for <tt>a</tt>
  36035. @see #hashCode(Object[])
  36036. @since 1.5
  36037. </member>
  36038. <member name="M:NPOI.Util.Arrays.DeepEquals(System.Object[],System.Object[])">
  36039. Returns <tt>true</tt> if the two specified arrays are <i>deeply
  36040. Equal</i> to one another. Unlike the {@link #Equals(Object[],Object[])}
  36041. method, this method is appropriate for use with nested arrays of
  36042. arbitrary depth.
  36043. Two array references are considered deeply equal if both
  36044. are <tt>null</tt>, or if they refer to arrays that contain the same
  36045. number of elements and all corresponding pairs of elements in the two
  36046. arrays are deeply Equal.
  36047. Two possibly <tt>null</tt> elements <tt>e1</tt> and <tt>e2</tt> are
  36048. deeply equal if any of the following conditions hold:
  36049. <ul>
  36050. <li> <tt>e1</tt> and <tt>e2</tt> are both arrays of object reference
  36051. types, and <tt>Arrays.DeepEquals(e1, e2) would return true</tt></li>
  36052. <li> <tt>e1</tt> and <tt>e2</tt> are arrays of the same primitive
  36053. type, and the appropriate overloading of
  36054. <tt>Arrays.Equals(e1, e2)</tt> would return true.</li>
  36055. <li> <tt>e1 == e2</tt></li>
  36056. <li> <tt>e1.Equals(e2)</tt> would return true.</li>
  36057. </ul>
  36058. Note that this defInition permits <tt>null</tt> elements at any depth.
  36059. If either of the specified arrays contain themselves as elements
  36060. either directly or indirectly through one or more levels of arrays,
  36061. the behavior of this method is undefined.
  36062. @param a1 one array to be tested for Equality
  36063. @param a2 the other array to be tested for Equality
  36064. @return <tt>true</tt> if the two arrays are equal
  36065. @see #Equals(Object[],Object[])
  36066. @see Objects#deepEquals(Object, Object)
  36067. @since 1.5
  36068. </member>
  36069. <member name="M:NPOI.Util.Arrays.ToString(System.Int64[])">
  36070. Returns a string representation of the contents of the specified array.
  36071. The string representation consists of a list of the array's elements,
  36072. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  36073. Separated by the characters <tt>", "</tt> (a comma followed by a
  36074. space). Elements are Converted to strings as by
  36075. <tt>String.ValueOf(long)</tt>. Returns <tt>"null"</tt> if <tt>a</tt>
  36076. is <tt>null</tt>.
  36077. @param a the array whose string representation to return
  36078. @return a string representation of <tt>a</tt>
  36079. @since 1.5
  36080. </member>
  36081. <member name="M:NPOI.Util.Arrays.ToString(System.Int32[])">
  36082. Returns a string representation of the contents of the specified array.
  36083. The string representation consists of a list of the array's elements,
  36084. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  36085. Separated by the characters <tt>", "</tt> (a comma followed by a
  36086. space). Elements are Converted to strings as by
  36087. <tt>String.ValueOf(int)</tt>. Returns <tt>"null"</tt> if <tt>a</tt> is
  36088. <tt>null</tt>.
  36089. @param a the array whose string representation to return
  36090. @return a string representation of <tt>a</tt>
  36091. @since 1.5
  36092. </member>
  36093. <member name="M:NPOI.Util.Arrays.ToString(System.Int16[])">
  36094. Returns a string representation of the contents of the specified array.
  36095. The string representation consists of a list of the array's elements,
  36096. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  36097. Separated by the characters <tt>", "</tt> (a comma followed by a
  36098. space). Elements are Converted to strings as by
  36099. <tt>String.ValueOf(short)</tt>. Returns <tt>"null"</tt> if <tt>a</tt>
  36100. is <tt>null</tt>.
  36101. @param a the array whose string representation to return
  36102. @return a string representation of <tt>a</tt>
  36103. @since 1.5
  36104. </member>
  36105. <member name="M:NPOI.Util.Arrays.ToString(System.Char[])">
  36106. Returns a string representation of the contents of the specified array.
  36107. The string representation consists of a list of the array's elements,
  36108. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  36109. Separated by the characters <tt>", "</tt> (a comma followed by a
  36110. space). Elements are Converted to strings as by
  36111. <tt>String.ValueOf(char)</tt>. Returns <tt>"null"</tt> if <tt>a</tt>
  36112. is <tt>null</tt>.
  36113. @param a the array whose string representation to return
  36114. @return a string representation of <tt>a</tt>
  36115. @since 1.5
  36116. </member>
  36117. <member name="M:NPOI.Util.Arrays.ToString(System.Byte[])">
  36118. Returns a string representation of the contents of the specified array.
  36119. The string representation consists of a list of the array's elements,
  36120. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements
  36121. are Separated by the characters <tt>", "</tt> (a comma followed
  36122. by a space). Elements are Converted to strings as by
  36123. <tt>String.ValueOf(byte)</tt>. Returns <tt>"null"</tt> if
  36124. <tt>a</tt> is <tt>null</tt>.
  36125. @param a the array whose string representation to return
  36126. @return a string representation of <tt>a</tt>
  36127. @since 1.5
  36128. </member>
  36129. <member name="M:NPOI.Util.Arrays.ToString(System.Boolean[])">
  36130. Returns a string representation of the contents of the specified array.
  36131. The string representation consists of a list of the array's elements,
  36132. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  36133. Separated by the characters <tt>", "</tt> (a comma followed by a
  36134. space). Elements are Converted to strings as by
  36135. <tt>String.ValueOf(bool)</tt>. Returns <tt>"null"</tt> if
  36136. <tt>a</tt> is <tt>null</tt>.
  36137. @param a the array whose string representation to return
  36138. @return a string representation of <tt>a</tt>
  36139. @since 1.5
  36140. </member>
  36141. <member name="M:NPOI.Util.Arrays.ToString(System.Single[])">
  36142. Returns a string representation of the contents of the specified array.
  36143. The string representation consists of a list of the array's elements,
  36144. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  36145. Separated by the characters <tt>", "</tt> (a comma followed by a
  36146. space). Elements are Converted to strings as by
  36147. <tt>String.ValueOf(float)</tt>. Returns <tt>"null"</tt> if <tt>a</tt>
  36148. is <tt>null</tt>.
  36149. @param a the array whose string representation to return
  36150. @return a string representation of <tt>a</tt>
  36151. @since 1.5
  36152. </member>
  36153. <member name="M:NPOI.Util.Arrays.ToString(System.Double[])">
  36154. Returns a string representation of the contents of the specified array.
  36155. The string representation consists of a list of the array's elements,
  36156. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  36157. Separated by the characters <tt>", "</tt> (a comma followed by a
  36158. space). Elements are Converted to strings as by
  36159. <tt>String.ValueOf(double)</tt>. Returns <tt>"null"</tt> if <tt>a</tt>
  36160. is <tt>null</tt>.
  36161. @param a the array whose string representation to return
  36162. @return a string representation of <tt>a</tt>
  36163. @since 1.5
  36164. </member>
  36165. <member name="M:NPOI.Util.Arrays.DeepToString(System.Object[])">
  36166. Returns a string representation of the "deep contents" of the specified
  36167. array. If the array Contains other arrays as elements, the string
  36168. representation Contains their contents and so on. This method is
  36169. designed for Converting multidimensional arrays to strings.
  36170. The string representation consists of a list of the array's
  36171. elements, enclosed in square brackets (<tt>"[]"</tt>). Adjacent
  36172. elements are Separated by the characters <tt>", "</tt> (a comma
  36173. followed by a space). Elements are Converted to strings as by
  36174. <tt>String.ValueOf(Object)</tt>, unless they are themselves
  36175. arrays.
  36176. If an element <tt>e</tt> is an array of a primitive type, it is
  36177. Converted to a string as by invoking the appropriate overloading of
  36178. <tt>Arrays.ToString(e)</tt>. If an element <tt>e</tt> is an array of a
  36179. reference type, it is Converted to a string as by invoking
  36180. this method recursively.
  36181. To avoid infInite recursion, if the specified array Contains itself
  36182. as an element, or Contains an indirect reference to itself through one
  36183. or more levels of arrays, the self-reference is Converted to the string
  36184. <tt>"[...]"</tt>. For example, an array Containing only a reference
  36185. to itself would be rendered as <tt>"[[...]]"</tt>.
  36186. This method returns <tt>"null"</tt> if the specified array
  36187. is <tt>null</tt>.
  36188. @param a the array whose string representation to return
  36189. @return a string representation of <tt>a</tt>
  36190. @see #ToString(Object[])
  36191. @since 1.5
  36192. </member>
  36193. <member name="M:NPOI.Util.Arrays.ToString(System.Object[])">
  36194. Returns a string representation of the contents of the specified array.
  36195. If the array contains other arrays as elements, they are converted to
  36196. strings by the {@link Object#toString} method inherited from
  36197. <tt>Object</tt>, which describes their <i>identities</i> rather than
  36198. their contents.
  36199. <p>The value returned by this method is equal to the value that would
  36200. be returned by <tt>Arrays.asList(a).toString()</tt>, unless <tt>a</tt>
  36201. is <tt>null</tt>, in which case <tt>"null"</tt> is returned.</p>
  36202. @param a the array whose string representation to return
  36203. @return a string representation of <tt>a</tt>
  36204. @see #deepToString(Object[])
  36205. @since 1.5
  36206. </member>
  36207. <member name="F:NPOI.Util.BigInteger._signum">
  36208. The signum of this BigInteger: -1 for negative, 0 for zero, or
  36209. 1 for positive. Note that the BigInteger zero <i>must</i> have
  36210. a signum of 0. This is necessary to ensures that there is exactly one
  36211. representation for each BigInteger value.
  36212. @serial
  36213. </member>
  36214. <member name="F:NPOI.Util.BigInteger.mag">
  36215. The magnitude of this BigInteger, in <i>big-endian</i> order: the
  36216. zeroth element of this array is the most-significant int of the
  36217. magnitude. The magnitude must be "minimal" in that the most-significant
  36218. int ({@code mag[0]}) must be non-zero. This is necessary to
  36219. ensure that there is exactly one representation for each BigInteger
  36220. value. Note that this implies that the BigInteger zero has a
  36221. zero-length mag array.
  36222. </member>
  36223. <member name="F:NPOI.Util.BigInteger.bitCount">
  36224. One plus the bitCount of this BigInteger. Zeros means unitialized.
  36225. @serial
  36226. @see #bitCount
  36227. @deprecated Deprecated since logical value is offset from stored
  36228. value and correction factor is applied in accessor method.
  36229. </member>
  36230. <member name="F:NPOI.Util.BigInteger.bitLength">
  36231. One plus the bitLength of this BigInteger. Zeros means unitialized.
  36232. (either value is acceptable).
  36233. @serial
  36234. @see #bitLength()
  36235. @deprecated Deprecated since logical value is offset from stored
  36236. value and correction factor is applied in accessor method.
  36237. </member>
  36238. <member name="F:NPOI.Util.BigInteger.firstNonzeroIntNum">
  36239. Two plus the index of the lowest-order int in the magnitude of this
  36240. BigInteger that contains a nonzero int, or -2 (either value is acceptable).
  36241. The least significant int has int-number 0, the next int in order of
  36242. increasing significance has int-number 1, and so forth.
  36243. @deprecated Deprecated since logical value is offset from stored
  36244. value and correction factor is applied in accessor method.
  36245. </member>
  36246. <member name="F:NPOI.Util.BigInteger.LONG_MASK">
  36247. This mask is used to obtain the value of an int as if it were unsigned.
  36248. </member>
  36249. <member name="M:NPOI.Util.BigInteger.#ctor(System.Int32[],System.Int32)">
  36250. This internal constructor differs from its public cousin
  36251. with the arguments reversed in two ways: it assumes that its
  36252. arguments are correct, and it doesn't copy the magnitude array.
  36253. </member>
  36254. <member name="M:NPOI.Util.BigInteger.#ctor(System.Byte[])">
  36255. Translates a byte array containing the two's-complement binary
  36256. representation of a BigInteger into a BigInteger. The input array is
  36257. assumed to be in <i>big-endian</i> byte-order: the most significant
  36258. byte is in the zeroth element.
  36259. @param val big-endian two's-complement binary representation of
  36260. BigInteger.
  36261. @throws NumberFormatException {@code val} is zero bytes long.
  36262. </member>
  36263. <member name="M:NPOI.Util.BigInteger.#ctor(System.Int32[])">
  36264. This private constructor translates an int array containing the
  36265. two's-complement binary representation of a BigInteger into a
  36266. BigInteger. The input array is assumed to be in <i>big-endian</i>
  36267. int-order: the most significant int is in the zeroth element.
  36268. </member>
  36269. <member name="M:NPOI.Util.BigInteger.#ctor(System.Int64)">
  36270. Constructs a BigInteger with the specified value, which may not be zero.
  36271. </member>
  36272. <member name="M:NPOI.Util.BigInteger.TrustedStripLeadingZeroInts(System.Int32[])">
  36273. Returns the input array stripped of any leading zero bytes.
  36274. Since the source is trusted the copying may be skipped.
  36275. </member>
  36276. <member name="M:NPOI.Util.BigInteger.ToString(System.Int32)">
  36277. Returns the String representation of this BigInteger in the
  36278. given radix. If the radix is outside the range from {@link
  36279. Character#Min_RADIX} to {@link Character#Max_RADIX} inclusive,
  36280. it will default to 10 (as is the case for
  36281. {@code Integer.toString}). The digit-to-character mapping
  36282. provided by {@code Character.forDigit} is used, and a minus
  36283. sign is prepended if appropriate. (This representation is
  36284. compatible with the {@link #BigInteger(String, int) (String,
  36285. int)} constructor.)
  36286. @param radix radix of the String representation.
  36287. @return String representation of this BigInteger in the given radix.
  36288. @see Integer#toString
  36289. @see Character#forDigit
  36290. @see #BigInteger(java.lang.String, int)
  36291. </member>
  36292. <member name="F:NPOI.Util.BigInteger.ZERO">
  36293. The BigInteger constant zero.
  36294. @since 1.2
  36295. </member>
  36296. <member name="F:NPOI.Util.BigInteger.One">
  36297. The BigInteger constant one.
  36298. @since 1.2
  36299. </member>
  36300. <member name="F:NPOI.Util.BigInteger.Two">
  36301. The BigInteger constant two. (Not exported.)
  36302. </member>
  36303. <member name="F:NPOI.Util.BigInteger.TEN">
  36304. The BigInteger constant ten.
  36305. @since 1.5
  36306. </member>
  36307. <member name="M:NPOI.Util.BigInteger.ValueOf(System.Int64)">
  36308. Returns a BigInteger whose value is equal to that of the
  36309. specified {@code long}. This "static factory method" is
  36310. provided in preference to a ({@code long}) constructor
  36311. because it allows for reuse of frequently used BigIntegers.
  36312. @param val value of the BigInteger to return.
  36313. @return a BigInteger with the specified value.
  36314. </member>
  36315. <member name="M:NPOI.Util.BigInteger.ValueOf(System.Int32[])">
  36316. Returns a BigInteger with the given two's complement representation.
  36317. Assumes that the input array will not be modified (the returned
  36318. BigInteger will reference the input array if feasible).
  36319. </member>
  36320. <member name="M:NPOI.Util.BigInteger.BitLengthForInt(System.Int32)">
  36321. Package private method to return bit length for an integer.
  36322. </member>
  36323. <member name="M:NPOI.Util.BigInteger.BitCount">
  36324. Returns the number of bits in the two's complement representation
  36325. of this BigInteger that differ from its sign bit. This method is
  36326. useful when implementing bit-vector style sets atop BigIntegers.
  36327. @return number of bits in the two's complement representation
  36328. of this BigInteger that differ from its sign bit.
  36329. </member>
  36330. <member name="M:NPOI.Util.BigInteger.Abs">
  36331. Returns a BigInteger whose value is the absolute value of this
  36332. BigInteger.
  36333. @return {@code abs(this)}
  36334. </member>
  36335. <member name="M:NPOI.Util.BigInteger.Negate">
  36336. Returns a BigInteger whose value is {@code (-this)}.
  36337. @return {@code -this}
  36338. </member>
  36339. <member name="M:NPOI.Util.BigInteger.Pow(System.Int32)">
  36340. Returns a BigInteger whose value is <c>(this<sup>exponent</sup>)</c>.
  36341. Note that {@code exponent} is an integer rather than a BigInteger.
  36342. @param exponent exponent to which this BigInteger is to be raised.
  36343. @return <c>this<sup>exponent</sup></c>
  36344. @throws ArithmeticException {@code exponent} is negative. (This would
  36345. cause the operation to yield a non-integer value.)
  36346. </member>
  36347. <member name="M:NPOI.Util.BigInteger.MultiplyToLen(System.Int32[],System.Int32,System.Int32[],System.Int32,System.Int32[])">
  36348. Multiplies int arrays x and y to the specified lengths and places
  36349. the result into z. There will be no leading zeros in the resultant array.
  36350. </member>
  36351. <member name="M:NPOI.Util.BigInteger.mulAdd(System.Int32[],System.Int32[],System.Int32,System.Int32,System.Int32)">
  36352. Multiply an array by one word k and add to result, return the carry
  36353. </member>
  36354. <member name="M:NPOI.Util.BigInteger.squareToLen(System.Int32[],System.Int32,System.Int32[])">
  36355. Squares the contents of the int array x. The result is placed into the
  36356. int array z. The contents of x are not changed.
  36357. </member>
  36358. <member name="M:NPOI.Util.BigInteger.addOne(System.Int32[],System.Int32,System.Int32,System.Int32)">
  36359. Add one word to the number a mlen words into a. Return the resulting
  36360. carry.
  36361. </member>
  36362. <member name="M:NPOI.Util.BigInteger.Signum">
  36363. Returns the signum function of this BigInteger.
  36364. @return -1, 0 or 1 as the value of this BigInteger is negative, zero or
  36365. positive.
  36366. </member>
  36367. <member name="M:NPOI.Util.BigInteger.ToByteArray">
  36368. Returns a byte array containing the two's-complement
  36369. representation of this BigInteger. The byte array will be in
  36370. <i>big-endian</i> byte-order: the most significant byte is in
  36371. the zeroth element. The array will contain the minimum number
  36372. of bytes required to represent this BigInteger, including at
  36373. least one sign bit, which is {@code (ceil((this.bitLength() +
  36374. 1)/8))}. (This representation is compatible with the
  36375. {@link #BigInteger(byte[]) (byte[])} constructor.)
  36376. @return a byte array containing the two's-complement representation of
  36377. this BigInteger.
  36378. @see #BigInteger(byte[])
  36379. </member>
  36380. <member name="M:NPOI.Util.BigInteger.intLength">
  36381. Returns the length of the two's complement representation in ints,
  36382. including space for at least one sign bit.
  36383. </member>
  36384. <member name="M:NPOI.Util.BigInteger.GetInt(System.Int32)">
  36385. Returns the specified int of the little-endian two's complement
  36386. representation (int 0 is the least significant). The int number can
  36387. be arbitrarily high (values are logically preceded by infinitely many
  36388. sign ints).
  36389. </member>
  36390. <member name="M:NPOI.Util.BigInteger.FirstNonzeroIntNum">
  36391. Returns the index of the int that contains the first nonzero int in the
  36392. little-endian binary representation of the magnitude (int 0 is the
  36393. least significant). If the magnitude is zero, return value is undefined.
  36394. </member>
  36395. <member name="M:NPOI.Util.BigInteger.stripLeadingZeroBytes(System.Byte[])">
  36396. Returns a copy of the input array stripped of any leading zero bytes.
  36397. </member>
  36398. <member name="M:NPOI.Util.BigInteger.makePositive(System.Byte[])">
  36399. Takes an array a representing a negative 2's-complement number and
  36400. returns the minimal (no leading zero bytes) unsigned whose value is -a.
  36401. </member>
  36402. <member name="M:NPOI.Util.BigInteger.makePositive(System.Int32[])">
  36403. Takes an array a representing a negative 2's-complement number and
  36404. returns the minimal (no leading zero ints) unsigned whose value is -a.
  36405. </member>
  36406. <member name="M:NPOI.Util.BigInteger.NumberOfLeadingZeros(System.Int32)">
  36407. Returns the number of zero bits preceding the highest-order
  36408. ("leftmost") one-bit in the two's complement binary representation
  36409. of the specified {@code int} value. Returns 32 if the
  36410. specified value has no one-bits in its two's complement representation,
  36411. in other words if it is equal to zero.
  36412. Note that this method is closely related to the logarithm base 2.
  36413. For all positive {@code int} values x:
  36414. <ul>
  36415. <li>floor(log<sub>2</sub>(x)) = {@code 31 - numberOfLeadingZeros(x)}</li>
  36416. <li>ceil(log<sub>2</sub>(x)) = {@code 32 - numberOfLeadingZeros(x - 1)}</li>
  36417. </ul>
  36418. @return the number of zero bits preceding the highest-order
  36419. ("leftmost") one-bit in the two's complement binary representation
  36420. of the specified {@code int} value, or 32 if the value
  36421. is equal to zero.
  36422. @since 1.5
  36423. </member>
  36424. <member name="M:NPOI.Util.BigInteger.NumberOfTrailingZeros(System.Int32)">
  36425. Returns the number of zero bits following the lowest-order ("rightmost")
  36426. one-bit in the two's complement binary representation of the specified
  36427. {@code int} value. Returns 32 if the specified value has no
  36428. one-bits in its two's complement representation, in other words if it is
  36429. equal to zero.
  36430. @return the number of zero bits following the lowest-order ("rightmost")
  36431. one-bit in the two's complement binary representation of the
  36432. specified {@code int} value, or 32 if the value is equal
  36433. to zero.
  36434. @since 1.5
  36435. </member>
  36436. <member name="M:NPOI.Util.BigInteger.BitCountForInt(System.Int32)">
  36437. Returns the number of one-bits in the two's complement binary
  36438. representation of the specified {@code int} value. This function is
  36439. sometimes referred to as the <i>population count</i>.
  36440. @return the number of one-bits in the two's complement binary
  36441. representation of the specified {@code int} value.
  36442. @since 1.5
  36443. </member>
  36444. <member name="M:NPOI.Util.BigInteger.compareMagnitude(NPOI.Util.BigInteger)">
  36445. Compares the magnitude array of this BigInteger with the specified
  36446. BigInteger's. This is the version of compareTo ignoring sign.
  36447. @param val BigInteger whose magnitude array to be compared.
  36448. @return -1, 0 or 1 as this magnitude array is less than, equal to or
  36449. greater than the magnitude aray for the specified BigInteger's.
  36450. </member>
  36451. <member name="M:NPOI.Util.BigInteger.Equals(System.Object)">
  36452. Compares this BigInteger with the specified Object for equality.
  36453. @param x Object to which this BigInteger is to be compared.
  36454. @return {@code true} if and only if the specified Object is a
  36455. BigInteger whose value is numerically equal to this BigInteger.
  36456. </member>
  36457. <member name="M:NPOI.Util.BigInteger.Min(NPOI.Util.BigInteger)">
  36458. Returns the minimum of this BigInteger and {@code val}.
  36459. @param val value with which the minimum is to be computed.
  36460. @return the BigInteger whose value is the lesser of this BigInteger and
  36461. {@code val}. If they are equal, either may be returned.
  36462. </member>
  36463. <member name="M:NPOI.Util.BigInteger.Max(NPOI.Util.BigInteger)">
  36464. Returns the maximum of this BigInteger and {@code val}.
  36465. @param val value with which the maximum is to be computed.
  36466. @return the BigInteger whose value is the greater of this and
  36467. {@code val}. If they are equal, either may be returned.
  36468. </member>
  36469. <member name="M:NPOI.Util.BigInteger.GetHashCode">
  36470. Returns the hash code for this BigInteger.
  36471. @return hash code for this BigInteger.
  36472. </member>
  36473. <member name="M:NPOI.Util.BigInteger.IntValue">
  36474. Converts this BigInteger to an {@code int}. This
  36475. conversion is analogous to a
  36476. <i>narrowing primitive conversion</i> from {@code long} to
  36477. {@code int} as defined in section 5.1.3 of
  36478. <cite>The Java(TM) Language Specification</cite>:
  36479. if this BigInteger is too big to fit in an
  36480. {@code int}, only the low-order 32 bits are returned.
  36481. Note that this conversion can lose information about the
  36482. overall magnitude of the BigInteger value as well as return a
  36483. result with the opposite sign.
  36484. @return this BigInteger converted to an {@code int}.
  36485. </member>
  36486. <member name="M:NPOI.Util.BigInteger.LongValue">
  36487. Converts this BigInteger to a {@code long}. This
  36488. conversion is analogous to a
  36489. <i>narrowing primitive conversion</i> from {@code long} to
  36490. {@code int} as defined in section 5.1.3 of
  36491. <cite>The Java(TM) Language Specification</cite>:
  36492. if this BigInteger is too big to fit in a
  36493. {@code long}, only the low-order 64 bits are returned.
  36494. Note that this conversion can lose information about the
  36495. overall magnitude of the BigInteger value as well as return a
  36496. result with the opposite sign.
  36497. @return this BigInteger converted to a {@code long}.
  36498. </member>
  36499. <member name="M:NPOI.Util.BigInteger.ShiftRight(System.Int32)">
  36500. Returns a BigInteger whose value is {@code (this >> n)}. Sign
  36501. extension is performed. The shift distance, {@code n}, may be
  36502. negative, in which case this method performs a left shift.
  36503. (Computes <c>floor(this / 2<sup>n</sup>)</c>.)
  36504. @param n shift distance, in bits.
  36505. @return {@code this >> n}
  36506. @throws ArithmeticException if the shift distance is {@code
  36507. Integer.Min_VALUE}.
  36508. @see #shiftLeft
  36509. </member>
  36510. <member name="M:NPOI.Util.BigInteger.Not">
  36511. Returns a BigInteger whose value is {@code (~this)}. (This method
  36512. returns a negative value if and only if this BigInteger is
  36513. non-negative.)
  36514. @return {@code ~this}
  36515. </member>
  36516. <member name="M:NPOI.Util.BigInteger.Or(NPOI.Util.BigInteger)">
  36517. Returns a BigInteger whose value is {@code (this | val)}. (This method
  36518. returns a negative BigInteger if and only if either this or val is
  36519. negative.)
  36520. @param val value to be OR'ed with this BigInteger.
  36521. @return {@code this | val}
  36522. </member>
  36523. <member name="M:NPOI.Util.BigInteger.Multiply(System.Int64)">
  36524. Package private methods used by BigDecimal code to multiply a BigInteger
  36525. with a long. Assumes v is not equal to INFLATED.
  36526. </member>
  36527. <member name="M:NPOI.Util.BigInteger.Multiply(NPOI.Util.BigInteger)">
  36528. Returns a BigInteger whose value is {@code (this * val)}.
  36529. @param val value to be multiplied by this BigInteger.
  36530. @return {@code this * val}
  36531. </member>
  36532. <member name="M:NPOI.Util.BigInteger.Add(NPOI.Util.BigInteger)">
  36533. Returns a BigInteger whose value is {@code (this + val)}.
  36534. @param val value to be added to this BigInteger.
  36535. @return {@code this + val}
  36536. </member>
  36537. <member name="M:NPOI.Util.BigInteger.add(System.Int32[],System.Int32[])">
  36538. Adds the contents of the int arrays x and y. This method allocates
  36539. a new int array to hold the answer and returns a reference to that
  36540. array.
  36541. </member>
  36542. <member name="M:NPOI.Util.BigInteger.Subtract(NPOI.Util.BigInteger)">
  36543. Returns a BigInteger whose value is {@code (this - val)}.
  36544. @param val value to be subtracted from this BigInteger.
  36545. @return {@code this - val}
  36546. </member>
  36547. <member name="M:NPOI.Util.BigInteger.Subtract(System.Int32[],System.Int32[])">
  36548. Subtracts the contents of the second int arrays (little) from the
  36549. first (big). The first int array (big) must represent a larger number
  36550. than the second. This method allocates the space necessary to hold the
  36551. answer.
  36552. </member>
  36553. <member name="M:NPOI.Util.BigInteger.Divide(NPOI.Util.BigInteger)">
  36554. Returns a BigInteger whose value is {@code (this / val)}.
  36555. @param val value by which this BigInteger is to be divided.
  36556. @return {@code this / val}
  36557. @throws ArithmeticException if {@code val} is zero.
  36558. </member>
  36559. <member name="F:NPOI.Util.MutableBigInteger._value">
  36560. Holds the magnitude of this MutableBigInteger in big endian order.
  36561. The magnitude may start at an offset into the value array, and it may
  36562. end before the length of the value array.
  36563. </member>
  36564. <member name="F:NPOI.Util.MutableBigInteger.intLen">
  36565. The number of ints of the value array that are currently used
  36566. to hold the magnitude of this MutableBigInteger. The magnitude starts
  36567. at an offset and offset + intLen may be less than value.Length.
  36568. </member>
  36569. <member name="F:NPOI.Util.MutableBigInteger.offset">
  36570. The offset into the value array where the magnitude of this
  36571. MutableBigInteger begins.
  36572. </member>
  36573. <member name="F:NPOI.Util.MutableBigInteger.One">
  36574. MutableBigInteger with one element value array with the value 1. Used by
  36575. BigDecimal divideAndRound to increment the quotient. Use this constant
  36576. only when the method is not going to modify this object.
  36577. </member>
  36578. <member name="M:NPOI.Util.MutableBigInteger.#ctor">
  36579. The default constructor. An empty MutableBigInteger is created with
  36580. a one word capacity.
  36581. </member>
  36582. <member name="M:NPOI.Util.MutableBigInteger.#ctor(System.Int32)">
  36583. Construct a new MutableBigInteger with a magnitude specified by
  36584. the int val.
  36585. </member>
  36586. <member name="M:NPOI.Util.MutableBigInteger.#ctor(System.Int32[])">
  36587. Construct a new MutableBigInteger with the specified value array
  36588. up to the length of the array supplied.
  36589. </member>
  36590. <member name="M:NPOI.Util.MutableBigInteger.#ctor(NPOI.Util.BigInteger)">
  36591. Construct a new MutableBigInteger with a magnitude equal to the
  36592. specified BigInteger.
  36593. </member>
  36594. <member name="M:NPOI.Util.MutableBigInteger.#ctor(NPOI.Util.MutableBigInteger)">
  36595. Construct a new MutableBigInteger with a magnitude equal to the
  36596. specified MutableBigInteger.
  36597. </member>
  36598. <member name="M:NPOI.Util.MutableBigInteger.getMagnitudeArray">
  36599. Internal helper method to return the magnitude array. The caller is not
  36600. supposed to modify the returned array.
  36601. </member>
  36602. <member name="M:NPOI.Util.MutableBigInteger.toLong">
  36603. Convert this MutableBigInteger to a long value. The caller has to make
  36604. sure this MutableBigInteger can be fit into long.
  36605. </member>
  36606. <member name="M:NPOI.Util.MutableBigInteger.toBigInteger(System.Int32)">
  36607. Convert this MutableBigInteger to a BigInteger object.
  36608. </member>
  36609. <member name="M:NPOI.Util.MutableBigInteger.clear">
  36610. Clear out a MutableBigInteger for reuse.
  36611. </member>
  36612. <member name="M:NPOI.Util.MutableBigInteger.reset">
  36613. Set a MutableBigInteger to zero, removing its offset.
  36614. </member>
  36615. <member name="M:NPOI.Util.MutableBigInteger.compare(NPOI.Util.MutableBigInteger)">
  36616. Compare the magnitude of two MutableBigIntegers. Returns -1, 0 or 1
  36617. as this MutableBigInteger is numerically less than, equal to, or
  36618. greater than <c>b</c>.
  36619. </member>
  36620. <member name="M:NPOI.Util.MutableBigInteger.compareHalf(NPOI.Util.MutableBigInteger)">
  36621. Compare this against half of a MutableBigInteger object (Needed for
  36622. remainder tests).
  36623. Assumes no leading unnecessary zeros, which holds for results
  36624. from divide().
  36625. </member>
  36626. <member name="M:NPOI.Util.MutableBigInteger.getLowestSetBit">
  36627. Return the index of the lowest set bit in this MutableBigInteger. If the
  36628. magnitude of this MutableBigInteger is zero, -1 is returned.
  36629. </member>
  36630. <member name="M:NPOI.Util.MutableBigInteger.getInt(System.Int32)">
  36631. Return the int in use in this MutableBigInteger at the specified
  36632. index. This method is not used because it is not inlined on all
  36633. platforms.
  36634. </member>
  36635. <member name="M:NPOI.Util.MutableBigInteger.getLong(System.Int32)">
  36636. Return a long which is equal to the unsigned value of the int in
  36637. use in this MutableBigInteger at the specified index. This method is
  36638. not used because it is not inlined on all platforms.
  36639. </member>
  36640. <member name="M:NPOI.Util.MutableBigInteger.normalize">
  36641. Ensure that the MutableBigInteger is in normal form, specifically
  36642. making sure that there are no leading zeros, and that if the
  36643. magnitude is zero, then intLen is zero.
  36644. </member>
  36645. <member name="M:NPOI.Util.MutableBigInteger.ensureCapacity(System.Int32)">
  36646. If this MutableBigInteger cannot hold len words, increase the size
  36647. of the value array to len words.
  36648. </member>
  36649. <member name="M:NPOI.Util.MutableBigInteger.toIntArray">
  36650. Convert this MutableBigInteger into an int array with no leading
  36651. zeros, of a length that is equal to this MutableBigInteger's intLen.
  36652. </member>
  36653. <member name="M:NPOI.Util.MutableBigInteger.setInt(System.Int32,System.Int32)">
  36654. Sets the int at index+offset in this MutableBigInteger to val.
  36655. This does not get inlined on all platforms so it is not used
  36656. as often as originally intended.
  36657. </member>
  36658. <member name="M:NPOI.Util.MutableBigInteger.setValue(System.Int32[],System.Int32)">
  36659. Sets this MutableBigInteger's value array to the specified array.
  36660. The intLen is set to the specified length.
  36661. </member>
  36662. <member name="M:NPOI.Util.MutableBigInteger.copyValue(NPOI.Util.MutableBigInteger)">
  36663. Sets this MutableBigInteger's value array to a copy of the specified
  36664. array. The intLen is set to the length of the new array.
  36665. </member>
  36666. <member name="M:NPOI.Util.MutableBigInteger.copyValue(System.Int32[])">
  36667. Sets this MutableBigInteger's value array to a copy of the specified
  36668. array. The intLen is set to the length of the specified array.
  36669. </member>
  36670. <member name="M:NPOI.Util.MutableBigInteger.isOne">
  36671. Returns true iff this MutableBigInteger has a value of one.
  36672. </member>
  36673. <member name="M:NPOI.Util.MutableBigInteger.isZero">
  36674. Returns true iff this MutableBigInteger has a value of zero.
  36675. </member>
  36676. <member name="M:NPOI.Util.MutableBigInteger.isEven">
  36677. Returns true iff this MutableBigInteger is even.
  36678. </member>
  36679. <member name="M:NPOI.Util.MutableBigInteger.isOdd">
  36680. Returns true iff this MutableBigInteger is odd.
  36681. </member>
  36682. <member name="M:NPOI.Util.MutableBigInteger.isNormal">
  36683. Returns true iff this MutableBigInteger is in normal form. A
  36684. MutableBigInteger is in normal form if it has no leading zeros
  36685. after the offset, and intLen + offset &lt;= value.Length.
  36686. </member>
  36687. <member name="M:NPOI.Util.MutableBigInteger.toString">
  36688. Returns a String representation of this MutableBigInteger in radix 10.
  36689. </member>
  36690. <member name="M:NPOI.Util.MutableBigInteger.rightShift(System.Int32)">
  36691. Right shift this MutableBigInteger n bits. The MutableBigInteger is left
  36692. in normal form.
  36693. </member>
  36694. <member name="M:NPOI.Util.MutableBigInteger.leftShift(System.Int32)">
  36695. Left shift this MutableBigInteger n bits.
  36696. </member>
  36697. <member name="M:NPOI.Util.MutableBigInteger.divadd(System.Int32[],System.Int32[],System.Int32)">
  36698. A primitive used for division. This method adds in one multiple of the
  36699. divisor a back to the dividend result at a specified offset. It is used
  36700. when qhat was estimated too large, and must be adjusted.
  36701. </member>
  36702. <member name="M:NPOI.Util.MutableBigInteger.mulsub(System.Int32[],System.Int32[],System.Int32,System.Int32,System.Int32)">
  36703. This method is used for division. It multiplies an n word input a by one
  36704. word input x, and subtracts the n word product from q. This is needed
  36705. when subtracting qhat*divisor from dividend.
  36706. </member>
  36707. <member name="M:NPOI.Util.MutableBigInteger.primitiveRightShift(System.Int32)">
  36708. Right shift this MutableBigInteger n bits, where n is
  36709. less than 32.
  36710. Assumes that intLen > 0, n > 0 for speed
  36711. </member>
  36712. <member name="M:NPOI.Util.MutableBigInteger.primitiveLeftShift(System.Int32)">
  36713. Left shift this MutableBigInteger n bits, where n is
  36714. less than 32.
  36715. Assumes that intLen > 0, n > 0 for speed
  36716. </member>
  36717. <member name="M:NPOI.Util.MutableBigInteger.add(NPOI.Util.MutableBigInteger)">
  36718. Adds the contents of two MutableBigInteger objects.The result
  36719. is placed within this MutableBigInteger.
  36720. The contents of the addend are not changed.
  36721. </member>
  36722. <member name="M:NPOI.Util.MutableBigInteger.subtract(NPOI.Util.MutableBigInteger)">
  36723. Subtracts the smaller of this and b from the larger and places the
  36724. result into this MutableBigInteger.
  36725. </member>
  36726. <member name="M:NPOI.Util.MutableBigInteger.difference(NPOI.Util.MutableBigInteger)">
  36727. Subtracts the smaller of a and b from the larger and places the result
  36728. into the larger. Returns 1 if the answer is in a, -1 if in b, 0 if no
  36729. operation was performed.
  36730. </member>
  36731. <member name="M:NPOI.Util.MutableBigInteger.multiply(NPOI.Util.MutableBigInteger,NPOI.Util.MutableBigInteger)">
  36732. Multiply the contents of two MutableBigInteger objects. The result is
  36733. placed into MutableBigInteger z. The contents of y are not changed.
  36734. </member>
  36735. <member name="M:NPOI.Util.MutableBigInteger.mul(System.Int32,NPOI.Util.MutableBigInteger)">
  36736. Multiply the contents of this MutableBigInteger by the word y. The
  36737. result is placed into z.
  36738. </member>
  36739. <member name="M:NPOI.Util.MutableBigInteger.divideOneWord(System.Int32,NPOI.Util.MutableBigInteger)">
  36740. This method is used for division of an n word dividend by a one word
  36741. divisor. The quotient is placed into quotient. The one word divisor is
  36742. specified by divisor.
  36743. @return the remainder of the division is returned.
  36744. </member>
  36745. <member name="M:NPOI.Util.MutableBigInteger.divide(NPOI.Util.MutableBigInteger,NPOI.Util.MutableBigInteger)">
  36746. Calculates the quotient of this div b and places the quotient in the
  36747. provided MutableBigInteger objects and the remainder object is returned.
  36748. Uses Algorithm D in Knuth section 4.3.1.
  36749. Many optimizations to that algorithm have been adapted from the Colin
  36750. Plumb C library.
  36751. It special cases one word divisors for speed. The content of b is not
  36752. changed.
  36753. </member>
  36754. <member name="M:NPOI.Util.MutableBigInteger.divide(System.Int64,NPOI.Util.MutableBigInteger)">
  36755. Internally used to calculate the quotient of this div v and places the
  36756. quotient in the provided MutableBigInteger object and the remainder is
  36757. returned.
  36758. @return the remainder of the division will be returned.
  36759. </member>
  36760. <member name="M:NPOI.Util.MutableBigInteger.divideMagnitude(System.Int32[],NPOI.Util.MutableBigInteger)">
  36761. Divide this MutableBigInteger by the divisor represented by its magnitude
  36762. array. The quotient will be placed into the provided quotient object &amp;
  36763. the remainder object is returned.
  36764. </member>
  36765. <member name="M:NPOI.Util.MutableBigInteger.unsignedLongCompare(System.Int64,System.Int64)">
  36766. Compare two longs as if they were unsigned.
  36767. Returns true iff one is bigger than two.
  36768. </member>
  36769. <member name="M:NPOI.Util.MutableBigInteger.divWord(System.Int32[],System.Int64,System.Int32)">
  36770. This method divides a long quantity by an int to estimate
  36771. qhat for two multi precision numbers. It is used when
  36772. the signed value of n is less than zero.
  36773. </member>
  36774. <member name="M:NPOI.Util.MutableBigInteger.hybridGCD(NPOI.Util.MutableBigInteger)">
  36775. Calculate GCD of this and b. This and b are changed by the computation.
  36776. </member>
  36777. <member name="M:NPOI.Util.MutableBigInteger.binaryGCD(NPOI.Util.MutableBigInteger)">
  36778. Calculate GCD of this and v.
  36779. Assumes that this and v are not zero.
  36780. </member>
  36781. <member name="M:NPOI.Util.MutableBigInteger.binaryGcd(System.Int32,System.Int32)">
  36782. Calculate GCD of a and b interpreted as unsigned integers.
  36783. </member>
  36784. <member name="M:NPOI.Util.MutableBigInteger.mutableModInverse(NPOI.Util.MutableBigInteger)">
  36785. Returns the modInverse of this mod p. This and p are not affected by
  36786. the operation.
  36787. </member>
  36788. <member name="M:NPOI.Util.MutableBigInteger.modInverse(NPOI.Util.MutableBigInteger)">
  36789. Calculate the multiplicative inverse of this mod mod, where mod is odd.
  36790. This and mod are not changed by the calculation.
  36791. This method implements an algorithm due to Richard Schroeppel, that uses
  36792. the same intermediate representation as Montgomery Reduction
  36793. ("Montgomery Form"). The algorithm is described in an unpublished
  36794. manuscript entitled "Fast Modular Reciprocals."
  36795. </member>
  36796. <member name="M:NPOI.Util.MutableBigInteger.euclidModInverse(System.Int32)">
  36797. Uses the extended Euclidean algorithm to compute the modInverse of base
  36798. mod a modulus that is a power of 2. The modulus is 2^k.
  36799. </member>
  36800. <member name="T:NPOI.Util.BitField">
  36801. <summary>
  36802. Manage operations dealing with bit-mapped fields.
  36803. @author Marc Johnson (mjohnson at apache dot org)
  36804. @author Andrew C. Oliver (acoliver at apache dot org)
  36805. </summary>
  36806. </member>
  36807. <member name="M:NPOI.Util.BitField.#ctor(System.Int32)">
  36808. <summary>
  36809. Create a <see cref="T:NPOI.Util.BitField"/> instance
  36810. </summary>
  36811. <param name="mask">
  36812. the mask specifying which bits apply to this
  36813. BitField. Bits that are set in this mask are the
  36814. bits that this BitField operates on
  36815. </param>
  36816. </member>
  36817. <member name="M:NPOI.Util.BitField.#ctor(System.UInt32)">
  36818. <summary>
  36819. Create a <see cref="T:NPOI.Util.BitField"/> instance
  36820. </summary>
  36821. <param name="mask">
  36822. the mask specifying which bits apply to this
  36823. BitField. Bits that are set in this mask are the
  36824. bits that this BitField operates on
  36825. </param>
  36826. </member>
  36827. <member name="M:NPOI.Util.BitField.Clear(System.Int32)">
  36828. <summary>
  36829. Clear the bits.
  36830. </summary>
  36831. <param name="holder">the int data containing the bits we're interested in</param>
  36832. <returns>the value of holder with the specified bits cleared (set to 0)</returns>
  36833. </member>
  36834. <member name="M:NPOI.Util.BitField.ClearShort(System.Int16)">
  36835. <summary>
  36836. Clear the bits.
  36837. </summary>
  36838. <param name="holder">the short data containing the bits we're interested in</param>
  36839. <returns>the value of holder with the specified bits cleared (set to 0)</returns>
  36840. </member>
  36841. <member name="M:NPOI.Util.BitField.GetRawValue(System.Int32)">
  36842. <summary>
  36843. Obtain the value for the specified BitField, appropriately
  36844. shifted right. Many users of a BitField will want to treat the
  36845. specified bits as an int value, and will not want to be aware
  36846. that the value is stored as a BitField (and so shifted left so
  36847. many bits)
  36848. </summary>
  36849. <param name="holder">the int data containing the bits we're interested in</param>
  36850. <returns>the selected bits, shifted right appropriately</returns>
  36851. </member>
  36852. <member name="M:NPOI.Util.BitField.GetShortRawValue(System.Int16)">
  36853. <summary>
  36854. Obtain the value for the specified BitField, unshifted
  36855. </summary>
  36856. <param name="holder">the short data containing the bits we're interested in</param>
  36857. <returns>the selected bits</returns>
  36858. </member>
  36859. <member name="M:NPOI.Util.BitField.GetShortValue(System.Int16)">
  36860. <summary>
  36861. Obtain the value for the specified BitField, appropriately
  36862. shifted right, as a short. Many users of a BitField will want
  36863. to treat the specified bits as an int value, and will not want
  36864. to be aware that the value is stored as a BitField (and so
  36865. shifted left so many bits)
  36866. </summary>
  36867. <param name="holder">the short data containing the bits we're interested in</param>
  36868. <returns>the selected bits, shifted right appropriately</returns>
  36869. </member>
  36870. <member name="M:NPOI.Util.BitField.GetValue(System.Int32)">
  36871. <summary>
  36872. Obtain the value for the specified BitField, appropriately
  36873. shifted right. Many users of a BitField will want to treat the
  36874. specified bits as an int value, and will not want to be aware
  36875. that the value is stored as a BitField (and so shifted left so
  36876. many bits)
  36877. </summary>
  36878. <param name="holder">the int data containing the bits we're interested in</param>
  36879. <returns>the selected bits, shifted right appropriately</returns>
  36880. </member>
  36881. <member name="M:NPOI.Util.BitField.IsAllSet(System.Int32)">
  36882. <summary>
  36883. Are all of the bits set or not? This is a stricter test than
  36884. isSet, in that all of the bits in a multi-bit set must be set
  36885. for this method to return true
  36886. </summary>
  36887. <param name="holder">the int data containing the bits we're interested in</param>
  36888. <returns>
  36889. <c>true</c> if all of the bits are set otherwise, <c>false</c>.
  36890. </returns>
  36891. </member>
  36892. <member name="M:NPOI.Util.BitField.IsSet(System.Int32)">
  36893. <summary>
  36894. is the field set or not? This is most commonly used for a
  36895. single-bit field, which is often used to represent a boolean
  36896. value; the results of using it for a multi-bit field is to
  36897. determine whether *any* of its bits are set
  36898. </summary>
  36899. <param name="holder">the int data containing the bits we're interested in</param>
  36900. <returns>
  36901. <c>true</c> if any of the bits are set; otherwise, <c>false</c>.
  36902. </returns>
  36903. </member>
  36904. <member name="M:NPOI.Util.BitField.Set(System.Int32)">
  36905. <summary>
  36906. Set the bits.
  36907. </summary>
  36908. <param name="holder">the int data containing the bits we're interested in</param>
  36909. <returns>the value of holder with the specified bits set to 1</returns>
  36910. </member>
  36911. <member name="M:NPOI.Util.BitField.SetBoolean(System.Int32,System.Boolean)">
  36912. <summary>
  36913. Set a boolean BitField
  36914. </summary>
  36915. <param name="holder">the int data containing the bits we're interested in</param>
  36916. <param name="flag">indicating whether to set or clear the bits</param>
  36917. <returns>the value of holder with the specified bits set or cleared</returns>
  36918. </member>
  36919. <member name="M:NPOI.Util.BitField.SetShort(System.Int16)">
  36920. <summary>
  36921. Set the bits.
  36922. </summary>
  36923. <param name="holder">the short data containing the bits we're interested in</param>
  36924. <returns>the value of holder with the specified bits set to 1</returns>
  36925. </member>
  36926. <member name="M:NPOI.Util.BitField.SetShortBoolean(System.Int16,System.Boolean)">
  36927. <summary>
  36928. Set a boolean BitField
  36929. </summary>
  36930. <param name="holder">the short data containing the bits we're interested in</param>
  36931. <param name="flag">indicating whether to set or clear the bits</param>
  36932. <returns>the value of holder with the specified bits set or cleared</returns>
  36933. </member>
  36934. <member name="M:NPOI.Util.BitField.SetShortValue(System.Int16,System.Int16)">
  36935. <summary>
  36936. Obtain the value for the specified BitField, appropriately
  36937. shifted right, as a short. Many users of a BitField will want
  36938. to treat the specified bits as an int value, and will not want
  36939. to be aware that the value is stored as a BitField (and so
  36940. shifted left so many bits)
  36941. </summary>
  36942. <param name="holder">the short data containing the bits we're interested in</param>
  36943. <param name="value">the new value for the specified bits</param>
  36944. <returns>the selected bits, shifted right appropriately</returns>
  36945. </member>
  36946. <member name="M:NPOI.Util.BitField.SetValue(System.Int32,System.Int32)">
  36947. <summary>
  36948. Sets the value.
  36949. </summary>
  36950. <param name="holder">the byte data containing the bits we're interested in</param>
  36951. <param name="value">The value.</param>
  36952. <returns></returns>
  36953. </member>
  36954. <member name="M:NPOI.Util.BitField.SetByteBoolean(System.Byte,System.Boolean)">
  36955. <summary>
  36956. Set a boolean BitField
  36957. </summary>
  36958. <param name="holder"> the byte data containing the bits we're interested in</param>
  36959. <param name="flag">indicating whether to set or clear the bits</param>
  36960. <returns>the value of holder with the specified bits set or cleared</returns>
  36961. </member>
  36962. <member name="M:NPOI.Util.BitField.ClearByte(System.Byte)">
  36963. <summary>
  36964. Clears the bits.
  36965. </summary>
  36966. <param name="holder">the byte data containing the bits we're interested in</param>
  36967. <returns>the value of holder with the specified bits cleared</returns>
  36968. </member>
  36969. <member name="M:NPOI.Util.BitField.SetByte(System.Byte)">
  36970. <summary>
  36971. Set the bits.
  36972. </summary>
  36973. <param name="holder">the byte data containing the bits we're interested in</param>
  36974. <returns>the value of holder with the specified bits set to 1</returns>
  36975. </member>
  36976. <member name="T:NPOI.Util.BitFieldFactory">
  36977. <summary>
  36978. Returns immutable Btfield instances.
  36979. @author Jason Height (jheight at apache dot org)
  36980. </summary>
  36981. </member>
  36982. <member name="M:NPOI.Util.BitFieldFactory.GetInstance(System.Int32)">
  36983. <summary>
  36984. Gets the instance.
  36985. </summary>
  36986. <param name="mask">The mask.</param>
  36987. <returns></returns>
  36988. </member>
  36989. <member name="M:NPOI.Util.ByteBuffer.Remaining">
  36990. <summary>
  36991. Returns the number of elements between the current position and the limit.
  36992. </summary>
  36993. <returns>The number of elements remaining in this buffer</returns>
  36994. </member>
  36995. <member name="M:NPOI.Util.ByteBuffer.HasRemaining">
  36996. <summary>
  36997. Tells whether there are any elements between the current position and the limit.
  36998. </summary>
  36999. <returns>true if, and only if, there is at least one element remaining in this buffer</returns>
  37000. </member>
  37001. <member name="T:NPOI.Util.ByteField">
  37002. <summary>
  37003. representation of a byte (8-bit) field at a fixed location within a
  37004. byte array
  37005. @author Marc Johnson (mjohnson at apache dot org
  37006. </summary>
  37007. </member>
  37008. <member name="M:NPOI.Util.ByteField.#ctor(System.Int32)">
  37009. <summary>
  37010. Initializes a new instance of the <see cref="T:NPOI.Util.ByteField"/> class.
  37011. </summary>
  37012. <param name="offset">The offset.</param>
  37013. </member>
  37014. <member name="M:NPOI.Util.ByteField.#ctor(System.Int32,System.Byte)">
  37015. <summary>
  37016. Initializes a new instance of the <see cref="T:NPOI.Util.ByteField"/> class.
  37017. </summary>
  37018. <param name="offset">The offset.</param>
  37019. <param name="value">The value.</param>
  37020. </member>
  37021. <member name="M:NPOI.Util.ByteField.#ctor(System.Int32,System.Byte[])">
  37022. <summary>
  37023. Initializes a new instance of the <see cref="T:NPOI.Util.ByteField"/> class.
  37024. </summary>
  37025. <param name="offset">The offset.</param>
  37026. <param name="data">The data.</param>
  37027. </member>
  37028. <member name="M:NPOI.Util.ByteField.#ctor(System.Int32,System.Byte,System.Byte[])">
  37029. <summary>
  37030. Initializes a new instance of the <see cref="T:NPOI.Util.ByteField"/> class.
  37031. </summary>
  37032. <param name="offset">The offset.</param>
  37033. <param name="_value">The _value.</param>
  37034. <param name="data">The data.</param>
  37035. </member>
  37036. <member name="P:NPOI.Util.ByteField.Value">
  37037. <summary>
  37038. Gets or sets the value.
  37039. </summary>
  37040. <value>The value.</value>
  37041. </member>
  37042. <member name="M:NPOI.Util.ByteField.ReadFromBytes(System.Byte[])">
  37043. <summary>
  37044. set the value from its offset into an array of bytes
  37045. </summary>
  37046. <param name="data">the byte array from which the value is to be read</param>
  37047. </member>
  37048. <member name="M:NPOI.Util.ByteField.ReadFromStream(System.IO.Stream)">
  37049. <summary>
  37050. set the value from an Stream
  37051. </summary>
  37052. <param name="stream">the Stream from which the value is to be read</param>
  37053. </member>
  37054. <member name="M:NPOI.Util.ByteField.Set(System.Byte,System.Byte[])">
  37055. <summary>
  37056. set the ByteField's current value and write it to a byte array
  37057. </summary>
  37058. <param name="value">value to be set</param>
  37059. <param name="data">the byte array to write the value to</param>
  37060. </member>
  37061. <member name="M:NPOI.Util.ByteField.ToString">
  37062. <summary>
  37063. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  37064. </summary>
  37065. <returns>
  37066. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  37067. </returns>
  37068. </member>
  37069. <member name="M:NPOI.Util.ByteField.WriteToBytes(System.Byte[])">
  37070. <summary>
  37071. write the value out to an array of bytes at the appropriate offset
  37072. </summary>
  37073. <param name="data">the array of bytes to which the value is to be written</param>
  37074. </member>
  37075. <member name="T:NPOI.Util.ClassID">
  37076. <summary>
  37077. Represents a class ID (16 bytes). Unlike other little-endian
  37078. type the {@link ClassID} is not just 16 bytes stored in the wrong
  37079. order. Instead, it is a double word (4 bytes) followed by two
  37080. words (2 bytes each) followed by 8 bytes.
  37081. @author Rainer Klute
  37082. <a href="mailto:klute@rainer-klute.de">klute@rainer-klute.de</a>
  37083. @version $Id: ClassID.java 489730 2006-12-22 19:18:16Z bayard $
  37084. @since 2002-02-09
  37085. </summary>
  37086. </member>
  37087. <member name="F:NPOI.Util.ClassID.bytes">
  37088. The bytes making out the class ID in correct order,
  37089. i.e. big-endian.
  37090. </member>
  37091. <member name="M:NPOI.Util.ClassID.#ctor(System.Byte[],System.Int32)">
  37092. <summary>
  37093. Creates a <see cref="T:NPOI.Util.ClassID"/> and Reads its value from a byte array.
  37094. </summary>
  37095. <param name="src">The byte array to Read from.</param>
  37096. <param name="offset">The offset of the first byte to Read.</param>
  37097. </member>
  37098. <member name="M:NPOI.Util.ClassID.#ctor">
  37099. <summary>
  37100. Creates a <see cref="T:NPOI.Util.ClassID"/> and initializes its value with 0x00 bytes.
  37101. </summary>
  37102. </member>
  37103. <member name="M:NPOI.Util.ClassID.#ctor(System.String)">
  37104. <p>Creates a {@link ClassID} from a human-readable representation of the Class ID in standard
  37105. format <code>"{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}"</code>.</p>
  37106. @param externalForm representation of the Class ID represented by this object.
  37107. </member>
  37108. <member name="F:NPOI.Util.ClassID.LENGTH">
  37109. The number of bytes occupied by this object in the byte
  37110. stream.
  37111. </member>
  37112. <member name="P:NPOI.Util.ClassID.Length">
  37113. <summary>
  37114. Gets the length.
  37115. </summary>
  37116. <value>The number of bytes occupied by this object in the byte stream.</value>
  37117. </member>
  37118. <member name="P:NPOI.Util.ClassID.Bytes">
  37119. <summary>
  37120. Gets or sets the bytes making out the class ID. They are returned in correct order, i.e. big-endian.
  37121. </summary>
  37122. <value>the bytes making out the class ID..</value>
  37123. </member>
  37124. <member name="M:NPOI.Util.ClassID.Read(System.Byte[],System.Int32)">
  37125. <summary>
  37126. Reads the class ID's value from a byte array by turning little-endian into big-endian.
  37127. </summary>
  37128. <param name="src">The byte array to Read from</param>
  37129. <param name="offset">The offset within the </param>
  37130. <returns>A byte array containing the class ID.</returns>
  37131. </member>
  37132. <member name="M:NPOI.Util.ClassID.Write(System.Byte[],System.Int32)">
  37133. <summary>
  37134. Writes the class ID to a byte array in the little-endian format.
  37135. </summary>
  37136. <param name="dst">The byte array to Write to.</param>
  37137. <param name="offset">The offset within the </param>
  37138. </member>
  37139. <member name="M:NPOI.Util.ClassID.Equals(System.Object)">
  37140. <summary>
  37141. Checks whether this ClassID is equal to another
  37142. object.
  37143. </summary>
  37144. <param name="o">the object to compare this PropertySet with</param>
  37145. <returns>true if the objects are equal, else
  37146. false</returns>
  37147. </member>
  37148. <member name="M:NPOI.Util.ClassID.GetHashCode">
  37149. <summary>
  37150. Serves as a hash function for a particular type.
  37151. </summary>
  37152. <returns>
  37153. A hash code for the current <see cref="T:System.Object"/>.
  37154. </returns>
  37155. </member>
  37156. <member name="M:NPOI.Util.ClassID.ToString">
  37157. <summary>
  37158. Returns a human-Readable representation of the Class ID in standard
  37159. format <c>"{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}"</c>.
  37160. </summary>
  37161. <returns>
  37162. A String representation of the Class ID represented by this object..
  37163. </returns>
  37164. </member>
  37165. <member name="T:NPOI.Util.CodePageUtil">
  37166. Utilities for working with Microsoft CodePages.
  37167. <p>Provides constants for understanding numeric codepages,
  37168. along with utilities to translate these into Java Character Sets.</p>
  37169. </member>
  37170. <member name="F:NPOI.Util.CodePageUtil.CP_037">
  37171. <p>Codepage 037, a special case</p>
  37172. </member>
  37173. <member name="F:NPOI.Util.CodePageUtil.CP_SJIS">
  37174. <p>Codepage for SJIS</p>
  37175. </member>
  37176. <member name="F:NPOI.Util.CodePageUtil.CP_GBK">
  37177. <p>Codepage for GBK, aka MS936</p>
  37178. </member>
  37179. <member name="F:NPOI.Util.CodePageUtil.CP_MS949">
  37180. <p>Codepage for MS949</p>
  37181. </member>
  37182. <member name="F:NPOI.Util.CodePageUtil.CP_UTF16">
  37183. <p>Codepage for UTF-16</p>
  37184. </member>
  37185. <member name="F:NPOI.Util.CodePageUtil.CP_UTF16_BE">
  37186. <p>Codepage for UTF-16 big-endian</p>
  37187. </member>
  37188. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1250">
  37189. <p>Codepage for Windows 1250</p>
  37190. </member>
  37191. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1251">
  37192. <p>Codepage for Windows 1251</p>
  37193. </member>
  37194. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1252">
  37195. <p>Codepage for Windows 1252</p>
  37196. </member>
  37197. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1253">
  37198. <p>Codepage for Windows 1253</p>
  37199. </member>
  37200. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1254">
  37201. <p>Codepage for Windows 1254</p>
  37202. </member>
  37203. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1255">
  37204. <p>Codepage for Windows 1255</p>
  37205. </member>
  37206. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1256">
  37207. <p>Codepage for Windows 1256</p>
  37208. </member>
  37209. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1257">
  37210. <p>Codepage for Windows 1257</p>
  37211. </member>
  37212. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1258">
  37213. <p>Codepage for Windows 1258</p>
  37214. </member>
  37215. <member name="F:NPOI.Util.CodePageUtil.CP_JOHAB">
  37216. <p>Codepage for Johab</p>
  37217. </member>
  37218. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_ROMAN">
  37219. <p>Codepage for Macintosh Roman (Java: MacRoman)</p>
  37220. </member>
  37221. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_JAPAN">
  37222. <p>Codepage for Macintosh Japan (Java: unknown - use SJIS, cp942 or
  37223. cp943)</p>
  37224. </member>
  37225. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_CHINESE_TRADITIONAL">
  37226. <p>Codepage for Macintosh Chinese Traditional (Java: unknown - use Big5,
  37227. MS950, or cp937)</p>
  37228. </member>
  37229. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_KOREAN">
  37230. <p>Codepage for Macintosh Korean (Java: unknown - use EUC_KR or
  37231. cp949)</p>
  37232. </member>
  37233. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_ARABIC">
  37234. <p>Codepage for Macintosh Arabic (Java: MacArabic)</p>
  37235. </member>
  37236. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_HEBREW">
  37237. <p>Codepage for Macintosh Hebrew (Java: MacHebrew)</p>
  37238. </member>
  37239. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_GREEK">
  37240. <p>Codepage for Macintosh Greek (Java: MacGreek)</p>
  37241. </member>
  37242. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_CYRILLIC">
  37243. <p>Codepage for Macintosh Cyrillic (Java: MacCyrillic)</p>
  37244. </member>
  37245. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_CHINESE_SIMPLE">
  37246. <p>Codepage for Macintosh Chinese Simplified (Java: unknown - use
  37247. EUC_CN, ISO2022_CN_GB, MS936 or cp935)</p>
  37248. </member>
  37249. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_ROMANIA">
  37250. <p>Codepage for Macintosh Romanian (Java: MacRomania)</p>
  37251. </member>
  37252. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_UKRAINE">
  37253. <p>Codepage for Macintosh Ukrainian (Java: MacUkraine)</p>
  37254. </member>
  37255. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_THAI">
  37256. <p>Codepage for Macintosh Thai (Java: MacThai)</p>
  37257. </member>
  37258. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_CENTRAL_EUROPE">
  37259. <p>Codepage for Macintosh Central Europe (Latin-2)
  37260. (Java: MacCentralEurope)</p>
  37261. </member>
  37262. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_ICELAND">
  37263. <p>Codepage for Macintosh Iceland (Java: MacIceland)</p>
  37264. </member>
  37265. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_TURKISH">
  37266. <p>Codepage for Macintosh Turkish (Java: MacTurkish)</p>
  37267. </member>
  37268. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_CROATIAN">
  37269. <p>Codepage for Macintosh Croatian (Java: MacCroatian)</p>
  37270. </member>
  37271. <member name="F:NPOI.Util.CodePageUtil.CP_US_ACSII">
  37272. <p>Codepage for US-ASCII</p>
  37273. </member>
  37274. <member name="F:NPOI.Util.CodePageUtil.CP_KOI8_R">
  37275. <p>Codepage for KOI8-R</p>
  37276. </member>
  37277. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_1">
  37278. <p>Codepage for ISO-8859-1</p>
  37279. </member>
  37280. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_2">
  37281. <p>Codepage for ISO-8859-2</p>
  37282. </member>
  37283. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_3">
  37284. <p>Codepage for ISO-8859-3</p>
  37285. </member>
  37286. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_4">
  37287. <p>Codepage for ISO-8859-4</p>
  37288. </member>
  37289. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_5">
  37290. <p>Codepage for ISO-8859-5</p>
  37291. </member>
  37292. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_6">
  37293. <p>Codepage for ISO-8859-6</p>
  37294. </member>
  37295. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_7">
  37296. <p>Codepage for ISO-8859-7</p>
  37297. </member>
  37298. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_8">
  37299. <p>Codepage for ISO-8859-8</p>
  37300. </member>
  37301. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_9">
  37302. <p>Codepage for ISO-8859-9</p>
  37303. </member>
  37304. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_2022_JP1">
  37305. <p>Codepage for ISO-2022-JP</p>
  37306. </member>
  37307. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_2022_JP2">
  37308. <p>Another codepage for ISO-2022-JP</p>
  37309. </member>
  37310. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_2022_JP3">
  37311. <p>Yet another codepage for ISO-2022-JP</p>
  37312. </member>
  37313. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_2022_KR">
  37314. <p>Codepage for ISO-2022-KR</p>
  37315. </member>
  37316. <member name="F:NPOI.Util.CodePageUtil.CP_EUC_JP">
  37317. <p>Codepage for EUC-JP</p>
  37318. </member>
  37319. <member name="F:NPOI.Util.CodePageUtil.CP_EUC_KR">
  37320. <p>Codepage for EUC-KR</p>
  37321. </member>
  37322. <member name="F:NPOI.Util.CodePageUtil.CP_GB2312">
  37323. <p>Codepage for GB2312</p>
  37324. </member>
  37325. <member name="F:NPOI.Util.CodePageUtil.CP_GB18030">
  37326. <p>Codepage for GB18030</p>
  37327. </member>
  37328. <member name="F:NPOI.Util.CodePageUtil.CP_US_ASCII2">
  37329. <p>Another codepage for US-ASCII</p>
  37330. </member>
  37331. <member name="F:NPOI.Util.CodePageUtil.CP_UTF8">
  37332. <p>Codepage for UTF-8</p>
  37333. </member>
  37334. <member name="F:NPOI.Util.CodePageUtil.CP_UNICODE">
  37335. <p>Codepage for Unicode</p>
  37336. </member>
  37337. <member name="M:NPOI.Util.CodePageUtil.GetBytesInCodePage(System.String,System.Int32)">
  37338. Converts a string into bytes, in the equivalent character encoding
  37339. to the supplied codepage number.
  37340. @param string The string to convert
  37341. @param codepage The codepage number
  37342. </member>
  37343. <member name="M:NPOI.Util.CodePageUtil.GetStringFromCodePage(System.Byte[],System.Int32)">
  37344. Converts the bytes into a String, based on the equivalent character encoding
  37345. to the supplied codepage number.
  37346. @param string The byte of the string to convert
  37347. @param codepage The codepage number
  37348. </member>
  37349. <member name="M:NPOI.Util.CodePageUtil.GetStringFromCodePage(System.Byte[],System.Int32,System.Int32,System.Int32)">
  37350. Converts the bytes into a String, based on the equivalent character encoding
  37351. to the supplied codepage number.
  37352. @param string The byte of the string to convert
  37353. @param codepage The codepage number
  37354. </member>
  37355. <member name="M:NPOI.Util.CodePageUtil.CodepageToEncoding(System.Int32)">
  37356. <p>Turns a codepage number into the equivalent character encoding's
  37357. name.</p>
  37358. @param codepage The codepage number
  37359. @return The character encoding's name. If the codepage number is 65001,
  37360. the encoding name is "UTF-8". All other positive numbers are mapped to
  37361. "cp" followed by the number, e.g. if the codepage number is 1252 the
  37362. returned character encoding name will be "cp1252".
  37363. @exception UnsupportedEncodingException if the specified codepage is
  37364. less than zero.
  37365. </member>
  37366. <member name="T:NPOI.Util.Collections.HashSet`1">
  37367. <summary>
  37368. This class comes from Java
  37369. </summary>
  37370. </member>
  37371. <member name="M:NPOI.Util.Collections.HashSet`1.#ctor">
  37372. <summary>
  37373. Initializes a new instance of the class.
  37374. </summary>
  37375. </member>
  37376. <member name="M:NPOI.Util.Collections.HashSet`1.Add(`0)">
  37377. <summary>
  37378. Adds the specified o.
  37379. </summary>
  37380. <param name="o">The o.</param>
  37381. </member>
  37382. <member name="M:NPOI.Util.Collections.HashSet`1.Contains(`0)">
  37383. <summary>
  37384. Determines whether [contains] [the specified o].
  37385. </summary>
  37386. <param name="o">The o.</param>
  37387. <returns>
  37388. <c>true</c> if [contains] [the specified o]; otherwise, <c>false</c>.
  37389. </returns>
  37390. </member>
  37391. <member name="M:NPOI.Util.Collections.HashSet`1.CopyTo(`0[],System.Int32)">
  37392. <summary>
  37393. 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.
  37394. </summary>
  37395. <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>
  37396. <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  37397. <exception cref="T:System.ArgumentNullException">
  37398. <paramref name="array"/> is null.
  37399. </exception>
  37400. <exception cref="T:System.ArgumentOutOfRangeException">
  37401. <paramref name="index"/> is less than zero.
  37402. </exception>
  37403. <exception cref="T:System.ArgumentException">
  37404. <paramref name="array"/> is multidimensional.
  37405. -or-
  37406. <paramref name="index"/> is equal to or greater than the length of <paramref name="array"/>.
  37407. -or-
  37408. 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"/>.
  37409. </exception>
  37410. <exception cref="T:System.ArgumentException">
  37411. The type of the source <see cref="T:System.Collections.ICollection"/> cannot be cast automatically to the type of the destination <paramref name="array"/>.
  37412. </exception>
  37413. </member>
  37414. <member name="P:NPOI.Util.Collections.HashSet`1.Count">
  37415. <summary>
  37416. Gets the number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  37417. </summary>
  37418. <value></value>
  37419. <returns>
  37420. The number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  37421. </returns>
  37422. </member>
  37423. <member name="M:NPOI.Util.Collections.HashSet`1.GetEnumerator">
  37424. <summary>
  37425. Returns an enumerator that iterates through a collection.
  37426. </summary>
  37427. <returns>
  37428. An <see cref="T:System.Collections.IEnumerator"/> object that can be used to iterate through the collection.
  37429. </returns>
  37430. </member>
  37431. <member name="M:NPOI.Util.Collections.HashSet`1.Remove(`0)">
  37432. <summary>
  37433. Removes the specified o.
  37434. </summary>
  37435. <param name="o">The o.</param>
  37436. </member>
  37437. <member name="M:NPOI.Util.Collections.HashSet`1.Clear">
  37438. <summary>
  37439. Removes all of the elements from this set.
  37440. The set will be empty after this call returns.
  37441. </summary>
  37442. </member>
  37443. <member name="T:NPOI.Util.CRC32">
  37444. <summary>
  37445. CRC Verification
  37446. </summary>
  37447. </member>
  37448. <member name="M:NPOI.Util.CRC32.#ctor">
  37449. <summary>
  37450. Initializes a new instance of the <see cref="T:NPOI.Util.CRC32"/> class.
  37451. </summary>
  37452. </member>
  37453. <member name="M:NPOI.Util.CRC32.ByteCRC(System.Byte[]@)">
  37454. <summary>
  37455. CRC Bytes.
  37456. </summary>
  37457. <param name="buffer">The buffer.</param>
  37458. <returns></returns>
  37459. </member>
  37460. <member name="M:NPOI.Util.CRC32.StringCRC(System.String)">
  37461. <summary>
  37462. String CRC
  37463. </summary>
  37464. <param name="sInputString">the string</param>
  37465. <returns></returns>
  37466. </member>
  37467. <member name="M:NPOI.Util.CRC32.FileCRC(System.String)">
  37468. <summary>
  37469. File CRC
  37470. </summary>
  37471. <param name="sInputFilename">the input file</param>
  37472. <returns></returns>
  37473. </member>
  37474. <member name="M:NPOI.Util.CRC32.StreamCRC(System.IO.Stream)">
  37475. <summary>
  37476. Stream CRC
  37477. </summary>
  37478. <param name="inFile">the input stream</param>
  37479. <returns></returns>
  37480. </member>
  37481. <member name="T:NPOI.Util.IDelayableLittleEndianOutput">
  37482. <summary>
  37483. Implementors of this interface allow client code to 'delay' writing to a certain section of a
  37484. data output stream.<br/>
  37485. A typical application is for writing BIFF records when the size is not known until well after
  37486. the header has been written. The client code can call <see cref="M:NPOI.Util.IDelayableLittleEndianOutput.CreateDelayedOutput"/>
  37487. to reserve two bytes of the output for the 'ushort size' header field. The delayed output can
  37488. be written at any stage.
  37489. </summary>
  37490. <remarks>@author Josh Micich</remarks>
  37491. </member>
  37492. <member name="M:NPOI.Util.IDelayableLittleEndianOutput.CreateDelayedOutput(System.Int32)">
  37493. <summary>
  37494. Creates an output stream intended for outputting a sequence of <c>size</c> bytes.
  37495. </summary>
  37496. <param name="size"></param>
  37497. <returns></returns>
  37498. </member>
  37499. <member name="T:NPOI.Util.FixedField">
  37500. <summary>
  37501. behavior of a field at a fixed location within a byte array
  37502. @author Marc Johnson (mjohnson at apache dot org
  37503. </summary>
  37504. </member>
  37505. <member name="M:NPOI.Util.FixedField.ReadFromBytes(System.Byte[])">
  37506. <summary>
  37507. set the value from its offset into an array of bytes
  37508. </summary>
  37509. <param name="data">the byte array from which the value is to be read</param>
  37510. </member>
  37511. <member name="M:NPOI.Util.FixedField.ReadFromStream(System.IO.Stream)">
  37512. <summary>
  37513. set the value from an Stream
  37514. </summary>
  37515. <param name="stream">the Stream from which the value is to be read</param>
  37516. </member>
  37517. <member name="M:NPOI.Util.FixedField.ToString">
  37518. <summary>
  37519. return the value as a String
  37520. </summary>
  37521. <returns></returns>
  37522. </member>
  37523. <member name="M:NPOI.Util.FixedField.WriteToBytes(System.Byte[])">
  37524. <summary>
  37525. write the value out to an array of bytes at the appropriate offset
  37526. </summary>
  37527. <param name="data">the array of bytes to which the value is to be written</param>
  37528. </member>
  37529. <member name="T:NPOI.Util.HexDump">
  37530. <summary>
  37531. dump data in hexadecimal format; derived from a HexDump utility I
  37532. wrote in June 2001.
  37533. @author Marc Johnson
  37534. @author Glen Stampoultzis (glens at apache.org)
  37535. </summary>
  37536. </member>
  37537. <member name="F:NPOI.Util.HexDump.DIGITS_LOWER">
  37538. Used to build output as Hex
  37539. </member>
  37540. <member name="F:NPOI.Util.HexDump.DIGITS_UPPER">
  37541. Used to build output as Hex
  37542. </member>
  37543. <member name="M:NPOI.Util.HexDump.Dump(System.Byte[],System.Int64,System.Int32,System.Int32)">
  37544. dump an array of bytes to a String
  37545. @param data the byte array to be dumped
  37546. @param offset its offset, whatever that might mean
  37547. @param index initial index into the byte array
  37548. @param length number of characters to output
  37549. @exception ArrayIndexOutOfBoundsException if the index is
  37550. outside the data array's bounds
  37551. @return output string
  37552. </member>
  37553. <member name="M:NPOI.Util.HexDump.Dump(System.IO.Stream,System.IO.Stream,System.Int32,System.Int32)">
  37554. Dumps <code>bytesToDump</code> bytes to an output stream.
  37555. @param in The stream to read from
  37556. @param out The output stream
  37557. @param start The index to use as the starting position for the left hand side label
  37558. @param bytesToDump The number of bytes to output. Use -1 to read until the end of file.
  37559. </member>
  37560. <member name="M:NPOI.Util.HexDump.ShortToHex(System.Int32)">
  37561. <summary>
  37562. Shorts to hex.
  37563. </summary>
  37564. <param name="value">The value.</param>
  37565. <returns>char array of 2 (zero padded) uppercase hex chars and prefixed with '0x'</returns>
  37566. </member>
  37567. <member name="M:NPOI.Util.HexDump.ByteToHex(System.Int32)">
  37568. <summary>
  37569. Bytes to hex.
  37570. </summary>
  37571. <param name="value">The value.</param>
  37572. <returns>char array of 1 (zero padded) uppercase hex chars and prefixed with '0x'</returns>
  37573. </member>
  37574. <member name="M:NPOI.Util.HexDump.IntToHex(System.Int32)">
  37575. <summary>
  37576. Ints to hex.
  37577. </summary>
  37578. <param name="value">The value.</param>
  37579. <returns>char array of 4 (zero padded) uppercase hex chars and prefixed with '0x'</returns>
  37580. </member>
  37581. <member name="M:NPOI.Util.HexDump.LongToHex(System.Int64)">
  37582. <summary>
  37583. char array of 4 (zero padded) uppercase hex chars and prefixed with '0x'
  37584. </summary>
  37585. <param name="value">The value.</param>
  37586. <returns>char array of 4 (zero padded) uppercase hex chars and prefixed with '0x'</returns>
  37587. </member>
  37588. <member name="M:NPOI.Util.HexDump.ToHexChars(System.Int64,System.Int32)">
  37589. <summary>
  37590. Toes the hex chars.
  37591. </summary>
  37592. <param name="pValue">The p value.</param>
  37593. <param name="nBytes">The n bytes.</param>
  37594. <returns>char array of uppercase hex chars, zero padded and prefixed with '0x'</returns>
  37595. </member>
  37596. <member name="M:NPOI.Util.HexRead.ReadData(System.String)">
  37597. <summary>
  37598. This method reads hex data from a filename and returns a byte array.
  37599. The file may contain line comments that are preceeded with a # symbol.
  37600. </summary>
  37601. <param name="filename">The filename to read</param>
  37602. <returns>The bytes read from the file.</returns>
  37603. <exception cref="T:System.IO.IOException">If there was a problem while reading the file.</exception>
  37604. </member>
  37605. <member name="M:NPOI.Util.HexRead.ReadData(System.IO.Stream,System.String)">
  37606. <summary>
  37607. Same as ReadData(String) except that this method allows you to specify sections within
  37608. a file. Sections are referenced using section headers in the form:
  37609. </summary>
  37610. <param name="stream">The stream.</param>
  37611. <param name="section">The section.</param>
  37612. <returns></returns>
  37613. </member>
  37614. <member name="M:NPOI.Util.HexRead.ReadData(System.String,System.String)">
  37615. <summary>
  37616. Reads the data.
  37617. </summary>
  37618. <param name="filename">The filename.</param>
  37619. <param name="section">The section.</param>
  37620. <returns></returns>
  37621. </member>
  37622. <member name="M:NPOI.Util.HexRead.ReadData(System.IO.Stream,System.Int32)">
  37623. <summary>
  37624. Reads the data.
  37625. </summary>
  37626. <param name="stream">The stream.</param>
  37627. <param name="eofChar">The EOF char.</param>
  37628. <returns></returns>
  37629. </member>
  37630. <member name="M:NPOI.Util.HexRead.ReadFromString(System.String)">
  37631. <summary>
  37632. Reads from string.
  37633. </summary>
  37634. <param name="data">The data.</param>
  37635. <returns></returns>
  37636. </member>
  37637. <member name="M:NPOI.Util.HexRead.ReadToEOL(System.IO.Stream)">
  37638. <summary>
  37639. Reads to EOL.
  37640. </summary>
  37641. <param name="stream">The stream.</param>
  37642. </member>
  37643. <member name="M:NPOI.Util.InputStream.Read">
  37644. <summary>
  37645. Reads the next byte of data from the input stream. The value byte is
  37646. returned as an <c>int</c> in the range <c>0</c> to
  37647. <c>255</c>. If no byte is available because the end of the stream
  37648. has been reached, the value <c>-1</c> is returned. This method
  37649. blocks until input data is available, the end of the stream is detected,
  37650. or an exception is thrown.
  37651. A subclass must provide an implementation of this method.
  37652. </summary>
  37653. <returns>
  37654. the next byte of data, or <c>-1</c> if the end of the
  37655. stream is reached.
  37656. </returns>
  37657. <exception cref="T:System.IO.IOException">if an I/O error occurs</exception>
  37658. </member>
  37659. <member name="M:NPOI.Util.InputStream.Read(System.Byte[])">
  37660. <summary>
  37661. Reads some number of bytes from the input stream and stores them into
  37662. the buffer array <c>b</c>. The number of bytes actually read is
  37663. returned as an integer. This method blocks until input data is
  37664. available, end of file is detected, or an exception is thrown.
  37665. <p> If the length of <c>b</c> is zero, then no bytes are read and
  37666. <c>0</c> is returned; otherwise, there is an attempt to read at
  37667. least one byte. If no byte is available because the stream is at the
  37668. end of the file, the value <c>-1</c> is returned; otherwise, at
  37669. least one byte is read and stored into <c>b</c>.</p>
  37670. <p> The first byte read is stored into element <c>b[0]</c>, the
  37671. next one into <c>b[1]</c>, and so on. The number of bytes read is,
  37672. at most, equal to the length of <c>b</c>. Let <i>k</i> be the
  37673. number of bytes actually read; these bytes will be stored in elements
  37674. <c>b[0]</c> through <c>b[</c><i>k</i><c>-1]</c>,
  37675. leaving elements <c>b[</c><i>k</i><c>]</c> through
  37676. <c>b[b.length-1]</c> unaffected.</p>
  37677. <p> The <c>read(b)</c> method for class <c>InputStream</c>
  37678. has the same effect as: <pre><c> read(b, 0, b.length) </c></pre></p>
  37679. </summary>
  37680. <param name="b">the buffer into which the data is read.</param>
  37681. <returns>
  37682. the total number of bytes read into the buffer, or
  37683. <c>-1</c> if there is no more data because the end of
  37684. the stream has been reached.
  37685. </returns>
  37686. <exception cref="T:System.IO.IOException">If the first byte cannot be read for any reason
  37687. other than the end of the file, if the input stream has been closed, or
  37688. if some other I/O error occurs.</exception>
  37689. <exception cref="T:System.NullReferenceException">if <c>b</c> is <c>null</c>.</exception>
  37690. <see cref="M:NPOI.Util.InputStream.Read(System.Byte[],System.Int32,System.Int32)"/>
  37691. </member>
  37692. <member name="M:NPOI.Util.InputStream.Read(System.Byte[],System.Int32,System.Int32)">
  37693. <summary>
  37694. Reads up to <c>len</c> bytes of data from the input stream into
  37695. an array of bytes. An attempt is made to read as many as
  37696. <c>len</c> bytes, but a smaller number may be read.
  37697. The number of bytes actually read is returned as an integer.
  37698. <p> This method blocks until input data is available, end of file is
  37699. detected, or an exception is thrown.</p>
  37700. <p> If <c>len</c> is zero, then no bytes are read and
  37701. <c>0</c> is returned; otherwise, there is an attempt to read at
  37702. least one byte. If no byte is available because the stream is at end of
  37703. file, the value <c>-1</c> is returned; otherwise, at least one
  37704. byte is read and stored into <c>b</c>.</p>
  37705. <p> The first byte read is stored into element <c>b[off]</c>, the
  37706. next one into <c>b[off+1]</c>, and so on. The number of bytes read
  37707. is, at most, equal to <c>len</c>. Let <i>k</i> be the number of
  37708. bytes actually read; these bytes will be stored in elements
  37709. <c>b[off]</c> through <c>b[off+</c><i>k</i><c>-1]</c>,
  37710. leaving elements <c>b[off+</c><i>k</i><c>]</c> through
  37711. <c>b[off+len-1]</c> unaffected.</p>
  37712. <p> In every case, elements <c>b[0]</c> through
  37713. <c>b[off]</c> and elements <c>b[off+len]</c> through
  37714. <c>b[b.length-1]</c> are unaffected.</p>
  37715. <p> The <c>read(b,</c> <c>off,</c> <c>len)</c> method
  37716. for class <c>InputStream</c> simply calls the method
  37717. <c>read()</c> repeatedly. If the first such call results in an
  37718. <c>IOException</c>, that exception is returned from the call to
  37719. the <c>read(b,</c> <c>off,</c> <c>len)</c> method. If
  37720. any subsequent call to <c>read()</c> results in a
  37721. <c>IOException</c>, the exception is caught and treated as if it
  37722. were end of file; the bytes read up to that point are stored into
  37723. <c>b</c> and the number of bytes read before the exception
  37724. occurred is returned. The default implementation of this method blocks
  37725. until the requested amount of input data <c>len</c> has been read,
  37726. end of file is detected, or an exception is thrown. Subclasses are encouraged
  37727. to provide a more efficient implementation of this method.</p>
  37728. </summary>
  37729. <param name="b">the buffer into which the data is read.</param>
  37730. <param name="off">the start offset in array <c>b</c> at which the data is written.</param>
  37731. <param name="len">the maximum number of bytes to read.</param>
  37732. <returns>
  37733. the total number of bytes read into the buffer, or
  37734. <c>-1</c> if there is no more data because the end of
  37735. the stream has been reached.</returns>
  37736. <exception cref="T:System.IO.IOException">If the first byte cannot be read for any reason
  37737. other than end of file, or if the input stream has been closed, or if
  37738. some other I/O error occurs.</exception>
  37739. <exception cref="T:System.NullReferenceException">If <c>b</c> is <c>null</c>.</exception>
  37740. <exception cref="T:System.IndexOutOfRangeException">If <c>off</c> is negative,
  37741. <c>len</c> is negative, or <c>len</c> is greater than
  37742. <c>b.length - off</c></exception>
  37743. <see cref="M:NPOI.Util.InputStream.Read"/>
  37744. </member>
  37745. <member name="M:NPOI.Util.InputStream.Skip(System.Int64)">
  37746. <summary>
  37747. Skips over and discards <c>n</c> bytes of data from this input
  37748. stream. The <c>skip</c> method may, for a variety of reasons, end
  37749. up skipping over some smaller number of bytes, possibly <c>0</c>.
  37750. This may result from any of a number of conditions; reaching end of file
  37751. before <c>n</c> bytes have been skipped is only one possibility.
  37752. The actual number of bytes skipped is returned. If {@code n} is
  37753. negative, the {@code skip} method for class {@code InputStream} always
  37754. returns 0, and no bytes are skipped. Subclasses may handle the negative
  37755. value differently.
  37756. <p> The <c>skip</c> method of this class creates a
  37757. byte array and then repeatedly reads into it until <c>n</c> bytes
  37758. have been read or the end of the stream has been reached. Subclasses are
  37759. encouraged to provide a more efficient implementation of this method.
  37760. For instance, the implementation may depend on the ability to seek.</p>
  37761. </summary>
  37762. <param name="n">the number of bytes to be skipped.</param>
  37763. <returns>the actual number of bytes skipped.</returns>
  37764. <exception cref="T:System.IO.IOException">if the stream does not support seek,
  37765. or if some other I/O error occurs.
  37766. </exception>
  37767. </member>
  37768. <member name="M:NPOI.Util.InputStream.Available">
  37769. <summary>
  37770. Returns an estimate of the number of bytes that can be read (or
  37771. skipped over) from this input stream without blocking by the next
  37772. invocation of a method for this input stream. The next invocation
  37773. might be the same thread or another thread. A single read or skip of this
  37774. many bytes will not block, but may read or skip fewer bytes.
  37775. <p> Note that while some implementations of {@code InputStream} will return
  37776. the total number of bytes in the stream, many will not. It is
  37777. never correct to use the return value of this method to allocate
  37778. a buffer intended to hold all data in this stream.</p>
  37779. <p> A subclass' implementation of this method may choose to throw an
  37780. {@link IOException} if this input stream has been closed by
  37781. invoking the {@link #close()} method.</p>
  37782. <p> The {@code available} method for class {@code InputStream} always
  37783. returns {@code 0}.</p>
  37784. <p> This method should be overridden by subclasses.</p>
  37785. </summary>
  37786. <exception cref="T:System.IO.IOException">if an I/O error occurs.</exception>
  37787. </member>
  37788. <member name="M:NPOI.Util.InputStream.Close">
  37789. <summary>
  37790. Closes this input stream and releases any system resources associated
  37791. with the stream.
  37792. <p> The <c>Close</c> method of <c>InputStream</c> does nothing.</p>
  37793. </summary>
  37794. <exception cref="T:System.IO.IOException">if an I/O error occurs.</exception>
  37795. </member>
  37796. <member name="M:NPOI.Util.InputStream.Mark(System.Int32)">
  37797. <summary>
  37798. Marks the current position in this input stream. A subsequent call to
  37799. the <c>reset</c> method repositions this stream at the last marked
  37800. position so that subsequent reads re-read the same bytes.
  37801. <p> The <c>readlimit</c> arguments tells this input stream to
  37802. allow that many bytes to be read before the mark position gets
  37803. invalidated.</p>
  37804. <p> The general contract of <c>mark</c> is that, if the method
  37805. <c>markSupported</c> returns <c>true</c>, the stream somehow
  37806. remembers all the bytes read after the call to <c>mark</c> and
  37807. stands ready to supply those same bytes again if and whenever the method
  37808. <c>reset</c> is called. However, the stream is not required to
  37809. remember any data at all if more than <c>readlimit</c> bytes are
  37810. read from the stream before <c>reset</c> is called.</p>
  37811. <p> Marking a closed stream should not have any effect on the stream.</p>
  37812. <p> The <c>mark</c> method of <c>InputStream</c> does
  37813. nothing.</p>
  37814. </summary>
  37815. <param name="readlimit">the maximum limit of bytes that can be read before
  37816. the mark position becomes invalid.
  37817. </param>
  37818. <see cref="M:NPOI.Util.InputStream.Reset"/>
  37819. </member>
  37820. <member name="M:NPOI.Util.InputStream.Reset">
  37821. <summary>
  37822. Repositions this stream to the position at the time the
  37823. <c>mark</c> method was last called on this input stream.
  37824. <p> The general contract of <c>reset</c> is:</p>
  37825. <ul>
  37826. <li> If the method <c>markSupported</c> returns
  37827. <c>true</c>, then:
  37828. <ul><li> If the method <c>mark</c> has not been called since
  37829. the stream was created, or the number of bytes read from the stream
  37830. since <c>mark</c> was last called is larger than the argument
  37831. to <c>mark</c> at that last call, then an
  37832. <c>IOException</c> might be thrown.</li>
  37833. <li> If such an <c>IOException</c> is not thrown, then the
  37834. stream is reset to a state such that all the bytes read since the
  37835. most recent call to <c>mark</c> (or since the start of the
  37836. file, if <c>mark</c> has not been called) will be resupplied
  37837. to subsequent callers of the <c>read</c> method, followed by
  37838. any bytes that otherwise would have been the next input data as of
  37839. the time of the call to <c>reset</c>. </li>
  37840. <li> If the method <c>markSupported</c> returns
  37841. <c>false</c>, then:
  37842. <ul><li> The call to <c>reset</c> may throw an
  37843. <c>IOException</c>.</li>
  37844. <li> If an <c>IOException</c> is not thrown, then the stream
  37845. is reset to a fixed state that depends on the particular type of the
  37846. input stream and how it was created. The bytes that will be supplied
  37847. to subsequent callers of the <c>read</c> method depend on the
  37848. particular type of the input stream. </li></ul></li></ul></li></ul>
  37849. <p>The method <c>reset</c> for class <c>InputStream</c>
  37850. does nothing except throw an <c>IOException</c>.</p>
  37851. </summary>
  37852. </member>
  37853. <member name="M:NPOI.Util.InputStream.MarkSupported">
  37854. <summary>
  37855. Tests if this input stream supports the <c>mark</c> and
  37856. <c>reset</c> methods. Whether or not <c>mark</c> and
  37857. <c>reset</c> are supported is an invariant property of a
  37858. particular input stream instance. The <c>markSupported</c> method
  37859. of <c>InputStream</c> returns <c>false</c>.
  37860. </summary>
  37861. <returns>
  37862. <c>true</c> if this stream instance supports the mark
  37863. and reset methods; <c>false</c> otherwise.
  37864. <see cref="M:NPOI.Util.InputStream.Mark(System.Int32)"/>
  37865. <see cref="M:NPOI.Util.InputStream.Reset"/>
  37866. </returns>
  37867. </member>
  37868. <member name="M:NPOI.Util.IntegerField.#ctor(System.Int32)">
  37869. <summary>
  37870. construct the <see cref="T:NPOI.Util.IntegerField"/> with its offset into its containing byte array class.
  37871. </summary>
  37872. <param name="offset">offset of the field within its byte array.</param>
  37873. </member>
  37874. <member name="M:NPOI.Util.IntegerField.#ctor(System.Int32,System.Int32)">
  37875. <summary>
  37876. construct the <see cref="T:NPOI.Util.IntegerField"/> with its offset into its containing
  37877. byte array and initialize its value
  37878. </summary>
  37879. <param name="offset">offset of the field within its byte array</param>
  37880. <param name="value">the initial value</param>
  37881. </member>
  37882. <member name="M:NPOI.Util.IntegerField.#ctor(System.Int32,System.Byte[])">
  37883. <summary>
  37884. Construct the <see cref="T:NPOI.Util.IntegerField"/> with its offset into its containing
  37885. byte array and initialize its value from its byte array
  37886. </summary>
  37887. <param name="offset">offset of the field within its byte array</param>
  37888. <param name="data">the byte array to Read the value from</param>
  37889. </member>
  37890. <member name="M:NPOI.Util.IntegerField.#ctor(System.Int32,System.Int32,System.Byte[])">
  37891. <summary>
  37892. construct the <see cref="T:NPOI.Util.IntegerField"/> with its offset into its containing
  37893. byte array, initialize its value, and write the value to a byte
  37894. </summary>
  37895. <param name="offset">offset of the field within its byte array</param>
  37896. <param name="value">the initial value</param>
  37897. <param name="data">the byte array to write the value to</param>
  37898. </member>
  37899. <member name="P:NPOI.Util.IntegerField.Value">
  37900. <summary>
  37901. get or Set the IntegerField's current value
  37902. </summary>
  37903. <value>The value.</value>
  37904. <returns></returns>
  37905. </member>
  37906. <member name="M:NPOI.Util.IntegerField.Set(System.Int32,System.Byte[])">
  37907. <summary>
  37908. Set the IntegerField's current value and write it to a byte array
  37909. </summary>
  37910. <param name="value">value to be Set</param>
  37911. <param name="data">the byte array to write the value to</param>
  37912. </member>
  37913. <member name="M:NPOI.Util.IntegerField.ReadFromBytes(System.Byte[])">
  37914. <summary>
  37915. Set the value from its offset into an array of bytes
  37916. </summary>
  37917. <param name="data">The data.</param>
  37918. </member>
  37919. <member name="M:NPOI.Util.IntegerField.ReadFromStream(System.IO.Stream)">
  37920. <summary>
  37921. Set the value from an Stream
  37922. </summary>
  37923. <param name="stream">the Stream from which the value is to be Read</param>
  37924. </member>
  37925. <member name="M:NPOI.Util.IntegerField.WriteToBytes(System.Byte[])">
  37926. <summary>
  37927. write the value out to an array of bytes at the appropriate offset
  37928. </summary>
  37929. <param name="data"> the array of bytes to which the value is to be written </param>
  37930. </member>
  37931. <member name="M:NPOI.Util.IntegerField.Write(System.Int32,System.Int32,System.Byte[])">
  37932. <summary>
  37933. Same as using the constructor <see cref="T:NPOI.Util.IntegerField"/> with the same
  37934. parameter list. Avoid creation of an useless object.
  37935. </summary>
  37936. <param name="offset">offset of the field within its byte array</param>
  37937. <param name="value">the initial value</param>
  37938. <param name="data">the byte array to write the value to</param>
  37939. </member>
  37940. <member name="M:NPOI.Util.IntegerField.ToString">
  37941. <summary>
  37942. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  37943. </summary>
  37944. <returns>
  37945. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  37946. </returns>
  37947. </member>
  37948. <member name="T:NPOI.Util.IntList">
  37949. <summary>
  37950. 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
  37951. the mimicry of List is as follows:
  37952. <ul>
  37953. <li> if possible, operations designated 'optional' in the List
  37954. interface are attempted</li>
  37955. <li> wherever the List interface refers to an Object, substitute
  37956. int</li>
  37957. <li> wherever the List interface refers to a Collection or List,
  37958. substitute IntList</li>
  37959. </ul>
  37960. the mimicry is not perfect, however:
  37961. <ul>
  37962. <li> operations involving Iterators or ListIterators are not
  37963. supported</li>
  37964. <li> Remove(Object) becomes RemoveValue to distinguish it from
  37965. Remove(int index)</li>
  37966. <li> subList is not supported</li>
  37967. </ul>
  37968. @author Marc Johnson
  37969. </summary>
  37970. </member>
  37971. <member name="M:NPOI.Util.IntList.#ctor">
  37972. <summary>
  37973. create an IntList of default size
  37974. </summary>
  37975. </member>
  37976. <member name="M:NPOI.Util.IntList.#ctor(NPOI.Util.IntList)">
  37977. <summary>
  37978. create a copy of an existing IntList
  37979. </summary>
  37980. <param name="list">the existing IntList</param>
  37981. </member>
  37982. <member name="M:NPOI.Util.IntList.#ctor(System.Int32,System.Int32)">
  37983. <summary>
  37984. create an IntList with a predefined Initial size
  37985. </summary>
  37986. <param name="initialCapacity">the size for the internal array</param>
  37987. <param name="fillvalue"></param>
  37988. </member>
  37989. <member name="M:NPOI.Util.IntList.Add(System.Int32,System.Int32)">
  37990. <summary>
  37991. add the specfied value at the specified index
  37992. </summary>
  37993. <param name="index">the index where the new value is to be Added</param>
  37994. <param name="value">the new value</param>
  37995. </member>
  37996. <member name="M:NPOI.Util.IntList.Add(System.Int32)">
  37997. <summary>
  37998. Appends the specified element to the end of this list
  37999. </summary>
  38000. <param name="value">element to be Appended to this list.</param>
  38001. <returns>return true (as per the general contract of the Collection.add method</returns>
  38002. </member>
  38003. <member name="M:NPOI.Util.IntList.AddAll(NPOI.Util.IntList)">
  38004. <summary>
  38005. Appends all of the elements in the specified collection to the
  38006. end of this list, in the order that they are returned by the
  38007. specified collection's iterator. The behavior of this
  38008. operation is unspecified if the specified collection is
  38009. modified while the operation is in progress. (Note that this
  38010. will occur if the specified collection is this list, and it's
  38011. nonempty.)
  38012. </summary>
  38013. <param name="c">collection whose elements are to be Added to this list.</param>
  38014. <returns>return true if this list Changed as a result of the call.</returns>
  38015. </member>
  38016. <member name="M:NPOI.Util.IntList.AddAll(System.Int32,NPOI.Util.IntList)">
  38017. <summary>
  38018. Inserts all of the elements in the specified collection into
  38019. this list at the specified position. Shifts the element
  38020. currently at that position (if any) and any subsequent elements
  38021. to the right (increases their indices). The new elements will
  38022. appear in this list in the order that they are returned by the
  38023. specified collection's iterator. The behavior of this
  38024. operation is unspecified if the specified collection is
  38025. modified while the operation is in progress. (Note that this
  38026. will occur if the specified collection is this list, and it's
  38027. nonempty.)
  38028. </summary>
  38029. <param name="index">index at which to insert first element from the specified collection.</param>
  38030. <param name="c">elements to be inserted into this list.</param>
  38031. <returns>return true if this list Changed as a result of the call.</returns>
  38032. </member>
  38033. <member name="M:NPOI.Util.IntList.Clear">
  38034. <summary>
  38035. Removes all of the elements from this list. This list will be
  38036. empty After this call returns (unless it throws an exception).
  38037. </summary>
  38038. </member>
  38039. <member name="M:NPOI.Util.IntList.Contains(System.Int32)">
  38040. <summary>
  38041. Returns true if this list Contains the specified element. More
  38042. formally, returns true if and only if this list Contains at
  38043. least one element e such that o == e
  38044. </summary>
  38045. <param name="o">element whose presence in this list is to be Tested.</param>
  38046. <returns>return true if this list Contains the specified element.</returns>
  38047. </member>
  38048. <member name="M:NPOI.Util.IntList.ContainsAll(NPOI.Util.IntList)">
  38049. <summary>
  38050. Returns true if this list Contains all of the elements of the
  38051. specified collection.
  38052. </summary>
  38053. <param name="c">collection to be Checked for Containment in this list.</param>
  38054. <returns>return true if this list Contains all of the elements of the specified collection.</returns>
  38055. </member>
  38056. <member name="M:NPOI.Util.IntList.Equals(System.Object)">
  38057. <summary>
  38058. Compares the specified object with this list for Equality.
  38059. Returns true if and only if the specified object is also a
  38060. list, both lists have the same size, and all corresponding
  38061. pairs of elements in the two lists are Equal. (Two elements e1
  38062. and e2 are equal if e1 == e2.) In other words, two lists are
  38063. defined to be equal if they contain the same elements in the
  38064. same order. This defInition ensures that the Equals method
  38065. works properly across different implementations of the List
  38066. interface.
  38067. </summary>
  38068. <param name="o">the object to be Compared for Equality with this list.</param>
  38069. <returns>return true if the specified object is equal to this list.</returns>
  38070. </member>
  38071. <member name="M:NPOI.Util.IntList.Get(System.Int32)">
  38072. <summary>
  38073. Returns the element at the specified position in this list.
  38074. </summary>
  38075. <param name="index">index of element to return.</param>
  38076. <returns>return the element at the specified position in this list.</returns>
  38077. </member>
  38078. <member name="M:NPOI.Util.IntList.GetHashCode">
  38079. <summary>
  38080. Returns the hash code value for this list. The hash code of a
  38081. list is defined to be the result of the following calculation:
  38082. <code>
  38083. hashCode = 1;
  38084. Iterator i = list.Iterator();
  38085. while (i.HasNext()) {
  38086. Object obj = i.Next();
  38087. hashCode = 31*hashCode + (obj==null ? 0 : obj.HashCode());
  38088. }
  38089. </code>
  38090. This ensures that list1.Equals(list2) implies that
  38091. list1.HashCode()==list2.HashCode() for any two lists, list1 and
  38092. list2, as required by the general contract of Object.HashCode.
  38093. </summary>
  38094. <returns>return the hash code value for this list.</returns>
  38095. </member>
  38096. <member name="M:NPOI.Util.IntList.IndexOf(System.Int32)">
  38097. <summary>
  38098. Returns the index in this list of the first occurrence of the
  38099. specified element, or -1 if this list does not contain this
  38100. element. More formally, returns the lowest index i such that
  38101. (o == Get(i)), or -1 if there is no such index.
  38102. </summary>
  38103. <param name="o">element to search for.</param>
  38104. <returns>return the index in this list of the first occurrence of the
  38105. specified element, or -1 if this list does not contain
  38106. this element.</returns>
  38107. </member>
  38108. <member name="M:NPOI.Util.IntList.IsEmpty">
  38109. <summary>
  38110. Returns true if this list Contains no elements.
  38111. </summary>
  38112. <returns>return true if this list Contains no elements.</returns>
  38113. </member>
  38114. <member name="M:NPOI.Util.IntList.LastIndexOf(System.Int32)">
  38115. <summary>
  38116. Returns the index in this list of the last occurrence of the
  38117. specified element, or -1 if this list does not contain this
  38118. element. More formally, returns the highest index i such that
  38119. (o == Get(i)), or -1 if there is no such index.
  38120. </summary>
  38121. <param name="o">element to search for.</param>
  38122. <returns>the index in this list of the last occurrence of the
  38123. specified element, or -1 if this list does not contain
  38124. this element.
  38125. </returns>
  38126. </member>
  38127. <member name="M:NPOI.Util.IntList.Remove(System.Int32)">
  38128. <summary>
  38129. Removes the element at the specified position in this list.
  38130. Shifts any subsequent elements to the left (subtracts one from
  38131. their indices). Returns the element that was Removed from the
  38132. list.
  38133. </summary>
  38134. <param name="index">the index of the element to Removed.</param>
  38135. <returns>return the element previously at the specified position.</returns>
  38136. </member>
  38137. <member name="M:NPOI.Util.IntList.RemoveValue(System.Int32)">
  38138. <summary>
  38139. Removes the first occurrence in this list of the specified
  38140. element (optional operation). If this list does not contain
  38141. the element, it is unChanged. More formally, Removes the
  38142. element with the lowest index i such that (o.Equals(get(i)))
  38143. (if such an element exists).
  38144. </summary>
  38145. <param name="o">element to be Removed from this list, if present.</param>
  38146. <returns>return true if this list Contained the specified element.</returns>
  38147. </member>
  38148. <member name="M:NPOI.Util.IntList.RemoveAll(NPOI.Util.IntList)">
  38149. <summary>
  38150. Removes from this list all the elements that are Contained in
  38151. the specified collection
  38152. </summary>
  38153. <param name="c">collection that defines which elements will be Removed from the list.</param>
  38154. <returns>return true if this list Changed as a result of the call.</returns>
  38155. </member>
  38156. <member name="M:NPOI.Util.IntList.RetainAll(NPOI.Util.IntList)">
  38157. <summary>
  38158. Retains only the elements in this list that are Contained in
  38159. the specified collection. In other words, Removes from this
  38160. list all the elements that are not Contained in the specified
  38161. collection.
  38162. </summary>
  38163. <param name="c">collection that defines which elements this Set will retain.</param>
  38164. <returns>return true if this list Changed as a result of the call.</returns>
  38165. </member>
  38166. <member name="M:NPOI.Util.IntList.Set(System.Int32,System.Int32)">
  38167. <summary>
  38168. Replaces the element at the specified position in this list with the specified element
  38169. </summary>
  38170. <param name="index">index of element to Replace.</param>
  38171. <param name="element">element to be stored at the specified position.</param>
  38172. <returns>the element previously at the specified position.</returns>
  38173. </member>
  38174. <member name="M:NPOI.Util.IntList.Size">
  38175. <summary>
  38176. Returns the number of elements in this list. If this list
  38177. Contains more than Int32.MaxValue elements, returns
  38178. Int32.MaxValue.
  38179. </summary>
  38180. <returns>the number of elements in this IntList</returns>
  38181. </member>
  38182. <member name="P:NPOI.Util.IntList.Count">
  38183. <summary>
  38184. the number of elements in this IntList
  38185. </summary>
  38186. </member>
  38187. <member name="M:NPOI.Util.IntList.ToArray">
  38188. <summary>
  38189. Returns an array Containing all of the elements in this list in
  38190. proper sequence. Obeys the general contract of the
  38191. Collection.ToArray method.
  38192. </summary>
  38193. <returns>an array Containing all of the elements in this list in proper sequence.</returns>
  38194. </member>
  38195. <member name="M:NPOI.Util.IntList.ToArray(System.Int32[])">
  38196. <summary>
  38197. Returns an array Containing all of the elements in this list in
  38198. proper sequence. Obeys the general contract of the
  38199. Collection.ToArray(Object[]) method.
  38200. </summary>
  38201. <param name="a">the array into which the elements of this list are to
  38202. be stored, if it is big enough; otherwise, a new array
  38203. is allocated for this purpose.</param>
  38204. <returns>return an array Containing the elements of this list.</returns>
  38205. </member>
  38206. <member name="T:NPOI.Util.IntMapper`1">
  38207. <summary>
  38208. A List of objects that are indexed AND keyed by an int; also allows for Getting
  38209. the index of a value in the list
  38210. <p>I am happy is someone wants to re-implement this without using the
  38211. internal list and hashmap. If so could you please make sure that
  38212. you can add elements half way into the list and have the value-key mappings
  38213. update</p>
  38214. </summary>
  38215. <typeparam name="T"></typeparam>
  38216. <remarks>@author Jason Height</remarks>
  38217. </member>
  38218. <member name="M:NPOI.Util.IntMapper`1.#ctor">
  38219. <summary>
  38220. create an IntMapper of default size
  38221. </summary>
  38222. </member>
  38223. <member name="M:NPOI.Util.IntMapper`1.Add(`0)">
  38224. <summary>
  38225. Appends the specified element to the end of this list
  38226. </summary>
  38227. <param name="value">element to be Appended to this list.</param>
  38228. <returns>return true (as per the general contract of the Collection.add method)</returns>
  38229. </member>
  38230. <member name="P:NPOI.Util.IntMapper`1.Size">
  38231. <summary>
  38232. Gets the size.
  38233. </summary>
  38234. </member>
  38235. <member name="P:NPOI.Util.IntMapper`1.Item(System.Int32)">
  38236. <summary>
  38237. Gets the T object at the specified index.
  38238. </summary>
  38239. <param name="index"></param>
  38240. <returns></returns>
  38241. </member>
  38242. <member name="M:NPOI.Util.IntMapper`1.GetIndex(`0)">
  38243. <summary>
  38244. Gets the index of T object.
  38245. </summary>
  38246. <param name="o">The o.</param>
  38247. <returns></returns>
  38248. </member>
  38249. <member name="M:NPOI.Util.IntMapper`1.GetEnumerator">
  38250. <summary>
  38251. Gets the enumerator.
  38252. </summary>
  38253. <returns></returns>
  38254. </member>
  38255. <member name="M:NPOI.Util.IOUtils.PeekFirst8Bytes(NPOI.Util.InputStream)">
  38256. Peeks at the first 8 bytes of the stream. Returns those bytes, but
  38257. with the stream unaffected. Requires a stream that supports mark/reset,
  38258. or a PushbackInputStream. If the stream has &gt;0 but &lt;8 bytes,
  38259. remaining bytes will be zero.
  38260. @throws EmptyFileException if the stream is empty
  38261. </member>
  38262. <member name="M:NPOI.Util.IOUtils.ToByteArray(System.IO.Stream)">
  38263. <summary>
  38264. Reads all the data from the input stream, and returns
  38265. the bytes Read.
  38266. </summary>
  38267. <param name="stream">The stream.</param>
  38268. <returns></returns>
  38269. <remarks>Tony Qu changed the code</remarks>
  38270. </member>
  38271. <member name="M:NPOI.Util.IOUtils.ToByteArray(System.IO.Stream,System.Int32)">
  38272. <summary>
  38273. Reads up to {@code length} bytes from the input stream, and returns the bytes read.
  38274. </summary>
  38275. <param name="stream"></param>
  38276. <param name="length"></param>
  38277. <returns></returns>
  38278. </member>
  38279. <member name="M:NPOI.Util.IOUtils.ReadFully(System.IO.Stream,System.Byte[])">
  38280. <summary>
  38281. Reads the fully.
  38282. </summary>
  38283. <param name="stream">The stream.</param>
  38284. <param name="b">The b.</param>
  38285. <returns></returns>
  38286. </member>
  38287. <member name="M:NPOI.Util.IOUtils.ReadFully(System.IO.Stream,System.Byte[],System.Int32,System.Int32)">
  38288. <summary>
  38289. Same as the normal InputStream#read(byte[], int, int), but tries to ensure
  38290. that the buffer is filled completely if possible, i.e. b.remaining()
  38291. returns 0.
  38292. If the end of file is reached before any bytes are Read, returns -1.
  38293. If the end of the file is reached after some bytes are read, returns the
  38294. number of bytes read. If the end of the file isn't reached before the
  38295. buffer has no more remaining capacity, will return the number of bytes
  38296. that were read.
  38297. </summary>
  38298. <param name="stream">the stream from which the data is read.</param>
  38299. <param name="b">the buffer into which the data is read.</param>
  38300. <param name="off">the start offset in array b at which the data is written.</param>
  38301. <param name="len">the maximum number of bytes to read.</param>
  38302. <returns></returns>
  38303. </member>
  38304. <member name="M:NPOI.Util.IOUtils.Copy(System.IO.Stream,System.IO.Stream)">
  38305. <summary>
  38306. Copies all the data from the given InputStream to the OutputStream. It
  38307. leaves both streams open, so you will still need to close them once done.
  38308. </summary>
  38309. <param name="inp"></param>
  38310. <param name="out1"></param>
  38311. </member>
  38312. <member name="M:NPOI.Util.IOUtils.CloseQuietly(System.IO.Stream)">
  38313. Quietly (no exceptions) close Closable resource. In case of error it will
  38314. be printed to {@link IOUtils} class logger.
  38315. @param closeable
  38316. resource to close
  38317. </member>
  38318. <member name="T:NPOI.Util.LittleEndian">
  38319. <summary>
  38320. a utility class for handling little-endian numbers, which the 80x86 world is
  38321. replete with. The methods are all static, and input/output is from/to byte
  38322. arrays, or from InputStreams.
  38323. </summary>
  38324. <remarks>
  38325. @author Marc Johnson (mjohnson at apache dot org)
  38326. @author Andrew Oliver (acoliver at apache dot org)
  38327. </remarks>
  38328. </member>
  38329. <member name="M:NPOI.Util.LittleEndian.#ctor">
  38330. <summary>
  38331. Initializes a new instance of the <see cref="T:NPOI.Util.LittleEndian"/> class.
  38332. </summary>
  38333. </member>
  38334. <member name="M:NPOI.Util.LittleEndian.GetShort(System.Byte[],System.Int32)">
  38335. <summary>
  38336. get a short value from a byte array
  38337. </summary>
  38338. <param name="data">the byte array</param>
  38339. <param name="offset">a starting offset into the byte array</param>
  38340. <returns>the short (16-bit) value</returns>
  38341. </member>
  38342. <member name="M:NPOI.Util.LittleEndian.GetUShort(System.Byte[],System.Int32)">
  38343. <summary>
  38344. get an unsigned short value from a byte array
  38345. </summary>
  38346. <param name="data">the byte array</param>
  38347. <param name="offset">a starting offset into the byte array</param>
  38348. <returns>the unsigned short (16-bit) value in an integer</returns>
  38349. </member>
  38350. <member name="M:NPOI.Util.LittleEndian.GetShort(System.Byte[])">
  38351. <summary>
  38352. get a short value from a byte array
  38353. </summary>
  38354. <param name="data">a starting offset into the byte array</param>
  38355. <returns>the short (16-bit) value</returns>
  38356. </member>
  38357. <member name="M:NPOI.Util.LittleEndian.GetUShort(System.Byte[])">
  38358. <summary>
  38359. get a short value from a byte array
  38360. </summary>
  38361. <param name="data">the unsigned short (16-bit) value in an integer</param>
  38362. <returns></returns>
  38363. </member>
  38364. <member name="M:NPOI.Util.LittleEndian.GetInt(System.Byte[],System.Int32)">
  38365. <summary>
  38366. get an int value from a byte array
  38367. </summary>
  38368. <param name="data">the byte array</param>
  38369. <param name="offset">a starting offset into the byte array</param>
  38370. <returns>the int (32-bit) value</returns>
  38371. </member>
  38372. <member name="M:NPOI.Util.LittleEndian.GetInt(System.Byte[])">
  38373. <summary>
  38374. get an int value from the beginning of a byte array
  38375. </summary>
  38376. <param name="data">the byte array</param>
  38377. <returns>the int (32-bit) value</returns>
  38378. </member>
  38379. <member name="M:NPOI.Util.LittleEndian.GetUInt(System.Byte[],System.Int32)">
  38380. <summary>
  38381. Gets the U int.
  38382. </summary>
  38383. <param name="data">the byte array</param>
  38384. <param name="offset">a starting offset into the byte array</param>
  38385. <returns>the unsigned int (32-bit) value in a long</returns>
  38386. </member>
  38387. <member name="M:NPOI.Util.LittleEndian.GetUInt(System.Byte[])">
  38388. <summary>
  38389. Gets the U int.
  38390. </summary>
  38391. <param name="data">the byte array</param>
  38392. <returns>the unsigned int (32-bit) value in a long</returns>
  38393. </member>
  38394. <member name="M:NPOI.Util.LittleEndian.GetLong(System.Byte[],System.Int32)">
  38395. <summary>
  38396. get a long value from a byte array
  38397. </summary>
  38398. <param name="data">the byte array</param>
  38399. <param name="offset">a starting offset into the byte array</param>
  38400. <returns>the long (64-bit) value</returns>
  38401. </member>
  38402. <member name="M:NPOI.Util.LittleEndian.GetDouble(System.Byte[],System.Int32)">
  38403. <summary>
  38404. get a double value from a byte array, reads it in little endian format
  38405. then converts the resulting revolting IEEE 754 (curse them) floating
  38406. point number to a c# double
  38407. </summary>
  38408. <param name="data">the byte array</param>
  38409. <param name="offset">a starting offset into the byte array</param>
  38410. <returns>the double (64-bit) value</returns>
  38411. </member>
  38412. <member name="M:NPOI.Util.LittleEndian.PutShort(System.Byte[],System.Int32,System.Int16)">
  38413. <summary>
  38414. Puts the short.
  38415. </summary>
  38416. <param name="data">the byte array</param>
  38417. <param name="offset">a starting offset into the byte array</param>
  38418. <param name="value">The value.</param>
  38419. </member>
  38420. <member name="M:NPOI.Util.LittleEndian.PutByte(System.Byte[],System.Int32,System.Int32)">
  38421. <summary>
  38422. Added for consistency with other put~() methods
  38423. </summary>
  38424. <param name="data">the byte array</param>
  38425. <param name="offset">a starting offset into the byte array</param>
  38426. <param name="value">The value.</param>
  38427. </member>
  38428. <member name="M:NPOI.Util.LittleEndian.PutUShort(System.Byte[],System.Int32,System.Int32)">
  38429. <summary>
  38430. Puts the U short.
  38431. </summary>
  38432. <param name="data">the byte array</param>
  38433. <param name="offset">a starting offset into the byte array</param>
  38434. <param name="value">The value.</param>
  38435. </member>
  38436. <member name="M:NPOI.Util.LittleEndian.PutShort(System.IO.Stream,System.Int16)">
  38437. Put signed short into output stream
  38438. @param value
  38439. the short (16-bit) value
  38440. @param outputStream
  38441. output stream
  38442. @throws IOException
  38443. if an I/O error occurs
  38444. </member>
  38445. <member name="M:NPOI.Util.LittleEndian.PutInt(System.Byte[],System.Int32,System.Int32)">
  38446. <summary>
  38447. put an int value into a byte array
  38448. </summary>
  38449. <param name="data">the byte array</param>
  38450. <param name="offset">a starting offset into the byte array</param>
  38451. <param name="value">the int (32-bit) value</param>
  38452. </member>
  38453. <member name="M:NPOI.Util.LittleEndian.PutInt(System.Int32,System.IO.Stream)">
  38454. <summary>
  38455. Put int into output stream
  38456. </summary>
  38457. <param name="value">the int (32-bit) value</param>
  38458. <param name="outputStream">output stream</param>
  38459. </member>
  38460. <member name="M:NPOI.Util.LittleEndian.PutLong(System.Byte[],System.Int32,System.Int64)">
  38461. <summary>
  38462. put a long value into a byte array
  38463. </summary>
  38464. <param name="data">the byte array</param>
  38465. <param name="offset">a starting offset into the byte array</param>
  38466. <param name="value">the long (64-bit) value</param>
  38467. </member>
  38468. <member name="M:NPOI.Util.LittleEndian.PutDouble(System.Byte[],System.Int32,System.Double)">
  38469. <summary>
  38470. put a double value into a byte array
  38471. </summary>
  38472. <param name="data">the byte array</param>
  38473. <param name="offset">a starting offset into the byte array</param>
  38474. <param name="value">the double (64-bit) value</param>
  38475. </member>
  38476. <member name="M:NPOI.Util.LittleEndian.ReadShort(System.IO.Stream)">
  38477. <summary>
  38478. Reads the short.
  38479. </summary>
  38480. <param name="stream">The stream.</param>
  38481. <returns></returns>
  38482. </member>
  38483. <member name="M:NPOI.Util.LittleEndian.ReadInt(System.IO.Stream)">
  38484. <summary>
  38485. get an int value from an Stream
  38486. </summary>
  38487. <param name="stream">the Stream from which the int is to be read</param>
  38488. <returns>the int (32-bit) value</returns>
  38489. <exception cref="T:System.IO.IOException">will be propagated back to the caller</exception>
  38490. <exception cref="T:NPOI.Util.BufferUnderrunException">if the stream cannot provide enough bytes</exception>
  38491. </member>
  38492. <member name="M:NPOI.Util.LittleEndian.ReadLong(System.IO.Stream)">
  38493. <summary>
  38494. get a long value from a Stream
  38495. </summary>
  38496. <param name="stream">the Stream from which the long is to be read</param>
  38497. <returns>the long (64-bit) value</returns>
  38498. <exception cref="T:System.IO.IOException">will be propagated back to the caller</exception>
  38499. <exception cref="T:NPOI.Util.BufferUnderrunException">if the stream cannot provide enough bytes</exception>
  38500. </member>
  38501. <member name="M:NPOI.Util.LittleEndian.UByteToInt(System.Byte)">
  38502. <summary>
  38503. Us the byte to int.
  38504. </summary>
  38505. <param name="b">The b.</param>
  38506. <returns></returns>
  38507. </member>
  38508. <member name="M:NPOI.Util.LittleEndian.GetByteArray(System.Byte[],System.Int32,System.Int32)">
  38509. <summary>
  38510. Copy a portion of a byte array
  38511. </summary>
  38512. <param name="data"> the original byte array</param>
  38513. <param name="offset">Where to start copying from.</param>
  38514. <param name="size">Number of bytes to copy.</param>
  38515. <returns>The byteArray value</returns>
  38516. <exception cref="T:System.IndexOutOfRangeException">
  38517. if copying would cause access ofdata outside array bounds.
  38518. </exception>
  38519. </member>
  38520. <member name="M:NPOI.Util.LittleEndian.GetUByte(System.Byte[])">
  38521. <summary>
  38522. Gets the unsigned byte.
  38523. </summary>
  38524. <param name="data">the byte array</param>
  38525. <returns></returns>
  38526. </member>
  38527. <member name="M:NPOI.Util.LittleEndian.GetUByte(System.Byte[],System.Int32)">
  38528. <summary>
  38529. Gets the unsigned byte.
  38530. </summary>
  38531. <param name="data">the byte array</param>
  38532. <param name="offset">a starting offset into the byte array</param>
  38533. <returns></returns>
  38534. </member>
  38535. <member name="M:NPOI.Util.LittleEndian.PutDouble(System.Byte[],System.Double)">
  38536. <summary>
  38537. Puts the double.
  38538. </summary>
  38539. <param name="data">the byte array</param>
  38540. <param name="value">The value.</param>
  38541. </member>
  38542. <member name="M:NPOI.Util.LittleEndian.PutDouble(System.Double,System.IO.Stream)">
  38543. put a double value into a byte array
  38544. @param value
  38545. the double (64-bit) value
  38546. @param outputStream
  38547. output stream
  38548. @throws IOException
  38549. if an I/O error occurs
  38550. </member>
  38551. <member name="M:NPOI.Util.LittleEndian.PutUInt(System.Int64,System.IO.Stream)">
  38552. Put unsigned int into output stream
  38553. @param value
  38554. the int (32-bit) value
  38555. @param outputStream
  38556. output stream
  38557. @throws IOException
  38558. if an I/O error occurs
  38559. </member>
  38560. <member name="M:NPOI.Util.LittleEndian.PutUInt(System.Byte[],System.Int32,System.UInt32)">
  38561. <summary>
  38562. Puts the uint.
  38563. </summary>
  38564. <param name="data">the byte array</param>
  38565. <param name="offset">a starting offset into the byte array</param>
  38566. <param name="value">The value.</param>
  38567. </member>
  38568. <member name="M:NPOI.Util.LittleEndian.PutLong(System.Byte[],System.Int64)">
  38569. <summary>
  38570. Puts the long.
  38571. </summary>
  38572. <param name="data">the byte array</param>
  38573. <param name="value">The value.</param>
  38574. </member>
  38575. <member name="M:NPOI.Util.LittleEndian.PutLong(System.Int64,System.IO.Stream)">
  38576. Put long into output stream
  38577. @param value
  38578. the long (64-bit) value
  38579. @param outputStream
  38580. output stream
  38581. @throws IOException
  38582. if an I/O error occurs
  38583. </member>
  38584. <member name="M:NPOI.Util.LittleEndian.PutULong(System.Byte[],System.UInt64)">
  38585. <summary>
  38586. Puts the long.
  38587. </summary>
  38588. <param name="data">the byte array</param>
  38589. <param name="value">The value.</param>
  38590. </member>
  38591. <member name="M:NPOI.Util.LittleEndian.PutULong(System.Byte[],System.Int32,System.UInt64)">
  38592. <summary>
  38593. Puts the ulong.
  38594. </summary>
  38595. <param name="data">the byte array</param>
  38596. <param name="offset">a starting offset into the byte array</param>
  38597. <param name="value">The value.</param>
  38598. </member>
  38599. <member name="M:NPOI.Util.LittleEndian.PutNumber(System.Byte[],System.Int32,System.Int64,System.Int32)">
  38600. <summary>
  38601. Puts the number.
  38602. </summary>
  38603. <param name="data">the byte array</param>
  38604. <param name="offset">a starting offset into the byte array</param>
  38605. <param name="value">The value.</param>
  38606. <param name="size">The size.</param>
  38607. </member>
  38608. <member name="M:NPOI.Util.LittleEndian.PutNumber(System.Byte[],System.Int32,System.UInt64,System.Int32)">
  38609. <summary>
  38610. Puts the number.
  38611. </summary>
  38612. <param name="data">the byte array</param>
  38613. <param name="offset">a starting offset into the byte array</param>
  38614. <param name="value">The value.</param>
  38615. <param name="size">The size.</param>
  38616. </member>
  38617. <member name="M:NPOI.Util.LittleEndian.PutShortArray(System.Byte[],System.Int32,System.Int16[])">
  38618. <summary>
  38619. Puts the short array.
  38620. </summary>
  38621. <param name="data">the byte array</param>
  38622. <param name="offset">a starting offset into the byte array</param>
  38623. <param name="value">The value.</param>
  38624. </member>
  38625. <member name="M:NPOI.Util.LittleEndian.PutUShort(System.Byte[],System.Int32)">
  38626. <summary>
  38627. Puts the U short.
  38628. </summary>
  38629. <param name="data">the byte array</param>
  38630. <param name="value">The value.</param>
  38631. </member>
  38632. <member name="M:NPOI.Util.LittleEndian.PutUShort(System.Int32,System.IO.Stream)">
  38633. Put unsigned short into output stream
  38634. @param value
  38635. the unsigned short (16-bit) value
  38636. @param outputStream
  38637. output stream
  38638. @throws IOException
  38639. if an I/O error occurs
  38640. </member>
  38641. <member name="M:NPOI.Util.LittleEndian.ReadFromStream(System.IO.Stream,System.Int32)">
  38642. <summary>
  38643. Reads from stream.
  38644. </summary>
  38645. <param name="stream">The stream.</param>
  38646. <param name="size">The size.</param>
  38647. <returns></returns>
  38648. </member>
  38649. <member name="M:NPOI.Util.LittleEndian.ReadULong(System.IO.Stream)">
  38650. <summary>
  38651. Reads the long.
  38652. </summary>
  38653. <param name="stream">The stream.</param>
  38654. <returns></returns>
  38655. </member>
  38656. <member name="T:NPOI.Util.LittleEndianByteArrayInputStream">
  38657. <summary>
  38658. Adapts a plain byte array to <see cref="T:NPOI.Util.ILittleEndianInput"/>
  38659. </summary>
  38660. <remarks>@author Josh Micich</remarks>
  38661. </member>
  38662. <member name="T:NPOI.Util.LittleEndianByteArrayOutputStream">
  38663. <summary>
  38664. Adapts a plain byte array to <see cref="T:NPOI.Util.ILittleEndianOutput"/>
  38665. </summary>
  38666. <remarks>@author Josh Micich</remarks>
  38667. </member>
  38668. <member name="T:NPOI.Util.ILittleEndianInput">
  38669. @author Josh Micich
  38670. </member>
  38671. <member name="T:NPOI.Util.LittleEndianInputStream">
  38672. <summary>
  38673. Wraps an <see cref="T:System.IO.Stream"/> providing <see cref="T:NPOI.Util.ILittleEndianInput"/><p/>
  38674. This class does not buffer any input, so the stream Read position maintained
  38675. by this class is consistent with that of the inner stream.
  38676. </summary>
  38677. <remarks>
  38678. @author Josh Micich
  38679. </remarks>
  38680. </member>
  38681. <member name="M:NPOI.Util.LittleEndianInputStream.Read(System.Byte[])">
  38682. <summary>
  38683. Reads up to <code>byte.length</code> bytes of data from this
  38684. input stream into an array of bytes. This method blocks until some
  38685. input is available.
  38686. simulate java FilterInputStream
  38687. </summary>
  38688. <param name="b"></param>
  38689. <returns></returns>
  38690. </member>
  38691. <member name="M:NPOI.Util.LittleEndianInputStream.Read(System.Byte[],System.Int32,System.Int32)">
  38692. <summary>
  38693. Reads up to <code>len</code> bytes of data from this input stream
  38694. into an array of bytes.If<code> len</code> is not zero, the method
  38695. blocks until some input is available; otherwise, no
  38696. bytes are read and<code>0</code> is returned.
  38697. simulate java FilterInputStream
  38698. </summary>
  38699. <param name="b"></param>
  38700. <param name="off"></param>
  38701. <param name="len"></param>
  38702. <returns></returns>
  38703. </member>
  38704. <member name="T:NPOI.Util.ILittleEndianOutput">
  38705. @author Josh Micich
  38706. </member>
  38707. <member name="T:NPOI.Util.LittleEndianOutputStream">
  38708. <summary>
  38709. Wraps an <see cref="T:System.IO.Stream"/> providing <see cref="T:NPOI.Util.ILittleEndianOutput"/>
  38710. </summary>
  38711. <remarks>@author Josh Micich</remarks>
  38712. </member>
  38713. <member name="T:NPOI.Util.LocaleUtil">
  38714. This utility class is used to set locale and time zone settings beside
  38715. of the JDK internal {@link java.util.Locale#setDefault(Locale)} and
  38716. {@link java.util.TimeZone#setDefault(TimeZone)} methods, because
  38717. the locale/time zone specific handling of certain office documents -
  38718. maybe for different time zones / locales ... - shouldn't affect
  38719. other java components.
  38720. The settings are saved in a {@link java.lang.ThreadLocal},
  38721. so they only apply to the current thread and can't be set globally.
  38722. </member>
  38723. <member name="F:NPOI.Util.LocaleUtil.TIMEZONE_UTC">
  38724. Excel doesn't store TimeZone information in the file, so if in doubt,
  38725. use UTC to perform calculations
  38726. </member>
  38727. <member name="F:NPOI.Util.LocaleUtil.CHARSET_1252">
  38728. Default encoding for unknown byte encodings of native files
  38729. (at least it's better than to rely on a platform dependent encoding
  38730. for legacy stuff ...)
  38731. </member>
  38732. <member name="M:NPOI.Util.LocaleUtil.SetUserTimeZone(System.TimeZoneInfo)">
  38733. As time zone information is not stored in any format, it can be
  38734. set before any date calculations take place.
  38735. This setting is specific to the current thread.
  38736. @param timezone the timezone under which date calculations take place
  38737. </member>
  38738. <member name="M:NPOI.Util.LocaleUtil.SetUserTimeZone(System.TimeZone)">
  38739. As time zone information is not stored in any format, it can be
  38740. set before any date calculations take place.
  38741. This setting is specific to the current thread.
  38742. @param timezone the timezone under which date calculations take place
  38743. </member>
  38744. <member name="M:NPOI.Util.LocaleUtil.GetUserTimeZoneInfo">
  38745. @return the time zone which is used for date calculations, defaults to UTC
  38746. </member>
  38747. <member name="M:NPOI.Util.LocaleUtil.GetUserTimeZone">
  38748. @return the time zone which is used for date calculations, defaults to UTC
  38749. </member>
  38750. <member name="M:NPOI.Util.LocaleUtil.SetUserLocale(System.Globalization.CultureInfo)">
  38751. Sets default user locale.
  38752. This setting is specific to the current thread.
  38753. </member>
  38754. <member name="M:NPOI.Util.LocaleUtil.GetUserLocale">
  38755. @return the default user locale, defaults to {@link Locale#ROOT}
  38756. </member>
  38757. <member name="M:NPOI.Util.LocaleUtil.GetLocaleCalendar">
  38758. @return a calendar for the user locale and time zone
  38759. </member>
  38760. <member name="M:NPOI.Util.LocaleUtil.GetLocaleCalendar(System.Int32,System.Int32,System.Int32)">
  38761. Convenience method - month is 0-based as in java.util.Calendar
  38762. @param year
  38763. @param month
  38764. @param day
  38765. @return a calendar for the user locale and time zone, and the given date
  38766. </member>
  38767. <member name="M:NPOI.Util.LocaleUtil.GetLocaleCalendar(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  38768. Convenience method - month is 0-based as in java.util.Calendar
  38769. @param year
  38770. @param month
  38771. @param day
  38772. @param hour
  38773. @param minute
  38774. @param second
  38775. @return a calendar for the user locale and time zone, and the given date
  38776. </member>
  38777. <member name="M:NPOI.Util.LocaleUtil.GetLocaleCalendar(System.TimeZoneInfo)">
  38778. @return a calendar for the user locale and time zone
  38779. </member>
  38780. <member name="M:NPOI.Util.LocaleUtil.GetLocaleCalendar(System.TimeZone)">
  38781. @return a calendar for the user locale and time zone
  38782. </member>
  38783. <member name="M:NPOI.Util.LongField.#ctor(System.Int32)">
  38784. <summary>
  38785. construct the <see cref="T:NPOI.Util.LongField"/> with its offset into its containing byte array
  38786. </summary>
  38787. <param name="offset">The offset.</param>
  38788. </member>
  38789. <member name="M:NPOI.Util.LongField.#ctor(System.Int32,System.Int64)">
  38790. <summary>
  38791. construct the LongField with its offset into its containing
  38792. byte array and initialize its value
  38793. </summary>
  38794. <param name="offset">offset of the field within its byte array</param>
  38795. <param name="value">the initial value</param>
  38796. </member>
  38797. <member name="M:NPOI.Util.LongField.#ctor(System.Int32,System.Byte[])">
  38798. <summary>
  38799. Construct the <see cref="T:NPOI.Util.LongField"/> class with its offset into its containing
  38800. byte array and initialize its value from its byte array
  38801. </summary>
  38802. <param name="offset">The offset of the field within its byte array</param>
  38803. <param name="data">the byte array to read the value from</param>
  38804. </member>
  38805. <member name="M:NPOI.Util.LongField.#ctor(System.Int32,System.Int64,System.Byte[])">
  38806. <summary>
  38807. construct the <see cref="T:NPOI.Util.LongField"/> class with its offset into its containing
  38808. byte array, initialize its value, and write the value to a byte
  38809. array
  38810. </summary>
  38811. <param name="offset">offset of the field within its byte array</param>
  38812. <param name="value">the initial value</param>
  38813. <param name="data">the byte array to write the value to</param>
  38814. </member>
  38815. <member name="P:NPOI.Util.LongField.Value">
  38816. <summary>
  38817. Getg or sets the LongField's current value
  38818. </summary>
  38819. <value>The current value</value>
  38820. </member>
  38821. <member name="M:NPOI.Util.LongField.Set(System.Int64,System.Byte[])">
  38822. <summary>
  38823. set the LongField's current value and write it to a byte array
  38824. </summary>
  38825. <param name="value">value to be set</param>
  38826. <param name="data">the byte array to write the value to</param>
  38827. </member>
  38828. <member name="M:NPOI.Util.LongField.ReadFromBytes(System.Byte[])">
  38829. <summary>
  38830. set the value from its offset into an array of bytes
  38831. </summary>
  38832. <param name="data">the byte array from which the value is to be read</param>
  38833. </member>
  38834. <member name="M:NPOI.Util.LongField.ReadFromStream(System.IO.Stream)">
  38835. <summary>
  38836. set the value from an Stream
  38837. </summary>
  38838. <param name="stream">the Stream from which the value is to be</param>
  38839. </member>
  38840. <member name="M:NPOI.Util.LongField.WriteToBytes(System.Byte[])">
  38841. <summary>
  38842. write the value out to an array of bytes at the appropriate offset
  38843. </summary>
  38844. <param name="data">the array of bytes to which the value is to be written</param>
  38845. </member>
  38846. <member name="M:NPOI.Util.LongField.Write(System.Int32,System.Int64,System.Byte[])">
  38847. <summary>
  38848. Same as using the constructor <see cref="T:NPOI.Util.LongField"/> with the same
  38849. parameter list. Avoid creation of an useless object.
  38850. </summary>
  38851. <param name="offset">offset of the field within its byte array</param>
  38852. <param name="value">the initial value</param>
  38853. <param name="data">the byte array to write the value to</param>
  38854. </member>
  38855. <member name="M:NPOI.Util.LongField.ToString">
  38856. <summary>
  38857. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  38858. </summary>
  38859. <returns>
  38860. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  38861. </returns>
  38862. </member>
  38863. <member name="T:NPOI.Util.NullLogger">
  38864. <summary>
  38865. A Logger class that strives to make it as easy as possible for
  38866. developers to write Log calls, while simultaneously making those
  38867. calls as cheap as possible by performing lazy evaluation of the Log
  38868. message.
  38869. @author Marc Johnson (mjohnson at apache dot org)
  38870. @author Glen Stampoultzis (glens at apache.org)
  38871. @author Nicola Ken Barozzi (nicolaken at apache.org)
  38872. </summary>
  38873. </member>
  38874. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object)">
  38875. Log a message
  38876. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38877. @param obj1 The object to Log.
  38878. </member>
  38879. <member name="M:NPOI.Util.NullLogger.Check(System.Int32)">
  38880. Check if a Logger is enabled to Log at the specified level
  38881. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38882. </member>
  38883. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object)">
  38884. Log a message. Lazily appends Object parameters together.
  38885. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38886. @param obj1 first object to place in the message
  38887. @param obj2 second object to place in the message
  38888. </member>
  38889. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object)">
  38890. Log a message. Lazily appends Object parameters together.
  38891. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38892. @param obj1 first Object to place in the message
  38893. @param obj2 second Object to place in the message
  38894. @param obj3 third Object to place in the message
  38895. </member>
  38896. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object)">
  38897. Log a message. Lazily appends Object parameters together.
  38898. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38899. @param obj1 first Object to place in the message
  38900. @param obj2 second Object to place in the message
  38901. @param obj3 third Object to place in the message
  38902. @param obj4 fourth Object to place in the message
  38903. </member>
  38904. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object)">
  38905. Log a message. Lazily appends Object parameters together.
  38906. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38907. @param obj1 first Object to place in the message
  38908. @param obj2 second Object to place in the message
  38909. @param obj3 third Object to place in the message
  38910. @param obj4 fourth Object to place in the message
  38911. @param obj5 fifth Object to place in the message
  38912. </member>
  38913. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object)">
  38914. Log a message. Lazily appends Object parameters together.
  38915. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38916. @param obj1 first Object to place in the message
  38917. @param obj2 second Object to place in the message
  38918. @param obj3 third Object to place in the message
  38919. @param obj4 fourth Object to place in the message
  38920. @param obj5 fifth Object to place in the message
  38921. @param obj6 sixth Object to place in the message
  38922. </member>
  38923. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object)">
  38924. Log a message. Lazily appends Object parameters together.
  38925. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38926. @param obj1 first Object to place in the message
  38927. @param obj2 second Object to place in the message
  38928. @param obj3 third Object to place in the message
  38929. @param obj4 fourth Object to place in the message
  38930. @param obj5 fifth Object to place in the message
  38931. @param obj6 sixth Object to place in the message
  38932. @param obj7 seventh Object to place in the message
  38933. </member>
  38934. <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)">
  38935. Log a message. Lazily appends Object parameters together.
  38936. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38937. @param obj1 first Object to place in the message
  38938. @param obj2 second Object to place in the message
  38939. @param obj3 third Object to place in the message
  38940. @param obj4 fourth Object to place in the message
  38941. @param obj5 fifth Object to place in the message
  38942. @param obj6 sixth Object to place in the message
  38943. @param obj7 seventh Object to place in the message
  38944. @param obj8 eighth Object to place in the message
  38945. </member>
  38946. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Exception)">
  38947. Log a message
  38948. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38949. @param obj1 The object to Log. This is converted to a string.
  38950. @param exception An exception to be Logged
  38951. </member>
  38952. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Exception)">
  38953. Log a message. Lazily appends Object parameters together.
  38954. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38955. @param obj1 first Object to place in the message
  38956. @param obj2 second Object to place in the message
  38957. @param exception An exception to be Logged
  38958. </member>
  38959. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Exception)">
  38960. Log a message. Lazily appends Object parameters together.
  38961. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38962. @param obj1 first Object to place in the message
  38963. @param obj2 second Object to place in the message
  38964. @param obj3 third object to place in the message
  38965. @param exception An error message to be Logged
  38966. </member>
  38967. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  38968. Log a message. Lazily appends Object parameters together.
  38969. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38970. @param obj1 first Object to place in the message
  38971. @param obj2 second Object to place in the message
  38972. @param obj3 third object to place in the message
  38973. @param obj4 fourth object to place in the message
  38974. @param exception An exception to be Logged
  38975. </member>
  38976. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  38977. Log a message. Lazily appends Object parameters together.
  38978. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38979. @param obj1 first Object to place in the message
  38980. @param obj2 second Object to place in the message
  38981. @param obj3 third object to place in the message
  38982. @param obj4 fourth object to place in the message
  38983. @param obj5 fifth object to place in the message
  38984. @param exception An exception to be Logged
  38985. </member>
  38986. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  38987. Log a message. Lazily appends Object parameters together.
  38988. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38989. @param obj1 first Object to place in the message
  38990. @param obj2 second Object to place in the message
  38991. @param obj3 third object to place in the message
  38992. @param obj4 fourth object to place in the message
  38993. @param obj5 fifth object to place in the message
  38994. @param obj6 sixth object to place in the message
  38995. @param exception An exception to be Logged
  38996. </member>
  38997. <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)">
  38998. Log a message. Lazily appends Object parameters together.
  38999. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  39000. @param obj1 first Object to place in the message
  39001. @param obj2 second Object to place in the message
  39002. @param obj3 third object to place in the message
  39003. @param obj4 fourth object to place in the message
  39004. @param obj5 fifth object to place in the message
  39005. @param obj6 sixth object to place in the message
  39006. @param obj7 seventh object to place in the message
  39007. @param exception An exception to be Logged
  39008. </member>
  39009. <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)">
  39010. Log a message. Lazily appends Object parameters together.
  39011. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  39012. @param obj1 first Object to place in the message
  39013. @param obj2 second Object to place in the message
  39014. @param obj3 third object to place in the message
  39015. @param obj4 fourth object to place in the message
  39016. @param obj5 fifth object to place in the message
  39017. @param obj6 sixth object to place in the message
  39018. @param obj7 seventh object to place in the message
  39019. @param obj8 eighth object to place in the message
  39020. @param exception An exception to be Logged
  39021. </member>
  39022. <member name="F:NPOI.Util.PngUtils.PNG_FILE_HEADER">
  39023. File header for PNG format.
  39024. </member>
  39025. <member name="M:NPOI.Util.PngUtils.MatchesPngHeader(System.Byte[],System.Int32)">
  39026. Checks if the offset matches the PNG header.
  39027. @param data the data to check.
  39028. @param offset the offset to check at.
  39029. @return {@code true} if the offset matches.
  39030. </member>
  39031. <member name="F:NPOI.Util.POILogFactory._loggers">
  39032. Map of POILogger instances, with classes as keys
  39033. </member>
  39034. <member name="F:NPOI.Util.POILogFactory._nullLogger">
  39035. A common instance of NullLogger, as it does nothing
  39036. we only need the one
  39037. </member>
  39038. <member name="F:NPOI.Util.POILogFactory._loggerClassName">
  39039. The name of the class to use. Initialised the
  39040. first time we need it
  39041. </member>
  39042. <member name="M:NPOI.Util.POILogFactory.#ctor">
  39043. <summary>
  39044. Initializes a new instance of the <see cref="T:NPOI.Util.POILogFactory"/> class.
  39045. </summary>
  39046. </member>
  39047. <member name="M:NPOI.Util.POILogFactory.GetLogger(System.Type)">
  39048. <summary>
  39049. Get a logger, based on a class name
  39050. </summary>
  39051. <param name="type">the class whose name defines the log</param>
  39052. <returns>a POILogger for the specified class</returns>
  39053. </member>
  39054. <member name="M:NPOI.Util.POILogFactory.GetLogger(System.String)">
  39055. <summary>
  39056. Get a logger, based on a String
  39057. </summary>
  39058. <param name="cat">the String that defines the log</param>
  39059. <returns>a POILogger for the specified class</returns>
  39060. </member>
  39061. <member name="M:NPOI.Util.POILogger.#ctor">
  39062. package scope so it cannot be instantiated outside of the util
  39063. package. You need a POILogger? Go to the POILogFactory for one
  39064. </member>
  39065. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object)">
  39066. Log a message
  39067. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  39068. @param obj1 The object to Log. This is converted to a string.
  39069. </member>
  39070. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Exception)">
  39071. Log a message
  39072. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  39073. @param obj1 The object to Log. This is converted to a string.
  39074. @param exception An exception to be Logged
  39075. </member>
  39076. <member name="M:NPOI.Util.POILogger.Check(System.Int32)">
  39077. Check if a Logger is enabled to Log at the specified level
  39078. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  39079. </member>
  39080. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object)">
  39081. Log a message. Lazily appends Object parameters together.
  39082. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  39083. @param obj1 first object to place in the message
  39084. @param obj2 second object to place in the message
  39085. </member>
  39086. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object)">
  39087. Log a message. Lazily appends Object parameters together.
  39088. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  39089. @param obj1 first Object to place in the message
  39090. @param obj2 second Object to place in the message
  39091. @param obj3 third Object to place in the message
  39092. </member>
  39093. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object)">
  39094. Log a message. Lazily appends Object parameters together.
  39095. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  39096. @param obj1 first Object to place in the message
  39097. @param obj2 second Object to place in the message
  39098. @param obj3 third Object to place in the message
  39099. @param obj4 fourth Object to place in the message
  39100. </member>
  39101. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object)">
  39102. Log a message. Lazily appends Object parameters together.
  39103. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  39104. @param obj1 first Object to place in the message
  39105. @param obj2 second Object to place in the message
  39106. @param obj3 third Object to place in the message
  39107. @param obj4 fourth Object to place in the message
  39108. @param obj5 fifth Object to place in the message
  39109. </member>
  39110. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object)">
  39111. Log a message. Lazily appends Object parameters together.
  39112. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  39113. @param obj1 first Object to place in the message
  39114. @param obj2 second Object to place in the message
  39115. @param obj3 third Object to place in the message
  39116. @param obj4 fourth Object to place in the message
  39117. @param obj5 fifth Object to place in the message
  39118. @param obj6 sixth Object to place in the message
  39119. </member>
  39120. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object)">
  39121. Log a message. Lazily appends Object parameters together.
  39122. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  39123. @param obj1 first Object to place in the message
  39124. @param obj2 second Object to place in the message
  39125. @param obj3 third Object to place in the message
  39126. @param obj4 fourth Object to place in the message
  39127. @param obj5 fifth Object to place in the message
  39128. @param obj6 sixth Object to place in the message
  39129. @param obj7 seventh Object to place in the message
  39130. </member>
  39131. <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)">
  39132. Log a message. Lazily appends Object parameters together.
  39133. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  39134. @param obj1 first Object to place in the message
  39135. @param obj2 second Object to place in the message
  39136. @param obj3 third Object to place in the message
  39137. @param obj4 fourth Object to place in the message
  39138. @param obj5 fifth Object to place in the message
  39139. @param obj6 sixth Object to place in the message
  39140. @param obj7 seventh Object to place in the message
  39141. @param obj8 eighth Object to place in the message
  39142. </member>
  39143. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Exception)">
  39144. Log an exception, without a message
  39145. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  39146. @param exception An exception to be Logged
  39147. </member>
  39148. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Exception)">
  39149. Log a message. Lazily appends Object parameters together.
  39150. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  39151. @param obj1 first Object to place in the message
  39152. @param obj2 second Object to place in the message
  39153. @param exception An exception to be Logged
  39154. </member>
  39155. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Exception)">
  39156. Log a message. Lazily appends Object parameters together.
  39157. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  39158. @param obj1 first Object to place in the message
  39159. @param obj2 second Object to place in the message
  39160. @param obj3 third object to place in the message
  39161. @param exception An error message to be Logged
  39162. </member>
  39163. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  39164. Log a message. Lazily appends Object parameters together.
  39165. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  39166. @param obj1 first Object to place in the message
  39167. @param obj2 second Object to place in the message
  39168. @param obj3 third object to place in the message
  39169. @param obj4 fourth object to place in the message
  39170. @param exception An exception to be Logged
  39171. </member>
  39172. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  39173. Log a message. Lazily appends Object parameters together.
  39174. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  39175. @param obj1 first Object to place in the message
  39176. @param obj2 second Object to place in the message
  39177. @param obj3 third object to place in the message
  39178. @param obj4 fourth object to place in the message
  39179. @param obj5 fifth object to place in the message
  39180. @param exception An exception to be Logged
  39181. </member>
  39182. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  39183. Log a message. Lazily appends Object parameters together.
  39184. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  39185. @param obj1 first Object to place in the message
  39186. @param obj2 second Object to place in the message
  39187. @param obj3 third object to place in the message
  39188. @param obj4 fourth object to place in the message
  39189. @param obj5 fifth object to place in the message
  39190. @param obj6 sixth object to place in the message
  39191. @param exception An exception to be Logged
  39192. </member>
  39193. <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)">
  39194. Log a message. Lazily appends Object parameters together.
  39195. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  39196. @param obj1 first Object to place in the message
  39197. @param obj2 second Object to place in the message
  39198. @param obj3 third object to place in the message
  39199. @param obj4 fourth object to place in the message
  39200. @param obj5 fifth object to place in the message
  39201. @param obj6 sixth object to place in the message
  39202. @param obj7 seventh object to place in the message
  39203. @param exception An exception to be Logged
  39204. </member>
  39205. <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)">
  39206. Log a message. Lazily appends Object parameters together.
  39207. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  39208. @param obj1 first Object to place in the message
  39209. @param obj2 second Object to place in the message
  39210. @param obj3 third object to place in the message
  39211. @param obj4 fourth object to place in the message
  39212. @param obj5 fifth object to place in the message
  39213. @param obj6 sixth object to place in the message
  39214. @param obj7 seventh object to place in the message
  39215. @param obj8 eighth object to place in the message
  39216. @param exception An exception to be Logged
  39217. </member>
  39218. <member name="M:NPOI.Util.PushbackInputStream.ReadByte">
  39219. <summary>
  39220. 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.
  39221. </summary>
  39222. <returns>
  39223. The unsigned byte cast to an Int32, or -1 if at the end of the stream.
  39224. </returns>
  39225. <exception cref="T:System.NotSupportedException">
  39226. The stream does not support reading.
  39227. </exception>
  39228. <exception cref="T:System.ObjectDisposedException">
  39229. Methods were called after the stream was closed.
  39230. </exception>
  39231. </member>
  39232. <member name="M:NPOI.Util.PushbackInputStream.Unread(System.Int32)">
  39233. <summary>
  39234. Unreads the specified b.
  39235. </summary>
  39236. <param name="b">The b.</param>
  39237. </member>
  39238. <member name="P:NPOI.Util.PushbackInputStream.CanRead">
  39239. <summary>
  39240. When overridden in a derived class, gets a value indicating whether the current stream supports reading.
  39241. </summary>
  39242. <value></value>
  39243. <returns>true if the stream supports reading; otherwise, false.
  39244. </returns>
  39245. </member>
  39246. <member name="M:NPOI.Util.PushbackInputStream.Unread(System.Byte[],System.Int32,System.Int32)">
  39247. <summary>
  39248. Pushes back a portion of an array of bytes by copying it to the front
  39249. of the pushback buffer.
  39250. </summary>
  39251. <param name="b">the byte array to push back.</param>
  39252. <param name="off">the start offset of the data.</param>
  39253. <param name="len">the number of bytes to push back.</param>
  39254. </member>
  39255. <member name="P:NPOI.Util.PushbackInputStream.CanSeek">
  39256. <summary>
  39257. When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
  39258. </summary>
  39259. <value></value>
  39260. <returns>true if the stream supports seeking; otherwise, false.
  39261. </returns>
  39262. </member>
  39263. <member name="P:NPOI.Util.PushbackInputStream.CanWrite">
  39264. <summary>
  39265. When overridden in a derived class, gets a value indicating whether the current stream supports writing.
  39266. </summary>
  39267. <value></value>
  39268. <returns>true if the stream supports writing; otherwise, false.
  39269. </returns>
  39270. </member>
  39271. <member name="P:NPOI.Util.PushbackInputStream.Length">
  39272. <summary>
  39273. When overridden in a derived class, gets the length in bytes of the stream.
  39274. </summary>
  39275. <value></value>
  39276. <returns>
  39277. A long value representing the length of the stream in bytes.
  39278. </returns>
  39279. <exception cref="T:System.NotSupportedException">
  39280. A class derived from Stream does not support seeking.
  39281. </exception>
  39282. <exception cref="T:System.ObjectDisposedException">
  39283. Methods were called after the stream was closed.
  39284. </exception>
  39285. </member>
  39286. <member name="P:NPOI.Util.PushbackInputStream.Position">
  39287. <summary>
  39288. When overridden in a derived class, gets or sets the position within the current stream.
  39289. </summary>
  39290. <value></value>
  39291. <returns>
  39292. The current position within the stream.
  39293. </returns>
  39294. <exception cref="T:System.IO.IOException">
  39295. An I/O error occurs.
  39296. </exception>
  39297. <exception cref="T:System.NotSupportedException">
  39298. The stream does not support seeking.
  39299. </exception>
  39300. <exception cref="T:System.ObjectDisposedException">
  39301. Methods were called after the stream was closed.
  39302. </exception>
  39303. </member>
  39304. <member name="M:NPOI.Util.PushbackInputStream.Close">
  39305. <summary>
  39306. Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream.
  39307. </summary>
  39308. </member>
  39309. <member name="M:NPOI.Util.PushbackInputStream.Flush">
  39310. <summary>
  39311. When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.
  39312. </summary>
  39313. <exception cref="T:System.IO.IOException">
  39314. An I/O error occurs.
  39315. </exception>
  39316. </member>
  39317. <member name="M:NPOI.Util.PushbackInputStream.Seek(System.Int64,System.IO.SeekOrigin)">
  39318. <summary>
  39319. When overridden in a derived class, sets the position within the current stream.
  39320. </summary>
  39321. <param name="offset">A byte offset relative to the <paramref name="origin"/> parameter.</param>
  39322. <param name="origin">A value of type <see cref="T:System.IO.SeekOrigin"/> indicating the reference point used to obtain the new position.</param>
  39323. <returns>
  39324. The new position within the current stream.
  39325. </returns>
  39326. <exception cref="T:System.IO.IOException">
  39327. An I/O error occurs.
  39328. </exception>
  39329. <exception cref="T:System.NotSupportedException">
  39330. The stream does not support seeking, such as if the stream is constructed from a pipe or console output.
  39331. </exception>
  39332. <exception cref="T:System.ObjectDisposedException">
  39333. Methods were called after the stream was closed.
  39334. </exception>
  39335. </member>
  39336. <member name="M:NPOI.Util.PushbackInputStream.SetLength(System.Int64)">
  39337. <summary>
  39338. When overridden in a derived class, sets the length of the current stream.
  39339. </summary>
  39340. <param name="value">The desired length of the current stream in bytes.</param>
  39341. <exception cref="T:System.IO.IOException">
  39342. An I/O error occurs.
  39343. </exception>
  39344. <exception cref="T:System.NotSupportedException">
  39345. The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output.
  39346. </exception>
  39347. <exception cref="T:System.ObjectDisposedException">
  39348. Methods were called after the stream was closed.
  39349. </exception>
  39350. </member>
  39351. <member name="M:NPOI.Util.PushbackInputStream.Write(System.Byte[],System.Int32,System.Int32)">
  39352. <summary>
  39353. 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.
  39354. </summary>
  39355. <param name="buffer">An array of bytes. This method copies <paramref name="count"/> bytes from <paramref name="buffer"/> to the current stream.</param>
  39356. <param name="offset">The zero-based byte offset in <paramref name="buffer"/> at which to begin copying bytes to the current stream.</param>
  39357. <param name="count">The number of bytes to be written to the current stream.</param>
  39358. <exception cref="T:System.ArgumentException">
  39359. The sum of <paramref name="offset"/> and <paramref name="count"/> is greater than the buffer length.
  39360. </exception>
  39361. <exception cref="T:System.ArgumentNullException">
  39362. <paramref name="buffer"/> is null.
  39363. </exception>
  39364. <exception cref="T:System.ArgumentOutOfRangeException">
  39365. <paramref name="offset"/> or <paramref name="count"/> is negative.
  39366. </exception>
  39367. <exception cref="T:System.IO.IOException">
  39368. An I/O error occurs.
  39369. </exception>
  39370. <exception cref="T:System.NotSupportedException">
  39371. The stream does not support writing.
  39372. </exception>
  39373. <exception cref="T:System.ObjectDisposedException">
  39374. Methods were called after the stream was closed.
  39375. </exception>
  39376. </member>
  39377. <member name="M:NPOI.Util.PushbackInputStream.WriteByte(System.Byte)">
  39378. <summary>
  39379. Writes a byte to the current position in the stream and advances the position within the stream by one byte.
  39380. </summary>
  39381. <param name="value">The byte to write to the stream.</param>
  39382. <exception cref="T:System.IO.IOException">
  39383. An I/O error occurs.
  39384. </exception>
  39385. <exception cref="T:System.NotSupportedException">
  39386. The stream does not support writing, or the stream is already closed.
  39387. </exception>
  39388. <exception cref="T:System.ObjectDisposedException">
  39389. Methods were called after the stream was closed.
  39390. </exception>
  39391. </member>
  39392. <member name="M:NPOI.Util.PushbackStream.ReadByte">
  39393. <summary>
  39394. 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.
  39395. </summary>
  39396. <returns>
  39397. The unsigned byte cast to an Int32, or -1 if at the end of the stream.
  39398. </returns>
  39399. <exception cref="T:System.NotSupportedException">
  39400. The stream does not support reading.
  39401. </exception>
  39402. <exception cref="T:System.ObjectDisposedException">
  39403. Methods were called after the stream was closed.
  39404. </exception>
  39405. </member>
  39406. <member name="M:NPOI.Util.PushbackStream.Read(System.Byte[],System.Int32,System.Int32)">
  39407. <summary>
  39408. 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.
  39409. </summary>
  39410. <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>
  39411. <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>
  39412. <param name="count">The maximum number of bytes to be read from the current stream.</param>
  39413. <returns>
  39414. 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.
  39415. </returns>
  39416. <exception cref="T:System.ArgumentException">
  39417. The sum of <paramref name="offset"/> and <paramref name="count"/> is larger than the buffer length.
  39418. </exception>
  39419. <exception cref="T:System.ArgumentNullException">
  39420. <paramref name="buffer"/> is null.
  39421. </exception>
  39422. <exception cref="T:System.ArgumentOutOfRangeException">
  39423. <paramref name="offset"/> or <paramref name="count"/> is negative.
  39424. </exception>
  39425. <exception cref="T:System.IO.IOException">
  39426. An I/O error occurs.
  39427. </exception>
  39428. <exception cref="T:System.NotSupportedException">
  39429. The stream does not support reading.
  39430. </exception>
  39431. <exception cref="T:System.ObjectDisposedException">
  39432. Methods were called after the stream was closed.
  39433. </exception>
  39434. </member>
  39435. <member name="M:NPOI.Util.PushbackStream.Unread(System.Int32)">
  39436. <summary>
  39437. Unreads the specified b.
  39438. </summary>
  39439. <param name="b">The b.</param>
  39440. </member>
  39441. <member name="P:NPOI.Util.PushbackStream.CanRead">
  39442. <summary>
  39443. When overridden in a derived class, gets a value indicating whether the current stream supports reading.
  39444. </summary>
  39445. <value></value>
  39446. <returns>true if the stream supports reading; otherwise, false.
  39447. </returns>
  39448. </member>
  39449. <member name="P:NPOI.Util.PushbackStream.CanSeek">
  39450. <summary>
  39451. When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
  39452. </summary>
  39453. <value></value>
  39454. <returns>true if the stream supports seeking; otherwise, false.
  39455. </returns>
  39456. </member>
  39457. <member name="P:NPOI.Util.PushbackStream.CanWrite">
  39458. <summary>
  39459. When overridden in a derived class, gets a value indicating whether the current stream supports writing.
  39460. </summary>
  39461. <value></value>
  39462. <returns>true if the stream supports writing; otherwise, false.
  39463. </returns>
  39464. </member>
  39465. <member name="P:NPOI.Util.PushbackStream.Length">
  39466. <summary>
  39467. When overridden in a derived class, gets the length in bytes of the stream.
  39468. </summary>
  39469. <value></value>
  39470. <returns>
  39471. A long value representing the length of the stream in bytes.
  39472. </returns>
  39473. <exception cref="T:System.NotSupportedException">
  39474. A class derived from Stream does not support seeking.
  39475. </exception>
  39476. <exception cref="T:System.ObjectDisposedException">
  39477. Methods were called after the stream was closed.
  39478. </exception>
  39479. </member>
  39480. <member name="P:NPOI.Util.PushbackStream.Position">
  39481. <summary>
  39482. When overridden in a derived class, gets or sets the position within the current stream.
  39483. </summary>
  39484. <value></value>
  39485. <returns>
  39486. The current position within the stream.
  39487. </returns>
  39488. <exception cref="T:System.IO.IOException">
  39489. An I/O error occurs.
  39490. </exception>
  39491. <exception cref="T:System.NotSupportedException">
  39492. The stream does not support seeking.
  39493. </exception>
  39494. <exception cref="T:System.ObjectDisposedException">
  39495. Methods were called after the stream was closed.
  39496. </exception>
  39497. </member>
  39498. <member name="M:NPOI.Util.PushbackStream.Close">
  39499. <summary>
  39500. Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream.
  39501. </summary>
  39502. </member>
  39503. <member name="M:NPOI.Util.PushbackStream.Flush">
  39504. <summary>
  39505. When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.
  39506. </summary>
  39507. <exception cref="T:System.IO.IOException">
  39508. An I/O error occurs.
  39509. </exception>
  39510. </member>
  39511. <member name="M:NPOI.Util.PushbackStream.Seek(System.Int64,System.IO.SeekOrigin)">
  39512. <summary>
  39513. When overridden in a derived class, sets the position within the current stream.
  39514. </summary>
  39515. <param name="offset">A byte offset relative to the <paramref name="origin"/> parameter.</param>
  39516. <param name="origin">A value of type <see cref="T:System.IO.SeekOrigin"/> indicating the reference point used to obtain the new position.</param>
  39517. <returns>
  39518. The new position within the current stream.
  39519. </returns>
  39520. <exception cref="T:System.IO.IOException">
  39521. An I/O error occurs.
  39522. </exception>
  39523. <exception cref="T:System.NotSupportedException">
  39524. The stream does not support seeking, such as if the stream is constructed from a pipe or console output.
  39525. </exception>
  39526. <exception cref="T:System.ObjectDisposedException">
  39527. Methods were called after the stream was closed.
  39528. </exception>
  39529. </member>
  39530. <member name="M:NPOI.Util.PushbackStream.SetLength(System.Int64)">
  39531. <summary>
  39532. When overridden in a derived class, sets the length of the current stream.
  39533. </summary>
  39534. <param name="value">The desired length of the current stream in bytes.</param>
  39535. <exception cref="T:System.IO.IOException">
  39536. An I/O error occurs.
  39537. </exception>
  39538. <exception cref="T:System.NotSupportedException">
  39539. The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output.
  39540. </exception>
  39541. <exception cref="T:System.ObjectDisposedException">
  39542. Methods were called after the stream was closed.
  39543. </exception>
  39544. </member>
  39545. <member name="M:NPOI.Util.PushbackStream.Write(System.Byte[],System.Int32,System.Int32)">
  39546. <summary>
  39547. 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.
  39548. </summary>
  39549. <param name="buffer">An array of bytes. This method copies <paramref name="count"/> bytes from <paramref name="buffer"/> to the current stream.</param>
  39550. <param name="offset">The zero-based byte offset in <paramref name="buffer"/> at which to begin copying bytes to the current stream.</param>
  39551. <param name="count">The number of bytes to be written to the current stream.</param>
  39552. <exception cref="T:System.ArgumentException">
  39553. The sum of <paramref name="offset"/> and <paramref name="count"/> is greater than the buffer length.
  39554. </exception>
  39555. <exception cref="T:System.ArgumentNullException">
  39556. <paramref name="buffer"/> is null.
  39557. </exception>
  39558. <exception cref="T:System.ArgumentOutOfRangeException">
  39559. <paramref name="offset"/> or <paramref name="count"/> is negative.
  39560. </exception>
  39561. <exception cref="T:System.IO.IOException">
  39562. An I/O error occurs.
  39563. </exception>
  39564. <exception cref="T:System.NotSupportedException">
  39565. The stream does not support writing.
  39566. </exception>
  39567. <exception cref="T:System.ObjectDisposedException">
  39568. Methods were called after the stream was closed.
  39569. </exception>
  39570. </member>
  39571. <member name="M:NPOI.Util.PushbackStream.WriteByte(System.Byte)">
  39572. <summary>
  39573. Writes a byte to the current position in the stream and advances the position within the stream by one byte.
  39574. </summary>
  39575. <param name="value">The byte to write to the stream.</param>
  39576. <exception cref="T:System.IO.IOException">
  39577. An I/O error occurs.
  39578. </exception>
  39579. <exception cref="T:System.NotSupportedException">
  39580. The stream does not support writing, or the stream is already closed.
  39581. </exception>
  39582. <exception cref="T:System.ObjectDisposedException">
  39583. Methods were called after the stream was closed.
  39584. </exception>
  39585. </member>
  39586. <member name="T:NPOI.Util.RecordFormatException">
  39587. A common exception thrown by our binary format Parsers
  39588. (especially HSSF and DDF), when they hit invalid
  39589. format or data when Processing a record.
  39590. </member>
  39591. <member name="M:NPOI.Util.ShortField.#ctor(System.Int32)">
  39592. <summary>
  39593. construct the ShortField with its offset into its containing
  39594. byte array
  39595. </summary>
  39596. <param name="offset">offset of the field within its byte array</param>
  39597. <exception cref="T:System.IndexOutOfRangeException">if offset is negative</exception>
  39598. </member>
  39599. <member name="M:NPOI.Util.ShortField.#ctor(System.Int32,System.Int16)">
  39600. <summary>
  39601. construct the ShortField with its offset into its containing byte array and initialize its value
  39602. </summary>
  39603. <param name="offset">offset of the field within its byte array</param>
  39604. <param name="value">the initial value</param>
  39605. <exception cref="T:System.IndexOutOfRangeException">if offset is negative</exception>
  39606. </member>
  39607. <member name="M:NPOI.Util.ShortField.#ctor(System.Int32,System.Byte[])">
  39608. <summary>
  39609. Construct the ShortField with its offset into its containing
  39610. byte array and initialize its value from its byte array
  39611. </summary>
  39612. <param name="offset">offset of the field within its byte array</param>
  39613. <param name="data">the byte array to read the value from</param>
  39614. <exception cref="T:System.IndexOutOfRangeException">if the offset is not
  39615. within the range of 0..(data.length - 1)</exception>
  39616. </member>
  39617. <member name="M:NPOI.Util.ShortField.#ctor(System.Int32,System.Int16,System.Byte[]@)">
  39618. <summary>
  39619. construct the ShortField with its offset into its containing
  39620. byte array, initialize its value, and write its value to its
  39621. byte array
  39622. </summary>
  39623. <param name="offset">offset of the field within its byte array</param>
  39624. <param name="value">the initial value</param>
  39625. <param name="data">the byte array to write the value to</param>
  39626. <exception cref="T:System.IndexOutOfRangeException">if offset is negative</exception>
  39627. </member>
  39628. <member name="P:NPOI.Util.ShortField.Value">
  39629. <summary>
  39630. Gets or sets the value.
  39631. </summary>
  39632. <value>The value.</value>
  39633. </member>
  39634. <member name="M:NPOI.Util.ShortField.Set(System.Int16,System.Byte[]@)">
  39635. <summary>
  39636. set the ShortField's current value and write it to a byte array
  39637. </summary>
  39638. <param name="value">value to be set</param>
  39639. <param name="data">the byte array to write the value to</param>
  39640. <exception cref="T:System.IndexOutOfRangeException">if the offset is out
  39641. of range</exception>
  39642. </member>
  39643. <member name="M:NPOI.Util.ShortField.ReadFromBytes(System.Byte[])">
  39644. <summary>
  39645. set the value from its offset into an array of bytes
  39646. </summary>
  39647. <param name="data">the byte array from which the value is to be read</param>
  39648. <exception cref="T:System.IndexOutOfRangeException">if the offset is out
  39649. of range</exception>
  39650. </member>
  39651. <member name="M:NPOI.Util.ShortField.ReadFromStream(System.IO.Stream)">
  39652. <summary>
  39653. set the value from an Stream
  39654. </summary>
  39655. <param name="stream">the Stream from which the value is to be
  39656. read</param>
  39657. <exception cref="T:System.IO.IOException">if an IOException is thrown from reading
  39658. the Stream</exception>
  39659. <exception cref="T:NPOI.Util.BufferUnderrunException">if there is not enough data
  39660. available from the Stream</exception>
  39661. </member>
  39662. <member name="M:NPOI.Util.ShortField.WriteToBytes(System.Byte[])">
  39663. <summary>
  39664. write the value out to an array of bytes at the appropriate
  39665. offset
  39666. </summary>
  39667. <param name="data">the array of bytes to which the value is to be
  39668. written</param>
  39669. <exception cref="T:System.IndexOutOfRangeException">if the offset is out
  39670. of range</exception>
  39671. </member>
  39672. <member name="M:NPOI.Util.ShortField.Write(System.Int32,System.Int16,System.Byte[]@)">
  39673. <summary>
  39674. Same as using the constructor <see cref="T:NPOI.Util.ShortField"/> with the same
  39675. parameter list. Avoid creation of an useless object.
  39676. </summary>
  39677. <param name="offset">offset of the field within its byte array</param>
  39678. <param name="value">the initial value</param>
  39679. <param name="data">the byte array to write the value to</param>
  39680. </member>
  39681. <member name="M:NPOI.Util.ShortField.ToString">
  39682. <summary>
  39683. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  39684. </summary>
  39685. <returns>
  39686. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  39687. </returns>
  39688. </member>
  39689. <member name="T:NPOI.Util.StringUtil">
  39690. <summary>
  39691. Title: String Utility Description: Collection of string handling utilities
  39692. @author Andrew C. Oliver
  39693. @author Sergei Kozello (sergeikozello at mail.ru)
  39694. @author Toshiaki Kamoshida (kamoshida.toshiaki at future dot co dot jp)
  39695. @since May 10, 2002
  39696. @version 1.0
  39697. </summary>
  39698. </member>
  39699. <member name="M:NPOI.Util.StringUtil.#ctor">
  39700. Constructor for the StringUtil object
  39701. </member>
  39702. <member name="M:NPOI.Util.StringUtil.GetFromUnicodeLE(System.Byte[],System.Int32,System.Int32)">
  39703. <summary>
  39704. Given a byte array of 16-bit unicode characters in Little Endian
  39705. Format (most important byte last), return a Java String representation
  39706. of it.
  39707. { 0x16, 0x00 } -0x16
  39708. </summary>
  39709. <param name="str">the byte array to be converted</param>
  39710. <param name="offset">the initial offset into the
  39711. byte array. it is assumed that string[ offset ] and string[ offset + 1 ] contain the first 16-bit unicode character</param>
  39712. <param name="len">the Length of the string</param>
  39713. <returns>the converted string</returns>
  39714. </member>
  39715. <member name="M:NPOI.Util.StringUtil.GetFromUnicodeLE(System.Byte[])">
  39716. <summary>
  39717. Given a byte array of 16-bit unicode characters in little endian
  39718. Format (most important byte last), return a Java String representation
  39719. of it.
  39720. { 0x16, 0x00 } -0x16
  39721. </summary>
  39722. <param name="str">the byte array to be converted</param>
  39723. <returns>the converted string</returns>
  39724. </member>
  39725. <member name="M:NPOI.Util.StringUtil.GetToUnicodeLE(System.String)">
  39726. Convert String to 16-bit unicode characters in little endian format
  39727. @param string the string
  39728. @return the byte array of 16-bit unicode characters
  39729. </member>
  39730. <member name="M:NPOI.Util.StringUtil.GetFromUnicodeBE(System.Byte[],System.Int32,System.Int32)">
  39731. <summary>
  39732. Given a byte array of 16-bit unicode characters in big endian
  39733. Format (most important byte first), return a Java String representation
  39734. of it.
  39735. { 0x00, 0x16 } -0x16
  39736. </summary>
  39737. <param name="str">the byte array to be converted</param>
  39738. <param name="offset">the initial offset into the
  39739. byte array. it is assumed that string[ offset ] and string[ offset + 1 ] contain the first 16-bit unicode character</param>
  39740. <param name="len">the Length of the string</param>
  39741. <returns> the converted string</returns>
  39742. </member>
  39743. <member name="M:NPOI.Util.StringUtil.GetFromUnicodeBE(System.Byte[])">
  39744. <summary>
  39745. Given a byte array of 16-bit unicode characters in big endian
  39746. Format (most important byte first), return a Java String representation
  39747. of it.
  39748. { 0x00, 0x16 } -0x16
  39749. </summary>
  39750. <param name="str">the byte array to be converted</param>
  39751. <returns>the converted string</returns>
  39752. </member>
  39753. <member name="M:NPOI.Util.StringUtil.GetFromCompressedUnicode(System.Byte[],System.Int32,System.Int32)">
  39754. <summary>
  39755. Read 8 bit data (in IsO-8859-1 codepage) into a (unicode) Java
  39756. String and return.
  39757. (In Excel terms, read compressed 8 bit unicode as a string)
  39758. </summary>
  39759. <param name="str">byte array to read</param>
  39760. <param name="offset">offset to read byte array</param>
  39761. <param name="len">Length to read byte array</param>
  39762. <returns>generated String instance by reading byte array</returns>
  39763. </member>
  39764. <member name="M:NPOI.Util.StringUtil.PutCompressedUnicode(System.String,System.Byte[],System.Int32)">
  39765. <summary>
  39766. Takes a unicode (java) string, and returns it as 8 bit data (in IsO-8859-1
  39767. codepage).
  39768. (In Excel terms, write compressed 8 bit unicode)
  39769. </summary>
  39770. <param name="input">the String containing the data to be written</param>
  39771. <param name="output">the byte array to which the data Is to be written</param>
  39772. <param name="offset">an offset into the byte arrat at which the data Is start when written</param>
  39773. </member>
  39774. <member name="M:NPOI.Util.StringUtil.PutUnicodeLE(System.String,System.Byte[],System.Int32)">
  39775. <summary>
  39776. Takes a unicode string, and returns it as little endian (most
  39777. important byte last) bytes in the supplied byte array.
  39778. (In Excel terms, write uncompressed unicode)
  39779. </summary>
  39780. <param name="input">the String containing the unicode data to be written</param>
  39781. <param name="output">the byte array to hold the uncompressed unicode, should be twice the Length of the String</param>
  39782. <param name="offset">the offset to start writing into the byte array</param>
  39783. </member>
  39784. <member name="M:NPOI.Util.StringUtil.PutUnicodeBE(System.String,System.Byte[],System.Int32)">
  39785. <summary>
  39786. Takes a unicode string, and returns it as big endian (most
  39787. important byte first) bytes in the supplied byte array.
  39788. (In Excel terms, write uncompressed unicode)
  39789. </summary>
  39790. <param name="input">the String containing the unicode data to be written</param>
  39791. <param name="output">the byte array to hold the uncompressed unicode, should be twice the Length of the String.</param>
  39792. <param name="offset">the offset to start writing into the byte array</param>
  39793. </member>
  39794. <member name="M:NPOI.Util.StringUtil.GetPreferredEncoding">
  39795. <summary>
  39796. Gets the preferred encoding.
  39797. </summary>
  39798. <returns>the encoding we want to use, currently hardcoded to IsO-8859-1</returns>
  39799. </member>
  39800. <member name="M:NPOI.Util.StringUtil.HasMultibyte(System.String)">
  39801. <summary>
  39802. check the parameter Has multibyte character
  39803. </summary>
  39804. <param name="value"> string to check</param>
  39805. <returns>
  39806. <c>true</c> if Has at least one multibyte character; otherwise, <c>false</c>.
  39807. </returns>
  39808. </member>
  39809. <member name="M:NPOI.Util.StringUtil.ReadUnicodeString(NPOI.Util.ILittleEndianInput)">
  39810. InputStream <c>in</c> is expected to contain:
  39811. <ol>
  39812. <li>ushort nChars</li>
  39813. <li>byte is16BitFlag</li>
  39814. <li>byte[]/char[] characterData</li>
  39815. </ol>
  39816. For this encoding, the is16BitFlag is always present even if nChars==0.
  39817. </member>
  39818. <member name="M:NPOI.Util.StringUtil.ReadUnicodeString(NPOI.Util.ILittleEndianInput,System.Int32)">
  39819. InputStream <c>in</c> is expected to contain:
  39820. <ol>
  39821. <li>byte is16BitFlag</li>
  39822. <li>byte[]/char[] characterData</li>
  39823. </ol>
  39824. For this encoding, the is16BitFlag is always present even if nChars==0.
  39825. <br/>
  39826. This method should be used when the nChars field is <em>not</em> stored
  39827. as a ushort immediately before the is16BitFlag. Otherwise, {@link
  39828. #readUnicodeString(LittleEndianInput)} can be used.
  39829. </member>
  39830. <member name="M:NPOI.Util.StringUtil.WriteUnicodeString(NPOI.Util.ILittleEndianOutput,System.String)">
  39831. OutputStream <c>out</c> will get:
  39832. <ol>
  39833. <li>ushort nChars</li>
  39834. <li>byte is16BitFlag</li>
  39835. <li>byte[]/char[] characterData</li>
  39836. </ol>
  39837. For this encoding, the is16BitFlag is always present even if nChars==0.
  39838. </member>
  39839. <member name="M:NPOI.Util.StringUtil.WriteUnicodeStringFlagAndData(NPOI.Util.ILittleEndianOutput,System.String)">
  39840. OutputStream <c>out</c> will get:
  39841. <ol>
  39842. <li>byte is16BitFlag</li>
  39843. <li>byte[]/char[] characterData</li>
  39844. </ol>
  39845. For this encoding, the is16BitFlag is always present even if nChars==0.
  39846. <br/>
  39847. This method should be used when the nChars field is <em>not</em> stored
  39848. as a ushort immediately before the is16BitFlag. Otherwise, {@link
  39849. #writeUnicodeString(LittleEndianOutput, String)} can be used.
  39850. </member>
  39851. <member name="M:NPOI.Util.StringUtil.GetEncodedSize(System.String)">
  39852. <summary>
  39853. Gets the number of bytes that would be written by WriteUnicodeString(LittleEndianOutput, String)
  39854. </summary>
  39855. <param name="value">The value.</param>
  39856. <returns></returns>
  39857. </member>
  39858. <member name="M:NPOI.Util.StringUtil.IsUnicodeString(System.String)">
  39859. <summary>
  39860. Checks to see if a given String needs to be represented as Unicode
  39861. </summary>
  39862. <param name="value">The value.</param>
  39863. <returns>
  39864. <c>true</c> if string needs Unicode to be represented.; otherwise, <c>false</c>.
  39865. </returns>
  39866. <remarks>Tony Qu change the logic</remarks>
  39867. </member>
  39868. <member name="M:NPOI.Util.StringUtil.ToHexString(System.String)">
  39869. <summary>
  39870. Encodes non-US-ASCII characters in a string, good for encoding file names for download
  39871. http://www.acriticsreview.com/List.aspx?listid=42
  39872. </summary>
  39873. <param name="s"></param>
  39874. <returns></returns>
  39875. </member>
  39876. <member name="M:NPOI.Util.StringUtil.ToHexString(System.Char)">
  39877. <summary>
  39878. Encodes a non-US-ASCII character.
  39879. </summary>
  39880. <param name="chr"></param>
  39881. <returns></returns>
  39882. </member>
  39883. <member name="M:NPOI.Util.StringUtil.ToHexString(System.Int16)">
  39884. <summary>
  39885. Encodes a non-US-ASCII character.
  39886. </summary>
  39887. <param name="chr"></param>
  39888. <returns></returns>
  39889. </member>
  39890. <member name="M:NPOI.Util.StringUtil.ToHexString(System.Int32)">
  39891. <summary>
  39892. Encodes a non-US-ASCII character.
  39893. </summary>
  39894. <param name="chr"></param>
  39895. <returns></returns>
  39896. </member>
  39897. <member name="M:NPOI.Util.StringUtil.ToHexString(System.Int64)">
  39898. <summary>
  39899. Encodes a non-US-ASCII character.
  39900. </summary>
  39901. <param name="chr"></param>
  39902. <returns></returns>
  39903. </member>
  39904. <member name="M:NPOI.Util.StringUtil.NeedToEncode(System.Char)">
  39905. <summary>
  39906. Determines if the character needs to be encoded.
  39907. http://www.acriticsreview.com/List.aspx?listid=42
  39908. </summary>
  39909. <param name="chr"></param>
  39910. <returns></returns>
  39911. </member>
  39912. <member name="M:NPOI.Util.StringUtil.MapMsCodepointString(System.String)">
  39913. Some strings may contain encoded characters of the unicode private use area.
  39914. Currently the characters of the symbol fonts are mapped to the corresponding
  39915. characters in the normal unicode range.
  39916. @param string the original string
  39917. @return the string with mapped characters
  39918. @see <a href="http://www.alanwood.net/unicode/private_use_area.html#symbol">Private Use Area (symbol)</a>
  39919. @see <a href="http://www.alanwood.net/demos/symbol.html">Symbol font - Unicode alternatives for Greek and special characters in HTML</a>
  39920. </member>
  39921. <member name="F:NPOI.Util.StringUtil.MIN_HIGH_SURROGATE">
  39922. The minimum value of a
  39923. <a href="http://www.unicode.org/glossary/#high_surrogate_code_unit">
  39924. Unicode high-surrogate code unit</a>
  39925. in the UTF-16 encoding, constant {@code '\u005CuD800'}.
  39926. A high-surrogate is also known as a <i>leading-surrogate</i>.
  39927. @since 1.5
  39928. </member>
  39929. <member name="F:NPOI.Util.StringUtil.MAX_HIGH_SURROGATE">
  39930. The maximum value of a
  39931. <a href="http://www.unicode.org/glossary/#high_surrogate_code_unit">
  39932. Unicode high-surrogate code unit</a>
  39933. in the UTF-16 encoding, constant {@code '\u005CuDBFF'}.
  39934. A high-surrogate is also known as a <i>leading-surrogate</i>.
  39935. @since 1.5
  39936. </member>
  39937. <member name="F:NPOI.Util.StringUtil.MIN_LOW_SURROGATE">
  39938. The minimum value of a
  39939. <a href="http://www.unicode.org/glossary/#low_surrogate_code_unit">
  39940. Unicode low-surrogate code unit</a>
  39941. in the UTF-16 encoding, constant {@code '\u005CuDC00'}.
  39942. A low-surrogate is also known as a <i>trailing-surrogate</i>.
  39943. @since 1.5
  39944. </member>
  39945. <member name="F:NPOI.Util.StringUtil.MAX_LOW_SURROGATE">
  39946. The maximum value of a
  39947. <a href="http://www.unicode.org/glossary/#low_surrogate_code_unit">
  39948. Unicode low-surrogate code unit</a>
  39949. in the UTF-16 encoding, constant {@code '\u005CuDFFF'}.
  39950. A low-surrogate is also known as a <i>trailing-surrogate</i>.
  39951. @since 1.5
  39952. </member>
  39953. <member name="M:NPOI.Util.StringUtil.toCodePoint(System.Char,System.Char)">
  39954. Converts the specified surrogate pair to its supplementary code
  39955. point value. This method does not validate the specified
  39956. surrogate pair. The caller must validate it using {@link
  39957. #isSurrogatePair(char, char) isSurrogatePair} if necessary.
  39958. @param high the high-surrogate code unit
  39959. @param low the low-surrogate code unit
  39960. @return the supplementary code point composed from the
  39961. specified surrogate pair.
  39962. @since 1.5
  39963. </member>
  39964. <member name="M:NPOI.Util.StringUtil.CharCount(System.Int32)">
  39965. Determines the number of {@code char} values needed to
  39966. represent the specified character (Unicode code point). If the
  39967. specified character is equal to or greater than 0x10000, then
  39968. the method returns 2. Otherwise, the method returns 1.
  39969. This method doesn't validate the specified character to be a
  39970. valid Unicode code point. The caller must validate the
  39971. character value using {@link #isValidCodePoint(int) isValidCodePoint}
  39972. if necessary.
  39973. @param codePoint the character (Unicode code point) to be tested.
  39974. @return 2 if the character is a valid supplementary character; 1 otherwise.
  39975. @see Character#isSupplementaryCodePoint(int)
  39976. @since 1.5
  39977. </member>
  39978. <member name="M:NPOI.Util.TempFile.CreateTempFile(System.String,System.String)">
  39979. Creates a temporary file. Files are collected into one directory and by default are
  39980. deleted on exit from the VM. Files can be kept by defining the system property
  39981. <c>poi.keep.tmp.files</c>.
  39982. Dont forget to close all files or it might not be possible to delete them.
  39983. </member>
  39984. <member name="T:NPOI.Util.Units">
  39985. @author Yegor Kozlov
  39986. </member>
  39987. <member name="F:NPOI.Util.Units.EMU_PER_PIXEL">
  39988. In Escher absolute distances are specified in
  39989. English Metric Units (EMUs), occasionally referred to as A units;
  39990. there are 360000 EMUs per centimeter, 914400 EMUs per inch, 12700 EMUs per point.
  39991. </member>
  39992. <member name="F:NPOI.Util.Units.MASTER_DPI">
  39993. Master DPI (576 pixels per inch).
  39994. Used by the reference coordinate system in PowerPoint (HSLF)
  39995. </member>
  39996. <member name="F:NPOI.Util.Units.PIXEL_DPI">
  39997. Pixels DPI (96 pixels per inch)
  39998. </member>
  39999. <member name="F:NPOI.Util.Units.POINT_DPI">
  40000. Points DPI (72 pixels per inch)
  40001. </member>
  40002. <member name="M:NPOI.Util.Units.ToEMU(System.Double)">
  40003. <summary>
  40004. Converts points to EMUs
  40005. </summary>
  40006. <param name="value"></param>
  40007. <returns>EMUs</returns>
  40008. </member>
  40009. <member name="M:NPOI.Util.Units.PixelToEMU(System.Int32)">
  40010. Converts pixels to EMUs
  40011. @param pixels pixels
  40012. @return EMUs
  40013. </member>
  40014. <member name="M:NPOI.Util.Units.FixedPointToDecimal(System.Int32)">
  40015. Converts a value of type FixedPoint to a decimal number
  40016. @param fixedPoint
  40017. @return decimal number
  40018. @see <a href="http://msdn.microsoft.com/en-us/library/dd910765(v=office.12).aspx">[MS-OSHARED] - 2.2.1.6 FixedPoint</a>
  40019. </member>
  40020. <member name="M:NPOI.Util.Units.DoubleToFixedPoint(System.Double)">
  40021. Converts a value of type floating point to a FixedPoint
  40022. @param floatPoint
  40023. @return fixedPoint
  40024. @see <a href="http://msdn.microsoft.com/en-us/library/dd910765(v=office.12).aspx">[MS-OSHARED] - 2.2.1.6 FixedPoint</a>
  40025. </member>
  40026. <member name="T:NPOI.Util.PackageHelper">
  40027. Provides handy methods to work with OOXML namespaces
  40028. @author Yegor Kozlov
  40029. </member>
  40030. <member name="M:NPOI.Util.PackageHelper.Clone(NPOI.OpenXml4Net.OPC.OPCPackage,System.String)">
  40031. Clone the specified namespace.
  40032. @param pkg the namespace to clone
  40033. @param file the destination file
  40034. @return the Cloned namespace
  40035. </member>
  40036. <member name="M:NPOI.Util.PackageHelper.CreateTempFile">
  40037. Creates an empty file in the default temporary-file directory,
  40038. </member>
  40039. <member name="M:NPOI.Util.PackageHelper.Copy(NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePart)">
  40040. Recursively copy namespace parts to the destination namespace
  40041. </member>
  40042. <member name="M:NPOI.Util.PackageHelper.CopyProperties(NPOI.OpenXml4Net.OPC.PackageProperties,NPOI.OpenXml4Net.OPC.PackageProperties)">
  40043. Copy core namespace properties
  40044. @param src source properties
  40045. @param tgt target properties
  40046. </member>
  40047. <member name="F:NPOI.Util.XMLConstants.NULL_NS_URI">
  40048. <p>Namespace URI to use to represent that there is no Namespace.</p>
  40049. <p>Defined by the Namespace specification to be "".</p>
  40050. @see <a href="http://www.w3.org/TR/REC-xml-names/#defaulting">
  40051. Namespaces in XML, 5.2 Namespace Defaulting</a>
  40052. </member>
  40053. <member name="F:NPOI.Util.XMLConstants.DEFAULT_NS_PREFIX">
  40054. <p>Prefix to use to represent the default XML Namespace.</p>
  40055. <p>Defined by the XML specification to be "".</p>
  40056. @see <a
  40057. href="http://www.w3.org/TR/REC-xml-names/#ns-qualnames">
  40058. Namespaces in XML, 3. Qualified Names</a>
  40059. </member>
  40060. <member name="F:NPOI.Util.XMLConstants.XML_NS_URI">
  40061. <p>The official XML Namespace name URI.</p>
  40062. <p>Defined by the XML specification to be
  40063. "{@code http://www.w3.org/XML/1998/namespace}".</p>
  40064. @see <a
  40065. href="http://www.w3.org/TR/REC-xml-names/#ns-qualnames">
  40066. Namespaces in XML, 3. Qualified Names</a>
  40067. </member>
  40068. <member name="F:NPOI.Util.XMLConstants.XML_NS_PREFIX">
  40069. <p>The official XML Namespace prefix.</p>
  40070. <p>Defined by the XML specification to be "{@code xml}".</p>
  40071. @see <a
  40072. href="http://www.w3.org/TR/REC-xml-names/#ns-qualnames">
  40073. Namespaces in XML, 3. Qualified Names</a>
  40074. </member>
  40075. <member name="F:NPOI.Util.XMLConstants.XMLNS_ATTRIBUTE_NS_URI">
  40076. <p>The official XML attribute used for specifying XML Namespace
  40077. declarations, {@link #XMLNS_ATTRIBUTE
  40078. XMLConstants.XMLNS_ATTRIBUTE}, Namespace name URI.</p>
  40079. <p>Defined by the XML specification to be
  40080. "{@code http://www.w3.org/2000/xmlns/}".</p>
  40081. @see <a
  40082. href="http://www.w3.org/TR/REC-xml-names/#ns-qualnames">
  40083. Namespaces in XML, 3. Qualified Names</a>
  40084. @see <a
  40085. href="http://www.w3.org/XML/xml-names-19990114-errata">
  40086. Namespaces in XML Errata</a>
  40087. </member>
  40088. <member name="F:NPOI.Util.XMLConstants.XMLNS_ATTRIBUTE">
  40089. <p>The official XML attribute used for specifying XML Namespace
  40090. declarations.</p>
  40091. <p>It is <strong><em>NOT</em></strong> valid to use as a
  40092. prefix. Defined by the XML specification to be
  40093. "{@code xmlns}".</p>
  40094. @see <a
  40095. href="http://www.w3.org/TR/REC-xml-names/#ns-qualnames">
  40096. Namespaces in XML, 3. Qualified Names</a>
  40097. </member>
  40098. <member name="F:NPOI.Util.XMLConstants.W3C_XML_SCHEMA_NS_URI">
  40099. * <p>W3C XML Schema Namespace URI.</p>
  40100. <p>Defined to be "{@code http://www.w3.org/2001/XMLSchema}".</p>
  40101. @see <a href=
  40102. "http://www.w3.org/TR/xmlschema-1/#Instance_Document_Constructions">
  40103. XML Schema Part 1:
  40104. Structures, 2.6 Schema-Related Markup in Documents Being Validated</a>
  40105. </member>
  40106. <member name="F:NPOI.Util.XMLConstants.W3C_XML_SCHEMA_INSTANCE_NS_URI">
  40107. <p>W3C XML Schema Instance Namespace URI.</p>
  40108. <p>Defined to be "{@code http://www.w3.org/2001/XMLSchema-instance}".</p>
  40109. @see <a href=
  40110. "http://www.w3.org/TR/xmlschema-1/#Instance_Document_Constructions">
  40111. XML Schema Part 1:
  40112. Structures, 2.6 Schema-Related Markup in Documents Being Validated</a>
  40113. </member>
  40114. <member name="F:NPOI.Util.XMLConstants.W3C_XPATH_DATATYPE_NS_URI">
  40115. <p>W3C XPath Datatype Namespace URI.</p>
  40116. <p>Defined to be "{@code http://www.w3.org/2003/11/xpath-datatypes}".</p>
  40117. @see <a href="http://www.w3.org/TR/xpath-datamodel">XQuery 1.0 and XPath 2.0 Data Model</a>
  40118. </member>
  40119. <member name="F:NPOI.Util.XMLConstants.XML_DTD_NS_URI">
  40120. <p>XML Document Type Declaration Namespace URI as an arbitrary value.</p>
  40121. <p>Since not formally defined by any existing standard, arbitrarily define to be "{@code http://www.w3.org/TR/REC-xml}".</p>
  40122. </member>
  40123. <member name="F:NPOI.Util.XMLConstants.RELAXNG_NS_URI">
  40124. <p>RELAX NG Namespace URI.</p>
  40125. <p>Defined to be "{@code http://relaxng.org/ns/structure/1.0}".</p>
  40126. @see <a href="http://relaxng.org/spec-20011203.html">RELAX NG Specification</a>
  40127. </member>
  40128. <member name="F:NPOI.POIXMLDocument.pkg">
  40129. The OPC Package
  40130. </member>
  40131. <member name="F:NPOI.POIXMLDocument.properties">
  40132. The properties of the OPC namespace, opened as needed
  40133. </member>
  40134. <member name="M:NPOI.POIXMLDocument.OpenPackage(System.String)">
  40135. Wrapper to open a namespace, returning an IOException
  40136. in the event of a problem.
  40137. Works around shortcomings in java's this() constructor calls
  40138. </member>
  40139. <member name="M:NPOI.POIXMLDocument.GetRelatedByType(System.String)">
  40140. Retrieves all the PackageParts which are defined as
  40141. relationships of the base document with the
  40142. specified content type.
  40143. </member>
  40144. <member name="M:NPOI.POIXMLDocument.HasOOXMLHeader(System.IO.Stream)">
  40145. Checks that the supplied Stream (which MUST
  40146. support mark and reSet, or be a PushbackStream)
  40147. has a OOXML (zip) header at the start of it.
  40148. If your Stream does not support mark / reSet,
  40149. then wrap it in a PushBackStream, then be
  40150. sure to always use that, and not the original!
  40151. @param inp An Stream which supports either mark/reSet, or is a PushbackStream
  40152. </member>
  40153. <member name="M:NPOI.POIXMLDocument.GetProperties">
  40154. Get the document properties. This gives you access to the
  40155. core ooxml properties, and the extended ooxml properties.
  40156. </member>
  40157. <member name="M:NPOI.POIXMLDocument.GetAllEmbedds">
  40158. Get the document's embedded files.
  40159. </member>
  40160. <member name="M:NPOI.POIXMLDocument.Close">
  40161. Closes the underlying {@link OPCPackage} from which this
  40162. document was read, if there is one
  40163. </member>
  40164. <member name="M:NPOI.POIXMLDocument.Write(System.IO.Stream)">
  40165. Write out this document to an Outputstream.
  40166. Note - if the Document was opened from a {@link File} rather
  40167. than an {@link InputStream}, you <b>must</b> write out to
  40168. a different file, overwriting via an OutputStream isn't possible.
  40169. If {@code stream} is a {@link java.io.FileOutputStream} on a networked drive
  40170. or has a high cost/latency associated with each written byte,
  40171. consider wrapping the OutputStream in a {@link java.io.BufferedOutputStream}
  40172. to improve write performance.
  40173. @param stream - the java Stream you wish to write the file to
  40174. @exception IOException if anything can't be written.
  40175. </member>
  40176. <member name="T:NPOI.POIXMLDocumentPart">
  40177. Represents an entry of a OOXML namespace.
  40178. <p>
  40179. Each POIXMLDocumentPart keeps a reference to the underlying a {@link org.apache.poi.openxml4j.opc.PackagePart}.
  40180. </p>
  40181. @author Yegor Kozlov
  40182. </member>
  40183. <member name="F:NPOI.POIXMLDocumentPart.relationCounter">
  40184. Counter that provides the amount of incoming relations from other parts
  40185. to this part.
  40186. </member>
  40187. <member name="M:NPOI.POIXMLDocumentPart.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage)">
  40188. Construct POIXMLDocumentPart representing a "core document" namespace part.
  40189. </member>
  40190. <member name="M:NPOI.POIXMLDocumentPart.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage,System.String)">
  40191. Construct POIXMLDocumentPart representing a custom "core document" package part.
  40192. </member>
  40193. <member name="M:NPOI.POIXMLDocumentPart.#ctor">
  40194. Creates new POIXMLDocumentPart - called by client code to create new parts from scratch.
  40195. @see #CreateRelationship(POIXMLRelation, POIXMLFactory, int, bool)
  40196. </member>
  40197. <member name="M:NPOI.POIXMLDocumentPart.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  40198. Creates an POIXMLDocumentPart representing the given package part and relationship.
  40199. Called by {@link #read(POIXMLFactory, java.util.Map)} when reading in an existing file.
  40200. @param part - The package part that holds xml data representing this sheet.
  40201. @see #read(POIXMLFactory, java.util.Map)
  40202. @since POI 3.14-Beta1
  40203. </member>
  40204. <member name="M:NPOI.POIXMLDocumentPart.#ctor(NPOI.POIXMLDocumentPart,NPOI.OpenXml4Net.OPC.PackagePart)">
  40205. Creates an POIXMLDocumentPart representing the given package part, relationship and parent
  40206. Called by {@link #read(POIXMLFactory, java.util.Map)} when reading in an existing file.
  40207. @param parent - Parent part
  40208. @param part - The package part that holds xml data representing this sheet.
  40209. @see #read(POIXMLFactory, java.util.Map)
  40210. @since POI 3.14-Beta1
  40211. </member>
  40212. <member name="M:NPOI.POIXMLDocumentPart.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  40213. Creates an POIXMLDocumentPart representing the given namespace part and relationship.
  40214. Called by {@link #read(POIXMLFactory, java.util.Map)} when Reading in an exisiting file.
  40215. @param part - The namespace part that holds xml data represenring this sheet.
  40216. @param rel - the relationship of the given namespace part
  40217. @see #read(POIXMLFactory, java.util.Map)
  40218. </member>
  40219. <member name="M:NPOI.POIXMLDocumentPart.#ctor(NPOI.POIXMLDocumentPart,NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  40220. Creates an POIXMLDocumentPart representing the given namespace part, relationship and parent
  40221. Called by {@link #read(POIXMLFactory, java.util.Map)} when Reading in an exisiting file.
  40222. @param parent - Parent part
  40223. @param part - The namespace part that holds xml data represenring this sheet.
  40224. @param rel - the relationship of the given namespace part
  40225. @see #read(POIXMLFactory, java.util.Map)
  40226. </member>
  40227. <member name="M:NPOI.POIXMLDocumentPart.Rebase(NPOI.OpenXml4Net.OPC.OPCPackage)">
  40228. When you open something like a theme, call this to
  40229. re-base the XML Document onto the core child of the
  40230. current core document
  40231. </member>
  40232. <member name="M:NPOI.POIXMLDocumentPart.GetPackagePart">
  40233. Provides access to the underlying PackagePart
  40234. @return the underlying PackagePart
  40235. </member>
  40236. <member name="M:NPOI.POIXMLDocumentPart.GetPackageRelationship">
  40237. Provides access to the PackageRelationship that identifies this POIXMLDocumentPart
  40238. @return the PackageRelationship that identifies this POIXMLDocumentPart
  40239. </member>
  40240. <member name="M:NPOI.POIXMLDocumentPart.GetRelations">
  40241. Returns the list of child relations for this POIXMLDocumentPart
  40242. @return child relations
  40243. </member>
  40244. <member name="P:NPOI.POIXMLDocumentPart.RelationParts">
  40245. Returns the list of child relations for this POIXMLDocumentPart
  40246. @return child relations
  40247. </member>
  40248. <member name="M:NPOI.POIXMLDocumentPart.GetRelationById(System.String)">
  40249. Returns the target {@link POIXMLDocumentPart}, where a
  40250. {@link PackageRelationship} is set from the {@link PackagePart} of this
  40251. {@link POIXMLDocumentPart} to the {@link PackagePart} of the target
  40252. {@link POIXMLDocumentPart} with a {@link PackageRelationship#GetId()}
  40253. matching the given parameter value.
  40254. @param id
  40255. The relation id to look for
  40256. @return the target part of the relation, or null, if none exists
  40257. </member>
  40258. <member name="M:NPOI.POIXMLDocumentPart.GetRelationId(NPOI.POIXMLDocumentPart)">
  40259. Returns the {@link PackageRelationship#GetId()} of the
  40260. {@link PackageRelationship}, that sources from the {@link PackagePart} of
  40261. this {@link POIXMLDocumentPart} to the {@link PackagePart} of the given
  40262. parameter value.
  40263. @param part
  40264. The {@link POIXMLDocumentPart} for which the according
  40265. relation-id shall be found.
  40266. @return The value of the {@link PackageRelationship#GetId()} or null, if
  40267. parts are not related.
  40268. </member>
  40269. <member name="M:NPOI.POIXMLDocumentPart.AddRelation(System.String,NPOI.POIXMLDocumentPart)">
  40270. Add a new child POIXMLDocumentPart
  40271. @param part the child to add
  40272. @deprecated in POI 3.14, scheduled for removal in POI 3.16
  40273. </member>
  40274. <member name="M:NPOI.POIXMLDocumentPart.AddRelation(System.String,NPOI.POIXMLRelation,NPOI.POIXMLDocumentPart)">
  40275. Add a new child POIXMLDocumentPart
  40276. @param relId the preferred relation id, when null the next free relation id will be used
  40277. @param relationshipType the package relationship type
  40278. @param part the child to add
  40279. @since 3.14-Beta1
  40280. </member>
  40281. <member name="M:NPOI.POIXMLDocumentPart.AddRelation(NPOI.OpenXml4Net.OPC.PackageRelationship,NPOI.POIXMLDocumentPart)">
  40282. Add a new child POIXMLDocumentPart
  40283. @param pr the relationship of the child
  40284. @param part the child to add
  40285. </member>
  40286. <member name="M:NPOI.POIXMLDocumentPart.FindExistingRelation(NPOI.POIXMLDocumentPart)">
  40287. <summary>
  40288. Check if the new part was already added before via PackagePart.addRelationship()
  40289. </summary>
  40290. <param name="part"> to find the relationship for</param>
  40291. <returns>The existing relationship, or null if there isn't yet one</returns>
  40292. </member>
  40293. <member name="M:NPOI.POIXMLDocumentPart.RemoveRelation(NPOI.POIXMLDocumentPart)">
  40294. Remove the relation to the specified part in this namespace and remove the
  40295. part, if it is no longer needed.
  40296. </member>
  40297. <member name="M:NPOI.POIXMLDocumentPart.RemoveRelation(NPOI.POIXMLDocumentPart,System.Boolean)">
  40298. Remove the relation to the specified part in this namespace and remove the
  40299. part, if it is no longer needed and flag is set to true.
  40300. @param part
  40301. The related part, to which the relation shall be Removed.
  40302. @param RemoveUnusedParts
  40303. true, if the part shall be Removed from the namespace if not
  40304. needed any longer.
  40305. </member>
  40306. <member name="M:NPOI.POIXMLDocumentPart.GetParent">
  40307. Returns the parent POIXMLDocumentPart. All parts except root have not-null parent.
  40308. @return the parent POIXMLDocumentPart or <code>null</code> for the root element.
  40309. </member>
  40310. <member name="M:NPOI.POIXMLDocumentPart.Commit">
  40311. Save the content in the underlying namespace part.
  40312. Default implementation is empty meaning that the namespace part is left unmodified.
  40313. Sub-classes should override and add logic to marshal the "model" into Ooxml4J.
  40314. For example, the code saving a generic XML entry may look as follows:
  40315. <pre><code>
  40316. protected void commit() {
  40317. PackagePart part = GetPackagePart();
  40318. Stream out = part.GetStream();
  40319. XmlObject bean = GetXmlBean(); //the "model" which holds Changes in memory
  40320. bean.save(out, DEFAULT_XML_OPTIONS);
  40321. out.close();
  40322. }
  40323. </code></pre>
  40324. </member>
  40325. <member name="M:NPOI.POIXMLDocumentPart.OnSave(System.Collections.Generic.List{NPOI.OpenXml4Net.OPC.PackagePart})">
  40326. Save Changes in the underlying OOXML namespace.
  40327. Recursively fires {@link #commit()} for each namespace part
  40328. @param alreadySaved context set Containing already visited nodes
  40329. </member>
  40330. <member name="M:NPOI.POIXMLDocumentPart.PrepareForCommit">
  40331. Ensure that a memory based package part does not have lingering data from previous
  40332. commit() calls.
  40333. Note: This is overwritten for some objects, as *PictureData seem to store the actual content
  40334. in the part directly without keeping a copy like all others therefore we need to handle them differently.
  40335. </member>
  40336. <member name="M:NPOI.POIXMLDocumentPart.CreateRelationship(NPOI.POIXMLRelation,NPOI.POIXMLFactory)">
  40337. Create a new child POIXMLDocumentPart
  40338. @param descriptor the part descriptor
  40339. @param factory the factory that will create an instance of the requested relation
  40340. @return the Created child POIXMLDocumentPart
  40341. </member>
  40342. <member name="M:NPOI.POIXMLDocumentPart.CreateRelationship(NPOI.POIXMLRelation,NPOI.POIXMLFactory,System.Int32,System.Boolean)">
  40343. Create a new child POIXMLDocumentPart
  40344. @param descriptor the part descriptor
  40345. @param factory the factory that will create an instance of the requested relation
  40346. @param idx part number
  40347. @param noRelation if true, then no relationship is Added.
  40348. @return the Created child POIXMLDocumentPart
  40349. </member>
  40350. <member name="M:NPOI.POIXMLDocumentPart.Read(NPOI.POIXMLFactory,System.Collections.Generic.Dictionary{NPOI.OpenXml4Net.OPC.PackagePart,NPOI.POIXMLDocumentPart})">
  40351. Iterate through the underlying PackagePart and create child POIXMLFactory instances
  40352. using the specified factory
  40353. @param factory the factory object that Creates POIXMLFactory instances
  40354. @param context context map Containing already visited noted keyed by tarGetURI
  40355. </member>
  40356. <member name="M:NPOI.POIXMLDocumentPart.GetTargetPart(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  40357. Get the PackagePart that is the target of a relationship.
  40358. @param rel The relationship
  40359. @return The target part
  40360. @throws InvalidFormatException
  40361. </member>
  40362. <member name="M:NPOI.POIXMLDocumentPart.OnDocumentCreate">
  40363. Fired when a new namespace part is Created
  40364. </member>
  40365. <member name="M:NPOI.POIXMLDocumentPart.OnDocumentRead">
  40366. Fired when a namespace part is read
  40367. </member>
  40368. <member name="M:NPOI.POIXMLDocumentPart.onDocumentRemove">
  40369. Fired when a namespace part is about to be Removed from the namespace
  40370. </member>
  40371. <member name="M:NPOI.POIXMLDocumentPart.GetPartFromOPCPackage(NPOI.OpenXml4Net.OPC.OPCPackage,System.String)">
  40372. Retrieves the core document part
  40373. @since POI 3.14-Beta1
  40374. </member>
  40375. <member name="T:NPOI.RelationPart">
  40376. The RelationPart is a cached relationship between the document, which contains the RelationPart,
  40377. and one of its referenced child document parts.
  40378. The child document parts may only belong to one parent, but it's often referenced by other
  40379. parents too, having varying {@link PackageRelationship#getId() relationship ids} pointing to it.
  40380. </member>
  40381. <member name="P:NPOI.RelationPart.Relationship">
  40382. @return the cached relationship, which uniquely identifies this child document part within the parent
  40383. </member>
  40384. <member name="M:NPOI.RelationPart.GetDocumentPart``1">
  40385. @return the child document part
  40386. </member>
  40387. <member name="T:NPOI.POIXMLFactory">
  40388. Defines a factory API that enables sub-classes to create instances of <code>POIXMLDocumentPart</code>
  40389. @author Yegor Kozlov
  40390. </member>
  40391. <member name="M:NPOI.POIXMLFactory.CreateDocumentPart(NPOI.POIXMLDocumentPart,NPOI.OpenXml4Net.OPC.PackagePart)">
  40392. Create a POIXMLDocumentPart from existing package part and relation. This method is called
  40393. from {@link POIXMLDocument#load(POIXMLFactory)} when parsing a document
  40394. @param parent parent part
  40395. @param rel the package part relationship
  40396. @param part the PackagePart representing the created instance
  40397. @return A new instance of a POIXMLDocumentPart.
  40398. @since by POI 3.14-Beta1
  40399. </member>
  40400. <member name="M:NPOI.POIXMLFactory.CreateDocumentPart(System.Type,System.Type[],System.Object[])">
  40401. Need to delegate instantiation to sub class because of constructor visibility
  40402. @since POI 3.14-Beta1
  40403. </member>
  40404. <member name="M:NPOI.POIXMLFactory.GetDescriptor(System.String)">
  40405. returns the descriptor for the given relationship type
  40406. @return the descriptor or null if type is unknown
  40407. @since POI 3.14-Beta1
  40408. </member>
  40409. <member name="M:NPOI.POIXMLFactory.CreateDocumentPart(NPOI.POIXMLDocumentPart,NPOI.OpenXml4Net.OPC.PackageRelationship,NPOI.OpenXml4Net.OPC.PackagePart)">
  40410. Create a POIXMLDocumentPart from existing package part and relation. This method is called
  40411. from {@link POIXMLDocument#load(POIXMLFactory)} when parsing a document
  40412. @param parent parent part
  40413. @param rel the package part relationship
  40414. @param part the PackagePart representing the created instance
  40415. @return A new instance of a POIXMLDocumentPart.
  40416. @deprecated in POI 3.14, scheduled for removal in POI 3.16
  40417. </member>
  40418. <member name="M:NPOI.POIXMLFactory.NewDocumentPart(NPOI.POIXMLRelation)">
  40419. Create a new POIXMLDocumentPart using the supplied descriptor. This method is used when adding new parts
  40420. to a document, for example, when adding a sheet to a workbook, slide to a presentation, etc.
  40421. @param descriptor describes the object to create
  40422. @return A new instance of a POIXMLDocumentPart.
  40423. </member>
  40424. <member name="M:NPOI.POIXMLFactory.GetPackageRelationship(NPOI.POIXMLDocumentPart,NPOI.OpenXml4Net.OPC.PackagePart)">
  40425. Retrieves the package relationship of the child part within the parent
  40426. @since POI 3.14-Beta1
  40427. </member>
  40428. <member name="T:NPOI.CoreProperties">
  40429. The core document properties
  40430. </member>
  40431. <member name="T:NPOI.POIXMLProperties">
  40432. Wrapper around the three different kinds of OOXML properties
  40433. and metadata a document can have (Core, Extended and Custom),
  40434. as well Thumbnails.
  40435. </member>
  40436. <member name="P:NPOI.POIXMLProperties.CoreProperties">
  40437. Returns the core document properties
  40438. </member>
  40439. <member name="P:NPOI.POIXMLProperties.ThumbnailPart">
  40440. Returns the {@link PackagePart} for the Document
  40441. Thumbnail, or <code>null</code> if there isn't one
  40442. @return The Document Thumbnail part or null
  40443. </member>
  40444. <member name="P:NPOI.POIXMLProperties.ThumbnailFilename">
  40445. Returns the name of the Document thumbnail, eg
  40446. <code>thumbnail.jpeg</code>, or <code>null</code> if there
  40447. isn't one.
  40448. @return The thumbnail filename, or null
  40449. </member>
  40450. <member name="P:NPOI.POIXMLProperties.ThumbnailImage">
  40451. Returns the Document thumbnail image data, or
  40452. <code>null</code> if there isn't one.
  40453. @return The thumbnail data, or null
  40454. </member>
  40455. <member name="M:NPOI.POIXMLProperties.SetThumbnail(System.String,System.IO.Stream)">
  40456. Sets the Thumbnail for the document, replacing any existing
  40457. one.
  40458. @param name The filename for the thumbnail image, eg <code>thumbnail.jpg</code>
  40459. @param imageData The inputstream to read the thumbnail image from
  40460. </member>
  40461. <member name="M:NPOI.POIXMLProperties.Commit">
  40462. Commit Changes to the underlying OPC namespace
  40463. </member>
  40464. <member name="T:NPOI.POIXMLRelation">
  40465. Represents a descriptor of a OOXML relation.
  40466. @author Yegor Kozlov
  40467. </member>
  40468. <member name="F:NPOI.POIXMLRelation._type">
  40469. Describes the content stored in a part.
  40470. </member>
  40471. <member name="F:NPOI.POIXMLRelation._relation">
  40472. The kind of connection between a source part and a target part in a namespace.
  40473. </member>
  40474. <member name="F:NPOI.POIXMLRelation._defaultName">
  40475. The path component of a pack URI.
  40476. </member>
  40477. <member name="F:NPOI.POIXMLRelation._cls">
  40478. Defines what object is used to construct instances of this relationship
  40479. </member>
  40480. <member name="M:NPOI.POIXMLRelation.#ctor(System.String,System.String,System.String,System.Type)">
  40481. Instantiates a POIXMLRelation.
  40482. @param type content type
  40483. @param rel relationship
  40484. @param defaultName default item name
  40485. @param cls defines what object is used to construct instances of this relationship
  40486. </member>
  40487. <member name="M:NPOI.POIXMLRelation.#ctor(System.String,System.String,System.String)">
  40488. Instantiates a POIXMLRelation.
  40489. @param type content type
  40490. @param rel relationship
  40491. @param defaultName default item name
  40492. </member>
  40493. <member name="P:NPOI.POIXMLRelation.ContentType">
  40494. Return the content type. Content types define a media type, a subtype, and an
  40495. optional set of parameters, as defined in RFC 2616.
  40496. @return the content type
  40497. </member>
  40498. <member name="P:NPOI.POIXMLRelation.Relation">
  40499. Return the relationship, the kind of connection between a source part and a target part in a namespace.
  40500. Relationships make the connections between parts directly discoverable without looking at the content
  40501. in the parts, and without altering the parts themselves.
  40502. @return the relationship
  40503. </member>
  40504. <member name="P:NPOI.POIXMLRelation.DefaultFileName">
  40505. Return the default part name. Part names are used to refer to a part in the context of a
  40506. namespace, typically as part of a URI.
  40507. @return the default part name
  40508. </member>
  40509. <member name="M:NPOI.POIXMLRelation.GetFileName(System.Int32)">
  40510. Returns the filename for the nth one of these,
  40511. e.g. /xl/comments4.xml
  40512. </member>
  40513. <member name="M:NPOI.POIXMLRelation.GetFileNameIndex(NPOI.POIXMLDocumentPart)">
  40514. Returns the index of the filename within the package for the given part.
  40515. e.g. 4 for /xl/comments4.xml
  40516. </member>
  40517. <member name="P:NPOI.POIXMLRelation.RelationClass">
  40518. Return type of the obejct used to construct instances of this relationship
  40519. @return the class of the object used to construct instances of this relation
  40520. </member>
  40521. <member name="T:NPOI.XSSF.Model.CalculationChain">
  40522. The cells in a workbook can be calculated in different orders depending on various optimizations and
  40523. dependencies. The calculation chain object specifies the order in which the cells in a workbook were last calculated.
  40524. @author Yegor Kozlov
  40525. </member>
  40526. <member name="M:NPOI.XSSF.Model.CalculationChain.RemoveItem(System.Int32,System.String)">
  40527. Remove a formula reference from the calculation chain
  40528. @param sheetId the sheet Id of a sheet the formula belongs to.
  40529. @param ref A1 style reference to the cell Containing the formula.
  40530. </member>
  40531. <member name="F:NPOI.XSSF.Model.CommentsTable.commentRefs">
  40532. XML Beans uses a list, which is very slow
  40533. to search, so we wrap things with our own
  40534. map for fast Lookup.
  40535. </member>
  40536. <member name="M:NPOI.XSSF.Model.CommentsTable.ReferenceUpdated(System.String,NPOI.OpenXmlFormats.Spreadsheet.CT_Comment)">
  40537. Called after the reference is updated, so that
  40538. we can reflect that in our cache
  40539. </member>
  40540. <member name="M:NPOI.XSSF.Model.CommentsTable.ReferenceUpdated(NPOI.SS.Util.CellAddress,NPOI.OpenXmlFormats.Spreadsheet.CT_Comment)">
  40541. Called after the reference is updated, so that
  40542. we can reflect that in our cache
  40543. @param oldReference the comment to remove from the commentRefs map
  40544. @param comment the comment to replace in the commentRefs map
  40545. </member>
  40546. <member name="M:NPOI.XSSF.Model.CommentsTable.FindAuthor(System.String)">
  40547. <summary>
  40548. Searches the author. If not found he is added to the list of authors.
  40549. </summary>
  40550. <param name="author">author to search</param>
  40551. <returns>index of the author</returns>
  40552. </member>
  40553. <member name="M:NPOI.XSSF.Model.CommentsTable.FindCellComment(System.String)">
  40554. Finds the cell comment at cellAddress, if one exists
  40555. @param cellAddress the address of the cell to find a comment
  40556. @return cell comment if one exists, otherwise returns null
  40557. @
  40558. </member>
  40559. <member name="M:NPOI.XSSF.Model.CommentsTable.FindCellComment(NPOI.SS.Util.CellAddress)">
  40560. Finds the cell comment at cellAddress, if one exists
  40561. @param cellAddress the address of the cell to find a comment
  40562. @return cell comment if one exists, otherwise returns null
  40563. </member>
  40564. <member name="M:NPOI.XSSF.Model.CommentsTable.GetCTComment(System.String)">
  40565. Get the underlying CTComment xmlbean for a comment located at cellRef, if it exists
  40566. @param cellRef the location of the cell comment
  40567. @return CTComment xmlbean if comment exists, otherwise return null.
  40568. @
  40569. </member>
  40570. <member name="M:NPOI.XSSF.Model.CommentsTable.GetCTComment(NPOI.SS.Util.CellAddress)">
  40571. Get the underlying CTComment xmlbean for a comment located at cellRef, if it exists
  40572. @param cellRef the location of the cell comment
  40573. @return CTComment xmlbean if comment exists, otherwise return null.
  40574. </member>
  40575. <member name="M:NPOI.XSSF.Model.CommentsTable.GetCellComments">
  40576. Returns all cell comments on this sheet.
  40577. @return A map of each Comment in this sheet, keyed on the cell address where
  40578. the comment is located.
  40579. </member>
  40580. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.Model.CommentsTable.PrepareCTCommentCache" -->
  40581. <member name="M:NPOI.XSSF.Model.CommentsTable.NewComment(System.String)">
  40582. Create a new comment located at cell address
  40583. @param ref the location to add the comment
  40584. @return a new CTComment located at ref with default author
  40585. </member>
  40586. <member name="M:NPOI.XSSF.Model.CommentsTable.NewComment(NPOI.SS.Util.CellAddress)">
  40587. Create a new comment located` at cell address
  40588. @param ref the location to add the comment
  40589. @return a new CTComment located at ref with default author
  40590. </member>
  40591. <member name="M:NPOI.XSSF.Model.CommentsTable.RemoveComment(System.String)">
  40592. Remove the comment at cellRef location, if one exists
  40593. @param cellRef the location of the comment to remove
  40594. @return returns true if a comment was removed
  40595. @deprecated 2015-11-23 (circa POI 3.14beta1). Use {@link #removeComment(CellAddress)} instead
  40596. </member>
  40597. <member name="M:NPOI.XSSF.Model.CommentsTable.RemoveComment(NPOI.SS.Util.CellAddress)">
  40598. Remove the comment at cellRef location, if one exists
  40599. @param cellRef the location of the comment to remove
  40600. @return returns true if a comment was removed
  40601. </member>
  40602. <member name="M:NPOI.XSSF.Model.CommentsTable.AddNewAuthor(System.String)">
  40603. Add a new author to the CommentsTable.
  40604. This does not check if the author already exists.
  40605. @param author the name of the comment author
  40606. @return the index of the new author
  40607. </member>
  40608. <member name="M:NPOI.XSSF.Model.CommentsTable.GetCTComments">
  40609. Returns the underlying CTComments list xmlbean
  40610. @return underlying comments list xmlbean
  40611. </member>
  40612. <member name="T:NPOI.XSSF.Model.ExternalLinksTable">
  40613. Holds details of links to parts of other workbooks (eg named ranges),
  40614. along with the most recently seen values for what they point to.
  40615. </member>
  40616. <member name="P:NPOI.XSSF.Model.ExternalLinksTable.CTExternalLink">
  40617. Returns the underlying xmlbeans object for the external
  40618. link table
  40619. </member>
  40620. <member name="P:NPOI.XSSF.Model.ExternalLinksTable.LinkedFileName">
  40621. get or set the last recorded name of the file that this
  40622. is linked to
  40623. </member>
  40624. <member name="T:NPOI.XSSF.Model.MapInfo">
  40625. This class : the Custom XML Mapping Part (Open Office XML Part 1:
  40626. chapter 12.3.6)
  40627. An instance of this part type Contains a schema for an XML file, and
  40628. information on the behavior that is used when allowing this custom XML schema
  40629. to be mapped into the spreadsheet.
  40630. @author Roberto Manicardi
  40631. </member>
  40632. <member name="P:NPOI.XSSF.Model.MapInfo.Workbook">
  40633. Returns the parent XSSFWorkbook
  40634. @return the parent XSSFWorkbook
  40635. </member>
  40636. <member name="M:NPOI.XSSF.Model.MapInfo.GetCTMapInfo">
  40637. @return the internal data object
  40638. </member>
  40639. <member name="M:NPOI.XSSF.Model.MapInfo.GetCTSchemaById(System.String)">
  40640. Gets the
  40641. @param schemaId the schema ID
  40642. @return CTSchema by it's ID
  40643. </member>
  40644. <member name="M:NPOI.XSSF.Model.MapInfo.GetAllXSSFMaps">
  40645. @return all the mappings configured in this document
  40646. </member>
  40647. <member name="T:NPOI.XSSF.Model.ParagraphPropertyFetcher">
  40648. Used internally to navigate the paragraph text style hierarchy within a shape and fetch properties
  40649. </member>
  40650. <member name="M:NPOI.XSSF.Model.ParagraphPropertyFetcher`1.Fetch(NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Shape)">
  40651. @param shape the shape being examined
  40652. @return true if the desired property was fetched
  40653. </member>
  40654. <member name="T:NPOI.XSSF.Model.SharedStringsTable">
  40655. Table of strings shared across all sheets in a workbook.
  40656. <p>
  40657. A workbook may contain thousands of cells Containing string (non-numeric) data. Furthermore this data is very
  40658. likely to be repeated across many rows or columns. The goal of implementing a single string table that is shared
  40659. across the workbook is to improve performance in opening and saving the file by only Reading and writing the
  40660. repetitive information once.
  40661. </p>
  40662. <p>
  40663. Consider for example a workbook summarizing information for cities within various countries. There may be a
  40664. column for the name of the country, a column for the name of each city in that country, and a column
  40665. Containing the data for each city. In this case the country name is repetitive, being duplicated in many cells.
  40666. In many cases the repetition is extensive, and a tremendous savings is realized by making use of a shared string
  40667. table when saving the workbook. When displaying text in the spreadsheet, the cell table will just contain an
  40668. index into the string table as the value of a cell, instead of the full string.
  40669. </p>
  40670. <p>
  40671. The shared string table Contains all the necessary information for displaying the string: the text, formatting
  40672. properties, and phonetic properties (for East Asian languages).
  40673. </p>
  40674. @author Nick Birch
  40675. @author Yegor Kozlov
  40676. </member>
  40677. <member name="F:NPOI.XSSF.Model.SharedStringsTable.strings">
  40678. Array of individual string items in the Shared String table.
  40679. </member>
  40680. <member name="F:NPOI.XSSF.Model.SharedStringsTable.stmap">
  40681. Maps strings and their indexes in the <code>strings</code> arrays
  40682. </member>
  40683. <member name="F:NPOI.XSSF.Model.SharedStringsTable.count">
  40684. An integer representing the total count of strings in the workbook. This count does not
  40685. include any numbers, it counts only the total of text strings in the workbook.
  40686. </member>
  40687. <member name="F:NPOI.XSSF.Model.SharedStringsTable.uniqueCount">
  40688. An integer representing the total count of unique strings in the Shared String Table.
  40689. A string is unique even if it is a copy of another string, but has different formatting applied
  40690. at the character level.
  40691. </member>
  40692. <member name="M:NPOI.XSSF.Model.SharedStringsTable.GetEntryAt(System.Int32)">
  40693. Return a string item by index
  40694. @param idx index of item to return.
  40695. @return the item at the specified position in this Shared String table.
  40696. </member>
  40697. <member name="P:NPOI.XSSF.Model.SharedStringsTable.Count">
  40698. Return an integer representing the total count of strings in the workbook. This count does not
  40699. include any numbers, it counts only the total of text strings in the workbook.
  40700. @return the total count of strings in the workbook
  40701. </member>
  40702. <member name="P:NPOI.XSSF.Model.SharedStringsTable.UniqueCount">
  40703. Returns an integer representing the total count of unique strings in the Shared String Table.
  40704. A string is unique even if it is a copy of another string, but has different formatting applied
  40705. at the character level.
  40706. @return the total count of unique strings in the workbook
  40707. </member>
  40708. <member name="M:NPOI.XSSF.Model.SharedStringsTable.AddEntry(NPOI.OpenXmlFormats.Spreadsheet.CT_Rst)">
  40709. Add an entry to this Shared String table (a new value is appened to the end).
  40710. <p>
  40711. If the Shared String table already Contains this <code>CT_Rst</code> bean, its index is returned.
  40712. Otherwise a new entry is aded.
  40713. </p>
  40714. @param st the entry to add
  40715. @return index the index of Added entry
  40716. </member>
  40717. <member name="P:NPOI.XSSF.Model.SharedStringsTable.Items">
  40718. Provide low-level access to the underlying array of CT_Rst beans
  40719. @return array of CT_Rst beans
  40720. </member>
  40721. <member name="M:NPOI.XSSF.Model.SharedStringsTable.WriteTo(System.IO.Stream)">
  40722. this table out as XML.
  40723. @param out The stream to write to.
  40724. @throws IOException if an error occurs while writing.
  40725. </member>
  40726. <member name="T:NPOI.XSSF.Model.SingleXmlCells">
  40727. This class : the Single Cell Tables Part (Open Office XML Part 4:
  40728. chapter 3.5.2)
  40729. @author Roberto Manicardi
  40730. </member>
  40731. <member name="M:NPOI.XSSF.Model.SingleXmlCells.GetAllSimpleXmlCell">
  40732. @return all the SimpleXmlCell Contained in this SingleXmlCells element
  40733. </member>
  40734. <member name="T:NPOI.XSSF.Model.StylesTable">
  40735. Table of styles shared across all sheets in a workbook.
  40736. @author ugo
  40737. </member>
  40738. <member name="F:NPOI.XSSF.Model.StylesTable.FIRST_CUSTOM_STYLE_ID">
  40739. The first style id available for use as a custom style
  40740. </member>
  40741. <member name="F:NPOI.XSSF.Model.StylesTable.MAXIMUM_NUMBER_OF_DATA_FORMATS">
  40742. Depending on the version of Excel, the maximum number of number formats in a workbook is between 200 and 250
  40743. See https://support.office.com/en-us/article/excel-specifications-and-limits-1672b34d-7043-467e-8e27-269d656771c3
  40744. POI defaults this limit to 250, but can be increased or decreased on a per-StylesTable basis with
  40745. {@link #setMaxNumberOfDataFormats(int)} if needed.
  40746. </member>
  40747. <member name="P:NPOI.XSSF.Model.StylesTable.MaxNumberOfDataFormats">
  40748. Get the upper limit on the number of data formats that has been set for the style table.
  40749. To get the current number of data formats in use, use {@link #getNumDataFormats()}.
  40750. @return the maximum number of data formats allowed in the workbook
  40751. </member>
  40752. <member name="M:NPOI.XSSF.Model.StylesTable.#ctor">
  40753. Create a new, empty StylesTable
  40754. </member>
  40755. <member name="M:NPOI.XSSF.Model.StylesTable.EnsureThemesTable">
  40756. If there isn't currently a {@link ThemesTable} for the
  40757. current Workbook, then creates one and sets it up.
  40758. After this, calls to {@link #getTheme()} won't give null
  40759. </member>
  40760. <member name="M:NPOI.XSSF.Model.StylesTable.ReadFrom(System.Xml.XmlDocument)">
  40761. Read this shared styles table from an XML file.
  40762. @param is The input stream Containing the XML document.
  40763. @throws IOException if an error occurs while Reading.
  40764. </member>
  40765. <member name="M:NPOI.XSSF.Model.StylesTable.GetNumberFormatAt(System.Int32)">
  40766. Get number format string given its id
  40767. @param idx number format id
  40768. @return number format code
  40769. </member>
  40770. <member name="M:NPOI.XSSF.Model.StylesTable.GetNumberFormatAt(System.Int16)">
  40771. Get number format string given its id
  40772. @param fmtId number format id
  40773. @return number format code
  40774. </member>
  40775. <member name="M:NPOI.XSSF.Model.StylesTable.PutNumberFormat(System.String)">
  40776. Puts <code>fmt</code> in the numberFormats map if the format is not
  40777. already in the the number format style table.
  40778. Does nothing if <code>fmt</code> is already in number format style table.
  40779. @param fmt the number format to add to number format style table
  40780. @return the index of <code>fmt</code> in the number format style table
  40781. </member>
  40782. <member name="M:NPOI.XSSF.Model.StylesTable.PutNumberFormat(System.Int16,System.String)">
  40783. Add a number format with a specific ID into the numberFormats map.
  40784. If a format with the same ID already exists, overwrite the format code
  40785. with <code>fmt</code>
  40786. This may be used to override built-in number formats.
  40787. @param index the number format ID
  40788. @param fmt the number format code
  40789. </member>
  40790. <member name="M:NPOI.XSSF.Model.StylesTable.RemoveNumberFormat(System.Int16)">
  40791. Remove a number format from the style table if it exists.
  40792. All cell styles with this number format will be modified to use the default number format.
  40793. @param fmt the number format to remove
  40794. @return true if the number format was removed
  40795. </member>
  40796. <member name="M:NPOI.XSSF.Model.StylesTable.RemoveNumberFormat(System.String)">
  40797. Remove a number format from the style table if it exists
  40798. All cell styles with this number format will be modified to use the default number format
  40799. @param fmt the number format to remove
  40800. @return true if the number format was removed
  40801. </member>
  40802. <member name="M:NPOI.XSSF.Model.StylesTable.PutFont(NPOI.XSSF.UserModel.XSSFFont,System.Boolean)">
  40803. Records the given font in the font table.
  40804. Will re-use an existing font index if this
  40805. font matches another, EXCEPT if forced
  40806. registration is requested.
  40807. This allows people to create several fonts
  40808. then customise them later.
  40809. Note - End Users probably want to call
  40810. {@link XSSFFont#registerTo(StylesTable)}
  40811. </member>
  40812. <member name="M:NPOI.XSSF.Model.StylesTable.PutBorder(NPOI.XSSF.UserModel.Extensions.XSSFCellBorder)">
  40813. <summary>
  40814. Adds a border to the border style table if it isn't already in the style table
  40815. Does nothing if border is already in borders style table
  40816. </summary>
  40817. <param name="border">border to add</param>
  40818. <returns>return the index of the added border</returns>
  40819. </member>
  40820. <member name="M:NPOI.XSSF.Model.StylesTable.PutFill(NPOI.XSSF.UserModel.Extensions.XSSFCellFill)">
  40821. <summary>
  40822. Adds a fill to the fill style table if it isn't already in the style table
  40823. Does nothing if fill is already in fill style table
  40824. </summary>
  40825. <param name="fill">fill to add</param>
  40826. <returns>return the index of the added fill</returns>
  40827. </member>
  40828. <member name="M:NPOI.XSSF.Model.StylesTable.PutCellXf(NPOI.OpenXmlFormats.Spreadsheet.CT_Xf)">
  40829. <summary>
  40830. Adds a cell to the styles table. Does not check for duplicates
  40831. </summary>
  40832. <param name="cellXf">the cell to add to the styles table</param>
  40833. <returns>return the added cell ID in the style table</returns>
  40834. </member>
  40835. <member name="M:NPOI.XSSF.Model.StylesTable.PutCellStyleXf(NPOI.OpenXmlFormats.Spreadsheet.CT_Xf)">
  40836. <summary>
  40837. Adds a cell style to the styles table.Does not check for duplicates.
  40838. </summary>
  40839. <param name="cellStyleXf">the cell style to add to the styles table</param>
  40840. <returns>return the cell style ID in the style table</returns>
  40841. </member>
  40842. <member name="P:NPOI.XSSF.Model.StylesTable.NumCellStyles">
  40843. get the size of cell styles
  40844. </member>
  40845. <member name="P:NPOI.XSSF.Model.StylesTable.NumDataFormats">
  40846. @return number of data formats in the styles table
  40847. </member>
  40848. <member name="P:NPOI.XSSF.Model.StylesTable.NumberFormatSize">
  40849. For unit testing only
  40850. </member>
  40851. <member name="P:NPOI.XSSF.Model.StylesTable.XfsSize">
  40852. For unit testing only
  40853. </member>
  40854. <member name="P:NPOI.XSSF.Model.StylesTable.StyleXfsSize">
  40855. For unit testing only
  40856. </member>
  40857. <member name="M:NPOI.XSSF.Model.StylesTable.GetCTStylesheet">
  40858. For unit testing only!
  40859. </member>
  40860. <member name="M:NPOI.XSSF.Model.StylesTable.WriteTo(System.IO.Stream)">
  40861. Write this table out as XML.
  40862. @param out The stream to write to.
  40863. @throws IOException if an error occurs while writing.
  40864. </member>
  40865. <member name="M:NPOI.XSSF.Model.StylesTable.PutDxf(NPOI.OpenXmlFormats.Spreadsheet.CT_Dxf)">
  40866. <summary>
  40867. Adds a Dxf to the style table Does not check for duplicates.
  40868. </summary>
  40869. <param name="dxf">the Dxf to add</param>
  40870. <returns>added dxf ID in the style table</returns>
  40871. </member>
  40872. <member name="M:NPOI.XSSF.Model.StylesTable.CreateCellStyle">
  40873. Create a cell style in this style table.
  40874. Note - End users probably want to call {@link XSSFWorkbook#createCellStyle()}
  40875. rather than working with the styles table directly.
  40876. </member>
  40877. <member name="M:NPOI.XSSF.Model.StylesTable.FindFont(System.Int16,System.Int16,System.Int16,System.String,System.Boolean,System.Boolean,NPOI.SS.UserModel.FontSuperScript,NPOI.SS.UserModel.FontUnderlineType)">
  40878. Finds a font that matches the one with the supplied attributes
  40879. </member>
  40880. <member name="M:NPOI.XSSF.Model.StylesTable.FindFont(System.Boolean,System.Int16,System.Int16,System.String,System.Boolean,System.Boolean,NPOI.SS.UserModel.FontSuperScript,NPOI.SS.UserModel.FontUnderlineType)">
  40881. Finds a font that matches the one with the supplied attributes
  40882. </member>
  40883. <member name="M:NPOI.XSSF.Model.StylesTable.FindFont(System.Boolean,NPOI.SS.UserModel.IColor,System.Int16,System.String,System.Boolean,System.Boolean,NPOI.SS.UserModel.FontSuperScript,NPOI.SS.UserModel.FontUnderlineType)">
  40884. Finds a font that matches the one with the supplied attributes
  40885. </member>
  40886. <member name="T:NPOI.XSSF.Model.ThemesTable">
  40887. Class that represents theme of XLSX document. The theme includes specific
  40888. colors and fonts.
  40889. </member>
  40890. <member name="M:NPOI.XSSF.Model.ThemesTable.#ctor">
  40891. Create a new, empty ThemesTable
  40892. </member>
  40893. <member name="M:NPOI.XSSF.Model.ThemesTable.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  40894. Construct a ThemesTable.
  40895. @param part A PackagePart.
  40896. @param rel A PackageRelationship.
  40897. </member>
  40898. <member name="M:NPOI.XSSF.Model.ThemesTable.#ctor(NPOI.OpenXmlFormats.Spreadsheet.ThemeDocument)">
  40899. Construct a ThemesTable from an existing ThemeDocument.
  40900. @param theme A ThemeDocument.
  40901. </member>
  40902. <member name="M:NPOI.XSSF.Model.ThemesTable.GetThemeColor(System.Int32)">
  40903. Convert a theme "index" into a color.
  40904. @param idx A theme "index"
  40905. @return The mapped XSSFColor, or null if not mapped.
  40906. </member>
  40907. <member name="M:NPOI.XSSF.Model.ThemesTable.InheritFromThemeAsRequired(NPOI.XSSF.UserModel.XSSFColor)">
  40908. If the colour is based on a theme, then inherit
  40909. information (currently just colours) from it as
  40910. required.
  40911. </member>
  40912. <member name="M:NPOI.XSSF.Model.ThemesTable.writeTo(System.IO.Stream)">
  40913. Write this table out as XML.
  40914. @param out The stream to write to.
  40915. @throws IOException if an error occurs while writing.
  40916. </member>
  40917. <member name="T:NPOI.XSSF.UserModel.BaseXSSFEvaluationWorkbook">
  40918. Internal POI use only - parent of XSSF and SXSSF Evaluation workbooks
  40919. </member>
  40920. <member name="M:NPOI.XSSF.UserModel.BaseXSSFEvaluationWorkbook.ConvertFromExternSheetIndex(System.Int32)">
  40921. XSSF doesn't use external sheet indexes, so when asked treat
  40922. it just as a local index
  40923. </member>
  40924. <member name="M:NPOI.XSSF.UserModel.BaseXSSFEvaluationWorkbook.ConvertToExternalSheetIndex(System.Int32)">
  40925. @return the external sheet index of the sheet with the given internal
  40926. index. Used by some of the more obscure formula and named range things.
  40927. Fairly easy on XSSF (we think...) since the internal and external
  40928. indices are the same
  40929. </member>
  40930. <member name="M:NPOI.XSSF.UserModel.BaseXSSFEvaluationWorkbook.GetName(System.String,System.Int32)">
  40931. <summary>
  40932. Return EvaluationName wrapper around the matching XSSFName (named range)
  40933. </summary>
  40934. <param name="name">case-aware but case-insensitive named range in workbook</param>
  40935. <param name="sheetIndex">index of sheet if named range scope is limited to one sheet
  40936. if named range scope is global to the workbook, sheetIndex is -1.</param>
  40937. <returns>If name is a named range in the workbook, returns
  40938. EvaluationName corresponding to that named range
  40939. Returns null if there is no named range with the same name and scope in the workbook
  40940. </returns>
  40941. </member>
  40942. <member name="M:NPOI.XSSF.UserModel.BaseXSSFEvaluationWorkbook.GetNameXPtg(System.String,NPOI.SS.Formula.SheetIdentifier)">
  40943. <summary>
  40944. Return an external name (named range, function, user-defined function) Pxg
  40945. </summary>
  40946. <param name="name"></param>
  40947. <param name="sheet"></param>
  40948. <returns></returns>
  40949. </member>
  40950. <member name="M:NPOI.XSSF.UserModel.BaseXSSFEvaluationWorkbook.GetTable(System.String)">
  40951. Returns the data table with the given name (case insensitive).
  40952. Tables are cached for performance (formula evaluation looks them up by name repeatedly).
  40953. After the first table lookup, adding or removing a table from the document structure will cause trouble.
  40954. This is meant to be used on documents whose structure is essentially static at the point formulas are evaluated.
  40955. @param name the data table name (case-insensitive)
  40956. @return The Data table in the workbook named <tt>name</tt>, or <tt>null</tt> if no table is named <tt>name</tt>.
  40957. @since 3.15 beta 2
  40958. </member>
  40959. <member name="T:NPOI.XSSF.UserModel.BaseXSSFFormulaEvaluator">
  40960. Internal POI use only - parent of XSSF and SXSSF formula Evaluators
  40961. </member>
  40962. <member name="M:NPOI.XSSF.UserModel.BaseXSSFFormulaEvaluator.ToEvaluationCell(NPOI.SS.UserModel.ICell)">
  40963. Turns a XSSFCell / SXSSFCell into a XSSFEvaluationCell
  40964. </member>
  40965. <member name="M:NPOI.XSSF.UserModel.BaseXSSFFormulaEvaluator.EvaluateFormulaCellValue(NPOI.SS.UserModel.ICell)">
  40966. Returns a CellValue wrapper around the supplied ValueEval instance.
  40967. </member>
  40968. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFBarChartData`2">
  40969. <summary>
  40970. Holds data for a XSSF Line Chart
  40971. </summary>
  40972. <typeparam name="Tx"></typeparam>
  40973. <typeparam name="Ty"></typeparam>
  40974. </member>
  40975. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFBarChartData`2.series">
  40976. List of all data series.
  40977. </member>
  40978. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFChartAxis">
  40979. Base class for all axis types.
  40980. @author Roman Kashitsyn
  40981. </member>
  40982. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFChartDataFactory">
  40983. @author Roman Kashitsyn
  40984. </member>
  40985. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartDataFactory.CreateScatterChartData``2">
  40986. @return new scatter chart data instance
  40987. </member>
  40988. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartDataFactory.GetInstance">
  40989. @return factory instance
  40990. </member>
  40991. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFChartLegend">
  40992. Represents a SpreadsheetML chart legend
  40993. @author Roman Kashitsyn
  40994. </member>
  40995. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFChartLegend.legend">
  40996. Underlaying CTLagend bean
  40997. </member>
  40998. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartLegend.#ctor(NPOI.XSSF.UserModel.XSSFChart)">
  40999. Create a new SpreadsheetML chart legend
  41000. </member>
  41001. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartLegend.SetDefaults">
  41002. Set sensible default styling.
  41003. </member>
  41004. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartLegend.GetCTLegend">
  41005. Return the underlying CTLegend bean.
  41006. @return the underlying CTLegend bean
  41007. </member>
  41008. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFChartUtil">
  41009. Package private class with utility methods.
  41010. @author Roman Kashitsyn
  41011. </member>
  41012. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartUtil.BuildAxDataSource``1(NPOI.OpenXmlFormats.Dml.Chart.CT_AxDataSource,NPOI.SS.UserModel.Charts.IChartDataSource{``0})">
  41013. Builds CTAxDataSource object content from POI ChartDataSource.
  41014. @param ctAxDataSource OOXML data source to build
  41015. @param dataSource POI data source to use
  41016. </member>
  41017. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartUtil.BuildNumDataSource``1(NPOI.OpenXmlFormats.Dml.Chart.CT_NumDataSource,NPOI.SS.UserModel.Charts.IChartDataSource{``0})">
  41018. Builds CTNumDataSource object content from POI ChartDataSource
  41019. @param ctNumDataSource OOXML data source to build
  41020. @param dataSource POI data source to use
  41021. </member>
  41022. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFLineChartData`2">
  41023. <summary>
  41024. Holds data for a XSSF Line Chart
  41025. </summary>
  41026. <typeparam name="Tx"></typeparam>
  41027. <typeparam name="Ty"></typeparam>
  41028. </member>
  41029. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFLineChartData`2.series">
  41030. List of all data series.
  41031. </member>
  41032. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFManualLayout">
  41033. Represents a SpreadsheetML manual layout.
  41034. @author Roman Kashitsyn
  41035. </member>
  41036. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFManualLayout.layout">
  41037. Underlaying CTManualLayout bean.
  41038. </member>
  41039. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFManualLayout.#ctor(NPOI.OpenXmlFormats.Dml.Chart.CT_Layout)">
  41040. Create a new SpreadsheetML manual layout.
  41041. @param layout a Spreadsheet ML layout that should be used as base.
  41042. </member>
  41043. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFManualLayout.#ctor(NPOI.XSSF.UserModel.XSSFChart)">
  41044. Create a new SpreadsheetML manual layout for chart.
  41045. @param chart a chart to create layout for.
  41046. </member>
  41047. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFManualLayout.GetCTManualLayout">
  41048. Return the underlying CTManualLayout bean.
  41049. @return the underlying CTManualLayout bean.
  41050. </member>
  41051. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2">
  41052. Represents DrawingML scatter chart.
  41053. @author Roman Kashitsyn
  41054. </member>
  41055. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.series">
  41056. List of all data series.
  41057. </member>
  41058. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.Series">
  41059. Package private ScatterChartSerie implementation.
  41060. </member>
  41061. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.Series.GetXValues">
  41062. Returns data source used for X axis values.
  41063. @return data source used for X axis values
  41064. </member>
  41065. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.Series.GetYValues">
  41066. Returns data source used for Y axis values.
  41067. @return data source used for Y axis values
  41068. </member>
  41069. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.Series.SetUseCache(System.Boolean)">
  41070. @param useCache if true, cached results will be Added on plot
  41071. </member>
  41072. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFValueAxis">
  41073. Value axis type.
  41074. @author Roman Kashitsyn
  41075. </member>
  41076. <member name="T:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment">
  41077. Cell Settings avaiable in the Format/Alignment tab
  41078. </member>
  41079. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_CellAlignment)">
  41080. Creates a Cell Alignment from the supplied XML defInition
  41081. @param cellAlignment
  41082. </member>
  41083. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.Vertical">
  41084. Get the type of vertical alignment for the cell
  41085. @return the type of aligment
  41086. @see VerticalAlignment
  41087. </member>
  41088. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.Horizontal">
  41089. Get the type of horizontal alignment for the cell
  41090. @return the type of aligment
  41091. @see HorizontalAlignment
  41092. </member>
  41093. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.Indent">
  41094. Get the number of spaces to indent the text in the cell
  41095. @return indent - number of spaces
  41096. </member>
  41097. <!-- Badly formed XML comment ignored for member "P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.TextRotation" -->
  41098. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.WrapText">
  41099. Whether the text should be wrapped
  41100. @return a bool value indicating if the text in a cell should be line-wrapped within the cell.
  41101. </member>
  41102. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.GetCTCellAlignment">
  41103. Access to low-level data
  41104. </member>
  41105. <member name="T:NPOI.XSSF.UserModel.Extensions.BorderSide">
  41106. The enumeration value indicating the side being used for a cell border.
  41107. </member>
  41108. <member name="T:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder">
  41109. This element Contains border formatting information, specifying border defInition formats (left, right, top, bottom, diagonal)
  41110. for cells in the workbook.
  41111. Color is optional.
  41112. </member>
  41113. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Border,NPOI.XSSF.Model.ThemesTable)">
  41114. Creates a Cell Border from the supplied XML defInition
  41115. </member>
  41116. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Border)">
  41117. Creates a Cell Border from the supplied XML defInition
  41118. </member>
  41119. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.#ctor">
  41120. Creates a new, empty Cell Border.
  41121. You need to attach this to the Styles Table
  41122. </member>
  41123. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.SetThemesTable(NPOI.XSSF.Model.ThemesTable)">
  41124. Records the Themes Table that is associated with
  41125. the current font, used when looking up theme
  41126. based colours and properties.
  41127. </member>
  41128. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.GetCTBorder">
  41129. Returns the underlying XML bean.
  41130. @return CT_Border
  41131. </member>
  41132. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.GetBorderStyle(NPOI.XSSF.UserModel.Extensions.BorderSide)">
  41133. Get the type of border to use for the selected border
  41134. @param side - - where to apply the color defInition
  41135. @return borderstyle - the type of border to use. default value is NONE if border style is not Set.
  41136. @see BorderStyle
  41137. </member>
  41138. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.SetBorderStyle(NPOI.XSSF.UserModel.Extensions.BorderSide,NPOI.SS.UserModel.BorderStyle)">
  41139. Set the type of border to use for the selected border
  41140. @param side - - where to apply the color defInition
  41141. @param style - border style
  41142. @see BorderStyle
  41143. </member>
  41144. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.GetBorderColor(NPOI.XSSF.UserModel.Extensions.BorderSide)">
  41145. Get the color to use for the selected border
  41146. @param side - where to apply the color defInition
  41147. @return color - color to use as XSSFColor. null if color is not set
  41148. </member>
  41149. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.SetBorderColor(NPOI.XSSF.UserModel.Extensions.BorderSide,NPOI.XSSF.UserModel.XSSFColor)">
  41150. Set the color to use for the selected border
  41151. @param side - where to apply the color defInition
  41152. @param color - the color to use
  41153. </member>
  41154. <member name="T:NPOI.XSSF.UserModel.Extensions.XSSFCellFill">
  41155. This element specifies fill formatting.
  41156. A cell fill consists of a background color, foreground color, and pattern to be applied across the cell.
  41157. </member>
  41158. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Fill)">
  41159. Creates a CellFill from the supplied parts
  41160. @param fill - fill
  41161. </member>
  41162. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.#ctor">
  41163. Creates an empty CellFill
  41164. </member>
  41165. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.GetFillBackgroundColor">
  41166. Get the background fill color.
  41167. @return fill color, null if color is not set
  41168. </member>
  41169. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetFillBackgroundColor(System.Int32)">
  41170. Set the background fill color represented as a indexed color value.
  41171. @param index
  41172. </member>
  41173. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetFillBackgroundColor(NPOI.XSSF.UserModel.XSSFColor)">
  41174. Set the background fill color represented as a {@link XSSFColor} value.
  41175. @param color
  41176. </member>
  41177. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.GetFillForegroundColor">
  41178. Get the foreground fill color.
  41179. @return XSSFColor - foreground color. null if color is not set
  41180. </member>
  41181. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetFillForegroundColor(System.Int32)">
  41182. Set the foreground fill color as a indexed color value
  41183. @param index - the color to use
  41184. </member>
  41185. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetFillForegroundColor(NPOI.XSSF.UserModel.XSSFColor)">
  41186. Set the foreground fill color represented as a {@link XSSFColor} value.
  41187. @param color - the color to use
  41188. </member>
  41189. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.GetPatternType">
  41190. get the fill pattern
  41191. @return fill pattern type. null if fill pattern is not set
  41192. </member>
  41193. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetPatternType(NPOI.OpenXmlFormats.Spreadsheet.ST_PatternType)">
  41194. set the fill pattern
  41195. @param patternType fill pattern to use
  41196. </member>
  41197. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.GetCTFill">
  41198. Returns the underlying XML bean.
  41199. @return CT_Fill
  41200. </member>
  41201. <member name="T:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter">
  41202. <summary>
  41203. Parent class of all XSSF headers and footers.
  41204. </summary>
  41205. </member>
  41206. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  41207. Create an instance of XSSFHeaderFooter from the supplied XML bean
  41208. @param headerFooter
  41209. </member>
  41210. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.GetHeaderFooter">
  41211. Returns the underlying CTHeaderFooter xml bean
  41212. @return the underlying CTHeaderFooter xml bean
  41213. </member>
  41214. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.AreFieldsStripped">
  41215. Are fields currently being stripped from the text that this
  41216. {@link XSSFHeaderFooter} returns? Default is false, but can be Changed
  41217. </member>
  41218. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.SetAreFieldsStripped(System.Boolean)">
  41219. Should fields (eg macros) be stripped from the text that this class
  41220. returns? Default is not to strip.
  41221. @param StripFields
  41222. </member>
  41223. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.StripFields(System.String)">
  41224. Removes any fields (eg macros, page markers etc) from the string.
  41225. Normally used to make some text suitable for showing to humans, and the
  41226. resultant text should not normally be saved back into the document!
  41227. </member>
  41228. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.Center">
  41229. get the text representing the center part of this element
  41230. </member>
  41231. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.Left">
  41232. get the text representing the left part of this element
  41233. </member>
  41234. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.Right">
  41235. get the text representing the right part of this element
  41236. </member>
  41237. <member name="T:NPOI.XSSF.UserModel.Helpers.ColumnHelper">
  41238. Helper class for dealing with the Column Settings on
  41239. a CT_Worksheet (the data part of a sheet).
  41240. Note - within POI, we use 0 based column indexes, but
  41241. the column defInitions in the XML are 1 based!
  41242. </member>
  41243. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.GetColumn(System.Int64,System.Boolean)">
  41244. Returns the Column at the given 0 based index
  41245. </member>
  41246. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.GetColumn1Based(System.Int64,System.Boolean)">
  41247. Returns the Column at the given 1 based index.
  41248. POI default is 0 based, but the file stores
  41249. as 1 based.
  41250. </member>
  41251. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.TreeSet`1.TailSet(`0,System.Boolean)">
  41252. <summary>
  41253. Returns a view of the portion of this map whose keys are greater than (or
  41254. equal to, if inclusive is true) fromKey.
  41255. </summary>
  41256. <param name="fromElement"></param>
  41257. <param name="inclusive"></param>
  41258. <returns></returns>
  41259. </member>
  41260. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.SweepCleanColumns(NPOI.OpenXmlFormats.Spreadsheet.CT_Cols,NPOI.OpenXmlFormats.Spreadsheet.CT_Col[],NPOI.OpenXmlFormats.Spreadsheet.CT_Col)">
  41261. @see <a href="http://en.wikipedia.org/wiki/Sweep_line_algorithm">Sweep line algorithm</a>
  41262. </member>
  41263. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.ColumnExists(NPOI.OpenXmlFormats.Spreadsheet.CT_Cols,System.Int64)">
  41264. Does the column at the given 0 based index exist
  41265. in the supplied list of column defInitions?
  41266. </member>
  41267. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.GetOrCreateColumn1Based(System.Int64,System.Boolean)">
  41268. Return the CT_Col at the given (0 based) column index,
  41269. creating it if required.
  41270. </member>
  41271. <member name="M:NPOI.XSSF.UserModel.Helpers.HeaderFooterHelper.GetParts(System.String)">
  41272. Split into left, center, right
  41273. </member>
  41274. <member name="T:NPOI.XSSF.UserModel.Helpers.XSSFFormulaUtils">
  41275. Utility to update formulas and named ranges when a sheet name was Changed
  41276. @author Yegor Kozlov
  41277. </member>
  41278. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFFormulaUtils.UpdateSheetName(System.Int32,System.String,System.String)">
  41279. Update sheet name in all formulas and named ranges.
  41280. Called from {@link XSSFWorkbook#setSheetName(int, String)}
  41281. <p/>
  41282. <p>
  41283. The idea is to parse every formula and render it back to string
  41284. with the updated sheet name. This is done by parsing into Ptgs,
  41285. looking for ones with sheet references in them, and changing those
  41286. </p>
  41287. @param sheetIndex the 0-based index of the sheet being changed
  41288. @param oldName the old sheet name
  41289. @param newName the new sheet name
  41290. </member>
  41291. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFFormulaUtils.UpdateFormula(NPOI.XSSF.UserModel.XSSFCell,System.String,System.String)">
  41292. Parse cell formula and re-assemble it back using the specified FormulaRenderingWorkbook.
  41293. @param cell the cell to update
  41294. @param frwb the formula rendering workbbok that returns new sheet name
  41295. </member>
  41296. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFFormulaUtils.UpdateName(NPOI.SS.UserModel.IName,System.String,System.String)">
  41297. Parse formula in the named range and re-assemble it back using the specified FormulaRenderingWorkbook.
  41298. @param name the name to update
  41299. @param frwb the formula rendering workbbok that returns new sheet name
  41300. </member>
  41301. <member name="T:NPOI.XSSF.UserModel.Helpers.XSSFIgnoredErrorHelper">
  41302. XSSF-specific code for working with ignored errors
  41303. </member>
  41304. <member name="T:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter">
  41305. @author Yegor Kozlov
  41306. </member>
  41307. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.ShiftMerged(System.Int32,System.Int32,System.Int32)">
  41308. Shift merged regions
  41309. @param startRow the row to start Shifting
  41310. @param endRow the row to end Shifting
  41311. @param n the number of rows to shift
  41312. @return an array of affected cell regions
  41313. </member>
  41314. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.UpdateNamedRanges(NPOI.SS.Formula.FormulaShifter)">
  41315. Updated named ranges
  41316. </member>
  41317. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.UpdateFormulas(NPOI.SS.Formula.FormulaShifter)">
  41318. Update formulas.
  41319. </member>
  41320. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.UpdateRowFormulas(NPOI.SS.UserModel.IRow,NPOI.SS.Formula.FormulaShifter)">
  41321. <summary>
  41322. Update the formulas in specified row using the formula shifting policy specified by shifter
  41323. </summary>
  41324. <param name="row">the row to update the formulas on</param>
  41325. <param name="Shifter">the formula shifting policy</param>
  41326. </member>
  41327. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.ShiftFormula(NPOI.SS.UserModel.IRow,System.String,NPOI.SS.Formula.FormulaShifter)">
  41328. Shift a formula using the supplied FormulaShifter
  41329. @param row the row of the cell this formula belongs to. Used to get a reference to the parent workbook.
  41330. @param formula the formula to shift
  41331. @param Shifter the FormulaShifter object that operates on the Parsed formula tokens
  41332. @return the Shifted formula if the formula was Changed,
  41333. <code>null</code> if the formula wasn't modified
  41334. </member>
  41335. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.UpdateHyperlinks(NPOI.SS.Formula.FormulaShifter)">
  41336. Shift the Hyperlink anchors (not the hyperlink text, even if the hyperlink
  41337. is of type LINK_DOCUMENT and refers to a cell that was shifted). Hyperlinks
  41338. do not track the content they point to.
  41339. @param shifter
  41340. </member>
  41341. <member name="T:NPOI.XSSF.UserModel.Helpers.XSSFSingleXmlCell">
  41342. *
  41343. * This class is a wrapper around the CTSingleXmlCell (Open Office XML Part 4:
  41344. * chapter 3.5.2.1)
  41345. *
  41346. *
  41347. * @author Roberto Manicardi
  41348. *
  41349. </member>
  41350. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFSingleXmlCell.GetReferencedCell">
  41351. Gets the XSSFCell referenced by the R attribute or Creates a new one if cell doesn't exists
  41352. @return the referenced XSSFCell, null if the cell reference is invalid
  41353. </member>
  41354. <member name="T:NPOI.XSSF.UserModel.Helpers.XSSFXmlColumnPr">
  41355. This class is a wrapper around the CT_XmlColumnPr (Open Office XML Part 4:
  41356. chapter 3.5.1.7)
  41357. @author Roberto Manicardi
  41358. </member>
  41359. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFXmlColumnPr.GetId">
  41360. (see Open Office XML Part 4: chapter 3.5.1.3)
  41361. @return An integer representing the unique identifier of this column.
  41362. </member>
  41363. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFXmlColumnPr.GetLocalXPath">
  41364. If the XPath is, for example, /Node1/Node2/Node3 and /Node1/Node2 is the common XPath for the table, the local XPath is /Node3
  41365. @return the local XPath
  41366. </member>
  41367. <member name="T:NPOI.XSSF.UserModel.ListAutoNumber">
  41368. Specifies type of automatic numbered bullet points that should be applied to a paragraph.
  41369. </member>
  41370. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ALPHA_LC_PARENT_BOTH">
  41371. (a), (b), (c), ...
  41372. </member>
  41373. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ALPHA_UC_PARENT_BOTH">
  41374. (A), (B), (C), ...
  41375. </member>
  41376. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ALPHA_LC_PARENT_R">
  41377. a), b), c), ...
  41378. </member>
  41379. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ALPHA_UC_PARENT_R">
  41380. A), B), C), ...
  41381. </member>
  41382. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ALPHA_LC_PERIOD">
  41383. a., b., c., ...
  41384. </member>
  41385. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ALPHA_UC_PERIOD">
  41386. A., B., C., ...
  41387. </member>
  41388. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ARABIC_PARENT_BOTH">
  41389. (1), (2), (3), ...
  41390. </member>
  41391. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ARABIC_PARENT_R">
  41392. 1), 2), 3), ...
  41393. </member>
  41394. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ARABIC_PERIOD">
  41395. 1., 2., 3., ...
  41396. </member>
  41397. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ARABIC_PLAIN">
  41398. 1, 2, 3, ...
  41399. </member>
  41400. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ROMAN_LC_PARENT_BOTH">
  41401. (i), (ii), (iii), ...
  41402. </member>
  41403. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ROMAN_UC_PARENT_BOTH">
  41404. (I), (II), (III), ...
  41405. </member>
  41406. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ROMAN_LC_PARENT_R">
  41407. i), ii), iii), ...
  41408. </member>
  41409. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ROMAN_UC_PARENT_R">
  41410. I), II), III), ...
  41411. </member>
  41412. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ROMAN_LC_PERIOD">
  41413. i., ii., iii., ...
  41414. </member>
  41415. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ROMAN_UC_PERIOD">
  41416. I., II., III., ...
  41417. </member>
  41418. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.CIRCLE_NUM_DB_PLAIN">
  41419. Dbl-byte circle numbers
  41420. </member>
  41421. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.CIRCLE_NUM_WD_BLACK_PLAIN">
  41422. Wingdings black circle numbers
  41423. </member>
  41424. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.CIRCLE_NUM_WD_WHITE_PLAIN">
  41425. Wingdings white circle numbers
  41426. </member>
  41427. <member name="T:NPOI.XSSF.UserModel.TextAlign">
  41428. Specified a list of text alignment types
  41429. </member>
  41430. <member name="F:NPOI.XSSF.UserModel.TextAlign.LEFT">
  41431. Align text to the left margin.
  41432. </member>
  41433. <member name="F:NPOI.XSSF.UserModel.TextAlign.CENTER">
  41434. Align text in the center.
  41435. </member>
  41436. <member name="F:NPOI.XSSF.UserModel.TextAlign.RIGHT">
  41437. Align text to the right margin.
  41438. </member>
  41439. <member name="F:NPOI.XSSF.UserModel.TextAlign.JUSTIFY">
  41440. Align text so that it is justified across the whole line. It
  41441. is smart in the sense that it will not justify sentences
  41442. which are short
  41443. </member>
  41444. <member name="T:NPOI.XSSF.UserModel.TextAutofit">
  41445. Specifies a list of auto-fit types.
  41446. <p>
  41447. Autofit specifies that a shape should be auto-fit to fully contain the text described within it.
  41448. Auto-fitting is when text within a shape is scaled in order to contain all the text inside
  41449. </p>
  41450. </member>
  41451. <member name="F:NPOI.XSSF.UserModel.TextAutofit.NONE">
  41452. Specifies that text within the text body should not be auto-fit to the bounding box.
  41453. Auto-fitting is when text within a text box is scaled in order to remain inside
  41454. the text box.
  41455. </member>
  41456. <member name="F:NPOI.XSSF.UserModel.TextAutofit.NORMAL">
  41457. Specifies that text within the text body should be normally auto-fit to the bounding box.
  41458. Autofitting is when text within a text box is scaled in order to remain inside the text box.
  41459. <p>
  41460. <em>Example:</em> Consider the situation where a user is building a diagram and needs
  41461. to have the text for each shape that they are using stay within the bounds of the shape.
  41462. An easy way this might be done is by using NORMAL autofit
  41463. </p>
  41464. </member>
  41465. <member name="F:NPOI.XSSF.UserModel.TextAutofit.SHAPE">
  41466. Specifies that a shape should be auto-fit to fully contain the text described within it.
  41467. Auto-fitting is when text within a shape is scaled in order to contain all the text inside.
  41468. <p>
  41469. <em>Example:</em> Consider the situation where a user is building a diagram and needs to have
  41470. the text for each shape that they are using stay within the bounds of the shape.
  41471. An easy way this might be done is by using SHAPE autofit
  41472. </p>
  41473. </member>
  41474. <member name="T:NPOI.XSSF.UserModel.TextCap">
  41475. Text Capitalization that is to be applied to the text Run. This is a render-only
  41476. modification and does not affect the actual characters stored in the text Run.
  41477. </member>
  41478. <member name="T:NPOI.XSSF.UserModel.TextDirection">
  41479. Vertical Text Types
  41480. </member>
  41481. <member name="F:NPOI.XSSF.UserModel.TextDirection.HORIZONTAL">
  41482. Horizontal text. This should be default.
  41483. </member>
  41484. <member name="F:NPOI.XSSF.UserModel.TextDirection.VERTICAL">
  41485. Vertical orientation.
  41486. (each line is 90 degrees rotated clockwise, so it goes
  41487. from top to bottom; each next line is to the left from
  41488. the previous one).
  41489. </member>
  41490. <member name="F:NPOI.XSSF.UserModel.TextDirection.VERTICAL_270">
  41491. Vertical orientation.
  41492. (each line is 270 degrees rotated clockwise, so it goes
  41493. from bottom to top; each next line is to the right from
  41494. the previous one).
  41495. </member>
  41496. <member name="F:NPOI.XSSF.UserModel.TextDirection.STACKED">
  41497. Determines if all of the text is vertical
  41498. ("one letter on top of another").
  41499. </member>
  41500. <member name="T:NPOI.XSSF.UserModel.TextFontAlign">
  41501. Specified a list of text font alignment types
  41502. </member>
  41503. <member name="F:NPOI.XSSF.UserModel.TextFontAlign.AUTO">
  41504. Automatic alignment
  41505. </member>
  41506. <member name="F:NPOI.XSSF.UserModel.TextFontAlign.TOP">
  41507. Align text to the top.
  41508. </member>
  41509. <member name="F:NPOI.XSSF.UserModel.TextFontAlign.CENTER">
  41510. Align text in the center.
  41511. </member>
  41512. <member name="F:NPOI.XSSF.UserModel.TextFontAlign.BASELINE">
  41513. Align text to the baseline.
  41514. </member>
  41515. <member name="F:NPOI.XSSF.UserModel.TextFontAlign.BOTTOM">
  41516. Align text to the bottom.
  41517. </member>
  41518. <member name="T:NPOI.XSSF.UserModel.TextHorizontalOverflow">
  41519. Text Horizontal Overflow
  41520. </member>
  41521. <member name="F:NPOI.XSSF.UserModel.TextHorizontalOverflow.OVERFLOW">
  41522. When a big character does not fit into a line, allow a
  41523. horizontal overflow.
  41524. </member>
  41525. <member name="F:NPOI.XSSF.UserModel.TextHorizontalOverflow.CLIP">
  41526. When a big character does not fit into a line, clip it at
  41527. the proper horizontal overflow.
  41528. </member>
  41529. <member name="T:NPOI.XSSF.UserModel.TextVerticalOverflow">
  41530. Text Vertical Overflow
  41531. </member>
  41532. <member name="F:NPOI.XSSF.UserModel.TextVerticalOverflow.OVERFLOW">
  41533. Overflow the text and pay no attention to top and bottom barriers.
  41534. </member>
  41535. <member name="F:NPOI.XSSF.UserModel.TextVerticalOverflow.ELLIPSIS">
  41536. Pay attention to top and bottom barriers. Use an
  41537. ellipsis to denote that there is text which is not visible.
  41538. </member>
  41539. <member name="F:NPOI.XSSF.UserModel.TextVerticalOverflow.CLIP">
  41540. Pay attention to top and bottom barriers. Provide no
  41541. indication that there is text which is not visible.
  41542. </member>
  41543. <member name="T:NPOI.XSSF.UserModel.XSSFAnchor">
  41544. An anchor is what specifics the position of a shape within a client object
  41545. or within another containing shape.
  41546. @author Yegor Kozlov
  41547. </member>
  41548. <member name="T:NPOI.XSSF.UserModel.XSSFAutoFilter">
  41549. Represents autofiltering for the specified worksheet.
  41550. @author Yegor Kozlov
  41551. </member>
  41552. <member name="T:NPOI.XSSF.UserModel.XSSFBorderFormatting">
  41553. @author Yegor Kozlov
  41554. </member>
  41555. <member name="T:NPOI.XSSF.UserModel.XSSFCell">
  41556. High level representation of a cell in a row of a spreadsheet.
  41557. <p>
  41558. Cells can be numeric, formula-based or string-based (text). The cell type
  41559. specifies this. String cells cannot conatin numbers and numeric cells cannot
  41560. contain strings (at least according to our model). Client apps should do the
  41561. conversions themselves. Formula cells have the formula string, as well as
  41562. the formula result, which can be numeric or string.
  41563. </p>
  41564. <p>
  41565. Cells should have their number (0 based) before being Added to a row. Only
  41566. cells that have values should be Added.
  41567. </p>
  41568. </member>
  41569. <member name="F:NPOI.XSSF.UserModel.XSSFCell._cell">
  41570. the xml bean Containing information about the cell's location, value,
  41571. data type, formatting, and formula
  41572. </member>
  41573. <member name="F:NPOI.XSSF.UserModel.XSSFCell._row">
  41574. the XSSFRow this cell belongs to
  41575. </member>
  41576. <member name="F:NPOI.XSSF.UserModel.XSSFCell._cellNum">
  41577. 0-based column index
  41578. </member>
  41579. <member name="F:NPOI.XSSF.UserModel.XSSFCell._sharedStringSource">
  41580. Table of strings shared across this workbook.
  41581. If two cells contain the same string, then the cell value is the same index into SharedStringsTable
  41582. </member>
  41583. <member name="F:NPOI.XSSF.UserModel.XSSFCell._stylesSource">
  41584. Table of cell styles shared across all cells in a workbook.
  41585. </member>
  41586. <member name="M:NPOI.XSSF.UserModel.XSSFCell.#ctor(NPOI.XSSF.UserModel.XSSFRow,NPOI.OpenXmlFormats.Spreadsheet.CT_Cell)">
  41587. Construct a XSSFCell.
  41588. @param row the parent row.
  41589. @param cell the xml bean Containing information about the cell.
  41590. </member>
  41591. <member name="M:NPOI.XSSF.UserModel.XSSFCell.CopyCellFrom(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.CellCopyPolicy)">
  41592. <summary>
  41593. Copy cell value, formula and style, from srcCell per cell copy policy
  41594. If srcCell is null, clears the cell value and cell style per cell copy policy
  41595. This does not shift references in formulas. Use {@link XSSFRowShifter} to shift references in formulas.
  41596. </summary>
  41597. <param name="srcCell">The cell to take value, formula and style from</param>
  41598. <param name="policy">The policy for copying the information, see {@link CellCopyPolicy}</param>
  41599. <exception cref="T:System.ArgumentException">if copy cell style and srcCell is from a different workbook</exception>
  41600. </member>
  41601. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetSharedStringSource">
  41602. @return table of strings shared across this workbook
  41603. </member>
  41604. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetStylesSource">
  41605. @return table of cell styles shared across this workbook
  41606. </member>
  41607. <member name="P:NPOI.XSSF.UserModel.XSSFCell.Sheet">
  41608. Returns the sheet this cell belongs to
  41609. @return the sheet this cell belongs to
  41610. </member>
  41611. <member name="P:NPOI.XSSF.UserModel.XSSFCell.Row">
  41612. Returns the row this cell belongs to
  41613. @return the row this cell belongs to
  41614. </member>
  41615. <member name="P:NPOI.XSSF.UserModel.XSSFCell.BooleanCellValue">
  41616. Get the value of the cell as a bool.
  41617. <p>
  41618. For strings, numbers, and errors, we throw an exception. For blank cells we return a false.
  41619. </p>
  41620. @return the value of the cell as a bool
  41621. @throws InvalidOperationException if the cell type returned by {@link #CellType}
  41622. is not CellType.Boolean, CellType.Blank or CellType.Formula
  41623. </member>
  41624. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(System.Boolean)">
  41625. Set a bool value for the cell
  41626. @param value the bool value to Set this cell to. For formulas we'll Set the
  41627. precalculated value, for bools we'll Set its value. For other types we
  41628. will change the cell to a bool cell and Set its value.
  41629. </member>
  41630. <member name="P:NPOI.XSSF.UserModel.XSSFCell.NumericCellValue">
  41631. Get the value of the cell as a number.
  41632. <p>
  41633. For strings we throw an exception. For blank cells we return a 0.
  41634. For formulas or error cells we return the precalculated value;
  41635. </p>
  41636. @return the value of the cell as a number
  41637. @throws InvalidOperationException if the cell type returned by {@link #CellType} is CellType.String
  41638. @exception NumberFormatException if the cell value isn't a parsable <code>double</code>.
  41639. @see DataFormatter for turning this number into a string similar to that which Excel would render this number as.
  41640. </member>
  41641. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(System.Double)">
  41642. Set a numeric value for the cell
  41643. @param value the numeric value to Set this cell to. For formulas we'll Set the
  41644. precalculated value, for numerics we'll Set its value. For other types we
  41645. will change the cell to a numeric cell and Set its value.
  41646. </member>
  41647. <member name="P:NPOI.XSSF.UserModel.XSSFCell.StringCellValue">
  41648. Get the value of the cell as a string
  41649. <p>
  41650. For numeric cells we throw an exception. For blank cells we return an empty string.
  41651. For formulaCells that are not string Formulas, we throw an exception
  41652. </p>
  41653. @return the value of the cell as a string
  41654. </member>
  41655. <member name="P:NPOI.XSSF.UserModel.XSSFCell.RichStringCellValue">
  41656. Get the value of the cell as a XSSFRichTextString
  41657. <p>
  41658. For numeric cells we throw an exception. For blank cells we return an empty string.
  41659. For formula cells we return the pre-calculated value if a string, otherwise an exception
  41660. </p>
  41661. @return the value of the cell as a XSSFRichTextString
  41662. </member>
  41663. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(System.String)">
  41664. Set a string value for the cell.
  41665. @param str value to Set the cell to. For formulas we'll Set the formula
  41666. cached string result, for String cells we'll Set its value. For other types we will
  41667. change the cell to a string cell and Set its value.
  41668. If value is null then we will change the cell to a Blank cell.
  41669. </member>
  41670. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(NPOI.SS.UserModel.IRichTextString)">
  41671. Set a string value for the cell.
  41672. @param str value to Set the cell to. For formulas we'll Set the 'pre-Evaluated result string,
  41673. for String cells we'll Set its value. For other types we will
  41674. change the cell to a string cell and Set its value.
  41675. If value is null then we will change the cell to a Blank cell.
  41676. </member>
  41677. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CellFormula">
  41678. <summary>
  41679. Return a formula for the cell, for example, <code>SUM(C4:E4)</code>
  41680. </summary>
  41681. </member>
  41682. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetCellFormula(NPOI.XSSF.UserModel.XSSFEvaluationWorkbook)">
  41683. package/hierarchy use only - reuse an existing evaluation workbook if available for caching
  41684. @param fpb evaluation workbook for reuse, if available, or null to create a new one as needed
  41685. @return a formula for the cell
  41686. @throws InvalidOperationException if the cell type returned by {@link #getCellType()} is not CELL_TYPE_FORMULA
  41687. </member>
  41688. <member name="M:NPOI.XSSF.UserModel.XSSFCell.ConvertSharedFormula(System.Int32,NPOI.XSSF.UserModel.XSSFEvaluationWorkbook)">
  41689. <summary>
  41690. Creates a non shared formula from the shared formula counterpart
  41691. </summary>
  41692. <param name="si">Shared Group Index</param>
  41693. <param name="fpb"></param>
  41694. <returns>non shared formula created for the given shared formula and this cell</returns>
  41695. </member>
  41696. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellFormula(System.String)">
  41697. Sets formula for this cell.
  41698. <p>
  41699. Note, this method only Sets the formula string and does not calculate the formula value.
  41700. To Set the precalculated value use {@link #setCellValue(double)} or {@link #setCellValue(String)}
  41701. </p>
  41702. @param formula the formula to Set, e.g. <code>"SUM(C4:E4)"</code>.
  41703. If the argument is <code>null</code> then the current formula is Removed.
  41704. @throws NPOI.ss.formula.FormulaParseException if the formula has incorrect syntax or is otherwise invalid
  41705. @throws InvalidOperationException if the operation is not allowed, for example,
  41706. when the cell is a part of a multi-cell array formula
  41707. </member>
  41708. <member name="P:NPOI.XSSF.UserModel.XSSFCell.ColumnIndex">
  41709. <summary>
  41710. Returns zero-based column index of this cell
  41711. </summary>
  41712. </member>
  41713. <member name="P:NPOI.XSSF.UserModel.XSSFCell.RowIndex">
  41714. <summary>
  41715. Returns zero-based row index of a row in the sheet that contains this cell
  41716. </summary>
  41717. </member>
  41718. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetReference">
  41719. <summary>
  41720. Returns an A1 style reference to the location of this cell
  41721. </summary>
  41722. <returns>A1 style reference to the location of this cell</returns>
  41723. </member>
  41724. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CellStyle">
  41725. <summary>
  41726. Return the cell's style.
  41727. </summary>
  41728. </member>
  41729. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CellType">
  41730. <summary>
  41731. Return the cell type.
  41732. </summary>
  41733. </member>
  41734. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CachedFormulaResultType">
  41735. <summary>
  41736. Only valid for formula cells
  41737. </summary>
  41738. </member>
  41739. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetBaseCellType(System.Boolean)">
  41740. <summary>
  41741. Detect cell type based on the "t" attribute of the CT_Cell bean
  41742. </summary>
  41743. <param name="blankCells"></param>
  41744. <returns></returns>
  41745. </member>
  41746. <member name="P:NPOI.XSSF.UserModel.XSSFCell.DateCellValue">
  41747. <summary>
  41748. Get the value of the cell as a date.
  41749. </summary>
  41750. </member>
  41751. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(System.DateTime)">
  41752. <summary>
  41753. Set a date value for the cell. Excel treats dates as numeric so you will need to format the cell as a date.
  41754. </summary>
  41755. <param name="value">the date value to Set this cell to. For formulas we'll set the precalculated value,
  41756. for numerics we'll Set its value. For other types we will change the cell to a numeric cell and Set its value. </param>
  41757. </member>
  41758. <member name="P:NPOI.XSSF.UserModel.XSSFCell.ErrorCellString">
  41759. <summary>
  41760. Returns the error message, such as #VALUE!
  41761. </summary>
  41762. </member>
  41763. <member name="P:NPOI.XSSF.UserModel.XSSFCell.ErrorCellValue">
  41764. <summary>
  41765. Get the value of the cell as an error code.
  41766. For strings, numbers, and bools, we throw an exception.
  41767. For blank cells we return a 0.
  41768. </summary>
  41769. </member>
  41770. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellErrorValue(NPOI.SS.UserModel.FormulaError)">
  41771. <summary>
  41772. Set a error value for the cell
  41773. </summary>
  41774. <param name="error">the error value to Set this cell to.
  41775. For formulas we'll Set the precalculated value , for errors we'll set
  41776. its value. For other types we will change the cell to an error cell and Set its value.
  41777. </param>
  41778. </member>
  41779. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetAsActiveCell">
  41780. <summary>
  41781. Sets this cell as the active cell for the worksheet.
  41782. </summary>
  41783. </member>
  41784. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetBlank">
  41785. <summary>
  41786. Blanks this cell. Blank cells have no formula or value but may have styling.
  41787. This method erases all the data previously associated with this cell.
  41788. </summary>
  41789. </member>
  41790. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellNum(System.Int32)">
  41791. <summary>
  41792. Sets column index of this cell
  41793. </summary>
  41794. <param name="num"></param>
  41795. </member>
  41796. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellType(NPOI.SS.UserModel.CellType)">
  41797. <summary>
  41798. Set the cells type (numeric, formula or string)
  41799. </summary>
  41800. <param name="cellType"></param>
  41801. </member>
  41802. <member name="M:NPOI.XSSF.UserModel.XSSFCell.ToString">
  41803. <summary>
  41804. Returns a string representation of the cell
  41805. </summary>
  41806. <returns>Formula cells return the formula string, rather than the formula result.
  41807. Dates are displayed in dd-MMM-yyyy format
  41808. Errors are displayed as #ERR&lt;errIdx&gt;
  41809. </returns>
  41810. </member>
  41811. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetRawValue">
  41812. Returns the raw, underlying ooxml value for the cell
  41813. <p>
  41814. If the cell Contains a string, then this value is an index into
  41815. the shared string table, pointing to the actual string value. Otherwise,
  41816. the value of the cell is expressed directly in this element. Cells Containing formulas express
  41817. the last calculated result of the formula in this element.
  41818. </p>
  41819. @return the raw cell value as Contained in the underlying CT_Cell bean,
  41820. <code>null</code> for blank cells.
  41821. </member>
  41822. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetCellTypeName(NPOI.SS.UserModel.CellType)">
  41823. <summary>
  41824. Used to help format error messages
  41825. </summary>
  41826. <param name="cellTypeCode"></param>
  41827. <returns></returns>
  41828. </member>
  41829. <member name="M:NPOI.XSSF.UserModel.XSSFCell.TypeMismatch(NPOI.SS.UserModel.CellType,NPOI.SS.UserModel.CellType,System.Boolean)">
  41830. Used to help format error messages
  41831. </member>
  41832. <member name="M:NPOI.XSSF.UserModel.XSSFCell.CheckBounds(System.Int32)">
  41833. @throws RuntimeException if the bounds are exceeded.
  41834. </member>
  41835. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CellComment">
  41836. <summary>
  41837. Returns cell comment associated with this cell
  41838. </summary>
  41839. </member>
  41840. <member name="M:NPOI.XSSF.UserModel.XSSFCell.RemoveCellComment">
  41841. <summary>
  41842. Removes the comment for this cell, if there is one.
  41843. </summary>
  41844. </member>
  41845. <member name="P:NPOI.XSSF.UserModel.XSSFCell.Hyperlink">
  41846. <summary>
  41847. Get or set hyperlink associated with this cell
  41848. If the supplied hyperlink is null on setting, the hyperlink for this cell will be removed.
  41849. </summary>
  41850. </member>
  41851. <member name="M:NPOI.XSSF.UserModel.XSSFCell.RemoveHyperlink">
  41852. Removes the hyperlink for this cell, if there is one.
  41853. </member>
  41854. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetCTCell">
  41855. Returns the xml bean containing information about the cell's location (reference), value,
  41856. data type, formatting, and formula
  41857. @return the xml bean containing information about this cell
  41858. </member>
  41859. <member name="M:NPOI.XSSF.UserModel.XSSFCell.ConvertCellValueToBoolean">
  41860. Chooses a new bool value for the cell when its type is changing.<p/>
  41861. Usually the caller is calling SetCellType() with the intention of calling
  41862. SetCellValue(bool) straight afterwards. This method only exists to give
  41863. the cell a somewhat reasonable value until the SetCellValue() call (if at all).
  41864. TODO - perhaps a method like SetCellTypeAndValue(int, Object) should be introduced to avoid this
  41865. </member>
  41866. <member name="M:NPOI.XSSF.UserModel.XSSFCell.NotifyArrayFormulaChanging(System.String)">
  41867. The purpose of this method is to validate the cell state prior to modification
  41868. @see #NotifyArrayFormulaChanging()
  41869. </member>
  41870. <member name="M:NPOI.XSSF.UserModel.XSSFCell.NotifyArrayFormulaChanging">
  41871. <summary>
  41872. Called when this cell is modified.The purpose of this method is to validate the cell state prior to modification.
  41873. </summary>
  41874. <exception cref="T:System.InvalidOperationException">if modification is not allowed</exception>
  41875. </member>
  41876. <member name="T:NPOI.XSSF.UserModel.XSSFCellStyle">
  41877. High level representation of the the possible formatting information for the contents of the cells on a sheet in a
  41878. SpreadsheetML document.
  41879. @see NPOI.xssf.usermodel.XSSFWorkbook#CreateCellStyle()
  41880. @see NPOI.xssf.usermodel.XSSFWorkbook#getCellStyleAt(short)
  41881. @see NPOI.xssf.usermodel.XSSFCell#setCellStyle(NPOI.ss.usermodel.CellStyle)
  41882. </member>
  41883. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.#ctor(System.Int32,System.Int32,NPOI.XSSF.Model.StylesTable,NPOI.XSSF.Model.ThemesTable)">
  41884. Creates a Cell Style from the supplied parts
  41885. @param cellXfId The main XF for the cell. Must be a valid 0-based index into the XF table
  41886. @param cellStyleXfId Optional, style xf. A value of <code>-1</code> means no xf.
  41887. @param stylesSource Styles Source to work off
  41888. </member>
  41889. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCoreXf">
  41890. Used so that StylesSource can figure out our location
  41891. </member>
  41892. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetStyleXf">
  41893. Used so that StylesSource can figure out our location
  41894. </member>
  41895. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.#ctor(NPOI.XSSF.Model.StylesTable)">
  41896. <summary>
  41897. Creates an empty Cell Style
  41898. </summary>
  41899. <param name="stylesSource"></param>
  41900. </member>
  41901. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.VerifyBelongsToStylesSource(NPOI.XSSF.Model.StylesTable)">
  41902. Verifies that this style belongs to the supplied Workbook
  41903. Styles Source.
  41904. Will throw an exception if it belongs to a different one.
  41905. This is normally called when trying to assign a style to a
  41906. cell, to ensure the cell and the style are from the same
  41907. workbook (if they're not, it won't work)
  41908. @throws ArgumentException if there's a workbook mis-match
  41909. </member>
  41910. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.CloneStyleFrom(NPOI.SS.UserModel.ICellStyle)">
  41911. Clones all the style information from another
  41912. XSSFCellStyle, onto this one. This
  41913. XSSFCellStyle will then have all the same
  41914. properties as the source, but the two may
  41915. be edited independently.
  41916. Any stylings on this XSSFCellStyle will be lost!
  41917. The source XSSFCellStyle could be from another
  41918. XSSFWorkbook if you like. This allows you to
  41919. copy styles from one XSSFWorkbook to another.
  41920. </member>
  41921. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetAlignmentEnum">
  41922. <summary>
  41923. Get the type of horizontal alignment for the cell
  41924. </summary>
  41925. <returns>the type of alignment</returns>
  41926. </member>
  41927. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.BorderBottom">
  41928. <summary>
  41929. Get or set the type of border to use for the bottom border of the cell
  41930. </summary>
  41931. </member>
  41932. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.BorderLeft">
  41933. <summary>
  41934. Get or set the type of border to use for the left border of the cell
  41935. </summary>
  41936. </member>
  41937. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.BorderRight">
  41938. <summary>
  41939. Get or set the type of border to use for the right border of the cell
  41940. </summary>
  41941. </member>
  41942. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.BorderTop">
  41943. <summary>
  41944. Get or set the type of border to use for the top border of the cell
  41945. </summary>
  41946. </member>
  41947. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.BottomBorderColor">
  41948. Get the color to use for the bottom border
  41949. Color is optional. When missing, IndexedColors.Automatic is implied.
  41950. @return the index of the color defInition, default value is {@link NPOI.ss.usermodel.IndexedColors#AUTOMATIC}
  41951. @see NPOI.ss.usermodel.IndexedColors
  41952. </member>
  41953. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.BottomBorderXSSFColor">
  41954. Get the color to use for the bottom border as a {@link XSSFColor}
  41955. @return the used color or <code>null</code> if not Set
  41956. </member>
  41957. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.DataFormat">
  41958. Get the index of the number format (numFmt) record used by this cell format.
  41959. @return the index of the number format
  41960. </member>
  41961. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetDataFormat(System.Int32)">
  41962. Set the index of a data format
  41963. @param fmt the index of a data format
  41964. </member>
  41965. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetDataFormatString">
  41966. Get the contents of the format string, by looking up
  41967. the StylesSource
  41968. @return the number format string
  41969. </member>
  41970. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillBackgroundColor">
  41971. <summary>
  41972. Get the background fill color.
  41973. Note - many cells are actually filled with a foreground fill, not a background fill
  41974. </summary>
  41975. </member>
  41976. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillBackgroundColorColor">
  41977. Get the background fill color.
  41978. <p>
  41979. Note - many cells are actually Filled with a foreground
  41980. Fill, not a background fill - see {@link #getFillForegroundColor()}
  41981. </p>
  41982. @see NPOI.xssf.usermodel.XSSFColor#getRgb()
  41983. @return XSSFColor - fill color or <code>null</code> if not Set
  41984. </member>
  41985. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillForegroundColor">
  41986. Get the foreground fill color.
  41987. <p>
  41988. Many cells are Filled with this, instead of a
  41989. background color ({@link #getFillBackgroundColor()})
  41990. </p>
  41991. @see IndexedColors
  41992. @return fill color, default value is {@link NPOI.ss.usermodel.IndexedColors#AUTOMATIC}
  41993. </member>
  41994. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillForegroundColorColor">
  41995. <summary>
  41996. Get the foreground fill color.
  41997. </summary>
  41998. </member>
  41999. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillForegroundXSSFColor">
  42000. <summary>
  42001. Get the foreground fill color.
  42002. </summary>
  42003. </member>
  42004. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetFont">
  42005. Gets the font for this style
  42006. @return Font - font
  42007. </member>
  42008. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FontIndex">
  42009. Gets the index of the font for this style
  42010. @return short - font index
  42011. @see NPOI.xssf.usermodel.XSSFWorkbook#getFontAt(short)
  42012. </member>
  42013. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.IsHidden">
  42014. Get whether the cell's using this style are to be hidden
  42015. @return bool - whether the cell using this style is hidden
  42016. </member>
  42017. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.Indention">
  42018. Get the number of spaces to indent the text in the cell
  42019. @return indent - number of spaces
  42020. </member>
  42021. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.Index">
  42022. Get the index within the StylesTable (sequence within the collection of CT_Xf elements)
  42023. @return unique index number of the underlying record this style represents
  42024. </member>
  42025. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.LeftBorderColor">
  42026. Get the color to use for the left border
  42027. @return the index of the color defInition, default value is {@link NPOI.ss.usermodel.IndexedColors#BLACK}
  42028. @see NPOI.ss.usermodel.IndexedColors
  42029. </member>
  42030. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.LeftBorderXSSFColor">
  42031. Get the color to use for the left border
  42032. @return the index of the color defInition or <code>null</code> if not Set
  42033. @see NPOI.ss.usermodel.IndexedColors
  42034. </member>
  42035. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.IsLocked">
  42036. <summary>
  42037. Get whether the cell's using this style are locked
  42038. </summary>
  42039. </member>
  42040. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.RightBorderColor">
  42041. <summary>
  42042. Get the color to use for the right border
  42043. </summary>
  42044. </member>
  42045. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.RightBorderXSSFColor">
  42046. <summary>
  42047. Get the color to use for the right border
  42048. </summary>
  42049. <returns></returns>
  42050. </member>
  42051. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.Rotation">
  42052. <summary>
  42053. Get the degree of rotation (between 0 and 180 degrees) for the text in the cell
  42054. Note: HSSF uses values from -90 to 90 degrees, whereas XSSF
  42055. uses values from 0 to 180 degrees.The implementations of this method will map between these two value-ranges
  42056. accordingly, however the corresponding getter is returning values in the range mandated by the current type
  42057. of Excel file-format that this CellStyle is applied to.
  42058. </summary>
  42059. <example>
  42060. Expressed in degrees. Values range from 0 to 180. The first letter of
  42061. the text is considered the center-point of the arc.
  42062. For 0 - 90, the value represents degrees above horizon. For 91-180 the degrees below the horizon is calculated as:
  42063. <code>[degrees below horizon] = 90 - textRotation.</code>
  42064. </example>
  42065. </member>
  42066. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.TopBorderColor">
  42067. Get the color to use for the top border
  42068. @return the index of the color defInition, default value is {@link NPOI.ss.usermodel.IndexedColors#BLACK}
  42069. @see NPOI.ss.usermodel.IndexedColors
  42070. </member>
  42071. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.TopBorderXSSFColor">
  42072. <summary>
  42073. Get the color to use for the top border
  42074. </summary>
  42075. <returns></returns>
  42076. </member>
  42077. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.VerticalAlignment">
  42078. <summary>
  42079. Get the type of vertical alignment for the cell
  42080. </summary>
  42081. </member>
  42082. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetVerticalAlignmentEnum">
  42083. <summary>
  42084. Get the type of vertical alignment for the cell
  42085. </summary>
  42086. <returns></returns>
  42087. </member>
  42088. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.WrapText">
  42089. <summary>
  42090. Whether the text in a cell should be line-wrapped within the cell.
  42091. </summary>
  42092. </member>
  42093. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetBottomBorderColor(NPOI.XSSF.UserModel.XSSFColor)">
  42094. Set the color to use for the bottom border
  42095. @param color the color to use, null means no color
  42096. </member>
  42097. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFCellStyle.SetFillBackgroundColor(NPOI.XSSF.UserModel.XSSFColor)" -->
  42098. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetFillForegroundColor(NPOI.XSSF.UserModel.XSSFColor)">
  42099. * Set the foreground fill color represented as a {@link XSSFColor} value.
  42100. * <br/>
  42101. * <i>Note: Ensure Foreground color is Set prior to background color.</i>
  42102. * @param color the color to use
  42103. * @see #setFillBackgroundColor(NPOI.xssf.usermodel.XSSFColor) )
  42104. </member>
  42105. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCTFill">
  42106. Get a <b>copy</b> of the currently used CT_Fill, if none is used, return a new instance.
  42107. </member>
  42108. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCTBorder">
  42109. Get a <b>copy</b> of the currently used CT_Border, if none is used, return a new instance.
  42110. </member>
  42111. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetFont(NPOI.SS.UserModel.IFont)">
  42112. Set the font for this style
  42113. @param font a font object Created or retrieved from the XSSFWorkbook object
  42114. @see NPOI.xssf.usermodel.XSSFWorkbook#CreateFont()
  42115. @see NPOI.xssf.usermodel.XSSFWorkbook#getFontAt(short)
  42116. </member>
  42117. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetLeftBorderColor(NPOI.XSSF.UserModel.XSSFColor)">
  42118. Set the color to use for the left border as a {@link XSSFColor} value
  42119. @param color the color to use
  42120. </member>
  42121. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetRightBorderColor(NPOI.XSSF.UserModel.XSSFColor)">
  42122. Set the color to use for the right border as a {@link XSSFColor} value
  42123. @param color the color to use
  42124. </member>
  42125. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetTopBorderColor(NPOI.XSSF.UserModel.XSSFColor)">
  42126. Set the color to use for the top border as a {@link XSSFColor} value
  42127. @param color the color to use
  42128. </member>
  42129. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetVerticalAlignment(System.Int16)">
  42130. Set the type of vertical alignment for the cell
  42131. @param align - align the type of alignment
  42132. @see NPOI.ss.usermodel.CellStyle#VERTICAL_TOP
  42133. @see NPOI.ss.usermodel.CellStyle#VERTICAL_CENTER
  42134. @see NPOI.ss.usermodel.CellStyle#VERTICAL_BOTTOM
  42135. @see NPOI.ss.usermodel.CellStyle#VERTICAL_JUSTIFY
  42136. @see NPOI.ss.usermodel.VerticalAlignment
  42137. </member>
  42138. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetBorderColor(NPOI.XSSF.UserModel.Extensions.BorderSide)">
  42139. Gets border color
  42140. @param side the border side
  42141. @return the used color
  42142. </member>
  42143. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetBorderColor(NPOI.XSSF.UserModel.Extensions.BorderSide,NPOI.XSSF.UserModel.XSSFColor)">
  42144. Set the color to use for the selected border
  42145. @param side - where to apply the color defInition
  42146. @param color - the color to use
  42147. </member>
  42148. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCellAlignment">
  42149. Get the cellAlignment object to use for manage alignment
  42150. @return XSSFCellAlignment - cell alignment
  42151. </member>
  42152. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCTCellAlignment">
  42153. Return the CT_CellAlignment instance for alignment
  42154. @return CT_CellAlignment
  42155. </member>
  42156. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetHashCode">
  42157. Returns a hash code value for the object. The hash is derived from the underlying CT_Xf bean.
  42158. @return the hash code value for this style
  42159. </member>
  42160. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.Equals(System.Object)">
  42161. Checks is the supplied style is equal to this style
  42162. @param o the style to check
  42163. @return true if the supplied style is equal to this style
  42164. </member>
  42165. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.Clone">
  42166. Make a copy of this style. The underlying CT_Xf bean is Cloned,
  42167. the references to Fills and borders remain.
  42168. @return a copy of this style
  42169. </member>
  42170. <member name="T:NPOI.XSSF.UserModel.XSSFChart">
  42171. Represents a SpreadsheetML Chart
  42172. @author Nick Burch
  42173. @author Roman Kashitsyn
  42174. </member>
  42175. <member name="F:NPOI.XSSF.UserModel.XSSFChart.frame">
  42176. Parent graphic frame.
  42177. </member>
  42178. <member name="F:NPOI.XSSF.UserModel.XSSFChart.chartSpaceDocument">
  42179. Root element of the SpreadsheetML Chart part
  42180. </member>
  42181. <member name="F:NPOI.XSSF.UserModel.XSSFChart.chart">
  42182. The Chart within that
  42183. </member>
  42184. <member name="M:NPOI.XSSF.UserModel.XSSFChart.#ctor">
  42185. Create a new SpreadsheetML chart
  42186. </member>
  42187. <member name="M:NPOI.XSSF.UserModel.XSSFChart.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  42188. Construct a SpreadsheetML chart from a namespace part.
  42189. @param part the namespace part holding the chart data,
  42190. the content type must be <code>application/vnd.Openxmlformats-officedocument.Drawingml.chart+xml</code>
  42191. @param rel the namespace relationship holding this chart,
  42192. the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/chart
  42193. </member>
  42194. <member name="M:NPOI.XSSF.UserModel.XSSFChart.CreateChart">
  42195. Construct a new CTChartSpace bean.
  42196. By default, it's just an empty placeholder for chart objects.
  42197. @return a new CTChartSpace bean
  42198. </member>
  42199. <member name="M:NPOI.XSSF.UserModel.XSSFChart.GetCTChartSpace">
  42200. Return the underlying CTChartSpace bean, the root element of the SpreadsheetML Chart part.
  42201. @return the underlying CTChartSpace bean
  42202. </member>
  42203. <member name="M:NPOI.XSSF.UserModel.XSSFChart.GetCTChart">
  42204. Return the underlying CTChart bean, within the Chart Space
  42205. @return the underlying CTChart bean
  42206. </member>
  42207. <member name="M:NPOI.XSSF.UserModel.XSSFChart.GetGraphicFrame">
  42208. Returns the parent graphic frame.
  42209. @return the graphic frame this chart belongs to
  42210. </member>
  42211. <member name="M:NPOI.XSSF.UserModel.XSSFChart.SetGraphicFrame(NPOI.XSSF.UserModel.XSSFGraphicFrame)">
  42212. Sets the parent graphic frame.
  42213. </member>
  42214. <member name="M:NPOI.XSSF.UserModel.XSSFChart.IsPlotOnlyVisibleCells">
  42215. @return true if only visible cells will be present on the chart,
  42216. false otherwise
  42217. </member>
  42218. <member name="M:NPOI.XSSF.UserModel.XSSFChart.SetPlotOnlyVisibleCells(System.Boolean)">
  42219. @param plotVisOnly a flag specifying if only visible cells should be
  42220. present on the chart
  42221. </member>
  42222. <member name="P:NPOI.XSSF.UserModel.XSSFChart.Title">
  42223. Returns the title, or null if none is Set
  42224. </member>
  42225. <member name="M:NPOI.XSSF.UserModel.XSSFChart.SetTitle(System.String)">
  42226. Sets the title text.
  42227. </member>
  42228. <member name="T:NPOI.XSSF.UserModel.XSSFChartSheet">
  42229. High level representation of Sheet Parts that are of type 'chartsheet'.
  42230. <p>
  42231. Chart sheet is a special kind of Sheet that Contains only chart and no data.
  42232. </p>
  42233. @author Yegor Kozlov
  42234. </member>
  42235. <member name="M:NPOI.XSSF.UserModel.XSSFChartSheet.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  42236. @since POI 3.14-Beta1
  42237. </member>
  42238. <member name="M:NPOI.XSSF.UserModel.XSSFChartSheet.GetCTChartsheet">
  42239. Provide access to the CTChartsheet bean holding this sheet's data
  42240. @return the CTChartsheet bean holding this sheet's data
  42241. </member>
  42242. <member name="T:NPOI.XSSF.UserModel.XSSFClientAnchor">
  42243. A client anchor is attached to an excel worksheet. It anchors against
  42244. top-left and bottom-right cells.
  42245. @author Yegor Kozlov
  42246. </member>
  42247. <member name="F:NPOI.XSSF.UserModel.XSSFClientAnchor.cell1">
  42248. Starting anchor point
  42249. </member>
  42250. <member name="F:NPOI.XSSF.UserModel.XSSFClientAnchor.cell2">
  42251. Ending anchor point
  42252. </member>
  42253. <member name="M:NPOI.XSSF.UserModel.XSSFClientAnchor.#ctor">
  42254. Creates a new client anchor and defaults all the anchor positions to 0.
  42255. </member>
  42256. <member name="M:NPOI.XSSF.UserModel.XSSFClientAnchor.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  42257. Creates a new client anchor and Sets the top-left and bottom-right
  42258. coordinates of the anchor.
  42259. @param dx1 the x coordinate within the first cell.
  42260. @param dy1 the y coordinate within the first cell.
  42261. @param dx2 the x coordinate within the second cell.
  42262. @param dy2 the y coordinate within the second cell.
  42263. @param col1 the column (0 based) of the first cell.
  42264. @param row1 the row (0 based) of the first cell.
  42265. @param col2 the column (0 based) of the second cell.
  42266. @param row2 the row (0 based) of the second cell.
  42267. </member>
  42268. <member name="M:NPOI.XSSF.UserModel.XSSFClientAnchor.#ctor(NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Marker,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Marker)">
  42269. Create XSSFClientAnchor from existing xml beans
  42270. @param cell1 starting anchor point
  42271. @param cell2 ending anchor point
  42272. </member>
  42273. <member name="P:NPOI.XSSF.UserModel.XSSFClientAnchor.From">
  42274. Return starting anchor point
  42275. @return starting anchor point
  42276. </member>
  42277. <member name="P:NPOI.XSSF.UserModel.XSSFClientAnchor.To">
  42278. Return ending anchor point
  42279. @return ending anchor point
  42280. </member>
  42281. <member name="T:NPOI.XSSF.UserModel.XSSFColor">
  42282. Represents a color in SpreadsheetML
  42283. </member>
  42284. <member name="M:NPOI.XSSF.UserModel.XSSFColor.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Color)">
  42285. Create an instance of XSSFColor from the supplied XML bean
  42286. </member>
  42287. <member name="M:NPOI.XSSF.UserModel.XSSFColor.#ctor">
  42288. Create an new instance of XSSFColor
  42289. </member>
  42290. <member name="P:NPOI.XSSF.UserModel.XSSFColor.IsAuto">
  42291. <summary>
  42292. A bool value indicating the ctColor is automatic and system ctColor dependent.
  42293. </summary>
  42294. </member>
  42295. <member name="P:NPOI.XSSF.UserModel.XSSFColor.HasAlpha">
  42296. A bool value indicating if the ctColor has a alpha or not
  42297. </member>
  42298. <member name="P:NPOI.XSSF.UserModel.XSSFColor.HasTint">
  42299. A bool value indicating if the ctColor has a tint or not
  42300. </member>
  42301. <member name="P:NPOI.XSSF.UserModel.XSSFColor.Indexed">
  42302. Indexed ctColor value. Only used for backwards compatibility. References a ctColor in indexedColors.
  42303. </member>
  42304. <member name="P:NPOI.XSSF.UserModel.XSSFColor.RGB">
  42305. Standard Red Green Blue ctColor value (RGB).
  42306. If there was an A (Alpha) value, it will be stripped.
  42307. </member>
  42308. <member name="P:NPOI.XSSF.UserModel.XSSFColor.ARGB">
  42309. Standard Alpha Red Green Blue ctColor value (ARGB).
  42310. </member>
  42311. <member name="M:NPOI.XSSF.UserModel.XSSFColor.GetARgb">
  42312. Standard Alpha Red Green Blue ctColor value (ARGB).
  42313. </member>
  42314. <member name="M:NPOI.XSSF.UserModel.XSSFColor.GetRgbWithTint">
  42315. Standard Red Green Blue ctColor value (RGB) with applied tint.
  42316. Alpha values are ignored.
  42317. </member>
  42318. <member name="M:NPOI.XSSF.UserModel.XSSFColor.SetRgb(System.Byte[])">
  42319. Standard Alpha Red Green Blue ctColor value (ARGB).
  42320. </member>
  42321. <member name="P:NPOI.XSSF.UserModel.XSSFColor.Theme">
  42322. Index into the clrScheme collection, referencing a particular sysClr or
  42323. srgbClr value expressed in the Theme part.
  42324. </member>
  42325. <member name="P:NPOI.XSSF.UserModel.XSSFColor.Tint">
  42326. Specifies the tint value applied to the ctColor.
  42327. <p>
  42328. If tint is supplied, then it is applied to the RGB value of the ctColor to determine the final
  42329. ctColor applied.
  42330. </p>
  42331. <p>
  42332. The tint value is stored as a double from -1.0 .. 1.0, where -1.0 means 100% darken and
  42333. 1.0 means 100% lighten. Also, 0.0 means no Change.
  42334. </p>
  42335. <p>
  42336. In loading the RGB value, it is Converted to HLS where HLS values are (0..HLSMAX), where
  42337. HLSMAX is currently 255.
  42338. </p>
  42339. Here are some examples of how to apply tint to ctColor:
  42340. <blockquote>
  42341. <pre>
  42342. If (tint &lt; 0)
  42343. Lum' = Lum * (1.0 + tint)
  42344. For example: Lum = 200; tint = -0.5; Darken 50%
  42345. Lum' = 200 * (0.5) =&gt; 100
  42346. For example: Lum = 200; tint = -1.0; Darken 100% (make black)
  42347. Lum' = 200 * (1.0-1.0) =&gt; 0
  42348. If (tint &gt; 0)
  42349. Lum' = Lum * (1.0-tint) + (HLSMAX - HLSMAX * (1.0-tint))
  42350. For example: Lum = 100; tint = 0.75; Lighten 75%
  42351. Lum' = 100 * (1-.75) + (HLSMAX - HLSMAX*(1-.75))
  42352. = 100 * .25 + (255 - 255 * .25)
  42353. = 25 + (255 - 63) = 25 + 192 = 217
  42354. For example: Lum = 100; tint = 1.0; Lighten 100% (make white)
  42355. Lum' = 100 * (1-1) + (HLSMAX - HLSMAX*(1-1))
  42356. = 100 * 0 + (255 - 255 * 0)
  42357. = 0 + (255 - 0) = 255
  42358. </pre>
  42359. </blockquote>
  42360. @return the tint value
  42361. </member>
  42362. <member name="M:NPOI.XSSF.UserModel.XSSFColor.GetCTColor">
  42363. Returns the underlying XML bean
  42364. @return the underlying XML bean
  42365. </member>
  42366. <member name="M:NPOI.XSSF.UserModel.XSSFColor.ToXSSFColor(NPOI.SS.UserModel.IColor)">
  42367. <summary>
  42368. Checked type cast <tt>color</tt> to an XSSFColor.
  42369. </summary>
  42370. <param name="color">the color to type cast</param>
  42371. <returns>the type casted color</returns>
  42372. <exception cref="T:System.ArgumentException">if color is null or is not an instance of XSSFColor</exception>
  42373. </member>
  42374. <member name="T:NPOI.XSSF.UserModel.XSSFColorScaleFormatting">
  42375. High level representation for Color Scale / Color Gradient Formatting
  42376. component of Conditional Formatting Settings
  42377. </member>
  42378. <member name="F:NPOI.XSSF.UserModel.XSSFComment._str">
  42379. cached reference to the string with the comment text
  42380. </member>
  42381. <member name="M:NPOI.XSSF.UserModel.XSSFComment.#ctor(NPOI.XSSF.Model.CommentsTable,NPOI.OpenXmlFormats.Spreadsheet.CT_Comment,NPOI.OpenXmlFormats.Vml.CT_Shape)">
  42382. Creates a new XSSFComment, associated with a given
  42383. low level comment object.
  42384. </member>
  42385. <member name="P:NPOI.XSSF.UserModel.XSSFComment.Author">
  42386. @return Name of the original comment author. Default value is blank.
  42387. </member>
  42388. <member name="P:NPOI.XSSF.UserModel.XSSFComment.Column">
  42389. @return the 0-based column of the cell that the comment is associated with.
  42390. </member>
  42391. <member name="P:NPOI.XSSF.UserModel.XSSFComment.Row">
  42392. @return the 0-based row index of the cell that the comment is associated with.
  42393. </member>
  42394. <member name="P:NPOI.XSSF.UserModel.XSSFComment.Visible">
  42395. @return whether the comment is visible
  42396. </member>
  42397. <member name="P:NPOI.XSSF.UserModel.XSSFComment.String">
  42398. @return the rich text string of the comment
  42399. </member>
  42400. <member name="M:NPOI.XSSF.UserModel.XSSFComment.SetString(System.String)">
  42401. Sets the rich text string used by this comment.
  42402. @param string the XSSFRichTextString used by this object.
  42403. </member>
  42404. <member name="M:NPOI.XSSF.UserModel.XSSFComment.GetCTComment">
  42405. @return the xml bean holding this comment's properties
  42406. </member>
  42407. <member name="T:NPOI.XSSF.UserModel.XSSFConditionalFormatting">
  42408. @author Yegor Kozlov
  42409. </member>
  42410. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormatting.GetFormattingRanges">
  42411. @return array of <tt>CellRangeAddress</tt>s. Never <code>null</code>
  42412. </member>
  42413. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormatting.SetRule(System.Int32,NPOI.SS.UserModel.IConditionalFormattingRule)">
  42414. Replaces an existing Conditional Formatting rule at position idx.
  42415. Excel allows to create up to 3 Conditional Formatting rules.
  42416. This method can be useful to modify existing Conditional Formatting rules.
  42417. @param idx position of the rule. Should be between 0 and 2.
  42418. @param cfRule - Conditional Formatting rule
  42419. </member>
  42420. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormatting.AddRule(NPOI.SS.UserModel.IConditionalFormattingRule)">
  42421. Add a Conditional Formatting rule.
  42422. Excel allows to create up to 3 Conditional Formatting rules.
  42423. @param cfRule - Conditional Formatting rule
  42424. </member>
  42425. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormatting.GetRule(System.Int32)">
  42426. @return the Conditional Formatting rule at position idx.
  42427. </member>
  42428. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormatting.NumberOfRules">
  42429. @return number of Conditional Formatting rules.
  42430. </member>
  42431. <member name="T:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule">
  42432. @author Yegor Kozlov
  42433. </member>
  42434. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.CreateBorderFormatting">
  42435. Create a new border formatting structure if it does not exist,
  42436. otherwise just return existing object.
  42437. @return - border formatting object, never returns <code>null</code>.
  42438. </member>
  42439. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.BorderFormatting">
  42440. @return - border formatting object if defined, <code>null</code> otherwise
  42441. </member>
  42442. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.CreateFontFormatting">
  42443. Create a new font formatting structure if it does not exist,
  42444. otherwise just return existing object.
  42445. @return - font formatting object, never returns <code>null</code>.
  42446. </member>
  42447. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.FontFormatting">
  42448. @return - font formatting object if defined, <code>null</code> otherwise
  42449. </member>
  42450. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.CreatePatternFormatting">
  42451. Create a new pattern formatting structure if it does not exist,
  42452. otherwise just return existing object.
  42453. @return - pattern formatting object, never returns <code>null</code>.
  42454. </member>
  42455. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.PatternFormatting">
  42456. @return - pattern formatting object if defined, <code>null</code> otherwise
  42457. </member>
  42458. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.ConditionType">
  42459. Type of conditional formatting rule.
  42460. </member>
  42461. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.ComparisonOperation">
  42462. The comparison function used when the type of conditional formatting is Set to
  42463. {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS}
  42464. <p>
  42465. MUST be a constant from {@link NPOI.ss.usermodel.ComparisonOperator}
  42466. </p>
  42467. @return the conditional format operator
  42468. </member>
  42469. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.Formula1">
  42470. The formula used to Evaluate the first operand for the conditional formatting rule.
  42471. <p>
  42472. If the condition type is {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS},
  42473. this field is the first operand of the comparison.
  42474. If type is {@link ConditionalFormattingRule#CONDITION_TYPE_FORMULA}, this formula is used
  42475. to determine if the conditional formatting is applied.
  42476. </p>
  42477. <p>
  42478. If comparison type is {@link ConditionalFormattingRule#CONDITION_TYPE_FORMULA} the formula MUST be a Boolean function
  42479. </p>
  42480. @return the first formula
  42481. </member>
  42482. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.Formula2">
  42483. The formula used to Evaluate the second operand of the comparison when
  42484. comparison type is {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS} and operator
  42485. is either {@link NPOI.ss.usermodel.ComparisonOperator#BETWEEN} or {@link NPOI.ss.usermodel.ComparisonOperator#NOT_BETWEEN}
  42486. @return the second formula
  42487. </member>
  42488. <member name="T:NPOI.XSSF.UserModel.XSSFConditionalFormattingThreshold">
  42489. High level representation for Icon / Multi-State / Databar /
  42490. Colour Scale change thresholds
  42491. </member>
  42492. <member name="T:NPOI.XSSF.UserModel.XSSFConnector">
  42493. A connection shape Drawing element. A connection shape is a line, etc.
  42494. that connects two other shapes in this Drawing.
  42495. @author Yegor Kozlov
  42496. </member>
  42497. <member name="M:NPOI.XSSF.UserModel.XSSFConnector.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Connector)">
  42498. Construct a new XSSFConnector object.
  42499. @param Drawing the XSSFDrawing that owns this shape
  42500. @param ctShape the shape bean that holds all the shape properties
  42501. </member>
  42502. <member name="M:NPOI.XSSF.UserModel.XSSFConnector.Prototype">
  42503. Initialize default structure of a new auto-shape
  42504. </member>
  42505. <member name="P:NPOI.XSSF.UserModel.XSSFConnector.ShapeType">
  42506. Gets the shape type, one of the constants defined in {@link NPOI.ss.usermodel.ShapeTypes}.
  42507. @return the shape type
  42508. @see NPOI.ss.usermodel.ShapeTypes
  42509. </member>
  42510. <member name="M:NPOI.XSSF.UserModel.XSSFCreationHelper.CreateRichTextString(System.String)">
  42511. Creates a new XSSFRichTextString for you.
  42512. </member>
  42513. <member name="M:NPOI.XSSF.UserModel.XSSFCreationHelper.CreateFormulaEvaluator">
  42514. Creates a XSSFFormulaEvaluator, the object that Evaluates formula cells.
  42515. @return a XSSFFormulaEvaluator instance
  42516. </member>
  42517. <member name="M:NPOI.XSSF.UserModel.XSSFCreationHelper.CreateClientAnchor">
  42518. Creates a XSSFClientAnchor. Use this object to position Drawing object in
  42519. a sheet
  42520. @return a XSSFClientAnchor instance
  42521. @see NPOI.ss.usermodel.Drawing
  42522. </member>
  42523. <member name="T:NPOI.XSSF.UserModel.XSSFDataBarFormatting">
  42524. High level representation for DataBar / Data Bar Formatting
  42525. component of Conditional Formatting Settings
  42526. </member>
  42527. <member name="T:NPOI.XSSF.UserModel.XSSFDataFormat">
  42528. Handles data formats for XSSF.
  42529. Per Microsoft Excel 2007+ format limitations:
  42530. Workbooks support between 200 and 250 "number formats"
  42531. (POI calls them "data formats") So short or even byte
  42532. would be acceptable data types to use for referring to
  42533. data format indices.
  42534. https://support.office.com/en-us/article/excel-specifications-and-limits-1672b34d-7043-467e-8e27-269d656771c3
  42535. </member>
  42536. <member name="M:NPOI.XSSF.UserModel.XSSFDataFormat.GetFormat(System.String)">
  42537. Get the format index that matches the given format
  42538. string, creating a new format entry if required.
  42539. Aliases text to the proper format as required.
  42540. @param format string matching a built in format
  42541. @return index of format.
  42542. </member>
  42543. <member name="M:NPOI.XSSF.UserModel.XSSFDataFormat.GetFormat(System.Int16)">
  42544. Get the format string that matches the given format index
  42545. @param index of a format
  42546. @return string represented at index of format or null if there is not a format at that index
  42547. </member>
  42548. <member name="M:NPOI.XSSF.UserModel.XSSFDataFormat.GetFormat(System.Int32)">
  42549. get the format string that matches the given format index
  42550. @param index of a format
  42551. @return string represented at index of format or null if there is not a format at that index
  42552. </member>
  42553. <member name="M:NPOI.XSSF.UserModel.XSSFDataFormat.PutFormat(System.Int16,System.String)">
  42554. Add a number format with a specific ID into the number format style table.
  42555. If a format with the same ID already exists, overwrite the format code
  42556. with <code>fmt</code>
  42557. This may be used to override built-in number formats.
  42558. @param index the number format ID
  42559. @param format the number format code
  42560. </member>
  42561. <member name="T:NPOI.XSSF.UserModel.XSSFDataValidation">
  42562. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  42563. </member>
  42564. <member name="T:NPOI.XSSF.UserModel.XSSFDataValidationConstraint">
  42565. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  42566. </member>
  42567. <member name="F:NPOI.XSSF.UserModel.XSSFDataValidationConstraint.LIST_SEPARATOR">
  42568. Excel validation constraints with static lists are delimited with optional whitespace and the Windows List Separator,
  42569. which is typically comma, but can be changed by users. POI will just assume comma.
  42570. </member>
  42571. <member name="M:NPOI.XSSF.UserModel.XSSFDataValidationConstraint.#ctor(System.Int32,System.Int32,System.String,System.String)">
  42572. <summary>
  42573. This is the constructor called using the OOXML raw data. Excel overloads formula1 to also encode explicit value lists,
  42574. so this constructor has to check for and parse that syntax.
  42575. </summary>
  42576. <param name="validationType"></param>
  42577. <param name="operator1"></param>
  42578. <param name="formula1">Overloaded: formula1 or list of explicit values</param>
  42579. <param name="formula2">formula1 is a list of explicit values, this is ignored: use <code>null</code></param>
  42580. </member>
  42581. <member name="T:NPOI.XSSF.UserModel.XSSFDataValidationHelper">
  42582. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  42583. </member>
  42584. <member name="T:NPOI.XSSF.UserModel.XSSFDrawing">
  42585. Represents a SpreadsheetML Drawing
  42586. @author Yegor Kozlov
  42587. </member>
  42588. <member name="F:NPOI.XSSF.UserModel.XSSFDrawing.drawing">
  42589. Root element of the SpreadsheetML Drawing part
  42590. </member>
  42591. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.#ctor">
  42592. Create a new SpreadsheetML Drawing
  42593. @see NPOI.xssf.usermodel.XSSFSheet#CreateDrawingPatriarch()
  42594. </member>
  42595. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  42596. Construct a SpreadsheetML Drawing from a namespace part
  42597. @param part the namespace part holding the Drawing data,
  42598. the content type must be <code>application/vnd.openxmlformats-officedocument.Drawing+xml</code>
  42599. @param rel the namespace relationship holding this Drawing,
  42600. the relationship type must be http://schemas.openxmlformats.org/officeDocument/2006/relationships/drawing
  42601. </member>
  42602. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.NewDrawing">
  42603. Construct a new CT_Drawing bean. By default, it's just an empty placeholder for Drawing objects
  42604. @return a new CT_Drawing bean
  42605. </member>
  42606. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.GetCTDrawing">
  42607. Return the underlying CT_Drawing bean, the root element of the SpreadsheetML Drawing part.
  42608. @return the underlying CT_Drawing bean
  42609. </member>
  42610. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateTextbox(NPOI.SS.UserModel.IClientAnchor)">
  42611. Constructs a textbox under the Drawing.
  42612. @param anchor the client anchor describes how this group is attached
  42613. to the sheet.
  42614. @return the newly Created textbox.
  42615. </member>
  42616. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreatePicture(NPOI.XSSF.UserModel.XSSFClientAnchor,System.Int32)">
  42617. Creates a picture.
  42618. @param anchor the client anchor describes how this picture is attached to the sheet.
  42619. @param pictureIndex the index of the picture in the workbook collection of pictures,
  42620. {@link NPOI.xssf.usermodel.XSSFWorkbook#getAllPictures()} .
  42621. @return the newly Created picture shape.
  42622. </member>
  42623. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateChart(NPOI.SS.UserModel.IClientAnchor)">
  42624. <summary>
  42625. Creates a chart.
  42626. </summary>
  42627. <param name="anchor">the client anchor describes how this chart is attached to</param>
  42628. <returns>the newly created chart</returns>
  42629. </member>
  42630. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.AddPictureReference(System.Int32)">
  42631. Add the indexed picture to this Drawing relations
  42632. @param pictureIndex the index of the picture in the workbook collection of pictures,
  42633. {@link NPOI.xssf.usermodel.XSSFWorkbook#getAllPictures()} .
  42634. </member>
  42635. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateSimpleShape(NPOI.XSSF.UserModel.XSSFClientAnchor)">
  42636. Creates a simple shape. This includes such shapes as lines, rectangles,
  42637. and ovals.
  42638. @param anchor the client anchor describes how this group is attached
  42639. to the sheet.
  42640. @return the newly Created shape.
  42641. </member>
  42642. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateConnector(NPOI.XSSF.UserModel.XSSFClientAnchor)">
  42643. Creates a simple shape. This includes such shapes as lines, rectangles,
  42644. and ovals.
  42645. @param anchor the client anchor describes how this group is attached
  42646. to the sheet.
  42647. @return the newly Created shape.
  42648. </member>
  42649. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateGroup(NPOI.XSSF.UserModel.XSSFClientAnchor)">
  42650. Creates a simple shape. This includes such shapes as lines, rectangles,
  42651. and ovals.
  42652. @param anchor the client anchor describes how this group is attached
  42653. to the sheet.
  42654. @return the newly Created shape.
  42655. </member>
  42656. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateCellComment(NPOI.SS.UserModel.IClientAnchor)">
  42657. Creates a comment.
  42658. @param anchor the client anchor describes how this comment is attached
  42659. to the sheet.
  42660. @return the newly Created comment.
  42661. </member>
  42662. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateGraphicFrame(NPOI.XSSF.UserModel.XSSFClientAnchor)">
  42663. Creates a new graphic frame.
  42664. @param anchor the client anchor describes how this frame is attached
  42665. to the sheet
  42666. @return the newly Created graphic frame
  42667. </member>
  42668. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.GetCharts">
  42669. Returns all charts in this Drawing.
  42670. </member>
  42671. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateTwoCellAnchor(NPOI.SS.UserModel.IClientAnchor)">
  42672. Create and Initialize a CT_TwoCellAnchor that anchors a shape against top-left and bottom-right cells.
  42673. @return a new CT_TwoCellAnchor
  42674. </member>
  42675. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.GetShapes">
  42676. @return list of shapes in this drawing
  42677. </member>
  42678. <member name="T:NPOI.XSSF.UserModel.XSSFEvaluationCell">
  42679. XSSF wrapper for a cell under Evaluation
  42680. @author Josh Micich
  42681. </member>
  42682. <member name="T:NPOI.XSSF.UserModel.XSSFEvaluationSheet">
  42683. XSSF wrapper for a sheet under Evaluation
  42684. @author Josh Micich
  42685. </member>
  42686. <member name="T:NPOI.XSSF.UserModel.XSSFEvaluationWorkbook">
  42687. Internal POI use only
  42688. @author Josh Micich
  42689. </member>
  42690. <member name="T:NPOI.XSSF.UserModel.XSSFEvenFooter">
  42691. Even page footer value. Corresponds to even printed pages.
  42692. Even page(s) in the sheet may not be printed, for example, if the print area is specified to be
  42693. a range such that it falls outside an even page's scope.
  42694. If no even footer is specified, then the odd footer's value is assumed for even page footers.
  42695. </member>
  42696. <member name="M:NPOI.XSSF.UserModel.XSSFEvenFooter.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  42697. Create an instance of XSSFEvenFooter from the supplied XML bean
  42698. @see XSSFSheet#GetEvenFooter()
  42699. @param headerFooter
  42700. </member>
  42701. <member name="P:NPOI.XSSF.UserModel.XSSFEvenFooter.Text">
  42702. Get the content text representing the footer
  42703. @return text
  42704. </member>
  42705. <member name="T:NPOI.XSSF.UserModel.XSSFEvenHeader">
  42706. <p>
  42707. Even page header value. Corresponds to even printed pages.
  42708. Even page(s) in the sheet may not be printed, for example, if the print area is specified to be
  42709. a range such that it falls outside an even page's scope.
  42710. If no even header is specified, then odd header value is assumed for even page headers.
  42711. </p>
  42712. </member>
  42713. <member name="M:NPOI.XSSF.UserModel.XSSFEvenHeader.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  42714. Create an instance of XSSFEvenHeader from the supplied XML bean
  42715. @see XSSFSheet#GetEvenHeader()
  42716. @param headerFooter
  42717. </member>
  42718. <member name="P:NPOI.XSSF.UserModel.XSSFEvenHeader.Text">
  42719. Get the content text representing this header
  42720. @return text
  42721. </member>
  42722. <member name="T:NPOI.XSSF.UserModel.XSSFFactory">
  42723. Instantiates sub-classes of POIXMLDocumentPart depending on their relationship type
  42724. @author Yegor Kozlov
  42725. </member>
  42726. <member name="M:NPOI.XSSF.UserModel.XSSFFactory.GetDescriptor(System.String)">
  42727. @since POI 3.14-Beta1
  42728. </member>
  42729. <member name="M:NPOI.XSSF.UserModel.XSSFFactory.CreateDocumentPart(System.Type,System.Type[],System.Object[])">
  42730. @since POI 3.14-Beta1
  42731. </member>
  42732. <member name="T:NPOI.XSSF.UserModel.XSSFFirstFooter">
  42733. First page footer content. Corresponds to first printed page.
  42734. The first logical page in the sheet may not be printed, for example, if the print area is specified to
  42735. be a range such that it falls outside the first page's scope.
  42736. </member>
  42737. <member name="M:NPOI.XSSF.UserModel.XSSFFirstFooter.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  42738. Create an instance of XSSFFirstFooter from the supplied XML bean
  42739. @see XSSFSheet#getFirstFooter()
  42740. @param headerFooter
  42741. </member>
  42742. <member name="P:NPOI.XSSF.UserModel.XSSFFirstFooter.Text">
  42743. Get the content text representing the footer
  42744. @return text
  42745. </member>
  42746. <member name="T:NPOI.XSSF.UserModel.XSSFFirstHeader">
  42747. First page header content. Corresponds to first printed page.
  42748. The first logical page in the sheet may not be printed, for example, if the print area is specified to
  42749. be a range such that it falls outside the first page's scope.
  42750. </member>
  42751. <member name="M:NPOI.XSSF.UserModel.XSSFFirstHeader.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  42752. Create an instance of XSSFFirstHeader from the supplied XML bean
  42753. @see XSSFSheet#getFirstHeader()
  42754. @param headerFooter
  42755. </member>
  42756. <member name="P:NPOI.XSSF.UserModel.XSSFFirstHeader.Text">
  42757. Get the content text representing this header
  42758. @return text
  42759. </member>
  42760. <member name="T:NPOI.XSSF.UserModel.XSSFFont">
  42761. Represents a font used in a workbook.
  42762. @author Gisella Bronzetti
  42763. </member>
  42764. <member name="F:NPOI.XSSF.UserModel.XSSFFont.DEFAULT_FONT_NAME">
  42765. By default, Microsoft Office Excel 2007 uses the Calibry font in font size 11
  42766. </member>
  42767. <member name="F:NPOI.XSSF.UserModel.XSSFFont.DEFAULT_FONT_SIZE">
  42768. By default, Microsoft Office Excel 2007 uses the Calibry font in font size 11
  42769. </member>
  42770. <member name="F:NPOI.XSSF.UserModel.XSSFFont.DEFAULT_FONT_COLOR">
  42771. Default font color is black
  42772. @see NPOI.SS.usermodel.IndexedColors#BLACK
  42773. </member>
  42774. <member name="M:NPOI.XSSF.UserModel.XSSFFont.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Font)">
  42775. Create a new XSSFFont
  42776. @param font the underlying CT_Font bean
  42777. </member>
  42778. <member name="M:NPOI.XSSF.UserModel.XSSFFont.#ctor">
  42779. Create a new XSSFont. This method is protected to be used only by XSSFWorkbook
  42780. </member>
  42781. <member name="M:NPOI.XSSF.UserModel.XSSFFont.GetCTFont">
  42782. get the underlying CT_Font font
  42783. </member>
  42784. <member name="P:NPOI.XSSF.UserModel.XSSFFont.IsBold">
  42785. get a bool value for the boldness to use.
  42786. @return bool - bold
  42787. </member>
  42788. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Charset">
  42789. get character-set to use.
  42790. @return int - character-set (0-255)
  42791. @see NPOI.SS.usermodel.FontCharset
  42792. </member>
  42793. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Color">
  42794. get the indexed color value for the font
  42795. References a color defined in IndexedColors.
  42796. @return short - indexed color to use
  42797. @see IndexedColors
  42798. </member>
  42799. <member name="M:NPOI.XSSF.UserModel.XSSFFont.GetXSSFColor">
  42800. get the color value for the font
  42801. References a color defined as Standard Alpha Red Green Blue color value (ARGB).
  42802. @return XSSFColor - rgb color to use
  42803. </member>
  42804. <member name="M:NPOI.XSSF.UserModel.XSSFFont.GetThemeColor">
  42805. get the color value for the font
  42806. References a color defined in theme.
  42807. @return short - theme defined to use
  42808. </member>
  42809. <member name="P:NPOI.XSSF.UserModel.XSSFFont.FontHeight">
  42810. <summary>
  42811. Get the font height in unit's of 1/20th of a point.
  42812. </summary>
  42813. </member>
  42814. <member name="P:NPOI.XSSF.UserModel.XSSFFont.FontHeightInPoints">
  42815. <summary>
  42816. Get the font height in points.
  42817. </summary>
  42818. </member>
  42819. <member name="P:NPOI.XSSF.UserModel.XSSFFont.FontName">
  42820. get the name of the font (i.e. Arial)
  42821. @return String - a string representing the name of the font to use
  42822. </member>
  42823. <member name="P:NPOI.XSSF.UserModel.XSSFFont.IsItalic">
  42824. get a bool value that specify whether to use italics or not
  42825. @return bool - value for italic
  42826. </member>
  42827. <member name="P:NPOI.XSSF.UserModel.XSSFFont.IsStrikeout">
  42828. get a bool value that specify whether to use a strikeout horizontal line through the text or not
  42829. @return bool - value for strikeout
  42830. </member>
  42831. <member name="P:NPOI.XSSF.UserModel.XSSFFont.TypeOffset">
  42832. get normal,super or subscript.
  42833. @return short - offset type to use (none,super,sub)
  42834. @see Font#SS_NONE
  42835. @see Font#SS_SUPER
  42836. @see Font#SS_SUB
  42837. </member>
  42838. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Underline">
  42839. get type of text underlining to use
  42840. @return byte - underlining type
  42841. @see NPOI.SS.usermodel.FontUnderline
  42842. </member>
  42843. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Boldweight">
  42844. get the boldness to use
  42845. @return boldweight
  42846. @see #BOLDWEIGHT_NORMAL
  42847. @see #BOLDWEIGHT_BOLD
  42848. </member>
  42849. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetCharSet(System.Byte)">
  42850. set character-set to use.
  42851. @param charset - charset
  42852. @see FontCharset
  42853. </member>
  42854. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetCharSet(System.Int32)">
  42855. set character-set to use.
  42856. @param charset - charset
  42857. @see FontCharset
  42858. </member>
  42859. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetCharSet(NPOI.SS.UserModel.FontCharset)">
  42860. set character-set to use.
  42861. @param charSet
  42862. </member>
  42863. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetColor(NPOI.XSSF.UserModel.XSSFColor)">
  42864. set the color for the font in Standard Alpha Red Green Blue color value
  42865. @param color - color to use
  42866. </member>
  42867. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetThemeColor(System.Int16)">
  42868. set the theme color for the font to use
  42869. @param theme - theme color to use
  42870. </member>
  42871. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetUnderline(NPOI.SS.UserModel.FontUnderlineType)">
  42872. set an enumeration representing the style of underlining that is used.
  42873. The none style is equivalent to not using underlining at all.
  42874. The possible values for this attribute are defined by the FontUnderline
  42875. @param underline - FontUnderline enum value
  42876. </member>
  42877. <member name="M:NPOI.XSSF.UserModel.XSSFFont.RegisterTo(NPOI.XSSF.Model.StylesTable)">
  42878. **
  42879. </member>
  42880. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetThemesTable(NPOI.XSSF.Model.ThemesTable)">
  42881. Records the Themes Table that is associated with
  42882. the current font, used when looking up theme
  42883. based colours and properties.
  42884. </member>
  42885. <member name="M:NPOI.XSSF.UserModel.XSSFFont.GetScheme">
  42886. get the font scheme property.
  42887. is used only in StylesTable to create the default instance of font
  42888. @return FontScheme
  42889. @see NPOI.XSSF.model.StylesTable#CreateDefaultFont()
  42890. </member>
  42891. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetScheme(NPOI.SS.UserModel.FontScheme)">
  42892. set font scheme property
  42893. @param scheme - FontScheme enum value
  42894. @see FontScheme
  42895. </member>
  42896. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Family">
  42897. get the font family to use.
  42898. @return the font family to use
  42899. @see NPOI.SS.usermodel.FontFamily
  42900. </member>
  42901. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetFamily(NPOI.SS.UserModel.FontFamily)">
  42902. set an enumeration representing the font family this font belongs to.
  42903. A font family is a set of fonts having common stroke width and serif characteristics.
  42904. @param family font family
  42905. @link #SetFamily(int value)
  42906. </member>
  42907. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Index">
  42908. get the index within the XSSFWorkbook (sequence within the collection of Font objects)
  42909. @return unique index number of the underlying record this Font represents (probably you don't care
  42910. unless you're comparing which one is which)
  42911. </member>
  42912. <member name="T:NPOI.XSSF.UserModel.XSSFFontFormatting">
  42913. @author Yegor Kozlov
  42914. </member>
  42915. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.EscapementType">
  42916. Get the type of super or subscript for the font
  42917. @return super or subscript option
  42918. @see #SS_NONE
  42919. @see #SS_SUPER
  42920. @see #SS_SUB
  42921. </member>
  42922. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.FontColorIndex">
  42923. @return font color index
  42924. </member>
  42925. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.FontHeight">
  42926. Gets the height of the font in 1/20th point units
  42927. @return fontheight (in points/20); or -1 if not modified
  42928. </member>
  42929. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.UnderlineType">
  42930. Get the type of underlining for the font
  42931. @return font underlining type
  42932. @see #U_NONE
  42933. @see #U_SINGLE
  42934. @see #U_DOUBLE
  42935. @see #U_SINGLE_ACCOUNTING
  42936. @see #U_DOUBLE_ACCOUNTING
  42937. </member>
  42938. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.IsBold">
  42939. Get whether the font weight is Set to bold or not
  42940. @return bold - whether the font is bold or not
  42941. </member>
  42942. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.IsItalic">
  42943. @return true if font style was Set to <i>italic</i>
  42944. </member>
  42945. <member name="M:NPOI.XSSF.UserModel.XSSFFontFormatting.SetFontStyle(System.Boolean,System.Boolean)">
  42946. Set font style options.
  42947. @param italic - if true, Set posture style to italic, otherwise to normal
  42948. @param bold if true, Set font weight to bold, otherwise to normal
  42949. </member>
  42950. <member name="M:NPOI.XSSF.UserModel.XSSFFontFormatting.ResetFontStyle">
  42951. Set font style options to default values (non-italic, non-bold)
  42952. </member>
  42953. <member name="T:NPOI.XSSF.UserModel.XSSFFormulaEvaluator">
  42954. Evaluates formula cells.<p/>
  42955. For performance reasons, this class keeps a cache of all previously calculated intermediate
  42956. cell values. Be sure to call {@link #ClearAllCachedResultValues()} if any workbook cells are Changed between
  42957. calls to Evaluate~ methods on this class.
  42958. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  42959. @author Josh Micich
  42960. </member>
  42961. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.Create(NPOI.XSSF.UserModel.XSSFWorkbook,NPOI.SS.Formula.IStabilityClassifier,NPOI.SS.Formula.UDF.UDFFinder)">
  42962. @param stabilityClassifier used to optimise caching performance. Pass <code>null</code>
  42963. for the (conservative) assumption that any cell may have its defInition Changed After
  42964. Evaluation begins.
  42965. @param udfFinder pass <code>null</code> for default (AnalysisToolPak only)
  42966. </member>
  42967. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.EvaluateAllFormulaCells(NPOI.XSSF.UserModel.XSSFWorkbook)">
  42968. Loops over all cells in all sheets of the supplied
  42969. workbook.
  42970. For cells that contain formulas, their formulas are
  42971. Evaluated, and the results are saved. These cells
  42972. remain as formula cells.
  42973. For cells that do not contain formulas, no Changes
  42974. are made.
  42975. This is a helpful wrapper around looping over all
  42976. cells, and calling EvaluateFormulaCell on each one.
  42977. </member>
  42978. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.EvaluateAll">
  42979. Loops over all cells in all sheets of the supplied
  42980. workbook.
  42981. For cells that contain formulas, their formulas are
  42982. Evaluated, and the results are saved. These cells
  42983. remain as formula cells.
  42984. For cells that do not contain formulas, no Changes
  42985. are made.
  42986. This is a helpful wrapper around looping over all
  42987. cells, and calling EvaluateFormulaCell on each one.
  42988. </member>
  42989. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.ToEvaluationCell(NPOI.SS.UserModel.ICell)">
  42990. Turns a XSSFCell into a XSSFEvaluationCell
  42991. </member>
  42992. <member name="T:NPOI.XSSF.UserModel.XSSFGraphicFrame">
  42993. Represents DrawingML GraphicalObjectFrame.
  42994. @author Roman Kashitsyn
  42995. </member>
  42996. <member name="M:NPOI.XSSF.UserModel.XSSFGraphicFrame.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_GraphicalObjectFrame)">
  42997. Construct a new XSSFGraphicFrame object.
  42998. @param Drawing the XSSFDrawing that owns this frame
  42999. @param ctGraphicFrame the XML bean that stores this frame content
  43000. </member>
  43001. <member name="M:NPOI.XSSF.UserModel.XSSFGraphicFrame.Prototype">
  43002. Initialize default structure of a new graphic frame
  43003. </member>
  43004. <member name="M:NPOI.XSSF.UserModel.XSSFGraphicFrame.SetMacro(System.String)">
  43005. Sets the frame macro.
  43006. </member>
  43007. <member name="P:NPOI.XSSF.UserModel.XSSFGraphicFrame.Name">
  43008. Returns the frame name.
  43009. @return name of the frame
  43010. </member>
  43011. <member name="P:NPOI.XSSF.UserModel.XSSFGraphicFrame.Anchor">
  43012. Returns the frame anchor.
  43013. @return the anchor this frame is attached to
  43014. </member>
  43015. <member name="M:NPOI.XSSF.UserModel.XSSFGraphicFrame.SetChart(NPOI.XSSF.UserModel.XSSFChart,System.String)">
  43016. Assign a DrawingML chart to the graphic frame.
  43017. </member>
  43018. <member name="P:NPOI.XSSF.UserModel.XSSFGraphicFrame.Id">
  43019. Gets the frame id.
  43020. </member>
  43021. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFGraphicFrame.AppendChartElement(NPOI.OpenXmlFormats.Dml.CT_GraphicalObjectData,System.String)" -->
  43022. <member name="T:NPOI.XSSF.UserModel.XSSFHyperlink">
  43023. XSSF Implementation of a Hyperlink.
  43024. Note - unlike with HSSF, many kinds of hyperlink
  43025. are largely stored as relations of the sheet
  43026. </member>
  43027. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.#ctor(NPOI.SS.UserModel.HyperlinkType)">
  43028. Create a new XSSFHyperlink. This method is protected to be used only by XSSFCreationHelper
  43029. @param type - the type of hyperlink to create
  43030. </member>
  43031. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Hyperlink,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  43032. Create a XSSFHyperlink amd Initialize it from the supplied CTHyperlink bean and namespace relationship
  43033. @param ctHyperlink the xml bean Containing xml properties
  43034. @param hyperlinkRel the relationship in the underlying OPC namespace which stores the actual link's Address
  43035. </member>
  43036. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.#ctor(NPOI.SS.UserModel.IHyperlink)">
  43037. Create a new XSSFHyperlink. This method is for Internal use only.
  43038. XSSFHyperlinks can be created by XSSFCreationHelper.
  43039. @param type - the type of hyperlink to create, see {@link Hyperlink}
  43040. </member>
  43041. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.GetCTHyperlink">
  43042. @return the underlying CTHyperlink object
  43043. </member>
  43044. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.NeedsRelationToo">
  43045. Do we need to a relation too, to represent
  43046. this hyperlink?
  43047. </member>
  43048. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.GenerateRelationIfNeeded(NPOI.OpenXml4Net.OPC.PackagePart)">
  43049. Generates the relation if required
  43050. </member>
  43051. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Type">
  43052. Return the type of this hyperlink
  43053. @return the type of this hyperlink
  43054. </member>
  43055. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.CellRef">
  43056. Get the reference of the cell this applies to,
  43057. es A55
  43058. </member>
  43059. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Address">
  43060. Hyperlink Address. Depending on the hyperlink type it can be URL, e-mail, path to a file
  43061. @return the Address of this hyperlink
  43062. </member>
  43063. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Label">
  43064. Return text label for this hyperlink
  43065. @return text to display
  43066. </member>
  43067. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Location">
  43068. Location within target. If target is a workbook (or this workbook) this shall refer to a
  43069. sheet and cell or a defined name. Can also be an HTML anchor if target is HTML file.
  43070. @return location
  43071. </member>
  43072. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.SetCellReference(System.String)">
  43073. Assigns this hyperlink to the given cell reference
  43074. </member>
  43075. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.FirstColumn">
  43076. Return the column of the first cell that Contains the hyperlink
  43077. @return the 0-based column of the first cell that Contains the hyperlink
  43078. </member>
  43079. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.LastColumn">
  43080. Return the column of the last cell that Contains the hyperlink
  43081. For XSSF, a Hyperlink may only reference one cell
  43082. @return the 0-based column of the last cell that Contains the hyperlink
  43083. </member>
  43084. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.FirstRow">
  43085. Return the row of the first cell that Contains the hyperlink
  43086. @return the 0-based row of the cell that Contains the hyperlink
  43087. </member>
  43088. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.LastRow">
  43089. Return the row of the last cell that Contains the hyperlink
  43090. For XSSF, a Hyperlink may only reference one cell
  43091. @return the 0-based row of the last cell that Contains the hyperlink
  43092. </member>
  43093. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Tooltip">
  43094. <summary>
  43095. get or set additional text to help the user understand more about the hyperlink
  43096. </summary>
  43097. </member>
  43098. <member name="T:NPOI.XSSF.UserModel.XSSFIconMultiStateFormatting">
  43099. High level representation for Icon / Multi-State Formatting
  43100. component of Conditional Formatting Settings
  43101. </member>
  43102. <member name="M:NPOI.XSSF.UserModel.XSSFLineBreak.SetText(System.String)">
  43103. Always . You cannot change text of a line break.
  43104. </member>
  43105. <member name="T:NPOI.XSSF.UserModel.XSSFMap">
  43106. This class : the Map element (Open Office XML Part 4:
  43107. chapter 3.16.2)
  43108. This element Contains all of the properties related to the XML map,
  43109. and the behaviors expected during data refresh operations.
  43110. @author Roberto Manicardi
  43111. </member>
  43112. <member name="M:NPOI.XSSF.UserModel.XSSFMap.GetRelatedSingleXMLCell">
  43113. @return the list of Single Xml Cells that provide a map rule to this mapping.
  43114. </member>
  43115. <member name="M:NPOI.XSSF.UserModel.XSSFMap.GetRelatedTables">
  43116. @return the list of all Tables that provide a map rule to this mapping
  43117. </member>
  43118. <member name="T:NPOI.XSSF.UserModel.XSSFName">
  43119. Represents a defined named range in a SpreadsheetML workbook.
  43120. <p>
  43121. Defined names are descriptive text that is used to represents a cell, range of cells, formula, or constant value.
  43122. Use easy-to-understand names, such as Products, to refer to hard to understand ranges, such as <code>Sales!C20:C30</code>.
  43123. </p>
  43124. Example:
  43125. <pre><blockquote>
  43126. XSSFWorkbook wb = new XSSFWorkbook();
  43127. XSSFSheet sh = wb.CreateSheet("Sheet1");
  43128. //applies to the entire workbook
  43129. XSSFName name1 = wb.CreateName();
  43130. name1.SetNameName("FMLA");
  43131. name1.SetRefersToFormula("Sheet1!$B$3");
  43132. //applies to Sheet1
  43133. XSSFName name2 = wb.CreateName();
  43134. name2.SetNameName("SheetLevelName");
  43135. name2.SetComment("This name is scoped to Sheet1");
  43136. name2.SetLocalSheetId(0);
  43137. name2.SetRefersToFormula("Sheet1!$B$3");
  43138. </blockquote></pre>
  43139. @author Nick Burch
  43140. @author Yegor Kozlov
  43141. </member>
  43142. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_PRINT_AREA">
  43143. A built-in defined name that specifies the workbook's print area
  43144. </member>
  43145. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_PRINT_TITLE">
  43146. A built-in defined name that specifies the row(s) or column(s) to repeat
  43147. at the top of each printed page.
  43148. </member>
  43149. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_CRITERIA">
  43150. A built-in defined name that refers to a range Containing the criteria values
  43151. to be used in Applying an advanced filter to a range of data
  43152. </member>
  43153. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_EXTRACT">
  43154. this defined name refers to the range Containing the filtered
  43155. output values resulting from Applying an advanced filter criteria to a source
  43156. range
  43157. </member>
  43158. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_FILTER_DB">
  43159. ?an be one of the following
  43160. 1 this defined name refers to a range to which an advanced filter has been
  43161. applied. This represents the source data range, unfiltered.
  43162. 2 This defined name refers to a range to which an AutoFilter has been
  43163. applied
  43164. </member>
  43165. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_CONSOLIDATE_AREA">
  43166. A built-in defined name that refers to a consolidation area
  43167. </member>
  43168. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_DATABASE">
  43169. A built-in defined name that specified that the range specified is from a database data source
  43170. </member>
  43171. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_SHEET_TITLE">
  43172. A built-in defined name that refers to a sheet title.
  43173. </member>
  43174. <member name="M:NPOI.XSSF.UserModel.XSSFName.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_DefinedName,NPOI.XSSF.UserModel.XSSFWorkbook)">
  43175. Creates an XSSFName object - called internally by XSSFWorkbook.
  43176. @param name - the xml bean that holds data represenring this defined name.
  43177. @param workbook - the workbook object associated with the name
  43178. @see NPOI.XSSF.usermodel.XSSFWorkbook#CreateName()
  43179. </member>
  43180. <member name="M:NPOI.XSSF.UserModel.XSSFName.GetCTName">
  43181. Returns the underlying named range object
  43182. </member>
  43183. <member name="P:NPOI.XSSF.UserModel.XSSFName.NameName">
  43184. Returns the name that will appear in the user interface for the defined name.
  43185. @return text name of this defined name
  43186. </member>
  43187. <member name="P:NPOI.XSSF.UserModel.XSSFName.SheetIndex">
  43188. Returns the sheet index this name applies to.
  43189. @return the sheet index this name applies to, -1 if this name applies to the entire workbook
  43190. </member>
  43191. <member name="P:NPOI.XSSF.UserModel.XSSFName.Function">
  43192. Indicates that the defined name refers to a user-defined function.
  43193. This attribute is used when there is an Add-in or other code project associated with the file.
  43194. @return <code>true</code> indicates the name refers to a function.
  43195. </member>
  43196. <member name="P:NPOI.XSSF.UserModel.XSSFName.FunctionGroupId">
  43197. Returns the function group index if the defined name refers to a function. The function
  43198. group defines the general category for the function. This attribute is used when there is
  43199. an Add-in or other code project associated with the file.
  43200. @return the function group index that defines the general category for the function
  43201. </member>
  43202. <member name="P:NPOI.XSSF.UserModel.XSSFName.SheetName">
  43203. Get the sheets name which this named range is referenced to
  43204. @return sheet name, which this named range referred to.
  43205. Empty string if the referenced sheet name weas not found.
  43206. </member>
  43207. <member name="P:NPOI.XSSF.UserModel.XSSFName.IsFunctionName">
  43208. Is the name refers to a user-defined function ?
  43209. @return <code>true</code> if this name refers to a user-defined function
  43210. </member>
  43211. <member name="P:NPOI.XSSF.UserModel.XSSFName.Comment">
  43212. Returns the comment the user provided when the name was Created.
  43213. @return the user comment for this named range
  43214. </member>
  43215. <member name="M:NPOI.XSSF.UserModel.XSSFName.Equals(System.Object)">
  43216. Compares this name to the specified object.
  43217. The result is <code>true</code> if the argument is XSSFName and the
  43218. underlying CTDefinedName bean Equals to the CTDefinedName representing this name
  43219. @param o the object to compare this <code>XSSFName</code> against.
  43220. @return <code>true</code> if the <code>XSSFName </code>are Equal;
  43221. <code>false</code> otherwise.
  43222. </member>
  43223. <member name="T:NPOI.XSSF.UserModel.XSSFOddFooter">
  43224. Odd page footer value. Corresponds to odd printed pages.
  43225. Odd page(s) in the sheet may not be printed, for example, if the print area is specified to be
  43226. a range such that it falls outside an odd page's scope.
  43227. </member>
  43228. <member name="M:NPOI.XSSF.UserModel.XSSFOddFooter.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  43229. Create an instance of XSSFOddFooter from the supplied XML bean
  43230. @see XSSFSheet#GetOddFooter()
  43231. @param headerFooter
  43232. </member>
  43233. <member name="P:NPOI.XSSF.UserModel.XSSFOddFooter.Text">
  43234. Get the content text representing the footer
  43235. @return text
  43236. </member>
  43237. <member name="T:NPOI.XSSF.UserModel.XSSFOddHeader">
  43238. Odd page header value. Corresponds to odd printed pages.
  43239. Odd page(s) in the sheet may not be printed, for example, if the print area is specified to be
  43240. a range such that it falls outside an odd page's scope.
  43241. </member>
  43242. <member name="M:NPOI.XSSF.UserModel.XSSFOddHeader.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  43243. Create an instance of XSSFOddHeader from the supplied XML bean
  43244. @see XSSFSheet#GetOddHeader()
  43245. @param headerFooter
  43246. </member>
  43247. <member name="P:NPOI.XSSF.UserModel.XSSFOddHeader.Text">
  43248. Get the content text representing this header
  43249. @return text
  43250. </member>
  43251. <member name="T:NPOI.XSSF.UserModel.XSSFPatternFormatting">
  43252. @author Yegor Kozlov
  43253. </member>
  43254. <member name="T:NPOI.XSSF.UserModel.XSSFPicture">
  43255. Represents a picture shape in a SpreadsheetML Drawing.
  43256. @author Yegor Kozlov
  43257. </member>
  43258. <member name="F:NPOI.XSSF.UserModel.XSSFPicture.prototype">
  43259. A default instance of CTShape used for creating new shapes.
  43260. </member>
  43261. <member name="F:NPOI.XSSF.UserModel.XSSFPicture.ctPicture">
  43262. This object specifies a picture object and all its properties
  43263. </member>
  43264. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Picture)">
  43265. Construct a new XSSFPicture object. This constructor is called from
  43266. {@link XSSFDrawing#CreatePicture(XSSFClientAnchor, int)}
  43267. @param Drawing the XSSFDrawing that owns this picture
  43268. </member>
  43269. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,System.Xml.XmlNode)">
  43270. Returns a prototype that is used to construct new shapes
  43271. @return a prototype that is used to construct new shapes
  43272. </member>
  43273. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.SetPictureReference(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  43274. Link this shape with the picture data
  43275. @param rel relationship referring the picture data
  43276. </member>
  43277. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetCTPicture">
  43278. Return the underlying CT_Picture bean that holds all properties for this picture
  43279. @return the underlying CT_Picture bean
  43280. </member>
  43281. <member name="P:NPOI.XSSF.UserModel.XSSFPicture.ClientAnchor">
  43282. @return the anchor that is used by this shape.
  43283. </member>
  43284. <member name="P:NPOI.XSSF.UserModel.XSSFPicture.Sheet">
  43285. @return the sheet which contains the picture shape
  43286. </member>
  43287. <member name="T:NPOI.XSSF.UserModel.XSSFPictureData">
  43288. Raw picture data, normally attached to a SpreadsheetML Drawing.
  43289. As a rule, pictures are stored in the /xl/media/ part of a SpreadsheetML package.
  43290. </member>
  43291. <member name="F:NPOI.XSSF.UserModel.XSSFPictureData.RELATIONS">
  43292. Relationships for each known picture type
  43293. </member>
  43294. <member name="M:NPOI.XSSF.UserModel.XSSFPictureData.#ctor">
  43295. Create a new XSSFPictureData node
  43296. @see NPOI.xssf.usermodel.XSSFWorkbook#AddPicture(byte[], int)
  43297. </member>
  43298. <member name="M:NPOI.XSSF.UserModel.XSSFPictureData.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  43299. Construct XSSFPictureData from a namespace part
  43300. @param part the namespace part holding the Drawing data,
  43301. @param rel the namespace relationship holding this Drawing,
  43302. the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/image
  43303. </member>
  43304. <member name="M:NPOI.XSSF.UserModel.XSSFPictureData.SuggestFileExtension">
  43305. Suggests a file extension for this image.
  43306. @return the file extension.
  43307. </member>
  43308. <member name="P:NPOI.XSSF.UserModel.XSSFPictureData.PictureType">
  43309. Return an integer constant that specifies type of this picture
  43310. @return an integer constant that specifies type of this picture
  43311. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_EMF
  43312. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_WMF
  43313. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_PICT
  43314. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_JPEG
  43315. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_PNG
  43316. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_DIB
  43317. </member>
  43318. <member name="P:NPOI.XSSF.UserModel.XSSFPictureData.Data">
  43319. <summary>
  43320. Gets the picture data as a byte array.
  43321. </summary>
  43322. </member>
  43323. <member name="M:NPOI.XSSF.UserModel.XSSFPictureData.PrepareForCommit">
  43324. *PictureData objects store the actual content in the part directly without keeping a
  43325. copy like all others therefore we need to handle them differently.
  43326. </member>
  43327. <member name="M:NPOI.XSSF.UserModel.XSSFPivotCache.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  43328. Creates n XSSFPivotCache representing the given package part and relationship.
  43329. Should only be called when Reading in an existing file.
  43330. @param part - The package part that holds xml data representing this pivot cache defInition.
  43331. @param rel - the relationship of the given package part in the underlying OPC package
  43332. </member>
  43333. <member name="M:NPOI.XSSF.UserModel.XSSFPivotCacheDefinition.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  43334. Creates an XSSFPivotCacheDefintion representing the given package part and relationship.
  43335. Should only be called when Reading in an existing file.
  43336. @param part - The package part that holds xml data representing this pivot cache defInition.
  43337. @param rel - the relationship of the given package part in the underlying OPC package
  43338. </member>
  43339. <member name="M:NPOI.XSSF.UserModel.XSSFPivotCacheDefinition.GetPivotArea(NPOI.SS.UserModel.IWorkbook)">
  43340. Find the 2D base data area for the pivot table, either from its direct reference or named table/range.
  43341. @return AreaReference representing the current area defined by the pivot table
  43342. @ if the ref1 attribute is not contiguous or the name attribute is not found.
  43343. </member>
  43344. <member name="M:NPOI.XSSF.UserModel.XSSFPivotCacheDefinition.CreateCacheFields(NPOI.SS.UserModel.ISheet)">
  43345. Generates a cache field for each column in the reference area for the pivot table.
  43346. @param sheet The sheet where the data i collected from
  43347. </member>
  43348. <member name="M:NPOI.XSSF.UserModel.XSSFPivotCacheRecords.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  43349. Creates an XSSFPivotCacheRecords representing the given package part and relationship.
  43350. Should only be called when Reading in an existing file.
  43351. @param part - The package part that holds xml data representing this pivot cache records.
  43352. @param rel - the relationship of the given package part in the underlying OPC package
  43353. </member>
  43354. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  43355. Creates an XSSFPivotTable representing the given package part and relationship.
  43356. Should only be called when Reading in an existing file.
  43357. @param part - The package part that holds xml data representing this pivot table.
  43358. @param rel - the relationship of the given package part in the underlying OPC package
  43359. </member>
  43360. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.SetDefaultPivotTableDefinition">
  43361. Set default values for the table defInition.
  43362. </member>
  43363. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.CheckColumnIndex(System.Int32)">
  43364. Verify column index (relative to first column in1 pivot area) is within the
  43365. pivot area
  43366. @param columnIndex
  43367. @
  43368. </member>
  43369. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.AddRowLabel(System.Int32)">
  43370. Add a row label using data from the given column.
  43371. @param columnIndex the index of the column to be used as row label.
  43372. </member>
  43373. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.AddColumnLabel(NPOI.SS.UserModel.DataConsolidateFunction,System.Int32,System.String)">
  43374. Add a column label using data from the given column and specified function
  43375. @param columnIndex the index of the column to be used as column label.
  43376. @param function the function to be used on the data
  43377. The following functions exists:
  43378. Sum, Count, Average, Max, Min, Product, Count numbers, StdDev, StdDevp, Var, Varp
  43379. @param valueFieldName the name of pivot table value field
  43380. </member>
  43381. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.AddColumnLabel(NPOI.SS.UserModel.DataConsolidateFunction,System.Int32)">
  43382. Add a column label using data from the given column and specified function
  43383. @param columnIndex the index of the column to be used as column label.
  43384. @param function the function to be used on the data
  43385. The following functions exists:
  43386. Sum, Count, Average, Max, Min, Product, Count numbers, StdDev, StdDevp, Var, Varp
  43387. </member>
  43388. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.AddDataField(NPOI.SS.UserModel.DataConsolidateFunction,System.Int32,System.String)">
  43389. Add data field with data from the given column and specified function.
  43390. @param function the function to be used on the data
  43391. The following functions exists:
  43392. Sum, Count, Average, Max, Min, Product, Count numbers, StdDev, StdDevp, Var, Varp
  43393. @param columnIndex the index of the column to be used as column label.
  43394. @param valueFieldName the name of pivot table value field
  43395. </member>
  43396. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.AddDataColumn(System.Int32,System.Boolean)">
  43397. Add column Containing data from the referenced area.
  43398. @param columnIndex the index of the column Containing the data
  43399. @param isDataField true if the data should be displayed in the pivot table.
  43400. </member>
  43401. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.AddReportFilter(System.Int32)">
  43402. Add filter for the column with the corresponding index and cell value
  43403. @param columnIndex index of column to filter on
  43404. </member>
  43405. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.CreateSourceReferences(NPOI.SS.Util.CellReference,NPOI.SS.UserModel.ISheet,NPOI.XSSF.UserModel.IPivotTableReferenceConfigurator)">
  43406. Creates cacheSource and workSheetSource for pivot table and sets the source reference as well assets the location of the pivot table
  43407. @param sourceRef Source for data for pivot table - mutually exclusive with sourceName
  43408. @param sourceName Source for data for pivot table - mutually exclusive with sourceRef
  43409. @param position Position for pivot table in sheet
  43410. @param sourceSheet Sheet where the source will be collected from
  43411. </member>
  43412. <member name="M:NPOI.XSSF.UserModel.IPivotTableReferenceConfigurator.ConfigureReference(NPOI.OpenXmlFormats.Spreadsheet.CT_WorksheetSource)">
  43413. Configure the name or area reference for the pivot table
  43414. @param wsSource CTWorksheetSource that needs the pivot source reference assignment
  43415. </member>
  43416. <member name="T:NPOI.XSSF.UserModel.XSSFPrintSetup">
  43417. Page Setup and page margins Settings for the worksheet.
  43418. </member>
  43419. <member name="M:NPOI.XSSF.UserModel.XSSFPrintSetup.SetPaperSize(NPOI.SS.UserModel.PaperSize)">
  43420. Set the paper size as enum value.
  43421. @param size value for the paper size.
  43422. </member>
  43423. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Orientation">
  43424. Orientation of the page: landscape - portrait.
  43425. @return Orientation of the page
  43426. @see PrintOrientation
  43427. </member>
  43428. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.PageOrder">
  43429. Get print page order.
  43430. @return PageOrder
  43431. </member>
  43432. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.PaperSize">
  43433. Returns the paper size.
  43434. @return short - paper size
  43435. </member>
  43436. <member name="M:NPOI.XSSF.UserModel.XSSFPrintSetup.GetPaperSizeEnum">
  43437. Returns the paper size as enum.
  43438. @return PaperSize paper size
  43439. @see PaperSize
  43440. </member>
  43441. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Scale">
  43442. Returns the scale.
  43443. @return short - scale
  43444. </member>
  43445. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.PageStart">
  43446. Set the page numbering start.
  43447. Page number for first printed page. If no value is specified, then 'automatic' is assumed.
  43448. @return page number for first printed page
  43449. </member>
  43450. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.FitWidth">
  43451. Returns the number of pages wide to fit sheet in.
  43452. @return number of pages wide to fit sheet in
  43453. </member>
  43454. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.FitHeight">
  43455. Returns the number of pages high to fit the sheet in.
  43456. @return number of pages high to fit the sheet in
  43457. </member>
  43458. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.LeftToRight">
  43459. Returns the left to right print order.
  43460. @return left to right print order
  43461. </member>
  43462. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Landscape">
  43463. Returns the landscape mode.
  43464. @return landscape mode
  43465. </member>
  43466. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.ValidSettings">
  43467. Use the printer's defaults Settings for page Setup values and don't use the default values
  43468. specified in the schema. For example, if dpi is not present or specified in the XML, the
  43469. application shall not assume 600dpi as specified in the schema as a default and instead
  43470. shall let the printer specify the default dpi.
  43471. @return valid Settings
  43472. </member>
  43473. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.NoColor">
  43474. Returns the black and white Setting.
  43475. @return black and white Setting
  43476. </member>
  43477. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Draft">
  43478. Returns the draft mode.
  43479. @return draft mode
  43480. </member>
  43481. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Notes">
  43482. Returns the print notes.
  43483. @return print notes
  43484. </member>
  43485. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.NoOrientation">
  43486. Returns the no orientation.
  43487. @return no orientation
  43488. </member>
  43489. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.UsePage">
  43490. Returns the use page numbers.
  43491. @return use page numbers
  43492. </member>
  43493. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.HResolution">
  43494. Returns the horizontal resolution.
  43495. @return horizontal resolution
  43496. </member>
  43497. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.VResolution">
  43498. Returns the vertical resolution.
  43499. @return vertical resolution
  43500. </member>
  43501. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.HeaderMargin">
  43502. Returns the header margin.
  43503. @return header margin
  43504. </member>
  43505. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.FooterMargin">
  43506. Returns the footer margin.
  43507. @return footer margin
  43508. </member>
  43509. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Copies">
  43510. Returns the number of copies.
  43511. @return number of copies
  43512. </member>
  43513. <member name="T:NPOI.XSSF.UserModel.XSSFRelation">
  43514. <summary>
  43515. Defines namespaces, content types and normal file names / naming
  43516. patterns, for the well-known XSSF format parts.
  43517. </summary>
  43518. </member>
  43519. <member name="F:NPOI.XSSF.UserModel.XSSFRelation._table">
  43520. A map to lookup POIXMLRelation by its relation type
  43521. </member>
  43522. <member name="F:NPOI.XSSF.UserModel.XSSFRelation.IMAGE_JPG">
  43523. JPG is an intentional duplicate of JPEG, to handle documents generated by other software. *
  43524. </member>
  43525. <member name="M:NPOI.XSSF.UserModel.XSSFRelation.GetContents(NPOI.OpenXml4Net.OPC.PackagePart)">
  43526. Fetches the InputStream to read the contents, based
  43527. of the specified core part, for which we are defined
  43528. as a suitable relationship
  43529. </member>
  43530. <member name="M:NPOI.XSSF.UserModel.XSSFRelation.GetInstance(System.String)">
  43531. Get POIXMLRelation by relation type
  43532. @param rel relation type, for example,
  43533. <code>http://schemas.openxmlformats.org/officeDocument/2006/relationships/image</code>
  43534. @return registered POIXMLRelation or null if not found
  43535. </member>
  43536. <member name="M:NPOI.XSSF.UserModel.XSSFRelation.RemoveRelation(NPOI.XSSF.UserModel.XSSFRelation)">
  43537. <summary>
  43538. Removes the relation from the internal table.
  43539. Following readings of files will ignoring the removed relation.
  43540. </summary>
  43541. <param name="relation">Relation to remove</param>
  43542. </member>
  43543. <member name="M:NPOI.XSSF.UserModel.XSSFRelation.AddRelation(NPOI.XSSF.UserModel.XSSFRelation)">
  43544. <summary>
  43545. Adds the relation to the internal table.
  43546. Following readings of files will process the given relation.
  43547. </summary>
  43548. <param name="relation">Relation to add</param>
  43549. </member>
  43550. <member name="T:NPOI.XSSF.UserModel.XSSFRichTextString">
  43551. Rich text unicode string. These strings can have fonts applied to arbitary parts of the string.
  43552. <p>
  43553. Most strings in a workbook have formatting applied at the cell level, that is, the entire string in the cell has the
  43554. same formatting applied. In these cases, the formatting for the cell is stored in the styles part,
  43555. and the string for the cell can be shared across the workbook. The following code illustrates the example.
  43556. </p>
  43557. <blockquote>
  43558. <pre>
  43559. cell1.SetCellValue(new XSSFRichTextString("Apache POI"));
  43560. cell2.SetCellValue(new XSSFRichTextString("Apache POI"));
  43561. cell3.SetCellValue(new XSSFRichTextString("Apache POI"));
  43562. </pre>
  43563. </blockquote>
  43564. In the above example all three cells will use the same string cached on workbook level.
  43565. <p>
  43566. Some strings in the workbook may have formatting applied at a level that is more granular than the cell level.
  43567. For instance, specific characters within the string may be bolded, have coloring, italicizing, etc.
  43568. In these cases, the formatting is stored along with the text in the string table, and is treated as
  43569. a unique entry in the workbook. The following xml and code snippet illustrate this.
  43570. </p>
  43571. <blockquote>
  43572. <pre>
  43573. XSSFRichTextString s1 = new XSSFRichTextString("Apache POI");
  43574. s1.ApplyFont(boldArial);
  43575. cell1.SetCellValue(s1);
  43576. XSSFRichTextString s2 = new XSSFRichTextString("Apache POI");
  43577. s2.ApplyFont(italicCourier);
  43578. cell2.SetCellValue(s2);
  43579. </pre>
  43580. </blockquote>
  43581. @author Yegor Kozlov
  43582. </member>
  43583. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.#ctor(System.String)">
  43584. Create a rich text string
  43585. </member>
  43586. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.#ctor">
  43587. Create empty rich text string and Initialize it with empty string
  43588. </member>
  43589. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Rst)">
  43590. Create a rich text string from the supplied XML bean
  43591. </member>
  43592. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ApplyFont(System.Int32,System.Int32,System.Int16)">
  43593. Applies a font to the specified characters of a string.
  43594. @param startIndex The start index to apply the font to (inclusive)
  43595. @param endIndex The end index to apply the font to (exclusive)
  43596. @param fontIndex The font to use.
  43597. </member>
  43598. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ApplyFont(System.Int32,System.Int32,NPOI.SS.UserModel.IFont)">
  43599. Applies a font to the specified characters of a string.
  43600. @param startIndex The start index to apply the font to (inclusive)
  43601. @param endIndex The end index to apply to font to (exclusive)
  43602. @param font The index of the font to use.
  43603. </member>
  43604. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ApplyFont(NPOI.SS.UserModel.IFont)">
  43605. Sets the font of the entire string.
  43606. @param font The font to use.
  43607. </member>
  43608. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ApplyFont(System.Int16)">
  43609. Applies the specified font to the entire string.
  43610. @param fontIndex the font to Apply.
  43611. </member>
  43612. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.Append(System.String,NPOI.XSSF.UserModel.XSSFFont)">
  43613. Append new text to this text run and apply the specify font to it
  43614. @param text the text to append
  43615. @param font the font to apply to the Appended text or <code>null</code> if no formatting is required
  43616. </member>
  43617. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.Append(System.String)">
  43618. Append new text to this text run
  43619. @param text the text to append
  43620. </member>
  43621. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.SetRunAttributes(NPOI.OpenXmlFormats.Spreadsheet.CT_Font,NPOI.OpenXmlFormats.Spreadsheet.CT_RPrElt)">
  43622. Copy font attributes from CTFont bean into CTRPrElt bean
  43623. </member>
  43624. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.HasFormatting">
  43625. Does this string have any explicit formatting applied, or is
  43626. it just text in the default style?
  43627. </member>
  43628. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ClearFormatting">
  43629. Removes any formatting that may have been applied to the string.
  43630. </member>
  43631. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetIndexOfFormattingRun(System.Int32)">
  43632. The index within the string to which the specified formatting run applies.
  43633. @param index the index of the formatting run
  43634. @return the index within the string.
  43635. </member>
  43636. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetLengthOfFormattingRun(System.Int32)">
  43637. Returns the number of characters this format run covers.
  43638. @param index the index of the formatting run
  43639. @return the number of characters this format run covers
  43640. </member>
  43641. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ToString">
  43642. Returns the plain string representation.
  43643. </member>
  43644. <member name="P:NPOI.XSSF.UserModel.XSSFRichTextString.Length">
  43645. Returns the number of characters in this string.
  43646. </member>
  43647. <member name="P:NPOI.XSSF.UserModel.XSSFRichTextString.NumFormattingRuns">
  43648. @return The number of formatting Runs used.
  43649. </member>
  43650. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetFontOfFormattingRun(System.Int32)">
  43651. Gets a copy of the font used in a particular formatting Run.
  43652. @param index the index of the formatting run
  43653. @return A copy of the font used or null if no formatting is applied to the specified text Run.
  43654. </member>
  43655. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetFontAtIndex(System.Int32)">
  43656. Return a copy of the font in use at a particular index.
  43657. @param index The index.
  43658. @return A copy of the font that's currently being applied at that
  43659. index or null if no font is being applied or the
  43660. index is out of range.
  43661. </member>
  43662. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetCTRst">
  43663. Return the underlying xml bean
  43664. </member>
  43665. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ToCTFont(NPOI.OpenXmlFormats.Spreadsheet.CT_RPrElt)">
  43666. CTRPrElt --> CTFont adapter
  43667. </member>
  43668. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.PreserveSpaces(System.String)">
  43669. **
  43670. </member>
  43671. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.UtfDecode(System.String)">
  43672. For all characters which cannot be represented in XML as defined by the XML 1.0 specification,
  43673. the characters are escaped using the Unicode numerical character representation escape character
  43674. format _xHHHH_, where H represents a hexadecimal character in the character's value.
  43675. <p>
  43676. Example: The Unicode character 0D is invalid in an XML 1.0 document,
  43677. so it shall be escaped as <code>_x000D_</code>.
  43678. </p>
  43679. See section 3.18.9 in the OOXML spec.
  43680. @param value the string to decode
  43681. @return the decoded string
  43682. </member>
  43683. <member name="T:NPOI.XSSF.UserModel.XSSFRow">
  43684. High level representation of a row of a spreadsheet.
  43685. </member>
  43686. <member name="F:NPOI.XSSF.UserModel.XSSFRow._row">
  43687. the xml bean Containing all cell defInitions for this row
  43688. </member>
  43689. <member name="F:NPOI.XSSF.UserModel.XSSFRow._cells">
  43690. Cells of this row keyed by their column indexes.
  43691. The TreeMap ensures that the cells are ordered by columnIndex in the ascending order.
  43692. </member>
  43693. <member name="F:NPOI.XSSF.UserModel.XSSFRow._sheet">
  43694. the parent sheet
  43695. </member>
  43696. <member name="M:NPOI.XSSF.UserModel.XSSFRow.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Row,NPOI.XSSF.UserModel.XSSFSheet)">
  43697. Construct a XSSFRow.
  43698. @param row the xml bean Containing all cell defInitions for this row.
  43699. @param sheet the parent sheet.
  43700. </member>
  43701. <member name="P:NPOI.XSSF.UserModel.XSSFRow.Sheet">
  43702. Returns the XSSFSheet this row belongs to
  43703. @return the XSSFSheet that owns this row
  43704. </member>
  43705. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFRow.CellIterator" -->
  43706. <member name="M:NPOI.XSSF.UserModel.XSSFRow.GetEnumerator">
  43707. Alias for {@link #cellIterator()} to allow foreach loops:
  43708. <blockquote><pre>
  43709. for(Cell cell : row){
  43710. ...
  43711. }
  43712. </pre></blockquote>
  43713. @return an iterator over cells in this row.
  43714. </member>
  43715. <member name="M:NPOI.XSSF.UserModel.XSSFRow.CompareTo(NPOI.XSSF.UserModel.XSSFRow)">
  43716. Compares two <code>XSSFRow</code> objects. Two rows are equal if they belong to the same worksheet and
  43717. their row indexes are equal.
  43718. @param row the <code>XSSFRow</code> to be compared.
  43719. @return <ul>
  43720. <li>
  43721. the value <code>0</code> if the row number of this <code>XSSFRow</code> is
  43722. equal to the row number of the argument <code>XSSFRow</code>
  43723. </li>
  43724. <li>
  43725. a value less than <code>0</code> if the row number of this this <code>XSSFRow</code> is
  43726. numerically less than the row number of the argument <code>XSSFRow</code>
  43727. </li>
  43728. <li>
  43729. a value greater than <code>0</code> if the row number of this this <code>XSSFRow</code> is
  43730. numerically greater than the row number of the argument <code>XSSFRow</code>
  43731. </li>
  43732. </ul>
  43733. @throws IllegalArgumentException if the argument row belongs to a different worksheet
  43734. </member>
  43735. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFRow.CreateCell(System.Int32)" -->
  43736. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFRow.CreateCell(System.Int32,NPOI.SS.UserModel.CellType)" -->
  43737. <member name="M:NPOI.XSSF.UserModel.XSSFRow.GetCell(System.Int32)">
  43738. Returns the cell at the given (0 based) index,
  43739. with the {@link NPOI.SS.usermodel.Row.MissingCellPolicy} from the parent Workbook.
  43740. @return the cell at the given (0 based) index
  43741. </member>
  43742. <member name="M:NPOI.XSSF.UserModel.XSSFRow.RetrieveCell(System.Int32)">
  43743. <summary>
  43744. Get the hssfcell representing a given column (logical cell)
  43745. 0-based. If you ask for a cell that is not defined, then
  43746. you Get a null.
  43747. This is the basic call, with no policies applied
  43748. </summary>
  43749. <param name="cellnum">0 based column number</param>
  43750. <returns>Cell representing that column or null if Undefined.</returns>
  43751. </member>
  43752. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFRow.GetCell(System.Int32,NPOI.SS.UserModel.MissingCellPolicy)" -->
  43753. <member name="P:NPOI.XSSF.UserModel.XSSFRow.FirstCellNum">
  43754. Get the number of the first cell Contained in this row.
  43755. @return short representing the first logical cell in the row,
  43756. or -1 if the row does not contain any cells.
  43757. </member>
  43758. <member name="P:NPOI.XSSF.UserModel.XSSFRow.LastCellNum">
  43759. Gets the index of the last cell Contained in this row <b>PLUS ONE</b>. The result also
  43760. happens to be the 1-based column number of the last cell. This value can be used as a
  43761. standard upper bound when iterating over cells:
  43762. <pre>
  43763. short minColIx = row.GetFirstCellNum();
  43764. short maxColIx = row.GetLastCellNum();
  43765. for(short colIx=minColIx; colIx&lt;maxColIx; colIx++) {
  43766. XSSFCell cell = row.GetCell(colIx);
  43767. if(cell == null) {
  43768. continue;
  43769. }
  43770. //... do something with cell
  43771. }
  43772. </pre>
  43773. @return short representing the last logical cell in the row <b>PLUS ONE</b>,
  43774. or -1 if the row does not contain any cells.
  43775. </member>
  43776. <member name="P:NPOI.XSSF.UserModel.XSSFRow.Height">
  43777. Get the row's height measured in twips (1/20th of a point). If the height is not Set, the default worksheet value is returned,
  43778. See {@link NPOI.XSSF.usermodel.XSSFSheet#GetDefaultRowHeightInPoints()}
  43779. @return row height measured in twips (1/20th of a point)
  43780. </member>
  43781. <member name="P:NPOI.XSSF.UserModel.XSSFRow.HeightInPoints">
  43782. Returns row height measured in point size. If the height is not Set, the default worksheet value is returned,
  43783. See {@link NPOI.XSSF.usermodel.XSSFSheet#GetDefaultRowHeightInPoints()}
  43784. @return row height measured in point size
  43785. @see NPOI.XSSF.usermodel.XSSFSheet#GetDefaultRowHeightInPoints()
  43786. </member>
  43787. <member name="P:NPOI.XSSF.UserModel.XSSFRow.PhysicalNumberOfCells">
  43788. Gets the number of defined cells (NOT number of cells in the actual row!).
  43789. That is to say if only columns 0,4,5 have values then there would be 3.
  43790. @return int representing the number of defined cells in the row.
  43791. </member>
  43792. <member name="P:NPOI.XSSF.UserModel.XSSFRow.RowNum">
  43793. Get row number this row represents
  43794. @return the row number (0 based)
  43795. </member>
  43796. <member name="P:NPOI.XSSF.UserModel.XSSFRow.ZeroHeight">
  43797. Get whether or not to display this row with 0 height
  43798. @return - height is zero or not.
  43799. </member>
  43800. <member name="P:NPOI.XSSF.UserModel.XSSFRow.IsFormatted">
  43801. Is this row formatted? Most aren't, but some rows
  43802. do have whole-row styles. For those that do, you
  43803. can get the formatting from {@link #GetRowStyle()}
  43804. </member>
  43805. <member name="P:NPOI.XSSF.UserModel.XSSFRow.RowStyle">
  43806. Returns the whole-row cell style. Most rows won't
  43807. have one of these, so will return null. Call
  43808. {@link #isFormatted()} to check first.
  43809. </member>
  43810. <member name="M:NPOI.XSSF.UserModel.XSSFRow.SetRowStyle(NPOI.SS.UserModel.ICellStyle)">
  43811. Applies a whole-row cell styling to the row.
  43812. If the value is null then the style information is Removed,
  43813. causing the cell to used the default workbook style.
  43814. </member>
  43815. <member name="M:NPOI.XSSF.UserModel.XSSFRow.RemoveCell(NPOI.SS.UserModel.ICell)">
  43816. Remove the Cell from this row.
  43817. @param cell the cell to remove
  43818. </member>
  43819. <member name="M:NPOI.XSSF.UserModel.XSSFRow.GetCTRow">
  43820. Returns the underlying CT_Row xml bean Containing all cell defInitions in this row
  43821. @return the underlying CT_Row xml bean
  43822. </member>
  43823. <member name="M:NPOI.XSSF.UserModel.XSSFRow.OnDocumentWrite">
  43824. Fired when the document is written to an output stream.
  43825. @see NPOI.XSSF.usermodel.XSSFSheet#Write(java.io.OutputStream) ()
  43826. </member>
  43827. <member name="M:NPOI.XSSF.UserModel.XSSFRow.ToString">
  43828. @return formatted xml representation of this row
  43829. </member>
  43830. <member name="M:NPOI.XSSF.UserModel.XSSFRow.Shift(System.Int32)">
  43831. update cell references when Shifting rows
  43832. @param n the number of rows to move
  43833. </member>
  43834. <member name="M:NPOI.XSSF.UserModel.XSSFRow.CopyRowFrom(NPOI.SS.UserModel.IRow,NPOI.SS.UserModel.CellCopyPolicy)">
  43835. Copy the cells from srcRow to this row
  43836. If this row is not a blank row, this will merge the two rows, overwriting
  43837. the cells in this row with the cells in srcRow
  43838. If srcRow is null, overwrite cells in destination row with blank values, styles, etc per cell copy policy
  43839. srcRow may be from a different sheet in the same workbook
  43840. @param srcRow the rows to copy from
  43841. @param policy the policy to determine what gets copied
  43842. </member>
  43843. <member name="T:NPOI.XSSF.UserModel.XSSFShape">
  43844. Represents a shape in a SpreadsheetML Drawing.
  43845. @author Yegor Kozlov
  43846. </member>
  43847. <member name="F:NPOI.XSSF.UserModel.XSSFShape.drawing">
  43848. Parent Drawing
  43849. </member>
  43850. <member name="F:NPOI.XSSF.UserModel.XSSFShape.parent">
  43851. The parent shape, always not-null for shapes in groups
  43852. </member>
  43853. <member name="F:NPOI.XSSF.UserModel.XSSFShape.anchor">
  43854. anchor that is used by this shape
  43855. </member>
  43856. <member name="M:NPOI.XSSF.UserModel.XSSFShape.GetDrawing">
  43857. Return the Drawing that owns this shape
  43858. @return the parent Drawing that owns this shape
  43859. </member>
  43860. <member name="P:NPOI.XSSF.UserModel.XSSFShape.Parent">
  43861. Gets the parent shape.
  43862. </member>
  43863. <member name="M:NPOI.XSSF.UserModel.XSSFShape.GetAnchor">
  43864. @return the anchor that is used by this shape.
  43865. </member>
  43866. <member name="M:NPOI.XSSF.UserModel.XSSFShape.GetShapeProperties">
  43867. Returns xml bean with shape properties.
  43868. @return xml bean with shape properties.
  43869. </member>
  43870. <member name="P:NPOI.XSSF.UserModel.XSSFShape.IsNoFill">
  43871. Whether this shape is not Filled with a color
  43872. @return true if this shape is not Filled with a color.
  43873. </member>
  43874. <member name="M:NPOI.XSSF.UserModel.XSSFShape.SetFillColor(System.Int32,System.Int32,System.Int32)">
  43875. Sets the color used to fill this shape using the solid fill pattern.
  43876. </member>
  43877. <member name="M:NPOI.XSSF.UserModel.XSSFShape.SetLineStyleColor(System.Int32,System.Int32,System.Int32)">
  43878. The color applied to the lines of this shape.
  43879. </member>
  43880. <member name="T:NPOI.XSSF.UserModel.XSSFShapeGroup">
  43881. This object specifies a group shape that represents many shapes grouped together. This shape is to be treated
  43882. just as if it were a regular shape but instead of being described by a single geometry it is made up of all the
  43883. shape geometries encompassed within it. Within a group shape each of the shapes that make up the group are
  43884. specified just as they normally would.
  43885. @author Yegor Kozlov
  43886. </member>
  43887. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_GroupShape)">
  43888. Construct a new XSSFSimpleShape object.
  43889. @param Drawing the XSSFDrawing that owns this shape
  43890. @param ctGroup the XML bean that stores this group content
  43891. </member>
  43892. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.Prototype">
  43893. Initialize default structure of a new shape group
  43894. </member>
  43895. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.CreateTextbox(NPOI.XSSF.UserModel.XSSFChildAnchor)">
  43896. Constructs a textbox.
  43897. @param anchor the child anchor describes how this shape is attached
  43898. to the group.
  43899. @return the newly Created textbox.
  43900. </member>
  43901. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.CreateSimpleShape(NPOI.XSSF.UserModel.XSSFChildAnchor)">
  43902. Creates a simple shape. This includes such shapes as lines, rectangles,
  43903. and ovals.
  43904. @param anchor the child anchor describes how this shape is attached
  43905. to the group.
  43906. @return the newly Created shape.
  43907. </member>
  43908. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.CreateConnector(NPOI.XSSF.UserModel.XSSFChildAnchor)">
  43909. Creates a simple shape. This includes such shapes as lines, rectangles,
  43910. and ovals.
  43911. @param anchor the child anchor describes how this shape is attached
  43912. to the group.
  43913. @return the newly Created shape.
  43914. </member>
  43915. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.CreatePicture(NPOI.XSSF.UserModel.XSSFClientAnchor,System.Int32)">
  43916. Creates a picture.
  43917. @param anchor the client anchor describes how this picture is attached to the sheet.
  43918. @param pictureIndex the index of the picture in the workbook collection of pictures,
  43919. {@link XSSFWorkbook#getAllPictures()} .
  43920. @return the newly Created picture shape.
  43921. </member>
  43922. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.SetCoordinates(System.Int32,System.Int32,System.Int32,System.Int32)">
  43923. Sets the coordinate space of this group. All children are constrained
  43924. to these coordinates.
  43925. </member>
  43926. <member name="T:NPOI.XSSF.UserModel.XSSFSheet">
  43927. High level representation of a SpreadsheetML worksheet.
  43928. <p>
  43929. Sheets are the central structures within a workbook, and are where a user does most of his spreadsheet work.
  43930. The most common type of sheet is the worksheet, which is represented as a grid of cells. Worksheet cells can
  43931. contain text, numbers, dates, and formulas. Cells can also be formatted.
  43932. </p>
  43933. </member>
  43934. <member name="F:NPOI.XSSF.UserModel.XSSFSheet.sharedFormulas">
  43935. cache of master shared formulas in this sheet.
  43936. Master shared formula is the first formula in a group of shared formulas is saved in the f element.
  43937. </member>
  43938. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.#ctor">
  43939. Creates new XSSFSheet - called by XSSFWorkbook to create a sheet from scratch.
  43940. @see NPOI.XSSF.usermodel.XSSFWorkbook#CreateSheet()
  43941. </member>
  43942. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  43943. Creates an XSSFSheet representing the given namespace part and relationship.
  43944. Should only be called by XSSFWorkbook when Reading in an exisiting file.
  43945. @param part - The namespace part that holds xml data represenring this sheet.
  43946. @param rel - the relationship of the given namespace part in the underlying OPC namespace
  43947. </member>
  43948. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Workbook">
  43949. Returns the parent XSSFWorkbook
  43950. @return the parent XSSFWorkbook
  43951. </member>
  43952. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.OnDocumentRead">
  43953. Initialize worksheet data when Reading in an exisiting file.
  43954. </member>
  43955. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.OnDocumentCreate">
  43956. Initialize worksheet data when creating a new sheet.
  43957. </member>
  43958. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.InitHyperlinks">
  43959. Read hyperlink relations, link them with CT_Hyperlink beans in this worksheet
  43960. and Initialize the internal array of XSSFHyperlink objects
  43961. </member>
  43962. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.NewSheet">
  43963. Create a new CT_Worksheet instance with all values set to defaults
  43964. @return a new instance
  43965. </member>
  43966. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCTWorksheet">
  43967. Provide access to the CT_Worksheet bean holding this sheet's data
  43968. @return the CT_Worksheet bean holding this sheet's data
  43969. </member>
  43970. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.SheetName">
  43971. Returns the name of this sheet
  43972. @return the name of this sheet
  43973. </member>
  43974. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AddMergedRegion(NPOI.SS.Util.CellRangeAddress)">
  43975. <summary>
  43976. Adds a merged region of cells on a sheet.
  43977. </summary>
  43978. <param name="region">region to merge</param>
  43979. <returns>index of this region</returns>
  43980. <exception cref="T:System.ArgumentException">if region contains fewer than 2 cells</exception>
  43981. <exception cref="T:System.InvalidOperationException">if region intersects with an existing merged region
  43982. or multi-cell array formula on this sheet</exception>
  43983. </member>
  43984. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AddMergedRegionUnsafe(NPOI.SS.Util.CellRangeAddress)">
  43985. <summary>
  43986. Adds a merged region of cells (hence those cells form one).
  43987. Skips validation.It is possible to create overlapping merged regions
  43988. or create a merged region that intersects a multi-cell array formula
  43989. with this formula, which may result in a corrupt workbook.
  43990. </summary>
  43991. <param name="region">region to merge</param>
  43992. <returns>index of this region</returns>
  43993. <exception cref="T:System.ArgumentException">if region contains fewer than 2 cells</exception>
  43994. </member>
  43995. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AddMergedRegion(NPOI.SS.Util.CellRangeAddress,System.Boolean)">
  43996. <summary>
  43997. Adds a merged region of cells (hence those cells form one).
  43998. </summary>
  43999. <param name="region">region (rowfrom/colfrom-rowto/colto) to merge</param>
  44000. <param name="validate">whether to validate merged region</param>
  44001. <returns>index of this region</returns>
  44002. <exception cref="T:System.InvalidOperationException">if region intersects with a multi-cell array formula or
  44003. if region intersects with an existing region on this sheet</exception>
  44004. <exception cref="T:System.ArgumentException">if region contains fewer than 2 cells</exception>
  44005. </member>
  44006. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ValidateArrayFormulas(NPOI.SS.Util.CellRangeAddress)">
  44007. Verify that the candidate region does not intersect with an existing multi-cell array formula in this sheet
  44008. @param region
  44009. @throws InvalidOperationException if candidate region intersects an existing array formula in this sheet
  44010. </member>
  44011. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CheckForMergedRegionsIntersectingArrayFormulas">
  44012. Verify that none of the merged regions intersect a multi-cell array formula in this sheet
  44013. @param region
  44014. @throws InvalidOperationException if candidate region intersects an existing array formula in this sheet
  44015. </member>
  44016. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ValidateMergedRegions(NPOI.SS.Util.CellRangeAddress)">
  44017. Verify that candidate region does not intersect with an existing merged region in this sheet
  44018. @param candidateRegion
  44019. @throws InvalidOperationException if candidate region intersects an existing merged region in this sheet
  44020. </member>
  44021. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CheckForIntersectingMergedRegions">
  44022. Verify that no merged regions intersect another merged region in this sheet.
  44023. @throws InvalidOperationException if at least one region intersects with another merged region in this sheet
  44024. </member>
  44025. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ValidateMergedRegions">
  44026. Verify that merged regions do not intersect multi-cell array formulas and
  44027. no merged regions intersect another merged region in this sheet.
  44028. @throws InvalidOperationException if region intersects with a multi-cell array formula
  44029. @throws InvalidOperationException if at least one region intersects with another merged region in this sheet
  44030. </member>
  44031. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetDrawingPatriarch">
  44032. Return the sheet's existing Drawing, or null if there isn't yet one.
  44033. Use {@link #CreateDrawingPatriarch()} to Get or create
  44034. @return a SpreadsheetML Drawing
  44035. </member>
  44036. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateDrawingPatriarch">
  44037. Create a new SpreadsheetML Drawing. If this sheet already Contains a Drawing - return that.
  44038. @return a SpreadsheetML Drawing
  44039. </member>
  44040. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetVMLDrawing(System.Boolean)">
  44041. Get VML drawing for this sheet (aka 'legacy' drawig)
  44042. @param autoCreate if true, then a new VML drawing part is Created
  44043. @return the VML drawing of <code>null</code> if the drawing was not found and autoCreate=false
  44044. </member>
  44045. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateFreezePane(System.Int32,System.Int32)">
  44046. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  44047. @param colSplit Horizonatal position of split.
  44048. @param rowSplit Vertical position of split.
  44049. </member>
  44050. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateFreezePane(System.Int32,System.Int32,System.Int32,System.Int32)">
  44051. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  44052. <p>
  44053. If both colSplit and rowSplit are zero then the existing freeze pane is Removed
  44054. </p>
  44055. @param colSplit Horizonatal position of split.
  44056. @param rowSplit Vertical position of split.
  44057. @param leftmostColumn Left column visible in right pane.
  44058. @param topRow Top row visible in bottom pane
  44059. </member>
  44060. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateRow(System.Int32)">
  44061. Create a new row within the sheet and return the high level representation
  44062. @param rownum row number
  44063. @return High level {@link XSSFRow} object representing a row in the sheet
  44064. @see #RemoveRow(NPOI.SS.usermodel.Row)
  44065. </member>
  44066. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateSplitPane(System.Int32,System.Int32,System.Int32,System.Int32,NPOI.SS.UserModel.PanePosition)">
  44067. Creates a split pane. Any existing freezepane or split pane is overwritten.
  44068. @param xSplitPos Horizonatal position of split (in 1/20th of a point).
  44069. @param ySplitPos Vertical position of split (in 1/20th of a point).
  44070. @param topRow Top row visible in bottom pane
  44071. @param leftmostColumn Left column visible in right pane.
  44072. @param activePane Active pane. One of: PANE_LOWER_RIGHT,
  44073. PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFT
  44074. @see NPOI.SS.usermodel.Sheet#PANE_LOWER_LEFT
  44075. @see NPOI.SS.usermodel.Sheet#PANE_LOWER_RIGHT
  44076. @see NPOI.SS.usermodel.Sheet#PANE_UPPER_LEFT
  44077. @see NPOI.SS.usermodel.Sheet#PANE_UPPER_RIGHT
  44078. </member>
  44079. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCellComment(System.Int32,System.Int32)">
  44080. <summary>
  44081. Returns cell comment for the specified row and column
  44082. </summary>
  44083. <param name="row">The row.</param>
  44084. <param name="column">The column.</param>
  44085. <returns>cell comment or <code>null</code> if not found</returns>
  44086. </member>
  44087. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCellComment(NPOI.SS.Util.CellAddress)">
  44088. <summary>
  44089. Returns cell comment for the specified location
  44090. </summary>
  44091. <param name="address">cell location</param>
  44092. <returns>return cell comment or null if not found</returns>
  44093. </member>
  44094. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCellComments">
  44095. <summary>
  44096. Returns all cell comments on this sheet.
  44097. </summary>
  44098. <returns>return A Dictionary of each Comment in the sheet, keyed on the cell address where the comment is located.</returns>
  44099. </member>
  44100. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetHyperlink(System.Int32,System.Int32)">
  44101. <summary>
  44102. Get a Hyperlink in this sheet anchored at row, column
  44103. </summary>
  44104. <param name="row"></param>
  44105. <param name="column"></param>
  44106. <returns>return hyperlink if there is a hyperlink anchored at row, column; otherwise returns null</returns>
  44107. </member>
  44108. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetHyperlink(NPOI.SS.Util.CellAddress)">
  44109. <summary>
  44110. Get a Hyperlink in this sheet located in a cell specified by {code addr}
  44111. </summary>
  44112. <param name="addr">The address of the cell containing the hyperlink</param>
  44113. <returns>return hyperlink if there is a hyperlink anchored at {@code addr}; otherwise returns {@code null}</returns>
  44114. </member>
  44115. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetHyperlinkList">
  44116. <summary>
  44117. Get a list of Hyperlinks in this sheet
  44118. </summary>
  44119. <returns></returns>
  44120. </member>
  44121. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.ColumnBreaks">
  44122. Vertical page break information used for print layout view, page layout view, drawing print breaks
  44123. in normal view, and for printing the worksheet.
  44124. @return column indexes of all the vertical page breaks, never <code>null</code>
  44125. </member>
  44126. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetColumnWidth(System.Int32)">
  44127. Get the actual column width (in units of 1/256th of a character width )
  44128. <p>
  44129. Note, the returned value is always gerater that {@link #GetDefaultColumnWidth()} because the latter does not include margins.
  44130. Actual column width measured as the number of characters of the maximum digit width of the
  44131. numbers 0, 1, 2, ..., 9 as rendered in the normal style's font. There are 4 pixels of margin
  44132. pAdding (two on each side), plus 1 pixel pAdding for the gridlines.
  44133. </p>
  44134. @param columnIndex - the column to set (0-based)
  44135. @return width - the width in units of 1/256th of a character width
  44136. </member>
  44137. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetColumnWidthInPixels(System.Int32)">
  44138. Get the actual column width in pixels
  44139. <p>
  44140. Please note, that this method works correctly only for workbooks
  44141. with the default font size (Calibri 11pt for .xlsx).
  44142. </p>
  44143. </member>
  44144. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DefaultColumnWidth">
  44145. Get the default column width for the sheet (if the columns do not define their own width) in
  44146. characters.
  44147. <p>
  44148. Note, this value is different from {@link #GetColumnWidth(int)}. The latter is always greater and includes
  44149. 4 pixels of margin pAdding (two on each side), plus 1 pixel pAdding for the gridlines.
  44150. </p>
  44151. @return column width, default value is 8
  44152. </member>
  44153. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DefaultRowHeight">
  44154. Get the default row height for the sheet (if the rows do not define their own height) in
  44155. twips (1/20 of a point)
  44156. @return default row height
  44157. </member>
  44158. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DefaultRowHeightInPoints">
  44159. Get the default row height for the sheet measued in point size (if the rows do not define their own height).
  44160. @return default row height in points
  44161. </member>
  44162. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetColumnStyle(System.Int32)">
  44163. Returns the CellStyle that applies to the given
  44164. (0 based) column, or null if no style has been
  44165. set for that column
  44166. </member>
  44167. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.RightToLeft">
  44168. Whether the text is displayed in right-to-left mode in the window
  44169. @return whether the text is displayed in right-to-left mode in the window
  44170. </member>
  44171. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayGuts">
  44172. Get whether to display the guts or not,
  44173. default value is true
  44174. @return bool - guts or no guts
  44175. </member>
  44176. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayZeros">
  44177. Gets the flag indicating whether the window should show 0 (zero) in cells Containing zero value.
  44178. When false, cells with zero value appear blank instead of Showing the number zero.
  44179. @return whether all zero values on the worksheet are displayed
  44180. </member>
  44181. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.FirstRowNum">
  44182. Gets the first row on the sheet
  44183. @return the number of the first logical row on the sheet, zero based
  44184. </member>
  44185. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.FitToPage">
  44186. Flag indicating whether the Fit to Page print option is enabled.
  44187. @return <code>true</code>
  44188. </member>
  44189. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Footer">
  44190. Returns the default footer for the sheet,
  44191. creating one as needed.
  44192. You may also want to look at
  44193. {@link #GetFirstFooter()},
  44194. {@link #GetOddFooter()} and
  44195. {@link #GetEvenFooter()}
  44196. </member>
  44197. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Header">
  44198. Returns the default header for the sheet,
  44199. creating one as needed.
  44200. You may also want to look at
  44201. {@link #GetFirstHeader()},
  44202. {@link #GetOddHeader()} and
  44203. {@link #GetEvenHeader()}
  44204. </member>
  44205. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.OddFooter">
  44206. Returns the odd footer. Used on all pages unless
  44207. other footers also present, when used on only
  44208. odd pages.
  44209. </member>
  44210. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.EvenFooter">
  44211. Returns the even footer. Not there by default, but
  44212. when Set, used on even pages.
  44213. </member>
  44214. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.FirstFooter">
  44215. Returns the first page footer. Not there by
  44216. default, but when Set, used on the first page.
  44217. </member>
  44218. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.OddHeader">
  44219. Returns the odd header. Used on all pages unless
  44220. other headers also present, when used on only
  44221. odd pages.
  44222. </member>
  44223. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.EvenHeader">
  44224. Returns the even header. Not there by default, but
  44225. when Set, used on even pages.
  44226. </member>
  44227. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.FirstHeader">
  44228. Returns the first page header. Not there by
  44229. default, but when Set, used on the first page.
  44230. </member>
  44231. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.HorizontallyCenter">
  44232. Determine whether printed output for this sheet will be horizontally centered.
  44233. </member>
  44234. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetMargin(NPOI.SS.UserModel.MarginType)">
  44235. Gets the size of the margin in inches.
  44236. @param margin which margin to get
  44237. @return the size of the margin
  44238. @see Sheet#LeftMargin
  44239. @see Sheet#RightMargin
  44240. @see Sheet#TopMargin
  44241. @see Sheet#BottomMargin
  44242. @see Sheet#HeaderMargin
  44243. @see Sheet#FooterMargin
  44244. </member>
  44245. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetMargin(NPOI.SS.UserModel.MarginType,System.Double)">
  44246. Sets the size of the margin in inches.
  44247. @param margin which margin to get
  44248. @param size the size of the margin
  44249. @see Sheet#LeftMargin
  44250. @see Sheet#RightMargin
  44251. @see Sheet#TopMargin
  44252. @see Sheet#BottomMargin
  44253. @see Sheet#HeaderMargin
  44254. @see Sheet#FooterMargin
  44255. </member>
  44256. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetMergedRegion(System.Int32)">
  44257. @return the merged region at the specified index
  44258. @throws InvalidOperationException if this worksheet does not contain merged regions
  44259. </member>
  44260. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.MergedRegions">
  44261. Returns the list of merged regions. If you want multiple regions, this is
  44262. faster than calling {@link #getMergedRegion(int)} each time.
  44263. @return the list of merged regions
  44264. @throws InvalidOperationException if this worksheet does not contain merged regions
  44265. </member>
  44266. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.NumMergedRegions">
  44267. Returns the number of merged regions defined in this worksheet
  44268. @return number of merged regions in this worksheet
  44269. </member>
  44270. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.PaneInformation">
  44271. Returns the information regarding the currently configured pane (split or freeze).
  44272. @return null if no pane configured, or the pane information.
  44273. </member>
  44274. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.PhysicalNumberOfRows">
  44275. Returns the number of phsyically defined rows (NOT the number of rows in the sheet)
  44276. @return the number of phsyically defined rows
  44277. </member>
  44278. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.PrintSetup">
  44279. Gets the print Setup object.
  44280. @return The user model for the print Setup object.
  44281. </member>
  44282. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Protect">
  44283. Answer whether protection is enabled or disabled
  44284. @return true => protection enabled; false => protection disabled
  44285. </member>
  44286. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetRow(System.Int32)">
  44287. Returns the logical row ( 0-based). If you ask for a row that is not
  44288. defined you get a null. This is to say row 4 represents the fifth row on a sheet.
  44289. @param rownum row to get
  44290. @return <code>XSSFRow</code> representing the rownumber or <code>null</code> if its not defined on the sheet
  44291. </member>
  44292. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetRows(System.Int32,System.Int32,System.Boolean)">
  44293. returns all rows between startRow and endRow, inclusive.
  44294. Rows between startRow and endRow that haven't been created are not included
  44295. in result unless createRowIfMissing is true
  44296. @param startRow the first row number in this sheet to return
  44297. @param endRow the last row number in this sheet to return
  44298. @param createRowIfMissing
  44299. @return
  44300. @throws IllegalArgumentException if startRowNum and endRowNum are not in ascending order
  44301. </member>
  44302. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.RowBreaks">
  44303. Horizontal page break information used for print layout view, page layout view, drawing print breaks in normal
  44304. view, and for printing the worksheet.
  44305. @return row indexes of all the horizontal page breaks, never <code>null</code>
  44306. </member>
  44307. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.RowSumsBelow">
  44308. Flag indicating whether summary rows appear below detail in an outline, when Applying an outline.
  44309. <p>
  44310. When true a summary row is inserted below the detailed data being summarized and a
  44311. new outline level is established on that row.
  44312. </p>
  44313. <p>
  44314. When false a summary row is inserted above the detailed data being summarized and a new outline level
  44315. is established on that row.
  44316. </p>
  44317. @return <code>true</code> if row summaries appear below detail in the outline
  44318. </member>
  44319. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.RowSumsRight">
  44320. Flag indicating whether summary columns appear to the right of detail in an outline, when Applying an outline.
  44321. <p>
  44322. When true a summary column is inserted to the right of the detailed data being summarized
  44323. and a new outline level is established on that column.
  44324. </p>
  44325. <p>
  44326. When false a summary column is inserted to the left of the detailed data being
  44327. summarized and a new outline level is established on that column.
  44328. </p>
  44329. @return <code>true</code> if col summaries appear right of the detail in the outline
  44330. </member>
  44331. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ensureOutlinePr">
  44332. Ensure CT_Worksheet.CT_SheetPr.CT_OutlinePr
  44333. </member>
  44334. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.ScenarioProtect">
  44335. <summary>
  44336. A flag indicating whether scenarios are locked when the sheet is protected.
  44337. </summary>
  44338. </member>
  44339. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.TopRow">
  44340. <summary>
  44341. The top row in the visible view when the sheet is first viewed after opening it in a viewer
  44342. </summary>
  44343. </member>
  44344. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.VerticallyCenter">
  44345. Determine whether printed output for this sheet will be vertically centered.
  44346. @return whether printed output for this sheet will be vertically centered.
  44347. </member>
  44348. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GroupColumn(System.Int32,System.Int32)">
  44349. Group between (0 based) columns
  44350. </member>
  44351. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetColWidthAttribute(NPOI.OpenXmlFormats.Spreadsheet.CT_Cols)">
  44352. Do not leave the width attribute undefined (see #52186).
  44353. </member>
  44354. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GroupRow(System.Int32,System.Int32)">
  44355. Tie a range of cell toGether so that they can be collapsed or expanded
  44356. @param fromRow start row (0-based)
  44357. @param toRow end row (0-based)
  44358. </member>
  44359. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsColumnBroken(System.Int32)">
  44360. Determines if there is a page break at the indicated column
  44361. </member>
  44362. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsColumnHidden(System.Int32)">
  44363. Get the hidden state for a given column.
  44364. @param columnIndex - the column to set (0-based)
  44365. @return hidden - <code>false</code> if the column is visible
  44366. </member>
  44367. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayFormulas">
  44368. Gets the flag indicating whether this sheet should display formulas.
  44369. @return <code>true</code> if this sheet should display formulas.
  44370. </member>
  44371. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayGridlines">
  44372. Gets the flag indicating whether this sheet displays the lines
  44373. between rows and columns to make editing and Reading easier.
  44374. @return <code>true</code> if this sheet displays gridlines.
  44375. @see #isPrintGridlines() to check if printing of gridlines is turned on or off
  44376. </member>
  44377. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayRowColHeadings">
  44378. Gets the flag indicating whether this sheet should display row and column headings.
  44379. <p>
  44380. Row heading are the row numbers to the side of the sheet
  44381. </p>
  44382. <p>
  44383. Column heading are the letters or numbers that appear above the columns of the sheet
  44384. </p>
  44385. @return <code>true</code> if this sheet should display row and column headings.
  44386. </member>
  44387. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsPrintGridlines">
  44388. Returns whether gridlines are printed.
  44389. @return whether gridlines are printed
  44390. </member>
  44391. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsPrintRowAndColumnHeadings">
  44392. Returns whether row and column headings are printed.
  44393. @return whether row and column headings are printed
  44394. </member>
  44395. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsRowBroken(System.Int32)">
  44396. Tests if there is a page break at the indicated row
  44397. @param row index of the row to test
  44398. @return <code>true</code> if there is a page break at the indicated row
  44399. </member>
  44400. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetRowBreak(System.Int32)">
  44401. Sets a page break at the indicated row
  44402. Breaks occur above the specified row and left of the specified column inclusive.
  44403. For example, <code>sheet.SetColumnBreak(2);</code> breaks the sheet into two parts
  44404. with columns A,B,C in the first and D,E,... in the second. Simuilar, <code>sheet.SetRowBreak(2);</code>
  44405. breaks the sheet into two parts with first three rows (rownum=1...3) in the first part
  44406. and rows starting with rownum=4 in the second.
  44407. @param row the row to break, inclusive
  44408. </member>
  44409. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveColumnBreak(System.Int32)">
  44410. Removes a page break at the indicated column
  44411. </member>
  44412. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveMergedRegion(System.Int32)">
  44413. Removes a merged region of cells (hence letting them free)
  44414. @param index of the region to unmerge
  44415. </member>
  44416. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveMergedRegions(System.Collections.Generic.IList{System.Int32})">
  44417. Removes a number of merged regions of cells (hence letting them free)
  44418. This method can be used to bulk-remove merged regions in a way
  44419. much faster than calling RemoveMergedRegion() for every single
  44420. merged region.
  44421. @param indices A Set of the regions to unmerge
  44422. </member>
  44423. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveRow(NPOI.SS.UserModel.IRow)">
  44424. Remove a row from this sheet. All cells Contained in the row are Removed as well
  44425. @param row the row to Remove.
  44426. </member>
  44427. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveRowBreak(System.Int32)">
  44428. Removes the page break at the indicated row
  44429. </member>
  44430. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.ForceFormulaRecalculation">
  44431. Whether Excel will be asked to recalculate all formulas when the
  44432. workbook is opened.
  44433. </member>
  44434. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Autobreaks">
  44435. Flag indicating whether the sheet displays Automatic Page Breaks.
  44436. @return <code>true</code> if the sheet displays Automatic Page Breaks.
  44437. </member>
  44438. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetColumnBreak(System.Int32)">
  44439. Sets a page break at the indicated column.
  44440. Breaks occur above the specified row and left of the specified column inclusive.
  44441. For example, <code>sheet.SetColumnBreak(2);</code> breaks the sheet into two parts
  44442. with columns A,B,C in the first and D,E,... in the second. Simuilar, <code>sheet.SetRowBreak(2);</code>
  44443. breaks the sheet into two parts with first three rows (rownum=1...3) in the first part
  44444. and rows starting with rownum=4 in the second.
  44445. @param column the column to break, inclusive
  44446. </member>
  44447. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetGroupHidden(System.Int32,System.Int32,System.Boolean)">
  44448. Sets all adjacent columns of the same outline level to the specified
  44449. hidden status.
  44450. @param pIdx
  44451. the col info index of the start of the outline group
  44452. @return the column index of the last column in the outline group
  44453. </member>
  44454. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsColumnGroupCollapsed(System.Int32)">
  44455. 'Collapsed' state is stored in a single column col info record
  44456. immediately after the outline group
  44457. @param idx
  44458. @return a bool represented if the column is collapsed
  44459. </member>
  44460. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetColumnHidden(System.Int32,System.Boolean)">
  44461. Get the visibility state for a given column.
  44462. @param columnIndex - the column to get (0-based)
  44463. @param hidden - the visiblity state of the column
  44464. </member>
  44465. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetColumnWidth(System.Int32,System.Int32)">
  44466. * Set the width (in units of 1/256th of a character width)
  44467. *
  44468. * <p>
  44469. * The maximum column width for an individual cell is 255 characters.
  44470. * This value represents the number of characters that can be displayed
  44471. * in a cell that is formatted with the standard font (first font in the workbook).
  44472. * </p>
  44473. *
  44474. * <p>
  44475. * Character width is defined as the maximum digit width
  44476. * of the numbers <code>0, 1, 2, ... 9</code> as rendered
  44477. * using the default font (first font in the workbook).
  44478. * <br/>
  44479. * Unless you are using a very special font, the default character is '0' (zero),
  44480. * this is true for Arial (default font font in HSSF) and Calibri (default font in XSSF)
  44481. * </p>
  44482. *
  44483. * <p>
  44484. * Please note, that the width set by this method includes 4 pixels of margin pAdding (two on each side),
  44485. * plus 1 pixel pAdding for the gridlines (Section 3.3.1.12 of the OOXML spec).
  44486. * This results is a slightly less value of visible characters than passed to this method (approx. 1/2 of a character).
  44487. * </p>
  44488. * <p>
  44489. * To compute the actual number of visible characters,
  44490. * Excel uses the following formula (Section 3.3.1.12 of the OOXML spec):
  44491. * </p>
  44492. * <code>
  44493. * width = TRuncate([{Number of Visible Characters} *
  44494. * {Maximum Digit Width} + {5 pixel pAdding}]/{Maximum Digit Width}*256)/256
  44495. * </code>
  44496. * <p>Using the Calibri font as an example, the maximum digit width of 11 point font size is 7 pixels (at 96 dpi).
  44497. * If you set a column width to be eight characters wide, e.g. <code>SetColumnWidth(columnIndex, 8*256)</code>,
  44498. * then the actual value of visible characters (the value Shown in Excel) is derived from the following equation:
  44499. * <code>
  44500. TRuncate([numChars*7+5]/7*256)/256 = 8;
  44501. * </code>
  44502. *
  44503. * which gives <code>7.29</code>.
  44504. * </p>
  44505. * @param columnIndex - the column to set (0-based)
  44506. * @param width - the width in units of 1/256th of a character width
  44507. * @throws ArgumentException if width > 255*256 (the maximum column width in Excel is 255 characters)
  44508. </member>
  44509. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetRowGroupCollapsed(System.Int32,System.Boolean)">
  44510. group the row It is possible for collapsed to be false and yet still have
  44511. the rows in question hidden. This can be achieved by having a lower
  44512. outline level collapsed, thus hiding all the child rows. Note that in
  44513. this case, if the lowest level were expanded, the middle level would
  44514. remain collapsed.
  44515. @param rowIndex -
  44516. the row involved, 0 based
  44517. @param collapse -
  44518. bool value for collapse
  44519. </member>
  44520. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CollapseRow(System.Int32)">
  44521. @param rowIndex the zero based row index to collapse
  44522. </member>
  44523. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.FindStartOfRowOutlineGroup(System.Int32)">
  44524. @param rowIndex the zero based row index to find from
  44525. </member>
  44526. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ExpandRow(System.Int32)">
  44527. @param rowNumber the zero based row index to expand
  44528. </member>
  44529. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.FindEndOfRowOutlineGroup(System.Int32)">
  44530. @param row the zero based row index to find from
  44531. </member>
  44532. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsRowGroupHiddenByParent(System.Int32)">
  44533. @param row the zero based row index to find from
  44534. </member>
  44535. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsRowGroupCollapsed(System.Int32)">
  44536. @param row the zero based row index to find from
  44537. </member>
  44538. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetZoom(System.Int32,System.Int32)">
  44539. Sets the zoom magnification for the sheet. The zoom is expressed as a
  44540. fraction. For example to express a zoom of 75% use 3 for the numerator
  44541. and 4 for the denominator.
  44542. @param numerator The numerator for the zoom magnification.
  44543. @param denominator The denominator for the zoom magnification.
  44544. @see #SetZoom(int)
  44545. </member>
  44546. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetZoom(System.Int32)">
  44547. Window zoom magnification for current view representing percent values.
  44548. Valid values range from 10 to 400. Horizontal &amp; Vertical scale toGether.
  44549. For example:
  44550. <pre>
  44551. 10 - 10%
  44552. 20 - 20%
  44553. ...
  44554. 100 - 100%
  44555. ...
  44556. 400 - 400%
  44557. </pre>
  44558. Current view can be Normal, Page Layout, or Page Break Preview.
  44559. @param scale window zoom magnification
  44560. @throws ArgumentException if scale is invalid
  44561. </member>
  44562. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CopyRows(System.Collections.Generic.List{NPOI.XSSF.UserModel.XSSFRow},System.Int32,NPOI.SS.UserModel.CellCopyPolicy)">
  44563. copyRows rows from srcRows to this sheet starting at destStartRow
  44564. Additionally copies merged regions that are completely defined in these
  44565. rows (ie. merged 2 cells on a row to be shifted).
  44566. @param srcRows the rows to copy. Formulas will be offset by the difference
  44567. in the row number of the first row in srcRows and destStartRow (even if srcRows
  44568. are from a different sheet).
  44569. @param destStartRow the row in this sheet to paste the first row of srcRows
  44570. the remainder of srcRows will be pasted below destStartRow per the cell copy policy
  44571. @param policy is the cell copy policy, which can be used to merge the source and destination
  44572. when the source is blank, copy styles only, paste as value, etc
  44573. </member>
  44574. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CopyRows(System.Int32,System.Int32,System.Int32,NPOI.SS.UserModel.CellCopyPolicy)">
  44575. Copies rows between srcStartRow and srcEndRow to the same sheet, starting at destStartRow
  44576. Convenience function for {@link #copyRows(List, int, CellCopyPolicy)}
  44577. Equivalent to copyRows(getRows(srcStartRow, srcEndRow, false), destStartRow, cellCopyPolicy)
  44578. @param srcStartRow the index of the first row to copy the cells from in this sheet
  44579. @param srcEndRow the index of the last row to copy the cells from in this sheet
  44580. @param destStartRow the index of the first row to copy the cells to in this sheet
  44581. @param cellCopyPolicy the policy to use to determine how cells are copied
  44582. </member>
  44583. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32)">
  44584. Shifts rows between startRow and endRow n number of rows.
  44585. If you use a negative number, it will shift rows up.
  44586. Code ensures that rows don't wrap around.
  44587. Calls ShiftRows(startRow, endRow, n, false, false);
  44588. <p>
  44589. Additionally Shifts merged regions that are completely defined in these
  44590. rows (ie. merged 2 cells on a row to be Shifted).</p>
  44591. @param startRow the row to start Shifting
  44592. @param endRow the row to end Shifting
  44593. @param n the number of rows to shift
  44594. </member>
  44595. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean)">
  44596. Shifts rows between startRow and endRow n number of rows.
  44597. If you use a negative number, it will shift rows up.
  44598. Code ensures that rows don't wrap around
  44599. <p>
  44600. Additionally Shifts merged regions that are completely defined in these
  44601. rows (ie. merged 2 cells on a row to be Shifted).</p>
  44602. @param startRow the row to start Shifting
  44603. @param endRow the row to end Shifting
  44604. @param n the number of rows to shift
  44605. @param copyRowHeight whether to copy the row height during the shift
  44606. @param reSetOriginalRowHeight whether to set the original row's height to the default
  44607. </member>
  44608. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.UngroupRow(System.Int32,System.Int32)">
  44609. Ungroup a range of rows that were previously groupped
  44610. @param fromRow start row (0-based)
  44611. @param toRow end row (0-based)
  44612. </member>
  44613. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSelected">
  44614. Returns a flag indicating whether this sheet is selected.
  44615. <p>
  44616. When only 1 sheet is selected and active, this value should be in synch with the activeTab value.
  44617. In case of a conflict, the Start Part Setting wins and Sets the active sheet tab.
  44618. </p>
  44619. Note: multiple sheets can be selected, but only one sheet can be active at one time.
  44620. @return <code>true</code> if this sheet is selected
  44621. </member>
  44622. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AddHyperlink(NPOI.XSSF.UserModel.XSSFHyperlink)">
  44623. Register a hyperlink in the collection of hyperlinks on this sheet
  44624. @param hyperlink the link to add
  44625. </member>
  44626. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveHyperlink(System.Int32,System.Int32)">
  44627. Removes a hyperlink in the collection of hyperlinks on this sheet
  44628. @param row row index
  44629. @param column column index
  44630. </member>
  44631. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.ActiveCell">
  44632. Return location of the active cell, e.g. <code>A1</code>.
  44633. @return the location of the active cell.
  44634. </member>
  44635. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.HasComments">
  44636. Does this sheet have any comments on it? We need to know,
  44637. so we can decide about writing it to disk or not
  44638. </member>
  44639. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetDefaultSheetView">
  44640. Return the default sheet view. This is the last one if the sheet's views, according to sec. 3.3.1.83
  44641. of the OOXML spec: "A single sheet view defInition. When more than 1 sheet view is defined in the file,
  44642. it means that when opening the workbook, each sheet view corresponds to a separate window within the
  44643. spreadsheet application, where each window is Showing the particular sheet. Containing the same
  44644. workbookViewId value, the last sheetView defInition is loaded, and the others are discarded.
  44645. When multiple windows are viewing the same sheet, multiple sheetView elements (with corresponding
  44646. workbookView entries) are saved."
  44647. </member>
  44648. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCommentsTable(System.Boolean)">
  44649. Returns the sheet's comments object if there is one,
  44650. or null if not
  44651. @param create create a new comments table if it does not exist
  44652. </member>
  44653. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetSharedFormula(System.Int32)">
  44654. Return a master shared formula by index
  44655. @param sid shared group index
  44656. @return a CT_CellFormula bean holding shared formula or <code>null</code> if not found
  44657. </member>
  44658. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsAutoFilterLocked">
  44659. @return true when Autofilters are locked and the sheet is protected.
  44660. </member>
  44661. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsDeleteColumnsLocked">
  44662. @return true when Deleting columns is locked and the sheet is protected.
  44663. </member>
  44664. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsDeleteRowsLocked">
  44665. @return true when Deleting rows is locked and the sheet is protected.
  44666. </member>
  44667. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsFormatCellsLocked">
  44668. @return true when Formatting cells is locked and the sheet is protected.
  44669. </member>
  44670. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsFormatColumnsLocked">
  44671. @return true when Formatting columns is locked and the sheet is protected.
  44672. </member>
  44673. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsFormatRowsLocked">
  44674. @return true when Formatting rows is locked and the sheet is protected.
  44675. </member>
  44676. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsInsertColumnsLocked">
  44677. @return true when Inserting columns is locked and the sheet is protected.
  44678. </member>
  44679. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsInsertHyperlinksLocked">
  44680. @return true when Inserting hyperlinks is locked and the sheet is protected.
  44681. </member>
  44682. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsInsertRowsLocked">
  44683. @return true when Inserting rows is locked and the sheet is protected.
  44684. </member>
  44685. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsPivotTablesLocked">
  44686. @return true when Pivot tables are locked and the sheet is protected.
  44687. </member>
  44688. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSortLocked">
  44689. @return true when Sorting is locked and the sheet is protected.
  44690. </member>
  44691. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsObjectsLocked">
  44692. @return true when Objects are locked and the sheet is protected.
  44693. </member>
  44694. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsScenariosLocked">
  44695. @return true when Scenarios are locked and the sheet is protected.
  44696. </member>
  44697. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSelectLockedCellsLocked">
  44698. @return true when Selection of locked cells is locked and the sheet is protected.
  44699. </member>
  44700. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSelectUnlockedCellsLocked">
  44701. @return true when Selection of unlocked cells is locked and the sheet is protected.
  44702. </member>
  44703. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSheetLocked">
  44704. @return true when Sheet is Protected.
  44705. </member>
  44706. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.EnableLocking">
  44707. Enable sheet protection
  44708. </member>
  44709. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.DisableLocking">
  44710. Disable sheet protection
  44711. </member>
  44712. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockAutoFilter(System.Boolean)">
  44713. Enable or disable Autofilters locking.
  44714. This does not modify sheet protection status.
  44715. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  44716. </member>
  44717. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockDeleteColumns(System.Boolean)">
  44718. Enable or disable Deleting columns locking.
  44719. This does not modify sheet protection status.
  44720. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  44721. </member>
  44722. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockDeleteRows(System.Boolean)">
  44723. Enable or disable Deleting rows locking.
  44724. This does not modify sheet protection status.
  44725. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  44726. </member>
  44727. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockFormatCells(System.Boolean)">
  44728. Enable or disable Formatting cells locking.
  44729. This does not modify sheet protection status.
  44730. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  44731. </member>
  44732. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockFormatColumns(System.Boolean)">
  44733. Enable or disable Formatting columns locking.
  44734. This does not modify sheet protection status.
  44735. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  44736. </member>
  44737. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockFormatRows(System.Boolean)">
  44738. Enable or disable Formatting rows locking.
  44739. This does not modify sheet protection status.
  44740. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  44741. </member>
  44742. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockInsertColumns(System.Boolean)">
  44743. Enable or disable Inserting columns locking.
  44744. This does not modify sheet protection status.
  44745. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  44746. </member>
  44747. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockInsertHyperlinks(System.Boolean)">
  44748. Enable or disable Inserting hyperlinks locking.
  44749. This does not modify sheet protection status.
  44750. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  44751. </member>
  44752. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockInsertRows(System.Boolean)">
  44753. Enable or disable Inserting rows locking.
  44754. This does not modify sheet protection status.
  44755. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  44756. </member>
  44757. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockPivotTables(System.Boolean)">
  44758. Enable or disable Pivot Tables locking.
  44759. This does not modify sheet protection status.
  44760. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  44761. </member>
  44762. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockSort(System.Boolean)">
  44763. Enable or disable Sort locking.
  44764. This does not modify sheet protection status.
  44765. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  44766. </member>
  44767. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockObjects(System.Boolean)">
  44768. Enable or disable Objects locking.
  44769. This does not modify sheet protection status.
  44770. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  44771. </member>
  44772. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockScenarios(System.Boolean)">
  44773. Enable or disable Scenarios locking.
  44774. This does not modify sheet protection status.
  44775. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  44776. </member>
  44777. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockSelectLockedCells(System.Boolean)">
  44778. Enable or disable Selection of locked cells locking.
  44779. This does not modify sheet protection status.
  44780. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  44781. </member>
  44782. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockSelectUnlockedCells(System.Boolean)">
  44783. Enable or disable Selection of unlocked cells locking.
  44784. This does not modify sheet protection status.
  44785. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  44786. </member>
  44787. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCellRange(NPOI.SS.Util.CellRangeAddress)">
  44788. Also Creates cells if they don't exist
  44789. </member>
  44790. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateTable">
  44791. Creates a new Table, and associates it with this Sheet
  44792. </member>
  44793. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetTables">
  44794. Returns any tables associated with this Sheet
  44795. </member>
  44796. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetTabColor(System.Int32)">
  44797. Set background color of the sheet tab
  44798. @param colorIndex the indexed color to set, must be a constant from {@link IndexedColors}
  44799. </member>
  44800. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.TabColor">
  44801. <summary>
  44802. Get or set background color of the sheet tab.
  44803. The value is null if no sheet tab color is set.
  44804. </summary>
  44805. </member>
  44806. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreatePivotTable">
  44807. Creates an empty XSSFPivotTable and Sets up all its relationships
  44808. including: pivotCacheDefInition, pivotCacheRecords
  44809. @return returns a pivotTable
  44810. </member>
  44811. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreatePivotTable(NPOI.SS.Util.AreaReference,NPOI.SS.Util.CellReference,NPOI.SS.UserModel.ISheet)">
  44812. Create a pivot table using the AreaReference range on sourceSheet, at the given position.
  44813. If the source reference contains a sheet name, it must match the sourceSheet
  44814. @param source location of pivot data
  44815. @param position A reference to the top left cell where the pivot table will start
  44816. @param sourceSheet The sheet containing the source data, if the source reference doesn't contain a sheet name
  44817. @throws IllegalArgumentException if source references a sheet different than sourceSheet
  44818. @return The pivot table
  44819. </member>
  44820. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreatePivotTable(NPOI.SS.Util.CellReference,NPOI.SS.UserModel.ISheet,NPOI.XSSF.UserModel.IPivotTableReferenceConfigurator)">
  44821. Create a pivot table using the AreaReference or named/table range on sourceSheet, at the given position.
  44822. If the source reference contains a sheet name, it must match the sourceSheet.
  44823. @param sourceRef location of pivot data - mutually exclusive with SourceName
  44824. @param sourceName range or table name for pivot data - mutually exclusive with SourceRef
  44825. @param position A reference to the top left cell where the pivot table will start
  44826. @param sourceSheet The sheet containing the source data, if the source reference doesn't contain a sheet name
  44827. @throws IllegalArgumentException if source references a sheet different than sourceSheet
  44828. @return The pivot table
  44829. </member>
  44830. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreatePivotTable(NPOI.SS.Util.AreaReference,NPOI.SS.Util.CellReference)">
  44831. Create a pivot table using the AreaReference range, at the given position.
  44832. If the source reference contains a sheet name, that sheet is used, otherwise this sheet is assumed as the source sheet.
  44833. @param source location of pivot data
  44834. @param position A reference to the top left cell where the pivot table will start
  44835. @return The pivot table
  44836. </member>
  44837. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreatePivotTable(NPOI.SS.UserModel.IName,NPOI.SS.Util.CellReference,NPOI.SS.UserModel.ISheet)">
  44838. Create a pivot table using the Name range reference on sourceSheet, at the given position.
  44839. If the source reference contains a sheet name, it must match the sourceSheet
  44840. @param source location of pivot data
  44841. @param position A reference to the top left cell where the pivot table will start
  44842. @param sourceSheet The sheet containing the source data, if the source reference doesn't contain a sheet name
  44843. @ if source references a sheet different than sourceSheet
  44844. @return The pivot table
  44845. </member>
  44846. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreatePivotTable(NPOI.SS.UserModel.IName,NPOI.SS.Util.CellReference)">
  44847. Create a pivot table using the Name range, at the given position.
  44848. If the source reference contains a sheet name, that sheet is used, otherwise this sheet is assumed as the source sheet.
  44849. @param source location of pivot data
  44850. @param position A reference to the top left cell where the pivot table will start
  44851. @return The pivot table
  44852. </member>
  44853. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreatePivotTable(NPOI.SS.UserModel.ITable,NPOI.SS.Util.CellReference)">
  44854. Create a pivot table using the Table, at the given position.
  44855. Tables are required to have a sheet reference, so no additional logic around reference sheet is needed.
  44856. @param source location of pivot data
  44857. @param position A reference to the top left cell where the pivot table will start
  44858. @return The pivot table
  44859. </member>
  44860. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetPivotTables">
  44861. Returns all the pivot tables for this Sheet
  44862. </member>
  44863. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AddIgnoredErrors(NPOI.SS.Util.CellReference,NPOI.SS.UserModel.IgnoredErrorType[])">
  44864. Add ignored errors (usually to suppress them in the UI of a consuming
  44865. application).
  44866. @param cell Cell.
  44867. @param ignoredErrorTypes Types of error to ignore there.
  44868. </member>
  44869. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AddIgnoredErrors(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.IgnoredErrorType[])">
  44870. Ignore errors across a range of cells.
  44871. @param region Range of cells.
  44872. @param ignoredErrorTypes Types of error to ignore there.
  44873. </member>
  44874. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetIgnoredErrors">
  44875. Returns the errors currently being ignored and the ranges
  44876. where they are ignored.
  44877. @return Map of error type to the range(s) where they are ignored.
  44878. </member>
  44879. <member name="T:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting">
  44880. XSSF Conditional Formattings
  44881. </member>
  44882. <member name="F:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.CF_EXT_2009_NS_X14">
  44883. Office 2010 Conditional Formatting extensions namespace
  44884. </member>
  44885. <member name="M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.ComparisonOperator,System.String,System.String)">
  44886. A factory method allowing to create a conditional formatting rule
  44887. with a cell comparison operator<p/>
  44888. TODO - formulas Containing cell references are currently not Parsed properly
  44889. @param comparisonOperation - a constant value from
  44890. <tt>{@link NPOI.hssf.record.CFRuleRecord.ComparisonOperator}</tt>: <p>
  44891. <ul>
  44892. <li>BETWEEN</li>
  44893. <li>NOT_BETWEEN</li>
  44894. <li>EQUAL</li>
  44895. <li>NOT_EQUAL</li>
  44896. <li>GT</li>
  44897. <li>LT</li>
  44898. <li>GE</li>
  44899. <li>LE</li>
  44900. </ul>
  44901. </p>
  44902. @param formula1 - formula for the valued, Compared with the cell
  44903. @param formula2 - second formula (only used with
  44904. {@link NPOI.ss.usermodel.ComparisonOperator#BETWEEN}) and
  44905. {@link NPOI.ss.usermodel.ComparisonOperator#NOT_BETWEEN} operations)
  44906. </member>
  44907. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.CreateConditionalFormattingRule(System.String)" -->
  44908. <member name="M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.IconSet)">
  44909. A factory method allowing the creation of conditional formatting
  44910. rules using an Icon Set / Multi-State formatting.
  44911. The thresholds for it will be created, but will be empty
  44912. and require configuring with
  44913. {@link XSSFConditionalFormattingRule#getMultiStateFormatting()}
  44914. then
  44915. {@link XSSFIconMultiStateFormatting#getThresholds()}
  44916. </member>
  44917. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.XSSF.UserModel.XSSFColor)" -->
  44918. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.CreateConditionalFormattingColorScaleRule" -->
  44919. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.UserModel.IConditionalFormatting)" -->
  44920. <member name="M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.GetConditionalFormattingAt(System.Int32)">
  44921. Gets Conditional Formatting object at a particular index
  44922. @param index
  44923. of the Conditional Formatting object to fetch
  44924. @return Conditional Formatting object
  44925. </member>
  44926. <member name="P:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.NumConditionalFormattings">
  44927. @return number of Conditional Formatting objects of the sheet
  44928. </member>
  44929. <member name="M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.RemoveConditionalFormatting(System.Int32)">
  44930. Removes a Conditional Formatting object by index
  44931. @param index of a Conditional Formatting object to remove
  44932. </member>
  44933. <member name="T:NPOI.XSSF.UserModel.XSSFSimpleShape">
  44934. Represents a shape with a predefined geometry in a SpreadsheetML Drawing.
  44935. Possible shape types are defined in {@link NPOI.SS.UserModel.ShapeTypes}
  44936. </member>
  44937. <member name="F:NPOI.XSSF.UserModel.XSSFSimpleShape._paragraphs">
  44938. List of the paragraphs that make up the text in this shape
  44939. </member>
  44940. <member name="F:NPOI.XSSF.UserModel.XSSFSimpleShape.prototype">
  44941. A default instance of CTShape used for creating new shapes.
  44942. </member>
  44943. <member name="F:NPOI.XSSF.UserModel.XSSFSimpleShape.ctShape">
  44944. Xml bean that stores properties of this shape
  44945. </member>
  44946. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.Prototype">
  44947. Prototype with the default structure of a new auto-shape.
  44948. </member>
  44949. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.Text">
  44950. Returns the text from all paragraphs in the shape. Paragraphs are Separated by new lines.
  44951. @return text Contained within this shape or empty string
  44952. </member>
  44953. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.ProcessAutoNumGroup(System.Int32,System.Int32,System.Collections.Generic.List{System.Int32},System.Text.StringBuilder)">
  44954. </member>
  44955. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.GetBulletPrefix(NPOI.XSSF.UserModel.ListAutoNumber,System.Int32)">
  44956. Returns a string Containing an appropriate prefix for an auto-numbering bullet
  44957. @param scheme the auto-numbering scheme used by the bullet
  44958. @param value the value of the bullet
  44959. @return appropriate prefix for an auto-numbering bullet
  44960. </member>
  44961. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.valueToAlpha(System.Int32)">
  44962. Convert an integer to its alpha equivalent e.g. 1 = A, 2 = B, 27 = AA etc
  44963. </member>
  44964. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.valueToRoman(System.Int32)">
  44965. Convert an integer to its roman equivalent e.g. 1 = I, 9 = IX etc
  44966. </member>
  44967. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.ClearText">
  44968. Clear all text from this shape
  44969. </member>
  44970. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.SetText(System.String)">
  44971. Set a single paragraph of text on the shape. Note this will replace all existing paragraphs Created on the shape.
  44972. @param text string representing the paragraph text
  44973. </member>
  44974. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.SetText(NPOI.XSSF.UserModel.XSSFRichTextString)">
  44975. Set a single paragraph of text on the shape. Note this will replace all existing paragraphs Created on the shape.
  44976. @param str rich text string representing the paragraph text
  44977. </member>
  44978. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.TextParagraphs">
  44979. Returns a collection of the XSSFTextParagraphs that are attached to this shape
  44980. @return text paragraphs in this shape
  44981. </member>
  44982. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.AddNewTextParagraph">
  44983. Add a new paragraph run to this shape
  44984. @return Created paragraph run
  44985. </member>
  44986. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.AddNewTextParagraph(System.String)">
  44987. Add a new paragraph run to this shape, Set to the provided string
  44988. @return Created paragraph run
  44989. </member>
  44990. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.AddNewTextParagraph(NPOI.XSSF.UserModel.XSSFRichTextString)">
  44991. Add a new paragraph run to this shape, Set to the provided rich text string
  44992. @return Created paragraph run
  44993. </member>
  44994. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.TextHorizontalOverflow">
  44995. Returns the type of horizontal overflow for the text.
  44996. @return the type of horizontal overflow
  44997. </member>
  44998. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.TextVerticalOverflow">
  44999. Returns the type of vertical overflow for the text.
  45000. @return the type of vertical overflow
  45001. </member>
  45002. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.VerticalAlignment">
  45003. Returns the type of vertical alignment for the text within the shape.
  45004. @return the type of vertical alignment
  45005. </member>
  45006. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.TextDirection">
  45007. Gets the vertical orientation of the text
  45008. @return vertical orientation of the text
  45009. </member>
  45010. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.BottomInset">
  45011. Returns the distance (in points) between the bottom of the text frame
  45012. and the bottom of the inscribed rectangle of the shape that Contains the text.
  45013. @return the bottom inset in points
  45014. </member>
  45015. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.LeftInset">
  45016. Returns the distance (in points) between the left edge of the text frame
  45017. and the left edge of the inscribed rectangle of the shape that Contains
  45018. the text.
  45019. @return the left inset in points
  45020. </member>
  45021. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.RightInset">
  45022. Returns the distance (in points) between the right edge of the
  45023. text frame and the right edge of the inscribed rectangle of the shape
  45024. that Contains the text.
  45025. @return the right inset in points
  45026. </member>
  45027. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.TopInset">
  45028. Returns the distance (in points) between the top of the text frame
  45029. and the top of the inscribed rectangle of the shape that Contains the text.
  45030. @return the top inset in points
  45031. </member>
  45032. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.WordWrap">
  45033. @return whether to wrap words within the bounding rectangle
  45034. </member>
  45035. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.TextAutofit">
  45036. Specifies that a shape should be auto-fit to fully contain the text described within it.
  45037. Auto-fitting is when text within a shape is scaled in order to contain all the text inside
  45038. @param value type of autofit
  45039. @return type of autofit
  45040. </member>
  45041. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.ShapeType">
  45042. Gets the shape type, one of the constants defined in {@link NPOI.SS.UserModel.ShapeTypes}.
  45043. @return the shape type
  45044. @see NPOI.SS.UserModel.ShapeTypes
  45045. </member>
  45046. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.ApplyAttributes(NPOI.OpenXmlFormats.Spreadsheet.CT_RPrElt,NPOI.OpenXmlFormats.Dml.CT_TextCharacterProperties)">
  45047. org.Openxmlformats.schemas.spreadsheetml.x2006.main.CTRPrElt to
  45048. org.Openxmlformats.schemas.Drawingml.x2006.main.CTFont adapter
  45049. </member>
  45050. <member name="T:NPOI.XSSF.UserModel.XSSFTable">
  45051. This class : the Table Part (Open Office XML Part 4:
  45052. chapter 3.5.1)
  45053. This implementation works under the assumption that a table Contains mappings to a subtree of an XML.
  45054. The root element of this subtree an occur multiple times (one for each row of the table). The child nodes
  45055. of the root element can be only attributes or element with maxOccurs=1 property set
  45056. @author Roberto Manicardi
  45057. </member>
  45058. <member name="M:NPOI.XSSF.UserModel.XSSFTable.MapsTo(System.Int64)">
  45059. Checks if this Table element Contains even a single mapping to the map identified by id
  45060. @param id the XSSFMap ID
  45061. @return true if the Table element contain mappings
  45062. </member>
  45063. <member name="M:NPOI.XSSF.UserModel.XSSFTable.GetCommonXpath">
  45064. Calculates the xpath of the root element for the table. This will be the common part
  45065. of all the mapping's xpaths
  45066. @return the xpath of the table's root element
  45067. </member>
  45068. <member name="M:NPOI.XSSF.UserModel.XSSFTable.GetXmlColumnPrs">
  45069. Note this list is static - once read, it does not notice later changes to the underlying column structures
  45070. @return List of XSSFXmlColumnPr
  45071. </member>
  45072. <member name="P:NPOI.XSSF.UserModel.XSSFTable.Name">
  45073. @return the name of the Table, if set
  45074. </member>
  45075. <member name="P:NPOI.XSSF.UserModel.XSSFTable.DisplayName">
  45076. @return the display name of the Table, if set
  45077. </member>
  45078. <member name="P:NPOI.XSSF.UserModel.XSSFTable.NumberOfMappedColumns">
  45079. @return the number of mapped table columns (see Open Office XML Part 4: chapter 3.5.1.4)
  45080. </member>
  45081. <member name="P:NPOI.XSSF.UserModel.XSSFTable.StartCellReference">
  45082. @return The reference for the cell in the top-left part of the table
  45083. (see Open Office XML Part 4: chapter 3.5.1.2, attribute ref)
  45084. To synchronize with changes to the underlying CTTable,
  45085. call {@link #updateReferences()}.
  45086. </member>
  45087. <member name="P:NPOI.XSSF.UserModel.XSSFTable.EndCellReference">
  45088. @return The reference for the cell in the bottom-right part of the table
  45089. (see Open Office XML Part 4: chapter 3.5.1.2, attribute ref)
  45090. Does not track updates to underlying changes to CTTable
  45091. To synchronize with changes to the underlying CTTable,
  45092. call {@link #updateReferences()}.
  45093. </member>
  45094. <member name="M:NPOI.XSSF.UserModel.XSSFTable.SetCellReferences">
  45095. @since POI 3.15 beta 3
  45096. </member>
  45097. <member name="M:NPOI.XSSF.UserModel.XSSFTable.UpdateReferences">
  45098. Clears the cached values set by {@link #getStartCellReference()}
  45099. and {@link #getEndCellReference()}.
  45100. The next call to {@link #getStartCellReference()} and
  45101. {@link #getEndCellReference()} will synchronize the
  45102. cell references with the underlying <code>CTTable</code>.
  45103. Thus, {@link #updateReferences()} is inexpensive.
  45104. @since POI 3.15 beta 3
  45105. </member>
  45106. <member name="P:NPOI.XSSF.UserModel.XSSFTable.RowCount">
  45107. @return the total number of rows in the selection. (Note: in this version autofiltering is ignored)
  45108. Returns 0 if the start or end cell references are not set.
  45109. To synchronize with changes to the underlying CTTable,
  45110. call {@link #updateReferences()}.
  45111. </member>
  45112. <member name="M:NPOI.XSSF.UserModel.XSSFTable.UpdateHeaders">
  45113. Synchronize table headers with cell values in the parent sheet.
  45114. Headers <em>must</em> be in sync, otherwise Excel will display a
  45115. "Found unreadable content" message on startup.
  45116. If calling both {@link #updateReferences()} and
  45117. {@link #updateHeaders()}, {@link #updateReferences()}
  45118. should be called first.
  45119. </member>
  45120. <member name="M:NPOI.XSSF.UserModel.XSSFTable.FindColumnIndex(System.String)">
  45121. Gets the relative column index of a column in this table having the header name <code>column</code>.
  45122. The column index is relative to the left-most column in the table, 0-indexed.
  45123. Returns <code>-1</code> if <code>column</code> is not a header name in table.
  45124. Column Header names are case-insensitive
  45125. Note: this function caches column names for performance. To flush the cache (because columns
  45126. have been moved or column headers have been changed), {@link #updateHeaders()} must be called.
  45127. @since 3.15 beta 2
  45128. </member>
  45129. <member name="T:NPOI.XSSF.UserModel.XSSFTextBox">
  45130. Represents a text box in a SpreadsheetML Drawing.
  45131. @author Yegor Kozlov
  45132. </member>
  45133. <member name="T:NPOI.XSSF.UserModel.XSSFTextParagraph">
  45134. Represents a paragraph of text within the Containing text body.
  45135. The paragraph is the highest level text separation mechanism.
  45136. </member>
  45137. <member name="M:NPOI.XSSF.UserModel.XSSFTextParagraph.AddNewTextRun">
  45138. Add a new run of text
  45139. @return a new run of text
  45140. </member>
  45141. <member name="M:NPOI.XSSF.UserModel.XSSFTextParagraph.AddLineBreak">
  45142. Insert a line break
  45143. @return text run representing this line break ('\n')
  45144. </member>
  45145. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.TextAlign">
  45146. get or set the alignment that is to be applied to the paragraph.
  45147. Possible values for this include left, right, centered, justified and distributed,
  45148. If this attribute is omitted, then a value of left is implied.
  45149. @return alignment that is applied to the paragraph
  45150. </member>
  45151. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.TextFontAlign">
  45152. Determines where vertically on a line of text the actual words are positioned. This deals
  45153. with vertical placement of the characters with respect to the baselines. For instance
  45154. having text anchored to the top baseline, anchored to the bottom baseline, centered in
  45155. between, etc.
  45156. If this attribute is omitted, then a value of baseline is implied.
  45157. @return alignment that is applied to the paragraph
  45158. </member>
  45159. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.BulletFont">
  45160. @return the font to be used on bullet characters within a given paragraph
  45161. </member>
  45162. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.BulletCharacter">
  45163. @return the character to be used in place of the standard bullet point
  45164. </member>
  45165. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.BulletFontColor">
  45166. @return the color of bullet characters within a given paragraph.
  45167. A <code>null</code> value means to use the text font color.
  45168. </member>
  45169. <!-- Badly formed XML comment ignored for member "P:NPOI.XSSF.UserModel.XSSFTextParagraph.BulletFontSize" -->
  45170. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.Indent">
  45171. @return the indent applied to the first line of text in the paragraph.
  45172. </member>
  45173. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.LeftMargin">
  45174. Specifies the left margin of the paragraph. This is specified in Addition to the text body
  45175. inset and applies only to this text paragraph. That is the text body inset and the LeftMargin
  45176. attributes are Additive with respect to the text position.
  45177. @param value the left margin of the paragraph, -1 to clear the margin and use the default of 0.
  45178. </member>
  45179. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.RightMargin">
  45180. Specifies the right margin of the paragraph. This is specified in Addition to the text body
  45181. inset and applies only to this text paragraph. That is the text body inset and the marR
  45182. attributes are Additive with respect to the text position.
  45183. @param value the right margin of the paragraph, -1 to clear the margin and use the default of 0.
  45184. </member>
  45185. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.DefaultTabSize">
  45186. @return the default size for a tab character within this paragraph in points
  45187. </member>
  45188. <member name="M:NPOI.XSSF.UserModel.XSSFTextParagraph.AddTabStop(System.Double)">
  45189. Add a single tab stop to be used on a line of text when there are one or more tab characters
  45190. present within the text.
  45191. @param value the position of the tab stop relative to the left margin
  45192. </member>
  45193. <!-- Badly formed XML comment ignored for member "P:NPOI.XSSF.UserModel.XSSFTextParagraph.LineSpacing" -->
  45194. <!-- Badly formed XML comment ignored for member "P:NPOI.XSSF.UserModel.XSSFTextParagraph.SpaceBefore" -->
  45195. <!-- Badly formed XML comment ignored for member "P:NPOI.XSSF.UserModel.XSSFTextParagraph.SpaceAfter" -->
  45196. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.Level">
  45197. Specifies the particular level text properties that this paragraph will follow.
  45198. The value for this attribute formats the text according to the corresponding level
  45199. paragraph properties defined in the list of styles associated with the body of text
  45200. that this paragraph belongs to (therefore in the parent shape).
  45201. <p>
  45202. Note that the closest properties object to the text is used, therefore if there is
  45203. a conflict between the text paragraph properties and the list style properties for
  45204. this level then the text paragraph properties will take precedence.
  45205. </p>
  45206. Returns the level of text properties that this paragraph will follow.
  45207. @return the text level of this paragraph (0-based). Default is 0.
  45208. </member>
  45209. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.IsBullet">
  45210. Returns whether this paragraph has bullets
  45211. </member>
  45212. <member name="M:NPOI.XSSF.UserModel.XSSFTextParagraph.SetBullet(System.Boolean)">
  45213. Set or unset this paragraph as a bullet point
  45214. @param flag whether text in this paragraph has bullets
  45215. </member>
  45216. <member name="M:NPOI.XSSF.UserModel.XSSFTextParagraph.SetBullet(NPOI.XSSF.UserModel.ListAutoNumber,System.Int32)">
  45217. Set this paragraph as an automatic numbered bullet point
  45218. @param scheme type of auto-numbering
  45219. @param startAt the number that will start number for a given sequence of automatically
  45220. numbered bullets (1-based).
  45221. </member>
  45222. <member name="M:NPOI.XSSF.UserModel.XSSFTextParagraph.SetBullet(NPOI.XSSF.UserModel.ListAutoNumber)">
  45223. Set this paragraph as an automatic numbered bullet point
  45224. @param scheme type of auto-numbering
  45225. </member>
  45226. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.IsBulletAutoNumber">
  45227. Returns whether this paragraph has automatic numbered bullets
  45228. </member>
  45229. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.BulletAutoNumberStart">
  45230. Returns the starting number if this paragraph has automatic numbered bullets, otherwise returns 0
  45231. </member>
  45232. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.BulletAutoNumberScheme">
  45233. Returns the auto number scheme if this paragraph has automatic numbered bullets, otherwise returns ListAutoNumber.ARABIC_PLAIN
  45234. </member>
  45235. <member name="T:NPOI.XSSF.UserModel.XSSFTextRun">
  45236. Represents a run of text within the Containing text body. The run element is the
  45237. lowest level text separation mechanism within a text body.
  45238. </member>
  45239. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.FontSize">
  45240. @return font size in points or -1 if font size is not Set.
  45241. </member>
  45242. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.CharacterSpacing">
  45243. @return the spacing between characters within a text Run,
  45244. If this attribute is omitted then a value of 0 or no adjustment is assumed.
  45245. </member>
  45246. <member name="M:NPOI.XSSF.UserModel.XSSFTextRun.SetFont(System.String)">
  45247. Specifies the typeface, or name of the font that is to be used for this text Run.
  45248. @param typeface the font to apply to this text Run.
  45249. The value of <code>null</code> unsets the Typeface attribute from the underlying xml.
  45250. </member>
  45251. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.FontFamily">
  45252. @return font family or null if not Set
  45253. </member>
  45254. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.IsStrikethrough">
  45255. get or set whether a run of text will be formatted as strikethrough text. Default is false.
  45256. </member>
  45257. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.IsSuperscript">
  45258. get or set whether a run of text will be formatted as a superscript text. Default is false.
  45259. Default base line offset is 30%
  45260. </member>
  45261. <member name="M:NPOI.XSSF.UserModel.XSSFTextRun.SetBaselineOffset(System.Double)">
  45262. Set the baseline for both the superscript and subscript fonts.
  45263. <p>
  45264. The size is specified using a percentage.
  45265. Positive values indicate superscript, negative values indicate subscript.
  45266. </p>
  45267. @param baselineOffset
  45268. </member>
  45269. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.IsSubscript">
  45270. get or set whether a run of text will be formatted as a superscript text. Default is false.
  45271. Default base line offset is -25%.
  45272. </member>
  45273. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.TextCap">
  45274. @return whether a run of text will be formatted as a superscript text. Default is false.
  45275. </member>
  45276. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.IsBold">
  45277. get or set whether this run of text is formatted as bold text
  45278. </member>
  45279. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.IsItalic">
  45280. get or set whether this run of text is formatted as italic text
  45281. </member>
  45282. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.IsUnderline">
  45283. get or set whether this run of text is formatted as underlined text
  45284. </member>
  45285. <member name="M:NPOI.XSSF.UserModel.XSSFVBAPart.#ctor">
  45286. Create a new XSSFVBAPart node
  45287. </member>
  45288. <member name="M:NPOI.XSSF.UserModel.XSSFVBAPart.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  45289. Construct XSSFVBAPart from a package part
  45290. @param part the package part holding the VBA data,
  45291. @param rel the package relationship holding this part
  45292. </member>
  45293. <member name="M:NPOI.XSSF.UserModel.XSSFVBAPart.PrepareForCommit">
  45294. Like *PictureData, VBA objects store the actual content in the part
  45295. directly without keeping a copy like all others therefore we need to
  45296. handle them differently.
  45297. </member>
  45298. <member name="T:NPOI.XSSF.UserModel.XSSFVMLDrawing">
  45299. Represents a SpreadsheetML VML Drawing.
  45300. <p>
  45301. In Excel 2007 VML Drawings are used to describe properties of cell comments,
  45302. although the spec says that VML is deprecated:
  45303. </p>
  45304. <p>
  45305. The VML format is a legacy format originally introduced with Office 2000 and is included and fully defined
  45306. in this Standard for backwards compatibility reasons. The DrawingML format is a newer and richer format
  45307. Created with the goal of eventually replacing any uses of VML in the Office Open XML formats. VML should be
  45308. considered a deprecated format included in Office Open XML for legacy reasons only and new applications that
  45309. need a file format for Drawings are strongly encouraged to use preferentially DrawingML
  45310. </p>
  45311. <p>
  45312. Warning - Excel is known to Put invalid XML into these files!
  45313. For example, &gt;br&lt; without being closed or escaped crops up.
  45314. </p>
  45315. See 6.4 VML - SpreadsheetML Drawing in Office Open XML Part 4 - Markup Language Reference.pdf
  45316. @author Yegor Kozlov
  45317. </member>
  45318. <member name="F:NPOI.XSSF.UserModel.XSSFVMLDrawing.ptrn_shapeId">
  45319. regexp to parse shape ids, in VML they have weird form of id="_x0000_s1026"
  45320. </member>
  45321. <member name="M:NPOI.XSSF.UserModel.XSSFVMLDrawing.#ctor">
  45322. Create a new SpreadsheetML Drawing
  45323. @see XSSFSheet#CreateDrawingPatriarch()
  45324. </member>
  45325. <member name="M:NPOI.XSSF.UserModel.XSSFVMLDrawing.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  45326. Construct a SpreadsheetML Drawing from a namespace part
  45327. @param part the namespace part holding the Drawing data,
  45328. the content type must be <code>application/vnd.Openxmlformats-officedocument.Drawing+xml</code>
  45329. @param rel the namespace relationship holding this Drawing,
  45330. the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/drawing
  45331. </member>
  45332. <member name="M:NPOI.XSSF.UserModel.XSSFVMLDrawing.newDrawing">
  45333. Initialize a new Speadsheet VML Drawing
  45334. </member>
  45335. <member name="M:NPOI.XSSF.UserModel.XSSFVMLDrawing.FindCommentShape(System.Int32,System.Int32)">
  45336. Find a shape with ClientData of type "NOTE" and the specified row and column
  45337. @return the comment shape or <code>null</code>
  45338. </member>
  45339. <member name="T:NPOI.XSSF.UserModel.XSSFWorkbook">
  45340. High level representation of a SpreadsheetML workbook. This is the first object most users
  45341. will construct whether they are Reading or writing a workbook. It is also the
  45342. top level object for creating new sheets/etc.
  45343. </member>
  45344. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.DEFAULT_CHARACTER_WIDTH">
  45345. Width of one character of the default font in pixels. Same for Calibry and Arial.
  45346. </member>
  45347. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.Max_SENSITIVE_SHEET_NAME_LEN">
  45348. Excel silently tRuncates long sheet names to 31 chars.
  45349. This constant is used to ensure uniqueness in the first 31 chars
  45350. </member>
  45351. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_EMF">
  45352. Extended windows meta file
  45353. </member>
  45354. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_WMF">
  45355. Windows Meta File
  45356. </member>
  45357. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_PICT">
  45358. Mac PICT format
  45359. </member>
  45360. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_JPEG">
  45361. JPEG format
  45362. </member>
  45363. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_PNG">
  45364. PNG format
  45365. </member>
  45366. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_DIB">
  45367. Device independent bitmap
  45368. </member>
  45369. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_GIF">
  45370. Images formats supported by XSSF but not by HSSF
  45371. </member>
  45372. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.workbook">
  45373. The underlying XML bean
  45374. </member>
  45375. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.sheets">
  45376. this holds the XSSFSheet objects attached to this workbook
  45377. </member>
  45378. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.namedRangesByName">
  45379. this holds the XSSFName objects attached to this workbook, keyed by lower-case name
  45380. </member>
  45381. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.namedRanges">
  45382. this holds the XSSFName objects attached to this workbook
  45383. </member>
  45384. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.sharedStringSource">
  45385. shared string table - a cache of strings in this workbook
  45386. </member>
  45387. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.stylesSource">
  45388. A collection of shared objects used for styling content,
  45389. e.g. fonts, cell styles, colors, etc.
  45390. </member>
  45391. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook._udfFinder">
  45392. The locator of user-defined functions.
  45393. By default includes functions from the Excel Analysis Toolpack
  45394. </member>
  45395. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.calcChain">
  45396. TODO
  45397. </member>
  45398. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.externalLinks">
  45399. External Links, for referencing names or cells in other workbooks.
  45400. </member>
  45401. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.mapInfo">
  45402. A collection of custom XML mappings
  45403. </member>
  45404. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.formatter">
  45405. Used to keep track of the data formatter so that all
  45406. CreateDataFormatter calls return the same one for a given
  45407. book. This ensures that updates from one places is visible
  45408. someplace else.
  45409. </member>
  45410. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook._missingCellPolicy">
  45411. The policy to apply in the event of missing or
  45412. blank cells when fetching from a row.
  45413. See {@link NPOI.ss.usermodel.Row.MissingCellPolicy}
  45414. </member>
  45415. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.pictures">
  45416. array of pictures for this workbook
  45417. </member>
  45418. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook._creationHelper">
  45419. cached instance of XSSFCreationHelper for this workbook
  45420. @see {@link #getCreationHelper()}
  45421. </member>
  45422. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.pivotTables">
  45423. List of all pivot tables in workbook
  45424. </member>
  45425. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor">
  45426. Create a new SpreadsheetML workbook.
  45427. </member>
  45428. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor(NPOI.XSSF.UserModel.XSSFWorkbookType)">
  45429. Create a new SpreadsheetML workbook.
  45430. @param workbookType The type of workbook to make (.xlsx or .xlsm).
  45431. </member>
  45432. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage)">
  45433. Constructs a XSSFWorkbook object given a OpenXML4J <code>Package</code> object,
  45434. see <a href="http://poi.apache.org/oxml4j/">http://poi.apache.org/oxml4j/</a>.
  45435. Once you have finished working with the Workbook, you should close the package
  45436. by calling pkg.close, to avoid leaving file handles open.
  45437. Creating a XSSFWorkbook from a file-backed OPC Package has a lower memory
  45438. footprint than an InputStream backed one.
  45439. @param pkg the OpenXML4J <code>OPC Package</code> object.
  45440. </member>
  45441. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor(System.IO.Stream)">
  45442. Constructs a XSSFWorkbook object, by buffering the whole stream into memory
  45443. and then opening an {@link OPCPackage} object for it.
  45444. Using an {@link InputStream} requires more memory than using a File, so
  45445. if a {@link File} is available then you should instead do something like
  45446. <pre><code>
  45447. OPCPackage pkg = OPCPackage.open(path);
  45448. XSSFWorkbook wb = new XSSFWorkbook(pkg);
  45449. // work with the wb object
  45450. ......
  45451. pkg.close(); // gracefully closes the underlying zip file
  45452. </code></pre>
  45453. </member>
  45454. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor(System.IO.FileInfo)" -->
  45455. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor(System.String)" -->
  45456. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.ParseSheet(System.Collections.Generic.Dictionary{System.String,NPOI.XSSF.UserModel.XSSFSheet},NPOI.OpenXmlFormats.Spreadsheet.CT_Sheet)">
  45457. Not normally to be called externally, but possibly to be overridden to avoid
  45458. the DOM based parse of large sheets (see examples).
  45459. </member>
  45460. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.OnWorkbookCreate">
  45461. Create a new CT_Workbook with all values Set to default
  45462. </member>
  45463. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.newPackage(NPOI.XSSF.UserModel.XSSFWorkbookType,System.IO.Stream)">
  45464. Create a new SpreadsheetML namespace and Setup the default minimal content
  45465. </member>
  45466. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCTWorkbook">
  45467. Return the underlying XML bean
  45468. @return the underlying CT_Workbook bean
  45469. </member>
  45470. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.AddPicture(System.Byte[],System.Int32)">
  45471. Adds a picture to the workbook.
  45472. @param pictureData The bytes of the picture
  45473. @param format The format of the picture.
  45474. @return the index to this picture (0 based), the Added picture can be obtained from {@link #getAllPictures()} .
  45475. @see Workbook#PICTURE_TYPE_EMF
  45476. @see Workbook#PICTURE_TYPE_WMF
  45477. @see Workbook#PICTURE_TYPE_PICT
  45478. @see Workbook#PICTURE_TYPE_JPEG
  45479. @see Workbook#PICTURE_TYPE_PNG
  45480. @see Workbook#PICTURE_TYPE_DIB
  45481. @see #getAllPictures()
  45482. </member>
  45483. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.AddPicture(System.IO.Stream,System.Int32)">
  45484. Adds a picture to the workbook.
  45485. @param is The sream to read image from
  45486. @param format The format of the picture.
  45487. @return the index to this picture (0 based), the Added picture can be obtained from {@link #getAllPictures()} .
  45488. @see Workbook#PICTURE_TYPE_EMF
  45489. @see Workbook#PICTURE_TYPE_WMF
  45490. @see Workbook#PICTURE_TYPE_PICT
  45491. @see Workbook#PICTURE_TYPE_JPEG
  45492. @see Workbook#PICTURE_TYPE_PNG
  45493. @see Workbook#PICTURE_TYPE_DIB
  45494. @see #getAllPictures()
  45495. </member>
  45496. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CloneSheet(System.Int32)">
  45497. Create an XSSFSheet from an existing sheet in the XSSFWorkbook.
  45498. The Cloned sheet is a deep copy of the original.
  45499. @param sheetNum The index of the sheet to clone
  45500. @return XSSFSheet representing the Cloned sheet.
  45501. @throws ArgumentException if the sheet index in invalid
  45502. @throws POIXMLException if there were errors when cloning
  45503. </member>
  45504. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CloneSheet(System.Int32,System.String)">
  45505. Create an XSSFSheet from an existing sheet in the XSSFWorkbook.
  45506. The cloned sheet is a deep copy of the original but with a new given
  45507. name.
  45508. @param sheetNum The index of the sheet to clone
  45509. @param newName The name to set for the newly created sheet
  45510. @return XSSFSheet representing the cloned sheet.
  45511. @throws IllegalArgumentException if the sheet index or the sheet
  45512. name is invalid
  45513. @throws POIXMLException if there were errors when cloning
  45514. </member>
  45515. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.AddRelation(NPOI.RelationPart,NPOI.POIXMLDocumentPart)">
  45516. @since 3.14-Beta1
  45517. </member>
  45518. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetUniqueSheetName(System.String)">
  45519. Generate a valid sheet name based on the existing one. Used when cloning sheets.
  45520. @param srcName the original sheet name to
  45521. @return clone sheet name
  45522. </member>
  45523. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateCellStyle">
  45524. <summary>
  45525. Create a new XSSFCellStyle and add it to the workbook's style table
  45526. </summary>
  45527. <returns>the new XSSFCellStyle object</returns>
  45528. </member>
  45529. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateDataFormat">
  45530. <summary>
  45531. Returns the workbook's data format table (a factory for creating data format strings).
  45532. </summary>
  45533. <returns>the XSSFDataFormat object</returns>
  45534. </member>
  45535. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateFont">
  45536. <summary>
  45537. Create a new Font and add it to the workbook's font table
  45538. </summary>
  45539. <returns></returns>
  45540. </member>
  45541. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateSheet">
  45542. Create an XSSFSheet for this workbook, Adds it to the sheets and returns
  45543. the high level representation. Use this to create new sheets.
  45544. @return XSSFSheet representing the new sheet.
  45545. </member>
  45546. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateSheet(System.String)">
  45547. Create a new sheet for this Workbook and return the high level representation.
  45548. Use this to create new sheets.
  45549. <p>
  45550. Note that Excel allows sheet names up to 31 chars in length but other applications
  45551. (such as OpenOffice) allow more. Some versions of Excel crash with names longer than 31 chars,
  45552. others - tRuncate such names to 31 character.
  45553. </p>
  45554. <p>
  45555. POI's SpreadsheetAPI silently tRuncates the input argument to 31 characters.
  45556. Example:
  45557. <pre><code>
  45558. Sheet sheet = workbook.CreateSheet("My very long sheet name which is longer than 31 chars"); // will be tRuncated
  45559. assert 31 == sheet.SheetName.Length;
  45560. assert "My very long sheet name which i" == sheet.SheetName;
  45561. </code></pre>
  45562. </p>
  45563. Except the 31-character constraint, Excel applies some other rules:
  45564. <p>
  45565. Sheet name MUST be unique in the workbook and MUST NOT contain the any of the following characters:
  45566. <ul>
  45567. <li> 0x0000 </li>
  45568. <li> 0x0003 </li>
  45569. <li> colon (:) </li>
  45570. <li> backslash (\) </li>
  45571. <li> asterisk (*) </li>
  45572. <li> question mark (?) </li>
  45573. <li> forward slash (/) </li>
  45574. <li> opening square bracket ([) </li>
  45575. <li> closing square bracket (]) </li>
  45576. </ul>
  45577. The string MUST NOT begin or end with the single quote (') character.
  45578. </p>
  45579. <p>
  45580. See {@link org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)}
  45581. for a safe way to create valid names
  45582. </p>
  45583. @param sheetname sheetname to set for the sheet.
  45584. @return Sheet representing the new sheet.
  45585. @throws IllegalArgumentException if the name is null or invalid
  45586. or workbook already contains a sheet with this name
  45587. @see org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)
  45588. </member>
  45589. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.FindFont(System.Int16,System.Int16,System.Int16,System.String,System.Boolean,System.Boolean,NPOI.SS.UserModel.FontSuperScript,NPOI.SS.UserModel.FontUnderlineType)">
  45590. Finds a font that matches the one with the supplied attributes
  45591. </member>
  45592. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.FindFont(System.Boolean,System.Int16,System.Int16,System.String,System.Boolean,System.Boolean,NPOI.SS.UserModel.FontSuperScript,NPOI.SS.UserModel.FontUnderlineType)">
  45593. Finds a font that matches the one with the supplied attributes
  45594. </member>
  45595. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.FindFont(System.Boolean,NPOI.SS.UserModel.IColor,System.Int16,System.String,System.Boolean,System.Boolean,NPOI.SS.UserModel.FontSuperScript,NPOI.SS.UserModel.FontUnderlineType)">
  45596. Finds a font that matches the one with the supplied attributes
  45597. </member>
  45598. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.ActiveSheetIndex">
  45599. Convenience method to Get the active sheet. The active sheet is is the sheet
  45600. which is currently displayed when the workbook is viewed in Excel.
  45601. 'Selected' sheet(s) is a distinct concept.
  45602. </member>
  45603. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetAllPictures">
  45604. Gets all pictures from the Workbook.
  45605. @return the list of pictures (a list of {@link XSSFPictureData} objects.)
  45606. @see #AddPicture(byte[], int)
  45607. </member>
  45608. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCellStyleAt(System.Int32)">
  45609. Get the cell style object at the given index
  45610. @param idx index within the set of styles
  45611. @return XSSFCellStyle object at the index
  45612. </member>
  45613. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetFontAt(System.Int16)">
  45614. Get the font at the given index number
  45615. @param idx index number
  45616. @return XSSFFont at the index
  45617. </member>
  45618. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetName(System.String)">
  45619. <summary>
  45620. Get the first named range with the given name.
  45621. Note: names of named ranges are not unique as they are scoped by sheet.
  45622. {@link #getNames(String name)} returns all named ranges with the given name.
  45623. </summary>
  45624. <param name="name">named range name</param>
  45625. <returns>return XSSFName with the given name. <code>null</code> is returned no named range could be found.</returns>
  45626. </member>
  45627. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetNames(System.String)">
  45628. <summary>
  45629. Get the named ranges with the given name.
  45630. <i>Note:</i>Excel named ranges are case-insensitive and
  45631. this method performs a case-insensitive search.
  45632. </summary>
  45633. <param name="name">named range name</param>
  45634. <returns>return list of XSSFNames with the given name. An empty list if no named ranges could be found</returns>
  45635. </member>
  45636. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetAllNames">
  45637. <summary>
  45638. Get a list of all the named ranges in the workbook.
  45639. </summary>
  45640. <returns>return list of XSSFNames in the workbook</returns>
  45641. </member>
  45642. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetNameIndex(System.String)">
  45643. Gets the named range index by his name
  45644. <i>Note:</i>Excel named ranges are case-insensitive and
  45645. this method performs a case-insensitive search.
  45646. @param name named range name
  45647. @return named range index
  45648. </member>
  45649. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.NumCellStyles">
  45650. Get the number of styles the workbook Contains
  45651. @return count of cell styles
  45652. </member>
  45653. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.NumberOfFonts">
  45654. Get the number of fonts in the this workbook
  45655. @return number of fonts
  45656. </member>
  45657. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.NumberOfNames">
  45658. Get the number of named ranges in the this workbook
  45659. @return number of named ranges
  45660. </member>
  45661. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.NumberOfSheets">
  45662. Get the number of worksheets in the this workbook
  45663. @return number of worksheets
  45664. </member>
  45665. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetPrintArea(System.Int32)">
  45666. Retrieves the reference for the printarea of the specified sheet, the sheet name is Appended to the reference even if it was not specified.
  45667. @param sheetIndex Zero-based sheet index (0 Represents the first sheet to keep consistent with java)
  45668. @return String Null if no print area has been defined
  45669. </member>
  45670. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheet(System.String)">
  45671. Get sheet with the given name (case insensitive match)
  45672. @param name of the sheet
  45673. @return XSSFSheet with the name provided or <code>null</code> if it does not exist
  45674. </member>
  45675. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheetAt(System.Int32)" -->
  45676. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheetIndex(System.String)">
  45677. <summary>
  45678. Returns the index of the sheet by his name (case insensitive match)
  45679. </summary>
  45680. <param name="name">the sheet name</param>
  45681. <returns>index of the sheet (0 based) or -1 if not found</returns>
  45682. </member>
  45683. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheetIndex(NPOI.SS.UserModel.ISheet)">
  45684. Returns the index of the given sheet
  45685. @param sheet the sheet to look up
  45686. @return index of the sheet (0 based). <tt>-1</tt> if not found
  45687. </member>
  45688. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheetName(System.Int32)">
  45689. Get the sheet name
  45690. @param sheetIx Number
  45691. @return Sheet name
  45692. </member>
  45693. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetEnumerator">
  45694. Allows foreach loops:
  45695. <pre><code>
  45696. XSSFWorkbook wb = new XSSFWorkbook(package);
  45697. for(XSSFSheet sheet : wb){
  45698. }
  45699. </code></pre>
  45700. </member>
  45701. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsMacroEnabled">
  45702. Are we a normal workbook (.xlsx), or a
  45703. macro enabled workbook (.xlsm)?
  45704. </member>
  45705. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.RemoveName(NPOI.SS.UserModel.IName)">
  45706. As {@link #removeName(String)} is not necessarily unique
  45707. (name + sheet index is unique), this method is more accurate.
  45708. @param name the name to remove.
  45709. </member>
  45710. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.RemovePrintArea(System.Int32)">
  45711. Delete the printarea for the sheet specified
  45712. @param sheetIndex 0-based sheet index (0 = First Sheet)
  45713. </member>
  45714. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.RemoveSheetAt(System.Int32)">
  45715. Removes sheet at the given index.<p/>
  45716. Care must be taken if the Removed sheet is the currently active or only selected sheet in
  45717. the workbook. There are a few situations when Excel must have a selection and/or active
  45718. sheet. (For example when printing - see Bug 40414).<br/>
  45719. This method Makes sure that if the Removed sheet was active, another sheet will become
  45720. active in its place. Furthermore, if the Removed sheet was the only selected sheet, another
  45721. sheet will become selected. The newly active/selected sheet will have the same index, or
  45722. one less if the Removed sheet was the last in the workbook.
  45723. @param index of the sheet (0-based)
  45724. </member>
  45725. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.OnSheetDelete(System.Int32)">
  45726. Gracefully remove references to the sheet being deleted
  45727. @param index the 0-based index of the sheet to delete
  45728. </member>
  45729. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.MissingCellPolicy">
  45730. Retrieves the current policy on what to do when
  45731. Getting missing or blank cells from a row.
  45732. The default is to return blank and null cells.
  45733. {@link MissingCellPolicy}
  45734. </member>
  45735. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.ValidateSheetIndex(System.Int32)">
  45736. Validate sheet index
  45737. @param index the index to validate
  45738. @throws ArgumentException if the index is out of range (index
  45739. &lt; 0 || index &gt;= NumberOfSheets).
  45740. </member>
  45741. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.FirstVisibleTab">
  45742. Gets the first tab that is displayed in the list of tabs in excel.
  45743. @return integer that Contains the index to the active sheet in this book view.
  45744. </member>
  45745. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFWorkbook.SetPrintArea(System.Int32,System.String)" -->
  45746. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetPrintArea(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  45747. For the Convenience of Java Programmers maintaining pointers.
  45748. @see #setPrintArea(int, String)
  45749. @param sheetIndex Zero-based sheet index (0 = First Sheet)
  45750. @param startColumn Column to begin printarea
  45751. @param endColumn Column to end the printarea
  45752. @param startRow Row to begin the printarea
  45753. @param endRow Row to end the printarea
  45754. </member>
  45755. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateBuiltInName(System.String,System.Int32)">
  45756. Generates a NameRecord to represent a built-in region
  45757. @return a new NameRecord
  45758. @throws ArgumentException if sheetNumber is invalid
  45759. @throws POIXMLException if such a name already exists in the workbook
  45760. </member>
  45761. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSelectedTab(System.Int32)">
  45762. We only Set one sheet as selected for compatibility with HSSF.
  45763. </member>
  45764. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetName(System.Int32,System.String)">
  45765. Set the sheet name.
  45766. @param sheetIndex sheet number (0 based)
  45767. @param sheetname the new sheet name
  45768. @throws ArgumentException if the name is null or invalid
  45769. or workbook already Contains a sheet with this name
  45770. @see {@link #CreateSheet(String)}
  45771. @see {@link NPOI.ss.util.WorkbookUtil#CreateSafeSheetName(String nameProposal)}
  45772. for a safe way to create valid names
  45773. </member>
  45774. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetOrder(System.String,System.Int32)">
  45775. Sets the order of appearance for a given sheet.
  45776. @param sheetname the name of the sheet to reorder
  45777. @param pos the position that we want to insert the sheet into (0 based)
  45778. </member>
  45779. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SaveNamedRanges">
  45780. marshal named ranges from the {@link #namedRanges} collection to the underlying CT_Workbook bean
  45781. </member>
  45782. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.Write(System.IO.Stream,System.Boolean)">
  45783. <summary>
  45784. Write the document to the specified stream, and optionally leave the stream open without closing it.
  45785. </summary>
  45786. </member>
  45787. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSharedStringSource">
  45788. Returns SharedStringsTable - the cache of strings for this workbook
  45789. @return the shared string table
  45790. </member>
  45791. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetStylesSource">
  45792. Return a object representing a collection of shared objects used for styling content,
  45793. e.g. fonts, cell styles, colors, etc.
  45794. </member>
  45795. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetTheme">
  45796. Returns the Theme of current workbook.
  45797. </member>
  45798. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCreationHelper">
  45799. Returns an object that handles instantiating concrete
  45800. classes of the various instances for XSSF.
  45801. </member>
  45802. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.ContainsSheet(System.String,System.Int32)">
  45803. Determines whether a workbook Contains the provided sheet name.
  45804. For the purpose of comparison, long names are tRuncated to 31 chars.
  45805. @param name the name to Test (case insensitive match)
  45806. @param excludeSheetIdx the sheet to exclude from the check or -1 to include all sheets in the Check.
  45807. @return true if the sheet Contains the name, false otherwise.
  45808. </member>
  45809. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsDate1904">
  45810. <summary>
  45811. Gets a bool value that indicates whether the date systems used in the workbook starts in 1904.
  45812. The default value is false, meaning that the workbook uses the 1900 date system,
  45813. where 1/1/1900 is the first day in the system.
  45814. </summary>
  45815. <returns>True if the date systems used in the workbook starts in 1904</returns>
  45816. </member>
  45817. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetAllEmbedds">
  45818. Get the document's embedded files.
  45819. </member>
  45820. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsSheetHidden(System.Int32)">
  45821. Check whether a sheet is hidden.
  45822. <p>
  45823. Note that a sheet could instead be Set to be very hidden, which is different
  45824. ({@link #isSheetVeryHidden(int)})
  45825. </p>
  45826. @param sheetIx Number
  45827. @return <code>true</code> if sheet is hidden
  45828. </member>
  45829. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsSheetVeryHidden(System.Int32)">
  45830. Check whether a sheet is very hidden.
  45831. <p>
  45832. This is different from the normal hidden status
  45833. ({@link #isSheetHidden(int)})
  45834. </p>
  45835. @param sheetIx sheet index to check
  45836. @return <code>true</code> if sheet is very hidden
  45837. </member>
  45838. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetHidden(System.Int32,System.Boolean)">
  45839. Sets the visible state of this sheet.
  45840. <p>
  45841. Calling <code>setSheetHidden(sheetIndex, true)</code> is equivalent to
  45842. <code>setSheetHidden(sheetIndex, Workbook.SHEET_STATE_HIDDEN)</code>.
  45843. <br/>
  45844. Calling <code>setSheetHidden(sheetIndex, false)</code> is equivalent to
  45845. <code>setSheetHidden(sheetIndex, Workbook.SHEET_STATE_VISIBLE)</code>.
  45846. </p>
  45847. @param sheetIx the 0-based index of the sheet
  45848. @param hidden whether this sheet is hidden
  45849. @see #setSheetHidden(int, int)
  45850. </member>
  45851. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetHidden(System.Int32,NPOI.SS.UserModel.SheetState)">
  45852. Hide or unhide a sheet.
  45853. <ul>
  45854. <li>0 - visible. </li>
  45855. <li>1 - hidden. </li>
  45856. <li>2 - very hidden.</li>
  45857. </ul>
  45858. @param sheetIx the sheet index (0-based)
  45859. @param state one of the following <code>Workbook</code> constants:
  45860. <code>Workbook.SHEET_STATE_VISIBLE</code>,
  45861. <code>Workbook.SHEET_STATE_HIDDEN</code>, or
  45862. <code>Workbook.SHEET_STATE_VERY_HIDDEN</code>.
  45863. @throws ArgumentException if the supplied sheet index or state is invalid
  45864. </member>
  45865. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetHidden(System.Int32,System.Int32)">
  45866. <summary>
  45867. Hide or unhide a sheet.
  45868. </summary>
  45869. <param name="sheetIx">The sheet number</param>
  45870. <param name="hidden">0 for not hidden, 1 for hidden, 2 for very hidden</param>
  45871. </member>
  45872. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.OnDeleteFormula(NPOI.XSSF.UserModel.XSSFCell)">
  45873. Fired when a formula is deleted from this workbook,
  45874. for example when calling cell.SetCellFormula(null)
  45875. @see XSSFCell#setCellFormula(String)
  45876. </member>
  45877. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCalculationChain">
  45878. Return the CalculationChain object for this workbook
  45879. <p>
  45880. The calculation chain object specifies the order in which the cells in a workbook were last calculated
  45881. </p>
  45882. @return the <code>CalculationChain</code> object or <code>null</code> if not defined
  45883. </member>
  45884. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.ExternalLinksTable">
  45885. * Returns the list of {@link ExternalLinksTable} object for this workbook
  45886. *
  45887. * <p>The external links table specifies details of named ranges etc
  45888. * that are referenced from other workbooks, along with the last seen
  45889. * values of what they point to.</p>
  45890. *
  45891. * <p>Note that Excel uses index 0 for the current workbook, so the first
  45892. * External Links in a formula would be '[1]Foo' which corresponds to
  45893. * entry 0 in this list.</p>
  45894. * @return the <code>ExternalLinksTable</code> list, which may be empty
  45895. </member>
  45896. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCustomXMLMappings">
  45897. @return a collection of custom XML mappings defined in this workbook
  45898. </member>
  45899. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetMapInfo">
  45900. @return the helper class used to query the custom XML mapping defined in this workbook
  45901. </member>
  45902. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.LinkExternalWorkbook(System.String,NPOI.SS.UserModel.IWorkbook)">
  45903. Adds the External Link Table part and relations required to allow formulas
  45904. referencing the specified external workbook to be added to this one. Allows
  45905. formulas such as "[MyOtherWorkbook.xlsx]Sheet3!$A$5" to be added to the
  45906. file, for workbooks not already linked / referenced.
  45907. @param name The name the workbook will be referenced as in formulas
  45908. @param workbook The open workbook to fetch the link required information from
  45909. </member>
  45910. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsStructureLocked">
  45911. Specifies a bool value that indicates whether structure of workbook is locked. <br/>
  45912. A value true indicates the structure of the workbook is locked. Worksheets in the workbook can't be Moved,
  45913. deleted, hidden, unhidden, or Renamed, and new worksheets can't be inserted.<br/>
  45914. A value of false indicates the structure of the workbook is not locked.<br/>
  45915. @return true if structure of workbook is locked
  45916. </member>
  45917. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsWindowsLocked">
  45918. Specifies a bool value that indicates whether the windows that comprise the workbook are locked. <br/>
  45919. A value of true indicates the workbook windows are locked. Windows are the same size and position each time the
  45920. workbook is opened.<br/>
  45921. A value of false indicates the workbook windows are not locked.
  45922. @return true if windows that comprise the workbook are locked
  45923. </member>
  45924. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsRevisionLocked">
  45925. Specifies a bool value that indicates whether the workbook is locked for revisions.
  45926. @return true if the workbook is locked for revisions.
  45927. </member>
  45928. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.LockStructure">
  45929. Locks the structure of workbook.
  45930. </member>
  45931. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.UnlockStructure">
  45932. Unlocks the structure of workbook.
  45933. </member>
  45934. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.LockWindows">
  45935. Locks the windows that comprise the workbook.
  45936. </member>
  45937. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.UnlockWindows">
  45938. Unlocks the windows that comprise the workbook.
  45939. </member>
  45940. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.LockRevision">
  45941. Locks the workbook for revisions.
  45942. </member>
  45943. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.UnlockRevision">
  45944. Unlocks the workbook for revisions.
  45945. </member>
  45946. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.RemovePivotTables">
  45947. Remove Pivot Tables and PivotCaches from the workbooka
  45948. </member>
  45949. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetUDFFinder">
  45950. Returns the locator of user-defined functions.
  45951. <p>
  45952. The default instance : the built-in functions with the Excel Analysis Tool Pack.
  45953. To Set / Evaluate custom functions you need to register them as follows:
  45954. </p>
  45955. @return wrapped instance of UDFFinder that allows seeking functions both by index and name
  45956. </member>
  45957. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.AddToolPack(NPOI.SS.Formula.UDF.UDFFinder)">
  45958. Register a new toolpack in this workbook.
  45959. @param toopack the toolpack to register
  45960. </member>
  45961. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetForceFormulaRecalculation(System.Boolean)">
  45962. Whether the application shall perform a full recalculation when the workbook is opened.
  45963. <p>
  45964. Typically you want to force formula recalculation when you modify cell formulas or values
  45965. of a workbook previously Created by Excel. When Set to true, this flag will tell Excel
  45966. that it needs to recalculate all formulas in the workbook the next time the file is opened.
  45967. </p>
  45968. <p>
  45969. Note, that recalculation updates cached formula results and, thus, modifies the workbook.
  45970. Depending on the version, Excel may prompt you with "Do you want to save the Changes in <em>filename</em>?"
  45971. on close.
  45972. </p>
  45973. @param value true if the application will perform a full recalculation of
  45974. workbook values when the workbook is opened
  45975. @since 3.8
  45976. </member>
  45977. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetForceFormulaRecalculation">
  45978. Whether Excel will be asked to recalculate all formulas when the workbook is opened.
  45979. @since 3.8
  45980. </member>
  45981. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.SpreadsheetVersion">
  45982. <summary>
  45983. Returns the spreadsheet version (EXCLE2007) of this workbook
  45984. </summary>
  45985. </member>
  45986. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetTable(System.String)">
  45987. Returns the data table with the given name (case insensitive).
  45988. @param name the data table name (case-insensitive)
  45989. @return The Data table in the workbook named <tt>name</tt>, or <tt>null</tt> if no table is named <tt>name</tt>.
  45990. @since 3.15 beta 2
  45991. </member>
  45992. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.AddPivotCache(System.String)">
  45993. Add pivotCache to the workbook
  45994. </member>
  45995. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetVBAProject(System.IO.Stream)">
  45996. Adds a vbaProject.bin file to the workbook. This will change the workbook
  45997. type if necessary.
  45998. @throws IOException
  45999. </member>
  46000. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetVBAProject(NPOI.XSSF.UserModel.XSSFWorkbook)">
  46001. Adds a vbaProject.bin file taken from another, given workbook to this one.
  46002. @throws IOException
  46003. @throws InvalidFormatException
  46004. </member>
  46005. <member name="T:NPOI.XSSF.XLSBUnsupportedException">
  46006. We don't support .xlsb files, sorry
  46007. </member>
  46008. <member name="T:NPOI.XWPF.UserModel.ParagraphAlignment">
  46009. Specifies all types of alignment which are available to be applied to objects in a
  46010. WordProcessingML document
  46011. @author Yegor Kozlov
  46012. </member>
  46013. <member name="T:NPOI.OpenXml4Net.Exceptions.NotOfficeXmlFileException">
  46014. This exception is thrown when we try to open a file that doesn't
  46015. seem to actually be an OOXML (Office Open XML) file After all
  46016. </member>
  46017. <member name="T:NPOI.OpenXml4Net.Exceptions.ODFNotOfficeXmlFileException">
  46018. This exception is thrown when we are given an ODF-based file
  46019. (eg OpenOffice .ods) instead of an actually OOXML (Office Open XML) file
  46020. </member>
  46021. <member name="T:NPOI.OpenXml4Net.Exceptions.OLE2NotOfficeXmlFileException">
  46022. This exception is thrown when we are given an OLE2-based file
  46023. (eg Excel .xls) instead of an actually OOXML (Office Open XML) file
  46024. </member>
  46025. <member name="T:NPOI.OpenXml4Net.OPC.ContentTypes">
  46026. Open Packaging Convention content types (see Annex F : Standard Namespaces
  46027. and Content Types).
  46028. @author CDubettier define some constants, Julien Chable
  46029. </member>
  46030. <member name="F:NPOI.OpenXml4Net.OPC.ContentTypes.CORE_PROPERTIES_PART">
  46031. Core Properties part.
  46032. </member>
  46033. <member name="F:NPOI.OpenXml4Net.OPC.ContentTypes.DIGITAL_SIGNATURE_CERTIFICATE_PART">
  46034. Digital Signature Certificate part.
  46035. </member>
  46036. <member name="F:NPOI.OpenXml4Net.OPC.ContentTypes.DIGITAL_SIGNATURE_ORIGIN_PART">
  46037. Digital Signature Origin part.
  46038. </member>
  46039. <member name="F:NPOI.OpenXml4Net.OPC.ContentTypes.DIGITAL_SIGNATURE_XML_SIGNATURE_PART">
  46040. Digital Signature XML Signature part.
  46041. </member>
  46042. <member name="F:NPOI.OpenXml4Net.OPC.ContentTypes.RELATIONSHIPS_PART">
  46043. Relationships part.
  46044. </member>
  46045. <member name="F:NPOI.OpenXml4Net.OPC.ContentTypes.CUSTOM_XML_PART">
  46046. Custom XML part.
  46047. </member>
  46048. <member name="F:NPOI.OpenXml4Net.OPC.ContentTypes.PLAIN_OLD_XML">
  46049. Plain old xml. Note - OOXML uses application/xml, and not text/xml!
  46050. </member>
  46051. <member name="F:NPOI.OpenXml4Net.OPC.ContentTypes.IMAGE_TIFF">
  46052. TIFF image format.
  46053. @see <a href="http://partners.adobe.com/public/developer/tiff/index.html#spec">
  46054. http://partners.adobe.com/public/developer/tiff/index.html#spec</a>
  46055. </member>
  46056. <member name="F:NPOI.OpenXml4Net.OPC.ContentTypes.IMAGE_PICT">
  46057. Pict image format.
  46058. @see <a href="http://developer.apple.com/documentation/mac/QuickDraw/QuickDraw-2.html">
  46059. http://developer.apple.com/documentation/mac/QuickDraw/QuickDraw-2.html</a>
  46060. </member>
  46061. <member name="F:NPOI.OpenXml4Net.OPC.ContentTypes.XML">
  46062. XML file.
  46063. </member>
  46064. <!-- Badly formed XML comment ignored for member "T:NPOI.OpenXml4Net.OPC.Internal.ContentType" -->
  46065. <member name="F:NPOI.OpenXml4Net.OPC.Internal.ContentType.type">
  46066. Type in Type/Subtype.
  46067. </member>
  46068. <member name="F:NPOI.OpenXml4Net.OPC.Internal.ContentType.subType">
  46069. Subtype
  46070. </member>
  46071. <member name="F:NPOI.OpenXml4Net.OPC.Internal.ContentType.parameters">
  46072. Parameters
  46073. </member>
  46074. <member name="F:NPOI.OpenXml4Net.OPC.Internal.ContentType.patternTypeSubType">
  46075. Media type compiled pattern for parameters.
  46076. </member>
  46077. <member name="F:NPOI.OpenXml4Net.OPC.Internal.ContentType.patternTypeSubTypeParams">
  46078. Media type compiled pattern, with parameters.
  46079. </member>
  46080. <member name="F:NPOI.OpenXml4Net.OPC.Internal.ContentType.patternParams">
  46081. Pattern to match on just the parameters part, to work
  46082. around the Java Regexp group capture behaviour
  46083. </member>
  46084. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentType.#ctor(System.String)">
  46085. Constructor. Check the input with the RFC 2616 grammar.
  46086. @param contentType
  46087. The content type to store.
  46088. @throws InvalidFormatException
  46089. If the specified content type is not valid with RFC 2616.
  46090. </member>
  46091. <member name="P:NPOI.OpenXml4Net.OPC.Internal.ContentType.SubType">
  46092. Get the subtype.
  46093. @return The subtype of this content type.
  46094. </member>
  46095. <member name="P:NPOI.OpenXml4Net.OPC.Internal.ContentType.Type">
  46096. Get the type.
  46097. @return The type of this content type.
  46098. </member>
  46099. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentType.HasParameters">
  46100. Does this content type have any parameters associated with it?
  46101. </member>
  46102. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentType.GetParameterKeys">
  46103. Return the parameter keys
  46104. </member>
  46105. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentType.GetParameter(System.String)">
  46106. Gets the value associated to the specified key.
  46107. @param key
  46108. The key of the key/value pair.
  46109. @return The value associated to the specified key.
  46110. </member>
  46111. <member name="T:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager">
  46112. Manage package content types ([Content_Types].xml part).
  46113. @author Julien Chable
  46114. @version 1.0
  46115. </member>
  46116. <member name="F:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.CONTENT_TYPES_PART_NAME">
  46117. Content type part name.
  46118. </member>
  46119. <member name="F:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.TYPES_NAMESPACE_URI">
  46120. Content type namespace
  46121. </member>
  46122. <member name="F:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.container">
  46123. Reference to the package using this content type manager.
  46124. </member>
  46125. <!-- Badly formed XML comment ignored for member "F:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.defaultContentType" -->
  46126. <member name="F:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.overrideContentType">
  46127. Override content type tree.
  46128. </member>
  46129. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.#ctor(System.IO.Stream,NPOI.OpenXml4Net.OPC.OPCPackage)">
  46130. Constructor. Parses the content of the specified input stream.
  46131. @param in
  46132. If different of <i>null</i> then the content types part is
  46133. retrieve and parse.
  46134. @throws InvalidFormatException
  46135. If the content types part content is not valid.
  46136. </member>
  46137. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.AddContentType(NPOI.OpenXml4Net.OPC.PackagePartName,System.String)">
  46138. Build association extention-> content type (will be stored in
  46139. [Content_Types].xml) for example ContentType="image/png" Extension="png"
  46140. <p>
  46141. [M2.8]: When adding a new part to a package, the package implementer
  46142. shall ensure that a content type for that part is specified in the
  46143. Content Types stream; the package implementer shall perform the steps
  46144. described in &#167;9.1.2.3:
  46145. </p><p>
  46146. 1. Get the extension from the part name by taking the substring to the
  46147. right of the rightmost occurrence of the dot character (.) from the
  46148. rightmost segment.
  46149. </p><p>
  46150. 2. If a part name has no extension, a corresponding Override element
  46151. shall be added to the Content Types stream.
  46152. </p><p>
  46153. 3. Compare the resulting extension with the values specified for the
  46154. Extension attributes of the Default elements in the Content Types stream.
  46155. The comparison shall be case-insensitive ASCII.
  46156. </p><p>
  46157. 4. If there is a Default element with a matching Extension attribute,
  46158. then the content type of the new part shall be compared with the value of
  46159. the ContentType attribute. The comparison might be case-sensitive and
  46160. include every character regardless of the role it plays in the
  46161. content-type grammar of RFC 2616, or it might follow the grammar of RFC
  46162. 2616.
  46163. </p><p>
  46164. a. If the content types match, no further action is required.
  46165. </p><p>
  46166. b. If the content types do not match, a new Override element shall be
  46167. added to the Content Types stream. .
  46168. </p><p>
  46169. 5. If there is no Default element with a matching Extension attribute, a
  46170. new Default element or Override element shall be added to the Content
  46171. Types stream.
  46172. </p>
  46173. </member>
  46174. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.AddOverrideContentType(NPOI.OpenXml4Net.OPC.PackagePartName,System.String)">
  46175. Add an override content type for a specific part.
  46176. @param partName
  46177. Name of the part.
  46178. @param contentType
  46179. Content type of the part.
  46180. </member>
  46181. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.AddDefaultContentType(System.String,System.String)">
  46182. Add a content type associated with the specified extension.
  46183. @param extension
  46184. The part name extension to bind to a content type.
  46185. @param contentType
  46186. The content type associated with the specified extension.
  46187. </member>
  46188. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.RemoveContentType(NPOI.OpenXml4Net.OPC.PackagePartName)">
  46189. <p>
  46190. Delete a content type based on the specified part name. If the specified
  46191. part name is register with an override content type, then this content
  46192. type is remove, else the content type is remove in the default content
  46193. type list if it exists and if no part is associated with it yet.
  46194. </p><p>
  46195. Check rule M2.4: The package implementer shall require that the Content
  46196. Types stream contain one of the following for every part in the package:
  46197. One matching Default element One matching Override element Both a
  46198. matching Default element and a matching Override element, in which case
  46199. the Override element takes precedence.
  46200. </p>
  46201. @param partName
  46202. The part URI associated with the override content type to
  46203. delete.
  46204. @exception InvalidOperationException
  46205. Throws if
  46206. </member>
  46207. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.IsContentTypeRegister(System.String)">
  46208. Check if the specified content type is already register.
  46209. @param contentType
  46210. The content type to check.
  46211. @return <code>true</code> if the specified content type is already
  46212. register, then <code>false</code>.
  46213. </member>
  46214. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.GetContentType(NPOI.OpenXml4Net.OPC.PackagePartName)">
  46215. Get the content type for the specified part, if any.
  46216. <p>
  46217. Rule [M2.9]: To get the content type of a part, the package implementer
  46218. shall perform the steps described in &#167;9.1.2.4:
  46219. </p><p>
  46220. 1. Compare the part name with the values specified for the PartName
  46221. attribute of the Override elements. The comparison shall be
  46222. case-insensitive ASCII.
  46223. </p><p>
  46224. 2. If there is an Override element with a matching PartName attribute,
  46225. return the value of its ContentType attribute. No further action is
  46226. required.
  46227. </p><p>
  46228. 3. If there is no Override element with a matching PartName attribute,
  46229. then a. Get the extension from the part name by taking the substring to
  46230. the right of the rightmost occurrence of the dot character (.) from the
  46231. rightmost segment. b. Check the Default elements of the Content Types
  46232. stream, comparing the extension with the value of the Extension
  46233. attribute. The comparison shall be case-insensitive ASCII.
  46234. </p><p>
  46235. 4. If there is a Default element with a matching Extension attribute,
  46236. return the value of its ContentType attribute. No further action is
  46237. required.
  46238. </p><p>
  46239. 5. If neither Override nor Default elements with matching attributes are
  46240. found for the specified part name, the implementation shall not map this
  46241. part name to a part.
  46242. </p>
  46243. @param partName
  46244. The URI part to check.
  46245. @return The content type associated with the URI (in case of an override
  46246. content type) or the extension (in case of default content type),
  46247. else <code>null</code>.
  46248. @exception OpenXml4NetRuntimeException
  46249. Throws if the content type manager is not able to find the
  46250. content from an existing part.
  46251. </member>
  46252. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.ClearAll">
  46253. Clear all content types.
  46254. </member>
  46255. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.ClearOverrideContentTypes">
  46256. Clear all override content types.
  46257. </member>
  46258. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.ParseContentTypesFile(System.IO.Stream)">
  46259. Parse the content types part.
  46260. @throws InvalidFormatException
  46261. Throws if the content type doesn't exist or the XML format is
  46262. invalid.
  46263. </member>
  46264. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.Save(Telerik.Windows.Zip.ZipArchive)">
  46265. Save the contents type part.
  46266. @param outStream
  46267. The output stream use to save the XML content of the content
  46268. types part.
  46269. @return <b>true</b> if the operation success, else <b>false</b>.
  46270. </member>
  46271. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.AppendSpecificTypes(System.Xml.XmlDocument,System.Xml.XmlElement,System.Collections.Generic.KeyValuePair{NPOI.OpenXml4Net.OPC.PackagePartName,System.String})">
  46272. Use to Append specific type XML elements, use by the save() method.
  46273. @param root
  46274. XML parent element use to Append this override type element.
  46275. @param entry
  46276. The values to Append.
  46277. @see #save(java.io.OutputStream)
  46278. </member>
  46279. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.AppendDefaultType(System.Xml.XmlDocument,System.Xml.XmlElement,System.Collections.Generic.KeyValuePair{System.String,System.String})">
  46280. Use to Append default types XML elements, use by the save() metid.
  46281. @param root
  46282. XML parent element use to Append this default type element.
  46283. @param entry
  46284. The values to Append.
  46285. @see #save(java.io.OutputStream)
  46286. </member>
  46287. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ContentTypeManager.SaveImpl(System.Xml.XmlDocument,Telerik.Windows.Zip.ZipArchive)">
  46288. Specific implementation of the save method. Call by the save() method,
  46289. call before exiting.
  46290. @param out
  46291. The output stream use to write the content type XML.
  46292. </member>
  46293. <member name="T:NPOI.OpenXml4Net.OPC.Internal.FileHelper">
  46294. Provide useful method to manage file.
  46295. @author Julien Chable
  46296. @version 0.1
  46297. </member>
  46298. <member name="M:NPOI.OpenXml4Net.OPC.Internal.FileHelper.GetDirectory(System.String)">
  46299. Get the directory part of the specified file path.
  46300. @param f
  46301. File to process.
  46302. @return The directory path from the specified
  46303. </member>
  46304. <member name="M:NPOI.OpenXml4Net.OPC.Internal.FileHelper.CopyFile(System.String,System.String)">
  46305. Copy a file.
  46306. @param in
  46307. The source file.
  46308. @param out
  46309. The target location.
  46310. @throws IOException
  46311. If an I/O error occur.
  46312. </member>
  46313. <member name="M:NPOI.OpenXml4Net.OPC.Internal.FileHelper.GetFilename(System.String)">
  46314. Get file name from the specified File object.
  46315. </member>
  46316. <member name="T:NPOI.OpenXml4Net.OPC.Internal.Marshallers.DefaultMarshaller">
  46317. Default marshaller that specified that the part is responsible to marshall its content.
  46318. @author Julien Chable
  46319. @version 1.0
  46320. @see PartMarshaller
  46321. </member>
  46322. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.DefaultMarshaller.Marshall(NPOI.OpenXml4Net.OPC.PackagePart,Telerik.Windows.Zip.ZipArchive)">
  46323. Save part in the output stream by using the save() method of the part.
  46324. @throws OpenXml4NetException
  46325. If any error occur.
  46326. </member>
  46327. <member name="T:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller">
  46328. Package properties marshaller.
  46329. @author CDubet, Julien Chable
  46330. </member>
  46331. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller.Marshall(NPOI.OpenXml4Net.OPC.PackagePart,Telerik.Windows.Zip.ZipArchive)">
  46332. Marshall package core properties to an XML document. Always return
  46333. <code>true</code>.
  46334. </member>
  46335. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller.AddCategory">
  46336. Add category property element if needed.
  46337. </member>
  46338. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller.AddContentStatus">
  46339. Add content status property element if needed.
  46340. </member>
  46341. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller.AddContentType">
  46342. Add content type property element if needed.
  46343. </member>
  46344. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller.AddCreated">
  46345. Add created property element if needed.
  46346. </member>
  46347. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller.AddCreator">
  46348. Add creator property element if needed.
  46349. </member>
  46350. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller.AddDescription">
  46351. Add description property element if needed.
  46352. </member>
  46353. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller.AddIdentifier">
  46354. Add identifier property element if needed.
  46355. </member>
  46356. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller.AddKeywords">
  46357. Add keywords property element if needed.
  46358. </member>
  46359. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller.AddLanguage">
  46360. Add language property element if needed.
  46361. </member>
  46362. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller.AddLastModifiedBy">
  46363. Add 'last modified by' property if needed.
  46364. </member>
  46365. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller.AddLastPrinted">
  46366. Add 'last printed' property if needed.
  46367. </member>
  46368. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller.AddModified">
  46369. Add modified property element if needed.
  46370. </member>
  46371. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller.AddRevision">
  46372. Add revision property if needed.
  46373. </member>
  46374. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller.AddSubject">
  46375. Add subject property if needed.
  46376. </member>
  46377. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.PackagePropertiesMarshaller.AddTitle">
  46378. Add title property if needed.
  46379. </member>
  46380. <member name="T:NPOI.OpenXml4Net.OPC.Internal.Marshallers.ZipPackagePropertiesMarshaller">
  46381. Package core properties marshaller specialized for zipped package.
  46382. @author Julien Chable
  46383. </member>
  46384. <member name="T:NPOI.OpenXml4Net.OPC.Internal.Marshallers.ZipPartMarshaller">
  46385. Zip part marshaller. This marshaller is use to save any part in a zip stream.
  46386. @author Julien Chable
  46387. </member>
  46388. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.ZipPartMarshaller.Marshall(NPOI.OpenXml4Net.OPC.PackagePart,Telerik.Windows.Zip.ZipArchive)">
  46389. Save the specified part.
  46390. @throws OpenXml4NetException
  46391. Throws if an internal exception is thrown.
  46392. </member>
  46393. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Marshallers.ZipPartMarshaller.MarshallRelationshipPart(NPOI.OpenXml4Net.OPC.PackageRelationshipCollection,NPOI.OpenXml4Net.OPC.PackagePartName,Telerik.Windows.Zip.ZipArchive)">
  46394. Save relationships into the part.
  46395. @param rels
  46396. The relationships collection to marshall.
  46397. @param relPartName
  46398. Part name of the relationship part to marshall.
  46399. @param zos
  46400. Zip output stream in which to save the XML content of the
  46401. relationships serialization.
  46402. </member>
  46403. <member name="F:NPOI.OpenXml4Net.OPC.Internal.MemoryPackagePart.data">
  46404. Storage for the part data.
  46405. </member>
  46406. <member name="M:NPOI.OpenXml4Net.OPC.Internal.MemoryPackagePart.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePartName,System.String)">
  46407. Constructor.
  46408. @param pack
  46409. The owner package.
  46410. @param partName
  46411. The part name.
  46412. @param contentType
  46413. The content type.
  46414. @throws InvalidFormatException
  46415. If the specified URI is not OPC compliant.
  46416. </member>
  46417. <member name="M:NPOI.OpenXml4Net.OPC.Internal.MemoryPackagePart.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePartName,System.String,System.Boolean)">
  46418. Constructor.
  46419. @param pack
  46420. The owner package.
  46421. @param partName
  46422. The part name.
  46423. @param contentType
  46424. The content type.
  46425. @param loadRelationships
  46426. Specify if the relationships will be loaded.
  46427. @throws InvalidFormatException
  46428. If the specified URI is not OPC compliant.
  46429. </member>
  46430. <member name="M:NPOI.OpenXml4Net.OPC.Internal.MemoryPackagePartOutputStream.Close">
  46431. Close this stream and flush the content.
  46432. @see #flush()
  46433. </member>
  46434. <member name="M:NPOI.OpenXml4Net.OPC.Internal.MemoryPackagePartOutputStream.Flush">
  46435. Flush this output stream. This method is called by the close() method.
  46436. Warning : don't call this method for output consistency.
  46437. @see #close()
  46438. </member>
  46439. <member name="T:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart">
  46440. Represents the core properties part of a package.
  46441. @author Julien Chable
  46442. @version 1.0
  46443. </member>
  46444. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePartName)">
  46445. Constructor.
  46446. @param pack
  46447. Container package.
  46448. @param partName
  46449. Name of this part.
  46450. @throws InvalidFormatException
  46451. Throws if the content is invalid.
  46452. </member>
  46453. <member name="F:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.category">
  46454. A categorization of the content of this package.
  46455. [Example: Example values for this property might include: Resume, Letter,
  46456. Financial Forecast, Proposal, Technical Presentation, and so on. This
  46457. value might be used by an application's user interface to facilitate
  46458. navigation of a large Set of documents. end example]
  46459. </member>
  46460. <member name="F:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.contentStatus">
  46461. The status of the content.
  46462. [Example: Values might include "Draft", "Reviewed", and "Final". end
  46463. example]
  46464. </member>
  46465. <member name="F:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.contentType">
  46466. The type of content represented, generally defined by a specific use and
  46467. intended audience.
  46468. [Example: Values might include "Whitepaper", "Security Bulletin", and
  46469. "Exam". end example] [Note: This property is distinct from MIME content
  46470. types as defined in RFC 2616. end note]
  46471. </member>
  46472. <member name="F:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.created">
  46473. Date of creation of the resource.
  46474. </member>
  46475. <member name="F:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.creator">
  46476. An entity primarily responsible for making the content of the resource.
  46477. </member>
  46478. <member name="F:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.description">
  46479. An explanation of the content of the resource.
  46480. [Example: Values might include an abstract, table of contents, reference
  46481. to a graphical representation of content, and a free-text account of the
  46482. content. end example]
  46483. </member>
  46484. <member name="F:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.identifier">
  46485. An unambiguous reference to the resource within a given context.
  46486. </member>
  46487. <member name="F:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.keywords">
  46488. A delimited Set of keywords to support searching and indexing. This is
  46489. typically a list of terms that are not available elsewhere in the
  46490. properties.
  46491. </member>
  46492. <member name="F:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.language">
  46493. The language of the intellectual content of the resource.
  46494. [Note: IETF RFC 3066 provides guidance on encoding to represent
  46495. languages. end note]
  46496. </member>
  46497. <member name="F:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.lastModifiedBy">
  46498. The user who performed the last modification. The identification is
  46499. environment-specific.
  46500. [Example: A name, email address, or employee ID. end example] It is
  46501. recommended that this value be as concise as possible.
  46502. </member>
  46503. <member name="F:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.lastPrinted">
  46504. The date and time of the last printing.
  46505. </member>
  46506. <member name="F:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.modified">
  46507. Date on which the resource was changed.
  46508. </member>
  46509. <member name="F:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.revision">
  46510. The revision number.
  46511. [Example: This value might indicate the number of saves or revisions,
  46512. provided the application updates it after each revision. end example]
  46513. </member>
  46514. <member name="F:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.subject">
  46515. The topic of the content of the resource.
  46516. </member>
  46517. <member name="F:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.title">
  46518. The name given to the resource.
  46519. </member>
  46520. <member name="F:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.version">
  46521. The version number. This value is Set by the user or by the application.
  46522. </member>
  46523. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetCategoryProperty">
  46524. Get the category property.
  46525. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#getCategoryProperty()
  46526. </member>
  46527. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetContentStatusProperty">
  46528. Get content status.
  46529. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#getContentStatusProperty()
  46530. </member>
  46531. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetContentTypeProperty">
  46532. Get content type.
  46533. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#getContentTypeProperty()
  46534. </member>
  46535. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetCreatedProperty">
  46536. Get created date.
  46537. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#getCreatedProperty()
  46538. </member>
  46539. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetCreatedPropertyString">
  46540. Get created date formated into a String.
  46541. @return A string representation of the created date.
  46542. </member>
  46543. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetCreatorProperty">
  46544. Get creator.
  46545. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#getCreatorProperty()
  46546. </member>
  46547. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetDescriptionProperty">
  46548. Get description.
  46549. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#getDescriptionProperty()
  46550. </member>
  46551. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetIdentifierProperty">
  46552. Get identifier.
  46553. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#getIdentifierProperty()
  46554. </member>
  46555. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetKeywordsProperty">
  46556. Get keywords.
  46557. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#getKeywordsProperty()
  46558. </member>
  46559. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetLanguageProperty">
  46560. Get the language.
  46561. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#getLanguageProperty()
  46562. </member>
  46563. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetLastModifiedByProperty">
  46564. Get the author of last modifications.
  46565. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#getLastModifiedByProperty()
  46566. </member>
  46567. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetLastPrintedProperty">
  46568. Get last printed date.
  46569. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#getLastPrintedProperty()
  46570. </member>
  46571. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetLastPrintedPropertyString">
  46572. Get last printed date formated into a String.
  46573. @return A string representation of the last printed date.
  46574. </member>
  46575. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetModifiedProperty">
  46576. Get modified date.
  46577. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#getModifiedProperty()
  46578. </member>
  46579. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetModifiedPropertyString">
  46580. Get modified date formated into a String.
  46581. @return A string representation of the modified date.
  46582. </member>
  46583. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetRevisionProperty">
  46584. Get revision.
  46585. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#getRevisionProperty()
  46586. </member>
  46587. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetSubjectProperty">
  46588. Get subject.
  46589. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#getSubjectProperty()
  46590. </member>
  46591. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetTitleProperty">
  46592. Get title.
  46593. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#getTitleProperty()
  46594. </member>
  46595. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetVersionProperty">
  46596. Get version.
  46597. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#getVersionProperty()
  46598. </member>
  46599. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetCategoryProperty(System.String)">
  46600. Set the category.
  46601. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setCategoryProperty(java.lang.String)
  46602. </member>
  46603. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetContentStatusProperty(System.String)">
  46604. Set the content status.
  46605. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setContentStatusProperty(java.lang.String)
  46606. </member>
  46607. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetContentTypeProperty(System.String)">
  46608. Set the content type.
  46609. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setContentTypeProperty(java.lang.String)
  46610. </member>
  46611. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetCreatedProperty(System.String)">
  46612. Set the created date.
  46613. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setCreatedProperty(org.apache.poi.OpenXml4Net.util.Nullable)
  46614. </member>
  46615. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetCreatedProperty(System.Nullable{System.DateTime})">
  46616. Set the created date.
  46617. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setCreatedProperty(org.apache.poi.OpenXml4Net.util.Nullable)
  46618. </member>
  46619. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetCreatorProperty(System.String)">
  46620. Set the creator.
  46621. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setCreatorProperty(java.lang.String)
  46622. </member>
  46623. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetDescriptionProperty(System.String)">
  46624. Set the description.
  46625. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setDescriptionProperty(java.lang.String)
  46626. </member>
  46627. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetIdentifierProperty(System.String)">
  46628. Set identifier.
  46629. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setIdentifierProperty(java.lang.String)
  46630. </member>
  46631. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetKeywordsProperty(System.String)">
  46632. Set keywords.
  46633. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setKeywordsProperty(java.lang.String)
  46634. </member>
  46635. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetLanguageProperty(System.String)">
  46636. Set language.
  46637. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setLanguageProperty(java.lang.String)
  46638. </member>
  46639. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetLastModifiedByProperty(System.String)">
  46640. Set last modifications author.
  46641. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setLastModifiedByProperty(java.lang.String)
  46642. </member>
  46643. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetLastPrintedProperty(System.String)">
  46644. Set last printed date.
  46645. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setLastPrintedProperty(org.apache.poi.OpenXml4Net.util.Nullable)
  46646. </member>
  46647. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetLastPrintedProperty(System.Nullable{System.DateTime})">
  46648. Set last printed date.
  46649. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setLastPrintedProperty(org.apache.poi.OpenXml4Net.util.Nullable)
  46650. </member>
  46651. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetModifiedProperty(System.String)">
  46652. Set last modification date.
  46653. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setModifiedProperty(org.apache.poi.OpenXml4Net.util.Nullable)
  46654. </member>
  46655. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetModifiedProperty(System.Nullable{System.DateTime})">
  46656. Set last modification date.
  46657. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setModifiedProperty(org.apache.poi.OpenXml4Net.util.Nullable)
  46658. </member>
  46659. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetRevisionProperty(System.String)">
  46660. Set revision.
  46661. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setRevisionProperty(java.lang.String)
  46662. </member>
  46663. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetSubjectProperty(System.String)">
  46664. Set subject.
  46665. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setSubjectProperty(java.lang.String)
  46666. </member>
  46667. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetTitleProperty(System.String)">
  46668. Set title.
  46669. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setTitleProperty(java.lang.String)
  46670. </member>
  46671. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetVersionProperty(System.String)">
  46672. Set version.
  46673. @see org.apache.poi.OpenXml4Net.opc.PackageProperties#setVersionProperty(java.lang.String)
  46674. </member>
  46675. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetStringValue(System.String)">
  46676. Convert a strig value into a String
  46677. </member>
  46678. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.SetDateValue(System.String)">
  46679. Convert a string value represented a date into a DateTime?.
  46680. @throws InvalidFormatException
  46681. Throws if the date format isnot valid.
  46682. </member>
  46683. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PackagePropertiesPart.GetDateValue(System.Nullable{System.DateTime})">
  46684. Convert a DateTime? into a String.
  46685. @param d
  46686. The Date to convert.
  46687. @return The formated date or null.
  46688. @see java.util.SimpleDateFormat
  46689. </member>
  46690. <member name="T:NPOI.OpenXml4Net.OPC.Internal.PartMarshaller">
  46691. Object implemented this interface are considered as part marshaller. A part
  46692. marshaller is responsible to marshall a part in order to be save in a
  46693. package.
  46694. @author Julien Chable
  46695. @version 0.1
  46696. </member>
  46697. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PartMarshaller.Marshall(NPOI.OpenXml4Net.OPC.PackagePart,Telerik.Windows.Zip.ZipArchive)">
  46698. Save the content of the package in the stream
  46699. @param part
  46700. Part to marshall.
  46701. @param out
  46702. The output stream into which the part will be marshall.
  46703. @return false if any marshall error occurs, else <b>true</b>
  46704. @throws OpenXml4NetException
  46705. Throws only if any other exceptions are thrown by inner
  46706. methods.
  46707. </member>
  46708. <member name="T:NPOI.OpenXml4Net.OPC.Internal.PartUnmarshaller">
  46709. Object implemented this interface are considered as part unmarshaller. A part
  46710. unmarshaller is responsible to unmarshall a part in order to load it from a
  46711. package.
  46712. @author Julien Chable
  46713. @version 0.1
  46714. </member>
  46715. <member name="M:NPOI.OpenXml4Net.OPC.Internal.PartUnmarshaller.Unmarshall(NPOI.OpenXml4Net.OPC.Internal.Unmarshallers.UnmarshallContext,System.IO.Stream)">
  46716. Save the content of the package in the stream
  46717. @param in
  46718. The input stream from which the part will be unmarshall.
  46719. @return The part freshly unmarshall from the input stream.
  46720. @throws OpenXml4NetException
  46721. Throws only if any other exceptions are thrown by inner
  46722. methods.
  46723. </member>
  46724. <member name="T:NPOI.OpenXml4Net.OPC.Internal.Unmarshallers.PackagePropertiesUnmarshaller">
  46725. Package properties unmarshaller.
  46726. @author Julien Chable
  46727. @version 1.0
  46728. </member>
  46729. <!-- Badly formed XML comment ignored for member "M:NPOI.OpenXml4Net.OPC.Internal.Unmarshallers.PackagePropertiesUnmarshaller.CheckElementForOPCCompliance(System.Xml.XmlElement)" -->
  46730. <member name="T:NPOI.OpenXml4Net.OPC.Internal.Unmarshallers.UnmarshallContext">
  46731. Context needed for the unmarshall process of a part. This class is immutable.
  46732. @author Julien Chable
  46733. @version 1.0
  46734. </member>
  46735. <member name="M:NPOI.OpenXml4Net.OPC.Internal.Unmarshallers.UnmarshallContext.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePartName)">
  46736. Constructor.
  46737. @param targetPackage
  46738. Container.
  46739. @param partName
  46740. Name of the part to unmarshall.
  46741. </member>
  46742. <member name="P:NPOI.OpenXml4Net.OPC.Internal.Unmarshallers.UnmarshallContext.Package">
  46743. @return the container
  46744. </member>
  46745. <member name="P:NPOI.OpenXml4Net.OPC.Internal.Unmarshallers.UnmarshallContext.PartName">
  46746. @return the partName
  46747. </member>
  46748. <member name="P:NPOI.OpenXml4Net.OPC.Internal.Unmarshallers.UnmarshallContext.ZipEntry">
  46749. @return the zipEntry
  46750. </member>
  46751. <member name="T:NPOI.OpenXml4Net.OPC.Internal.ZipContentTypeManager">
  46752. Zip implementation of the ContentTypeManager.
  46753. @author Julien Chable
  46754. @version 1.0
  46755. @see ContentTypeManager
  46756. </member>
  46757. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ZipContentTypeManager.#ctor(System.IO.Stream,NPOI.OpenXml4Net.OPC.OPCPackage)">
  46758. Delegate constructor to the super constructor.
  46759. @param in
  46760. The input stream to parse to fill internal content type
  46761. collections.
  46762. @throws InvalidFormatException
  46763. If the content types part content is not valid.
  46764. </member>
  46765. <member name="F:NPOI.OpenXml4Net.OPC.Internal.ZipHelper.FORWARD_SLASH">
  46766. Forward slash use to convert part name between OPC and zip item naming
  46767. conventions.
  46768. </member>
  46769. <member name="F:NPOI.OpenXml4Net.OPC.Internal.ZipHelper.READ_WRITE_FILE_BUFFER_SIZE">
  46770. Buffer to read data from file. Use big buffer to improve performaces. the
  46771. InputStream class is reading only 8192 bytes per read call (default value
  46772. set by sun)
  46773. </member>
  46774. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ZipHelper.#ctor">
  46775. Prevent this class to be instancied.
  46776. </member>
  46777. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ZipHelper.GetCorePropertiesZipEntry(NPOI.OpenXml4Net.OPC.ZipPackage)">
  46778. Retrieve the zip entry of the core properties part.
  46779. @throws OpenXml4NetException
  46780. Throws if internal error occurs.
  46781. </member>
  46782. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ZipHelper.GetContentTypeZipEntry(NPOI.OpenXml4Net.OPC.ZipPackage)">
  46783. Retrieve the Zip entry of the content types part.
  46784. </member>
  46785. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ZipHelper.GetOPCNameFromZipItemName(System.String)">
  46786. Convert a zip name into an OPC name by adding a leading forward slash to
  46787. the specified item name.
  46788. @param zipItemName
  46789. Zip item name to convert.
  46790. @return An OPC compliant name.
  46791. </member>
  46792. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ZipHelper.GetZipItemNameFromOPCName(System.String)">
  46793. Convert an OPC item name into a zip item name by removing any leading
  46794. forward slash if it exist.
  46795. @param opcItemName
  46796. The OPC item name to convert.
  46797. @return A zip item name without any leading slashes.
  46798. </member>
  46799. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ZipHelper.GetZipURIFromOPCName(System.String)">
  46800. Convert an OPC item name into a zip URI by removing any leading forward
  46801. slash if it exist.
  46802. @param opcItemName
  46803. The OPC item name to convert.
  46804. @return A zip URI without any leading slashes.
  46805. </member>
  46806. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ZipHelper.VerifyZipHeader(NPOI.Util.InputStream)">
  46807. Verifies that the given stream starts with a Zip structure.
  46808. Warning - this will consume the first few bytes of the stream,
  46809. you should push-back or reset the stream after use!
  46810. </member>
  46811. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ZipHelper.OpenZipStream(System.IO.Stream)">
  46812. Opens the specified stream as a secure zip
  46813. @param stream
  46814. The stream to open.
  46815. @return The zip stream freshly open.
  46816. </member>
  46817. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ZipHelper.OpenZipFile(System.IO.FileInfo)">
  46818. Opens the specified file as a zip, or returns null if no such file exists
  46819. @param file
  46820. The file to open.
  46821. @return The zip archive freshly open.
  46822. </member>
  46823. <member name="M:NPOI.OpenXml4Net.OPC.Internal.ZipHelper.OpenZipFile(System.String)">
  46824. Retrieve and open a zip file with the specified path.
  46825. @param path
  46826. The file path.
  46827. @return The zip archive freshly open.
  46828. </member>
  46829. <member name="T:NPOI.OpenXml4Net.OPC.OPCPackage">
  46830. Represents a container that can store multiple data objects.
  46831. @author Julien Chable, CDubet
  46832. @version 0.1
  46833. </member>
  46834. <member name="F:NPOI.OpenXml4Net.OPC.OPCPackage.logger">
  46835. Logger.
  46836. </member>
  46837. <member name="F:NPOI.OpenXml4Net.OPC.OPCPackage.defaultPackageAccess">
  46838. Default package access.
  46839. </member>
  46840. <member name="F:NPOI.OpenXml4Net.OPC.OPCPackage.packageAccess">
  46841. Package access.
  46842. </member>
  46843. <member name="F:NPOI.OpenXml4Net.OPC.OPCPackage.partList">
  46844. Package parts collection.
  46845. </member>
  46846. <member name="F:NPOI.OpenXml4Net.OPC.OPCPackage.relationships">
  46847. Package relationships.
  46848. </member>
  46849. <member name="F:NPOI.OpenXml4Net.OPC.OPCPackage.partMarshallers">
  46850. Part marshallers by content type.
  46851. </member>
  46852. <member name="F:NPOI.OpenXml4Net.OPC.OPCPackage.defaultPartMarshaller">
  46853. Default part marshaller.
  46854. </member>
  46855. <member name="F:NPOI.OpenXml4Net.OPC.OPCPackage.partUnmarshallers">
  46856. Part unmarshallers by content type.
  46857. </member>
  46858. <member name="F:NPOI.OpenXml4Net.OPC.OPCPackage.packageProperties">
  46859. Core package properties.
  46860. </member>
  46861. <member name="F:NPOI.OpenXml4Net.OPC.OPCPackage.contentTypeManager">
  46862. Manage parts content types of this package.
  46863. </member>
  46864. <member name="F:NPOI.OpenXml4Net.OPC.OPCPackage.isDirty">
  46865. Flag if a modification is done to the document.
  46866. </member>
  46867. <member name="F:NPOI.OpenXml4Net.OPC.OPCPackage.originalPackagePath">
  46868. File path of this package.
  46869. </member>
  46870. <member name="F:NPOI.OpenXml4Net.OPC.OPCPackage.output">
  46871. Output stream for writing this package.
  46872. </member>
  46873. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.#ctor(NPOI.OpenXml4Net.OPC.PackageAccess)">
  46874. Constructor.
  46875. @param access
  46876. Package access.
  46877. </member>
  46878. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.Init">
  46879. Initialize the package instance.
  46880. </member>
  46881. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.Open(System.String)">
  46882. Open a package with read/write permission.
  46883. @param path
  46884. The document path.
  46885. @return A Package object, else <b>null</b>.
  46886. @throws InvalidFormatException
  46887. If the specified file doesn't exist, and a parsing error
  46888. occur.
  46889. </member>
  46890. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.Open(System.IO.FileInfo)">
  46891. Open a package with read/write permission.
  46892. @param file
  46893. The file to open.
  46894. @return A Package object, else <b>null</b>.
  46895. @throws InvalidFormatException
  46896. If the specified file doesn't exist, and a parsing error
  46897. occur.
  46898. </member>
  46899. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.Open(System.String,NPOI.OpenXml4Net.OPC.PackageAccess)">
  46900. Open a package.
  46901. @param path
  46902. The document path.
  46903. @param access
  46904. PackageBase access.
  46905. @return A PackageBase object, else <b>null</b>.
  46906. @throws InvalidFormatException
  46907. If the specified file doesn't exist, and a parsing error
  46908. occur.
  46909. </member>
  46910. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.Open(System.IO.FileInfo,NPOI.OpenXml4Net.OPC.PackageAccess)">
  46911. Open a package.
  46912. @param file
  46913. The file to open.
  46914. @param access
  46915. PackageBase access.
  46916. @return A PackageBase object, else <b>null</b>.
  46917. @throws InvalidFormatException
  46918. If the specified file doesn't exist, and a parsing error
  46919. occur.
  46920. </member>
  46921. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.Open(System.IO.Stream)">
  46922. Open a package.
  46923. Note - uses quite a bit more memory than {@link #open(String)}, which
  46924. doesn't need to hold the whole zip file in memory, and can take advantage
  46925. of native methods
  46926. @param in
  46927. The InputStream to read the package from
  46928. @return A PackageBase object
  46929. </member>
  46930. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.OpenOrCreate(System.String)">
  46931. Opens a package if it exists, else it Creates one.
  46932. @param file
  46933. The file to open or to Create.
  46934. @return A newly Created package if the specified file does not exist,
  46935. else the package extract from the file.
  46936. @throws InvalidFormatException
  46937. Throws if the specified file exist and is not valid.
  46938. </member>
  46939. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.Create(System.String)">
  46940. Creates a new package.
  46941. @param file
  46942. Path of the document.
  46943. @return A newly Created PackageBase ready to use.
  46944. </member>
  46945. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.ConfigurePackage(NPOI.OpenXml4Net.OPC.OPCPackage)">
  46946. Configure the package.
  46947. @param pkg
  46948. </member>
  46949. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.Flush">
  46950. Flush the package : save all.
  46951. @see #close()
  46952. </member>
  46953. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.Close">
  46954. Close the package and save its content.
  46955. @throws IOException
  46956. If an IO exception occur during the saving process.
  46957. </member>
  46958. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.Revert">
  46959. Close the package WITHOUT saving its content. Reinitialize this package
  46960. and cancel all changes done to it.
  46961. </member>
  46962. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.AddThumbnail(System.String)">
  46963. <summary>
  46964. Add a thumbnail to the package. This method is provided to make easier
  46965. the addition of a thumbnail in a package. You can do the same work by
  46966. using the traditionnal relationship and part mechanism.
  46967. </summary>
  46968. <param name="path">path The full path to the image file.</param>
  46969. </member>
  46970. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.AddThumbnail(System.String,System.IO.Stream)">
  46971. <summary>
  46972. Add a thumbnail to the package. This method is provided to make easier
  46973. the addition of a thumbnail in a package. You can do the same work by
  46974. using the traditionnal relationship and part mechanism.
  46975. </summary>
  46976. <param name="filename"></param>
  46977. <param name="data"></param>
  46978. </member>
  46979. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.ThrowExceptionIfReadOnly">
  46980. Throws an exception if the package access mode is in read only mode
  46981. (PackageAccess.Read).
  46982. @throws InvalidOperationException
  46983. Throws if a writing operation is done on a read only package.
  46984. @see org.apache.poi.OpenXml4Net.opc.PackageAccess
  46985. </member>
  46986. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.ThrowExceptionIfWriteOnly">
  46987. Throws an exception if the package access mode is in write only mode
  46988. (PackageAccess.Write). This method is call when other methods need write
  46989. right.
  46990. @throws InvalidOperationException
  46991. Throws if a read operation is done on a write only package.
  46992. @see org.apache.poi.OpenXml4Net.opc.PackageAccess
  46993. </member>
  46994. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.GetPackageProperties">
  46995. Retrieves or Creates if none exists, core package property part.
  46996. @return The PackageProperties part of this package.
  46997. </member>
  46998. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.GetPart(NPOI.OpenXml4Net.OPC.PackagePartName)">
  46999. Retrieve a part identified by its name.
  47000. @param PartName
  47001. Part name of the part to retrieve.
  47002. @return The part with the specified name, else <code>null</code>.
  47003. </member>
  47004. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.GetPartsByContentType(System.String)">
  47005. Retrieve parts by content type.
  47006. @param contentType
  47007. The content type criteria.
  47008. @return All part associated to the specified content type.
  47009. </member>
  47010. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.GetPartsByRelationshipType(System.String)">
  47011. Retrieve parts by relationship type.
  47012. @param relationshipType
  47013. Relationship type.
  47014. @return All parts which are the target of a relationship with the
  47015. specified type, if the method can't retrieve relationships from
  47016. the package, then return <code>null</code>.
  47017. </member>
  47018. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.GetPartsByName(System.Text.RegularExpressions.Regex)">
  47019. Retrieve parts by name
  47020. @param namePattern
  47021. The pattern for matching the names
  47022. @return All parts associated to the specified content type, sorted
  47023. in alphanumerically by the part-name
  47024. </member>
  47025. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.GetPart(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  47026. Get the target part from the specified relationship.
  47027. @param partRel
  47028. The part relationship uses to retrieve the part.
  47029. </member>
  47030. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.GetParts">
  47031. Load the parts of the archive if it has not been done yet. The
  47032. relationships of each part are not loaded.
  47033. Note - Rule M4.1 states that there may only ever be one Core
  47034. Properties Part, but Office produced files will sometimes
  47035. have multiple! As Office ignores all but the first, we relax
  47036. Compliance with Rule M4.1, and ignore all others silently too.
  47037. @return All this package's parts.
  47038. </member>
  47039. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.CreatePart(NPOI.OpenXml4Net.OPC.PackagePartName,System.String)">
  47040. Create and Add a part, with the specified name and content type, to the
  47041. package.
  47042. @param PartName
  47043. Part name.
  47044. @param contentType
  47045. Part content type.
  47046. @return The newly Created part.
  47047. @throws InvalidFormatException
  47048. If rule M1.12 is not verified : Packages shall not contain
  47049. equivalent part names and package implementers shall neither
  47050. Create nor recognize packages with equivalent part names.
  47051. @see #CreatePartImpl(PackagePartName, String, bool)
  47052. </member>
  47053. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.CreatePart(NPOI.OpenXml4Net.OPC.PackagePartName,System.String,System.Boolean)">
  47054. Create and Add a part, with the specified name and content type, to the
  47055. package. For general purpose, prefer the overload version of this method
  47056. without the 'loadRelationships' parameter.
  47057. @param PartName
  47058. Part name.
  47059. @param contentType
  47060. Part content type.
  47061. @param loadRelationships
  47062. Specify if the existing relationship part, if any, logically
  47063. associated to the newly Created part will be loaded.
  47064. @return The newly Created part.
  47065. @throws InvalidFormatException
  47066. If rule M1.12 is not verified : Packages shall not contain
  47067. equivalent part names and package implementers shall neither
  47068. Create nor recognize packages with equivalent part names.
  47069. @see {@link#CreatePartImpl(URI, String)}
  47070. </member>
  47071. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.CreatePart(NPOI.OpenXml4Net.OPC.PackagePartName,System.String,System.IO.MemoryStream)">
  47072. Add a part to the package.
  47073. @param PartName
  47074. Part name of the part to Create.
  47075. @param contentType
  47076. type associated with the file
  47077. @param content
  47078. the contents to Add. In order to have faster operation in
  47079. document merge, the data are stored in memory not on a hard
  47080. disk
  47081. @return The new part.
  47082. @see #CreatePart(PackagePartName, String)
  47083. </member>
  47084. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.AddPackagePart(NPOI.OpenXml4Net.OPC.PackagePart)">
  47085. Add the specified part to the package. If a part already exists in the
  47086. package with the same name as the one specified, then we replace the old
  47087. part by the specified part.
  47088. @param part
  47089. The part to Add (or replace).
  47090. @return The part Added to the package, the same as the one specified.
  47091. @throws InvalidFormatException
  47092. If rule M1.12 is not verified : Packages shall not contain
  47093. equivalent part names and package implementers shall neither
  47094. Create nor recognize packages with equivalent part names.
  47095. </member>
  47096. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.RemovePart(NPOI.OpenXml4Net.OPC.PackagePart)">
  47097. Remove the specified part in this package. If this part is relationship
  47098. part, then delete all relationships in the source part.
  47099. @param part
  47100. The part to Remove. If <code>null</code>, skip the action.
  47101. @see #RemovePart(PackagePartName)
  47102. </member>
  47103. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.RemovePart(NPOI.OpenXml4Net.OPC.PackagePartName)">
  47104. Remove a part in this package. If this part is relationship part, then
  47105. delete all relationships in the source part.
  47106. @param PartName
  47107. The part name of the part to Remove.
  47108. </member>
  47109. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.RemovePartRecursive(NPOI.OpenXml4Net.OPC.PackagePartName)">
  47110. Remove a part from this package as well as its relationship part, if one
  47111. exists, and all parts listed in the relationship part. Be aware that this
  47112. do not delete relationships which target the specified part.
  47113. @param PartName
  47114. The name of the part to delete.
  47115. @throws InvalidFormatException
  47116. Throws if the associated relationship part of the specified
  47117. part is not valid.
  47118. </member>
  47119. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.DeletePart(NPOI.OpenXml4Net.OPC.PackagePartName)">
  47120. Delete the part with the specified name and its associated relationships
  47121. part if one exists. Prefer the use of this method to delete a part in the
  47122. package, compare to the Remove() methods that don't Remove associated
  47123. relationships part.
  47124. @param PartName
  47125. Name of the part to delete
  47126. </member>
  47127. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.DeletePartRecursive(NPOI.OpenXml4Net.OPC.PackagePartName)">
  47128. Delete the part with the specified name and all part listed in its
  47129. associated relationships part if one exists. This process is recursively
  47130. apply to all parts in the relationships part of the specified part.
  47131. Prefer the use of this method to delete a part in the package, compare to
  47132. the Remove() methods that don't Remove associated relationships part.
  47133. @param PartName
  47134. Name of the part to delete
  47135. </member>
  47136. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.ContainPart(NPOI.OpenXml4Net.OPC.PackagePartName)">
  47137. Check if a part already exists in this package from its name.
  47138. @param PartName
  47139. Part name to check.
  47140. @return <i>true</i> if the part is logically Added to this package, else
  47141. <i>false</i>.
  47142. </member>
  47143. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.AddRelationship(NPOI.OpenXml4Net.OPC.PackagePartName,NPOI.OpenXml4Net.OPC.TargetMode,System.String,System.String)">
  47144. Add a relationship to the package (except relationships part).
  47145. Check rule M4.1 : The format designer shall specify and the format
  47146. producer shall Create at most one core properties relationship for a
  47147. package. A format consumer shall consider more than one core properties
  47148. relationship for a package to be an error. If present, the relationship
  47149. shall target the Core Properties part.
  47150. Check rule M1.25: The Relationships part shall not have relationships to
  47151. any other part. Package implementers shall enforce this requirement upon
  47152. the attempt to Create such a relationship and shall treat any such
  47153. relationship as invalid.
  47154. @param targetPartName
  47155. Target part name.
  47156. @param targetMode
  47157. Target mode, either Internal or External.
  47158. @param relationshipType
  47159. Relationship type.
  47160. @param relID
  47161. ID of the relationship.
  47162. @see PackageRelationshipTypes
  47163. </member>
  47164. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.AddRelationship(NPOI.OpenXml4Net.OPC.PackagePartName,NPOI.OpenXml4Net.OPC.TargetMode,System.String)">
  47165. Add a package relationship.
  47166. @param targetPartName
  47167. Target part name.
  47168. @param targetMode
  47169. Target mode, either Internal or External.
  47170. @param relationshipType
  47171. Relationship type.
  47172. @see PackageRelationshipTypes
  47173. </member>
  47174. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.AddExternalRelationship(System.String,System.String)">
  47175. Adds an external relationship to a part (except relationships part).
  47176. The targets of external relationships are not subject to the same
  47177. validity checks that internal ones are, as the contents is potentially
  47178. any file, URL or similar.
  47179. @param target
  47180. External target of the relationship
  47181. @param relationshipType
  47182. Type of relationship.
  47183. @return The newly Created and Added relationship
  47184. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#AddExternalRelationship(java.lang.String,
  47185. java.lang.String)
  47186. </member>
  47187. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.AddExternalRelationship(System.String,System.String,System.String)">
  47188. Adds an external relationship to a part (except relationships part).
  47189. The targets of external relationships are not subject to the same
  47190. validity checks that internal ones are, as the contents is potentially
  47191. any file, URL or similar.
  47192. @param target
  47193. External target of the relationship
  47194. @param relationshipType
  47195. Type of relationship.
  47196. @param id
  47197. Relationship unique id.
  47198. @return The newly Created and Added relationship
  47199. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#AddExternalRelationship(java.lang.String,
  47200. java.lang.String)
  47201. </member>
  47202. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.RemoveRelationship(System.String)">
  47203. Delete a relationship from this package.
  47204. @param id
  47205. Id of the relationship to delete.
  47206. </member>
  47207. <member name="P:NPOI.OpenXml4Net.OPC.OPCPackage.Relationships">
  47208. Retrieves all package relationships.
  47209. @return All package relationships of this package.
  47210. @throws OpenXml4NetException
  47211. @see #GetRelationshipsHelper(String)
  47212. </member>
  47213. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.GetRelationshipsByType(System.String)">
  47214. Retrieves all relationships with the specified type.
  47215. @param relationshipType
  47216. The filter specifying the relationship type.
  47217. @return All relationships with the specified relationship type.
  47218. </member>
  47219. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.GetRelationshipsHelper(System.String)">
  47220. Retrieves all relationships with specified id (normally just ine because
  47221. a relationship id is supposed to be unique).
  47222. @param id
  47223. Id of the wanted relationship.
  47224. </member>
  47225. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.ClearRelationships">
  47226. Clear package relationships.
  47227. </member>
  47228. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.EnsureRelationships">
  47229. Ensure that the relationships collection is not null.
  47230. </member>
  47231. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.GetRelationship(System.String)">
  47232. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#GetRelationship(java.lang.String)
  47233. </member>
  47234. <member name="P:NPOI.OpenXml4Net.OPC.OPCPackage.HasRelationships">
  47235. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#hasRelationships()
  47236. </member>
  47237. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.IsRelationshipExists(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  47238. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#isRelationshipExists(org.apache.poi.OpenXml4Net.opc.PackageRelationship)
  47239. </member>
  47240. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.AddMarshaller(System.String,NPOI.OpenXml4Net.OPC.Internal.PartMarshaller)">
  47241. Add a marshaller.
  47242. @param contentType
  47243. The content type to bind to the specified marshaller.
  47244. @param marshaller
  47245. The marshaller to register with the specified content type.
  47246. </member>
  47247. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.AddUnmarshaller(System.String,NPOI.OpenXml4Net.OPC.Internal.PartUnmarshaller)">
  47248. Add an unmarshaller.
  47249. @param contentType
  47250. The content type to bind to the specified unmarshaller.
  47251. @param unmarshaller
  47252. The unmarshaller to register with the specified content type.
  47253. </member>
  47254. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.RemoveMarshaller(System.String)">
  47255. Remove a marshaller by its content type.
  47256. @param contentType
  47257. The content type associated with the marshaller to Remove.
  47258. </member>
  47259. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.RemoveUnmarshaller(System.String)">
  47260. Remove an unmarshaller by its content type.
  47261. @param contentType
  47262. The content type associated with the unmarshaller to Remove.
  47263. </member>
  47264. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.GetPackageAccess">
  47265. Get the package access mode.
  47266. @return the packageAccess The current package access.
  47267. </member>
  47268. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.ValidatePackage(NPOI.OpenXml4Net.OPC.OPCPackage)">
  47269. Validates the package compliance with the OPC specifications.
  47270. @return <b>true</b> if the package is valid else <b>false</b>
  47271. </member>
  47272. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.Save(System.String)">
  47273. Save the document in the specified file.
  47274. @param targetFile
  47275. Destination file.
  47276. @throws IOException
  47277. Throws if an IO exception occur.
  47278. @see #save(OutputStream)
  47279. </member>
  47280. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.Save(System.IO.Stream)">
  47281. Save the document in the specified output stream.
  47282. @param outputStream
  47283. The stream to save the package.
  47284. @see #saveImpl(OutputStream)
  47285. </member>
  47286. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.CreatePartImpl(NPOI.OpenXml4Net.OPC.PackagePartName,System.String,System.Boolean)">
  47287. Core method to Create a package part. This method must be implemented by
  47288. the subclass.
  47289. @param PartName
  47290. URI of the part to Create.
  47291. @param contentType
  47292. Content type of the part to Create.
  47293. @return The newly Created package part.
  47294. </member>
  47295. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.RemovePartImpl(NPOI.OpenXml4Net.OPC.PackagePartName)">
  47296. Core method to delete a package part. This method must be implemented by
  47297. the subclass.
  47298. @param PartName
  47299. The URI of the part to delete.
  47300. </member>
  47301. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.FlushImpl">
  47302. Flush the package but not save.
  47303. </member>
  47304. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.CloseImpl">
  47305. Close the package and cause a save of the package.
  47306. </member>
  47307. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.RevertImpl">
  47308. Close the package without saving the document. Discard all changes made
  47309. to this package.
  47310. </member>
  47311. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.SaveImpl(System.IO.Stream)">
  47312. Save the package into the specified output stream.
  47313. @param outputStream
  47314. The output stream use to save this package.
  47315. </member>
  47316. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.GetPartImpl(NPOI.OpenXml4Net.OPC.PackagePartName)">
  47317. Get the package part mapped to the specified URI.
  47318. @param PartName
  47319. The URI of the part to retrieve.
  47320. @return The package part located by the specified URI, else <b>null</b>.
  47321. </member>
  47322. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.GetPartsImpl">
  47323. Get all parts link to the package.
  47324. @return A list of the part owned by the package.
  47325. </member>
  47326. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.ReplaceContentType(System.String,System.String)">
  47327. Replace a content type in this package.
  47328. <p>
  47329. A typical scneario to call this method is to rename a template file to the main format, e.g.
  47330. ".dotx" to ".docx"
  47331. ".dotm" to ".docm"
  47332. ".xltx" to ".xlsx"
  47333. ".xltm" to ".xlsm"
  47334. ".potx" to ".pptx"
  47335. ".potm" to ".pptm"
  47336. </p>
  47337. For example, a code converting a .xlsm macro workbook to .xlsx would look as follows:
  47338. <p>
  47339. <pre><code>
  47340. OPCPackage pkg = OPCPackage.open(new FileInputStream("macro-workbook.xlsm"));
  47341. pkg.replaceContentType(
  47342. "application/vnd.ms-excel.sheet.macroEnabled.main+xml",
  47343. "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.main+xml");
  47344. FileOutputStream out = new FileOutputStream("workbook.xlsx");
  47345. pkg.save(out);
  47346. out.close();
  47347. </code></pre>
  47348. </p>
  47349. @param oldContentType the content type to be replaced
  47350. @param newContentType the replacement
  47351. @return whether replacement was succesfull
  47352. @since POI-3.8
  47353. </member>
  47354. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.RegisterPartAndContentType(NPOI.OpenXml4Net.OPC.PackagePart)">
  47355. Add the specified part, and register its content type with the content
  47356. type manager.
  47357. @param part
  47358. The part to add.
  47359. </member>
  47360. <member name="M:NPOI.OpenXml4Net.OPC.OPCPackage.UnregisterPartAndContentType(NPOI.OpenXml4Net.OPC.PackagePartName)">
  47361. Remove the specified part, and clear its content type from the content
  47362. type manager.
  47363. @param partName
  47364. The part name of the part to remove.
  47365. </member>
  47366. <member name="T:NPOI.OpenXml4Net.OPC.PackageAccess">
  47367. Specifies package access.
  47368. @author Julien Chable
  47369. @version 1.0
  47370. </member>
  47371. <member name="F:NPOI.OpenXml4Net.OPC.PackageAccess.READ">
  47372. Read only. Write not authorized.
  47373. </member>
  47374. <member name="F:NPOI.OpenXml4Net.OPC.PackageAccess.WRITE">
  47375. Write only. Read not authorized.
  47376. </member>
  47377. <member name="F:NPOI.OpenXml4Net.OPC.PackageAccess.READ_WRITE">
  47378. Read and Write mode.
  47379. </member>
  47380. <member name="T:NPOI.OpenXml4Net.OPC.PackageNamespaces">
  47381. Open Packaging Convention namespaces URI.
  47382. @author Julien Chable
  47383. @version 1.0
  47384. </member>
  47385. <member name="F:NPOI.OpenXml4Net.OPC.PackageNamespaces.NAMESPACE_DCTERMS">
  47386. Dublin Core Terms URI.
  47387. </member>
  47388. <member name="F:NPOI.OpenXml4Net.OPC.PackageNamespaces.NAMESPACE_DC">
  47389. Dublin Core namespace URI.
  47390. </member>
  47391. <member name="F:NPOI.OpenXml4Net.OPC.PackageNamespaces.CONTENT_TYPES">
  47392. Content Types.
  47393. </member>
  47394. <member name="F:NPOI.OpenXml4Net.OPC.PackageNamespaces.CORE_PROPERTIES">
  47395. Core Properties.
  47396. </member>
  47397. <member name="F:NPOI.OpenXml4Net.OPC.PackageNamespaces.DIGITAL_SIGNATURE">
  47398. Digital Signatures.
  47399. </member>
  47400. <member name="F:NPOI.OpenXml4Net.OPC.PackageNamespaces.RELATIONSHIPS">
  47401. Relationships.
  47402. </member>
  47403. <member name="F:NPOI.OpenXml4Net.OPC.PackageNamespaces.MARKUP_COMPATIBILITY">
  47404. Markup Compatibility.
  47405. </member>
  47406. <member name="T:NPOI.OpenXml4Net.OPC.PackagePart">
  47407. Provides a base class for parts stored in a Package.
  47408. @author Julien Chable
  47409. @version 0.9
  47410. </member>
  47411. <member name="F:NPOI.OpenXml4Net.OPC.PackagePart._container">
  47412. This part's container.
  47413. </member>
  47414. <member name="F:NPOI.OpenXml4Net.OPC.PackagePart._partName">
  47415. The part name. (required by the specification [M1.1])
  47416. </member>
  47417. <member name="F:NPOI.OpenXml4Net.OPC.PackagePart._contentType">
  47418. The type of content of this part. (required by the specification [M1.2])
  47419. </member>
  47420. <member name="F:NPOI.OpenXml4Net.OPC.PackagePart._isRelationshipPart">
  47421. Flag to know if this part is a relationship.
  47422. </member>
  47423. <member name="F:NPOI.OpenXml4Net.OPC.PackagePart._isDeleted">
  47424. Flag to know if this part has been logically deleted.
  47425. </member>
  47426. <member name="F:NPOI.OpenXml4Net.OPC.PackagePart._relationships">
  47427. This part's relationships.
  47428. </member>
  47429. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePartName,NPOI.OpenXml4Net.OPC.Internal.ContentType)">
  47430. Constructor.
  47431. @param pack
  47432. Parent package.
  47433. @param partName
  47434. The part name, relative to the parent Package root.
  47435. @param contentType
  47436. The content type.
  47437. @throws InvalidFormatException
  47438. If the specified URI is not valid.
  47439. </member>
  47440. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePartName,NPOI.OpenXml4Net.OPC.Internal.ContentType,System.Boolean)">
  47441. Constructor.
  47442. @param pack
  47443. Parent package.
  47444. @param partName
  47445. The part name, relative to the parent Package root.
  47446. @param contentType
  47447. The content type.
  47448. @param loadRelationships
  47449. Specify if the relationships will be loaded
  47450. @throws InvalidFormatException
  47451. If the specified URI is not valid.
  47452. </member>
  47453. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePartName,System.String)">
  47454. Constructor.
  47455. @param pack
  47456. Parent package.
  47457. @param partName
  47458. The part name, relative to the parent Package root.
  47459. @param contentType
  47460. The Multipurpose Internet Mail Extensions (MIME) content type
  47461. of the part's data stream.
  47462. </member>
  47463. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.AddExternalRelationship(System.String,System.String)">
  47464. Adds an external relationship to a part (except relationships part).
  47465. The targets of external relationships are not subject to the same
  47466. validity checks that internal ones are, as the contents is potentially
  47467. any file, URL or similar.
  47468. @param target
  47469. External target of the relationship
  47470. @param relationshipType
  47471. Type of relationship.
  47472. @return The newly created and added relationship
  47473. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#addExternalRelationship(java.lang.String,
  47474. java.lang.String)
  47475. </member>
  47476. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.AddExternalRelationship(System.String,System.String,System.String)">
  47477. Adds an external relationship to a part (except relationships part).
  47478. The targets of external relationships are not subject to the same
  47479. validity checks that internal ones are, as the contents is potentially
  47480. any file, URL or similar.
  47481. @param target
  47482. External target of the relationship
  47483. @param relationshipType
  47484. Type of relationship.
  47485. @param id
  47486. Relationship unique id.
  47487. @return The newly created and added relationship
  47488. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#addExternalRelationship(java.lang.String,
  47489. java.lang.String)
  47490. </member>
  47491. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.AddRelationship(NPOI.OpenXml4Net.OPC.PackagePartName,NPOI.OpenXml4Net.OPC.TargetMode,System.String)">
  47492. Add a relationship to a part (except relationships part).
  47493. @param targetPartName
  47494. Name of the target part. This one must be relative to the
  47495. source root directory of the part.
  47496. @param targetMode
  47497. Mode [Internal|External].
  47498. @param relationshipType
  47499. Type of relationship.
  47500. @return The newly created and added relationship
  47501. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#AddRelationship(org.apache.poi.OpenXml4Net.opc.PackagePartName,
  47502. org.apache.poi.OpenXml4Net.opc.TargetMode, java.lang.String)
  47503. </member>
  47504. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.AddRelationship(NPOI.OpenXml4Net.OPC.PackagePartName,NPOI.OpenXml4Net.OPC.TargetMode,System.String,System.String)">
  47505. Add a relationship to a part (except relationships part).
  47506. <p>
  47507. Check rule M1.25: The Relationships part shall not have relationships to
  47508. any other part. Package implementers shall enforce this requirement upon
  47509. the attempt to create such a relationship and shall treat any such
  47510. relationship as invalid.
  47511. </p>
  47512. @param targetPartName
  47513. Name of the target part. This one must be relative to the
  47514. source root directory of the part.
  47515. @param targetMode
  47516. Mode [Internal|External].
  47517. @param relationshipType
  47518. Type of relationship.
  47519. @param id
  47520. Relationship unique id.
  47521. @return The newly created and added relationship
  47522. @throws InvalidFormatException
  47523. If the URI point to a relationship part URI.
  47524. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#AddRelationship(org.apache.poi.OpenXml4Net.opc.PackagePartName,
  47525. org.apache.poi.OpenXml4Net.opc.TargetMode, java.lang.String, java.lang.String)
  47526. </member>
  47527. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.AddRelationship(System.Uri,NPOI.OpenXml4Net.OPC.TargetMode,System.String)">
  47528. Add a relationship to a part (except relationships part).
  47529. @param targetURI
  47530. URI the target part. Must be relative to the source root
  47531. directory of the part.
  47532. @param targetMode
  47533. Mode [Internal|External].
  47534. @param relationshipType
  47535. Type of relationship.
  47536. @return The newly created and added relationship
  47537. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#AddRelationship(org.apache.poi.OpenXml4Net.opc.PackagePartName,
  47538. org.apache.poi.OpenXml4Net.opc.TargetMode, java.lang.String)
  47539. </member>
  47540. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.AddRelationship(System.Uri,NPOI.OpenXml4Net.OPC.TargetMode,System.String,System.String)">
  47541. Add a relationship to a part (except relationships part).
  47542. <p>
  47543. Check rule M1.25: The Relationships part shall not have relationships to
  47544. any other part. Package implementers shall enforce this requirement upon
  47545. the attempt to create such a relationship and shall treat any such
  47546. relationship as invalid.
  47547. </p>
  47548. @param targetURI
  47549. URI of the target part. Must be relative to the source root
  47550. directory of the part.
  47551. @param targetMode
  47552. Mode [Internal|External].
  47553. @param relationshipType
  47554. Type of relationship.
  47555. @param id
  47556. Relationship unique id.
  47557. @return The newly created and added relationship
  47558. @throws InvalidFormatException
  47559. If the URI point to a relationship part URI.
  47560. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#AddRelationship(org.apache.poi.OpenXml4Net.opc.PackagePartName,
  47561. org.apache.poi.OpenXml4Net.opc.TargetMode, java.lang.String, java.lang.String)
  47562. </member>
  47563. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.ClearRelationships">
  47564. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#clearRelationships()
  47565. </member>
  47566. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.RemoveRelationship(System.String)">
  47567. Delete the relationship specified by its id.
  47568. @param id
  47569. The ID identified the part to delete.
  47570. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#removeRelationship(java.lang.String)
  47571. </member>
  47572. <member name="P:NPOI.OpenXml4Net.OPC.PackagePart.Relationships">
  47573. Retrieve all the relationships attached to this part.
  47574. @return This part's relationships.
  47575. @throws OpenXml4NetException
  47576. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#getRelationships()
  47577. </member>
  47578. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.GetRelationship(System.String)">
  47579. Retrieves a package relationship from its id.
  47580. @param id
  47581. ID of the package relationship to retrieve.
  47582. @return The package relationship
  47583. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#getRelationship(java.lang.String)
  47584. </member>
  47585. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.GetRelationshipsByType(System.String)">
  47586. Retrieve all relationships attached to this part which have the specified
  47587. type.
  47588. @param relationshipType
  47589. Relationship type filter.
  47590. @return All relationships from this part that have the specified type.
  47591. @throws InvalidFormatException
  47592. If an error occurs while parsing the part.
  47593. @throws InvalidOperationException
  47594. If the package is open in write only mode.
  47595. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#getRelationshipsByType(java.lang.String)
  47596. </member>
  47597. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.GetRelationshipsCore(System.String)">
  47598. Implementation of the getRelationships method().
  47599. @param filter
  47600. Relationship type filter. If <i>null</i> then the filter is
  47601. disabled and return all the relationships.
  47602. @return All relationships from this part that have the specified type.
  47603. @throws InvalidFormatException
  47604. Throws if an error occurs during parsing the relationships
  47605. part.
  47606. @throws InvalidOperationException
  47607. Throws if the package is open en write only mode.
  47608. @see #getRelationshipsByType(String)
  47609. </member>
  47610. <member name="P:NPOI.OpenXml4Net.OPC.PackagePart.HasRelationships">
  47611. Knows if the part have any relationships.
  47612. @return <b>true</b> if the part have at least one relationship else
  47613. <b>false</b>.
  47614. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#hasRelationships()
  47615. </member>
  47616. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.IsRelationshipExists(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  47617. Checks if the specified relationship is part of this package part.
  47618. @param rel
  47619. The relationship to check.
  47620. @return <b>true</b> if the specified relationship exists in this part,
  47621. else returns <b>false</b>
  47622. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#isRelationshipExists(org.apache.poi.OpenXml4Net.opc.PackageRelationship)
  47623. </member>
  47624. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.GetRelatedPart(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  47625. Get the PackagePart that is the target of a relationship.
  47626. @param rel A relationship from this part to another one
  47627. @return The target part of the relationship
  47628. </member>
  47629. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.GetInputStream">
  47630. Get the input stream of this part to read its content.
  47631. @return The input stream of the content of this part, else
  47632. <code>null</code>.
  47633. </member>
  47634. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.GetOutputStream">
  47635. Get the output stream of this part. If the part is originally embedded in
  47636. Zip package, it'll be transform intot a <i>MemoryPackagePart</i> in
  47637. order to write inside (the standard Java API doesn't allow to write in
  47638. the file)
  47639. @see org.apache.poi.openxml4j.opc.internal.MemoryPackagePart
  47640. </member>
  47641. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.ThrowExceptionIfRelationship">
  47642. Throws an exception if this package part is a relationship part.
  47643. @throws InvalidOperationException
  47644. If this part is a relationship part.
  47645. </member>
  47646. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.LoadRelationships">
  47647. Ensure the package relationships collection instance is built.
  47648. @throws InvalidFormatException
  47649. Throws if
  47650. </member>
  47651. <member name="P:NPOI.OpenXml4Net.OPC.PackagePart.PartName">
  47652. @return the uri
  47653. </member>
  47654. <member name="P:NPOI.OpenXml4Net.OPC.PackagePart.ContentType">
  47655. @return the contentType
  47656. </member>
  47657. <member name="P:NPOI.OpenXml4Net.OPC.PackagePart.ContentTypeDetails">
  47658. @return The Content Type, including parameters, of the part
  47659. </member>
  47660. <member name="P:NPOI.OpenXml4Net.OPC.PackagePart.IsRelationshipPart">
  47661. @return true if this part is a relationship
  47662. </member>
  47663. <member name="P:NPOI.OpenXml4Net.OPC.PackagePart.IsDeleted">
  47664. @return true if this part has been logically deleted
  47665. </member>
  47666. <member name="P:NPOI.OpenXml4Net.OPC.PackagePart.Size">
  47667. @return The length of the part in bytes, or -1 if not known
  47668. </member>
  47669. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.CompareTo(NPOI.OpenXml4Net.OPC.PackagePart)">
  47670. Compare based on the package part name, using a natural sort order
  47671. </member>
  47672. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.GetInputStreamImpl">
  47673. Abtract method that get the input stream of this part.
  47674. @exception IOException
  47675. Throws if an IO Exception occur in the implementation
  47676. method.
  47677. </member>
  47678. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.GetOutputStreamImpl">
  47679. Abstract method that get the output stream of this part.
  47680. </member>
  47681. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.Save(Telerik.Windows.Zip.ZipArchive)">
  47682. Save the content of this part and the associated relationships part (if
  47683. this part own at least one relationship) into the specified output
  47684. stream.
  47685. @param zos
  47686. Output stream to save this part.
  47687. @throws OpenXml4NetException
  47688. If any exception occur.
  47689. </member>
  47690. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.Load(System.IO.Stream)">
  47691. Load the content of this part.
  47692. @param ios
  47693. The input stream of the content to load.
  47694. @return <b>true</b> if the content has been successfully loaded, else
  47695. <b>false</b>.
  47696. @throws InvalidFormatException
  47697. Throws if the content format is invalid.
  47698. </member>
  47699. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.Close">
  47700. Close this part : flush this part, close the input stream and output
  47701. stream. After this method call, the part must be available for packaging.
  47702. </member>
  47703. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.Flush">
  47704. Flush the content of this part. If the input stream and/or output stream
  47705. as in a waiting state to read or write, the must to empty their
  47706. respective buffer.
  47707. </member>
  47708. <member name="M:NPOI.OpenXml4Net.OPC.PackagePart.Clear">
  47709. Allows sub-classes to clean up before new data is added.
  47710. </member>
  47711. <member name="T:NPOI.OpenXml4Net.OPC.PackagePartCollection">
  47712. A package part collection.
  47713. @author Julien Chable
  47714. @version 0.1
  47715. </member>
  47716. <member name="F:NPOI.OpenXml4Net.OPC.PackagePartCollection.registerPartNameStr">
  47717. Arraylist use to store this collection part names as string for rule
  47718. M1.11 optimized checking.
  47719. </member>
  47720. <member name="M:NPOI.OpenXml4Net.OPC.PackagePartCollection.Put(NPOI.OpenXml4Net.OPC.PackagePartName,NPOI.OpenXml4Net.OPC.PackagePart)">
  47721. Check rule [M1.11]: a package implementer shall neither create nor
  47722. recognize a part with a part name derived from another part name by
  47723. Appending segments to it.
  47724. @exception InvalidOperationException
  47725. Throws if you try to add a part with a name derived from
  47726. another part name.
  47727. </member>
  47728. <member name="T:NPOI.OpenXml4Net.OPC.PackagePartName">
  47729. An immutable Open Packaging Convention compliant part name.
  47730. @author Julien Chable
  47731. @see <a href="http://www.ietf.org/rfc/rfc3986.txt">http://www.ietf.org/rfc/rfc3986.txt</a>
  47732. </member>
  47733. <member name="F:NPOI.OpenXml4Net.OPC.PackagePartName.partNameURI">
  47734. Part name stored as an URI.
  47735. </member>
  47736. <member name="F:NPOI.OpenXml4Net.OPC.PackagePartName.RFC3986_PCHAR_SUB_DELIMS">
  47737. Reserved characters for sub delimitations.
  47738. </member>
  47739. <!-- Badly formed XML comment ignored for member "F:NPOI.OpenXml4Net.OPC.PackagePartName.RFC3986_PCHAR_UNRESERVED_SUP" -->
  47740. <member name="F:NPOI.OpenXml4Net.OPC.PackagePartName.RFC3986_PCHAR_AUTHORIZED_SUP">
  47741. Authorized reserved characters for pChar.
  47742. </member>
  47743. <member name="F:NPOI.OpenXml4Net.OPC.PackagePartName.isRelationship">
  47744. Flag to know if this part name is from a relationship part name.
  47745. </member>
  47746. <member name="M:NPOI.OpenXml4Net.OPC.PackagePartName.#ctor(System.Uri,System.Boolean)">
  47747. Constructor. Makes a ValidPartName object from a java.net.URI
  47748. @param uri
  47749. The URI to validate and to transform into ValidPartName.
  47750. @param checkConformance
  47751. Flag to specify if the contructor have to validate the OPC
  47752. conformance. Must be always <code>true</code> except for
  47753. special URI like '/' which is needed for internal use by
  47754. OpenXml4Net but is not valid.
  47755. @throws InvalidFormatException
  47756. Throw if the specified part name is not conform to Open
  47757. Packaging Convention specifications.
  47758. @see java.net.URI
  47759. </member>
  47760. <member name="M:NPOI.OpenXml4Net.OPC.PackagePartName.#ctor(System.String,System.Boolean)">
  47761. Constructor. Makes a ValidPartName object from a String part name.
  47762. @param partName
  47763. Part name to valid and to create.
  47764. @param checkConformance
  47765. Flag to specify if the contructor have to validate the OPC
  47766. conformance. Must be always <code>true</code> except for
  47767. special URI like '/' which is needed for internal use by
  47768. OpenXml4Net but is not valid.
  47769. @throws InvalidFormatException
  47770. Throw if the specified part name is not conform to Open
  47771. Packaging Convention specifications.
  47772. </member>
  47773. <member name="M:NPOI.OpenXml4Net.OPC.PackagePartName.IsRelationshipPartURI(System.Uri)">
  47774. Check if the specified part name is a relationship part name.
  47775. @param partUri
  47776. The URI to check.
  47777. @return <code>true</code> if this part name respect the relationship
  47778. part naming convention else <code>false</code>.
  47779. </member>
  47780. <member name="M:NPOI.OpenXml4Net.OPC.PackagePartName.IsRelationshipPartURI">
  47781. Know if this part name is a relationship part name.
  47782. @return <code>true</code> if this part name respect the relationship
  47783. part naming convention else <code>false</code>.
  47784. </member>
  47785. <member name="M:NPOI.OpenXml4Net.OPC.PackagePartName.ThrowExceptionIfInvalidPartUri(System.Uri)">
  47786. Throws an exception (of any kind) if the specified part name does not
  47787. follow the Open Packaging Convention specifications naming rules.
  47788. @param partUri
  47789. The part name to check.
  47790. @throws Exception
  47791. Throws if the part name is invalid.
  47792. </member>
  47793. <member name="M:NPOI.OpenXml4Net.OPC.PackagePartName.ThrowExceptionIfEmptyURI(System.Uri)">
  47794. Throws an exception if the specified URI is empty. [M1.1]
  47795. @param partURI
  47796. Part URI to check.
  47797. @throws InvalidFormatException
  47798. If the specified URI is empty.
  47799. </member>
  47800. <member name="M:NPOI.OpenXml4Net.OPC.PackagePartName.ThrowExceptionIfPartNameHaveInvalidSegments(System.Uri)">
  47801. Throws an exception if the part name has empty segments. [M1.3]
  47802. Throws an exception if a segment any characters other than pchar
  47803. characters. [M1.6]
  47804. Throws an exception if a segment contain percent-encoded forward slash
  47805. ('/'), or backward slash ('\') characters. [M1.7]
  47806. Throws an exception if a segment contain percent-encoded unreserved
  47807. characters. [M1.8]
  47808. Throws an exception if the specified part name's segments end with a dot
  47809. ('.') character. [M1.9]
  47810. Throws an exception if a segment doesn't include at least one non-dot
  47811. character. [M1.10]
  47812. @param partUri
  47813. The part name to check.
  47814. @throws InvalidFormatException
  47815. if the specified URI contain an empty segments or if one the
  47816. segments contained in the part name, ends with a dot ('.')
  47817. character.
  47818. </member>
  47819. <member name="M:NPOI.OpenXml4Net.OPC.PackagePartName.CheckPCharCompliance(System.String)">
  47820. Throws an exception if a segment any characters other than pchar
  47821. characters. [M1.6]
  47822. Throws an exception if a segment contain percent-encoded forward slash
  47823. ('/'), or backward slash ('\') characters. [M1.7]
  47824. Throws an exception if a segment contain percent-encoded unreserved
  47825. characters. [M1.8]
  47826. @param segment
  47827. The segment to check
  47828. </member>
  47829. <member name="M:NPOI.OpenXml4Net.OPC.PackagePartName.ThrowExceptionIfPartNameNotStartsWithForwardSlashChar(System.Uri)">
  47830. Throws an exception if the specified part name doesn't start with a
  47831. forward slash character '/'. [M1.4]
  47832. @param partUri
  47833. The part name to check.
  47834. @throws InvalidFormatException
  47835. If the specified part name doesn't start with a forward slash
  47836. character '/'.
  47837. </member>
  47838. <member name="M:NPOI.OpenXml4Net.OPC.PackagePartName.ThrowExceptionIfPartNameEndsWithForwardSlashChar(System.Uri)">
  47839. Throws an exception if the specified part name ends with a forwar slash
  47840. character '/'. [M1.5]
  47841. @param partUri
  47842. The part name to check.
  47843. @throws InvalidFormatException
  47844. If the specified part name ends with a forwar slash character
  47845. '/'.
  47846. </member>
  47847. <member name="M:NPOI.OpenXml4Net.OPC.PackagePartName.ThrowExceptionIfAbsoluteUri(System.Uri)">
  47848. Throws an exception if the specified URI is absolute.
  47849. @param partUri
  47850. The URI to check.
  47851. @throws InvalidFormatException
  47852. Throws if the specified URI is absolute.
  47853. </member>
  47854. <member name="M:NPOI.OpenXml4Net.OPC.PackagePartName.CompareTo(NPOI.OpenXml4Net.OPC.PackagePartName)">
  47855. Compare two part name following the rule M1.12 :
  47856. Part name equivalence is determined by comparing part names as
  47857. case-insensitive ASCII strings. Packages shall not contain equivalent
  47858. part names and package implementers shall neither create nor recognize
  47859. packages with equivalent part names. [M1.12]
  47860. </member>
  47861. <member name="P:NPOI.OpenXml4Net.OPC.PackagePartName.Extension">
  47862. Retrieves the extension of the part name if any. If there is no extension
  47863. returns an empty String. Example : '/document/content.xml' => 'xml'
  47864. @return The extension of the part name.
  47865. </member>
  47866. <member name="P:NPOI.OpenXml4Net.OPC.PackagePartName.Name">
  47867. Get this part name.
  47868. @return The name of this part name.
  47869. </member>
  47870. <member name="M:NPOI.OpenXml4Net.OPC.PackagePartName.Equals(System.Object)">
  47871. Part name equivalence is determined by comparing part names as
  47872. case-insensitive ASCII strings. Packages shall not contain equivalent
  47873. part names and package implementers shall neither create nor recognize
  47874. packages with equivalent part names. [M1.12]
  47875. </member>
  47876. <member name="P:NPOI.OpenXml4Net.OPC.PackagePartName.URI">
  47877. Part name property getter.
  47878. @return This part name URI.
  47879. </member>
  47880. <!-- Badly formed XML comment ignored for member "M:NPOI.OpenXml4Net.OPC.PackagePartName.Compare(NPOI.OpenXml4Net.OPC.PackagePartName,NPOI.OpenXml4Net.OPC.PackagePartName)" -->
  47881. <!-- Badly formed XML comment ignored for member "M:NPOI.OpenXml4Net.OPC.PackagePartName.Compare(System.String,System.String)" -->
  47882. <member name="T:NPOI.OpenXml4Net.OPC.PackageProperties">
  47883. Represents the core properties of an OPC package.
  47884. @author Julien Chable
  47885. @version 1.0
  47886. @see org.apache.poi.OpenXml4Net.opc.OPCPackage
  47887. </member>
  47888. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.GetCategoryProperty">
  47889. Set the category of the content of this package.
  47890. </member>
  47891. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetCategoryProperty(System.String)">
  47892. Set the category of the content of this package.
  47893. </member>
  47894. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.GetContentStatusProperty">
  47895. Set the status of the content.
  47896. </member>
  47897. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetContentStatusProperty(System.String)">
  47898. Get the status of the content.
  47899. </member>
  47900. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.GetContentTypeProperty">
  47901. Get the type of content represented, generally defined by a specific use
  47902. and intended audience.
  47903. </member>
  47904. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetContentTypeProperty(System.String)">
  47905. Set the type of content represented, generally defined by a specific use
  47906. and intended audience.
  47907. </member>
  47908. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.GetCreatedProperty">
  47909. Get the date of creation of the resource.
  47910. </member>
  47911. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetCreatedProperty(System.String)">
  47912. Set the date of creation of the resource.
  47913. </member>
  47914. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetCreatedProperty(System.Nullable{System.DateTime})">
  47915. Set the date of creation of the resource.
  47916. </member>
  47917. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.GetCreatorProperty">
  47918. Get the entity primarily responsible for making the content of the
  47919. resource.
  47920. </member>
  47921. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetCreatorProperty(System.String)">
  47922. Set the entity primarily responsible for making the content of the
  47923. resource.
  47924. </member>
  47925. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.GetDescriptionProperty">
  47926. Get the explanation of the content of the resource.
  47927. </member>
  47928. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetDescriptionProperty(System.String)">
  47929. Set the explanation of the content of the resource.
  47930. </member>
  47931. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.GetIdentifierProperty">
  47932. Get an unambiguous reference to the resource within a given context.
  47933. </member>
  47934. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetIdentifierProperty(System.String)">
  47935. Set an unambiguous reference to the resource within a given context.
  47936. </member>
  47937. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.GetKeywordsProperty">
  47938. Get a delimited Set of keywords to support searching and indexing. This
  47939. is typically a list of terms that are not available elsewhere in the
  47940. properties
  47941. </member>
  47942. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetKeywordsProperty(System.String)">
  47943. Set a delimited Set of keywords to support searching and indexing. This
  47944. is typically a list of terms that are not available elsewhere in the
  47945. properties
  47946. </member>
  47947. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.GetLanguageProperty">
  47948. Get the language of the intellectual content of the resource.
  47949. </member>
  47950. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetLanguageProperty(System.String)">
  47951. Set the language of the intellectual content of the resource.
  47952. </member>
  47953. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.GetLastModifiedByProperty">
  47954. Get the user who performed the last modification.
  47955. </member>
  47956. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetLastModifiedByProperty(System.String)">
  47957. Set the user who performed the last modification.
  47958. </member>
  47959. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.GetLastPrintedProperty">
  47960. Get the date and time of the last printing.
  47961. </member>
  47962. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetLastPrintedProperty(System.String)">
  47963. Set the date and time of the last printing.
  47964. </member>
  47965. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetLastPrintedProperty(System.Nullable{System.DateTime})">
  47966. Set the date and time of the last printing.
  47967. </member>
  47968. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.GetModifiedProperty">
  47969. Get the date on which the resource was changed.
  47970. </member>
  47971. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetModifiedProperty(System.String)">
  47972. Set the date on which the resource was changed.
  47973. </member>
  47974. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetModifiedProperty(System.Nullable{System.DateTime})">
  47975. Set the date on which the resource was changed.
  47976. </member>
  47977. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.GetRevisionProperty">
  47978. Get the revision number.
  47979. </member>
  47980. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetRevisionProperty(System.String)">
  47981. Set the revision number.
  47982. </member>
  47983. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.GetSubjectProperty">
  47984. Get the topic of the content of the resource.
  47985. </member>
  47986. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetSubjectProperty(System.String)">
  47987. Set the topic of the content of the resource.
  47988. </member>
  47989. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.GetTitleProperty">
  47990. Get the name given to the resource.
  47991. </member>
  47992. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetTitleProperty(System.String)">
  47993. Set the name given to the resource.
  47994. </member>
  47995. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.GetVersionProperty">
  47996. Get the version number.
  47997. </member>
  47998. <member name="M:NPOI.OpenXml4Net.OPC.PackageProperties.SetVersionProperty(System.String)">
  47999. Set the version number.
  48000. </member>
  48001. <member name="T:NPOI.OpenXml4Net.OPC.PackageRelationship">
  48002. A part relationship.
  48003. @author Julien Chable
  48004. @version 1.0
  48005. </member>
  48006. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationship.id">
  48007. Relation id.
  48008. </member>
  48009. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationship.container">
  48010. Reference to the package.
  48011. </member>
  48012. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationship.relationshipType">
  48013. Relationship type
  48014. </member>
  48015. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationship.source">
  48016. Part of this relationship source
  48017. </member>
  48018. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationship.targetMode">
  48019. Targeting mode [Internal|External]
  48020. </member>
  48021. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationship.targetUri">
  48022. Target URI
  48023. </member>
  48024. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationship.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePart,System.Uri,NPOI.OpenXml4Net.OPC.TargetMode,System.String,System.String)">
  48025. Constructor.
  48026. @param pkg
  48027. @param sourcePart
  48028. @param targetUri
  48029. @param targetMode
  48030. @param relationshipType
  48031. @param id
  48032. </member>
  48033. <member name="P:NPOI.OpenXml4Net.OPC.PackageRelationship.Package">
  48034. @return the container
  48035. </member>
  48036. <member name="P:NPOI.OpenXml4Net.OPC.PackageRelationship.Id">
  48037. @return the id
  48038. </member>
  48039. <member name="P:NPOI.OpenXml4Net.OPC.PackageRelationship.RelationshipType">
  48040. @return the relationshipType
  48041. </member>
  48042. <member name="P:NPOI.OpenXml4Net.OPC.PackageRelationship.Source">
  48043. @return the source
  48044. </member>
  48045. <member name="P:NPOI.OpenXml4Net.OPC.PackageRelationship.SourceUri">
  48046. @return URL of the source part of this relationship
  48047. </member>
  48048. <member name="P:NPOI.OpenXml4Net.OPC.PackageRelationship.TargetMode">
  48049. public URI getSourceUri(){ }
  48050. @return the targetMode
  48051. </member>
  48052. <member name="P:NPOI.OpenXml4Net.OPC.PackageRelationship.TargetUri">
  48053. @return the targetUri
  48054. </member>
  48055. <member name="T:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection">
  48056. Represents a collection of PackageRelationship elements that are owned by a
  48057. given PackagePart or the Package.
  48058. @author Julien Chable, CDubettier
  48059. @version 0.1
  48060. </member>
  48061. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.relationshipsByID">
  48062. Package relationships ordered by ID.
  48063. </member>
  48064. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.relationshipsByType">
  48065. Package relationships ordered by type.
  48066. </member>
  48067. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.relationshipPart">
  48068. This relationshipPart.
  48069. </member>
  48070. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.sourcePart">
  48071. Source part.
  48072. </member>
  48073. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.partName">
  48074. This part name.
  48075. </member>
  48076. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.container">
  48077. Reference to the package.
  48078. </member>
  48079. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.nextRelationshipId">
  48080. The ID number of the next rID# to generate, or -1
  48081. if that is still to be determined.
  48082. </member>
  48083. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.#ctor">
  48084. Constructor.
  48085. </member>
  48086. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.#ctor(NPOI.OpenXml4Net.OPC.PackageRelationshipCollection,System.String)">
  48087. Copy constructor.
  48088. This collection will contain only elements from the specified collection
  48089. for which the type is compatible with the specified relationship type
  48090. filter.
  48091. @param coll
  48092. Collection to import.
  48093. @param filter
  48094. Relationship type filter.
  48095. </member>
  48096. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage)">
  48097. Constructor.
  48098. </member>
  48099. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  48100. Constructor.
  48101. @throws InvalidFormatException
  48102. Throws if the format of the content part is invalid.
  48103. @throws InvalidOperationException
  48104. Throws if the specified part is a relationship part.
  48105. </member>
  48106. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePart)">
  48107. Constructor. Parse the existing package relationship part if one exists.
  48108. @param container
  48109. The parent package.
  48110. @param part
  48111. The part that own this relationships collection. If <b>null</b>
  48112. then this part is considered as the package root.
  48113. @throws InvalidFormatException
  48114. If an error occurs during the parsing of the relatinships
  48115. part fo the specified part.
  48116. </member>
  48117. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.GetRelationshipPartName(NPOI.OpenXml4Net.OPC.PackagePart)">
  48118. Get the relationship part name of the specified part.
  48119. @param part
  48120. The part .
  48121. @return The relationship part name of the specified part. Be careful,
  48122. only the correct name is returned, this method does not check if
  48123. the part really exist in a package !
  48124. @throws InvalidOperationException
  48125. Throws if the specified part is a relationship part.
  48126. </member>
  48127. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.AddRelationship(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  48128. Add the specified relationship to the collection.
  48129. @param relPart
  48130. The relationship to add.
  48131. </member>
  48132. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.AddRelationship(System.Uri,NPOI.OpenXml4Net.OPC.TargetMode,System.String,System.String)">
  48133. Add a relationship to the collection.
  48134. @param targetUri
  48135. Target URI.
  48136. @param targetMode
  48137. The target mode : INTERNAL or EXTERNAL
  48138. @param relationshipType
  48139. Relationship type.
  48140. @param id
  48141. Relationship ID.
  48142. @return The newly created relationship.
  48143. @see PackageAccess
  48144. </member>
  48145. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.RemoveRelationship(System.String)">
  48146. Remove a relationship by its ID.
  48147. @param id
  48148. The relationship ID to Remove.
  48149. </member>
  48150. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.RemoveRelationship(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  48151. Remove a relationship by its reference.
  48152. @param rel
  48153. The relationship to delete.
  48154. </member>
  48155. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.GetRelationship(System.Int32)">
  48156. Retrieves a relationship by its index in the collection.
  48157. @param index
  48158. Must be a value between [0-relationships_count-1]
  48159. </member>
  48160. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.GetRelationshipByID(System.String)">
  48161. Retrieves a package relationship based on its id.
  48162. @param id
  48163. ID of the package relationship to retrieve.
  48164. @return The package relationship identified by the specified id.
  48165. </member>
  48166. <member name="P:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.Size">
  48167. Get the numbe rof relationships in the collection.
  48168. </member>
  48169. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.ParseRelationshipsPart(NPOI.OpenXml4Net.OPC.PackagePart)">
  48170. Parse the relationship part and add all relationship in this collection.
  48171. @param relPart
  48172. The package part to parse.
  48173. @throws InvalidFormatException
  48174. Throws if the relationship part is invalid.
  48175. </member>
  48176. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.GetRelationships(System.String)">
  48177. Retrieves all relations with the specified type.
  48178. @param typeFilter
  48179. Relationship type filter. If <b>null</b> then all
  48180. relationships are returned.
  48181. @return All relationships of the type specified by the filter.
  48182. </member>
  48183. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.GetEnumerator">
  48184. Get this collection's iterator.
  48185. </member>
  48186. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.Iterator(System.String)">
  48187. Get an iterator of a collection with all relationship with the specified
  48188. type.
  48189. @param typeFilter
  48190. Type filter.
  48191. @return An iterator to a collection containing all relationships with the
  48192. specified type contain in this collection.
  48193. </member>
  48194. <member name="M:NPOI.OpenXml4Net.OPC.PackageRelationshipCollection.Clear">
  48195. Clear all relationships.
  48196. </member>
  48197. <member name="T:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes">
  48198. Relationship types.
  48199. @author Julien Chable
  48200. @version 0.2
  48201. </member>
  48202. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.CORE_PROPERTIES">
  48203. Core properties relationship type.
  48204. <p>
  48205. The standard specifies a source relations ship for the Core File Properties part as follows:
  48206. <code>http://schemas.openxmlformats.org/officedocument/2006/relationships/metadata/core-properties.</code>
  48207. </p>
  48208. <p>
  48209. Office uses the following source relationship for the Core File Properties part:
  48210. <code>http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties.</code>
  48211. </p>
  48212. See 2.1.33 Part 1 Section 15.2.11.1, Core File Properties Part in [MS-OE376].pdf
  48213. </member>
  48214. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.CORE_PROPERTIES_ECMA376">
  48215. Core properties relationship type as defiend in ECMA 376.
  48216. </member>
  48217. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.DIGITAL_SIGNATURE">
  48218. Digital signature relationship type.
  48219. </member>
  48220. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.DIGITAL_SIGNATURE_CERTIFICATE">
  48221. Digital signature certificate relationship type.
  48222. </member>
  48223. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.DIGITAL_SIGNATURE_ORIGIN">
  48224. Digital signature origin relationship type.
  48225. </member>
  48226. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.THUMBNAIL">
  48227. Thumbnail relationship type.
  48228. </member>
  48229. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.EXTENDED_PROPERTIES">
  48230. Extended properties relationship type.
  48231. </member>
  48232. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.STRICT_EXTENDED_PROPERTIES">
  48233. Extended properties relationship type for strict ooxml.
  48234. </member>
  48235. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.CUSTOM_PROPERTIES">
  48236. Custom properties relationship type.
  48237. </member>
  48238. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.CORE_DOCUMENT">
  48239. Core document relationship type.
  48240. </member>
  48241. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.STRICT_CORE_DOCUMENT">
  48242. Core document relationship type for strict ooxml.
  48243. </member>
  48244. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.CUSTOM_XML">
  48245. Custom XML relationship type.
  48246. </member>
  48247. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.IMAGE_PART">
  48248. Image type.
  48249. </member>
  48250. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.HYPERLINK_PART">
  48251. Hyperlink type.
  48252. </member>
  48253. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.STYLE_PART">
  48254. Style type.
  48255. </member>
  48256. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.EXTERNAL_LINK_PATH">
  48257. External Link to another Document
  48258. </member>
  48259. <member name="F:NPOI.OpenXml4Net.OPC.PackageRelationshipTypes.VISIO_CORE_DOCUMENT">
  48260. Visio 2010 VSDX equivalent of package {@link #CORE_DOCUMENT}
  48261. </member>
  48262. <member name="T:NPOI.OpenXml4Net.OPC.PackagingUriHelper">
  48263. Helper for part and pack Uri.
  48264. @author Julien Chable, CDubet, Kim Ung
  48265. @version 0.1
  48266. </member>
  48267. <member name="F:NPOI.OpenXml4Net.OPC.PackagingUriHelper.packageRootUri">
  48268. Package root Uri.
  48269. </member>
  48270. <member name="F:NPOI.OpenXml4Net.OPC.PackagingUriHelper.RELATIONSHIP_PART_EXTENSION_NAME">
  48271. Extension name of a relationship part.
  48272. </member>
  48273. <member name="F:NPOI.OpenXml4Net.OPC.PackagingUriHelper.RELATIONSHIP_PART_SEGMENT_NAME">
  48274. Segment name of a relationship part.
  48275. </member>
  48276. <member name="F:NPOI.OpenXml4Net.OPC.PackagingUriHelper.PACKAGE_PROPERTIES_SEGMENT_NAME">
  48277. Segment name of the package properties folder.
  48278. </member>
  48279. <member name="F:NPOI.OpenXml4Net.OPC.PackagingUriHelper.PACKAGE_CORE_PROPERTIES_NAME">
  48280. Core package properties art name.
  48281. </member>
  48282. <member name="F:NPOI.OpenXml4Net.OPC.PackagingUriHelper.FORWARD_SLASH_CHAR">
  48283. Forward slash Uri separator.
  48284. </member>
  48285. <member name="F:NPOI.OpenXml4Net.OPC.PackagingUriHelper.FORWARD_SLASH_STRING">
  48286. Forward slash Uri separator.
  48287. </member>
  48288. <member name="F:NPOI.OpenXml4Net.OPC.PackagingUriHelper.PACKAGE_RELATIONSHIPS_ROOT_URI">
  48289. Package relationships part Uri
  48290. </member>
  48291. <member name="F:NPOI.OpenXml4Net.OPC.PackagingUriHelper.PACKAGE_RELATIONSHIPS_ROOT_PART_NAME">
  48292. Package relationships part name.
  48293. </member>
  48294. <member name="F:NPOI.OpenXml4Net.OPC.PackagingUriHelper.CORE_PROPERTIES_URI">
  48295. Core properties part Uri.
  48296. </member>
  48297. <member name="F:NPOI.OpenXml4Net.OPC.PackagingUriHelper.CORE_PROPERTIES_PART_NAME">
  48298. Core properties partname.
  48299. </member>
  48300. <member name="F:NPOI.OpenXml4Net.OPC.PackagingUriHelper.PACKAGE_ROOT_URI">
  48301. Root package Uri.
  48302. </member>
  48303. <member name="F:NPOI.OpenXml4Net.OPC.PackagingUriHelper.PACKAGE_ROOT_PART_NAME">
  48304. Root package part name.
  48305. </member>
  48306. <member name="P:NPOI.OpenXml4Net.OPC.PackagingUriHelper.PackageRootUri">
  48307. Gets the Uri for the package root.
  48308. @return Uri of the package root.
  48309. </member>
  48310. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.IsRelationshipPartURI(System.Uri)">
  48311. Know if the specified Uri is a relationship part name.
  48312. @param partUri
  48313. Uri to check.
  48314. @return <i>true</i> if the Uri <i>false</i>.
  48315. </member>
  48316. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.GetFilename(System.Uri)">
  48317. Get file name from the specified Uri.
  48318. </member>
  48319. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.GetFilenameWithoutExtension(System.Uri)">
  48320. Get the file name without the trailing extension.
  48321. </member>
  48322. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.GetPath(System.Uri)">
  48323. Get the directory path from the specified Uri.
  48324. </member>
  48325. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.Combine(System.Uri,System.Uri)">
  48326. Combine two URIs.
  48327. @param prefix the prefix Uri
  48328. @param suffix the suffix Uri
  48329. @return the Combined Uri
  48330. </member>
  48331. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.Combine(System.String,System.String)">
  48332. Combine a string Uri with a prefix and a suffix.
  48333. </member>
  48334. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.RelativizeUri(System.Uri,System.Uri,System.Boolean)">
  48335. Fully relativize the source part Uri against the target part Uri.
  48336. @param sourceURI
  48337. The source part Uri.
  48338. @param targetURI
  48339. The target part Uri.
  48340. @return A fully relativize part name Uri ('word/media/image1.gif',
  48341. '/word/document.xml' => 'media/image1.gif') else
  48342. <code>null</code>.
  48343. </member>
  48344. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.RelativizeUri(System.Uri,System.Uri)">
  48345. Fully relativize the source part URI against the target part URI.
  48346. @param sourceURI
  48347. The source part URI.
  48348. @param targetURI
  48349. The target part URI.
  48350. @return A fully relativize part name URI ('word/media/image1.gif',
  48351. '/word/document.xml' => 'media/image1.gif') else
  48352. <code>null</code>.
  48353. </member>
  48354. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.ResolvePartUri(System.Uri,System.Uri)">
  48355. Resolve a source uri against a target.
  48356. @param sourcePartUri
  48357. The source Uri.
  48358. @param targetUri
  48359. The target Uri.
  48360. @return The resolved Uri.
  48361. </member>
  48362. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.GetURIFromPath(System.String)">
  48363. Get Uri from a string path.
  48364. </member>
  48365. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.GetSourcePartUriFromRelationshipPartUri(System.Uri)">
  48366. Get the source part Uri from a specified relationships part.
  48367. @param relationshipPartUri
  48368. The relationship part use to retrieve the source part.
  48369. @return The source part Uri from the specified relationships part.
  48370. </member>
  48371. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.CreatePartName(System.Uri)">
  48372. Create an OPC compliant part name by throwing an exception if the Uri is
  48373. not valid.
  48374. @param partUri
  48375. The part name Uri to validate.
  48376. @return A valid part name object, else <code>null</code>.
  48377. @throws InvalidFormatException
  48378. Throws if the specified Uri is not OPC compliant.
  48379. </member>
  48380. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.CreatePartName(System.String)">
  48381. Create an OPC compliant part name.
  48382. @param partName
  48383. The part name to validate.
  48384. @return The correspondant part name if valid, else <code>null</code>.
  48385. @throws InvalidFormatException
  48386. Throws if the specified part name is not OPC compliant.
  48387. @see #CreatePartName(Uri)
  48388. </member>
  48389. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.CreatePartName(System.String,NPOI.OpenXml4Net.OPC.PackagePart)">
  48390. Create an OPC compliant part name by resolving it using a base part.
  48391. @param partName
  48392. The part name to validate.
  48393. @param relativePart
  48394. The relative base part.
  48395. @return The correspondant part name if valid, else <code>null</code>.
  48396. @throws InvalidFormatException
  48397. Throws if the specified part name is not OPC compliant.
  48398. @see #CreatePartName(Uri)
  48399. </member>
  48400. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.CreatePartName(System.Uri,NPOI.OpenXml4Net.OPC.PackagePart)">
  48401. Create an OPC compliant part name by resolving it using a base part.
  48402. @param partName
  48403. The part name Uri to validate.
  48404. @param relativePart
  48405. The relative base part.
  48406. @return The correspondant part name if valid, else <code>null</code>.
  48407. @throws InvalidFormatException
  48408. Throws if the specified part name is not OPC compliant.
  48409. @see #CreatePartName(Uri)
  48410. </member>
  48411. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.IsValidPartName(System.Uri)">
  48412. Validate a part Uri by returning a bool.
  48413. ([M1.1],[M1.3],[M1.4],[M1.5],[M1.6])
  48414. (OPC Specifications 8.1.1 Part names) :
  48415. Part Name Syntax
  48416. The part name grammar is defined as follows:
  48417. <i>part_name = 1*( "/" segment )
  48418. segment = 1*( pchar )</i>
  48419. (pchar is defined in RFC 3986)
  48420. @param partUri
  48421. The Uri to validate.
  48422. @return <b>true</b> if the Uri is valid to the OPC Specifications, else
  48423. <b>false</b>
  48424. @see #CreatePartName(Uri)
  48425. </member>
  48426. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.DecodeURI(System.Uri)">
  48427. Decode a Uri by converting all percent encoded character into a String
  48428. character.
  48429. @param uri
  48430. The Uri to decode.
  48431. @return The specified Uri in a String with converted percent encoded
  48432. characters.
  48433. </member>
  48434. <!-- Badly formed XML comment ignored for member "M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.ToUri(System.String)" -->
  48435. <!-- Badly formed XML comment ignored for member "M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.Encode(System.String)" -->
  48436. <member name="M:NPOI.OpenXml4Net.OPC.PackagingUriHelper.GetRelationshipPartName(NPOI.OpenXml4Net.OPC.PackagePartName)">
  48437. Build a part name where the relationship should be stored ((ex
  48438. /word/document.xml -> /word/_rels/document.xml.rels)
  48439. @param partName
  48440. Source part Uri
  48441. @return the full path (as Uri) of the relation file
  48442. @throws InvalidOperationException
  48443. Throws if the specified Uri is a relationshp part.
  48444. </member>
  48445. <member name="M:NPOI.OpenXml4Net.OPC.RelationshipSource.AddRelationship(NPOI.OpenXml4Net.OPC.PackagePartName,NPOI.OpenXml4Net.OPC.TargetMode,System.String)">
  48446. Add a relationship to a part (except relationships part).
  48447. @param targetPartName
  48448. Name of the target part. This one must be relative to the
  48449. source root directory of the part.
  48450. @param targetMode
  48451. Mode [Internal|External].
  48452. @param relationshipType
  48453. Type of relationship.
  48454. @return The newly created and added relationship
  48455. </member>
  48456. <member name="M:NPOI.OpenXml4Net.OPC.RelationshipSource.AddRelationship(NPOI.OpenXml4Net.OPC.PackagePartName,NPOI.OpenXml4Net.OPC.TargetMode,System.String,System.String)">
  48457. * Add a relationship to a part (except relationships part).
  48458. * Check rule M1.25: The Relationships part shall not have relationships to
  48459. * any other part. Package implementers shall enforce this requirement upon
  48460. * the attempt to create such a relationship and shall treat any such
  48461. * relationship as invalid.
  48462. *
  48463. * @param targetPartName
  48464. * Name of the target part. This one must be relative to the
  48465. * source root directory of the part.
  48466. * @param targetMode
  48467. * Mode [Internal|External].
  48468. * @param relationshipType
  48469. * Type of relationship.
  48470. * @param id
  48471. * Relationship unique id.
  48472. * @return The newly created and added relationship
  48473. *
  48474. * @throws InvalidFormatException
  48475. * If the URI point to a relationship part URI.
  48476. </member>
  48477. <member name="M:NPOI.OpenXml4Net.OPC.RelationshipSource.AddExternalRelationship(System.String,System.String)">
  48478. Adds an external relationship to a part
  48479. (except relationships part).
  48480. The targets of external relationships are not
  48481. subject to the same validity checks that internal
  48482. ones are, as the contents is potentially
  48483. any file, URL or similar.
  48484. @param target External target of the relationship
  48485. @param relationshipType Type of relationship.
  48486. @return The newly created and added relationship
  48487. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#addExternalRelationship(java.lang.String, java.lang.String)
  48488. </member>
  48489. <member name="M:NPOI.OpenXml4Net.OPC.RelationshipSource.AddExternalRelationship(System.String,System.String,System.String)">
  48490. Adds an external relationship to a part
  48491. (except relationships part).
  48492. The targets of external relationships are not
  48493. subject to the same validity checks that internal
  48494. ones are, as the contents is potentially
  48495. any file, URL or similar.
  48496. @param target External target of the relationship
  48497. @param relationshipType Type of relationship.
  48498. @param id Relationship unique id.
  48499. @return The newly created and added relationship
  48500. @see org.apache.poi.OpenXml4Net.opc.RelationshipSource#addExternalRelationship(java.lang.String, java.lang.String)
  48501. </member>
  48502. <member name="M:NPOI.OpenXml4Net.OPC.RelationshipSource.ClearRelationships">
  48503. Delete all the relationships attached to this.
  48504. </member>
  48505. <member name="M:NPOI.OpenXml4Net.OPC.RelationshipSource.RemoveRelationship(System.String)">
  48506. Delete the relationship specified by its id.
  48507. @param id
  48508. The ID identified the part to delete.
  48509. </member>
  48510. <member name="P:NPOI.OpenXml4Net.OPC.RelationshipSource.Relationships">
  48511. Retrieve all the relationships attached to this.
  48512. @return This part's relationships.
  48513. @throws OpenXml4NetException
  48514. </member>
  48515. <member name="M:NPOI.OpenXml4Net.OPC.RelationshipSource.GetRelationship(System.String)">
  48516. Retrieves a package relationship from its id.
  48517. @param id
  48518. ID of the package relationship to retrieve.
  48519. @return The package relationship
  48520. </member>
  48521. <member name="M:NPOI.OpenXml4Net.OPC.RelationshipSource.GetRelationshipsByType(System.String)">
  48522. Retrieve all relationships attached to this part which have the specified
  48523. type.
  48524. @param relationshipType
  48525. Relationship type filter.
  48526. @return All relationships from this part that have the specified type.
  48527. @throws InvalidFormatException
  48528. If an error occurs while parsing the part.
  48529. @throws InvalidOperationException
  48530. If the package is open in write only mode.
  48531. </member>
  48532. <member name="P:NPOI.OpenXml4Net.OPC.RelationshipSource.HasRelationships">
  48533. Knows if the part have any relationships.
  48534. @return <b>true</b> if the part have at least one relationship else
  48535. <b>false</b>.
  48536. </member>
  48537. <member name="M:NPOI.OpenXml4Net.OPC.RelationshipSource.IsRelationshipExists(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  48538. Checks if the specified relationship is part of this package part.
  48539. @param rel
  48540. The relationship to check.
  48541. @return <b>true</b> if the specified relationship exists in this part,
  48542. else returns <b>false</b>
  48543. </member>
  48544. <member name="M:NPOI.OpenXml4Net.OPC.StreamHelper.SaveXmlInStream(System.Xml.XmlDocument,System.IO.Stream)">
  48545. Turning the DOM4j object in the specified output stream.
  48546. @param xmlContent
  48547. The XML document.
  48548. @param outStream
  48549. The Stream in which the XML document will be written.
  48550. @return <b>true</b> if the xml is successfully written in the stream,
  48551. else <b>false</b>.
  48552. </member>
  48553. <member name="M:NPOI.OpenXml4Net.OPC.StreamHelper.CopyStream(System.IO.Stream,System.IO.Stream)">
  48554. Copy the input stream into the output stream.
  48555. @param inStream
  48556. The source stream.
  48557. @param outStream
  48558. The destination stream.
  48559. @return <b>true</b> if the operation succeed, else return <b>false</b>.
  48560. </member>
  48561. <member name="T:NPOI.OpenXml4Net.OPC.TargetMode">
  48562. Specifies whether the target of a PackageRelationship is inside or outside a
  48563. Package.
  48564. @author Julien Chable
  48565. @version 1.0
  48566. </member>
  48567. <member name="F:NPOI.OpenXml4Net.OPC.TargetMode.Internal">
  48568. The relationship references a resource that is external to the package.
  48569. </member>
  48570. <member name="F:NPOI.OpenXml4Net.OPC.TargetMode.External">
  48571. The relationship references a part that is inside the package.
  48572. </member>
  48573. <member name="T:NPOI.OpenXml4Net.OPC.ZipPackage">
  48574. Physical zip package.
  48575. @author Julien Chable
  48576. </member>
  48577. <member name="F:NPOI.OpenXml4Net.OPC.ZipPackage.zipArchive">
  48578. Zip archive, as either a file on disk,
  48579. or a stream
  48580. </member>
  48581. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackage.#ctor">
  48582. Constructor. Creates a new ZipPackage.
  48583. </member>
  48584. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackage.#ctor(System.IO.Stream,NPOI.OpenXml4Net.OPC.PackageAccess)">
  48585. Constructor. <b>Operation not supported.</b>
  48586. @param in
  48587. Zip input stream to load.
  48588. @param access
  48589. </member>
  48590. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackage.#ctor(System.String,NPOI.OpenXml4Net.OPC.PackageAccess)">
  48591. Constructor. Opens a Zip based Open XML document.
  48592. @param path
  48593. The path of the file to open or create.
  48594. @param access
  48595. The package access mode.
  48596. </member>
  48597. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackage.#ctor(System.IO.FileInfo,NPOI.OpenXml4Net.OPC.PackageAccess)">
  48598. Constructor. Opens a Zip based Open XML document.
  48599. @param file
  48600. The file to open or create.
  48601. @param access
  48602. The package access mode.
  48603. </member>
  48604. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackage.GetPartsImpl">
  48605. Retrieves the parts from this package. We assume that the package has not
  48606. been yet inspect to retrieve all the parts, this method will open the
  48607. archive and look for all parts contain inside it. If the package part
  48608. list is not empty, it will be emptied.
  48609. @return All parts contain in this package.
  48610. @throws InvalidFormatException
  48611. Throws if the package is not valid.
  48612. </member>
  48613. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackage.BuildPartName(Telerik.Windows.Zip.ZipArchiveEntry)">
  48614. Builds a PackagePartName for the given ZipEntry,
  48615. or null if it's the content types / invalid part
  48616. </member>
  48617. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackage.CreatePartImpl(NPOI.OpenXml4Net.OPC.PackagePartName,System.String,System.Boolean)">
  48618. Create a new MemoryPackagePart from the specified URI and content type
  48619. aram partName The part URI.
  48620. @param contentType
  48621. The part content type.
  48622. @return The newly created zip package part, else <b>null</b>.
  48623. </member>
  48624. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackage.RemovePartImpl(NPOI.OpenXml4Net.OPC.PackagePartName)">
  48625. Delete a part from the package
  48626. @throws ArgumentException
  48627. Throws if the part URI is nulll or invalid.
  48628. </member>
  48629. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackage.FlushImpl">
  48630. Flush the package. Do nothing.
  48631. </member>
  48632. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackage.CloseImpl">
  48633. Close and save the package.
  48634. @see #close()
  48635. </member>
  48636. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackage.GenerateTempFileName(System.String)">
  48637. Create a unique identifier to be use as a temp file name.
  48638. @return A unique identifier use to be use as a temp file name.
  48639. </member>
  48640. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackage.RevertImpl">
  48641. Close the package without saving the document. Discard all the changes
  48642. made to this package.
  48643. </member>
  48644. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackage.GetPartImpl(NPOI.OpenXml4Net.OPC.PackagePartName)">
  48645. Implement the getPart() method to retrieve a part from its URI in the
  48646. current package
  48647. @see #getPart(PackageRelationship)
  48648. </member>
  48649. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackage.SaveImpl(System.IO.Stream)">
  48650. Save this package into the specified stream
  48651. @param outputStream
  48652. The stream use to save this package.
  48653. @see #save(OutputStream)
  48654. </member>
  48655. <member name="P:NPOI.OpenXml4Net.OPC.ZipPackage.ZipArchive">
  48656. Get the zip archive
  48657. @return The zip archive.
  48658. </member>
  48659. <member name="T:NPOI.OpenXml4Net.OPC.ZipPackagePart">
  48660. Zip implementation of a PackagePart.
  48661. @author Julien Chable
  48662. @version 1.0
  48663. @see PackagePart
  48664. </member>
  48665. <member name="F:NPOI.OpenXml4Net.OPC.ZipPackagePart.zipEntry">
  48666. The zip entry corresponding to this part.
  48667. </member>
  48668. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackagePart.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePartName,System.String)">
  48669. Constructor.
  48670. @param container
  48671. The container package.
  48672. @param partName
  48673. Part name.
  48674. @param contentType
  48675. Content type.
  48676. @throws InvalidFormatException
  48677. Throws if the content of this part invalid.
  48678. </member>
  48679. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackagePart.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage,Telerik.Windows.Zip.ZipArchiveEntry,NPOI.OpenXml4Net.OPC.PackagePartName,System.String)">
  48680. Constructor.
  48681. @param container
  48682. The container package.
  48683. @param zipEntry
  48684. The zip entry corresponding to this part.
  48685. @param partName
  48686. The part name.
  48687. @param contentType
  48688. Content type.
  48689. @throws InvalidFormatException
  48690. Throws if the content of this part is invalid.
  48691. </member>
  48692. <member name="P:NPOI.OpenXml4Net.OPC.ZipPackagePart.ZipArchive">
  48693. Get the zip entry of this part.
  48694. @return The zip entry in the zip structure coresponding to this part.
  48695. </member>
  48696. <member name="M:NPOI.OpenXml4Net.OPC.ZipPackagePart.GetInputStreamImpl">
  48697. Implementation of the getInputStream() which return the inputStream of
  48698. this part zip entry.
  48699. @return Input stream of this part zip entry.
  48700. </member>
  48701. <member name="F:NPOI.OpenXmlFormats.Dml.EG_ColorTransform.alpha">
  48702. <remarks/>
  48703. </member>
  48704. <member name="F:NPOI.OpenXmlFormats.Dml.EG_ColorTransform.alphaMod">
  48705. <remarks/>
  48706. </member>
  48707. <member name="F:NPOI.OpenXmlFormats.Dml.EG_ColorTransform.alphaOff">
  48708. <remarks/>
  48709. </member>
  48710. <member name="F:NPOI.OpenXmlFormats.Dml.EG_ColorTransform.blue">
  48711. <remarks/>
  48712. </member>
  48713. <member name="F:NPOI.OpenXmlFormats.Dml.EG_ColorTransform.blueMod">
  48714. <remarks/>
  48715. </member>
  48716. <member name="F:NPOI.OpenXmlFormats.Dml.EG_ColorTransform.blueOff">
  48717. <remarks/>
  48718. </member>
  48719. <member name="F:NPOI.OpenXmlFormats.Dml.EG_ColorTransform.comp">
  48720. <remarks/>
  48721. </member>
  48722. <member name="F:NPOI.OpenXmlFormats.Dml.EG_ColorTransform.gamma">
  48723. <remarks/>
  48724. </member>
  48725. <member name="F:NPOI.OpenXmlFormats.Dml.EG_ColorTransform.gray">
  48726. <remarks/>
  48727. </member>
  48728. <member name="F:NPOI.OpenXmlFormats.Dml.EG_ColorTransform.green">
  48729. <remarks/>
  48730. </member>
  48731. <member name="F:NPOI.OpenXmlFormats.Dml.EG_ColorTransform.greenMod">
  48732. <remarks/>
  48733. </member>
  48734. <member name="F:NPOI.OpenXmlFormats.Dml.EG_ColorTransform.greenOff">
  48735. <remarks/>
  48736. </member>
  48737. <member name="F:NPOI.OpenXmlFormats.Dml.EG_ColorTransform.hue">
  48738. <remarks/>
  48739. </member>
  48740. <member name="F:NPOI.OpenXmlFormats.Dml.EG_ColorTransform.hueMod">
  48741. <remarks/>
  48742. </member>
  48743. <member name="F:NPOI.OpenXmlFormats.Dml.EG_ColorTransform.hueOff">
  48744. <remarks/>
  48745. </member>
  48746. <member name="F:NPOI.OpenXmlFormats.Dml.EG_ColorTransform.inv">
  48747. <remarks/>
  48748. </member>
  48749. <member name="F:NPOI.OpenXmlFormats.Dml.EG_ColorTransform.invGamma">
  48750. <remarks/>
  48751. </member>
  48752. <member name="F:NPOI.OpenXmlFormats.Dml.EG_ColorTransform.lum">
  48753. <remarks/>
  48754. </member>
  48755. <member name="F:NPOI.OpenXmlFormats.Dml.EG_ColorTransform.lumMod">
  48756. <remarks/>
  48757. </member>
  48758. <member name="F:NPOI.OpenXmlFormats.Dml.EG_ColorTransform.lumOff">
  48759. <remarks/>
  48760. </member>
  48761. <member name="F:NPOI.OpenXmlFormats.Dml.EG_ColorTransform.red">
  48762. <remarks/>
  48763. </member>
  48764. <member name="F:NPOI.OpenXmlFormats.Dml.EG_ColorTransform.redMod">
  48765. <remarks/>
  48766. </member>
  48767. <member name="F:NPOI.OpenXmlFormats.Dml.EG_ColorTransform.redOff">
  48768. <remarks/>
  48769. </member>
  48770. <member name="F:NPOI.OpenXmlFormats.Dml.EG_ColorTransform.sat">
  48771. <remarks/>
  48772. </member>
  48773. <member name="F:NPOI.OpenXmlFormats.Dml.EG_ColorTransform.satMod">
  48774. <remarks/>
  48775. </member>
  48776. <member name="F:NPOI.OpenXmlFormats.Dml.EG_ColorTransform.satOff">
  48777. <remarks/>
  48778. </member>
  48779. <member name="F:NPOI.OpenXmlFormats.Dml.EG_ColorTransform.shade">
  48780. <remarks/>
  48781. </member>
  48782. <member name="F:NPOI.OpenXmlFormats.Dml.EG_ColorTransform.tint">
  48783. <remarks/>
  48784. </member>
  48785. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SystemColorVal.scrollBar">
  48786. <remarks/>
  48787. </member>
  48788. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SystemColorVal.background">
  48789. <remarks/>
  48790. </member>
  48791. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SystemColorVal.activeCaption">
  48792. <remarks/>
  48793. </member>
  48794. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SystemColorVal.inactiveCaption">
  48795. <remarks/>
  48796. </member>
  48797. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SystemColorVal.menu">
  48798. <remarks/>
  48799. </member>
  48800. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SystemColorVal.window">
  48801. <remarks/>
  48802. </member>
  48803. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SystemColorVal.windowFrame">
  48804. <remarks/>
  48805. </member>
  48806. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SystemColorVal.menuText">
  48807. <remarks/>
  48808. </member>
  48809. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SystemColorVal.windowText">
  48810. <remarks/>
  48811. </member>
  48812. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SystemColorVal.captionText">
  48813. <remarks/>
  48814. </member>
  48815. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SystemColorVal.activeBorder">
  48816. <remarks/>
  48817. </member>
  48818. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SystemColorVal.inactiveBorder">
  48819. <remarks/>
  48820. </member>
  48821. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SystemColorVal.appWorkspace">
  48822. <remarks/>
  48823. </member>
  48824. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SystemColorVal.highlight">
  48825. <remarks/>
  48826. </member>
  48827. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SystemColorVal.highlightText">
  48828. <remarks/>
  48829. </member>
  48830. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SystemColorVal.btnFace">
  48831. <remarks/>
  48832. </member>
  48833. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SystemColorVal.btnShadow">
  48834. <remarks/>
  48835. </member>
  48836. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SystemColorVal.grayText">
  48837. <remarks/>
  48838. </member>
  48839. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SystemColorVal.btnText">
  48840. <remarks/>
  48841. </member>
  48842. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SystemColorVal.inactiveCaptionText">
  48843. <remarks/>
  48844. </member>
  48845. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SystemColorVal.btnHighlight">
  48846. <remarks/>
  48847. </member>
  48848. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SystemColorVal.Item3dDkShadow">
  48849. <remarks/>
  48850. </member>
  48851. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SystemColorVal.Item3dLight">
  48852. <remarks/>
  48853. </member>
  48854. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SystemColorVal.infoText">
  48855. <remarks/>
  48856. </member>
  48857. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SystemColorVal.infoBk">
  48858. <remarks/>
  48859. </member>
  48860. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SystemColorVal.hotLight">
  48861. <remarks/>
  48862. </member>
  48863. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SystemColorVal.gradientActiveCaption">
  48864. <remarks/>
  48865. </member>
  48866. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SystemColorVal.gradientInactiveCaption">
  48867. <remarks/>
  48868. </member>
  48869. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SystemColorVal.menuHighlight">
  48870. <remarks/>
  48871. </member>
  48872. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SystemColorVal.menuBar">
  48873. <remarks/>
  48874. </member>
  48875. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SchemeColorVal.bg1">
  48876. <remarks/>
  48877. </member>
  48878. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SchemeColorVal.tx1">
  48879. <remarks/>
  48880. </member>
  48881. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SchemeColorVal.bg2">
  48882. <remarks/>
  48883. </member>
  48884. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SchemeColorVal.tx2">
  48885. <remarks/>
  48886. </member>
  48887. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SchemeColorVal.accent1">
  48888. <remarks/>
  48889. </member>
  48890. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SchemeColorVal.accent2">
  48891. <remarks/>
  48892. </member>
  48893. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SchemeColorVal.accent3">
  48894. <remarks/>
  48895. </member>
  48896. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SchemeColorVal.accent4">
  48897. <remarks/>
  48898. </member>
  48899. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SchemeColorVal.accent5">
  48900. <remarks/>
  48901. </member>
  48902. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SchemeColorVal.accent6">
  48903. <remarks/>
  48904. </member>
  48905. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SchemeColorVal.hlink">
  48906. <remarks/>
  48907. </member>
  48908. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SchemeColorVal.folHlink">
  48909. <remarks/>
  48910. </member>
  48911. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SchemeColorVal.phClr">
  48912. <remarks/>
  48913. </member>
  48914. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SchemeColorVal.dk1">
  48915. <remarks/>
  48916. </member>
  48917. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SchemeColorVal.lt1">
  48918. <remarks/>
  48919. </member>
  48920. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SchemeColorVal.dk2">
  48921. <remarks/>
  48922. </member>
  48923. <member name="F:NPOI.OpenXmlFormats.Dml.ST_SchemeColorVal.lt2">
  48924. <remarks/>
  48925. </member>
  48926. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.aliceBlue">
  48927. <remarks/>
  48928. </member>
  48929. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.antiqueWhite">
  48930. <remarks/>
  48931. </member>
  48932. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.aqua">
  48933. <remarks/>
  48934. </member>
  48935. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.aquamarine">
  48936. <remarks/>
  48937. </member>
  48938. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.azure">
  48939. <remarks/>
  48940. </member>
  48941. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.beige">
  48942. <remarks/>
  48943. </member>
  48944. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.bisque">
  48945. <remarks/>
  48946. </member>
  48947. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.black">
  48948. <remarks/>
  48949. </member>
  48950. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.blanchedAlmond">
  48951. <remarks/>
  48952. </member>
  48953. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.blue">
  48954. <remarks/>
  48955. </member>
  48956. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.blueViolet">
  48957. <remarks/>
  48958. </member>
  48959. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.brown">
  48960. <remarks/>
  48961. </member>
  48962. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.burlyWood">
  48963. <remarks/>
  48964. </member>
  48965. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.cadetBlue">
  48966. <remarks/>
  48967. </member>
  48968. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.chartreuse">
  48969. <remarks/>
  48970. </member>
  48971. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.chocolate">
  48972. <remarks/>
  48973. </member>
  48974. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.coral">
  48975. <remarks/>
  48976. </member>
  48977. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.cornflowerBlue">
  48978. <remarks/>
  48979. </member>
  48980. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.cornsilk">
  48981. <remarks/>
  48982. </member>
  48983. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.crimson">
  48984. <remarks/>
  48985. </member>
  48986. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.cyan">
  48987. <remarks/>
  48988. </member>
  48989. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.dkBlue">
  48990. <remarks/>
  48991. </member>
  48992. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.dkCyan">
  48993. <remarks/>
  48994. </member>
  48995. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.dkGoldenrod">
  48996. <remarks/>
  48997. </member>
  48998. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.dkGray">
  48999. <remarks/>
  49000. </member>
  49001. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.dkGreen">
  49002. <remarks/>
  49003. </member>
  49004. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.dkKhaki">
  49005. <remarks/>
  49006. </member>
  49007. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.dkMagenta">
  49008. <remarks/>
  49009. </member>
  49010. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.dkOliveGreen">
  49011. <remarks/>
  49012. </member>
  49013. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.dkOrange">
  49014. <remarks/>
  49015. </member>
  49016. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.dkOrchid">
  49017. <remarks/>
  49018. </member>
  49019. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.dkRed">
  49020. <remarks/>
  49021. </member>
  49022. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.dkSalmon">
  49023. <remarks/>
  49024. </member>
  49025. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.dkSeaGreen">
  49026. <remarks/>
  49027. </member>
  49028. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.dkSlateBlue">
  49029. <remarks/>
  49030. </member>
  49031. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.dkSlateGray">
  49032. <remarks/>
  49033. </member>
  49034. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.dkTurquoise">
  49035. <remarks/>
  49036. </member>
  49037. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.dkViolet">
  49038. <remarks/>
  49039. </member>
  49040. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.deepPink">
  49041. <remarks/>
  49042. </member>
  49043. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.deepSkyBlue">
  49044. <remarks/>
  49045. </member>
  49046. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.dimGray">
  49047. <remarks/>
  49048. </member>
  49049. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.dodgerBlue">
  49050. <remarks/>
  49051. </member>
  49052. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.firebrick">
  49053. <remarks/>
  49054. </member>
  49055. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.floralWhite">
  49056. <remarks/>
  49057. </member>
  49058. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.forestGreen">
  49059. <remarks/>
  49060. </member>
  49061. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.fuchsia">
  49062. <remarks/>
  49063. </member>
  49064. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.gainsboro">
  49065. <remarks/>
  49066. </member>
  49067. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.ghostWhite">
  49068. <remarks/>
  49069. </member>
  49070. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.gold">
  49071. <remarks/>
  49072. </member>
  49073. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.goldenrod">
  49074. <remarks/>
  49075. </member>
  49076. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.gray">
  49077. <remarks/>
  49078. </member>
  49079. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.green">
  49080. <remarks/>
  49081. </member>
  49082. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.greenYellow">
  49083. <remarks/>
  49084. </member>
  49085. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.honeydew">
  49086. <remarks/>
  49087. </member>
  49088. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.hotPink">
  49089. <remarks/>
  49090. </member>
  49091. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.indianRed">
  49092. <remarks/>
  49093. </member>
  49094. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.indigo">
  49095. <remarks/>
  49096. </member>
  49097. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.ivory">
  49098. <remarks/>
  49099. </member>
  49100. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.khaki">
  49101. <remarks/>
  49102. </member>
  49103. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.lavender">
  49104. <remarks/>
  49105. </member>
  49106. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.lavenderBlush">
  49107. <remarks/>
  49108. </member>
  49109. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.lawnGreen">
  49110. <remarks/>
  49111. </member>
  49112. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.lemonChiffon">
  49113. <remarks/>
  49114. </member>
  49115. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.ltBlue">
  49116. <remarks/>
  49117. </member>
  49118. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.ltCoral">
  49119. <remarks/>
  49120. </member>
  49121. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.ltCyan">
  49122. <remarks/>
  49123. </member>
  49124. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.ltGoldenrodYellow">
  49125. <remarks/>
  49126. </member>
  49127. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.ltGray">
  49128. <remarks/>
  49129. </member>
  49130. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.ltGreen">
  49131. <remarks/>
  49132. </member>
  49133. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.ltPink">
  49134. <remarks/>
  49135. </member>
  49136. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.ltSalmon">
  49137. <remarks/>
  49138. </member>
  49139. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.ltSeaGreen">
  49140. <remarks/>
  49141. </member>
  49142. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.ltSkyBlue">
  49143. <remarks/>
  49144. </member>
  49145. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.ltSlateGray">
  49146. <remarks/>
  49147. </member>
  49148. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.ltSteelBlue">
  49149. <remarks/>
  49150. </member>
  49151. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.ltYellow">
  49152. <remarks/>
  49153. </member>
  49154. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.lime">
  49155. <remarks/>
  49156. </member>
  49157. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.limeGreen">
  49158. <remarks/>
  49159. </member>
  49160. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.linen">
  49161. <remarks/>
  49162. </member>
  49163. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.magenta">
  49164. <remarks/>
  49165. </member>
  49166. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.maroon">
  49167. <remarks/>
  49168. </member>
  49169. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.medAquamarine">
  49170. <remarks/>
  49171. </member>
  49172. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.medBlue">
  49173. <remarks/>
  49174. </member>
  49175. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.medOrchid">
  49176. <remarks/>
  49177. </member>
  49178. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.medPurple">
  49179. <remarks/>
  49180. </member>
  49181. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.medSeaGreen">
  49182. <remarks/>
  49183. </member>
  49184. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.medSlateBlue">
  49185. <remarks/>
  49186. </member>
  49187. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.medSpringGreen">
  49188. <remarks/>
  49189. </member>
  49190. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.medTurquoise">
  49191. <remarks/>
  49192. </member>
  49193. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.medVioletRed">
  49194. <remarks/>
  49195. </member>
  49196. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.midnightBlue">
  49197. <remarks/>
  49198. </member>
  49199. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.mintCream">
  49200. <remarks/>
  49201. </member>
  49202. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.mistyRose">
  49203. <remarks/>
  49204. </member>
  49205. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.moccasin">
  49206. <remarks/>
  49207. </member>
  49208. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.navajoWhite">
  49209. <remarks/>
  49210. </member>
  49211. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.navy">
  49212. <remarks/>
  49213. </member>
  49214. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.oldLace">
  49215. <remarks/>
  49216. </member>
  49217. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.olive">
  49218. <remarks/>
  49219. </member>
  49220. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.oliveDrab">
  49221. <remarks/>
  49222. </member>
  49223. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.orange">
  49224. <remarks/>
  49225. </member>
  49226. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.orangeRed">
  49227. <remarks/>
  49228. </member>
  49229. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.orchid">
  49230. <remarks/>
  49231. </member>
  49232. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.paleGoldenrod">
  49233. <remarks/>
  49234. </member>
  49235. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.paleGreen">
  49236. <remarks/>
  49237. </member>
  49238. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.paleTurquoise">
  49239. <remarks/>
  49240. </member>
  49241. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.paleVioletRed">
  49242. <remarks/>
  49243. </member>
  49244. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.papayaWhip">
  49245. <remarks/>
  49246. </member>
  49247. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.peachPuff">
  49248. <remarks/>
  49249. </member>
  49250. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.peru">
  49251. <remarks/>
  49252. </member>
  49253. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.pink">
  49254. <remarks/>
  49255. </member>
  49256. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.plum">
  49257. <remarks/>
  49258. </member>
  49259. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.powderBlue">
  49260. <remarks/>
  49261. </member>
  49262. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.purple">
  49263. <remarks/>
  49264. </member>
  49265. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.red">
  49266. <remarks/>
  49267. </member>
  49268. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.rosyBrown">
  49269. <remarks/>
  49270. </member>
  49271. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.royalBlue">
  49272. <remarks/>
  49273. </member>
  49274. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.saddleBrown">
  49275. <remarks/>
  49276. </member>
  49277. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.salmon">
  49278. <remarks/>
  49279. </member>
  49280. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.sandyBrown">
  49281. <remarks/>
  49282. </member>
  49283. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.seaGreen">
  49284. <remarks/>
  49285. </member>
  49286. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.seaShell">
  49287. <remarks/>
  49288. </member>
  49289. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.sienna">
  49290. <remarks/>
  49291. </member>
  49292. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.silver">
  49293. <remarks/>
  49294. </member>
  49295. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.skyBlue">
  49296. <remarks/>
  49297. </member>
  49298. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.slateBlue">
  49299. <remarks/>
  49300. </member>
  49301. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.slateGray">
  49302. <remarks/>
  49303. </member>
  49304. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.snow">
  49305. <remarks/>
  49306. </member>
  49307. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.springGreen">
  49308. <remarks/>
  49309. </member>
  49310. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.steelBlue">
  49311. <remarks/>
  49312. </member>
  49313. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.tan">
  49314. <remarks/>
  49315. </member>
  49316. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.teal">
  49317. <remarks/>
  49318. </member>
  49319. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.thistle">
  49320. <remarks/>
  49321. </member>
  49322. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.tomato">
  49323. <remarks/>
  49324. </member>
  49325. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.turquoise">
  49326. <remarks/>
  49327. </member>
  49328. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.violet">
  49329. <remarks/>
  49330. </member>
  49331. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.wheat">
  49332. <remarks/>
  49333. </member>
  49334. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.white">
  49335. <remarks/>
  49336. </member>
  49337. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.whiteSmoke">
  49338. <remarks/>
  49339. </member>
  49340. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.yellow">
  49341. <remarks/>
  49342. </member>
  49343. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetColorVal.yellowGreen">
  49344. <remarks/>
  49345. </member>
  49346. <member name="F:NPOI.OpenXmlFormats.Dml.ST_RectAlignment.tl">
  49347. <remarks/>
  49348. </member>
  49349. <member name="F:NPOI.OpenXmlFormats.Dml.ST_RectAlignment.t">
  49350. <remarks/>
  49351. </member>
  49352. <member name="F:NPOI.OpenXmlFormats.Dml.ST_RectAlignment.tr">
  49353. <remarks/>
  49354. </member>
  49355. <member name="F:NPOI.OpenXmlFormats.Dml.ST_RectAlignment.l">
  49356. <remarks/>
  49357. </member>
  49358. <member name="F:NPOI.OpenXmlFormats.Dml.ST_RectAlignment.ctr">
  49359. <remarks/>
  49360. </member>
  49361. <member name="F:NPOI.OpenXmlFormats.Dml.ST_RectAlignment.r">
  49362. <remarks/>
  49363. </member>
  49364. <member name="F:NPOI.OpenXmlFormats.Dml.ST_RectAlignment.bl">
  49365. <remarks/>
  49366. </member>
  49367. <member name="F:NPOI.OpenXmlFormats.Dml.ST_RectAlignment.b">
  49368. <remarks/>
  49369. </member>
  49370. <member name="F:NPOI.OpenXmlFormats.Dml.ST_RectAlignment.br">
  49371. <remarks/>
  49372. </member>
  49373. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_BarDir.bar">
  49374. <remarks/>
  49375. </member>
  49376. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_BarDir.col">
  49377. <remarks/>
  49378. </member>
  49379. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_BarGrouping.percentStacked">
  49380. <remarks/>
  49381. </member>
  49382. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_BarGrouping.clustered">
  49383. <remarks/>
  49384. </member>
  49385. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_BarGrouping.standard">
  49386. <remarks/>
  49387. </member>
  49388. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_BarGrouping.stacked">
  49389. <remarks/>
  49390. </member>
  49391. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_SizeRepresents.area">
  49392. <remarks/>
  49393. </member>
  49394. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_SizeRepresents.w">
  49395. <remarks/>
  49396. </member>
  49397. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_PageSetupOrientation.default">
  49398. <remarks/>
  49399. </member>
  49400. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_PageSetupOrientation.portrait">
  49401. <remarks/>
  49402. </member>
  49403. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_PageSetupOrientation.landscape">
  49404. <remarks/>
  49405. </member>
  49406. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_DispBlanksAs.span">
  49407. <remarks/>
  49408. </member>
  49409. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_DispBlanksAs.gap">
  49410. <remarks/>
  49411. </member>
  49412. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_DispBlanksAs.zero">
  49413. <remarks/>
  49414. </member>
  49415. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_LegendPos.b">
  49416. <remarks/>
  49417. </member>
  49418. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_LegendPos.tr">
  49419. <remarks/>
  49420. </member>
  49421. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_LegendPos.l">
  49422. <remarks/>
  49423. </member>
  49424. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_LegendPos.r">
  49425. <remarks/>
  49426. </member>
  49427. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_LegendPos.t">
  49428. <remarks/>
  49429. </member>
  49430. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_LayoutTarget.inner">
  49431. <remarks/>
  49432. </member>
  49433. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_LayoutTarget.outer">
  49434. <remarks/>
  49435. </member>
  49436. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_LayoutMode.edge">
  49437. <remarks/>
  49438. </member>
  49439. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_LayoutMode.factor">
  49440. <remarks/>
  49441. </member>
  49442. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_Orientation.maxMin">
  49443. <remarks/>
  49444. </member>
  49445. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_Orientation.minMax">
  49446. <remarks/>
  49447. </member>
  49448. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_AxPos.b">
  49449. <remarks/>
  49450. </member>
  49451. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_AxPos.l">
  49452. <remarks/>
  49453. </member>
  49454. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_AxPos.r">
  49455. <remarks/>
  49456. </member>
  49457. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_AxPos.t">
  49458. <remarks/>
  49459. </member>
  49460. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_TickMark.cross">
  49461. <remarks/>
  49462. </member>
  49463. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_TickMark.in">
  49464. <remarks/>
  49465. </member>
  49466. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_TickMark.none">
  49467. <remarks/>
  49468. </member>
  49469. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_TickMark.out">
  49470. <remarks/>
  49471. </member>
  49472. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_TickLblPos.high">
  49473. <remarks/>
  49474. </member>
  49475. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_TickLblPos.low">
  49476. <remarks/>
  49477. </member>
  49478. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_TickLblPos.nextTo">
  49479. <remarks/>
  49480. </member>
  49481. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_TickLblPos.none">
  49482. <remarks/>
  49483. </member>
  49484. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_Crosses.autoZero">
  49485. <remarks/>
  49486. </member>
  49487. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_Crosses.max">
  49488. <remarks/>
  49489. </member>
  49490. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_Crosses.min">
  49491. <remarks/>
  49492. </member>
  49493. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_TimeUnit.days">
  49494. <remarks/>
  49495. </member>
  49496. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_TimeUnit.months">
  49497. <remarks/>
  49498. </member>
  49499. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_TimeUnit.years">
  49500. <remarks/>
  49501. </member>
  49502. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_LblAlgn.ctr">
  49503. <remarks/>
  49504. </member>
  49505. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_LblAlgn.l">
  49506. <remarks/>
  49507. </member>
  49508. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_LblAlgn.r">
  49509. <remarks/>
  49510. </member>
  49511. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_BuiltInUnit.hundreds">
  49512. <remarks/>
  49513. </member>
  49514. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_BuiltInUnit.thousands">
  49515. <remarks/>
  49516. </member>
  49517. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_BuiltInUnit.tenThousands">
  49518. <remarks/>
  49519. </member>
  49520. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_BuiltInUnit.hundredThousands">
  49521. <remarks/>
  49522. </member>
  49523. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_BuiltInUnit.millions">
  49524. <remarks/>
  49525. </member>
  49526. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_BuiltInUnit.tenMillions">
  49527. <remarks/>
  49528. </member>
  49529. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_BuiltInUnit.hundredMillions">
  49530. <remarks/>
  49531. </member>
  49532. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_BuiltInUnit.billions">
  49533. <remarks/>
  49534. </member>
  49535. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_BuiltInUnit.trillions">
  49536. <remarks/>
  49537. </member>
  49538. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_CrossBetween.between">
  49539. <remarks/>
  49540. </member>
  49541. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_CrossBetween.midCat">
  49542. <remarks/>
  49543. </member>
  49544. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_MarkerStyle.circle">
  49545. <remarks/>
  49546. </member>
  49547. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_MarkerStyle.dash">
  49548. <remarks/>
  49549. </member>
  49550. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_MarkerStyle.diamond">
  49551. <remarks/>
  49552. </member>
  49553. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_MarkerStyle.dot">
  49554. <remarks/>
  49555. </member>
  49556. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_MarkerStyle.none">
  49557. <remarks/>
  49558. </member>
  49559. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_MarkerStyle.picture">
  49560. <remarks/>
  49561. </member>
  49562. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_MarkerStyle.plus">
  49563. <remarks/>
  49564. </member>
  49565. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_MarkerStyle.square">
  49566. <remarks/>
  49567. </member>
  49568. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_MarkerStyle.star">
  49569. <remarks/>
  49570. </member>
  49571. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_MarkerStyle.triangle">
  49572. <remarks/>
  49573. </member>
  49574. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_MarkerStyle.x">
  49575. <remarks/>
  49576. </member>
  49577. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_PictureFormat.stretch">
  49578. <remarks/>
  49579. </member>
  49580. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_PictureFormat.stack">
  49581. <remarks/>
  49582. </member>
  49583. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_PictureFormat.stackScale">
  49584. <remarks/>
  49585. </member>
  49586. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_DLblPos.bestFit">
  49587. <remarks/>
  49588. </member>
  49589. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_DLblPos.b">
  49590. <remarks/>
  49591. </member>
  49592. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_DLblPos.ctr">
  49593. <remarks/>
  49594. </member>
  49595. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_DLblPos.inBase">
  49596. <remarks/>
  49597. </member>
  49598. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_DLblPos.inEnd">
  49599. <remarks/>
  49600. </member>
  49601. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_DLblPos.l">
  49602. <remarks/>
  49603. </member>
  49604. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_DLblPos.outEnd">
  49605. <remarks/>
  49606. </member>
  49607. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_DLblPos.r">
  49608. <remarks/>
  49609. </member>
  49610. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_DLblPos.t">
  49611. <remarks/>
  49612. </member>
  49613. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_TrendlineType.exp">
  49614. <remarks/>
  49615. </member>
  49616. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_TrendlineType.linear">
  49617. <remarks/>
  49618. </member>
  49619. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_TrendlineType.log">
  49620. <remarks/>
  49621. </member>
  49622. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_TrendlineType.movingAvg">
  49623. <remarks/>
  49624. </member>
  49625. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_TrendlineType.poly">
  49626. <remarks/>
  49627. </member>
  49628. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_TrendlineType.power">
  49629. <remarks/>
  49630. </member>
  49631. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_ErrDir.x">
  49632. <remarks/>
  49633. </member>
  49634. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_ErrDir.y">
  49635. <remarks/>
  49636. </member>
  49637. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_ErrBarType.both">
  49638. <remarks/>
  49639. </member>
  49640. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_ErrBarType.minus">
  49641. <remarks/>
  49642. </member>
  49643. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_ErrBarType.plus">
  49644. <remarks/>
  49645. </member>
  49646. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_ErrValType.cust">
  49647. <remarks/>
  49648. </member>
  49649. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_ErrValType.fixedVal">
  49650. <remarks/>
  49651. </member>
  49652. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_ErrValType.percentage">
  49653. <remarks/>
  49654. </member>
  49655. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_ErrValType.stdDev">
  49656. <remarks/>
  49657. </member>
  49658. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_ErrValType.stdErr">
  49659. <remarks/>
  49660. </member>
  49661. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_SplitType.auto">
  49662. <remarks/>
  49663. </member>
  49664. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_SplitType.cust">
  49665. <remarks/>
  49666. </member>
  49667. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_SplitType.percent">
  49668. <remarks/>
  49669. </member>
  49670. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_SplitType.pos">
  49671. <remarks/>
  49672. </member>
  49673. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_SplitType.val">
  49674. <remarks/>
  49675. </member>
  49676. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_Shape.cone">
  49677. <remarks/>
  49678. </member>
  49679. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_Shape.coneToMax">
  49680. <remarks/>
  49681. </member>
  49682. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_Shape.box">
  49683. <remarks/>
  49684. </member>
  49685. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_Shape.cylinder">
  49686. <remarks/>
  49687. </member>
  49688. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_Shape.pyramid">
  49689. <remarks/>
  49690. </member>
  49691. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_Shape.pyramidToMax">
  49692. <remarks/>
  49693. </member>
  49694. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_Grouping.percentStacked">
  49695. <remarks/>
  49696. </member>
  49697. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_Grouping.standard">
  49698. <remarks/>
  49699. </member>
  49700. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_Grouping.stacked">
  49701. <remarks/>
  49702. </member>
  49703. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_OfPieType.pie">
  49704. <remarks/>
  49705. </member>
  49706. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_OfPieType.bar">
  49707. <remarks/>
  49708. </member>
  49709. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_RadarStyle.standard">
  49710. <remarks/>
  49711. </member>
  49712. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_RadarStyle.marker">
  49713. <remarks/>
  49714. </member>
  49715. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_RadarStyle.filled">
  49716. <remarks/>
  49717. </member>
  49718. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_ScatterStyle.none">
  49719. <remarks/>
  49720. </member>
  49721. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_ScatterStyle.line">
  49722. <remarks/>
  49723. </member>
  49724. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_ScatterStyle.lineMarker">
  49725. <remarks/>
  49726. </member>
  49727. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_ScatterStyle.marker">
  49728. <remarks/>
  49729. </member>
  49730. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_ScatterStyle.smooth">
  49731. <remarks/>
  49732. </member>
  49733. <member name="F:NPOI.OpenXmlFormats.Dml.Chart.ST_ScatterStyle.smoothMarker">
  49734. <remarks/>
  49735. </member>
  49736. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.legacyObliqueTopLeft">
  49737. <remarks/>
  49738. </member>
  49739. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.legacyObliqueTop">
  49740. <remarks/>
  49741. </member>
  49742. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.legacyObliqueTopRight">
  49743. <remarks/>
  49744. </member>
  49745. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.legacyObliqueLeft">
  49746. <remarks/>
  49747. </member>
  49748. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.legacyObliqueFront">
  49749. <remarks/>
  49750. </member>
  49751. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.legacyObliqueRight">
  49752. <remarks/>
  49753. </member>
  49754. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.legacyObliqueBottomLeft">
  49755. <remarks/>
  49756. </member>
  49757. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.legacyObliqueBottom">
  49758. <remarks/>
  49759. </member>
  49760. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.legacyObliqueBottomRight">
  49761. <remarks/>
  49762. </member>
  49763. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.legacyPerspectiveTopLeft">
  49764. <remarks/>
  49765. </member>
  49766. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.legacyPerspectiveTop">
  49767. <remarks/>
  49768. </member>
  49769. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.legacyPerspectiveTopRight">
  49770. <remarks/>
  49771. </member>
  49772. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.legacyPerspectiveLeft">
  49773. <remarks/>
  49774. </member>
  49775. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.legacyPerspectiveFront">
  49776. <remarks/>
  49777. </member>
  49778. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.legacyPerspectiveRight">
  49779. <remarks/>
  49780. </member>
  49781. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.legacyPerspectiveBottomLeft">
  49782. <remarks/>
  49783. </member>
  49784. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.legacyPerspectiveBottom">
  49785. <remarks/>
  49786. </member>
  49787. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.legacyPerspectiveBottomRight">
  49788. <remarks/>
  49789. </member>
  49790. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.orthographicFront">
  49791. <remarks/>
  49792. </member>
  49793. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.isometricTopUp">
  49794. <remarks/>
  49795. </member>
  49796. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.isometricTopDown">
  49797. <remarks/>
  49798. </member>
  49799. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.isometricBottomUp">
  49800. <remarks/>
  49801. </member>
  49802. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.isometricBottomDown">
  49803. <remarks/>
  49804. </member>
  49805. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.isometricLeftUp">
  49806. <remarks/>
  49807. </member>
  49808. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.isometricLeftDown">
  49809. <remarks/>
  49810. </member>
  49811. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.isometricRightUp">
  49812. <remarks/>
  49813. </member>
  49814. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.isometricRightDown">
  49815. <remarks/>
  49816. </member>
  49817. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.isometricOffAxis1Left">
  49818. <remarks/>
  49819. </member>
  49820. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.isometricOffAxis1Right">
  49821. <remarks/>
  49822. </member>
  49823. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.isometricOffAxis1Top">
  49824. <remarks/>
  49825. </member>
  49826. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.isometricOffAxis2Left">
  49827. <remarks/>
  49828. </member>
  49829. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.isometricOffAxis2Right">
  49830. <remarks/>
  49831. </member>
  49832. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.isometricOffAxis2Top">
  49833. <remarks/>
  49834. </member>
  49835. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.isometricOffAxis3Left">
  49836. <remarks/>
  49837. </member>
  49838. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.isometricOffAxis3Right">
  49839. <remarks/>
  49840. </member>
  49841. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.isometricOffAxis3Bottom">
  49842. <remarks/>
  49843. </member>
  49844. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.isometricOffAxis4Left">
  49845. <remarks/>
  49846. </member>
  49847. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.isometricOffAxis4Right">
  49848. <remarks/>
  49849. </member>
  49850. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.isometricOffAxis4Bottom">
  49851. <remarks/>
  49852. </member>
  49853. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.obliqueTopLeft">
  49854. <remarks/>
  49855. </member>
  49856. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.obliqueTop">
  49857. <remarks/>
  49858. </member>
  49859. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.obliqueTopRight">
  49860. <remarks/>
  49861. </member>
  49862. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.obliqueLeft">
  49863. <remarks/>
  49864. </member>
  49865. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.obliqueRight">
  49866. <remarks/>
  49867. </member>
  49868. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.obliqueBottomLeft">
  49869. <remarks/>
  49870. </member>
  49871. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.obliqueBottom">
  49872. <remarks/>
  49873. </member>
  49874. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.obliqueBottomRight">
  49875. <remarks/>
  49876. </member>
  49877. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.perspectiveFront">
  49878. <remarks/>
  49879. </member>
  49880. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.perspectiveLeft">
  49881. <remarks/>
  49882. </member>
  49883. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.perspectiveRight">
  49884. <remarks/>
  49885. </member>
  49886. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.perspectiveAbove">
  49887. <remarks/>
  49888. </member>
  49889. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.perspectiveBelow">
  49890. <remarks/>
  49891. </member>
  49892. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.perspectiveAboveLeftFacing">
  49893. <remarks/>
  49894. </member>
  49895. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.perspectiveAboveRightFacing">
  49896. <remarks/>
  49897. </member>
  49898. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.perspectiveContrastingLeftFacing">
  49899. <remarks/>
  49900. </member>
  49901. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.perspectiveContrastingRightFacing">
  49902. <remarks/>
  49903. </member>
  49904. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.perspectiveHeroicLeftFacing">
  49905. <remarks/>
  49906. </member>
  49907. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.perspectiveHeroicRightFacing">
  49908. <remarks/>
  49909. </member>
  49910. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.perspectiveHeroicExtremeLeftFacing">
  49911. <remarks/>
  49912. </member>
  49913. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.perspectiveHeroicExtremeRightFacing">
  49914. <remarks/>
  49915. </member>
  49916. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.perspectiveRelaxed">
  49917. <remarks/>
  49918. </member>
  49919. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetCameraType.perspectiveRelaxedModerately">
  49920. <remarks/>
  49921. </member>
  49922. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigType.legacyFlat1">
  49923. <remarks/>
  49924. </member>
  49925. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigType.legacyFlat2">
  49926. <remarks/>
  49927. </member>
  49928. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigType.legacyFlat3">
  49929. <remarks/>
  49930. </member>
  49931. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigType.legacyFlat4">
  49932. <remarks/>
  49933. </member>
  49934. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigType.legacyNormal1">
  49935. <remarks/>
  49936. </member>
  49937. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigType.legacyNormal2">
  49938. <remarks/>
  49939. </member>
  49940. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigType.legacyNormal3">
  49941. <remarks/>
  49942. </member>
  49943. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigType.legacyNormal4">
  49944. <remarks/>
  49945. </member>
  49946. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigType.legacyHarsh1">
  49947. <remarks/>
  49948. </member>
  49949. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigType.legacyHarsh2">
  49950. <remarks/>
  49951. </member>
  49952. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigType.legacyHarsh3">
  49953. <remarks/>
  49954. </member>
  49955. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigType.legacyHarsh4">
  49956. <remarks/>
  49957. </member>
  49958. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigType.threePt">
  49959. <remarks/>
  49960. </member>
  49961. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigType.balanced">
  49962. <remarks/>
  49963. </member>
  49964. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigType.soft">
  49965. <remarks/>
  49966. </member>
  49967. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigType.harsh">
  49968. <remarks/>
  49969. </member>
  49970. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigType.flood">
  49971. <remarks/>
  49972. </member>
  49973. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigType.contrasting">
  49974. <remarks/>
  49975. </member>
  49976. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigType.morning">
  49977. <remarks/>
  49978. </member>
  49979. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigType.sunrise">
  49980. <remarks/>
  49981. </member>
  49982. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigType.sunset">
  49983. <remarks/>
  49984. </member>
  49985. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigType.chilly">
  49986. <remarks/>
  49987. </member>
  49988. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigType.freezing">
  49989. <remarks/>
  49990. </member>
  49991. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigType.flat">
  49992. <remarks/>
  49993. </member>
  49994. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigType.twoPt">
  49995. <remarks/>
  49996. </member>
  49997. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigType.glow">
  49998. <remarks/>
  49999. </member>
  50000. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigType.brightRoom">
  50001. <remarks/>
  50002. </member>
  50003. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigDirection.tl">
  50004. <remarks/>
  50005. </member>
  50006. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigDirection.t">
  50007. <remarks/>
  50008. </member>
  50009. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigDirection.tr">
  50010. <remarks/>
  50011. </member>
  50012. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigDirection.l">
  50013. <remarks/>
  50014. </member>
  50015. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigDirection.r">
  50016. <remarks/>
  50017. </member>
  50018. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigDirection.bl">
  50019. <remarks/>
  50020. </member>
  50021. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigDirection.b">
  50022. <remarks/>
  50023. </member>
  50024. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LightRigDirection.br">
  50025. <remarks/>
  50026. </member>
  50027. <member name="F:NPOI.OpenXmlFormats.Dml.ST_BevelPresetType.relaxedInset">
  50028. <remarks/>
  50029. </member>
  50030. <member name="F:NPOI.OpenXmlFormats.Dml.ST_BevelPresetType.circle">
  50031. <remarks/>
  50032. </member>
  50033. <member name="F:NPOI.OpenXmlFormats.Dml.ST_BevelPresetType.slope">
  50034. <remarks/>
  50035. </member>
  50036. <member name="F:NPOI.OpenXmlFormats.Dml.ST_BevelPresetType.cross">
  50037. <remarks/>
  50038. </member>
  50039. <member name="F:NPOI.OpenXmlFormats.Dml.ST_BevelPresetType.angle">
  50040. <remarks/>
  50041. </member>
  50042. <member name="F:NPOI.OpenXmlFormats.Dml.ST_BevelPresetType.softRound">
  50043. <remarks/>
  50044. </member>
  50045. <member name="F:NPOI.OpenXmlFormats.Dml.ST_BevelPresetType.convex">
  50046. <remarks/>
  50047. </member>
  50048. <member name="F:NPOI.OpenXmlFormats.Dml.ST_BevelPresetType.coolSlant">
  50049. <remarks/>
  50050. </member>
  50051. <member name="F:NPOI.OpenXmlFormats.Dml.ST_BevelPresetType.divot">
  50052. <remarks/>
  50053. </member>
  50054. <member name="F:NPOI.OpenXmlFormats.Dml.ST_BevelPresetType.riblet">
  50055. <remarks/>
  50056. </member>
  50057. <member name="F:NPOI.OpenXmlFormats.Dml.ST_BevelPresetType.hardEdge">
  50058. <remarks/>
  50059. </member>
  50060. <member name="F:NPOI.OpenXmlFormats.Dml.ST_BevelPresetType.artDeco">
  50061. <remarks/>
  50062. </member>
  50063. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetMaterialType.legacyMatte">
  50064. <remarks/>
  50065. </member>
  50066. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetMaterialType.legacyPlastic">
  50067. <remarks/>
  50068. </member>
  50069. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetMaterialType.legacyMetal">
  50070. <remarks/>
  50071. </member>
  50072. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetMaterialType.legacyWireframe">
  50073. <remarks/>
  50074. </member>
  50075. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetMaterialType.matte">
  50076. <remarks/>
  50077. </member>
  50078. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetMaterialType.plastic">
  50079. <remarks/>
  50080. </member>
  50081. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetMaterialType.metal">
  50082. <remarks/>
  50083. </member>
  50084. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetMaterialType.warmMatte">
  50085. <remarks/>
  50086. </member>
  50087. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetMaterialType.translucentPowder">
  50088. <remarks/>
  50089. </member>
  50090. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetMaterialType.powder">
  50091. <remarks/>
  50092. </member>
  50093. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetMaterialType.dkEdge">
  50094. <remarks/>
  50095. </member>
  50096. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetMaterialType.softEdge">
  50097. <remarks/>
  50098. </member>
  50099. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetMaterialType.clear">
  50100. <remarks/>
  50101. </member>
  50102. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetMaterialType.flat">
  50103. <remarks/>
  50104. </member>
  50105. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetMaterialType.softmetal">
  50106. <remarks/>
  50107. </member>
  50108. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetShadowVal.shdw1">
  50109. <remarks/>
  50110. </member>
  50111. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetShadowVal.shdw2">
  50112. <remarks/>
  50113. </member>
  50114. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetShadowVal.shdw3">
  50115. <remarks/>
  50116. </member>
  50117. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetShadowVal.shdw4">
  50118. <remarks/>
  50119. </member>
  50120. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetShadowVal.shdw5">
  50121. <remarks/>
  50122. </member>
  50123. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetShadowVal.shdw6">
  50124. <remarks/>
  50125. </member>
  50126. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetShadowVal.shdw7">
  50127. <remarks/>
  50128. </member>
  50129. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetShadowVal.shdw8">
  50130. <remarks/>
  50131. </member>
  50132. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetShadowVal.shdw9">
  50133. <remarks/>
  50134. </member>
  50135. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetShadowVal.shdw10">
  50136. <remarks/>
  50137. </member>
  50138. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetShadowVal.shdw11">
  50139. <remarks/>
  50140. </member>
  50141. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetShadowVal.shdw12">
  50142. <remarks/>
  50143. </member>
  50144. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetShadowVal.shdw13">
  50145. <remarks/>
  50146. </member>
  50147. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetShadowVal.shdw14">
  50148. <remarks/>
  50149. </member>
  50150. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetShadowVal.shdw15">
  50151. <remarks/>
  50152. </member>
  50153. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetShadowVal.shdw16">
  50154. <remarks/>
  50155. </member>
  50156. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetShadowVal.shdw17">
  50157. <remarks/>
  50158. </member>
  50159. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetShadowVal.shdw18">
  50160. <remarks/>
  50161. </member>
  50162. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetShadowVal.shdw19">
  50163. <remarks/>
  50164. </member>
  50165. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetShadowVal.shdw20">
  50166. <remarks/>
  50167. </member>
  50168. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PathShadeType.shape">
  50169. <remarks/>
  50170. </member>
  50171. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PathShadeType.circle">
  50172. <remarks/>
  50173. </member>
  50174. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PathShadeType.rect">
  50175. <remarks/>
  50176. </member>
  50177. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TileFlipMode.none">
  50178. <remarks/>
  50179. </member>
  50180. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TileFlipMode.x">
  50181. <remarks/>
  50182. </member>
  50183. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TileFlipMode.y">
  50184. <remarks/>
  50185. </member>
  50186. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TileFlipMode.xy">
  50187. <remarks/>
  50188. </member>
  50189. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.pct5">
  50190. <remarks/>
  50191. </member>
  50192. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.pct10">
  50193. <remarks/>
  50194. </member>
  50195. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.pct20">
  50196. <remarks/>
  50197. </member>
  50198. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.pct25">
  50199. <remarks/>
  50200. </member>
  50201. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.pct30">
  50202. <remarks/>
  50203. </member>
  50204. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.pct40">
  50205. <remarks/>
  50206. </member>
  50207. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.pct50">
  50208. <remarks/>
  50209. </member>
  50210. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.pct60">
  50211. <remarks/>
  50212. </member>
  50213. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.pct70">
  50214. <remarks/>
  50215. </member>
  50216. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.pct75">
  50217. <remarks/>
  50218. </member>
  50219. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.pct80">
  50220. <remarks/>
  50221. </member>
  50222. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.pct90">
  50223. <remarks/>
  50224. </member>
  50225. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.horz">
  50226. <remarks/>
  50227. </member>
  50228. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.vert">
  50229. <remarks/>
  50230. </member>
  50231. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.ltHorz">
  50232. <remarks/>
  50233. </member>
  50234. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.ltVert">
  50235. <remarks/>
  50236. </member>
  50237. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.dkHorz">
  50238. <remarks/>
  50239. </member>
  50240. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.dkVert">
  50241. <remarks/>
  50242. </member>
  50243. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.narHorz">
  50244. <remarks/>
  50245. </member>
  50246. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.narVert">
  50247. <remarks/>
  50248. </member>
  50249. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.dashHorz">
  50250. <remarks/>
  50251. </member>
  50252. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.dashVert">
  50253. <remarks/>
  50254. </member>
  50255. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.cross">
  50256. <remarks/>
  50257. </member>
  50258. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.dnDiag">
  50259. <remarks/>
  50260. </member>
  50261. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.upDiag">
  50262. <remarks/>
  50263. </member>
  50264. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.ltDnDiag">
  50265. <remarks/>
  50266. </member>
  50267. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.ltUpDiag">
  50268. <remarks/>
  50269. </member>
  50270. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.dkDnDiag">
  50271. <remarks/>
  50272. </member>
  50273. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.dkUpDiag">
  50274. <remarks/>
  50275. </member>
  50276. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.wdDnDiag">
  50277. <remarks/>
  50278. </member>
  50279. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.wdUpDiag">
  50280. <remarks/>
  50281. </member>
  50282. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.dashDnDiag">
  50283. <remarks/>
  50284. </member>
  50285. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.dashUpDiag">
  50286. <remarks/>
  50287. </member>
  50288. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.diagCross">
  50289. <remarks/>
  50290. </member>
  50291. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.smCheck">
  50292. <remarks/>
  50293. </member>
  50294. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.lgCheck">
  50295. <remarks/>
  50296. </member>
  50297. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.smGrid">
  50298. <remarks/>
  50299. </member>
  50300. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.lgGrid">
  50301. <remarks/>
  50302. </member>
  50303. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.dotGrid">
  50304. <remarks/>
  50305. </member>
  50306. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.smConfetti">
  50307. <remarks/>
  50308. </member>
  50309. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.lgConfetti">
  50310. <remarks/>
  50311. </member>
  50312. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.horzBrick">
  50313. <remarks/>
  50314. </member>
  50315. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.diagBrick">
  50316. <remarks/>
  50317. </member>
  50318. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.solidDmnd">
  50319. <remarks/>
  50320. </member>
  50321. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.openDmnd">
  50322. <remarks/>
  50323. </member>
  50324. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.dotDmnd">
  50325. <remarks/>
  50326. </member>
  50327. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.plaid">
  50328. <remarks/>
  50329. </member>
  50330. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.sphere">
  50331. <remarks/>
  50332. </member>
  50333. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.weave">
  50334. <remarks/>
  50335. </member>
  50336. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.divot">
  50337. <remarks/>
  50338. </member>
  50339. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.shingle">
  50340. <remarks/>
  50341. </member>
  50342. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.wave">
  50343. <remarks/>
  50344. </member>
  50345. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.trellis">
  50346. <remarks/>
  50347. </member>
  50348. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetPatternVal.zigZag">
  50349. <remarks/>
  50350. </member>
  50351. <member name="F:NPOI.OpenXmlFormats.Dml.ST_BlendMode.over">
  50352. <remarks/>
  50353. </member>
  50354. <member name="F:NPOI.OpenXmlFormats.Dml.ST_BlendMode.mult">
  50355. <remarks/>
  50356. </member>
  50357. <member name="F:NPOI.OpenXmlFormats.Dml.ST_BlendMode.screen">
  50358. <remarks/>
  50359. </member>
  50360. <member name="F:NPOI.OpenXmlFormats.Dml.ST_BlendMode.darken">
  50361. <remarks/>
  50362. </member>
  50363. <member name="F:NPOI.OpenXmlFormats.Dml.ST_BlendMode.lighten">
  50364. <remarks/>
  50365. </member>
  50366. <member name="F:NPOI.OpenXmlFormats.Dml.ST_EffectContainerType.sib">
  50367. <remarks/>
  50368. </member>
  50369. <member name="F:NPOI.OpenXmlFormats.Dml.ST_EffectContainerType.tree">
  50370. <remarks/>
  50371. </member>
  50372. <member name="F:NPOI.OpenXmlFormats.Dml.ST_BlipCompression.email">
  50373. <remarks/>
  50374. </member>
  50375. <member name="F:NPOI.OpenXmlFormats.Dml.ST_BlipCompression.screen">
  50376. <remarks/>
  50377. </member>
  50378. <member name="F:NPOI.OpenXmlFormats.Dml.ST_BlipCompression.print">
  50379. <remarks/>
  50380. </member>
  50381. <member name="F:NPOI.OpenXmlFormats.Dml.ST_BlipCompression.hqprint">
  50382. <remarks/>
  50383. </member>
  50384. <member name="F:NPOI.OpenXmlFormats.Dml.ST_BlipCompression.none">
  50385. <remarks/>
  50386. </member>
  50387. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LineEndType.none">
  50388. <remarks/>
  50389. </member>
  50390. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LineEndType.triangle">
  50391. <remarks/>
  50392. </member>
  50393. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LineEndType.stealth">
  50394. <remarks/>
  50395. </member>
  50396. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LineEndType.diamond">
  50397. <remarks/>
  50398. </member>
  50399. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LineEndType.oval">
  50400. <remarks/>
  50401. </member>
  50402. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LineEndType.arrow">
  50403. <remarks/>
  50404. </member>
  50405. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LineEndWidth.sm">
  50406. <remarks/>
  50407. </member>
  50408. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LineEndWidth.med">
  50409. <remarks/>
  50410. </member>
  50411. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LineEndWidth.lg">
  50412. <remarks/>
  50413. </member>
  50414. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LineEndLength.sm">
  50415. <remarks/>
  50416. </member>
  50417. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LineEndLength.med">
  50418. <remarks/>
  50419. </member>
  50420. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LineEndLength.lg">
  50421. <remarks/>
  50422. </member>
  50423. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetLineDashVal.solid">
  50424. <remarks/>
  50425. </member>
  50426. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetLineDashVal.dot">
  50427. <remarks/>
  50428. </member>
  50429. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetLineDashVal.dash">
  50430. <remarks/>
  50431. </member>
  50432. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetLineDashVal.lgDash">
  50433. <remarks/>
  50434. </member>
  50435. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetLineDashVal.dashDot">
  50436. <remarks/>
  50437. </member>
  50438. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetLineDashVal.lgDashDot">
  50439. <remarks/>
  50440. </member>
  50441. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetLineDashVal.lgDashDotDot">
  50442. <remarks/>
  50443. </member>
  50444. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetLineDashVal.sysDash">
  50445. <remarks/>
  50446. </member>
  50447. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetLineDashVal.sysDot">
  50448. <remarks/>
  50449. </member>
  50450. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetLineDashVal.sysDashDot">
  50451. <remarks/>
  50452. </member>
  50453. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PresetLineDashVal.sysDashDotDot">
  50454. <remarks/>
  50455. </member>
  50456. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LineCap.rnd">
  50457. <remarks/>
  50458. </member>
  50459. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LineCap.sq">
  50460. <remarks/>
  50461. </member>
  50462. <member name="F:NPOI.OpenXmlFormats.Dml.ST_LineCap.flat">
  50463. <remarks/>
  50464. </member>
  50465. <member name="F:NPOI.OpenXmlFormats.Dml.ST_CompoundLine.sng">
  50466. <remarks/>
  50467. </member>
  50468. <member name="F:NPOI.OpenXmlFormats.Dml.ST_CompoundLine.dbl">
  50469. <remarks/>
  50470. </member>
  50471. <member name="F:NPOI.OpenXmlFormats.Dml.ST_CompoundLine.thickThin">
  50472. <remarks/>
  50473. </member>
  50474. <member name="F:NPOI.OpenXmlFormats.Dml.ST_CompoundLine.thinThick">
  50475. <remarks/>
  50476. </member>
  50477. <member name="F:NPOI.OpenXmlFormats.Dml.ST_CompoundLine.tri">
  50478. <remarks/>
  50479. </member>
  50480. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PenAlignment.ctr">
  50481. <remarks/>
  50482. </member>
  50483. <member name="F:NPOI.OpenXmlFormats.Dml.ST_PenAlignment.in">
  50484. <remarks/>
  50485. </member>
  50486. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.alphaLcParenBoth">
  50487. <remarks/>
  50488. </member>
  50489. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.alphaUcParenBoth">
  50490. <remarks/>
  50491. </member>
  50492. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.alphaLcParenR">
  50493. <remarks/>
  50494. </member>
  50495. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.alphaUcParenR">
  50496. <remarks/>
  50497. </member>
  50498. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.alphaLcPeriod">
  50499. <remarks/>
  50500. </member>
  50501. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.alphaUcPeriod">
  50502. <remarks/>
  50503. </member>
  50504. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.arabicParenBoth">
  50505. <remarks/>
  50506. </member>
  50507. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.arabicParenR">
  50508. <remarks/>
  50509. </member>
  50510. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.arabicPeriod">
  50511. <remarks/>
  50512. </member>
  50513. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.arabicPlain">
  50514. <remarks/>
  50515. </member>
  50516. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.romanLcParenBoth">
  50517. <remarks/>
  50518. </member>
  50519. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.romanUcParenBoth">
  50520. <remarks/>
  50521. </member>
  50522. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.romanLcParenR">
  50523. <remarks/>
  50524. </member>
  50525. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.romanUcParenR">
  50526. <remarks/>
  50527. </member>
  50528. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.romanLcPeriod">
  50529. <remarks/>
  50530. </member>
  50531. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.romanUcPeriod">
  50532. <remarks/>
  50533. </member>
  50534. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.circleNumDbPlain">
  50535. <remarks/>
  50536. </member>
  50537. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.circleNumWdBlackPlain">
  50538. <remarks/>
  50539. </member>
  50540. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.circleNumWdWhitePlain">
  50541. <remarks/>
  50542. </member>
  50543. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.arabicDbPeriod">
  50544. <remarks/>
  50545. </member>
  50546. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.arabicDbPlain">
  50547. <remarks/>
  50548. </member>
  50549. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.ea1ChsPeriod">
  50550. <remarks/>
  50551. </member>
  50552. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.ea1ChsPlain">
  50553. <remarks/>
  50554. </member>
  50555. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.ea1ChtPeriod">
  50556. <remarks/>
  50557. </member>
  50558. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.ea1ChtPlain">
  50559. <remarks/>
  50560. </member>
  50561. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.ea1JpnChsDbPeriod">
  50562. <remarks/>
  50563. </member>
  50564. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.ea1JpnKorPlain">
  50565. <remarks/>
  50566. </member>
  50567. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.ea1JpnKorPeriod">
  50568. <remarks/>
  50569. </member>
  50570. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.arabic1Minus">
  50571. <remarks/>
  50572. </member>
  50573. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.arabic2Minus">
  50574. <remarks/>
  50575. </member>
  50576. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.hebrew2Minus">
  50577. <remarks/>
  50578. </member>
  50579. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.thaiAlphaPeriod">
  50580. <remarks/>
  50581. </member>
  50582. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.thaiAlphaParenR">
  50583. <remarks/>
  50584. </member>
  50585. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.thaiAlphaParenBoth">
  50586. <remarks/>
  50587. </member>
  50588. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.thaiNumPeriod">
  50589. <remarks/>
  50590. </member>
  50591. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.thaiNumParenR">
  50592. <remarks/>
  50593. </member>
  50594. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.thaiNumParenBoth">
  50595. <remarks/>
  50596. </member>
  50597. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.hindiAlphaPeriod">
  50598. <remarks/>
  50599. </member>
  50600. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.hindiNumPeriod">
  50601. <remarks/>
  50602. </member>
  50603. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.hindiNumParenR">
  50604. <remarks/>
  50605. </member>
  50606. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAutonumberScheme.hindiAlpha1Period">
  50607. <remarks/>
  50608. </member>
  50609. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextUnderlineType.none">
  50610. <remarks/>
  50611. </member>
  50612. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextUnderlineType.words">
  50613. <remarks/>
  50614. </member>
  50615. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextUnderlineType.sng">
  50616. <remarks/>
  50617. </member>
  50618. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextUnderlineType.dbl">
  50619. <remarks/>
  50620. </member>
  50621. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextUnderlineType.heavy">
  50622. <remarks/>
  50623. </member>
  50624. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextUnderlineType.dotted">
  50625. <remarks/>
  50626. </member>
  50627. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextUnderlineType.dottedHeavy">
  50628. <remarks/>
  50629. </member>
  50630. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextUnderlineType.dash">
  50631. <remarks/>
  50632. </member>
  50633. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextUnderlineType.dashHeavy">
  50634. <remarks/>
  50635. </member>
  50636. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextUnderlineType.dashLong">
  50637. <remarks/>
  50638. </member>
  50639. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextUnderlineType.dashLongHeavy">
  50640. <remarks/>
  50641. </member>
  50642. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextUnderlineType.dotDash">
  50643. <remarks/>
  50644. </member>
  50645. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextUnderlineType.dotDashHeavy">
  50646. <remarks/>
  50647. </member>
  50648. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextUnderlineType.dotDotDash">
  50649. <remarks/>
  50650. </member>
  50651. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextUnderlineType.dotDotDashHeavy">
  50652. <remarks/>
  50653. </member>
  50654. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextUnderlineType.wavy">
  50655. <remarks/>
  50656. </member>
  50657. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextUnderlineType.wavyHeavy">
  50658. <remarks/>
  50659. </member>
  50660. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextUnderlineType.wavyDbl">
  50661. <remarks/>
  50662. </member>
  50663. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextStrikeType.noStrike">
  50664. <remarks/>
  50665. </member>
  50666. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextStrikeType.sngStrike">
  50667. <remarks/>
  50668. </member>
  50669. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextStrikeType.dblStrike">
  50670. <remarks/>
  50671. </member>
  50672. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextCapsType.none">
  50673. <remarks/>
  50674. </member>
  50675. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextCapsType.small">
  50676. <remarks/>
  50677. </member>
  50678. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextCapsType.all">
  50679. <remarks/>
  50680. </member>
  50681. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextTabAlignType.l">
  50682. <remarks/>
  50683. </member>
  50684. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextTabAlignType.ctr">
  50685. <remarks/>
  50686. </member>
  50687. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextTabAlignType.r">
  50688. <remarks/>
  50689. </member>
  50690. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextTabAlignType.dec">
  50691. <remarks/>
  50692. </member>
  50693. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAlignType.l">
  50694. <remarks/>
  50695. </member>
  50696. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAlignType.ctr">
  50697. <remarks/>
  50698. </member>
  50699. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAlignType.r">
  50700. <remarks/>
  50701. </member>
  50702. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAlignType.just">
  50703. <remarks/>
  50704. </member>
  50705. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAlignType.justLow">
  50706. <remarks/>
  50707. </member>
  50708. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAlignType.dist">
  50709. <remarks/>
  50710. </member>
  50711. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextAlignType.thaiDist">
  50712. <remarks/>
  50713. </member>
  50714. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextFontAlignType.auto">
  50715. <remarks/>
  50716. </member>
  50717. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextFontAlignType.t">
  50718. <remarks/>
  50719. </member>
  50720. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextFontAlignType.ctr">
  50721. <remarks/>
  50722. </member>
  50723. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextFontAlignType.base">
  50724. <remarks/>
  50725. </member>
  50726. <member name="F:NPOI.OpenXmlFormats.Dml.ST_TextFontAlignType.b">
  50727. <remarks/>
  50728. </member>
  50729. <member name="M:NPOI.OpenXmlFormats.Dml.WordProcessing.CT_Inline.#ctor">
  50730. <summary>
  50731. CT_Inline class constructor
  50732. </summary>
  50733. </member>
  50734. <member name="M:NPOI.OpenXmlFormats.Dml.WordProcessing.CT_Anchor.#ctor">
  50735. <summary>
  50736. CT_Anchor class constructor
  50737. </summary>
  50738. </member>
  50739. <member name="M:NPOI.OpenXmlFormats.Dml.WordProcessing.CT_WrapSquare.#ctor">
  50740. <summary>
  50741. CT_WrapSquare class constructor
  50742. </summary>
  50743. </member>
  50744. <member name="M:NPOI.OpenXmlFormats.Dml.WordProcessing.CT_WrapThrough.#ctor">
  50745. <summary>
  50746. CT_WrapThrough class constructor
  50747. </summary>
  50748. </member>
  50749. <member name="M:NPOI.OpenXmlFormats.Dml.WordProcessing.CT_WrapPath.#ctor">
  50750. <summary>
  50751. CT_WrapPath class constructor
  50752. </summary>
  50753. </member>
  50754. <member name="M:NPOI.OpenXmlFormats.Dml.WordProcessing.CT_WrapTight.#ctor">
  50755. <summary>
  50756. CT_WrapTight class constructor
  50757. </summary>
  50758. </member>
  50759. <member name="M:NPOI.OpenXmlFormats.Dml.WordProcessing.CT_WrapTopBottom.#ctor">
  50760. <summary>
  50761. CT_WrapTopBottom class constructor
  50762. </summary>
  50763. </member>
  50764. <member name="M:NPOI.OpenXmlFormats.Shared.IOMathContainer.AddNewR">
  50765. <summary>
  50766. Add new Run
  50767. </summary>
  50768. <returns></returns>
  50769. </member>
  50770. <member name="M:NPOI.OpenXmlFormats.Shared.IOMathContainer.AddNewAcc">
  50771. <summary>
  50772. Add new Accent
  50773. </summary>
  50774. <returns></returns>
  50775. </member>
  50776. <member name="M:NPOI.OpenXmlFormats.Shared.IOMathContainer.AddNewNary">
  50777. <summary>
  50778. Add new n-ary Operator
  50779. </summary>
  50780. <returns></returns>
  50781. </member>
  50782. <member name="M:NPOI.OpenXmlFormats.Shared.IOMathContainer.AddNewSSub">
  50783. <summary>
  50784. Add new Subscript
  50785. </summary>
  50786. <returns></returns>
  50787. </member>
  50788. <member name="M:NPOI.OpenXmlFormats.Shared.IOMathContainer.AddNewSSup">
  50789. <summary>
  50790. Add new Superscript
  50791. </summary>
  50792. <returns></returns>
  50793. </member>
  50794. <member name="M:NPOI.OpenXmlFormats.Shared.IOMathContainer.AddNewF">
  50795. <summary>
  50796. Add new Fraction
  50797. </summary>
  50798. <returns></returns>
  50799. </member>
  50800. <member name="M:NPOI.OpenXmlFormats.Shared.IOMathContainer.AddNewRad">
  50801. <summary>
  50802. Add new Radical
  50803. </summary>
  50804. <returns></returns>
  50805. </member>
  50806. <member name="M:NPOI.OpenXmlFormats.Shared.CT_MathPr.#ctor">
  50807. <summary>
  50808. CT_MathPr class constructor
  50809. </summary>
  50810. </member>
  50811. <member name="F:NPOI.OpenXmlFormats.Shared.ST_OnOff.Value0">
  50812. <summary>
  50813. False
  50814. </summary>
  50815. </member>
  50816. <member name="F:NPOI.OpenXmlFormats.Shared.ST_OnOff.Value1">
  50817. <summary>
  50818. True
  50819. </summary>
  50820. </member>
  50821. <member name="M:NPOI.OpenXmlFormats.Shared.CT_RPR.#ctor">
  50822. <summary>
  50823. CT_RPR class constructor
  50824. </summary>
  50825. </member>
  50826. <member name="M:NPOI.OpenXmlFormats.Shared.CT_R.#ctor">
  50827. <summary>
  50828. CT_R class constructor
  50829. </summary>
  50830. </member>
  50831. <member name="M:NPOI.OpenXmlFormats.Shared.CT_AccPr.#ctor">
  50832. <summary>
  50833. CT_AccPr class constructor
  50834. </summary>
  50835. </member>
  50836. <member name="M:NPOI.OpenXmlFormats.Shared.CT_Acc.#ctor">
  50837. <summary>
  50838. CT_Acc class constructor
  50839. </summary>
  50840. </member>
  50841. <member name="M:NPOI.OpenXmlFormats.Shared.CT_OMathArg.#ctor">
  50842. <summary>
  50843. CT_OMathArg class constructor
  50844. </summary>
  50845. </member>
  50846. <member name="M:NPOI.OpenXmlFormats.Shared.CT_OMathArgPr.#ctor">
  50847. <summary>
  50848. CT_OMathArgPr class constructor
  50849. </summary>
  50850. </member>
  50851. <member name="M:NPOI.OpenXmlFormats.Shared.CT_BarPr.#ctor">
  50852. <summary>
  50853. CT_BarPr class constructor
  50854. </summary>
  50855. </member>
  50856. <member name="M:NPOI.OpenXmlFormats.Shared.CT_Bar.#ctor">
  50857. <summary>
  50858. CT_Bar class constructor
  50859. </summary>
  50860. </member>
  50861. <member name="M:NPOI.OpenXmlFormats.Shared.CT_BoxPr.#ctor">
  50862. <summary>
  50863. CT_BoxPr class constructor
  50864. </summary>
  50865. </member>
  50866. <member name="M:NPOI.OpenXmlFormats.Shared.CT_Box.#ctor">
  50867. <summary>
  50868. CT_Box class constructor
  50869. </summary>
  50870. </member>
  50871. <member name="M:NPOI.OpenXmlFormats.Shared.CT_BorderBoxPr.#ctor">
  50872. <summary>
  50873. CT_BorderBoxPr class constructor
  50874. </summary>
  50875. </member>
  50876. <member name="M:NPOI.OpenXmlFormats.Shared.CT_BorderBox.#ctor">
  50877. <summary>
  50878. CT_BorderBox class constructor
  50879. </summary>
  50880. </member>
  50881. <member name="M:NPOI.OpenXmlFormats.Shared.CT_DPr.#ctor">
  50882. <summary>
  50883. CT_DPr class constructor
  50884. </summary>
  50885. </member>
  50886. <member name="M:NPOI.OpenXmlFormats.Shared.CT_D.#ctor">
  50887. <summary>
  50888. CT_D class constructor
  50889. </summary>
  50890. </member>
  50891. <member name="M:NPOI.OpenXmlFormats.Shared.CT_EqArrPr.#ctor">
  50892. <summary>
  50893. CT_EqArrPr class constructor
  50894. </summary>
  50895. </member>
  50896. <member name="M:NPOI.OpenXmlFormats.Shared.CT_EqArr.#ctor">
  50897. <summary>
  50898. CT_EqArr class constructor
  50899. </summary>
  50900. </member>
  50901. <member name="M:NPOI.OpenXmlFormats.Shared.CT_FPr.#ctor">
  50902. <summary>
  50903. CT_FPr class constructor
  50904. </summary>
  50905. </member>
  50906. <member name="M:NPOI.OpenXmlFormats.Shared.CT_F.#ctor">
  50907. <summary>
  50908. CT_F class constructor
  50909. </summary>
  50910. </member>
  50911. <member name="M:NPOI.OpenXmlFormats.Shared.CT_FuncPr.#ctor">
  50912. <summary>
  50913. CT_FuncPr class constructor
  50914. </summary>
  50915. </member>
  50916. <member name="M:NPOI.OpenXmlFormats.Shared.CT_Func.#ctor">
  50917. <summary>
  50918. CT_Func class constructor
  50919. </summary>
  50920. </member>
  50921. <member name="M:NPOI.OpenXmlFormats.Shared.CT_GroupChrPr.#ctor">
  50922. <summary>
  50923. CT_GroupChrPr class constructor
  50924. </summary>
  50925. </member>
  50926. <member name="M:NPOI.OpenXmlFormats.Shared.CT_GroupChr.#ctor">
  50927. <summary>
  50928. CT_GroupChr class constructor
  50929. </summary>
  50930. </member>
  50931. <member name="M:NPOI.OpenXmlFormats.Shared.CT_LimLowPr.#ctor">
  50932. <summary>
  50933. CT_LimLowPr class constructor
  50934. </summary>
  50935. </member>
  50936. <member name="M:NPOI.OpenXmlFormats.Shared.CT_LimLow.#ctor">
  50937. <summary>
  50938. CT_LimLow class constructor
  50939. </summary>
  50940. </member>
  50941. <member name="M:NPOI.OpenXmlFormats.Shared.CT_LimUppPr.#ctor">
  50942. <summary>
  50943. CT_LimUppPr class constructor
  50944. </summary>
  50945. </member>
  50946. <member name="M:NPOI.OpenXmlFormats.Shared.CT_LimUpp.#ctor">
  50947. <summary>
  50948. CT_LimUpp class constructor
  50949. </summary>
  50950. </member>
  50951. <member name="M:NPOI.OpenXmlFormats.Shared.CT_MCPr.#ctor">
  50952. <summary>
  50953. CT_MCPr class constructor
  50954. </summary>
  50955. </member>
  50956. <member name="M:NPOI.OpenXmlFormats.Shared.CT_MC.#ctor">
  50957. <summary>
  50958. CT_MC class constructor
  50959. </summary>
  50960. </member>
  50961. <member name="M:NPOI.OpenXmlFormats.Shared.CT_MCS.#ctor">
  50962. <summary>
  50963. CT_MCS class constructor
  50964. </summary>
  50965. </member>
  50966. <member name="M:NPOI.OpenXmlFormats.Shared.CT_MPr.#ctor">
  50967. <summary>
  50968. CT_MPr class constructor
  50969. </summary>
  50970. </member>
  50971. <member name="M:NPOI.OpenXmlFormats.Shared.CT_MR.#ctor">
  50972. <summary>
  50973. CT_MR class constructor
  50974. </summary>
  50975. </member>
  50976. <member name="M:NPOI.OpenXmlFormats.Shared.CT_M.#ctor">
  50977. <summary>
  50978. CT_M class constructor
  50979. </summary>
  50980. </member>
  50981. <member name="M:NPOI.OpenXmlFormats.Shared.CT_NaryPr.#ctor">
  50982. <summary>
  50983. CT_NaryPr class constructor
  50984. </summary>
  50985. </member>
  50986. <member name="M:NPOI.OpenXmlFormats.Shared.CT_Nary.#ctor">
  50987. <summary>
  50988. CT_Nary class constructor
  50989. </summary>
  50990. </member>
  50991. <member name="M:NPOI.OpenXmlFormats.Shared.CT_PhantPr.#ctor">
  50992. <summary>
  50993. CT_PhantPr class constructor
  50994. </summary>
  50995. </member>
  50996. <member name="M:NPOI.OpenXmlFormats.Shared.CT_Phant.#ctor">
  50997. <summary>
  50998. CT_Phant class constructor
  50999. </summary>
  51000. </member>
  51001. <member name="M:NPOI.OpenXmlFormats.Shared.CT_RadPr.#ctor">
  51002. <summary>
  51003. CT_RadPr class constructor
  51004. </summary>
  51005. </member>
  51006. <member name="M:NPOI.OpenXmlFormats.Shared.CT_Rad.#ctor">
  51007. <summary>
  51008. CT_Rad class constructor
  51009. </summary>
  51010. </member>
  51011. <member name="M:NPOI.OpenXmlFormats.Shared.CT_SPrePr.#ctor">
  51012. <summary>
  51013. CT_SPrePr class constructor
  51014. </summary>
  51015. </member>
  51016. <member name="M:NPOI.OpenXmlFormats.Shared.CT_SPre.#ctor">
  51017. <summary>
  51018. CT_SPre class constructor
  51019. </summary>
  51020. </member>
  51021. <member name="M:NPOI.OpenXmlFormats.Shared.CT_SSubPr.#ctor">
  51022. <summary>
  51023. CT_SSubPr class constructor
  51024. </summary>
  51025. </member>
  51026. <member name="M:NPOI.OpenXmlFormats.Shared.CT_SSub.#ctor">
  51027. <summary>
  51028. CT_SSub class constructor
  51029. </summary>
  51030. </member>
  51031. <member name="M:NPOI.OpenXmlFormats.Shared.CT_SSubSupPr.#ctor">
  51032. <summary>
  51033. CT_SSubSupPr class constructor
  51034. </summary>
  51035. </member>
  51036. <member name="M:NPOI.OpenXmlFormats.Shared.CT_SSubSup.#ctor">
  51037. <summary>
  51038. CT_SSubSup class constructor
  51039. </summary>
  51040. </member>
  51041. <member name="M:NPOI.OpenXmlFormats.Shared.CT_SSupPr.#ctor">
  51042. <summary>
  51043. CT_SSupPr class constructor
  51044. </summary>
  51045. </member>
  51046. <member name="M:NPOI.OpenXmlFormats.Shared.CT_SSup.#ctor">
  51047. <summary>
  51048. CT_SSup class constructor
  51049. </summary>
  51050. </member>
  51051. <member name="M:NPOI.OpenXmlFormats.Shared.CT_OMathParaPr.#ctor">
  51052. <summary>
  51053. CT_OMathParaPr class constructor
  51054. </summary>
  51055. </member>
  51056. <member name="M:NPOI.OpenXmlFormats.Shared.CT_OMathPara.#ctor">
  51057. <summary>
  51058. CT_OMathPara class constructor
  51059. </summary>
  51060. </member>
  51061. <member name="M:NPOI.OpenXmlFormats.Shared.CT_OMath.#ctor">
  51062. <summary>
  51063. CT_OMath class constructor
  51064. </summary>
  51065. </member>
  51066. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_SourceType.worksheet">
  51067. <remarks/>
  51068. </member>
  51069. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_SourceType.external">
  51070. <remarks/>
  51071. </member>
  51072. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_SourceType.consolidation">
  51073. <remarks/>
  51074. </member>
  51075. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_SourceType.scenario">
  51076. <remarks/>
  51077. </member>
  51078. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_GroupBy.range">
  51079. <remarks/>
  51080. </member>
  51081. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_GroupBy.seconds">
  51082. <remarks/>
  51083. </member>
  51084. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_GroupBy.minutes">
  51085. <remarks/>
  51086. </member>
  51087. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_GroupBy.hours">
  51088. <remarks/>
  51089. </member>
  51090. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_GroupBy.days">
  51091. <remarks/>
  51092. </member>
  51093. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_GroupBy.months">
  51094. <remarks/>
  51095. </member>
  51096. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_GroupBy.quarters">
  51097. <remarks/>
  51098. </member>
  51099. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_GroupBy.years">
  51100. <remarks/>
  51101. </member>
  51102. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_SortType.none">
  51103. <remarks/>
  51104. </member>
  51105. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_SortType.ascending">
  51106. <remarks/>
  51107. </member>
  51108. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_SortType.descending">
  51109. <remarks/>
  51110. </member>
  51111. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_SortType.ascendingAlpha">
  51112. <remarks/>
  51113. </member>
  51114. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_SortType.descendingAlpha">
  51115. <remarks/>
  51116. </member>
  51117. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_SortType.ascendingNatural">
  51118. <remarks/>
  51119. </member>
  51120. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_SortType.descendingNatural">
  51121. <remarks/>
  51122. </member>
  51123. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_ItemType.data">
  51124. <remarks/>
  51125. </member>
  51126. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_ItemType.default">
  51127. <remarks/>
  51128. </member>
  51129. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_ItemType.sum">
  51130. <remarks/>
  51131. </member>
  51132. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_ItemType.countA">
  51133. <remarks/>
  51134. </member>
  51135. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_ItemType.avg">
  51136. <remarks/>
  51137. </member>
  51138. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_ItemType.max">
  51139. <remarks/>
  51140. </member>
  51141. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_ItemType.min">
  51142. <remarks/>
  51143. </member>
  51144. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_ItemType.product">
  51145. <remarks/>
  51146. </member>
  51147. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_ItemType.count">
  51148. <remarks/>
  51149. </member>
  51150. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_ItemType.stdDev">
  51151. <remarks/>
  51152. </member>
  51153. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_ItemType.stdDevP">
  51154. <remarks/>
  51155. </member>
  51156. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_ItemType.var">
  51157. <remarks/>
  51158. </member>
  51159. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_ItemType.varP">
  51160. <remarks/>
  51161. </member>
  51162. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_ItemType.grand">
  51163. <remarks/>
  51164. </member>
  51165. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_ItemType.blank">
  51166. <remarks/>
  51167. </member>
  51168. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_FieldSortType.manual">
  51169. <remarks/>
  51170. </member>
  51171. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_FieldSortType.ascending">
  51172. <remarks/>
  51173. </member>
  51174. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_FieldSortType.descending">
  51175. <remarks/>
  51176. </member>
  51177. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_ShowDataAs.normal">
  51178. <remarks/>
  51179. </member>
  51180. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_ShowDataAs.difference">
  51181. <remarks/>
  51182. </member>
  51183. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_ShowDataAs.percent">
  51184. <remarks/>
  51185. </member>
  51186. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_ShowDataAs.percentDiff">
  51187. <remarks/>
  51188. </member>
  51189. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_ShowDataAs.runTotal">
  51190. <remarks/>
  51191. </member>
  51192. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_ShowDataAs.percentOfRow">
  51193. <remarks/>
  51194. </member>
  51195. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_ShowDataAs.percentOfCol">
  51196. <remarks/>
  51197. </member>
  51198. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_ShowDataAs.percentOfTotal">
  51199. <remarks/>
  51200. </member>
  51201. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_ShowDataAs.index">
  51202. <remarks/>
  51203. </member>
  51204. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_FormatAction.blank">
  51205. <remarks/>
  51206. </member>
  51207. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_FormatAction.formatting">
  51208. <remarks/>
  51209. </member>
  51210. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_FormatAction.drill">
  51211. <remarks/>
  51212. </member>
  51213. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_FormatAction.formula">
  51214. <remarks/>
  51215. </member>
  51216. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_Scope.selection">
  51217. <remarks/>
  51218. </member>
  51219. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_Scope.data">
  51220. <remarks/>
  51221. </member>
  51222. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_Scope.field">
  51223. <remarks/>
  51224. </member>
  51225. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_Type.none">
  51226. <remarks/>
  51227. </member>
  51228. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_Type.all">
  51229. <remarks/>
  51230. </member>
  51231. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_Type.row">
  51232. <remarks/>
  51233. </member>
  51234. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_Type.column">
  51235. <remarks/>
  51236. </member>
  51237. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.unknown">
  51238. <remarks/>
  51239. </member>
  51240. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.count">
  51241. <remarks/>
  51242. </member>
  51243. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.percent">
  51244. <remarks/>
  51245. </member>
  51246. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.sum">
  51247. <remarks/>
  51248. </member>
  51249. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.captionEqual">
  51250. <remarks/>
  51251. </member>
  51252. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.captionNotEqual">
  51253. <remarks/>
  51254. </member>
  51255. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.captionBeginsWith">
  51256. <remarks/>
  51257. </member>
  51258. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.captionNotBeginsWith">
  51259. <remarks/>
  51260. </member>
  51261. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.captionEndsWith">
  51262. <remarks/>
  51263. </member>
  51264. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.captionNotEndsWith">
  51265. <remarks/>
  51266. </member>
  51267. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.captionContains">
  51268. <remarks/>
  51269. </member>
  51270. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.captionNotContains">
  51271. <remarks/>
  51272. </member>
  51273. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.captionGreaterThan">
  51274. <remarks/>
  51275. </member>
  51276. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.captionGreaterThanOrEqual">
  51277. <remarks/>
  51278. </member>
  51279. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.captionLessThan">
  51280. <remarks/>
  51281. </member>
  51282. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.captionLessThanOrEqual">
  51283. <remarks/>
  51284. </member>
  51285. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.captionBetween">
  51286. <remarks/>
  51287. </member>
  51288. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.captionNotBetween">
  51289. <remarks/>
  51290. </member>
  51291. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.valueEqual">
  51292. <remarks/>
  51293. </member>
  51294. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.valueNotEqual">
  51295. <remarks/>
  51296. </member>
  51297. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.valueGreaterThan">
  51298. <remarks/>
  51299. </member>
  51300. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.valueGreaterThanOrEqual">
  51301. <remarks/>
  51302. </member>
  51303. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.valueLessThan">
  51304. <remarks/>
  51305. </member>
  51306. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.valueLessThanOrEqual">
  51307. <remarks/>
  51308. </member>
  51309. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.valueBetween">
  51310. <remarks/>
  51311. </member>
  51312. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.valueNotBetween">
  51313. <remarks/>
  51314. </member>
  51315. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.dateEqual">
  51316. <remarks/>
  51317. </member>
  51318. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.dateNotEqual">
  51319. <remarks/>
  51320. </member>
  51321. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.dateOlderThan">
  51322. <remarks/>
  51323. </member>
  51324. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.dateOlderThanOrEqual">
  51325. <remarks/>
  51326. </member>
  51327. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.dateNewerThan">
  51328. <remarks/>
  51329. </member>
  51330. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.dateNewerThanOrEqual">
  51331. <remarks/>
  51332. </member>
  51333. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.dateBetween">
  51334. <remarks/>
  51335. </member>
  51336. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.dateNotBetween">
  51337. <remarks/>
  51338. </member>
  51339. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.tomorrow">
  51340. <remarks/>
  51341. </member>
  51342. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.today">
  51343. <remarks/>
  51344. </member>
  51345. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.yesterday">
  51346. <remarks/>
  51347. </member>
  51348. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.nextWeek">
  51349. <remarks/>
  51350. </member>
  51351. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.thisWeek">
  51352. <remarks/>
  51353. </member>
  51354. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.lastWeek">
  51355. <remarks/>
  51356. </member>
  51357. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.nextMonth">
  51358. <remarks/>
  51359. </member>
  51360. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.thisMonth">
  51361. <remarks/>
  51362. </member>
  51363. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.lastMonth">
  51364. <remarks/>
  51365. </member>
  51366. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.nextQuarter">
  51367. <remarks/>
  51368. </member>
  51369. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.thisQuarter">
  51370. <remarks/>
  51371. </member>
  51372. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.lastQuarter">
  51373. <remarks/>
  51374. </member>
  51375. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.nextYear">
  51376. <remarks/>
  51377. </member>
  51378. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.thisYear">
  51379. <remarks/>
  51380. </member>
  51381. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.lastYear">
  51382. <remarks/>
  51383. </member>
  51384. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.yearToDate">
  51385. <remarks/>
  51386. </member>
  51387. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.Q1">
  51388. <remarks/>
  51389. </member>
  51390. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.Q2">
  51391. <remarks/>
  51392. </member>
  51393. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.Q3">
  51394. <remarks/>
  51395. </member>
  51396. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.Q4">
  51397. <remarks/>
  51398. </member>
  51399. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.M1">
  51400. <remarks/>
  51401. </member>
  51402. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.M2">
  51403. <remarks/>
  51404. </member>
  51405. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.M3">
  51406. <remarks/>
  51407. </member>
  51408. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.M4">
  51409. <remarks/>
  51410. </member>
  51411. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.M5">
  51412. <remarks/>
  51413. </member>
  51414. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.M6">
  51415. <remarks/>
  51416. </member>
  51417. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.M7">
  51418. <remarks/>
  51419. </member>
  51420. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.M8">
  51421. <remarks/>
  51422. </member>
  51423. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.M9">
  51424. <remarks/>
  51425. </member>
  51426. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.M10">
  51427. <remarks/>
  51428. </member>
  51429. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.M11">
  51430. <remarks/>
  51431. </member>
  51432. <member name="F:NPOI.OpenXmlFormats.Spreadsheet.ST_PivotFilterType.M12">
  51433. <remarks/>
  51434. </member>
  51435. <member name="T:NPOI.OpenXmlFormats.Spreadsheet.CT_PhoneticRun">
  51436. <summary>
  51437. Rich Text Phonetic Run
  51438. </summary>
  51439. </member>
  51440. <member name="T:NPOI.OpenXmlFormats.Spreadsheet.CT_PhoneticPr">
  51441. <summary>
  51442. Properties of the Rich Text Phonetic Run
  51443. </summary>
  51444. </member>
  51445. <member name="T:NPOI.OpenXmlFormats.Spreadsheet.CT_RElt">
  51446. <summary>
  51447. Rich Text Run container.
  51448. </summary>
  51449. </member>
  51450. <member name="P:NPOI.OpenXmlFormats.Spreadsheet.CT_RElt.rPr">
  51451. <summary>
  51452. Run Properties
  51453. </summary>
  51454. </member>
  51455. <member name="P:NPOI.OpenXmlFormats.Spreadsheet.CT_RElt.t">
  51456. <summary>
  51457. Text
  51458. </summary>
  51459. </member>
  51460. <member name="T:NPOI.OpenXmlFormats.Spreadsheet.CT_RPrElt">
  51461. <summary>
  51462. Properties of Rich Text Run.
  51463. </summary>
  51464. </member>
  51465. <member name="P:NPOI.OpenXmlFormats.Spreadsheet.CT_Rst.r">
  51466. <summary>
  51467. Rich Text Run
  51468. </summary>
  51469. </member>
  51470. <member name="P:NPOI.OpenXmlFormats.Spreadsheet.CT_Rst.rPh">
  51471. <summary>
  51472. Phonetic Run
  51473. </summary>
  51474. </member>
  51475. <member name="P:NPOI.OpenXmlFormats.Spreadsheet.CT_Rst.phoneticPr">
  51476. <summary>
  51477. Phonetic Properties
  51478. </summary>
  51479. </member>
  51480. <member name="T:NPOI.OpenXmlFormats.Spreadsheet.CT_Col">
  51481. <summary>
  51482. Holds the Column Width and its Formatting
  51483. </summary>
  51484. </member>
  51485. <member name="M:NPOI.OpenXmlFormats.Spreadsheet.CT_Border.Equals(System.Object)">
  51486. <summary>
  51487. Determines whether the specified <see cref="T:System.Object" /> is equal
  51488. to the current <see cref="T:System.Object" />.
  51489. </summary>
  51490. <param name="obj">The <see cref="T:System.Object" /> to compare with the current
  51491. <see cref="T:System.Object" />.</param>
  51492. <returns>
  51493. True if the specified <see cref="T:System.Object" /> is equal to the
  51494. current <see cref="T:System.Object" />; otherwise, false.
  51495. </returns>
  51496. </member>
  51497. <member name="M:NPOI.OpenXmlFormats.Spreadsheet.CT_Border.GetHashCode">
  51498. <summary>
  51499. Serves as a hash function for a particular type.
  51500. </summary>
  51501. <returns>A hash code for the current <see cref="T:System.Object" />.</returns>
  51502. </member>
  51503. <member name="M:NPOI.OpenXmlFormats.Spreadsheet.CT_BorderPr.Equals(System.Object)">
  51504. <summary>
  51505. Determines whether the specified <see cref="T:System.Object" /> is equal
  51506. to the current <see cref="T:System.Object" />.
  51507. </summary>
  51508. <param name="obj">The <see cref="T:System.Object" /> to compare with the current
  51509. <see cref="T:System.Object" />.</param>
  51510. <returns>
  51511. True if the specified <see cref="T:System.Object" /> is equal to the
  51512. current <see cref="T:System.Object" />; otherwise, false.
  51513. </returns>
  51514. </member>
  51515. <member name="M:NPOI.OpenXmlFormats.Spreadsheet.CT_BorderPr.GetHashCode">
  51516. <summary>
  51517. Serves as a hash function for a particular type.
  51518. </summary>
  51519. <returns>A hash code for the current <see cref="T:System.Object" />.</returns>
  51520. </member>
  51521. <member name="M:NPOI.OpenXmlFormats.Spreadsheet.CT_Color.Equals(System.Object)">
  51522. <summary>
  51523. Determines whether the specified <see cref="T:System.Object" /> is equal
  51524. to the current <see cref="T:System.Object" />.
  51525. </summary>
  51526. <param name="obj">The <see cref="T:System.Object" /> to compare with the current
  51527. <see cref="T:System.Object" />.</param>
  51528. <returns>
  51529. True if the specified <see cref="T:System.Object" /> is equal to the
  51530. current <see cref="T:System.Object" />; otherwise, false.
  51531. </returns>
  51532. </member>
  51533. <member name="M:NPOI.OpenXmlFormats.Spreadsheet.CT_Color.GetHashCode">
  51534. <summary>
  51535. Serves as a hash function for a particular type.
  51536. </summary>
  51537. <returns>A hash code for the current <see cref="T:System.Object" />.</returns>
  51538. </member>
  51539. <member name="T:NPOI.OpenXmlFormats.Wordprocessing.CT_OnOff">
  51540. <summary>
  51541. On/Off Value
  51542. </summary>
  51543. </member>
  51544. <member name="T:NPOI.OpenXmlFormats.Wordprocessing.ST_OnOff">
  51545. <summary>
  51546. On/Off Value
  51547. </summary>
  51548. </member>
  51549. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_OnOff.off">
  51550. <summary>
  51551. False
  51552. </summary>
  51553. </member>
  51554. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_OnOff.on">
  51555. <summary>
  51556. True
  51557. </summary>
  51558. </member>
  51559. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_OnOff.True">
  51560. <summary>
  51561. True
  51562. </summary>
  51563. </member>
  51564. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_OnOff.False">
  51565. <summary>
  51566. False
  51567. </summary>
  51568. </member>
  51569. <member name="T:NPOI.OpenXmlFormats.Wordprocessing.CT_LongHexNumber">
  51570. <summary>
  51571. Long Hexadecimal Number
  51572. </summary>
  51573. </member>
  51574. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_LongHexNumber.val">
  51575. <summary>
  51576. Four Digit Hexadecimal Number Value
  51577. </summary>
  51578. </member>
  51579. <member name="T:NPOI.OpenXmlFormats.Wordprocessing.CT_ShortHexNumber">
  51580. <summary>
  51581. Two Digit Hexadecimal Number
  51582. </summary>
  51583. </member>
  51584. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_ShortHexNumber.val">
  51585. <summary>
  51586. Two Digit Hexadecimal Number Value
  51587. </summary>
  51588. </member>
  51589. <member name="T:NPOI.OpenXmlFormats.Wordprocessing.CT_UcharHexNumber">
  51590. <summary>
  51591. Two Digit Hexadecimal Number
  51592. </summary>
  51593. </member>
  51594. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_UcharHexNumber.val">
  51595. <summary>
  51596. Two Digit Hexadecimal Number Value
  51597. </summary>
  51598. </member>
  51599. <member name="T:NPOI.OpenXmlFormats.Wordprocessing.CT_DecimalNumber">
  51600. <summary>
  51601. Decimal Number Value
  51602. </summary>
  51603. </member>
  51604. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_DecimalNumber.val">
  51605. <summary>
  51606. Decimal Number
  51607. </summary>
  51608. </member>
  51609. <member name="T:NPOI.OpenXmlFormats.Wordprocessing.CT_TwipsMeasure">
  51610. <summary>
  51611. Measurement in Twentieths of a Point
  51612. </summary>
  51613. </member>
  51614. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_TwipsMeasure.val">
  51615. <summary>
  51616. Measurement in Twentieths of a Point
  51617. </summary>
  51618. </member>
  51619. <member name="T:NPOI.OpenXmlFormats.Wordprocessing.CT_SignedTwipsMeasure">
  51620. <summary>
  51621. Signed Measurement in Twentieths of a Point
  51622. </summary>
  51623. </member>
  51624. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_SignedTwipsMeasure.val">
  51625. <summary>
  51626. Signed Measurement in Twentieths of a Point
  51627. </summary>
  51628. </member>
  51629. <member name="T:NPOI.OpenXmlFormats.Wordprocessing.CT_PixelsMeasure">
  51630. <summary>
  51631. Measurement in Pixels
  51632. </summary>
  51633. </member>
  51634. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_PixelsMeasure.val">
  51635. <summary>
  51636. Measurement in Pixels
  51637. </summary>
  51638. </member>
  51639. <member name="T:NPOI.OpenXmlFormats.Wordprocessing.CT_HpsMeasure">
  51640. <summary>
  51641. Half Point Measurement
  51642. </summary>
  51643. </member>
  51644. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_HpsMeasure.val">
  51645. <summary>
  51646. Half Point Measurement
  51647. </summary>
  51648. </member>
  51649. <member name="T:NPOI.OpenXmlFormats.Wordprocessing.CT_SignedHpsMeasure">
  51650. <summary>
  51651. Signed Measurement in Half-Points
  51652. </summary>
  51653. </member>
  51654. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_SignedHpsMeasure.val">
  51655. <summary>
  51656. Signed Measurement in Half-Points
  51657. </summary>
  51658. </member>
  51659. <member name="T:NPOI.OpenXmlFormats.Wordprocessing.CT_MacroName">
  51660. <summary>
  51661. Name of Script Function
  51662. </summary>
  51663. </member>
  51664. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_MacroName.val">
  51665. <summary>
  51666. Script Subroutine Name Value
  51667. </summary>
  51668. </member>
  51669. <member name="T:NPOI.OpenXmlFormats.Wordprocessing.CT_String">
  51670. <summary>
  51671. String
  51672. </summary>
  51673. </member>
  51674. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_String.val">
  51675. <summary>
  51676. String Value
  51677. </summary>
  51678. </member>
  51679. <member name="T:NPOI.OpenXmlFormats.Wordprocessing.CT_Lang">
  51680. <summary>
  51681. Language Reference
  51682. </summary>
  51683. </member>
  51684. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_Lang.val">
  51685. <summary>
  51686. Language Code
  51687. </summary>
  51688. </member>
  51689. <member name="T:NPOI.OpenXmlFormats.Wordprocessing.CT_Guid">
  51690. <summary>
  51691. 128-Bit GUID
  51692. </summary>
  51693. </member>
  51694. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_Guid.val">
  51695. <summary>
  51696. GUID Value
  51697. </summary>
  51698. </member>
  51699. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.DocumentBodyItemChoiceType.p">
  51700. <summary>
  51701. Paragraph
  51702. </summary>
  51703. </member>
  51704. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ItemsChoiceType50.oMath">
  51705. <remarks/>
  51706. </member>
  51707. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ItemsChoiceType50.oMathPara">
  51708. <remarks/>
  51709. </member>
  51710. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ItemsChoiceType50.altChunk">
  51711. <remarks/>
  51712. </member>
  51713. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ItemsChoiceType50.bookmarkEnd">
  51714. <remarks/>
  51715. </member>
  51716. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ItemsChoiceType50.bookmarkStart">
  51717. <remarks/>
  51718. </member>
  51719. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ItemsChoiceType50.commentRangeEnd">
  51720. <remarks/>
  51721. </member>
  51722. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ItemsChoiceType50.commentRangeStart">
  51723. <remarks/>
  51724. </member>
  51725. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ItemsChoiceType50.customXml">
  51726. <remarks/>
  51727. </member>
  51728. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ItemsChoiceType50.customXmlDelRangeEnd">
  51729. <remarks/>
  51730. </member>
  51731. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ItemsChoiceType50.customXmlDelRangeStart">
  51732. <remarks/>
  51733. </member>
  51734. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ItemsChoiceType50.customXmlInsRangeEnd">
  51735. <remarks/>
  51736. </member>
  51737. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ItemsChoiceType50.customXmlInsRangeStart">
  51738. <remarks/>
  51739. </member>
  51740. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ItemsChoiceType50.customXmlMoveFromRangeEnd">
  51741. <remarks/>
  51742. </member>
  51743. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ItemsChoiceType50.customXmlMoveFromRangeStart">
  51744. <remarks/>
  51745. </member>
  51746. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ItemsChoiceType50.customXmlMoveToRangeEnd">
  51747. <remarks/>
  51748. </member>
  51749. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ItemsChoiceType50.customXmlMoveToRangeStart">
  51750. <remarks/>
  51751. </member>
  51752. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ItemsChoiceType50.del">
  51753. <remarks/>
  51754. </member>
  51755. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ItemsChoiceType50.ins">
  51756. <remarks/>
  51757. </member>
  51758. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ItemsChoiceType50.moveFrom">
  51759. <remarks/>
  51760. </member>
  51761. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ItemsChoiceType50.moveFromRangeEnd">
  51762. <remarks/>
  51763. </member>
  51764. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ItemsChoiceType50.moveFromRangeStart">
  51765. <remarks/>
  51766. </member>
  51767. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ItemsChoiceType50.moveTo">
  51768. <remarks/>
  51769. </member>
  51770. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ItemsChoiceType50.moveToRangeEnd">
  51771. <remarks/>
  51772. </member>
  51773. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ItemsChoiceType50.moveToRangeStart">
  51774. <remarks/>
  51775. </member>
  51776. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ItemsChoiceType50.p">
  51777. <remarks/>
  51778. </member>
  51779. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ItemsChoiceType50.permEnd">
  51780. <remarks/>
  51781. </member>
  51782. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ItemsChoiceType50.permStart">
  51783. <remarks/>
  51784. </member>
  51785. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ItemsChoiceType50.proofErr">
  51786. <remarks/>
  51787. </member>
  51788. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ItemsChoiceType50.sdt">
  51789. <remarks/>
  51790. </member>
  51791. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ItemsChoiceType50.tbl">
  51792. <remarks/>
  51793. </member>
  51794. <member name="T:NPOI.OpenXmlFormats.Wordprocessing.CT_TextScale">
  51795. <summary>
  51796. Text Expansion/Compression Percentage
  51797. </summary>
  51798. </member>
  51799. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_TextScale.val">
  51800. <summary>
  51801. Text Expansion/Compression Value
  51802. </summary>
  51803. </member>
  51804. <member name="T:NPOI.OpenXmlFormats.Wordprocessing.CT_Highlight">
  51805. <summary>
  51806. Text Highlight Colors
  51807. </summary>
  51808. </member>
  51809. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_Highlight.val">
  51810. <summary>
  51811. Highlighting Color
  51812. </summary>
  51813. </member>
  51814. <member name="T:NPOI.OpenXmlFormats.Wordprocessing.CT_Color">
  51815. <summary>
  51816. Color Value
  51817. </summary>
  51818. </member>
  51819. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_Color.val">
  51820. <summary>
  51821. Run Content Color
  51822. </summary>
  51823. </member>
  51824. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_Color.themeColor">
  51825. <summary>
  51826. Run Content Theme Color
  51827. </summary>
  51828. </member>
  51829. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_Color.themeTint">
  51830. <summary>
  51831. Run Content Theme Color Tint
  51832. </summary>
  51833. </member>
  51834. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_Color.themeShade">
  51835. <summary>
  51836. Run Content Theme Color Shade
  51837. </summary>
  51838. </member>
  51839. <member name="T:NPOI.OpenXmlFormats.Wordprocessing.CT_Underline">
  51840. <summary>
  51841. Underline Style
  51842. </summary>
  51843. </member>
  51844. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_Underline.val">
  51845. <summary>
  51846. Underline Style value
  51847. </summary>
  51848. </member>
  51849. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_Underline.color">
  51850. <summary>
  51851. Underline Color
  51852. </summary>
  51853. </member>
  51854. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_Underline.themeColor">
  51855. <summary>
  51856. Underline Theme Color
  51857. </summary>
  51858. </member>
  51859. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_Underline.themeTint">
  51860. <summary>
  51861. Underline Theme Color Tint
  51862. </summary>
  51863. </member>
  51864. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_Underline.themeShade">
  51865. <summary>
  51866. Underline Theme Color Shade
  51867. </summary>
  51868. </member>
  51869. <member name="T:NPOI.OpenXmlFormats.Wordprocessing.ST_Underline">
  51870. <summary>
  51871. Underline Patterns
  51872. </summary>
  51873. </member>
  51874. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Underline.single">
  51875. <summary>
  51876. Single Underline
  51877. </summary>
  51878. </member>
  51879. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Underline.words">
  51880. <summary>
  51881. Underline Non-Space Characters Only
  51882. </summary>
  51883. </member>
  51884. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Underline.double">
  51885. <summary>
  51886. Double Underline
  51887. </summary>
  51888. </member>
  51889. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Underline.thick">
  51890. <summary>
  51891. Thick Underline
  51892. </summary>
  51893. </member>
  51894. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Underline.dotted">
  51895. <summary>
  51896. Dotted Underline
  51897. </summary>
  51898. </member>
  51899. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Underline.dottedHeavy">
  51900. <summary>
  51901. Thick Dotted Underline
  51902. </summary>
  51903. </member>
  51904. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Underline.dash">
  51905. <summary>
  51906. Dashed Underline
  51907. </summary>
  51908. </member>
  51909. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Underline.dashedHeavy">
  51910. <summary>
  51911. Thick Dashed Underline
  51912. </summary>
  51913. </member>
  51914. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Underline.dashLong">
  51915. <summary>
  51916. Long Dashed Underline
  51917. </summary>
  51918. </member>
  51919. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Underline.dashLongHeavy">
  51920. <summary>
  51921. Thick Long Dashed Underline
  51922. </summary>
  51923. </member>
  51924. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Underline.dotDash">
  51925. <summary>
  51926. Dash-Dot Underline
  51927. </summary>
  51928. </member>
  51929. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Underline.dashDotHeavy">
  51930. <summary>
  51931. Thick Dash-Dot Underline
  51932. </summary>
  51933. </member>
  51934. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Underline.dotDotDash">
  51935. <summary>
  51936. Dash-Dot-Dot Underline
  51937. </summary>
  51938. </member>
  51939. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Underline.dashDotDotHeavy">
  51940. <summary>
  51941. Thick Dash-Dot-Dot Underline
  51942. </summary>
  51943. </member>
  51944. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Underline.wave">
  51945. <summary>
  51946. Wave Underline
  51947. </summary>
  51948. </member>
  51949. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Underline.wavyHeavy">
  51950. <summary>
  51951. Heavy Wave Underline
  51952. </summary>
  51953. </member>
  51954. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Underline.wavyDouble">
  51955. <summary>
  51956. Double Wave Underline
  51957. </summary>
  51958. </member>
  51959. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Underline.none">
  51960. <summary>
  51961. No Underline
  51962. </summary>
  51963. </member>
  51964. <member name="T:NPOI.OpenXmlFormats.Wordprocessing.CT_TextEffect">
  51965. <summary>
  51966. Animated Text Effects
  51967. </summary>
  51968. </member>
  51969. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_TextEffect.val">
  51970. <summary>
  51971. Animated Text Effect Type
  51972. </summary>
  51973. </member>
  51974. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_TextEffect.blinkBackground">
  51975. <summary>
  51976. Blinking Background Animation
  51977. </summary>
  51978. </member>
  51979. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_TextEffect.lights">
  51980. <summary>
  51981. Colored Lights Animation
  51982. </summary>
  51983. </member>
  51984. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_TextEffect.antsBlack">
  51985. <summary>
  51986. Black Dashed Line Animation
  51987. </summary>
  51988. </member>
  51989. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_TextEffect.antsRed">
  51990. <summary>
  51991. Marching Red Ants
  51992. </summary>
  51993. </member>
  51994. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_TextEffect.shimmer">
  51995. <summary>
  51996. Shimmer Animation
  51997. </summary>
  51998. </member>
  51999. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_TextEffect.sparkle">
  52000. <summary>
  52001. Sparkling Lights Animation
  52002. </summary>
  52003. </member>
  52004. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_TextEffect.none">
  52005. <summary>
  52006. No Animation
  52007. </summary>
  52008. </member>
  52009. <member name="T:NPOI.OpenXmlFormats.Wordprocessing.CT_Border">
  52010. <summary>
  52011. Border Style
  52012. </summary>
  52013. </member>
  52014. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_Border.val">
  52015. <summary>
  52016. Border Style
  52017. </summary>
  52018. </member>
  52019. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_Border.color">
  52020. <summary>
  52021. Border Color
  52022. </summary>
  52023. </member>
  52024. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_Border.themeColor">
  52025. <summary>
  52026. Border Theme Color
  52027. </summary>
  52028. </member>
  52029. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_Border.themeTint">
  52030. <summary>
  52031. Border Theme Color Tint
  52032. </summary>
  52033. </member>
  52034. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_Border.themeShade">
  52035. <summary>
  52036. Border Theme Color Shade
  52037. </summary>
  52038. </member>
  52039. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_Border.sz">
  52040. <summary>
  52041. Border Width
  52042. </summary>
  52043. ST_EighthPointMeasure
  52044. </member>
  52045. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_Border.space">
  52046. <summary>
  52047. Border Spacing Measurement
  52048. </summary>
  52049. </member>
  52050. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_Border.shadow">
  52051. <summary>
  52052. Border Shadow
  52053. </summary>
  52054. </member>
  52055. <member name="P:NPOI.OpenXmlFormats.Wordprocessing.CT_Border.frame">
  52056. <summary>
  52057. Create Frame Effect
  52058. </summary>
  52059. </member>
  52060. <member name="T:NPOI.OpenXmlFormats.Wordprocessing.ST_Border">
  52061. <summary>
  52062. Border Styles
  52063. </summary>
  52064. </member>
  52065. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.nil">
  52066. <summary>
  52067. No Border
  52068. </summary>
  52069. </member>
  52070. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.none">
  52071. <summary>
  52072. No Border
  52073. </summary>
  52074. </member>
  52075. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.single">
  52076. <summary>
  52077. Single Line Border
  52078. </summary>
  52079. </member>
  52080. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.thick">
  52081. <summary>
  52082. Single Line Border
  52083. </summary>
  52084. </member>
  52085. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.double">
  52086. <summary>
  52087. Double Line Border
  52088. </summary>
  52089. </member>
  52090. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.dotted">
  52091. <summary>
  52092. Dotted Line Border
  52093. </summary>
  52094. </member>
  52095. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.dashed">
  52096. <summary>
  52097. Dashed Line Border
  52098. </summary>
  52099. </member>
  52100. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.dotDash">
  52101. <summary>
  52102. Dot Dash Line Border
  52103. </summary>
  52104. </member>
  52105. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.dotDotDash">
  52106. <summary>
  52107. Dot Dot Dash Line Border
  52108. </summary>
  52109. </member>
  52110. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.triple">
  52111. <summary>
  52112. Triple Line Border
  52113. </summary>
  52114. </member>
  52115. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.thinThickSmallGap">
  52116. <summary>
  52117. Thin, Thick Line Border
  52118. </summary>
  52119. </member>
  52120. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.thickThinSmallGap">
  52121. <summary>
  52122. Thick, Thin Line Border
  52123. </summary>
  52124. </member>
  52125. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.thinThickThinSmallGap">
  52126. <summary>
  52127. Thin, Thick, Thin Line Border
  52128. </summary>
  52129. </member>
  52130. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.thinThickMediumGap">
  52131. <summary>
  52132. Thin, Thick Line Border
  52133. </summary>
  52134. </member>
  52135. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.thickThinMediumGap">
  52136. <summary>
  52137. Thick, Thin Line Border
  52138. </summary>
  52139. </member>
  52140. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.thinThickThinMediumGap">
  52141. <summary>
  52142. Thin, Thick, Thin Line Border
  52143. </summary>
  52144. </member>
  52145. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.thinThickLargeGap">
  52146. <summary>
  52147. Thin, Thick Line Border
  52148. </summary>
  52149. </member>
  52150. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.thickThinLargeGap">
  52151. <summary>
  52152. Thick, Thin Line Border
  52153. </summary>
  52154. </member>
  52155. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.thinThickThinLargeGap">
  52156. <summary>
  52157. Thin, Thick, Thin Line Border
  52158. </summary>
  52159. </member>
  52160. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.wave">
  52161. <summary>
  52162. Wavy Line Border
  52163. </summary>
  52164. </member>
  52165. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.doubleWave">
  52166. <summary>
  52167. Double Wave Line Border
  52168. </summary>
  52169. </member>
  52170. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.dashSmallGap">
  52171. <summary>
  52172. Dashed Line Border
  52173. </summary>
  52174. </member>
  52175. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.dashDotStroked">
  52176. <summary>
  52177. Dash Dot Strokes Line Border
  52178. </summary>
  52179. </member>
  52180. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.threeDEmboss">
  52181. <summary>
  52182. 3D Embossed Line Border
  52183. </summary>
  52184. </member>
  52185. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.threeDEngrave">
  52186. <summary>
  52187. 3D Engraved Line Border
  52188. </summary>
  52189. </member>
  52190. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.outset">
  52191. <summary>
  52192. Outset Line Border
  52193. </summary>
  52194. </member>
  52195. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.inset">
  52196. <summary>
  52197. Inset Line Border
  52198. </summary>
  52199. </member>
  52200. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.apples">
  52201. <summary>
  52202. Apples Art Border
  52203. </summary>
  52204. </member>
  52205. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.archedScallops">
  52206. <summary>
  52207. Arched Scallops Art Border
  52208. </summary>
  52209. </member>
  52210. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.babyPacifier">
  52211. <summary>
  52212. Baby Pacifier Art Border
  52213. </summary>
  52214. </member>
  52215. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.babyRattle">
  52216. <summary>
  52217. Baby Rattle Art Border
  52218. </summary>
  52219. </member>
  52220. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.balloons3Colors">
  52221. <summary>
  52222. Three Color Balloons Art Border
  52223. </summary>
  52224. </member>
  52225. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.balloonsHotAir">
  52226. <summary>
  52227. Hot Air Balloons Art Border
  52228. </summary>
  52229. </member>
  52230. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.basicBlackDashes">
  52231. <summary>
  52232. Black Dash Art Border
  52233. </summary>
  52234. </member>
  52235. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.basicBlackDots">
  52236. <summary>
  52237. Black Dot Art Border
  52238. </summary>
  52239. </member>
  52240. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.basicBlackSquares">
  52241. <summary>
  52242. Black Square Art Border
  52243. </summary>
  52244. </member>
  52245. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.basicThinLines">
  52246. <summary>
  52247. Thin Line Art Border
  52248. </summary>
  52249. </member>
  52250. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.basicWhiteDashes">
  52251. <summary>
  52252. White Dash Art Border
  52253. </summary>
  52254. </member>
  52255. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.basicWhiteDots">
  52256. <summary>
  52257. White Dot Art Border
  52258. </summary>
  52259. </member>
  52260. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.basicWhiteSquares">
  52261. <summary>
  52262. White Square Art Border
  52263. </summary>
  52264. </member>
  52265. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.basicWideInline">
  52266. <summary>
  52267. Wide Inline Art Border
  52268. </summary>
  52269. </member>
  52270. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.basicWideMidline">
  52271. <summary>
  52272. Wide Midline Art Border
  52273. </summary>
  52274. </member>
  52275. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.basicWideOutline">
  52276. <summary>
  52277. </summary>
  52278. </member>
  52279. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.bats">
  52280. <summary>
  52281. Wide Outline Art Border
  52282. </summary>
  52283. </member>
  52284. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.birds">
  52285. <summary>
  52286. Bats Art Border
  52287. </summary>
  52288. </member>
  52289. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.birdsFlight">
  52290. <summary>
  52291. Birds Art Border
  52292. </summary>
  52293. </member>
  52294. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.cabins">
  52295. <summary>
  52296. Cabin Art Border
  52297. </summary>
  52298. </member>
  52299. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.cakeSlice">
  52300. <summary>
  52301. Cake Art Border
  52302. </summary>
  52303. </member>
  52304. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.candyCorn">
  52305. <summary>
  52306. Candy Corn Art Border
  52307. </summary>
  52308. </member>
  52309. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.celticKnotwork">
  52310. <summary>
  52311. Knot Work Art Border
  52312. </summary>
  52313. </member>
  52314. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.certificateBanner">
  52315. <summary>
  52316. Certificate Banner Art Border
  52317. </summary>
  52318. </member>
  52319. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.chainLink">
  52320. <summary>
  52321. Chain Link Art Border
  52322. </summary>
  52323. </member>
  52324. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.champagneBottle">
  52325. <summary>
  52326. Champagne Bottle Art Border
  52327. </summary>
  52328. </member>
  52329. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.checkedBarBlack">
  52330. <summary>
  52331. Black and White Bar Art Border
  52332. </summary>
  52333. </member>
  52334. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.checkedBarColor">
  52335. <summary>
  52336. Color Checked Bar Art Border
  52337. </summary>
  52338. </member>
  52339. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.checkered">
  52340. <summary>
  52341. Checkerboard Art Border
  52342. </summary>
  52343. </member>
  52344. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.christmasTree">
  52345. <summary>
  52346. Christmas Tree Art Border
  52347. </summary>
  52348. </member>
  52349. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.circlesLines">
  52350. <summary>
  52351. Circles And Lines Art Border
  52352. </summary>
  52353. </member>
  52354. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.circlesRectangles">
  52355. <summary>
  52356. Circles and Rectangles Art Border
  52357. </summary>
  52358. </member>
  52359. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.classicalWave">
  52360. <summary>
  52361. Wave Art Border
  52362. </summary>
  52363. </member>
  52364. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.clocks">
  52365. <summary>
  52366. Clocks Art Border
  52367. </summary>
  52368. </member>
  52369. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.compass">
  52370. <summary>
  52371. Compass Art Border
  52372. </summary>
  52373. </member>
  52374. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.confetti">
  52375. <summary>
  52376. Confetti Art Border
  52377. </summary>
  52378. </member>
  52379. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.confettiGrays">
  52380. <summary>
  52381. Confetti Art Border
  52382. </summary>
  52383. </member>
  52384. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.confettiOutline">
  52385. <summary>
  52386. Confetti Art Border
  52387. </summary>
  52388. </member>
  52389. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.confettiStreamers">
  52390. <summary>
  52391. Confetti Streamers Art Border
  52392. </summary>
  52393. </member>
  52394. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.confettiWhite">
  52395. <summary>
  52396. Confetti Art Border
  52397. </summary>
  52398. </member>
  52399. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.cornerTriangles">
  52400. <summary>
  52401. Corner Triangle Art Border
  52402. </summary>
  52403. </member>
  52404. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.couponCutoutDashes">
  52405. <summary>
  52406. Dashed Line Art Border
  52407. </summary>
  52408. </member>
  52409. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.couponCutoutDots">
  52410. <summary>
  52411. Dotted Line Art Border
  52412. </summary>
  52413. </member>
  52414. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.crazyMaze">
  52415. <summary>
  52416. Maze Art Border
  52417. </summary>
  52418. </member>
  52419. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.creaturesButterfly">
  52420. <summary>
  52421. Butterfly Art Border
  52422. </summary>
  52423. </member>
  52424. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.creaturesFish">
  52425. <summary>
  52426. Fish Art Border
  52427. </summary>
  52428. </member>
  52429. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.creaturesInsects">
  52430. <summary>
  52431. Insects Art Border
  52432. </summary>
  52433. </member>
  52434. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.creaturesLadyBug">
  52435. <summary>
  52436. Ladybug Art Border
  52437. </summary>
  52438. </member>
  52439. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.crossStitch">
  52440. <summary>
  52441. Cross-stitch Art Border
  52442. </summary>
  52443. </member>
  52444. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.cup">
  52445. <summary>
  52446. Cupid Art Border
  52447. </summary>
  52448. </member>
  52449. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.decoArch">
  52450. <summary>
  52451. Archway Art Border
  52452. </summary>
  52453. </member>
  52454. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.decoArchColor">
  52455. <summary>
  52456. Color Archway Art Border
  52457. </summary>
  52458. </member>
  52459. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.decoBlocks">
  52460. <summary>
  52461. Blocks Art Border
  52462. </summary>
  52463. </member>
  52464. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.diamondsGray">
  52465. <summary>
  52466. Gray Diamond Art Border
  52467. </summary>
  52468. </member>
  52469. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.doubleD">
  52470. <summary>
  52471. Double D Art Border
  52472. </summary>
  52473. </member>
  52474. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.doubleDiamonds">
  52475. <summary>
  52476. Diamond Art Border
  52477. </summary>
  52478. </member>
  52479. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.earth1">
  52480. <summary>
  52481. Earth Art Border
  52482. </summary>
  52483. </member>
  52484. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.earth2">
  52485. <summary>
  52486. Earth Art Border
  52487. </summary>
  52488. </member>
  52489. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.eclipsingSquares1">
  52490. <summary>
  52491. Shadowed Square Art Border
  52492. </summary>
  52493. </member>
  52494. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.eclipsingSquares2">
  52495. <summary>
  52496. Shadowed Square Art Border
  52497. </summary>
  52498. </member>
  52499. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.eggsBlack">
  52500. <summary>
  52501. Painted Egg Art Border
  52502. </summary>
  52503. </member>
  52504. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.fans">
  52505. <summary>
  52506. Fans Art Border
  52507. </summary>
  52508. </member>
  52509. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.film">
  52510. <summary>
  52511. Film Reel Art Border
  52512. </summary>
  52513. </member>
  52514. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.firecrackers">
  52515. <summary>
  52516. Firecracker Art Border
  52517. </summary>
  52518. </member>
  52519. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.flowersBlockPrint">
  52520. <summary>
  52521. Flowers Art Border
  52522. </summary>
  52523. </member>
  52524. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.flowersDaisies">
  52525. <summary>
  52526. Daisy Art Border
  52527. </summary>
  52528. </member>
  52529. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.flowersModern1">
  52530. <summary>
  52531. Flowers Art Border
  52532. </summary>
  52533. </member>
  52534. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.flowersModern2">
  52535. <summary>
  52536. Flowers Art Border
  52537. </summary>
  52538. </member>
  52539. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.flowersPansy">
  52540. <summary>
  52541. Pansy Art Border
  52542. </summary>
  52543. </member>
  52544. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.flowersRedRose">
  52545. <summary>
  52546. Red Rose Art Border
  52547. </summary>
  52548. </member>
  52549. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.flowersRoses">
  52550. <summary>
  52551. Roses Art Border
  52552. </summary>
  52553. </member>
  52554. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.flowersTeacup">
  52555. <summary>
  52556. Flowers in a Teacup Art Border
  52557. </summary>
  52558. </member>
  52559. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.flowersTiny">
  52560. <summary>
  52561. Small Flower Art Border
  52562. </summary>
  52563. </member>
  52564. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.gems">
  52565. <summary>
  52566. Gems Art Border
  52567. </summary>
  52568. </member>
  52569. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.gingerbreadMan">
  52570. <summary>
  52571. Gingerbread Man Art Border
  52572. </summary>
  52573. </member>
  52574. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.gradient">
  52575. <summary>
  52576. Triangle Gradient Art Border
  52577. </summary>
  52578. </member>
  52579. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.handmade1">
  52580. <summary>
  52581. Handmade Art Border
  52582. </summary>
  52583. </member>
  52584. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.handmade2">
  52585. <summary>
  52586. Handmade Art Border
  52587. </summary>
  52588. </member>
  52589. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.heartBalloon">
  52590. <summary>
  52591. Heart-Shaped Balloon Art Border
  52592. </summary>
  52593. </member>
  52594. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.heartGray">
  52595. <summary>
  52596. Gray Heart Art Border
  52597. </summary>
  52598. </member>
  52599. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.hearts">
  52600. <summary>
  52601. Hearts Art Border
  52602. </summary>
  52603. </member>
  52604. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.heebieJeebies">
  52605. <summary>
  52606. Pattern Art Border
  52607. </summary>
  52608. </member>
  52609. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.holly">
  52610. <summary>
  52611. Holly Art Border
  52612. </summary>
  52613. </member>
  52614. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.houseFunky">
  52615. <summary>
  52616. House Art Border
  52617. </summary>
  52618. </member>
  52619. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.hypnotic">
  52620. <summary>
  52621. Circular Art Border
  52622. </summary>
  52623. </member>
  52624. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.iceCreamCones">
  52625. <summary>
  52626. Ice Cream Cone Art Border
  52627. </summary>
  52628. </member>
  52629. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.lightBulb">
  52630. <summary>
  52631. Light Bulb Art Border
  52632. </summary>
  52633. </member>
  52634. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.lightning1">
  52635. <summary>
  52636. Light Bulb Art Border
  52637. </summary>
  52638. </member>
  52639. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.lightning2">
  52640. <summary>
  52641. Light Bulb Art Border
  52642. </summary>
  52643. </member>
  52644. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.mapPins">
  52645. <summary>
  52646. Map Pins Art Border
  52647. </summary>
  52648. </member>
  52649. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.mapleLeaf">
  52650. <summary>
  52651. Maple Leaf Art Border
  52652. </summary>
  52653. </member>
  52654. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.mapleMuffins">
  52655. <summary>
  52656. Muffin Art Border
  52657. </summary>
  52658. </member>
  52659. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.marquee">
  52660. <summary>
  52661. Marquee Art Border
  52662. </summary>
  52663. </member>
  52664. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.marqueeToothed">
  52665. <summary>
  52666. Marquee Art Border
  52667. </summary>
  52668. </member>
  52669. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.moons">
  52670. <summary>
  52671. Moon Art Border
  52672. </summary>
  52673. </member>
  52674. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.mosaic">
  52675. <summary>
  52676. Mosaic Art Border
  52677. </summary>
  52678. </member>
  52679. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.musicNotes">
  52680. <summary>
  52681. Musical Note Art Border
  52682. </summary>
  52683. </member>
  52684. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.northwest">
  52685. <summary>
  52686. Patterned Art Border
  52687. </summary>
  52688. </member>
  52689. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.ovals">
  52690. <summary>
  52691. Oval Art Border
  52692. </summary>
  52693. </member>
  52694. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.packages">
  52695. <summary>
  52696. Package Art Border
  52697. </summary>
  52698. </member>
  52699. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.palmsBlack">
  52700. <summary>
  52701. Black Palm Tree Art Border
  52702. </summary>
  52703. </member>
  52704. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.palmsColor">
  52705. <summary>
  52706. Color Palm Tree Art Border
  52707. </summary>
  52708. </member>
  52709. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.paperClips">
  52710. <summary>
  52711. Paper Clip Art Border
  52712. </summary>
  52713. </member>
  52714. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.papyrus">
  52715. <summary>
  52716. Papyrus Art Border
  52717. </summary>
  52718. </member>
  52719. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.partyFavor">
  52720. <summary>
  52721. Party Favor Art Border
  52722. </summary>
  52723. </member>
  52724. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.partyGlass">
  52725. <summary>
  52726. Party Glass Art Border
  52727. </summary>
  52728. </member>
  52729. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.pencils">
  52730. <summary>
  52731. Pencils Art Border
  52732. </summary>
  52733. </member>
  52734. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.people">
  52735. <summary>
  52736. Character Art Border
  52737. </summary>
  52738. </member>
  52739. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.peopleWaving">
  52740. <summary>
  52741. Waving Character Border
  52742. </summary>
  52743. </member>
  52744. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.peopleHats">
  52745. <summary>
  52746. Character With Hat Art Border
  52747. </summary>
  52748. </member>
  52749. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.poinsettias">
  52750. <summary>
  52751. Poinsettia Art Border
  52752. </summary>
  52753. </member>
  52754. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.postageStamp">
  52755. <summary>
  52756. Postage Stamp Art Border
  52757. </summary>
  52758. </member>
  52759. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.pumpkin1">
  52760. <summary>
  52761. Pumpkin Art Border
  52762. </summary>
  52763. </member>
  52764. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.pushPinNote2">
  52765. <summary>
  52766. Push Pin Art Border
  52767. </summary>
  52768. </member>
  52769. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.pushPinNote1">
  52770. <summary>
  52771. Push Pin Art Border
  52772. </summary>
  52773. </member>
  52774. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.pyramids">
  52775. <summary>
  52776. Pyramid Art Border
  52777. </summary>
  52778. </member>
  52779. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.pyramidsAbove">
  52780. <summary>
  52781. Pyramid Art Border
  52782. </summary>
  52783. </member>
  52784. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.quadrants">
  52785. <summary>
  52786. Quadrants Art Border
  52787. </summary>
  52788. </member>
  52789. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.rings">
  52790. <summary>
  52791. Rings Art Border
  52792. </summary>
  52793. </member>
  52794. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.safari">
  52795. <summary>
  52796. Safari Art Border
  52797. </summary>
  52798. </member>
  52799. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.sawtooth">
  52800. <summary>
  52801. Saw tooth Art Border
  52802. </summary>
  52803. </member>
  52804. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.sawtoothGray">
  52805. <summary>
  52806. Gray Saw tooth Art Border
  52807. </summary>
  52808. </member>
  52809. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.scaredCat">
  52810. <summary>
  52811. Scared Cat Art Border
  52812. </summary>
  52813. </member>
  52814. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.seattle">
  52815. <summary>
  52816. Umbrella Art Border
  52817. </summary>
  52818. </member>
  52819. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.shadowedSquares">
  52820. <summary>
  52821. Shadowed Squares Art Border
  52822. </summary>
  52823. </member>
  52824. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.sharksTeeth">
  52825. <summary>
  52826. Shark Tooth Art Border
  52827. </summary>
  52828. </member>
  52829. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.shorebirdTracks">
  52830. <summary>
  52831. Bird Tracks Art Border
  52832. </summary>
  52833. </member>
  52834. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.skyrocket">
  52835. <summary>
  52836. Rocket Art Border
  52837. </summary>
  52838. </member>
  52839. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.snowflakeFancy">
  52840. <summary>
  52841. Snowflake Art Border
  52842. </summary>
  52843. </member>
  52844. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.snowflakes">
  52845. <summary>
  52846. Snowflake Art Border
  52847. </summary>
  52848. </member>
  52849. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.sombrero">
  52850. <summary>
  52851. Sombrero Art Border
  52852. </summary>
  52853. </member>
  52854. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.southwest">
  52855. <summary>
  52856. Southwest-themed Art Border
  52857. </summary>
  52858. </member>
  52859. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.stars">
  52860. <summary>
  52861. Stars Art Border
  52862. </summary>
  52863. </member>
  52864. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.starsTop">
  52865. <summary>
  52866. Stars On Top Art Border
  52867. </summary>
  52868. </member>
  52869. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.stars3d">
  52870. <summary>
  52871. 3-D Stars Art Border
  52872. </summary>
  52873. </member>
  52874. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.starsBlack">
  52875. <summary>
  52876. Stars Art Border
  52877. </summary>
  52878. </member>
  52879. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.starsShadowed">
  52880. <summary>
  52881. Stars With Shadows Art Border
  52882. </summary>
  52883. </member>
  52884. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.sun">
  52885. <summary>
  52886. Sun Art Border
  52887. </summary>
  52888. </member>
  52889. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.swirligig">
  52890. <summary>
  52891. Whirligig Art Border
  52892. </summary>
  52893. </member>
  52894. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.tornPaper">
  52895. <summary>
  52896. Torn Paper Art Border
  52897. </summary>
  52898. </member>
  52899. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.tornPaperBlack">
  52900. <summary>
  52901. Black Torn Paper Art Border
  52902. </summary>
  52903. </member>
  52904. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.trees">
  52905. <summary>
  52906. Tree Art Border
  52907. </summary>
  52908. </member>
  52909. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.triangleParty">
  52910. <summary>
  52911. Triangle Art Border
  52912. </summary>
  52913. </member>
  52914. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.triangles">
  52915. <summary>
  52916. Triangles Art Border
  52917. </summary>
  52918. </member>
  52919. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.tribal1">
  52920. <summary>
  52921. Tribal Art Border One
  52922. </summary>
  52923. </member>
  52924. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.tribal2">
  52925. <summary>
  52926. Tribal Art Border Two
  52927. </summary>
  52928. </member>
  52929. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.tribal3">
  52930. <summary>
  52931. Tribal Art Border Three
  52932. </summary>
  52933. </member>
  52934. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.tribal4">
  52935. <summary>
  52936. Tribal Art Border Four
  52937. </summary>
  52938. </member>
  52939. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.tribal5">
  52940. <summary>
  52941. Tribal Art Border Five
  52942. </summary>
  52943. </member>
  52944. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.tribal6">
  52945. <summary>
  52946. Tribal Art Border Six
  52947. </summary>
  52948. </member>
  52949. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.twistedLines1">
  52950. <summary>
  52951. Twisted Lines Art Border
  52952. </summary>
  52953. </member>
  52954. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.twistedLines2">
  52955. <summary>
  52956. Twisted Lines Art Border
  52957. </summary>
  52958. </member>
  52959. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.vine">
  52960. <summary>
  52961. Vine Art Border
  52962. </summary>
  52963. </member>
  52964. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.waveline">
  52965. <summary>
  52966. Wavy Line Art Border
  52967. </summary>
  52968. </member>
  52969. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.weavingAngles">
  52970. <summary>
  52971. Weaving Angles Art Border
  52972. </summary>
  52973. </member>
  52974. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.weavingBraid">
  52975. <summary>
  52976. Weaving Braid Art Border
  52977. </summary>
  52978. </member>
  52979. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.weavingRibbon">
  52980. <summary>
  52981. Weaving Ribbon Art Border
  52982. </summary>
  52983. </member>
  52984. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.weavingStrips">
  52985. <summary>
  52986. Weaving Strips Art Border
  52987. </summary>
  52988. </member>
  52989. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.whiteFlowers">
  52990. <summary>
  52991. White Flowers Art Border
  52992. </summary>
  52993. </member>
  52994. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.woodwork">
  52995. <summary>
  52996. Woodwork Art Border
  52997. </summary>
  52998. </member>
  52999. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.xIllusions">
  53000. <summary>
  53001. Crisscross Art Border
  53002. </summary>
  53003. </member>
  53004. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.zanyTriangles">
  53005. <summary>
  53006. Triangle Art Border
  53007. </summary>
  53008. </member>
  53009. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.zigZag">
  53010. <summary>
  53011. Zigzag Art Border
  53012. </summary>
  53013. </member>
  53014. <member name="F:NPOI.OpenXmlFormats.Wordprocessing.ST_Border.zigZagStitch">
  53015. <summary>
  53016. Zigzag stitch
  53017. </summary>
  53018. </member>
  53019. <member name="F:RangeType.NUMBER">
  53020. Number / Parameter
  53021. </member>
  53022. <member name="F:RangeType.MIN">
  53023. The minimum value from the range
  53024. </member>
  53025. <member name="F:RangeType.MAX">
  53026. The maximum value from the range
  53027. </member>
  53028. <member name="F:RangeType.PERCENT">
  53029. Percent of the way from the mi to the max value in the range
  53030. </member>
  53031. <member name="F:RangeType.PERCENTILE">
  53032. The minimum value of the cell that is in X percentile of the range
  53033. </member>
  53034. <member name="F:RangeType.FORMULA">
  53035. Formula result
  53036. </member>
  53037. <member name="F:RangeType.id">
  53038. Numeric ID of the type
  53039. </member>
  53040. <member name="F:RangeType.name">
  53041. Name (system) of the type
  53042. </member>
  53043. </members>
  53044. </doc>