NPOI.OOXML.XML 448 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879
  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.PrepareForCommit">
  120. Ensure that a memory based package part does not have lingering data from previous
  121. commit() calls.
  122. Note: This is overwritten for some objects, as *PictureData seem to store the actual content
  123. in the part directly without keeping a copy like all others therefore we need to handle them differently.
  124. </member>
  125. <member name="M:NPOI.POIXMLDocumentPart.CreateRelationship(NPOI.POIXMLRelation,NPOI.POIXMLFactory)">
  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. @return the Created child POIXMLDocumentPart
  130. </member>
  131. <member name="M:NPOI.POIXMLDocumentPart.CreateRelationship(NPOI.POIXMLRelation,NPOI.POIXMLFactory,System.Int32,System.Boolean)">
  132. Create a new child POIXMLDocumentPart
  133. @param descriptor the part descriptor
  134. @param factory the factory that will create an instance of the requested relation
  135. @param idx part number
  136. @param noRelation if true, then no relationship is Added.
  137. @return the Created child POIXMLDocumentPart
  138. </member>
  139. <member name="M:NPOI.POIXMLDocumentPart.Read(NPOI.POIXMLFactory,System.Collections.Generic.Dictionary{NPOI.OpenXml4Net.OPC.PackagePart,NPOI.POIXMLDocumentPart})">
  140. Iterate through the underlying PackagePart and create child POIXMLFactory instances
  141. using the specified factory
  142. @param factory the factory object that Creates POIXMLFactory instances
  143. @param context context map Containing already visited noted keyed by tarGetURI
  144. </member>
  145. <member name="M:NPOI.POIXMLDocumentPart.GetTargetPart(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  146. Get the PackagePart that is the target of a relationship.
  147. @param rel The relationship
  148. @return The target part
  149. @throws InvalidFormatException
  150. </member>
  151. <member name="M:NPOI.POIXMLDocumentPart.OnDocumentCreate">
  152. Fired when a new namespace part is Created
  153. </member>
  154. <member name="M:NPOI.POIXMLDocumentPart.OnDocumentRead">
  155. Fired when a namespace part is read
  156. </member>
  157. <member name="M:NPOI.POIXMLDocumentPart.onDocumentRemove">
  158. Fired when a namespace part is about to be Removed from the namespace
  159. </member>
  160. <member name="F:NPOI.POIXMLDocument.pkg">
  161. The OPC Package
  162. </member>
  163. <member name="F:NPOI.POIXMLDocument.properties">
  164. The properties of the OPC namespace, opened as needed
  165. </member>
  166. <member name="M:NPOI.POIXMLDocument.OpenPackage(System.String)">
  167. Wrapper to open a namespace, returning an IOException
  168. in the event of a problem.
  169. Works around shortcomings in java's this() constructor calls
  170. </member>
  171. <member name="M:NPOI.POIXMLDocument.GetRelatedByType(System.String)">
  172. Retrieves all the PackageParts which are defined as
  173. relationships of the base document with the
  174. specified content type.
  175. </member>
  176. <member name="M:NPOI.POIXMLDocument.HasOOXMLHeader(System.IO.Stream)">
  177. Checks that the supplied Stream (which MUST
  178. support mark and reSet, or be a PushbackStream)
  179. has a OOXML (zip) header at the start of it.
  180. If your Stream does not support mark / reSet,
  181. then wrap it in a PushBackStream, then be
  182. sure to always use that, and not the original!
  183. @param inp An Stream which supports either mark/reSet, or is a PushbackStream
  184. </member>
  185. <member name="M:NPOI.POIXMLDocument.GetProperties">
  186. Get the document properties. This gives you access to the
  187. core ooxml properties, and the extended ooxml properties.
  188. </member>
  189. <member name="M:NPOI.POIXMLDocument.GetAllEmbedds">
  190. Get the document's embedded files.
  191. </member>
  192. <member name="M:NPOI.POIXMLDocument.Close">
  193. Closes the underlying {@link OPCPackage} from which this
  194. document was read, if there is one
  195. </member>
  196. <member name="M:NPOI.POIXMLDocument.Write(System.IO.Stream)">
  197. Write out this document to an Outputstream.
  198. @param stream - the java Stream you wish to write the file to
  199. @exception IOException if anything can't be written.
  200. </member>
  201. <member name="T:NPOI.POIXMLFactory">
  202. Defines a factory API that enables sub-classes to create instances of <code>POIXMLDocumentPart</code>
  203. @author Yegor Kozlov
  204. </member>
  205. <member name="M:NPOI.POIXMLFactory.CreateDocumentPart(NPOI.POIXMLDocumentPart,NPOI.OpenXml4Net.OPC.PackageRelationship,NPOI.OpenXml4Net.OPC.PackagePart)">
  206. Create a POIXMLDocumentPart from existing namespace part and relation. This method is called
  207. from {@link POIXMLDocument#load(POIXMLFactory)} when parsing a document
  208. @param parent parent part
  209. @param rel the namespace part relationship
  210. @param part the PackagePart representing the Created instance
  211. @return A new instance of a POIXMLDocumentPart.
  212. </member>
  213. <member name="M:NPOI.POIXMLFactory.CreateDocumentPart(NPOI.POIXMLRelation)">
  214. Create a new POIXMLDocumentPart using the supplied descriptor. This method is used when Adding new parts
  215. to a document, for example, when Adding a sheet to a workbook, slide to a presentation, etc.
  216. @param descriptor describes the object to create
  217. @return A new instance of a POIXMLDocumentPart.
  218. </member>
  219. <member name="T:NPOI.CoreProperties">
  220. The core document properties
  221. </member>
  222. <member name="T:NPOI.ExtendedProperties">
  223. Extended document properties
  224. </member>
  225. <member name="T:NPOI.CustomProperties">
  226. Custom document properties
  227. </member>
  228. <member name="F:NPOI.CustomProperties.FORMAT_ID">
  229. Each custom property element Contains an fmtid attribute
  230. with the same GUID value ({D5CDD505-2E9C-101B-9397-08002B2CF9AE}).
  231. </member>
  232. <member name="M:NPOI.CustomProperties.Add(System.String)">
  233. Add a new property
  234. @param name the property name
  235. @throws IllegalArgumentException if a property with this name already exists
  236. </member>
  237. <member name="M:NPOI.CustomProperties.AddProperty(System.String,System.String)">
  238. Add a new string property
  239. @throws IllegalArgumentException if a property with this name already exists
  240. </member>
  241. <member name="M:NPOI.CustomProperties.AddProperty(System.String,System.Double)">
  242. Add a new double property
  243. @throws IllegalArgumentException if a property with this name already exists
  244. </member>
  245. <member name="M:NPOI.CustomProperties.AddProperty(System.String,System.Int32)">
  246. Add a new integer property
  247. @throws IllegalArgumentException if a property with this name already exists
  248. </member>
  249. <member name="M:NPOI.CustomProperties.AddProperty(System.String,System.Boolean)">
  250. Add a new bool property
  251. @throws IllegalArgumentException if a property with this name already exists
  252. </member>
  253. <member name="M:NPOI.CustomProperties.NextPid">
  254. Generate next id that uniquely relates a custom property
  255. @return next property id starting with 2
  256. </member>
  257. <member name="M:NPOI.CustomProperties.Contains(System.String)">
  258. Check if a property with this name already exists in the collection of custom properties
  259. @param name the name to check
  260. @return whether a property with the given name exists in the custom properties
  261. </member>
  262. <member name="M:NPOI.CustomProperties.GetProperty(System.String)">
  263. Retrieve the custom property with this name, or null if none exists.
  264. You will need to test the various isSetX methods to work out
  265. what the type of the property is, before fetching the
  266. appropriate value for it.
  267. @param name the name of the property to fetch
  268. </member>
  269. <member name="T:NPOI.POIXMLProperties">
  270. Wrapper around the two different kinds of OOXML properties
  271. a document can have
  272. </member>
  273. <member name="M:NPOI.POIXMLProperties.Commit">
  274. Commit Changes to the underlying OPC namespace
  275. </member>
  276. <member name="P:NPOI.POIXMLProperties.CoreProperties">
  277. Returns the core document properties
  278. </member>
  279. <member name="P:NPOI.POIXMLProperties.ExtendedProperties">
  280. Returns the extended document properties
  281. </member>
  282. <member name="P:NPOI.POIXMLProperties.CustomProperties">
  283. Returns the custom document properties
  284. </member>
  285. <member name="T:NPOI.POIXMLPropertiesTextExtractor">
  286. A {@link POITextExtractor} for returning the textual
  287. content of the OOXML file properties, eg author
  288. and title.
  289. </member>
  290. <member name="F:NPOI.POIXMLTextExtractor._document">
  291. The POIXMLDocument that's open
  292. </member>
  293. <member name="M:NPOI.POIXMLTextExtractor.#ctor(NPOI.POIXMLDocument)">
  294. Creates a new text extractor for the given document
  295. </member>
  296. <member name="M:NPOI.POIXMLTextExtractor.GetCoreProperties">
  297. Returns the core document properties
  298. </member>
  299. <member name="M:NPOI.POIXMLTextExtractor.GetExtendedProperties">
  300. Returns the extended document properties
  301. </member>
  302. <member name="M:NPOI.POIXMLTextExtractor.GetCustomProperties">
  303. Returns the custom document properties
  304. </member>
  305. <member name="P:NPOI.POIXMLTextExtractor.Document">
  306. Returns opened document
  307. </member>
  308. <member name="P:NPOI.POIXMLTextExtractor.Package">
  309. Returns the opened OPCPackage that Contains the document
  310. </member>
  311. <member name="P:NPOI.POIXMLTextExtractor.MetadataTextExtractor">
  312. Returns an OOXML properties text extractor for the
  313. document properties metadata, such as title and author.
  314. </member>
  315. <member name="M:NPOI.POIXMLPropertiesTextExtractor.#ctor(NPOI.POIXMLDocument)">
  316. Creates a new POIXMLPropertiesTextExtractor for the
  317. given open document.
  318. </member>
  319. <member name="M:NPOI.POIXMLPropertiesTextExtractor.#ctor(NPOI.POIXMLTextExtractor)">
  320. Creates a new POIXMLPropertiesTextExtractor, for the
  321. same file that another TextExtractor is already
  322. working on.
  323. </member>
  324. <member name="M:NPOI.POIXMLPropertiesTextExtractor.GetCorePropertiesText">
  325. Returns the core document properties, eg author
  326. </member>
  327. <member name="M:NPOI.POIXMLPropertiesTextExtractor.GetExtendedPropertiesText">
  328. Returns the extended document properties, eg
  329. application
  330. </member>
  331. <member name="M:NPOI.POIXMLPropertiesTextExtractor.GetCustomPropertiesText">
  332. Returns the custom document properties, if
  333. there are any
  334. </member>
  335. <member name="T:NPOI.POIXMLRelation">
  336. Represents a descriptor of a OOXML relation.
  337. @author Yegor Kozlov
  338. </member>
  339. <member name="F:NPOI.POIXMLRelation._type">
  340. Describes the content stored in a part.
  341. </member>
  342. <member name="F:NPOI.POIXMLRelation._relation">
  343. The kind of connection between a source part and a target part in a namespace.
  344. </member>
  345. <member name="F:NPOI.POIXMLRelation._defaultName">
  346. The path component of a pack URI.
  347. </member>
  348. <member name="F:NPOI.POIXMLRelation._cls">
  349. Defines what object is used to construct instances of this relationship
  350. </member>
  351. <member name="M:NPOI.POIXMLRelation.#ctor(System.String,System.String,System.String,System.Type)">
  352. Instantiates a POIXMLRelation.
  353. @param type content type
  354. @param rel relationship
  355. @param defaultName default item name
  356. @param cls defines what object is used to construct instances of this relationship
  357. </member>
  358. <member name="M:NPOI.POIXMLRelation.#ctor(System.String,System.String,System.String)">
  359. Instantiates a POIXMLRelation.
  360. @param type content type
  361. @param rel relationship
  362. @param defaultName default item name
  363. </member>
  364. <member name="M:NPOI.POIXMLRelation.GetFileName(System.Int32)">
  365. Returns the filename for the nth one of these,
  366. e.g. /xl/comments4.xml
  367. </member>
  368. <member name="P:NPOI.POIXMLRelation.ContentType">
  369. Return the content type. Content types define a media type, a subtype, and an
  370. optional set of parameters, as defined in RFC 2616.
  371. @return the content type
  372. </member>
  373. <member name="P:NPOI.POIXMLRelation.Relation">
  374. Return the relationship, the kind of connection between a source part and a target part in a namespace.
  375. Relationships make the connections between parts directly discoverable without looking at the content
  376. in the parts, and without altering the parts themselves.
  377. @return the relationship
  378. </member>
  379. <member name="P:NPOI.POIXMLRelation.DefaultFileName">
  380. Return the default part name. Part names are used to refer to a part in the context of a
  381. namespace, typically as part of a URI.
  382. @return the default part name
  383. </member>
  384. <member name="P:NPOI.POIXMLRelation.RelationClass">
  385. Return type of the obejct used to construct instances of this relationship
  386. @return the class of the object used to construct instances of this relation
  387. </member>
  388. <member name="M:NPOI.SS.Converter.ExcelToHtmlConverter.ProcessRow(NPOI.SS.Util.CellRangeAddress[][],NPOI.SS.UserModel.IRow,System.Xml.XmlElement)">
  389. @return maximum 1-base index of column that were rendered, zero if none
  390. </member>
  391. <member name="M:NPOI.SS.Converter.ExcelToHtmlConverter.ProcessColumnWidths(NPOI.SS.UserModel.ISheet,System.Int32,System.Xml.XmlElement)">
  392. Creates COLGROUP element with width specified for all columns. (Except
  393. first if <tt>{@link #isOutputRowNumbers()}==true</tt>)
  394. </member>
  395. <member name="P:NPOI.SS.Converter.ExcelToHtmlConverter.OutputColumnHeaders">
  396. <summary>
  397. 是否输出列头
  398. </summary>
  399. </member>
  400. <member name="P:NPOI.SS.Converter.ExcelToHtmlConverter.OutputHiddenColumns">
  401. <summary>
  402. 是否输出隐藏的列
  403. </summary>
  404. </member>
  405. <member name="P:NPOI.SS.Converter.ExcelToHtmlConverter.OutputHiddenRows">
  406. <summary>
  407. 是否输出隐藏的行
  408. </summary>
  409. </member>
  410. <member name="P:NPOI.SS.Converter.ExcelToHtmlConverter.OutputLeadingSpacesAsNonBreaking">
  411. <summary>
  412. 是否输出文本前的空格
  413. </summary>
  414. </member>
  415. <member name="P:NPOI.SS.Converter.ExcelToHtmlConverter.OutputRowNumbers">
  416. <summary>
  417. 是否输出行号
  418. </summary>
  419. </member>
  420. <member name="P:NPOI.SS.Converter.ExcelToHtmlConverter.UseDivsToSpan">
  421. <summary>
  422. 在跨列的单元格使用DIV标记
  423. </summary>
  424. </member>
  425. <member name="M:NPOI.SS.Converter.ExcelToHtmlUtils.BuildMergedRangesMap(NPOI.SS.UserModel.ISheet)">
  426. Creates a map (i.e. two-dimensional array) filled with ranges. Allow fast
  427. retrieving {@link CellRangeAddress} of any cell, if cell is contained in
  428. range.
  429. @see #getMergedRange(CellRangeAddress[][], int, int)
  430. </member>
  431. <member name="M:NPOI.SS.Converter.ExcelToHtmlUtils.GetColumnWidthInPx(System.Int32)">
  432. See <a href=
  433. "http://apache-poi.1045710.n5.nabble.com/Excel-Column-Width-Unit-Converter-pixels-excel-column-width-units-td2301481.html"
  434. >here</a> for Xio explanation and details
  435. </member>
  436. <member name="M:NPOI.SS.Converter.ExcelToHtmlUtils.GetMergedRange(NPOI.SS.Util.CellRangeAddress[][],System.Int32,System.Int32)">
  437. @param mergedRanges
  438. map of sheet merged ranges built with
  439. {@link #buildMergedRangesMap(HSSFSheet)}
  440. @return {@link CellRangeAddress} from map if cell with specified row and
  441. column numbers contained in found range, <tt>null</tt> otherwise
  442. </member>
  443. <member name="T:NPOI.SS.UserModel.IndexedColors">
  444. A deprecated indexing scheme for colours that is still required for some records, and for backwards
  445. compatibility with OLE2 formats.
  446. <p>
  447. Each element corresponds to a color index (zero-based). When using the default indexed color palette,
  448. the values are not written out, but instead are implied. When the color palette has been modified from default,
  449. then the entire color palette is used.
  450. </p>
  451. @author Yegor Kozlov
  452. </member>
  453. <member name="P:NPOI.SS.UserModel.IndexedColors.Index">
  454. Returns index of this color
  455. @return index of this color
  456. </member>
  457. <member name="F:NPOI.SS.UserModel.ImportOption.SheetContentOnly">
  458. <summary>
  459. Only Text and Formulas are imported. Pictures, Drawing, Styles etc. are all ignored.
  460. </summary>
  461. </member>
  462. <member name="F:NPOI.SS.UserModel.ImportOption.TextOnly">
  463. <summary>
  464. Only Text, Comments and Formulas are imported. Pictures, Drawing, Styles etc. are all ignored.
  465. </summary>
  466. </member>
  467. <member name="F:NPOI.SS.UserModel.ImportOption.All">
  468. <summary>
  469. Everything is imported - this is the same as NONE.
  470. </summary>
  471. </member>
  472. <member name="T:NPOI.SS.UserModel.WorkbookFactory">
  473. <summary>
  474. Factory for creating the appropriate kind of Workbook
  475. (be it HSSFWorkbook or XSSFWorkbook), from the given input
  476. </summary>
  477. </member>
  478. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  479. <summary>
  480. Creates an HSSFWorkbook from the given POIFSFileSystem
  481. </summary>
  482. </member>
  483. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(NPOI.POIFS.FileSystem.NPOIFSFileSystem)">
  484. Creates an HSSFWorkbook from the given NPOIFSFileSystem
  485. </member>
  486. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(NPOI.OpenXml4Net.OPC.OPCPackage)">
  487. <summary>
  488. Creates an XSSFWorkbook from the given OOXML Package
  489. </summary>
  490. </member>
  491. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(System.IO.Stream)">
  492. <summary>
  493. Creates the appropriate HSSFWorkbook / XSSFWorkbook from
  494. the given InputStream. The Stream is wraped inside a PushbackInputStream.
  495. </summary>
  496. <param name="inputStream">Input Stream of .xls or .xlsx file</param>
  497. <returns>IWorkbook depending on the input HSSFWorkbook or XSSFWorkbook is returned.</returns>
  498. </member>
  499. <!-- Badly formed XML comment ignored for member "M:NPOI.SS.UserModel.WorkbookFactory.Create(System.String)" -->
  500. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(System.IO.Stream,NPOI.SS.UserModel.ImportOption)">
  501. <summary>
  502. Creates the appropriate HSSFWorkbook / XSSFWorkbook from
  503. the given InputStream. The Stream is wraped inside a PushbackInputStream.
  504. </summary>
  505. <param name="inputStream">Input Stream of .xls or .xlsx file</param>
  506. <param name="importOption">Customize the elements that are processed on the next import</param>
  507. <returns>IWorkbook depending on the input HSSFWorkbook or XSSFWorkbook is returned.</returns>
  508. </member>
  509. <member name="M:NPOI.SS.UserModel.WorkbookFactory.CreateFormulaEvaluator(NPOI.SS.UserModel.IWorkbook)">
  510. <summary>
  511. Creates a specific FormulaEvaluator for the given workbook.
  512. </summary>
  513. </member>
  514. <member name="M:NPOI.SS.UserModel.WorkbookFactory.SetImportOption(NPOI.SS.UserModel.ImportOption)">
  515. <summary>
  516. Sets the import option when opening the next workbook.
  517. Works only for XSSF. For HSSF workbooks this option is ignored.
  518. </summary>
  519. <param name="importOption">Customize the elements that are processed on the next import</param>
  520. </member>
  521. <member name="T:NPOI.Util.IdentifierManager">
  522. <summary>
  523. 24.08.2009 @author Stefan Stern
  524. </summary>
  525. </member>
  526. <member name="F:NPOI.Util.IdentifierManager.upperbound">
  527. </member>
  528. <member name="F:NPOI.Util.IdentifierManager.lowerbound">
  529. </member>
  530. <member name="F:NPOI.Util.IdentifierManager.segments">
  531. List of segments of available identifiers
  532. </member>
  533. <member name="M:NPOI.Util.IdentifierManager.#ctor(System.Int64,System.Int64)">
  534. @param lowerbound the lower limit of the id-range to manage. Must be greater than or equal to {@link #MIN_ID}.
  535. @param upperbound the upper limit of the id-range to manage. Must be less then or equal {@link #MAX_ID}.
  536. </member>
  537. <member name="M:NPOI.Util.IdentifierManager.ReserveNew">
  538. @return a new identifier.
  539. @throws IllegalStateException if no more identifiers are available, then an Exception is raised.
  540. </member>
  541. <member name="M:NPOI.Util.IdentifierManager.Release(System.Int64)">
  542. @param id
  543. the identifier to release. Must be greater than or equal to
  544. {@link #lowerbound} and must be less than or equal to {@link #upperbound}
  545. @return true, if the identifier was reserved and has been successfully
  546. released, false, if the identifier was not reserved.
  547. </member>
  548. <member name="M:NPOI.Util.IdentifierManager.VerifyIdentifiersLeft">
  549. </member>
  550. <member name="T:NPOI.Util.PackageHelper">
  551. Provides handy methods to work with OOXML namespaces
  552. @author Yegor Kozlov
  553. </member>
  554. <member name="M:NPOI.Util.PackageHelper.Clone(NPOI.OpenXml4Net.OPC.OPCPackage,System.String)">
  555. Clone the specified namespace.
  556. @param pkg the namespace to clone
  557. @param file the destination file
  558. @return the Cloned namespace
  559. </member>
  560. <member name="M:NPOI.Util.PackageHelper.CreateTempFile">
  561. Creates an empty file in the default temporary-file directory,
  562. </member>
  563. <member name="M:NPOI.Util.PackageHelper.Copy(NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePart)">
  564. Recursively copy namespace parts to the destination namespace
  565. </member>
  566. <member name="M:NPOI.Util.PackageHelper.CopyProperties(NPOI.OpenXml4Net.OPC.PackageProperties,NPOI.OpenXml4Net.OPC.PackageProperties)">
  567. Copy core namespace properties
  568. @param src source properties
  569. @param tgt target properties
  570. </member>
  571. <member name="T:NPOI.XSSF.Extractor.XSSFExcelExtractor">
  572. Helper class to extract text from an OOXML Excel file
  573. </member>
  574. <member name="M:NPOI.XSSF.Extractor.XSSFExcelExtractor.SetIncludeSheetNames(System.Boolean)">
  575. Should sheet names be included? Default is true
  576. </member>
  577. <member name="M:NPOI.XSSF.Extractor.XSSFExcelExtractor.SetFormulasNotResults(System.Boolean)">
  578. Should we return the formula itself, and not
  579. the result it produces? Default is false
  580. </member>
  581. <member name="M:NPOI.XSSF.Extractor.XSSFExcelExtractor.SetIncludeCellComments(System.Boolean)">
  582. Should cell comments be included? Default is false
  583. </member>
  584. <member name="M:NPOI.XSSF.Extractor.XSSFExcelExtractor.SetIncludeHeadersFooters(System.Boolean)">
  585. Should headers and footers be included? Default is true
  586. </member>
  587. <member name="P:NPOI.XSSF.Extractor.XSSFExcelExtractor.IncludeHeaderFooter">
  588. <summary>
  589. Should header and footer be included? Default is true
  590. </summary>
  591. </member>
  592. <member name="P:NPOI.XSSF.Extractor.XSSFExcelExtractor.IncludeSheetNames">
  593. <summary>
  594. Should sheet names be included? Default is true
  595. </summary>
  596. <value>if set to <c>true</c> [include sheet names].</value>
  597. </member>
  598. <member name="P:NPOI.XSSF.Extractor.XSSFExcelExtractor.FormulasNotResults">
  599. <summary>
  600. Should we return the formula itself, and not
  601. the result it produces? Default is false
  602. </summary>
  603. <value>if set to <c>true</c> [formulas not results].</value>
  604. </member>
  605. <member name="P:NPOI.XSSF.Extractor.XSSFExcelExtractor.IncludeCellComments">
  606. <summary>
  607. Should cell comments be included? Default is false
  608. </summary>
  609. <value>if set to <c>true</c> [include cell comments].</value>
  610. </member>
  611. <member name="P:NPOI.XSSF.Extractor.XSSFExcelExtractor.Text">
  612. Retreives the text contents of the file
  613. </member>
  614. <member name="T:NPOI.XSSF.Extractor.XSSFExportToXml">
  615. Maps an XLSX to an XML according to one of the mapping defined.
  616. The output XML Schema must respect this limitations:
  617. <ul>
  618. <li> all mandatory elements and attributes must be mapped (enable validation to check this)</li>
  619. <li> no &lt;any&gt; in complex type/element declaration </li>
  620. <li> no &lt;anyAttribute&gt; attributes declaration </li>
  621. <li> no recursive structures: recursive structures can't be nested more than one level </li>
  622. <li> no abstract elements: abstract complex types can be declared but must not be used in elements. </li>
  623. <li> no mixed content: an element can't contain simple text and child element(s) together </li>
  624. <li> no &lt;substitutionGroup&gt; in complex type/element declaration </li>
  625. </ul>
  626. </member>
  627. <member name="M:NPOI.XSSF.Extractor.XSSFExportToXml.#ctor(NPOI.XSSF.UserModel.XSSFMap)">
  628. Creates a new exporter and Sets the mapping to be used when generating the XML output document
  629. @param map the mapping rule to be used
  630. </member>
  631. <member name="M:NPOI.XSSF.Extractor.XSSFExportToXml.ExportToXML(System.IO.Stream,System.Boolean)">
  632. Exports the data in an XML stream
  633. @param os OutputStream in which will contain the output XML
  634. @param validate if true, validates the XML againts the XML Schema
  635. @throws SAXException
  636. @throws TransformerException
  637. @throws ParserConfigurationException
  638. </member>
  639. <member name="M:NPOI.XSSF.Extractor.XSSFExportToXml.ExportToXML(System.IO.Stream,System.String,System.Boolean)">
  640. Exports the data in an XML stream
  641. @param os OutputStream in which will contain the output XML
  642. @param encoding the output charset encoding
  643. @param validate if true, validates the XML againts the XML Schema
  644. @throws SAXException
  645. @throws ParserConfigurationException
  646. @throws TransformerException
  647. @throws InvalidFormatException
  648. </member>
  649. <member name="M:NPOI.XSSF.Extractor.XSSFExportToXml.IsValid(System.Xml.XmlDocument)">
  650. Validate the generated XML against the XML Schema associated with the XSSFMap
  651. @param xml the XML to validate
  652. @return
  653. </member>
  654. <member name="M:NPOI.XSSF.Extractor.XSSFExportToXml.Compare(System.String,System.String)">
  655. Compares two xpaths to define an ordering according to the XML Schema
  656. </member>
  657. <member name="T:NPOI.XSSF.Model.CalculationChain">
  658. The cells in a workbook can be calculated in different orders depending on various optimizations and
  659. dependencies. The calculation chain object specifies the order in which the cells in a workbook were last calculated.
  660. @author Yegor Kozlov
  661. </member>
  662. <member name="M:NPOI.XSSF.Model.CalculationChain.RemoveItem(System.Int32,System.String)">
  663. Remove a formula reference from the calculation chain
  664. @param sheetId the sheet Id of a sheet the formula belongs to.
  665. @param ref A1 style reference to the cell Containing the formula.
  666. </member>
  667. <member name="F:NPOI.XSSF.Model.CommentsTable.commentRefs">
  668. XML Beans uses a list, which is very slow
  669. to search, so we wrap things with our own
  670. map for fast Lookup.
  671. </member>
  672. <member name="M:NPOI.XSSF.Model.CommentsTable.ReferenceUpdated(System.String,NPOI.OpenXmlFormats.Spreadsheet.CT_Comment)">
  673. Called after the reference is updated, so that
  674. we can reflect that in our cache
  675. </member>
  676. <member name="M:NPOI.XSSF.Model.CommentsTable.FindAuthor(System.String)">
  677. <summary>
  678. Searches the author. If not found he is added to the list of authors.
  679. </summary>
  680. <param name="author">author to search</param>
  681. <returns>index of the author</returns>
  682. </member>
  683. <member name="M:NPOI.XSSF.Model.CommentsTable.NewComment">
  684. This method is deprecated and should not be used any more as
  685. it overwrites the comment in Cell A1.
  686. @return
  687. </member>
  688. <member name="T:NPOI.XSSF.Model.ExternalLinksTable">
  689. Holds details of links to parts of other workbooks (eg named ranges),
  690. along with the most recently seen values for what they point to.
  691. </member>
  692. <member name="P:NPOI.XSSF.Model.ExternalLinksTable.CTExternalLink">
  693. Returns the underlying xmlbeans object for the external
  694. link table
  695. </member>
  696. <member name="P:NPOI.XSSF.Model.ExternalLinksTable.LinkedFileName">
  697. get or set the last recorded name of the file that this
  698. is linked to
  699. </member>
  700. <member name="T:NPOI.XSSF.Model.MapInfo">
  701. This class : the Custom XML Mapping Part (Open Office XML Part 1:
  702. chapter 12.3.6)
  703. An instance of this part type Contains a schema for an XML file, and
  704. information on the behavior that is used when allowing this custom XML schema
  705. to be mapped into the spreadsheet.
  706. @author Roberto Manicardi
  707. </member>
  708. <member name="M:NPOI.XSSF.Model.MapInfo.GetCTMapInfo">
  709. @return the internal data object
  710. </member>
  711. <member name="M:NPOI.XSSF.Model.MapInfo.GetCTSchemaById(System.String)">
  712. Gets the
  713. @param schemaId the schema ID
  714. @return CTSchema by it's ID
  715. </member>
  716. <member name="M:NPOI.XSSF.Model.MapInfo.GetAllXSSFMaps">
  717. @return all the mappings configured in this document
  718. </member>
  719. <member name="P:NPOI.XSSF.Model.MapInfo.Workbook">
  720. Returns the parent XSSFWorkbook
  721. @return the parent XSSFWorkbook
  722. </member>
  723. <member name="T:NPOI.XSSF.Model.ParagraphPropertyFetcher">
  724. Used internally to navigate the paragraph text style hierarchy within a shape and fetch properties
  725. </member>
  726. <member name="M:NPOI.XSSF.Model.ParagraphPropertyFetcher`1.Fetch(NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Shape)">
  727. @param shape the shape being examined
  728. @return true if the desired property was fetched
  729. </member>
  730. <member name="T:NPOI.XSSF.Model.SharedStringsTable">
  731. Table of strings shared across all sheets in a workbook.
  732. <p>
  733. A workbook may contain thousands of cells Containing string (non-numeric) data. Furthermore this data is very
  734. likely to be repeated across many rows or columns. The goal of implementing a single string table that is shared
  735. across the workbook is to improve performance in opening and saving the file by only Reading and writing the
  736. repetitive information once.
  737. </p>
  738. <p>
  739. Consider for example a workbook summarizing information for cities within various countries. There may be a
  740. column for the name of the country, a column for the name of each city in that country, and a column
  741. Containing the data for each city. In this case the country name is repetitive, being duplicated in many cells.
  742. In many cases the repetition is extensive, and a tremendous savings is realized by making use of a shared string
  743. table when saving the workbook. When displaying text in the spreadsheet, the cell table will just contain an
  744. index into the string table as the value of a cell, instead of the full string.
  745. </p>
  746. <p>
  747. The shared string table Contains all the necessary information for displaying the string: the text, formatting
  748. properties, and phonetic properties (for East Asian languages).
  749. </p>
  750. @author Nick Birch
  751. @author Yegor Kozlov
  752. </member>
  753. <member name="F:NPOI.XSSF.Model.SharedStringsTable.strings">
  754. Array of individual string items in the Shared String table.
  755. </member>
  756. <member name="F:NPOI.XSSF.Model.SharedStringsTable.stmap">
  757. Maps strings and their indexes in the <code>strings</code> arrays
  758. </member>
  759. <member name="F:NPOI.XSSF.Model.SharedStringsTable.count">
  760. An integer representing the total count of strings in the workbook. This count does not
  761. include any numbers, it counts only the total of text strings in the workbook.
  762. </member>
  763. <member name="F:NPOI.XSSF.Model.SharedStringsTable.uniqueCount">
  764. An integer representing the total count of unique strings in the Shared String Table.
  765. A string is unique even if it is a copy of another string, but has different formatting applied
  766. at the character level.
  767. </member>
  768. <member name="M:NPOI.XSSF.Model.SharedStringsTable.GetEntryAt(System.Int32)">
  769. Return a string item by index
  770. @param idx index of item to return.
  771. @return the item at the specified position in this Shared String table.
  772. </member>
  773. <member name="M:NPOI.XSSF.Model.SharedStringsTable.AddEntry(NPOI.OpenXmlFormats.Spreadsheet.CT_Rst)">
  774. Add an entry to this Shared String table (a new value is appened to the end).
  775. <p>
  776. If the Shared String table already Contains this <code>CT_Rst</code> bean, its index is returned.
  777. Otherwise a new entry is aded.
  778. </p>
  779. @param st the entry to add
  780. @return index the index of Added entry
  781. </member>
  782. <member name="M:NPOI.XSSF.Model.SharedStringsTable.WriteTo(System.IO.Stream)">
  783. this table out as XML.
  784. @param out The stream to write to.
  785. @throws IOException if an error occurs while writing.
  786. </member>
  787. <member name="P:NPOI.XSSF.Model.SharedStringsTable.Count">
  788. Return an integer representing the total count of strings in the workbook. This count does not
  789. include any numbers, it counts only the total of text strings in the workbook.
  790. @return the total count of strings in the workbook
  791. </member>
  792. <member name="P:NPOI.XSSF.Model.SharedStringsTable.UniqueCount">
  793. Returns an integer representing the total count of unique strings in the Shared String Table.
  794. A string is unique even if it is a copy of another string, but has different formatting applied
  795. at the character level.
  796. @return the total count of unique strings in the workbook
  797. </member>
  798. <member name="P:NPOI.XSSF.Model.SharedStringsTable.Items">
  799. Provide low-level access to the underlying array of CT_Rst beans
  800. @return array of CT_Rst beans
  801. </member>
  802. <member name="T:NPOI.XSSF.Model.SingleXmlCells">
  803. This class : the Single Cell Tables Part (Open Office XML Part 4:
  804. chapter 3.5.2)
  805. @author Roberto Manicardi
  806. </member>
  807. <member name="M:NPOI.XSSF.Model.SingleXmlCells.GetAllSimpleXmlCell">
  808. @return all the SimpleXmlCell Contained in this SingleXmlCells element
  809. </member>
  810. <member name="T:NPOI.XSSF.Model.StylesTable">
  811. Table of styles shared across all sheets in a workbook.
  812. @author ugo
  813. </member>
  814. <member name="F:NPOI.XSSF.Model.StylesTable.FIRST_CUSTOM_STYLE_ID">
  815. The first style id available for use as a custom style
  816. </member>
  817. <member name="M:NPOI.XSSF.Model.StylesTable.#ctor">
  818. Create a new, empty StylesTable
  819. </member>
  820. <member name="M:NPOI.XSSF.Model.StylesTable.ReadFrom(System.Xml.XmlDocument)">
  821. Read this shared styles table from an XML file.
  822. @param is The input stream Containing the XML document.
  823. @throws IOException if an error occurs while Reading.
  824. </member>
  825. <member name="M:NPOI.XSSF.Model.StylesTable.PutFont(NPOI.XSSF.UserModel.XSSFFont,System.Boolean)">
  826. Records the given font in the font table.
  827. Will re-use an existing font index if this
  828. font matches another, EXCEPT if forced
  829. registration is requested.
  830. This allows people to create several fonts
  831. then customise them later.
  832. Note - End Users probably want to call
  833. {@link XSSFFont#registerTo(StylesTable)}
  834. </member>
  835. <member name="M:NPOI.XSSF.Model.StylesTable.GetCTStylesheet">
  836. For unit testing only!
  837. </member>
  838. <member name="M:NPOI.XSSF.Model.StylesTable.WriteTo(System.IO.Stream)">
  839. Write this table out as XML.
  840. @param out The stream to write to.
  841. @throws IOException if an error occurs while writing.
  842. </member>
  843. <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)">
  844. Finds a font that matches the one with the supplied attributes
  845. </member>
  846. <member name="P:NPOI.XSSF.Model.StylesTable.NumCellStyles">
  847. get the size of cell styles
  848. </member>
  849. <member name="P:NPOI.XSSF.Model.StylesTable.NumberFormatSize">
  850. For unit testing only
  851. </member>
  852. <member name="P:NPOI.XSSF.Model.StylesTable.XfsSize">
  853. For unit testing only
  854. </member>
  855. <member name="P:NPOI.XSSF.Model.StylesTable.StyleXfsSize">
  856. For unit testing only
  857. </member>
  858. <member name="T:NPOI.XSSF.Model.ThemesTable">
  859. Class that represents theme of XLSX document. The theme includes specific
  860. colors and fonts.
  861. </member>
  862. <member name="M:NPOI.XSSF.Model.ThemesTable.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  863. Construct a ThemesTable.
  864. @param part A PackagePart.
  865. @param rel A PackageRelationship.
  866. </member>
  867. <member name="M:NPOI.XSSF.Model.ThemesTable.#ctor(NPOI.OpenXmlFormats.Spreadsheet.ThemeDocument)">
  868. Construct a ThemesTable from an existing ThemeDocument.
  869. @param theme A ThemeDocument.
  870. </member>
  871. <member name="M:NPOI.XSSF.Model.ThemesTable.GetThemeColor(System.Int32)">
  872. Convert a theme "index" into a color.
  873. @param idx A theme "index"
  874. @return The mapped XSSFColor, or null if not mapped.
  875. </member>
  876. <member name="M:NPOI.XSSF.Model.ThemesTable.InheritFromThemeAsRequired(NPOI.XSSF.UserModel.XSSFColor)">
  877. If the colour is based on a theme, then inherit
  878. information (currently just colours) from it as
  879. required.
  880. </member>
  881. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFChartAxis">
  882. Base class for all axis types.
  883. @author Roman Kashitsyn
  884. </member>
  885. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFChartDataFactory">
  886. @author Roman Kashitsyn
  887. </member>
  888. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartDataFactory.CreateScatterChartData``2">
  889. @return new scatter chart data instance
  890. </member>
  891. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartDataFactory.GetInstance">
  892. @return factory instance
  893. </member>
  894. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFChartLegend">
  895. Represents a SpreadsheetML chart legend
  896. @author Roman Kashitsyn
  897. </member>
  898. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFChartLegend.legend">
  899. Underlaying CTLagend bean
  900. </member>
  901. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartLegend.#ctor(NPOI.XSSF.UserModel.XSSFChart)">
  902. Create a new SpreadsheetML chart legend
  903. </member>
  904. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartLegend.SetDefaults">
  905. Set sensible default styling.
  906. </member>
  907. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartLegend.GetCTLegend">
  908. Return the underlying CTLegend bean.
  909. @return the underlying CTLegend bean
  910. </member>
  911. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFChartUtil">
  912. Package private class with utility methods.
  913. @author Roman Kashitsyn
  914. </member>
  915. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartUtil.BuildAxDataSource``1(NPOI.OpenXmlFormats.Dml.Chart.CT_AxDataSource,NPOI.SS.UserModel.Charts.IChartDataSource{``0})">
  916. Builds CTAxDataSource object content from POI ChartDataSource.
  917. @param ctAxDataSource OOXML data source to build
  918. @param dataSource POI data source to use
  919. </member>
  920. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartUtil.BuildNumDataSource``1(NPOI.OpenXmlFormats.Dml.Chart.CT_NumDataSource,NPOI.SS.UserModel.Charts.IChartDataSource{``0})">
  921. Builds CTNumDataSource object content from POI ChartDataSource
  922. @param ctNumDataSource OOXML data source to build
  923. @param dataSource POI data source to use
  924. </member>
  925. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFLineChartData`2">
  926. <summary>
  927. Holds data for a XSSF Line Chart
  928. </summary>
  929. <typeparam name="Tx"></typeparam>
  930. <typeparam name="Ty"></typeparam>
  931. </member>
  932. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFLineChartData`2.series">
  933. List of all data series.
  934. </member>
  935. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFManualLayout">
  936. Represents a SpreadsheetML manual layout.
  937. @author Roman Kashitsyn
  938. </member>
  939. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFManualLayout.layout">
  940. Underlaying CTManualLayout bean.
  941. </member>
  942. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFManualLayout.#ctor(NPOI.OpenXmlFormats.Dml.Chart.CT_Layout)">
  943. Create a new SpreadsheetML manual layout.
  944. @param layout a Spreadsheet ML layout that should be used as base.
  945. </member>
  946. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFManualLayout.#ctor(NPOI.XSSF.UserModel.XSSFChart)">
  947. Create a new SpreadsheetML manual layout for chart.
  948. @param chart a chart to create layout for.
  949. </member>
  950. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFManualLayout.GetCTManualLayout">
  951. Return the underlying CTManualLayout bean.
  952. @return the underlying CTManualLayout bean.
  953. </member>
  954. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2">
  955. Represents DrawingML scatter chart.
  956. @author Roman Kashitsyn
  957. </member>
  958. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.series">
  959. List of all data series.
  960. </member>
  961. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.Series">
  962. Package private ScatterChartSerie implementation.
  963. </member>
  964. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.Series.GetXValues">
  965. Returns data source used for X axis values.
  966. @return data source used for X axis values
  967. </member>
  968. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.Series.GetYValues">
  969. Returns data source used for Y axis values.
  970. @return data source used for Y axis values
  971. </member>
  972. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.Series.SetUseCache(System.Boolean)">
  973. @param useCache if true, cached results will be Added on plot
  974. </member>
  975. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFValueAxis">
  976. Value axis type.
  977. @author Roman Kashitsyn
  978. </member>
  979. <member name="T:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment">
  980. Cell Settings avaiable in the Format/Alignment tab
  981. </member>
  982. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_CellAlignment)">
  983. Creates a Cell Alignment from the supplied XML defInition
  984. @param cellAlignment
  985. </member>
  986. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.GetCTCellAlignment">
  987. Access to low-level data
  988. </member>
  989. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.Vertical">
  990. Get the type of vertical alignment for the cell
  991. @return the type of aligment
  992. @see VerticalAlignment
  993. </member>
  994. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.Horizontal">
  995. Get the type of horizontal alignment for the cell
  996. @return the type of aligment
  997. @see HorizontalAlignment
  998. </member>
  999. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.Indent">
  1000. Get the number of spaces to indent the text in the cell
  1001. @return indent - number of spaces
  1002. </member>
  1003. <!-- Badly formed XML comment ignored for member "P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.TextRotation" -->
  1004. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.WrapText">
  1005. Whether the text should be wrapped
  1006. @return a bool value indicating if the text in a cell should be line-wrapped within the cell.
  1007. </member>
  1008. <member name="T:NPOI.XSSF.UserModel.Extensions.BorderSide">
  1009. The enumeration value indicating the side being used for a cell border.
  1010. </member>
  1011. <member name="T:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder">
  1012. This element Contains border formatting information, specifying border defInition formats (left, right, top, bottom, diagonal)
  1013. for cells in the workbook.
  1014. Color is optional.
  1015. </member>
  1016. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Border,NPOI.XSSF.Model.ThemesTable)">
  1017. Creates a Cell Border from the supplied XML defInition
  1018. </member>
  1019. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Border)">
  1020. Creates a Cell Border from the supplied XML defInition
  1021. </member>
  1022. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.#ctor">
  1023. Creates a new, empty Cell Border.
  1024. You need to attach this to the Styles Table
  1025. </member>
  1026. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.SetThemesTable(NPOI.XSSF.Model.ThemesTable)">
  1027. Records the Themes Table that is associated with
  1028. the current font, used when looking up theme
  1029. based colours and properties.
  1030. </member>
  1031. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.GetCTBorder">
  1032. Returns the underlying XML bean.
  1033. @return CT_Border
  1034. </member>
  1035. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.GetBorderStyle(NPOI.XSSF.UserModel.Extensions.BorderSide)">
  1036. Get the type of border to use for the selected border
  1037. @param side - - where to apply the color defInition
  1038. @return borderstyle - the type of border to use. default value is NONE if border style is not Set.
  1039. @see BorderStyle
  1040. </member>
  1041. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.SetBorderStyle(NPOI.XSSF.UserModel.Extensions.BorderSide,NPOI.SS.UserModel.BorderStyle)">
  1042. Set the type of border to use for the selected border
  1043. @param side - - where to apply the color defInition
  1044. @param style - border style
  1045. @see BorderStyle
  1046. </member>
  1047. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.GetBorderColor(NPOI.XSSF.UserModel.Extensions.BorderSide)">
  1048. Get the color to use for the selected border
  1049. @param side - where to apply the color defInition
  1050. @return color - color to use as XSSFColor. null if color is not set
  1051. </member>
  1052. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.SetBorderColor(NPOI.XSSF.UserModel.Extensions.BorderSide,NPOI.XSSF.UserModel.XSSFColor)">
  1053. Set the color to use for the selected border
  1054. @param side - where to apply the color defInition
  1055. @param color - the color to use
  1056. </member>
  1057. <member name="T:NPOI.XSSF.UserModel.Extensions.XSSFCellFill">
  1058. This element specifies fill formatting.
  1059. A cell fill consists of a background color, foreground color, and pattern to be applied across the cell.
  1060. </member>
  1061. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Fill)">
  1062. Creates a CellFill from the supplied parts
  1063. @param fill - fill
  1064. </member>
  1065. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.#ctor">
  1066. Creates an empty CellFill
  1067. </member>
  1068. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.GetFillBackgroundColor">
  1069. Get the background fill color.
  1070. @return fill color, null if color is not set
  1071. </member>
  1072. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetFillBackgroundColor(System.Int32)">
  1073. Set the background fill color represented as a indexed color value.
  1074. @param index
  1075. </member>
  1076. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetFillBackgroundColor(NPOI.XSSF.UserModel.XSSFColor)">
  1077. Set the background fill color represented as a {@link XSSFColor} value.
  1078. @param color
  1079. </member>
  1080. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.GetFillForegroundColor">
  1081. Get the foreground fill color.
  1082. @return XSSFColor - foreground color. null if color is not set
  1083. </member>
  1084. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetFillForegroundColor(System.Int32)">
  1085. Set the foreground fill color as a indexed color value
  1086. @param index - the color to use
  1087. </member>
  1088. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetFillForegroundColor(NPOI.XSSF.UserModel.XSSFColor)">
  1089. Set the foreground fill color represented as a {@link XSSFColor} value.
  1090. @param color - the color to use
  1091. </member>
  1092. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.GetPatternType">
  1093. get the fill pattern
  1094. @return fill pattern type. null if fill pattern is not set
  1095. </member>
  1096. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetPatternType(NPOI.OpenXmlFormats.Spreadsheet.ST_PatternType)">
  1097. set the fill pattern
  1098. @param patternType fill pattern to use
  1099. </member>
  1100. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.GetCTFill">
  1101. Returns the underlying XML bean.
  1102. @return CT_Fill
  1103. </member>
  1104. <member name="T:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter">
  1105. <summary>
  1106. Parent class of all XSSF headers and footers.
  1107. </summary>
  1108. </member>
  1109. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  1110. Create an instance of XSSFHeaderFooter from the supplied XML bean
  1111. @param headerFooter
  1112. </member>
  1113. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.GetHeaderFooter">
  1114. Returns the underlying CTHeaderFooter xml bean
  1115. @return the underlying CTHeaderFooter xml bean
  1116. </member>
  1117. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.AreFieldsStripped">
  1118. Are fields currently being stripped from the text that this
  1119. {@link XSSFHeaderFooter} returns? Default is false, but can be Changed
  1120. </member>
  1121. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.SetAreFieldsStripped(System.Boolean)">
  1122. Should fields (eg macros) be stripped from the text that this class
  1123. returns? Default is not to strip.
  1124. @param StripFields
  1125. </member>
  1126. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.StripFields(System.String)">
  1127. Removes any fields (eg macros, page markers etc) from the string.
  1128. Normally used to make some text suitable for showing to humans, and the
  1129. resultant text should not normally be saved back into the document!
  1130. </member>
  1131. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.Center">
  1132. get the text representing the center part of this element
  1133. </member>
  1134. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.Left">
  1135. get the text representing the left part of this element
  1136. </member>
  1137. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.Right">
  1138. get the text representing the right part of this element
  1139. </member>
  1140. <member name="T:NPOI.XSSF.UserModel.Helpers.ColumnHelper">
  1141. Helper class for dealing with the Column Settings on
  1142. a CT_Worksheet (the data part of a sheet).
  1143. Note - within POI, we use 0 based column indexes, but
  1144. the column defInitions in the XML are 1 based!
  1145. </member>
  1146. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.GetColumn(System.Int64,System.Boolean)">
  1147. Returns the Column at the given 0 based index
  1148. </member>
  1149. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.GetColumn1Based(System.Int64,System.Boolean)">
  1150. Returns the Column at the given 1 based index.
  1151. POI default is 0 based, but the file stores
  1152. as 1 based.
  1153. </member>
  1154. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.SweepCleanColumns(NPOI.OpenXmlFormats.Spreadsheet.CT_Cols,NPOI.OpenXmlFormats.Spreadsheet.CT_Col[],NPOI.OpenXmlFormats.Spreadsheet.CT_Col)">
  1155. @see <a href="http://en.wikipedia.org/wiki/Sweep_line_algorithm">Sweep line algorithm</a>
  1156. </member>
  1157. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.columnExists(NPOI.OpenXmlFormats.Spreadsheet.CT_Cols,System.Int64)">
  1158. Does the column at the given 0 based index exist
  1159. in the supplied list of column defInitions?
  1160. </member>
  1161. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.GetOrCreateColumn1Based(System.Int64,System.Boolean)">
  1162. Return the CT_Col at the given (0 based) column index,
  1163. creating it if required.
  1164. </member>
  1165. <member name="M:NPOI.XSSF.UserModel.Helpers.HeaderFooterHelper.GetParts(System.String)">
  1166. Split into left, center, right
  1167. </member>
  1168. <member name="T:NPOI.XSSF.UserModel.Helpers.XSSFFormulaUtils">
  1169. Utility to update formulas and named ranges when a sheet name was Changed
  1170. @author Yegor Kozlov
  1171. </member>
  1172. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFFormulaUtils.UpdateSheetName(System.Int32,System.String,System.String)">
  1173. Update sheet name in all formulas and named ranges.
  1174. Called from {@link XSSFWorkbook#setSheetName(int, String)}
  1175. <p/>
  1176. <p>
  1177. The idea is to parse every formula and render it back to string
  1178. with the updated sheet name. This is done by parsing into Ptgs,
  1179. looking for ones with sheet references in them, and changing those
  1180. </p>
  1181. @param sheetIndex the 0-based index of the sheet being changed
  1182. @param oldName the old sheet name
  1183. @param newName the new sheet name
  1184. </member>
  1185. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFFormulaUtils.UpdateFormula(NPOI.XSSF.UserModel.XSSFCell,System.String,System.String)">
  1186. Parse cell formula and re-assemble it back using the specified FormulaRenderingWorkbook.
  1187. @param cell the cell to update
  1188. @param frwb the formula rendering workbbok that returns new sheet name
  1189. </member>
  1190. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFFormulaUtils.UpdateName(NPOI.SS.UserModel.IName,System.String,System.String)">
  1191. Parse formula in the named range and re-assemble it back using the specified FormulaRenderingWorkbook.
  1192. @param name the name to update
  1193. @param frwb the formula rendering workbbok that returns new sheet name
  1194. </member>
  1195. <member name="T:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter">
  1196. @author Yegor Kozlov
  1197. </member>
  1198. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.ShiftMerged(System.Int32,System.Int32,System.Int32)">
  1199. Shift merged regions
  1200. @param startRow the row to start Shifting
  1201. @param endRow the row to end Shifting
  1202. @param n the number of rows to shift
  1203. @return an array of affected cell regions
  1204. </member>
  1205. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.ContainsCell(NPOI.SS.Util.CellRangeAddress,System.Int32,System.Int32)">
  1206. Check if the row and column are in the specified cell range
  1207. @param cr the cell range to check in
  1208. @param rowIx the row to check
  1209. @param colIx the column to check
  1210. @return true if the range Contains the cell [rowIx,colIx]
  1211. </member>
  1212. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.UpdateNamedRanges(NPOI.SS.Formula.FormulaShifter)">
  1213. Updated named ranges
  1214. </member>
  1215. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.UpdateFormulas(NPOI.SS.Formula.FormulaShifter)">
  1216. Update formulas.
  1217. </member>
  1218. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.ShiftFormula(NPOI.XSSF.UserModel.XSSFRow,System.String,NPOI.SS.Formula.FormulaShifter)">
  1219. Shift a formula using the supplied FormulaShifter
  1220. @param row the row of the cell this formula belongs to. Used to get a reference to the parent workbook.
  1221. @param formula the formula to shift
  1222. @param Shifter the FormulaShifter object that operates on the Parsed formula tokens
  1223. @return the Shifted formula if the formula was Changed,
  1224. <code>null</code> if the formula wasn't modified
  1225. </member>
  1226. <member name="T:NPOI.XSSF.UserModel.Helpers.XSSFSingleXmlCell">
  1227. *
  1228. * This class is a wrapper around the CTSingleXmlCell (Open Office XML Part 4:
  1229. * chapter 3.5.2.1)
  1230. *
  1231. *
  1232. * @author Roberto Manicardi
  1233. *
  1234. </member>
  1235. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFSingleXmlCell.GetReferencedCell">
  1236. Gets the XSSFCell referenced by the R attribute or Creates a new one if cell doesn't exists
  1237. @return the referenced XSSFCell, null if the cell reference is invalid
  1238. </member>
  1239. <member name="T:NPOI.XSSF.UserModel.Helpers.XSSFXmlColumnPr">
  1240. This class is a wrapper around the CT_XmlColumnPr (Open Office XML Part 4:
  1241. chapter 3.5.1.7)
  1242. @author Roberto Manicardi
  1243. </member>
  1244. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFXmlColumnPr.GetId">
  1245. (see Open Office XML Part 4: chapter 3.5.1.3)
  1246. @return An integer representing the unique identifier of this column.
  1247. </member>
  1248. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFXmlColumnPr.GetLocalXPath">
  1249. If the XPath is, for example, /Node1/Node2/Node3 and /Node1/Node2 is the common XPath for the table, the local XPath is /Node3
  1250. @return the local XPath
  1251. </member>
  1252. <member name="T:NPOI.XSSF.UserModel.ListAutoNumber">
  1253. Specifies type of automatic numbered bullet points that should be applied to a paragraph.
  1254. </member>
  1255. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ALPHA_LC_PARENT_BOTH">
  1256. (a), (b), (c), ...
  1257. </member>
  1258. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ALPHA_UC_PARENT_BOTH">
  1259. (A), (B), (C), ...
  1260. </member>
  1261. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ALPHA_LC_PARENT_R">
  1262. a), b), c), ...
  1263. </member>
  1264. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ALPHA_UC_PARENT_R">
  1265. A), B), C), ...
  1266. </member>
  1267. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ALPHA_LC_PERIOD">
  1268. a., b., c., ...
  1269. </member>
  1270. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ALPHA_UC_PERIOD">
  1271. A., B., C., ...
  1272. </member>
  1273. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ARABIC_PARENT_BOTH">
  1274. (1), (2), (3), ...
  1275. </member>
  1276. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ARABIC_PARENT_R">
  1277. 1), 2), 3), ...
  1278. </member>
  1279. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ARABIC_PERIOD">
  1280. 1., 2., 3., ...
  1281. </member>
  1282. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ARABIC_PLAIN">
  1283. 1, 2, 3, ...
  1284. </member>
  1285. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ROMAN_LC_PARENT_BOTH">
  1286. (i), (ii), (iii), ...
  1287. </member>
  1288. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ROMAN_UC_PARENT_BOTH">
  1289. (I), (II), (III), ...
  1290. </member>
  1291. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ROMAN_LC_PARENT_R">
  1292. i), ii), iii), ...
  1293. </member>
  1294. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ROMAN_UC_PARENT_R">
  1295. I), II), III), ...
  1296. </member>
  1297. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ROMAN_LC_PERIOD">
  1298. i., ii., iii., ...
  1299. </member>
  1300. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ROMAN_UC_PERIOD">
  1301. I., II., III., ...
  1302. </member>
  1303. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.CIRCLE_NUM_DB_PLAIN">
  1304. Dbl-byte circle numbers
  1305. </member>
  1306. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.CIRCLE_NUM_WD_BLACK_PLAIN">
  1307. Wingdings black circle numbers
  1308. </member>
  1309. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.CIRCLE_NUM_WD_WHITE_PLAIN">
  1310. Wingdings white circle numbers
  1311. </member>
  1312. <member name="T:NPOI.XSSF.UserModel.TextAlign">
  1313. Specified a list of text alignment types
  1314. </member>
  1315. <member name="F:NPOI.XSSF.UserModel.TextAlign.LEFT">
  1316. Align text to the left margin.
  1317. </member>
  1318. <member name="F:NPOI.XSSF.UserModel.TextAlign.CENTER">
  1319. Align text in the center.
  1320. </member>
  1321. <member name="F:NPOI.XSSF.UserModel.TextAlign.RIGHT">
  1322. Align text to the right margin.
  1323. </member>
  1324. <member name="F:NPOI.XSSF.UserModel.TextAlign.JUSTIFY">
  1325. Align text so that it is justified across the whole line. It
  1326. is smart in the sense that it will not justify sentences
  1327. which are short
  1328. </member>
  1329. <member name="T:NPOI.XSSF.UserModel.TextAutofit">
  1330. Specifies a list of auto-fit types.
  1331. <p>
  1332. Autofit specifies that a shape should be auto-fit to fully contain the text described within it.
  1333. Auto-fitting is when text within a shape is scaled in order to contain all the text inside
  1334. </p>
  1335. </member>
  1336. <member name="F:NPOI.XSSF.UserModel.TextAutofit.NONE">
  1337. Specifies that text within the text body should not be auto-fit to the bounding box.
  1338. Auto-fitting is when text within a text box is scaled in order to remain inside
  1339. the text box.
  1340. </member>
  1341. <member name="F:NPOI.XSSF.UserModel.TextAutofit.NORMAL">
  1342. Specifies that text within the text body should be normally auto-fit to the bounding box.
  1343. Autofitting is when text within a text box is scaled in order to remain inside the text box.
  1344. <p>
  1345. <em>Example:</em> Consider the situation where a user is building a diagram and needs
  1346. to have the text for each shape that they are using stay within the bounds of the shape.
  1347. An easy way this might be done is by using NORMAL autofit
  1348. </p>
  1349. </member>
  1350. <member name="F:NPOI.XSSF.UserModel.TextAutofit.SHAPE">
  1351. Specifies that a shape should be auto-fit to fully contain the text described within it.
  1352. Auto-fitting is when text within a shape is scaled in order to contain all the text inside.
  1353. <p>
  1354. <em>Example:</em> Consider the situation where a user is building a diagram and needs to have
  1355. the text for each shape that they are using stay within the bounds of the shape.
  1356. An easy way this might be done is by using SHAPE autofit
  1357. </p>
  1358. </member>
  1359. <member name="T:NPOI.XSSF.UserModel.TextCap">
  1360. Text Capitalization that is to be applied to the text Run. This is a render-only
  1361. modification and does not affect the actual characters stored in the text Run.
  1362. </member>
  1363. <member name="T:NPOI.XSSF.UserModel.TextDirection">
  1364. Vertical Text Types
  1365. </member>
  1366. <member name="F:NPOI.XSSF.UserModel.TextDirection.HORIZONTAL">
  1367. Horizontal text. This should be default.
  1368. </member>
  1369. <member name="F:NPOI.XSSF.UserModel.TextDirection.VERTICAL">
  1370. Vertical orientation.
  1371. (each line is 90 degrees rotated clockwise, so it goes
  1372. from top to bottom; each next line is to the left from
  1373. the previous one).
  1374. </member>
  1375. <member name="F:NPOI.XSSF.UserModel.TextDirection.VERTICAL_270">
  1376. Vertical orientation.
  1377. (each line is 270 degrees rotated clockwise, so it goes
  1378. from bottom to top; each next line is to the right from
  1379. the previous one).
  1380. </member>
  1381. <member name="F:NPOI.XSSF.UserModel.TextDirection.STACKED">
  1382. Determines if all of the text is vertical
  1383. ("one letter on top of another").
  1384. </member>
  1385. <member name="T:NPOI.XSSF.UserModel.TextFontAlign">
  1386. Specified a list of text font alignment types
  1387. </member>
  1388. <member name="F:NPOI.XSSF.UserModel.TextFontAlign.AUTO">
  1389. Automatic alignment
  1390. </member>
  1391. <member name="F:NPOI.XSSF.UserModel.TextFontAlign.TOP">
  1392. Align text to the top.
  1393. </member>
  1394. <member name="F:NPOI.XSSF.UserModel.TextFontAlign.CENTER">
  1395. Align text in the center.
  1396. </member>
  1397. <member name="F:NPOI.XSSF.UserModel.TextFontAlign.BASELINE">
  1398. Align text to the baseline.
  1399. </member>
  1400. <member name="F:NPOI.XSSF.UserModel.TextFontAlign.BOTTOM">
  1401. Align text to the bottom.
  1402. </member>
  1403. <member name="T:NPOI.XSSF.UserModel.TextHorizontalOverflow">
  1404. Text Horizontal Overflow
  1405. </member>
  1406. <member name="F:NPOI.XSSF.UserModel.TextHorizontalOverflow.OVERFLOW">
  1407. When a big character does not fit into a line, allow a
  1408. horizontal overflow.
  1409. </member>
  1410. <member name="F:NPOI.XSSF.UserModel.TextHorizontalOverflow.CLIP">
  1411. When a big character does not fit into a line, clip it at
  1412. the proper horizontal overflow.
  1413. </member>
  1414. <member name="T:NPOI.XSSF.UserModel.TextVerticalOverflow">
  1415. Text Vertical Overflow
  1416. </member>
  1417. <member name="F:NPOI.XSSF.UserModel.TextVerticalOverflow.OVERFLOW">
  1418. Overflow the text and pay no attention to top and bottom barriers.
  1419. </member>
  1420. <member name="F:NPOI.XSSF.UserModel.TextVerticalOverflow.ELLIPSIS">
  1421. Pay attention to top and bottom barriers. Use an
  1422. ellipsis to denote that there is text which is not visible.
  1423. </member>
  1424. <member name="F:NPOI.XSSF.UserModel.TextVerticalOverflow.CLIP">
  1425. Pay attention to top and bottom barriers. Provide no
  1426. indication that there is text which is not visible.
  1427. </member>
  1428. <member name="T:NPOI.XSSF.UserModel.XSSFAnchor">
  1429. An anchor is what specifics the position of a shape within a client object
  1430. or within another containing shape.
  1431. @author Yegor Kozlov
  1432. </member>
  1433. <member name="T:NPOI.XSSF.UserModel.XSSFAutoFilter">
  1434. Represents autofiltering for the specified worksheet.
  1435. @author Yegor Kozlov
  1436. </member>
  1437. <member name="T:NPOI.XSSF.UserModel.XSSFBorderFormatting">
  1438. @author Yegor Kozlov
  1439. </member>
  1440. <member name="T:NPOI.XSSF.UserModel.XSSFCell">
  1441. High level representation of a cell in a row of a spreadsheet.
  1442. <p>
  1443. Cells can be numeric, formula-based or string-based (text). The cell type
  1444. specifies this. String cells cannot conatin numbers and numeric cells cannot
  1445. contain strings (at least according to our model). Client apps should do the
  1446. conversions themselves. Formula cells have the formula string, as well as
  1447. the formula result, which can be numeric or string.
  1448. </p>
  1449. <p>
  1450. Cells should have their number (0 based) before being Added to a row. Only
  1451. cells that have values should be Added.
  1452. </p>
  1453. </member>
  1454. <member name="F:NPOI.XSSF.UserModel.XSSFCell._cell">
  1455. the xml bean Containing information about the cell's location, value,
  1456. data type, formatting, and formula
  1457. </member>
  1458. <member name="F:NPOI.XSSF.UserModel.XSSFCell._row">
  1459. the XSSFRow this cell belongs to
  1460. </member>
  1461. <member name="F:NPOI.XSSF.UserModel.XSSFCell._cellNum">
  1462. 0-based column index
  1463. </member>
  1464. <member name="F:NPOI.XSSF.UserModel.XSSFCell._sharedStringSource">
  1465. Table of strings shared across this workbook.
  1466. If two cells contain the same string, then the cell value is the same index into SharedStringsTable
  1467. </member>
  1468. <member name="F:NPOI.XSSF.UserModel.XSSFCell._stylesSource">
  1469. Table of cell styles shared across all cells in a workbook.
  1470. </member>
  1471. <member name="M:NPOI.XSSF.UserModel.XSSFCell.#ctor(NPOI.XSSF.UserModel.XSSFRow,NPOI.OpenXmlFormats.Spreadsheet.CT_Cell)">
  1472. Construct a XSSFCell.
  1473. @param row the parent row.
  1474. @param cell the xml bean Containing information about the cell.
  1475. </member>
  1476. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetSharedStringSource">
  1477. @return table of strings shared across this workbook
  1478. </member>
  1479. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetStylesSource">
  1480. @return table of cell styles shared across this workbook
  1481. </member>
  1482. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(System.Boolean)">
  1483. Set a bool value for the cell
  1484. @param value the bool value to Set this cell to. For formulas we'll Set the
  1485. precalculated value, for bools we'll Set its value. For other types we
  1486. will change the cell to a bool cell and Set its value.
  1487. </member>
  1488. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(System.Double)">
  1489. Set a numeric value for the cell
  1490. @param value the numeric value to Set this cell to. For formulas we'll Set the
  1491. precalculated value, for numerics we'll Set its value. For other types we
  1492. will change the cell to a numeric cell and Set its value.
  1493. </member>
  1494. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(System.String)">
  1495. Set a string value for the cell.
  1496. @param str value to Set the cell to. For formulas we'll Set the formula
  1497. cached string result, for String cells we'll Set its value. For other types we will
  1498. change the cell to a string cell and Set its value.
  1499. If value is null then we will change the cell to a Blank cell.
  1500. </member>
  1501. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(NPOI.SS.UserModel.IRichTextString)">
  1502. Set a string value for the cell.
  1503. @param str value to Set the cell to. For formulas we'll Set the 'pre-Evaluated result string,
  1504. for String cells we'll Set its value. For other types we will
  1505. change the cell to a string cell and Set its value.
  1506. If value is null then we will change the cell to a Blank cell.
  1507. </member>
  1508. <member name="M:NPOI.XSSF.UserModel.XSSFCell.ConvertSharedFormula(System.Int32)">
  1509. <summary>
  1510. Creates a non shared formula from the shared formula counterpart
  1511. </summary>
  1512. <param name="si">Shared Group Index</param>
  1513. <returns>non shared formula created for the given shared formula and this cell</returns>
  1514. </member>
  1515. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellFormula(System.String)">
  1516. Sets formula for this cell.
  1517. <p>
  1518. Note, this method only Sets the formula string and does not calculate the formula value.
  1519. To Set the precalculated value use {@link #setCellValue(double)} or {@link #setCellValue(String)}
  1520. </p>
  1521. @param formula the formula to Set, e.g. <code>"SUM(C4:E4)"</code>.
  1522. If the argument is <code>null</code> then the current formula is Removed.
  1523. @throws NPOI.ss.formula.FormulaParseException if the formula has incorrect syntax or is otherwise invalid
  1524. @throws InvalidOperationException if the operation is not allowed, for example,
  1525. when the cell is a part of a multi-cell array formula
  1526. </member>
  1527. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetReference">
  1528. <summary>
  1529. Returns an A1 style reference to the location of this cell
  1530. </summary>
  1531. <returns>A1 style reference to the location of this cell</returns>
  1532. </member>
  1533. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetBaseCellType(System.Boolean)">
  1534. <summary>
  1535. Detect cell type based on the "t" attribute of the CT_Cell bean
  1536. </summary>
  1537. <param name="blankCells"></param>
  1538. <returns></returns>
  1539. </member>
  1540. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(System.DateTime)">
  1541. <summary>
  1542. Set a date value for the cell. Excel treats dates as numeric so you will need to format the cell as a date.
  1543. </summary>
  1544. <param name="value">the date value to Set this cell to. For formulas we'll set the precalculated value,
  1545. for numerics we'll Set its value. For other types we will change the cell to a numeric cell and Set its value. </param>
  1546. </member>
  1547. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellErrorValue(NPOI.SS.UserModel.FormulaError)">
  1548. <summary>
  1549. Set a error value for the cell
  1550. </summary>
  1551. <param name="error">the error value to Set this cell to.
  1552. For formulas we'll Set the precalculated value , for errors we'll set
  1553. its value. For other types we will change the cell to an error cell and Set its value.
  1554. </param>
  1555. </member>
  1556. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetAsActiveCell">
  1557. <summary>
  1558. Sets this cell as the active cell for the worksheet.
  1559. </summary>
  1560. </member>
  1561. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetBlank">
  1562. <summary>
  1563. Blanks this cell. Blank cells have no formula or value but may have styling.
  1564. This method erases all the data previously associated with this cell.
  1565. </summary>
  1566. </member>
  1567. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellNum(System.Int32)">
  1568. <summary>
  1569. Sets column index of this cell
  1570. </summary>
  1571. <param name="num"></param>
  1572. </member>
  1573. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellType(NPOI.SS.UserModel.CellType)">
  1574. <summary>
  1575. Set the cells type (numeric, formula or string)
  1576. </summary>
  1577. <param name="cellType"></param>
  1578. </member>
  1579. <member name="M:NPOI.XSSF.UserModel.XSSFCell.ToString">
  1580. <summary>
  1581. Returns a string representation of the cell
  1582. </summary>
  1583. <returns>Formula cells return the formula string, rather than the formula result.
  1584. Dates are displayed in dd-MMM-yyyy format
  1585. Errors are displayed as #ERR&lt;errIdx&gt;
  1586. </returns>
  1587. </member>
  1588. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetRawValue">
  1589. Returns the raw, underlying ooxml value for the cell
  1590. <p>
  1591. If the cell Contains a string, then this value is an index into
  1592. the shared string table, pointing to the actual string value. Otherwise,
  1593. the value of the cell is expressed directly in this element. Cells Containing formulas express
  1594. the last calculated result of the formula in this element.
  1595. </p>
  1596. @return the raw cell value as Contained in the underlying CT_Cell bean,
  1597. <code>null</code> for blank cells.
  1598. </member>
  1599. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetCellTypeName(NPOI.SS.UserModel.CellType)">
  1600. <summary>
  1601. Used to help format error messages
  1602. </summary>
  1603. <param name="cellTypeCode"></param>
  1604. <returns></returns>
  1605. </member>
  1606. <member name="M:NPOI.XSSF.UserModel.XSSFCell.TypeMismatch(NPOI.SS.UserModel.CellType,NPOI.SS.UserModel.CellType,System.Boolean)">
  1607. Used to help format error messages
  1608. </member>
  1609. <member name="M:NPOI.XSSF.UserModel.XSSFCell.CheckBounds(System.Int32)">
  1610. @throws RuntimeException if the bounds are exceeded.
  1611. </member>
  1612. <member name="M:NPOI.XSSF.UserModel.XSSFCell.RemoveCellComment">
  1613. <summary>
  1614. Removes the comment for this cell, if there is one.
  1615. </summary>
  1616. </member>
  1617. <member name="M:NPOI.XSSF.UserModel.XSSFCell.RemoveHyperlink">
  1618. Removes the hyperlink for this cell, if there is one.
  1619. </member>
  1620. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetCTCell">
  1621. Returns the xml bean containing information about the cell's location (reference), value,
  1622. data type, formatting, and formula
  1623. @return the xml bean containing information about this cell
  1624. </member>
  1625. <member name="M:NPOI.XSSF.UserModel.XSSFCell.ConvertCellValueToBoolean">
  1626. Chooses a new bool value for the cell when its type is changing.<p/>
  1627. Usually the caller is calling SetCellType() with the intention of calling
  1628. SetCellValue(bool) straight afterwards. This method only exists to give
  1629. the cell a somewhat reasonable value until the SetCellValue() call (if at all).
  1630. TODO - perhaps a method like SetCellTypeAndValue(int, Object) should be introduced to avoid this
  1631. </member>
  1632. <member name="M:NPOI.XSSF.UserModel.XSSFCell.NotifyArrayFormulaChanging(System.String)">
  1633. The purpose of this method is to validate the cell state prior to modification
  1634. @see #NotifyArrayFormulaChanging()
  1635. </member>
  1636. <member name="M:NPOI.XSSF.UserModel.XSSFCell.NotifyArrayFormulaChanging">
  1637. <summary>
  1638. Called when this cell is modified.The purpose of this method is to validate the cell state prior to modification.
  1639. </summary>
  1640. <exception cref="T:System.InvalidOperationException">if modification is not allowed</exception>
  1641. </member>
  1642. <member name="P:NPOI.XSSF.UserModel.XSSFCell.Sheet">
  1643. Returns the sheet this cell belongs to
  1644. @return the sheet this cell belongs to
  1645. </member>
  1646. <member name="P:NPOI.XSSF.UserModel.XSSFCell.Row">
  1647. Returns the row this cell belongs to
  1648. @return the row this cell belongs to
  1649. </member>
  1650. <member name="P:NPOI.XSSF.UserModel.XSSFCell.BooleanCellValue">
  1651. Get the value of the cell as a bool.
  1652. <p>
  1653. For strings, numbers, and errors, we throw an exception. For blank cells we return a false.
  1654. </p>
  1655. @return the value of the cell as a bool
  1656. @throws InvalidOperationException if the cell type returned by {@link #CellType}
  1657. is not CellType.Boolean, CellType.Blank or CellType.Formula
  1658. </member>
  1659. <member name="P:NPOI.XSSF.UserModel.XSSFCell.NumericCellValue">
  1660. Get the value of the cell as a number.
  1661. <p>
  1662. For strings we throw an exception. For blank cells we return a 0.
  1663. For formulas or error cells we return the precalculated value;
  1664. </p>
  1665. @return the value of the cell as a number
  1666. @throws InvalidOperationException if the cell type returned by {@link #CellType} is CellType.String
  1667. @exception NumberFormatException if the cell value isn't a parsable <code>double</code>.
  1668. @see DataFormatter for turning this number into a string similar to that which Excel would render this number as.
  1669. </member>
  1670. <member name="P:NPOI.XSSF.UserModel.XSSFCell.StringCellValue">
  1671. Get the value of the cell as a string
  1672. <p>
  1673. For numeric cells we throw an exception. For blank cells we return an empty string.
  1674. For formulaCells that are not string Formulas, we throw an exception
  1675. </p>
  1676. @return the value of the cell as a string
  1677. </member>
  1678. <member name="P:NPOI.XSSF.UserModel.XSSFCell.RichStringCellValue">
  1679. Get the value of the cell as a XSSFRichTextString
  1680. <p>
  1681. For numeric cells we throw an exception. For blank cells we return an empty string.
  1682. For formula cells we return the pre-calculated value if a string, otherwise an exception
  1683. </p>
  1684. @return the value of the cell as a XSSFRichTextString
  1685. </member>
  1686. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CellFormula">
  1687. <summary>
  1688. Return a formula for the cell, for example, <code>SUM(C4:E4)</code>
  1689. </summary>
  1690. </member>
  1691. <member name="P:NPOI.XSSF.UserModel.XSSFCell.ColumnIndex">
  1692. <summary>
  1693. Returns zero-based column index of this cell
  1694. </summary>
  1695. </member>
  1696. <member name="P:NPOI.XSSF.UserModel.XSSFCell.RowIndex">
  1697. <summary>
  1698. Returns zero-based row index of a row in the sheet that contains this cell
  1699. </summary>
  1700. </member>
  1701. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CellStyle">
  1702. <summary>
  1703. Return the cell's style.
  1704. </summary>
  1705. </member>
  1706. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CellType">
  1707. <summary>
  1708. Return the cell type.
  1709. </summary>
  1710. </member>
  1711. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CachedFormulaResultType">
  1712. <summary>
  1713. Only valid for formula cells
  1714. </summary>
  1715. </member>
  1716. <member name="P:NPOI.XSSF.UserModel.XSSFCell.DateCellValue">
  1717. <summary>
  1718. Get the value of the cell as a date.
  1719. </summary>
  1720. </member>
  1721. <member name="P:NPOI.XSSF.UserModel.XSSFCell.ErrorCellString">
  1722. <summary>
  1723. Returns the error message, such as #VALUE!
  1724. </summary>
  1725. </member>
  1726. <member name="P:NPOI.XSSF.UserModel.XSSFCell.ErrorCellValue">
  1727. <summary>
  1728. Get the value of the cell as an error code.
  1729. For strings, numbers, and bools, we throw an exception.
  1730. For blank cells we return a 0.
  1731. </summary>
  1732. </member>
  1733. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CellComment">
  1734. <summary>
  1735. Returns cell comment associated with this cell
  1736. </summary>
  1737. </member>
  1738. <member name="P:NPOI.XSSF.UserModel.XSSFCell.Hyperlink">
  1739. <summary>
  1740. Get or set hyperlink associated with this cell
  1741. If the supplied hyperlink is null on setting, the hyperlink for this cell will be removed.
  1742. </summary>
  1743. </member>
  1744. <member name="T:NPOI.XSSF.UserModel.XSSFCellStyle">
  1745. High level representation of the the possible formatting information for the contents of the cells on a sheet in a
  1746. SpreadsheetML document.
  1747. @see NPOI.xssf.usermodel.XSSFWorkbook#CreateCellStyle()
  1748. @see NPOI.xssf.usermodel.XSSFWorkbook#getCellStyleAt(short)
  1749. @see NPOI.xssf.usermodel.XSSFCell#setCellStyle(NPOI.ss.usermodel.CellStyle)
  1750. </member>
  1751. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.#ctor(System.Int32,System.Int32,NPOI.XSSF.Model.StylesTable,NPOI.XSSF.Model.ThemesTable)">
  1752. Creates a Cell Style from the supplied parts
  1753. @param cellXfId The main XF for the cell. Must be a valid 0-based index into the XF table
  1754. @param cellStyleXfId Optional, style xf. A value of <code>-1</code> means no xf.
  1755. @param stylesSource Styles Source to work off
  1756. </member>
  1757. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCoreXf">
  1758. Used so that StylesSource can figure out our location
  1759. </member>
  1760. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetStyleXf">
  1761. Used so that StylesSource can figure out our location
  1762. </member>
  1763. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.#ctor(NPOI.XSSF.Model.StylesTable)">
  1764. <summary>
  1765. Creates an empty Cell Style
  1766. </summary>
  1767. <param name="stylesSource"></param>
  1768. </member>
  1769. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.VerifyBelongsToStylesSource(NPOI.XSSF.Model.StylesTable)">
  1770. Verifies that this style belongs to the supplied Workbook
  1771. Styles Source.
  1772. Will throw an exception if it belongs to a different one.
  1773. This is normally called when trying to assign a style to a
  1774. cell, to ensure the cell and the style are from the same
  1775. workbook (if they're not, it won't work)
  1776. @throws ArgumentException if there's a workbook mis-match
  1777. </member>
  1778. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.CloneStyleFrom(NPOI.SS.UserModel.ICellStyle)">
  1779. Clones all the style information from another
  1780. XSSFCellStyle, onto this one. This
  1781. XSSFCellStyle will then have all the same
  1782. properties as the source, but the two may
  1783. be edited independently.
  1784. Any stylings on this XSSFCellStyle will be lost!
  1785. The source XSSFCellStyle could be from another
  1786. XSSFWorkbook if you like. This allows you to
  1787. copy styles from one XSSFWorkbook to another.
  1788. </member>
  1789. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetAlignmentEnum">
  1790. <summary>
  1791. Get the type of horizontal alignment for the cell
  1792. </summary>
  1793. <returns>the type of alignment</returns>
  1794. </member>
  1795. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetDataFormat(System.Int32)">
  1796. Set the index of a data format
  1797. @param fmt the index of a data format
  1798. </member>
  1799. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetDataFormatString">
  1800. Get the contents of the format string, by looking up
  1801. the StylesSource
  1802. @return the number format string
  1803. </member>
  1804. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetFont">
  1805. Gets the font for this style
  1806. @return Font - font
  1807. </member>
  1808. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetVerticalAlignmentEnum">
  1809. <summary>
  1810. Get the type of vertical alignment for the cell
  1811. </summary>
  1812. <returns></returns>
  1813. </member>
  1814. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetBottomBorderColor(NPOI.XSSF.UserModel.XSSFColor)">
  1815. Set the color to use for the bottom border
  1816. @param color the color to use, null means no color
  1817. </member>
  1818. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFCellStyle.SetFillBackgroundColor(NPOI.XSSF.UserModel.XSSFColor)" -->
  1819. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetFillForegroundColor(NPOI.XSSF.UserModel.XSSFColor)">
  1820. * Set the foreground fill color represented as a {@link XSSFColor} value.
  1821. * <br/>
  1822. * <i>Note: Ensure Foreground color is Set prior to background color.</i>
  1823. * @param color the color to use
  1824. * @see #setFillBackgroundColor(NPOI.xssf.usermodel.XSSFColor) )
  1825. </member>
  1826. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCTFill">
  1827. Get a <b>copy</b> of the currently used CT_Fill, if none is used, return a new instance.
  1828. </member>
  1829. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCTBorder">
  1830. Get a <b>copy</b> of the currently used CT_Border, if none is used, return a new instance.
  1831. </member>
  1832. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetFont(NPOI.SS.UserModel.IFont)">
  1833. Set the font for this style
  1834. @param font a font object Created or retreived from the XSSFWorkbook object
  1835. @see NPOI.xssf.usermodel.XSSFWorkbook#CreateFont()
  1836. @see NPOI.xssf.usermodel.XSSFWorkbook#getFontAt(short)
  1837. </member>
  1838. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetLeftBorderColor(NPOI.XSSF.UserModel.XSSFColor)">
  1839. Set the color to use for the left border as a {@link XSSFColor} value
  1840. @param color the color to use
  1841. </member>
  1842. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetRightBorderColor(NPOI.XSSF.UserModel.XSSFColor)">
  1843. Set the color to use for the right border as a {@link XSSFColor} value
  1844. @param color the color to use
  1845. </member>
  1846. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetTopBorderColor(NPOI.XSSF.UserModel.XSSFColor)">
  1847. Set the color to use for the top border as a {@link XSSFColor} value
  1848. @param color the color to use
  1849. </member>
  1850. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetVerticalAlignment(System.Int16)">
  1851. Set the type of vertical alignment for the cell
  1852. @param align - align the type of alignment
  1853. @see NPOI.ss.usermodel.CellStyle#VERTICAL_TOP
  1854. @see NPOI.ss.usermodel.CellStyle#VERTICAL_CENTER
  1855. @see NPOI.ss.usermodel.CellStyle#VERTICAL_BOTTOM
  1856. @see NPOI.ss.usermodel.CellStyle#VERTICAL_JUSTIFY
  1857. @see NPOI.ss.usermodel.VerticalAlignment
  1858. </member>
  1859. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetBorderColor(NPOI.XSSF.UserModel.Extensions.BorderSide)">
  1860. Gets border color
  1861. @param side the border side
  1862. @return the used color
  1863. </member>
  1864. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetBorderColor(NPOI.XSSF.UserModel.Extensions.BorderSide,NPOI.XSSF.UserModel.XSSFColor)">
  1865. Set the color to use for the selected border
  1866. @param side - where to apply the color defInition
  1867. @param color - the color to use
  1868. </member>
  1869. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCellAlignment">
  1870. Get the cellAlignment object to use for manage alignment
  1871. @return XSSFCellAlignment - cell alignment
  1872. </member>
  1873. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCTCellAlignment">
  1874. Return the CT_CellAlignment instance for alignment
  1875. @return CT_CellAlignment
  1876. </member>
  1877. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetHashCode">
  1878. Returns a hash code value for the object. The hash is derived from the underlying CT_Xf bean.
  1879. @return the hash code value for this style
  1880. </member>
  1881. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.Equals(System.Object)">
  1882. Checks is the supplied style is equal to this style
  1883. @param o the style to check
  1884. @return true if the supplied style is equal to this style
  1885. </member>
  1886. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.Clone">
  1887. Make a copy of this style. The underlying CT_Xf bean is Cloned,
  1888. the references to Fills and borders remain.
  1889. @return a copy of this style
  1890. </member>
  1891. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.BorderRight">
  1892. <summary>
  1893. Get the type of border to use for the right border of the cell
  1894. </summary>
  1895. </member>
  1896. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.BottomBorderColor">
  1897. Get the color to use for the bottom border
  1898. Color is optional. When missing, IndexedColors.Automatic is implied.
  1899. @return the index of the color defInition, default value is {@link NPOI.ss.usermodel.IndexedColors#AUTOMATIC}
  1900. @see NPOI.ss.usermodel.IndexedColors
  1901. </member>
  1902. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.BottomBorderXSSFColor">
  1903. Get the color to use for the bottom border as a {@link XSSFColor}
  1904. @return the used color or <code>null</code> if not Set
  1905. </member>
  1906. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.DataFormat">
  1907. Get the index of the number format (numFmt) record used by this cell format.
  1908. @return the index of the number format
  1909. </member>
  1910. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillBackgroundColor">
  1911. <summary>
  1912. Get the background fill color.
  1913. Note - many cells are actually filled with a foreground fill, not a background fill
  1914. </summary>
  1915. </member>
  1916. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillBackgroundColorColor">
  1917. Get the background fill color.
  1918. <p>
  1919. Note - many cells are actually Filled with a foreground
  1920. Fill, not a background fill - see {@link #getFillForegroundColor()}
  1921. </p>
  1922. @see NPOI.xssf.usermodel.XSSFColor#getRgb()
  1923. @return XSSFColor - fill color or <code>null</code> if not Set
  1924. </member>
  1925. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillForegroundColor">
  1926. Get the foreground fill color.
  1927. <p>
  1928. Many cells are Filled with this, instead of a
  1929. background color ({@link #getFillBackgroundColor()})
  1930. </p>
  1931. @see IndexedColors
  1932. @return fill color, default value is {@link NPOI.ss.usermodel.IndexedColors#AUTOMATIC}
  1933. </member>
  1934. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillForegroundColorColor">
  1935. <summary>
  1936. Get the foreground fill color.
  1937. </summary>
  1938. </member>
  1939. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillForegroundXSSFColor">
  1940. <summary>
  1941. Get the foreground fill color.
  1942. </summary>
  1943. </member>
  1944. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FontIndex">
  1945. Gets the index of the font for this style
  1946. @return short - font index
  1947. @see NPOI.xssf.usermodel.XSSFWorkbook#getFontAt(short)
  1948. </member>
  1949. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.IsHidden">
  1950. Get whether the cell's using this style are to be hidden
  1951. @return bool - whether the cell using this style is hidden
  1952. </member>
  1953. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.Indention">
  1954. Get the number of spaces to indent the text in the cell
  1955. @return indent - number of spaces
  1956. </member>
  1957. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.Index">
  1958. Get the index within the StylesTable (sequence within the collection of CT_Xf elements)
  1959. @return unique index number of the underlying record this style represents
  1960. </member>
  1961. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.LeftBorderColor">
  1962. Get the color to use for the left border
  1963. @return the index of the color defInition, default value is {@link NPOI.ss.usermodel.IndexedColors#BLACK}
  1964. @see NPOI.ss.usermodel.IndexedColors
  1965. </member>
  1966. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.LeftBorderXSSFColor">
  1967. Get the color to use for the left border
  1968. @return the index of the color defInition or <code>null</code> if not Set
  1969. @see NPOI.ss.usermodel.IndexedColors
  1970. </member>
  1971. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.IsLocked">
  1972. <summary>
  1973. Get whether the cell's using this style are locked
  1974. </summary>
  1975. </member>
  1976. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.RightBorderColor">
  1977. <summary>
  1978. Get the color to use for the right border
  1979. </summary>
  1980. </member>
  1981. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.RightBorderXSSFColor">
  1982. <summary>
  1983. Get the color to use for the right border
  1984. </summary>
  1985. <returns></returns>
  1986. </member>
  1987. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.Rotation">
  1988. <summary>
  1989. Get the degree of rotation (between 0 and 180 degrees) for the text in the cell
  1990. </summary>
  1991. <example>
  1992. Expressed in degrees. Values range from 0 to 180. The first letter of
  1993. the text is considered the center-point of the arc.
  1994. For 0 - 90, the value represents degrees above horizon. For 91-180 the degrees below the horizon is calculated as:
  1995. <code>[degrees below horizon] = 90 - textRotation.</code>
  1996. </example>
  1997. </member>
  1998. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.TopBorderColor">
  1999. Get the color to use for the top border
  2000. @return the index of the color defInition, default value is {@link NPOI.ss.usermodel.IndexedColors#BLACK}
  2001. @see NPOI.ss.usermodel.IndexedColors
  2002. </member>
  2003. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.TopBorderXSSFColor">
  2004. <summary>
  2005. Get the color to use for the top border
  2006. </summary>
  2007. <returns></returns>
  2008. </member>
  2009. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.VerticalAlignment">
  2010. <summary>
  2011. Get the type of vertical alignment for the cell
  2012. </summary>
  2013. </member>
  2014. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.WrapText">
  2015. <summary>
  2016. Whether the text in a cell should be line-wrapped within the cell.
  2017. </summary>
  2018. </member>
  2019. <member name="T:NPOI.XSSF.UserModel.XSSFChart">
  2020. Represents a SpreadsheetML Chart
  2021. @author Nick Burch
  2022. @author Roman Kashitsyn
  2023. </member>
  2024. <member name="F:NPOI.XSSF.UserModel.XSSFChart.frame">
  2025. Parent graphic frame.
  2026. </member>
  2027. <member name="F:NPOI.XSSF.UserModel.XSSFChart.chartSpaceDocument">
  2028. Root element of the SpreadsheetML Chart part
  2029. </member>
  2030. <member name="F:NPOI.XSSF.UserModel.XSSFChart.chart">
  2031. The Chart within that
  2032. </member>
  2033. <member name="M:NPOI.XSSF.UserModel.XSSFChart.#ctor">
  2034. Create a new SpreadsheetML chart
  2035. </member>
  2036. <member name="M:NPOI.XSSF.UserModel.XSSFChart.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  2037. Construct a SpreadsheetML chart from a namespace part.
  2038. @param part the namespace part holding the chart data,
  2039. the content type must be <code>application/vnd.Openxmlformats-officedocument.Drawingml.chart+xml</code>
  2040. @param rel the namespace relationship holding this chart,
  2041. the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/chart
  2042. </member>
  2043. <member name="M:NPOI.XSSF.UserModel.XSSFChart.CreateChart">
  2044. Construct a new CTChartSpace bean.
  2045. By default, it's just an empty placeholder for chart objects.
  2046. @return a new CTChartSpace bean
  2047. </member>
  2048. <member name="M:NPOI.XSSF.UserModel.XSSFChart.GetCTChartSpace">
  2049. Return the underlying CTChartSpace bean, the root element of the SpreadsheetML Chart part.
  2050. @return the underlying CTChartSpace bean
  2051. </member>
  2052. <member name="M:NPOI.XSSF.UserModel.XSSFChart.GetCTChart">
  2053. Return the underlying CTChart bean, within the Chart Space
  2054. @return the underlying CTChart bean
  2055. </member>
  2056. <member name="M:NPOI.XSSF.UserModel.XSSFChart.GetGraphicFrame">
  2057. Returns the parent graphic frame.
  2058. @return the graphic frame this chart belongs to
  2059. </member>
  2060. <member name="M:NPOI.XSSF.UserModel.XSSFChart.SetGraphicFrame(NPOI.XSSF.UserModel.XSSFGraphicFrame)">
  2061. Sets the parent graphic frame.
  2062. </member>
  2063. <member name="M:NPOI.XSSF.UserModel.XSSFChart.IsPlotOnlyVisibleCells">
  2064. @return true if only visible cells will be present on the chart,
  2065. false otherwise
  2066. </member>
  2067. <member name="M:NPOI.XSSF.UserModel.XSSFChart.SetPlotOnlyVisibleCells(System.Boolean)">
  2068. @param plotVisOnly a flag specifying if only visible cells should be
  2069. present on the chart
  2070. </member>
  2071. <member name="P:NPOI.XSSF.UserModel.XSSFChart.Title">
  2072. Returns the title, or null if none is Set
  2073. </member>
  2074. <member name="T:NPOI.XSSF.UserModel.XSSFChartSheet">
  2075. High level representation of Sheet Parts that are of type 'chartsheet'.
  2076. <p>
  2077. Chart sheet is a special kind of Sheet that Contains only chart and no data.
  2078. </p>
  2079. @author Yegor Kozlov
  2080. </member>
  2081. <member name="T:NPOI.XSSF.UserModel.XSSFSheet">
  2082. High level representation of a SpreadsheetML worksheet.
  2083. <p>
  2084. Sheets are the central structures within a workbook, and are where a user does most of his spreadsheet work.
  2085. The most common type of sheet is the worksheet, which is represented as a grid of cells. Worksheet cells can
  2086. contain text, numbers, dates, and formulas. Cells can also be formatted.
  2087. </p>
  2088. </member>
  2089. <member name="F:NPOI.XSSF.UserModel.XSSFSheet.sharedFormulas">
  2090. cache of master shared formulas in this sheet.
  2091. Master shared formula is the first formula in a group of shared formulas is saved in the f element.
  2092. </member>
  2093. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.#ctor">
  2094. Creates new XSSFSheet - called by XSSFWorkbook to create a sheet from scratch.
  2095. @see NPOI.XSSF.usermodel.XSSFWorkbook#CreateSheet()
  2096. </member>
  2097. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  2098. Creates an XSSFSheet representing the given namespace part and relationship.
  2099. Should only be called by XSSFWorkbook when Reading in an exisiting file.
  2100. @param part - The namespace part that holds xml data represenring this sheet.
  2101. @param rel - the relationship of the given namespace part in the underlying OPC namespace
  2102. </member>
  2103. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.OnDocumentRead">
  2104. Initialize worksheet data when Reading in an exisiting file.
  2105. </member>
  2106. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.OnDocumentCreate">
  2107. Initialize worksheet data when creating a new sheet.
  2108. </member>
  2109. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.InitHyperlinks">
  2110. Read hyperlink relations, link them with CT_Hyperlink beans in this worksheet
  2111. and Initialize the internal array of XSSFHyperlink objects
  2112. </member>
  2113. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.NewSheet">
  2114. Create a new CT_Worksheet instance with all values set to defaults
  2115. @return a new instance
  2116. </member>
  2117. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCTWorksheet">
  2118. Provide access to the CT_Worksheet bean holding this sheet's data
  2119. @return the CT_Worksheet bean holding this sheet's data
  2120. </member>
  2121. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AddMergedRegion(NPOI.SS.Util.CellRangeAddress)">
  2122. Adds a merged region of cells (hence those cells form one).
  2123. @param region (rowfrom/colfrom-rowto/colto) to merge
  2124. @return index of this region
  2125. </member>
  2126. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AutoSizeColumn(System.Int32)">
  2127. Adjusts the column width to fit the contents.
  2128. This process can be relatively slow on large sheets, so this should
  2129. normally only be called once per column, at the end of your
  2130. Processing.
  2131. @param column the column index
  2132. </member>
  2133. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AutoSizeColumn(System.Int32,System.Boolean)">
  2134. Adjusts the column width to fit the contents.
  2135. <p>
  2136. This process can be relatively slow on large sheets, so this should
  2137. normally only be called once per column, at the end of your
  2138. Processing.
  2139. </p>
  2140. You can specify whether the content of merged cells should be considered or ignored.
  2141. Default is to ignore merged cells.
  2142. @param column the column index
  2143. @param useMergedCells whether to use the contents of merged cells when calculating the width of the column
  2144. </member>
  2145. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetDrawingPatriarch">
  2146. Return the sheet's existing Drawing, or null if there isn't yet one.
  2147. Use {@link #CreateDrawingPatriarch()} to Get or create
  2148. @return a SpreadsheetML Drawing
  2149. </member>
  2150. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateDrawingPatriarch">
  2151. Create a new SpreadsheetML Drawing. If this sheet already Contains a Drawing - return that.
  2152. @return a SpreadsheetML Drawing
  2153. </member>
  2154. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetVMLDrawing(System.Boolean)">
  2155. Get VML drawing for this sheet (aka 'legacy' drawig)
  2156. @param autoCreate if true, then a new VML drawing part is Created
  2157. @return the VML drawing of <code>null</code> if the drawing was not found and autoCreate=false
  2158. </member>
  2159. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateFreezePane(System.Int32,System.Int32)">
  2160. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  2161. @param colSplit Horizonatal position of split.
  2162. @param rowSplit Vertical position of split.
  2163. </member>
  2164. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateFreezePane(System.Int32,System.Int32,System.Int32,System.Int32)">
  2165. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  2166. <p>
  2167. If both colSplit and rowSplit are zero then the existing freeze pane is Removed
  2168. </p>
  2169. @param colSplit Horizonatal position of split.
  2170. @param rowSplit Vertical position of split.
  2171. @param leftmostColumn Left column visible in right pane.
  2172. @param topRow Top row visible in bottom pane
  2173. </member>
  2174. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateComment">
  2175. Creates a new comment for this sheet. You still
  2176. need to assign it to a cell though
  2177. @deprecated since Nov 2009 this method is not compatible with the common SS interfaces,
  2178. use {@link NPOI.XSSF.usermodel.XSSFDrawing#CreateCellComment
  2179. (NPOI.SS.usermodel.ClientAnchor)} instead
  2180. </member>
  2181. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateRow(System.Int32)">
  2182. Create a new row within the sheet and return the high level representation
  2183. @param rownum row number
  2184. @return High level {@link XSSFRow} object representing a row in the sheet
  2185. @see #RemoveRow(NPOI.SS.usermodel.Row)
  2186. </member>
  2187. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateSplitPane(System.Int32,System.Int32,System.Int32,System.Int32,NPOI.SS.UserModel.PanePosition)">
  2188. Creates a split pane. Any existing freezepane or split pane is overwritten.
  2189. @param xSplitPos Horizonatal position of split (in 1/20th of a point).
  2190. @param ySplitPos Vertical position of split (in 1/20th of a point).
  2191. @param topRow Top row visible in bottom pane
  2192. @param leftmostColumn Left column visible in right pane.
  2193. @param activePane Active pane. One of: PANE_LOWER_RIGHT,
  2194. PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFT
  2195. @see NPOI.SS.usermodel.Sheet#PANE_LOWER_LEFT
  2196. @see NPOI.SS.usermodel.Sheet#PANE_LOWER_RIGHT
  2197. @see NPOI.SS.usermodel.Sheet#PANE_UPPER_LEFT
  2198. @see NPOI.SS.usermodel.Sheet#PANE_UPPER_RIGHT
  2199. </member>
  2200. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetColumnWidth(System.Int32)">
  2201. Get the actual column width (in units of 1/256th of a character width )
  2202. <p>
  2203. Note, the returned value is always gerater that {@link #GetDefaultColumnWidth()} because the latter does not include margins.
  2204. Actual column width measured as the number of characters of the maximum digit width of the
  2205. numbers 0, 1, 2, ..., 9 as rendered in the normal style's font. There are 4 pixels of margin
  2206. pAdding (two on each side), plus 1 pixel pAdding for the gridlines.
  2207. </p>
  2208. @param columnIndex - the column to set (0-based)
  2209. @return width - the width in units of 1/256th of a character width
  2210. </member>
  2211. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetColumnWidthInPixels(System.Int32)">
  2212. Get the actual column width in pixels
  2213. <p>
  2214. Please note, that this method works correctly only for workbooks
  2215. with the default font size (Calibri 11pt for .xlsx).
  2216. </p>
  2217. </member>
  2218. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetColumnStyle(System.Int32)">
  2219. Returns the CellStyle that applies to the given
  2220. (0 based) column, or null if no style has been
  2221. set for that column
  2222. </member>
  2223. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetMargin(NPOI.SS.UserModel.MarginType)">
  2224. Gets the size of the margin in inches.
  2225. @param margin which margin to get
  2226. @return the size of the margin
  2227. @see Sheet#LeftMargin
  2228. @see Sheet#RightMargin
  2229. @see Sheet#TopMargin
  2230. @see Sheet#BottomMargin
  2231. @see Sheet#HeaderMargin
  2232. @see Sheet#FooterMargin
  2233. </member>
  2234. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetMargin(NPOI.SS.UserModel.MarginType,System.Double)">
  2235. Sets the size of the margin in inches.
  2236. @param margin which margin to get
  2237. @param size the size of the margin
  2238. @see Sheet#LeftMargin
  2239. @see Sheet#RightMargin
  2240. @see Sheet#TopMargin
  2241. @see Sheet#BottomMargin
  2242. @see Sheet#HeaderMargin
  2243. @see Sheet#FooterMargin
  2244. </member>
  2245. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetMergedRegion(System.Int32)">
  2246. @return the merged region at the specified index
  2247. @throws InvalidOperationException if this worksheet does not contain merged regions
  2248. </member>
  2249. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ProtectSheet(System.String)">
  2250. Enables sheet protection and Sets the password for the sheet.
  2251. Also Sets some attributes on the {@link CT_SheetProtection} that correspond to
  2252. the default values used by Excel
  2253. @param password to set for protection. Pass <code>null</code> to remove protection
  2254. </member>
  2255. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.StringToExcelPassword(System.String)">
  2256. Converts a String to a {@link STUnsignedshortHex} value that Contains the {@link PasswordRecord#hashPassword(String)}
  2257. value in hexadecimal format
  2258. @param password the password string you wish convert to an {@link STUnsignedshortHex}
  2259. @return {@link STUnsignedshortHex} that Contains Excel hashed password in Hex format
  2260. </member>
  2261. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetRow(System.Int32)">
  2262. Returns the logical row ( 0-based). If you ask for a row that is not
  2263. defined you get a null. This is to say row 4 represents the fifth row on a sheet.
  2264. @param rownum row to get
  2265. @return <code>XSSFRow</code> representing the rownumber or <code>null</code> if its not defined on the sheet
  2266. </member>
  2267. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ensureOutlinePr">
  2268. Ensure CT_Worksheet.CT_SheetPr.CT_OutlinePr
  2269. </member>
  2270. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GroupColumn(System.Int32,System.Int32)">
  2271. Group between (0 based) columns
  2272. </member>
  2273. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetColWidthAttribute(NPOI.OpenXmlFormats.Spreadsheet.CT_Cols)">
  2274. Do not leave the width attribute undefined (see #52186).
  2275. </member>
  2276. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GroupRow(System.Int32,System.Int32)">
  2277. Tie a range of cell toGether so that they can be collapsed or expanded
  2278. @param fromRow start row (0-based)
  2279. @param toRow end row (0-based)
  2280. </member>
  2281. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsColumnBroken(System.Int32)">
  2282. Determines if there is a page break at the indicated column
  2283. </member>
  2284. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsColumnHidden(System.Int32)">
  2285. Get the hidden state for a given column.
  2286. @param columnIndex - the column to set (0-based)
  2287. @return hidden - <code>false</code> if the column is visible
  2288. </member>
  2289. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsRowBroken(System.Int32)">
  2290. Tests if there is a page break at the indicated row
  2291. @param row index of the row to test
  2292. @return <code>true</code> if there is a page break at the indicated row
  2293. </member>
  2294. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetRowBreak(System.Int32)">
  2295. Sets a page break at the indicated row
  2296. Breaks occur above the specified row and left of the specified column inclusive.
  2297. For example, <code>sheet.SetColumnBreak(2);</code> breaks the sheet into two parts
  2298. with columns A,B,C in the first and D,E,... in the second. Simuilar, <code>sheet.SetRowBreak(2);</code>
  2299. breaks the sheet into two parts with first three rows (rownum=1...3) in the first part
  2300. and rows starting with rownum=4 in the second.
  2301. @param row the row to break, inclusive
  2302. </member>
  2303. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveColumnBreak(System.Int32)">
  2304. Removes a page break at the indicated column
  2305. </member>
  2306. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveMergedRegion(System.Int32)">
  2307. Removes a merged region of cells (hence letting them free)
  2308. @param index of the region to unmerge
  2309. </member>
  2310. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveMergedRegions(NPOI.Util.Collections.HashSet{System.Int32})">
  2311. Removes a number of merged regions of cells (hence letting them free)
  2312. This method can be used to bulk-remove merged regions in a way
  2313. much faster than calling RemoveMergedRegion() for every single
  2314. merged region.
  2315. @param indices A Set of the regions to unmerge
  2316. </member>
  2317. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveRow(NPOI.SS.UserModel.IRow)">
  2318. Remove a row from this sheet. All cells Contained in the row are Removed as well
  2319. @param row the row to Remove.
  2320. </member>
  2321. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveRowBreak(System.Int32)">
  2322. Removes the page break at the indicated row
  2323. </member>
  2324. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetColumnBreak(System.Int32)">
  2325. Sets a page break at the indicated column.
  2326. Breaks occur above the specified row and left of the specified column inclusive.
  2327. For example, <code>sheet.SetColumnBreak(2);</code> breaks the sheet into two parts
  2328. with columns A,B,C in the first and D,E,... in the second. Simuilar, <code>sheet.SetRowBreak(2);</code>
  2329. breaks the sheet into two parts with first three rows (rownum=1...3) in the first part
  2330. and rows starting with rownum=4 in the second.
  2331. @param column the column to break, inclusive
  2332. </member>
  2333. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetGroupHidden(System.Int32,System.Int32,System.Boolean)">
  2334. Sets all adjacent columns of the same outline level to the specified
  2335. hidden status.
  2336. @param pIdx
  2337. the col info index of the start of the outline group
  2338. @return the column index of the last column in the outline group
  2339. </member>
  2340. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsColumnGroupCollapsed(System.Int32)">
  2341. 'Collapsed' state is stored in a single column col info record
  2342. immediately after the outline group
  2343. @param idx
  2344. @return a bool represented if the column is collapsed
  2345. </member>
  2346. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetColumnHidden(System.Int32,System.Boolean)">
  2347. Get the visibility state for a given column.
  2348. @param columnIndex - the column to get (0-based)
  2349. @param hidden - the visiblity state of the column
  2350. </member>
  2351. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFSheet.SetColumnWidth(System.Int32,System.Int32)" -->
  2352. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetRowGroupCollapsed(System.Int32,System.Boolean)">
  2353. group the row It is possible for collapsed to be false and yet still have
  2354. the rows in question hidden. This can be achieved by having a lower
  2355. outline level collapsed, thus hiding all the child rows. Note that in
  2356. this case, if the lowest level were expanded, the middle level would
  2357. remain collapsed.
  2358. @param rowIndex -
  2359. the row involved, 0 based
  2360. @param collapse -
  2361. bool value for collapse
  2362. </member>
  2363. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CollapseRow(System.Int32)">
  2364. @param rowIndex the zero based row index to collapse
  2365. </member>
  2366. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.FindStartOfRowOutlineGroup(System.Int32)">
  2367. @param rowIndex the zero based row index to find from
  2368. </member>
  2369. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ExpandRow(System.Int32)">
  2370. @param rowNumber the zero based row index to expand
  2371. </member>
  2372. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.FindEndOfRowOutlineGroup(System.Int32)">
  2373. @param row the zero based row index to find from
  2374. </member>
  2375. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsRowGroupHiddenByParent(System.Int32)">
  2376. @param row the zero based row index to find from
  2377. </member>
  2378. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsRowGroupCollapsed(System.Int32)">
  2379. @param row the zero based row index to find from
  2380. </member>
  2381. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetZoom(System.Int32,System.Int32)">
  2382. Sets the zoom magnication for the sheet. The zoom is expressed as a
  2383. fraction. For example to express a zoom of 75% use 3 for the numerator
  2384. and 4 for the denominator.
  2385. @param numerator The numerator for the zoom magnification.
  2386. @param denominator The denominator for the zoom magnification.
  2387. @see #SetZoom(int)
  2388. </member>
  2389. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFSheet.SetZoom(System.Int32)" -->
  2390. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32)" -->
  2391. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean)" -->
  2392. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ShowInPane(System.Int16,System.Int16)">
  2393. Location of the top left visible cell Location of the top left visible cell in the bottom right
  2394. pane (when in Left-to-Right mode).
  2395. @param toprow the top row to show in desktop window pane
  2396. @param leftcol the left column to show in desktop window pane
  2397. </member>
  2398. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.UngroupRow(System.Int32,System.Int32)">
  2399. Ungroup a range of rows that were previously groupped
  2400. @param fromRow start row (0-based)
  2401. @param toRow end row (0-based)
  2402. </member>
  2403. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetCellComment(System.String,NPOI.XSSF.UserModel.XSSFComment)">
  2404. Assign a cell comment to a cell region in this worksheet
  2405. @param cellRef cell region
  2406. @param comment the comment to assign
  2407. @deprecated since Nov 2009 use {@link XSSFCell#SetCellComment(NPOI.SS.usermodel.Comment)} instead
  2408. </member>
  2409. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AddHyperlink(NPOI.XSSF.UserModel.XSSFHyperlink)">
  2410. Register a hyperlink in the collection of hyperlinks on this sheet
  2411. @param hyperlink the link to add
  2412. </member>
  2413. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveHyperlink(System.Int32,System.Int32)">
  2414. Removes a hyperlink in the collection of hyperlinks on this sheet
  2415. @param row row index
  2416. @param column column index
  2417. </member>
  2418. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetDefaultSheetView">
  2419. Return the default sheet view. This is the last one if the sheet's views, according to sec. 3.3.1.83
  2420. of the OOXML spec: "A single sheet view defInition. When more than 1 sheet view is defined in the file,
  2421. it means that when opening the workbook, each sheet view corresponds to a separate window within the
  2422. spreadsheet application, where each window is Showing the particular sheet. Containing the same
  2423. workbookViewId value, the last sheetView defInition is loaded, and the others are discarded.
  2424. When multiple windows are viewing the same sheet, multiple sheetView elements (with corresponding
  2425. workbookView entries) are saved."
  2426. </member>
  2427. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCommentsTable(System.Boolean)">
  2428. Returns the sheet's comments object if there is one,
  2429. or null if not
  2430. @param create create a new comments table if it does not exist
  2431. </member>
  2432. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetSharedFormula(System.Int32)">
  2433. Return a master shared formula by index
  2434. @param sid shared group index
  2435. @return a CT_CellFormula bean holding shared formula or <code>null</code> if not found
  2436. </member>
  2437. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.EnableLocking">
  2438. Enable sheet protection
  2439. </member>
  2440. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.DisableLocking">
  2441. Disable sheet protection
  2442. </member>
  2443. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockAutoFilter">
  2444. Enable Autofilters locking.
  2445. This does not modify sheet protection status.
  2446. To enforce this locking, call {@link #enableLocking()}
  2447. </member>
  2448. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockDeleteColumns">
  2449. Enable Deleting columns locking.
  2450. This does not modify sheet protection status.
  2451. To enforce this locking, call {@link #enableLocking()}
  2452. </member>
  2453. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockDeleteRows">
  2454. Enable Deleting rows locking.
  2455. This does not modify sheet protection status.
  2456. To enforce this locking, call {@link #enableLocking()}
  2457. </member>
  2458. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockFormatCells">
  2459. Enable Formatting cells locking.
  2460. This does not modify sheet protection status.
  2461. To enforce this locking, call {@link #enableLocking()}
  2462. </member>
  2463. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockFormatColumns">
  2464. Enable Formatting columns locking.
  2465. This does not modify sheet protection status.
  2466. To enforce this locking, call {@link #enableLocking()}
  2467. </member>
  2468. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockFormatRows">
  2469. Enable Formatting rows locking.
  2470. This does not modify sheet protection status.
  2471. To enforce this locking, call {@link #enableLocking()}
  2472. </member>
  2473. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockInsertColumns">
  2474. Enable Inserting columns locking.
  2475. This does not modify sheet protection status.
  2476. To enforce this locking, call {@link #enableLocking()}
  2477. </member>
  2478. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockInsertHyperlinks">
  2479. Enable Inserting hyperlinks locking.
  2480. This does not modify sheet protection status.
  2481. To enforce this locking, call {@link #enableLocking()}
  2482. </member>
  2483. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockInsertRows">
  2484. Enable Inserting rows locking.
  2485. This does not modify sheet protection status.
  2486. To enforce this locking, call {@link #enableLocking()}
  2487. </member>
  2488. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockPivotTables">
  2489. Enable Pivot Tables locking.
  2490. This does not modify sheet protection status.
  2491. To enforce this locking, call {@link #enableLocking()}
  2492. </member>
  2493. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockSort">
  2494. Enable Sort locking.
  2495. This does not modify sheet protection status.
  2496. To enforce this locking, call {@link #enableLocking()}
  2497. </member>
  2498. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockObjects">
  2499. Enable Objects locking.
  2500. This does not modify sheet protection status.
  2501. To enforce this locking, call {@link #enableLocking()}
  2502. </member>
  2503. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockScenarios">
  2504. Enable Scenarios locking.
  2505. This does not modify sheet protection status.
  2506. To enforce this locking, call {@link #enableLocking()}
  2507. </member>
  2508. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockSelectLockedCells">
  2509. Enable Selection of locked cells locking.
  2510. This does not modify sheet protection status.
  2511. To enforce this locking, call {@link #enableLocking()}
  2512. </member>
  2513. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockSelectUnlockedCells">
  2514. Enable Selection of unlocked cells locking.
  2515. This does not modify sheet protection status.
  2516. To enforce this locking, call {@link #enableLocking()}
  2517. </member>
  2518. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCellRange(NPOI.SS.Util.CellRangeAddress)">
  2519. Also Creates cells if they don't exist
  2520. </member>
  2521. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateTable">
  2522. Creates a new Table, and associates it with this Sheet
  2523. </member>
  2524. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetTables">
  2525. Returns any tables associated with this Sheet
  2526. </member>
  2527. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetTabColor(System.Int32)">
  2528. Set background color of the sheet tab
  2529. @param colorIndex the indexed color to set, must be a constant from {@link IndexedColors}
  2530. </member>
  2531. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Workbook">
  2532. Returns the parent XSSFWorkbook
  2533. @return the parent XSSFWorkbook
  2534. </member>
  2535. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.SheetName">
  2536. Returns the name of this sheet
  2537. @return the name of this sheet
  2538. </member>
  2539. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.ColumnBreaks">
  2540. Vertical page break information used for print layout view, page layout view, drawing print breaks
  2541. in normal view, and for printing the worksheet.
  2542. @return column indexes of all the vertical page breaks, never <code>null</code>
  2543. </member>
  2544. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DefaultColumnWidth">
  2545. Get the default column width for the sheet (if the columns do not define their own width) in
  2546. characters.
  2547. <p>
  2548. Note, this value is different from {@link #GetColumnWidth(int)}. The latter is always greater and includes
  2549. 4 pixels of margin pAdding (two on each side), plus 1 pixel pAdding for the gridlines.
  2550. </p>
  2551. @return column width, default value is 8
  2552. </member>
  2553. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DefaultRowHeight">
  2554. Get the default row height for the sheet (if the rows do not define their own height) in
  2555. twips (1/20 of a point)
  2556. @return default row height
  2557. </member>
  2558. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DefaultRowHeightInPoints">
  2559. Get the default row height for the sheet measued in point size (if the rows do not define their own height).
  2560. @return default row height in points
  2561. </member>
  2562. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.RightToLeft">
  2563. Whether the text is displayed in right-to-left mode in the window
  2564. @return whether the text is displayed in right-to-left mode in the window
  2565. </member>
  2566. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayGuts">
  2567. Get whether to display the guts or not,
  2568. default value is true
  2569. @return bool - guts or no guts
  2570. </member>
  2571. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayZeros">
  2572. Gets the flag indicating whether the window should show 0 (zero) in cells Containing zero value.
  2573. When false, cells with zero value appear blank instead of Showing the number zero.
  2574. @return whether all zero values on the worksheet are displayed
  2575. </member>
  2576. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.FirstRowNum">
  2577. Gets the first row on the sheet
  2578. @return the number of the first logical row on the sheet, zero based
  2579. </member>
  2580. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.FitToPage">
  2581. Flag indicating whether the Fit to Page print option is enabled.
  2582. @return <code>true</code>
  2583. </member>
  2584. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Footer">
  2585. Returns the default footer for the sheet,
  2586. creating one as needed.
  2587. You may also want to look at
  2588. {@link #GetFirstFooter()},
  2589. {@link #GetOddFooter()} and
  2590. {@link #GetEvenFooter()}
  2591. </member>
  2592. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Header">
  2593. Returns the default header for the sheet,
  2594. creating one as needed.
  2595. You may also want to look at
  2596. {@link #GetFirstHeader()},
  2597. {@link #GetOddHeader()} and
  2598. {@link #GetEvenHeader()}
  2599. </member>
  2600. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.OddFooter">
  2601. Returns the odd footer. Used on all pages unless
  2602. other footers also present, when used on only
  2603. odd pages.
  2604. </member>
  2605. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.EvenFooter">
  2606. Returns the even footer. Not there by default, but
  2607. when Set, used on even pages.
  2608. </member>
  2609. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.FirstFooter">
  2610. Returns the first page footer. Not there by
  2611. default, but when Set, used on the first page.
  2612. </member>
  2613. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.OddHeader">
  2614. Returns the odd header. Used on all pages unless
  2615. other headers also present, when used on only
  2616. odd pages.
  2617. </member>
  2618. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.EvenHeader">
  2619. Returns the even header. Not there by default, but
  2620. when Set, used on even pages.
  2621. </member>
  2622. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.FirstHeader">
  2623. Returns the first page header. Not there by
  2624. default, but when Set, used on the first page.
  2625. </member>
  2626. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.HorizontallyCenter">
  2627. Determine whether printed output for this sheet will be horizontally centered.
  2628. </member>
  2629. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.NumMergedRegions">
  2630. Returns the number of merged regions defined in this worksheet
  2631. @return number of merged regions in this worksheet
  2632. </member>
  2633. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.PaneInformation">
  2634. Returns the information regarding the currently configured pane (split or freeze).
  2635. @return null if no pane configured, or the pane information.
  2636. </member>
  2637. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.PhysicalNumberOfRows">
  2638. Returns the number of phsyically defined rows (NOT the number of rows in the sheet)
  2639. @return the number of phsyically defined rows
  2640. </member>
  2641. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.PrintSetup">
  2642. Gets the print Setup object.
  2643. @return The user model for the print Setup object.
  2644. </member>
  2645. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Protect">
  2646. Answer whether protection is enabled or disabled
  2647. @return true => protection enabled; false => protection disabled
  2648. </member>
  2649. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.RowBreaks">
  2650. Horizontal page break information used for print layout view, page layout view, drawing print breaks in normal
  2651. view, and for printing the worksheet.
  2652. @return row indexes of all the horizontal page breaks, never <code>null</code>
  2653. </member>
  2654. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.RowSumsBelow">
  2655. Flag indicating whether summary rows appear below detail in an outline, when Applying an outline.
  2656. <p>
  2657. When true a summary row is inserted below the detailed data being summarized and a
  2658. new outline level is established on that row.
  2659. </p>
  2660. <p>
  2661. When false a summary row is inserted above the detailed data being summarized and a new outline level
  2662. is established on that row.
  2663. </p>
  2664. @return <code>true</code> if row summaries appear below detail in the outline
  2665. </member>
  2666. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.RowSumsRight">
  2667. Flag indicating whether summary columns appear to the right of detail in an outline, when Applying an outline.
  2668. <p>
  2669. When true a summary column is inserted to the right of the detailed data being summarized
  2670. and a new outline level is established on that column.
  2671. </p>
  2672. <p>
  2673. When false a summary column is inserted to the left of the detailed data being
  2674. summarized and a new outline level is established on that column.
  2675. </p>
  2676. @return <code>true</code> if col summaries appear right of the detail in the outline
  2677. </member>
  2678. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.ScenarioProtect">
  2679. <summary>
  2680. A flag indicating whether scenarios are locked when the sheet is protected.
  2681. </summary>
  2682. </member>
  2683. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.TopRow">
  2684. <summary>
  2685. The top row in the visible view when the sheet is first viewed after opening it in a viewer
  2686. </summary>
  2687. </member>
  2688. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.VerticallyCenter">
  2689. Determine whether printed output for this sheet will be vertically centered.
  2690. @return whether printed output for this sheet will be vertically centered.
  2691. </member>
  2692. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayFormulas">
  2693. Gets the flag indicating whether this sheet should display formulas.
  2694. @return <code>true</code> if this sheet should display formulas.
  2695. </member>
  2696. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayGridlines">
  2697. Gets the flag indicating whether this sheet displays the lines
  2698. between rows and columns to make editing and Reading easier.
  2699. @return <code>true</code> if this sheet displays gridlines.
  2700. @see #isPrintGridlines() to check if printing of gridlines is turned on or off
  2701. </member>
  2702. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayRowColHeadings">
  2703. Gets the flag indicating whether this sheet should display row and column headings.
  2704. <p>
  2705. Row heading are the row numbers to the side of the sheet
  2706. </p>
  2707. <p>
  2708. Column heading are the letters or numbers that appear above the columns of the sheet
  2709. </p>
  2710. @return <code>true</code> if this sheet should display row and column headings.
  2711. </member>
  2712. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsPrintGridlines">
  2713. Returns whether gridlines are printed.
  2714. @return whether gridlines are printed
  2715. </member>
  2716. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.ForceFormulaRecalculation">
  2717. Whether Excel will be asked to recalculate all formulas when the
  2718. workbook is opened.
  2719. </member>
  2720. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Autobreaks">
  2721. Flag indicating whether the sheet displays Automatic Page Breaks.
  2722. @return <code>true</code> if the sheet displays Automatic Page Breaks.
  2723. </member>
  2724. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSelected">
  2725. Returns a flag indicating whether this sheet is selected.
  2726. <p>
  2727. When only 1 sheet is selected and active, this value should be in synch with the activeTab value.
  2728. In case of a conflict, the Start Part Setting wins and Sets the active sheet tab.
  2729. </p>
  2730. Note: multiple sheets can be selected, but only one sheet can be active at one time.
  2731. @return <code>true</code> if this sheet is selected
  2732. </member>
  2733. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.ActiveCell">
  2734. Return location of the active cell, e.g. <code>A1</code>.
  2735. @return the location of the active cell.
  2736. </member>
  2737. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.HasComments">
  2738. Does this sheet have any comments on it? We need to know,
  2739. so we can decide about writing it to disk or not
  2740. </member>
  2741. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsAutoFilterLocked">
  2742. @return true when Autofilters are locked and the sheet is protected.
  2743. </member>
  2744. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsDeleteColumnsLocked">
  2745. @return true when Deleting columns is locked and the sheet is protected.
  2746. </member>
  2747. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsDeleteRowsLocked">
  2748. @return true when Deleting rows is locked and the sheet is protected.
  2749. </member>
  2750. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsFormatCellsLocked">
  2751. @return true when Formatting cells is locked and the sheet is protected.
  2752. </member>
  2753. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsFormatColumnsLocked">
  2754. @return true when Formatting columns is locked and the sheet is protected.
  2755. </member>
  2756. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsFormatRowsLocked">
  2757. @return true when Formatting rows is locked and the sheet is protected.
  2758. </member>
  2759. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsInsertColumnsLocked">
  2760. @return true when Inserting columns is locked and the sheet is protected.
  2761. </member>
  2762. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsInsertHyperlinksLocked">
  2763. @return true when Inserting hyperlinks is locked and the sheet is protected.
  2764. </member>
  2765. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsInsertRowsLocked">
  2766. @return true when Inserting rows is locked and the sheet is protected.
  2767. </member>
  2768. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsPivotTablesLocked">
  2769. @return true when Pivot tables are locked and the sheet is protected.
  2770. </member>
  2771. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSortLocked">
  2772. @return true when Sorting is locked and the sheet is protected.
  2773. </member>
  2774. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsObjectsLocked">
  2775. @return true when Objects are locked and the sheet is protected.
  2776. </member>
  2777. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsScenariosLocked">
  2778. @return true when Scenarios are locked and the sheet is protected.
  2779. </member>
  2780. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSelectLockedCellsLocked">
  2781. @return true when Selection of locked cells is locked and the sheet is protected.
  2782. </member>
  2783. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSelectUnlockedCellsLocked">
  2784. @return true when Selection of unlocked cells is locked and the sheet is protected.
  2785. </member>
  2786. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSheetLocked">
  2787. @return true when Sheet is Protected.
  2788. </member>
  2789. <member name="M:NPOI.XSSF.UserModel.XSSFChartSheet.GetCTChartsheet">
  2790. Provide access to the CTChartsheet bean holding this sheet's data
  2791. @return the CTChartsheet bean holding this sheet's data
  2792. </member>
  2793. <member name="T:NPOI.XSSF.UserModel.XSSFClientAnchor">
  2794. A client anchor is attached to an excel worksheet. It anchors against
  2795. top-left and bottom-right cells.
  2796. @author Yegor Kozlov
  2797. </member>
  2798. <member name="F:NPOI.XSSF.UserModel.XSSFClientAnchor.cell1">
  2799. Starting anchor point
  2800. </member>
  2801. <member name="F:NPOI.XSSF.UserModel.XSSFClientAnchor.cell2">
  2802. Ending anchor point
  2803. </member>
  2804. <member name="M:NPOI.XSSF.UserModel.XSSFClientAnchor.#ctor">
  2805. Creates a new client anchor and defaults all the anchor positions to 0.
  2806. </member>
  2807. <member name="M:NPOI.XSSF.UserModel.XSSFClientAnchor.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  2808. Creates a new client anchor and Sets the top-left and bottom-right
  2809. coordinates of the anchor.
  2810. @param dx1 the x coordinate within the first cell.
  2811. @param dy1 the y coordinate within the first cell.
  2812. @param dx2 the x coordinate within the second cell.
  2813. @param dy2 the y coordinate within the second cell.
  2814. @param col1 the column (0 based) of the first cell.
  2815. @param row1 the row (0 based) of the first cell.
  2816. @param col2 the column (0 based) of the second cell.
  2817. @param row2 the row (0 based) of the second cell.
  2818. </member>
  2819. <member name="M:NPOI.XSSF.UserModel.XSSFClientAnchor.#ctor(NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Marker,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Marker)">
  2820. Create XSSFClientAnchor from existing xml beans
  2821. @param cell1 starting anchor point
  2822. @param cell2 ending anchor point
  2823. </member>
  2824. <member name="P:NPOI.XSSF.UserModel.XSSFClientAnchor.From">
  2825. Return starting anchor point
  2826. @return starting anchor point
  2827. </member>
  2828. <member name="P:NPOI.XSSF.UserModel.XSSFClientAnchor.To">
  2829. Return ending anchor point
  2830. @return ending anchor point
  2831. </member>
  2832. <member name="T:NPOI.XSSF.UserModel.XSSFColor">
  2833. Represents a color in SpreadsheetML
  2834. </member>
  2835. <member name="M:NPOI.XSSF.UserModel.XSSFColor.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Color)">
  2836. Create an instance of XSSFColor from the supplied XML bean
  2837. </member>
  2838. <member name="M:NPOI.XSSF.UserModel.XSSFColor.#ctor">
  2839. Create an new instance of XSSFColor
  2840. </member>
  2841. <member name="M:NPOI.XSSF.UserModel.XSSFColor.GetARgb">
  2842. Standard Alpha Red Green Blue ctColor value (ARGB).
  2843. </member>
  2844. <member name="M:NPOI.XSSF.UserModel.XSSFColor.GetRgbWithTint">
  2845. Standard Red Green Blue ctColor value (RGB) with applied tint.
  2846. Alpha values are ignored.
  2847. </member>
  2848. <member name="M:NPOI.XSSF.UserModel.XSSFColor.GetARGBHex">
  2849. Return the ARGB value in hex format, eg FF00FF00.
  2850. Works for both regular and indexed colours.
  2851. </member>
  2852. <member name="M:NPOI.XSSF.UserModel.XSSFColor.SetRgb(System.Byte[])">
  2853. Standard Alpha Red Green Blue ctColor value (ARGB).
  2854. </member>
  2855. <member name="M:NPOI.XSSF.UserModel.XSSFColor.GetCTColor">
  2856. Returns the underlying XML bean
  2857. @return the underlying XML bean
  2858. </member>
  2859. <member name="P:NPOI.XSSF.UserModel.XSSFColor.IsAuto">
  2860. <summary>
  2861. A bool value indicating the ctColor is automatic and system ctColor dependent.
  2862. </summary>
  2863. </member>
  2864. <member name="P:NPOI.XSSF.UserModel.XSSFColor.Indexed">
  2865. Indexed ctColor value. Only used for backwards compatibility. References a ctColor in indexedColors.
  2866. </member>
  2867. <member name="P:NPOI.XSSF.UserModel.XSSFColor.RGB">
  2868. Standard Red Green Blue ctColor value (RGB).
  2869. If there was an A (Alpha) value, it will be stripped.
  2870. </member>
  2871. <!-- Badly formed XML comment ignored for member "P:NPOI.XSSF.UserModel.XSSFColor.Theme" -->
  2872. <member name="P:NPOI.XSSF.UserModel.XSSFColor.Tint">
  2873. Specifies the tint value applied to the ctColor.
  2874. <p>
  2875. If tint is supplied, then it is applied to the RGB value of the ctColor to determine the final
  2876. ctColor applied.
  2877. </p>
  2878. <p>
  2879. The tint value is stored as a double from -1.0 .. 1.0, where -1.0 means 100% darken and
  2880. 1.0 means 100% lighten. Also, 0.0 means no Change.
  2881. </p>
  2882. <p>
  2883. In loading the RGB value, it is Converted to HLS where HLS values are (0..HLSMAX), where
  2884. HLSMAX is currently 255.
  2885. </p>
  2886. Here are some examples of how to apply tint to ctColor:
  2887. <blockquote>
  2888. <pre>
  2889. If (tint &lt; 0)
  2890. Lum' = Lum * (1.0 + tint)
  2891. For example: Lum = 200; tint = -0.5; Darken 50%
  2892. Lum' = 200 * (0.5) =&gt; 100
  2893. For example: Lum = 200; tint = -1.0; Darken 100% (make black)
  2894. Lum' = 200 * (1.0-1.0) =&gt; 0
  2895. If (tint &gt; 0)
  2896. Lum' = Lum * (1.0-tint) + (HLSMAX - HLSMAX * (1.0-tint))
  2897. For example: Lum = 100; tint = 0.75; Lighten 75%
  2898. Lum' = 100 * (1-.75) + (HLSMAX - HLSMAX*(1-.75))
  2899. = 100 * .25 + (255 - 255 * .25)
  2900. = 25 + (255 - 63) = 25 + 192 = 217
  2901. For example: Lum = 100; tint = 1.0; Lighten 100% (make white)
  2902. Lum' = 100 * (1-1) + (HLSMAX - HLSMAX*(1-1))
  2903. = 100 * 0 + (255 - 255 * 0)
  2904. = 0 + (255 - 0) = 255
  2905. </pre>
  2906. </blockquote>
  2907. @return the tint value
  2908. </member>
  2909. <member name="F:NPOI.XSSF.UserModel.XSSFComment._str">
  2910. cached reference to the string with the comment text
  2911. </member>
  2912. <member name="M:NPOI.XSSF.UserModel.XSSFComment.#ctor(NPOI.XSSF.Model.CommentsTable,NPOI.OpenXmlFormats.Spreadsheet.CT_Comment,NPOI.OpenXmlFormats.Vml.CT_Shape)">
  2913. Creates a new XSSFComment, associated with a given
  2914. low level comment object.
  2915. </member>
  2916. <member name="M:NPOI.XSSF.UserModel.XSSFComment.SetString(System.String)">
  2917. Sets the rich text string used by this comment.
  2918. @param string the XSSFRichTextString used by this object.
  2919. </member>
  2920. <member name="M:NPOI.XSSF.UserModel.XSSFComment.GetCTComment">
  2921. @return the xml bean holding this comment's properties
  2922. </member>
  2923. <member name="P:NPOI.XSSF.UserModel.XSSFComment.Author">
  2924. @return Name of the original comment author. Default value is blank.
  2925. </member>
  2926. <member name="P:NPOI.XSSF.UserModel.XSSFComment.Column">
  2927. @return the 0-based column of the cell that the comment is associated with.
  2928. </member>
  2929. <member name="P:NPOI.XSSF.UserModel.XSSFComment.Row">
  2930. @return the 0-based row index of the cell that the comment is associated with.
  2931. </member>
  2932. <member name="P:NPOI.XSSF.UserModel.XSSFComment.Visible">
  2933. @return whether the comment is visible
  2934. </member>
  2935. <member name="P:NPOI.XSSF.UserModel.XSSFComment.String">
  2936. @return the rich text string of the comment
  2937. </member>
  2938. <member name="T:NPOI.XSSF.UserModel.XSSFConditionalFormatting">
  2939. @author Yegor Kozlov
  2940. </member>
  2941. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormatting.GetFormattingRanges">
  2942. @return array of <tt>CellRangeAddress</tt>s. Never <code>null</code>
  2943. </member>
  2944. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormatting.SetRule(System.Int32,NPOI.SS.UserModel.IConditionalFormattingRule)">
  2945. Replaces an existing Conditional Formatting rule at position idx.
  2946. Excel allows to create up to 3 Conditional Formatting rules.
  2947. This method can be useful to modify existing Conditional Formatting rules.
  2948. @param idx position of the rule. Should be between 0 and 2.
  2949. @param cfRule - Conditional Formatting rule
  2950. </member>
  2951. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormatting.AddRule(NPOI.SS.UserModel.IConditionalFormattingRule)">
  2952. Add a Conditional Formatting rule.
  2953. Excel allows to create up to 3 Conditional Formatting rules.
  2954. @param cfRule - Conditional Formatting rule
  2955. </member>
  2956. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormatting.GetRule(System.Int32)">
  2957. @return the Conditional Formatting rule at position idx.
  2958. </member>
  2959. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormatting.NumberOfRules">
  2960. @return number of Conditional Formatting rules.
  2961. </member>
  2962. <member name="T:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule">
  2963. @author Yegor Kozlov
  2964. </member>
  2965. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.CreateBorderFormatting">
  2966. Create a new border formatting structure if it does not exist,
  2967. otherwise just return existing object.
  2968. @return - border formatting object, never returns <code>null</code>.
  2969. </member>
  2970. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.GetBorderFormatting">
  2971. @return - border formatting object if defined, <code>null</code> otherwise
  2972. </member>
  2973. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.CreateFontFormatting">
  2974. Create a new font formatting structure if it does not exist,
  2975. otherwise just return existing object.
  2976. @return - font formatting object, never returns <code>null</code>.
  2977. </member>
  2978. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.GetFontFormatting">
  2979. @return - font formatting object if defined, <code>null</code> otherwise
  2980. </member>
  2981. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.CreatePatternFormatting">
  2982. Create a new pattern formatting structure if it does not exist,
  2983. otherwise just return existing object.
  2984. @return - pattern formatting object, never returns <code>null</code>.
  2985. </member>
  2986. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.GetPatternFormatting">
  2987. @return - pattern formatting object if defined, <code>null</code> otherwise
  2988. </member>
  2989. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.ConditionType">
  2990. Type of conditional formatting rule.
  2991. <p>
  2992. MUST be either {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS}
  2993. or {@link ConditionalFormattingRule#CONDITION_TYPE_FORMULA}
  2994. </p>
  2995. @return the type of condition
  2996. </member>
  2997. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.ComparisonOperation">
  2998. The comparison function used when the type of conditional formatting is Set to
  2999. {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS}
  3000. <p>
  3001. MUST be a constant from {@link NPOI.ss.usermodel.ComparisonOperator}
  3002. </p>
  3003. @return the conditional format operator
  3004. </member>
  3005. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.Formula1">
  3006. The formula used to Evaluate the first operand for the conditional formatting rule.
  3007. <p>
  3008. If the condition type is {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS},
  3009. this field is the first operand of the comparison.
  3010. If type is {@link ConditionalFormattingRule#CONDITION_TYPE_FORMULA}, this formula is used
  3011. to determine if the conditional formatting is applied.
  3012. </p>
  3013. <p>
  3014. If comparison type is {@link ConditionalFormattingRule#CONDITION_TYPE_FORMULA} the formula MUST be a Boolean function
  3015. </p>
  3016. @return the first formula
  3017. </member>
  3018. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.Formula2">
  3019. The formula used to Evaluate the second operand of the comparison when
  3020. comparison type is {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS} and operator
  3021. is either {@link NPOI.ss.usermodel.ComparisonOperator#BETWEEN} or {@link NPOI.ss.usermodel.ComparisonOperator#NOT_BETWEEN}
  3022. @return the second formula
  3023. </member>
  3024. <member name="T:NPOI.XSSF.UserModel.XSSFConnector">
  3025. A connection shape Drawing element. A connection shape is a line, etc.
  3026. that connects two other shapes in this Drawing.
  3027. @author Yegor Kozlov
  3028. </member>
  3029. <member name="T:NPOI.XSSF.UserModel.XSSFShape">
  3030. Represents a shape in a SpreadsheetML Drawing.
  3031. @author Yegor Kozlov
  3032. </member>
  3033. <member name="F:NPOI.XSSF.UserModel.XSSFShape.drawing">
  3034. Parent Drawing
  3035. </member>
  3036. <member name="F:NPOI.XSSF.UserModel.XSSFShape.parent">
  3037. The parent shape, always not-null for shapes in groups
  3038. </member>
  3039. <member name="F:NPOI.XSSF.UserModel.XSSFShape.anchor">
  3040. anchor that is used by this shape
  3041. </member>
  3042. <member name="M:NPOI.XSSF.UserModel.XSSFShape.GetDrawing">
  3043. Return the Drawing that owns this shape
  3044. @return the parent Drawing that owns this shape
  3045. </member>
  3046. <member name="M:NPOI.XSSF.UserModel.XSSFShape.GetAnchor">
  3047. @return the anchor that is used by this shape.
  3048. </member>
  3049. <member name="M:NPOI.XSSF.UserModel.XSSFShape.GetShapeProperties">
  3050. Returns xml bean with shape properties.
  3051. @return xml bean with shape properties.
  3052. </member>
  3053. <member name="M:NPOI.XSSF.UserModel.XSSFShape.SetFillColor(System.Int32,System.Int32,System.Int32)">
  3054. Sets the color used to fill this shape using the solid fill pattern.
  3055. </member>
  3056. <member name="M:NPOI.XSSF.UserModel.XSSFShape.SetLineStyleColor(System.Int32,System.Int32,System.Int32)">
  3057. The color applied to the lines of this shape.
  3058. </member>
  3059. <member name="P:NPOI.XSSF.UserModel.XSSFShape.Parent">
  3060. Gets the parent shape.
  3061. </member>
  3062. <member name="P:NPOI.XSSF.UserModel.XSSFShape.IsNoFill">
  3063. Whether this shape is not Filled with a color
  3064. @return true if this shape is not Filled with a color.
  3065. </member>
  3066. <member name="M:NPOI.XSSF.UserModel.XSSFConnector.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Connector)">
  3067. Construct a new XSSFConnector object.
  3068. @param Drawing the XSSFDrawing that owns this shape
  3069. @param ctShape the shape bean that holds all the shape properties
  3070. </member>
  3071. <member name="M:NPOI.XSSF.UserModel.XSSFConnector.Prototype">
  3072. Initialize default structure of a new auto-shape
  3073. </member>
  3074. <member name="P:NPOI.XSSF.UserModel.XSSFConnector.ShapeType">
  3075. Gets the shape type, one of the constants defined in {@link NPOI.ss.usermodel.ShapeTypes}.
  3076. @return the shape type
  3077. @see NPOI.ss.usermodel.ShapeTypes
  3078. </member>
  3079. <member name="M:NPOI.XSSF.UserModel.XSSFCreationHelper.CreateRichTextString(System.String)">
  3080. Creates a new XSSFRichTextString for you.
  3081. </member>
  3082. <member name="M:NPOI.XSSF.UserModel.XSSFCreationHelper.CreateFormulaEvaluator">
  3083. Creates a XSSFFormulaEvaluator, the object that Evaluates formula cells.
  3084. @return a XSSFFormulaEvaluator instance
  3085. </member>
  3086. <member name="M:NPOI.XSSF.UserModel.XSSFCreationHelper.CreateClientAnchor">
  3087. Creates a XSSFClientAnchor. Use this object to position Drawing object in
  3088. a sheet
  3089. @return a XSSFClientAnchor instance
  3090. @see NPOI.ss.usermodel.Drawing
  3091. </member>
  3092. <member name="T:NPOI.XSSF.UserModel.XSSFDataFormat">
  3093. Handles data formats for XSSF.
  3094. </member>
  3095. <member name="M:NPOI.XSSF.UserModel.XSSFDataFormat.GetFormat(System.String)">
  3096. Get the format index that matches the given format
  3097. string, creating a new format entry if required.
  3098. Aliases text to the proper format as required.
  3099. @param format string matching a built in format
  3100. @return index of format.
  3101. </member>
  3102. <member name="M:NPOI.XSSF.UserModel.XSSFDataFormat.GetFormat(System.Int16)">
  3103. Get the format string that matches the given format index
  3104. @param index of a format
  3105. @return string represented at index of format or null if there is not a format at that index
  3106. </member>
  3107. <member name="M:NPOI.XSSF.UserModel.XSSFDataFormat.GetFormat(System.Int32)">
  3108. get the format string that matches the given format index
  3109. @param index of a format
  3110. @return string represented at index of format or null if there is not a format at that index
  3111. </member>
  3112. <member name="T:NPOI.XSSF.UserModel.XSSFDataValidation">
  3113. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  3114. </member>
  3115. <member name="T:NPOI.XSSF.UserModel.XSSFDataValidationConstraint">
  3116. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  3117. </member>
  3118. <member name="T:NPOI.XSSF.UserModel.XSSFDataValidationHelper">
  3119. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  3120. </member>
  3121. <member name="T:NPOI.XSSF.UserModel.XSSFDrawing">
  3122. Represents a SpreadsheetML Drawing
  3123. @author Yegor Kozlov
  3124. </member>
  3125. <member name="F:NPOI.XSSF.UserModel.XSSFDrawing.drawing">
  3126. Root element of the SpreadsheetML Drawing part
  3127. </member>
  3128. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.#ctor">
  3129. Create a new SpreadsheetML Drawing
  3130. @see NPOI.xssf.usermodel.XSSFSheet#CreateDrawingPatriarch()
  3131. </member>
  3132. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  3133. Construct a SpreadsheetML Drawing from a namespace part
  3134. @param part the namespace part holding the Drawing data,
  3135. the content type must be <code>application/vnd.openxmlformats-officedocument.Drawing+xml</code>
  3136. @param rel the namespace relationship holding this Drawing,
  3137. the relationship type must be http://schemas.openxmlformats.org/officeDocument/2006/relationships/drawing
  3138. </member>
  3139. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.NewDrawing">
  3140. Construct a new CT_Drawing bean. By default, it's just an empty placeholder for Drawing objects
  3141. @return a new CT_Drawing bean
  3142. </member>
  3143. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.GetCTDrawing">
  3144. Return the underlying CT_Drawing bean, the root element of the SpreadsheetML Drawing part.
  3145. @return the underlying CT_Drawing bean
  3146. </member>
  3147. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateTextbox(NPOI.SS.UserModel.IClientAnchor)">
  3148. Constructs a textbox under the Drawing.
  3149. @param anchor the client anchor describes how this group is attached
  3150. to the sheet.
  3151. @return the newly Created textbox.
  3152. </member>
  3153. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreatePicture(NPOI.XSSF.UserModel.XSSFClientAnchor,System.Int32)">
  3154. Creates a picture.
  3155. @param anchor the client anchor describes how this picture is attached to the sheet.
  3156. @param pictureIndex the index of the picture in the workbook collection of pictures,
  3157. {@link NPOI.xssf.usermodel.XSSFWorkbook#getAllPictures()} .
  3158. @return the newly Created picture shape.
  3159. </member>
  3160. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateChart(NPOI.SS.UserModel.IClientAnchor)">
  3161. <summary>
  3162. Creates a chart.
  3163. </summary>
  3164. <param name="anchor">the client anchor describes how this chart is attached to</param>
  3165. <returns>the newly created chart</returns>
  3166. </member>
  3167. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.AddPictureReference(System.Int32)">
  3168. Add the indexed picture to this Drawing relations
  3169. @param pictureIndex the index of the picture in the workbook collection of pictures,
  3170. {@link NPOI.xssf.usermodel.XSSFWorkbook#getAllPictures()} .
  3171. </member>
  3172. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateSimpleShape(NPOI.XSSF.UserModel.XSSFClientAnchor)">
  3173. Creates a simple shape. This includes such shapes as lines, rectangles,
  3174. and ovals.
  3175. @param anchor the client anchor describes how this group is attached
  3176. to the sheet.
  3177. @return the newly Created shape.
  3178. </member>
  3179. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateConnector(NPOI.XSSF.UserModel.XSSFClientAnchor)">
  3180. Creates a simple shape. This includes such shapes as lines, rectangles,
  3181. and ovals.
  3182. @param anchor the client anchor describes how this group is attached
  3183. to the sheet.
  3184. @return the newly Created shape.
  3185. </member>
  3186. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateGroup(NPOI.XSSF.UserModel.XSSFClientAnchor)">
  3187. Creates a simple shape. This includes such shapes as lines, rectangles,
  3188. and ovals.
  3189. @param anchor the client anchor describes how this group is attached
  3190. to the sheet.
  3191. @return the newly Created shape.
  3192. </member>
  3193. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateCellComment(NPOI.SS.UserModel.IClientAnchor)">
  3194. Creates a comment.
  3195. @param anchor the client anchor describes how this comment is attached
  3196. to the sheet.
  3197. @return the newly Created comment.
  3198. </member>
  3199. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateGraphicFrame(NPOI.XSSF.UserModel.XSSFClientAnchor)">
  3200. Creates a new graphic frame.
  3201. @param anchor the client anchor describes how this frame is attached
  3202. to the sheet
  3203. @return the newly Created graphic frame
  3204. </member>
  3205. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.GetCharts">
  3206. Returns all charts in this Drawing.
  3207. </member>
  3208. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateTwoCellAnchor(NPOI.SS.UserModel.IClientAnchor)">
  3209. Create and Initialize a CT_TwoCellAnchor that anchors a shape against top-left and bottom-right cells.
  3210. @return a new CT_TwoCellAnchor
  3211. </member>
  3212. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.GetShapes">
  3213. @return list of shapes in this drawing
  3214. </member>
  3215. <member name="T:NPOI.XSSF.UserModel.XSSFEvaluationCell">
  3216. XSSF wrapper for a cell under Evaluation
  3217. @author Josh Micich
  3218. </member>
  3219. <member name="T:NPOI.XSSF.UserModel.XSSFEvaluationSheet">
  3220. XSSF wrapper for a sheet under Evaluation
  3221. @author Josh Micich
  3222. </member>
  3223. <member name="T:NPOI.XSSF.UserModel.XSSFEvaluationWorkbook">
  3224. Internal POI use only
  3225. @author Josh Micich
  3226. </member>
  3227. <member name="M:NPOI.XSSF.UserModel.XSSFEvaluationWorkbook.ConvertFromExternSheetIndex(System.Int32)">
  3228. @return the sheet index of the sheet with the given external index.
  3229. </member>
  3230. <member name="M:NPOI.XSSF.UserModel.XSSFEvaluationWorkbook.ConvertToExternalSheetIndex(System.Int32)">
  3231. @return the external sheet index of the sheet with the given internal
  3232. index. Used by some of the more obscure formula and named range things.
  3233. Fairly easy on XSSF (we think...) since the internal and external
  3234. indicies are the same
  3235. </member>
  3236. <member name="M:NPOI.XSSF.UserModel.XSSFEvaluationWorkbook.CleanXSSFFormulaText(System.String)">
  3237. XSSF allows certain extra textual characters in the formula that
  3238. HSSF does not. As these can't be composed down to HSSF-compatible
  3239. Ptgs, this method strips them out for us.
  3240. </member>
  3241. <member name="T:NPOI.XSSF.UserModel.XSSFEvenFooter">
  3242. Even page footer value. Corresponds to even printed pages.
  3243. Even page(s) in the sheet may not be printed, for example, if the print area is specified to be
  3244. a range such that it falls outside an even page's scope.
  3245. If no even footer is specified, then the odd footer's value is assumed for even page footers.
  3246. </member>
  3247. <member name="M:NPOI.XSSF.UserModel.XSSFEvenFooter.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  3248. Create an instance of XSSFEvenFooter from the supplied XML bean
  3249. @see XSSFSheet#GetEvenFooter()
  3250. @param headerFooter
  3251. </member>
  3252. <member name="P:NPOI.XSSF.UserModel.XSSFEvenFooter.Text">
  3253. Get the content text representing the footer
  3254. @return text
  3255. </member>
  3256. <member name="T:NPOI.XSSF.UserModel.XSSFEvenHeader">
  3257. <p>
  3258. Even page header value. Corresponds to even printed pages.
  3259. Even page(s) in the sheet may not be printed, for example, if the print area is specified to be
  3260. a range such that it falls outside an even page's scope.
  3261. If no even header is specified, then odd header value is assumed for even page headers.
  3262. </p>
  3263. </member>
  3264. <member name="M:NPOI.XSSF.UserModel.XSSFEvenHeader.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  3265. Create an instance of XSSFEvenHeader from the supplied XML bean
  3266. @see XSSFSheet#GetEvenHeader()
  3267. @param headerFooter
  3268. </member>
  3269. <member name="P:NPOI.XSSF.UserModel.XSSFEvenHeader.Text">
  3270. Get the content text representing this header
  3271. @return text
  3272. </member>
  3273. <member name="T:NPOI.XSSF.UserModel.XSSFFactory">
  3274. Instantiates sub-classes of POIXMLDocumentPart depending on their relationship type
  3275. @author Yegor Kozlov
  3276. </member>
  3277. <member name="T:NPOI.XSSF.UserModel.XSSFFirstFooter">
  3278. First page footer content. Corresponds to first printed page.
  3279. The first logical page in the sheet may not be printed, for example, if the print area is specified to
  3280. be a range such that it falls outside the first page's scope.
  3281. </member>
  3282. <member name="M:NPOI.XSSF.UserModel.XSSFFirstFooter.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  3283. Create an instance of XSSFFirstFooter from the supplied XML bean
  3284. @see XSSFSheet#getFirstFooter()
  3285. @param headerFooter
  3286. </member>
  3287. <member name="P:NPOI.XSSF.UserModel.XSSFFirstFooter.Text">
  3288. Get the content text representing the footer
  3289. @return text
  3290. </member>
  3291. <member name="T:NPOI.XSSF.UserModel.XSSFFirstHeader">
  3292. First page header content. Corresponds to first printed page.
  3293. The first logical page in the sheet may not be printed, for example, if the print area is specified to
  3294. be a range such that it falls outside the first page's scope.
  3295. </member>
  3296. <member name="M:NPOI.XSSF.UserModel.XSSFFirstHeader.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  3297. Create an instance of XSSFFirstHeader from the supplied XML bean
  3298. @see XSSFSheet#getFirstHeader()
  3299. @param headerFooter
  3300. </member>
  3301. <member name="P:NPOI.XSSF.UserModel.XSSFFirstHeader.Text">
  3302. Get the content text representing this header
  3303. @return text
  3304. </member>
  3305. <member name="T:NPOI.XSSF.UserModel.XSSFFont">
  3306. Represents a font used in a workbook.
  3307. @author Gisella Bronzetti
  3308. </member>
  3309. <member name="F:NPOI.XSSF.UserModel.XSSFFont.DEFAULT_FONT_NAME">
  3310. By default, Microsoft Office Excel 2007 uses the Calibry font in font size 11
  3311. </member>
  3312. <member name="F:NPOI.XSSF.UserModel.XSSFFont.DEFAULT_FONT_SIZE">
  3313. By default, Microsoft Office Excel 2007 uses the Calibry font in font size 11
  3314. </member>
  3315. <member name="F:NPOI.XSSF.UserModel.XSSFFont.DEFAULT_FONT_COLOR">
  3316. Default font color is black
  3317. @see NPOI.SS.usermodel.IndexedColors#BLACK
  3318. </member>
  3319. <member name="M:NPOI.XSSF.UserModel.XSSFFont.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Font)">
  3320. Create a new XSSFFont
  3321. @param font the underlying CT_Font bean
  3322. </member>
  3323. <member name="M:NPOI.XSSF.UserModel.XSSFFont.#ctor">
  3324. Create a new XSSFont. This method is protected to be used only by XSSFWorkbook
  3325. </member>
  3326. <member name="M:NPOI.XSSF.UserModel.XSSFFont.GetCTFont">
  3327. get the underlying CT_Font font
  3328. </member>
  3329. <member name="M:NPOI.XSSF.UserModel.XSSFFont.GetXSSFColor">
  3330. get the color value for the font
  3331. References a color defined as Standard Alpha Red Green Blue color value (ARGB).
  3332. @return XSSFColor - rgb color to use
  3333. </member>
  3334. <member name="M:NPOI.XSSF.UserModel.XSSFFont.GetThemeColor">
  3335. get the color value for the font
  3336. References a color defined in theme.
  3337. @return short - theme defined to use
  3338. </member>
  3339. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetCharSet(System.Byte)">
  3340. set character-set to use.
  3341. @param charset - charset
  3342. @see FontCharset
  3343. </member>
  3344. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetCharSet(System.Int32)">
  3345. set character-set to use.
  3346. @param charset - charset
  3347. @see FontCharset
  3348. </member>
  3349. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetCharSet(NPOI.SS.UserModel.FontCharset)">
  3350. set character-set to use.
  3351. @param charSet
  3352. </member>
  3353. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetColor(NPOI.XSSF.UserModel.XSSFColor)">
  3354. set the color for the font in Standard Alpha Red Green Blue color value
  3355. @param color - color to use
  3356. </member>
  3357. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetThemeColor(System.Int16)">
  3358. set the theme color for the font to use
  3359. @param theme - theme color to use
  3360. </member>
  3361. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetUnderline(NPOI.SS.UserModel.FontUnderlineType)">
  3362. set an enumeration representing the style of underlining that is used.
  3363. The none style is equivalent to not using underlining at all.
  3364. The possible values for this attribute are defined by the FontUnderline
  3365. @param underline - FontUnderline enum value
  3366. </member>
  3367. <member name="M:NPOI.XSSF.UserModel.XSSFFont.RegisterTo(NPOI.XSSF.Model.StylesTable)">
  3368. **
  3369. </member>
  3370. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetThemesTable(NPOI.XSSF.Model.ThemesTable)">
  3371. Records the Themes Table that is associated with
  3372. the current font, used when looking up theme
  3373. based colours and properties.
  3374. </member>
  3375. <member name="M:NPOI.XSSF.UserModel.XSSFFont.GetScheme">
  3376. get the font scheme property.
  3377. is used only in StylesTable to create the default instance of font
  3378. @return FontScheme
  3379. @see NPOI.XSSF.model.StylesTable#CreateDefaultFont()
  3380. </member>
  3381. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetScheme(NPOI.SS.UserModel.FontScheme)">
  3382. set font scheme property
  3383. @param scheme - FontScheme enum value
  3384. @see FontScheme
  3385. </member>
  3386. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetFamily(NPOI.SS.UserModel.FontFamily)">
  3387. set an enumeration representing the font family this font belongs to.
  3388. A font family is a set of fonts having common stroke width and serif characteristics.
  3389. @param family font family
  3390. @link #SetFamily(int value)
  3391. </member>
  3392. <member name="P:NPOI.XSSF.UserModel.XSSFFont.IsBold">
  3393. get a bool value for the boldness to use.
  3394. @return bool - bold
  3395. </member>
  3396. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Charset">
  3397. get character-set to use.
  3398. @return int - character-set (0-255)
  3399. @see NPOI.SS.usermodel.FontCharset
  3400. </member>
  3401. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Color">
  3402. get the indexed color value for the font
  3403. References a color defined in IndexedColors.
  3404. @return short - indexed color to use
  3405. @see IndexedColors
  3406. </member>
  3407. <member name="P:NPOI.XSSF.UserModel.XSSFFont.FontHeight">
  3408. get the font height in point.
  3409. @return short - height in point
  3410. </member>
  3411. <member name="P:NPOI.XSSF.UserModel.XSSFFont.FontHeightInPoints">
  3412. @see #GetFontHeight()
  3413. </member>
  3414. <member name="P:NPOI.XSSF.UserModel.XSSFFont.FontName">
  3415. get the name of the font (i.e. Arial)
  3416. @return String - a string representing the name of the font to use
  3417. </member>
  3418. <member name="P:NPOI.XSSF.UserModel.XSSFFont.IsItalic">
  3419. get a bool value that specify whether to use italics or not
  3420. @return bool - value for italic
  3421. </member>
  3422. <member name="P:NPOI.XSSF.UserModel.XSSFFont.IsStrikeout">
  3423. get a bool value that specify whether to use a strikeout horizontal line through the text or not
  3424. @return bool - value for strikeout
  3425. </member>
  3426. <member name="P:NPOI.XSSF.UserModel.XSSFFont.TypeOffset">
  3427. get normal,super or subscript.
  3428. @return short - offset type to use (none,super,sub)
  3429. @see Font#SS_NONE
  3430. @see Font#SS_SUPER
  3431. @see Font#SS_SUB
  3432. </member>
  3433. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Underline">
  3434. get type of text underlining to use
  3435. @return byte - underlining type
  3436. @see NPOI.SS.usermodel.FontUnderline
  3437. </member>
  3438. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Boldweight">
  3439. get the boldness to use
  3440. @return boldweight
  3441. @see #BOLDWEIGHT_NORMAL
  3442. @see #BOLDWEIGHT_BOLD
  3443. </member>
  3444. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Family">
  3445. get the font family to use.
  3446. @return the font family to use
  3447. @see NPOI.SS.usermodel.FontFamily
  3448. </member>
  3449. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Index">
  3450. get the index within the XSSFWorkbook (sequence within the collection of Font objects)
  3451. @return unique index number of the underlying record this Font represents (probably you don't care
  3452. unless you're comparing which one is which)
  3453. </member>
  3454. <member name="T:NPOI.XSSF.UserModel.XSSFFontFormatting">
  3455. @author Yegor Kozlov
  3456. </member>
  3457. <member name="M:NPOI.XSSF.UserModel.XSSFFontFormatting.GetXSSFColor">
  3458. @return xssf color wrapper or null if color info is missing
  3459. </member>
  3460. <member name="M:NPOI.XSSF.UserModel.XSSFFontFormatting.SetFontStyle(System.Boolean,System.Boolean)">
  3461. Set font style options.
  3462. @param italic - if true, Set posture style to italic, otherwise to normal
  3463. @param bold if true, Set font weight to bold, otherwise to normal
  3464. </member>
  3465. <member name="M:NPOI.XSSF.UserModel.XSSFFontFormatting.ResetFontStyle">
  3466. Set font style options to default values (non-italic, non-bold)
  3467. </member>
  3468. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.EscapementType">
  3469. Get the type of super or subscript for the font
  3470. @return super or subscript option
  3471. @see #SS_NONE
  3472. @see #SS_SUPER
  3473. @see #SS_SUB
  3474. </member>
  3475. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.FontColorIndex">
  3476. @return font color index
  3477. </member>
  3478. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.FontHeight">
  3479. Gets the height of the font in 1/20th point units
  3480. @return fontheight (in points/20); or -1 if not modified
  3481. </member>
  3482. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.UnderlineType">
  3483. Get the type of underlining for the font
  3484. @return font underlining type
  3485. @see #U_NONE
  3486. @see #U_SINGLE
  3487. @see #U_DOUBLE
  3488. @see #U_SINGLE_ACCOUNTING
  3489. @see #U_DOUBLE_ACCOUNTING
  3490. </member>
  3491. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.IsBold">
  3492. Get whether the font weight is Set to bold or not
  3493. @return bold - whether the font is bold or not
  3494. </member>
  3495. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.IsItalic">
  3496. @return true if font style was Set to <i>italic</i>
  3497. </member>
  3498. <member name="T:NPOI.XSSF.UserModel.XSSFFormulaEvaluator">
  3499. Evaluates formula cells.<p/>
  3500. For performance reasons, this class keeps a cache of all previously calculated intermediate
  3501. cell values. Be sure to call {@link #ClearAllCachedResultValues()} if any workbook cells are Changed between
  3502. calls to Evaluate~ methods on this class.
  3503. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  3504. @author Josh Micich
  3505. </member>
  3506. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.#ctor(NPOI.XSSF.UserModel.XSSFWorkbook,NPOI.SS.Formula.IStabilityClassifier)">
  3507. @param stabilityClassifier used to optimise caching performance. Pass <code>null</code>
  3508. for the (conservative) assumption that any cell may have its defInition Changed After
  3509. Evaluation begins.
  3510. @deprecated (Sep 2009) (reduce overloading) use {@link #Create(XSSFWorkbook, NPOI.ss.formula.IStabilityClassifier, NPOI.ss.formula.udf.UDFFinder)}
  3511. </member>
  3512. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.Create(NPOI.XSSF.UserModel.XSSFWorkbook,NPOI.SS.Formula.IStabilityClassifier,NPOI.SS.Formula.Udf.UDFFinder)">
  3513. @param stabilityClassifier used to optimise caching performance. Pass <code>null</code>
  3514. for the (conservative) assumption that any cell may have its defInition Changed After
  3515. Evaluation begins.
  3516. @param udfFinder pass <code>null</code> for default (AnalysisToolPak only)
  3517. </member>
  3518. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.ClearAllCachedResultValues">
  3519. Should be called whenever there are major Changes (e.g. moving sheets) to input cells
  3520. in the Evaluated workbook.
  3521. Failure to call this method After changing cell values will cause incorrect behaviour
  3522. of the Evaluate~ methods of this class
  3523. </member>
  3524. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.Evaluate(NPOI.SS.UserModel.ICell)">
  3525. If cell Contains a formula, the formula is Evaluated and returned,
  3526. else the CellValue simply copies the appropriate cell value from
  3527. the cell and also its cell type. This method should be preferred over
  3528. EvaluateInCell() when the call should not modify the contents of the
  3529. original cell.
  3530. @param cell
  3531. </member>
  3532. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.EvaluateFormulaCell(NPOI.SS.UserModel.ICell)">
  3533. If cell Contains formula, it Evaluates the formula,
  3534. and saves the result of the formula. The cell
  3535. remains as a formula cell.
  3536. Else if cell does not contain formula, this method leaves
  3537. the cell unChanged.
  3538. Note that the type of the formula result is returned,
  3539. so you know what kind of value is also stored with
  3540. the formula.
  3541. <pre>
  3542. int EvaluatedCellType = Evaluator.EvaluateFormulaCell(cell);
  3543. </pre>
  3544. Be aware that your cell will hold both the formula,
  3545. and the result. If you want the cell Replaced with
  3546. the result of the formula, use {@link #Evaluate(NPOI.ss.usermodel.Cell)} }
  3547. @param cell The cell to Evaluate
  3548. @return The type of the formula result (the cell's type remains as HSSFCell.CELL_TYPE_FORMULA however)
  3549. </member>
  3550. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.EvaluateInCell(NPOI.SS.UserModel.ICell)">
  3551. If cell Contains formula, it Evaluates the formula, and
  3552. Puts the formula result back into the cell, in place
  3553. of the old formula.
  3554. Else if cell does not contain formula, this method leaves
  3555. the cell unChanged.
  3556. Note that the same instance of HSSFCell is returned to
  3557. allow chained calls like:
  3558. <pre>
  3559. int EvaluatedCellType = Evaluator.EvaluateInCell(cell).CellType;
  3560. </pre>
  3561. Be aware that your cell value will be Changed to hold the
  3562. result of the formula. If you simply want the formula
  3563. value computed for you, use {@link #EvaluateFormulaCell(NPOI.ss.usermodel.Cell)} }
  3564. @param cell
  3565. </member>
  3566. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.EvaluateAllFormulaCells(NPOI.SS.UserModel.IWorkbook)">
  3567. Loops over all cells in all sheets of the supplied
  3568. workbook.
  3569. For cells that contain formulas, their formulas are
  3570. Evaluated, and the results are saved. These cells
  3571. remain as formula cells.
  3572. For cells that do not contain formulas, no Changes
  3573. are made.
  3574. This is a helpful wrapper around looping over all
  3575. cells, and calling EvaluateFormulaCell on each one.
  3576. </member>
  3577. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.EvaluateAll">
  3578. Loops over all cells in all sheets of the supplied
  3579. workbook.
  3580. For cells that contain formulas, their formulas are
  3581. Evaluated, and the results are saved. These cells
  3582. remain as formula cells.
  3583. For cells that do not contain formulas, no Changes
  3584. are made.
  3585. This is a helpful wrapper around looping over all
  3586. cells, and calling EvaluateFormulaCell on each one.
  3587. </member>
  3588. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.EvaluateFormulaCellValue(NPOI.SS.UserModel.ICell)">
  3589. Returns a CellValue wrapper around the supplied ValueEval instance.
  3590. </member>
  3591. <member name="T:NPOI.XSSF.UserModel.XSSFGraphicFrame">
  3592. Represents DrawingML GraphicalObjectFrame.
  3593. @author Roman Kashitsyn
  3594. </member>
  3595. <member name="M:NPOI.XSSF.UserModel.XSSFGraphicFrame.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_GraphicalObjectFrame)">
  3596. Construct a new XSSFGraphicFrame object.
  3597. @param Drawing the XSSFDrawing that owns this frame
  3598. @param ctGraphicFrame the XML bean that stores this frame content
  3599. </member>
  3600. <member name="M:NPOI.XSSF.UserModel.XSSFGraphicFrame.Prototype">
  3601. Initialize default structure of a new graphic frame
  3602. </member>
  3603. <member name="M:NPOI.XSSF.UserModel.XSSFGraphicFrame.SetMacro(System.String)">
  3604. Sets the frame macro.
  3605. </member>
  3606. <member name="M:NPOI.XSSF.UserModel.XSSFGraphicFrame.SetChart(NPOI.XSSF.UserModel.XSSFChart,System.String)">
  3607. Assign a DrawingML chart to the graphic frame.
  3608. </member>
  3609. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFGraphicFrame.AppendChartElement(NPOI.OpenXmlFormats.Dml.CT_GraphicalObjectData,System.String)" -->
  3610. <member name="P:NPOI.XSSF.UserModel.XSSFGraphicFrame.Name">
  3611. Returns the frame name.
  3612. @return name of the frame
  3613. </member>
  3614. <member name="P:NPOI.XSSF.UserModel.XSSFGraphicFrame.Anchor">
  3615. Returns the frame anchor.
  3616. @return the anchor this frame is attached to
  3617. </member>
  3618. <member name="P:NPOI.XSSF.UserModel.XSSFGraphicFrame.Id">
  3619. Gets the frame id.
  3620. </member>
  3621. <member name="T:NPOI.XSSF.UserModel.XSSFTextRun">
  3622. Represents a run of text within the Containing text body. The run element is the
  3623. lowest level text separation mechanism within a text body.
  3624. </member>
  3625. <member name="M:NPOI.XSSF.UserModel.XSSFTextRun.SetFont(System.String)">
  3626. Specifies the typeface, or name of the font that is to be used for this text Run.
  3627. @param typeface the font to apply to this text Run.
  3628. The value of <code>null</code> unsets the Typeface attribute from the underlying xml.
  3629. </member>
  3630. <member name="M:NPOI.XSSF.UserModel.XSSFTextRun.SetBaselineOffset(System.Double)">
  3631. Set the baseline for both the superscript and subscript fonts.
  3632. <p>
  3633. The size is specified using a percentage.
  3634. Positive values indicate superscript, negative values indicate subscript.
  3635. </p>
  3636. @param baselineOffset
  3637. </member>
  3638. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.FontSize">
  3639. @return font size in points or -1 if font size is not Set.
  3640. </member>
  3641. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.CharacterSpacing">
  3642. @return the spacing between characters within a text Run,
  3643. If this attribute is omitted then a value of 0 or no adjustment is assumed.
  3644. </member>
  3645. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.FontFamily">
  3646. @return font family or null if not Set
  3647. </member>
  3648. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.IsStrikethrough">
  3649. get or set whether a run of text will be formatted as strikethrough text. Default is false.
  3650. </member>
  3651. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.IsSuperscript">
  3652. get or set whether a run of text will be formatted as a superscript text. Default is false.
  3653. Default base line offset is 30%
  3654. </member>
  3655. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.IsSubscript">
  3656. get or set whether a run of text will be formatted as a superscript text. Default is false.
  3657. Default base line offset is -25%.
  3658. </member>
  3659. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.TextCap">
  3660. @return whether a run of text will be formatted as a superscript text. Default is false.
  3661. </member>
  3662. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.IsBold">
  3663. get or set whether this run of text is formatted as bold text
  3664. </member>
  3665. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.IsItalic">
  3666. get or set whether this run of text is formatted as italic text
  3667. </member>
  3668. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.IsUnderline">
  3669. get or set whether this run of text is formatted as underlined text
  3670. </member>
  3671. <member name="M:NPOI.XSSF.UserModel.XSSFLineBreak.SetText(System.String)">
  3672. Always . You cannot change text of a line break.
  3673. </member>
  3674. <member name="T:NPOI.XSSF.UserModel.XSSFMap">
  3675. This class : the Map element (Open Office XML Part 4:
  3676. chapter 3.16.2)
  3677. This element Contains all of the properties related to the XML map,
  3678. and the behaviors expected during data refresh operations.
  3679. @author Roberto Manicardi
  3680. </member>
  3681. <member name="M:NPOI.XSSF.UserModel.XSSFMap.GetRelatedSingleXMLCell">
  3682. @return the list of Single Xml Cells that provide a map rule to this mapping.
  3683. </member>
  3684. <member name="M:NPOI.XSSF.UserModel.XSSFMap.GetRelatedTables">
  3685. @return the list of all Tables that provide a map rule to this mapping
  3686. </member>
  3687. <member name="T:NPOI.XSSF.UserModel.XSSFName">
  3688. Represents a defined named range in a SpreadsheetML workbook.
  3689. <p>
  3690. Defined names are descriptive text that is used to represents a cell, range of cells, formula, or constant value.
  3691. Use easy-to-understand names, such as Products, to refer to hard to understand ranges, such as <code>Sales!C20:C30</code>.
  3692. </p>
  3693. Example:
  3694. <pre><blockquote>
  3695. XSSFWorkbook wb = new XSSFWorkbook();
  3696. XSSFSheet sh = wb.CreateSheet("Sheet1");
  3697. //applies to the entire workbook
  3698. XSSFName name1 = wb.CreateName();
  3699. name1.SetNameName("FMLA");
  3700. name1.SetRefersToFormula("Sheet1!$B$3");
  3701. //applies to Sheet1
  3702. XSSFName name2 = wb.CreateName();
  3703. name2.SetNameName("SheetLevelName");
  3704. name2.SetComment("This name is scoped to Sheet1");
  3705. name2.SetLocalSheetId(0);
  3706. name2.SetRefersToFormula("Sheet1!$B$3");
  3707. </blockquote></pre>
  3708. @author Nick Burch
  3709. @author Yegor Kozlov
  3710. </member>
  3711. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_PRINT_AREA">
  3712. A built-in defined name that specifies the workbook's print area
  3713. </member>
  3714. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_PRINT_TITLE">
  3715. A built-in defined name that specifies the row(s) or column(s) to repeat
  3716. at the top of each printed page.
  3717. </member>
  3718. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_CRITERIA">
  3719. A built-in defined name that refers to a range Containing the criteria values
  3720. to be used in Applying an advanced filter to a range of data
  3721. </member>
  3722. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_EXTRACT">
  3723. this defined name refers to the range Containing the filtered
  3724. output values resulting from Applying an advanced filter criteria to a source
  3725. range
  3726. </member>
  3727. <!-- Badly formed XML comment ignored for member "F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_FILTER_DB" -->
  3728. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_CONSOLIDATE_AREA">
  3729. A built-in defined name that refers to a consolidation area
  3730. </member>
  3731. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_DATABASE">
  3732. A built-in defined name that specified that the range specified is from a database data source
  3733. </member>
  3734. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_SHEET_TITLE">
  3735. A built-in defined name that refers to a sheet title.
  3736. </member>
  3737. <member name="M:NPOI.XSSF.UserModel.XSSFName.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_DefinedName,NPOI.XSSF.UserModel.XSSFWorkbook)">
  3738. Creates an XSSFName object - called internally by XSSFWorkbook.
  3739. @param name - the xml bean that holds data represenring this defined name.
  3740. @param workbook - the workbook object associated with the name
  3741. @see NPOI.XSSF.usermodel.XSSFWorkbook#CreateName()
  3742. </member>
  3743. <member name="M:NPOI.XSSF.UserModel.XSSFName.GetCTName">
  3744. Returns the underlying named range object
  3745. </member>
  3746. <member name="M:NPOI.XSSF.UserModel.XSSFName.Equals(System.Object)">
  3747. Compares this name to the specified object.
  3748. The result is <code>true</code> if the argument is XSSFName and the
  3749. underlying CTDefinedName bean Equals to the CTDefinedName representing this name
  3750. @param o the object to compare this <code>XSSFName</code> against.
  3751. @return <code>true</code> if the <code>XSSFName </code>are Equal;
  3752. <code>false</code> otherwise.
  3753. </member>
  3754. <member name="P:NPOI.XSSF.UserModel.XSSFName.NameName">
  3755. Returns the name that will appear in the user interface for the defined name.
  3756. @return text name of this defined name
  3757. </member>
  3758. <member name="P:NPOI.XSSF.UserModel.XSSFName.SheetIndex">
  3759. Returns the sheet index this name applies to.
  3760. @return the sheet index this name applies to, -1 if this name applies to the entire workbook
  3761. </member>
  3762. <member name="P:NPOI.XSSF.UserModel.XSSFName.Function">
  3763. Indicates that the defined name refers to a user-defined function.
  3764. This attribute is used when there is an Add-in or other code project associated with the file.
  3765. @return <code>true</code> indicates the name refers to a function.
  3766. </member>
  3767. <member name="P:NPOI.XSSF.UserModel.XSSFName.FunctionGroupId">
  3768. Returns the function group index if the defined name refers to a function. The function
  3769. group defines the general category for the function. This attribute is used when there is
  3770. an Add-in or other code project associated with the file.
  3771. @return the function group index that defines the general category for the function
  3772. </member>
  3773. <member name="P:NPOI.XSSF.UserModel.XSSFName.SheetName">
  3774. Get the sheets name which this named range is referenced to
  3775. @return sheet name, which this named range referred to.
  3776. Empty string if the referenced sheet name weas not found.
  3777. </member>
  3778. <member name="P:NPOI.XSSF.UserModel.XSSFName.IsFunctionName">
  3779. Is the name refers to a user-defined function ?
  3780. @return <code>true</code> if this name refers to a user-defined function
  3781. </member>
  3782. <member name="P:NPOI.XSSF.UserModel.XSSFName.Comment">
  3783. Returns the comment the user provided when the name was Created.
  3784. @return the user comment for this named range
  3785. </member>
  3786. <member name="T:NPOI.XSSF.UserModel.XSSFHyperlink">
  3787. XSSF Implementation of a Hyperlink.
  3788. Note - unlike with HSSF, many kinds of hyperlink
  3789. are largely stored as relations of the sheet
  3790. </member>
  3791. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.#ctor(NPOI.SS.UserModel.HyperlinkType)">
  3792. Create a new XSSFHyperlink. This method is protected to be used only by XSSFCreationHelper
  3793. @param type - the type of hyperlink to create
  3794. </member>
  3795. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Hyperlink,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  3796. Create a XSSFHyperlink amd Initialize it from the supplied CTHyperlink bean and namespace relationship
  3797. @param ctHyperlink the xml bean Containing xml properties
  3798. @param hyperlinkRel the relationship in the underlying OPC namespace which stores the actual link's Address
  3799. </member>
  3800. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.GetCTHyperlink">
  3801. @return the underlying CTHyperlink object
  3802. </member>
  3803. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.NeedsRelationToo">
  3804. Do we need to a relation too, to represent
  3805. this hyperlink?
  3806. </member>
  3807. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.GenerateRelationIfNeeded(NPOI.OpenXml4Net.OPC.PackagePart)">
  3808. Generates the relation if required
  3809. </member>
  3810. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.GetCellRef">
  3811. Get the reference of the cell this applies to,
  3812. es A55
  3813. </member>
  3814. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.SetCellReference(System.String)">
  3815. Assigns this hyperlink to the given cell reference
  3816. </member>
  3817. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Type">
  3818. Return the type of this hyperlink
  3819. @return the type of this hyperlink
  3820. </member>
  3821. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Address">
  3822. Hyperlink Address. Depending on the hyperlink type it can be URL, e-mail, path to a file
  3823. @return the Address of this hyperlink
  3824. </member>
  3825. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Label">
  3826. Return text label for this hyperlink
  3827. @return text to display
  3828. </member>
  3829. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Location">
  3830. Location within target. If target is a workbook (or this workbook) this shall refer to a
  3831. sheet and cell or a defined name. Can also be an HTML anchor if target is HTML file.
  3832. @return location
  3833. </member>
  3834. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.FirstColumn">
  3835. Return the column of the first cell that Contains the hyperlink
  3836. @return the 0-based column of the first cell that Contains the hyperlink
  3837. </member>
  3838. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.LastColumn">
  3839. Return the column of the last cell that Contains the hyperlink
  3840. For XSSF, a Hyperlink may only reference one cell
  3841. @return the 0-based column of the last cell that Contains the hyperlink
  3842. </member>
  3843. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.FirstRow">
  3844. Return the row of the first cell that Contains the hyperlink
  3845. @return the 0-based row of the cell that Contains the hyperlink
  3846. </member>
  3847. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.LastRow">
  3848. Return the row of the last cell that Contains the hyperlink
  3849. For XSSF, a Hyperlink may only reference one cell
  3850. @return the 0-based row of the last cell that Contains the hyperlink
  3851. </member>
  3852. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Tooltip">
  3853. <summary>
  3854. get or set additional text to help the user understand more about the hyperlink
  3855. </summary>
  3856. </member>
  3857. <member name="T:NPOI.XSSF.UserModel.XSSFOddFooter">
  3858. Odd page footer value. Corresponds to odd printed pages.
  3859. Odd page(s) in the sheet may not be printed, for example, if the print area is specified to be
  3860. a range such that it falls outside an odd page's scope.
  3861. </member>
  3862. <member name="M:NPOI.XSSF.UserModel.XSSFOddFooter.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  3863. Create an instance of XSSFOddFooter from the supplied XML bean
  3864. @see XSSFSheet#GetOddFooter()
  3865. @param headerFooter
  3866. </member>
  3867. <member name="P:NPOI.XSSF.UserModel.XSSFOddFooter.Text">
  3868. Get the content text representing the footer
  3869. @return text
  3870. </member>
  3871. <member name="T:NPOI.XSSF.UserModel.XSSFOddHeader">
  3872. Odd page header value. Corresponds to odd printed pages.
  3873. Odd page(s) in the sheet may not be printed, for example, if the print area is specified to be
  3874. a range such that it falls outside an odd page's scope.
  3875. </member>
  3876. <member name="M:NPOI.XSSF.UserModel.XSSFOddHeader.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  3877. Create an instance of XSSFOddHeader from the supplied XML bean
  3878. @see XSSFSheet#GetOddHeader()
  3879. @param headerFooter
  3880. </member>
  3881. <member name="P:NPOI.XSSF.UserModel.XSSFOddHeader.Text">
  3882. Get the content text representing this header
  3883. @return text
  3884. </member>
  3885. <member name="T:NPOI.XSSF.UserModel.XSSFPatternFormatting">
  3886. @author Yegor Kozlov
  3887. </member>
  3888. <member name="T:NPOI.XSSF.UserModel.XSSFPicture">
  3889. Represents a picture shape in a SpreadsheetML Drawing.
  3890. @author Yegor Kozlov
  3891. </member>
  3892. <member name="F:NPOI.XSSF.UserModel.XSSFPicture.prototype">
  3893. A default instance of CTShape used for creating new shapes.
  3894. </member>
  3895. <member name="F:NPOI.XSSF.UserModel.XSSFPicture.ctPicture">
  3896. This object specifies a picture object and all its properties
  3897. </member>
  3898. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Picture)">
  3899. Construct a new XSSFPicture object. This constructor is called from
  3900. {@link XSSFDrawing#CreatePicture(XSSFClientAnchor, int)}
  3901. @param Drawing the XSSFDrawing that owns this picture
  3902. </member>
  3903. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,System.Xml.XmlNode)">
  3904. Returns a prototype that is used to construct new shapes
  3905. @return a prototype that is used to construct new shapes
  3906. </member>
  3907. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.SetPictureReference(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  3908. Link this shape with the picture data
  3909. @param rel relationship referring the picture data
  3910. </member>
  3911. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetCTPicture">
  3912. Return the underlying CT_Picture bean that holds all properties for this picture
  3913. @return the underlying CT_Picture bean
  3914. </member>
  3915. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.Resize">
  3916. Reset the image to the original size.
  3917. <p>
  3918. Please note, that this method works correctly only for workbooks
  3919. with the default font size (Calibri 11pt for .xlsx).
  3920. If the default font is Changed the resized image can be streched vertically or horizontally.
  3921. </p>
  3922. </member>
  3923. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.Resize(System.Double)">
  3924. Resize the image proportionally.
  3925. @see #resize(double, double)
  3926. </member>
  3927. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.Resize(System.Double,System.Double)">
  3928. Resize the image relatively to its current size.
  3929. <p>
  3930. Please note, that this method works correctly only for workbooks
  3931. with the default font size (Calibri 11pt for .xlsx).
  3932. If the default font is changed the resized image can be streched vertically or horizontally.
  3933. </p>
  3934. <p>
  3935. <code>resize(1.0,1.0)</code> keeps the original size,<br/>
  3936. <code>resize(0.5,0.5)</code> resize to 50% of the original,<br/>
  3937. <code>resize(2.0,2.0)</code> resizes to 200% of the original.<br/>
  3938. <code>resize({@link Double#MAX_VALUE},{@link Double#MAX_VALUE})</code> resizes to the dimension of the embedded image.
  3939. </p>
  3940. @param scaleX the amount by which the image width is multiplied relative to the original width,
  3941. when set to {@link java.lang.Double#MAX_VALUE} the width of the embedded image is used
  3942. @param scaleY the amount by which the image height is multiplied relative to the original height,
  3943. when set to {@link java.lang.Double#MAX_VALUE} the height of the embedded image is used
  3944. </member>
  3945. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetPreferredSize">
  3946. Calculate the preferred size for this picture.
  3947. @return XSSFClientAnchor with the preferred size for this image
  3948. </member>
  3949. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetPreferredSize(System.Double)">
  3950. Calculate the preferred size for this picture.
  3951. @param scale the amount by which image dimensions are multiplied relative to the original size.
  3952. @return XSSFClientAnchor with the preferred size for this image
  3953. </member>
  3954. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetPreferredSize(System.Double,System.Double)">
  3955. Calculate the preferred size for this picture.
  3956. @param scaleX the amount by which image width is multiplied relative to the original width.
  3957. @param scaleY the amount by which image height is multiplied relative to the original height.
  3958. @return XSSFClientAnchor with the preferred size for this image
  3959. </member>
  3960. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetImageDimension(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.SS.UserModel.PictureType)">
  3961. Return the dimension of this image
  3962. @param part the namespace part holding raw picture data
  3963. @param type type of the picture: {@link Workbook#PICTURE_TYPE_JPEG},
  3964. {@link Workbook#PICTURE_TYPE_PNG} or {@link Workbook#PICTURE_TYPE_DIB}
  3965. @return image dimension in pixels
  3966. </member>
  3967. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetImageDimension">
  3968. Return the dimension of the embedded image in pixel
  3969. @return image dimension in pixels
  3970. </member>
  3971. <member name="P:NPOI.XSSF.UserModel.XSSFPicture.ClientAnchor">
  3972. @return the anchor that is used by this shape.
  3973. </member>
  3974. <member name="P:NPOI.XSSF.UserModel.XSSFPicture.Sheet">
  3975. @return the sheet which contains the picture shape
  3976. </member>
  3977. <member name="T:NPOI.XSSF.UserModel.XSSFPictureData">
  3978. Raw picture data, normally attached to a SpreadsheetML Drawing.
  3979. As a rule, pictures are stored in the /xl/media/ part of a SpreadsheetML package.
  3980. </member>
  3981. <member name="F:NPOI.XSSF.UserModel.XSSFPictureData.RELATIONS">
  3982. Relationships for each known picture type
  3983. </member>
  3984. <member name="M:NPOI.XSSF.UserModel.XSSFPictureData.#ctor">
  3985. Create a new XSSFPictureData node
  3986. @see NPOI.xssf.usermodel.XSSFWorkbook#AddPicture(byte[], int)
  3987. </member>
  3988. <member name="M:NPOI.XSSF.UserModel.XSSFPictureData.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  3989. Construct XSSFPictureData from a namespace part
  3990. @param part the namespace part holding the Drawing data,
  3991. @param rel the namespace relationship holding this Drawing,
  3992. the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/image
  3993. </member>
  3994. <member name="M:NPOI.XSSF.UserModel.XSSFPictureData.SuggestFileExtension">
  3995. Suggests a file extension for this image.
  3996. @return the file extension.
  3997. </member>
  3998. <member name="M:NPOI.XSSF.UserModel.XSSFPictureData.PrepareForCommit">
  3999. *PictureData objects store the actual content in the part directly without keeping a
  4000. copy like all others therefore we need to handle them differently.
  4001. </member>
  4002. <member name="P:NPOI.XSSF.UserModel.XSSFPictureData.PictureType">
  4003. Return an integer constant that specifies type of this picture
  4004. @return an integer constant that specifies type of this picture
  4005. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_EMF
  4006. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_WMF
  4007. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_PICT
  4008. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_JPEG
  4009. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_PNG
  4010. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_DIB
  4011. </member>
  4012. <member name="P:NPOI.XSSF.UserModel.XSSFPictureData.Data">
  4013. <summary>
  4014. Gets the picture data as a byte array.
  4015. </summary>
  4016. </member>
  4017. <member name="T:NPOI.XSSF.UserModel.XSSFPrintSetup">
  4018. Page Setup and page margins Settings for the worksheet.
  4019. </member>
  4020. <member name="M:NPOI.XSSF.UserModel.XSSFPrintSetup.SetPaperSize(NPOI.SS.UserModel.PaperSize)">
  4021. Set the paper size as enum value.
  4022. @param size value for the paper size.
  4023. </member>
  4024. <member name="M:NPOI.XSSF.UserModel.XSSFPrintSetup.GetPaperSizeEnum">
  4025. Returns the paper size as enum.
  4026. @return PaperSize paper size
  4027. @see PaperSize
  4028. </member>
  4029. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Orientation">
  4030. Orientation of the page: landscape - portrait.
  4031. @return Orientation of the page
  4032. @see PrintOrientation
  4033. </member>
  4034. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.PageOrder">
  4035. Get print page order.
  4036. @return PageOrder
  4037. </member>
  4038. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.PaperSize">
  4039. Returns the paper size.
  4040. @return short - paper size
  4041. </member>
  4042. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Scale">
  4043. Returns the scale.
  4044. @return short - scale
  4045. </member>
  4046. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.PageStart">
  4047. Set the page numbering start.
  4048. Page number for first printed page. If no value is specified, then 'automatic' is assumed.
  4049. @return page number for first printed page
  4050. </member>
  4051. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.FitWidth">
  4052. Returns the number of pages wide to fit sheet in.
  4053. @return number of pages wide to fit sheet in
  4054. </member>
  4055. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.FitHeight">
  4056. Returns the number of pages high to fit the sheet in.
  4057. @return number of pages high to fit the sheet in
  4058. </member>
  4059. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.LeftToRight">
  4060. Returns the left to right print order.
  4061. @return left to right print order
  4062. </member>
  4063. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Landscape">
  4064. Returns the landscape mode.
  4065. @return landscape mode
  4066. </member>
  4067. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.ValidSettings">
  4068. Use the printer's defaults Settings for page Setup values and don't use the default values
  4069. specified in the schema. For example, if dpi is not present or specified in the XML, the
  4070. application shall not assume 600dpi as specified in the schema as a default and instead
  4071. shall let the printer specify the default dpi.
  4072. @return valid Settings
  4073. </member>
  4074. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.NoColor">
  4075. Returns the black and white Setting.
  4076. @return black and white Setting
  4077. </member>
  4078. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Draft">
  4079. Returns the draft mode.
  4080. @return draft mode
  4081. </member>
  4082. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Notes">
  4083. Returns the print notes.
  4084. @return print notes
  4085. </member>
  4086. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.NoOrientation">
  4087. Returns the no orientation.
  4088. @return no orientation
  4089. </member>
  4090. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.UsePage">
  4091. Returns the use page numbers.
  4092. @return use page numbers
  4093. </member>
  4094. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.HResolution">
  4095. Returns the horizontal resolution.
  4096. @return horizontal resolution
  4097. </member>
  4098. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.VResolution">
  4099. Returns the vertical resolution.
  4100. @return vertical resolution
  4101. </member>
  4102. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.HeaderMargin">
  4103. Returns the header margin.
  4104. @return header margin
  4105. </member>
  4106. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.FooterMargin">
  4107. Returns the footer margin.
  4108. @return footer margin
  4109. </member>
  4110. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Copies">
  4111. Returns the number of copies.
  4112. @return number of copies
  4113. </member>
  4114. <member name="T:NPOI.XSSF.UserModel.XSSFRelation">
  4115. </member>
  4116. <member name="F:NPOI.XSSF.UserModel.XSSFRelation._table">
  4117. A map to lookup POIXMLRelation by its relation type
  4118. </member>
  4119. <member name="M:NPOI.XSSF.UserModel.XSSFRelation.GetContents(NPOI.OpenXml4Net.OPC.PackagePart)">
  4120. Fetches the InputStream to read the contents, based
  4121. of the specified core part, for which we are defined
  4122. as a suitable relationship
  4123. </member>
  4124. <member name="M:NPOI.XSSF.UserModel.XSSFRelation.GetInstance(System.String)">
  4125. Get POIXMLRelation by relation type
  4126. @param rel relation type, for example,
  4127. <code>http://schemas.openxmlformats.org/officeDocument/2006/relationships/image</code>
  4128. @return registered POIXMLRelation or null if not found
  4129. </member>
  4130. <member name="M:NPOI.XSSF.UserModel.XSSFRelation.RemoveRelation(NPOI.XSSF.UserModel.XSSFRelation)">
  4131. <summary>
  4132. Removes the relation from the internal table.
  4133. Following readings of files will ignoring the removed relation.
  4134. </summary>
  4135. <param name="relation">Relation to remove</param>
  4136. </member>
  4137. <member name="M:NPOI.XSSF.UserModel.XSSFRelation.AddRelation(NPOI.XSSF.UserModel.XSSFRelation)">
  4138. <summary>
  4139. Adds the relation to the internal table.
  4140. Following readings of files will process the given relation.
  4141. </summary>
  4142. <param name="relation">Relation to add</param>
  4143. </member>
  4144. <member name="T:NPOI.XSSF.UserModel.XSSFRichTextString">
  4145. Rich text unicode string. These strings can have fonts applied to arbitary parts of the string.
  4146. <p>
  4147. Most strings in a workbook have formatting applied at the cell level, that is, the entire string in the cell has the
  4148. same formatting applied. In these cases, the formatting for the cell is stored in the styles part,
  4149. and the string for the cell can be shared across the workbook. The following code illustrates the example.
  4150. </p>
  4151. <blockquote>
  4152. <pre>
  4153. cell1.SetCellValue(new XSSFRichTextString("Apache POI"));
  4154. cell2.SetCellValue(new XSSFRichTextString("Apache POI"));
  4155. cell3.SetCellValue(new XSSFRichTextString("Apache POI"));
  4156. </pre>
  4157. </blockquote>
  4158. In the above example all three cells will use the same string cached on workbook level.
  4159. <p>
  4160. Some strings in the workbook may have formatting applied at a level that is more granular than the cell level.
  4161. For instance, specific characters within the string may be bolded, have coloring, italicizing, etc.
  4162. In these cases, the formatting is stored along with the text in the string table, and is treated as
  4163. a unique entry in the workbook. The following xml and code snippet illustrate this.
  4164. </p>
  4165. <blockquote>
  4166. <pre>
  4167. XSSFRichTextString s1 = new XSSFRichTextString("Apache POI");
  4168. s1.ApplyFont(boldArial);
  4169. cell1.SetCellValue(s1);
  4170. XSSFRichTextString s2 = new XSSFRichTextString("Apache POI");
  4171. s2.ApplyFont(italicCourier);
  4172. cell2.SetCellValue(s2);
  4173. </pre>
  4174. </blockquote>
  4175. @author Yegor Kozlov
  4176. </member>
  4177. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.#ctor(System.String)">
  4178. Create a rich text string
  4179. </member>
  4180. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.#ctor">
  4181. Create empty rich text string and Initialize it with empty string
  4182. </member>
  4183. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Rst)">
  4184. Create a rich text string from the supplied XML bean
  4185. </member>
  4186. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ApplyFont(System.Int32,System.Int32,System.Int16)">
  4187. Applies a font to the specified characters of a string.
  4188. @param startIndex The start index to apply the font to (inclusive)
  4189. @param endIndex The end index to apply the font to (exclusive)
  4190. @param fontIndex The font to use.
  4191. </member>
  4192. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ApplyFont(System.Int32,System.Int32,NPOI.SS.UserModel.IFont)">
  4193. Applies a font to the specified characters of a string.
  4194. @param startIndex The start index to apply the font to (inclusive)
  4195. @param endIndex The end index to apply to font to (exclusive)
  4196. @param font The index of the font to use.
  4197. </member>
  4198. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ApplyFont(NPOI.SS.UserModel.IFont)">
  4199. Sets the font of the entire string.
  4200. @param font The font to use.
  4201. </member>
  4202. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ApplyFont(System.Int16)">
  4203. Applies the specified font to the entire string.
  4204. @param fontIndex the font to Apply.
  4205. </member>
  4206. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.Append(System.String,NPOI.XSSF.UserModel.XSSFFont)">
  4207. Append new text to this text run and apply the specify font to it
  4208. @param text the text to append
  4209. @param font the font to apply to the Appended text or <code>null</code> if no formatting is required
  4210. </member>
  4211. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.Append(System.String)">
  4212. Append new text to this text run
  4213. @param text the text to append
  4214. </member>
  4215. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.SetRunAttributes(NPOI.OpenXmlFormats.Spreadsheet.CT_Font,NPOI.OpenXmlFormats.Spreadsheet.CT_RPrElt)">
  4216. Copy font attributes from CTFont bean into CTRPrElt bean
  4217. </member>
  4218. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ClearFormatting">
  4219. Removes any formatting that may have been applied to the string.
  4220. </member>
  4221. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetIndexOfFormattingRun(System.Int32)">
  4222. The index within the string to which the specified formatting run applies.
  4223. @param index the index of the formatting run
  4224. @return the index within the string.
  4225. </member>
  4226. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetLengthOfFormattingRun(System.Int32)">
  4227. Returns the number of characters this format run covers.
  4228. @param index the index of the formatting run
  4229. @return the number of characters this format run covers
  4230. </member>
  4231. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ToString">
  4232. Returns the plain string representation.
  4233. </member>
  4234. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetFontOfFormattingRun(System.Int32)">
  4235. Gets a copy of the font used in a particular formatting Run.
  4236. @param index the index of the formatting run
  4237. @return A copy of the font used or null if no formatting is applied to the specified text Run.
  4238. </member>
  4239. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetFontAtIndex(System.Int32)">
  4240. Return a copy of the font in use at a particular index.
  4241. @param index The index.
  4242. @return A copy of the font that's currently being applied at that
  4243. index or null if no font is being applied or the
  4244. index is out of range.
  4245. </member>
  4246. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetCTRst">
  4247. Return the underlying xml bean
  4248. </member>
  4249. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ToCTFont(NPOI.OpenXmlFormats.Spreadsheet.CT_RPrElt)">
  4250. CTRPrElt --> CTFont adapter
  4251. </member>
  4252. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.PreserveSpaces(System.String)">
  4253. **
  4254. </member>
  4255. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.UtfDecode(System.String)">
  4256. For all characters which cannot be represented in XML as defined by the XML 1.0 specification,
  4257. the characters are escaped using the Unicode numerical character representation escape character
  4258. format _xHHHH_, where H represents a hexadecimal character in the character's value.
  4259. <p>
  4260. Example: The Unicode character 0D is invalid in an XML 1.0 document,
  4261. so it shall be escaped as <code>_x000D_</code>.
  4262. </p>
  4263. See section 3.18.9 in the OOXML spec.
  4264. @param value the string to decode
  4265. @return the decoded string
  4266. </member>
  4267. <member name="P:NPOI.XSSF.UserModel.XSSFRichTextString.Length">
  4268. Returns the number of characters in this string.
  4269. </member>
  4270. <member name="P:NPOI.XSSF.UserModel.XSSFRichTextString.NumFormattingRuns">
  4271. @return The number of formatting Runs used.
  4272. </member>
  4273. <member name="T:NPOI.XSSF.UserModel.XSSFRow">
  4274. High level representation of a row of a spreadsheet.
  4275. </member>
  4276. <member name="F:NPOI.XSSF.UserModel.XSSFRow._row">
  4277. the xml bean Containing all cell defInitions for this row
  4278. </member>
  4279. <member name="F:NPOI.XSSF.UserModel.XSSFRow._cells">
  4280. Cells of this row keyed by their column indexes.
  4281. The TreeMap ensures that the cells are ordered by columnIndex in the ascending order.
  4282. </member>
  4283. <member name="F:NPOI.XSSF.UserModel.XSSFRow._sheet">
  4284. the parent sheet
  4285. </member>
  4286. <member name="M:NPOI.XSSF.UserModel.XSSFRow.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Row,NPOI.XSSF.UserModel.XSSFSheet)">
  4287. Construct a XSSFRow.
  4288. @param row the xml bean Containing all cell defInitions for this row.
  4289. @param sheet the parent sheet.
  4290. </member>
  4291. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFRow.CellIterator" -->
  4292. <member name="M:NPOI.XSSF.UserModel.XSSFRow.GetEnumerator">
  4293. Alias for {@link #cellIterator()} to allow foreach loops:
  4294. <blockquote><pre>
  4295. for(Cell cell : row){
  4296. ...
  4297. }
  4298. </pre></blockquote>
  4299. @return an iterator over cells in this row.
  4300. </member>
  4301. <member name="M:NPOI.XSSF.UserModel.XSSFRow.CompareTo(NPOI.XSSF.UserModel.XSSFRow)">
  4302. Compares two <code>XSSFRow</code> objects. Two rows are equal if they belong to the same worksheet and
  4303. their row indexes are Equal.
  4304. @param row the <code>XSSFRow</code> to be Compared.
  4305. @return the value <code>0</code> if the row number of this <code>XSSFRow</code> is
  4306. equal to the row number of the argument <code>XSSFRow</code>; a value less than
  4307. <code>0</code> if the row number of this this <code>XSSFRow</code> is numerically less
  4308. than the row number of the argument <code>XSSFRow</code>; and a value greater
  4309. than <code>0</code> if the row number of this this <code>XSSFRow</code> is numerically
  4310. greater than the row number of the argument <code>XSSFRow</code>.
  4311. @throws ArgumentException if the argument row belongs to a different worksheet
  4312. </member>
  4313. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFRow.CreateCell(System.Int32)" -->
  4314. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFRow.CreateCell(System.Int32,NPOI.SS.UserModel.CellType)" -->
  4315. <member name="M:NPOI.XSSF.UserModel.XSSFRow.GetCell(System.Int32)">
  4316. Returns the cell at the given (0 based) index,
  4317. with the {@link NPOI.SS.usermodel.Row.MissingCellPolicy} from the parent Workbook.
  4318. @return the cell at the given (0 based) index
  4319. </member>
  4320. <member name="M:NPOI.XSSF.UserModel.XSSFRow.RetrieveCell(System.Int32)">
  4321. <summary>
  4322. Get the hssfcell representing a given column (logical cell)
  4323. 0-based. If you ask for a cell that is not defined, then
  4324. you Get a null.
  4325. This is the basic call, with no policies applied
  4326. </summary>
  4327. <param name="cellnum">0 based column number</param>
  4328. <returns>Cell representing that column or null if Undefined.</returns>
  4329. </member>
  4330. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFRow.GetCell(System.Int32,NPOI.SS.UserModel.MissingCellPolicy)" -->
  4331. <member name="M:NPOI.XSSF.UserModel.XSSFRow.SetRowStyle(NPOI.SS.UserModel.ICellStyle)">
  4332. Applies a whole-row cell styling to the row.
  4333. If the value is null then the style information is Removed,
  4334. causing the cell to used the default workbook style.
  4335. </member>
  4336. <member name="M:NPOI.XSSF.UserModel.XSSFRow.RemoveCell(NPOI.SS.UserModel.ICell)">
  4337. Remove the Cell from this row.
  4338. @param cell the cell to remove
  4339. </member>
  4340. <member name="M:NPOI.XSSF.UserModel.XSSFRow.GetCTRow">
  4341. Returns the underlying CT_Row xml bean Containing all cell defInitions in this row
  4342. @return the underlying CT_Row xml bean
  4343. </member>
  4344. <member name="M:NPOI.XSSF.UserModel.XSSFRow.OnDocumentWrite">
  4345. Fired when the document is written to an output stream.
  4346. @see NPOI.XSSF.usermodel.XSSFSheet#Write(java.io.OutputStream) ()
  4347. </member>
  4348. <member name="M:NPOI.XSSF.UserModel.XSSFRow.ToString">
  4349. @return formatted xml representation of this row
  4350. </member>
  4351. <member name="M:NPOI.XSSF.UserModel.XSSFRow.Shift(System.Int32)">
  4352. update cell references when Shifting rows
  4353. @param n the number of rows to move
  4354. </member>
  4355. <member name="P:NPOI.XSSF.UserModel.XSSFRow.Sheet">
  4356. Returns the XSSFSheet this row belongs to
  4357. @return the XSSFSheet that owns this row
  4358. </member>
  4359. <member name="P:NPOI.XSSF.UserModel.XSSFRow.FirstCellNum">
  4360. Get the number of the first cell Contained in this row.
  4361. @return short representing the first logical cell in the row,
  4362. or -1 if the row does not contain any cells.
  4363. </member>
  4364. <member name="P:NPOI.XSSF.UserModel.XSSFRow.LastCellNum">
  4365. Gets the index of the last cell Contained in this row <b>PLUS ONE</b>. The result also
  4366. happens to be the 1-based column number of the last cell. This value can be used as a
  4367. standard upper bound when iterating over cells:
  4368. <pre>
  4369. short minColIx = row.GetFirstCellNum();
  4370. short maxColIx = row.GetLastCellNum();
  4371. for(short colIx=minColIx; colIx&lt;maxColIx; colIx++) {
  4372. XSSFCell cell = row.GetCell(colIx);
  4373. if(cell == null) {
  4374. continue;
  4375. }
  4376. //... do something with cell
  4377. }
  4378. </pre>
  4379. @return short representing the last logical cell in the row <b>PLUS ONE</b>,
  4380. or -1 if the row does not contain any cells.
  4381. </member>
  4382. <member name="P:NPOI.XSSF.UserModel.XSSFRow.Height">
  4383. 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,
  4384. See {@link NPOI.XSSF.usermodel.XSSFSheet#GetDefaultRowHeightInPoints()}
  4385. @return row height measured in twips (1/20th of a point)
  4386. </member>
  4387. <member name="P:NPOI.XSSF.UserModel.XSSFRow.HeightInPoints">
  4388. Returns row height measured in point size. If the height is not Set, the default worksheet value is returned,
  4389. See {@link NPOI.XSSF.usermodel.XSSFSheet#GetDefaultRowHeightInPoints()}
  4390. @return row height measured in point size
  4391. @see NPOI.XSSF.usermodel.XSSFSheet#GetDefaultRowHeightInPoints()
  4392. </member>
  4393. <member name="P:NPOI.XSSF.UserModel.XSSFRow.PhysicalNumberOfCells">
  4394. Gets the number of defined cells (NOT number of cells in the actual row!).
  4395. That is to say if only columns 0,4,5 have values then there would be 3.
  4396. @return int representing the number of defined cells in the row.
  4397. </member>
  4398. <member name="P:NPOI.XSSF.UserModel.XSSFRow.RowNum">
  4399. Get row number this row represents
  4400. @return the row number (0 based)
  4401. </member>
  4402. <member name="P:NPOI.XSSF.UserModel.XSSFRow.ZeroHeight">
  4403. Get whether or not to display this row with 0 height
  4404. @return - height is zero or not.
  4405. </member>
  4406. <member name="P:NPOI.XSSF.UserModel.XSSFRow.IsFormatted">
  4407. Is this row formatted? Most aren't, but some rows
  4408. do have whole-row styles. For those that do, you
  4409. can get the formatting from {@link #GetRowStyle()}
  4410. </member>
  4411. <member name="P:NPOI.XSSF.UserModel.XSSFRow.RowStyle">
  4412. Returns the whole-row cell style. Most rows won't
  4413. have one of these, so will return null. Call
  4414. {@link #isFormatted()} to check first.
  4415. </member>
  4416. <member name="T:NPOI.XSSF.UserModel.XSSFShapeGroup">
  4417. This object specifies a group shape that represents many shapes grouped together. This shape is to be treated
  4418. just as if it were a regular shape but instead of being described by a single geometry it is made up of all the
  4419. shape geometries encompassed within it. Within a group shape each of the shapes that make up the group are
  4420. specified just as they normally would.
  4421. @author Yegor Kozlov
  4422. </member>
  4423. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_GroupShape)">
  4424. Construct a new XSSFSimpleShape object.
  4425. @param Drawing the XSSFDrawing that owns this shape
  4426. @param ctGroup the XML bean that stores this group content
  4427. </member>
  4428. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.Prototype">
  4429. Initialize default structure of a new shape group
  4430. </member>
  4431. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.CreateTextbox(NPOI.XSSF.UserModel.XSSFChildAnchor)">
  4432. Constructs a textbox.
  4433. @param anchor the child anchor describes how this shape is attached
  4434. to the group.
  4435. @return the newly Created textbox.
  4436. </member>
  4437. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.CreateSimpleShape(NPOI.XSSF.UserModel.XSSFChildAnchor)">
  4438. Creates a simple shape. This includes such shapes as lines, rectangles,
  4439. and ovals.
  4440. @param anchor the child anchor describes how this shape is attached
  4441. to the group.
  4442. @return the newly Created shape.
  4443. </member>
  4444. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.CreateConnector(NPOI.XSSF.UserModel.XSSFChildAnchor)">
  4445. Creates a simple shape. This includes such shapes as lines, rectangles,
  4446. and ovals.
  4447. @param anchor the child anchor describes how this shape is attached
  4448. to the group.
  4449. @return the newly Created shape.
  4450. </member>
  4451. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.CreatePicture(NPOI.XSSF.UserModel.XSSFClientAnchor,System.Int32)">
  4452. Creates a picture.
  4453. @param anchor the client anchor describes how this picture is attached to the sheet.
  4454. @param pictureIndex the index of the picture in the workbook collection of pictures,
  4455. {@link XSSFWorkbook#getAllPictures()} .
  4456. @return the newly Created picture shape.
  4457. </member>
  4458. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.SetCoordinates(System.Int32,System.Int32,System.Int32,System.Int32)">
  4459. Sets the coordinate space of this group. All children are constrained
  4460. to these coordinates.
  4461. </member>
  4462. <member name="T:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting">
  4463. @author Yegor Kozlov
  4464. </member>
  4465. <member name="M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.ComparisonOperator,System.String,System.String)">
  4466. A factory method allowing to create a conditional formatting rule
  4467. with a cell comparison operator<p/>
  4468. TODO - formulas Containing cell references are currently not Parsed properly
  4469. @param comparisonOperation - a constant value from
  4470. <tt>{@link NPOI.hssf.record.CFRuleRecord.ComparisonOperator}</tt>: <p>
  4471. <ul>
  4472. <li>BETWEEN</li>
  4473. <li>NOT_BETWEEN</li>
  4474. <li>EQUAL</li>
  4475. <li>NOT_EQUAL</li>
  4476. <li>GT</li>
  4477. <li>LT</li>
  4478. <li>GE</li>
  4479. <li>LE</li>
  4480. </ul>
  4481. </p>
  4482. @param formula1 - formula for the valued, Compared with the cell
  4483. @param formula2 - second formula (only used with
  4484. {@link NPOI.ss.usermodel.ComparisonOperator#BETWEEN}) and
  4485. {@link NPOI.ss.usermodel.ComparisonOperator#NOT_BETWEEN} operations)
  4486. </member>
  4487. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.CreateConditionalFormattingRule(System.String)" -->
  4488. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.UserModel.IConditionalFormatting)" -->
  4489. <member name="M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.GetConditionalFormattingAt(System.Int32)">
  4490. Gets Conditional Formatting object at a particular index
  4491. @param index
  4492. of the Conditional Formatting object to fetch
  4493. @return Conditional Formatting object
  4494. </member>
  4495. <member name="M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.RemoveConditionalFormatting(System.Int32)">
  4496. Removes a Conditional Formatting object by index
  4497. @param index of a Conditional Formatting object to remove
  4498. </member>
  4499. <member name="P:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.NumConditionalFormattings">
  4500. @return number of Conditional Formatting objects of the sheet
  4501. </member>
  4502. <member name="T:NPOI.XSSF.UserModel.XSSFSimpleShape">
  4503. Represents a shape with a predefined geometry in a SpreadsheetML Drawing.
  4504. Possible shape types are defined in {@link NPOI.SS.UserModel.ShapeTypes}
  4505. </member>
  4506. <member name="F:NPOI.XSSF.UserModel.XSSFSimpleShape._paragraphs">
  4507. List of the paragraphs that make up the text in this shape
  4508. </member>
  4509. <member name="F:NPOI.XSSF.UserModel.XSSFSimpleShape.prototype">
  4510. A default instance of CTShape used for creating new shapes.
  4511. </member>
  4512. <member name="F:NPOI.XSSF.UserModel.XSSFSimpleShape.ctShape">
  4513. Xml bean that stores properties of this shape
  4514. </member>
  4515. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.GetPrototype">
  4516. Prototype with the default structure of a new auto-shape.
  4517. </member>
  4518. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.ProcessAutoNumGroup(System.Int32,System.Int32,System.Collections.Generic.List{System.Int32},System.Text.StringBuilder)">
  4519. </member>
  4520. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.GetBulletPrefix(NPOI.XSSF.UserModel.ListAutoNumber,System.Int32)">
  4521. Returns a string Containing an appropriate prefix for an auto-numbering bullet
  4522. @param scheme the auto-numbering scheme used by the bullet
  4523. @param value the value of the bullet
  4524. @return appropriate prefix for an auto-numbering bullet
  4525. </member>
  4526. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.valueToAlpha(System.Int32)">
  4527. Convert an integer to its alpha equivalent e.g. 1 = A, 2 = B, 27 = AA etc
  4528. </member>
  4529. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.valueToRoman(System.Int32)">
  4530. Convert an integer to its roman equivalent e.g. 1 = I, 9 = IX etc
  4531. </member>
  4532. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.ClearText">
  4533. Clear all text from this shape
  4534. </member>
  4535. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.SetText(System.String)">
  4536. Set a single paragraph of text on the shape. Note this will replace all existing paragraphs Created on the shape.
  4537. @param text string representing the paragraph text
  4538. </member>
  4539. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.SetText(NPOI.XSSF.UserModel.XSSFRichTextString)">
  4540. Set a single paragraph of text on the shape. Note this will replace all existing paragraphs Created on the shape.
  4541. @param str rich text string representing the paragraph text
  4542. </member>
  4543. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.AddNewTextParagraph">
  4544. Add a new paragraph run to this shape
  4545. @return Created paragraph run
  4546. </member>
  4547. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.AddNewTextParagraph(System.String)">
  4548. Add a new paragraph run to this shape, Set to the provided string
  4549. @return Created paragraph run
  4550. </member>
  4551. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.AddNewTextParagraph(NPOI.XSSF.UserModel.XSSFRichTextString)">
  4552. Add a new paragraph run to this shape, Set to the provided rich text string
  4553. @return Created paragraph run
  4554. </member>
  4555. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.ApplyAttributes(NPOI.OpenXmlFormats.Spreadsheet.CT_RPrElt,NPOI.OpenXmlFormats.Dml.CT_TextCharacterProperties)">
  4556. org.Openxmlformats.schemas.spreadsheetml.x2006.main.CTRPrElt to
  4557. org.Openxmlformats.schemas.Drawingml.x2006.main.CTFont adapter
  4558. </member>
  4559. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.Text">
  4560. Returns the text from all paragraphs in the shape. Paragraphs are Separated by new lines.
  4561. @return text Contained within this shape or empty string
  4562. </member>
  4563. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.TextParagraphs">
  4564. Returns a collection of the XSSFTextParagraphs that are attached to this shape
  4565. @return text paragraphs in this shape
  4566. </member>
  4567. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.TextHorizontalOverflow">
  4568. Returns the type of horizontal overflow for the text.
  4569. @return the type of horizontal overflow
  4570. </member>
  4571. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.TextVerticalOverflow">
  4572. Returns the type of vertical overflow for the text.
  4573. @return the type of vertical overflow
  4574. </member>
  4575. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.VerticalAlignment">
  4576. Returns the type of vertical alignment for the text within the shape.
  4577. @return the type of vertical alignment
  4578. </member>
  4579. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.TextDirection">
  4580. Gets the vertical orientation of the text
  4581. @return vertical orientation of the text
  4582. </member>
  4583. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.BottomInset">
  4584. Returns the distance (in points) between the bottom of the text frame
  4585. and the bottom of the inscribed rectangle of the shape that Contains the text.
  4586. @return the bottom inset in points
  4587. </member>
  4588. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.LeftInset">
  4589. Returns the distance (in points) between the left edge of the text frame
  4590. and the left edge of the inscribed rectangle of the shape that Contains
  4591. the text.
  4592. @return the left inset in points
  4593. </member>
  4594. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.RightInset">
  4595. Returns the distance (in points) between the right edge of the
  4596. text frame and the right edge of the inscribed rectangle of the shape
  4597. that Contains the text.
  4598. @return the right inset in points
  4599. </member>
  4600. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.TopInset">
  4601. Returns the distance (in points) between the top of the text frame
  4602. and the top of the inscribed rectangle of the shape that Contains the text.
  4603. @return the top inset in points
  4604. </member>
  4605. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.WordWrap">
  4606. @return whether to wrap words within the bounding rectangle
  4607. </member>
  4608. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.TextAutofit">
  4609. Specifies that a shape should be auto-fit to fully contain the text described within it.
  4610. Auto-fitting is when text within a shape is scaled in order to contain all the text inside
  4611. @param value type of autofit
  4612. @return type of autofit
  4613. </member>
  4614. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.ShapeType">
  4615. Gets the shape type, one of the constants defined in {@link NPOI.SS.UserModel.ShapeTypes}.
  4616. @return the shape type
  4617. @see NPOI.SS.UserModel.ShapeTypes
  4618. </member>
  4619. <member name="T:NPOI.XSSF.UserModel.XSSFTable">
  4620. This class : the Table Part (Open Office XML Part 4:
  4621. chapter 3.5.1)
  4622. This implementation works under the assumption that a table Contains mappings to a subtree of an XML.
  4623. The root element of this subtree an occur multiple times (one for each row of the table). The child nodes
  4624. of the root element can be only attributes or element with maxOccurs=1 property set
  4625. @author Roberto Manicardi
  4626. </member>
  4627. <member name="M:NPOI.XSSF.UserModel.XSSFTable.MapsTo(System.Int64)">
  4628. Checks if this Table element Contains even a single mapping to the map identified by id
  4629. @param id the XSSFMap ID
  4630. @return true if the Table element contain mappings
  4631. </member>
  4632. <member name="M:NPOI.XSSF.UserModel.XSSFTable.GetCommonXpath">
  4633. Calculates the xpath of the root element for the table. This will be the common part
  4634. of all the mapping's xpaths
  4635. @return the xpath of the table's root element
  4636. </member>
  4637. <member name="M:NPOI.XSSF.UserModel.XSSFTable.GetStartCellReference">
  4638. @return The reference for the cell in the top-left part of the table
  4639. (see Open Office XML Part 4: chapter 3.5.1.2, attribute ref)
  4640. </member>
  4641. <member name="M:NPOI.XSSF.UserModel.XSSFTable.GetEndCellReference">
  4642. @return The reference for the cell in the bottom-right part of the table
  4643. (see Open Office XML Part 4: chapter 3.5.1.2, attribute ref)
  4644. </member>
  4645. <member name="M:NPOI.XSSF.UserModel.XSSFTable.UpdateHeaders">
  4646. Synchronize table headers with cell values in the parent sheet.
  4647. Headers <em>must</em> be in sync, otherwise Excel will display a
  4648. "Found unreadable content" message on startup.
  4649. </member>
  4650. <member name="P:NPOI.XSSF.UserModel.XSSFTable.Name">
  4651. @return the name of the Table, if set
  4652. </member>
  4653. <member name="P:NPOI.XSSF.UserModel.XSSFTable.DisplayName">
  4654. @return the display name of the Table, if set
  4655. </member>
  4656. <member name="P:NPOI.XSSF.UserModel.XSSFTable.NumberOfMappedColumns">
  4657. @return the number of mapped table columns (see Open Office XML Part 4: chapter 3.5.1.4)
  4658. </member>
  4659. <member name="P:NPOI.XSSF.UserModel.XSSFTable.RowCount">
  4660. @return the total number of rows in the selection. (Note: in this version autofiltering is ignored)
  4661. </member>
  4662. <member name="T:NPOI.XSSF.UserModel.XSSFTextBox">
  4663. Represents a text box in a SpreadsheetML Drawing.
  4664. @author Yegor Kozlov
  4665. </member>
  4666. <member name="T:NPOI.XSSF.UserModel.XSSFTextParagraph">
  4667. Represents a paragraph of text within the Containing text body.
  4668. The paragraph is the highest level text separation mechanism.
  4669. </member>
  4670. <member name="M:NPOI.XSSF.UserModel.XSSFTextParagraph.AddNewTextRun">
  4671. Add a new run of text
  4672. @return a new run of text
  4673. </member>
  4674. <member name="M:NPOI.XSSF.UserModel.XSSFTextParagraph.AddLineBreak">
  4675. Insert a line break
  4676. @return text run representing this line break ('\n')
  4677. </member>
  4678. <member name="M:NPOI.XSSF.UserModel.XSSFTextParagraph.AddTabStop(System.Double)">
  4679. Add a single tab stop to be used on a line of text when there are one or more tab characters
  4680. present within the text.
  4681. @param value the position of the tab stop relative to the left margin
  4682. </member>
  4683. <member name="M:NPOI.XSSF.UserModel.XSSFTextParagraph.IsBullet">
  4684. Returns whether this paragraph has bullets
  4685. </member>
  4686. <member name="M:NPOI.XSSF.UserModel.XSSFTextParagraph.SetBullet(System.Boolean)">
  4687. Set or unset this paragraph as a bullet point
  4688. @param flag whether text in this paragraph has bullets
  4689. </member>
  4690. <member name="M:NPOI.XSSF.UserModel.XSSFTextParagraph.SetBullet(NPOI.XSSF.UserModel.ListAutoNumber,System.Int32)">
  4691. Set this paragraph as an automatic numbered bullet point
  4692. @param scheme type of auto-numbering
  4693. @param startAt the number that will start number for a given sequence of automatically
  4694. numbered bullets (1-based).
  4695. </member>
  4696. <member name="M:NPOI.XSSF.UserModel.XSSFTextParagraph.SetBullet(NPOI.XSSF.UserModel.ListAutoNumber)">
  4697. Set this paragraph as an automatic numbered bullet point
  4698. @param scheme type of auto-numbering
  4699. </member>
  4700. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.TextAlign">
  4701. get or set the alignment that is to be applied to the paragraph.
  4702. Possible values for this include left, right, centered, justified and distributed,
  4703. If this attribute is omitted, then a value of left is implied.
  4704. @return alignment that is applied to the paragraph
  4705. </member>
  4706. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.TextFontAlign">
  4707. Determines where vertically on a line of text the actual words are positioned. This deals
  4708. with vertical placement of the characters with respect to the baselines. For instance
  4709. having text anchored to the top baseline, anchored to the bottom baseline, centered in
  4710. between, etc.
  4711. If this attribute is omitted, then a value of baseline is implied.
  4712. @return alignment that is applied to the paragraph
  4713. </member>
  4714. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.BulletFont">
  4715. @return the font to be used on bullet characters within a given paragraph
  4716. </member>
  4717. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.BulletCharacter">
  4718. @return the character to be used in place of the standard bullet point
  4719. </member>
  4720. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.BulletFontColor">
  4721. @return the color of bullet characters within a given paragraph.
  4722. A <code>null</code> value means to use the text font color.
  4723. </member>
  4724. <!-- Badly formed XML comment ignored for member "P:NPOI.XSSF.UserModel.XSSFTextParagraph.BulletFontSize" -->
  4725. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.Indent">
  4726. @return the indent applied to the first line of text in the paragraph.
  4727. </member>
  4728. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.LeftMargin">
  4729. Specifies the left margin of the paragraph. This is specified in Addition to the text body
  4730. inset and applies only to this text paragraph. That is the text body inset and the LeftMargin
  4731. attributes are Additive with respect to the text position.
  4732. @param value the left margin of the paragraph, -1 to clear the margin and use the default of 0.
  4733. </member>
  4734. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.RightMargin">
  4735. Specifies the right margin of the paragraph. This is specified in Addition to the text body
  4736. inset and applies only to this text paragraph. That is the text body inset and the marR
  4737. attributes are Additive with respect to the text position.
  4738. @param value the right margin of the paragraph, -1 to clear the margin and use the default of 0.
  4739. </member>
  4740. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.DefaultTabSize">
  4741. @return the default size for a tab character within this paragraph in points
  4742. </member>
  4743. <!-- Badly formed XML comment ignored for member "P:NPOI.XSSF.UserModel.XSSFTextParagraph.LineSpacing" -->
  4744. <!-- Badly formed XML comment ignored for member "P:NPOI.XSSF.UserModel.XSSFTextParagraph.SpaceBefore" -->
  4745. <!-- Badly formed XML comment ignored for member "P:NPOI.XSSF.UserModel.XSSFTextParagraph.SpaceAfter" -->
  4746. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.Level">
  4747. Specifies the particular level text properties that this paragraph will follow.
  4748. The value for this attribute formats the text according to the corresponding level
  4749. paragraph properties defined in the list of styles associated with the body of text
  4750. that this paragraph belongs to (therefore in the parent shape).
  4751. <p>
  4752. Note that the closest properties object to the text is used, therefore if there is
  4753. a conflict between the text paragraph properties and the list style properties for
  4754. this level then the text paragraph properties will take precedence.
  4755. </p>
  4756. Returns the level of text properties that this paragraph will follow.
  4757. @return the text level of this paragraph (0-based). Default is 0.
  4758. </member>
  4759. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.IsBulletAutoNumber">
  4760. Returns whether this paragraph has automatic numbered bullets
  4761. </member>
  4762. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.BulletAutoNumberStart">
  4763. Returns the starting number if this paragraph has automatic numbered bullets, otherwise returns 0
  4764. </member>
  4765. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.BulletAutoNumberScheme">
  4766. Returns the auto number scheme if this paragraph has automatic numbered bullets, otherwise returns ListAutoNumber.ARABIC_PLAIN
  4767. </member>
  4768. <member name="T:NPOI.XSSF.UserModel.XSSFVMLDrawing">
  4769. Represents a SpreadsheetML VML Drawing.
  4770. <p>
  4771. In Excel 2007 VML Drawings are used to describe properties of cell comments,
  4772. although the spec says that VML is deprecated:
  4773. </p>
  4774. <p>
  4775. The VML format is a legacy format originally introduced with Office 2000 and is included and fully defined
  4776. in this Standard for backwards compatibility reasons. The DrawingML format is a newer and richer format
  4777. Created with the goal of eventually replacing any uses of VML in the Office Open XML formats. VML should be
  4778. considered a deprecated format included in Office Open XML for legacy reasons only and new applications that
  4779. need a file format for Drawings are strongly encouraged to use preferentially DrawingML
  4780. </p>
  4781. <p>
  4782. Warning - Excel is known to Put invalid XML into these files!
  4783. For example, &gt;br&lt; without being closed or escaped crops up.
  4784. </p>
  4785. See 6.4 VML - SpreadsheetML Drawing in Office Open XML Part 4 - Markup Language Reference.pdf
  4786. @author Yegor Kozlov
  4787. </member>
  4788. <member name="F:NPOI.XSSF.UserModel.XSSFVMLDrawing.ptrn_shapeId">
  4789. regexp to parse shape ids, in VML they have weird form of id="_x0000_s1026"
  4790. </member>
  4791. <member name="M:NPOI.XSSF.UserModel.XSSFVMLDrawing.#ctor">
  4792. Create a new SpreadsheetML Drawing
  4793. @see XSSFSheet#CreateDrawingPatriarch()
  4794. </member>
  4795. <member name="M:NPOI.XSSF.UserModel.XSSFVMLDrawing.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  4796. Construct a SpreadsheetML Drawing from a namespace part
  4797. @param part the namespace part holding the Drawing data,
  4798. the content type must be <code>application/vnd.Openxmlformats-officedocument.Drawing+xml</code>
  4799. @param rel the namespace relationship holding this Drawing,
  4800. the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/drawing
  4801. </member>
  4802. <member name="M:NPOI.XSSF.UserModel.XSSFVMLDrawing.newDrawing">
  4803. Initialize a new Speadsheet VML Drawing
  4804. </member>
  4805. <member name="M:NPOI.XSSF.UserModel.XSSFVMLDrawing.FindCommentShape(System.Int32,System.Int32)">
  4806. Find a shape with ClientData of type "NOTE" and the specified row and column
  4807. @return the comment shape or <code>null</code>
  4808. </member>
  4809. <member name="T:NPOI.XSSF.UserModel.XSSFWorkbook">
  4810. High level representation of a SpreadsheetML workbook. This is the first object most users
  4811. will construct whether they are Reading or writing a workbook. It is also the
  4812. top level object for creating new sheets/etc.
  4813. </member>
  4814. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.DEFAULT_CHARACTER_WIDTH">
  4815. Width of one character of the default font in pixels. Same for Calibry and Arial.
  4816. </member>
  4817. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.Max_SENSITIVE_SHEET_NAME_LEN">
  4818. Excel silently tRuncates long sheet names to 31 chars.
  4819. This constant is used to ensure uniqueness in the first 31 chars
  4820. </member>
  4821. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_EMF">
  4822. Extended windows meta file
  4823. </member>
  4824. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_WMF">
  4825. Windows Meta File
  4826. </member>
  4827. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_PICT">
  4828. Mac PICT format
  4829. </member>
  4830. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_JPEG">
  4831. JPEG format
  4832. </member>
  4833. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_PNG">
  4834. PNG format
  4835. </member>
  4836. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_DIB">
  4837. Device independent bitmap
  4838. </member>
  4839. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_GIF">
  4840. Images formats supported by XSSF but not by HSSF
  4841. </member>
  4842. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.workbook">
  4843. The underlying XML bean
  4844. </member>
  4845. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.sheets">
  4846. this holds the XSSFSheet objects attached to this workbook
  4847. </member>
  4848. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.namedRanges">
  4849. this holds the XSSFName objects attached to this workbook
  4850. </member>
  4851. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.sharedStringSource">
  4852. shared string table - a cache of strings in this workbook
  4853. </member>
  4854. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.stylesSource">
  4855. A collection of shared objects used for styling content,
  4856. e.g. fonts, cell styles, colors, etc.
  4857. </member>
  4858. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook._udfFinder">
  4859. The locator of user-defined functions.
  4860. By default includes functions from the Excel Analysis Toolpack
  4861. </member>
  4862. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.calcChain">
  4863. TODO
  4864. </member>
  4865. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.externalLinks">
  4866. External Links, for referencing names or cells in other workbooks.
  4867. </member>
  4868. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.mapInfo">
  4869. A collection of custom XML mappings
  4870. </member>
  4871. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.formatter">
  4872. Used to keep track of the data formatter so that all
  4873. CreateDataFormatter calls return the same one for a given
  4874. book. This ensures that updates from one places is visible
  4875. someplace else.
  4876. </member>
  4877. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook._missingCellPolicy">
  4878. The policy to apply in the event of missing or
  4879. blank cells when fetching from a row.
  4880. See {@link NPOI.ss.usermodel.Row.MissingCellPolicy}
  4881. </member>
  4882. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.pictures">
  4883. array of pictures for this workbook
  4884. </member>
  4885. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook._creationHelper">
  4886. cached instance of XSSFCreationHelper for this workbook
  4887. @see {@link #getCreationHelper()}
  4888. </member>
  4889. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor">
  4890. Create a new SpreadsheetML workbook.
  4891. </member>
  4892. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage)">
  4893. Constructs a XSSFWorkbook object given a OpenXML4J <code>Package</code> object,
  4894. see <a href="http://poi.apache.org/oxml4j/">http://poi.apache.org/oxml4j/</a>.
  4895. Once you have finished working with the Workbook, you should close the package
  4896. by calling pkg.close, to avoid leaving file handles open.
  4897. Creating a XSSFWorkbook from a file-backed OPC Package has a lower memory
  4898. footprint than an InputStream backed one.
  4899. @param pkg the OpenXML4J <code>OPC Package</code> object.
  4900. </member>
  4901. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor(System.IO.Stream)">
  4902. Constructs a XSSFWorkbook object, by buffering the whole stream into memory
  4903. and then opening an {@link OPCPackage} object for it.
  4904. Using an {@link InputStream} requires more memory than using a File, so
  4905. if a {@link File} is available then you should instead do something like
  4906. <pre><code>
  4907. OPCPackage pkg = OPCPackage.open(path);
  4908. XSSFWorkbook wb = new XSSFWorkbook(pkg);
  4909. // work with the wb object
  4910. ......
  4911. pkg.close(); // gracefully closes the underlying zip file
  4912. </code></pre>
  4913. </member>
  4914. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor(System.IO.FileInfo)" -->
  4915. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor(System.String)" -->
  4916. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.OnWorkbookCreate">
  4917. Create a new CT_Workbook with all values Set to default
  4918. </member>
  4919. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.newPackage">
  4920. Create a new SpreadsheetML namespace and Setup the default minimal content
  4921. </member>
  4922. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCTWorkbook">
  4923. Return the underlying XML bean
  4924. @return the underlying CT_Workbook bean
  4925. </member>
  4926. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.AddPicture(System.Byte[],System.Int32)">
  4927. Adds a picture to the workbook.
  4928. @param pictureData The bytes of the picture
  4929. @param format The format of the picture.
  4930. @return the index to this picture (0 based), the Added picture can be obtained from {@link #getAllPictures()} .
  4931. @see Workbook#PICTURE_TYPE_EMF
  4932. @see Workbook#PICTURE_TYPE_WMF
  4933. @see Workbook#PICTURE_TYPE_PICT
  4934. @see Workbook#PICTURE_TYPE_JPEG
  4935. @see Workbook#PICTURE_TYPE_PNG
  4936. @see Workbook#PICTURE_TYPE_DIB
  4937. @see #getAllPictures()
  4938. </member>
  4939. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.AddPicture(System.IO.Stream,System.Int32)">
  4940. Adds a picture to the workbook.
  4941. @param is The sream to read image from
  4942. @param format The format of the picture.
  4943. @return the index to this picture (0 based), the Added picture can be obtained from {@link #getAllPictures()} .
  4944. @see Workbook#PICTURE_TYPE_EMF
  4945. @see Workbook#PICTURE_TYPE_WMF
  4946. @see Workbook#PICTURE_TYPE_PICT
  4947. @see Workbook#PICTURE_TYPE_JPEG
  4948. @see Workbook#PICTURE_TYPE_PNG
  4949. @see Workbook#PICTURE_TYPE_DIB
  4950. @see #getAllPictures()
  4951. </member>
  4952. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CloneSheet(System.Int32)">
  4953. Create an XSSFSheet from an existing sheet in the XSSFWorkbook.
  4954. The Cloned sheet is a deep copy of the original.
  4955. @return XSSFSheet representing the Cloned sheet.
  4956. @throws ArgumentException if the sheet index in invalid
  4957. @throws POIXMLException if there were errors when cloning
  4958. </member>
  4959. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateCellStyle">
  4960. Create a new XSSFCellStyle and add it to the workbook's style table
  4961. @return the new XSSFCellStyle object
  4962. </member>
  4963. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateDataFormat">
  4964. Returns the instance of XSSFDataFormat for this workbook.
  4965. @return the XSSFDataFormat object
  4966. @see NPOI.ss.usermodel.DataFormat
  4967. </member>
  4968. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateFont">
  4969. Create a new Font and add it to the workbook's font table
  4970. @return new font object
  4971. </member>
  4972. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateSheet">
  4973. Create an XSSFSheet for this workbook, Adds it to the sheets and returns
  4974. the high level representation. Use this to create new sheets.
  4975. @return XSSFSheet representing the new sheet.
  4976. </member>
  4977. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateSheet(System.String)">
  4978. Create a new sheet for this Workbook and return the high level representation.
  4979. Use this to create new sheets.
  4980. <p>
  4981. Note that Excel allows sheet names up to 31 chars in length but other applications
  4982. (such as OpenOffice) allow more. Some versions of Excel crash with names longer than 31 chars,
  4983. others - tRuncate such names to 31 character.
  4984. </p>
  4985. <p>
  4986. POI's SpreadsheetAPI silently tRuncates the input argument to 31 characters.
  4987. Example:
  4988. <pre><code>
  4989. Sheet sheet = workbook.CreateSheet("My very long sheet name which is longer than 31 chars"); // will be tRuncated
  4990. assert 31 == sheet.SheetName.Length;
  4991. assert "My very long sheet name which i" == sheet.SheetName;
  4992. </code></pre>
  4993. </p>
  4994. Except the 31-character constraint, Excel applies some other rules:
  4995. <p>
  4996. Sheet name MUST be unique in the workbook and MUST NOT contain the any of the following characters:
  4997. <ul>
  4998. <li> 0x0000 </li>
  4999. <li> 0x0003 </li>
  5000. <li> colon (:) </li>
  5001. <li> backslash (\) </li>
  5002. <li> asterisk (*) </li>
  5003. <li> question mark (?) </li>
  5004. <li> forward slash (/) </li>
  5005. <li> opening square bracket ([) </li>
  5006. <li> closing square bracket (]) </li>
  5007. </ul>
  5008. The string MUST NOT begin or end with the single quote (') character.
  5009. </p>
  5010. <p>
  5011. See {@link org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)}
  5012. for a safe way to create valid names
  5013. </p>
  5014. @param sheetname sheetname to set for the sheet.
  5015. @return Sheet representing the new sheet.
  5016. @throws IllegalArgumentException if the name is null or invalid
  5017. or workbook already contains a sheet with this name
  5018. @see org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)
  5019. </member>
  5020. <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)">
  5021. Finds a font that matches the one with the supplied attributes
  5022. </member>
  5023. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetAllPictures">
  5024. Gets all pictures from the Workbook.
  5025. @return the list of pictures (a list of {@link XSSFPictureData} objects.)
  5026. @see #AddPicture(byte[], int)
  5027. </member>
  5028. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCellStyleAt(System.Int16)">
  5029. Get the cell style object at the given index
  5030. @param idx index within the Set of styles
  5031. @return XSSFCellStyle object at the index
  5032. </member>
  5033. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCellStyleAt(System.Int32)">
  5034. Get the cell style object at the given index
  5035. @param idx index within the set of styles
  5036. @return XSSFCellStyle object at the index
  5037. </member>
  5038. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetFontAt(System.Int16)">
  5039. Get the font at the given index number
  5040. @param idx index number
  5041. @return XSSFFont at the index
  5042. </member>
  5043. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetNameIndex(System.String)">
  5044. Gets the named range index by his name
  5045. <i>Note:</i>Excel named ranges are case-insensitive and
  5046. this method performs a case-insensitive search.
  5047. @param name named range name
  5048. @return named range index
  5049. </member>
  5050. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetPrintArea(System.Int32)">
  5051. Retrieves the reference for the printarea of the specified sheet, the sheet name is Appended to the reference even if it was not specified.
  5052. @param sheetIndex Zero-based sheet index (0 Represents the first sheet to keep consistent with java)
  5053. @return String Null if no print area has been defined
  5054. </member>
  5055. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheet(System.String)">
  5056. Get sheet with the given name (case insensitive match)
  5057. @param name of the sheet
  5058. @return XSSFSheet with the name provided or <code>null</code> if it does not exist
  5059. </member>
  5060. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheetAt(System.Int32)" -->
  5061. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheetIndex(System.String)">
  5062. <summary>
  5063. Returns the index of the sheet by his name (case insensitive match)
  5064. </summary>
  5065. <param name="name">the sheet name</param>
  5066. <returns>index of the sheet (0 based) or -1 if not found</returns>
  5067. </member>
  5068. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheetIndex(NPOI.SS.UserModel.ISheet)">
  5069. Returns the index of the given sheet
  5070. @param sheet the sheet to look up
  5071. @return index of the sheet (0 based). <tt>-1</tt> if not found
  5072. </member>
  5073. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheetName(System.Int32)">
  5074. Get the sheet name
  5075. @param sheetIx Number
  5076. @return Sheet name
  5077. </member>
  5078. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetEnumerator">
  5079. Allows foreach loops:
  5080. <pre><code>
  5081. XSSFWorkbook wb = new XSSFWorkbook(package);
  5082. for(XSSFSheet sheet : wb){
  5083. }
  5084. </code></pre>
  5085. </member>
  5086. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsMacroEnabled">
  5087. Are we a normal workbook (.xlsx), or a
  5088. macro enabled workbook (.xlsm)?
  5089. </member>
  5090. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.RemoveName(NPOI.XSSF.UserModel.XSSFName)">
  5091. As {@link #removeName(String)} is not necessarily unique
  5092. (name + sheet index is unique), this method is more accurate.
  5093. @param name the name to remove.
  5094. </member>
  5095. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.RemovePrintArea(System.Int32)">
  5096. Delete the printarea for the sheet specified
  5097. @param sheetIndex 0-based sheet index (0 = First Sheet)
  5098. </member>
  5099. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.RemoveSheetAt(System.Int32)">
  5100. Removes sheet at the given index.<p/>
  5101. Care must be taken if the Removed sheet is the currently active or only selected sheet in
  5102. the workbook. There are a few situations when Excel must have a selection and/or active
  5103. sheet. (For example when printing - see Bug 40414).<br/>
  5104. This method Makes sure that if the Removed sheet was active, another sheet will become
  5105. active in its place. Furthermore, if the Removed sheet was the only selected sheet, another
  5106. sheet will become selected. The newly active/selected sheet will have the same index, or
  5107. one less if the Removed sheet was the last in the workbook.
  5108. @param index of the sheet (0-based)
  5109. </member>
  5110. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.OnSheetDelete(System.Int32)">
  5111. Gracefully remove references to the sheet being deleted
  5112. @param index the 0-based index of the sheet to delete
  5113. </member>
  5114. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.ValidateSheetIndex(System.Int32)">
  5115. Validate sheet index
  5116. @param index the index to validate
  5117. @throws ArgumentException if the index is out of range (index
  5118. &lt; 0 || index &gt;= NumberOfSheets).
  5119. </member>
  5120. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFWorkbook.SetPrintArea(System.Int32,System.String)" -->
  5121. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetPrintArea(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  5122. For the Convenience of Java Programmers maintaining pointers.
  5123. @see #setPrintArea(int, String)
  5124. @param sheetIndex Zero-based sheet index (0 = First Sheet)
  5125. @param startColumn Column to begin printarea
  5126. @param endColumn Column to end the printarea
  5127. @param startRow Row to begin the printarea
  5128. @param endRow Row to end the printarea
  5129. </member>
  5130. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetRepeatingRowsAndColumns(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  5131. Sets the repeating rows and columns for a sheet.
  5132. <p/>
  5133. To Set just repeating columns:
  5134. <pre>
  5135. workbook.SetRepeatingRowsAndColumns(0,0,1,-1,-1);
  5136. </pre>
  5137. To Set just repeating rows:
  5138. <pre>
  5139. workbook.SetRepeatingRowsAndColumns(0,-1,-1,0,4);
  5140. </pre>
  5141. To remove all repeating rows and columns for a sheet.
  5142. <pre>
  5143. workbook.SetRepeatingRowsAndColumns(0,-1,-1,-1,-1);
  5144. </pre>
  5145. @param sheetIndex 0 based index to sheet.
  5146. @param startColumn 0 based start of repeating columns.
  5147. @param endColumn 0 based end of repeating columns.
  5148. @param startRow 0 based start of repeating rows.
  5149. @param endRow 0 based end of repeating rows.
  5150. </member>
  5151. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateBuiltInName(System.String,System.Int32)">
  5152. Generates a NameRecord to represent a built-in region
  5153. @return a new NameRecord
  5154. @throws ArgumentException if sheetNumber is invalid
  5155. @throws POIXMLException if such a name already exists in the workbook
  5156. </member>
  5157. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSelectedTab(System.Int32)">
  5158. We only Set one sheet as selected for compatibility with HSSF.
  5159. </member>
  5160. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetName(System.Int32,System.String)">
  5161. Set the sheet name.
  5162. @param sheetIndex sheet number (0 based)
  5163. @param sheetname the new sheet name
  5164. @throws ArgumentException if the name is null or invalid
  5165. or workbook already Contains a sheet with this name
  5166. @see {@link #CreateSheet(String)}
  5167. @see {@link NPOI.ss.util.WorkbookUtil#CreateSafeSheetName(String nameProposal)}
  5168. for a safe way to create valid names
  5169. </member>
  5170. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetOrder(System.String,System.Int32)">
  5171. Sets the order of appearance for a given sheet.
  5172. @param sheetname the name of the sheet to reorder
  5173. @param pos the position that we want to insert the sheet into (0 based)
  5174. </member>
  5175. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SaveNamedRanges">
  5176. marshal named ranges from the {@link #namedRanges} collection to the underlying CT_Workbook bean
  5177. </member>
  5178. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSharedStringSource">
  5179. Returns SharedStringsTable - tha cache of string for this workbook
  5180. @return the shared string table
  5181. </member>
  5182. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetStylesSource">
  5183. Return a object representing a collection of shared objects used for styling content,
  5184. e.g. fonts, cell styles, colors, etc.
  5185. </member>
  5186. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetTheme">
  5187. Returns the Theme of current workbook.
  5188. </member>
  5189. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCreationHelper">
  5190. Returns an object that handles instantiating concrete
  5191. classes of the various instances for XSSF.
  5192. </member>
  5193. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.ContainsSheet(System.String,System.Int32)">
  5194. Determines whether a workbook Contains the provided sheet name.
  5195. For the purpose of comparison, long names are tRuncated to 31 chars.
  5196. @param name the name to Test (case insensitive match)
  5197. @param excludeSheetIdx the sheet to exclude from the check or -1 to include all sheets in the Check.
  5198. @return true if the sheet Contains the name, false otherwise.
  5199. </member>
  5200. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsDate1904">
  5201. Gets a bool value that indicates whether the date systems used in the workbook starts in 1904.
  5202. <p>
  5203. The default value is false, meaning that the workbook uses the 1900 date system,
  5204. where 1/1/1900 is the first day in the system..
  5205. </p>
  5206. @return true if the date systems used in the workbook starts in 1904
  5207. </member>
  5208. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetAllEmbedds">
  5209. Get the document's embedded files.
  5210. </member>
  5211. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsSheetHidden(System.Int32)">
  5212. Check whether a sheet is hidden.
  5213. <p>
  5214. Note that a sheet could instead be Set to be very hidden, which is different
  5215. ({@link #isSheetVeryHidden(int)})
  5216. </p>
  5217. @param sheetIx Number
  5218. @return <code>true</code> if sheet is hidden
  5219. </member>
  5220. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsSheetVeryHidden(System.Int32)">
  5221. Check whether a sheet is very hidden.
  5222. <p>
  5223. This is different from the normal hidden status
  5224. ({@link #isSheetHidden(int)})
  5225. </p>
  5226. @param sheetIx sheet index to check
  5227. @return <code>true</code> if sheet is very hidden
  5228. </member>
  5229. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetHidden(System.Int32,System.Boolean)">
  5230. Sets the visible state of this sheet.
  5231. <p>
  5232. Calling <code>setSheetHidden(sheetIndex, true)</code> is equivalent to
  5233. <code>setSheetHidden(sheetIndex, Workbook.SHEET_STATE_HIDDEN)</code>.
  5234. <br/>
  5235. Calling <code>setSheetHidden(sheetIndex, false)</code> is equivalent to
  5236. <code>setSheetHidden(sheetIndex, Workbook.SHEET_STATE_VISIBLE)</code>.
  5237. </p>
  5238. @param sheetIx the 0-based index of the sheet
  5239. @param hidden whether this sheet is hidden
  5240. @see #setSheetHidden(int, int)
  5241. </member>
  5242. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetHidden(System.Int32,NPOI.SS.UserModel.SheetState)">
  5243. Hide or unhide a sheet.
  5244. <ul>
  5245. <li>0 - visible. </li>
  5246. <li>1 - hidden. </li>
  5247. <li>2 - very hidden.</li>
  5248. </ul>
  5249. @param sheetIx the sheet index (0-based)
  5250. @param state one of the following <code>Workbook</code> constants:
  5251. <code>Workbook.SHEET_STATE_VISIBLE</code>,
  5252. <code>Workbook.SHEET_STATE_HIDDEN</code>, or
  5253. <code>Workbook.SHEET_STATE_VERY_HIDDEN</code>.
  5254. @throws ArgumentException if the supplied sheet index or state is invalid
  5255. </member>
  5256. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetHidden(System.Int32,System.Int32)">
  5257. <summary>
  5258. Hide or unhide a sheet.
  5259. </summary>
  5260. <param name="sheetIx">The sheet number</param>
  5261. <param name="hidden">0 for not hidden, 1 for hidden, 2 for very hidden</param>
  5262. </member>
  5263. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.OnDeleteFormula(NPOI.XSSF.UserModel.XSSFCell)">
  5264. Fired when a formula is deleted from this workbook,
  5265. for example when calling cell.SetCellFormula(null)
  5266. @see XSSFCell#setCellFormula(String)
  5267. </member>
  5268. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCalculationChain">
  5269. Return the CalculationChain object for this workbook
  5270. <p>
  5271. The calculation chain object specifies the order in which the cells in a workbook were last calculated
  5272. </p>
  5273. @return the <code>CalculationChain</code> object or <code>null</code> if not defined
  5274. </member>
  5275. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCustomXMLMappings">
  5276. @return a collection of custom XML mappings defined in this workbook
  5277. </member>
  5278. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetMapInfo">
  5279. @return the helper class used to query the custom XML mapping defined in this workbook
  5280. </member>
  5281. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.LinkExternalWorkbook(System.String,NPOI.SS.UserModel.IWorkbook)">
  5282. Adds the External Link Table part and relations required to allow formulas
  5283. referencing the specified external workbook to be added to this one. Allows
  5284. formulas such as "[MyOtherWorkbook.xlsx]Sheet3!$A$5" to be added to the
  5285. file, for workbooks not already linked / referenced.
  5286. @param name The name the workbook will be referenced as in formulas
  5287. @param workbook The open workbook to fetch the link required information from
  5288. </member>
  5289. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsStructureLocked">
  5290. Specifies a bool value that indicates whether structure of workbook is locked. <br/>
  5291. A value true indicates the structure of the workbook is locked. Worksheets in the workbook can't be Moved,
  5292. deleted, hidden, unhidden, or Renamed, and new worksheets can't be inserted.<br/>
  5293. A value of false indicates the structure of the workbook is not locked.<br/>
  5294. @return true if structure of workbook is locked
  5295. </member>
  5296. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsWindowsLocked">
  5297. Specifies a bool value that indicates whether the windows that comprise the workbook are locked. <br/>
  5298. A value of true indicates the workbook windows are locked. Windows are the same size and position each time the
  5299. workbook is opened.<br/>
  5300. A value of false indicates the workbook windows are not locked.
  5301. @return true if windows that comprise the workbook are locked
  5302. </member>
  5303. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsRevisionLocked">
  5304. Specifies a bool value that indicates whether the workbook is locked for revisions.
  5305. @return true if the workbook is locked for revisions.
  5306. </member>
  5307. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.LockStructure">
  5308. Locks the structure of workbook.
  5309. </member>
  5310. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.UnlockStructure">
  5311. Unlocks the structure of workbook.
  5312. </member>
  5313. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.LockWindows">
  5314. Locks the windows that comprise the workbook.
  5315. </member>
  5316. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.UnlockWindows">
  5317. Unlocks the windows that comprise the workbook.
  5318. </member>
  5319. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.LockRevision">
  5320. Locks the workbook for revisions.
  5321. </member>
  5322. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.UnlockRevision">
  5323. Unlocks the workbook for revisions.
  5324. </member>
  5325. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetUDFFinder">
  5326. Returns the locator of user-defined functions.
  5327. <p>
  5328. The default instance : the built-in functions with the Excel Analysis Tool Pack.
  5329. To Set / Evaluate custom functions you need to register them as follows:
  5330. </p>
  5331. @return wrapped instance of UDFFinder that allows seeking functions both by index and name
  5332. </member>
  5333. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.AddToolPack(NPOI.SS.Formula.Udf.UDFFinder)">
  5334. Register a new toolpack in this workbook.
  5335. @param toopack the toolpack to register
  5336. </member>
  5337. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetForceFormulaRecalculation(System.Boolean)">
  5338. Whether the application shall perform a full recalculation when the workbook is opened.
  5339. <p>
  5340. Typically you want to force formula recalculation when you modify cell formulas or values
  5341. of a workbook previously Created by Excel. When Set to true, this flag will tell Excel
  5342. that it needs to recalculate all formulas in the workbook the next time the file is opened.
  5343. </p>
  5344. <p>
  5345. Note, that recalculation updates cached formula results and, thus, modifies the workbook.
  5346. Depending on the version, Excel may prompt you with "Do you want to save the Changes in <em>filename</em>?"
  5347. on close.
  5348. </p>
  5349. @param value true if the application will perform a full recalculation of
  5350. workbook values when the workbook is opened
  5351. @since 3.8
  5352. </member>
  5353. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetForceFormulaRecalculation">
  5354. Whether Excel will be asked to recalculate all formulas when the workbook is opened.
  5355. @since 3.8
  5356. </member>
  5357. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.ActiveSheetIndex">
  5358. Convenience method to Get the active sheet. The active sheet is is the sheet
  5359. which is currently displayed when the workbook is viewed in Excel.
  5360. 'Selected' sheet(s) is a distinct concept.
  5361. </member>
  5362. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.NumCellStyles">
  5363. Get the number of styles the workbook Contains
  5364. @return count of cell styles
  5365. </member>
  5366. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.NumberOfFonts">
  5367. Get the number of fonts in the this workbook
  5368. @return number of fonts
  5369. </member>
  5370. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.NumberOfNames">
  5371. Get the number of named ranges in the this workbook
  5372. @return number of named ranges
  5373. </member>
  5374. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.NumberOfSheets">
  5375. Get the number of worksheets in the this workbook
  5376. @return number of worksheets
  5377. </member>
  5378. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.MissingCellPolicy">
  5379. Retrieves the current policy on what to do when
  5380. Getting missing or blank cells from a row.
  5381. The default is to return blank and null cells.
  5382. {@link MissingCellPolicy}
  5383. </member>
  5384. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.FirstVisibleTab">
  5385. Gets the first tab that is displayed in the list of tabs in excel.
  5386. @return integer that Contains the index to the active sheet in this book view.
  5387. </member>
  5388. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.ExternalLinksTable">
  5389. * Returns the list of {@link ExternalLinksTable} object for this workbook
  5390. *
  5391. * <p>The external links table specifies details of named ranges etc
  5392. * that are referenced from other workbooks, along with the last seen
  5393. * values of what they point to.</p>
  5394. *
  5395. * <p>Note that Excel uses index 0 for the current workbook, so the first
  5396. * External Links in a formula would be '[1]Foo' which corresponds to
  5397. * entry 0 in this list.</p>
  5398. * @return the <code>ExternalLinksTable</code> list, which may be empty
  5399. </member>
  5400. <member name="T:NPOI.XSSF.Util.EvilUnclosedBRFixingInputStream">
  5401. This is a seriously sick fix for the fact that some .xlsx
  5402. files contain raw bits of HTML, without being escaped
  5403. or properly turned into XML.
  5404. The result is that they contain things like &gt;br&lt;,
  5405. which breaks the XML parsing.
  5406. This very sick InputStream wrapper attempts to spot
  5407. these go past, and fix them.
  5408. Only works for UTF-8 and US-ASCII based streams!
  5409. It should only be used where experience Shows the problem
  5410. can occur...
  5411. </member>
  5412. <member name="M:NPOI.XSSF.Util.EvilUnclosedBRFixingInputStream.Read">
  5413. Warning - doesn't fix!
  5414. </member>
  5415. <member name="M:NPOI.XSSF.Util.EvilUnclosedBRFixingInputStream.ReadFromSpare(System.Byte[],System.Int32,System.Int32)">
  5416. Reads into the buffer from the spare bytes
  5417. </member>
  5418. <member name="T:NPOI.XSSF.XLSBUnsupportedException">
  5419. We don't support .xlsb files, sorry
  5420. </member>
  5421. <member name="T:NPOI.XWPF.Extractor.XWPFWordExtractor">
  5422. Helper class to extract text from an OOXML Word file
  5423. </member>
  5424. <member name="M:NPOI.XWPF.Extractor.XWPFWordExtractor.SetFetchHyperlinks(System.Boolean)">
  5425. Should we also fetch the hyperlinks, when fetching
  5426. the text content? Default is to only output the
  5427. hyperlink label, and not the contents
  5428. </member>
  5429. <member name="T:NPOI.XWPF.Model.XMLParagraph">
  5430. Base class for XWPF paragraphs
  5431. @author Yury Batrakov (batrakov at gmail.com)
  5432. </member>
  5433. <member name="T:NPOI.XWPF.Model.XWPFCommentsDecorator">
  5434. Decorator class for XWPFParagraph allowing to add comments
  5435. found in paragraph to its text
  5436. @author Yury Batrakov (batrakov at gmail.com)
  5437. </member>
  5438. <member name="T:NPOI.XWPF.Model.XWPFParagraphDecorator">
  5439. Base decorator class for XWPFParagraph
  5440. </member>
  5441. <member name="T:NPOI.XWPF.Model.XWPFHeaderFooterPolicy">
  5442. A .docx file can have no headers/footers, the same header/footer
  5443. on each page, odd/even page footers, and optionally also
  5444. a different header/footer on the first page.
  5445. This class handles sorting out what there is, and giving you
  5446. the right headers and footers for the document.
  5447. </member>
  5448. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.#ctor(NPOI.XWPF.UserModel.XWPFDocument)">
  5449. Figures out the policy for the given document,
  5450. and Creates any header and footer objects
  5451. as required.
  5452. </member>
  5453. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.#ctor(NPOI.XWPF.UserModel.XWPFDocument,NPOI.OpenXmlFormats.Wordprocessing.CT_SectPr)">
  5454. Figures out the policy for the given document,
  5455. and Creates any header and footer objects
  5456. as required.
  5457. </member>
  5458. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.buildHdrFtr(System.String,NPOI.XWPF.UserModel.XWPFParagraph[],NPOI.XWPF.UserModel.XWPFHeaderFooter)">
  5459. MB 24 May 2010. Created this overloaded buildHdrFtr() method because testing demonstrated
  5460. that the XWPFFooter or XWPFHeader object returned by calls to the CreateHeader(int, XWPFParagraph[])
  5461. and CreateFooter(int, XWPFParagraph[]) methods or the GetXXXXXHeader/Footer methods where
  5462. headers or footers had been Added to a document since it had been Created/opened, returned
  5463. an object that Contained no XWPFParagraph objects even if the header/footer itself did contain
  5464. text. The reason was that this line of code; CTHdrFtr ftr = CTHdrFtr.Factory.NewInstance();
  5465. Created a brand new instance of the CTHDRFtr class which was then populated with data when
  5466. it should have recovered the CTHdrFtr object encapsulated within the XWPFHeaderFooter object
  5467. that had previoulsy been instantiated in the CreateHeader(int, XWPFParagraph[]) or
  5468. CreateFooter(int, XWPFParagraph[]) methods.
  5469. </member>
  5470. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.GetOddPageHeader">
  5471. Returns the odd page header. This is
  5472. also the same as the default one...
  5473. </member>
  5474. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.GetOddPageFooter">
  5475. Returns the odd page footer. This is
  5476. also the same as the default one...
  5477. </member>
  5478. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.GetHeader(System.Int32)">
  5479. Get the header that applies to the given
  5480. (1 based) page.
  5481. @param pageNumber The one based page number
  5482. </member>
  5483. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.GetFooter(System.Int32)">
  5484. Get the footer that applies to the given
  5485. (1 based) page.
  5486. @param pageNumber The one based page number
  5487. </member>
  5488. <member name="T:NPOI.XWPF.Model.XWPFHyperlinkDecorator">
  5489. Decorator class for XWPFParagraph allowing to add hyperlinks
  5490. found in paragraph to its text.
  5491. Note - Adds the hyperlink at the end, not in the right place...
  5492. @deprecated Use {@link XWPFHyperlinkRun} instead
  5493. </member>
  5494. <member name="M:NPOI.XWPF.Model.XWPFHyperlinkDecorator.#ctor(NPOI.XWPF.Model.XWPFParagraphDecorator,System.Boolean)">
  5495. @param nextDecorator The next decorator to use
  5496. @param outputHyperlinkUrls Should we output the links too, or just the link text?
  5497. </member>
  5498. <member name="M:NPOI.XWPF.Model.XWPFHyperlinkDecorator.#ctor(NPOI.XWPF.UserModel.XWPFParagraph,NPOI.XWPF.Model.XWPFParagraphDecorator,System.Boolean)">
  5499. @param prgrph The paragraph of text to work on
  5500. @param outputHyperlinkUrls Should we output the links too, or just the link text?
  5501. </member>
  5502. <member name="T:NPOI.XWPF.UserModel.AbstractXWPFSDT">
  5503. Experimental abstract class that is a base for XWPFSDT and XWPFSDTCell
  5504. <p/>
  5505. WARNING - APIs expected to change rapidly.
  5506. <p/>
  5507. These classes have so far been built only for Read-only Processing.
  5508. </member>
  5509. <member name="T:NPOI.XWPF.UserModel.ISDTContents">
  5510. Interface for anything that can be within an STD:
  5511. {@link XWPFRun}, {@link XWPFTable}, {@link XWPFParagraph},
  5512. {@link XWPFSDT} etc
  5513. </member>
  5514. <member name="M:NPOI.XWPF.UserModel.AbstractXWPFSDT.GetTitle">
  5515. @return first SDT Title
  5516. </member>
  5517. <member name="M:NPOI.XWPF.UserModel.AbstractXWPFSDT.GetTag">
  5518. @return first SDT Tag
  5519. </member>
  5520. <member name="M:NPOI.XWPF.UserModel.AbstractXWPFSDT.GetBody">
  5521. @return null
  5522. </member>
  5523. <member name="M:NPOI.XWPF.UserModel.AbstractXWPFSDT.GetPart">
  5524. @return document part
  5525. </member>
  5526. <member name="M:NPOI.XWPF.UserModel.AbstractXWPFSDT.GetPartType">
  5527. @return partType
  5528. </member>
  5529. <member name="M:NPOI.XWPF.UserModel.AbstractXWPFSDT.GetElementType">
  5530. @return element type
  5531. </member>
  5532. <member name="P:NPOI.XWPF.UserModel.AbstractXWPFSDT.Content">
  5533. @return the content object
  5534. </member>
  5535. <member name="T:NPOI.XWPF.UserModel.BodyElementType">
  5536. <p>
  5537. 9 Jan 2010
  5538. </p>
  5539. <p>
  5540. // TODO insert Javadoc here!
  5541. </p>
  5542. @author epp
  5543. </member>
  5544. <member name="T:NPOI.XWPF.UserModel.BodyType">
  5545. The different kinds of {@link IBody} that exist
  5546. </member>
  5547. <member name="T:NPOI.XWPF.UserModel.Borders">
  5548. Specifies all types of borders which can be specified for WordProcessingML
  5549. objects which have a border. Borders can be Separated into two types:
  5550. <ul>
  5551. <li> Line borders: which specify a pattern to be used when Drawing a line around the
  5552. specified object.
  5553. </li>
  5554. <li> Art borders: which specify a repeated image to be used
  5555. when Drawing a border around the specified object. Line borders may be
  5556. specified on any object which allows a border, however, art borders may only
  5557. be used as a border at the page level - the borders under the pgBorders
  5558. element
  5559. </li>
  5560. </ul>
  5561. @author Gisella Bronzetti
  5562. </member>
  5563. <member name="F:NPOI.XWPF.UserModel.Borders.Single">
  5564. Specifies a line border consisting of a single line around the parent
  5565. object.
  5566. </member>
  5567. <member name="F:NPOI.XWPF.UserModel.Borders.Apples">
  5568. specifies an art border consisting of a repeated image of an apple
  5569. </member>
  5570. <member name="F:NPOI.XWPF.UserModel.Borders.ArchedScallops">
  5571. specifies an art border consisting of a repeated image of a shell pattern
  5572. </member>
  5573. <member name="F:NPOI.XWPF.UserModel.Borders.BabyPacifier">
  5574. specifies an art border consisting of a repeated image of a baby pacifier
  5575. </member>
  5576. <member name="F:NPOI.XWPF.UserModel.Borders.BabyRattle">
  5577. specifies an art border consisting of a repeated image of a baby rattle
  5578. </member>
  5579. <member name="F:NPOI.XWPF.UserModel.Borders.Balloons3Colors">
  5580. specifies an art border consisting of a repeated image of a set of
  5581. balloons
  5582. </member>
  5583. <member name="F:NPOI.XWPF.UserModel.Borders.BalloonsHotAir">
  5584. specifies an art border consisting of a repeated image of a hot air
  5585. balloon
  5586. </member>
  5587. <member name="F:NPOI.XWPF.UserModel.Borders.BasicBlackDashes">
  5588. specifies an art border consisting of a repeating image of a black and
  5589. white background.
  5590. </member>
  5591. <member name="F:NPOI.XWPF.UserModel.Borders.BasicBlackDots">
  5592. specifies an art border consisting of a repeating image of a black dot on
  5593. a white background.
  5594. </member>
  5595. <member name="F:NPOI.XWPF.UserModel.Borders.BasicBlackSquares">
  5596. specifies an art border consisting of a repeating image of a black and
  5597. white background
  5598. </member>
  5599. <member name="F:NPOI.XWPF.UserModel.Borders.BasicThinLines">
  5600. specifies an art border consisting of a repeating image of a black and
  5601. white background.
  5602. </member>
  5603. <member name="F:NPOI.XWPF.UserModel.Borders.BasicWhiteDashes">
  5604. specifies an art border consisting of a repeating image of a black and
  5605. white background.
  5606. </member>
  5607. <member name="F:NPOI.XWPF.UserModel.Borders.BasicWhiteDots">
  5608. specifies an art border consisting of a repeating image of a white dot on
  5609. a black background.
  5610. </member>
  5611. <member name="F:NPOI.XWPF.UserModel.Borders.BasicWhiteSquares">
  5612. specifies an art border consisting of a repeating image of a black and
  5613. white background.
  5614. </member>
  5615. <member name="F:NPOI.XWPF.UserModel.Borders.BasicWideInline">
  5616. specifies an art border consisting of a repeating image of a black and
  5617. white background.
  5618. </member>
  5619. <member name="F:NPOI.XWPF.UserModel.Borders.BasicWideMidline">
  5620. specifies an art border consisting of a repeating image of a black and
  5621. white background
  5622. </member>
  5623. <member name="F:NPOI.XWPF.UserModel.Borders.BasicWideOutline">
  5624. specifies an art border consisting of a repeating image of a black and
  5625. white background
  5626. </member>
  5627. <member name="F:NPOI.XWPF.UserModel.Borders.Bats">
  5628. specifies an art border consisting of a repeated image of bats
  5629. </member>
  5630. <member name="F:NPOI.XWPF.UserModel.Borders.Birds">
  5631. specifies an art border consisting of repeating images of birds
  5632. </member>
  5633. <member name="F:NPOI.XWPF.UserModel.Borders.BirdsFlight">
  5634. specifies an art border consisting of a repeated image of birds flying
  5635. </member>
  5636. <member name="F:NPOI.XWPF.UserModel.Borders.Cabins">
  5637. specifies an art border consisting of a repeated image of a cabin
  5638. </member>
  5639. <member name="F:NPOI.XWPF.UserModel.Borders.CakeSlice">
  5640. specifies an art border consisting of a repeated image of a piece of cake
  5641. </member>
  5642. <member name="F:NPOI.XWPF.UserModel.Borders.CandyCorn">
  5643. specifies an art border consisting of a repeated image of candy corn
  5644. </member>
  5645. <member name="F:NPOI.XWPF.UserModel.Borders.CelticKnotwork">
  5646. specifies an art border consisting of a repeated image of a knot work
  5647. pattern
  5648. </member>
  5649. <member name="F:NPOI.XWPF.UserModel.Borders.CertificateBanner">
  5650. specifies an art border consisting of a banner.
  5651. <p>
  5652. if the border is on the left or right, no border is displayed.
  5653. </p>
  5654. </member>
  5655. <member name="F:NPOI.XWPF.UserModel.Borders.ChainLink">
  5656. specifies an art border consisting of a repeating image of a chain link
  5657. pattern.
  5658. </member>
  5659. <member name="F:NPOI.XWPF.UserModel.Borders.ChampagneBottle">
  5660. specifies an art border consisting of a repeated image of a champagne
  5661. bottle
  5662. </member>
  5663. <member name="F:NPOI.XWPF.UserModel.Borders.CheckedBarBlack">
  5664. specifies an art border consisting of repeating images of a compass
  5665. </member>
  5666. <member name="F:NPOI.XWPF.UserModel.Borders.CheckedBarColor">
  5667. specifies an art border consisting of a repeating image of a colored
  5668. pattern.
  5669. </member>
  5670. <member name="F:NPOI.XWPF.UserModel.Borders.Checkered">
  5671. specifies an art border consisting of a repeated image of a checkerboard
  5672. </member>
  5673. <member name="F:NPOI.XWPF.UserModel.Borders.ChristmasTree">
  5674. specifies an art border consisting of a repeated image of a christmas
  5675. tree
  5676. </member>
  5677. <member name="F:NPOI.XWPF.UserModel.Borders.CirclesLines">
  5678. specifies an art border consisting of repeating images of lines and
  5679. circles
  5680. </member>
  5681. <member name="F:NPOI.XWPF.UserModel.Borders.CirclesRectangles">
  5682. specifies an art border consisting of a repeated image of a rectangular
  5683. pattern
  5684. </member>
  5685. <member name="F:NPOI.XWPF.UserModel.Borders.ClassicalWave">
  5686. specifies an art border consisting of a repeated image of a wave
  5687. </member>
  5688. <member name="F:NPOI.XWPF.UserModel.Borders.Clocks">
  5689. specifies an art border consisting of a repeated image of a clock
  5690. </member>
  5691. <member name="F:NPOI.XWPF.UserModel.Borders.Compass">
  5692. specifies an art border consisting of repeating images of a compass
  5693. </member>
  5694. <member name="F:NPOI.XWPF.UserModel.Borders.Confetti">
  5695. specifies an art border consisting of a repeated image of confetti
  5696. </member>
  5697. <member name="F:NPOI.XWPF.UserModel.Borders.ConfettiGrays">
  5698. specifies an art border consisting of a repeated image of confetti
  5699. </member>
  5700. <member name="F:NPOI.XWPF.UserModel.Borders.ConfettiOutline">
  5701. specifies an art border consisting of a repeated image of confetti
  5702. </member>
  5703. <member name="F:NPOI.XWPF.UserModel.Borders.ConfettiStreamers">
  5704. specifies an art border consisting of a repeated image of confetti
  5705. streamers
  5706. </member>
  5707. <member name="F:NPOI.XWPF.UserModel.Borders.ConfettiWhite">
  5708. specifies an art border consisting of a repeated image of confetti
  5709. </member>
  5710. <member name="F:NPOI.XWPF.UserModel.Borders.CornerTriangles">
  5711. specifies an art border consisting of a repeated image
  5712. </member>
  5713. <member name="F:NPOI.XWPF.UserModel.Borders.CouponCutoutDashes">
  5714. specifies an art border consisting of a dashed line
  5715. </member>
  5716. <member name="F:NPOI.XWPF.UserModel.Borders.CouponCutoutDots">
  5717. specifies an art border consisting of a dotted line
  5718. </member>
  5719. <member name="F:NPOI.XWPF.UserModel.Borders.CrazyMaze">
  5720. specifies an art border consisting of a repeated image of a maze-like
  5721. pattern
  5722. </member>
  5723. <member name="F:NPOI.XWPF.UserModel.Borders.CreaturesButterfly">
  5724. specifies an art border consisting of a repeated image of a butterfly
  5725. </member>
  5726. <member name="F:NPOI.XWPF.UserModel.Borders.CreaturesFish">
  5727. specifies an art border consisting of a repeated image of a fish
  5728. </member>
  5729. <member name="F:NPOI.XWPF.UserModel.Borders.CreaturesInsects">
  5730. specifies an art border consisting of repeating images of insects.
  5731. </member>
  5732. <member name="F:NPOI.XWPF.UserModel.Borders.CreaturesLadyBug">
  5733. specifies an art border consisting of a repeated image of a ladybug
  5734. </member>
  5735. <member name="F:NPOI.XWPF.UserModel.Borders.CrossStitch">
  5736. specifies an art border consisting of repeating images of a cross-stitch
  5737. pattern
  5738. </member>
  5739. <member name="F:NPOI.XWPF.UserModel.Borders.Cup">
  5740. specifies an art border consisting of a repeated image of cupid
  5741. </member>
  5742. <member name="T:NPOI.XWPF.UserModel.BreakClear">
  5743. Specifies the Set of possible restart locations which may be used as to
  5744. determine the next available line when a break's type attribute has a value
  5745. of textWrapping.
  5746. @author Gisella Bronzetti
  5747. </member>
  5748. <member name="F:NPOI.XWPF.UserModel.BreakClear.NONE">
  5749. Specifies that the text wrapping break shall advance the text to the next
  5750. line in the WordProcessingML document, regardless of its position left to
  5751. right or the presence of any floating objects which intersect with the
  5752. line,
  5753. This is the Setting for a typical line break in a document.
  5754. </member>
  5755. <member name="F:NPOI.XWPF.UserModel.BreakClear.LEFT">
  5756. Specifies that the text wrapping break shall behave as follows:
  5757. <ul>
  5758. <li> If this line is broken into multiple regions (a floating object in
  5759. the center of the page has text wrapping on both sides:
  5760. <ul>
  5761. <li> If this is the leftmost region of text flow on this line, advance
  5762. the text to the next position on the line </li>
  5763. <li>Otherwise, treat this as a text wrapping break of type all. </li>
  5764. </ul>
  5765. </li>
  5766. <li> If this line is not broken into multiple regions, then treat this
  5767. break as a text wrapping break of type none. </li>
  5768. </ul>
  5769. <li> If the parent paragraph is right to left, then these behaviors are
  5770. also reversed. </li>
  5771. </member>
  5772. <!-- Badly formed XML comment ignored for member "F:NPOI.XWPF.UserModel.BreakClear.RIGHT" -->
  5773. <member name="F:NPOI.XWPF.UserModel.BreakClear.ALL">
  5774. Specifies that the text wrapping break shall advance the text to the next
  5775. line in the WordProcessingML document which spans the full width of the
  5776. line.
  5777. </member>
  5778. <member name="T:NPOI.XWPF.UserModel.BreakType">
  5779. Specifies the possible types of break characters in a WordProcessingML
  5780. document.
  5781. The break type determines the next location where text shall be
  5782. placed After this manual break is applied to the text contents
  5783. @author Gisella Bronzetti
  5784. </member>
  5785. <member name="F:NPOI.XWPF.UserModel.BreakType.PAGE">
  5786. Specifies that the current break shall restart itself on the next page of
  5787. the document when the document is displayed in page view.
  5788. </member>
  5789. <member name="F:NPOI.XWPF.UserModel.BreakType.COLUMN">
  5790. Specifies that the current break shall restart itself on the next column
  5791. available on the current page when the document is displayed in page
  5792. view.
  5793. <p>
  5794. If the current section is not divided into columns, or the column break
  5795. occurs in the last column on the current page when displayed, then the
  5796. restart location for text shall be the next page in the document.
  5797. </p>
  5798. </member>
  5799. <member name="F:NPOI.XWPF.UserModel.BreakType.TEXTWRAPPING">
  5800. Specifies that the current break shall restart itself on the next line in
  5801. the document when the document is displayed in page view.
  5802. The determine of the next line shall be done subject to the value of the clear
  5803. attribute on the specified break character.
  5804. </member>
  5805. <member name="F:NPOI.XWPF.UserModel.PictureType.EMF">
  5806. Extended windows meta file
  5807. </member>
  5808. <member name="F:NPOI.XWPF.UserModel.PictureType.WMF">
  5809. Windows Meta File
  5810. </member>
  5811. <member name="F:NPOI.XWPF.UserModel.PictureType.PICT">
  5812. Mac PICT format
  5813. </member>
  5814. <member name="F:NPOI.XWPF.UserModel.PictureType.JPEG">
  5815. JPEG format
  5816. </member>
  5817. <member name="F:NPOI.XWPF.UserModel.PictureType.PNG">
  5818. PNG format
  5819. </member>
  5820. <member name="F:NPOI.XWPF.UserModel.PictureType.DIB">
  5821. Device independent bitmap
  5822. </member>
  5823. <member name="F:NPOI.XWPF.UserModel.PictureType.GIF">
  5824. GIF image format
  5825. </member>
  5826. <member name="F:NPOI.XWPF.UserModel.PictureType.TIFF">
  5827. Tag Image File (.tiff)
  5828. </member>
  5829. <member name="F:NPOI.XWPF.UserModel.PictureType.EPS">
  5830. Encapsulated Postscript (.eps)
  5831. </member>
  5832. <member name="F:NPOI.XWPF.UserModel.PictureType.BMP">
  5833. Windows Bitmap (.bmp)
  5834. </member>
  5835. <member name="F:NPOI.XWPF.UserModel.PictureType.WPG">
  5836. WordPerfect graphics (.wpg)
  5837. </member>
  5838. <member name="T:NPOI.XWPF.UserModel.IBody">
  5839. An IBody represents the different parts of the document which
  5840. can contain collections of Paragraphs and Tables. It provides a
  5841. common way to work with these and their contents.
  5842. Typically, this is something like a XWPFDocument, or one of
  5843. the parts in it like XWPFHeader, XWPFFooter, XWPFTableCell
  5844. </member>
  5845. <member name="M:NPOI.XWPF.UserModel.IBody.GetParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  5846. if there is a corresponding {@link XWPFParagraph} of the parameter ctTable in the paragraphList of this header or footer
  5847. the method will return this paragraph
  5848. if there is no corresponding {@link XWPFParagraph} the method will return null
  5849. @param p is instance of CTP and is searching for an XWPFParagraph
  5850. @return null if there is no XWPFParagraph with an corresponding CTPparagraph in the paragraphList of this header or footer
  5851. XWPFParagraph with the correspondig CTP p
  5852. </member>
  5853. <member name="M:NPOI.XWPF.UserModel.IBody.GetTable(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  5854. if there is a corresponding {@link XWPFTable} of the parameter ctTable in the tableList of this header
  5855. the method will return this table
  5856. if there is no corresponding {@link XWPFTable} the method will return null
  5857. @param ctTable
  5858. </member>
  5859. <member name="M:NPOI.XWPF.UserModel.IBody.GetParagraphArray(System.Int32)">
  5860. Returns the paragraph that of position pos
  5861. </member>
  5862. <member name="M:NPOI.XWPF.UserModel.IBody.GetTableArray(System.Int32)">
  5863. Returns the table at position pos
  5864. </member>
  5865. <member name="M:NPOI.XWPF.UserModel.IBody.InsertNewParagraph(System.Xml.XmlDocument)">
  5866. inserts a new paragraph at position of the cursor
  5867. @param cursor
  5868. </member>
  5869. <member name="M:NPOI.XWPF.UserModel.IBody.InsertNewTbl(System.Xml.XmlDocument)">
  5870. inserts a new Table at the cursor position.
  5871. @param cursor
  5872. </member>
  5873. <member name="M:NPOI.XWPF.UserModel.IBody.InsertTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  5874. inserts a new Table at position pos
  5875. @param pos
  5876. @param table
  5877. </member>
  5878. <member name="M:NPOI.XWPF.UserModel.IBody.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  5879. returns the TableCell to which the Table belongs
  5880. @param cell
  5881. </member>
  5882. <member name="M:NPOI.XWPF.UserModel.IBody.GetXWPFDocument">
  5883. Return XWPFDocument
  5884. </member>
  5885. <member name="P:NPOI.XWPF.UserModel.IBody.Part">
  5886. returns the Part, to which the body belongs, which you need for Adding relationship to other parts
  5887. Actually it is needed of the class XWPFTableCell. Because you have to know to which part the tableCell
  5888. belongs.
  5889. @return the Part, to which the body belongs
  5890. </member>
  5891. <member name="P:NPOI.XWPF.UserModel.IBody.PartType">
  5892. Get the PartType of the body, for example
  5893. DOCUMENT, HEADER, FOOTER, FOOTNOTE,
  5894. @return the PartType of the body
  5895. </member>
  5896. <member name="P:NPOI.XWPF.UserModel.IBody.BodyElements">
  5897. Returns an Iterator with paragraphs and tables,
  5898. in the order that they occur in the text.
  5899. </member>
  5900. <member name="P:NPOI.XWPF.UserModel.IBody.Paragraphs">
  5901. Returns the paragraph(s) that holds
  5902. the text of the header or footer.
  5903. </member>
  5904. <member name="P:NPOI.XWPF.UserModel.IBody.Tables">
  5905. Return the table(s) that holds the text
  5906. of the IBodyPart, for complex cases
  5907. where a paragraph isn't used.
  5908. </member>
  5909. <member name="T:NPOI.XWPF.UserModel.IBodyElement">
  5910. 9 Jan 2010
  5911. @author Philipp Epp
  5912. </member>
  5913. <!-- Badly formed XML comment ignored for member "T:NPOI.XWPF.UserModel.ICell" -->
  5914. <member name="T:NPOI.XWPF.UserModel.IRunBody">
  5915. Simple interface describing both {@link XWPFParagraph}
  5916. and {@link XWPFSDT}
  5917. </member>
  5918. <member name="T:NPOI.XWPF.UserModel.IRunElement">
  5919. Common interface for things that can occur
  5920. where a run (text with common stylings) can,
  5921. eg {@link XWPFRun} or {@link XWPFSDT}.
  5922. More methods to follow shortly!
  5923. </member>
  5924. <member name="T:NPOI.XWPF.UserModel.ISDTContent">
  5925. Experimental interface to offer rudimentary Read-only Processing of
  5926. of the contentblock of an SDT/ContentControl.
  5927. <p/>
  5928. <p/>
  5929. <p/>
  5930. WARNING - APIs expected to change rapidly
  5931. </member>
  5932. <member name="T:NPOI.XWPF.UserModel.LineSpacingRule">
  5933. Specifies the logic which shall be used to calculate the line spacing of the
  5934. parent object when it is displayed in the document.
  5935. @author Gisella Bronzetti
  5936. </member>
  5937. <member name="F:NPOI.XWPF.UserModel.LineSpacingRule.AUTO">
  5938. Specifies that the line spacing of the parent object shall be
  5939. automatically determined by the size of its contents, with no
  5940. predetermined minimum or maximum size.
  5941. </member>
  5942. <member name="F:NPOI.XWPF.UserModel.LineSpacingRule.EXACT">
  5943. Specifies that the height of the line shall be exactly the value
  5944. specified, regardless of the size of the contents If the contents are too
  5945. large for the specified height, then they shall be clipped as necessary.
  5946. </member>
  5947. <member name="F:NPOI.XWPF.UserModel.LineSpacingRule.ATLEAST">
  5948. Specifies that the height of the line shall be at least the value
  5949. specified, but may be expanded to fit its content as needed.
  5950. </member>
  5951. <member name="T:NPOI.XWPF.UserModel.ParagraphAlignment">
  5952. Specifies all types of alignment which are available to be applied to objects in a
  5953. WordProcessingML document
  5954. @author Yegor Kozlov
  5955. </member>
  5956. <member name="T:NPOI.XWPF.UserModel.PositionInParagraph">
  5957. * postion of a character in a paragrapho
  5958. * 1st RunPositon
  5959. * 2nd TextPosition
  5960. * 3rd CharacterPosition
  5961. *
  5962. *
  5963. </member>
  5964. <member name="T:NPOI.XWPF.UserModel.TextAlignment">
  5965. Specifies all types of vertical alignment which are available to be applied to of all text
  5966. on each line displayed within a paragraph.
  5967. @author Gisella Bronzetti
  5968. </member>
  5969. <member name="F:NPOI.XWPF.UserModel.TextAlignment.TOP">
  5970. Specifies that all text in the parent object shall be
  5971. aligned to the top of each character when displayed
  5972. </member>
  5973. <member name="F:NPOI.XWPF.UserModel.TextAlignment.CENTER">
  5974. Specifies that all text in the parent object shall be
  5975. aligned to the center of each character when displayed.
  5976. </member>
  5977. <member name="F:NPOI.XWPF.UserModel.TextAlignment.BASELINE">
  5978. Specifies that all text in the parent object shall be
  5979. aligned to the baseline of each character when displayed.
  5980. </member>
  5981. <member name="F:NPOI.XWPF.UserModel.TextAlignment.BOTTOM">
  5982. Specifies that all text in the parent object shall be
  5983. aligned to the bottom of each character when displayed.
  5984. </member>
  5985. <member name="F:NPOI.XWPF.UserModel.TextAlignment.AUTO">
  5986. Specifies that all text in the parent object shall be
  5987. aligned automatically when displayed.
  5988. </member>
  5989. <member name="T:NPOI.XWPF.UserModel.TextSegement">
  5990. saves the begin and end position of a text in a Paragraph
  5991. </member>
  5992. <member name="P:NPOI.XWPF.UserModel.TextSegement.BeginRun">
  5993. <summary>
  5994. The index of the start run
  5995. </summary>
  5996. </member>
  5997. <member name="P:NPOI.XWPF.UserModel.TextSegement.BeginText">
  5998. <summary>
  5999. The index of the start CT_Text
  6000. </summary>
  6001. </member>
  6002. <member name="P:NPOI.XWPF.UserModel.TextSegement.BeginChar">
  6003. <summary>
  6004. The index of the start text character
  6005. </summary>
  6006. </member>
  6007. <member name="P:NPOI.XWPF.UserModel.TextSegement.EndText">
  6008. <summary>
  6009. the index of the end CT_Text
  6010. </summary>
  6011. </member>
  6012. <member name="P:NPOI.XWPF.UserModel.TextSegement.EndChar">
  6013. <summary>
  6014. the index of the end text character
  6015. </summary>
  6016. </member>
  6017. <member name="T:NPOI.XWPF.UserModel.UnderlinePatterns">
  6018. Specifies the types of patterns which may be used to create the underline
  6019. applied beneath the text in a Run.
  6020. @author Gisella Bronzetti
  6021. </member>
  6022. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Single">
  6023. Specifies an underline consisting of a single line beneath all characters
  6024. in this Run.
  6025. </member>
  6026. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Words">
  6027. Specifies an underline consisting of a single line beneath all non-space
  6028. characters in the Run. There shall be no underline beneath any space
  6029. character (breaking or non-breaking).
  6030. </member>
  6031. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Double">
  6032. Specifies an underline consisting of two lines beneath all characters in
  6033. this run
  6034. </member>
  6035. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Thick">
  6036. Specifies an underline consisting of a single thick line beneath all
  6037. characters in this Run.
  6038. </member>
  6039. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Dotted">
  6040. Specifies an underline consisting of a series of dot characters beneath
  6041. all characters in this Run.
  6042. </member>
  6043. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DottedHeavy">
  6044. Specifies an underline consisting of a series of thick dot characters
  6045. beneath all characters in this Run.
  6046. </member>
  6047. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Dash">
  6048. Specifies an underline consisting of a dashed line beneath all characters
  6049. in this Run.
  6050. </member>
  6051. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DashedHeavy">
  6052. Specifies an underline consisting of a series of thick dashes beneath all
  6053. characters in this Run.
  6054. </member>
  6055. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DashLong">
  6056. Specifies an underline consisting of long dashed characters beneath all
  6057. characters in this Run.
  6058. </member>
  6059. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DashLongHeavy">
  6060. Specifies an underline consisting of thick long dashed characters beneath
  6061. all characters in this Run.
  6062. </member>
  6063. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DotDash">
  6064. Specifies an underline consisting of a series of dash, dot characters
  6065. beneath all characters in this Run.
  6066. </member>
  6067. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DashDotHeavy">
  6068. Specifies an underline consisting of a series of thick dash, dot
  6069. characters beneath all characters in this Run.
  6070. </member>
  6071. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DotDotDash">
  6072. Specifies an underline consisting of a series of dash, dot, dot
  6073. characters beneath all characters in this Run.
  6074. </member>
  6075. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DashDotDotHeavy">
  6076. Specifies an underline consisting of a series of thick dash, dot, dot
  6077. characters beneath all characters in this Run.
  6078. </member>
  6079. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Wave">
  6080. Specifies an underline consisting of a single wavy line beneath all
  6081. characters in this Run.
  6082. </member>
  6083. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.WavyHeavy">
  6084. Specifies an underline consisting of a single thick wavy line beneath all
  6085. characters in this Run.
  6086. </member>
  6087. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.WavyDouble">
  6088. Specifies an underline consisting of a pair of wavy lines beneath all
  6089. characters in this Run.
  6090. </member>
  6091. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.None">
  6092. Specifies no underline beneath this Run.
  6093. </member>
  6094. <member name="T:NPOI.XWPF.UserModel.VerticalAlign">
  6095. Specifies possible values for the alignment of the contents of this run in
  6096. relation to the default appearance of the Run's text. This allows the text to
  6097. be repositioned as subscript or superscript without altering the font size of
  6098. the run properties.
  6099. @author Gisella Bronzetti
  6100. </member>
  6101. <member name="F:NPOI.XWPF.UserModel.VerticalAlign.BASELINE">
  6102. Specifies that the text in the parent run shall be located at the
  6103. baseline and presented in the same size as surrounding text.
  6104. </member>
  6105. <member name="F:NPOI.XWPF.UserModel.VerticalAlign.SUPERSCRIPT">
  6106. Specifies that this text should be subscript. This Setting shall lower
  6107. the text in this run below the baseline and change it to a smaller size,
  6108. if a smaller size is available.
  6109. </member>
  6110. <member name="F:NPOI.XWPF.UserModel.VerticalAlign.SUBSCRIPT">
  6111. Specifies that this text should be superscript. This Setting shall raise
  6112. the text in this run above the baseline and change it to a smaller size,
  6113. if a smaller size is available.
  6114. </member>
  6115. <member name="T:NPOI.XWPF.UserModel.XWPFAbstractNum">
  6116. @author Philipp Epp
  6117. </member>
  6118. <member name="P:NPOI.XWPF.UserModel.XWPFAbstractNum.MultiLevelType">
  6119. <summary>
  6120. Abstract Numbering Definition Type
  6121. </summary>
  6122. </member>
  6123. <member name="T:NPOI.XWPF.UserModel.MultiLevelType">
  6124. <summary>
  6125. Numbering Definition Type
  6126. </summary>
  6127. </member>
  6128. <member name="F:NPOI.XWPF.UserModel.MultiLevelType.SingleLevel">
  6129. <summary>
  6130. Single Level Numbering Definition
  6131. </summary>
  6132. </member>
  6133. <member name="F:NPOI.XWPF.UserModel.MultiLevelType.Multilevel">
  6134. <summary>
  6135. Multilevel Numbering Definition
  6136. </summary>
  6137. </member>
  6138. <member name="F:NPOI.XWPF.UserModel.MultiLevelType.HybridMultilevel">
  6139. <summary>
  6140. Hybrid Multilevel Numbering Definition
  6141. </summary>
  6142. </member>
  6143. <member name="T:NPOI.XWPF.UserModel.NumberFormat">
  6144. <summary>
  6145. Numbering Format
  6146. </summary>
  6147. </member>
  6148. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Decimal">
  6149. <summary>
  6150. Decimal Numbers
  6151. </summary>
  6152. </member>
  6153. <member name="F:NPOI.XWPF.UserModel.NumberFormat.UpperRoman">
  6154. <summary>
  6155. Uppercase Roman Numerals
  6156. </summary>
  6157. </member>
  6158. <member name="F:NPOI.XWPF.UserModel.NumberFormat.LowerRoman">
  6159. <summary>
  6160. Lowercase Roman Numerals
  6161. </summary>
  6162. </member>
  6163. <member name="F:NPOI.XWPF.UserModel.NumberFormat.UpperLetter">
  6164. <summary>
  6165. Uppercase Latin Alphabet
  6166. </summary>
  6167. </member>
  6168. <member name="F:NPOI.XWPF.UserModel.NumberFormat.LowerLetter">
  6169. <summary>
  6170. Lowercase Latin Alphabet
  6171. </summary>
  6172. </member>
  6173. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Ordinal">
  6174. <summary>
  6175. Ordinal
  6176. </summary>
  6177. </member>
  6178. <member name="F:NPOI.XWPF.UserModel.NumberFormat.CardinalText">
  6179. <summary>
  6180. Cardinal Text
  6181. </summary>
  6182. </member>
  6183. <member name="F:NPOI.XWPF.UserModel.NumberFormat.OrdinalText">
  6184. <summary>
  6185. Ordinal Text
  6186. </summary>
  6187. </member>
  6188. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Hex">
  6189. <summary>
  6190. Hexadecimal Numbering
  6191. </summary>
  6192. </member>
  6193. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Chicago">
  6194. <summary>
  6195. Chicago Manual of Style
  6196. </summary>
  6197. </member>
  6198. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographDigital">
  6199. <summary>
  6200. Ideographs
  6201. </summary>
  6202. </member>
  6203. <member name="F:NPOI.XWPF.UserModel.NumberFormat.JapaneseCounting">
  6204. <summary>
  6205. Japanese Counting System
  6206. </summary>
  6207. </member>
  6208. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Aiueo">
  6209. <summary>
  6210. AIUEO Order Hiragana
  6211. </summary>
  6212. </member>
  6213. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Iroha">
  6214. <summary>
  6215. Iroha Ordered Katakana
  6216. </summary>
  6217. </member>
  6218. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalFullWidth">
  6219. <summary>
  6220. Double Byte Arabic Numerals
  6221. </summary>
  6222. </member>
  6223. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalHalfWidth">
  6224. <summary>
  6225. Single Byte Arabic Numerals
  6226. </summary>
  6227. </member>
  6228. <member name="F:NPOI.XWPF.UserModel.NumberFormat.JapaneseLegal">
  6229. <summary>
  6230. Japanese Legal Numbering
  6231. </summary>
  6232. </member>
  6233. <member name="F:NPOI.XWPF.UserModel.NumberFormat.JapaneseDigitalTenThousand">
  6234. <summary>
  6235. Japanese Digital Ten Thousand Counting System
  6236. </summary>
  6237. </member>
  6238. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalEnclosedCircle">
  6239. <summary>
  6240. Decimal Numbers Enclosed in a Circle
  6241. </summary>
  6242. </member>
  6243. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalFullWidth2">
  6244. <summary>
  6245. Double Byte Arabic Numerals Alternate
  6246. </summary>
  6247. </member>
  6248. <member name="F:NPOI.XWPF.UserModel.NumberFormat.AiueoFullWidth">
  6249. <summary>
  6250. Full-Width AIUEO Order Hiragana
  6251. </summary>
  6252. </member>
  6253. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IrohaFullWidth">
  6254. <summary>
  6255. Full-Width Iroha Ordered Katakana
  6256. </summary>
  6257. </member>
  6258. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalZero">
  6259. <summary>
  6260. Initial Zero Arabic Numerals
  6261. </summary>
  6262. </member>
  6263. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Bullet">
  6264. <summary>
  6265. Bullet
  6266. </summary>
  6267. </member>
  6268. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Ganada">
  6269. <summary>
  6270. Korean Ganada Numbering
  6271. </summary>
  6272. </member>
  6273. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Chosung">
  6274. <summary>
  6275. Korean Chosung Numbering
  6276. </summary>
  6277. </member>
  6278. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalEnclosedFullstop">
  6279. <summary>
  6280. Decimal Numbers Followed by a Period
  6281. </summary>
  6282. </member>
  6283. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalEnclosedParen">
  6284. <summary>
  6285. Decimal Numbers Enclosed in Parenthesis
  6286. </summary>
  6287. </member>
  6288. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalEnclosedCircleChinese">
  6289. <summary>
  6290. Decimal Numbers Enclosed in a Circle
  6291. </summary>
  6292. </member>
  6293. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographEnclosedCircle">
  6294. <summary>
  6295. Ideographs Enclosed in a Circle
  6296. </summary>
  6297. </member>
  6298. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographTraditional">
  6299. <summary>
  6300. Traditional Ideograph Format
  6301. </summary>
  6302. </member>
  6303. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographZodiac">
  6304. <summary>
  6305. Zodiac Ideograph Format
  6306. </summary>
  6307. </member>
  6308. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographZodiacTraditional">
  6309. <summary>
  6310. Traditional Zodiac Ideograph Format
  6311. </summary>
  6312. </member>
  6313. <member name="F:NPOI.XWPF.UserModel.NumberFormat.TaiwaneseCounting">
  6314. <summary>
  6315. Taiwanese Counting System
  6316. </summary>
  6317. </member>
  6318. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographLegalTraditional">
  6319. <summary>
  6320. Traditional Legal Ideograph Format
  6321. </summary>
  6322. </member>
  6323. <member name="F:NPOI.XWPF.UserModel.NumberFormat.TaiwaneseCountingThousand">
  6324. <summary>
  6325. Taiwanese Counting Thousand System
  6326. </summary>
  6327. </member>
  6328. <member name="F:NPOI.XWPF.UserModel.NumberFormat.TaiwaneseDigital">
  6329. <summary>
  6330. Taiwanese Digital Counting System
  6331. </summary>
  6332. </member>
  6333. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ChineseCounting">
  6334. <summary>
  6335. Chinese Counting System
  6336. </summary>
  6337. </member>
  6338. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ChineseLegalSimplified">
  6339. <summary>
  6340. Chinese Legal Simplified Format
  6341. </summary>
  6342. </member>
  6343. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ChineseCountingThousand">
  6344. <summary>
  6345. Chinese Counting Thousand System
  6346. </summary>
  6347. </member>
  6348. <member name="F:NPOI.XWPF.UserModel.NumberFormat.KoreanDigital">
  6349. <summary>
  6350. Korean Digital Counting System
  6351. </summary>
  6352. </member>
  6353. <member name="F:NPOI.XWPF.UserModel.NumberFormat.KoreanCounting">
  6354. <summary>
  6355. Korean Counting System
  6356. </summary>
  6357. </member>
  6358. <member name="F:NPOI.XWPF.UserModel.NumberFormat.KoreanLegal">
  6359. <summary>
  6360. Korean Legal Numbering
  6361. </summary>
  6362. </member>
  6363. <member name="F:NPOI.XWPF.UserModel.NumberFormat.KoreanDigital2">
  6364. <summary>
  6365. Korean Digital Counting System Alternate
  6366. </summary>
  6367. </member>
  6368. <member name="F:NPOI.XWPF.UserModel.NumberFormat.VietnameseCounting">
  6369. <summary>
  6370. Vietnamese Numerals
  6371. </summary>
  6372. </member>
  6373. <member name="F:NPOI.XWPF.UserModel.NumberFormat.RussianLower">
  6374. <summary>
  6375. Lowercase Russian Alphabet
  6376. </summary>
  6377. </member>
  6378. <member name="F:NPOI.XWPF.UserModel.NumberFormat.RussianUpper">
  6379. <summary>
  6380. Uppercase Russian Alphabet
  6381. </summary>
  6382. </member>
  6383. <member name="F:NPOI.XWPF.UserModel.NumberFormat.None">
  6384. <summary>
  6385. No Numbering
  6386. </summary>
  6387. </member>
  6388. <member name="F:NPOI.XWPF.UserModel.NumberFormat.NumberInDash">
  6389. <summary>
  6390. Number With Dashes
  6391. </summary>
  6392. </member>
  6393. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Hebrew1">
  6394. <summary>
  6395. Hebrew Numerals
  6396. </summary>
  6397. </member>
  6398. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Hebrew2">
  6399. <summary>
  6400. Hebrew Alphabet
  6401. </summary>
  6402. </member>
  6403. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ArabicAlpha">
  6404. <summary>
  6405. Arabic Alphabet
  6406. </summary>
  6407. </member>
  6408. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ArabicAbjad">
  6409. <summary>
  6410. Arabic Abjad Numerals
  6411. </summary>
  6412. </member>
  6413. <member name="F:NPOI.XWPF.UserModel.NumberFormat.HindiVowels">
  6414. <summary>
  6415. Hindi Vowels
  6416. </summary>
  6417. </member>
  6418. <member name="F:NPOI.XWPF.UserModel.NumberFormat.HindiConsonants">
  6419. <summary>
  6420. Hindi Consonants
  6421. </summary>
  6422. </member>
  6423. <member name="F:NPOI.XWPF.UserModel.NumberFormat.HindiNumbers">
  6424. <summary>
  6425. Hindi Numbers
  6426. </summary>
  6427. </member>
  6428. <member name="F:NPOI.XWPF.UserModel.NumberFormat.HindiCounting">
  6429. <summary>
  6430. Hindi Counting System
  6431. </summary>
  6432. </member>
  6433. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ThaiLetters">
  6434. <summary>
  6435. Thai Letters
  6436. </summary>
  6437. </member>
  6438. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ThaiNumbers">
  6439. <summary>
  6440. Thai Numerals
  6441. </summary>
  6442. </member>
  6443. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ThaiCounting">
  6444. <summary>
  6445. Thai Counting System
  6446. </summary>
  6447. </member>
  6448. <member name="T:NPOI.XWPF.UserModel.XWPFComment">
  6449. * Sketch of XWPF comment class
  6450. *
  6451. * @author Yury Batrakov (batrakov at gmail.com)
  6452. *
  6453. </member>
  6454. <member name="T:NPOI.XWPF.UserModel.XWPFDefaultParagraphStyle">
  6455. Default Paragraph style, from which other styles will override
  6456. TODO Share logic with {@link XWPFParagraph} which also uses CTPPr
  6457. </member>
  6458. <member name="T:NPOI.XWPF.UserModel.XWPFDefaultRunStyle">
  6459. Default Character Run style, from which other styles will override
  6460. TODO Share logic with {@link XWPFRun} which also uses CTRPr
  6461. </member>
  6462. <member name="T:NPOI.XWPF.UserModel.XWPFDocument">
  6463. <p>High(ish) level class for working with .docx files.</p>
  6464. <p>This class tries to hide some of the complexity
  6465. of the underlying file format, but as it's not a
  6466. mature and stable API yet, certain parts of the
  6467. XML structure come through. You'll therefore almost
  6468. certainly need to refer to the OOXML specifications
  6469. from
  6470. http://www.ecma-international.org/publications/standards/Ecma-376.htm
  6471. at some point in your use.</p>
  6472. </member>
  6473. <member name="F:NPOI.XWPF.UserModel.XWPFDocument.drawingIdManager">
  6474. Keeps track on all id-values used in this document and included parts, like headers, footers, etc.
  6475. </member>
  6476. <member name="F:NPOI.XWPF.UserModel.XWPFDocument.headerFooterPolicy">
  6477. Handles the joy of different headers/footers for different pages
  6478. </member>
  6479. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.NewPackage">
  6480. Create a new WordProcessingML package and Setup the default minimal content
  6481. </member>
  6482. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.OnDocumentCreate">
  6483. Create a new CT_Document with all values Set to default
  6484. </member>
  6485. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetTableArray(System.Int32)">
  6486. @see NPOI.XWPF.UserModel.IBody#getTableArray(int)
  6487. </member>
  6488. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetPartById(System.String)">
  6489. Get the document part that's defined as the
  6490. given relationship of the core document.
  6491. </member>
  6492. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetHeaderFooterPolicy">
  6493. Returns the policy on headers and footers, which
  6494. also provides a way to Get at them.
  6495. </member>
  6496. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetCTStyle">
  6497. Returns the styles object used
  6498. </member>
  6499. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetAllEmbedds">
  6500. Get the document's embedded files.
  6501. </member>
  6502. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetBodyElementSpecificPos(System.Int32,System.Collections.Generic.List{NPOI.XWPF.UserModel.IBodyElement})">
  6503. Finds that for example the 2nd entry in the body list is the 1st paragraph
  6504. </member>
  6505. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetParagraphPos(System.Int32)">
  6506. Look up the paragraph at the specified position in the body elemnts list
  6507. and return this paragraphs position in the paragraphs list
  6508. @param pos
  6509. The position of the relevant paragraph in the body elements
  6510. list
  6511. @return the position of the paragraph in the paragraphs list, if there is
  6512. a paragraph at the position in the bodyelements list. Else it
  6513. will return -1
  6514. </member>
  6515. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetTablePos(System.Int32)">
  6516. Get with the position of a table in the bodyelement array list
  6517. the position of this table in the table array list
  6518. @param pos position of the table in the bodyelement array list
  6519. @return if there is a table at the position in the bodyelement array list,
  6520. else it will return null.
  6521. </member>
  6522. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.InsertNewParagraph(System.Xml.XmlDocument)">
  6523. Add a new paragraph at position of the cursor. The cursor must be on the
  6524. {@link org.apache.xmlbeans.XmlCursor.TokenType#START} tag of an subelement
  6525. of the documents body. When this method is done, the cursor passed as
  6526. parameter points to the {@link org.apache.xmlbeans.XmlCursor.TokenType#END}
  6527. of the newly inserted paragraph.
  6528. @param cursor
  6529. @return the {@link XWPFParagraph} object representing the newly inserted
  6530. CTP object
  6531. </member>
  6532. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsCursorInBody(System.Xml.XmlDocument)">
  6533. verifies that cursor is on the right position
  6534. @param cursor
  6535. </member>
  6536. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetPosOfParagraph(NPOI.XWPF.UserModel.XWPFParagraph)">
  6537. Get the position of the paragraph, within the list
  6538. of all the body elements.
  6539. @param p The paragraph to find
  6540. @return The location, or -1 if the paragraph couldn't be found
  6541. </member>
  6542. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetPosOfTable(NPOI.XWPF.UserModel.XWPFTable)">
  6543. Get the position of the table, within the list of
  6544. all the body elements.
  6545. @param t The table to find
  6546. @return The location, or -1 if the table couldn't be found
  6547. </member>
  6548. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.Commit">
  6549. Commit and saves the document
  6550. </member>
  6551. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetRelationIndex(NPOI.XWPF.UserModel.XWPFRelation)">
  6552. Gets the index of the relation we're trying to create
  6553. @param relation
  6554. @return i
  6555. </member>
  6556. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateParagraph">
  6557. Appends a new paragraph to this document
  6558. @return a new paragraph
  6559. </member>
  6560. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateNumbering">
  6561. Creates an empty numbering if one does not already exist and Sets the numbering member
  6562. @return numbering
  6563. </member>
  6564. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateStyles">
  6565. Creates an empty styles for the document if one does not already exist
  6566. @return styles
  6567. </member>
  6568. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateFootnotes">
  6569. Creates an empty footnotes element for the document if one does not already exist
  6570. @return footnotes
  6571. </member>
  6572. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.RemoveBodyElement(System.Int32)">
  6573. remove a BodyElement from bodyElements array list
  6574. @param pos
  6575. @return true if removing was successfully, else return false
  6576. </member>
  6577. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.SetParagraph(NPOI.XWPF.UserModel.XWPFParagraph,System.Int32)">
  6578. copies content of a paragraph to a existing paragraph in the list paragraphs at position pos
  6579. @param paragraph
  6580. @param pos
  6581. </member>
  6582. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetLastParagraph">
  6583. @return the LastParagraph of the document
  6584. </member>
  6585. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateTable">
  6586. Create an empty table with one row and one column as default.
  6587. @return a new table
  6588. </member>
  6589. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateTable(System.Int32,System.Int32)">
  6590. Create an empty table with a number of rows and cols specified
  6591. @param rows
  6592. @param cols
  6593. @return table
  6594. </member>
  6595. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateTOC">
  6596. </member>
  6597. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.SetTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  6598. Replace content of table in array tables at position pos with a
  6599. @param pos
  6600. @param table
  6601. </member>
  6602. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsEnforcedReadonlyProtection">
  6603. Verifies that the documentProtection tag in Settings.xml file <br/>
  6604. specifies that the protection is enforced (w:enforcement="1") <br/>
  6605. and that the kind of protection is ReadOnly (w:edit="readOnly")<br/>
  6606. <br/>
  6607. sample snippet from Settings.xml
  6608. <pre>
  6609. &lt;w:settings ... &gt;
  6610. &lt;w:documentProtection w:edit=&quot;readOnly&quot; w:enforcement=&quot;1&quot;/&gt;
  6611. </pre>
  6612. @return true if documentProtection is enforced with option ReadOnly
  6613. </member>
  6614. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsEnforcedFillingFormsProtection">
  6615. Verifies that the documentProtection tag in Settings.xml file <br/>
  6616. specifies that the protection is enforced (w:enforcement="1") <br/>
  6617. and that the kind of protection is forms (w:edit="forms")<br/>
  6618. <br/>
  6619. sample snippet from Settings.xml
  6620. <pre>
  6621. &lt;w:settings ... &gt;
  6622. &lt;w:documentProtection w:edit=&quot;forms&quot; w:enforcement=&quot;1&quot;/&gt;
  6623. </pre>
  6624. @return true if documentProtection is enforced with option forms
  6625. </member>
  6626. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsEnforcedCommentsProtection">
  6627. Verifies that the documentProtection tag in Settings.xml file <br/>
  6628. specifies that the protection is enforced (w:enforcement="1") <br/>
  6629. and that the kind of protection is comments (w:edit="comments")<br/>
  6630. <br/>
  6631. sample snippet from Settings.xml
  6632. <pre>
  6633. &lt;w:settings ... &gt;
  6634. &lt;w:documentProtection w:edit=&quot;comments&quot; w:enforcement=&quot;1&quot;/&gt;
  6635. </pre>
  6636. @return true if documentProtection is enforced with option comments
  6637. </member>
  6638. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsEnforcedTrackedChangesProtection">
  6639. Verifies that the documentProtection tag in Settings.xml file <br/>
  6640. specifies that the protection is enforced (w:enforcement="1") <br/>
  6641. and that the kind of protection is trackedChanges (w:edit="trackedChanges")<br/>
  6642. <br/>
  6643. sample snippet from Settings.xml
  6644. <pre>
  6645. &lt;w:settings ... &gt;
  6646. &lt;w:documentProtection w:edit=&quot;trackedChanges&quot; w:enforcement=&quot;1&quot;/&gt;
  6647. </pre>
  6648. @return true if documentProtection is enforced with option trackedChanges
  6649. </member>
  6650. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.EnforceReadonlyProtection">
  6651. Enforces the ReadOnly protection.<br/>
  6652. In the documentProtection tag inside Settings.xml file, <br/>
  6653. it Sets the value of enforcement to "1" (w:enforcement="1") <br/>
  6654. and the value of edit to ReadOnly (w:edit="readOnly")<br/>
  6655. <br/>
  6656. sample snippet from Settings.xml
  6657. <pre>
  6658. &lt;w:settings ... &gt;
  6659. &lt;w:documentProtection w:edit=&quot;readOnly&quot; w:enforcement=&quot;1&quot;/&gt;
  6660. </pre>
  6661. </member>
  6662. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.EnforceFillingFormsProtection">
  6663. Enforce the Filling Forms protection.<br/>
  6664. In the documentProtection tag inside Settings.xml file, <br/>
  6665. it Sets the value of enforcement to "1" (w:enforcement="1") <br/>
  6666. and the value of edit to forms (w:edit="forms")<br/>
  6667. <br/>
  6668. sample snippet from Settings.xml
  6669. <pre>
  6670. &lt;w:settings ... &gt;
  6671. &lt;w:documentProtection w:edit=&quot;forms&quot; w:enforcement=&quot;1&quot;/&gt;
  6672. </pre>
  6673. </member>
  6674. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.EnforceCommentsProtection">
  6675. Enforce the Comments protection.<br/>
  6676. In the documentProtection tag inside Settings.xml file,<br/>
  6677. it Sets the value of enforcement to "1" (w:enforcement="1") <br/>
  6678. and the value of edit to comments (w:edit="comments")<br/>
  6679. <br/>
  6680. sample snippet from Settings.xml
  6681. <pre>
  6682. &lt;w:settings ... &gt;
  6683. &lt;w:documentProtection w:edit=&quot;comments&quot; w:enforcement=&quot;1&quot;/&gt;
  6684. </pre>
  6685. </member>
  6686. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.EnforceTrackedChangesProtection">
  6687. Enforce the Tracked Changes protection.<br/>
  6688. In the documentProtection tag inside Settings.xml file, <br/>
  6689. it Sets the value of enforcement to "1" (w:enforcement="1") <br/>
  6690. and the value of edit to trackedChanges (w:edit="trackedChanges")<br/>
  6691. <br/>
  6692. sample snippet from Settings.xml
  6693. <pre>
  6694. &lt;w:settings ... &gt;
  6695. &lt;w:documentProtection w:edit=&quot;trackedChanges&quot; w:enforcement=&quot;1&quot;/&gt;
  6696. </pre>
  6697. </member>
  6698. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.RemoveProtectionEnforcement">
  6699. Remove protection enforcement.<br/>
  6700. In the documentProtection tag inside Settings.xml file <br/>
  6701. it Sets the value of enforcement to "0" (w:enforcement="0") <br/>
  6702. </member>
  6703. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.EnforceUpdateFields">
  6704. Enforces fields update on document open (in Word).
  6705. In the settings.xml file <br/>
  6706. sets the updateSettings value to true (w:updateSettings w:val="true")
  6707. NOTICES:
  6708. <ul>
  6709. <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?"
  6710. (if "Update automatic links at open" is enabled)</li>
  6711. <li>Flag is removed after saving with changes in Word </li>
  6712. </ul>
  6713. </member>
  6714. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.InsertTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  6715. inserts an existing XWPFTable to the arrays bodyElements and tables
  6716. @param pos
  6717. @param table
  6718. </member>
  6719. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetNextPicNameNumber(System.Int32)">
  6720. Get the next free ImageNumber
  6721. @param format
  6722. @return the next free ImageNumber
  6723. @throws InvalidFormatException
  6724. </member>
  6725. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetPictureDataByID(System.String)">
  6726. returns the PictureData by blipID
  6727. @param blipID
  6728. @return XWPFPictureData of a specificID
  6729. </member>
  6730. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetNumbering">
  6731. GetNumbering
  6732. @return numbering
  6733. </member>
  6734. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetStyles">
  6735. Get Styles
  6736. @return styles for this document
  6737. </member>
  6738. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  6739. Get the paragraph with the CTP class p
  6740. @param p
  6741. @return the paragraph with the CTP class p
  6742. </member>
  6743. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetTable(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  6744. Get a table by its CTTbl-Object
  6745. @param ctTbl
  6746. @see NPOI.XWPF.UserModel.IBody#getTable(org.Openxmlformats.schemas.wordProcessingml.x2006.main.CTTbl)
  6747. @return a table by its CTTbl-Object or null
  6748. </member>
  6749. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetParagraphArray(System.Int32)">
  6750. Returns the paragraph that of position pos
  6751. @see NPOI.XWPF.UserModel.IBody#getParagraphArray(int)
  6752. </member>
  6753. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  6754. Get the TableCell which belongs to the TableCell
  6755. @param cell
  6756. </member>
  6757. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.Document">
  6758. Returns the low level document base object
  6759. </member>
  6760. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.BodyElements">
  6761. returns an Iterator with paragraphs and tables
  6762. @see NPOI.XWPF.UserModel.IBody#getBodyElements()
  6763. </member>
  6764. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.Paragraphs">
  6765. @see NPOI.XWPF.UserModel.IBody#getParagraphs()
  6766. </member>
  6767. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.Tables">
  6768. @see NPOI.XWPF.UserModel.IBody#getTables()
  6769. </member>
  6770. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.FooterList">
  6771. @return the list of footers
  6772. </member>
  6773. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.HeaderList">
  6774. @return the list of headers
  6775. </member>
  6776. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.IsTrackRevisions">
  6777. Check if revision tracking is turned on.
  6778. @return <code>true</code> if revision tracking is turned on
  6779. </member>
  6780. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.AllPictures">
  6781. Returns all Pictures, which are referenced from the document itself.
  6782. @return a {@link List} of {@link XWPFPictureData}. The returned {@link List} is unmodifiable. Use #a
  6783. </member>
  6784. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.AllPackagePictures">
  6785. @return all Pictures in this package
  6786. </member>
  6787. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.Part">
  6788. returns the Part, to which the body belongs, which you need for Adding relationship to other parts
  6789. Actually it is needed of the class XWPFTableCell. Because you have to know to which part the tableCell
  6790. belongs.
  6791. @see NPOI.XWPF.UserModel.IBody#getPart()
  6792. </member>
  6793. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.PartType">
  6794. Get the PartType of the body, for example
  6795. DOCUMENT, HEADER, FOOTER, FOOTNOTE,
  6796. @see NPOI.XWPF.UserModel.IBody#getPartType()
  6797. </member>
  6798. <member name="T:NPOI.XWPF.UserModel.XWPFFactory">
  6799. @author Yegor Kozlov
  6800. </member>
  6801. <member name="T:NPOI.XWPF.UserModel.XWPFFooter">
  6802. Sketch of XWPF footer class
  6803. </member>
  6804. <member name="T:NPOI.XWPF.UserModel.XWPFHeaderFooter">
  6805. Parent of XWPF headers and footers
  6806. </member>
  6807. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.SetHeaderFooter(NPOI.OpenXmlFormats.Wordprocessing.CT_HdrFtr)">
  6808. Set a new headerFooter
  6809. </member>
  6810. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetTable(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  6811. if there is a corresponding {@link XWPFTable} of the parameter ctTable in the tableList of this header
  6812. the method will return this table
  6813. if there is no corresponding {@link XWPFTable} the method will return null
  6814. @param ctTable
  6815. </member>
  6816. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  6817. if there is a corresponding {@link XWPFParagraph} of the parameter ctTable in the paragraphList of this header or footer
  6818. the method will return this paragraph
  6819. if there is no corresponding {@link XWPFParagraph} the method will return null
  6820. @param p is instance of CTP and is searching for an XWPFParagraph
  6821. @return null if there is no XWPFParagraph with an corresponding CTPparagraph in the paragraphList of this header or footer
  6822. XWPFParagraph with the correspondig CTP p
  6823. </member>
  6824. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetParagraphArray(System.Int32)">
  6825. Returns the paragraph that holds
  6826. the text of the header or footer.
  6827. </member>
  6828. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetListParagraph">
  6829. Get a List of all Paragraphs
  6830. @return a list of {@link XWPFParagraph}
  6831. </member>
  6832. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.AddPictureData(System.Byte[],System.Int32)">
  6833. Adds a picture to the document.
  6834. @param pictureData The picture data
  6835. @param format The format of the picture.
  6836. @return the index to this picture (0 based), the Added picture can be obtained from {@link #getAllPictures()} .
  6837. @throws InvalidFormatException
  6838. </member>
  6839. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.AddPictureData(System.IO.Stream,System.Int32)">
  6840. Adds a picture to the document.
  6841. @param is The stream to read image from
  6842. @param format The format of the picture.
  6843. @return the index to this picture (0 based), the Added picture can be obtained from {@link #getAllPictures()} .
  6844. @throws InvalidFormatException
  6845. @
  6846. </member>
  6847. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetPictureDataByID(System.String)">
  6848. returns the PictureData by blipID
  6849. @param blipID
  6850. @return XWPFPictureData of a specificID
  6851. @throws Exception
  6852. </member>
  6853. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetTableArray(System.Int32)">
  6854. Returns the table at position pos
  6855. @see NPOI.XWPF.UserModel.IBody#getTableArray(int)
  6856. </member>
  6857. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.InsertTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  6858. inserts an existing XWPFTable to the arrays bodyElements and tables
  6859. @param pos
  6860. @param table
  6861. </member>
  6862. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  6863. Get the TableCell which belongs to the TableCell
  6864. @param cell
  6865. </member>
  6866. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.Paragraphs">
  6867. Returns the paragraph(s) that holds
  6868. the text of the header or footer.
  6869. Normally there is only the one paragraph, but
  6870. there could be more in certain cases, or
  6871. a table.
  6872. </member>
  6873. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.Tables">
  6874. Return the table(s) that holds the text
  6875. of the header or footer, for complex cases
  6876. where a paragraph isn't used.
  6877. Normally there's just one paragraph, but some
  6878. complex headers/footers have a table or two
  6879. in Addition.
  6880. </member>
  6881. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.Text">
  6882. Returns the textual content of the header/footer,
  6883. by flattening out the text of its paragraph(s)
  6884. </member>
  6885. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.AllPackagePictures">
  6886. Get all Pictures in this package
  6887. @return all Pictures in this package
  6888. </member>
  6889. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.Owner">
  6890. verifies that cursor is on the right position
  6891. @param cursor
  6892. </member>
  6893. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.Part">
  6894. returns the Part, to which the body belongs, which you need for Adding relationship to other parts
  6895. @see NPOI.XWPF.UserModel.IBody#getPart()
  6896. </member>
  6897. <member name="M:NPOI.XWPF.UserModel.XWPFFooter.Commit">
  6898. save and Commit footer
  6899. </member>
  6900. <member name="P:NPOI.XWPF.UserModel.XWPFFooter.PartType">
  6901. Get the PartType of the body
  6902. @see NPOI.XWPF.UserModel.IBody#getPartType()
  6903. </member>
  6904. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetTableArray(System.Int32)">
  6905. <summary>
  6906. </summary>
  6907. <param name="pos">position in table array</param>
  6908. <returns>The table at position pos</returns>
  6909. </member>
  6910. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.InsertTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  6911. <summary>
  6912. inserts an existing XWPFTable to the arrays bodyElements and tables
  6913. </summary>
  6914. <param name="pos"></param>
  6915. <param name="table"></param>
  6916. </member>
  6917. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetTable(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  6918. if there is a corresponding {@link XWPFTable} of the parameter ctTable in the tableList of this header
  6919. the method will return this table
  6920. if there is no corresponding {@link XWPFTable} the method will return null
  6921. @param ctTable
  6922. @see NPOI.XWPF.UserModel.IBody#getTable(CTTbl ctTable)
  6923. </member>
  6924. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  6925. if there is a corresponding {@link XWPFParagraph} of the parameter ctTable in the paragraphList of this header or footer
  6926. the method will return this paragraph
  6927. if there is no corresponding {@link XWPFParagraph} the method will return null
  6928. @param p is instance of CTP and is searching for an XWPFParagraph
  6929. @return null if there is no XWPFParagraph with an corresponding CTPparagraph in the paragraphList of this header or footer
  6930. XWPFParagraph with the correspondig CTP p
  6931. @see NPOI.XWPF.UserModel.IBody#getParagraph(CTP p)
  6932. </member>
  6933. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetParagraphArray(System.Int32)">
  6934. <summary>
  6935. Returns the paragraph that holds the text of the header or footer.
  6936. </summary>
  6937. <param name="pos"></param>
  6938. <returns></returns>
  6939. </member>
  6940. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  6941. <summary>
  6942. Get the TableCell which belongs to the TableCell
  6943. </summary>
  6944. <param name="cell"></param>
  6945. <returns></returns>
  6946. </member>
  6947. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.IsCursorInFtn(System.Xml.XmlDocument)">
  6948. verifies that cursor is on the right position
  6949. @param cursor
  6950. </member>
  6951. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.InsertNewTbl(System.Xml.XmlDocument)">
  6952. @param cursor
  6953. @return the inserted table
  6954. @see NPOI.XWPF.UserModel.IBody#insertNewTbl(XmlCursor cursor)
  6955. </member>
  6956. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.InsertNewParagraph(System.Xml.XmlDocument)">
  6957. add a new paragraph at position of the cursor
  6958. @param cursor
  6959. @return the inserted paragraph
  6960. @see NPOI.XWPF.UserModel.IBody#insertNewParagraph(XmlCursor cursor)
  6961. </member>
  6962. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.AddNewTbl(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  6963. add a new table to the end of the footnote
  6964. @param table
  6965. @return the Added XWPFTable
  6966. </member>
  6967. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.AddNewParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  6968. add a new paragraph to the end of the footnote
  6969. @param paragraph
  6970. @return the Added XWPFParagraph
  6971. </member>
  6972. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetXWPFDocument">
  6973. @see NPOI.XWPF.UserModel.IBody#getXWPFDocument()
  6974. </member>
  6975. <member name="P:NPOI.XWPF.UserModel.XWPFFootnote.Part">
  6976. returns the Part, to which the body belongs, which you need for Adding relationship to other parts
  6977. @see NPOI.XWPF.UserModel.IBody#getPart()
  6978. </member>
  6979. <member name="P:NPOI.XWPF.UserModel.XWPFFootnote.PartType">
  6980. Get the PartType of the body
  6981. @see NPOI.XWPF.UserModel.IBody#getPartType()
  6982. </member>
  6983. <member name="T:NPOI.XWPF.UserModel.XWPFFootnotes">
  6984. Looks After the collection of Footnotes for a document
  6985. @author Mike McEuen (mceuen@hp.com)
  6986. </member>
  6987. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  6988. Construct XWPFFootnotes from a package part
  6989. @param part the package part holding the data of the footnotes,
  6990. @param rel the package relationship of type "http://schemas.Openxmlformats.org/officeDocument/2006/relationships/footnotes"
  6991. </member>
  6992. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.#ctor">
  6993. Construct XWPFFootnotes from scratch for a new document.
  6994. </member>
  6995. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.OnDocumentRead">
  6996. Read document
  6997. </member>
  6998. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.SetFootnotes(NPOI.OpenXmlFormats.Wordprocessing.CT_Footnotes)">
  6999. Sets the ctFootnotes
  7000. @param footnotes
  7001. </member>
  7002. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.AddFootnote(NPOI.XWPF.UserModel.XWPFFootnote)">
  7003. add an XWPFFootnote to the document
  7004. @param footnote
  7005. @throws IOException
  7006. </member>
  7007. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.AddFootnote(NPOI.OpenXmlFormats.Wordprocessing.CT_FtnEdn)">
  7008. add a footnote to the document
  7009. @param note
  7010. @throws IOException
  7011. </member>
  7012. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.GetXWPFDocument">
  7013. @see NPOI.XWPF.UserModel.IBody#getPart()
  7014. </member>
  7015. <member name="T:NPOI.XWPF.UserModel.XWPFHeader">
  7016. Sketch of XWPF header class
  7017. </member>
  7018. <member name="M:NPOI.XWPF.UserModel.XWPFHeader.Commit">
  7019. <summary>
  7020. Save and commit footer
  7021. </summary>
  7022. </member>
  7023. <member name="M:NPOI.XWPF.UserModel.XWPFHeader.OnDocumentRead">
  7024. <summary>
  7025. Read the document
  7026. </summary>
  7027. </member>
  7028. <member name="P:NPOI.XWPF.UserModel.XWPFHeader.PartType">
  7029. <summary>
  7030. Get the PartType of the body
  7031. </summary>
  7032. </member>
  7033. <member name="T:NPOI.XWPF.UserModel.XWPFHyperlink">
  7034. * Sketch of XWPF hyperlink class
  7035. *
  7036. * @author Yury Batrakov (batrakov at gmail.com)
  7037. *
  7038. </member>
  7039. <member name="T:NPOI.XWPF.UserModel.XWPFHyperlinkRun">
  7040. A run of text with a Hyperlink applied to it.
  7041. Any given Hyperlink may be made up of multiple of these.
  7042. </member>
  7043. <member name="T:NPOI.XWPF.UserModel.XWPFRun">
  7044. XWPFrun.object defines a region of text with a common Set of properties
  7045. @author Yegor Kozlov
  7046. @author Gregg Morris (gregg dot morris at gmail dot com) - added getColor(), setColor()
  7047. </member>
  7048. <member name="M:NPOI.XWPF.UserModel.XWPFRun.#ctor(NPOI.OpenXmlFormats.Wordprocessing.CT_R,NPOI.XWPF.UserModel.IRunBody)">
  7049. @param r the CT_R bean which holds the run.attributes
  7050. @param p the parent paragraph
  7051. </member>
  7052. <member name="M:NPOI.XWPF.UserModel.XWPFRun.#ctor(NPOI.OpenXmlFormats.Wordprocessing.CT_R,NPOI.XWPF.UserModel.XWPFParagraph)">
  7053. @deprecated Use {@link XWPFRun#XWPFRun(CTR, IRunBody)}
  7054. </member>
  7055. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetCTR">
  7056. Get the currently used CT_R object
  7057. @return CT_R object
  7058. </member>
  7059. <member name="M:NPOI.XWPF.UserModel.XWPFRun.IsCTOnOff(NPOI.OpenXmlFormats.Wordprocessing.CT_OnOff)">
  7060. For isBold, isItalic etc
  7061. </member>
  7062. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetColor">
  7063. Get text color. The returned value is a string in the hex form "RRGGBB".
  7064. </member>
  7065. <member name="M:NPOI.XWPF.UserModel.XWPFRun.SetColor(System.String)">
  7066. Set text color.
  7067. @param rgbStr - the desired color, in the hex form "RRGGBB".
  7068. </member>
  7069. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetText(System.Int32)">
  7070. Return the string content of this text run
  7071. @return the text of this text run.or <code>null</code> if not Set
  7072. </member>
  7073. <member name="M:NPOI.XWPF.UserModel.XWPFRun.SetText(System.String)">
  7074. Sets the text of this text run
  7075. @param value the literal text which shall be displayed in the document
  7076. </member>
  7077. <member name="M:NPOI.XWPF.UserModel.XWPFRun.SetText(System.String,System.Int32)">
  7078. Sets the text of this text run.in the
  7079. @param value the literal text which shall be displayed in the document
  7080. @param pos - position in the text array (NB: 0 based)
  7081. </member>
  7082. <member name="M:NPOI.XWPF.UserModel.XWPFRun.InsertText(System.String,System.Int32)">
  7083. <summary>
  7084. insert text at start index in the run
  7085. </summary>
  7086. <param name="text">insert text</param>
  7087. <param name="startIndex">start index of the insertion in the run text</param>
  7088. </member>
  7089. <member name="M:NPOI.XWPF.UserModel.XWPFRun.SetUnderline(NPOI.XWPF.UserModel.UnderlinePatterns)">
  7090. Specifies that the contents of this run.should be displayed along with an
  7091. underline appearing directly below the character heigh
  7092. If this element is not present, the default value is to leave the
  7093. formatting applied at previous level in the style hierarchy. If this
  7094. element is never applied in the style hierarchy, then an underline shall
  7095. not be applied to the contents of this run.
  7096. @param value -
  7097. underline type
  7098. @see UnderlinePatterns : all possible patterns that could be applied
  7099. </member>
  7100. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetFontFamily(NPOI.XWPF.UserModel.FontCharRange)">
  7101. Gets the font family for the specified font char range.
  7102. If fcr is null, the font char range "ascii" is used
  7103. @param fcr the font char range, defaults to "ansi"
  7104. @return a string representing the font famil
  7105. </member>
  7106. <member name="M:NPOI.XWPF.UserModel.XWPFRun.SetFontFamily(System.String,NPOI.XWPF.UserModel.FontCharRange)">
  7107. Specifies the fonts which shall be used to display the text contents of
  7108. this run. The default handling for fcr == null is to overwrite the
  7109. ascii font char range with the given font family and also set all not
  7110. specified font ranges
  7111. @param fontFamily
  7112. @param fcr FontCharRange or null for default handling
  7113. </member>
  7114. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetTextPosition">
  7115. This element specifies the amount by which text shall be raised or
  7116. lowered for this run.in relation to the default baseline of the
  7117. surrounding non-positioned text. This allows the text to be repositioned
  7118. without altering the font size of the contents.
  7119. @return a big integer representing the amount of text shall be "moved"
  7120. </member>
  7121. <member name="M:NPOI.XWPF.UserModel.XWPFRun.SetTextPosition(System.Int32)">
  7122. This element specifies the amount by which text shall be raised or
  7123. lowered for this run.in relation to the default baseline of the
  7124. surrounding non-positioned text. This allows the text to be repositioned
  7125. without altering the font size of the contents.
  7126. If the val attribute is positive, then the parent run.shall be raised
  7127. above the baseline of the surrounding text by the specified number of
  7128. half-points. If the val attribute is negative, then the parent run.shall
  7129. be lowered below the baseline of the surrounding text by the specified
  7130. number of half-points.
  7131. *
  7132. If this element is not present, the default value is to leave the
  7133. formatting applied at previous level in the style hierarchy. If this
  7134. element is never applied in the style hierarchy, then the text shall not
  7135. be raised or lowered relative to the default baseline location for the
  7136. contents of this run.
  7137. </member>
  7138. <member name="M:NPOI.XWPF.UserModel.XWPFRun.RemoveBreak">
  7139. </member>
  7140. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddBreak">
  7141. Specifies that a break shall be placed at the current location in the run
  7142. content.
  7143. A break is a special character which is used to override the
  7144. normal line breaking that would be performed based on the normal layout
  7145. of the document's contents.
  7146. @see #AddCarriageReturn()
  7147. </member>
  7148. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddBreak(NPOI.XWPF.UserModel.BreakType)">
  7149. Specifies that a break shall be placed at the current location in the run
  7150. content.
  7151. A break is a special character which is used to override the
  7152. normal line breaking that would be performed based on the normal layout
  7153. of the document's contents.
  7154. <p>
  7155. The behavior of this break character (the
  7156. location where text shall be restarted After this break) shall be
  7157. determined by its type values.
  7158. </p>
  7159. @see BreakType
  7160. </member>
  7161. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddBreak(NPOI.XWPF.UserModel.BreakClear)">
  7162. Specifies that a break shall be placed at the current location in the run
  7163. content. A break is a special character which is used to override the
  7164. normal line breaking that would be performed based on the normal layout
  7165. of the document's contents.
  7166. <p>
  7167. The behavior of this break character (the
  7168. location where text shall be restarted After this break) shall be
  7169. determined by its type (in this case is BreakType.TEXT_WRAPPING as default) and clear attribute values.
  7170. </p>
  7171. @see BreakClear
  7172. </member>
  7173. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddTab">
  7174. Specifies that a tab shall be placed at the current location in
  7175. the run content.
  7176. </member>
  7177. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddCarriageReturn">
  7178. Specifies that a carriage return shall be placed at the
  7179. current location in the run.content.
  7180. A carriage return is used to end the current line of text in
  7181. WordProcess.
  7182. The behavior of a carriage return in run.content shall be
  7183. identical to a break character with null type and clear attributes, which
  7184. shall end the current line and find the next available line on which to
  7185. continue.
  7186. The carriage return character forced the following text to be
  7187. restarted on the next available line in the document.
  7188. </member>
  7189. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddPicture(System.IO.Stream,System.Int32,System.String,System.Int32,System.Int32)">
  7190. Adds a picture to the run. This method handles
  7191. attaching the picture data to the overall file.
  7192. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_EMF
  7193. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_WMF
  7194. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_PICT
  7195. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_JPEG
  7196. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_PNG
  7197. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_DIB
  7198. @param pictureData The raw picture data
  7199. @param pictureType The type of the picture, eg {@link Document#PICTURE_TYPE_JPEG}
  7200. @param width width in EMUs. To convert to / from points use {@link org.apache.poi.util.Units}
  7201. @param height height in EMUs. To convert to / from points use {@link org.apache.poi.util.Units}
  7202. @throws NPOI.Openxml4j.exceptions.InvalidFormatException
  7203. @throws IOException
  7204. </member>
  7205. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetEmbeddedPictures">
  7206. Returns the embedded pictures of the run. These
  7207. are pictures which reference an external,
  7208. embedded picture image such as a .png or .jpg
  7209. </member>
  7210. <member name="M:NPOI.XWPF.UserModel.XWPFRun.preserveSpaces(NPOI.OpenXmlFormats.Wordprocessing.CT_Text)">
  7211. Add the xml:spaces="preserve" attribute if the string has leading or trailing white spaces
  7212. @param xs the string to check
  7213. </member>
  7214. <member name="M:NPOI.XWPF.UserModel.XWPFRun.ToString">
  7215. Returns the string version of the text, with tabs and
  7216. carriage returns in place of their xml equivalents.
  7217. </member>
  7218. <member name="P:NPOI.XWPF.UserModel.XWPFRun.Parent">
  7219. Get the currently referenced paragraph/SDT object
  7220. @return current parent
  7221. </member>
  7222. <member name="P:NPOI.XWPF.UserModel.XWPFRun.Paragraph">
  7223. Get the currently referenced paragraph, or null if a SDT object
  7224. @deprecated use {@link XWPFRun#getParent()} instead
  7225. </member>
  7226. <member name="P:NPOI.XWPF.UserModel.XWPFRun.Document">
  7227. @return The {@link XWPFDocument} instance, this run.belongs to, or
  7228. <code>null</code> if parent structure (paragraph > document) is not properly Set.
  7229. </member>
  7230. <member name="P:NPOI.XWPF.UserModel.XWPFRun.IsBold">
  7231. Whether the bold property shall be applied to all non-complex script
  7232. characters in the contents of this run.when displayed in a document.
  7233. <p>
  7234. This formatting property is a toggle property, which specifies that its
  7235. behavior differs between its use within a style defInition and its use as
  7236. direct formatting. When used as part of a style defInition, Setting this
  7237. property shall toggle the current state of that property as specified up
  7238. to this point in the hierarchy (i.e. applied to not applied, and vice
  7239. versa). Setting it to <code>false</code> (or an equivalent) shall
  7240. result in the current Setting remaining unChanged. However, when used as
  7241. direct formatting, Setting this property to true or false shall Set the
  7242. absolute state of the resulting property.
  7243. </p>
  7244. <p>
  7245. If this element is not present, the default value is to leave the
  7246. formatting applied at previous level in the style hierarchy. If this
  7247. element is never applied in the style hierarchy, then bold shall not be
  7248. applied to non-complex script characters.
  7249. </p>
  7250. @param value <code>true</code> if the bold property is applied to
  7251. this run
  7252. </member>
  7253. <member name="P:NPOI.XWPF.UserModel.XWPFRun.PictureText">
  7254. Returns text embedded in pictures
  7255. </member>
  7256. <member name="P:NPOI.XWPF.UserModel.XWPFRun.IsItalic">
  7257. Whether the italic property should be applied to all non-complex script
  7258. characters in the contents of this run.when displayed in a document.
  7259. @return <code>true</code> if the italic property is applied
  7260. </member>
  7261. <member name="P:NPOI.XWPF.UserModel.XWPFRun.Underline">
  7262. Specifies that the contents of this run.should be displayed along with an
  7263. underline appearing directly below the character heigh
  7264. @return the Underline pattern Applyed to this run
  7265. @see UnderlinePatterns
  7266. </member>
  7267. <member name="P:NPOI.XWPF.UserModel.XWPFRun.IsStrikeThrough">
  7268. Specifies that the contents of this run.shall be displayed with a single
  7269. horizontal line through the center of the line.
  7270. @return <code>true</code> if the strike property is applied
  7271. </member>
  7272. <!-- Badly formed XML comment ignored for member "P:NPOI.XWPF.UserModel.XWPFRun.IsStrike" -->
  7273. <member name="P:NPOI.XWPF.UserModel.XWPFRun.IsDoubleStrikeThrough">
  7274. Specifies that the contents of this run shall be displayed with a double
  7275. horizontal line through the center of the line.
  7276. @return <code>true</code> if the double strike property is applied
  7277. </member>
  7278. <member name="P:NPOI.XWPF.UserModel.XWPFRun.Subscript">
  7279. Specifies the alignment which shall be applied to the contents of this
  7280. run.in relation to the default appearance of the run.s text.
  7281. This allows the text to be repositioned as subscript or superscript without
  7282. altering the font size of the run.properties.
  7283. @return VerticalAlign
  7284. @see VerticalAlign all possible value that could be Applyed to this run
  7285. </member>
  7286. <member name="P:NPOI.XWPF.UserModel.XWPFRun.FontFamily">
  7287. Specifies the fonts which shall be used to display the text contents of
  7288. this run. Specifies a font which shall be used to format all characters
  7289. in the ASCII range (0 - 127) within the parent run
  7290. @return a string representing the font family
  7291. </member>
  7292. <member name="P:NPOI.XWPF.UserModel.XWPFRun.FontSize">
  7293. Specifies the font size which shall be applied to all non complex script
  7294. characters in the contents of this run.when displayed.
  7295. @return value representing the font size
  7296. </member>
  7297. <member name="M:NPOI.XWPF.UserModel.XWPFHyperlinkRun.GetHyperlinkId">
  7298. Returns the ID of the hyperlink, if one is Set.
  7299. </member>
  7300. <member name="M:NPOI.XWPF.UserModel.XWPFHyperlinkRun.GetHyperlink(NPOI.XWPF.UserModel.XWPFDocument)">
  7301. If this Hyperlink is an external reference hyperlink,
  7302. return the object for it.
  7303. </member>
  7304. <member name="M:NPOI.XWPF.UserModel.XWPFLatentStyles.IsLatentStyle(System.String)">
  7305. checks whether specific LatentStyleID is a latentStyle
  7306. </member>
  7307. <member name="T:NPOI.XWPF.UserModel.XWPFNum">
  7308. @author Philipp Epp
  7309. </member>
  7310. <member name="T:NPOI.XWPF.UserModel.XWPFNumbering">
  7311. @author Philipp Epp
  7312. </member>
  7313. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  7314. create a new styles object with an existing document
  7315. </member>
  7316. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.#ctor">
  7317. create a new XWPFNumbering object for use in a new document
  7318. </member>
  7319. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.OnDocumentRead">
  7320. read numbering form an existing package
  7321. </member>
  7322. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.Commit">
  7323. save and Commit numbering
  7324. </member>
  7325. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.SetNumbering(NPOI.OpenXmlFormats.Wordprocessing.CT_Numbering)">
  7326. Sets the ctNumbering
  7327. @param numbering
  7328. </member>
  7329. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.NumExist(System.String)">
  7330. Checks whether number with numID exists
  7331. @param numID
  7332. @return bool true if num exist, false if num not exist
  7333. </member>
  7334. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.AddNum(NPOI.XWPF.UserModel.XWPFNum)">
  7335. add a new number to the numbering document
  7336. @param num
  7337. </member>
  7338. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.AddNum(System.String)">
  7339. Add a new num with an abstractNumID
  7340. @return return NumId of the Added num
  7341. </member>
  7342. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.AddNum(System.String,System.String)">
  7343. Add a new num with an abstractNumID and a numID
  7344. @param abstractNumID
  7345. @param numID
  7346. </member>
  7347. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.GetNum(System.String)">
  7348. Get Num by NumID
  7349. @param numID
  7350. @return abstractNum with NumId if no Num exists with that NumID
  7351. null will be returned
  7352. </member>
  7353. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.GetAbstractNum(System.String)">
  7354. Get AbstractNum by abstractNumID
  7355. @param abstractNumID
  7356. @return abstractNum with abstractNumId if no abstractNum exists with that abstractNumID
  7357. null will be returned
  7358. </member>
  7359. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.GetIdOfAbstractNum(NPOI.XWPF.UserModel.XWPFAbstractNum)">
  7360. Compare AbstractNum with abstractNums of this numbering document.
  7361. If the content of abstractNum Equals with an abstractNum of the List in numbering
  7362. the Bigint Value of it will be returned.
  7363. If no equal abstractNum is existing null will be returned
  7364. @param abstractNum
  7365. @return Bigint
  7366. </member>
  7367. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.AddAbstractNum(NPOI.XWPF.UserModel.XWPFAbstractNum)">
  7368. add a new AbstractNum and return its AbstractNumID
  7369. @param abstractNum
  7370. </member>
  7371. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.AddAbstractNum">
  7372. <summary>
  7373. Add a new AbstractNum
  7374. </summary>
  7375. <returns></returns>
  7376. @author antony liu
  7377. </member>
  7378. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.RemoveAbstractNum(System.String)">
  7379. remove an existing abstractNum
  7380. @param abstractNumID
  7381. @return true if abstractNum with abstractNumID exists in NumberingArray,
  7382. false if abstractNum with abstractNumID not exists
  7383. </member>
  7384. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.GetAbstractNumID(System.String)">
  7385. return the abstractNumID
  7386. If the AbstractNumID not exists
  7387. return null
  7388. @param numID
  7389. @return abstractNumID
  7390. </member>
  7391. <member name="T:NPOI.XWPF.UserModel.XWPFParagraph">
  7392. <p>A Paragraph within a Document, Table, Header etc.</p>
  7393. <p>A paragraph has a lot of styling information, but the
  7394. actual text (possibly along with more styling) is held on
  7395. the child {@link XWPFRun}s.</p>
  7396. </member>
  7397. <member name="F:NPOI.XWPF.UserModel.XWPFParagraph.document">
  7398. For access to the document's hyperlink, comments, tables etc
  7399. </member>
  7400. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.BuildRunsInOrderFromXml(System.Collections.ArrayList)">
  7401. Identifies (in order) the parts of the paragraph /
  7402. sub-paragraph that correspond to character text
  7403. runs, and builds the appropriate runs for these.
  7404. </member>
  7405. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetNumID">
  7406. If style exist for this paragraph
  7407. NumId of the paragraph will be returned.
  7408. If style not exist null will be returned
  7409. @return NumID as Bigint
  7410. </member>
  7411. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetNumIlvl">
  7412. Returns Ilvl of the numeric style for this paragraph.
  7413. Returns null if this paragraph does not have numeric style.
  7414. @return Ilvl as BigInteger
  7415. </member>
  7416. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetNumFmt">
  7417. Returns numbering format for this paragraph, eg bullet or
  7418. lowerLetter.
  7419. Returns null if this paragraph does not have numeric style.
  7420. </member>
  7421. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetNumStartOverride">
  7422. Gets the numstartOverride for the paragraph numbering for this paragraph.
  7423. @return returns the overridden start number or null if there is no override for this paragraph.
  7424. </member>
  7425. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.SetNumID(System.String)">
  7426. SetNumID of Paragraph
  7427. @param numPos
  7428. </member>
  7429. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.SetNumID(System.String,System.String)">
  7430. <summary>
  7431. Set NumID and level of Paragraph
  7432. </summary>
  7433. <param name="numId"></param>
  7434. <param name="ilvl"></param>
  7435. </member>
  7436. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetCTPBrd(System.Boolean)">
  7437. Get a <b>copy</b> of the currently used CTPBrd, if none is used, return
  7438. a new instance.
  7439. </member>
  7440. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetCTSpacing(System.Boolean)">
  7441. Get a <b>copy</b> of the currently used CTSpacing, if none is used,
  7442. return a new instance.
  7443. </member>
  7444. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetCTInd(System.Boolean)">
  7445. Get a <b>copy</b> of the currently used CTPInd, if none is used, return
  7446. a new instance.
  7447. </member>
  7448. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetCTPPr">
  7449. Get a <b>copy</b> of the currently used CTPPr, if none is used, return
  7450. a new instance.
  7451. </member>
  7452. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.AddRun(NPOI.OpenXmlFormats.Wordprocessing.CT_R)">
  7453. add a new run at the end of the position of
  7454. the content of parameter run
  7455. @param run
  7456. </member>
  7457. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.ReplaceText(System.String,System.String)">
  7458. <summary>
  7459. Replace text inside each run (cross run is not supported yet)
  7460. </summary>
  7461. <param name="oldText">target text</param>
  7462. <param name="newText">replacement text</param>
  7463. </member>
  7464. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.SearchText(System.String,NPOI.XWPF.UserModel.PositionInParagraph)">
  7465. <summary>
  7466. this methods parse the paragraph and search for the string searched.
  7467. If it finds the string, it will return true and the position of the String will be saved in the parameter startPos.
  7468. </summary>
  7469. <param name="searched"></param>
  7470. <param name="startPos"></param>
  7471. <returns></returns>
  7472. </member>
  7473. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.CreateRun">
  7474. Appends a new run to this paragraph
  7475. @return a new text run
  7476. </member>
  7477. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.InsertNewRun(System.Int32)">
  7478. insert a new Run in RunArray
  7479. @param pos
  7480. @return the inserted run
  7481. </member>
  7482. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetText(NPOI.XWPF.UserModel.TextSegement)">
  7483. Get a Text
  7484. @param segment
  7485. </member>
  7486. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.RemoveRun(System.Int32)">
  7487. Removes a Run at the position pos in the paragraph
  7488. @param pos
  7489. @return true if the run was Removed
  7490. </member>
  7491. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.AddRun(NPOI.XWPF.UserModel.XWPFRun)">
  7492. Adds a new Run to the Paragraph
  7493. @param r
  7494. </member>
  7495. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetRun(NPOI.OpenXmlFormats.Wordprocessing.CT_R)">
  7496. return the XWPFRun-Element which owns the CTR Run-Element
  7497. @param r
  7498. </member>
  7499. <!-- Badly formed XML comment ignored for member "P:NPOI.XWPF.UserModel.XWPFParagraph.IRuns" -->
  7500. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.Text">
  7501. Return the textual content of the paragraph, including text from pictures
  7502. and std element in it.
  7503. </member>
  7504. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.StyleID">
  7505. Return styleID of the paragraph if style exist for this paragraph
  7506. if not, null will be returned
  7507. @return styleID as String
  7508. </member>
  7509. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.NumLevelText">
  7510. Returns the text that should be used around the paragraph level numbers.
  7511. @return a string (e.g. "%1.") or null if the value is not found.
  7512. </member>
  7513. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.ParagraphText">
  7514. Returns the text of the paragraph, but not of any objects in the
  7515. paragraph
  7516. </member>
  7517. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.PictureText">
  7518. Returns any text from any suitable pictures in the paragraph
  7519. </member>
  7520. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.FootnoteText">
  7521. Returns the footnote text of the paragraph
  7522. @return the footnote text or empty string if the paragraph does not have footnotes
  7523. </member>
  7524. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.Alignment">
  7525. Returns the paragraph alignment which shall be applied to text in this
  7526. paragraph.
  7527. <p>
  7528. If this element is not Set on a given paragraph, its value is determined
  7529. by the Setting previously Set at any level of the style hierarchy (i.e.
  7530. that previous Setting remains unChanged). If this Setting is never
  7531. specified in the style hierarchy, then no alignment is applied to the
  7532. paragraph.
  7533. </p>
  7534. @return the paragraph alignment of this paragraph.
  7535. </member>
  7536. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.FontAlignment">
  7537. @return The raw alignment value, {@link #getAlignment()} is suggested
  7538. </member>
  7539. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.VerticalAlignment">
  7540. Returns the text vertical alignment which shall be applied to text in
  7541. this paragraph.
  7542. <p>
  7543. If the line height (before any Added spacing) is larger than one or more
  7544. characters on the line, all characters will be aligned to each other as
  7545. specified by this element.
  7546. </p>
  7547. <p>
  7548. If this element is omitted on a given paragraph, its value is determined
  7549. by the Setting previously Set at any level of the style hierarchy (i.e.
  7550. that previous Setting remains unChanged). If this Setting is never
  7551. specified in the style hierarchy, then the vertical alignment of all
  7552. characters on the line shall be automatically determined by the consumer.
  7553. </p>
  7554. @return the vertical alignment of this paragraph.
  7555. </member>
  7556. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.BorderTop">
  7557. <summary>
  7558. the top border for the paragraph
  7559. </summary>
  7560. </member>
  7561. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.BorderBottom">
  7562. <summary>
  7563. Specifies the border which shall be displayed below a Set of
  7564. paragraphs which have the same Set of paragraph border Settings.
  7565. </summary>
  7566. <returns>the bottom border for the paragraph</returns>
  7567. </member>
  7568. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.BorderLeft">
  7569. <summary>
  7570. Specifies the border which shall be displayed on the left side of the
  7571. page around the specified paragraph.
  7572. </summary>
  7573. <returns>the left border for the paragraph</returns>
  7574. </member>
  7575. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.BorderRight">
  7576. Specifies the border which shall be displayed on the right side of the
  7577. page around the specified paragraph.
  7578. @return ParagraphBorder - the right border for the paragraph
  7579. @see #setBorderRight(Borders)
  7580. @see Borders for a list of all possible borders
  7581. </member>
  7582. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.BorderBetween">
  7583. Specifies the border which shall be displayed between each paragraph in a
  7584. Set of paragraphs which have the same Set of paragraph border Settings.
  7585. @return ParagraphBorder - the between border for the paragraph
  7586. @see #setBorderBetween(Borders)
  7587. @see Borders for a list of all possible borders
  7588. </member>
  7589. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IsPageBreak">
  7590. Specifies that when rendering this document in a paginated
  7591. view, the contents of this paragraph are rendered on the start of a new
  7592. page in the document.
  7593. <p>
  7594. If this element is omitted on a given paragraph,
  7595. its value is determined by the Setting previously Set at any level of the
  7596. style hierarchy (i.e. that previous Setting remains unChanged). If this
  7597. Setting is never specified in the style hierarchy, then this property
  7598. shall not be applied. Since the paragraph is specified to start on a new
  7599. page, it begins page two even though it could have fit on page one.
  7600. </p>
  7601. @return bool - if page break is Set
  7602. </member>
  7603. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.SpacingAfter">
  7604. Specifies the spacing that should be Added After the last line in this
  7605. paragraph in the document in absolute units.
  7606. @return int - value representing the spacing After the paragraph
  7607. </member>
  7608. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.SpacingAfterLines">
  7609. Specifies the spacing that should be Added After the last line in this
  7610. paragraph in the document in absolute units.
  7611. @return bigint - value representing the spacing After the paragraph
  7612. @see #setSpacingAfterLines(int)
  7613. </member>
  7614. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.SpacingBefore">
  7615. Specifies the spacing that should be Added above the first line in this
  7616. paragraph in the document in absolute units.
  7617. @return the spacing that should be Added above the first line
  7618. @see #setSpacingBefore(int)
  7619. </member>
  7620. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.SpacingBeforeLines">
  7621. Specifies the spacing that should be Added before the first line in this paragraph in the
  7622. document in line units.
  7623. The value of this attribute is specified in one hundredths of a line.
  7624. @return the spacing that should be Added before the first line in this paragraph
  7625. @see #setSpacingBeforeLines(int)
  7626. </member>
  7627. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.SpacingLineRule">
  7628. Specifies how the spacing between lines is calculated as stored in the
  7629. line attribute. If this attribute is omitted, then it shall be assumed to
  7630. be of a value auto if a line attribute value is present.
  7631. @return rule
  7632. @see LineSpacingRule
  7633. @see #setSpacingLineRule(LineSpacingRule)
  7634. </member>
  7635. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IndentationLeft">
  7636. Specifies the indentation which shall be placed between the left text
  7637. margin for this paragraph and the left edge of that paragraph's content
  7638. in a left to right paragraph, and the right text margin and the right
  7639. edge of that paragraph's text in a right to left paragraph
  7640. <p>
  7641. If this attribute is omitted, its value shall be assumed to be zero.
  7642. Negative values are defined such that the text is Moved past the text margin,
  7643. positive values Move the text inside the text margin.
  7644. </p>
  7645. @return indentation or null if indentation is not Set
  7646. </member>
  7647. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IndentationRight">
  7648. Specifies the indentation which shall be placed between the right text
  7649. margin for this paragraph and the right edge of that paragraph's content
  7650. in a left to right paragraph, and the right text margin and the right
  7651. edge of that paragraph's text in a right to left paragraph
  7652. <p>
  7653. If this attribute is omitted, its value shall be assumed to be zero.
  7654. Negative values are defined such that the text is Moved past the text margin,
  7655. positive values Move the text inside the text margin.
  7656. </p>
  7657. @return indentation or null if indentation is not Set
  7658. </member>
  7659. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IndentationHanging">
  7660. Specifies the indentation which shall be Removed from the first line of
  7661. the parent paragraph, by moving the indentation on the first line back
  7662. towards the beginning of the direction of text flow.
  7663. This indentation is
  7664. specified relative to the paragraph indentation which is specified for
  7665. all other lines in the parent paragraph.
  7666. The firstLine and hanging
  7667. attributes are mutually exclusive, if both are specified, then the
  7668. firstLine value is ignored.
  7669. @return indentation or null if indentation is not Set
  7670. </member>
  7671. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IndentationFirstLine">
  7672. Specifies the Additional indentation which shall be applied to the first
  7673. line of the parent paragraph. This Additional indentation is specified
  7674. relative to the paragraph indentation which is specified for all other
  7675. lines in the parent paragraph.
  7676. The firstLine and hanging attributes are
  7677. mutually exclusive, if both are specified, then the firstLine value is
  7678. ignored.
  7679. If the firstLineChars attribute is also specified, then this
  7680. value is ignored.
  7681. If this attribute is omitted, then its value shall be
  7682. assumed to be zero (if needed).
  7683. @return indentation or null if indentation is not Set
  7684. </member>
  7685. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IsWordWrapped">
  7686. This element specifies whether a consumer shall break Latin text which
  7687. exceeds the text extents of a line by breaking the word across two lines
  7688. (breaking on the character level) or by moving the word to the following
  7689. line (breaking on the word level).
  7690. @return bool
  7691. </member>
  7692. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.Style">
  7693. @return the style of the paragraph
  7694. </member>
  7695. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.ElementType">
  7696. returns the type of the BodyElement Paragraph
  7697. @see NPOI.XWPF.UserModel.IBodyElement#getElementType()
  7698. </member>
  7699. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.Part">
  7700. returns the part of the bodyElement
  7701. @see NPOI.XWPF.UserModel.IBody#getPart()
  7702. </member>
  7703. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.PartType">
  7704. returns the partType of the bodyPart which owns the bodyElement
  7705. @see NPOI.XWPF.UserModel.IBody#getPartType()
  7706. </member>
  7707. <member name="T:NPOI.XWPF.UserModel.XWPFPicture">
  7708. @author Philipp Epp
  7709. </member>
  7710. <member name="M:NPOI.XWPF.UserModel.XWPFPicture.SetPictureReference(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  7711. Link Picture with PictureData
  7712. @param rel
  7713. </member>
  7714. <member name="M:NPOI.XWPF.UserModel.XWPFPicture.GetCTPicture">
  7715. Return the underlying CTPicture bean that holds all properties for this picture
  7716. @return the underlying CTPicture bean
  7717. </member>
  7718. <member name="M:NPOI.XWPF.UserModel.XWPFPicture.GetPictureData">
  7719. Get the PictureData of the Picture, if present.
  7720. Note - not all kinds of picture have data
  7721. </member>
  7722. <member name="T:NPOI.XWPF.UserModel.XWPFPictureData">
  7723. <summary>
  7724. Raw picture data, normally attached to a WordProcessingML Drawing. As a rule, pictures are stored in the /word/media/ part of a WordProcessingML package.
  7725. </summary>
  7726. <remarks>
  7727. @author Philipp Epp
  7728. </remarks>
  7729. </member>
  7730. <member name="F:NPOI.XWPF.UserModel.XWPFPictureData.RELATIONS">
  7731. Relationships for each known picture type
  7732. </member>
  7733. <member name="M:NPOI.XWPF.UserModel.XWPFPictureData.#ctor">
  7734. Create a new XWPFGraphicData node
  7735. </member>
  7736. <member name="M:NPOI.XWPF.UserModel.XWPFPictureData.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  7737. Construct XWPFPictureData from a package part
  7738. @param part the package part holding the Drawing data,
  7739. @param rel the package relationship holding this Drawing,
  7740. the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/image
  7741. </member>
  7742. <member name="M:NPOI.XWPF.UserModel.XWPFPictureData.SuggestFileExtension">
  7743. Suggests a file extension for this image.
  7744. @return the file extension.
  7745. </member>
  7746. <member name="M:NPOI.XWPF.UserModel.XWPFPictureData.GetPictureType">
  7747. Return an integer constant that specifies type of this picture
  7748. @return an integer constant that specifies type of this picture
  7749. @see NPOI.XWPF.UserModel.PictureTypeEMF
  7750. @see NPOI.XWPF.UserModel.PictureTypeWMF
  7751. @see NPOI.XWPF.UserModel.PictureTypePICT
  7752. @see NPOI.XWPF.UserModel.PictureTypeJPEG
  7753. @see NPOI.XWPF.UserModel.PictureTypePNG
  7754. @see NPOI.XWPF.UserModel.PictureTypeDIB
  7755. </member>
  7756. <member name="M:NPOI.XWPF.UserModel.XWPFPictureData.PrepareForCommit">
  7757. *PictureData objects store the actual content in the part directly without keeping a
  7758. copy like all others therefore we need to handle them differently.
  7759. </member>
  7760. <member name="P:NPOI.XWPF.UserModel.XWPFPictureData.Data">
  7761. Gets the picture data as a byte array.
  7762. <p>
  7763. Note, that this call might be expensive since all the picture data is copied into a temporary byte array.
  7764. You can grab the picture data directly from the underlying package part as follows:
  7765. <br/>
  7766. <code>
  7767. InputStream is1 = GetPackagePart().InputStream;
  7768. </code>
  7769. </p>
  7770. @return the Picture data.
  7771. </member>
  7772. <member name="P:NPOI.XWPF.UserModel.XWPFPictureData.FileName">
  7773. Returns the file name of the image, eg image7.jpg . The original filename
  7774. isn't always available, but if it can be found it's likely to be in the
  7775. CTDrawing
  7776. </member>
  7777. <member name="T:NPOI.XWPF.UserModel.XWPFRelation">
  7778. @author Yegor Kozlov
  7779. </member>
  7780. <member name="F:NPOI.XWPF.UserModel.XWPFRelation._table">
  7781. A map to lookup POIXMLRelation by its relation type
  7782. </member>
  7783. <member name="F:NPOI.XWPF.UserModel.XWPFRelation.IMAGE_EMF">
  7784. Supported image formats
  7785. </member>
  7786. <member name="M:NPOI.XWPF.UserModel.XWPFRelation.GetInstance(System.String)">
  7787. Get POIXMLRelation by relation type
  7788. @param rel relation type, for example,
  7789. <code>http://schemas.openxmlformats.org/officeDocument/2006/relationships/image</code>
  7790. @return registered POIXMLRelation or null if not found
  7791. </member>
  7792. <member name="T:NPOI.XWPF.UserModel.FontCharRange">
  7793. @see <a href="http://msdn.microsoft.com/en-us/library/ff533743(v=office.12).aspx">[MS-OI29500] Run Fonts</a>
  7794. </member>
  7795. <member name="T:NPOI.XWPF.UserModel.XWPFSDT">
  7796. Experimental class to offer rudimentary Read-only Processing of
  7797. of StructuredDocumentTags/ContentControl
  7798. WARNING - APIs expected to change rapidly
  7799. </member>
  7800. <member name="T:NPOI.XWPF.UserModel.XWPFSDTCell">
  7801. Experimental class to offer rudimentary Read-only Processing of
  7802. of StructuredDocumentTags/ContentControl that can appear
  7803. in a table row as if a table cell.
  7804. <p/>
  7805. These can contain one or more cells or other SDTs within them.
  7806. <p/>
  7807. WARNING - APIs expected to change rapidly
  7808. </member>
  7809. <member name="T:NPOI.XWPF.UserModel.XWPFSDTContent">
  7810. Experimental class to offer rudimentary Read-only Processing of
  7811. of the contentblock of an SDT/ContentControl.
  7812. WARNING - APIs expected to change rapidly
  7813. </member>
  7814. <member name="T:NPOI.XWPF.UserModel.XWPFSDTContentCell">
  7815. Experimental class to offer rudimentary Read-only Processing of
  7816. of the XWPFSDTCellContent.
  7817. <p/>
  7818. WARNING - APIs expected to change rapidly
  7819. </member>
  7820. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.GetZoomPercent">
  7821. In the zoom tag inside Settings.xml file <br/>
  7822. it Sets the value of zoom
  7823. @return percentage as an integer of zoom level
  7824. </member>
  7825. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.SetZoomPercent(System.Int64)">
  7826. <summary>
  7827. Set zoom. In the zoom tag inside settings.xml file it sets the value of zoom
  7828. </summary>
  7829. <param name="zoomPercent"></param>
  7830. <example>
  7831. sample snippet from Settings.xml
  7832. &lt;w:zoom w:percent="50" /&gt;
  7833. </example>
  7834. </member>
  7835. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.IsEnforcedWith(NPOI.OpenXmlFormats.Wordprocessing.ST_DocProtect)">
  7836. Verifies the documentProtection tag inside Settings.xml file <br/>
  7837. if the protection is enforced (w:enforcement="1") <br/>
  7838. and if the kind of protection Equals to passed (STDocProtect.Enum editValue) <br/>
  7839. <br/>
  7840. sample snippet from Settings.xml
  7841. <pre>
  7842. &lt;w:settings ... &gt;
  7843. &lt;w:documentProtection w:edit=&quot;readOnly&quot; w:enforcement=&quot;1&quot;/&gt;
  7844. </pre>
  7845. @return true if documentProtection is enforced with option ReadOnly
  7846. </member>
  7847. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.SetEnforcementEditValue(NPOI.OpenXmlFormats.Wordprocessing.ST_DocProtect)">
  7848. Enforces the protection with the option specified by passed editValue.<br/>
  7849. <br/>
  7850. In the documentProtection tag inside Settings.xml file <br/>
  7851. it Sets the value of enforcement to "1" (w:enforcement="1") <br/>
  7852. and the value of edit to the passed editValue (w:edit="[passed editValue]")<br/>
  7853. <br/>
  7854. sample snippet from Settings.xml
  7855. <pre>
  7856. &lt;w:settings ... &gt;
  7857. &lt;w:documentProtection w:edit=&quot;[passed editValue]&quot; w:enforcement=&quot;1&quot;/&gt;
  7858. </pre>
  7859. </member>
  7860. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.RemoveEnforcement">
  7861. Removes protection enforcement.<br/>
  7862. In the documentProtection tag inside Settings.xml file <br/>
  7863. it Sets the value of enforcement to "0" (w:enforcement="0") <br/>
  7864. </member>
  7865. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.SetUpdateFields">
  7866. Enforces fields update on document open (in Word).
  7867. In the settings.xml file <br/>
  7868. sets the updateSettings value to true (w:updateSettings w:val="true")
  7869. NOTICES:
  7870. <ul>
  7871. <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?"
  7872. (if "Update automatic links at open" is enabled)</li>
  7873. <li>Flag is removed after saving with changes in Word </li>
  7874. </ul>
  7875. </member>
  7876. <member name="P:NPOI.XWPF.UserModel.XWPFSettings.IsTrackRevisions">
  7877. get or set revision tracking
  7878. </member>
  7879. <member name="T:NPOI.XWPF.UserModel.XWPFStyle">
  7880. @author Philipp Epp
  7881. </member>
  7882. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.#ctor(NPOI.OpenXmlFormats.Wordprocessing.CT_Style)">
  7883. constructor
  7884. @param style
  7885. </member>
  7886. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.#ctor(NPOI.OpenXmlFormats.Wordprocessing.CT_Style,NPOI.XWPF.UserModel.XWPFStyles)">
  7887. constructor
  7888. @param style
  7889. @param styles
  7890. </member>
  7891. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.SetStyle(NPOI.OpenXmlFormats.Wordprocessing.CT_Style)">
  7892. Set style
  7893. @param style
  7894. </member>
  7895. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.GetCTStyle">
  7896. Get ctStyle
  7897. @return ctStyle
  7898. </member>
  7899. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.GetStyles">
  7900. Get styles
  7901. @return styles the styles to which this style belongs
  7902. </member>
  7903. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.HasSameName(NPOI.XWPF.UserModel.XWPFStyle)">
  7904. Compares the names of the Styles
  7905. @param compStyle
  7906. </member>
  7907. <member name="P:NPOI.XWPF.UserModel.XWPFStyle.StyleId">
  7908. Get StyleID of the style
  7909. @return styleID StyleID of the style
  7910. </member>
  7911. <member name="P:NPOI.XWPF.UserModel.XWPFStyle.StyleType">
  7912. Get Type of the Style
  7913. @return ctType
  7914. </member>
  7915. <member name="P:NPOI.XWPF.UserModel.XWPFStyle.LinkStyleID">
  7916. Get StyleID of the linked Style
  7917. </member>
  7918. <member name="P:NPOI.XWPF.UserModel.XWPFStyle.NextStyleID">
  7919. Get StyleID of the next style
  7920. </member>
  7921. <member name="T:NPOI.XWPF.UserModel.XWPFStyles">
  7922. Holds details of built-in, default and user styles, which
  7923. apply to tables / paragraphs / lists etc.
  7924. Text within one of those with custom stylings has the style
  7925. information stored in the {@link XWPFRun}
  7926. </member>
  7927. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  7928. Construct XWPFStyles from a package part
  7929. @param part the package part holding the data of the styles,
  7930. @param rel the package relationship of type "http://schemas.Openxmlformats.org/officeDocument/2006/relationships/styles"
  7931. </member>
  7932. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.#ctor">
  7933. Construct XWPFStyles from scratch for a new document.
  7934. </member>
  7935. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.OnDocumentRead">
  7936. Read document
  7937. </member>
  7938. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.SetStyles(NPOI.OpenXmlFormats.Wordprocessing.CT_Styles)">
  7939. Sets the ctStyles
  7940. @param styles
  7941. </member>
  7942. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.StyleExist(System.String)">
  7943. Checks whether style with styleID exist
  7944. @param styleID styleID of the Style in the style-Document
  7945. @return true if style exist, false if style not exist
  7946. </member>
  7947. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.AddStyle(NPOI.XWPF.UserModel.XWPFStyle)">
  7948. add a style to the document
  7949. @param style
  7950. @throws IOException
  7951. </member>
  7952. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.GetStyle(System.String)">
  7953. get style by a styleID
  7954. @param styleID styleID of the searched style
  7955. @return style
  7956. </member>
  7957. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.GetUsedStyleList(NPOI.XWPF.UserModel.XWPFStyle)">
  7958. Get the styles which are related to the parameter style and their relatives
  7959. this method can be used to copy all styles from one document to another document
  7960. @param style
  7961. @return a list of all styles which were used by this method
  7962. </member>
  7963. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.GetUsedStyleList(NPOI.XWPF.UserModel.XWPFStyle,System.Collections.Generic.List{NPOI.XWPF.UserModel.XWPFStyle})">
  7964. Get the styles which are related to parameter style
  7965. @param style
  7966. @return all Styles of the parameterList
  7967. </member>
  7968. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.SetSpellingLanguage(System.String)">
  7969. Sets the default spelling language on ctStyles DocDefaults parameter
  7970. @param strSpellingLanguage
  7971. </member>
  7972. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.SetEastAsia(System.String)">
  7973. Sets the default East Asia spelling language on ctStyles DocDefaults parameter
  7974. @param strEastAsia
  7975. </member>
  7976. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.SetDefaultFonts(NPOI.OpenXmlFormats.Wordprocessing.CT_Fonts)">
  7977. Sets the default font on ctStyles DocDefaults parameter
  7978. TODO Replace this with specific Setters for each type, possibly
  7979. on XWPFDefaultRunStyle
  7980. </member>
  7981. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.GetStyleWithSameName(NPOI.XWPF.UserModel.XWPFStyle)">
  7982. Get the style with the same name
  7983. if this style is not existing, return null
  7984. </member>
  7985. <member name="P:NPOI.XWPF.UserModel.XWPFStyles.DefaultRunStyle">
  7986. Get the default style which applies text runs in the document
  7987. </member>
  7988. <member name="P:NPOI.XWPF.UserModel.XWPFStyles.DefaultParagraphStyle">
  7989. Get the default paragraph style which applies to the document
  7990. </member>
  7991. <member name="P:NPOI.XWPF.UserModel.XWPFStyles.LatentStyles">
  7992. Get the definition of all the Latent Styles
  7993. </member>
  7994. <member name="T:NPOI.XWPF.UserModel.XWPFTable">
  7995. <p>Sketch of XWPFTable class. Only table's text is being hold.</p>
  7996. <p>Specifies the contents of a table present in the document. A table is a set
  7997. of paragraphs (and other block-level content) arranged in rows and columns.</p>
  7998. </member>
  7999. <member name="M:NPOI.XWPF.UserModel.XWPFTable.GetCTTbl">
  8000. @return ctTbl object
  8001. </member>
  8002. <member name="M:NPOI.XWPF.UserModel.XWPFTable.AddNewCol">
  8003. add a new column for each row in this table
  8004. </member>
  8005. <member name="M:NPOI.XWPF.UserModel.XWPFTable.CreateRow">
  8006. create a new XWPFTableRow object with as many cells as the number of columns defined in that moment
  8007. @return tableRow
  8008. </member>
  8009. <member name="M:NPOI.XWPF.UserModel.XWPFTable.GetRow(System.Int32)">
  8010. @param pos - index of the row
  8011. @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
  8012. </member>
  8013. <member name="M:NPOI.XWPF.UserModel.XWPFTable.AddRow(NPOI.XWPF.UserModel.XWPFTableRow)">
  8014. add a new Row to the table
  8015. @param row the row which should be Added
  8016. </member>
  8017. <member name="M:NPOI.XWPF.UserModel.XWPFTable.AddRow(NPOI.XWPF.UserModel.XWPFTableRow,System.Int32)">
  8018. add a new Row to the table
  8019. at position pos
  8020. @param row the row which should be Added
  8021. </member>
  8022. <member name="M:NPOI.XWPF.UserModel.XWPFTable.InsertNewTableRow(System.Int32)">
  8023. inserts a new tablerow
  8024. @param pos
  8025. @return the inserted row
  8026. </member>
  8027. <member name="M:NPOI.XWPF.UserModel.XWPFTable.RemoveRow(System.Int32)">
  8028. Remove a row at position pos from the table
  8029. @param pos position the Row in the Table
  8030. </member>
  8031. <member name="M:NPOI.XWPF.UserModel.XWPFTable.GetRow(NPOI.OpenXmlFormats.Wordprocessing.CT_Row)">
  8032. returns the XWPFRow which belongs to the CTRow row
  8033. if this row is not existing in the table null will be returned
  8034. </member>
  8035. <!-- Badly formed XML comment ignored for member "P:NPOI.XWPF.UserModel.XWPFTable.Text" -->
  8036. <member name="P:NPOI.XWPF.UserModel.XWPFTable.Width">
  8037. @return width value
  8038. </member>
  8039. <member name="P:NPOI.XWPF.UserModel.XWPFTable.NumberOfRows">
  8040. @return number of rows in table
  8041. </member>
  8042. <member name="P:NPOI.XWPF.UserModel.XWPFTable.StyleID">
  8043. Get the StyleID of the table
  8044. @return style-ID of the table
  8045. </member>
  8046. <member name="P:NPOI.XWPF.UserModel.XWPFTable.ElementType">
  8047. returns the type of the BodyElement Table
  8048. @see NPOI.XWPF.UserModel.IBodyElement#getElementType()
  8049. </member>
  8050. <member name="P:NPOI.XWPF.UserModel.XWPFTable.Part">
  8051. returns the part of the bodyElement
  8052. @see NPOI.XWPF.UserModel.IBody#getPart()
  8053. </member>
  8054. <member name="P:NPOI.XWPF.UserModel.XWPFTable.PartType">
  8055. returns the partType of the bodyPart which owns the bodyElement
  8056. @see NPOI.XWPF.UserModel.IBody#getPartType()
  8057. </member>
  8058. <member name="T:NPOI.XWPF.UserModel.XWPFTableCell">
  8059. Represents a Cell within a {@link XWPFTable}. The
  8060. Cell is the thing that holds the actual content (paragraphs etc)
  8061. </member>
  8062. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.#ctor(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc,NPOI.XWPF.UserModel.XWPFTableRow,NPOI.XWPF.UserModel.IBody)">
  8063. If a table cell does not include at least one block-level element, then this document shall be considered corrupt
  8064. </member>
  8065. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.AddParagraph">
  8066. Add a Paragraph to this Table Cell
  8067. @return The paragraph which was Added
  8068. </member>
  8069. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.AddParagraph(NPOI.XWPF.UserModel.XWPFParagraph)">
  8070. add a Paragraph to this TableCell
  8071. @param p the paragaph which has to be Added
  8072. </member>
  8073. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.RemoveParagraph(System.Int32)">
  8074. Removes a paragraph of this tablecell
  8075. @param pos
  8076. </member>
  8077. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  8078. if there is a corresponding {@link XWPFParagraph} of the parameter ctTable in the paragraphList of this table
  8079. the method will return this paragraph
  8080. if there is no corresponding {@link XWPFParagraph} the method will return null
  8081. @param p is instance of CTP and is searching for an XWPFParagraph
  8082. @return null if there is no XWPFParagraph with an corresponding CTPparagraph in the paragraphList of this table
  8083. XWPFParagraph with the correspondig CTP p
  8084. </member>
  8085. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.SetColor(System.String)">
  8086. Set cell color. This sets some associated values; for finer control
  8087. you may want to access these elements individually.
  8088. @param rgbStr - the desired cell color, in the hex form "RRGGBB".
  8089. </member>
  8090. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetColor">
  8091. Get cell color. Note that this method only returns the "fill" value.
  8092. @return RGB string of cell color
  8093. </member>
  8094. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.SetVerticalAlignment(NPOI.XWPF.UserModel.XWPFTableCell.XWPFVertAlign)">
  8095. Set the vertical alignment of the cell.
  8096. @param vAlign - the desired alignment enum value
  8097. </member>
  8098. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetVerticalAlignment">
  8099. Get the vertical alignment of the cell.
  8100. @return the cell alignment enum value
  8101. </member>
  8102. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.InsertNewParagraph(System.Xml.XmlDocument)">
  8103. add a new paragraph at position of the cursor
  8104. @param cursor
  8105. @return the inserted paragraph
  8106. </member>
  8107. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.IsCursorInTableCell(System.Xml.XmlDocument)">
  8108. verifies that cursor is on the right position
  8109. </member>
  8110. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetParagraphArray(System.Int32)">
  8111. @see NPOI.XWPF.UserModel.IBody#getParagraphArray(int)
  8112. </member>
  8113. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetTable(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  8114. Get a table by its CTTbl-Object
  8115. @see NPOI.XWPF.UserModel.IBody#getTable(org.Openxmlformats.schemas.wordProcessingml.x2006.main.CTTbl)
  8116. </member>
  8117. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetTableArray(System.Int32)">
  8118. @see NPOI.XWPF.UserModel.IBody#getTableArray(int)
  8119. </member>
  8120. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.InsertTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  8121. inserts an existing XWPFTable to the arrays bodyElements and tables
  8122. @see NPOI.XWPF.UserModel.IBody#insertTable(int, NPOI.XWPF.UserModel.XWPFTable)
  8123. </member>
  8124. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetTextRecursively">
  8125. extracts all text recursively through embedded tables and embedded SDTs
  8126. </member>
  8127. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  8128. Get the TableCell which belongs to the TableCell
  8129. </member>
  8130. <member name="P:NPOI.XWPF.UserModel.XWPFTableCell.BodyElements">
  8131. returns an Iterator with paragraphs and tables
  8132. @see NPOI.XWPF.UserModel.IBody#getBodyElements()
  8133. </member>
  8134. <member name="P:NPOI.XWPF.UserModel.XWPFTableCell.Paragraphs">
  8135. returns a list of paragraphs
  8136. </member>
  8137. <member name="P:NPOI.XWPF.UserModel.XWPFTableCell.Part">
  8138. Get the to which the TableCell belongs
  8139. @see NPOI.XWPF.UserModel.IBody#getPart()
  8140. </member>
  8141. <member name="P:NPOI.XWPF.UserModel.XWPFTableCell.PartType">
  8142. @see NPOI.XWPF.UserModel.IBody#getPartType()
  8143. </member>
  8144. <member name="P:NPOI.XWPF.UserModel.XWPFTableCell.Tables">
  8145. @see NPOI.XWPF.UserModel.IBody#getTables()
  8146. </member>
  8147. <member name="T:NPOI.XWPF.UserModel.XWPFTableRow">
  8148. A row within an {@link XWPFTable}. Rows mostly just have
  8149. sizings and stylings, the interesting content lives inside
  8150. the child {@link XWPFTableCell}s
  8151. </member>
  8152. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.CreateCell">
  8153. create a new XWPFTableCell and add it to the tableCell-list of this tableRow
  8154. @return the newly Created XWPFTableCell
  8155. </member>
  8156. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.AddNewTableCell">
  8157. Adds a new TableCell at the end of this tableRow
  8158. </member>
  8159. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.GetTableICells">
  8160. create and return a list of all XWPFTableCell
  8161. who belongs to this row
  8162. @return a list of {@link XWPFTableCell}
  8163. </member>
  8164. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.GetTableCells">
  8165. create and return a list of all XWPFTableCell
  8166. who belongs to this row
  8167. @return a list of {@link XWPFTableCell}
  8168. </member>
  8169. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  8170. returns the XWPFTableCell which belongs to the CTTC cell
  8171. if there is no XWPFTableCell which belongs to the parameter CTTc cell null will be returned
  8172. </member>
  8173. <member name="P:NPOI.XWPF.UserModel.XWPFTableRow.Height">
  8174. This element specifies the height of the current table row within the
  8175. current table. This height shall be used to determine the resulting
  8176. height of the table row, which may be absolute or relative (depending on
  8177. its attribute values). If omitted, then the table row shall automatically
  8178. resize its height to the height required by its contents (the equivalent
  8179. of an hRule value of auto).
  8180. @return height
  8181. </member>
  8182. <member name="P:NPOI.XWPF.UserModel.XWPFTableRow.IsCantSplitRow">
  8183. Return true if the "can't split row" value is true. The logic for this
  8184. attribute is a little unusual: a TRUE value means DON'T allow rows to
  8185. split, FALSE means allow rows to split.
  8186. @return true if rows can't be split, false otherwise.
  8187. </member>
  8188. <member name="P:NPOI.XWPF.UserModel.XWPFTableRow.IsRepeatHeader">
  8189. Return true if a table's header row should be repeated at the top of a
  8190. table split across pages.
  8191. @return true if table's header row should be repeated at the top of each
  8192. page of table, false otherwise.
  8193. </member>
  8194. </members>
  8195. </doc>