NPOI.OOXML.XML 413 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>NPOI.OOXML</name>
  5. </assembly>
  6. <members>
  7. <member name="T:NPOI.POIXMLDocumentPart">
  8. Represents an entry of a OOXML namespace.
  9. <p>
  10. Each POIXMLDocumentPart keeps a reference to the underlying a {@link org.apache.poi.openxml4j.opc.PackagePart}.
  11. </p>
  12. @author Yegor Kozlov
  13. </member>
  14. <member name="F:NPOI.POIXMLDocumentPart.relationCounter">
  15. Counter that provides the amount of incoming relations from other parts
  16. to this part.
  17. </member>
  18. <member name="M:NPOI.POIXMLDocumentPart.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage)">
  19. Construct POIXMLDocumentPart representing a "core document" namespace part.
  20. </member>
  21. <member name="M:NPOI.POIXMLDocumentPart.#ctor">
  22. Creates new POIXMLDocumentPart - called by client code to create new parts from scratch.
  23. @see #CreateRelationship(POIXMLRelation, POIXMLFactory, int, bool)
  24. </member>
  25. <member name="M:NPOI.POIXMLDocumentPart.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  26. Creates an POIXMLDocumentPart representing the given namespace part and relationship.
  27. Called by {@link #read(POIXMLFactory, java.util.Map)} when Reading in an exisiting file.
  28. @param part - The namespace part that holds xml data represenring this sheet.
  29. @param rel - the relationship of the given namespace part
  30. @see #read(POIXMLFactory, java.util.Map)
  31. </member>
  32. <member name="M:NPOI.POIXMLDocumentPart.#ctor(NPOI.POIXMLDocumentPart,NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  33. Creates an POIXMLDocumentPart representing the given namespace part, relationship and parent
  34. Called by {@link #read(POIXMLFactory, java.util.Map)} when Reading in an exisiting file.
  35. @param parent - Parent part
  36. @param part - The namespace part that holds xml data represenring this sheet.
  37. @param rel - the relationship of the given namespace part
  38. @see #read(POIXMLFactory, java.util.Map)
  39. </member>
  40. <member name="M:NPOI.POIXMLDocumentPart.Rebase(NPOI.OpenXml4Net.OPC.OPCPackage)">
  41. When you open something like a theme, call this to
  42. re-base the XML Document onto the core child of the
  43. current core document
  44. </member>
  45. <member name="M:NPOI.POIXMLDocumentPart.GetPackagePart">
  46. Provides access to the underlying PackagePart
  47. @return the underlying PackagePart
  48. </member>
  49. <member name="M:NPOI.POIXMLDocumentPart.GetPackageRelationship">
  50. Provides access to the PackageRelationship that identifies this POIXMLDocumentPart
  51. @return the PackageRelationship that identifies this POIXMLDocumentPart
  52. </member>
  53. <member name="M:NPOI.POIXMLDocumentPart.GetRelations">
  54. Returns the list of child relations for this POIXMLDocumentPart
  55. @return child relations
  56. </member>
  57. <member name="M:NPOI.POIXMLDocumentPart.GetRelationById(System.String)">
  58. Returns the target {@link POIXMLDocumentPart}, where a
  59. {@link PackageRelationship} is set from the {@link PackagePart} of this
  60. {@link POIXMLDocumentPart} to the {@link PackagePart} of the target
  61. {@link POIXMLDocumentPart} with a {@link PackageRelationship#GetId()}
  62. matching the given parameter value.
  63. @param id
  64. The relation id to look for
  65. @return the target part of the relation, or null, if none exists
  66. </member>
  67. <member name="M:NPOI.POIXMLDocumentPart.GetRelationId(NPOI.POIXMLDocumentPart)">
  68. Returns the {@link PackageRelationship#GetId()} of the
  69. {@link PackageRelationship}, that sources from the {@link PackagePart} of
  70. this {@link POIXMLDocumentPart} to the {@link PackagePart} of the given
  71. parameter value.
  72. @param part
  73. The {@link POIXMLDocumentPart} for which the according
  74. relation-id shall be found.
  75. @return The value of the {@link PackageRelationship#GetId()} or null, if
  76. parts are not related.
  77. </member>
  78. <member name="M:NPOI.POIXMLDocumentPart.AddRelation(System.String,NPOI.POIXMLDocumentPart)">
  79. Add a new child POIXMLDocumentPart
  80. @param part the child to add
  81. </member>
  82. <member name="M:NPOI.POIXMLDocumentPart.RemoveRelation(NPOI.POIXMLDocumentPart)">
  83. Remove the relation to the specified part in this namespace and remove the
  84. part, if it is no longer needed.
  85. </member>
  86. <member name="M:NPOI.POIXMLDocumentPart.RemoveRelation(NPOI.POIXMLDocumentPart,System.Boolean)">
  87. Remove the relation to the specified part in this namespace and remove the
  88. part, if it is no longer needed and flag is set to true.
  89. @param part
  90. The related part, to which the relation shall be Removed.
  91. @param RemoveUnusedParts
  92. true, if the part shall be Removed from the namespace if not
  93. needed any longer.
  94. </member>
  95. <member name="M:NPOI.POIXMLDocumentPart.GetParent">
  96. Returns the parent POIXMLDocumentPart. All parts except root have not-null parent.
  97. @return the parent POIXMLDocumentPart or <code>null</code> for the root element.
  98. </member>
  99. <member name="M:NPOI.POIXMLDocumentPart.Commit">
  100. Save the content in the underlying namespace part.
  101. Default implementation is empty meaning that the namespace part is left unmodified.
  102. Sub-classes should override and add logic to marshal the "model" into Ooxml4J.
  103. For example, the code saving a generic XML entry may look as follows:
  104. <pre><code>
  105. protected void commit() {
  106. PackagePart part = GetPackagePart();
  107. Stream out = part.GetStream();
  108. XmlObject bean = GetXmlBean(); //the "model" which holds Changes in memory
  109. bean.save(out, DEFAULT_XML_OPTIONS);
  110. out.close();
  111. }
  112. </code></pre>
  113. </member>
  114. <member name="M:NPOI.POIXMLDocumentPart.OnSave(System.Collections.Generic.List{NPOI.OpenXml4Net.OPC.PackagePart})">
  115. Save Changes in the underlying OOXML namespace.
  116. Recursively fires {@link #commit()} for each namespace part
  117. @param alreadySaved context set Containing already visited nodes
  118. </member>
  119. <member name="M:NPOI.POIXMLDocumentPart.CreateRelationship(NPOI.POIXMLRelation,NPOI.POIXMLFactory)">
  120. Create a new child POIXMLDocumentPart
  121. @param descriptor the part descriptor
  122. @param factory the factory that will create an instance of the requested relation
  123. @return the Created child POIXMLDocumentPart
  124. </member>
  125. <member name="M:NPOI.POIXMLDocumentPart.CreateRelationship(NPOI.POIXMLRelation,NPOI.POIXMLFactory,System.Int32,System.Boolean)">
  126. Create a new child POIXMLDocumentPart
  127. @param descriptor the part descriptor
  128. @param factory the factory that will create an instance of the requested relation
  129. @param idx part number
  130. @param noRelation if true, then no relationship is Added.
  131. @return the Created child POIXMLDocumentPart
  132. </member>
  133. <member name="M:NPOI.POIXMLDocumentPart.Read(NPOI.POIXMLFactory,System.Collections.Generic.Dictionary{NPOI.OpenXml4Net.OPC.PackagePart,NPOI.POIXMLDocumentPart})">
  134. Iterate through the underlying PackagePart and create child POIXMLFactory instances
  135. using the specified factory
  136. @param factory the factory object that Creates POIXMLFactory instances
  137. @param context context map Containing already visited noted keyed by tarGetURI
  138. </member>
  139. <member name="M:NPOI.POIXMLDocumentPart.GetTargetPart(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  140. Get the PackagePart that is the target of a relationship.
  141. @param rel The relationship
  142. @return The target part
  143. @throws InvalidFormatException
  144. </member>
  145. <member name="M:NPOI.POIXMLDocumentPart.OnDocumentCreate">
  146. Fired when a new namespace part is Created
  147. </member>
  148. <member name="M:NPOI.POIXMLDocumentPart.OnDocumentRead">
  149. Fired when a namespace part is read
  150. </member>
  151. <member name="M:NPOI.POIXMLDocumentPart.onDocumentRemove">
  152. Fired when a namespace part is about to be Removed from the namespace
  153. </member>
  154. <member name="F:NPOI.POIXMLDocument.pkg">
  155. The OPC Package
  156. </member>
  157. <member name="F:NPOI.POIXMLDocument.properties">
  158. The properties of the OPC namespace, opened as needed
  159. </member>
  160. <member name="M:NPOI.POIXMLDocument.OpenPackage(System.String)">
  161. Wrapper to open a namespace, returning an IOException
  162. in the event of a problem.
  163. Works around shortcomings in java's this() constructor calls
  164. </member>
  165. <member name="M:NPOI.POIXMLDocument.GetRelatedByType(System.String)">
  166. Retrieves all the PackageParts which are defined as
  167. relationships of the base document with the
  168. specified content type.
  169. </member>
  170. <member name="M:NPOI.POIXMLDocument.HasOOXMLHeader(System.IO.Stream)">
  171. Checks that the supplied Stream (which MUST
  172. support mark and reSet, or be a PushbackStream)
  173. has a OOXML (zip) header at the start of it.
  174. If your Stream does not support mark / reSet,
  175. then wrap it in a PushBackStream, then be
  176. sure to always use that, and not the original!
  177. @param inp An Stream which supports either mark/reSet, or is a PushbackStream
  178. </member>
  179. <member name="M:NPOI.POIXMLDocument.GetProperties">
  180. Get the document properties. This gives you access to the
  181. core ooxml properties, and the extended ooxml properties.
  182. </member>
  183. <member name="M:NPOI.POIXMLDocument.GetAllEmbedds">
  184. Get the document's embedded files.
  185. </member>
  186. <member name="M:NPOI.POIXMLDocument.Write(System.IO.Stream)">
  187. Write out this document to an Outputstream.
  188. @param stream - the java Stream you wish to write the file to
  189. @exception IOException if anything can't be written.
  190. </member>
  191. <member name="T:NPOI.POIXMLFactory">
  192. Defines a factory API that enables sub-classes to create instances of <code>POIXMLDocumentPart</code>
  193. @author Yegor Kozlov
  194. </member>
  195. <member name="M:NPOI.POIXMLFactory.CreateDocumentPart(NPOI.POIXMLDocumentPart,NPOI.OpenXml4Net.OPC.PackageRelationship,NPOI.OpenXml4Net.OPC.PackagePart)">
  196. Create a POIXMLDocumentPart from existing namespace part and relation. This method is called
  197. from {@link POIXMLDocument#load(POIXMLFactory)} when parsing a document
  198. @param parent parent part
  199. @param rel the namespace part relationship
  200. @param part the PackagePart representing the Created instance
  201. @return A new instance of a POIXMLDocumentPart.
  202. </member>
  203. <member name="M:NPOI.POIXMLFactory.CreateDocumentPart(NPOI.POIXMLRelation)">
  204. Create a new POIXMLDocumentPart using the supplied descriptor. This method is used when Adding new parts
  205. to a document, for example, when Adding a sheet to a workbook, slide to a presentation, etc.
  206. @param descriptor describes the object to create
  207. @return A new instance of a POIXMLDocumentPart.
  208. </member>
  209. <member name="T:NPOI.CoreProperties">
  210. The core document properties
  211. </member>
  212. <member name="T:NPOI.ExtendedProperties">
  213. Extended document properties
  214. </member>
  215. <member name="T:NPOI.CustomProperties">
  216. Custom document properties
  217. </member>
  218. <member name="F:NPOI.CustomProperties.FORMAT_ID">
  219. Each custom property element Contains an fmtid attribute
  220. with the same GUID value ({D5CDD505-2E9C-101B-9397-08002B2CF9AE}).
  221. </member>
  222. <member name="M:NPOI.CustomProperties.Add(System.String)">
  223. Add a new property
  224. @param name the property name
  225. @throws IllegalArgumentException if a property with this name already exists
  226. </member>
  227. <member name="M:NPOI.CustomProperties.AddProperty(System.String,System.String)">
  228. Add a new string property
  229. @throws IllegalArgumentException if a property with this name already exists
  230. </member>
  231. <member name="M:NPOI.CustomProperties.AddProperty(System.String,System.Double)">
  232. Add a new double property
  233. @throws IllegalArgumentException if a property with this name already exists
  234. </member>
  235. <member name="M:NPOI.CustomProperties.AddProperty(System.String,System.Int32)">
  236. Add a new integer property
  237. @throws IllegalArgumentException if a property with this name already exists
  238. </member>
  239. <member name="M:NPOI.CustomProperties.AddProperty(System.String,System.Boolean)">
  240. Add a new bool property
  241. @throws IllegalArgumentException if a property with this name already exists
  242. </member>
  243. <member name="M:NPOI.CustomProperties.NextPid">
  244. Generate next id that uniquely relates a custom property
  245. @return next property id starting with 2
  246. </member>
  247. <member name="M:NPOI.CustomProperties.Contains(System.String)">
  248. Check if a property with this name already exists in the collection of custom properties
  249. @param name the name to check
  250. @return whether a property with the given name exists in the custom properties
  251. </member>
  252. <member name="T:NPOI.POIXMLProperties">
  253. Wrapper around the two different kinds of OOXML properties
  254. a document can have
  255. </member>
  256. <member name="M:NPOI.POIXMLProperties.Commit">
  257. Commit Changes to the underlying OPC namespace
  258. </member>
  259. <member name="P:NPOI.POIXMLProperties.CoreProperties">
  260. Returns the core document properties
  261. </member>
  262. <member name="P:NPOI.POIXMLProperties.ExtendedProperties">
  263. Returns the extended document properties
  264. </member>
  265. <member name="P:NPOI.POIXMLProperties.CustomProperties">
  266. Returns the custom document properties
  267. </member>
  268. <member name="T:NPOI.POIXMLPropertiesTextExtractor">
  269. A {@link POITextExtractor} for returning the textual
  270. content of the OOXML file properties, eg author
  271. and title.
  272. </member>
  273. <member name="F:NPOI.POIXMLTextExtractor._document">
  274. The POIXMLDocument that's open
  275. </member>
  276. <member name="M:NPOI.POIXMLTextExtractor.#ctor(NPOI.POIXMLDocument)">
  277. Creates a new text extractor for the given document
  278. </member>
  279. <member name="M:NPOI.POIXMLTextExtractor.GetCoreProperties">
  280. Returns the core document properties
  281. </member>
  282. <member name="M:NPOI.POIXMLTextExtractor.GetExtendedProperties">
  283. Returns the extended document properties
  284. </member>
  285. <member name="M:NPOI.POIXMLTextExtractor.GetCustomProperties">
  286. Returns the custom document properties
  287. </member>
  288. <member name="P:NPOI.POIXMLTextExtractor.Document">
  289. Returns opened document
  290. </member>
  291. <member name="P:NPOI.POIXMLTextExtractor.Package">
  292. Returns the opened OPCPackage that Contains the document
  293. </member>
  294. <member name="P:NPOI.POIXMLTextExtractor.MetadataTextExtractor">
  295. Returns an OOXML properties text extractor for the
  296. document properties metadata, such as title and author.
  297. </member>
  298. <member name="M:NPOI.POIXMLPropertiesTextExtractor.#ctor(NPOI.POIXMLDocument)">
  299. Creates a new POIXMLPropertiesTextExtractor for the
  300. given open document.
  301. </member>
  302. <member name="M:NPOI.POIXMLPropertiesTextExtractor.#ctor(NPOI.POIXMLTextExtractor)">
  303. Creates a new POIXMLPropertiesTextExtractor, for the
  304. same file that another TextExtractor is already
  305. working on.
  306. </member>
  307. <member name="M:NPOI.POIXMLPropertiesTextExtractor.GetCorePropertiesText">
  308. Returns the core document properties, eg author
  309. </member>
  310. <member name="M:NPOI.POIXMLPropertiesTextExtractor.GetExtendedPropertiesText">
  311. Returns the extended document properties, eg
  312. application
  313. </member>
  314. <member name="M:NPOI.POIXMLPropertiesTextExtractor.GetCustomPropertiesText">
  315. Returns the custom document properties, if
  316. there are any
  317. </member>
  318. <member name="T:NPOI.POIXMLRelation">
  319. Represents a descriptor of a OOXML relation.
  320. @author Yegor Kozlov
  321. </member>
  322. <member name="F:NPOI.POIXMLRelation._type">
  323. Describes the content stored in a part.
  324. </member>
  325. <member name="F:NPOI.POIXMLRelation._relation">
  326. The kind of connection between a source part and a target part in a namespace.
  327. </member>
  328. <member name="F:NPOI.POIXMLRelation._defaultName">
  329. The path component of a pack URI.
  330. </member>
  331. <member name="F:NPOI.POIXMLRelation._cls">
  332. Defines what object is used to construct instances of this relationship
  333. </member>
  334. <member name="M:NPOI.POIXMLRelation.#ctor(System.String,System.String,System.String,System.Type)">
  335. Instantiates a POIXMLRelation.
  336. @param type content type
  337. @param rel relationship
  338. @param defaultName default item name
  339. @param cls defines what object is used to construct instances of this relationship
  340. </member>
  341. <member name="M:NPOI.POIXMLRelation.#ctor(System.String,System.String,System.String)">
  342. Instantiates a POIXMLRelation.
  343. @param type content type
  344. @param rel relationship
  345. @param defaultName default item name
  346. </member>
  347. <member name="M:NPOI.POIXMLRelation.GetFileName(System.Int32)">
  348. Returns the filename for the nth one of these,
  349. e.g. /xl/comments4.xml
  350. </member>
  351. <member name="P:NPOI.POIXMLRelation.ContentType">
  352. Return the content type. Content types define a media type, a subtype, and an
  353. optional set of parameters, as defined in RFC 2616.
  354. @return the content type
  355. </member>
  356. <member name="P:NPOI.POIXMLRelation.Relation">
  357. Return the relationship, the kind of connection between a source part and a target part in a namespace.
  358. Relationships make the connections between parts directly discoverable without looking at the content
  359. in the parts, and without altering the parts themselves.
  360. @return the relationship
  361. </member>
  362. <member name="P:NPOI.POIXMLRelation.DefaultFileName">
  363. Return the default part name. Part names are used to refer to a part in the context of a
  364. namespace, typically as part of a URI.
  365. @return the default part name
  366. </member>
  367. <member name="P:NPOI.POIXMLRelation.RelationClass">
  368. Return type of the obejct used to construct instances of this relationship
  369. @return the class of the object used to construct instances of this relation
  370. </member>
  371. <member name="F:NPOI.SS.UserModel.ImportOption.SheetContentOnly">
  372. <summary>
  373. Only Text and Formulas are imported. Pictures, Drawing, Styles etc. are all ignored.
  374. </summary>
  375. </member>
  376. <member name="F:NPOI.SS.UserModel.ImportOption.TextOnly">
  377. <summary>
  378. Only Text, Comments and Formulas are imported. Pictures, Drawing, Styles etc. are all ignored.
  379. </summary>
  380. </member>
  381. <member name="F:NPOI.SS.UserModel.ImportOption.All">
  382. <summary>
  383. Everything is imported - this is the same as NONE.
  384. </summary>
  385. </member>
  386. <member name="T:NPOI.SS.UserModel.WorkbookFactory">
  387. <summary>
  388. Factory for creating the appropriate kind of Workbook
  389. (be it HSSFWorkbook or XSSFWorkbook), from the given input
  390. </summary>
  391. </member>
  392. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  393. <summary>
  394. Creates an HSSFWorkbook from the given POIFSFileSystem
  395. </summary>
  396. </member>
  397. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(NPOI.POIFS.FileSystem.NPOIFSFileSystem)">
  398. Creates an HSSFWorkbook from the given NPOIFSFileSystem
  399. </member>
  400. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(NPOI.OpenXml4Net.OPC.OPCPackage)">
  401. <summary>
  402. Creates an XSSFWorkbook from the given OOXML Package
  403. </summary>
  404. </member>
  405. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(System.IO.Stream)">
  406. <summary>
  407. Creates the appropriate HSSFWorkbook / XSSFWorkbook from
  408. the given InputStream. The Stream is wraped inside a PushbackInputStream.
  409. </summary>
  410. <param name="inputStream">Input Stream of .xls or .xlsx file</param>
  411. <returns>IWorkbook depending on the input HSSFWorkbook or XSSFWorkbook is returned.</returns>
  412. </member>
  413. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(System.String)">
  414. Creates the appropriate HSSFWorkbook / XSSFWorkbook from
  415. the given File, which must exist and be readable.
  416. </member>
  417. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(System.IO.Stream,NPOI.SS.UserModel.ImportOption)">
  418. <summary>
  419. Creates the appropriate HSSFWorkbook / XSSFWorkbook from
  420. the given InputStream. The Stream is wraped inside a PushbackInputStream.
  421. </summary>
  422. <param name="inputStream">Input Stream of .xls or .xlsx file</param>
  423. <param name="importOption">Customize the elements that are processed on the next import</param>
  424. <returns>IWorkbook depending on the input HSSFWorkbook or XSSFWorkbook is returned.</returns>
  425. </member>
  426. <member name="M:NPOI.SS.UserModel.WorkbookFactory.CreateFormulaEvaluator(NPOI.SS.UserModel.IWorkbook)">
  427. <summary>
  428. Creates a specific FormulaEvaluator for the given workbook.
  429. </summary>
  430. </member>
  431. <member name="M:NPOI.SS.UserModel.WorkbookFactory.SetImportOption(NPOI.SS.UserModel.ImportOption)">
  432. <summary>
  433. Sets the import option when opening the next workbook.
  434. Works only for XSSF. For HSSF workbooks this option is ignored.
  435. </summary>
  436. <param name="importOption">Customize the elements that are processed on the next import</param>
  437. </member>
  438. <member name="T:NPOI.Util.IdentifierManager">
  439. <summary>
  440. 24.08.2009 @author Stefan Stern
  441. </summary>
  442. </member>
  443. <member name="F:NPOI.Util.IdentifierManager.upperbound">
  444. </member>
  445. <member name="F:NPOI.Util.IdentifierManager.lowerbound">
  446. </member>
  447. <member name="F:NPOI.Util.IdentifierManager.segments">
  448. List of segments of available identifiers
  449. </member>
  450. <member name="M:NPOI.Util.IdentifierManager.#ctor(System.Int64,System.Int64)">
  451. @param lowerbound the lower limit of the id-range to manage. Must be greater than or equal to {@link #MIN_ID}.
  452. @param upperbound the upper limit of the id-range to manage. Must be less then or equal {@link #MAX_ID}.
  453. </member>
  454. <member name="M:NPOI.Util.IdentifierManager.ReserveNew">
  455. @return a new identifier.
  456. @throws IllegalStateException if no more identifiers are available, then an Exception is raised.
  457. </member>
  458. <member name="M:NPOI.Util.IdentifierManager.Release(System.Int64)">
  459. @param id
  460. the identifier to release. Must be greater than or equal to
  461. {@link #lowerbound} and must be less than or equal to {@link #upperbound}
  462. @return true, if the identifier was reserved and has been successfully
  463. released, false, if the identifier was not reserved.
  464. </member>
  465. <member name="M:NPOI.Util.IdentifierManager.VerifyIdentifiersLeft">
  466. </member>
  467. <member name="T:NPOI.Util.PackageHelper">
  468. Provides handy methods to work with OOXML namespaces
  469. @author Yegor Kozlov
  470. </member>
  471. <member name="M:NPOI.Util.PackageHelper.Clone(NPOI.OpenXml4Net.OPC.OPCPackage,System.String)">
  472. Clone the specified namespace.
  473. @param pkg the namespace to clone
  474. @param file the destination file
  475. @return the Cloned namespace
  476. </member>
  477. <member name="M:NPOI.Util.PackageHelper.CreateTempFile">
  478. Creates an empty file in the default temporary-file directory,
  479. </member>
  480. <member name="M:NPOI.Util.PackageHelper.Copy(NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePart)">
  481. Recursively copy namespace parts to the destination namespace
  482. </member>
  483. <member name="M:NPOI.Util.PackageHelper.CopyProperties(NPOI.OpenXml4Net.OPC.PackageProperties,NPOI.OpenXml4Net.OPC.PackageProperties)">
  484. Copy core namespace properties
  485. @param src source properties
  486. @param tgt target properties
  487. </member>
  488. <member name="T:NPOI.Util.Units">
  489. @author Yegor Kozlov
  490. </member>
  491. <member name="T:NPOI.XSSF.Extractor.XSSFExcelExtractor">
  492. Helper class to extract text from an OOXML Excel file
  493. </member>
  494. <member name="M:NPOI.XSSF.Extractor.XSSFExcelExtractor.SetIncludeSheetNames(System.Boolean)">
  495. Should sheet names be included? Default is true
  496. </member>
  497. <member name="M:NPOI.XSSF.Extractor.XSSFExcelExtractor.SetFormulasNotResults(System.Boolean)">
  498. Should we return the formula itself, and not
  499. the result it produces? Default is false
  500. </member>
  501. <member name="M:NPOI.XSSF.Extractor.XSSFExcelExtractor.SetIncludeCellComments(System.Boolean)">
  502. Should cell comments be included? Default is true
  503. </member>
  504. <member name="M:NPOI.XSSF.Extractor.XSSFExcelExtractor.SetIncludeHeadersFooters(System.Boolean)">
  505. Should headers and footers be included? Default is true
  506. </member>
  507. <member name="P:NPOI.XSSF.Extractor.XSSFExcelExtractor.Text">
  508. Retreives the text contents of the file
  509. </member>
  510. <member name="T:NPOI.XSSF.Extractor.XSSFExportToXml">
  511. Maps an XLSX to an XML according to one of the mapping defined.
  512. The output XML Schema must respect this limitations:
  513. <ul>
  514. <li> all mandatory elements and attributes must be mapped (enable validation to check this)</li>
  515. <li> no &lt;any&gt; in complex type/element declaration </li>
  516. <li> no &lt;anyAttribute&gt; attributes declaration </li>
  517. <li> no recursive structures: recursive structures can't be nested more than one level </li>
  518. <li> no abstract elements: abstract complex types can be declared but must not be used in elements. </li>
  519. <li> no mixed content: an element can't contain simple text and child element(s) together </li>
  520. <li> no &lt;substitutionGroup&gt; in complex type/element declaration </li>
  521. </ul>
  522. </member>
  523. <member name="M:NPOI.XSSF.Extractor.XSSFExportToXml.#ctor(NPOI.XSSF.UserModel.XSSFMap)">
  524. Creates a new exporter and Sets the mapping to be used when generating the XML output document
  525. @param map the mapping rule to be used
  526. </member>
  527. <member name="M:NPOI.XSSF.Extractor.XSSFExportToXml.ExportToXML(System.IO.Stream,System.Boolean)">
  528. Exports the data in an XML stream
  529. @param os OutputStream in which will contain the output XML
  530. @param validate if true, validates the XML againts the XML Schema
  531. @throws SAXException
  532. @throws TransformerException
  533. @throws ParserConfigurationException
  534. </member>
  535. <member name="M:NPOI.XSSF.Extractor.XSSFExportToXml.ExportToXML(System.IO.Stream,System.String,System.Boolean)">
  536. Exports the data in an XML stream
  537. @param os OutputStream in which will contain the output XML
  538. @param encoding the output charset encoding
  539. @param validate if true, validates the XML againts the XML Schema
  540. @throws SAXException
  541. @throws ParserConfigurationException
  542. @throws TransformerException
  543. @throws InvalidFormatException
  544. </member>
  545. <member name="M:NPOI.XSSF.Extractor.XSSFExportToXml.IsValid(System.Xml.XmlDocument)">
  546. Validate the generated XML against the XML Schema associated with the XSSFMap
  547. @param xml the XML to validate
  548. @return
  549. </member>
  550. <member name="M:NPOI.XSSF.Extractor.XSSFExportToXml.Compare(System.String,System.String)">
  551. Compares two xpaths to define an ordering according to the XML Schema
  552. </member>
  553. <member name="T:NPOI.XSSF.Model.CalculationChain">
  554. The cells in a workbook can be calculated in different orders depending on various optimizations and
  555. dependencies. The calculation chain object specifies the order in which the cells in a workbook were last calculated.
  556. @author Yegor Kozlov
  557. </member>
  558. <member name="M:NPOI.XSSF.Model.CalculationChain.RemoveItem(System.Int32,System.String)">
  559. Remove a formula reference from the calculation chain
  560. @param sheetId the sheet Id of a sheet the formula belongs to.
  561. @param ref A1 style reference to the cell Containing the formula.
  562. </member>
  563. <member name="F:NPOI.XSSF.Model.CommentsTable.commentRefs">
  564. XML Beans uses a list, which is very slow
  565. to search, so we wrap things with our own
  566. map for fast Lookup.
  567. </member>
  568. <member name="M:NPOI.XSSF.Model.CommentsTable.ReferenceUpdated(System.String,NPOI.OpenXmlFormats.Spreadsheet.CT_Comment)">
  569. Called after the reference is updated, so that
  570. we can reflect that in our cache
  571. </member>
  572. <member name="M:NPOI.XSSF.Model.CommentsTable.FindAuthor(System.String)">
  573. <summary>
  574. Searches the author. If not found he is added to the list of authors.
  575. </summary>
  576. <param name="author">author to search</param>
  577. <returns>index of the author</returns>
  578. </member>
  579. <member name="T:NPOI.XSSF.Model.IndexedUDFFinder">
  580. A UDFFinder that can retrieve functions both by name and by fake index.
  581. @author Yegor Kozlov
  582. </member>
  583. <member name="T:NPOI.XSSF.Model.MapInfo">
  584. This class : the Custom XML Mapping Part (Open Office XML Part 1:
  585. chapter 12.3.6)
  586. An instance of this part type Contains a schema for an XML file, and
  587. information on the behavior that is used when allowing this custom XML schema
  588. to be mapped into the spreadsheet.
  589. @author Roberto Manicardi
  590. </member>
  591. <member name="M:NPOI.XSSF.Model.MapInfo.GetCTMapInfo">
  592. @return the internal data object
  593. </member>
  594. <member name="M:NPOI.XSSF.Model.MapInfo.GetCTSchemaById(System.String)">
  595. Gets the
  596. @param schemaId the schema ID
  597. @return CTSchema by it's ID
  598. </member>
  599. <member name="M:NPOI.XSSF.Model.MapInfo.GetAllXSSFMaps">
  600. @return all the mappings configured in this document
  601. </member>
  602. <member name="P:NPOI.XSSF.Model.MapInfo.Workbook">
  603. Returns the parent XSSFWorkbook
  604. @return the parent XSSFWorkbook
  605. </member>
  606. <member name="T:NPOI.XSSF.Model.SharedStringsTable">
  607. Table of strings shared across all sheets in a workbook.
  608. <p>
  609. A workbook may contain thousands of cells Containing string (non-numeric) data. Furthermore this data is very
  610. likely to be repeated across many rows or columns. The goal of implementing a single string table that is shared
  611. across the workbook is to improve performance in opening and saving the file by only Reading and writing the
  612. repetitive information once.
  613. </p>
  614. <p>
  615. Consider for example a workbook summarizing information for cities within various countries. There may be a
  616. column for the name of the country, a column for the name of each city in that country, and a column
  617. Containing the data for each city. In this case the country name is repetitive, being duplicated in many cells.
  618. In many cases the repetition is extensive, and a tremendous savings is realized by making use of a shared string
  619. table when saving the workbook. When displaying text in the spreadsheet, the cell table will just contain an
  620. index into the string table as the value of a cell, instead of the full string.
  621. </p>
  622. <p>
  623. The shared string table Contains all the necessary information for displaying the string: the text, formatting
  624. properties, and phonetic properties (for East Asian languages).
  625. </p>
  626. @author Nick Birch
  627. @author Yegor Kozlov
  628. </member>
  629. <member name="F:NPOI.XSSF.Model.SharedStringsTable.strings">
  630. Array of individual string items in the Shared String table.
  631. </member>
  632. <member name="F:NPOI.XSSF.Model.SharedStringsTable.stmap">
  633. Maps strings and their indexes in the <code>strings</code> arrays
  634. </member>
  635. <member name="F:NPOI.XSSF.Model.SharedStringsTable.count">
  636. An integer representing the total count of strings in the workbook. This count does not
  637. include any numbers, it counts only the total of text strings in the workbook.
  638. </member>
  639. <member name="F:NPOI.XSSF.Model.SharedStringsTable.uniqueCount">
  640. An integer representing the total count of unique strings in the Shared String Table.
  641. A string is unique even if it is a copy of another string, but has different formatting applied
  642. at the character level.
  643. </member>
  644. <member name="M:NPOI.XSSF.Model.SharedStringsTable.GetEntryAt(System.Int32)">
  645. Return a string item by index
  646. @param idx index of item to return.
  647. @return the item at the specified position in this Shared String table.
  648. </member>
  649. <member name="M:NPOI.XSSF.Model.SharedStringsTable.AddEntry(NPOI.OpenXmlFormats.Spreadsheet.CT_Rst)">
  650. Add an entry to this Shared String table (a new value is appened to the end).
  651. <p>
  652. If the Shared String table already Contains this <code>CT_Rst</code> bean, its index is returned.
  653. Otherwise a new entry is aded.
  654. </p>
  655. @param st the entry to add
  656. @return index the index of Added entry
  657. </member>
  658. <member name="M:NPOI.XSSF.Model.SharedStringsTable.WriteTo(System.IO.Stream)">
  659. this table out as XML.
  660. @param out The stream to write to.
  661. @throws IOException if an error occurs while writing.
  662. </member>
  663. <member name="P:NPOI.XSSF.Model.SharedStringsTable.Count">
  664. Return an integer representing the total count of strings in the workbook. This count does not
  665. include any numbers, it counts only the total of text strings in the workbook.
  666. @return the total count of strings in the workbook
  667. </member>
  668. <member name="P:NPOI.XSSF.Model.SharedStringsTable.UniqueCount">
  669. Returns an integer representing the total count of unique strings in the Shared String Table.
  670. A string is unique even if it is a copy of another string, but has different formatting applied
  671. at the character level.
  672. @return the total count of unique strings in the workbook
  673. </member>
  674. <member name="P:NPOI.XSSF.Model.SharedStringsTable.Items">
  675. Provide low-level access to the underlying array of CT_Rst beans
  676. @return array of CT_Rst beans
  677. </member>
  678. <member name="T:NPOI.XSSF.Model.SingleXmlCells">
  679. This class : the Single Cell Tables Part (Open Office XML Part 4:
  680. chapter 3.5.2)
  681. @author Roberto Manicardi
  682. </member>
  683. <member name="M:NPOI.XSSF.Model.SingleXmlCells.GetAllSimpleXmlCell">
  684. @return all the SimpleXmlCell Contained in this SingleXmlCells element
  685. </member>
  686. <member name="T:NPOI.XSSF.Model.StylesTable">
  687. Table of styles shared across all sheets in a workbook.
  688. @author ugo
  689. </member>
  690. <member name="F:NPOI.XSSF.Model.StylesTable.FIRST_CUSTOM_STYLE_ID">
  691. The first style id available for use as a custom style
  692. </member>
  693. <member name="M:NPOI.XSSF.Model.StylesTable.#ctor">
  694. Create a new, empty StylesTable
  695. </member>
  696. <member name="M:NPOI.XSSF.Model.StylesTable.ReadFrom(System.Xml.XmlDocument)">
  697. Read this shared styles table from an XML file.
  698. @param is The input stream Containing the XML document.
  699. @throws IOException if an error occurs while Reading.
  700. </member>
  701. <member name="M:NPOI.XSSF.Model.StylesTable.PutFont(NPOI.XSSF.UserModel.XSSFFont,System.Boolean)">
  702. Records the given font in the font table.
  703. Will re-use an existing font index if this
  704. font matches another, EXCEPT if forced
  705. registration is requested.
  706. This allows people to create several fonts
  707. then customise them later.
  708. Note - End Users probably want to call
  709. {@link XSSFFont#registerTo(StylesTable)}
  710. </member>
  711. <member name="M:NPOI.XSSF.Model.StylesTable.GetNumCellStyles">
  712. get the size of cell styles
  713. </member>
  714. <member name="M:NPOI.XSSF.Model.StylesTable.GetNumberFormatSize">
  715. For unit testing only
  716. </member>
  717. <member name="M:NPOI.XSSF.Model.StylesTable.GetXfsSize">
  718. For unit testing only
  719. </member>
  720. <member name="M:NPOI.XSSF.Model.StylesTable.GetStyleXfsSize">
  721. For unit testing only
  722. </member>
  723. <member name="M:NPOI.XSSF.Model.StylesTable.GetCTStylesheet">
  724. For unit testing only!
  725. </member>
  726. <member name="M:NPOI.XSSF.Model.StylesTable.WriteTo(System.IO.Stream)">
  727. Write this table out as XML.
  728. @param out The stream to write to.
  729. @throws IOException if an error occurs while writing.
  730. </member>
  731. <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)">
  732. Finds a font that matches the one with the supplied attributes
  733. </member>
  734. <member name="T:NPOI.XSSF.Model.ThemesTable">
  735. Class that represents theme of XLSX document. The theme includes specific
  736. colors and fonts.
  737. @author Petr Udalau(Petr.Udalau at exigenservices.com) - theme colors
  738. </member>
  739. <member name="M:NPOI.XSSF.Model.ThemesTable.InheritFromThemeAsRequired(NPOI.XSSF.UserModel.XSSFColor)">
  740. If the colour is based on a theme, then inherit
  741. information (currently just colours) from it as
  742. required.
  743. </member>
  744. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFChartAxis">
  745. Base class for all axis types.
  746. @author Roman Kashitsyn
  747. </member>
  748. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFChartDataFactory">
  749. @author Roman Kashitsyn
  750. </member>
  751. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartDataFactory.CreateScatterChartData``2">
  752. @return new scatter chart data instance
  753. </member>
  754. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartDataFactory.GetInstance">
  755. @return factory instance
  756. </member>
  757. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFChartLegend">
  758. Represents a SpreadsheetML chart legend
  759. @author Roman Kashitsyn
  760. </member>
  761. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFChartLegend.legend">
  762. Underlaying CTLagend bean
  763. </member>
  764. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartLegend.#ctor(NPOI.XSSF.UserModel.XSSFChart)">
  765. Create a new SpreadsheetML chart legend
  766. </member>
  767. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartLegend.GetCTLegend">
  768. Return the underlying CTLegend bean.
  769. @return the underlying CTLegend bean
  770. </member>
  771. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFChartUtil">
  772. Package private class with utility methods.
  773. @author Roman Kashitsyn
  774. </member>
  775. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartUtil.BuildAxDataSource``1(NPOI.OpenXmlFormats.Dml.Chart.CT_AxDataSource,NPOI.SS.UserModel.Charts.IChartDataSource{``0})">
  776. Builds CTAxDataSource object content from POI ChartDataSource.
  777. @param ctAxDataSource OOXML data source to build
  778. @param dataSource POI data source to use
  779. </member>
  780. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartUtil.BuildNumDataSource``1(NPOI.OpenXmlFormats.Dml.Chart.CT_NumDataSource,NPOI.SS.UserModel.Charts.IChartDataSource{``0})">
  781. Builds CTNumDataSource object content from POI ChartDataSource
  782. @param ctNumDataSource OOXML data source to build
  783. @param dataSource POI data source to use
  784. </member>
  785. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFManualLayout">
  786. Represents a SpreadsheetML manual layout.
  787. @author Roman Kashitsyn
  788. </member>
  789. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFManualLayout.layout">
  790. Underlaying CTManualLayout bean.
  791. </member>
  792. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFManualLayout.#ctor(NPOI.OpenXmlFormats.Dml.Chart.CT_Layout)">
  793. Create a new SpreadsheetML manual layout.
  794. @param layout a Spreadsheet ML layout that should be used as base.
  795. </member>
  796. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFManualLayout.#ctor(NPOI.XSSF.UserModel.XSSFChart)">
  797. Create a new SpreadsheetML manual layout for chart.
  798. @param chart a chart to create layout for.
  799. </member>
  800. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFManualLayout.GetCTManualLayout">
  801. Return the underlying CTManualLayout bean.
  802. @return the underlying CTManualLayout bean.
  803. </member>
  804. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2">
  805. Represents DrawingML scatter chart.
  806. @author Roman Kashitsyn
  807. </member>
  808. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.series">
  809. List of all data series.
  810. </member>
  811. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.Serie">
  812. Package private ScatterChartSerie implementation.
  813. </member>
  814. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.Serie.GetXValues">
  815. Returns data source used for X axis values.
  816. @return data source used for X axis values
  817. </member>
  818. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.Serie.GetYValues">
  819. Returns data source used for Y axis values.
  820. @return data source used for Y axis values
  821. </member>
  822. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.Serie.SetUseCache(System.Boolean)">
  823. @param useCache if true, cached results will be Added on plot
  824. </member>
  825. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.Serie.AddToChart(NPOI.OpenXmlFormats.Dml.Chart.CT_ScatterChart)">
  826. <summary>
  827. Returns last calculated number cache for Y axis.
  828. </summary>
  829. </member>
  830. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFValueAxis">
  831. Value axis type.
  832. @author Roman Kashitsyn
  833. </member>
  834. <member name="T:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment">
  835. Cell Settings avaiable in the Format/Alignment tab
  836. </member>
  837. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_CellAlignment)">
  838. Creates a Cell Alignment from the supplied XML defInition
  839. @param cellAlignment
  840. </member>
  841. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.GetCTCellAlignment">
  842. Access to low-level data
  843. </member>
  844. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.Vertical">
  845. Get the type of vertical alignment for the cell
  846. @return the type of aligment
  847. @see VerticalAlignment
  848. </member>
  849. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.Horizontal">
  850. Get the type of horizontal alignment for the cell
  851. @return the type of aligment
  852. @see HorizontalAlignment
  853. </member>
  854. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.Indent">
  855. Get the number of spaces to indent the text in the cell
  856. @return indent - number of spaces
  857. </member>
  858. <!-- Badly formed XML comment ignored for member "P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.TextRotation" -->
  859. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.WrapText">
  860. Whether the text should be wrapped
  861. @return a bool value indicating if the text in a cell should be line-wrapped within the cell.
  862. </member>
  863. <member name="T:NPOI.XSSF.UserModel.Extensions.BorderSide">
  864. The enumeration value indicating the side being used for a cell border.
  865. </member>
  866. <member name="T:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder">
  867. This element Contains border formatting information, specifying border defInition formats (left, right, top, bottom, diagonal)
  868. for cells in the workbook.
  869. Color is optional.
  870. </member>
  871. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Border,NPOI.XSSF.Model.ThemesTable)">
  872. Creates a Cell Border from the supplied XML defInition
  873. </member>
  874. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Border)">
  875. Creates a Cell Border from the supplied XML defInition
  876. </member>
  877. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.#ctor">
  878. Creates a new, empty Cell Border.
  879. You need to attach this to the Styles Table
  880. </member>
  881. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.SetThemesTable(NPOI.XSSF.Model.ThemesTable)">
  882. Records the Themes Table that is associated with
  883. the current font, used when looking up theme
  884. based colours and properties.
  885. </member>
  886. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.GetCTBorder">
  887. Returns the underlying XML bean.
  888. @return CT_Border
  889. </member>
  890. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.GetBorderStyle(NPOI.XSSF.UserModel.Extensions.BorderSide)">
  891. Get the type of border to use for the selected border
  892. @param side - - where to apply the color defInition
  893. @return borderstyle - the type of border to use. default value is NONE if border style is not Set.
  894. @see BorderStyle
  895. </member>
  896. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.SetBorderStyle(NPOI.XSSF.UserModel.Extensions.BorderSide,NPOI.SS.UserModel.BorderStyle)">
  897. Set the type of border to use for the selected border
  898. @param side - - where to apply the color defInition
  899. @param style - border style
  900. @see BorderStyle
  901. </member>
  902. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.GetBorderColor(NPOI.XSSF.UserModel.Extensions.BorderSide)">
  903. Get the color to use for the selected border
  904. @param side - where to apply the color defInition
  905. @return color - color to use as XSSFColor. null if color is not set
  906. </member>
  907. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.SetBorderColor(NPOI.XSSF.UserModel.Extensions.BorderSide,NPOI.XSSF.UserModel.XSSFColor)">
  908. Set the color to use for the selected border
  909. @param side - where to apply the color defInition
  910. @param color - the color to use
  911. </member>
  912. <member name="T:NPOI.XSSF.UserModel.Extensions.XSSFCellFill">
  913. This element specifies fill formatting.
  914. A cell fill consists of a background color, foreground color, and pattern to be applied across the cell.
  915. </member>
  916. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Fill)">
  917. Creates a CellFill from the supplied parts
  918. @param fill - fill
  919. </member>
  920. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.#ctor">
  921. Creates an empty CellFill
  922. </member>
  923. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.GetFillBackgroundColor">
  924. Get the background fill color.
  925. @return fill color, null if color is not set
  926. </member>
  927. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetFillBackgroundColor(System.Int32)">
  928. Set the background fill color represented as a indexed color value.
  929. @param index
  930. </member>
  931. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetFillBackgroundColor(NPOI.XSSF.UserModel.XSSFColor)">
  932. Set the background fill color represented as a {@link XSSFColor} value.
  933. @param color
  934. </member>
  935. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.GetFillForegroundColor">
  936. Get the foreground fill color.
  937. @return XSSFColor - foreground color. null if color is not set
  938. </member>
  939. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetFillForegroundColor(System.Int32)">
  940. Set the foreground fill color as a indexed color value
  941. @param index - the color to use
  942. </member>
  943. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetFillForegroundColor(NPOI.XSSF.UserModel.XSSFColor)">
  944. Set the foreground fill color represented as a {@link XSSFColor} value.
  945. @param color - the color to use
  946. </member>
  947. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.GetPatternType">
  948. get the fill pattern
  949. @return fill pattern type. null if fill pattern is not set
  950. </member>
  951. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetPatternType(NPOI.OpenXmlFormats.Spreadsheet.ST_PatternType)">
  952. set the fill pattern
  953. @param patternType fill pattern to use
  954. </member>
  955. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.GetCTFill">
  956. Returns the underlying XML bean.
  957. @return CT_Fill
  958. </member>
  959. <member name="T:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter">
  960. <summary>
  961. Parent class of all XSSF headers and footers.
  962. </summary>
  963. </member>
  964. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  965. Create an instance of XSSFHeaderFooter from the supplied XML bean
  966. @param headerFooter
  967. </member>
  968. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.GetHeaderFooter">
  969. Returns the underlying CTHeaderFooter xml bean
  970. @return the underlying CTHeaderFooter xml bean
  971. </member>
  972. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.AreFieldsStripped">
  973. Are fields currently being stripped from the text that this
  974. {@link XSSFHeaderFooter} returns? Default is false, but can be Changed
  975. </member>
  976. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.SetAreFieldsStripped(System.Boolean)">
  977. Should fields (eg macros) be stripped from the text that this class
  978. returns? Default is not to strip.
  979. @param StripFields
  980. </member>
  981. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.StripFields(System.String)">
  982. Removes any fields (eg macros, page markers etc) from the string.
  983. Normally used to make some text suitable for showing to humans, and the
  984. resultant text should not normally be saved back into the document!
  985. </member>
  986. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.Center">
  987. get the text representing the center part of this element
  988. </member>
  989. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.Left">
  990. get the text representing the left part of this element
  991. </member>
  992. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.Right">
  993. get the text representing the right part of this element
  994. </member>
  995. <member name="T:NPOI.XSSF.UserModel.Helpers.ColumnHelper">
  996. Helper class for dealing with the Column Settings on
  997. a CT_Worksheet (the data part of a sheet).
  998. Note - within POI, we use 0 based column indexes, but
  999. the column defInitions in the XML are 1 based!
  1000. </member>
  1001. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.GetColumn(System.Int64,System.Boolean)">
  1002. Returns the Column at the given 0 based index
  1003. </member>
  1004. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.GetColumn1Based(System.Int64,System.Boolean)">
  1005. Returns the Column at the given 1 based index.
  1006. POI default is 0 based, but the file stores
  1007. as 1 based.
  1008. </member>
  1009. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.columnExists(NPOI.OpenXmlFormats.Spreadsheet.CT_Cols,System.Int64)">
  1010. Does the column at the given 0 based index exist
  1011. in the supplied list of column defInitions?
  1012. </member>
  1013. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.GetOrCreateColumn1Based(System.Int64,System.Boolean)">
  1014. Return the CT_Col at the given (0 based) column index,
  1015. creating it if required.
  1016. </member>
  1017. <member name="M:NPOI.XSSF.UserModel.Helpers.HeaderFooterHelper.GetParts(System.String)">
  1018. Split into left, center, right
  1019. </member>
  1020. <member name="T:NPOI.XSSF.UserModel.Helpers.XSSFFormulaUtils">
  1021. Utility to update formulas and named ranges when a sheet name was Changed
  1022. @author Yegor Kozlov
  1023. </member>
  1024. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFFormulaUtils.UpdateSheetName(System.Int32,System.String)">
  1025. Update sheet name in all formulas and named ranges.
  1026. Called from {@link XSSFWorkbook#SetSheetName(int, String)}
  1027. <p/>
  1028. <p>
  1029. The idea is to parse every formula and render it back to string
  1030. with the updated sheet name. The IFormulaParsingWorkbook passed to the formula Parser
  1031. is constructed from the old workbook (sheet name is not yet updated) and
  1032. the FormulaRenderingWorkbook passed to FormulaRenderer#toFormulaString is a custom implementation that
  1033. returns the new sheet name.
  1034. </p>
  1035. @param sheetIndex the 0-based index of the sheet being Changed
  1036. @param name the new sheet name
  1037. </member>
  1038. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFFormulaUtils.UpdateFormula(NPOI.XSSF.UserModel.XSSFCell,NPOI.SS.Formula.IFormulaRenderingWorkbook)">
  1039. Parse cell formula and re-assemble it back using the specified FormulaRenderingWorkbook.
  1040. @param cell the cell to update
  1041. @param frwb the formula rendering workbbok that returns new sheet name
  1042. </member>
  1043. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFFormulaUtils.UpdateName(NPOI.SS.UserModel.IName,NPOI.SS.Formula.IFormulaRenderingWorkbook)">
  1044. Parse formula in the named range and re-assemble it back using the specified FormulaRenderingWorkbook.
  1045. @param name the name to update
  1046. @param frwb the formula rendering workbbok that returns new sheet name
  1047. </member>
  1048. <member name="T:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter">
  1049. @author Yegor Kozlov
  1050. </member>
  1051. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.ShiftMerged(System.Int32,System.Int32,System.Int32)">
  1052. Shift merged regions
  1053. @param startRow the row to start Shifting
  1054. @param endRow the row to end Shifting
  1055. @param n the number of rows to shift
  1056. @return an array of affected cell regions
  1057. </member>
  1058. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.ContainsCell(NPOI.SS.Util.CellRangeAddress,System.Int32,System.Int32)">
  1059. Check if the row and column are in the specified cell range
  1060. @param cr the cell range to check in
  1061. @param rowIx the row to check
  1062. @param colIx the column to check
  1063. @return true if the range Contains the cell [rowIx,colIx]
  1064. </member>
  1065. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.UpdateNamedRanges(NPOI.SS.Formula.FormulaShifter)">
  1066. Updated named ranges
  1067. </member>
  1068. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.UpdateFormulas(NPOI.SS.Formula.FormulaShifter)">
  1069. Update formulas.
  1070. </member>
  1071. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.ShiftFormula(NPOI.XSSF.UserModel.XSSFRow,System.String,NPOI.SS.Formula.FormulaShifter)">
  1072. Shift a formula using the supplied FormulaShifter
  1073. @param row the row of the cell this formula belongs to. Used to get a reference to the parent workbook.
  1074. @param formula the formula to shift
  1075. @param Shifter the FormulaShifter object that operates on the Parsed formula tokens
  1076. @return the Shifted formula if the formula was Changed,
  1077. <code>null</code> if the formula wasn't modified
  1078. </member>
  1079. <member name="T:NPOI.XSSF.UserModel.Helpers.XSSFSingleXmlCell">
  1080. *
  1081. * This class is a wrapper around the CTSingleXmlCell (Open Office XML Part 4:
  1082. * chapter 3.5.2.1)
  1083. *
  1084. *
  1085. * @author Roberto Manicardi
  1086. *
  1087. </member>
  1088. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFSingleXmlCell.GetReferencedCell">
  1089. Gets the XSSFCell referenced by the R attribute or Creates a new one if cell doesn't exists
  1090. @return the referenced XSSFCell, null if the cell reference is invalid
  1091. </member>
  1092. <member name="T:NPOI.XSSF.UserModel.Helpers.XSSFXmlColumnPr">
  1093. This class is a wrapper around the CT_XmlColumnPr (Open Office XML Part 4:
  1094. chapter 3.5.1.7)
  1095. @author Roberto Manicardi
  1096. </member>
  1097. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFXmlColumnPr.GetId">
  1098. (see Open Office XML Part 4: chapter 3.5.1.3)
  1099. @return An integer representing the unique identifier of this column.
  1100. </member>
  1101. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFXmlColumnPr.GetLocalXPath">
  1102. If the XPath is, for example, /Node1/Node2/Node3 and /Node1/Node2 is the common XPath for the table, the local XPath is /Node3
  1103. @return the local XPath
  1104. </member>
  1105. <member name="T:NPOI.XSSF.UserModel.XSSFAnchor">
  1106. An anchor is what specifics the position of a shape within a client object
  1107. or within another containing shape.
  1108. @author Yegor Kozlov
  1109. </member>
  1110. <member name="T:NPOI.XSSF.UserModel.XSSFAutoFilter">
  1111. Represents autofiltering for the specified worksheet.
  1112. @author Yegor Kozlov
  1113. </member>
  1114. <member name="T:NPOI.XSSF.UserModel.XSSFBorderFormatting">
  1115. @author Yegor Kozlov
  1116. </member>
  1117. <member name="T:NPOI.XSSF.UserModel.XSSFCell">
  1118. High level representation of a cell in a row of a spreadsheet.
  1119. <p>
  1120. Cells can be numeric, formula-based or string-based (text). The cell type
  1121. specifies this. String cells cannot conatin numbers and numeric cells cannot
  1122. contain strings (at least according to our model). Client apps should do the
  1123. conversions themselves. Formula cells have the formula string, as well as
  1124. the formula result, which can be numeric or string.
  1125. </p>
  1126. <p>
  1127. Cells should have their number (0 based) before being Added to a row. Only
  1128. cells that have values should be Added.
  1129. </p>
  1130. </member>
  1131. <member name="F:NPOI.XSSF.UserModel.XSSFCell._cell">
  1132. the xml bean Containing information about the cell's location, value,
  1133. data type, formatting, and formula
  1134. </member>
  1135. <member name="F:NPOI.XSSF.UserModel.XSSFCell._row">
  1136. the XSSFRow this cell belongs to
  1137. </member>
  1138. <member name="F:NPOI.XSSF.UserModel.XSSFCell._cellNum">
  1139. 0-based column index
  1140. </member>
  1141. <member name="F:NPOI.XSSF.UserModel.XSSFCell._sharedStringSource">
  1142. Table of strings shared across this workbook.
  1143. If two cells contain the same string, then the cell value is the same index into SharedStringsTable
  1144. </member>
  1145. <member name="F:NPOI.XSSF.UserModel.XSSFCell._stylesSource">
  1146. Table of cell styles shared across all cells in a workbook.
  1147. </member>
  1148. <member name="M:NPOI.XSSF.UserModel.XSSFCell.#ctor(NPOI.XSSF.UserModel.XSSFRow,NPOI.OpenXmlFormats.Spreadsheet.CT_Cell)">
  1149. Construct a XSSFCell.
  1150. @param row the parent row.
  1151. @param cell the xml bean Containing information about the cell.
  1152. </member>
  1153. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetSharedStringSource">
  1154. @return table of strings shared across this workbook
  1155. </member>
  1156. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetStylesSource">
  1157. @return table of cell styles shared across this workbook
  1158. </member>
  1159. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(System.Boolean)">
  1160. Set a bool value for the cell
  1161. @param value the bool value to Set this cell to. For formulas we'll Set the
  1162. precalculated value, for bools we'll Set its value. For other types we
  1163. will change the cell to a bool cell and Set its value.
  1164. </member>
  1165. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(System.Double)">
  1166. Set a numeric value for the cell
  1167. @param value the numeric value to Set this cell to. For formulas we'll Set the
  1168. precalculated value, for numerics we'll Set its value. For other types we
  1169. will change the cell to a numeric cell and Set its value.
  1170. </member>
  1171. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(System.String)">
  1172. Set a string value for the cell.
  1173. @param str value to Set the cell to. For formulas we'll Set the formula
  1174. cached string result, for String cells we'll Set its value. For other types we will
  1175. change the cell to a string cell and Set its value.
  1176. If value is null then we will change the cell to a Blank cell.
  1177. </member>
  1178. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(NPOI.SS.UserModel.IRichTextString)">
  1179. Set a string value for the cell.
  1180. @param str value to Set the cell to. For formulas we'll Set the 'pre-Evaluated result string,
  1181. for String cells we'll Set its value. For other types we will
  1182. change the cell to a string cell and Set its value.
  1183. If value is null then we will change the cell to a Blank cell.
  1184. </member>
  1185. <member name="M:NPOI.XSSF.UserModel.XSSFCell.ConvertSharedFormula(System.Int32)">
  1186. <summary>
  1187. Creates a non shared formula from the shared formula counterpart
  1188. </summary>
  1189. <param name="si">Shared Group Index</param>
  1190. <returns>non shared formula created for the given shared formula and this cell</returns>
  1191. </member>
  1192. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellFormula(System.String)">
  1193. Sets formula for this cell.
  1194. <p>
  1195. Note, this method only Sets the formula string and does not calculate the formula value.
  1196. To Set the precalculated value use {@link #setCellValue(double)} or {@link #setCellValue(String)}
  1197. </p>
  1198. @param formula the formula to Set, e.g. <code>"SUM(C4:E4)"</code>.
  1199. If the argument is <code>null</code> then the current formula is Removed.
  1200. @throws NPOI.ss.formula.FormulaParseException if the formula has incorrect syntax or is otherwise invalid
  1201. @throws InvalidOperationException if the operation is not allowed, for example,
  1202. when the cell is a part of a multi-cell array formula
  1203. </member>
  1204. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetReference">
  1205. <summary>
  1206. Returns an A1 style reference to the location of this cell
  1207. </summary>
  1208. <returns>A1 style reference to the location of this cell</returns>
  1209. </member>
  1210. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetBaseCellType(System.Boolean)">
  1211. <summary>
  1212. Detect cell type based on the "t" attribute of the CT_Cell bean
  1213. </summary>
  1214. <param name="blankCells"></param>
  1215. <returns></returns>
  1216. </member>
  1217. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(System.DateTime)">
  1218. <summary>
  1219. Set a date value for the cell. Excel treats dates as numeric so you will need to format the cell as a date.
  1220. </summary>
  1221. <param name="value">the date value to Set this cell to. For formulas we'll set the precalculated value,
  1222. for numerics we'll Set its value. For other types we will change the cell to a numeric cell and Set its value. </param>
  1223. </member>
  1224. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellErrorValue(NPOI.SS.UserModel.FormulaError)">
  1225. <summary>
  1226. Set a error value for the cell
  1227. </summary>
  1228. <param name="error">the error value to Set this cell to.
  1229. For formulas we'll Set the precalculated value , for errors we'll set
  1230. its value. For other types we will change the cell to an error cell and Set its value.
  1231. </param>
  1232. </member>
  1233. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetAsActiveCell">
  1234. <summary>
  1235. Sets this cell as the active cell for the worksheet.
  1236. </summary>
  1237. </member>
  1238. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetBlank">
  1239. <summary>
  1240. Blanks this cell. Blank cells have no formula or value but may have styling.
  1241. This method erases all the data previously associated with this cell.
  1242. </summary>
  1243. </member>
  1244. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellNum(System.Int32)">
  1245. <summary>
  1246. Sets column index of this cell
  1247. </summary>
  1248. <param name="num"></param>
  1249. </member>
  1250. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellType(NPOI.SS.UserModel.CellType)">
  1251. <summary>
  1252. Set the cells type (numeric, formula or string)
  1253. </summary>
  1254. <param name="cellType"></param>
  1255. </member>
  1256. <member name="M:NPOI.XSSF.UserModel.XSSFCell.ToString">
  1257. <summary>
  1258. Returns a string representation of the cell
  1259. </summary>
  1260. <returns>Formula cells return the formula string, rather than the formula result.
  1261. Dates are displayed in dd-MMM-yyyy format
  1262. Errors are displayed as #ERR&lt;errIdx&gt;
  1263. </returns>
  1264. </member>
  1265. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetRawValue">
  1266. Returns the raw, underlying ooxml value for the cell
  1267. <p>
  1268. If the cell Contains a string, then this value is an index into
  1269. the shared string table, pointing to the actual string value. Otherwise,
  1270. the value of the cell is expressed directly in this element. Cells Containing formulas express
  1271. the last calculated result of the formula in this element.
  1272. </p>
  1273. @return the raw cell value as Contained in the underlying CT_Cell bean,
  1274. <code>null</code> for blank cells.
  1275. </member>
  1276. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetCellTypeName(NPOI.SS.UserModel.CellType)">
  1277. <summary>
  1278. Used to help format error messages
  1279. </summary>
  1280. <param name="cellTypeCode"></param>
  1281. <returns></returns>
  1282. </member>
  1283. <member name="M:NPOI.XSSF.UserModel.XSSFCell.TypeMismatch(NPOI.SS.UserModel.CellType,NPOI.SS.UserModel.CellType,System.Boolean)">
  1284. Used to help format error messages
  1285. </member>
  1286. <member name="M:NPOI.XSSF.UserModel.XSSFCell.CheckBounds(System.Int32)">
  1287. @throws RuntimeException if the bounds are exceeded.
  1288. </member>
  1289. <member name="M:NPOI.XSSF.UserModel.XSSFCell.RemoveCellComment">
  1290. <summary>
  1291. Removes the comment for this cell, if there is one.
  1292. </summary>
  1293. </member>
  1294. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetCTCell">
  1295. Returns the xml bean containing information about the cell's location (reference), value,
  1296. data type, formatting, and formula
  1297. @return the xml bean containing information about this cell
  1298. </member>
  1299. <member name="M:NPOI.XSSF.UserModel.XSSFCell.ConvertCellValueToBoolean">
  1300. Chooses a new bool value for the cell when its type is changing.<p/>
  1301. Usually the caller is calling SetCellType() with the intention of calling
  1302. SetCellValue(bool) straight afterwards. This method only exists to give
  1303. the cell a somewhat reasonable value until the SetCellValue() call (if at all).
  1304. TODO - perhaps a method like SetCellTypeAndValue(int, Object) should be introduced to avoid this
  1305. </member>
  1306. <member name="M:NPOI.XSSF.UserModel.XSSFCell.NotifyArrayFormulaChanging(System.String)">
  1307. The purpose of this method is to validate the cell state prior to modification
  1308. @see #NotifyArrayFormulaChanging()
  1309. </member>
  1310. <member name="M:NPOI.XSSF.UserModel.XSSFCell.NotifyArrayFormulaChanging">
  1311. <summary>
  1312. Called when this cell is modified.The purpose of this method is to validate the cell state prior to modification.
  1313. </summary>
  1314. <exception cref="T:System.InvalidOperationException">if modification is not allowed</exception>
  1315. </member>
  1316. <member name="P:NPOI.XSSF.UserModel.XSSFCell.Sheet">
  1317. Returns the sheet this cell belongs to
  1318. @return the sheet this cell belongs to
  1319. </member>
  1320. <member name="P:NPOI.XSSF.UserModel.XSSFCell.Row">
  1321. Returns the row this cell belongs to
  1322. @return the row this cell belongs to
  1323. </member>
  1324. <member name="P:NPOI.XSSF.UserModel.XSSFCell.BooleanCellValue">
  1325. Get the value of the cell as a bool.
  1326. <p>
  1327. For strings, numbers, and errors, we throw an exception. For blank cells we return a false.
  1328. </p>
  1329. @return the value of the cell as a bool
  1330. @throws InvalidOperationException if the cell type returned by {@link #CellType}
  1331. is not CellType.Boolean, CellType.Blank or CellType.Formula
  1332. </member>
  1333. <member name="P:NPOI.XSSF.UserModel.XSSFCell.NumericCellValue">
  1334. Get the value of the cell as a number.
  1335. <p>
  1336. For strings we throw an exception. For blank cells we return a 0.
  1337. For formulas or error cells we return the precalculated value;
  1338. </p>
  1339. @return the value of the cell as a number
  1340. @throws InvalidOperationException if the cell type returned by {@link #CellType} is CellType.String
  1341. @exception NumberFormatException if the cell value isn't a parsable <code>double</code>.
  1342. @see DataFormatter for turning this number into a string similar to that which Excel would render this number as.
  1343. </member>
  1344. <member name="P:NPOI.XSSF.UserModel.XSSFCell.StringCellValue">
  1345. Get the value of the cell as a string
  1346. <p>
  1347. For numeric cells we throw an exception. For blank cells we return an empty string.
  1348. For formulaCells that are not string Formulas, we throw an exception
  1349. </p>
  1350. @return the value of the cell as a string
  1351. </member>
  1352. <member name="P:NPOI.XSSF.UserModel.XSSFCell.RichStringCellValue">
  1353. Get the value of the cell as a XSSFRichTextString
  1354. <p>
  1355. For numeric cells we throw an exception. For blank cells we return an empty string.
  1356. For formula cells we return the pre-calculated value if a string, otherwise an exception
  1357. </p>
  1358. @return the value of the cell as a XSSFRichTextString
  1359. </member>
  1360. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CellFormula">
  1361. <summary>
  1362. Return a formula for the cell, for example, <code>SUM(C4:E4)</code>
  1363. </summary>
  1364. </member>
  1365. <member name="P:NPOI.XSSF.UserModel.XSSFCell.ColumnIndex">
  1366. <summary>
  1367. Returns zero-based column index of this cell
  1368. </summary>
  1369. </member>
  1370. <member name="P:NPOI.XSSF.UserModel.XSSFCell.RowIndex">
  1371. <summary>
  1372. Returns zero-based row index of a row in the sheet that contains this cell
  1373. </summary>
  1374. </member>
  1375. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CellStyle">
  1376. <summary>
  1377. Return the cell's style.
  1378. </summary>
  1379. </member>
  1380. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CellType">
  1381. <summary>
  1382. Return the cell type.
  1383. </summary>
  1384. </member>
  1385. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CachedFormulaResultType">
  1386. <summary>
  1387. Only valid for formula cells
  1388. </summary>
  1389. </member>
  1390. <member name="P:NPOI.XSSF.UserModel.XSSFCell.DateCellValue">
  1391. <summary>
  1392. Get the value of the cell as a date.
  1393. </summary>
  1394. </member>
  1395. <member name="P:NPOI.XSSF.UserModel.XSSFCell.ErrorCellString">
  1396. <summary>
  1397. Returns the error message, such as #VALUE!
  1398. </summary>
  1399. </member>
  1400. <member name="P:NPOI.XSSF.UserModel.XSSFCell.ErrorCellValue">
  1401. <summary>
  1402. Get the value of the cell as an error code.
  1403. For strings, numbers, and bools, we throw an exception.
  1404. For blank cells we return a 0.
  1405. </summary>
  1406. </member>
  1407. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CellComment">
  1408. <summary>
  1409. Returns cell comment associated with this cell
  1410. </summary>
  1411. </member>
  1412. <member name="P:NPOI.XSSF.UserModel.XSSFCell.Hyperlink">
  1413. <summary>
  1414. Returns hyperlink associated with this cell
  1415. </summary>
  1416. </member>
  1417. <member name="T:NPOI.XSSF.UserModel.XSSFCellStyle">
  1418. High level representation of the the possible formatting information for the contents of the cells on a sheet in a
  1419. SpreadsheetML document.
  1420. @see NPOI.xssf.usermodel.XSSFWorkbook#CreateCellStyle()
  1421. @see NPOI.xssf.usermodel.XSSFWorkbook#getCellStyleAt(short)
  1422. @see NPOI.xssf.usermodel.XSSFCell#setCellStyle(NPOI.ss.usermodel.CellStyle)
  1423. </member>
  1424. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.#ctor(System.Int32,System.Int32,NPOI.XSSF.Model.StylesTable,NPOI.XSSF.Model.ThemesTable)">
  1425. Creates a Cell Style from the supplied parts
  1426. @param cellXfId The main XF for the cell. Must be a valid 0-based index into the XF table
  1427. @param cellStyleXfId Optional, style xf. A value of <code>-1</code> means no xf.
  1428. @param stylesSource Styles Source to work off
  1429. </member>
  1430. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCoreXf">
  1431. Used so that StylesSource can figure out our location
  1432. </member>
  1433. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetStyleXf">
  1434. Used so that StylesSource can figure out our location
  1435. </member>
  1436. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.#ctor(NPOI.XSSF.Model.StylesTable)">
  1437. Creates an empty Cell Style
  1438. </member>
  1439. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.VerifyBelongsToStylesSource(NPOI.XSSF.Model.StylesTable)">
  1440. Verifies that this style belongs to the supplied Workbook
  1441. Styles Source.
  1442. Will throw an exception if it belongs to a different one.
  1443. This is normally called when trying to assign a style to a
  1444. cell, to ensure the cell and the style are from the same
  1445. workbook (if they're not, it won't work)
  1446. @throws ArgumentException if there's a workbook mis-match
  1447. </member>
  1448. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.CloneStyleFrom(NPOI.SS.UserModel.ICellStyle)">
  1449. Clones all the style information from another
  1450. XSSFCellStyle, onto this one. This
  1451. XSSFCellStyle will then have all the same
  1452. properties as the source, but the two may
  1453. be edited independently.
  1454. Any stylings on this XSSFCellStyle will be lost!
  1455. The source XSSFCellStyle could be from another
  1456. XSSFWorkbook if you like. This allows you to
  1457. copy styles from one XSSFWorkbook to another.
  1458. </member>
  1459. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetAlignmentEnum">
  1460. Get the type of horizontal alignment for the cell
  1461. @return HorizontalAlignment - the type of alignment
  1462. @see NPOI.ss.usermodel.HorizontalAlignment
  1463. </member>
  1464. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetBottomBorderXSSFColor">
  1465. Get the color to use for the bottom border as a {@link XSSFColor}
  1466. @return the used color or <code>null</code> if not Set
  1467. </member>
  1468. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetDataFormatString">
  1469. Get the contents of the format string, by looking up
  1470. the StylesSource
  1471. @return the number format string
  1472. </member>
  1473. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetFont">
  1474. Gets the font for this style
  1475. @return Font - font
  1476. </member>
  1477. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetLeftBorderXSSFColor">
  1478. Get the color to use for the left border
  1479. @return the index of the color defInition or <code>null</code> if not Set
  1480. @see NPOI.ss.usermodel.IndexedColors
  1481. </member>
  1482. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetRightBorderXSSFColor">
  1483. Get the color to use for the right border
  1484. @return the used color or <code>null</code> if not Set
  1485. </member>
  1486. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetTopBorderXSSFColor">
  1487. Get the color to use for the top border
  1488. @return the used color or <code>null</code> if not Set
  1489. </member>
  1490. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetVerticalAlignmentEnum">
  1491. Get the type of vertical alignment for the cell
  1492. @return the type of alignment, default value is {@link NPOI.ss.usermodel.VerticalAlignment#BOTTOM}
  1493. @see NPOI.ss.usermodel.VerticalAlignment
  1494. </member>
  1495. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetBottomBorderColor(NPOI.XSSF.UserModel.XSSFColor)">
  1496. Set the color to use for the bottom border
  1497. @param color the color to use, null means no color
  1498. </member>
  1499. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFCellStyle.SetFillBackgroundColor(NPOI.XSSF.UserModel.XSSFColor)" -->
  1500. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetFillForegroundColor(NPOI.XSSF.UserModel.XSSFColor)">
  1501. * Set the foreground fill color represented as a {@link XSSFColor} value.
  1502. * <br/>
  1503. * <i>Note: Ensure Foreground color is Set prior to background color.</i>
  1504. * @param color the color to use
  1505. * @see #setFillBackgroundColor(NPOI.xssf.usermodel.XSSFColor) )
  1506. </member>
  1507. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCTFill">
  1508. Get a <b>copy</b> of the currently used CT_Fill, if none is used, return a new instance.
  1509. </member>
  1510. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCTBorder">
  1511. Get a <b>copy</b> of the currently used CT_Border, if none is used, return a new instance.
  1512. </member>
  1513. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetFont(NPOI.SS.UserModel.IFont)">
  1514. Set the font for this style
  1515. @param font a font object Created or retreived from the XSSFWorkbook object
  1516. @see NPOI.xssf.usermodel.XSSFWorkbook#CreateFont()
  1517. @see NPOI.xssf.usermodel.XSSFWorkbook#getFontAt(short)
  1518. </member>
  1519. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetLeftBorderColor(NPOI.XSSF.UserModel.XSSFColor)">
  1520. Set the color to use for the left border as a {@link XSSFColor} value
  1521. @param color the color to use
  1522. </member>
  1523. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetRightBorderColor(NPOI.XSSF.UserModel.XSSFColor)">
  1524. Set the color to use for the right border as a {@link XSSFColor} value
  1525. @param color the color to use
  1526. </member>
  1527. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetTopBorderColor(NPOI.XSSF.UserModel.XSSFColor)">
  1528. Set the color to use for the top border as a {@link XSSFColor} value
  1529. @param color the color to use
  1530. </member>
  1531. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetVerticalAlignment(System.Int16)">
  1532. Set the type of vertical alignment for the cell
  1533. @param align - align the type of alignment
  1534. @see NPOI.ss.usermodel.CellStyle#VERTICAL_TOP
  1535. @see NPOI.ss.usermodel.CellStyle#VERTICAL_CENTER
  1536. @see NPOI.ss.usermodel.CellStyle#VERTICAL_BOTTOM
  1537. @see NPOI.ss.usermodel.CellStyle#VERTICAL_JUSTIFY
  1538. @see NPOI.ss.usermodel.VerticalAlignment
  1539. </member>
  1540. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetBorderColor(NPOI.XSSF.UserModel.Extensions.BorderSide)">
  1541. Gets border color
  1542. @param side the border side
  1543. @return the used color
  1544. </member>
  1545. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetBorderColor(NPOI.XSSF.UserModel.Extensions.BorderSide,NPOI.XSSF.UserModel.XSSFColor)">
  1546. Set the color to use for the selected border
  1547. @param side - where to apply the color defInition
  1548. @param color - the color to use
  1549. </member>
  1550. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCellAlignment">
  1551. Get the cellAlignment object to use for manage alignment
  1552. @return XSSFCellAlignment - cell alignment
  1553. </member>
  1554. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCTCellAlignment">
  1555. Return the CT_CellAlignment instance for alignment
  1556. @return CT_CellAlignment
  1557. </member>
  1558. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetHashCode">
  1559. Returns a hash code value for the object. The hash is derived from the underlying CT_Xf bean.
  1560. @return the hash code value for this style
  1561. </member>
  1562. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.Equals(System.Object)">
  1563. Checks is the supplied style is equal to this style
  1564. @param o the style to check
  1565. @return true if the supplied style is equal to this style
  1566. </member>
  1567. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.Clone">
  1568. Make a copy of this style. The underlying CT_Xf bean is Cloned,
  1569. the references to Fills and borders remain.
  1570. @return a copy of this style
  1571. </member>
  1572. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.BorderRight">
  1573. Get the type of border to use for the right border of the cell
  1574. @return short - border type, default value is {@link NPOI.ss.usermodel.CellStyle#BorderStyle.None}
  1575. </member>
  1576. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.BottomBorderColor">
  1577. Get the color to use for the bottom border
  1578. <br/>
  1579. Color is optional. When missing, IndexedColors.Automatic is implied.
  1580. @return the index of the color defInition, default value is {@link NPOI.ss.usermodel.IndexedColors#AUTOMATIC}
  1581. @see NPOI.ss.usermodel.IndexedColors
  1582. </member>
  1583. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.DataFormat">
  1584. Get the index of the number format (numFmt) record used by this cell format.
  1585. @return the index of the number format
  1586. </member>
  1587. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillBackgroundColor">
  1588. Get the background fill color.
  1589. <p>
  1590. Note - many cells are actually Filled with a foreground
  1591. Fill, not a background fill - see {@link #getFillForegroundColor()}
  1592. </p>
  1593. @return fill color, default value is {@link NPOI.ss.usermodel.IndexedColors#AUTOMATIC}
  1594. @see NPOI.ss.usermodel.IndexedColors
  1595. </member>
  1596. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillBackgroundColorColor">
  1597. Get the background fill color.
  1598. <p>
  1599. Note - many cells are actually Filled with a foreground
  1600. Fill, not a background fill - see {@link #getFillForegroundColor()}
  1601. </p>
  1602. @see NPOI.xssf.usermodel.XSSFColor#getRgb()
  1603. @return XSSFColor - fill color or <code>null</code> if not Set
  1604. </member>
  1605. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillForegroundColor">
  1606. Get the foreground fill color.
  1607. <p>
  1608. Many cells are Filled with this, instead of a
  1609. background color ({@link #getFillBackgroundColor()})
  1610. </p>
  1611. @see IndexedColors
  1612. @return fill color, default value is {@link NPOI.ss.usermodel.IndexedColors#AUTOMATIC}
  1613. </member>
  1614. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillForegroundColorColor">
  1615. Get the foreground fill color.
  1616. @return XSSFColor - fill color or <code>null</code> if not Set
  1617. </member>
  1618. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillForegroundXSSFColor">
  1619. Get the foreground fill color.
  1620. @return XSSFColor - fill color or <code>null</code> if not set
  1621. </member>
  1622. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FontIndex">
  1623. Gets the index of the font for this style
  1624. @return short - font index
  1625. @see NPOI.xssf.usermodel.XSSFWorkbook#getFontAt(short)
  1626. </member>
  1627. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.IsHidden">
  1628. Get whether the cell's using this style are to be hidden
  1629. @return bool - whether the cell using this style is hidden
  1630. </member>
  1631. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.Indention">
  1632. Get the number of spaces to indent the text in the cell
  1633. @return indent - number of spaces
  1634. </member>
  1635. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.Index">
  1636. Get the index within the StylesTable (sequence within the collection of CT_Xf elements)
  1637. @return unique index number of the underlying record this style represents
  1638. </member>
  1639. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.LeftBorderColor">
  1640. Get the color to use for the left border
  1641. @return the index of the color defInition, default value is {@link NPOI.ss.usermodel.IndexedColors#BLACK}
  1642. @see NPOI.ss.usermodel.IndexedColors
  1643. </member>
  1644. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.IsLocked">
  1645. Get whether the cell's using this style are locked
  1646. @return whether the cell using this style are locked
  1647. </member>
  1648. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.RightBorderColor">
  1649. Get the color to use for the right border
  1650. @return the index of the color defInition, default value is {@link NPOI.ss.usermodel.IndexedColors#BLACK}
  1651. @see NPOI.ss.usermodel.IndexedColors
  1652. </member>
  1653. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.Rotation">
  1654. Get the degree of rotation for the text in the cell
  1655. <p>
  1656. Expressed in degrees. Values range from 0 to 180. The first letter of
  1657. the text is considered the center-point of the arc.
  1658. <br/>
  1659. For 0 - 90, the value represents degrees above horizon. For 91-180 the degrees below the
  1660. horizon is calculated as:
  1661. <br/>
  1662. <code>[degrees below horizon] = 90 - textRotation.</code>
  1663. </p>
  1664. @return rotation degrees (between 0 and 180 degrees)
  1665. </member>
  1666. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.TopBorderColor">
  1667. Get the color to use for the top border
  1668. @return the index of the color defInition, default value is {@link NPOI.ss.usermodel.IndexedColors#BLACK}
  1669. @see NPOI.ss.usermodel.IndexedColors
  1670. </member>
  1671. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.VerticalAlignment">
  1672. Get the type of vertical alignment for the cell
  1673. @return align the type of alignment, default value is {@link NPOI.ss.usermodel.CellStyle#VERTICAL_BOTTOM}
  1674. @see NPOI.ss.usermodel.CellStyle#VERTICAL_TOP
  1675. @see NPOI.ss.usermodel.CellStyle#VERTICAL_CENTER
  1676. @see NPOI.ss.usermodel.CellStyle#VERTICAL_BOTTOM
  1677. @see NPOI.ss.usermodel.CellStyle#VERTICAL_JUSTIFY
  1678. </member>
  1679. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.WrapText">
  1680. Whether the text should be wrapped
  1681. @return a bool value indicating if the text in a cell should be line-wrapped within the cell.
  1682. </member>
  1683. <member name="T:NPOI.XSSF.UserModel.XSSFChart">
  1684. Represents a SpreadsheetML Chart
  1685. @author Nick Burch
  1686. @author Roman Kashitsyn
  1687. </member>
  1688. <member name="F:NPOI.XSSF.UserModel.XSSFChart.frame">
  1689. Parent graphic frame.
  1690. </member>
  1691. <member name="F:NPOI.XSSF.UserModel.XSSFChart.chartSpaceDocument">
  1692. Root element of the SpreadsheetML Chart part
  1693. </member>
  1694. <member name="F:NPOI.XSSF.UserModel.XSSFChart.chart">
  1695. The Chart within that
  1696. </member>
  1697. <member name="M:NPOI.XSSF.UserModel.XSSFChart.#ctor">
  1698. Create a new SpreadsheetML chart
  1699. </member>
  1700. <member name="M:NPOI.XSSF.UserModel.XSSFChart.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  1701. Construct a SpreadsheetML chart from a namespace part.
  1702. @param part the namespace part holding the chart data,
  1703. the content type must be <code>application/vnd.Openxmlformats-officedocument.Drawingml.chart+xml</code>
  1704. @param rel the namespace relationship holding this chart,
  1705. the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/chart
  1706. </member>
  1707. <member name="M:NPOI.XSSF.UserModel.XSSFChart.CreateChart">
  1708. Construct a new CTChartSpace bean.
  1709. By default, it's just an empty placeholder for chart objects.
  1710. @return a new CTChartSpace bean
  1711. </member>
  1712. <member name="M:NPOI.XSSF.UserModel.XSSFChart.GetCTChartSpace">
  1713. Return the underlying CTChartSpace bean, the root element of the SpreadsheetML Chart part.
  1714. @return the underlying CTChartSpace bean
  1715. </member>
  1716. <member name="M:NPOI.XSSF.UserModel.XSSFChart.GetCTChart">
  1717. Return the underlying CTChart bean, within the Chart Space
  1718. @return the underlying CTChart bean
  1719. </member>
  1720. <member name="M:NPOI.XSSF.UserModel.XSSFChart.GetGraphicFrame">
  1721. Returns the parent graphic frame.
  1722. @return the graphic frame this chart belongs to
  1723. </member>
  1724. <member name="M:NPOI.XSSF.UserModel.XSSFChart.SetGraphicFrame(NPOI.XSSF.UserModel.XSSFGraphicFrame)">
  1725. Sets the parent graphic frame.
  1726. </member>
  1727. <member name="M:NPOI.XSSF.UserModel.XSSFChart.IsPlotOnlyVisibleCells">
  1728. @return true if only visible cells will be present on the chart,
  1729. false otherwise
  1730. </member>
  1731. <member name="M:NPOI.XSSF.UserModel.XSSFChart.SetPlotOnlyVisibleCells(System.Boolean)">
  1732. @param plotVisOnly a flag specifying if only visible cells should be
  1733. present on the chart
  1734. </member>
  1735. <member name="P:NPOI.XSSF.UserModel.XSSFChart.Title">
  1736. Returns the title, or null if none is Set
  1737. </member>
  1738. <member name="T:NPOI.XSSF.UserModel.XSSFChartSheet">
  1739. High level representation of Sheet Parts that are of type 'chartsheet'.
  1740. <p>
  1741. Chart sheet is a special kind of Sheet that Contains only chart and no data.
  1742. </p>
  1743. @author Yegor Kozlov
  1744. </member>
  1745. <member name="T:NPOI.XSSF.UserModel.XSSFSheet">
  1746. High level representation of a SpreadsheetML worksheet.
  1747. <p>
  1748. Sheets are the central structures within a workbook, and are where a user does most of his spreadsheet work.
  1749. The most common type of sheet is the worksheet, which is represented as a grid of cells. Worksheet cells can
  1750. contain text, numbers, dates, and formulas. Cells can also be formatted.
  1751. </p>
  1752. </member>
  1753. <member name="F:NPOI.XSSF.UserModel.XSSFSheet.sharedFormulas">
  1754. cache of master shared formulas in this sheet.
  1755. Master shared formula is the first formula in a group of shared formulas is saved in the f element.
  1756. </member>
  1757. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.#ctor">
  1758. Creates new XSSFSheet - called by XSSFWorkbook to create a sheet from scratch.
  1759. @see NPOI.XSSF.usermodel.XSSFWorkbook#CreateSheet()
  1760. </member>
  1761. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  1762. Creates an XSSFSheet representing the given namespace part and relationship.
  1763. Should only be called by XSSFWorkbook when Reading in an exisiting file.
  1764. @param part - The namespace part that holds xml data represenring this sheet.
  1765. @param rel - the relationship of the given namespace part in the underlying OPC namespace
  1766. </member>
  1767. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.OnDocumentRead">
  1768. Initialize worksheet data when Reading in an exisiting file.
  1769. </member>
  1770. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.OnDocumentCreate">
  1771. Initialize worksheet data when creating a new sheet.
  1772. </member>
  1773. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.InitHyperlinks">
  1774. Read hyperlink relations, link them with CT_Hyperlink beans in this worksheet
  1775. and Initialize the internal array of XSSFHyperlink objects
  1776. </member>
  1777. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.NewSheet">
  1778. Create a new CT_Worksheet instance with all values set to defaults
  1779. @return a new instance
  1780. </member>
  1781. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCTWorksheet">
  1782. Provide access to the CT_Worksheet bean holding this sheet's data
  1783. @return the CT_Worksheet bean holding this sheet's data
  1784. </member>
  1785. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AddMergedRegion(NPOI.SS.Util.CellRangeAddress)">
  1786. Adds a merged region of cells (hence those cells form one).
  1787. @param region (rowfrom/colfrom-rowto/colto) to merge
  1788. @return index of this region
  1789. </member>
  1790. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AutoSizeColumn(System.Int32)">
  1791. Adjusts the column width to fit the contents.
  1792. This process can be relatively slow on large sheets, so this should
  1793. normally only be called once per column, at the end of your
  1794. Processing.
  1795. @param column the column index
  1796. </member>
  1797. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AutoSizeColumn(System.Int32,System.Boolean)">
  1798. Adjusts the column width to fit the contents.
  1799. <p>
  1800. This process can be relatively slow on large sheets, so this should
  1801. normally only be called once per column, at the end of your
  1802. Processing.
  1803. </p>
  1804. You can specify whether the content of merged cells should be considered or ignored.
  1805. Default is to ignore merged cells.
  1806. @param column the column index
  1807. @param useMergedCells whether to use the contents of merged cells when calculating the width of the column
  1808. </member>
  1809. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateDrawingPatriarch">
  1810. Create a new SpreadsheetML drawing. If this sheet already Contains a drawing - return that.
  1811. @return a SpreadsheetML drawing
  1812. </member>
  1813. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetVMLDrawing(System.Boolean)">
  1814. Get VML drawing for this sheet (aka 'legacy' drawig)
  1815. @param autoCreate if true, then a new VML drawing part is Created
  1816. @return the VML drawing of <code>null</code> if the drawing was not found and autoCreate=false
  1817. </member>
  1818. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateFreezePane(System.Int32,System.Int32)">
  1819. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  1820. @param colSplit Horizonatal position of split.
  1821. @param rowSplit Vertical position of split.
  1822. </member>
  1823. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateFreezePane(System.Int32,System.Int32,System.Int32,System.Int32)">
  1824. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  1825. <p>
  1826. If both colSplit and rowSplit are zero then the existing freeze pane is Removed
  1827. </p>
  1828. @param colSplit Horizonatal position of split.
  1829. @param rowSplit Vertical position of split.
  1830. @param leftmostColumn Left column visible in right pane.
  1831. @param topRow Top row visible in bottom pane
  1832. </member>
  1833. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateComment">
  1834. Creates a new comment for this sheet. You still
  1835. need to assign it to a cell though
  1836. @deprecated since Nov 2009 this method is not compatible with the common SS interfaces,
  1837. use {@link NPOI.XSSF.usermodel.XSSFDrawing#CreateCellComment
  1838. (NPOI.SS.usermodel.ClientAnchor)} instead
  1839. </member>
  1840. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateRow(System.Int32)">
  1841. Create a new row within the sheet and return the high level representation
  1842. @param rownum row number
  1843. @return High level {@link XSSFRow} object representing a row in the sheet
  1844. @see #RemoveRow(NPOI.SS.usermodel.Row)
  1845. </member>
  1846. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateSplitPane(System.Int32,System.Int32,System.Int32,System.Int32,NPOI.SS.UserModel.PanePosition)">
  1847. Creates a split pane. Any existing freezepane or split pane is overwritten.
  1848. @param xSplitPos Horizonatal position of split (in 1/20th of a point).
  1849. @param ySplitPos Vertical position of split (in 1/20th of a point).
  1850. @param topRow Top row visible in bottom pane
  1851. @param leftmostColumn Left column visible in right pane.
  1852. @param activePane Active pane. One of: PANE_LOWER_RIGHT,
  1853. PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFT
  1854. @see NPOI.SS.usermodel.Sheet#PANE_LOWER_LEFT
  1855. @see NPOI.SS.usermodel.Sheet#PANE_LOWER_RIGHT
  1856. @see NPOI.SS.usermodel.Sheet#PANE_UPPER_LEFT
  1857. @see NPOI.SS.usermodel.Sheet#PANE_UPPER_RIGHT
  1858. </member>
  1859. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetColumnWidth(System.Int32)">
  1860. Get the actual column width (in units of 1/256th of a character width )
  1861. <p>
  1862. Note, the returned value is always gerater that {@link #GetDefaultColumnWidth()} because the latter does not include margins.
  1863. Actual column width measured as the number of characters of the maximum digit width of the
  1864. numbers 0, 1, 2, ..., 9 as rendered in the normal style's font. There are 4 pixels of margin
  1865. pAdding (two on each side), plus 1 pixel pAdding for the gridlines.
  1866. </p>
  1867. @param columnIndex - the column to set (0-based)
  1868. @return width - the width in units of 1/256th of a character width
  1869. </member>
  1870. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetColumnStyle(System.Int32)">
  1871. Returns the CellStyle that applies to the given
  1872. (0 based) column, or null if no style has been
  1873. set for that column
  1874. </member>
  1875. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetMargin(NPOI.SS.UserModel.MarginType)">
  1876. Gets the size of the margin in inches.
  1877. @param margin which margin to get
  1878. @return the size of the margin
  1879. @see Sheet#LeftMargin
  1880. @see Sheet#RightMargin
  1881. @see Sheet#TopMargin
  1882. @see Sheet#BottomMargin
  1883. @see Sheet#HeaderMargin
  1884. @see Sheet#FooterMargin
  1885. </member>
  1886. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetMargin(NPOI.SS.UserModel.MarginType,System.Double)">
  1887. Sets the size of the margin in inches.
  1888. @param margin which margin to get
  1889. @param size the size of the margin
  1890. @see Sheet#LeftMargin
  1891. @see Sheet#RightMargin
  1892. @see Sheet#TopMargin
  1893. @see Sheet#BottomMargin
  1894. @see Sheet#HeaderMargin
  1895. @see Sheet#FooterMargin
  1896. </member>
  1897. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetMergedRegion(System.Int32)">
  1898. @return the merged region at the specified index
  1899. @throws InvalidOperationException if this worksheet does not contain merged regions
  1900. </member>
  1901. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ProtectSheet(System.String)">
  1902. Enables sheet protection and Sets the password for the sheet.
  1903. Also Sets some attributes on the {@link CT_SheetProtection} that correspond to
  1904. the default values used by Excel
  1905. @param password to set for protection. Pass <code>null</code> to remove protection
  1906. </member>
  1907. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.StringToExcelPassword(System.String)">
  1908. Converts a String to a {@link STUnsignedshortHex} value that Contains the {@link PasswordRecord#hashPassword(String)}
  1909. value in hexadecimal format
  1910. @param password the password string you wish convert to an {@link STUnsignedshortHex}
  1911. @return {@link STUnsignedshortHex} that Contains Excel hashed password in Hex format
  1912. </member>
  1913. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetRow(System.Int32)">
  1914. Returns the logical row ( 0-based). If you ask for a row that is not
  1915. defined you get a null. This is to say row 4 represents the fifth row on a sheet.
  1916. @param rownum row to get
  1917. @return <code>XSSFRow</code> representing the rownumber or <code>null</code> if its not defined on the sheet
  1918. </member>
  1919. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ensureOutlinePr">
  1920. Ensure CT_Worksheet.CT_SheetPr.CT_OutlinePr
  1921. </member>
  1922. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GroupColumn(System.Int32,System.Int32)">
  1923. Group between (0 based) columns
  1924. </member>
  1925. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GroupRow(System.Int32,System.Int32)">
  1926. Tie a range of cell toGether so that they can be collapsed or expanded
  1927. @param fromRow start row (0-based)
  1928. @param toRow end row (0-based)
  1929. </member>
  1930. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsColumnBroken(System.Int32)">
  1931. Determines if there is a page break at the indicated column
  1932. </member>
  1933. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsColumnHidden(System.Int32)">
  1934. Get the hidden state for a given column.
  1935. @param columnIndex - the column to set (0-based)
  1936. @return hidden - <code>false</code> if the column is visible
  1937. </member>
  1938. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsRowBroken(System.Int32)">
  1939. Tests if there is a page break at the indicated row
  1940. @param row index of the row to test
  1941. @return <code>true</code> if there is a page break at the indicated row
  1942. </member>
  1943. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetRowBreak(System.Int32)">
  1944. Sets a page break at the indicated row
  1945. Breaks occur above the specified row and left of the specified column inclusive.
  1946. For example, <code>sheet.SetColumnBreak(2);</code> breaks the sheet into two parts
  1947. with columns A,B,C in the first and D,E,... in the second. Simuilar, <code>sheet.SetRowBreak(2);</code>
  1948. breaks the sheet into two parts with first three rows (rownum=1...3) in the first part
  1949. and rows starting with rownum=4 in the second.
  1950. @param row the row to break, inclusive
  1951. </member>
  1952. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveColumnBreak(System.Int32)">
  1953. Removes a page break at the indicated column
  1954. </member>
  1955. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveMergedRegion(System.Int32)">
  1956. Removes a merged region of cells (hence letting them free)
  1957. @param index of the region to unmerge
  1958. </member>
  1959. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveRow(NPOI.SS.UserModel.IRow)">
  1960. Remove a row from this sheet. All cells Contained in the row are Removed as well
  1961. @param row the row to Remove.
  1962. </member>
  1963. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveRowBreak(System.Int32)">
  1964. Removes the page break at the indicated row
  1965. </member>
  1966. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetColumnBreak(System.Int32)">
  1967. Sets a page break at the indicated column.
  1968. Breaks occur above the specified row and left of the specified column inclusive.
  1969. For example, <code>sheet.SetColumnBreak(2);</code> breaks the sheet into two parts
  1970. with columns A,B,C in the first and D,E,... in the second. Simuilar, <code>sheet.SetRowBreak(2);</code>
  1971. breaks the sheet into two parts with first three rows (rownum=1...3) in the first part
  1972. and rows starting with rownum=4 in the second.
  1973. @param column the column to break, inclusive
  1974. </member>
  1975. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetGroupHidden(System.Int32,System.Int32,System.Boolean)">
  1976. Sets all adjacent columns of the same outline level to the specified
  1977. hidden status.
  1978. @param pIdx
  1979. the col info index of the start of the outline group
  1980. @return the column index of the last column in the outline group
  1981. </member>
  1982. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsColumnGroupCollapsed(System.Int32)">
  1983. 'Collapsed' state is stored in a single column col info record
  1984. immediately after the outline group
  1985. @param idx
  1986. @return a bool represented if the column is collapsed
  1987. </member>
  1988. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetColumnHidden(System.Int32,System.Boolean)">
  1989. Get the visibility state for a given column.
  1990. @param columnIndex - the column to get (0-based)
  1991. @param hidden - the visiblity state of the column
  1992. </member>
  1993. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFSheet.SetColumnWidth(System.Int32,System.Int32)" -->
  1994. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetRowGroupCollapsed(System.Int32,System.Boolean)">
  1995. group the row It is possible for collapsed to be false and yet still have
  1996. the rows in question hidden. This can be achieved by having a lower
  1997. outline level collapsed, thus hiding all the child rows. Note that in
  1998. this case, if the lowest level were expanded, the middle level would
  1999. remain collapsed.
  2000. @param rowIndex -
  2001. the row involved, 0 based
  2002. @param collapse -
  2003. bool value for collapse
  2004. </member>
  2005. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CollapseRow(System.Int32)">
  2006. @param rowIndex the zero based row index to collapse
  2007. </member>
  2008. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.FindStartOfRowOutlineGroup(System.Int32)">
  2009. @param rowIndex the zero based row index to find from
  2010. </member>
  2011. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ExpandRow(System.Int32)">
  2012. @param rowNumber the zero based row index to expand
  2013. </member>
  2014. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.FindEndOfRowOutlineGroup(System.Int32)">
  2015. @param row the zero based row index to find from
  2016. </member>
  2017. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsRowGroupHiddenByParent(System.Int32)">
  2018. @param row the zero based row index to find from
  2019. </member>
  2020. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsRowGroupCollapsed(System.Int32)">
  2021. @param row the zero based row index to find from
  2022. </member>
  2023. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetZoom(System.Int32,System.Int32)">
  2024. Sets the zoom magnication for the sheet. The zoom is expressed as a
  2025. fraction. For example to express a zoom of 75% use 3 for the numerator
  2026. and 4 for the denominator.
  2027. @param numerator The numerator for the zoom magnification.
  2028. @param denominator The denominator for the zoom magnification.
  2029. @see #SetZoom(int)
  2030. </member>
  2031. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFSheet.SetZoom(System.Int32)" -->
  2032. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32)" -->
  2033. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean)" -->
  2034. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ShowInPane(System.Int16,System.Int16)">
  2035. Location of the top left visible cell Location of the top left visible cell in the bottom right
  2036. pane (when in Left-to-Right mode).
  2037. @param toprow the top row to show in desktop window pane
  2038. @param leftcol the left column to show in desktop window pane
  2039. </member>
  2040. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.UngroupRow(System.Int32,System.Int32)">
  2041. Ungroup a range of rows that were previously groupped
  2042. @param fromRow start row (0-based)
  2043. @param toRow end row (0-based)
  2044. </member>
  2045. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetCellComment(System.String,NPOI.XSSF.UserModel.XSSFComment)">
  2046. Assign a cell comment to a cell region in this worksheet
  2047. @param cellRef cell region
  2048. @param comment the comment to assign
  2049. @deprecated since Nov 2009 use {@link XSSFCell#SetCellComment(NPOI.SS.usermodel.Comment)} instead
  2050. </member>
  2051. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AddHyperlink(NPOI.XSSF.UserModel.XSSFHyperlink)">
  2052. Register a hyperlink in the collection of hyperlinks on this sheet
  2053. @param hyperlink the link to add
  2054. </member>
  2055. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetDefaultSheetView">
  2056. Return the default sheet view. This is the last one if the sheet's views, according to sec. 3.3.1.83
  2057. of the OOXML spec: "A single sheet view defInition. When more than 1 sheet view is defined in the file,
  2058. it means that when opening the workbook, each sheet view corresponds to a separate window within the
  2059. spreadsheet application, where each window is Showing the particular sheet. Containing the same
  2060. workbookViewId value, the last sheetView defInition is loaded, and the others are discarded.
  2061. When multiple windows are viewing the same sheet, multiple sheetView elements (with corresponding
  2062. workbookView entries) are saved."
  2063. </member>
  2064. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCommentsTable(System.Boolean)">
  2065. Returns the sheet's comments object if there is one,
  2066. or null if not
  2067. @param create create a new comments table if it does not exist
  2068. </member>
  2069. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetSharedFormula(System.Int32)">
  2070. Return a master shared formula by index
  2071. @param sid shared group index
  2072. @return a CT_CellFormula bean holding shared formula or <code>null</code> if not found
  2073. </member>
  2074. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.EnableLocking">
  2075. Enable sheet protection
  2076. </member>
  2077. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.DisableLocking">
  2078. Disable sheet protection
  2079. </member>
  2080. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockAutoFilter">
  2081. Enable Autofilters locking.
  2082. This does not modify sheet protection status.
  2083. To enforce this locking, call {@link #enableLocking()}
  2084. </member>
  2085. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockDeleteColumns">
  2086. Enable Deleting columns locking.
  2087. This does not modify sheet protection status.
  2088. To enforce this locking, call {@link #enableLocking()}
  2089. </member>
  2090. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockDeleteRows">
  2091. Enable Deleting rows locking.
  2092. This does not modify sheet protection status.
  2093. To enforce this locking, call {@link #enableLocking()}
  2094. </member>
  2095. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockFormatCells">
  2096. Enable Formatting cells locking.
  2097. This does not modify sheet protection status.
  2098. To enforce this locking, call {@link #enableLocking()}
  2099. </member>
  2100. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockFormatColumns">
  2101. Enable Formatting columns locking.
  2102. This does not modify sheet protection status.
  2103. To enforce this locking, call {@link #enableLocking()}
  2104. </member>
  2105. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockFormatRows">
  2106. Enable Formatting rows locking.
  2107. This does not modify sheet protection status.
  2108. To enforce this locking, call {@link #enableLocking()}
  2109. </member>
  2110. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockInsertColumns">
  2111. Enable Inserting columns locking.
  2112. This does not modify sheet protection status.
  2113. To enforce this locking, call {@link #enableLocking()}
  2114. </member>
  2115. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockInsertHyperlinks">
  2116. Enable Inserting hyperlinks locking.
  2117. This does not modify sheet protection status.
  2118. To enforce this locking, call {@link #enableLocking()}
  2119. </member>
  2120. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockInsertRows">
  2121. Enable Inserting rows locking.
  2122. This does not modify sheet protection status.
  2123. To enforce this locking, call {@link #enableLocking()}
  2124. </member>
  2125. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockPivotTables">
  2126. Enable Pivot Tables locking.
  2127. This does not modify sheet protection status.
  2128. To enforce this locking, call {@link #enableLocking()}
  2129. </member>
  2130. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockSort">
  2131. Enable Sort locking.
  2132. This does not modify sheet protection status.
  2133. To enforce this locking, call {@link #enableLocking()}
  2134. </member>
  2135. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockObjects">
  2136. Enable Objects locking.
  2137. This does not modify sheet protection status.
  2138. To enforce this locking, call {@link #enableLocking()}
  2139. </member>
  2140. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockScenarios">
  2141. Enable Scenarios locking.
  2142. This does not modify sheet protection status.
  2143. To enforce this locking, call {@link #enableLocking()}
  2144. </member>
  2145. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockSelectLockedCells">
  2146. Enable Selection of locked cells locking.
  2147. This does not modify sheet protection status.
  2148. To enforce this locking, call {@link #enableLocking()}
  2149. </member>
  2150. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockSelectUnlockedCells">
  2151. Enable Selection of unlocked cells locking.
  2152. This does not modify sheet protection status.
  2153. To enforce this locking, call {@link #enableLocking()}
  2154. </member>
  2155. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCellRange(NPOI.SS.Util.CellRangeAddress)">
  2156. Also Creates cells if they don't exist
  2157. </member>
  2158. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateTable">
  2159. Creates a new Table, and associates it with this Sheet
  2160. </member>
  2161. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetTables">
  2162. Returns any tables associated with this Sheet
  2163. </member>
  2164. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetTabColor(System.Int32)">
  2165. Set background color of the sheet tab
  2166. @param colorIndex the indexed color to set, must be a constant from {@link IndexedColors}
  2167. </member>
  2168. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Workbook">
  2169. Returns the parent XSSFWorkbook
  2170. @return the parent XSSFWorkbook
  2171. </member>
  2172. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.SheetName">
  2173. Returns the name of this sheet
  2174. @return the name of this sheet
  2175. </member>
  2176. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.ColumnBreaks">
  2177. Vertical page break information used for print layout view, page layout view, drawing print breaks
  2178. in normal view, and for printing the worksheet.
  2179. @return column indexes of all the vertical page breaks, never <code>null</code>
  2180. </member>
  2181. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DefaultColumnWidth">
  2182. Get the default column width for the sheet (if the columns do not define their own width) in
  2183. characters.
  2184. <p>
  2185. Note, this value is different from {@link #GetColumnWidth(int)}. The latter is always greater and includes
  2186. 4 pixels of margin pAdding (two on each side), plus 1 pixel pAdding for the gridlines.
  2187. </p>
  2188. @return column width, default value is 8
  2189. </member>
  2190. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DefaultRowHeight">
  2191. Get the default row height for the sheet (if the rows do not define their own height) in
  2192. twips (1/20 of a point)
  2193. @return default row height
  2194. </member>
  2195. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DefaultRowHeightInPoints">
  2196. Get the default row height for the sheet measued in point size (if the rows do not define their own height).
  2197. @return default row height in points
  2198. </member>
  2199. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.RightToLeft">
  2200. Whether the text is displayed in right-to-left mode in the window
  2201. @return whether the text is displayed in right-to-left mode in the window
  2202. </member>
  2203. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayGuts">
  2204. Get whether to display the guts or not,
  2205. default value is true
  2206. @return bool - guts or no guts
  2207. </member>
  2208. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayZeros">
  2209. Gets the flag indicating whether the window should show 0 (zero) in cells Containing zero value.
  2210. When false, cells with zero value appear blank instead of Showing the number zero.
  2211. @return whether all zero values on the worksheet are displayed
  2212. </member>
  2213. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.FirstRowNum">
  2214. Gets the first row on the sheet
  2215. @return the number of the first logical row on the sheet, zero based
  2216. </member>
  2217. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.FitToPage">
  2218. Flag indicating whether the Fit to Page print option is enabled.
  2219. @return <code>true</code>
  2220. </member>
  2221. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Footer">
  2222. Returns the default footer for the sheet,
  2223. creating one as needed.
  2224. You may also want to look at
  2225. {@link #GetFirstFooter()},
  2226. {@link #GetOddFooter()} and
  2227. {@link #GetEvenFooter()}
  2228. </member>
  2229. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Header">
  2230. Returns the default header for the sheet,
  2231. creating one as needed.
  2232. You may also want to look at
  2233. {@link #GetFirstHeader()},
  2234. {@link #GetOddHeader()} and
  2235. {@link #GetEvenHeader()}
  2236. </member>
  2237. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.OddFooter">
  2238. Returns the odd footer. Used on all pages unless
  2239. other footers also present, when used on only
  2240. odd pages.
  2241. </member>
  2242. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.EvenFooter">
  2243. Returns the even footer. Not there by default, but
  2244. when Set, used on even pages.
  2245. </member>
  2246. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.FirstFooter">
  2247. Returns the first page footer. Not there by
  2248. default, but when Set, used on the first page.
  2249. </member>
  2250. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.OddHeader">
  2251. Returns the odd header. Used on all pages unless
  2252. other headers also present, when used on only
  2253. odd pages.
  2254. </member>
  2255. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.EvenHeader">
  2256. Returns the even header. Not there by default, but
  2257. when Set, used on even pages.
  2258. </member>
  2259. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.FirstHeader">
  2260. Returns the first page header. Not there by
  2261. default, but when Set, used on the first page.
  2262. </member>
  2263. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.HorizontallyCenter">
  2264. Determine whether printed output for this sheet will be horizontally centered.
  2265. </member>
  2266. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.NumMergedRegions">
  2267. Returns the number of merged regions defined in this worksheet
  2268. @return number of merged regions in this worksheet
  2269. </member>
  2270. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.PaneInformation">
  2271. Returns the information regarding the currently configured pane (split or freeze).
  2272. @return null if no pane configured, or the pane information.
  2273. </member>
  2274. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.PhysicalNumberOfRows">
  2275. Returns the number of phsyically defined rows (NOT the number of rows in the sheet)
  2276. @return the number of phsyically defined rows
  2277. </member>
  2278. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.PrintSetup">
  2279. Gets the print Setup object.
  2280. @return The user model for the print Setup object.
  2281. </member>
  2282. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Protect">
  2283. Answer whether protection is enabled or disabled
  2284. @return true => protection enabled; false => protection disabled
  2285. </member>
  2286. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.RowBreaks">
  2287. Horizontal page break information used for print layout view, page layout view, drawing print breaks in normal
  2288. view, and for printing the worksheet.
  2289. @return row indexes of all the horizontal page breaks, never <code>null</code>
  2290. </member>
  2291. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.RowSumsBelow">
  2292. Flag indicating whether summary rows appear below detail in an outline, when Applying an outline.
  2293. <p>
  2294. When true a summary row is inserted below the detailed data being summarized and a
  2295. new outline level is established on that row.
  2296. </p>
  2297. <p>
  2298. When false a summary row is inserted above the detailed data being summarized and a new outline level
  2299. is established on that row.
  2300. </p>
  2301. @return <code>true</code> if row summaries appear below detail in the outline
  2302. </member>
  2303. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.RowSumsRight">
  2304. Flag indicating whether summary columns appear to the right of detail in an outline, when Applying an outline.
  2305. <p>
  2306. When true a summary column is inserted to the right of the detailed data being summarized
  2307. and a new outline level is established on that column.
  2308. </p>
  2309. <p>
  2310. When false a summary column is inserted to the left of the detailed data being
  2311. summarized and a new outline level is established on that column.
  2312. </p>
  2313. @return <code>true</code> if col summaries appear right of the detail in the outline
  2314. </member>
  2315. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.ScenarioProtect">
  2316. <summary>
  2317. A flag indicating whether scenarios are locked when the sheet is protected.
  2318. </summary>
  2319. </member>
  2320. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.TopRow">
  2321. <summary>
  2322. The top row in the visible view when the sheet is first viewed after opening it in a viewer
  2323. </summary>
  2324. </member>
  2325. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.VerticallyCenter">
  2326. Determine whether printed output for this sheet will be vertically centered.
  2327. @return whether printed output for this sheet will be vertically centered.
  2328. </member>
  2329. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayFormulas">
  2330. Gets the flag indicating whether this sheet should display formulas.
  2331. @return <code>true</code> if this sheet should display formulas.
  2332. </member>
  2333. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayGridlines">
  2334. Gets the flag indicating whether this sheet displays the lines
  2335. between rows and columns to make editing and Reading easier.
  2336. @return <code>true</code> if this sheet displays gridlines.
  2337. @see #isPrintGridlines() to check if printing of gridlines is turned on or off
  2338. </member>
  2339. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayRowColHeadings">
  2340. Gets the flag indicating whether this sheet should display row and column headings.
  2341. <p>
  2342. Row heading are the row numbers to the side of the sheet
  2343. </p>
  2344. <p>
  2345. Column heading are the letters or numbers that appear above the columns of the sheet
  2346. </p>
  2347. @return <code>true</code> if this sheet should display row and column headings.
  2348. </member>
  2349. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsPrintGridlines">
  2350. Returns whether gridlines are printed.
  2351. @return whether gridlines are printed
  2352. </member>
  2353. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.ForceFormulaRecalculation">
  2354. Whether Excel will be asked to recalculate all formulas when the
  2355. workbook is opened.
  2356. </member>
  2357. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Autobreaks">
  2358. Flag indicating whether the sheet displays Automatic Page Breaks.
  2359. @return <code>true</code> if the sheet displays Automatic Page Breaks.
  2360. </member>
  2361. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSelected">
  2362. Returns a flag indicating whether this sheet is selected.
  2363. <p>
  2364. When only 1 sheet is selected and active, this value should be in synch with the activeTab value.
  2365. In case of a conflict, the Start Part Setting wins and Sets the active sheet tab.
  2366. </p>
  2367. Note: multiple sheets can be selected, but only one sheet can be active at one time.
  2368. @return <code>true</code> if this sheet is selected
  2369. </member>
  2370. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.ActiveCell">
  2371. Return location of the active cell, e.g. <code>A1</code>.
  2372. @return the location of the active cell.
  2373. </member>
  2374. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.HasComments">
  2375. Does this sheet have any comments on it? We need to know,
  2376. so we can decide about writing it to disk or not
  2377. </member>
  2378. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsAutoFilterLocked">
  2379. @return true when Autofilters are locked and the sheet is protected.
  2380. </member>
  2381. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsDeleteColumnsLocked">
  2382. @return true when Deleting columns is locked and the sheet is protected.
  2383. </member>
  2384. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsDeleteRowsLocked">
  2385. @return true when Deleting rows is locked and the sheet is protected.
  2386. </member>
  2387. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsFormatCellsLocked">
  2388. @return true when Formatting cells is locked and the sheet is protected.
  2389. </member>
  2390. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsFormatColumnsLocked">
  2391. @return true when Formatting columns is locked and the sheet is protected.
  2392. </member>
  2393. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsFormatRowsLocked">
  2394. @return true when Formatting rows is locked and the sheet is protected.
  2395. </member>
  2396. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsInsertColumnsLocked">
  2397. @return true when Inserting columns is locked and the sheet is protected.
  2398. </member>
  2399. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsInsertHyperlinksLocked">
  2400. @return true when Inserting hyperlinks is locked and the sheet is protected.
  2401. </member>
  2402. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsInsertRowsLocked">
  2403. @return true when Inserting rows is locked and the sheet is protected.
  2404. </member>
  2405. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsPivotTablesLocked">
  2406. @return true when Pivot tables are locked and the sheet is protected.
  2407. </member>
  2408. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSortLocked">
  2409. @return true when Sorting is locked and the sheet is protected.
  2410. </member>
  2411. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsObjectsLocked">
  2412. @return true when Objects are locked and the sheet is protected.
  2413. </member>
  2414. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsScenariosLocked">
  2415. @return true when Scenarios are locked and the sheet is protected.
  2416. </member>
  2417. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSelectLockedCellsLocked">
  2418. @return true when Selection of locked cells is locked and the sheet is protected.
  2419. </member>
  2420. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSelectUnlockedCellsLocked">
  2421. @return true when Selection of unlocked cells is locked and the sheet is protected.
  2422. </member>
  2423. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSheetLocked">
  2424. @return true when Sheet is Protected.
  2425. </member>
  2426. <member name="M:NPOI.XSSF.UserModel.XSSFChartSheet.GetCTChartsheet">
  2427. Provide access to the CTChartsheet bean holding this sheet's data
  2428. @return the CTChartsheet bean holding this sheet's data
  2429. </member>
  2430. <member name="T:NPOI.XSSF.UserModel.XSSFChildAnchor">
  2431. @author Yegor Kozlov
  2432. </member>
  2433. <member name="T:NPOI.XSSF.UserModel.XSSFClientAnchor">
  2434. A client anchor is attached to an excel worksheet. It anchors against
  2435. top-left and bottom-right cells.
  2436. @author Yegor Kozlov
  2437. </member>
  2438. <member name="F:NPOI.XSSF.UserModel.XSSFClientAnchor.cell1">
  2439. Starting anchor point
  2440. </member>
  2441. <member name="F:NPOI.XSSF.UserModel.XSSFClientAnchor.cell2">
  2442. Ending anchor point
  2443. </member>
  2444. <member name="M:NPOI.XSSF.UserModel.XSSFClientAnchor.#ctor">
  2445. Creates a new client anchor and defaults all the anchor positions to 0.
  2446. </member>
  2447. <member name="M:NPOI.XSSF.UserModel.XSSFClientAnchor.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  2448. Creates a new client anchor and Sets the top-left and bottom-right
  2449. coordinates of the anchor.
  2450. @param dx1 the x coordinate within the first cell.
  2451. @param dy1 the y coordinate within the first cell.
  2452. @param dx2 the x coordinate within the second cell.
  2453. @param dy2 the y coordinate within the second cell.
  2454. @param col1 the column (0 based) of the first cell.
  2455. @param row1 the row (0 based) of the first cell.
  2456. @param col2 the column (0 based) of the second cell.
  2457. @param row2 the row (0 based) of the second cell.
  2458. </member>
  2459. <member name="M:NPOI.XSSF.UserModel.XSSFClientAnchor.#ctor(NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Marker,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Marker)">
  2460. Create XSSFClientAnchor from existing xml beans
  2461. @param cell1 starting anchor point
  2462. @param cell2 ending anchor point
  2463. </member>
  2464. <member name="P:NPOI.XSSF.UserModel.XSSFClientAnchor.From">
  2465. Return starting anchor point
  2466. @return starting anchor point
  2467. </member>
  2468. <member name="P:NPOI.XSSF.UserModel.XSSFClientAnchor.To">
  2469. Return ending anchor point
  2470. @return ending anchor point
  2471. </member>
  2472. <member name="T:NPOI.XSSF.UserModel.XSSFColor">
  2473. Represents a color in SpreadsheetML
  2474. </member>
  2475. <member name="M:NPOI.XSSF.UserModel.XSSFColor.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Color)">
  2476. Create an instance of XSSFColor from the supplied XML bean
  2477. </member>
  2478. <member name="M:NPOI.XSSF.UserModel.XSSFColor.#ctor">
  2479. Create an new instance of XSSFColor
  2480. </member>
  2481. <member name="M:NPOI.XSSF.UserModel.XSSFColor.CorrectRGB(System.Byte[])">
  2482. For RGB colours, but not ARGB (we think...)
  2483. Excel Gets black and white the wrong way around, so switch them
  2484. </member>
  2485. <member name="M:NPOI.XSSF.UserModel.XSSFColor.GetRgb">
  2486. Standard Red Green Blue ctColor value (RGB).
  2487. If there was an A (Alpha) value, it will be stripped.
  2488. </member>
  2489. <member name="M:NPOI.XSSF.UserModel.XSSFColor.GetARgb">
  2490. Standard Alpha Red Green Blue ctColor value (ARGB).
  2491. </member>
  2492. <member name="M:NPOI.XSSF.UserModel.XSSFColor.GetRgbWithTint">
  2493. Standard Red Green Blue ctColor value (RGB) with applied tint.
  2494. Alpha values are ignored.
  2495. </member>
  2496. <member name="M:NPOI.XSSF.UserModel.XSSFColor.GetARGBHex">
  2497. Return the ARGB value in hex format, eg FF00FF00.
  2498. Works for both regular and indexed colours.
  2499. </member>
  2500. <member name="M:NPOI.XSSF.UserModel.XSSFColor.SetRgb(System.Byte[])">
  2501. Standard Alpha Red Green Blue ctColor value (ARGB).
  2502. </member>
  2503. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFColor.GetTheme" -->
  2504. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFColor.SetTheme(System.Int32)" -->
  2505. <member name="M:NPOI.XSSF.UserModel.XSSFColor.GetCTColor">
  2506. Returns the underlying XML bean
  2507. @return the underlying XML bean
  2508. </member>
  2509. <member name="P:NPOI.XSSF.UserModel.XSSFColor.IsAuto">
  2510. <summary>
  2511. A bool value indicating the ctColor is automatic and system ctColor dependent.
  2512. </summary>
  2513. </member>
  2514. <member name="P:NPOI.XSSF.UserModel.XSSFColor.Indexed">
  2515. Indexed ctColor value. Only used for backwards compatibility. References a ctColor in indexedColors.
  2516. </member>
  2517. <member name="P:NPOI.XSSF.UserModel.XSSFColor.Tint">
  2518. Specifies the tint value applied to the ctColor.
  2519. <p>
  2520. If tint is supplied, then it is applied to the RGB value of the ctColor to determine the final
  2521. ctColor applied.
  2522. </p>
  2523. <p>
  2524. The tint value is stored as a double from -1.0 .. 1.0, where -1.0 means 100% darken and
  2525. 1.0 means 100% lighten. Also, 0.0 means no Change.
  2526. </p>
  2527. <p>
  2528. In loading the RGB value, it is Converted to HLS where HLS values are (0..HLSMAX), where
  2529. HLSMAX is currently 255.
  2530. </p>
  2531. Here are some examples of how to apply tint to ctColor:
  2532. <blockquote>
  2533. <pre>
  2534. If (tint &lt; 0)
  2535. Lum' = Lum * (1.0 + tint)
  2536. For example: Lum = 200; tint = -0.5; Darken 50%
  2537. Lum' = 200 * (0.5) =&gt; 100
  2538. For example: Lum = 200; tint = -1.0; Darken 100% (make black)
  2539. Lum' = 200 * (1.0-1.0) =&gt; 0
  2540. If (tint &gt; 0)
  2541. Lum' = Lum * (1.0-tint) + (HLSMAX - HLSMAX * (1.0-tint))
  2542. For example: Lum = 100; tint = 0.75; Lighten 75%
  2543. Lum' = 100 * (1-.75) + (HLSMAX - HLSMAX*(1-.75))
  2544. = 100 * .25 + (255 - 255 * .25)
  2545. = 25 + (255 - 63) = 25 + 192 = 217
  2546. For example: Lum = 100; tint = 1.0; Lighten 100% (make white)
  2547. Lum' = 100 * (1-1) + (HLSMAX - HLSMAX*(1-1))
  2548. = 100 * 0 + (255 - 255 * 0)
  2549. = 0 + (255 - 0) = 255
  2550. </pre>
  2551. </blockquote>
  2552. @return the tint value
  2553. </member>
  2554. <member name="F:NPOI.XSSF.UserModel.XSSFComment._str">
  2555. cached reference to the string with the comment text
  2556. </member>
  2557. <member name="M:NPOI.XSSF.UserModel.XSSFComment.#ctor(NPOI.XSSF.Model.CommentsTable,NPOI.OpenXmlFormats.Spreadsheet.CT_Comment,NPOI.OpenXmlFormats.Vml.CT_Shape)">
  2558. Creates a new XSSFComment, associated with a given
  2559. low level comment object.
  2560. </member>
  2561. <member name="M:NPOI.XSSF.UserModel.XSSFComment.SetString(System.String)">
  2562. Sets the rich text string used by this comment.
  2563. @param string the XSSFRichTextString used by this object.
  2564. </member>
  2565. <member name="M:NPOI.XSSF.UserModel.XSSFComment.GetCTComment">
  2566. @return the xml bean holding this comment's properties
  2567. </member>
  2568. <member name="P:NPOI.XSSF.UserModel.XSSFComment.Author">
  2569. @return Name of the original comment author. Default value is blank.
  2570. </member>
  2571. <member name="P:NPOI.XSSF.UserModel.XSSFComment.Column">
  2572. @return the 0-based column of the cell that the comment is associated with.
  2573. </member>
  2574. <member name="P:NPOI.XSSF.UserModel.XSSFComment.Row">
  2575. @return the 0-based row index of the cell that the comment is associated with.
  2576. </member>
  2577. <member name="P:NPOI.XSSF.UserModel.XSSFComment.Visible">
  2578. @return whether the comment is visible
  2579. </member>
  2580. <member name="P:NPOI.XSSF.UserModel.XSSFComment.String">
  2581. @return the rich text string of the comment
  2582. </member>
  2583. <member name="T:NPOI.XSSF.UserModel.XSSFConditionalFormatting">
  2584. @author Yegor Kozlov
  2585. </member>
  2586. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormatting.GetFormattingRanges">
  2587. @return array of <tt>CellRangeAddress</tt>s. Never <code>null</code>
  2588. </member>
  2589. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormatting.SetRule(System.Int32,NPOI.SS.UserModel.IConditionalFormattingRule)">
  2590. Replaces an existing Conditional Formatting rule at position idx.
  2591. Excel allows to create up to 3 Conditional Formatting rules.
  2592. This method can be useful to modify existing Conditional Formatting rules.
  2593. @param idx position of the rule. Should be between 0 and 2.
  2594. @param cfRule - Conditional Formatting rule
  2595. </member>
  2596. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormatting.AddRule(NPOI.SS.UserModel.IConditionalFormattingRule)">
  2597. Add a Conditional Formatting rule.
  2598. Excel allows to create up to 3 Conditional Formatting rules.
  2599. @param cfRule - Conditional Formatting rule
  2600. </member>
  2601. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormatting.GetRule(System.Int32)">
  2602. @return the Conditional Formatting rule at position idx.
  2603. </member>
  2604. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormatting.NumberOfRules">
  2605. @return number of Conditional Formatting rules.
  2606. </member>
  2607. <member name="T:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule">
  2608. @author Yegor Kozlov
  2609. </member>
  2610. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.CreateBorderFormatting">
  2611. Create a new border formatting structure if it does not exist,
  2612. otherwise just return existing object.
  2613. @return - border formatting object, never returns <code>null</code>.
  2614. </member>
  2615. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.GetBorderFormatting">
  2616. @return - border formatting object if defined, <code>null</code> otherwise
  2617. </member>
  2618. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.CreateFontFormatting">
  2619. Create a new font formatting structure if it does not exist,
  2620. otherwise just return existing object.
  2621. @return - font formatting object, never returns <code>null</code>.
  2622. </member>
  2623. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.GetFontFormatting">
  2624. @return - font formatting object if defined, <code>null</code> otherwise
  2625. </member>
  2626. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.CreatePatternFormatting">
  2627. Create a new pattern formatting structure if it does not exist,
  2628. otherwise just return existing object.
  2629. @return - pattern formatting object, never returns <code>null</code>.
  2630. </member>
  2631. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.GetPatternFormatting">
  2632. @return - pattern formatting object if defined, <code>null</code> otherwise
  2633. </member>
  2634. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.ConditionType">
  2635. Type of conditional formatting rule.
  2636. <p>
  2637. MUST be either {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS}
  2638. or {@link ConditionalFormattingRule#CONDITION_TYPE_FORMULA}
  2639. </p>
  2640. @return the type of condition
  2641. </member>
  2642. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.ComparisonOperation">
  2643. The comparison function used when the type of conditional formatting is Set to
  2644. {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS}
  2645. <p>
  2646. MUST be a constant from {@link NPOI.ss.usermodel.ComparisonOperator}
  2647. </p>
  2648. @return the conditional format operator
  2649. </member>
  2650. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.Formula1">
  2651. The formula used to Evaluate the first operand for the conditional formatting rule.
  2652. <p>
  2653. If the condition type is {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS},
  2654. this field is the first operand of the comparison.
  2655. If type is {@link ConditionalFormattingRule#CONDITION_TYPE_FORMULA}, this formula is used
  2656. to determine if the conditional formatting is applied.
  2657. </p>
  2658. <p>
  2659. If comparison type is {@link ConditionalFormattingRule#CONDITION_TYPE_FORMULA} the formula MUST be a Boolean function
  2660. </p>
  2661. @return the first formula
  2662. </member>
  2663. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.Formula2">
  2664. The formula used to Evaluate the second operand of the comparison when
  2665. comparison type is {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS} and operator
  2666. is either {@link NPOI.ss.usermodel.ComparisonOperator#BETWEEN} or {@link NPOI.ss.usermodel.ComparisonOperator#NOT_BETWEEN}
  2667. @return the second formula
  2668. </member>
  2669. <member name="T:NPOI.XSSF.UserModel.XSSFConnector">
  2670. A connection shape Drawing element. A connection shape is a line, etc.
  2671. that connects two other shapes in this Drawing.
  2672. @author Yegor Kozlov
  2673. </member>
  2674. <member name="T:NPOI.XSSF.UserModel.XSSFShape">
  2675. Represents a shape in a SpreadsheetML Drawing.
  2676. @author Yegor Kozlov
  2677. </member>
  2678. <member name="F:NPOI.XSSF.UserModel.XSSFShape.drawing">
  2679. Parent Drawing
  2680. </member>
  2681. <member name="F:NPOI.XSSF.UserModel.XSSFShape.parent">
  2682. The parent shape, always not-null for shapes in groups
  2683. </member>
  2684. <member name="F:NPOI.XSSF.UserModel.XSSFShape.anchor">
  2685. anchor that is used by this shape
  2686. </member>
  2687. <member name="M:NPOI.XSSF.UserModel.XSSFShape.GetDrawing">
  2688. Return the Drawing that owns this shape
  2689. @return the parent Drawing that owns this shape
  2690. </member>
  2691. <member name="M:NPOI.XSSF.UserModel.XSSFShape.GetAnchor">
  2692. @return the anchor that is used by this shape.
  2693. </member>
  2694. <member name="M:NPOI.XSSF.UserModel.XSSFShape.GetShapeProperties">
  2695. Returns xml bean with shape properties.
  2696. @return xml bean with shape properties.
  2697. </member>
  2698. <member name="M:NPOI.XSSF.UserModel.XSSFShape.SetFillColor(System.Int32,System.Int32,System.Int32)">
  2699. Sets the color used to fill this shape using the solid fill pattern.
  2700. </member>
  2701. <member name="M:NPOI.XSSF.UserModel.XSSFShape.SetLineStyleColor(System.Int32,System.Int32,System.Int32)">
  2702. The color applied to the lines of this shape.
  2703. </member>
  2704. <member name="P:NPOI.XSSF.UserModel.XSSFShape.Parent">
  2705. Gets the parent shape.
  2706. </member>
  2707. <member name="P:NPOI.XSSF.UserModel.XSSFShape.IsNoFill">
  2708. Whether this shape is not Filled with a color
  2709. @return true if this shape is not Filled with a color.
  2710. </member>
  2711. <member name="M:NPOI.XSSF.UserModel.XSSFConnector.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Connector)">
  2712. Construct a new XSSFConnector object.
  2713. @param Drawing the XSSFDrawing that owns this shape
  2714. @param ctShape the shape bean that holds all the shape properties
  2715. </member>
  2716. <member name="M:NPOI.XSSF.UserModel.XSSFConnector.Prototype">
  2717. Initialize default structure of a new auto-shape
  2718. </member>
  2719. <member name="P:NPOI.XSSF.UserModel.XSSFConnector.ShapeType">
  2720. Gets the shape type, one of the constants defined in {@link NPOI.ss.usermodel.ShapeTypes}.
  2721. @return the shape type
  2722. @see NPOI.ss.usermodel.ShapeTypes
  2723. </member>
  2724. <member name="M:NPOI.XSSF.UserModel.XSSFCreationHelper.CreateRichTextString(System.String)">
  2725. Creates a new XSSFRichTextString for you.
  2726. </member>
  2727. <member name="M:NPOI.XSSF.UserModel.XSSFCreationHelper.CreateFormulaEvaluator">
  2728. Creates a XSSFFormulaEvaluator, the object that Evaluates formula cells.
  2729. @return a XSSFFormulaEvaluator instance
  2730. </member>
  2731. <member name="M:NPOI.XSSF.UserModel.XSSFCreationHelper.CreateClientAnchor">
  2732. Creates a XSSFClientAnchor. Use this object to position Drawing object in
  2733. a sheet
  2734. @return a XSSFClientAnchor instance
  2735. @see NPOI.ss.usermodel.Drawing
  2736. </member>
  2737. <member name="T:NPOI.XSSF.UserModel.XSSFDataFormat">
  2738. Handles data formats for XSSF.
  2739. </member>
  2740. <member name="M:NPOI.XSSF.UserModel.XSSFDataFormat.GetFormat(System.String)">
  2741. Get the format index that matches the given format
  2742. string, creating a new format entry if required.
  2743. Aliases text to the proper format as required.
  2744. @param format string matching a built in format
  2745. @return index of format.
  2746. </member>
  2747. <member name="M:NPOI.XSSF.UserModel.XSSFDataFormat.GetFormat(System.Int16)">
  2748. Get the format string that matches the given format index
  2749. @param index of a format
  2750. @return string represented at index of format or null if there is not a format at that index
  2751. </member>
  2752. <member name="T:NPOI.XSSF.UserModel.XSSFDataValidation">
  2753. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  2754. </member>
  2755. <member name="T:NPOI.XSSF.UserModel.XSSFDataValidationConstraint">
  2756. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  2757. </member>
  2758. <member name="T:NPOI.XSSF.UserModel.XSSFDataValidationHelper">
  2759. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  2760. </member>
  2761. <member name="T:NPOI.XSSF.UserModel.XSSFDrawing">
  2762. Represents a SpreadsheetML Drawing
  2763. @author Yegor Kozlov
  2764. </member>
  2765. <member name="F:NPOI.XSSF.UserModel.XSSFDrawing.drawing">
  2766. Root element of the SpreadsheetML Drawing part
  2767. </member>
  2768. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.#ctor">
  2769. Create a new SpreadsheetML Drawing
  2770. @see NPOI.xssf.usermodel.XSSFSheet#CreateDrawingPatriarch()
  2771. </member>
  2772. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  2773. Construct a SpreadsheetML Drawing from a namespace part
  2774. @param part the namespace part holding the Drawing data,
  2775. the content type must be <code>application/vnd.openxmlformats-officedocument.Drawing+xml</code>
  2776. @param rel the namespace relationship holding this Drawing,
  2777. the relationship type must be http://schemas.openxmlformats.org/officeDocument/2006/relationships/drawing
  2778. </member>
  2779. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.NewDrawing">
  2780. Construct a new CT_Drawing bean. By default, it's just an empty placeholder for Drawing objects
  2781. @return a new CT_Drawing bean
  2782. </member>
  2783. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.GetCTDrawing">
  2784. Return the underlying CT_Drawing bean, the root element of the SpreadsheetML Drawing part.
  2785. @return the underlying CT_Drawing bean
  2786. </member>
  2787. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateTextbox(NPOI.SS.UserModel.IClientAnchor)">
  2788. Constructs a textbox under the Drawing.
  2789. @param anchor the client anchor describes how this group is attached
  2790. to the sheet.
  2791. @return the newly Created textbox.
  2792. </member>
  2793. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreatePicture(NPOI.XSSF.UserModel.XSSFClientAnchor,System.Int32)">
  2794. Creates a picture.
  2795. @param anchor the client anchor describes how this picture is attached to the sheet.
  2796. @param pictureIndex the index of the picture in the workbook collection of pictures,
  2797. {@link NPOI.xssf.usermodel.XSSFWorkbook#getAllPictures()} .
  2798. @return the newly Created picture shape.
  2799. </member>
  2800. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateChart(NPOI.SS.UserModel.IClientAnchor)">
  2801. <summary>
  2802. Creates a chart.
  2803. </summary>
  2804. <param name="anchor">the client anchor describes how this chart is attached to</param>
  2805. <returns>the newly created chart</returns>
  2806. </member>
  2807. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.AddPictureReference(System.Int32)">
  2808. Add the indexed picture to this Drawing relations
  2809. @param pictureIndex the index of the picture in the workbook collection of pictures,
  2810. {@link NPOI.xssf.usermodel.XSSFWorkbook#getAllPictures()} .
  2811. </member>
  2812. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateSimpleShape(NPOI.XSSF.UserModel.XSSFClientAnchor)">
  2813. Creates a simple shape. This includes such shapes as lines, rectangles,
  2814. and ovals.
  2815. @param anchor the client anchor describes how this group is attached
  2816. to the sheet.
  2817. @return the newly Created shape.
  2818. </member>
  2819. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateConnector(NPOI.XSSF.UserModel.XSSFClientAnchor)">
  2820. Creates a simple shape. This includes such shapes as lines, rectangles,
  2821. and ovals.
  2822. @param anchor the client anchor describes how this group is attached
  2823. to the sheet.
  2824. @return the newly Created shape.
  2825. </member>
  2826. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateGroup(NPOI.XSSF.UserModel.XSSFClientAnchor)">
  2827. Creates a simple shape. This includes such shapes as lines, rectangles,
  2828. and ovals.
  2829. @param anchor the client anchor describes how this group is attached
  2830. to the sheet.
  2831. @return the newly Created shape.
  2832. </member>
  2833. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateCellComment(NPOI.SS.UserModel.IClientAnchor)">
  2834. Creates a comment.
  2835. @param anchor the client anchor describes how this comment is attached
  2836. to the sheet.
  2837. @return the newly Created comment.
  2838. </member>
  2839. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateGraphicFrame(NPOI.XSSF.UserModel.XSSFClientAnchor)">
  2840. Creates a new graphic frame.
  2841. @param anchor the client anchor describes how this frame is attached
  2842. to the sheet
  2843. @return the newly Created graphic frame
  2844. </member>
  2845. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.GetCharts">
  2846. Returns all charts in this Drawing.
  2847. </member>
  2848. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateTwoCellAnchor(NPOI.SS.UserModel.IClientAnchor)">
  2849. Create and Initialize a CT_TwoCellAnchor that anchors a shape against top-left and bottom-right cells.
  2850. @return a new CT_TwoCellAnchor
  2851. </member>
  2852. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.GetShapes">
  2853. @return list of shapes in this drawing
  2854. </member>
  2855. <member name="T:NPOI.XSSF.UserModel.XSSFEvaluationCell">
  2856. XSSF wrapper for a cell under Evaluation
  2857. @author Josh Micich
  2858. </member>
  2859. <member name="T:NPOI.XSSF.UserModel.XSSFEvaluationSheet">
  2860. XSSF wrapper for a sheet under Evaluation
  2861. @author Josh Micich
  2862. </member>
  2863. <member name="T:NPOI.XSSF.UserModel.XSSFEvaluationWorkbook">
  2864. Internal POI use only
  2865. @author Josh Micich
  2866. </member>
  2867. <member name="M:NPOI.XSSF.UserModel.XSSFEvaluationWorkbook.ConvertFromExternSheetIndex(System.Int32)">
  2868. @return the sheet index of the sheet with the given external index.
  2869. </member>
  2870. <member name="M:NPOI.XSSF.UserModel.XSSFEvaluationWorkbook.ConvertToExternalSheetIndex(System.Int32)">
  2871. @return the external sheet index of the sheet with the given internal
  2872. index. Used by some of the more obscure formula and named range things.
  2873. Fairly easy on XSSF (we think...) since the internal and external
  2874. indicies are the same
  2875. </member>
  2876. <member name="M:NPOI.XSSF.UserModel.XSSFEvaluationWorkbook.CleanXSSFFormulaText(System.String)">
  2877. XSSF allows certain extra textual characters in the formula that
  2878. HSSF does not. As these can't be composed down to HSSF-compatible
  2879. Ptgs, this method strips them out for us.
  2880. </member>
  2881. <member name="T:NPOI.XSSF.UserModel.XSSFEvenFooter">
  2882. Even page footer value. Corresponds to even printed pages.
  2883. Even page(s) in the sheet may not be printed, for example, if the print area is specified to be
  2884. a range such that it falls outside an even page's scope.
  2885. If no even footer is specified, then the odd footer's value is assumed for even page footers.
  2886. </member>
  2887. <member name="M:NPOI.XSSF.UserModel.XSSFEvenFooter.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  2888. Create an instance of XSSFEvenFooter from the supplied XML bean
  2889. @see XSSFSheet#GetEvenFooter()
  2890. @param headerFooter
  2891. </member>
  2892. <member name="P:NPOI.XSSF.UserModel.XSSFEvenFooter.Text">
  2893. Get the content text representing the footer
  2894. @return text
  2895. </member>
  2896. <member name="T:NPOI.XSSF.UserModel.XSSFEvenHeader">
  2897. <p>
  2898. Even page header value. Corresponds to even printed pages.
  2899. Even page(s) in the sheet may not be printed, for example, if the print area is specified to be
  2900. a range such that it falls outside an even page's scope.
  2901. If no even header is specified, then odd header value is assumed for even page headers.
  2902. </p>
  2903. </member>
  2904. <member name="M:NPOI.XSSF.UserModel.XSSFEvenHeader.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  2905. Create an instance of XSSFEvenHeader from the supplied XML bean
  2906. @see XSSFSheet#GetEvenHeader()
  2907. @param headerFooter
  2908. </member>
  2909. <member name="P:NPOI.XSSF.UserModel.XSSFEvenHeader.Text">
  2910. Get the content text representing this header
  2911. @return text
  2912. </member>
  2913. <member name="T:NPOI.XSSF.UserModel.XSSFFactory">
  2914. Instantiates sub-classes of POIXMLDocumentPart depending on their relationship type
  2915. @author Yegor Kozlov
  2916. </member>
  2917. <member name="T:NPOI.XSSF.UserModel.XSSFFirstFooter">
  2918. First page footer content. Corresponds to first printed page.
  2919. The first logical page in the sheet may not be printed, for example, if the print area is specified to
  2920. be a range such that it falls outside the first page's scope.
  2921. </member>
  2922. <member name="M:NPOI.XSSF.UserModel.XSSFFirstFooter.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  2923. Create an instance of XSSFFirstFooter from the supplied XML bean
  2924. @see XSSFSheet#getFirstFooter()
  2925. @param headerFooter
  2926. </member>
  2927. <member name="P:NPOI.XSSF.UserModel.XSSFFirstFooter.Text">
  2928. Get the content text representing the footer
  2929. @return text
  2930. </member>
  2931. <member name="T:NPOI.XSSF.UserModel.XSSFFirstHeader">
  2932. First page header content. Corresponds to first printed page.
  2933. The first logical page in the sheet may not be printed, for example, if the print area is specified to
  2934. be a range such that it falls outside the first page's scope.
  2935. </member>
  2936. <member name="M:NPOI.XSSF.UserModel.XSSFFirstHeader.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  2937. Create an instance of XSSFFirstHeader from the supplied XML bean
  2938. @see XSSFSheet#getFirstHeader()
  2939. @param headerFooter
  2940. </member>
  2941. <member name="P:NPOI.XSSF.UserModel.XSSFFirstHeader.Text">
  2942. Get the content text representing this header
  2943. @return text
  2944. </member>
  2945. <member name="T:NPOI.XSSF.UserModel.XSSFFont">
  2946. Represents a font used in a workbook.
  2947. @author Gisella Bronzetti
  2948. </member>
  2949. <member name="F:NPOI.XSSF.UserModel.XSSFFont.DEFAULT_FONT_NAME">
  2950. By default, Microsoft Office Excel 2007 uses the Calibry font in font size 11
  2951. </member>
  2952. <member name="F:NPOI.XSSF.UserModel.XSSFFont.DEFAULT_FONT_SIZE">
  2953. By default, Microsoft Office Excel 2007 uses the Calibry font in font size 11
  2954. </member>
  2955. <member name="F:NPOI.XSSF.UserModel.XSSFFont.DEFAULT_FONT_COLOR">
  2956. Default font color is black
  2957. @see NPOI.SS.usermodel.IndexedColors#BLACK
  2958. </member>
  2959. <member name="M:NPOI.XSSF.UserModel.XSSFFont.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Font)">
  2960. Create a new XSSFFont
  2961. @param font the underlying CT_Font bean
  2962. </member>
  2963. <member name="M:NPOI.XSSF.UserModel.XSSFFont.#ctor">
  2964. Create a new XSSFont. This method is protected to be used only by XSSFWorkbook
  2965. </member>
  2966. <member name="M:NPOI.XSSF.UserModel.XSSFFont.GetCTFont">
  2967. get the underlying CT_Font font
  2968. </member>
  2969. <member name="M:NPOI.XSSF.UserModel.XSSFFont.GetXSSFColor">
  2970. get the color value for the font
  2971. References a color defined as Standard Alpha Red Green Blue color value (ARGB).
  2972. @return XSSFColor - rgb color to use
  2973. </member>
  2974. <member name="M:NPOI.XSSF.UserModel.XSSFFont.GetThemeColor">
  2975. get the color value for the font
  2976. References a color defined in theme.
  2977. @return short - theme defined to use
  2978. </member>
  2979. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetCharSet(System.Byte)">
  2980. set character-set to use.
  2981. @param charset - charset
  2982. @see FontCharset
  2983. </member>
  2984. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetCharSet(System.Int32)">
  2985. set character-set to use.
  2986. @param charset - charset
  2987. @see FontCharset
  2988. </member>
  2989. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetCharSet(NPOI.SS.UserModel.FontCharset)">
  2990. set character-set to use.
  2991. @param charSet
  2992. </member>
  2993. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetColor(NPOI.XSSF.UserModel.XSSFColor)">
  2994. set the color for the font in Standard Alpha Red Green Blue color value
  2995. @param color - color to use
  2996. </member>
  2997. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetThemeColor(System.Int16)">
  2998. set the theme color for the font to use
  2999. @param theme - theme color to use
  3000. </member>
  3001. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetUnderline(NPOI.SS.UserModel.FontUnderlineType)">
  3002. set an enumeration representing the style of underlining that is used.
  3003. The none style is equivalent to not using underlining at all.
  3004. The possible values for this attribute are defined by the FontUnderline
  3005. @param underline - FontUnderline enum value
  3006. </member>
  3007. <member name="M:NPOI.XSSF.UserModel.XSSFFont.RegisterTo(NPOI.XSSF.Model.StylesTable)">
  3008. **
  3009. </member>
  3010. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetThemesTable(NPOI.XSSF.Model.ThemesTable)">
  3011. Records the Themes Table that is associated with
  3012. the current font, used when looking up theme
  3013. based colours and properties.
  3014. </member>
  3015. <member name="M:NPOI.XSSF.UserModel.XSSFFont.GetScheme">
  3016. get the font scheme property.
  3017. is used only in StylesTable to create the default instance of font
  3018. @return FontScheme
  3019. @see NPOI.XSSF.model.StylesTable#CreateDefaultFont()
  3020. </member>
  3021. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetScheme(NPOI.SS.UserModel.FontScheme)">
  3022. set font scheme property
  3023. @param scheme - FontScheme enum value
  3024. @see FontScheme
  3025. </member>
  3026. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetFamily(NPOI.SS.UserModel.FontFamily)">
  3027. set an enumeration representing the font family this font belongs to.
  3028. A font family is a set of fonts having common stroke width and serif characteristics.
  3029. @param family font family
  3030. @link #SetFamily(int value)
  3031. </member>
  3032. <member name="P:NPOI.XSSF.UserModel.XSSFFont.IsBold">
  3033. get a bool value for the boldness to use.
  3034. @return bool - bold
  3035. </member>
  3036. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Charset">
  3037. get character-set to use.
  3038. @return int - character-set (0-255)
  3039. @see NPOI.SS.usermodel.FontCharset
  3040. </member>
  3041. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Color">
  3042. get the indexed color value for the font
  3043. References a color defined in IndexedColors.
  3044. @return short - indexed color to use
  3045. @see IndexedColors
  3046. </member>
  3047. <member name="P:NPOI.XSSF.UserModel.XSSFFont.FontHeight">
  3048. get the font height in point.
  3049. @return short - height in point
  3050. </member>
  3051. <member name="P:NPOI.XSSF.UserModel.XSSFFont.FontHeightInPoints">
  3052. @see #GetFontHeight()
  3053. </member>
  3054. <member name="P:NPOI.XSSF.UserModel.XSSFFont.FontName">
  3055. get the name of the font (i.e. Arial)
  3056. @return String - a string representing the name of the font to use
  3057. </member>
  3058. <member name="P:NPOI.XSSF.UserModel.XSSFFont.IsItalic">
  3059. get a bool value that specify whether to use italics or not
  3060. @return bool - value for italic
  3061. </member>
  3062. <member name="P:NPOI.XSSF.UserModel.XSSFFont.IsStrikeout">
  3063. get a bool value that specify whether to use a strikeout horizontal line through the text or not
  3064. @return bool - value for strikeout
  3065. </member>
  3066. <member name="P:NPOI.XSSF.UserModel.XSSFFont.TypeOffset">
  3067. get normal,super or subscript.
  3068. @return short - offset type to use (none,super,sub)
  3069. @see Font#SS_NONE
  3070. @see Font#SS_SUPER
  3071. @see Font#SS_SUB
  3072. </member>
  3073. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Underline">
  3074. get type of text underlining to use
  3075. @return byte - underlining type
  3076. @see NPOI.SS.usermodel.FontUnderline
  3077. </member>
  3078. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Boldweight">
  3079. get the boldness to use
  3080. @return boldweight
  3081. @see #BOLDWEIGHT_NORMAL
  3082. @see #BOLDWEIGHT_BOLD
  3083. </member>
  3084. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Family">
  3085. get the font family to use.
  3086. @return the font family to use
  3087. @see NPOI.SS.usermodel.FontFamily
  3088. </member>
  3089. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Index">
  3090. get the index within the XSSFWorkbook (sequence within the collection of Font objects)
  3091. @return unique index number of the underlying record this Font represents (probably you don't care
  3092. unless you're comparing which one is which)
  3093. </member>
  3094. <member name="T:NPOI.XSSF.UserModel.XSSFFontFormatting">
  3095. @author Yegor Kozlov
  3096. </member>
  3097. <member name="M:NPOI.XSSF.UserModel.XSSFFontFormatting.GetXSSFColor">
  3098. @return xssf color wrapper or null if color info is missing
  3099. </member>
  3100. <member name="M:NPOI.XSSF.UserModel.XSSFFontFormatting.SetFontStyle(System.Boolean,System.Boolean)">
  3101. Set font style options.
  3102. @param italic - if true, Set posture style to italic, otherwise to normal
  3103. @param bold if true, Set font weight to bold, otherwise to normal
  3104. </member>
  3105. <member name="M:NPOI.XSSF.UserModel.XSSFFontFormatting.ResetFontStyle">
  3106. Set font style options to default values (non-italic, non-bold)
  3107. </member>
  3108. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.EscapementType">
  3109. Get the type of super or subscript for the font
  3110. @return super or subscript option
  3111. @see #SS_NONE
  3112. @see #SS_SUPER
  3113. @see #SS_SUB
  3114. </member>
  3115. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.FontColorIndex">
  3116. @return font color index
  3117. </member>
  3118. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.FontHeight">
  3119. Gets the height of the font in 1/20th point units
  3120. @return fontheight (in points/20); or -1 if not modified
  3121. </member>
  3122. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.UnderlineType">
  3123. Get the type of underlining for the font
  3124. @return font underlining type
  3125. @see #U_NONE
  3126. @see #U_SINGLE
  3127. @see #U_DOUBLE
  3128. @see #U_SINGLE_ACCOUNTING
  3129. @see #U_DOUBLE_ACCOUNTING
  3130. </member>
  3131. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.IsBold">
  3132. Get whether the font weight is Set to bold or not
  3133. @return bold - whether the font is bold or not
  3134. </member>
  3135. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.IsItalic">
  3136. @return true if font style was Set to <i>italic</i>
  3137. </member>
  3138. <member name="T:NPOI.XSSF.UserModel.XSSFFormulaEvaluator">
  3139. Evaluates formula cells.<p/>
  3140. For performance reasons, this class keeps a cache of all previously calculated intermediate
  3141. cell values. Be sure to call {@link #ClearAllCachedResultValues()} if any workbook cells are Changed between
  3142. calls to Evaluate~ methods on this class.
  3143. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  3144. @author Josh Micich
  3145. </member>
  3146. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.#ctor(NPOI.XSSF.UserModel.XSSFWorkbook,NPOI.SS.Formula.IStabilityClassifier)">
  3147. @param stabilityClassifier used to optimise caching performance. Pass <code>null</code>
  3148. for the (conservative) assumption that any cell may have its defInition Changed After
  3149. Evaluation begins.
  3150. @deprecated (Sep 2009) (reduce overloading) use {@link #Create(XSSFWorkbook, NPOI.ss.formula.IStabilityClassifier, NPOI.ss.formula.udf.UDFFinder)}
  3151. </member>
  3152. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.Create(NPOI.XSSF.UserModel.XSSFWorkbook,NPOI.SS.Formula.IStabilityClassifier,NPOI.SS.Formula.Udf.UDFFinder)">
  3153. @param stabilityClassifier used to optimise caching performance. Pass <code>null</code>
  3154. for the (conservative) assumption that any cell may have its defInition Changed After
  3155. Evaluation begins.
  3156. @param udfFinder pass <code>null</code> for default (AnalysisToolPak only)
  3157. </member>
  3158. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.ClearAllCachedResultValues">
  3159. Should be called whenever there are major Changes (e.g. moving sheets) to input cells
  3160. in the Evaluated workbook.
  3161. Failure to call this method After changing cell values will cause incorrect behaviour
  3162. of the Evaluate~ methods of this class
  3163. </member>
  3164. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.Evaluate(NPOI.SS.UserModel.ICell)">
  3165. If cell Contains a formula, the formula is Evaluated and returned,
  3166. else the CellValue simply copies the appropriate cell value from
  3167. the cell and also its cell type. This method should be preferred over
  3168. EvaluateInCell() when the call should not modify the contents of the
  3169. original cell.
  3170. @param cell
  3171. </member>
  3172. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.EvaluateFormulaCell(NPOI.SS.UserModel.ICell)">
  3173. If cell Contains formula, it Evaluates the formula,
  3174. and saves the result of the formula. The cell
  3175. remains as a formula cell.
  3176. Else if cell does not contain formula, this method leaves
  3177. the cell unChanged.
  3178. Note that the type of the formula result is returned,
  3179. so you know what kind of value is also stored with
  3180. the formula.
  3181. <pre>
  3182. int EvaluatedCellType = Evaluator.EvaluateFormulaCell(cell);
  3183. </pre>
  3184. Be aware that your cell will hold both the formula,
  3185. and the result. If you want the cell Replaced with
  3186. the result of the formula, use {@link #Evaluate(NPOI.ss.usermodel.Cell)} }
  3187. @param cell The cell to Evaluate
  3188. @return The type of the formula result (the cell's type remains as HSSFCell.CELL_TYPE_FORMULA however)
  3189. </member>
  3190. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.EvaluateInCell(NPOI.SS.UserModel.ICell)">
  3191. If cell Contains formula, it Evaluates the formula, and
  3192. Puts the formula result back into the cell, in place
  3193. of the old formula.
  3194. Else if cell does not contain formula, this method leaves
  3195. the cell unChanged.
  3196. Note that the same instance of HSSFCell is returned to
  3197. allow chained calls like:
  3198. <pre>
  3199. int EvaluatedCellType = Evaluator.EvaluateInCell(cell).CellType;
  3200. </pre>
  3201. Be aware that your cell value will be Changed to hold the
  3202. result of the formula. If you simply want the formula
  3203. value computed for you, use {@link #EvaluateFormulaCell(NPOI.ss.usermodel.Cell)} }
  3204. @param cell
  3205. </member>
  3206. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.EvaluateAllFormulaCells(NPOI.SS.UserModel.IWorkbook)">
  3207. Loops over all cells in all sheets of the supplied
  3208. workbook.
  3209. For cells that contain formulas, their formulas are
  3210. Evaluated, and the results are saved. These cells
  3211. remain as formula cells.
  3212. For cells that do not contain formulas, no Changes
  3213. are made.
  3214. This is a helpful wrapper around looping over all
  3215. cells, and calling EvaluateFormulaCell on each one.
  3216. </member>
  3217. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.EvaluateAll">
  3218. Loops over all cells in all sheets of the supplied
  3219. workbook.
  3220. For cells that contain formulas, their formulas are
  3221. Evaluated, and the results are saved. These cells
  3222. remain as formula cells.
  3223. For cells that do not contain formulas, no Changes
  3224. are made.
  3225. This is a helpful wrapper around looping over all
  3226. cells, and calling EvaluateFormulaCell on each one.
  3227. </member>
  3228. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.EvaluateFormulaCellValue(NPOI.SS.UserModel.ICell)">
  3229. Returns a CellValue wrapper around the supplied ValueEval instance.
  3230. </member>
  3231. <member name="T:NPOI.XSSF.UserModel.XSSFGraphicFrame">
  3232. Represents DrawingML GraphicalObjectFrame.
  3233. @author Roman Kashitsyn
  3234. </member>
  3235. <member name="M:NPOI.XSSF.UserModel.XSSFGraphicFrame.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_GraphicalObjectFrame)">
  3236. Construct a new XSSFGraphicFrame object.
  3237. @param Drawing the XSSFDrawing that owns this frame
  3238. @param ctGraphicFrame the XML bean that stores this frame content
  3239. </member>
  3240. <member name="M:NPOI.XSSF.UserModel.XSSFGraphicFrame.Prototype">
  3241. Initialize default structure of a new graphic frame
  3242. </member>
  3243. <member name="M:NPOI.XSSF.UserModel.XSSFGraphicFrame.SetMacro(System.String)">
  3244. Sets the frame macro.
  3245. </member>
  3246. <member name="M:NPOI.XSSF.UserModel.XSSFGraphicFrame.SetChart(NPOI.XSSF.UserModel.XSSFChart,System.String)">
  3247. Assign a DrawingML chart to the graphic frame.
  3248. </member>
  3249. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFGraphicFrame.AppendChartElement(NPOI.OpenXmlFormats.Dml.CT_GraphicalObjectData,System.String)" -->
  3250. <member name="P:NPOI.XSSF.UserModel.XSSFGraphicFrame.Name">
  3251. Returns the frame name.
  3252. @return name of the frame
  3253. </member>
  3254. <member name="P:NPOI.XSSF.UserModel.XSSFGraphicFrame.Anchor">
  3255. Returns the frame anchor.
  3256. @return the anchor this frame is attached to
  3257. </member>
  3258. <member name="P:NPOI.XSSF.UserModel.XSSFGraphicFrame.Id">
  3259. Gets the frame id.
  3260. </member>
  3261. <member name="T:NPOI.XSSF.UserModel.XSSFMap">
  3262. This class : the Map element (Open Office XML Part 4:
  3263. chapter 3.16.2)
  3264. This element Contains all of the properties related to the XML map,
  3265. and the behaviors expected during data refresh operations.
  3266. @author Roberto Manicardi
  3267. </member>
  3268. <member name="M:NPOI.XSSF.UserModel.XSSFMap.GetRelatedSingleXMLCell">
  3269. @return the list of Single Xml Cells that provide a map rule to this mapping.
  3270. </member>
  3271. <member name="M:NPOI.XSSF.UserModel.XSSFMap.GetRelatedTables">
  3272. @return the list of all Tables that provide a map rule to this mapping
  3273. </member>
  3274. <member name="T:NPOI.XSSF.UserModel.XSSFName">
  3275. Represents a defined named range in a SpreadsheetML workbook.
  3276. <p>
  3277. Defined names are descriptive text that is used to represents a cell, range of cells, formula, or constant value.
  3278. Use easy-to-understand names, such as Products, to refer to hard to understand ranges, such as <code>Sales!C20:C30</code>.
  3279. </p>
  3280. Example:
  3281. <pre><blockquote>
  3282. XSSFWorkbook wb = new XSSFWorkbook();
  3283. XSSFSheet sh = wb.CreateSheet("Sheet1");
  3284. //applies to the entire workbook
  3285. XSSFName name1 = wb.CreateName();
  3286. name1.SetNameName("FMLA");
  3287. name1.SetRefersToFormula("Sheet1!$B$3");
  3288. //applies to Sheet1
  3289. XSSFName name2 = wb.CreateName();
  3290. name2.SetNameName("SheetLevelName");
  3291. name2.SetComment("This name is scoped to Sheet1");
  3292. name2.SetLocalSheetId(0);
  3293. name2.SetRefersToFormula("Sheet1!$B$3");
  3294. </blockquote></pre>
  3295. @author Nick Burch
  3296. @author Yegor Kozlov
  3297. </member>
  3298. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_PRINT_AREA">
  3299. A built-in defined name that specifies the workbook's print area
  3300. </member>
  3301. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_PRINT_TITLE">
  3302. A built-in defined name that specifies the row(s) or column(s) to repeat
  3303. at the top of each printed page.
  3304. </member>
  3305. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_CRITERIA">
  3306. A built-in defined name that refers to a range Containing the criteria values
  3307. to be used in Applying an advanced filter to a range of data
  3308. </member>
  3309. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_EXTRACT">
  3310. this defined name refers to the range Containing the filtered
  3311. output values resulting from Applying an advanced filter criteria to a source
  3312. range
  3313. </member>
  3314. <!-- Badly formed XML comment ignored for member "F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_FILTER_DB" -->
  3315. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_CONSOLIDATE_AREA">
  3316. A built-in defined name that refers to a consolidation area
  3317. </member>
  3318. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_DATABASE">
  3319. A built-in defined name that specified that the range specified is from a database data source
  3320. </member>
  3321. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_SHEET_TITLE">
  3322. A built-in defined name that refers to a sheet title.
  3323. </member>
  3324. <member name="M:NPOI.XSSF.UserModel.XSSFName.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_DefinedName,NPOI.XSSF.UserModel.XSSFWorkbook)">
  3325. Creates an XSSFName object - called internally by XSSFWorkbook.
  3326. @param name - the xml bean that holds data represenring this defined name.
  3327. @param workbook - the workbook object associated with the name
  3328. @see NPOI.XSSF.usermodel.XSSFWorkbook#CreateName()
  3329. </member>
  3330. <member name="M:NPOI.XSSF.UserModel.XSSFName.GetCTName">
  3331. Returns the underlying named range object
  3332. </member>
  3333. <member name="M:NPOI.XSSF.UserModel.XSSFName.Equals(System.Object)">
  3334. Compares this name to the specified object.
  3335. The result is <code>true</code> if the argument is XSSFName and the
  3336. underlying CTDefinedName bean Equals to the CTDefinedName representing this name
  3337. @param o the object to compare this <code>XSSFName</code> against.
  3338. @return <code>true</code> if the <code>XSSFName </code>are Equal;
  3339. <code>false</code> otherwise.
  3340. </member>
  3341. <member name="P:NPOI.XSSF.UserModel.XSSFName.NameName">
  3342. Returns the name that will appear in the user interface for the defined name.
  3343. @return text name of this defined name
  3344. </member>
  3345. <member name="P:NPOI.XSSF.UserModel.XSSFName.SheetIndex">
  3346. Returns the sheet index this name applies to.
  3347. @return the sheet index this name applies to, -1 if this name applies to the entire workbook
  3348. </member>
  3349. <member name="P:NPOI.XSSF.UserModel.XSSFName.Function">
  3350. Indicates that the defined name refers to a user-defined function.
  3351. This attribute is used when there is an Add-in or other code project associated with the file.
  3352. @return <code>true</code> indicates the name refers to a function.
  3353. </member>
  3354. <member name="P:NPOI.XSSF.UserModel.XSSFName.FunctionGroupId">
  3355. Returns the function group index if the defined name refers to a function. The function
  3356. group defines the general category for the function. This attribute is used when there is
  3357. an Add-in or other code project associated with the file.
  3358. @return the function group index that defines the general category for the function
  3359. </member>
  3360. <member name="P:NPOI.XSSF.UserModel.XSSFName.SheetName">
  3361. Get the sheets name which this named range is referenced to
  3362. @return sheet name, which this named range referred to.
  3363. Empty string if the referenced sheet name weas not found.
  3364. </member>
  3365. <member name="P:NPOI.XSSF.UserModel.XSSFName.IsFunctionName">
  3366. Is the name refers to a user-defined function ?
  3367. @return <code>true</code> if this name refers to a user-defined function
  3368. </member>
  3369. <member name="P:NPOI.XSSF.UserModel.XSSFName.Comment">
  3370. Returns the comment the user provided when the name was Created.
  3371. @return the user comment for this named range
  3372. </member>
  3373. <member name="T:NPOI.XSSF.UserModel.XSSFHyperlink">
  3374. XSSF Implementation of a Hyperlink.
  3375. Note - unlike with HSSF, many kinds of hyperlink
  3376. are largely stored as relations of the sheet
  3377. </member>
  3378. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.#ctor(NPOI.SS.UserModel.HyperlinkType)">
  3379. Create a new XSSFHyperlink. This method is protected to be used only by XSSFCreationHelper
  3380. @param type - the type of hyperlink to create
  3381. </member>
  3382. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Hyperlink,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  3383. Create a XSSFHyperlink amd Initialize it from the supplied CTHyperlink bean and namespace relationship
  3384. @param ctHyperlink the xml bean Containing xml properties
  3385. @param hyperlinkRel the relationship in the underlying OPC namespace which stores the actual link's Address
  3386. </member>
  3387. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.GetCTHyperlink">
  3388. @return the underlying CTHyperlink object
  3389. </member>
  3390. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.NeedsRelationToo">
  3391. Do we need to a relation too, to represent
  3392. this hyperlink?
  3393. </member>
  3394. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.GenerateRelationIfNeeded(NPOI.OpenXml4Net.OPC.PackagePart)">
  3395. Generates the relation if required
  3396. </member>
  3397. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.GetCellRef">
  3398. Get the reference of the cell this applies to,
  3399. es A55
  3400. </member>
  3401. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.SetCellReference(System.String)">
  3402. Assigns this hyperlink to the given cell reference
  3403. </member>
  3404. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Type">
  3405. Return the type of this hyperlink
  3406. @return the type of this hyperlink
  3407. </member>
  3408. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Address">
  3409. Hyperlink Address. Depending on the hyperlink type it can be URL, e-mail, path to a file
  3410. @return the Address of this hyperlink
  3411. </member>
  3412. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Label">
  3413. Return text label for this hyperlink
  3414. @return text to display
  3415. </member>
  3416. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Location">
  3417. Location within target. If target is a workbook (or this workbook) this shall refer to a
  3418. sheet and cell or a defined name. Can also be an HTML anchor if target is HTML file.
  3419. @return location
  3420. </member>
  3421. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.FirstColumn">
  3422. Return the column of the first cell that Contains the hyperlink
  3423. @return the 0-based column of the first cell that Contains the hyperlink
  3424. </member>
  3425. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.LastColumn">
  3426. Return the column of the last cell that Contains the hyperlink
  3427. @return the 0-based column of the last cell that Contains the hyperlink
  3428. </member>
  3429. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.FirstRow">
  3430. Return the row of the first cell that Contains the hyperlink
  3431. @return the 0-based row of the cell that Contains the hyperlink
  3432. </member>
  3433. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.LastRow">
  3434. Return the row of the last cell that Contains the hyperlink
  3435. @return the 0-based row of the last cell that Contains the hyperlink
  3436. </member>
  3437. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Tooltip">
  3438. <summary>
  3439. get or set additional text to help the user understand more about the hyperlink
  3440. </summary>
  3441. </member>
  3442. <member name="T:NPOI.XSSF.UserModel.XSSFOddFooter">
  3443. Odd page footer value. Corresponds to odd printed pages.
  3444. Odd page(s) in the sheet may not be printed, for example, if the print area is specified to be
  3445. a range such that it falls outside an odd page's scope.
  3446. </member>
  3447. <member name="M:NPOI.XSSF.UserModel.XSSFOddFooter.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  3448. Create an instance of XSSFOddFooter from the supplied XML bean
  3449. @see XSSFSheet#GetOddFooter()
  3450. @param headerFooter
  3451. </member>
  3452. <member name="P:NPOI.XSSF.UserModel.XSSFOddFooter.Text">
  3453. Get the content text representing the footer
  3454. @return text
  3455. </member>
  3456. <member name="T:NPOI.XSSF.UserModel.XSSFOddHeader">
  3457. Odd page header value. Corresponds to odd printed pages.
  3458. Odd page(s) in the sheet may not be printed, for example, if the print area is specified to be
  3459. a range such that it falls outside an odd page's scope.
  3460. </member>
  3461. <member name="M:NPOI.XSSF.UserModel.XSSFOddHeader.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  3462. Create an instance of XSSFOddHeader from the supplied XML bean
  3463. @see XSSFSheet#GetOddHeader()
  3464. @param headerFooter
  3465. </member>
  3466. <member name="P:NPOI.XSSF.UserModel.XSSFOddHeader.Text">
  3467. Get the content text representing this header
  3468. @return text
  3469. </member>
  3470. <member name="T:NPOI.XSSF.UserModel.XSSFPatternFormatting">
  3471. @author Yegor Kozlov
  3472. </member>
  3473. <member name="T:NPOI.XSSF.UserModel.XSSFPicture">
  3474. Represents a picture shape in a SpreadsheetML Drawing.
  3475. @author Yegor Kozlov
  3476. </member>
  3477. <member name="F:NPOI.XSSF.UserModel.XSSFPicture.DEFAULT_COLUMN_WIDTH">
  3478. Column width measured as the number of characters of the maximum digit width of the
  3479. numbers 0, 1, 2, ..., 9 as rendered in the normal style's font. There are 4 pixels of margin
  3480. pAdding (two on each side), plus 1 pixel pAdding for the gridlines.
  3481. This value is the same for default font in Office 2007 (Calibry) and Office 2003 and earlier (Arial)
  3482. </member>
  3483. <member name="F:NPOI.XSSF.UserModel.XSSFPicture.prototype">
  3484. A default instance of CTShape used for creating new shapes.
  3485. </member>
  3486. <member name="F:NPOI.XSSF.UserModel.XSSFPicture.ctPicture">
  3487. This object specifies a picture object and all its properties
  3488. </member>
  3489. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Picture)">
  3490. Construct a new XSSFPicture object. This constructor is called from
  3491. {@link XSSFDrawing#CreatePicture(XSSFClientAnchor, int)}
  3492. @param Drawing the XSSFDrawing that owns this picture
  3493. </member>
  3494. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,System.Xml.XmlNode)">
  3495. Returns a prototype that is used to construct new shapes
  3496. @return a prototype that is used to construct new shapes
  3497. </member>
  3498. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.SetPictureReference(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  3499. Link this shape with the picture data
  3500. @param rel relationship referring the picture data
  3501. </member>
  3502. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetCTPicture">
  3503. Return the underlying CT_Picture bean that holds all properties for this picture
  3504. @return the underlying CT_Picture bean
  3505. </member>
  3506. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.Resize">
  3507. Reset the image to the original size.
  3508. <p>
  3509. Please note, that this method works correctly only for workbooks
  3510. with the default font size (Calibri 11pt for .xlsx).
  3511. If the default font is Changed the resized image can be streched vertically or horizontally.
  3512. </p>
  3513. </member>
  3514. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.Resize(System.Double)">
  3515. Reset the image to the original size.
  3516. <p>
  3517. Please note, that this method works correctly only for workbooks
  3518. with the default font size (Calibri 11pt for .xlsx).
  3519. If the default font is Changed the resized image can be streched vertically or horizontally.
  3520. </p>
  3521. @param scale the amount by which image dimensions are multiplied relative to the original size.
  3522. <code>resize(1.0)</code> Sets the original size, <code>resize(0.5)</code> resize to 50% of the original,
  3523. <code>resize(2.0)</code> resizes to 200% of the original.
  3524. </member>
  3525. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetPreferredSize">
  3526. Calculate the preferred size for this picture.
  3527. @return XSSFClientAnchor with the preferred size for this image
  3528. </member>
  3529. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetPreferredSize(System.Double)">
  3530. Calculate the preferred size for this picture.
  3531. @param scale the amount by which image dimensions are multiplied relative to the original size.
  3532. @return XSSFClientAnchor with the preferred size for this image
  3533. </member>
  3534. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetImageDimension(NPOI.OpenXml4Net.OPC.PackagePart,System.Int32)">
  3535. Return the dimension of this image
  3536. @param part the namespace part holding raw picture data
  3537. @param type type of the picture: {@link Workbook#PICTURE_TYPE_JPEG},
  3538. {@link Workbook#PICTURE_TYPE_PNG} or {@link Workbook#PICTURE_TYPE_DIB}
  3539. @return image dimension in pixels
  3540. </member>
  3541. <member name="T:NPOI.XSSF.UserModel.XSSFPictureData">
  3542. Raw picture data, normally attached to a SpreadsheetML Drawing.
  3543. As a rule, pictures are stored in the /xl/media/ part of a SpreadsheetML package.
  3544. </member>
  3545. <member name="F:NPOI.XSSF.UserModel.XSSFPictureData.RELATIONS">
  3546. Relationships for each known picture type
  3547. </member>
  3548. <member name="M:NPOI.XSSF.UserModel.XSSFPictureData.#ctor">
  3549. Create a new XSSFPictureData node
  3550. @see NPOI.xssf.usermodel.XSSFWorkbook#AddPicture(byte[], int)
  3551. </member>
  3552. <member name="M:NPOI.XSSF.UserModel.XSSFPictureData.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  3553. Construct XSSFPictureData from a namespace part
  3554. @param part the namespace part holding the Drawing data,
  3555. @param rel the namespace relationship holding this Drawing,
  3556. the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/image
  3557. </member>
  3558. <member name="M:NPOI.XSSF.UserModel.XSSFPictureData.SuggestFileExtension">
  3559. Suggests a file extension for this image.
  3560. @return the file extension.
  3561. </member>
  3562. <member name="M:NPOI.XSSF.UserModel.XSSFPictureData.GetPictureType">
  3563. Return an integer constant that specifies type of this picture
  3564. @return an integer constant that specifies type of this picture
  3565. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_EMF
  3566. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_WMF
  3567. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_PICT
  3568. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_JPEG
  3569. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_PNG
  3570. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_DIB
  3571. </member>
  3572. <member name="P:NPOI.XSSF.UserModel.XSSFPictureData.Data">
  3573. <summary>
  3574. Gets the picture data as a byte array.
  3575. </summary>
  3576. </member>
  3577. <member name="T:NPOI.XSSF.UserModel.XSSFPrintSetup">
  3578. Page Setup and page margins Settings for the worksheet.
  3579. </member>
  3580. <member name="M:NPOI.XSSF.UserModel.XSSFPrintSetup.SetPaperSize(NPOI.SS.UserModel.PaperSize)">
  3581. Set the paper size as enum value.
  3582. @param size value for the paper size.
  3583. </member>
  3584. <member name="M:NPOI.XSSF.UserModel.XSSFPrintSetup.GetPaperSizeEnum">
  3585. Returns the paper size as enum.
  3586. @return PaperSize paper size
  3587. @see PaperSize
  3588. </member>
  3589. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Orientation">
  3590. Orientation of the page: landscape - portrait.
  3591. @return Orientation of the page
  3592. @see PrintOrientation
  3593. </member>
  3594. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.PageOrder">
  3595. Get print page order.
  3596. @return PageOrder
  3597. </member>
  3598. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.PaperSize">
  3599. Returns the paper size.
  3600. @return short - paper size
  3601. </member>
  3602. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Scale">
  3603. Returns the scale.
  3604. @return short - scale
  3605. </member>
  3606. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.PageStart">
  3607. Set the page numbering start.
  3608. Page number for first printed page. If no value is specified, then 'automatic' is assumed.
  3609. @return page number for first printed page
  3610. </member>
  3611. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.FitWidth">
  3612. Returns the number of pages wide to fit sheet in.
  3613. @return number of pages wide to fit sheet in
  3614. </member>
  3615. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.FitHeight">
  3616. Returns the number of pages high to fit the sheet in.
  3617. @return number of pages high to fit the sheet in
  3618. </member>
  3619. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.LeftToRight">
  3620. Returns the left to right print order.
  3621. @return left to right print order
  3622. </member>
  3623. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Landscape">
  3624. Returns the landscape mode.
  3625. @return landscape mode
  3626. </member>
  3627. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.ValidSettings">
  3628. Use the printer's defaults Settings for page Setup values and don't use the default values
  3629. specified in the schema. For example, if dpi is not present or specified in the XML, the
  3630. application shall not assume 600dpi as specified in the schema as a default and instead
  3631. shall let the printer specify the default dpi.
  3632. @return valid Settings
  3633. </member>
  3634. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.NoColor">
  3635. Returns the black and white Setting.
  3636. @return black and white Setting
  3637. </member>
  3638. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Draft">
  3639. Returns the draft mode.
  3640. @return draft mode
  3641. </member>
  3642. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Notes">
  3643. Returns the print notes.
  3644. @return print notes
  3645. </member>
  3646. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.NoOrientation">
  3647. Returns the no orientation.
  3648. @return no orientation
  3649. </member>
  3650. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.UsePage">
  3651. Returns the use page numbers.
  3652. @return use page numbers
  3653. </member>
  3654. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.HResolution">
  3655. Returns the horizontal resolution.
  3656. @return horizontal resolution
  3657. </member>
  3658. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.VResolution">
  3659. Returns the vertical resolution.
  3660. @return vertical resolution
  3661. </member>
  3662. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.HeaderMargin">
  3663. Returns the header margin.
  3664. @return header margin
  3665. </member>
  3666. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.FooterMargin">
  3667. Returns the footer margin.
  3668. @return footer margin
  3669. </member>
  3670. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Copies">
  3671. Returns the number of copies.
  3672. @return number of copies
  3673. </member>
  3674. <member name="T:NPOI.XSSF.UserModel.XSSFRelation">
  3675. </member>
  3676. <member name="F:NPOI.XSSF.UserModel.XSSFRelation._table">
  3677. A map to lookup POIXMLRelation by its relation type
  3678. </member>
  3679. <member name="M:NPOI.XSSF.UserModel.XSSFRelation.GetContents(NPOI.OpenXml4Net.OPC.PackagePart)">
  3680. Fetches the InputStream to read the contents, based
  3681. of the specified core part, for which we are defined
  3682. as a suitable relationship
  3683. </member>
  3684. <member name="M:NPOI.XSSF.UserModel.XSSFRelation.GetInstance(System.String)">
  3685. Get POIXMLRelation by relation type
  3686. @param rel relation type, for example,
  3687. <code>http://schemas.openxmlformats.org/officeDocument/2006/relationships/image</code>
  3688. @return registered POIXMLRelation or null if not found
  3689. </member>
  3690. <member name="M:NPOI.XSSF.UserModel.XSSFRelation.RemoveRelation(NPOI.XSSF.UserModel.XSSFRelation)">
  3691. <summary>
  3692. Removes the relation from the internal table.
  3693. Following readings of files will ignoring the removed relation.
  3694. </summary>
  3695. <param name="relation">Relation to remove</param>
  3696. </member>
  3697. <member name="M:NPOI.XSSF.UserModel.XSSFRelation.AddRelation(NPOI.XSSF.UserModel.XSSFRelation)">
  3698. <summary>
  3699. Adds the relation to the internal table.
  3700. Following readings of files will process the given relation.
  3701. </summary>
  3702. <param name="relation">Relation to add</param>
  3703. </member>
  3704. <member name="T:NPOI.XSSF.UserModel.XSSFRichTextString">
  3705. Rich text unicode string. These strings can have fonts applied to arbitary parts of the string.
  3706. <p>
  3707. Most strings in a workbook have formatting applied at the cell level, that is, the entire string in the cell has the
  3708. same formatting applied. In these cases, the formatting for the cell is stored in the styles part,
  3709. and the string for the cell can be shared across the workbook. The following code illustrates the example.
  3710. </p>
  3711. <blockquote>
  3712. <pre>
  3713. cell1.SetCellValue(new XSSFRichTextString("Apache POI"));
  3714. cell2.SetCellValue(new XSSFRichTextString("Apache POI"));
  3715. cell3.SetCellValue(new XSSFRichTextString("Apache POI"));
  3716. </pre>
  3717. </blockquote>
  3718. In the above example all three cells will use the same string cached on workbook level.
  3719. <p>
  3720. Some strings in the workbook may have formatting applied at a level that is more granular than the cell level.
  3721. For instance, specific characters within the string may be bolded, have coloring, italicizing, etc.
  3722. In these cases, the formatting is stored along with the text in the string table, and is treated as
  3723. a unique entry in the workbook. The following xml and code snippet illustrate this.
  3724. </p>
  3725. <blockquote>
  3726. <pre>
  3727. XSSFRichTextString s1 = new XSSFRichTextString("Apache POI");
  3728. s1.ApplyFont(boldArial);
  3729. cell1.SetCellValue(s1);
  3730. XSSFRichTextString s2 = new XSSFRichTextString("Apache POI");
  3731. s2.ApplyFont(italicCourier);
  3732. cell2.SetCellValue(s2);
  3733. </pre>
  3734. </blockquote>
  3735. @author Yegor Kozlov
  3736. </member>
  3737. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.#ctor(System.String)">
  3738. Create a rich text string
  3739. </member>
  3740. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.#ctor">
  3741. Create empty rich text string and Initialize it with empty string
  3742. </member>
  3743. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Rst)">
  3744. Create a rich text string from the supplied XML bean
  3745. </member>
  3746. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ApplyFont(System.Int32,System.Int32,System.Int16)">
  3747. Applies a font to the specified characters of a string.
  3748. @param startIndex The start index to apply the font to (inclusive)
  3749. @param endIndex The end index to apply the font to (exclusive)
  3750. @param fontIndex The font to use.
  3751. </member>
  3752. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ApplyFont(System.Int32,System.Int32,NPOI.SS.UserModel.IFont)">
  3753. Applies a font to the specified characters of a string.
  3754. @param startIndex The start index to apply the font to (inclusive)
  3755. @param endIndex The end index to apply to font to (exclusive)
  3756. @param font The index of the font to use.
  3757. </member>
  3758. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ApplyFont(NPOI.SS.UserModel.IFont)">
  3759. Sets the font of the entire string.
  3760. @param font The font to use.
  3761. </member>
  3762. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ApplyFont(System.Int16)">
  3763. Applies the specified font to the entire string.
  3764. @param fontIndex the font to Apply.
  3765. </member>
  3766. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.Append(System.String,NPOI.XSSF.UserModel.XSSFFont)">
  3767. Append new text to this text run and apply the specify font to it
  3768. @param text the text to append
  3769. @param font the font to apply to the Appended text or <code>null</code> if no formatting is required
  3770. </member>
  3771. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.Append(System.String)">
  3772. Append new text to this text run
  3773. @param text the text to append
  3774. </member>
  3775. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.SetRunAttributes(NPOI.OpenXmlFormats.Spreadsheet.CT_Font,NPOI.OpenXmlFormats.Spreadsheet.CT_RPrElt)">
  3776. Copy font attributes from CTFont bean into CTRPrElt bean
  3777. </member>
  3778. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ClearFormatting">
  3779. Removes any formatting that may have been applied to the string.
  3780. </member>
  3781. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetIndexOfFormattingRun(System.Int32)">
  3782. The index within the string to which the specified formatting run applies.
  3783. @param index the index of the formatting run
  3784. @return the index within the string.
  3785. </member>
  3786. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetLengthOfFormattingRun(System.Int32)">
  3787. Returns the number of characters this format run covers.
  3788. @param index the index of the formatting run
  3789. @return the number of characters this format run covers
  3790. </member>
  3791. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ToString">
  3792. Returns the plain string representation.
  3793. </member>
  3794. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetFontOfFormattingRun(System.Int32)">
  3795. Gets a copy of the font used in a particular formatting Run.
  3796. @param index the index of the formatting run
  3797. @return A copy of the font used or null if no formatting is applied to the specified text Run.
  3798. </member>
  3799. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetFontAtIndex(System.Int32)">
  3800. Return a copy of the font in use at a particular index.
  3801. @param index The index.
  3802. @return A copy of the font that's currently being applied at that
  3803. index or null if no font is being applied or the
  3804. index is out of range.
  3805. </member>
  3806. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetCTRst">
  3807. Return the underlying xml bean
  3808. </member>
  3809. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ToCTFont(NPOI.OpenXmlFormats.Spreadsheet.CT_RPrElt)">
  3810. CTRPrElt --> CTFont adapter
  3811. </member>
  3812. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.PreserveSpaces(System.String)">
  3813. **
  3814. </member>
  3815. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.UtfDecode(System.String)">
  3816. For all characters which cannot be represented in XML as defined by the XML 1.0 specification,
  3817. the characters are escaped using the Unicode numerical character representation escape character
  3818. format _xHHHH_, where H represents a hexadecimal character in the character's value.
  3819. <p>
  3820. Example: The Unicode character 0D is invalid in an XML 1.0 document,
  3821. so it shall be escaped as <code>_x000D_</code>.
  3822. </p>
  3823. See section 3.18.9 in the OOXML spec.
  3824. @param value the string to decode
  3825. @return the decoded string
  3826. </member>
  3827. <member name="P:NPOI.XSSF.UserModel.XSSFRichTextString.Length">
  3828. Returns the number of characters in this string.
  3829. </member>
  3830. <member name="P:NPOI.XSSF.UserModel.XSSFRichTextString.NumFormattingRuns">
  3831. @return The number of formatting Runs used.
  3832. </member>
  3833. <member name="T:NPOI.XSSF.UserModel.XSSFRow">
  3834. High level representation of a row of a spreadsheet.
  3835. </member>
  3836. <member name="F:NPOI.XSSF.UserModel.XSSFRow._row">
  3837. the xml bean Containing all cell defInitions for this row
  3838. </member>
  3839. <member name="F:NPOI.XSSF.UserModel.XSSFRow._cells">
  3840. Cells of this row keyed by their column indexes.
  3841. The TreeMap ensures that the cells are ordered by columnIndex in the ascending order.
  3842. </member>
  3843. <member name="F:NPOI.XSSF.UserModel.XSSFRow._sheet">
  3844. the parent sheet
  3845. </member>
  3846. <member name="M:NPOI.XSSF.UserModel.XSSFRow.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Row,NPOI.XSSF.UserModel.XSSFSheet)">
  3847. Construct a XSSFRow.
  3848. @param row the xml bean Containing all cell defInitions for this row.
  3849. @param sheet the parent sheet.
  3850. </member>
  3851. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFRow.CellIterator" -->
  3852. <member name="M:NPOI.XSSF.UserModel.XSSFRow.GetEnumerator">
  3853. Alias for {@link #cellIterator()} to allow foreach loops:
  3854. <blockquote><pre>
  3855. for(Cell cell : row){
  3856. ...
  3857. }
  3858. </pre></blockquote>
  3859. @return an iterator over cells in this row.
  3860. </member>
  3861. <member name="M:NPOI.XSSF.UserModel.XSSFRow.CompareTo(NPOI.XSSF.UserModel.XSSFRow)">
  3862. Compares two <code>XSSFRow</code> objects. Two rows are equal if they belong to the same worksheet and
  3863. their row indexes are Equal.
  3864. @param row the <code>XSSFRow</code> to be Compared.
  3865. @return the value <code>0</code> if the row number of this <code>XSSFRow</code> is
  3866. equal to the row number of the argument <code>XSSFRow</code>; a value less than
  3867. <code>0</code> if the row number of this this <code>XSSFRow</code> is numerically less
  3868. than the row number of the argument <code>XSSFRow</code>; and a value greater
  3869. than <code>0</code> if the row number of this this <code>XSSFRow</code> is numerically
  3870. greater than the row number of the argument <code>XSSFRow</code>.
  3871. @throws ArgumentException if the argument row belongs to a different worksheet
  3872. </member>
  3873. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFRow.CreateCell(System.Int32)" -->
  3874. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFRow.CreateCell(System.Int32,NPOI.SS.UserModel.CellType)" -->
  3875. <member name="M:NPOI.XSSF.UserModel.XSSFRow.GetCell(System.Int32)">
  3876. Returns the cell at the given (0 based) index,
  3877. with the {@link NPOI.SS.usermodel.Row.MissingCellPolicy} from the parent Workbook.
  3878. @return the cell at the given (0 based) index
  3879. </member>
  3880. <member name="M:NPOI.XSSF.UserModel.XSSFRow.RetrieveCell(System.Int32)">
  3881. <summary>
  3882. Get the hssfcell representing a given column (logical cell)
  3883. 0-based. If you ask for a cell that is not defined, then
  3884. you Get a null.
  3885. This is the basic call, with no policies applied
  3886. </summary>
  3887. <param name="cellnum">0 based column number</param>
  3888. <returns>Cell representing that column or null if Undefined.</returns>
  3889. </member>
  3890. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFRow.GetCell(System.Int32,NPOI.SS.UserModel.MissingCellPolicy)" -->
  3891. <member name="M:NPOI.XSSF.UserModel.XSSFRow.SetRowStyle(NPOI.SS.UserModel.ICellStyle)">
  3892. Applies a whole-row cell styling to the row.
  3893. If the value is null then the style information is Removed,
  3894. causing the cell to used the default workbook style.
  3895. </member>
  3896. <member name="M:NPOI.XSSF.UserModel.XSSFRow.RemoveCell(NPOI.SS.UserModel.ICell)">
  3897. Remove the Cell from this row.
  3898. @param cell the cell to remove
  3899. </member>
  3900. <member name="M:NPOI.XSSF.UserModel.XSSFRow.GetCTRow">
  3901. Returns the underlying CT_Row xml bean Containing all cell defInitions in this row
  3902. @return the underlying CT_Row xml bean
  3903. </member>
  3904. <member name="M:NPOI.XSSF.UserModel.XSSFRow.OnDocumentWrite">
  3905. Fired when the document is written to an output stream.
  3906. @see NPOI.XSSF.usermodel.XSSFSheet#Write(java.io.OutputStream) ()
  3907. </member>
  3908. <member name="M:NPOI.XSSF.UserModel.XSSFRow.ToString">
  3909. @return formatted xml representation of this row
  3910. </member>
  3911. <member name="M:NPOI.XSSF.UserModel.XSSFRow.Shift(System.Int32)">
  3912. update cell references when Shifting rows
  3913. @param n the number of rows to move
  3914. </member>
  3915. <member name="P:NPOI.XSSF.UserModel.XSSFRow.Sheet">
  3916. Returns the XSSFSheet this row belongs to
  3917. @return the XSSFSheet that owns this row
  3918. </member>
  3919. <member name="P:NPOI.XSSF.UserModel.XSSFRow.FirstCellNum">
  3920. Get the number of the first cell Contained in this row.
  3921. @return short representing the first logical cell in the row,
  3922. or -1 if the row does not contain any cells.
  3923. </member>
  3924. <member name="P:NPOI.XSSF.UserModel.XSSFRow.LastCellNum">
  3925. Gets the index of the last cell Contained in this row <b>PLUS ONE</b>. The result also
  3926. happens to be the 1-based column number of the last cell. This value can be used as a
  3927. standard upper bound when iterating over cells:
  3928. <pre>
  3929. short minColIx = row.GetFirstCellNum();
  3930. short maxColIx = row.GetLastCellNum();
  3931. for(short colIx=minColIx; colIx&lt;maxColIx; colIx++) {
  3932. XSSFCell cell = row.GetCell(colIx);
  3933. if(cell == null) {
  3934. continue;
  3935. }
  3936. //... do something with cell
  3937. }
  3938. </pre>
  3939. @return short representing the last logical cell in the row <b>PLUS ONE</b>,
  3940. or -1 if the row does not contain any cells.
  3941. </member>
  3942. <member name="P:NPOI.XSSF.UserModel.XSSFRow.Height">
  3943. 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,
  3944. See {@link NPOI.XSSF.usermodel.XSSFSheet#GetDefaultRowHeightInPoints()}
  3945. @return row height measured in twips (1/20th of a point)
  3946. </member>
  3947. <member name="P:NPOI.XSSF.UserModel.XSSFRow.HeightInPoints">
  3948. Returns row height measured in point size. If the height is not Set, the default worksheet value is returned,
  3949. See {@link NPOI.XSSF.usermodel.XSSFSheet#GetDefaultRowHeightInPoints()}
  3950. @return row height measured in point size
  3951. @see NPOI.XSSF.usermodel.XSSFSheet#GetDefaultRowHeightInPoints()
  3952. </member>
  3953. <member name="P:NPOI.XSSF.UserModel.XSSFRow.PhysicalNumberOfCells">
  3954. Gets the number of defined cells (NOT number of cells in the actual row!).
  3955. That is to say if only columns 0,4,5 have values then there would be 3.
  3956. @return int representing the number of defined cells in the row.
  3957. </member>
  3958. <member name="P:NPOI.XSSF.UserModel.XSSFRow.RowNum">
  3959. Get row number this row represents
  3960. @return the row number (0 based)
  3961. </member>
  3962. <member name="P:NPOI.XSSF.UserModel.XSSFRow.ZeroHeight">
  3963. Get whether or not to display this row with 0 height
  3964. @return - height is zero or not.
  3965. </member>
  3966. <member name="P:NPOI.XSSF.UserModel.XSSFRow.IsFormatted">
  3967. Is this row formatted? Most aren't, but some rows
  3968. do have whole-row styles. For those that do, you
  3969. can get the formatting from {@link #GetRowStyle()}
  3970. </member>
  3971. <member name="P:NPOI.XSSF.UserModel.XSSFRow.RowStyle">
  3972. Returns the whole-row cell style. Most rows won't
  3973. have one of these, so will return null. Call
  3974. {@link #isFormatted()} to check first.
  3975. </member>
  3976. <member name="T:NPOI.XSSF.UserModel.XSSFShapeGroup">
  3977. This object specifies a group shape that represents many shapes grouped together. This shape is to be treated
  3978. just as if it were a regular shape but instead of being described by a single geometry it is made up of all the
  3979. shape geometries encompassed within it. Within a group shape each of the shapes that make up the group are
  3980. specified just as they normally would.
  3981. @author Yegor Kozlov
  3982. </member>
  3983. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_GroupShape)">
  3984. Construct a new XSSFSimpleShape object.
  3985. @param Drawing the XSSFDrawing that owns this shape
  3986. @param ctGroup the XML bean that stores this group content
  3987. </member>
  3988. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.Prototype">
  3989. Initialize default structure of a new shape group
  3990. </member>
  3991. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.CreateTextbox(NPOI.XSSF.UserModel.XSSFChildAnchor)">
  3992. Constructs a textbox.
  3993. @param anchor the child anchor describes how this shape is attached
  3994. to the group.
  3995. @return the newly Created textbox.
  3996. </member>
  3997. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.CreateSimpleShape(NPOI.XSSF.UserModel.XSSFChildAnchor)">
  3998. Creates a simple shape. This includes such shapes as lines, rectangles,
  3999. and ovals.
  4000. @param anchor the child anchor describes how this shape is attached
  4001. to the group.
  4002. @return the newly Created shape.
  4003. </member>
  4004. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.CreateConnector(NPOI.XSSF.UserModel.XSSFChildAnchor)">
  4005. Creates a simple shape. This includes such shapes as lines, rectangles,
  4006. and ovals.
  4007. @param anchor the child anchor describes how this shape is attached
  4008. to the group.
  4009. @return the newly Created shape.
  4010. </member>
  4011. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.CreatePicture(NPOI.XSSF.UserModel.XSSFClientAnchor,System.Int32)">
  4012. Creates a picture.
  4013. @param anchor the client anchor describes how this picture is attached to the sheet.
  4014. @param pictureIndex the index of the picture in the workbook collection of pictures,
  4015. {@link XSSFWorkbook#getAllPictures()} .
  4016. @return the newly Created picture shape.
  4017. </member>
  4018. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.SetCoordinates(System.Int32,System.Int32,System.Int32,System.Int32)">
  4019. Sets the coordinate space of this group. All children are constrained
  4020. to these coordinates.
  4021. </member>
  4022. <member name="T:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting">
  4023. @author Yegor Kozlov
  4024. </member>
  4025. <member name="M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.ComparisonOperator,System.String,System.String)">
  4026. A factory method allowing to create a conditional formatting rule
  4027. with a cell comparison operator<p/>
  4028. TODO - formulas Containing cell references are currently not Parsed properly
  4029. @param comparisonOperation - a constant value from
  4030. <tt>{@link NPOI.hssf.record.CFRuleRecord.ComparisonOperator}</tt>: <p>
  4031. <ul>
  4032. <li>BETWEEN</li>
  4033. <li>NOT_BETWEEN</li>
  4034. <li>EQUAL</li>
  4035. <li>NOT_EQUAL</li>
  4036. <li>GT</li>
  4037. <li>LT</li>
  4038. <li>GE</li>
  4039. <li>LE</li>
  4040. </ul>
  4041. </p>
  4042. @param formula1 - formula for the valued, Compared with the cell
  4043. @param formula2 - second formula (only used with
  4044. {@link NPOI.ss.usermodel.ComparisonOperator#BETWEEN}) and
  4045. {@link NPOI.ss.usermodel.ComparisonOperator#NOT_BETWEEN} operations)
  4046. </member>
  4047. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.CreateConditionalFormattingRule(System.String)" -->
  4048. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.UserModel.IConditionalFormatting)" -->
  4049. <member name="M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.GetConditionalFormattingAt(System.Int32)">
  4050. Gets Conditional Formatting object at a particular index
  4051. @param index
  4052. of the Conditional Formatting object to fetch
  4053. @return Conditional Formatting object
  4054. </member>
  4055. <member name="M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.RemoveConditionalFormatting(System.Int32)">
  4056. Removes a Conditional Formatting object by index
  4057. @param index of a Conditional Formatting object to remove
  4058. </member>
  4059. <member name="P:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.NumConditionalFormattings">
  4060. @return number of Conditional Formatting objects of the sheet
  4061. </member>
  4062. <member name="T:NPOI.XSSF.UserModel.XSSFSimpleShape">
  4063. Represents a shape with a predefined geometry in a SpreadsheetML Drawing.
  4064. Possible shape types are defined in {@link NPOI.ss.usermodel.ShapeTypes}
  4065. @author Yegor Kozlov
  4066. </member>
  4067. <member name="F:NPOI.XSSF.UserModel.XSSFSimpleShape.prototype">
  4068. A default instance of CT_Shape used for creating new shapes.
  4069. </member>
  4070. <member name="F:NPOI.XSSF.UserModel.XSSFSimpleShape.ctShape">
  4071. Xml bean that stores properties of this shape
  4072. </member>
  4073. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.Prototype">
  4074. Prototype with the default structure of a new auto-shape.
  4075. </member>
  4076. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.GetShapeType">
  4077. Gets the shape type, one of the constants defined in {@link NPOI.ss.usermodel.ShapeTypes}.
  4078. @return the shape type
  4079. @see NPOI.ss.usermodel.ShapeTypes
  4080. </member>
  4081. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.SetShapeType(System.Int32)">
  4082. Sets the shape types.
  4083. @param type the shape type, one of the constants defined in {@link NPOI.ss.usermodel.ShapeTypes}.
  4084. @see NPOI.ss.usermodel.ShapeTypes
  4085. </member>
  4086. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.ApplyAttributes(NPOI.OpenXmlFormats.Spreadsheet.CT_RPrElt,NPOI.OpenXmlFormats.Dml.CT_TextCharacterProperties)">
  4087. org.openxmlformats.schemas.spreadsheetml.x2006.main.CTRPrElt to
  4088. org.openxmlformats.schemas.drawingml.x2006.main.CTFont adapter
  4089. </member>
  4090. <member name="T:NPOI.XSSF.UserModel.XSSFTable">
  4091. This class : the Table Part (Open Office XML Part 4:
  4092. chapter 3.5.1)
  4093. This implementation works under the assumption that a table Contains mappings to a subtree of an XML.
  4094. The root element of this subtree an occur multiple times (one for each row of the table). The child nodes
  4095. of the root element can be only attributes or element with maxOccurs=1 property set
  4096. @author Roberto Manicardi
  4097. </member>
  4098. <member name="M:NPOI.XSSF.UserModel.XSSFTable.MapsTo(System.Int64)">
  4099. Checks if this Table element Contains even a single mapping to the map identified by id
  4100. @param id the XSSFMap ID
  4101. @return true if the Table element contain mappings
  4102. </member>
  4103. <member name="M:NPOI.XSSF.UserModel.XSSFTable.GetCommonXpath">
  4104. Calculates the xpath of the root element for the table. This will be the common part
  4105. of all the mapping's xpaths
  4106. @return the xpath of the table's root element
  4107. </member>
  4108. <member name="M:NPOI.XSSF.UserModel.XSSFTable.GetStartCellReference">
  4109. @return The reference for the cell in the top-left part of the table
  4110. (see Open Office XML Part 4: chapter 3.5.1.2, attribute ref)
  4111. </member>
  4112. <member name="M:NPOI.XSSF.UserModel.XSSFTable.GetEndCellReference">
  4113. @return The reference for the cell in the bottom-right part of the table
  4114. (see Open Office XML Part 4: chapter 3.5.1.2, attribute ref)
  4115. </member>
  4116. <member name="M:NPOI.XSSF.UserModel.XSSFTable.UpdateHeaders">
  4117. Synchronize table headers with cell values in the parent sheet.
  4118. Headers <em>must</em> be in sync, otherwise Excel will display a
  4119. "Found unreadable content" message on startup.
  4120. </member>
  4121. <member name="P:NPOI.XSSF.UserModel.XSSFTable.Name">
  4122. @return the name of the Table, if set
  4123. </member>
  4124. <member name="P:NPOI.XSSF.UserModel.XSSFTable.DisplayName">
  4125. @return the display name of the Table, if set
  4126. </member>
  4127. <member name="P:NPOI.XSSF.UserModel.XSSFTable.NumberOfMappedColumns">
  4128. @return the number of mapped table columns (see Open Office XML Part 4: chapter 3.5.1.4)
  4129. </member>
  4130. <member name="P:NPOI.XSSF.UserModel.XSSFTable.RowCount">
  4131. @return the total number of rows in the selection. (Note: in this version autofiltering is ignored)
  4132. </member>
  4133. <member name="T:NPOI.XSSF.UserModel.XSSFTextBox">
  4134. Represents a text box in a SpreadsheetML Drawing.
  4135. @author Yegor Kozlov
  4136. </member>
  4137. <member name="T:NPOI.XSSF.UserModel.XSSFVMLDrawing">
  4138. Represents a SpreadsheetML VML Drawing.
  4139. <p>
  4140. In Excel 2007 VML Drawings are used to describe properties of cell comments,
  4141. although the spec says that VML is deprecated:
  4142. </p>
  4143. <p>
  4144. The VML format is a legacy format originally introduced with Office 2000 and is included and fully defined
  4145. in this Standard for backwards compatibility reasons. The DrawingML format is a newer and richer format
  4146. Created with the goal of eventually replacing any uses of VML in the Office Open XML formats. VML should be
  4147. considered a deprecated format included in Office Open XML for legacy reasons only and new applications that
  4148. need a file format for Drawings are strongly encouraged to use preferentially DrawingML
  4149. </p>
  4150. <p>
  4151. Warning - Excel is known to Put invalid XML into these files!
  4152. For example, &gt;br&lt; without being closed or escaped crops up.
  4153. </p>
  4154. See 6.4 VML - SpreadsheetML Drawing in Office Open XML Part 4 - Markup Language Reference.pdf
  4155. @author Yegor Kozlov
  4156. </member>
  4157. <member name="F:NPOI.XSSF.UserModel.XSSFVMLDrawing.ptrn_shapeId">
  4158. regexp to parse shape ids, in VML they have weird form of id="_x0000_s1026"
  4159. </member>
  4160. <member name="M:NPOI.XSSF.UserModel.XSSFVMLDrawing.#ctor">
  4161. Create a new SpreadsheetML Drawing
  4162. @see XSSFSheet#CreateDrawingPatriarch()
  4163. </member>
  4164. <member name="M:NPOI.XSSF.UserModel.XSSFVMLDrawing.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  4165. Construct a SpreadsheetML Drawing from a namespace part
  4166. @param part the namespace part holding the Drawing data,
  4167. the content type must be <code>application/vnd.Openxmlformats-officedocument.Drawing+xml</code>
  4168. @param rel the namespace relationship holding this Drawing,
  4169. the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/drawing
  4170. </member>
  4171. <member name="M:NPOI.XSSF.UserModel.XSSFVMLDrawing.newDrawing">
  4172. Initialize a new Speadsheet VML Drawing
  4173. </member>
  4174. <member name="M:NPOI.XSSF.UserModel.XSSFVMLDrawing.FindCommentShape(System.Int32,System.Int32)">
  4175. Find a shape with ClientData of type "NOTE" and the specified row and column
  4176. @return the comment shape or <code>null</code>
  4177. </member>
  4178. <member name="T:NPOI.XSSF.UserModel.XSSFWorkbook">
  4179. High level representation of a SpreadsheetML workbook. This is the first object most users
  4180. will construct whether they are Reading or writing a workbook. It is also the
  4181. top level object for creating new sheets/etc.
  4182. </member>
  4183. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.DEFAULT_CHARACTER_WIDTH">
  4184. Width of one character of the default font in pixels. Same for Calibry and Arial.
  4185. </member>
  4186. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.Max_SENSITIVE_SHEET_NAME_LEN">
  4187. Excel silently tRuncates long sheet names to 31 chars.
  4188. This constant is used to ensure uniqueness in the first 31 chars
  4189. </member>
  4190. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_EMF">
  4191. Extended windows meta file
  4192. </member>
  4193. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_WMF">
  4194. Windows Meta File
  4195. </member>
  4196. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_PICT">
  4197. Mac PICT format
  4198. </member>
  4199. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_JPEG">
  4200. JPEG format
  4201. </member>
  4202. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_PNG">
  4203. PNG format
  4204. </member>
  4205. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_DIB">
  4206. Device independent bitmap
  4207. </member>
  4208. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_GIF">
  4209. Images formats supported by XSSF but not by HSSF
  4210. </member>
  4211. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.workbook">
  4212. The underlying XML bean
  4213. </member>
  4214. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.sheets">
  4215. this holds the XSSFSheet objects attached to this workbook
  4216. </member>
  4217. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.namedRanges">
  4218. this holds the XSSFName objects attached to this workbook
  4219. </member>
  4220. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.sharedStringSource">
  4221. shared string table - a cache of strings in this workbook
  4222. </member>
  4223. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.stylesSource">
  4224. A collection of shared objects used for styling content,
  4225. e.g. fonts, cell styles, colors, etc.
  4226. </member>
  4227. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook._udfFinder">
  4228. The locator of user-defined functions.
  4229. By default includes functions from the Excel Analysis Toolpack
  4230. </member>
  4231. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.calcChain">
  4232. TODO
  4233. </member>
  4234. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.mapInfo">
  4235. A collection of custom XML mappings
  4236. </member>
  4237. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.formatter">
  4238. Used to keep track of the data formatter so that all
  4239. CreateDataFormatter calls return the same one for a given
  4240. book. This ensures that updates from one places is visible
  4241. someplace else.
  4242. </member>
  4243. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook._missingCellPolicy">
  4244. The policy to apply in the event of missing or
  4245. blank cells when fetching from a row.
  4246. See {@link NPOI.ss.usermodel.Row.MissingCellPolicy}
  4247. </member>
  4248. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.pictures">
  4249. array of pictures for this workbook
  4250. </member>
  4251. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook._creationHelper">
  4252. cached instance of XSSFCreationHelper for this workbook
  4253. @see {@link #getCreationHelper()}
  4254. </member>
  4255. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor">
  4256. Create a new SpreadsheetML workbook.
  4257. </member>
  4258. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage)">
  4259. Constructs a XSSFWorkbook object given a OpenXML4J <code>Package</code> object,
  4260. see <a href="http://poi.apache.org/oxml4j/">http://poi.apache.org/oxml4j/</a>.
  4261. Once you have finished working with the Workbook, you should close the package
  4262. by calling pkg.close, to avoid leaving file handles open.
  4263. Creating a XSSFWorkbook from a file-backed OPC Package has a lower memory
  4264. footprint than an InputStream backed one.
  4265. @param pkg the OpenXML4J <code>OPC Package</code> object.
  4266. </member>
  4267. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor(System.IO.Stream)">
  4268. Constructs a XSSFWorkbook object, by buffering the whole stream into memory
  4269. and then opening an {@link OPCPackage} object for it.
  4270. Using an {@link InputStream} requires more memory than using a File, so
  4271. if a {@link File} is available then you should instead do something like
  4272. <pre><code>
  4273. OPCPackage pkg = OPCPackage.open(path);
  4274. XSSFWorkbook wb = new XSSFWorkbook(pkg);
  4275. // work with the wb object
  4276. ......
  4277. pkg.close(); // gracefully closes the underlying zip file
  4278. </code></pre>
  4279. </member>
  4280. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor(System.String)" -->
  4281. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.OnWorkbookCreate">
  4282. Create a new CT_Workbook with all values Set to default
  4283. </member>
  4284. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.newPackage">
  4285. Create a new SpreadsheetML namespace and Setup the default minimal content
  4286. </member>
  4287. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCTWorkbook">
  4288. Return the underlying XML bean
  4289. @return the underlying CT_Workbook bean
  4290. </member>
  4291. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.AddPicture(System.Byte[],System.Int32)">
  4292. Adds a picture to the workbook.
  4293. @param pictureData The bytes of the picture
  4294. @param format The format of the picture.
  4295. @return the index to this picture (0 based), the Added picture can be obtained from {@link #getAllPictures()} .
  4296. @see Workbook#PICTURE_TYPE_EMF
  4297. @see Workbook#PICTURE_TYPE_WMF
  4298. @see Workbook#PICTURE_TYPE_PICT
  4299. @see Workbook#PICTURE_TYPE_JPEG
  4300. @see Workbook#PICTURE_TYPE_PNG
  4301. @see Workbook#PICTURE_TYPE_DIB
  4302. @see #getAllPictures()
  4303. </member>
  4304. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.AddPicture(System.IO.Stream,System.Int32)">
  4305. Adds a picture to the workbook.
  4306. @param is The sream to read image from
  4307. @param format The format of the picture.
  4308. @return the index to this picture (0 based), the Added picture can be obtained from {@link #getAllPictures()} .
  4309. @see Workbook#PICTURE_TYPE_EMF
  4310. @see Workbook#PICTURE_TYPE_WMF
  4311. @see Workbook#PICTURE_TYPE_PICT
  4312. @see Workbook#PICTURE_TYPE_JPEG
  4313. @see Workbook#PICTURE_TYPE_PNG
  4314. @see Workbook#PICTURE_TYPE_DIB
  4315. @see #getAllPictures()
  4316. </member>
  4317. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CloneSheet(System.Int32)">
  4318. Create an XSSFSheet from an existing sheet in the XSSFWorkbook.
  4319. The Cloned sheet is a deep copy of the original.
  4320. @return XSSFSheet representing the Cloned sheet.
  4321. @throws ArgumentException if the sheet index in invalid
  4322. @throws POIXMLException if there were errors when cloning
  4323. </member>
  4324. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetUniqueSheetName(System.String)">
  4325. Generate a valid sheet name based on the existing one. Used when cloning sheets.
  4326. @param srcName the original sheet name to
  4327. @return clone sheet name
  4328. </member>
  4329. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateCellStyle">
  4330. Create a new XSSFCellStyle and add it to the workbook's style table
  4331. @return the new XSSFCellStyle object
  4332. </member>
  4333. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateDataFormat">
  4334. Returns the instance of XSSFDataFormat for this workbook.
  4335. @return the XSSFDataFormat object
  4336. @see NPOI.ss.usermodel.DataFormat
  4337. </member>
  4338. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateFont">
  4339. Create a new Font and add it to the workbook's font table
  4340. @return new font object
  4341. </member>
  4342. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateSheet">
  4343. Create an XSSFSheet for this workbook, Adds it to the sheets and returns
  4344. the high level representation. Use this to create new sheets.
  4345. @return XSSFSheet representing the new sheet.
  4346. </member>
  4347. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateSheet(System.String)">
  4348. Create a new sheet for this Workbook and return the high level representation.
  4349. Use this to create new sheets.
  4350. <p>
  4351. Note that Excel allows sheet names up to 31 chars in length but other applications
  4352. (such as OpenOffice) allow more. Some versions of Excel crash with names longer than 31 chars,
  4353. others - tRuncate such names to 31 character.
  4354. </p>
  4355. <p>
  4356. POI's SpreadsheetAPI silently tRuncates the input argument to 31 characters.
  4357. Example:
  4358. <pre><code>
  4359. Sheet sheet = workbook.CreateSheet("My very long sheet name which is longer than 31 chars"); // will be tRuncated
  4360. assert 31 == sheet.SheetName.Length;
  4361. assert "My very long sheet name which i" == sheet.SheetName;
  4362. </code></pre>
  4363. </p>
  4364. Except the 31-character constraint, Excel applies some other rules:
  4365. <p>
  4366. Sheet name MUST be unique in the workbook and MUST NOT contain the any of the following characters:
  4367. <ul>
  4368. <li> 0x0000 </li>
  4369. <li> 0x0003 </li>
  4370. <li> colon (:) </li>
  4371. <li> backslash (\) </li>
  4372. <li> asterisk (*) </li>
  4373. <li> question mark (?) </li>
  4374. <li> forward slash (/) </li>
  4375. <li> opening square bracket ([) </li>
  4376. <li> closing square bracket (]) </li>
  4377. </ul>
  4378. The string MUST NOT begin or end with the single quote (') character.
  4379. </p>
  4380. <p>
  4381. See {@link org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)}
  4382. for a safe way to create valid names
  4383. </p>
  4384. @param sheetname sheetname to set for the sheet.
  4385. @return Sheet representing the new sheet.
  4386. @throws IllegalArgumentException if the name is null or invalid
  4387. or workbook already contains a sheet with this name
  4388. @see org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)
  4389. </member>
  4390. <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)">
  4391. Finds a font that matches the one with the supplied attributes
  4392. </member>
  4393. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetAllPictures">
  4394. Gets all pictures from the Workbook.
  4395. @return the list of pictures (a list of {@link XSSFPictureData} objects.)
  4396. @see #AddPicture(byte[], int)
  4397. </member>
  4398. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCellStyleAt(System.Int16)">
  4399. Get the cell style object at the given index
  4400. @param idx index within the Set of styles
  4401. @return XSSFCellStyle object at the index
  4402. </member>
  4403. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetFontAt(System.Int16)">
  4404. Get the font at the given index number
  4405. @param idx index number
  4406. @return XSSFFont at the index
  4407. </member>
  4408. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetNameIndex(System.String)">
  4409. Gets the named range index by his name
  4410. <i>Note:</i>Excel named ranges are case-insensitive and
  4411. this method performs a case-insensitive search.
  4412. @param name named range name
  4413. @return named range index
  4414. </member>
  4415. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetPrintArea(System.Int32)">
  4416. Retrieves the reference for the printarea of the specified sheet, the sheet name is Appended to the reference even if it was not specified.
  4417. @param sheetIndex Zero-based sheet index (0 Represents the first sheet to keep consistent with java)
  4418. @return String Null if no print area has been defined
  4419. </member>
  4420. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheet(System.String)">
  4421. Get sheet with the given name (case insensitive match)
  4422. @param name of the sheet
  4423. @return XSSFSheet with the name provided or <code>null</code> if it does not exist
  4424. </member>
  4425. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheetAt(System.Int32)" -->
  4426. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheetIndex(System.String)" -->
  4427. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheetIndex(NPOI.SS.UserModel.ISheet)">
  4428. Returns the index of the given sheet
  4429. @param sheet the sheet to look up
  4430. @return index of the sheet (0 based). <tt>-1</tt> if not found
  4431. </member>
  4432. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheetName(System.Int32)">
  4433. Get the sheet name
  4434. @param sheetIx Number
  4435. @return Sheet name
  4436. </member>
  4437. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetEnumerator">
  4438. Allows foreach loops:
  4439. <pre><code>
  4440. XSSFWorkbook wb = new XSSFWorkbook(package);
  4441. for(XSSFSheet sheet : wb){
  4442. }
  4443. </code></pre>
  4444. </member>
  4445. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsMacroEnabled">
  4446. Are we a normal workbook (.xlsx), or a
  4447. macro enabled workbook (.xlsm)?
  4448. </member>
  4449. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.RemoveName(NPOI.XSSF.UserModel.XSSFName)">
  4450. As {@link #removeName(String)} is not necessarily unique
  4451. (name + sheet index is unique), this method is more accurate.
  4452. @param name the name to remove.
  4453. </member>
  4454. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.RemovePrintArea(System.Int32)">
  4455. Delete the printarea for the sheet specified
  4456. @param sheetIndex 0-based sheet index (0 = First Sheet)
  4457. </member>
  4458. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.RemoveSheetAt(System.Int32)">
  4459. Removes sheet at the given index.<p/>
  4460. Care must be taken if the Removed sheet is the currently active or only selected sheet in
  4461. the workbook. There are a few situations when Excel must have a selection and/or active
  4462. sheet. (For example when printing - see Bug 40414).<br/>
  4463. This method Makes sure that if the Removed sheet was active, another sheet will become
  4464. active in its place. Furthermore, if the Removed sheet was the only selected sheet, another
  4465. sheet will become selected. The newly active/selected sheet will have the same index, or
  4466. one less if the Removed sheet was the last in the workbook.
  4467. @param index of the sheet (0-based)
  4468. </member>
  4469. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.OnSheetDelete(System.Int32)">
  4470. Gracefully remove references to the sheet being deleted
  4471. @param index the 0-based index of the sheet to delete
  4472. </member>
  4473. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.ValidateSheetIndex(System.Int32)">
  4474. Validate sheet index
  4475. @param index the index to validate
  4476. @throws ArgumentException if the index is out of range (index
  4477. &lt; 0 || index &gt;= NumberOfSheets).
  4478. </member>
  4479. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFWorkbook.SetPrintArea(System.Int32,System.String)" -->
  4480. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetPrintArea(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  4481. For the Convenience of Java Programmers maintaining pointers.
  4482. @see #setPrintArea(int, String)
  4483. @param sheetIndex Zero-based sheet index (0 = First Sheet)
  4484. @param startColumn Column to begin printarea
  4485. @param endColumn Column to end the printarea
  4486. @param startRow Row to begin the printarea
  4487. @param endRow Row to end the printarea
  4488. </member>
  4489. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetRepeatingRowsAndColumns(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  4490. Sets the repeating rows and columns for a sheet.
  4491. <p/>
  4492. To Set just repeating columns:
  4493. <pre>
  4494. workbook.SetRepeatingRowsAndColumns(0,0,1,-1,-1);
  4495. </pre>
  4496. To Set just repeating rows:
  4497. <pre>
  4498. workbook.SetRepeatingRowsAndColumns(0,-1,-1,0,4);
  4499. </pre>
  4500. To remove all repeating rows and columns for a sheet.
  4501. <pre>
  4502. workbook.SetRepeatingRowsAndColumns(0,-1,-1,-1,-1);
  4503. </pre>
  4504. @param sheetIndex 0 based index to sheet.
  4505. @param startColumn 0 based start of repeating columns.
  4506. @param endColumn 0 based end of repeating columns.
  4507. @param startRow 0 based start of repeating rows.
  4508. @param endRow 0 based end of repeating rows.
  4509. </member>
  4510. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateBuiltInName(System.String,System.Int32)">
  4511. Generates a NameRecord to represent a built-in region
  4512. @return a new NameRecord
  4513. @throws ArgumentException if sheetNumber is invalid
  4514. @throws POIXMLException if such a name already exists in the workbook
  4515. </member>
  4516. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSelectedTab(System.Int32)">
  4517. We only Set one sheet as selected for compatibility with HSSF.
  4518. </member>
  4519. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetName(System.Int32,System.String)">
  4520. Set the sheet name.
  4521. @param sheetIndex sheet number (0 based)
  4522. @param sheetname the new sheet name
  4523. @throws ArgumentException if the name is null or invalid
  4524. or workbook already Contains a sheet with this name
  4525. @see {@link #CreateSheet(String)}
  4526. @see {@link NPOI.ss.util.WorkbookUtil#CreateSafeSheetName(String nameProposal)}
  4527. for a safe way to create valid names
  4528. </member>
  4529. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetOrder(System.String,System.Int32)">
  4530. Sets the order of appearance for a given sheet.
  4531. @param sheetname the name of the sheet to reorder
  4532. @param pos the position that we want to insert the sheet into (0 based)
  4533. </member>
  4534. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SaveNamedRanges">
  4535. marshal named ranges from the {@link #namedRanges} collection to the underlying CT_Workbook bean
  4536. </member>
  4537. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSharedStringSource">
  4538. Returns SharedStringsTable - tha cache of string for this workbook
  4539. @return the shared string table
  4540. </member>
  4541. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetStylesSource">
  4542. Return a object representing a collection of shared objects used for styling content,
  4543. e.g. fonts, cell styles, colors, etc.
  4544. </member>
  4545. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetTheme">
  4546. Returns the Theme of current workbook.
  4547. </member>
  4548. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCreationHelper">
  4549. Returns an object that handles instantiating concrete
  4550. classes of the various instances for XSSF.
  4551. </member>
  4552. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.ContainsSheet(System.String,System.Int32)">
  4553. Determines whether a workbook Contains the provided sheet name.
  4554. For the purpose of comparison, long names are tRuncated to 31 chars.
  4555. @param name the name to Test (case insensitive match)
  4556. @param excludeSheetIdx the sheet to exclude from the check or -1 to include all sheets in the Check.
  4557. @return true if the sheet Contains the name, false otherwise.
  4558. </member>
  4559. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsDate1904">
  4560. Gets a bool value that indicates whether the date systems used in the workbook starts in 1904.
  4561. <p>
  4562. The default value is false, meaning that the workbook uses the 1900 date system,
  4563. where 1/1/1900 is the first day in the system..
  4564. </p>
  4565. @return true if the date systems used in the workbook starts in 1904
  4566. </member>
  4567. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetAllEmbedds">
  4568. Get the document's embedded files.
  4569. </member>
  4570. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsSheetHidden(System.Int32)">
  4571. Check whether a sheet is hidden.
  4572. <p>
  4573. Note that a sheet could instead be Set to be very hidden, which is different
  4574. ({@link #isSheetVeryHidden(int)})
  4575. </p>
  4576. @param sheetIx Number
  4577. @return <code>true</code> if sheet is hidden
  4578. </member>
  4579. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsSheetVeryHidden(System.Int32)">
  4580. Check whether a sheet is very hidden.
  4581. <p>
  4582. This is different from the normal hidden status
  4583. ({@link #isSheetHidden(int)})
  4584. </p>
  4585. @param sheetIx sheet index to check
  4586. @return <code>true</code> if sheet is very hidden
  4587. </member>
  4588. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetHidden(System.Int32,System.Boolean)">
  4589. Sets the visible state of this sheet.
  4590. <p>
  4591. Calling <code>setSheetHidden(sheetIndex, true)</code> is equivalent to
  4592. <code>setSheetHidden(sheetIndex, Workbook.SHEET_STATE_HIDDEN)</code>.
  4593. <br/>
  4594. Calling <code>setSheetHidden(sheetIndex, false)</code> is equivalent to
  4595. <code>setSheetHidden(sheetIndex, Workbook.SHEET_STATE_VISIBLE)</code>.
  4596. </p>
  4597. @param sheetIx the 0-based index of the sheet
  4598. @param hidden whether this sheet is hidden
  4599. @see #setSheetHidden(int, int)
  4600. </member>
  4601. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetHidden(System.Int32,NPOI.SS.UserModel.SheetState)">
  4602. Hide or unhide a sheet.
  4603. <ul>
  4604. <li>0 - visible. </li>
  4605. <li>1 - hidden. </li>
  4606. <li>2 - very hidden.</li>
  4607. </ul>
  4608. @param sheetIx the sheet index (0-based)
  4609. @param state one of the following <code>Workbook</code> constants:
  4610. <code>Workbook.SHEET_STATE_VISIBLE</code>,
  4611. <code>Workbook.SHEET_STATE_HIDDEN</code>, or
  4612. <code>Workbook.SHEET_STATE_VERY_HIDDEN</code>.
  4613. @throws ArgumentException if the supplied sheet index or state is invalid
  4614. </member>
  4615. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetHidden(System.Int32,System.Int32)">
  4616. <summary>
  4617. Hide or unhide a sheet.
  4618. </summary>
  4619. <param name="sheetIx">The sheet number</param>
  4620. <param name="hidden">0 for not hidden, 1 for hidden, 2 for very hidden</param>
  4621. </member>
  4622. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.OnDeleteFormula(NPOI.XSSF.UserModel.XSSFCell)">
  4623. Fired when a formula is deleted from this workbook,
  4624. for example when calling cell.SetCellFormula(null)
  4625. @see XSSFCell#setCellFormula(String)
  4626. </member>
  4627. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCalculationChain">
  4628. Return the CalculationChain object for this workbook
  4629. <p>
  4630. The calculation chain object specifies the order in which the cells in a workbook were last calculated
  4631. </p>
  4632. @return the <code>CalculationChain</code> object or <code>null</code> if not defined
  4633. </member>
  4634. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCustomXMLMappings">
  4635. @return a collection of custom XML mappings defined in this workbook
  4636. </member>
  4637. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetMapInfo">
  4638. @return the helper class used to query the custom XML mapping defined in this workbook
  4639. </member>
  4640. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsStructureLocked">
  4641. Specifies a bool value that indicates whether structure of workbook is locked. <br/>
  4642. A value true indicates the structure of the workbook is locked. Worksheets in the workbook can't be Moved,
  4643. deleted, hidden, unhidden, or Renamed, and new worksheets can't be inserted.<br/>
  4644. A value of false indicates the structure of the workbook is not locked.<br/>
  4645. @return true if structure of workbook is locked
  4646. </member>
  4647. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsWindowsLocked">
  4648. Specifies a bool value that indicates whether the windows that comprise the workbook are locked. <br/>
  4649. A value of true indicates the workbook windows are locked. Windows are the same size and position each time the
  4650. workbook is opened.<br/>
  4651. A value of false indicates the workbook windows are not locked.
  4652. @return true if windows that comprise the workbook are locked
  4653. </member>
  4654. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsRevisionLocked">
  4655. Specifies a bool value that indicates whether the workbook is locked for revisions.
  4656. @return true if the workbook is locked for revisions.
  4657. </member>
  4658. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.LockStructure">
  4659. Locks the structure of workbook.
  4660. </member>
  4661. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.UnlockStructure">
  4662. Unlocks the structure of workbook.
  4663. </member>
  4664. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.LockWindows">
  4665. Locks the windows that comprise the workbook.
  4666. </member>
  4667. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.UnlockWindows">
  4668. Unlocks the windows that comprise the workbook.
  4669. </member>
  4670. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.LockRevision">
  4671. Locks the workbook for revisions.
  4672. </member>
  4673. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.UnlockRevision">
  4674. Unlocks the workbook for revisions.
  4675. </member>
  4676. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetUDFFinder">
  4677. Returns the locator of user-defined functions.
  4678. <p>
  4679. The default instance : the built-in functions with the Excel Analysis Tool Pack.
  4680. To Set / Evaluate custom functions you need to register them as follows:
  4681. </p>
  4682. @return wrapped instance of UDFFinder that allows seeking functions both by index and name
  4683. </member>
  4684. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.AddToolPack(NPOI.SS.Formula.Udf.UDFFinder)">
  4685. Register a new toolpack in this workbook.
  4686. @param toopack the toolpack to register
  4687. </member>
  4688. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetForceFormulaRecalculation(System.Boolean)">
  4689. Whether the application shall perform a full recalculation when the workbook is opened.
  4690. <p>
  4691. Typically you want to force formula recalculation when you modify cell formulas or values
  4692. of a workbook previously Created by Excel. When Set to true, this flag will tell Excel
  4693. that it needs to recalculate all formulas in the workbook the next time the file is opened.
  4694. </p>
  4695. <p>
  4696. Note, that recalculation updates cached formula results and, thus, modifies the workbook.
  4697. Depending on the version, Excel may prompt you with "Do you want to save the Changes in <em>filename</em>?"
  4698. on close.
  4699. </p>
  4700. @param value true if the application will perform a full recalculation of
  4701. workbook values when the workbook is opened
  4702. @since 3.8
  4703. </member>
  4704. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetForceFormulaRecalculation">
  4705. Whether Excel will be asked to recalculate all formulas when the workbook is opened.
  4706. @since 3.8
  4707. </member>
  4708. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.ActiveSheetIndex">
  4709. Convenience method to Get the active sheet. The active sheet is is the sheet
  4710. which is currently displayed when the workbook is viewed in Excel.
  4711. 'Selected' sheet(s) is a distinct concept.
  4712. </member>
  4713. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.NumCellStyles">
  4714. Get the number of styles the workbook Contains
  4715. @return count of cell styles
  4716. </member>
  4717. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.NumberOfFonts">
  4718. Get the number of fonts in the this workbook
  4719. @return number of fonts
  4720. </member>
  4721. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.NumberOfNames">
  4722. Get the number of named ranges in the this workbook
  4723. @return number of named ranges
  4724. </member>
  4725. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.NumberOfSheets">
  4726. Get the number of worksheets in the this workbook
  4727. @return number of worksheets
  4728. </member>
  4729. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.MissingCellPolicy">
  4730. Retrieves the current policy on what to do when
  4731. Getting missing or blank cells from a row.
  4732. The default is to return blank and null cells.
  4733. {@link MissingCellPolicy}
  4734. </member>
  4735. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.FirstVisibleTab">
  4736. Gets the first tab that is displayed in the list of tabs in excel.
  4737. @return integer that Contains the index to the active sheet in this book view.
  4738. </member>
  4739. <member name="T:NPOI.XSSF.Util.EvilUnclosedBRFixingInputStream">
  4740. This is a seriously sick fix for the fact that some .xlsx
  4741. files contain raw bits of HTML, without being escaped
  4742. or properly turned into XML.
  4743. The result is that they contain things like &gt;br&lt;,
  4744. which breaks the XML parsing.
  4745. This very sick InputStream wrapper attempts to spot
  4746. these go past, and fix them.
  4747. Only works for UTF-8 and US-ASCII based streams!
  4748. It should only be used where experience Shows the problem
  4749. can occur...
  4750. </member>
  4751. <member name="M:NPOI.XSSF.Util.EvilUnclosedBRFixingInputStream.Read">
  4752. Warning - doesn't fix!
  4753. </member>
  4754. <member name="M:NPOI.XSSF.Util.EvilUnclosedBRFixingInputStream.ReadFromSpare(System.Byte[],System.Int32,System.Int32)">
  4755. Reads into the buffer from the spare bytes
  4756. </member>
  4757. <member name="T:NPOI.XWPF.Extractor.XWPFWordExtractor">
  4758. Helper class to extract text from an OOXML Word file
  4759. </member>
  4760. <member name="M:NPOI.XWPF.Extractor.XWPFWordExtractor.SetFetchHyperlinks(System.Boolean)">
  4761. Should we also fetch the hyperlinks, when fetching
  4762. the text content? Default is to only output the
  4763. hyperlink label, and not the contents
  4764. </member>
  4765. <member name="T:NPOI.XWPF.Model.XMLParagraph">
  4766. Base class for XWPF paragraphs
  4767. @author Yury Batrakov (batrakov at gmail.com)
  4768. </member>
  4769. <member name="T:NPOI.XWPF.Model.XWPFCommentsDecorator">
  4770. Decorator class for XWPFParagraph allowing to add comments
  4771. found in paragraph to its text
  4772. @author Yury Batrakov (batrakov at gmail.com)
  4773. </member>
  4774. <member name="T:NPOI.XWPF.Model.XWPFParagraphDecorator">
  4775. Base decorator class for XWPFParagraph
  4776. </member>
  4777. <member name="T:NPOI.XWPF.Model.XWPFHeaderFooterPolicy">
  4778. A .docx file can have no headers/footers, the same header/footer
  4779. on each page, odd/even page footers, and optionally also
  4780. a different header/footer on the first page.
  4781. This class handles sorting out what there is, and giving you
  4782. the right headers and footers for the document.
  4783. </member>
  4784. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.#ctor(NPOI.XWPF.UserModel.XWPFDocument)">
  4785. Figures out the policy for the given document,
  4786. and Creates any header and footer objects
  4787. as required.
  4788. </member>
  4789. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.#ctor(NPOI.XWPF.UserModel.XWPFDocument,NPOI.OpenXmlFormats.Wordprocessing.CT_SectPr)">
  4790. Figures out the policy for the given document,
  4791. and Creates any header and footer objects
  4792. as required.
  4793. </member>
  4794. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.buildHdrFtr(System.String,NPOI.XWPF.UserModel.XWPFParagraph[],NPOI.XWPF.UserModel.XWPFHeaderFooter)">
  4795. MB 24 May 2010. Created this overloaded buildHdrFtr() method because testing demonstrated
  4796. that the XWPFFooter or XWPFHeader object returned by calls to the CreateHeader(int, XWPFParagraph[])
  4797. and CreateFooter(int, XWPFParagraph[]) methods or the GetXXXXXHeader/Footer methods where
  4798. headers or footers had been Added to a document since it had been Created/opened, returned
  4799. an object that Contained no XWPFParagraph objects even if the header/footer itself did contain
  4800. text. The reason was that this line of code; CTHdrFtr ftr = CTHdrFtr.Factory.NewInstance();
  4801. Created a brand new instance of the CTHDRFtr class which was then populated with data when
  4802. it should have recovered the CTHdrFtr object encapsulated within the XWPFHeaderFooter object
  4803. that had previoulsy been instantiated in the CreateHeader(int, XWPFParagraph[]) or
  4804. CreateFooter(int, XWPFParagraph[]) methods.
  4805. </member>
  4806. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.GetOddPageHeader">
  4807. Returns the odd page header. This is
  4808. also the same as the default one...
  4809. </member>
  4810. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.GetOddPageFooter">
  4811. Returns the odd page footer. This is
  4812. also the same as the default one...
  4813. </member>
  4814. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.GetHeader(System.Int32)">
  4815. Get the header that applies to the given
  4816. (1 based) page.
  4817. @param pageNumber The one based page number
  4818. </member>
  4819. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.GetFooter(System.Int32)">
  4820. Get the footer that applies to the given
  4821. (1 based) page.
  4822. @param pageNumber The one based page number
  4823. </member>
  4824. <member name="T:NPOI.XWPF.Model.XWPFHyperlinkDecorator">
  4825. Decorator class for XWPFParagraph allowing to add hyperlinks
  4826. found in paragraph to its text.
  4827. Note - Adds the hyperlink at the end, not in the right place...
  4828. @deprecated Use {@link XWPFHyperlinkRun} instead
  4829. </member>
  4830. <member name="M:NPOI.XWPF.Model.XWPFHyperlinkDecorator.#ctor(NPOI.XWPF.Model.XWPFParagraphDecorator,System.Boolean)">
  4831. @param nextDecorator The next decorator to use
  4832. @param outputHyperlinkUrls Should we output the links too, or just the link text?
  4833. </member>
  4834. <member name="M:NPOI.XWPF.Model.XWPFHyperlinkDecorator.#ctor(NPOI.XWPF.UserModel.XWPFParagraph,NPOI.XWPF.Model.XWPFParagraphDecorator,System.Boolean)">
  4835. @param prgrph The paragraph of text to work on
  4836. @param outputHyperlinkUrls Should we output the links too, or just the link text?
  4837. </member>
  4838. <member name="T:NPOI.XWPF.UserModel.BodyElementType">
  4839. <p>
  4840. 9 Jan 2010
  4841. </p>
  4842. <p>
  4843. // TODO insert Javadoc here!
  4844. </p>
  4845. @author epp
  4846. </member>
  4847. <member name="T:NPOI.XWPF.UserModel.BodyType">
  4848. <p>
  4849. 9 Jan 2010
  4850. </p>
  4851. <p>
  4852. // TODO insert Javadoc here!
  4853. </p>
  4854. @author epp
  4855. </member>
  4856. <member name="T:NPOI.XWPF.UserModel.Borders">
  4857. Specifies all types of borders which can be specified for WordProcessingML
  4858. objects which have a border. Borders can be Separated into two types:
  4859. <ul>
  4860. <li> Line borders: which specify a pattern to be used when Drawing a line around the
  4861. specified object.
  4862. </li>
  4863. <li> Art borders: which specify a repeated image to be used
  4864. when Drawing a border around the specified object. Line borders may be
  4865. specified on any object which allows a border, however, art borders may only
  4866. be used as a border at the page level - the borders under the pgBorders
  4867. element
  4868. </li>
  4869. </ul>
  4870. @author Gisella Bronzetti
  4871. </member>
  4872. <member name="F:NPOI.XWPF.UserModel.Borders.SINGLE">
  4873. Specifies a line border consisting of a single line around the parent
  4874. object.
  4875. </member>
  4876. <member name="F:NPOI.XWPF.UserModel.Borders.APPLES">
  4877. Specifies an art border consisting of a repeated image of an apple
  4878. </member>
  4879. <member name="F:NPOI.XWPF.UserModel.Borders.ARCHED_SCALLOPS">
  4880. Specifies an art border consisting of a repeated image of a shell pattern
  4881. </member>
  4882. <member name="F:NPOI.XWPF.UserModel.Borders.BABY_PACIFIER">
  4883. Specifies an art border consisting of a repeated image of a baby pacifier
  4884. </member>
  4885. <member name="F:NPOI.XWPF.UserModel.Borders.BABY_RATTLE">
  4886. Specifies an art border consisting of a repeated image of a baby rattle
  4887. </member>
  4888. <member name="F:NPOI.XWPF.UserModel.Borders.BALLOONS_3_COLORS">
  4889. Specifies an art border consisting of a repeated image of a Set of
  4890. balloons
  4891. </member>
  4892. <member name="F:NPOI.XWPF.UserModel.Borders.BALLOONS_HOT_AIR">
  4893. Specifies an art border consisting of a repeated image of a hot air
  4894. balloon
  4895. </member>
  4896. <member name="F:NPOI.XWPF.UserModel.Borders.BASIC_BLACK_DASHES">
  4897. Specifies an art border consisting of a repeating image of a black and
  4898. white background.
  4899. </member>
  4900. <member name="F:NPOI.XWPF.UserModel.Borders.BASIC_BLACK_DOTS">
  4901. Specifies an art border consisting of a repeating image of a black dot on
  4902. a white background.
  4903. </member>
  4904. <member name="F:NPOI.XWPF.UserModel.Borders.BASIC_BLACK_SQUARES">
  4905. Specifies an art border consisting of a repeating image of a black and
  4906. white background
  4907. </member>
  4908. <member name="F:NPOI.XWPF.UserModel.Borders.BASIC_THIN_LINES">
  4909. Specifies an art border consisting of a repeating image of a black and
  4910. white background.
  4911. </member>
  4912. <member name="F:NPOI.XWPF.UserModel.Borders.BASIC_WHITE_DASHES">
  4913. Specifies an art border consisting of a repeating image of a black and
  4914. white background.
  4915. </member>
  4916. <member name="F:NPOI.XWPF.UserModel.Borders.BASIC_WHITE_DOTS">
  4917. Specifies an art border consisting of a repeating image of a white dot on
  4918. a black background.
  4919. </member>
  4920. <member name="F:NPOI.XWPF.UserModel.Borders.BASIC_WHITE_SQUARES">
  4921. Specifies an art border consisting of a repeating image of a black and
  4922. white background.
  4923. </member>
  4924. <member name="F:NPOI.XWPF.UserModel.Borders.BASIC_WIDE_INLINE">
  4925. Specifies an art border consisting of a repeating image of a black and
  4926. white background.
  4927. </member>
  4928. <member name="F:NPOI.XWPF.UserModel.Borders.BASIC_WIDE_MIDLINE">
  4929. Specifies an art border consisting of a repeating image of a black and
  4930. white background
  4931. </member>
  4932. <member name="F:NPOI.XWPF.UserModel.Borders.BASIC_WIDE_OUTLINE">
  4933. Specifies an art border consisting of a repeating image of a black and
  4934. white background
  4935. </member>
  4936. <member name="F:NPOI.XWPF.UserModel.Borders.BATS">
  4937. Specifies an art border consisting of a repeated image of bats
  4938. </member>
  4939. <member name="F:NPOI.XWPF.UserModel.Borders.BIRDS">
  4940. Specifies an art border consisting of repeating images of birds
  4941. </member>
  4942. <member name="F:NPOI.XWPF.UserModel.Borders.BIRDS_FLIGHT">
  4943. Specifies an art border consisting of a repeated image of birds flying
  4944. </member>
  4945. <member name="F:NPOI.XWPF.UserModel.Borders.CABINS">
  4946. Specifies an art border consisting of a repeated image of a cabin
  4947. </member>
  4948. <member name="F:NPOI.XWPF.UserModel.Borders.CAKE_SLICE">
  4949. Specifies an art border consisting of a repeated image of a piece of cake
  4950. </member>
  4951. <member name="F:NPOI.XWPF.UserModel.Borders.CANDY_CORN">
  4952. Specifies an art border consisting of a repeated image of candy corn
  4953. </member>
  4954. <member name="F:NPOI.XWPF.UserModel.Borders.CELTIC_KNOTWORK">
  4955. Specifies an art border consisting of a repeated image of a knot work
  4956. pattern
  4957. </member>
  4958. <member name="F:NPOI.XWPF.UserModel.Borders.CERTIFICATE_BANNER">
  4959. Specifies an art border consisting of a banner.
  4960. <p>
  4961. If the border is on the left or right, no border is displayed.
  4962. </p>
  4963. </member>
  4964. <member name="F:NPOI.XWPF.UserModel.Borders.CHAIN_LINK">
  4965. Specifies an art border consisting of a repeating image of a chain link
  4966. pattern.
  4967. </member>
  4968. <member name="F:NPOI.XWPF.UserModel.Borders.CHAMPAGNE_BOTTLE">
  4969. Specifies an art border consisting of a repeated image of a champagne
  4970. bottle
  4971. </member>
  4972. <member name="F:NPOI.XWPF.UserModel.Borders.CHECKED_BAR_BLACK">
  4973. Specifies an art border consisting of repeating images of a compass
  4974. </member>
  4975. <member name="F:NPOI.XWPF.UserModel.Borders.CHECKED_BAR_COLOR">
  4976. Specifies an art border consisting of a repeating image of a colored
  4977. pattern.
  4978. </member>
  4979. <member name="F:NPOI.XWPF.UserModel.Borders.CHECKERED">
  4980. Specifies an art border consisting of a repeated image of a Checkerboard
  4981. </member>
  4982. <member name="F:NPOI.XWPF.UserModel.Borders.CHRISTMAS_TREE">
  4983. Specifies an art border consisting of a repeated image of a Christmas
  4984. tree
  4985. </member>
  4986. <member name="F:NPOI.XWPF.UserModel.Borders.CIRCLES_LINES">
  4987. Specifies an art border consisting of repeating images of lines and
  4988. circles
  4989. </member>
  4990. <member name="F:NPOI.XWPF.UserModel.Borders.CIRCLES_RECTANGLES">
  4991. Specifies an art border consisting of a repeated image of a rectangular
  4992. pattern
  4993. </member>
  4994. <member name="F:NPOI.XWPF.UserModel.Borders.CLASSICAL_WAVE">
  4995. Specifies an art border consisting of a repeated image of a wave
  4996. </member>
  4997. <member name="F:NPOI.XWPF.UserModel.Borders.CLOCKS">
  4998. Specifies an art border consisting of a repeated image of a clock
  4999. </member>
  5000. <member name="F:NPOI.XWPF.UserModel.Borders.COMPASS">
  5001. Specifies an art border consisting of repeating images of a compass
  5002. </member>
  5003. <member name="F:NPOI.XWPF.UserModel.Borders.CONFETTI">
  5004. Specifies an art border consisting of a repeated image of confetti
  5005. </member>
  5006. <member name="F:NPOI.XWPF.UserModel.Borders.CONFETTI_GRAYS">
  5007. Specifies an art border consisting of a repeated image of confetti
  5008. </member>
  5009. <member name="F:NPOI.XWPF.UserModel.Borders.CONFETTI_OUTLINE">
  5010. Specifies an art border consisting of a repeated image of confetti
  5011. </member>
  5012. <member name="F:NPOI.XWPF.UserModel.Borders.CONFETTI_STREAMERS">
  5013. Specifies an art border consisting of a repeated image of confetti
  5014. streamers
  5015. </member>
  5016. <member name="F:NPOI.XWPF.UserModel.Borders.CONFETTI_WHITE">
  5017. Specifies an art border consisting of a repeated image of confetti
  5018. </member>
  5019. <member name="F:NPOI.XWPF.UserModel.Borders.CORNER_TRIANGLES">
  5020. Specifies an art border consisting of a repeated image
  5021. </member>
  5022. <member name="F:NPOI.XWPF.UserModel.Borders.COUPON_CUTOUT_DASHES">
  5023. Specifies an art border consisting of a dashed line
  5024. </member>
  5025. <member name="F:NPOI.XWPF.UserModel.Borders.COUPON_CUTOUT_DOTS">
  5026. Specifies an art border consisting of a dotted line
  5027. </member>
  5028. <member name="F:NPOI.XWPF.UserModel.Borders.CRAZY_MAZE">
  5029. Specifies an art border consisting of a repeated image of a maze-like
  5030. pattern
  5031. </member>
  5032. <member name="F:NPOI.XWPF.UserModel.Borders.CREATURES_BUTTERFLY">
  5033. Specifies an art border consisting of a repeated image of a butterfly
  5034. </member>
  5035. <member name="F:NPOI.XWPF.UserModel.Borders.CREATURES_FISH">
  5036. Specifies an art border consisting of a repeated image of a fish
  5037. </member>
  5038. <member name="F:NPOI.XWPF.UserModel.Borders.CREATURES_INSECTS">
  5039. Specifies an art border consisting of repeating images of insects.
  5040. </member>
  5041. <member name="F:NPOI.XWPF.UserModel.Borders.CREATURES_LADY_BUG">
  5042. Specifies an art border consisting of a repeated image of a ladybug
  5043. </member>
  5044. <member name="F:NPOI.XWPF.UserModel.Borders.CROSS_STITCH">
  5045. Specifies an art border consisting of repeating images of a cross-stitch
  5046. pattern
  5047. </member>
  5048. <member name="F:NPOI.XWPF.UserModel.Borders.CUP">
  5049. Specifies an art border consisting of a repeated image of Cupid
  5050. </member>
  5051. <member name="T:NPOI.XWPF.UserModel.BreakClear">
  5052. Specifies the Set of possible restart locations which may be used as to
  5053. determine the next available line when a break's type attribute has a value
  5054. of textWrapping.
  5055. @author Gisella Bronzetti
  5056. </member>
  5057. <member name="F:NPOI.XWPF.UserModel.BreakClear.NONE">
  5058. Specifies that the text wrapping break shall advance the text to the next
  5059. line in the WordProcessingML document, regardless of its position left to
  5060. right or the presence of any floating objects which intersect with the
  5061. line,
  5062. This is the Setting for a typical line break in a document.
  5063. </member>
  5064. <member name="F:NPOI.XWPF.UserModel.BreakClear.LEFT">
  5065. Specifies that the text wrapping break shall behave as follows:
  5066. <ul>
  5067. <li> If this line is broken into multiple regions (a floating object in
  5068. the center of the page has text wrapping on both sides:
  5069. <ul>
  5070. <li> If this is the leftmost region of text flow on this line, advance
  5071. the text to the next position on the line </li>
  5072. <li>Otherwise, treat this as a text wrapping break of type all. </li>
  5073. </ul>
  5074. </li>
  5075. <li> If this line is not broken into multiple regions, then treat this
  5076. break as a text wrapping break of type none. </li>
  5077. </ul>
  5078. <li> If the parent paragraph is right to left, then these behaviors are
  5079. also reversed. </li>
  5080. </member>
  5081. <!-- Badly formed XML comment ignored for member "F:NPOI.XWPF.UserModel.BreakClear.RIGHT" -->
  5082. <member name="F:NPOI.XWPF.UserModel.BreakClear.ALL">
  5083. Specifies that the text wrapping break shall advance the text to the next
  5084. line in the WordProcessingML document which spans the full width of the
  5085. line.
  5086. </member>
  5087. <member name="T:NPOI.XWPF.UserModel.BreakType">
  5088. Specifies the possible types of break characters in a WordProcessingML
  5089. document.
  5090. The break type determines the next location where text shall be
  5091. placed After this manual break is applied to the text contents
  5092. @author Gisella Bronzetti
  5093. </member>
  5094. <member name="F:NPOI.XWPF.UserModel.BreakType.PAGE">
  5095. Specifies that the current break shall restart itself on the next page of
  5096. the document when the document is displayed in page view.
  5097. </member>
  5098. <member name="F:NPOI.XWPF.UserModel.BreakType.COLUMN">
  5099. Specifies that the current break shall restart itself on the next column
  5100. available on the current page when the document is displayed in page
  5101. view.
  5102. <p>
  5103. If the current section is not divided into columns, or the column break
  5104. occurs in the last column on the current page when displayed, then the
  5105. restart location for text shall be the next page in the document.
  5106. </p>
  5107. </member>
  5108. <member name="F:NPOI.XWPF.UserModel.BreakType.TEXTWRAPPING">
  5109. Specifies that the current break shall restart itself on the next line in
  5110. the document when the document is displayed in page view.
  5111. The determine of the next line shall be done subject to the value of the clear
  5112. attribute on the specified break character.
  5113. </member>
  5114. <member name="F:NPOI.XWPF.UserModel.PictureType.EMF">
  5115. Extended windows meta file
  5116. </member>
  5117. <member name="F:NPOI.XWPF.UserModel.PictureType.WMF">
  5118. Windows Meta File
  5119. </member>
  5120. <member name="F:NPOI.XWPF.UserModel.PictureType.PICT">
  5121. Mac PICT format
  5122. </member>
  5123. <member name="F:NPOI.XWPF.UserModel.PictureType.JPEG">
  5124. JPEG format
  5125. </member>
  5126. <member name="F:NPOI.XWPF.UserModel.PictureType.PNG">
  5127. PNG format
  5128. </member>
  5129. <member name="F:NPOI.XWPF.UserModel.PictureType.DIB">
  5130. Device independent bitmap
  5131. </member>
  5132. <member name="F:NPOI.XWPF.UserModel.PictureType.GIF">
  5133. GIF image format
  5134. </member>
  5135. <member name="F:NPOI.XWPF.UserModel.PictureType.TIFF">
  5136. Tag Image File (.tiff)
  5137. </member>
  5138. <member name="F:NPOI.XWPF.UserModel.PictureType.EPS">
  5139. Encapsulated Postscript (.eps)
  5140. </member>
  5141. <member name="F:NPOI.XWPF.UserModel.PictureType.BMP">
  5142. Windows Bitmap (.bmp)
  5143. </member>
  5144. <member name="F:NPOI.XWPF.UserModel.PictureType.WPG">
  5145. WordPerfect graphics (.wpg)
  5146. </member>
  5147. <member name="T:NPOI.XWPF.UserModel.IBody">
  5148. <p>
  5149. 8 Jan 2010
  5150. </p>
  5151. <p>
  5152. // This Interface represents an object, which is able to have a collection of paragraphs and tables
  5153. this can be XWFPDocument, XWPFHeader, XWPFFooter, XWPFTableCell
  5154. </p>
  5155. @author Philipp Epp
  5156. </member>
  5157. <member name="M:NPOI.XWPF.UserModel.IBody.GetPart">
  5158. returns the Part, to which the body belongs, which you need for Adding relationship to other parts
  5159. Actually it is needed of the class XWPFTableCell. Because you have to know to which part the tableCell
  5160. belongs.
  5161. @return the Part, to which the body belongs
  5162. </member>
  5163. <member name="M:NPOI.XWPF.UserModel.IBody.GetParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  5164. if there is a corresponding {@link XWPFParagraph} of the parameter ctTable in the paragraphList of this header or footer
  5165. the method will return this paragraph
  5166. if there is no corresponding {@link XWPFParagraph} the method will return null
  5167. @param p is instance of CTP and is searching for an XWPFParagraph
  5168. @return null if there is no XWPFParagraph with an corresponding CTPparagraph in the paragraphList of this header or footer
  5169. XWPFParagraph with the correspondig CTP p
  5170. </member>
  5171. <member name="M:NPOI.XWPF.UserModel.IBody.GetTable(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  5172. if there is a corresponding {@link XWPFTable} of the parameter ctTable in the tableList of this header
  5173. the method will return this table
  5174. if there is no corresponding {@link XWPFTable} the method will return null
  5175. @param ctTable
  5176. </member>
  5177. <member name="M:NPOI.XWPF.UserModel.IBody.GetParagraphArray(System.Int32)">
  5178. Returns the paragraph that of position pos
  5179. </member>
  5180. <member name="M:NPOI.XWPF.UserModel.IBody.GetTableArray(System.Int32)">
  5181. Returns the table at position pos
  5182. </member>
  5183. <member name="M:NPOI.XWPF.UserModel.IBody.InsertNewParagraph(System.Xml.XmlDocument)">
  5184. inserts a new paragraph at position of the cursor
  5185. @param cursor
  5186. </member>
  5187. <member name="M:NPOI.XWPF.UserModel.IBody.InsertNewTbl(System.Xml.XmlDocument)">
  5188. inserts a new Table at the cursor position.
  5189. @param cursor
  5190. </member>
  5191. <member name="M:NPOI.XWPF.UserModel.IBody.InsertTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  5192. inserts a new Table at position pos
  5193. @param pos
  5194. @param table
  5195. </member>
  5196. <member name="M:NPOI.XWPF.UserModel.IBody.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  5197. returns the TableCell to which the Table belongs
  5198. @param cell
  5199. </member>
  5200. <member name="M:NPOI.XWPF.UserModel.IBody.GetXWPFDocument">
  5201. Return XWPFDocument
  5202. </member>
  5203. <member name="P:NPOI.XWPF.UserModel.IBody.PartType">
  5204. Get the PartType of the body, for example
  5205. DOCUMENT, HEADER, FOOTER, FOOTNOTE,
  5206. @return the PartType of the body
  5207. </member>
  5208. <member name="P:NPOI.XWPF.UserModel.IBody.BodyElements">
  5209. Returns an Iterator with paragraphs and tables,
  5210. in the order that they occur in the text.
  5211. </member>
  5212. <member name="P:NPOI.XWPF.UserModel.IBody.Paragraphs">
  5213. Returns the paragraph(s) that holds
  5214. the text of the header or footer.
  5215. </member>
  5216. <member name="P:NPOI.XWPF.UserModel.IBody.Tables">
  5217. Return the table(s) that holds the text
  5218. of the IBodyPart, for complex cases
  5219. where a paragraph isn't used.
  5220. </member>
  5221. <member name="T:NPOI.XWPF.UserModel.IBodyElement">
  5222. 9 Jan 2010
  5223. @author Philipp Epp
  5224. </member>
  5225. <member name="T:NPOI.XWPF.UserModel.LineSpacingRule">
  5226. Specifies the logic which shall be used to calculate the line spacing of the
  5227. parent object when it is displayed in the document.
  5228. @author Gisella Bronzetti
  5229. </member>
  5230. <member name="F:NPOI.XWPF.UserModel.LineSpacingRule.AUTO">
  5231. Specifies that the line spacing of the parent object shall be
  5232. automatically determined by the size of its contents, with no
  5233. predetermined minimum or maximum size.
  5234. </member>
  5235. <member name="F:NPOI.XWPF.UserModel.LineSpacingRule.EXACT">
  5236. Specifies that the height of the line shall be exactly the value
  5237. specified, regardless of the size of the contents If the contents are too
  5238. large for the specified height, then they shall be clipped as necessary.
  5239. </member>
  5240. <member name="F:NPOI.XWPF.UserModel.LineSpacingRule.ATLEAST">
  5241. Specifies that the height of the line shall be at least the value
  5242. specified, but may be expanded to fit its content as needed.
  5243. </member>
  5244. <member name="T:NPOI.XWPF.UserModel.ParagraphAlignment">
  5245. Specifies all types of alignment which are available to be applied to objects in a
  5246. WordProcessingML document
  5247. @author Yegor Kozlov
  5248. </member>
  5249. <member name="T:NPOI.XWPF.UserModel.PositionInParagraph">
  5250. * postion of a character in a paragrapho
  5251. * 1st RunPositon
  5252. * 2nd TextPosition
  5253. * 3rd CharacterPosition
  5254. *
  5255. *
  5256. </member>
  5257. <member name="T:NPOI.XWPF.UserModel.TextAlignment">
  5258. Specifies all types of vertical alignment which are available to be applied to of all text
  5259. on each line displayed within a paragraph.
  5260. @author Gisella Bronzetti
  5261. </member>
  5262. <member name="F:NPOI.XWPF.UserModel.TextAlignment.TOP">
  5263. Specifies that all text in the parent object shall be
  5264. aligned to the top of each character when displayed
  5265. </member>
  5266. <member name="F:NPOI.XWPF.UserModel.TextAlignment.CENTER">
  5267. Specifies that all text in the parent object shall be
  5268. aligned to the center of each character when displayed.
  5269. </member>
  5270. <member name="F:NPOI.XWPF.UserModel.TextAlignment.BASELINE">
  5271. Specifies that all text in the parent object shall be
  5272. aligned to the baseline of each character when displayed.
  5273. </member>
  5274. <member name="F:NPOI.XWPF.UserModel.TextAlignment.BOTTOM">
  5275. Specifies that all text in the parent object shall be
  5276. aligned to the bottom of each character when displayed.
  5277. </member>
  5278. <member name="F:NPOI.XWPF.UserModel.TextAlignment.AUTO">
  5279. Specifies that all text in the parent object shall be
  5280. aligned automatically when displayed.
  5281. </member>
  5282. <member name="T:NPOI.XWPF.UserModel.TextSegement">
  5283. saves the begin and end position of a text in a Paragraph
  5284. </member>
  5285. <member name="T:NPOI.XWPF.UserModel.UnderlinePatterns">
  5286. Specifies the types of patterns which may be used to create the underline
  5287. applied beneath the text in a Run.
  5288. @author Gisella Bronzetti
  5289. </member>
  5290. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Single">
  5291. Specifies an underline consisting of a single line beneath all characters
  5292. in this Run.
  5293. </member>
  5294. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Words">
  5295. Specifies an underline consisting of a single line beneath all non-space
  5296. characters in the Run. There shall be no underline beneath any space
  5297. character (breaking or non-breaking).
  5298. </member>
  5299. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Double">
  5300. Specifies an underline consisting of two lines beneath all characters in
  5301. this run
  5302. </member>
  5303. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Thick">
  5304. Specifies an underline consisting of a single thick line beneath all
  5305. characters in this Run.
  5306. </member>
  5307. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Dotted">
  5308. Specifies an underline consisting of a series of dot characters beneath
  5309. all characters in this Run.
  5310. </member>
  5311. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DottedHeavy">
  5312. Specifies an underline consisting of a series of thick dot characters
  5313. beneath all characters in this Run.
  5314. </member>
  5315. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Dash">
  5316. Specifies an underline consisting of a dashed line beneath all characters
  5317. in this Run.
  5318. </member>
  5319. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DashedHeavy">
  5320. Specifies an underline consisting of a series of thick dashes beneath all
  5321. characters in this Run.
  5322. </member>
  5323. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DashLong">
  5324. Specifies an underline consisting of long dashed characters beneath all
  5325. characters in this Run.
  5326. </member>
  5327. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DashLongHeavy">
  5328. Specifies an underline consisting of thick long dashed characters beneath
  5329. all characters in this Run.
  5330. </member>
  5331. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DotDash">
  5332. Specifies an underline consisting of a series of dash, dot characters
  5333. beneath all characters in this Run.
  5334. </member>
  5335. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DashDotHeavy">
  5336. Specifies an underline consisting of a series of thick dash, dot
  5337. characters beneath all characters in this Run.
  5338. </member>
  5339. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DotDotDash">
  5340. Specifies an underline consisting of a series of dash, dot, dot
  5341. characters beneath all characters in this Run.
  5342. </member>
  5343. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DashDotDotHeavy">
  5344. Specifies an underline consisting of a series of thick dash, dot, dot
  5345. characters beneath all characters in this Run.
  5346. </member>
  5347. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Wave">
  5348. Specifies an underline consisting of a single wavy line beneath all
  5349. characters in this Run.
  5350. </member>
  5351. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.WavyHeavy">
  5352. Specifies an underline consisting of a single thick wavy line beneath all
  5353. characters in this Run.
  5354. </member>
  5355. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.WavyDouble">
  5356. Specifies an underline consisting of a pair of wavy lines beneath all
  5357. characters in this Run.
  5358. </member>
  5359. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.None">
  5360. Specifies no underline beneath this Run.
  5361. </member>
  5362. <member name="T:NPOI.XWPF.UserModel.VerticalAlign">
  5363. Specifies possible values for the alignment of the contents of this run in
  5364. relation to the default appearance of the Run's text. This allows the text to
  5365. be repositioned as subscript or superscript without altering the font size of
  5366. the run properties.
  5367. @author Gisella Bronzetti
  5368. </member>
  5369. <member name="F:NPOI.XWPF.UserModel.VerticalAlign.BASELINE">
  5370. Specifies that the text in the parent run shall be located at the
  5371. baseline and presented in the same size as surrounding text.
  5372. </member>
  5373. <member name="F:NPOI.XWPF.UserModel.VerticalAlign.SUPERSCRIPT">
  5374. Specifies that this text should be subscript. This Setting shall lower
  5375. the text in this run below the baseline and change it to a smaller size,
  5376. if a smaller size is available.
  5377. </member>
  5378. <member name="F:NPOI.XWPF.UserModel.VerticalAlign.SUBSCRIPT">
  5379. Specifies that this text should be superscript. This Setting shall raise
  5380. the text in this run above the baseline and change it to a smaller size,
  5381. if a smaller size is available.
  5382. </member>
  5383. <member name="T:NPOI.XWPF.UserModel.XWPFAbstractNum">
  5384. @author Philipp Epp
  5385. </member>
  5386. <member name="P:NPOI.XWPF.UserModel.XWPFAbstractNum.MultiLevelType">
  5387. <summary>
  5388. Abstract Numbering Definition Type
  5389. </summary>
  5390. </member>
  5391. <member name="T:NPOI.XWPF.UserModel.MultiLevelType">
  5392. <summary>
  5393. Numbering Definition Type
  5394. </summary>
  5395. </member>
  5396. <member name="F:NPOI.XWPF.UserModel.MultiLevelType.SingleLevel">
  5397. <summary>
  5398. Single Level Numbering Definition
  5399. </summary>
  5400. </member>
  5401. <member name="F:NPOI.XWPF.UserModel.MultiLevelType.Multilevel">
  5402. <summary>
  5403. Multilevel Numbering Definition
  5404. </summary>
  5405. </member>
  5406. <member name="F:NPOI.XWPF.UserModel.MultiLevelType.HybridMultilevel">
  5407. <summary>
  5408. Hybrid Multilevel Numbering Definition
  5409. </summary>
  5410. </member>
  5411. <member name="T:NPOI.XWPF.UserModel.NumberFormat">
  5412. <summary>
  5413. Numbering Format
  5414. </summary>
  5415. </member>
  5416. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Decimal">
  5417. <summary>
  5418. Decimal Numbers
  5419. </summary>
  5420. </member>
  5421. <member name="F:NPOI.XWPF.UserModel.NumberFormat.UpperRoman">
  5422. <summary>
  5423. Uppercase Roman Numerals
  5424. </summary>
  5425. </member>
  5426. <member name="F:NPOI.XWPF.UserModel.NumberFormat.LowerRoman">
  5427. <summary>
  5428. Lowercase Roman Numerals
  5429. </summary>
  5430. </member>
  5431. <member name="F:NPOI.XWPF.UserModel.NumberFormat.UpperLetter">
  5432. <summary>
  5433. Uppercase Latin Alphabet
  5434. </summary>
  5435. </member>
  5436. <member name="F:NPOI.XWPF.UserModel.NumberFormat.LowerLetter">
  5437. <summary>
  5438. Lowercase Latin Alphabet
  5439. </summary>
  5440. </member>
  5441. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Ordinal">
  5442. <summary>
  5443. Ordinal
  5444. </summary>
  5445. </member>
  5446. <member name="F:NPOI.XWPF.UserModel.NumberFormat.CardinalText">
  5447. <summary>
  5448. Cardinal Text
  5449. </summary>
  5450. </member>
  5451. <member name="F:NPOI.XWPF.UserModel.NumberFormat.OrdinalText">
  5452. <summary>
  5453. Ordinal Text
  5454. </summary>
  5455. </member>
  5456. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Hex">
  5457. <summary>
  5458. Hexadecimal Numbering
  5459. </summary>
  5460. </member>
  5461. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Chicago">
  5462. <summary>
  5463. Chicago Manual of Style
  5464. </summary>
  5465. </member>
  5466. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographDigital">
  5467. <summary>
  5468. Ideographs
  5469. </summary>
  5470. </member>
  5471. <member name="F:NPOI.XWPF.UserModel.NumberFormat.JapaneseCounting">
  5472. <summary>
  5473. Japanese Counting System
  5474. </summary>
  5475. </member>
  5476. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Aiueo">
  5477. <summary>
  5478. AIUEO Order Hiragana
  5479. </summary>
  5480. </member>
  5481. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Iroha">
  5482. <summary>
  5483. Iroha Ordered Katakana
  5484. </summary>
  5485. </member>
  5486. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalFullWidth">
  5487. <summary>
  5488. Double Byte Arabic Numerals
  5489. </summary>
  5490. </member>
  5491. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalHalfWidth">
  5492. <summary>
  5493. Single Byte Arabic Numerals
  5494. </summary>
  5495. </member>
  5496. <member name="F:NPOI.XWPF.UserModel.NumberFormat.JapaneseLegal">
  5497. <summary>
  5498. Japanese Legal Numbering
  5499. </summary>
  5500. </member>
  5501. <member name="F:NPOI.XWPF.UserModel.NumberFormat.JapaneseDigitalTenThousand">
  5502. <summary>
  5503. Japanese Digital Ten Thousand Counting System
  5504. </summary>
  5505. </member>
  5506. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalEnclosedCircle">
  5507. <summary>
  5508. Decimal Numbers Enclosed in a Circle
  5509. </summary>
  5510. </member>
  5511. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalFullWidth2">
  5512. <summary>
  5513. Double Byte Arabic Numerals Alternate
  5514. </summary>
  5515. </member>
  5516. <member name="F:NPOI.XWPF.UserModel.NumberFormat.AiueoFullWidth">
  5517. <summary>
  5518. Full-Width AIUEO Order Hiragana
  5519. </summary>
  5520. </member>
  5521. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IrohaFullWidth">
  5522. <summary>
  5523. Full-Width Iroha Ordered Katakana
  5524. </summary>
  5525. </member>
  5526. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalZero">
  5527. <summary>
  5528. Initial Zero Arabic Numerals
  5529. </summary>
  5530. </member>
  5531. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Bullet">
  5532. <summary>
  5533. Bullet
  5534. </summary>
  5535. </member>
  5536. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Ganada">
  5537. <summary>
  5538. Korean Ganada Numbering
  5539. </summary>
  5540. </member>
  5541. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Chosung">
  5542. <summary>
  5543. Korean Chosung Numbering
  5544. </summary>
  5545. </member>
  5546. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalEnclosedFullstop">
  5547. <summary>
  5548. Decimal Numbers Followed by a Period
  5549. </summary>
  5550. </member>
  5551. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalEnclosedParen">
  5552. <summary>
  5553. Decimal Numbers Enclosed in Parenthesis
  5554. </summary>
  5555. </member>
  5556. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalEnclosedCircleChinese">
  5557. <summary>
  5558. Decimal Numbers Enclosed in a Circle
  5559. </summary>
  5560. </member>
  5561. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographEnclosedCircle">
  5562. <summary>
  5563. Ideographs Enclosed in a Circle
  5564. </summary>
  5565. </member>
  5566. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographTraditional">
  5567. <summary>
  5568. Traditional Ideograph Format
  5569. </summary>
  5570. </member>
  5571. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographZodiac">
  5572. <summary>
  5573. Zodiac Ideograph Format
  5574. </summary>
  5575. </member>
  5576. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographZodiacTraditional">
  5577. <summary>
  5578. Traditional Zodiac Ideograph Format
  5579. </summary>
  5580. </member>
  5581. <member name="F:NPOI.XWPF.UserModel.NumberFormat.TaiwaneseCounting">
  5582. <summary>
  5583. Taiwanese Counting System
  5584. </summary>
  5585. </member>
  5586. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographLegalTraditional">
  5587. <summary>
  5588. Traditional Legal Ideograph Format
  5589. </summary>
  5590. </member>
  5591. <member name="F:NPOI.XWPF.UserModel.NumberFormat.TaiwaneseCountingThousand">
  5592. <summary>
  5593. Taiwanese Counting Thousand System
  5594. </summary>
  5595. </member>
  5596. <member name="F:NPOI.XWPF.UserModel.NumberFormat.TaiwaneseDigital">
  5597. <summary>
  5598. Taiwanese Digital Counting System
  5599. </summary>
  5600. </member>
  5601. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ChineseCounting">
  5602. <summary>
  5603. Chinese Counting System
  5604. </summary>
  5605. </member>
  5606. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ChineseLegalSimplified">
  5607. <summary>
  5608. Chinese Legal Simplified Format
  5609. </summary>
  5610. </member>
  5611. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ChineseCountingThousand">
  5612. <summary>
  5613. Chinese Counting Thousand System
  5614. </summary>
  5615. </member>
  5616. <member name="F:NPOI.XWPF.UserModel.NumberFormat.KoreanDigital">
  5617. <summary>
  5618. Korean Digital Counting System
  5619. </summary>
  5620. </member>
  5621. <member name="F:NPOI.XWPF.UserModel.NumberFormat.KoreanCounting">
  5622. <summary>
  5623. Korean Counting System
  5624. </summary>
  5625. </member>
  5626. <member name="F:NPOI.XWPF.UserModel.NumberFormat.KoreanLegal">
  5627. <summary>
  5628. Korean Legal Numbering
  5629. </summary>
  5630. </member>
  5631. <member name="F:NPOI.XWPF.UserModel.NumberFormat.KoreanDigital2">
  5632. <summary>
  5633. Korean Digital Counting System Alternate
  5634. </summary>
  5635. </member>
  5636. <member name="F:NPOI.XWPF.UserModel.NumberFormat.VietnameseCounting">
  5637. <summary>
  5638. Vietnamese Numerals
  5639. </summary>
  5640. </member>
  5641. <member name="F:NPOI.XWPF.UserModel.NumberFormat.RussianLower">
  5642. <summary>
  5643. Lowercase Russian Alphabet
  5644. </summary>
  5645. </member>
  5646. <member name="F:NPOI.XWPF.UserModel.NumberFormat.RussianUpper">
  5647. <summary>
  5648. Uppercase Russian Alphabet
  5649. </summary>
  5650. </member>
  5651. <member name="F:NPOI.XWPF.UserModel.NumberFormat.None">
  5652. <summary>
  5653. No Numbering
  5654. </summary>
  5655. </member>
  5656. <member name="F:NPOI.XWPF.UserModel.NumberFormat.NumberInDash">
  5657. <summary>
  5658. Number With Dashes
  5659. </summary>
  5660. </member>
  5661. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Hebrew1">
  5662. <summary>
  5663. Hebrew Numerals
  5664. </summary>
  5665. </member>
  5666. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Hebrew2">
  5667. <summary>
  5668. Hebrew Alphabet
  5669. </summary>
  5670. </member>
  5671. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ArabicAlpha">
  5672. <summary>
  5673. Arabic Alphabet
  5674. </summary>
  5675. </member>
  5676. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ArabicAbjad">
  5677. <summary>
  5678. Arabic Abjad Numerals
  5679. </summary>
  5680. </member>
  5681. <member name="F:NPOI.XWPF.UserModel.NumberFormat.HindiVowels">
  5682. <summary>
  5683. Hindi Vowels
  5684. </summary>
  5685. </member>
  5686. <member name="F:NPOI.XWPF.UserModel.NumberFormat.HindiConsonants">
  5687. <summary>
  5688. Hindi Consonants
  5689. </summary>
  5690. </member>
  5691. <member name="F:NPOI.XWPF.UserModel.NumberFormat.HindiNumbers">
  5692. <summary>
  5693. Hindi Numbers
  5694. </summary>
  5695. </member>
  5696. <member name="F:NPOI.XWPF.UserModel.NumberFormat.HindiCounting">
  5697. <summary>
  5698. Hindi Counting System
  5699. </summary>
  5700. </member>
  5701. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ThaiLetters">
  5702. <summary>
  5703. Thai Letters
  5704. </summary>
  5705. </member>
  5706. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ThaiNumbers">
  5707. <summary>
  5708. Thai Numerals
  5709. </summary>
  5710. </member>
  5711. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ThaiCounting">
  5712. <summary>
  5713. Thai Counting System
  5714. </summary>
  5715. </member>
  5716. <member name="T:NPOI.XWPF.UserModel.XWPFComment">
  5717. * Sketch of XWPF comment class
  5718. *
  5719. * @author Yury Batrakov (batrakov at gmail.com)
  5720. *
  5721. </member>
  5722. <member name="T:NPOI.XWPF.UserModel.XWPFDocument">
  5723. Experimental class to do low level Processing
  5724. of docx files.
  5725. If you're using these low level classes, then you
  5726. will almost certainly need to refer to the OOXML
  5727. specifications from
  5728. http://www.ecma-international.org/publications/standards/Ecma-376.htm
  5729. WARNING - APIs expected to change rapidly
  5730. </member>
  5731. <member name="F:NPOI.XWPF.UserModel.XWPFDocument.drawingIdManager">
  5732. Keeps track on all id-values used in this document and included parts, like headers, footers, etc.
  5733. </member>
  5734. <member name="F:NPOI.XWPF.UserModel.XWPFDocument.headerFooterPolicy">
  5735. Handles the joy of different headers/footers for different pages
  5736. </member>
  5737. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.newPackage">
  5738. Create a new WordProcessingML package and Setup the default minimal content
  5739. </member>
  5740. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.OnDocumentCreate">
  5741. Create a new CT_Document with all values Set to default
  5742. </member>
  5743. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetTableArray(System.Int32)">
  5744. @see NPOI.XWPF.UserModel.IBody#getTableArray(int)
  5745. </member>
  5746. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetPartById(System.String)">
  5747. Get the document part that's defined as the
  5748. given relationship of the core document.
  5749. </member>
  5750. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetHeaderFooterPolicy">
  5751. Returns the policy on headers and footers, which
  5752. also provides a way to Get at them.
  5753. </member>
  5754. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetCTStyle">
  5755. Returns the styles object used
  5756. </member>
  5757. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetAllEmbedds">
  5758. Get the document's embedded files.
  5759. </member>
  5760. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetBodyElementSpecificPos(System.Int32,System.Collections.Generic.List{NPOI.XWPF.UserModel.IBodyElement})">
  5761. Finds that for example the 2nd entry in the body list is the 1st paragraph
  5762. </member>
  5763. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetParagraphPos(System.Int32)">
  5764. Look up the paragraph at the specified position in the body elemnts list
  5765. and return this paragraphs position in the paragraphs list
  5766. @param pos
  5767. The position of the relevant paragraph in the body elements
  5768. list
  5769. @return the position of the paragraph in the paragraphs list, if there is
  5770. a paragraph at the position in the bodyelements list. Else it
  5771. will return -1
  5772. </member>
  5773. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetTablePos(System.Int32)">
  5774. Get with the position of a table in the bodyelement array list
  5775. the position of this table in the table array list
  5776. @param pos position of the table in the bodyelement array list
  5777. @return if there is a table at the position in the bodyelement array list,
  5778. else it will return null.
  5779. </member>
  5780. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.InsertNewParagraph(System.Xml.XmlDocument)">
  5781. Add a new paragraph at position of the cursor. The cursor must be on the
  5782. {@link org.apache.xmlbeans.XmlCursor.TokenType#START} tag of an subelement
  5783. of the documents body. When this method is done, the cursor passed as
  5784. parameter points to the {@link org.apache.xmlbeans.XmlCursor.TokenType#END}
  5785. of the newly inserted paragraph.
  5786. @param cursor
  5787. @return the {@link XWPFParagraph} object representing the newly inserted
  5788. CTP object
  5789. </member>
  5790. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsCursorInBody(System.Xml.XmlDocument)">
  5791. verifies that cursor is on the right position
  5792. @param cursor
  5793. </member>
  5794. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetPosOfParagraph(NPOI.XWPF.UserModel.XWPFParagraph)">
  5795. Get the position of the paragraph, within the list
  5796. of all the body elements.
  5797. @param p The paragraph to find
  5798. @return The location, or -1 if the paragraph couldn't be found
  5799. </member>
  5800. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetPosOfTable(NPOI.XWPF.UserModel.XWPFTable)">
  5801. Get the position of the table, within the list of
  5802. all the body elements.
  5803. @param t The table to find
  5804. @return The location, or -1 if the table couldn't be found
  5805. </member>
  5806. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.Commit">
  5807. Commit and saves the document
  5808. </member>
  5809. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetRelationIndex(NPOI.XWPF.UserModel.XWPFRelation)">
  5810. Gets the index of the relation we're trying to create
  5811. @param relation
  5812. @return i
  5813. </member>
  5814. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateParagraph">
  5815. Appends a new paragraph to this document
  5816. @return a new paragraph
  5817. </member>
  5818. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateNumbering">
  5819. Creates an empty numbering if one does not already exist and Sets the numbering member
  5820. @return numbering
  5821. </member>
  5822. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateStyles">
  5823. Creates an empty styles for the document if one does not already exist
  5824. @return styles
  5825. </member>
  5826. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateFootnotes">
  5827. Creates an empty footnotes element for the document if one does not already exist
  5828. @return footnotes
  5829. </member>
  5830. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.RemoveBodyElement(System.Int32)">
  5831. remove a BodyElement from bodyElements array list
  5832. @param pos
  5833. @return true if removing was successfully, else return false
  5834. </member>
  5835. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.SetParagraph(NPOI.XWPF.UserModel.XWPFParagraph,System.Int32)">
  5836. copies content of a paragraph to a existing paragraph in the list paragraphs at position pos
  5837. @param paragraph
  5838. @param pos
  5839. </member>
  5840. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetLastParagraph">
  5841. @return the LastParagraph of the document
  5842. </member>
  5843. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateTable">
  5844. Create an empty table with one row and one column as default.
  5845. @return a new table
  5846. </member>
  5847. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateTable(System.Int32,System.Int32)">
  5848. Create an empty table with a number of rows and cols specified
  5849. @param rows
  5850. @param cols
  5851. @return table
  5852. </member>
  5853. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateTOC">
  5854. </member>
  5855. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.SetTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  5856. Replace content of table in array tables at position pos with a
  5857. @param pos
  5858. @param table
  5859. </member>
  5860. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsEnforcedReadonlyProtection">
  5861. Verifies that the documentProtection tag in Settings.xml file <br/>
  5862. specifies that the protection is enforced (w:enforcement="1") <br/>
  5863. and that the kind of protection is ReadOnly (w:edit="readOnly")<br/>
  5864. <br/>
  5865. sample snippet from Settings.xml
  5866. <pre>
  5867. &lt;w:settings ... &gt;
  5868. &lt;w:documentProtection w:edit=&quot;readOnly&quot; w:enforcement=&quot;1&quot;/&gt;
  5869. </pre>
  5870. @return true if documentProtection is enforced with option ReadOnly
  5871. </member>
  5872. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsEnforcedFillingFormsProtection">
  5873. Verifies that the documentProtection tag in Settings.xml file <br/>
  5874. specifies that the protection is enforced (w:enforcement="1") <br/>
  5875. and that the kind of protection is forms (w:edit="forms")<br/>
  5876. <br/>
  5877. sample snippet from Settings.xml
  5878. <pre>
  5879. &lt;w:settings ... &gt;
  5880. &lt;w:documentProtection w:edit=&quot;forms&quot; w:enforcement=&quot;1&quot;/&gt;
  5881. </pre>
  5882. @return true if documentProtection is enforced with option forms
  5883. </member>
  5884. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsEnforcedCommentsProtection">
  5885. Verifies that the documentProtection tag in Settings.xml file <br/>
  5886. specifies that the protection is enforced (w:enforcement="1") <br/>
  5887. and that the kind of protection is comments (w:edit="comments")<br/>
  5888. <br/>
  5889. sample snippet from Settings.xml
  5890. <pre>
  5891. &lt;w:settings ... &gt;
  5892. &lt;w:documentProtection w:edit=&quot;comments&quot; w:enforcement=&quot;1&quot;/&gt;
  5893. </pre>
  5894. @return true if documentProtection is enforced with option comments
  5895. </member>
  5896. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsEnforcedTrackedChangesProtection">
  5897. Verifies that the documentProtection tag in Settings.xml file <br/>
  5898. specifies that the protection is enforced (w:enforcement="1") <br/>
  5899. and that the kind of protection is trackedChanges (w:edit="trackedChanges")<br/>
  5900. <br/>
  5901. sample snippet from Settings.xml
  5902. <pre>
  5903. &lt;w:settings ... &gt;
  5904. &lt;w:documentProtection w:edit=&quot;trackedChanges&quot; w:enforcement=&quot;1&quot;/&gt;
  5905. </pre>
  5906. @return true if documentProtection is enforced with option trackedChanges
  5907. </member>
  5908. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.EnforceReadonlyProtection">
  5909. Enforces the ReadOnly protection.<br/>
  5910. In the documentProtection tag inside Settings.xml file, <br/>
  5911. it Sets the value of enforcement to "1" (w:enforcement="1") <br/>
  5912. and the value of edit to ReadOnly (w:edit="readOnly")<br/>
  5913. <br/>
  5914. sample snippet from Settings.xml
  5915. <pre>
  5916. &lt;w:settings ... &gt;
  5917. &lt;w:documentProtection w:edit=&quot;readOnly&quot; w:enforcement=&quot;1&quot;/&gt;
  5918. </pre>
  5919. </member>
  5920. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.EnforceFillingFormsProtection">
  5921. Enforce the Filling Forms protection.<br/>
  5922. In the documentProtection tag inside Settings.xml file, <br/>
  5923. it Sets the value of enforcement to "1" (w:enforcement="1") <br/>
  5924. and the value of edit to forms (w:edit="forms")<br/>
  5925. <br/>
  5926. sample snippet from Settings.xml
  5927. <pre>
  5928. &lt;w:settings ... &gt;
  5929. &lt;w:documentProtection w:edit=&quot;forms&quot; w:enforcement=&quot;1&quot;/&gt;
  5930. </pre>
  5931. </member>
  5932. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.EnforceCommentsProtection">
  5933. Enforce the Comments protection.<br/>
  5934. In the documentProtection tag inside Settings.xml file,<br/>
  5935. it Sets the value of enforcement to "1" (w:enforcement="1") <br/>
  5936. and the value of edit to comments (w:edit="comments")<br/>
  5937. <br/>
  5938. sample snippet from Settings.xml
  5939. <pre>
  5940. &lt;w:settings ... &gt;
  5941. &lt;w:documentProtection w:edit=&quot;comments&quot; w:enforcement=&quot;1&quot;/&gt;
  5942. </pre>
  5943. </member>
  5944. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.EnforceTrackedChangesProtection">
  5945. Enforce the Tracked Changes protection.<br/>
  5946. In the documentProtection tag inside Settings.xml file, <br/>
  5947. it Sets the value of enforcement to "1" (w:enforcement="1") <br/>
  5948. and the value of edit to trackedChanges (w:edit="trackedChanges")<br/>
  5949. <br/>
  5950. sample snippet from Settings.xml
  5951. <pre>
  5952. &lt;w:settings ... &gt;
  5953. &lt;w:documentProtection w:edit=&quot;trackedChanges&quot; w:enforcement=&quot;1&quot;/&gt;
  5954. </pre>
  5955. </member>
  5956. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.RemoveProtectionEnforcement">
  5957. Remove protection enforcement.<br/>
  5958. In the documentProtection tag inside Settings.xml file <br/>
  5959. it Sets the value of enforcement to "0" (w:enforcement="0") <br/>
  5960. </member>
  5961. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.EnforceUpdateFields">
  5962. Enforces fields update on document open (in Word).
  5963. In the settings.xml file <br/>
  5964. sets the updateSettings value to true (w:updateSettings w:val="true")
  5965. NOTICES:
  5966. <ul>
  5967. <li>Causing Word to ask on open: "This document contains fields that may refer to other files. Do you want to update the fields in this document?"
  5968. (if "Update automatic links at open" is enabled)</li>
  5969. <li>Flag is removed after saving with changes in Word </li>
  5970. </ul>
  5971. </member>
  5972. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.InsertTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  5973. inserts an existing XWPFTable to the arrays bodyElements and tables
  5974. @param pos
  5975. @param table
  5976. </member>
  5977. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetNextPicNameNumber(System.Int32)">
  5978. Get the next free ImageNumber
  5979. @param format
  5980. @return the next free ImageNumber
  5981. @throws InvalidFormatException
  5982. </member>
  5983. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetPictureDataByID(System.String)">
  5984. returns the PictureData by blipID
  5985. @param blipID
  5986. @return XWPFPictureData of a specificID
  5987. </member>
  5988. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetNumbering">
  5989. GetNumbering
  5990. @return numbering
  5991. </member>
  5992. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetStyles">
  5993. Get Styles
  5994. @return styles for this document
  5995. </member>
  5996. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  5997. Get the paragraph with the CTP class p
  5998. @param p
  5999. @return the paragraph with the CTP class p
  6000. </member>
  6001. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetTable(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  6002. Get a table by its CTTbl-Object
  6003. @param ctTbl
  6004. @see NPOI.XWPF.UserModel.IBody#getTable(org.Openxmlformats.schemas.wordProcessingml.x2006.main.CTTbl)
  6005. @return a table by its CTTbl-Object or null
  6006. </member>
  6007. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetParagraphArray(System.Int32)">
  6008. Returns the paragraph that of position pos
  6009. @see NPOI.XWPF.UserModel.IBody#getParagraphArray(int)
  6010. </member>
  6011. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetPart">
  6012. returns the Part, to which the body belongs, which you need for Adding relationship to other parts
  6013. Actually it is needed of the class XWPFTableCell. Because you have to know to which part the tableCell
  6014. belongs.
  6015. @see NPOI.XWPF.UserModel.IBody#getPart()
  6016. </member>
  6017. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  6018. Get the TableCell which belongs to the TableCell
  6019. @param cell
  6020. </member>
  6021. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.Document">
  6022. Returns the low level document base object
  6023. </member>
  6024. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.BodyElements">
  6025. returns an Iterator with paragraphs and tables
  6026. @see NPOI.XWPF.UserModel.IBody#getBodyElements()
  6027. </member>
  6028. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.Paragraphs">
  6029. @see NPOI.XWPF.UserModel.IBody#getParagraphs()
  6030. </member>
  6031. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.Tables">
  6032. @see NPOI.XWPF.UserModel.IBody#getTables()
  6033. </member>
  6034. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.FooterList">
  6035. @return the list of footers
  6036. </member>
  6037. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.HeaderList">
  6038. @return the list of headers
  6039. </member>
  6040. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.AllPictures">
  6041. Returns all Pictures, which are referenced from the document itself.
  6042. @return a {@link List} of {@link XWPFPictureData}. The returned {@link List} is unmodifiable. Use #a
  6043. </member>
  6044. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.AllPackagePictures">
  6045. @return all Pictures in this package
  6046. </member>
  6047. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.PartType">
  6048. Get the PartType of the body, for example
  6049. DOCUMENT, HEADER, FOOTER, FOOTNOTE,
  6050. @see NPOI.XWPF.UserModel.IBody#getPartType()
  6051. </member>
  6052. <member name="T:NPOI.XWPF.UserModel.XWPFFactory">
  6053. @author Yegor Kozlov
  6054. </member>
  6055. <member name="T:NPOI.XWPF.UserModel.XWPFFooter">
  6056. Sketch of XWPF footer class
  6057. </member>
  6058. <member name="T:NPOI.XWPF.UserModel.XWPFHeaderFooter">
  6059. Parent of XWPF headers and footers
  6060. </member>
  6061. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.SetHeaderFooter(NPOI.OpenXmlFormats.Wordprocessing.CT_HdrFtr)">
  6062. Set a new headerFooter
  6063. </member>
  6064. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetTable(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  6065. if there is a corresponding {@link XWPFTable} of the parameter ctTable in the tableList of this header
  6066. the method will return this table
  6067. if there is no corresponding {@link XWPFTable} the method will return null
  6068. @param ctTable
  6069. </member>
  6070. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  6071. if there is a corresponding {@link XWPFParagraph} of the parameter ctTable in the paragraphList of this header or footer
  6072. the method will return this paragraph
  6073. if there is no corresponding {@link XWPFParagraph} the method will return null
  6074. @param p is instance of CTP and is searching for an XWPFParagraph
  6075. @return null if there is no XWPFParagraph with an corresponding CTPparagraph in the paragraphList of this header or footer
  6076. XWPFParagraph with the correspondig CTP p
  6077. </member>
  6078. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetParagraphArray(System.Int32)">
  6079. Returns the paragraph that holds
  6080. the text of the header or footer.
  6081. </member>
  6082. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetListParagraph">
  6083. Get a List of all Paragraphs
  6084. @return a list of {@link XWPFParagraph}
  6085. </member>
  6086. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.AddPictureData(System.Byte[],System.Int32)">
  6087. Adds a picture to the document.
  6088. @param pictureData The picture data
  6089. @param format The format of the picture.
  6090. @return the index to this picture (0 based), the Added picture can be obtained from {@link #getAllPictures()} .
  6091. @throws InvalidFormatException
  6092. </member>
  6093. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.AddPictureData(System.IO.Stream,System.Int32)">
  6094. Adds a picture to the document.
  6095. @param is The stream to read image from
  6096. @param format The format of the picture.
  6097. @return the index to this picture (0 based), the Added picture can be obtained from {@link #getAllPictures()} .
  6098. @throws InvalidFormatException
  6099. @
  6100. </member>
  6101. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetPictureDataByID(System.String)">
  6102. returns the PictureData by blipID
  6103. @param blipID
  6104. @return XWPFPictureData of a specificID
  6105. @throws Exception
  6106. </member>
  6107. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetTableArray(System.Int32)">
  6108. Returns the table at position pos
  6109. @see NPOI.XWPF.UserModel.IBody#getTableArray(int)
  6110. </member>
  6111. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.InsertTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  6112. inserts an existing XWPFTable to the arrays bodyElements and tables
  6113. @param pos
  6114. @param table
  6115. </member>
  6116. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  6117. Get the TableCell which belongs to the TableCell
  6118. @param cell
  6119. </member>
  6120. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetPart">
  6121. returns the Part, to which the body belongs, which you need for Adding relationship to other parts
  6122. @see NPOI.XWPF.UserModel.IBody#getPart()
  6123. </member>
  6124. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.Paragraphs">
  6125. Returns the paragraph(s) that holds
  6126. the text of the header or footer.
  6127. Normally there is only the one paragraph, but
  6128. there could be more in certain cases, or
  6129. a table.
  6130. </member>
  6131. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.Tables">
  6132. Return the table(s) that holds the text
  6133. of the header or footer, for complex cases
  6134. where a paragraph isn't used.
  6135. Normally there's just one paragraph, but some
  6136. complex headers/footers have a table or two
  6137. in Addition.
  6138. </member>
  6139. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.Text">
  6140. Returns the textual content of the header/footer,
  6141. by flattening out the text of its paragraph(s)
  6142. </member>
  6143. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.AllPackagePictures">
  6144. Get all Pictures in this package
  6145. @return all Pictures in this package
  6146. </member>
  6147. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.Owner">
  6148. verifies that cursor is on the right position
  6149. @param cursor
  6150. </member>
  6151. <member name="M:NPOI.XWPF.UserModel.XWPFFooter.Commit">
  6152. save and Commit footer
  6153. </member>
  6154. <member name="P:NPOI.XWPF.UserModel.XWPFFooter.PartType">
  6155. Get the PartType of the body
  6156. @see NPOI.XWPF.UserModel.IBody#getPartType()
  6157. </member>
  6158. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetTableArray(System.Int32)">
  6159. <summary>
  6160. </summary>
  6161. <param name="pos">position in table array</param>
  6162. <returns>The table at position pos</returns>
  6163. </member>
  6164. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.InsertTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  6165. <summary>
  6166. inserts an existing XWPFTable to the arrays bodyElements and tables
  6167. </summary>
  6168. <param name="pos"></param>
  6169. <param name="table"></param>
  6170. </member>
  6171. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetTable(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  6172. if there is a corresponding {@link XWPFTable} of the parameter ctTable in the tableList of this header
  6173. the method will return this table
  6174. if there is no corresponding {@link XWPFTable} the method will return null
  6175. @param ctTable
  6176. @see NPOI.XWPF.UserModel.IBody#getTable(CTTbl ctTable)
  6177. </member>
  6178. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  6179. if there is a corresponding {@link XWPFParagraph} of the parameter ctTable in the paragraphList of this header or footer
  6180. the method will return this paragraph
  6181. if there is no corresponding {@link XWPFParagraph} the method will return null
  6182. @param p is instance of CTP and is searching for an XWPFParagraph
  6183. @return null if there is no XWPFParagraph with an corresponding CTPparagraph in the paragraphList of this header or footer
  6184. XWPFParagraph with the correspondig CTP p
  6185. @see NPOI.XWPF.UserModel.IBody#getParagraph(CTP p)
  6186. </member>
  6187. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetParagraphArray(System.Int32)">
  6188. <summary>
  6189. Returns the paragraph that holds the text of the header or footer.
  6190. </summary>
  6191. <param name="pos"></param>
  6192. <returns></returns>
  6193. </member>
  6194. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  6195. <summary>
  6196. Get the TableCell which belongs to the TableCell
  6197. </summary>
  6198. <param name="cell"></param>
  6199. <returns></returns>
  6200. </member>
  6201. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.IsCursorInFtn(System.Xml.XmlDocument)">
  6202. verifies that cursor is on the right position
  6203. @param cursor
  6204. </member>
  6205. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.InsertNewTbl(System.Xml.XmlDocument)">
  6206. @param cursor
  6207. @return the inserted table
  6208. @see NPOI.XWPF.UserModel.IBody#insertNewTbl(XmlCursor cursor)
  6209. </member>
  6210. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.InsertNewParagraph(System.Xml.XmlDocument)">
  6211. add a new paragraph at position of the cursor
  6212. @param cursor
  6213. @return the inserted paragraph
  6214. @see NPOI.XWPF.UserModel.IBody#insertNewParagraph(XmlCursor cursor)
  6215. </member>
  6216. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.AddNewTbl(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  6217. add a new table to the end of the footnote
  6218. @param table
  6219. @return the Added XWPFTable
  6220. </member>
  6221. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.AddNewParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  6222. add a new paragraph to the end of the footnote
  6223. @param paragraph
  6224. @return the Added XWPFParagraph
  6225. </member>
  6226. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetXWPFDocument">
  6227. @see NPOI.XWPF.UserModel.IBody#getXWPFDocument()
  6228. </member>
  6229. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetPart">
  6230. returns the Part, to which the body belongs, which you need for Adding relationship to other parts
  6231. @see NPOI.XWPF.UserModel.IBody#getPart()
  6232. </member>
  6233. <member name="P:NPOI.XWPF.UserModel.XWPFFootnote.PartType">
  6234. Get the PartType of the body
  6235. @see NPOI.XWPF.UserModel.IBody#getPartType()
  6236. </member>
  6237. <member name="T:NPOI.XWPF.UserModel.XWPFFootnotes">
  6238. Looks After the collection of Footnotes for a document
  6239. @author Mike McEuen (mceuen@hp.com)
  6240. </member>
  6241. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  6242. Construct XWPFFootnotes from a package part
  6243. @param part the package part holding the data of the footnotes,
  6244. @param rel the package relationship of type "http://schemas.Openxmlformats.org/officeDocument/2006/relationships/footnotes"
  6245. </member>
  6246. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.#ctor">
  6247. Construct XWPFFootnotes from scratch for a new document.
  6248. </member>
  6249. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.OnDocumentRead">
  6250. Read document
  6251. </member>
  6252. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.SetFootnotes(NPOI.OpenXmlFormats.Wordprocessing.CT_Footnotes)">
  6253. Sets the ctFootnotes
  6254. @param footnotes
  6255. </member>
  6256. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.AddFootnote(NPOI.XWPF.UserModel.XWPFFootnote)">
  6257. add an XWPFFootnote to the document
  6258. @param footnote
  6259. @throws IOException
  6260. </member>
  6261. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.AddFootnote(NPOI.OpenXmlFormats.Wordprocessing.CT_FtnEdn)">
  6262. add a footnote to the document
  6263. @param note
  6264. @throws IOException
  6265. </member>
  6266. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.GetXWPFDocument">
  6267. @see NPOI.XWPF.UserModel.IBody#getPart()
  6268. </member>
  6269. <member name="T:NPOI.XWPF.UserModel.XWPFHeader">
  6270. Sketch of XWPF header class
  6271. </member>
  6272. <member name="M:NPOI.XWPF.UserModel.XWPFHeader.Commit">
  6273. <summary>
  6274. Save and commit footer
  6275. </summary>
  6276. </member>
  6277. <member name="M:NPOI.XWPF.UserModel.XWPFHeader.OnDocumentRead">
  6278. <summary>
  6279. Read the document
  6280. </summary>
  6281. </member>
  6282. <member name="P:NPOI.XWPF.UserModel.XWPFHeader.PartType">
  6283. <summary>
  6284. Get the PartType of the body
  6285. </summary>
  6286. </member>
  6287. <member name="T:NPOI.XWPF.UserModel.XWPFHyperlink">
  6288. * Sketch of XWPF hyperlink class
  6289. *
  6290. * @author Yury Batrakov (batrakov at gmail.com)
  6291. *
  6292. </member>
  6293. <member name="T:NPOI.XWPF.UserModel.XWPFHyperlinkRun">
  6294. A run of text with a Hyperlink applied to it.
  6295. Any given Hyperlink may be made up of multiple of these.
  6296. </member>
  6297. <member name="T:NPOI.XWPF.UserModel.XWPFRun">
  6298. XWPFrun.object defines a region of text with a common Set of properties
  6299. @author Yegor Kozlov
  6300. @author Gregg Morris (gregg dot morris at gmail dot com) - added getColor(), setColor()
  6301. </member>
  6302. <member name="M:NPOI.XWPF.UserModel.XWPFRun.#ctor(NPOI.OpenXmlFormats.Wordprocessing.CT_R,NPOI.XWPF.UserModel.XWPFParagraph)">
  6303. @param r the CT_R bean which holds the run.attributes
  6304. @param p the parent paragraph
  6305. </member>
  6306. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetCTR">
  6307. Get the currently used CT_R object
  6308. @return CT_R object
  6309. </member>
  6310. <member name="M:NPOI.XWPF.UserModel.XWPFRun.IsCTOnOff(NPOI.OpenXmlFormats.Wordprocessing.CT_OnOff)">
  6311. For isBold, isItalic etc
  6312. </member>
  6313. <member name="M:NPOI.XWPF.UserModel.XWPFRun.SetBold(System.Boolean)">
  6314. Whether the bold property shall be applied to all non-complex script
  6315. characters in the contents of this run.when displayed in a document.
  6316. <p>
  6317. This formatting property is a toggle property, which specifies that its
  6318. behavior differs between its use within a style defInition and its use as
  6319. direct formatting. When used as part of a style defInition, Setting this
  6320. property shall toggle the current state of that property as specified up
  6321. to this point in the hierarchy (i.e. applied to not applied, and vice
  6322. versa). Setting it to <code>false</code> (or an equivalent) shall
  6323. result in the current Setting remaining unChanged. However, when used as
  6324. direct formatting, Setting this property to true or false shall Set the
  6325. absolute state of the resulting property.
  6326. </p>
  6327. <p>
  6328. If this element is not present, the default value is to leave the
  6329. formatting applied at previous level in the style hierarchy. If this
  6330. element is never applied in the style hierarchy, then bold shall not be
  6331. applied to non-complex script characters.
  6332. </p>
  6333. @param value <code>true</code> if the bold property is applied to
  6334. this run
  6335. </member>
  6336. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetColor">
  6337. Get text color. The returned value is a string in the hex form "RRGGBB".
  6338. </member>
  6339. <member name="M:NPOI.XWPF.UserModel.XWPFRun.SetColor(System.String)">
  6340. Set text color.
  6341. @param rgbStr - the desired color, in the hex form "RRGGBB".
  6342. </member>
  6343. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetText(System.Int32)">
  6344. Return the string content of this text run
  6345. @return the text of this text run.or <code>null</code> if not Set
  6346. </member>
  6347. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetPictureText">
  6348. Returns text embedded in pictures
  6349. </member>
  6350. <member name="M:NPOI.XWPF.UserModel.XWPFRun.SetText(System.String)">
  6351. Sets the text of this text run
  6352. @param value the literal text which shall be displayed in the document
  6353. </member>
  6354. <member name="M:NPOI.XWPF.UserModel.XWPFRun.SetText(System.String,System.Int32)">
  6355. Sets the text of this text run.in the
  6356. @param value the literal text which shall be displayed in the document
  6357. @param pos - position in the text array (NB: 0 based)
  6358. </member>
  6359. <!-- Badly formed XML comment ignored for member "M:NPOI.XWPF.UserModel.XWPFRun.SetUnderline(NPOI.XWPF.UserModel.UnderlinePatterns)" -->
  6360. <!-- Badly formed XML comment ignored for member "M:NPOI.XWPF.UserModel.XWPFRun.SetStrike(System.Boolean)" -->
  6361. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetSubscript">
  6362. Specifies the alignment which shall be applied to the contents of this
  6363. run.in relation to the default appearance of the run.s text.
  6364. This allows the text to be repositioned as subscript or superscript without
  6365. altering the font size of the run.properties.
  6366. @return VerticalAlign
  6367. @see VerticalAlign all possible value that could be Applyed to this run
  6368. </member>
  6369. <!-- Badly formed XML comment ignored for member "M:NPOI.XWPF.UserModel.XWPFRun.SetSubscript(NPOI.XWPF.UserModel.VerticalAlign)" -->
  6370. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetFontFamily">
  6371. Specifies the fonts which shall be used to display the text contents of
  6372. this run. Specifies a font which shall be used to format all characters
  6373. in the ASCII range (0 - 127) within the parent run
  6374. @return a string representing the font family
  6375. </member>
  6376. <member name="M:NPOI.XWPF.UserModel.XWPFRun.SetFontFamily(System.String)">
  6377. Specifies the fonts which shall be used to display the text contents of
  6378. this run. Specifies a font which shall be used to format all characters
  6379. in the ASCII range (0 - 127) within the parent run
  6380. @param fontFamily
  6381. </member>
  6382. <!-- Badly formed XML comment ignored for member "M:NPOI.XWPF.UserModel.XWPFRun.SetFontSize(System.Int32)" -->
  6383. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetTextPosition">
  6384. This element specifies the amount by which text shall be raised or
  6385. lowered for this run.in relation to the default baseline of the
  6386. surrounding non-positioned text. This allows the text to be repositioned
  6387. without altering the font size of the contents.
  6388. @return a big integer representing the amount of text shall be "moved"
  6389. </member>
  6390. <!-- Badly formed XML comment ignored for member "M:NPOI.XWPF.UserModel.XWPFRun.SetTextPosition(System.Int32)" -->
  6391. <member name="M:NPOI.XWPF.UserModel.XWPFRun.RemoveBreak">
  6392. </member>
  6393. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddBreak">
  6394. Specifies that a break shall be placed at the current location in the run
  6395. content.
  6396. A break is a special character which is used to override the
  6397. normal line breaking that would be performed based on the normal layout
  6398. of the document's contents.
  6399. @see #AddCarriageReturn()
  6400. </member>
  6401. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddBreak(NPOI.XWPF.UserModel.BreakType)">
  6402. Specifies that a break shall be placed at the current location in the run
  6403. content.
  6404. A break is a special character which is used to override the
  6405. normal line breaking that would be performed based on the normal layout
  6406. of the document's contents.
  6407. <p>
  6408. The behavior of this break character (the
  6409. location where text shall be restarted After this break) shall be
  6410. determined by its type values.
  6411. </p>
  6412. @see BreakType
  6413. </member>
  6414. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddBreak(NPOI.XWPF.UserModel.BreakClear)">
  6415. Specifies that a break shall be placed at the current location in the run
  6416. content. A break is a special character which is used to override the
  6417. normal line breaking that would be performed based on the normal layout
  6418. of the document's contents.
  6419. <p>
  6420. The behavior of this break character (the
  6421. location where text shall be restarted After this break) shall be
  6422. determined by its type (in this case is BreakType.TEXT_WRAPPING as default) and clear attribute values.
  6423. </p>
  6424. @see BreakClear
  6425. </member>
  6426. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddCarriageReturn">
  6427. Specifies that a carriage return shall be placed at the
  6428. current location in the run.content.
  6429. A carriage return is used to end the current line of text in
  6430. WordProcess.
  6431. The behavior of a carriage return in run.content shall be
  6432. identical to a break character with null type and clear attributes, which
  6433. shall end the current line and find the next available line on which to
  6434. continue.
  6435. The carriage return character forced the following text to be
  6436. restarted on the next available line in the document.
  6437. </member>
  6438. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddPicture(System.IO.Stream,System.Int32,System.String,System.Int32,System.Int32)">
  6439. Adds a picture to the run. This method handles
  6440. attaching the picture data to the overall file.
  6441. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_EMF
  6442. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_WMF
  6443. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_PICT
  6444. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_JPEG
  6445. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_PNG
  6446. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_DIB
  6447. @param pictureData The raw picture data
  6448. @param pictureType The type of the picture, eg {@link Document#PICTURE_TYPE_JPEG}
  6449. @param width width in EMUs. To convert to / from points use {@link org.apache.poi.util.Units}
  6450. @param height height in EMUs. To convert to / from points use {@link org.apache.poi.util.Units}
  6451. @throws NPOI.Openxml4j.exceptions.InvalidFormatException
  6452. @throws IOException
  6453. </member>
  6454. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetEmbeddedPictures">
  6455. Returns the embedded pictures of the run. These
  6456. are pictures which reference an external,
  6457. embedded picture image such as a .png or .jpg
  6458. </member>
  6459. <member name="M:NPOI.XWPF.UserModel.XWPFRun.preserveSpaces(NPOI.OpenXmlFormats.Wordprocessing.CT_Text)">
  6460. Add the xml:spaces="preserve" attribute if the string has leading or trailing white spaces
  6461. @param xs the string to check
  6462. </member>
  6463. <member name="M:NPOI.XWPF.UserModel.XWPFRun.ToString">
  6464. Returns the string version of the text, with tabs and
  6465. carriage returns in place of their xml equivalents.
  6466. </member>
  6467. <member name="P:NPOI.XWPF.UserModel.XWPFRun.Paragraph">
  6468. Get the currenty referenced paragraph object
  6469. @return current paragraph
  6470. </member>
  6471. <member name="P:NPOI.XWPF.UserModel.XWPFRun.Document">
  6472. @return The {@link XWPFDocument} instance, this run.belongs to, or
  6473. <code>null</code> if parent structure (paragraph > document) is not properly Set.
  6474. </member>
  6475. <member name="P:NPOI.XWPF.UserModel.XWPFRun.IsBold">
  6476. Whether the bold property shall be applied to all non-complex script
  6477. characters in the contents of this run.when displayed in a document
  6478. @return <code>true</code> if the bold property is applied
  6479. </member>
  6480. <member name="P:NPOI.XWPF.UserModel.XWPFRun.IsItalic">
  6481. Whether the italic property should be applied to all non-complex script
  6482. characters in the contents of this run.when displayed in a document.
  6483. @return <code>true</code> if the italic property is applied
  6484. </member>
  6485. <member name="P:NPOI.XWPF.UserModel.XWPFRun.Underline">
  6486. Specifies that the contents of this run.should be displayed along with an
  6487. underline appearing directly below the character heigh
  6488. @return the Underline pattern Applyed to this run
  6489. @see UnderlinePatterns
  6490. </member>
  6491. <member name="P:NPOI.XWPF.UserModel.XWPFRun.IsStrike">
  6492. Specifies that the contents of this run.shall be displayed with a single
  6493. horizontal line through the center of the line.
  6494. @return <code>true</code> if the strike property is applied
  6495. </member>
  6496. <member name="P:NPOI.XWPF.UserModel.XWPFRun.FontSize">
  6497. Specifies the font size which shall be applied to all non complex script
  6498. characters in the contents of this run.when displayed.
  6499. @return value representing the font size
  6500. </member>
  6501. <member name="M:NPOI.XWPF.UserModel.XWPFHyperlinkRun.GetHyperlinkId">
  6502. Returns the ID of the hyperlink, if one is Set.
  6503. </member>
  6504. <member name="M:NPOI.XWPF.UserModel.XWPFHyperlinkRun.GetHyperlink(NPOI.XWPF.UserModel.XWPFDocument)">
  6505. If this Hyperlink is an external reference hyperlink,
  6506. return the object for it.
  6507. </member>
  6508. <member name="M:NPOI.XWPF.UserModel.XWPFLatentStyles.IsLatentStyle(System.String)">
  6509. Checks wheter specific LatentStyleID is a latentStyle
  6510. </member>
  6511. <member name="T:NPOI.XWPF.UserModel.XWPFNum">
  6512. @author Philipp Epp
  6513. </member>
  6514. <member name="T:NPOI.XWPF.UserModel.XWPFNumbering">
  6515. @author Philipp Epp
  6516. </member>
  6517. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  6518. create a new styles object with an existing document
  6519. </member>
  6520. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.#ctor">
  6521. create a new XWPFNumbering object for use in a new document
  6522. </member>
  6523. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.OnDocumentRead">
  6524. read numbering form an existing package
  6525. </member>
  6526. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.Commit">
  6527. save and Commit numbering
  6528. </member>
  6529. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.SetNumbering(NPOI.OpenXmlFormats.Wordprocessing.CT_Numbering)">
  6530. Sets the ctNumbering
  6531. @param numbering
  6532. </member>
  6533. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.NumExist(System.String)">
  6534. Checks whether number with numID exists
  6535. @param numID
  6536. @return bool true if num exist, false if num not exist
  6537. </member>
  6538. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.AddNum(NPOI.XWPF.UserModel.XWPFNum)">
  6539. add a new number to the numbering document
  6540. @param num
  6541. </member>
  6542. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.AddNum(System.String)">
  6543. Add a new num with an abstractNumID
  6544. @return return NumId of the Added num
  6545. </member>
  6546. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.AddNum(System.String,System.String)">
  6547. Add a new num with an abstractNumID and a numID
  6548. @param abstractNumID
  6549. @param numID
  6550. </member>
  6551. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.GetNum(System.String)">
  6552. Get Num by NumID
  6553. @param numID
  6554. @return abstractNum with NumId if no Num exists with that NumID
  6555. null will be returned
  6556. </member>
  6557. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.GetAbstractNum(System.String)">
  6558. Get AbstractNum by abstractNumID
  6559. @param abstractNumID
  6560. @return abstractNum with abstractNumId if no abstractNum exists with that abstractNumID
  6561. null will be returned
  6562. </member>
  6563. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.GetIdOfAbstractNum(NPOI.XWPF.UserModel.XWPFAbstractNum)">
  6564. Compare AbstractNum with abstractNums of this numbering document.
  6565. If the content of abstractNum Equals with an abstractNum of the List in numbering
  6566. the Bigint Value of it will be returned.
  6567. If no equal abstractNum is existing null will be returned
  6568. @param abstractNum
  6569. @return Bigint
  6570. </member>
  6571. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.AddAbstractNum(NPOI.XWPF.UserModel.XWPFAbstractNum)">
  6572. add a new AbstractNum and return its AbstractNumID
  6573. @param abstractNum
  6574. </member>
  6575. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.AddAbstractNum">
  6576. <summary>
  6577. Add a new AbstractNum
  6578. </summary>
  6579. <returns></returns>
  6580. @author antony liu
  6581. </member>
  6582. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.RemoveAbstractNum(System.String)">
  6583. remove an existing abstractNum
  6584. @param abstractNumID
  6585. @return true if abstractNum with abstractNumID exists in NumberingArray,
  6586. false if abstractNum with abstractNumID not exists
  6587. </member>
  6588. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.GetAbstractNumID(System.String)">
  6589. return the abstractNumID
  6590. If the AbstractNumID not exists
  6591. return null
  6592. @param numID
  6593. @return abstractNumID
  6594. </member>
  6595. <member name="T:NPOI.XWPF.UserModel.XWPFParagraph">
  6596. Sketch of XWPF paragraph class
  6597. </member>
  6598. <member name="F:NPOI.XWPF.UserModel.XWPFParagraph.document">
  6599. For access to the document's hyperlink, comments, tables etc
  6600. </member>
  6601. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.BuildRunsInOrderFromXml(System.Collections.ArrayList)">
  6602. Identifies (in order) the parts of the paragraph /
  6603. sub-paragraph that correspond to character text
  6604. runs, and builds the appropriate runs for these.
  6605. </member>
  6606. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetNumID">
  6607. If style exist for this paragraph
  6608. NumId of the paragraph will be returned.
  6609. If style not exist null will be returned
  6610. @return NumID as Bigint
  6611. </member>
  6612. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.SetNumID(System.String)">
  6613. SetNumID of Paragraph
  6614. @param numPos
  6615. </member>
  6616. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.SetNumID(System.String,System.String)">
  6617. <summary>
  6618. Set NumID and level of Paragraph
  6619. </summary>
  6620. <param name="numId"></param>
  6621. <param name="ilvl"></param>
  6622. </member>
  6623. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetPictureText">
  6624. Returns any text from any suitable pictures in the paragraph
  6625. </member>
  6626. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.CreateRun">
  6627. <summary>
  6628. Appends a new run to this paragraph
  6629. </summary>
  6630. <returns>a new text run</returns>
  6631. </member>
  6632. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetAlignment">
  6633. Returns the paragraph alignment which shall be applied to text in this
  6634. paragraph.
  6635. <p>
  6636. If this element is not Set on a given paragraph, its value is determined
  6637. by the Setting previously Set at any level of the style hierarchy (i.e.
  6638. that previous Setting remains unChanged). If this Setting is never
  6639. specified in the style hierarchy, then no alignment is applied to the
  6640. paragraph.
  6641. </p>
  6642. @return the paragraph alignment of this paragraph.
  6643. </member>
  6644. <!-- Badly formed XML comment ignored for member "M:NPOI.XWPF.UserModel.XWPFParagraph.SetAlignment(NPOI.XWPF.UserModel.ParagraphAlignment)" -->
  6645. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetVerticalAlignment">
  6646. Returns the text vertical alignment which shall be applied to text in
  6647. this paragraph.
  6648. <p>
  6649. If the line height (before any Added spacing) is larger than one or more
  6650. characters on the line, all characters will be aligned to each other as
  6651. specified by this element.
  6652. </p>
  6653. <p>
  6654. If this element is omitted on a given paragraph, its value is determined
  6655. by the Setting previously Set at any level of the style hierarchy (i.e.
  6656. that previous Setting remains unChanged). If this Setting is never
  6657. specified in the style hierarchy, then the vertical alignment of all
  6658. characters on the line shall be automatically determined by the consumer.
  6659. </p>
  6660. @return the vertical alignment of this paragraph.
  6661. </member>
  6662. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.SetVerticalAlignment(NPOI.XWPF.UserModel.TextAlignment)">
  6663. Specifies the text vertical alignment which shall be applied to text in
  6664. this paragraph.
  6665. <p>
  6666. If the line height (before any Added spacing) is larger than one or more
  6667. characters on the line, all characters will be aligned to each other as
  6668. specified by this element.
  6669. </p>
  6670. <p>
  6671. If this element is omitted on a given paragraph, its value is determined
  6672. by the Setting previously Set at any level of the style hierarchy (i.e.
  6673. that previous Setting remains unChanged). If this Setting is never
  6674. specified in the style hierarchy, then the vertical alignment of all
  6675. characters on the line shall be automatically determined by the consumer.
  6676. </p>
  6677. @param valign the paragraph vertical alignment to apply to this
  6678. paragraph.
  6679. </member>
  6680. <!-- Badly formed XML comment ignored for member "M:NPOI.XWPF.UserModel.XWPFParagraph.SetBorderTop(NPOI.XWPF.UserModel.Borders)" -->
  6681. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetBorderTop">
  6682. Specifies the border which shall be displayed above a Set of paragraphs
  6683. which have the same Set of paragraph border Settings.
  6684. @return paragraphBorder - the top border for the paragraph
  6685. @see #setBorderTop(Borders)
  6686. @see Borders a list of all types of borders
  6687. </member>
  6688. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.SetBorderBottom(NPOI.XWPF.UserModel.Borders)">
  6689. *
  6690. * <p>
  6691. * </p>
  6692. * <p>
  6693. * If this element is omitted on a given paragraph, its value is determined
  6694. * by the Setting previously Set at any level of the style hierarchy (i.e.
  6695. * that previous Setting remains unChanged). If this Setting is never
  6696. * specified in the style hierarchy, then no between border shall be applied
  6697. * below identical paragraphs.
  6698. * </p>
  6699. * <b>This border can only be a line border.</b>
  6700. <summary>
  6701. Specifies the border which shall be displayed below a Set of paragraphs
  6702. which have the same Set of paragraph border Settings.
  6703. </summary>
  6704. <param name="border">a list of all types of borders</param>
  6705. <remarks>
  6706. To determine if any two adjoining paragraphs shall have an individual top
  6707. and bottom border or a between border, the Set of borders on the two
  6708. adjoining paragraphs are Compared. If the border information on those two
  6709. paragraphs is identical for all possible paragraphs borders, then the
  6710. between border is displayed. Otherwise, the paragraph shall use its
  6711. bottom border and the following paragraph shall use its top border,
  6712. respectively. If this border specifies a space attribute, that value
  6713. determines the space After the bottom of the text (ignoring any space
  6714. below) which should be left before this border is Drawn, specified in
  6715. points.
  6716. </remarks>
  6717. </member>
  6718. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetBorderBottom">
  6719. <summary>
  6720. Specifies the border which shall be displayed below a Set of
  6721. paragraphs which have the same Set of paragraph border Settings.
  6722. </summary>
  6723. <returns>the bottom border for the paragraph</returns>
  6724. </member>
  6725. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.SetBorderLeft(NPOI.XWPF.UserModel.Borders)">
  6726. Specifies the border which shall be displayed on the left side of the
  6727. page around the specified paragraph.
  6728. <p>
  6729. To determine if any two adjoining paragraphs should have a left border
  6730. which spans the full line height or not, the left border shall be Drawn
  6731. between the top border or between border at the top (whichever would be
  6732. rendered for the current paragraph), and the bottom border or between
  6733. border at the bottom (whichever would be rendered for the current
  6734. paragraph).
  6735. </p>
  6736. <p>
  6737. If this element is omitted on a given paragraph, its value is determined
  6738. by the Setting previously Set at any level of the style hierarchy (i.e.
  6739. that previous Setting remains unChanged). If this Setting is never
  6740. specified in the style hierarchy, then no left border shall be applied.
  6741. </p>
  6742. <b>This border can only be a line border.</b>
  6743. @param border
  6744. @see Borders for a list of all possible borders
  6745. </member>
  6746. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetBorderLeft">
  6747. <summary>
  6748. Specifies the border which shall be displayed on the left side of the
  6749. page around the specified paragraph.
  6750. </summary>
  6751. <returns>the left border for the paragraph</returns>
  6752. </member>
  6753. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.SetBorderRight(NPOI.XWPF.UserModel.Borders)">
  6754. Specifies the border which shall be displayed on the right side of the
  6755. page around the specified paragraph.
  6756. <p>
  6757. To determine if any two adjoining paragraphs should have a right border
  6758. which spans the full line height or not, the right border shall be Drawn
  6759. between the top border or between border at the top (whichever would be
  6760. rendered for the current paragraph), and the bottom border or between
  6761. border at the bottom (whichever would be rendered for the current
  6762. paragraph).
  6763. </p>
  6764. <p>
  6765. If this element is omitted on a given paragraph, its value is determined
  6766. by the Setting previously Set at any level of the style hierarchy (i.e.
  6767. that previous Setting remains unChanged). If this Setting is never
  6768. specified in the style hierarchy, then no right border shall be applied.
  6769. </p>
  6770. <b>This border can only be a line border.</b>
  6771. @param border
  6772. @see Borders for a list of all possible borders
  6773. </member>
  6774. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetBorderRight">
  6775. Specifies the border which shall be displayed on the right side of the
  6776. page around the specified paragraph.
  6777. @return ParagraphBorder - the right border for the paragraph
  6778. @see #setBorderRight(Borders)
  6779. @see Borders for a list of all possible borders
  6780. </member>
  6781. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.SetBorderBetween(NPOI.XWPF.UserModel.Borders)">
  6782. Specifies the border which shall be displayed between each paragraph in a
  6783. Set of paragraphs which have the same Set of paragraph border Settings.
  6784. <p>
  6785. To determine if any two adjoining paragraphs should have a between border
  6786. or an individual top and bottom border, the Set of borders on the two
  6787. adjoining paragraphs are Compared. If the border information on those two
  6788. paragraphs is identical for all possible paragraphs borders, then the
  6789. between border is displayed. Otherwise, each paragraph shall use its
  6790. bottom and top border, respectively. If this border specifies a space
  6791. attribute, that value is ignored - this border is always located at the
  6792. bottom of each paragraph with an identical following paragraph, taking
  6793. into account any space After the line pitch.
  6794. </p>
  6795. <p>
  6796. If this element is omitted on a given paragraph, its value is determined
  6797. by the Setting previously Set at any level of the style hierarchy (i.e.
  6798. that previous Setting remains unChanged). If this Setting is never
  6799. specified in the style hierarchy, then no between border shall be applied
  6800. between identical paragraphs.
  6801. </p>
  6802. <b>This border can only be a line border.</b>
  6803. @param border
  6804. @see Borders for a list of all possible borders
  6805. </member>
  6806. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetBorderBetween">
  6807. Specifies the border which shall be displayed between each paragraph in a
  6808. Set of paragraphs which have the same Set of paragraph border Settings.
  6809. @return ParagraphBorder - the between border for the paragraph
  6810. @see #setBorderBetween(Borders)
  6811. @see Borders for a list of all possible borders
  6812. </member>
  6813. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.SetPageBreak(System.Boolean)">
  6814. Specifies that when rendering this document in a paginated
  6815. view, the contents of this paragraph are rendered on the start of a new
  6816. page in the document.
  6817. <p>
  6818. If this element is omitted on a given paragraph,
  6819. its value is determined by the Setting previously Set at any level of the
  6820. style hierarchy (i.e. that previous Setting remains unChanged). If this
  6821. Setting is never specified in the style hierarchy, then this property
  6822. shall not be applied. Since the paragraph is specified to start on a new
  6823. page, it begins page two even though it could have fit on page one.
  6824. </p>
  6825. @param pageBreak -
  6826. bool value
  6827. </member>
  6828. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.SetSpacingAfterLines(System.Int32)">
  6829. Specifies the spacing that should be Added After the last line in this
  6830. paragraph in the document in line units.
  6831. <b>The value of this attribute is
  6832. specified in one hundredths of a line.
  6833. </b>
  6834. <p>
  6835. If the AfterAutoSpacing attribute
  6836. is also specified, then this attribute value is ignored. If this Setting
  6837. is never specified in the style hierarchy, then its value shall be zero
  6838. (if needed)
  6839. </p>
  6840. @param spaces -
  6841. a positive whole number, whose contents consist of a
  6842. measurement in twentieths of a
  6843. </member>
  6844. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetSpacingAfterLines">
  6845. Specifies the spacing that should be Added After the last line in this
  6846. paragraph in the document in absolute units.
  6847. @return bigint - value representing the spacing After the paragraph
  6848. @see #setSpacingAfterLines(int)
  6849. </member>
  6850. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.SetSpacingBefore(System.Int32)">
  6851. Specifies the spacing that should be Added above the first line in this
  6852. paragraph in the document in absolute units.
  6853. <p>
  6854. If the beforeLines attribute or the beforeAutoSpacing attribute is also
  6855. specified, then this attribute value is ignored.
  6856. </p>
  6857. @param spaces
  6858. </member>
  6859. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetSpacingBefore">
  6860. Specifies the spacing that should be Added above the first line in this
  6861. paragraph in the document in absolute units.
  6862. @return the spacing that should be Added above the first line
  6863. @see #setSpacingBefore(int)
  6864. </member>
  6865. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.SetSpacingBeforeLines(System.Int32)">
  6866. Specifies the spacing that should be Added before the first line in this
  6867. paragraph in the document in line units. <b> The value of this attribute
  6868. is specified in one hundredths of a line. </b>
  6869. <p>
  6870. If the beforeAutoSpacing attribute is also specified, then this attribute
  6871. value is ignored. If this Setting is never specified in the style
  6872. hierarchy, then its value shall be zero.
  6873. </p>
  6874. @param spaces
  6875. </member>
  6876. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetSpacingBeforeLines">
  6877. Specifies the spacing that should be Added before the first line in this paragraph in the
  6878. document in line units.
  6879. The value of this attribute is specified in one hundredths of a line.
  6880. @return the spacing that should be Added before the first line in this paragraph
  6881. @see #setSpacingBeforeLines(int)
  6882. </member>
  6883. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.SetSpacingLineRule(NPOI.XWPF.UserModel.LineSpacingRule)">
  6884. Specifies how the spacing between lines is calculated as stored in the
  6885. line attribute. If this attribute is omitted, then it shall be assumed to
  6886. be of a value auto if a line attribute value is present.
  6887. @param rule
  6888. @see LineSpacingRule
  6889. </member>
  6890. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetSpacingLineRule">
  6891. Specifies how the spacing between lines is calculated as stored in the
  6892. line attribute. If this attribute is omitted, then it shall be assumed to
  6893. be of a value auto if a line attribute value is present.
  6894. @return rule
  6895. @see LineSpacingRule
  6896. @see #setSpacingLineRule(LineSpacingRule)
  6897. </member>
  6898. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetCTPBrd(System.Boolean)">
  6899. Get a <b>copy</b> of the currently used CTPBrd, if none is used, return
  6900. a new instance.
  6901. </member>
  6902. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetCTSpacing(System.Boolean)">
  6903. Get a <b>copy</b> of the currently used CTSpacing, if none is used,
  6904. return a new instance.
  6905. </member>
  6906. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetCTInd(System.Boolean)">
  6907. Get a <b>copy</b> of the currently used CTPInd, if none is used, return
  6908. a new instance.
  6909. </member>
  6910. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetCTPPr">
  6911. Get a <b>copy</b> of the currently used CTPPr, if none is used, return
  6912. a new instance.
  6913. </member>
  6914. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.AddRun(NPOI.OpenXmlFormats.Wordprocessing.CT_R)">
  6915. add a new run at the end of the position of
  6916. the content of parameter run
  6917. @param run
  6918. </member>
  6919. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.SearchText(System.String,NPOI.XWPF.UserModel.PositionInParagraph)">
  6920. this methods parse the paragraph and search for the string searched.
  6921. If it Finds the string, it will return true and the position of the String
  6922. will be saved in the parameter startPos.
  6923. @param searched
  6924. @param startPos
  6925. </member>
  6926. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.InsertNewRun(System.Int32)">
  6927. insert a new Run in RunArray
  6928. @param pos
  6929. @return the inserted run
  6930. </member>
  6931. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetText(NPOI.XWPF.UserModel.TextSegement)">
  6932. Get a Text
  6933. @param segment
  6934. </member>
  6935. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.RemoveRun(System.Int32)">
  6936. Removes a Run at the position pos in the paragraph
  6937. @param pos
  6938. @return true if the run was Removed
  6939. </member>
  6940. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetPart">
  6941. returns the part of the bodyElement
  6942. @see NPOI.XWPF.UserModel.IBody#getPart()
  6943. </member>
  6944. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.AddRun(NPOI.XWPF.UserModel.XWPFRun)">
  6945. Adds a new Run to the Paragraph
  6946. @param r
  6947. </member>
  6948. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetRun(NPOI.OpenXmlFormats.Wordprocessing.CT_R)">
  6949. return the XWPFRun-Element which owns the CTR Run-Element
  6950. @param r
  6951. </member>
  6952. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.Text">
  6953. Return the textual content of the paragraph, including text from pictures
  6954. in it.
  6955. </member>
  6956. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.StyleID">
  6957. Return styleID of the paragraph if style exist for this paragraph
  6958. if not, null will be returned
  6959. @return styleID as String
  6960. </member>
  6961. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.ParagraphText">
  6962. Returns the text of the paragraph, but not of any objects in the
  6963. paragraph
  6964. </member>
  6965. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.FootnoteText">
  6966. Returns the footnote text of the paragraph
  6967. @return the footnote text or empty string if the paragraph does not have footnotes
  6968. </member>
  6969. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IsPageBreak">
  6970. Specifies that when rendering this document in a paginated
  6971. view, the contents of this paragraph are rendered on the start of a new
  6972. page in the document.
  6973. <p>
  6974. If this element is omitted on a given paragraph,
  6975. its value is determined by the Setting previously Set at any level of the
  6976. style hierarchy (i.e. that previous Setting remains unChanged). If this
  6977. Setting is never specified in the style hierarchy, then this property
  6978. shall not be applied. Since the paragraph is specified to start on a new
  6979. page, it begins page two even though it could have fit on page one.
  6980. </p>
  6981. @return bool - if page break is Set
  6982. </member>
  6983. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.SpacingAfter">
  6984. Specifies the spacing that should be Added After the last line in this
  6985. paragraph in the document in absolute units.
  6986. @return int - value representing the spacing After the paragraph
  6987. </member>
  6988. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IndentationLeft">
  6989. Specifies the indentation which shall be placed between the left text
  6990. margin for this paragraph and the left edge of that paragraph's content
  6991. in a left to right paragraph, and the right text margin and the right
  6992. edge of that paragraph's text in a right to left paragraph
  6993. <p>
  6994. If this attribute is omitted, its value shall be assumed to be zero.
  6995. Negative values are defined such that the text is Moved past the text margin,
  6996. positive values Move the text inside the text margin.
  6997. </p>
  6998. @return indentation or null if indentation is not Set
  6999. </member>
  7000. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IndentationRight">
  7001. Specifies the indentation which shall be placed between the right text
  7002. margin for this paragraph and the right edge of that paragraph's content
  7003. in a left to right paragraph, and the right text margin and the right
  7004. edge of that paragraph's text in a right to left paragraph
  7005. <p>
  7006. If this attribute is omitted, its value shall be assumed to be zero.
  7007. Negative values are defined such that the text is Moved past the text margin,
  7008. positive values Move the text inside the text margin.
  7009. </p>
  7010. @return indentation or null if indentation is not Set
  7011. </member>
  7012. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IndentationHanging">
  7013. Specifies the indentation which shall be Removed from the first line of
  7014. the parent paragraph, by moving the indentation on the first line back
  7015. towards the beginning of the direction of text flow.
  7016. This indentation is
  7017. specified relative to the paragraph indentation which is specified for
  7018. all other lines in the parent paragraph.
  7019. The firstLine and hanging
  7020. attributes are mutually exclusive, if both are specified, then the
  7021. firstLine value is ignored.
  7022. @return indentation or null if indentation is not Set
  7023. </member>
  7024. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IndentationFirstLine">
  7025. Specifies the Additional indentation which shall be applied to the first
  7026. line of the parent paragraph. This Additional indentation is specified
  7027. relative to the paragraph indentation which is specified for all other
  7028. lines in the parent paragraph.
  7029. The firstLine and hanging attributes are
  7030. mutually exclusive, if both are specified, then the firstLine value is
  7031. ignored.
  7032. If the firstLineChars attribute is also specified, then this
  7033. value is ignored.
  7034. If this attribute is omitted, then its value shall be
  7035. assumed to be zero (if needed).
  7036. @return indentation or null if indentation is not Set
  7037. </member>
  7038. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IsWordWrap">
  7039. This element specifies whether a consumer shall break Latin text which
  7040. exceeds the text extents of a line by breaking the word across two lines
  7041. (breaking on the character level) or by moving the word to the following
  7042. line (breaking on the word level).
  7043. @return bool
  7044. </member>
  7045. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.Style">
  7046. @return the style of the paragraph
  7047. </member>
  7048. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.ElementType">
  7049. returns the type of the BodyElement Paragraph
  7050. @see NPOI.XWPF.UserModel.IBodyElement#getElementType()
  7051. </member>
  7052. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.PartType">
  7053. returns the partType of the bodyPart which owns the bodyElement
  7054. @see NPOI.XWPF.UserModel.IBody#getPartType()
  7055. </member>
  7056. <member name="T:NPOI.XWPF.UserModel.XWPFPicture">
  7057. @author Philipp Epp
  7058. </member>
  7059. <member name="M:NPOI.XWPF.UserModel.XWPFPicture.SetPictureReference(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  7060. Link Picture with PictureData
  7061. @param rel
  7062. </member>
  7063. <member name="M:NPOI.XWPF.UserModel.XWPFPicture.GetCTPicture">
  7064. Return the underlying CTPicture bean that holds all properties for this picture
  7065. @return the underlying CTPicture bean
  7066. </member>
  7067. <member name="M:NPOI.XWPF.UserModel.XWPFPicture.GetPictureData">
  7068. Get the PictureData of the Picture, if present.
  7069. Note - not all kinds of picture have data
  7070. </member>
  7071. <member name="T:NPOI.XWPF.UserModel.XWPFPictureData">
  7072. <summary>
  7073. Raw picture data, normally attached to a WordProcessingML Drawing. As a rule, pictures are stored in the /word/media/ part of a WordProcessingML package.
  7074. </summary>
  7075. <remarks>
  7076. @author Philipp Epp
  7077. </remarks>
  7078. </member>
  7079. <member name="F:NPOI.XWPF.UserModel.XWPFPictureData.RELATIONS">
  7080. Relationships for each known picture type
  7081. </member>
  7082. <member name="M:NPOI.XWPF.UserModel.XWPFPictureData.#ctor">
  7083. Create a new XWPFGraphicData node
  7084. </member>
  7085. <member name="M:NPOI.XWPF.UserModel.XWPFPictureData.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  7086. Construct XWPFPictureData from a package part
  7087. @param part the package part holding the Drawing data,
  7088. @param rel the package relationship holding this Drawing,
  7089. the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/image
  7090. </member>
  7091. <member name="M:NPOI.XWPF.UserModel.XWPFPictureData.GetData">
  7092. Gets the picture data as a byte array.
  7093. <p>
  7094. Note, that this call might be expensive since all the picture data is copied into a temporary byte array.
  7095. You can grab the picture data directly from the underlying package part as follows:
  7096. <br/>
  7097. <code>
  7098. InputStream is1 = GetPackagePart().InputStream;
  7099. </code>
  7100. </p>
  7101. @return the Picture data.
  7102. </member>
  7103. <member name="M:NPOI.XWPF.UserModel.XWPFPictureData.GetFileName">
  7104. Returns the file name of the image, eg image7.jpg . The original filename
  7105. isn't always available, but if it can be found it's likely to be in the
  7106. CTDrawing
  7107. </member>
  7108. <member name="M:NPOI.XWPF.UserModel.XWPFPictureData.suggestFileExtension">
  7109. Suggests a file extension for this image.
  7110. @return the file extension.
  7111. </member>
  7112. <member name="M:NPOI.XWPF.UserModel.XWPFPictureData.GetPictureType">
  7113. Return an integer constant that specifies type of this picture
  7114. @return an integer constant that specifies type of this picture
  7115. @see NPOI.XWPF.UserModel.PictureTypeEMF
  7116. @see NPOI.XWPF.UserModel.PictureTypeWMF
  7117. @see NPOI.XWPF.UserModel.PictureTypePICT
  7118. @see NPOI.XWPF.UserModel.PictureTypeJPEG
  7119. @see NPOI.XWPF.UserModel.PictureTypePNG
  7120. @see NPOI.XWPF.UserModel.PictureTypeDIB
  7121. </member>
  7122. <member name="T:NPOI.XWPF.UserModel.XWPFRelation">
  7123. @author Yegor Kozlov
  7124. </member>
  7125. <member name="F:NPOI.XWPF.UserModel.XWPFRelation._table">
  7126. A map to lookup POIXMLRelation by its relation type
  7127. </member>
  7128. <member name="F:NPOI.XWPF.UserModel.XWPFRelation.IMAGE_EMF">
  7129. Supported image formats
  7130. </member>
  7131. <member name="M:NPOI.XWPF.UserModel.XWPFRelation.GetInstance(System.String)">
  7132. Get POIXMLRelation by relation type
  7133. @param rel relation type, for example,
  7134. <code>http://schemas.openxmlformats.org/officeDocument/2006/relationships/image</code>
  7135. @return registered POIXMLRelation or null if not found
  7136. </member>
  7137. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.GetZoomPercent">
  7138. In the zoom tag inside Settings.xml file <br/>
  7139. it Sets the value of zoom
  7140. @return percentage as an integer of zoom level
  7141. </member>
  7142. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.SetZoomPercent(System.Int64)">
  7143. <summary>
  7144. Set zoom. In the zoom tag inside settings.xml file it sets the value of zoom
  7145. </summary>
  7146. <param name="zoomPercent"></param>
  7147. <example>
  7148. sample snippet from Settings.xml
  7149. &lt;w:zoom w:percent="50" /&gt;
  7150. </example>
  7151. </member>
  7152. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.IsEnforcedWith(NPOI.OpenXmlFormats.Wordprocessing.ST_DocProtect)">
  7153. Verifies the documentProtection tag inside Settings.xml file <br/>
  7154. if the protection is enforced (w:enforcement="1") <br/>
  7155. and if the kind of protection Equals to passed (STDocProtect.Enum editValue) <br/>
  7156. <br/>
  7157. sample snippet from Settings.xml
  7158. <pre>
  7159. &lt;w:settings ... &gt;
  7160. &lt;w:documentProtection w:edit=&quot;readOnly&quot; w:enforcement=&quot;1&quot;/&gt;
  7161. </pre>
  7162. @return true if documentProtection is enforced with option ReadOnly
  7163. </member>
  7164. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.SetEnforcementEditValue(NPOI.OpenXmlFormats.Wordprocessing.ST_DocProtect)">
  7165. Enforces the protection with the option specified by passed editValue.<br/>
  7166. <br/>
  7167. In the documentProtection tag inside Settings.xml file <br/>
  7168. it Sets the value of enforcement to "1" (w:enforcement="1") <br/>
  7169. and the value of edit to the passed editValue (w:edit="[passed editValue]")<br/>
  7170. <br/>
  7171. sample snippet from Settings.xml
  7172. <pre>
  7173. &lt;w:settings ... &gt;
  7174. &lt;w:documentProtection w:edit=&quot;[passed editValue]&quot; w:enforcement=&quot;1&quot;/&gt;
  7175. </pre>
  7176. </member>
  7177. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.RemoveEnforcement">
  7178. Removes protection enforcement.<br/>
  7179. In the documentProtection tag inside Settings.xml file <br/>
  7180. it Sets the value of enforcement to "0" (w:enforcement="0") <br/>
  7181. </member>
  7182. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.SetUpdateFields">
  7183. Enforces fields update on document open (in Word).
  7184. In the settings.xml file <br/>
  7185. sets the updateSettings value to true (w:updateSettings w:val="true")
  7186. NOTICES:
  7187. <ul>
  7188. <li>Causing Word to ask on open: "This document contains fields that may refer to other files. Do you want to update the fields in this document?"
  7189. (if "Update automatic links at open" is enabled)</li>
  7190. <li>Flag is removed after saving with changes in Word </li>
  7191. </ul>
  7192. </member>
  7193. <member name="T:NPOI.XWPF.UserModel.XWPFStyle">
  7194. @author Philipp Epp
  7195. </member>
  7196. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.#ctor(NPOI.OpenXmlFormats.Wordprocessing.CT_Style)">
  7197. constructor
  7198. @param style
  7199. </member>
  7200. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.#ctor(NPOI.OpenXmlFormats.Wordprocessing.CT_Style,NPOI.XWPF.UserModel.XWPFStyles)">
  7201. constructor
  7202. @param style
  7203. @param styles
  7204. </member>
  7205. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.SetStyle(NPOI.OpenXmlFormats.Wordprocessing.CT_Style)">
  7206. Set style
  7207. @param style
  7208. </member>
  7209. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.GetCTStyle">
  7210. Get ctStyle
  7211. @return ctStyle
  7212. </member>
  7213. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.GetStyles">
  7214. Get styles
  7215. @return styles the styles to which this style belongs
  7216. </member>
  7217. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.HasSameName(NPOI.XWPF.UserModel.XWPFStyle)">
  7218. Compares the names of the Styles
  7219. @param compStyle
  7220. </member>
  7221. <member name="P:NPOI.XWPF.UserModel.XWPFStyle.StyleId">
  7222. Get StyleID of the style
  7223. @return styleID StyleID of the style
  7224. </member>
  7225. <member name="P:NPOI.XWPF.UserModel.XWPFStyle.StyleType">
  7226. Get Type of the Style
  7227. @return ctType
  7228. </member>
  7229. <member name="P:NPOI.XWPF.UserModel.XWPFStyle.LinkStyleID">
  7230. Get StyleID of the linked Style
  7231. </member>
  7232. <member name="P:NPOI.XWPF.UserModel.XWPFStyle.NextStyleID">
  7233. Get StyleID of the next style
  7234. </member>
  7235. <member name="T:NPOI.XWPF.UserModel.XWPFStyles">
  7236. @author Philipp Epp
  7237. </member>
  7238. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  7239. Construct XWPFStyles from a package part
  7240. @param part the package part holding the data of the styles,
  7241. @param rel the package relationship of type "http://schemas.Openxmlformats.org/officeDocument/2006/relationships/styles"
  7242. </member>
  7243. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.#ctor">
  7244. Construct XWPFStyles from scratch for a new document.
  7245. </member>
  7246. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.OnDocumentRead">
  7247. Read document
  7248. </member>
  7249. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.SetStyles(NPOI.OpenXmlFormats.Wordprocessing.CT_Styles)">
  7250. Sets the ctStyles
  7251. @param styles
  7252. </member>
  7253. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.StyleExist(System.String)">
  7254. Checks whether style with styleID exist
  7255. @param styleID styleID of the Style in the style-Document
  7256. @return true if style exist, false if style not exist
  7257. </member>
  7258. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.AddStyle(NPOI.XWPF.UserModel.XWPFStyle)">
  7259. add a style to the document
  7260. @param style
  7261. @throws IOException
  7262. </member>
  7263. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.GetStyle(System.String)">
  7264. get style by a styleID
  7265. @param styleID styleID of the searched style
  7266. @return style
  7267. </member>
  7268. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.GetUsedStyleList(NPOI.XWPF.UserModel.XWPFStyle)">
  7269. Get the styles which are related to the parameter style and their relatives
  7270. this method can be used to copy all styles from one document to another document
  7271. @param style
  7272. @return a list of all styles which were used by this method
  7273. </member>
  7274. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.GetUsedStyleList(NPOI.XWPF.UserModel.XWPFStyle,System.Collections.Generic.List{NPOI.XWPF.UserModel.XWPFStyle})">
  7275. Get the styles which are related to parameter style
  7276. @param style
  7277. @return all Styles of the parameterList
  7278. </member>
  7279. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.SetSpellingLanguage(System.String)">
  7280. Sets the default spelling language on ctStyles DocDefaults parameter
  7281. @param strSpellingLanguage
  7282. </member>
  7283. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.SetEastAsia(System.String)">
  7284. Sets the default East Asia spelling language on ctStyles DocDefaults parameter
  7285. @param strEastAsia
  7286. </member>
  7287. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.SetDefaultFonts(NPOI.OpenXmlFormats.Wordprocessing.CT_Fonts)">
  7288. Sets the default font on ctStyles DocDefaults parameter
  7289. @param fonts
  7290. </member>
  7291. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.GetLatentStyles">
  7292. Get latentstyles
  7293. </member>
  7294. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.GetStyleWithSameName(NPOI.XWPF.UserModel.XWPFStyle)">
  7295. Get the style with the same name
  7296. if this style is not existing, return null
  7297. </member>
  7298. <member name="T:NPOI.XWPF.UserModel.XWPFTable">
  7299. Sketch of XWPFTable class. Only table's text is being hold.
  7300. <p/>
  7301. Specifies the contents of a table present in the document. A table is a Set
  7302. of paragraphs (and other block-level content) arranged in rows and columns.
  7303. @author Yury Batrakov (batrakov at gmail.com)
  7304. @author Gregg Morris (gregg dot morris at gmail dot com) - added
  7305. setStyleID()
  7306. getRowBandSize(), setRowBandSize()
  7307. getColBandSize(), setColBandSize()
  7308. getInsideHBorderType(), getInsideHBorderSize(), getInsideHBorderSpace(), getInsideHBorderColor()
  7309. getInsideVBorderType(), getInsideVBorderSize(), getInsideVBorderSpace(), getInsideVBorderColor()
  7310. setInsideHBorder(), setInsideVBorder()
  7311. getCellMarginTop(), getCellMarginLeft(), getCellMarginBottom(), getCellMarginRight()
  7312. setCellMargins()
  7313. </member>
  7314. <member name="M:NPOI.XWPF.UserModel.XWPFTable.GetCTTbl">
  7315. @return ctTbl object
  7316. </member>
  7317. <member name="M:NPOI.XWPF.UserModel.XWPFTable.AddNewCol">
  7318. add a new column for each row in this table
  7319. </member>
  7320. <member name="M:NPOI.XWPF.UserModel.XWPFTable.CreateRow">
  7321. create a new XWPFTableRow object with as many cells as the number of columns defined in that moment
  7322. @return tableRow
  7323. </member>
  7324. <member name="M:NPOI.XWPF.UserModel.XWPFTable.GetRow(System.Int32)">
  7325. @param pos - index of the row
  7326. @return the row at the position specified or null if no rows is defined or if the position is greather than the max size of rows array
  7327. </member>
  7328. <member name="M:NPOI.XWPF.UserModel.XWPFTable.AddRow(NPOI.XWPF.UserModel.XWPFTableRow)">
  7329. add a new Row to the table
  7330. @param row the row which should be Added
  7331. </member>
  7332. <member name="M:NPOI.XWPF.UserModel.XWPFTable.AddRow(NPOI.XWPF.UserModel.XWPFTableRow,System.Int32)">
  7333. add a new Row to the table
  7334. at position pos
  7335. @param row the row which should be Added
  7336. </member>
  7337. <member name="M:NPOI.XWPF.UserModel.XWPFTable.InsertNewTableRow(System.Int32)">
  7338. inserts a new tablerow
  7339. @param pos
  7340. @return the inserted row
  7341. </member>
  7342. <member name="M:NPOI.XWPF.UserModel.XWPFTable.RemoveRow(System.Int32)">
  7343. Remove a row at position pos from the table
  7344. @param pos position the Row in the Table
  7345. </member>
  7346. <member name="M:NPOI.XWPF.UserModel.XWPFTable.GetPart">
  7347. returns the part of the bodyElement
  7348. @see NPOI.XWPF.UserModel.IBody#getPart()
  7349. </member>
  7350. <member name="M:NPOI.XWPF.UserModel.XWPFTable.GetRow(NPOI.OpenXmlFormats.Wordprocessing.CT_Row)">
  7351. returns the XWPFRow which belongs to the CTRow row
  7352. if this row is not existing in the table null will be returned
  7353. </member>
  7354. <member name="P:NPOI.XWPF.UserModel.XWPFTable.Text">
  7355. @return text
  7356. </member>
  7357. <member name="P:NPOI.XWPF.UserModel.XWPFTable.Width">
  7358. @return width value
  7359. </member>
  7360. <member name="P:NPOI.XWPF.UserModel.XWPFTable.NumberOfRows">
  7361. @return number of rows in table
  7362. </member>
  7363. <member name="P:NPOI.XWPF.UserModel.XWPFTable.StyleID">
  7364. Get the StyleID of the table
  7365. @return style-ID of the table
  7366. </member>
  7367. <member name="P:NPOI.XWPF.UserModel.XWPFTable.ElementType">
  7368. returns the type of the BodyElement Table
  7369. @see NPOI.XWPF.UserModel.IBodyElement#getElementType()
  7370. </member>
  7371. <member name="P:NPOI.XWPF.UserModel.XWPFTable.PartType">
  7372. returns the partType of the bodyPart which owns the bodyElement
  7373. @see NPOI.XWPF.UserModel.IBody#getPartType()
  7374. </member>
  7375. <member name="T:NPOI.XWPF.UserModel.XWPFTableCell">
  7376. XWPFTableCell class.
  7377. @author Gregg Morris (gregg dot morris at gmail dot com) - added XWPFVertAlign enum,
  7378. setColor(),
  7379. setVerticalAlignment()
  7380. </member>
  7381. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.#ctor(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc,NPOI.XWPF.UserModel.XWPFTableRow,NPOI.XWPF.UserModel.IBody)">
  7382. If a table cell does not include at least one block-level element, then this document shall be considered corrupt
  7383. </member>
  7384. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.AddParagraph">
  7385. Add a Paragraph to this Table Cell
  7386. @return The paragraph which was Added
  7387. </member>
  7388. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.AddParagraph(NPOI.XWPF.UserModel.XWPFParagraph)">
  7389. add a Paragraph to this TableCell
  7390. @param p the paragaph which has to be Added
  7391. </member>
  7392. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.RemoveParagraph(System.Int32)">
  7393. Removes a paragraph of this tablecell
  7394. @param pos
  7395. </member>
  7396. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  7397. if there is a corresponding {@link XWPFParagraph} of the parameter ctTable in the paragraphList of this table
  7398. the method will return this paragraph
  7399. if there is no corresponding {@link XWPFParagraph} the method will return null
  7400. @param p is instance of CTP and is searching for an XWPFParagraph
  7401. @return null if there is no XWPFParagraph with an corresponding CTPparagraph in the paragraphList of this table
  7402. XWPFParagraph with the correspondig CTP p
  7403. </member>
  7404. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.SetColor(System.String)">
  7405. Set cell color. This sets some associated values; for finer control
  7406. you may want to access these elements individually.
  7407. @param rgbStr - the desired cell color, in the hex form "RRGGBB".
  7408. </member>
  7409. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetColor">
  7410. Get cell color. Note that this method only returns the "fill" value.
  7411. @return RGB string of cell color
  7412. </member>
  7413. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.SetVerticalAlignment(NPOI.XWPF.UserModel.XWPFTableCell.XWPFVertAlign)">
  7414. Set the vertical alignment of the cell.
  7415. @param vAlign - the desired alignment enum value
  7416. </member>
  7417. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetVerticalAlignment">
  7418. Get the vertical alignment of the cell.
  7419. @return the cell alignment enum value
  7420. </member>
  7421. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.InsertNewParagraph(System.Xml.XmlDocument)">
  7422. add a new paragraph at position of the cursor
  7423. @param cursor
  7424. @return the inserted paragraph
  7425. </member>
  7426. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.IsCursorInTableCell(System.Xml.XmlDocument)">
  7427. verifies that cursor is on the right position
  7428. </member>
  7429. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetParagraphArray(System.Int32)">
  7430. @see NPOI.XWPF.UserModel.IBody#getParagraphArray(int)
  7431. </member>
  7432. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetPart">
  7433. Get the to which the TableCell belongs
  7434. @see NPOI.XWPF.UserModel.IBody#getPart()
  7435. </member>
  7436. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetTable(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  7437. Get a table by its CTTbl-Object
  7438. @see NPOI.XWPF.UserModel.IBody#getTable(org.Openxmlformats.schemas.wordProcessingml.x2006.main.CTTbl)
  7439. </member>
  7440. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetTableArray(System.Int32)">
  7441. @see NPOI.XWPF.UserModel.IBody#getTableArray(int)
  7442. </member>
  7443. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.InsertTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  7444. inserts an existing XWPFTable to the arrays bodyElements and tables
  7445. @see NPOI.XWPF.UserModel.IBody#insertTable(int, NPOI.XWPF.UserModel.XWPFTable)
  7446. </member>
  7447. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  7448. Get the TableCell which belongs to the TableCell
  7449. </member>
  7450. <member name="P:NPOI.XWPF.UserModel.XWPFTableCell.BodyElements">
  7451. returns an Iterator with paragraphs and tables
  7452. @see NPOI.XWPF.UserModel.IBody#getBodyElements()
  7453. </member>
  7454. <member name="P:NPOI.XWPF.UserModel.XWPFTableCell.Paragraphs">
  7455. returns a list of paragraphs
  7456. </member>
  7457. <member name="P:NPOI.XWPF.UserModel.XWPFTableCell.PartType">
  7458. @see NPOI.XWPF.UserModel.IBody#getPartType()
  7459. </member>
  7460. <member name="P:NPOI.XWPF.UserModel.XWPFTableCell.Tables">
  7461. @see NPOI.XWPF.UserModel.IBody#getTables()
  7462. </member>
  7463. <member name="T:NPOI.XWPF.UserModel.XWPFTableRow">
  7464. @author gisellabronzetti
  7465. @author gregg morris - added removeCell(), setCantSplitRow(), setRepeatHeader()
  7466. </member>
  7467. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.CreateCell">
  7468. create a new XWPFTableCell and add it to the tableCell-list of this tableRow
  7469. @return the newly Created XWPFTableCell
  7470. </member>
  7471. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.AddNewTableCell">
  7472. Adds a new TableCell at the end of this tableRow
  7473. </member>
  7474. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.SetHeight(System.Int32)">
  7475. This element specifies the height of the current table row within the
  7476. current table. This height shall be used to determine the resulting
  7477. height of the table row, which may be absolute or relative (depending on
  7478. its attribute values). If omitted, then the table row shall automatically
  7479. resize its height to the height required by its contents (the equivalent
  7480. of an hRule value of auto).
  7481. @param height
  7482. </member>
  7483. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.GetHeight">
  7484. This element specifies the height of the current table row within the
  7485. current table. This height shall be used to determine the resulting
  7486. height of the table row, which may be absolute or relative (depending on
  7487. its attribute values). If omitted, then the table row shall automatically
  7488. resize its height to the height required by its contents (the equivalent
  7489. of an hRule value of auto).
  7490. @return height
  7491. </member>
  7492. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.GetTableCells">
  7493. create and return a list of all XWPFTableCell
  7494. who belongs to this row
  7495. @return a list of {@link XWPFTableCell}
  7496. </member>
  7497. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  7498. returns the XWPFTableCell which belongs to the CTTC cell
  7499. if there is no XWPFTableCell which belongs to the parameter CTTc cell null will be returned
  7500. </member>
  7501. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.SetCantSplitRow(System.Boolean)">
  7502. This attribute controls whether to allow table rows to split across pages.
  7503. The logic for this attribute is a little unusual: a true value means
  7504. DON'T allow rows to split, false means allow rows to split.
  7505. @param split - if true, don't allow rows to be split. If false, allow
  7506. rows to be split.
  7507. </member>
  7508. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.IsCantSplitRow">
  7509. Return true if the "can't split row" value is true. The logic for this
  7510. attribute is a little unusual: a TRUE value means DON'T allow rows to
  7511. split, FALSE means allow rows to split.
  7512. @return true if rows can't be split, false otherwise.
  7513. </member>
  7514. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.SetRepeatHeader(System.Boolean)">
  7515. This attribute controls whether to repeat a table's header row at the top
  7516. of a table split across pages.
  7517. @param repeat - if TRUE, repeat header row at the top of each page of table;
  7518. if FALSE, don't repeat header row.
  7519. </member>
  7520. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.IsRepeatHeader">
  7521. Return true if a table's header row should be repeated at the top of a
  7522. table split across pages.
  7523. @return true if table's header row should be repeated at the top of each
  7524. page of table, false otherwise.
  7525. </member>
  7526. </members>
  7527. </doc>