NPOI.OOXML.xml 612 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>NPOI.OOXML</name>
  5. </assembly>
  6. <members>
  7. <member name="T:NPOI.POIFS.Crypt.Agile.AgileDecryptor">
  8. Decryptor implementation for Agile Encryption
  9. </member>
  10. <member name="M:NPOI.POIFS.Crypt.Agile.AgileDecryptor.VerifyPassword(System.String)">
  11. Set decryption password
  12. </member>
  13. <member name="M:NPOI.POIFS.Crypt.Agile.AgileDecryptor.VerifyPassword(NPOI.POIFS.Crypt.Agile.KeyPair,Org.BouncyCastle.X509.X509Certificate)">
  14. instead of a password, it's also possible to decrypt via certificate.
  15. Warning: this code is experimental and hasn't been validated
  16. @see <a href="http://social.msdn.microsoft.com/Forums/en-US/cc9092bb-0c82-4b5b-ae21-abf643bdb37c/agile-encryption-with-certificates">Agile encryption with certificates</a>
  17. @param keyPair
  18. @param x509
  19. @return true, when the data can be successfully decrypted with the given private key
  20. @throws GeneralSecurityException
  21. </member>
  22. <member name="T:NPOI.POIFS.Crypt.Agile.AgileDecryptor.AgileCipherInputStream">
  23. 2.3.4.15 Data Encryption (Agile Encryption)
  24. The EncryptedPackage stream (1) MUST be encrypted in 4096-byte segments to facilitate nearly
  25. random access while allowing CBC modes to be used in the encryption Process.
  26. The Initialization vector for the encryption process MUST be obtained by using the zero-based
  27. segment number as a blockKey and the binary form of the KeyData.saltValue as specified in
  28. section 2.3.4.12. The block number MUST be represented as a 32-bit unsigned integer.
  29. Data blocks MUST then be encrypted by using the Initialization vector and the intermediate key
  30. obtained by decrypting the encryptedKeyValue from a KeyEncryptor Contained within the
  31. KeyEncryptors sequence as specified in section 2.3.4.10. The data block MUST be pAdded to
  32. the next integral multiple of the KeyData.blockSize value. Any pAdding bytes can be used. Note
  33. that the StreamSize field of the EncryptedPackage field specifies the number of bytes of
  34. unencrypted data as specified in section 2.3.4.4.
  35. </member>
  36. <member name="T:NPOI.POIFS.Crypt.Agile.AgileEncryptionVerifier">
  37. Used when Checking if a key is valid for a document
  38. </member>
  39. <member name="M:NPOI.POIFS.Crypt.Agile.AgileEncryptor.UpdateIntegrityHMAC(System.IO.FileInfo,System.Int32)">
  40. Generate an HMAC, as specified in [RFC2104], of the encrypted form of the data (message),
  41. which the DataIntegrity element will verify by using the Salt generated in step 2 as the key.
  42. Note that the entire EncryptedPackage stream (1), including the StreamSize field, MUST be
  43. used as the message.
  44. Encrypt the HMAC as in step 3 by using a blockKey byte array consisting of the following bytes:
  45. 0xa0, 0x67, 0x7f, 0x02, 0xb2, 0x2c, 0x84, and 0x33.
  46. </member>
  47. <member name="T:NPOI.POIFS.Crypt.Agile.AgileEncryptor.AgileCipherOutputStream">
  48. 2.3.4.15 Data Encryption (Agile Encryption)
  49. The EncryptedPackage stream (1) MUST be encrypted in 4096-byte segments to facilitate nearly
  50. random access while allowing CBC modes to be used in the encryption Process.
  51. The Initialization vector for the encryption process MUST be obtained by using the zero-based
  52. segment number as a blockKey and the binary form of the KeyData.saltValue as specified in
  53. section 2.3.4.12. The block number MUST be represented as a 32-bit unsigned integer.
  54. Data blocks MUST then be encrypted by using the Initialization vector and the intermediate key
  55. obtained by decrypting the encryptedKeyValue from a KeyEncryptor Contained within the
  56. KeyEncryptors sequence as specified in section 2.3.4.10. The data block MUST be pAdded to
  57. the next integral multiple of the KeyData.blockSize value. Any pAdding bytes can be used. Note
  58. that the StreamSize field of the EncryptedPackage field specifies the number of bytes of
  59. unencrypted data as specified in section 2.3.4.4.
  60. </member>
  61. <member name="T:NPOI.POIFS.Crypt.Dsig.CertificateSecurityException">
  62. Exception thrown in case there is something wrong with the incoming eID
  63. certificate.
  64. @author Frank Cornelis
  65. </member>
  66. <member name="T:NPOI.POIFS.Crypt.Dsig.DigestInfo">
  67. Digest Information data transfer class.
  68. </member>
  69. <member name="M:NPOI.POIFS.Crypt.Dsig.DigestInfo.#ctor(System.Byte[],NPOI.POIFS.Crypt.HashAlgorithm,System.String)">
  70. Main constructor.
  71. @param digestValue
  72. @param hashAlgo
  73. @param description
  74. </member>
  75. <member name="T:NPOI.POIFS.Crypt.Dsig.ExpiredCertificateSecurityException">
  76. Exception thrown in case the incoming eID certificate is expired.
  77. @author Frank Cornelis
  78. </member>
  79. <member name="T:NPOI.POIFS.Crypt.Dsig.Facets.EnvelopedSignatureFacet">
  80. Signature Facet implementation to create enveloped signatures.
  81. @author Frank Cornelis
  82. </member>
  83. <member name="T:NPOI.POIFS.Crypt.Dsig.Facets.KeyInfoSignatureFacet">
  84. Signature Facet implementation that Adds ds:KeyInfo to the XML signature.
  85. @author Frank Cornelis
  86. </member>
  87. <member name="T:NPOI.POIFS.Crypt.Dsig.Facets.Office2010SignatureFacet">
  88. Work-around for Office2010 to accept the XAdES-BES/EPES signature.
  89. xades:UnsignedProperties/xades:UnsignedSignatureProperties needs to be
  90. present.
  91. @author Frank Cornelis
  92. </member>
  93. <member name="T:NPOI.POIFS.Crypt.Dsig.Facets.OOXMLSignatureFacet">
  94. Office OpenXML Signature Facet implementation.
  95. @author fcorneli
  96. @see <a href="http://msdn.microsoft.com/en-us/library/cc313071.aspx">[MS-OFFCRYPTO]: Office Document Cryptography Structure</a>
  97. </member>
  98. <member name="F:NPOI.POIFS.Crypt.Dsig.Facets.OOXMLSignatureFacet.signed">
  99. Office 2010 list of signed types (extensions).
  100. </member>
  101. <member name="T:NPOI.POIFS.Crypt.Dsig.Facets.SignatureFacet">
  102. JSR105 Signature Facet base class.
  103. </member>
  104. <member name="M:NPOI.POIFS.Crypt.Dsig.Facets.SignatureFacet.preSign(System.Xml.XmlDocument,System.Collections.Generic.List{System.Security.Cryptography.Xml.Reference},System.Collections.Generic.List{System.Xml.XmlNode})">
  105. This method is being invoked by the XML signature service engine during
  106. pre-sign phase. Via this method a signature facet implementation can add
  107. signature facets to an XML signature.
  108. @param document the signature document to be used for imports
  109. @param references list of reference defInitions
  110. @param objects objects to be signed/included in the signature document
  111. @throws XMLSignatureException
  112. </member>
  113. <member name="M:NPOI.POIFS.Crypt.Dsig.Facets.SignatureFacet.postSign(System.Xml.XmlDocument)">
  114. This method is being invoked by the XML signature service engine during
  115. the post-sign phase. Via this method a signature facet can extend the XML
  116. signatures with for example key information.
  117. @param document the signature document to be modified
  118. @throws MarshalException
  119. </member>
  120. <member name="T:NPOI.POIFS.Crypt.Dsig.Facets.XAdESSignatureFacet">
  121. XAdES Signature Facet. Implements XAdES v1.4.1 which is compatible with XAdES
  122. v1.3.2. The implemented XAdES format is XAdES-BES/EPES. It's up to another
  123. part of the signature service to upgrade the XAdES-BES to a XAdES-X-L.
  124. This implementation has been tested against an implementation that
  125. participated multiple ETSI XAdES plugtests.
  126. @author Frank Cornelis
  127. @see <a href="http://en.wikipedia.org/wiki/XAdES">XAdES</a>
  128. </member>
  129. <member name="M:NPOI.POIFS.Crypt.Dsig.Facets.XAdESSignatureFacet.AddMimeType(System.String,System.String)">
  130. Adds a mime-type for the given ds:Reference (referred via its @URI). This
  131. information is Added via the xades:DataObjectFormat element.
  132. @param dsReferenceUri
  133. @param mimetype
  134. </member>
  135. <member name="T:NPOI.POIFS.Crypt.Dsig.Facets.XAdESXLSignatureFacet">
  136. XAdES-X-L v1.4.1 signature facet. This signature facet implementation will
  137. upgrade a given XAdES-BES/EPES signature to XAdES-X-L.
  138. We don't inherit from XAdESSignatureFacet as we also want to be able to use
  139. this facet out of the context of a signature creation. This signature facet
  140. assumes that the signature is already XAdES-BES/EPES compliant.
  141. This implementation has been tested against an implementation that
  142. participated multiple ETSI XAdES plugtests.
  143. @author Frank Cornelis
  144. @see XAdESSignatureFacet
  145. </member>
  146. <member name="T:NPOI.POIFS.Crypt.Dsig.OOXMLURIDereferencer">
  147. JSR105 URI dereferencer for Office Open XML documents.
  148. </member>
  149. <member name="T:NPOI.POIFS.Crypt.Dsig.RevokedCertificateSecurityException">
  150. Exception thrown in case the incoming eID certificate has been revoked.
  151. @author Frank Cornelis
  152. </member>
  153. <member name="T:NPOI.POIFS.Crypt.Dsig.Services.RevocationData">
  154. Container class for PKI revocation data.
  155. @author Frank Cornelis
  156. </member>
  157. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.RevocationData.#ctor">
  158. Default constructor.
  159. </member>
  160. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.RevocationData.AddCRL(System.Byte[])">
  161. Adds a CRL to this revocation data Set.
  162. @param encodedCrl
  163. </member>
  164. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.RevocationData.AddCRL(NPOI.POIFS.Crypt.Dsig.Services.X509CRL)">
  165. Adds a CRL to this revocation data Set.
  166. @param crl
  167. </member>
  168. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.RevocationData.AddOCSP(System.Byte[])">
  169. Adds an OCSP response to this revocation data Set.
  170. @param encodedOcsp
  171. </member>
  172. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.RevocationData.GetCRLs">
  173. Gives back a list of all CRLs.
  174. @return a list of all CRLs
  175. </member>
  176. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.RevocationData.GetOCSPs">
  177. Gives back a list of all OCSP responses.
  178. @return a list of all OCSP response
  179. </member>
  180. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.RevocationData.HasOCSPs">
  181. Returns <code>true</code> if this revocation data Set holds OCSP
  182. responses.
  183. @return <code>true</code> if this revocation data Set holds OCSP
  184. responses.
  185. </member>
  186. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.RevocationData.HasCRLs">
  187. Returns <code>true</code> if this revocation data Set holds CRLs.
  188. @return <code>true</code> if this revocation data Set holds CRLs.
  189. </member>
  190. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.RevocationData.HasRevocationDataEntries">
  191. Returns <code>true</code> if this revocation data is not empty.
  192. @return <code>true</code> if this revocation data is not empty.
  193. </member>
  194. <member name="T:NPOI.POIFS.Crypt.Dsig.Services.IRevocationDataService">
  195. Interface for a service that retrieves revocation data about some given
  196. certificate chain.
  197. @author Frank Cornelis
  198. </member>
  199. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.IRevocationDataService.GetRevocationData(System.Collections.Generic.List{System.Security.Cryptography.X509Certificates.X509Certificate})">
  200. Gives back the revocation data corresponding with the given certificate
  201. chain.
  202. @param certificateChain the certificate chain
  203. @return the revocation data corresponding with the given certificate chain.
  204. </member>
  205. <member name="T:NPOI.POIFS.Crypt.Dsig.Services.ISignaturePolicyService">
  206. Interface for the signature policy service.
  207. @author Frank Cornelis
  208. </member>
  209. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.ISignaturePolicyService.GetSignaturePolicyIdentifier">
  210. Gives back the signature policy identifier URI.
  211. @return the signature policy identifier URI.
  212. </member>
  213. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.ISignaturePolicyService.GetSignaturePolicyDescription">
  214. Gives back the short description of the signature policy or
  215. <code>null</code> if a description is not available.
  216. @return the description, or <code>null</code>.
  217. </member>
  218. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.ISignaturePolicyService.GetSignaturePolicyDownloadUrl">
  219. Gives back the download URL where the signature policy document can be
  220. found. Can be <code>null</code> in case such a download location does not
  221. exist.
  222. @return the download URL, or <code>null</code>.
  223. </member>
  224. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.ISignaturePolicyService.GetSignaturePolicyDocument">
  225. Gives back the signature policy document.
  226. @return the bytes of the signature policy document.
  227. </member>
  228. <member name="T:NPOI.POIFS.Crypt.Dsig.Services.ITimeStampService">
  229. Interface for a time-stamp service.
  230. @author Frank Cornelis
  231. </member>
  232. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.ITimeStampService.TimeStamp(System.Byte[],NPOI.POIFS.Crypt.Dsig.Services.RevocationData)">
  233. Gives back the encoded time-stamp token for the given array of data
  234. bytes. We assume that the time-stamp token itself Contains its full
  235. certificate chain required for proper validation.
  236. @param data
  237. the data to be time-stamped.
  238. @param revocationData
  239. the optional Container that needs to be Filled up with the
  240. revocation data used to validate the TSA certificate chain.
  241. @return the DER encoded time-stamp token.
  242. @throws Exception
  243. in case something went wrong.
  244. </member>
  245. <member name="T:NPOI.POIFS.Crypt.Dsig.Services.ITimeStampServiceValidator">
  246. Interface for trust validator of a TSP.
  247. @author Frank Cornelis
  248. </member>
  249. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.ITimeStampServiceValidator.Validate(System.Collections.Generic.List{Org.BouncyCastle.X509.X509Certificate},NPOI.POIFS.Crypt.Dsig.Services.RevocationData)">
  250. Validates the given certificate chain.
  251. @param certificateChain
  252. @param revocationData
  253. the optional data Container that should be Filled with
  254. revocation data that was used to validate the given
  255. certificate chain.
  256. @throws Exception
  257. in case the certificate chain is invalid.
  258. </member>
  259. <member name="T:NPOI.POIFS.Crypt.Dsig.Services.TSPTimeStampService">
  260. A TSP time-stamp service implementation.
  261. @author Frank Cornelis
  262. </member>
  263. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.TSPTimeStampService.mapDigestAlgoToOID(NPOI.POIFS.Crypt.HashAlgorithm)">
  264. Maps the digest algorithm to corresponding OID value.
  265. </member>
  266. <member name="T:NPOI.POIFS.Crypt.Dsig.SignatureConfig">
  267. This class bundles the configuration options used for the existing
  268. signature facets.
  269. Apart of the thread local members (e.g. opc-package) most values will probably be constant, so
  270. it might be configured centrally (e.g. by spring)
  271. </member>
  272. <!-- Badly formed XML comment ignored for member "F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.signatureFacets" -->
  273. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.signaturePolicyService">
  274. the optional signature policy service used for XAdES-EPES.
  275. </member>
  276. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.tspService">
  277. the time-stamp service used for XAdES-T and XAdES-X.
  278. </member>
  279. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.tspUrl">
  280. timestamp service provider URL
  281. </member>
  282. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.tspDigestAlgo">
  283. if not defined, it's the same as the main digest
  284. </member>
  285. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.tspRequestPolicy">
  286. the optional TSP request policy OID.
  287. </member>
  288. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.revocationDataService">
  289. the optional revocation data service used for XAdES-C and XAdES-X-L.
  290. When <code>null</code> the signature will be limited to XAdES-T only.
  291. </member>
  292. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.xadesDigestAlgo">
  293. if not defined, it's the same as the main digest
  294. </member>
  295. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.xadesIssuerNameNoReverseOrder">
  296. Work-around for Office 2010 IssuerName encoding.
  297. </member>
  298. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.packageSignatureId">
  299. The signature Id attribute value used to create the XML signature. A
  300. <code>null</code> value will trigger an automatically generated signature Id.
  301. </member>
  302. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.signatureDescription">
  303. Gives back the human-readable description of what the citizen will be
  304. signing. The default value is "Office OpenXML Document".
  305. </member>
  306. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.signatureMarshalListener">
  307. The process of signing includes the marshalling of xml structures.
  308. This also includes the canonicalization. Currently this leads to problems
  309. with certain namespaces, so this EventListener is used to interfere
  310. with the marshalling Process.
  311. </member>
  312. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.namespacePrefixes">
  313. Map of namespace uris to prefix
  314. If a mapping is specified, the corresponding elements will be prefixed
  315. </member>
  316. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.Init(System.Boolean)">
  317. Inits and Checks the config object.
  318. If not Set previously, complex configuration properties also Get
  319. Created/initialized via this Initialization call.
  320. @param onlyValidation if true, only a subset of the properties
  321. is Initialized, which are necessary for validation. If false,
  322. also the other properties needed for signing are been taken care of
  323. </member>
  324. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.AddSignatureFacet(NPOI.POIFS.Crypt.Dsig.Facets.SignatureFacet)">
  325. @param signatureFacet the signature facet is Appended to facet list
  326. </member>
  327. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetSignatureFacets">
  328. @return the list of facets, may be empty when the config object is not Initialized
  329. </member>
  330. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetSignatureFacets(System.Collections.Generic.List{NPOI.POIFS.Crypt.Dsig.Facets.SignatureFacet})">
  331. @param signatureFacets the new list of facets
  332. </member>
  333. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetDigestAlgo">
  334. @return the main digest algorithm, defaults to sha-1
  335. </member>
  336. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetDigestAlgo(NPOI.POIFS.Crypt.HashAlgorithm)">
  337. @param digestAlgo the main digest algorithm
  338. </member>
  339. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetOpcPackage">
  340. @return the opc package to be used by this thread, stored as thread-local
  341. </member>
  342. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetOpcPackage(NPOI.OpenXml4Net.OPC.OPCPackage)">
  343. @param opcPackage the opc package to be handled by this thread, stored as thread-local
  344. </member>
  345. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetKey">
  346. @return the private key
  347. </member>
  348. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetKey(NPOI.POIFS.Crypt.IPrivateKey)">
  349. @param key the private key
  350. </member>
  351. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetSigningCertificateChain">
  352. @return the certificate chain, index 0 is usually the certificate matching
  353. the private key
  354. </member>
  355. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetSigningCertificateChain(System.Collections.Generic.List{System.Security.Cryptography.X509Certificates.X509Certificate})">
  356. @param signingCertificateChain the certificate chain, index 0 should be
  357. the certificate matching the private key
  358. </member>
  359. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetExecutionTime">
  360. @return the time at which the document is signed, also used for the timestamp service.
  361. defaults to now
  362. </member>
  363. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetExecutionTime(System.DateTime)">
  364. @param executionTime Sets the time at which the document ought to be signed
  365. </member>
  366. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetSignaturePolicyService">
  367. @return the service to be used for XAdES-EPES properties. There's no default implementation
  368. </member>
  369. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetSignaturePolicyService(NPOI.POIFS.Crypt.Dsig.Services.ISignaturePolicyService)">
  370. @param signaturePolicyService the service to be used for XAdES-EPES properties
  371. </member>
  372. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetSignatureDescription">
  373. @return Gives back the human-readable description of what the citizen
  374. will be signing. The default value is "Office OpenXML Document".
  375. </member>
  376. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetSignatureDescription(System.String)">
  377. @param signatureDescription the human-readable description of
  378. what the citizen will be signing.
  379. </member>
  380. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetCanonicalizationMethod">
  381. @return the default canonicalization method, defaults to INCLUSIVE
  382. </member>
  383. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetCanonicalizationMethod(System.String)">
  384. @param canonicalizationMethod the default canonicalization method
  385. </member>
  386. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetPackageSignatureId">
  387. @return The signature Id attribute value used to create the XML signature.
  388. Defaults to "idPackageSignature"
  389. </member>
  390. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetPackageSignatureId(System.String)">
  391. @param packageSignatureId The signature Id attribute value used to create the XML signature.
  392. A <code>null</code> value will trigger an automatically generated signature Id.
  393. </member>
  394. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetTspUrl">
  395. @return the url of the timestamp provider (TSP)
  396. </member>
  397. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetTspUrl(System.String)">
  398. @param tspUrl the url of the timestamp provider (TSP)
  399. </member>
  400. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.IsTspOldProtocol">
  401. @return if true, uses timestamp-request/response mimetype,
  402. if false, timestamp-query/reply mimetype
  403. </member>
  404. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetTspOldProtocol(System.Boolean)">
  405. @param tspOldProtocol defines the timestamp-protocol mimetype
  406. @see #isTspOldProtocol
  407. </member>
  408. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetTspDigestAlgo">
  409. @return the hash algorithm to be used for the timestamp entry.
  410. Defaults to the hash algorithm of the main entry
  411. </member>
  412. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetTspDigestAlgo(NPOI.POIFS.Crypt.HashAlgorithm)">
  413. @param tspDigestAlgo the algorithm to be used for the timestamp entry.
  414. if <code>null</code>, the hash algorithm of the main entry
  415. </member>
  416. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetProxyUrl">
  417. @return the proxy url to be used for all communications.
  418. Currently this affects the timestamp service
  419. </member>
  420. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetProxyUrl(System.String)">
  421. @param proxyUrl the proxy url to be used for all communications.
  422. Currently this affects the timestamp service
  423. </member>
  424. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetTspService">
  425. @return the timestamp service. Defaults to {@link TSPTimeStampService}
  426. </member>
  427. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetTspService(NPOI.POIFS.Crypt.Dsig.Services.ITimeStampService)">
  428. @param tspService the timestamp service
  429. </member>
  430. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetTspUser">
  431. @return the user id for the timestamp service - currently only basic authorization is supported
  432. </member>
  433. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetTspUser(System.String)">
  434. @param tspUser the user id for the timestamp service - currently only basic authorization is supported
  435. </member>
  436. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetTspPass">
  437. @return the password for the timestamp service
  438. </member>
  439. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetTspPass(System.String)">
  440. @param tspPass the password for the timestamp service
  441. </member>
  442. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetTspValidator">
  443. @return the validator for the timestamp service (certificate)
  444. </member>
  445. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetTspValidator(NPOI.POIFS.Crypt.Dsig.Services.ITimeStampServiceValidator)">
  446. @param tspValidator the validator for the timestamp service (certificate)
  447. </member>
  448. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetRevocationDataService">
  449. @return the optional revocation data service used for XAdES-C and XAdES-X-L.
  450. When <code>null</code> the signature will be limited to XAdES-T only.
  451. </member>
  452. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetRevocationDataService(NPOI.POIFS.Crypt.Dsig.Services.IRevocationDataService)">
  453. @param revocationDataService the optional revocation data service used for XAdES-C and XAdES-X-L.
  454. When <code>null</code> the signature will be limited to XAdES-T only.
  455. </member>
  456. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetXadesDigestAlgo">
  457. @return hash algorithm used for XAdES. Defaults to the {@link #getDigestAlgo()}
  458. </member>
  459. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetXadesDigestAlgo(NPOI.POIFS.Crypt.HashAlgorithm)">
  460. @param xadesDigestAlgo hash algorithm used for XAdES.
  461. When <code>null</code>, defaults to {@link #getDigestAlgo()}
  462. </member>
  463. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetUserAgent">
  464. @return the user agent used for http communication (e.g. to the TSP)
  465. </member>
  466. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetUserAgent(System.String)">
  467. @param userAgent the user agent used for http communication (e.g. to the TSP)
  468. </member>
  469. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetTspRequestPolicy">
  470. @return the asn.1 object id for the tsp request policy.
  471. Defaults to <code>1.3.6.1.4.1.13762.3</code>
  472. </member>
  473. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetTspRequestPolicy(System.String)">
  474. @param tspRequestPolicy the asn.1 object id for the tsp request policy.
  475. </member>
  476. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.IsIncludeEntireCertificateChain">
  477. @return true, if the whole certificate chain is included in the signature.
  478. When false, only the signer cert will be included
  479. </member>
  480. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetIncludeEntireCertificateChain(System.Boolean)">
  481. @param includeEntireCertificateChain if true, include the whole certificate chain.
  482. If false, only include the signer cert
  483. </member>
  484. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.IsIncludeIssuerSerial">
  485. @return if true, issuer serial number is included
  486. </member>
  487. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetIncludeIssuerSerial(System.Boolean)">
  488. @param includeIssuerSerial if true, issuer serial number is included
  489. </member>
  490. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.IsIncludeKeyValue">
  491. @return if true, the key value of the public key (certificate) is included
  492. </member>
  493. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetIncludeKeyValue(System.Boolean)">
  494. @param includeKeyValue if true, the key value of the public key (certificate) is included
  495. </member>
  496. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetXadesRole">
  497. @return the xades role element. If <code>null</code> the claimed role element is omitted.
  498. Defaults to <code>null</code>
  499. </member>
  500. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetXadesRole(System.String)">
  501. @param xadesRole the xades role element. If <code>null</code> the claimed role element is omitted.
  502. </member>
  503. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetXadesSignatureId">
  504. @return the Id for the XAdES SignedProperties element.
  505. Defaults to <code>idSignedProperties</code>
  506. </member>
  507. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetXadesSignatureId(System.String)">
  508. @param xadesSignatureId the Id for the XAdES SignedProperties element.
  509. When <code>null</code> defaults to <code>idSignedProperties</code>
  510. </member>
  511. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.IsXadesSignaturePolicyImplied">
  512. @return when true, include the policy-implied block.
  513. Defaults to <code>true</code>
  514. </member>
  515. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetXadesSignaturePolicyImplied(System.Boolean)">
  516. @param xadesSignaturePolicyImplied when true, include the policy-implied block
  517. </member>
  518. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.IsXadesIssuerNameNoReverseOrder">
  519. Make sure the DN is encoded using the same order as present
  520. within the certificate. This is an Office2010 work-around.
  521. Should be reverted back.
  522. XXX: not correct according to RFC 4514.
  523. @return when true, the issuer DN is used instead of the issuer X500 principal
  524. </member>
  525. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetXadesIssuerNameNoReverseOrder(System.Boolean)">
  526. @param xadesIssuerNameNoReverseOrder when true, the issuer DN instead of the issuer X500 prinicpal is used
  527. </member>
  528. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetNamespacePrefixes">
  529. @return the map of namespace uri (key) to prefix (value)
  530. </member>
  531. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetNamespacePrefixes(System.Collections.Generic.Dictionary{System.String,System.String})">
  532. @param namespacePrefixes the map of namespace uri (key) to prefix (value)
  533. </member>
  534. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.nvl``1(``0,``0)">
  535. helper method for null/default value handling
  536. @param value
  537. @param defaultValue
  538. @return if value is not null, return value otherwise defaultValue
  539. </member>
  540. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetHashMagic">
  541. Each digest method has its own IV (Initial vector)
  542. @return the IV depending on the main digest method
  543. </member>
  544. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetSignatureMethodUri">
  545. @return the uri for the signature method, i.e. currently only rsa is
  546. supported, so it's the rsa variant of the main digest
  547. </member>
  548. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetDigestMethodUri">
  549. @return the uri for the main digest
  550. </member>
  551. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetDigestMethodUri(NPOI.POIFS.Crypt.HashAlgorithm)">
  552. @param digestAlgo the digest algo, currently only sha* and ripemd160 is supported
  553. @return the uri for the given digest
  554. </member>
  555. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetXadesCanonicalizationMethod">
  556. @return the cannonicalization method for XAdES-XL signing.
  557. Defaults to <code>EXCLUSIVE</code>
  558. @see <a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/crypto/dsig/CanonicalizationMethod.html">javax.xml.Crypto.dsig.CanonicalizationMethod</a>
  559. </member>
  560. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetXadesCanonicalizationMethod(System.String)">
  561. @param xadesCanonicalizationMethod the cannonicalization method for XAdES-XL signing
  562. @see <a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/crypto/dsig/CanonicalizationMethod.html">javax.xml.Crypto.dsig.CanonicalizationMethod</a>
  563. </member>
  564. <!-- Badly formed XML comment ignored for member "T:NPOI.POIFS.Crypt.Dsig.IURIReference" -->
  565. <member name="M:NPOI.POIFS.Crypt.Dsig.IURIReference.getURI">
  566. Returns the URI of the referenced data object.
  567. @return the URI of the data object in RFC 2396 format (may be
  568. <code>null</code> if not specified)
  569. </member>
  570. <member name="M:NPOI.POIFS.Crypt.Dsig.IURIReference.getType">
  571. Returns the type of data referenced by this URI.
  572. @return the type (a URI) of the data object (may be <code>null</code>
  573. if not specified)
  574. </member>
  575. <!-- Badly formed XML comment ignored for member "T:NPOI.POIFS.Crypt.Dsig.IURIDereferencer" -->
  576. <member name="M:NPOI.POIFS.Crypt.Dsig.IURIDereferencer.dereference(NPOI.POIFS.Crypt.Dsig.IURIReference,System.Security.Cryptography.Xml.SignedXml)">
  577. Dereferences the specified <code>URIReference</code> and returns the
  578. dereferenced data.
  579. @param uriReference the <code>URIReference</code>
  580. @param context an <code>XMLCryptoContext</code> that may
  581. contain additional useful information for dereferencing the URI. This
  582. implementation should dereference the specified
  583. <code>URIReference</code> against the context's <code>baseURI</code>
  584. parameter, if specified.
  585. @return the dereferenced data
  586. @throws NullPointerException if <code>uriReference</code> or
  587. <code>context</code> are <code>null</code>
  588. @throws URIReferenceException if an exception occurs while
  589. dereferencing the specified <code>uriReference</code>
  590. </member>
  591. <!-- Badly formed XML comment ignored for member "T:NPOI.POIFS.Crypt.Dsig.IEventListener" -->
  592. <member name="M:NPOI.POIFS.Crypt.Dsig.IEventListener.handleEvent(NPOI.POIFS.Crypt.Dsig.IEvent)">
  593. This method is called whenever an event occurs of the type for which
  594. the <code> EventListener</code> interface was registered.
  595. @param evt The <code>Event</code> contains contextual information
  596. about the event. It also contains the <code>stopPropagation</code>
  597. and <code>preventDefault</code> methods which are used in
  598. determining the event's flow and default action.
  599. </member>
  600. <member name="T:NPOI.POIFS.Crypt.Dsig.SignatureInfo">
  601. <p>This class is the default entry point for XML signatures and can be used for
  602. validating an existing signed office document and signing a office document.</p>
  603. <p><b>Validating a signed office document</b></p>
  604. <pre>
  605. OPCPackage pkg = OPCPackage.open(..., PackageAccess.READ);
  606. SignatureConfig sic = new SignatureConfig();
  607. sic.setOpcPackage(pkg);
  608. SignatureInfo si = new SignatureInfo();
  609. si.setSignatureConfig(sic);
  610. boolean isValid = si.validate();
  611. ...
  612. </pre>
  613. <p><b>Signing an office document</b></p>
  614. <pre>
  615. // loading the keystore - pkcs12 is used here, but of course jks &amp; co are also valid
  616. // the keystore needs to contain a private key and it's certificate having a
  617. // 'digitalSignature' key usage
  618. char password[] = "test".toCharArray();
  619. File file = new File("test.pfx");
  620. KeyStore keystore = KeyStore.getInstance("PKCS12");
  621. FileInputStream fis = new FileInputStream(file);
  622. keystore.load(fis, password);
  623. fis.close();
  624. // extracting private key and certificate
  625. String alias = "xyz"; // alias of the keystore entry
  626. Key key = keystore.getKey(alias, password);
  627. X509Certificate x509 = (X509Certificate)keystore.getCertificate(alias);
  628. // filling the SignatureConfig entries (minimum fields, more options are available ...)
  629. SignatureConfig signatureConfig = new SignatureConfig();
  630. signatureConfig.setKey(keyPair.getPrivate());
  631. signatureConfig.setSigningCertificateChain(Collections.singletonList(x509));
  632. OPCPackage pkg = OPCPackage.open(..., PackageAccess.READ_WRITE);
  633. signatureConfig.setOpcPackage(pkg);
  634. // adding the signature document to the package
  635. SignatureInfo si = new SignatureInfo();
  636. si.setSignatureConfig(signatureConfig);
  637. si.confirmSignature();
  638. // optionally verify the generated signature
  639. boolean b = si.verifySignature();
  640. assert (b);
  641. // write the changes back to disc
  642. pkg.close();
  643. </pre>
  644. <p><b>Implementation notes:</b></p>
  645. <p>Although there's a XML signature implementation in the Oracle JDKs 6 and higher,
  646. compatibility with IBM JDKs is also in focus (... but maybe not thoroughly tested ...).
  647. Therefore we are using the Apache Santuario libs (xmlsec) instead of the built-in classes,
  648. as the compatibility seems to be provided there.</p>
  649. <p>To use SignatureInfo and its sibling classes, you'll need to have the following libs
  650. in the classpath:</p>
  651. <ul>
  652. <li>BouncyCastle bcpkix and bcprov (tested against 1.51)</li>
  653. <li>Apache Santuario "xmlsec" (tested against 2.0.1)</li>
  654. <li>and slf4j-api (tested against 1.7.7)</li>
  655. </ul>
  656. </member>
  657. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.SignaturePart.GetPackagePart">
  658. @return the package part Containing the signature
  659. </member>
  660. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.SignaturePart.GetSigner">
  661. @return the signer certificate
  662. </member>
  663. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.SignaturePart.GetCertChain">
  664. @return the certificate chain of the signer
  665. </member>
  666. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.SignaturePart.Validate">
  667. @return true, when the xml signature is valid, false otherwise
  668. @throws EncryptedDocumentException if the signature can't be extracted or if its malformed
  669. </member>
  670. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.#ctor">
  671. Constructor Initializes xml signature environment, if it hasn't been Initialized before
  672. </member>
  673. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.GetSignatureConfig">
  674. @return the signature config
  675. </member>
  676. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.SetSignatureConfig(NPOI.POIFS.Crypt.Dsig.SignatureConfig)">
  677. @param signatureConfig the signature config, needs to be Set before a SignatureInfo object is used
  678. </member>
  679. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.VerifySignature">
  680. @return true, if first signature part is valid
  681. </member>
  682. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.ConfirmSignature">
  683. add the xml signature to the document
  684. @throws XMLSignatureException
  685. @throws MarshalException
  686. </member>
  687. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.signDigest(System.Byte[])">
  688. Sign (encrypt) the digest with the private key.
  689. Currently only rsa is supported.
  690. @param digest the hashed input
  691. @return the encrypted hash
  692. </member>
  693. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.GetSignatureParts">
  694. @return a signature part for each signature document.
  695. the parts can be validated independently.
  696. </member>
  697. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.InitXmlProvider">
  698. Initialize the xml signing environment and the bouncycastle provider
  699. </member>
  700. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.preSign(System.Xml.XmlDocument,System.Collections.Generic.List{NPOI.POIFS.Crypt.Dsig.DigestInfo})">
  701. Helper method for Adding informations before the signing.
  702. Normally {@link #ConfirmSignature()} is sufficient to be used.
  703. </member>
  704. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.postSign(System.Xml.XmlDocument,System.Byte[])">
  705. Helper method for Adding informations After the signing.
  706. Normally {@link #ConfirmSignature()} is sufficient to be used.
  707. </member>
  708. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.WriteDocument(System.Xml.XmlDocument)">
  709. Write XML signature into the OPC package
  710. @param document the xml signature document
  711. @throws MarshalException
  712. </member>
  713. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.safe``1(System.Collections.Generic.List{``0})">
  714. Helper method for null lists, which are Converted to empty lists
  715. @param other the reference to wrap, if null
  716. @return if other is null, an empty lists is returned, otherwise other is returned
  717. </member>
  718. <member name="T:NPOI.POIFS.Crypt.Dsig.SignatureMarshalListener">
  719. This listener class is used, to modify the to be digested xml document,
  720. e.g. to register id attributes or Set prefixes for registered namespaces
  721. </member>
  722. <!-- Badly formed XML comment ignored for member "F:NPOI.POIFS.Crypt.Dsig.SignatureMarshalListener.signatureConfig" -->
  723. <member name="T:NPOI.POIFS.Crypt.Dsig.TrustCertificateSecurityException">
  724. Exception thrown in case the incoming eID certificate is not trusted.
  725. @author Frank Cornelis
  726. </member>
  727. <member name="F:NPOI.POIXMLDocument.pkg">
  728. The OPC Package
  729. </member>
  730. <member name="F:NPOI.POIXMLDocument.properties">
  731. The properties of the OPC namespace, opened as needed
  732. </member>
  733. <member name="M:NPOI.POIXMLDocument.OpenPackage(System.String)">
  734. Wrapper to open a namespace, returning an IOException
  735. in the event of a problem.
  736. Works around shortcomings in java's this() constructor calls
  737. </member>
  738. <member name="M:NPOI.POIXMLDocument.GetRelatedByType(System.String)">
  739. Retrieves all the PackageParts which are defined as
  740. relationships of the base document with the
  741. specified content type.
  742. </member>
  743. <member name="M:NPOI.POIXMLDocument.HasOOXMLHeader(System.IO.Stream)">
  744. Checks that the supplied Stream (which MUST
  745. support mark and reSet, or be a PushbackStream)
  746. has a OOXML (zip) header at the start of it.
  747. If your Stream does not support mark / reSet,
  748. then wrap it in a PushBackStream, then be
  749. sure to always use that, and not the original!
  750. @param inp An Stream which supports either mark/reSet, or is a PushbackStream
  751. </member>
  752. <member name="M:NPOI.POIXMLDocument.GetProperties">
  753. Get the document properties. This gives you access to the
  754. core ooxml properties, and the extended ooxml properties.
  755. </member>
  756. <member name="M:NPOI.POIXMLDocument.GetAllEmbedds">
  757. Get the document's embedded files.
  758. </member>
  759. <member name="M:NPOI.POIXMLDocument.Close">
  760. Closes the underlying {@link OPCPackage} from which this
  761. document was read, if there is one
  762. </member>
  763. <member name="M:NPOI.POIXMLDocument.Write(System.IO.Stream)">
  764. Write out this document to an Outputstream.
  765. Note - if the Document was opened from a {@link File} rather
  766. than an {@link InputStream}, you <b>must</b> write out to
  767. a different file, overwriting via an OutputStream isn't possible.
  768. If {@code stream} is a {@link java.io.FileOutputStream} on a networked drive
  769. or has a high cost/latency associated with each written byte,
  770. consider wrapping the OutputStream in a {@link java.io.BufferedOutputStream}
  771. to improve write performance.
  772. @param stream - the java Stream you wish to write the file to
  773. @exception IOException if anything can't be written.
  774. </member>
  775. <member name="T:NPOI.POIXMLDocumentPart">
  776. Represents an entry of a OOXML namespace.
  777. <p>
  778. Each POIXMLDocumentPart keeps a reference to the underlying a {@link org.apache.poi.openxml4j.opc.PackagePart}.
  779. </p>
  780. @author Yegor Kozlov
  781. </member>
  782. <member name="T:NPOI.POIXMLDocumentPart.RelationPart">
  783. The RelationPart is a cached relationship between the document, which contains the RelationPart,
  784. and one of its referenced child document parts.
  785. The child document parts may only belong to one parent, but it's often referenced by other
  786. parents too, having varying {@link PackageRelationship#getId() relationship ids} pointing to it.
  787. </member>
  788. <member name="P:NPOI.POIXMLDocumentPart.RelationPart.Relationship">
  789. @return the cached relationship, which uniquely identifies this child document part within the parent
  790. </member>
  791. <member name="M:NPOI.POIXMLDocumentPart.RelationPart.GetDocumentPart``1">
  792. @return the child document part
  793. </member>
  794. <member name="F:NPOI.POIXMLDocumentPart.relationCounter">
  795. Counter that provides the amount of incoming relations from other parts
  796. to this part.
  797. </member>
  798. <member name="M:NPOI.POIXMLDocumentPart.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage)">
  799. Construct POIXMLDocumentPart representing a "core document" namespace part.
  800. </member>
  801. <member name="M:NPOI.POIXMLDocumentPart.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage,System.String)">
  802. Construct POIXMLDocumentPart representing a custom "core document" package part.
  803. </member>
  804. <member name="M:NPOI.POIXMLDocumentPart.#ctor">
  805. Creates new POIXMLDocumentPart - called by client code to create new parts from scratch.
  806. @see #CreateRelationship(POIXMLRelation, POIXMLFactory, int, bool)
  807. </member>
  808. <member name="M:NPOI.POIXMLDocumentPart.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  809. Creates an POIXMLDocumentPart representing the given package part and relationship.
  810. Called by {@link #read(POIXMLFactory, java.util.Map)} when reading in an existing file.
  811. @param part - The package part that holds xml data representing this sheet.
  812. @see #read(POIXMLFactory, java.util.Map)
  813. @since POI 3.14-Beta1
  814. </member>
  815. <member name="M:NPOI.POIXMLDocumentPart.#ctor(NPOI.POIXMLDocumentPart,NPOI.OpenXml4Net.OPC.PackagePart)">
  816. Creates an POIXMLDocumentPart representing the given package part, relationship and parent
  817. Called by {@link #read(POIXMLFactory, java.util.Map)} when reading in an existing file.
  818. @param parent - Parent part
  819. @param part - The package part that holds xml data representing this sheet.
  820. @see #read(POIXMLFactory, java.util.Map)
  821. @since POI 3.14-Beta1
  822. </member>
  823. <member name="M:NPOI.POIXMLDocumentPart.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  824. Creates an POIXMLDocumentPart representing the given namespace part and relationship.
  825. Called by {@link #read(POIXMLFactory, java.util.Map)} when Reading in an exisiting file.
  826. @param part - The namespace part that holds xml data represenring this sheet.
  827. @param rel - the relationship of the given namespace part
  828. @see #read(POIXMLFactory, java.util.Map)
  829. </member>
  830. <member name="M:NPOI.POIXMLDocumentPart.#ctor(NPOI.POIXMLDocumentPart,NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  831. Creates an POIXMLDocumentPart representing the given namespace part, relationship and parent
  832. Called by {@link #read(POIXMLFactory, java.util.Map)} when Reading in an exisiting file.
  833. @param parent - Parent part
  834. @param part - The namespace part that holds xml data represenring this sheet.
  835. @param rel - the relationship of the given namespace part
  836. @see #read(POIXMLFactory, java.util.Map)
  837. </member>
  838. <member name="M:NPOI.POIXMLDocumentPart.Rebase(NPOI.OpenXml4Net.OPC.OPCPackage)">
  839. When you open something like a theme, call this to
  840. re-base the XML Document onto the core child of the
  841. current core document
  842. </member>
  843. <member name="M:NPOI.POIXMLDocumentPart.GetPackagePart">
  844. Provides access to the underlying PackagePart
  845. @return the underlying PackagePart
  846. </member>
  847. <member name="M:NPOI.POIXMLDocumentPart.GetPackageRelationship">
  848. Provides access to the PackageRelationship that identifies this POIXMLDocumentPart
  849. @return the PackageRelationship that identifies this POIXMLDocumentPart
  850. </member>
  851. <member name="M:NPOI.POIXMLDocumentPart.GetRelations">
  852. Returns the list of child relations for this POIXMLDocumentPart
  853. @return child relations
  854. </member>
  855. <member name="P:NPOI.POIXMLDocumentPart.RelationParts">
  856. Returns the list of child relations for this POIXMLDocumentPart
  857. @return child relations
  858. </member>
  859. <member name="M:NPOI.POIXMLDocumentPart.GetRelationById(System.String)">
  860. Returns the target {@link POIXMLDocumentPart}, where a
  861. {@link PackageRelationship} is set from the {@link PackagePart} of this
  862. {@link POIXMLDocumentPart} to the {@link PackagePart} of the target
  863. {@link POIXMLDocumentPart} with a {@link PackageRelationship#GetId()}
  864. matching the given parameter value.
  865. @param id
  866. The relation id to look for
  867. @return the target part of the relation, or null, if none exists
  868. </member>
  869. <member name="M:NPOI.POIXMLDocumentPart.GetRelationId(NPOI.POIXMLDocumentPart)">
  870. Returns the {@link PackageRelationship#GetId()} of the
  871. {@link PackageRelationship}, that sources from the {@link PackagePart} of
  872. this {@link POIXMLDocumentPart} to the {@link PackagePart} of the given
  873. parameter value.
  874. @param part
  875. The {@link POIXMLDocumentPart} for which the according
  876. relation-id shall be found.
  877. @return The value of the {@link PackageRelationship#GetId()} or null, if
  878. parts are not related.
  879. </member>
  880. <member name="M:NPOI.POIXMLDocumentPart.AddRelation(System.String,NPOI.POIXMLDocumentPart)">
  881. Add a new child POIXMLDocumentPart
  882. @param part the child to add
  883. @deprecated in POI 3.14, scheduled for removal in POI 3.16
  884. </member>
  885. <member name="M:NPOI.POIXMLDocumentPart.AddRelation(System.String,NPOI.POIXMLRelation,NPOI.POIXMLDocumentPart)">
  886. Add a new child POIXMLDocumentPart
  887. @param relId the preferred relation id, when null the next free relation id will be used
  888. @param relationshipType the package relationship type
  889. @param part the child to add
  890. @since 3.14-Beta1
  891. </member>
  892. <member name="M:NPOI.POIXMLDocumentPart.AddRelation(NPOI.OpenXml4Net.OPC.PackageRelationship,NPOI.POIXMLDocumentPart)">
  893. Add a new child POIXMLDocumentPart
  894. @param pr the relationship of the child
  895. @param part the child to add
  896. </member>
  897. <member name="M:NPOI.POIXMLDocumentPart.FindExistingRelation(NPOI.POIXMLDocumentPart)">
  898. <summary>
  899. Check if the new part was already added before via PackagePart.addRelationship()
  900. </summary>
  901. <param name="part"> to find the relationship for</param>
  902. <returns>The existing relationship, or null if there isn't yet one</returns>
  903. </member>
  904. <member name="M:NPOI.POIXMLDocumentPart.RemoveRelation(NPOI.POIXMLDocumentPart)">
  905. Remove the relation to the specified part in this namespace and remove the
  906. part, if it is no longer needed.
  907. </member>
  908. <member name="M:NPOI.POIXMLDocumentPart.RemoveRelation(NPOI.POIXMLDocumentPart,System.Boolean)">
  909. Remove the relation to the specified part in this namespace and remove the
  910. part, if it is no longer needed and flag is set to true.
  911. @param part
  912. The related part, to which the relation shall be Removed.
  913. @param RemoveUnusedParts
  914. true, if the part shall be Removed from the namespace if not
  915. needed any longer.
  916. </member>
  917. <member name="M:NPOI.POIXMLDocumentPart.GetParent">
  918. Returns the parent POIXMLDocumentPart. All parts except root have not-null parent.
  919. @return the parent POIXMLDocumentPart or <code>null</code> for the root element.
  920. </member>
  921. <member name="M:NPOI.POIXMLDocumentPart.Commit">
  922. Save the content in the underlying namespace part.
  923. Default implementation is empty meaning that the namespace part is left unmodified.
  924. Sub-classes should override and add logic to marshal the "model" into Ooxml4J.
  925. For example, the code saving a generic XML entry may look as follows:
  926. <pre><code>
  927. protected void commit() {
  928. PackagePart part = GetPackagePart();
  929. Stream out = part.GetStream();
  930. XmlObject bean = GetXmlBean(); //the "model" which holds Changes in memory
  931. bean.save(out, DEFAULT_XML_OPTIONS);
  932. out.close();
  933. }
  934. </code></pre>
  935. </member>
  936. <member name="M:NPOI.POIXMLDocumentPart.OnSave(System.Collections.Generic.List{NPOI.OpenXml4Net.OPC.PackagePart})">
  937. Save Changes in the underlying OOXML namespace.
  938. Recursively fires {@link #commit()} for each namespace part
  939. @param alreadySaved context set Containing already visited nodes
  940. </member>
  941. <member name="M:NPOI.POIXMLDocumentPart.PrepareForCommit">
  942. Ensure that a memory based package part does not have lingering data from previous
  943. commit() calls.
  944. Note: This is overwritten for some objects, as *PictureData seem to store the actual content
  945. in the part directly without keeping a copy like all others therefore we need to handle them differently.
  946. </member>
  947. <member name="M:NPOI.POIXMLDocumentPart.CreateRelationship(NPOI.POIXMLRelation,NPOI.POIXMLFactory)">
  948. Create a new child POIXMLDocumentPart
  949. @param descriptor the part descriptor
  950. @param factory the factory that will create an instance of the requested relation
  951. @return the Created child POIXMLDocumentPart
  952. </member>
  953. <member name="M:NPOI.POIXMLDocumentPart.CreateRelationship(NPOI.POIXMLRelation,NPOI.POIXMLFactory,System.Int32,System.Boolean)">
  954. Create a new child POIXMLDocumentPart
  955. @param descriptor the part descriptor
  956. @param factory the factory that will create an instance of the requested relation
  957. @param idx part number
  958. @param noRelation if true, then no relationship is Added.
  959. @return the Created child POIXMLDocumentPart
  960. </member>
  961. <member name="M:NPOI.POIXMLDocumentPart.Read(NPOI.POIXMLFactory,System.Collections.Generic.Dictionary{NPOI.OpenXml4Net.OPC.PackagePart,NPOI.POIXMLDocumentPart})">
  962. Iterate through the underlying PackagePart and create child POIXMLFactory instances
  963. using the specified factory
  964. @param factory the factory object that Creates POIXMLFactory instances
  965. @param context context map Containing already visited noted keyed by tarGetURI
  966. </member>
  967. <member name="M:NPOI.POIXMLDocumentPart.GetTargetPart(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  968. Get the PackagePart that is the target of a relationship.
  969. @param rel The relationship
  970. @return The target part
  971. @throws InvalidFormatException
  972. </member>
  973. <member name="M:NPOI.POIXMLDocumentPart.OnDocumentCreate">
  974. Fired when a new namespace part is Created
  975. </member>
  976. <member name="M:NPOI.POIXMLDocumentPart.OnDocumentRead">
  977. Fired when a namespace part is read
  978. </member>
  979. <member name="M:NPOI.POIXMLDocumentPart.onDocumentRemove">
  980. Fired when a namespace part is about to be Removed from the namespace
  981. </member>
  982. <member name="M:NPOI.POIXMLDocumentPart.GetPartFromOPCPackage(NPOI.OpenXml4Net.OPC.OPCPackage,System.String)">
  983. Retrieves the core document part
  984. @since POI 3.14-Beta1
  985. </member>
  986. <member name="T:NPOI.POIXMLFactory">
  987. Defines a factory API that enables sub-classes to create instances of <code>POIXMLDocumentPart</code>
  988. @author Yegor Kozlov
  989. </member>
  990. <member name="M:NPOI.POIXMLFactory.CreateDocumentPart(NPOI.POIXMLDocumentPart,NPOI.OpenXml4Net.OPC.PackagePart)">
  991. Create a POIXMLDocumentPart from existing package part and relation. This method is called
  992. from {@link POIXMLDocument#load(POIXMLFactory)} when parsing a document
  993. @param parent parent part
  994. @param rel the package part relationship
  995. @param part the PackagePart representing the created instance
  996. @return A new instance of a POIXMLDocumentPart.
  997. @since by POI 3.14-Beta1
  998. </member>
  999. <member name="M:NPOI.POIXMLFactory.CreateDocumentPart(System.Type,System.Type[],System.Object[])">
  1000. Need to delegate instantiation to sub class because of constructor visibility
  1001. @since POI 3.14-Beta1
  1002. </member>
  1003. <member name="M:NPOI.POIXMLFactory.GetDescriptor(System.String)">
  1004. returns the descriptor for the given relationship type
  1005. @return the descriptor or null if type is unknown
  1006. @since POI 3.14-Beta1
  1007. </member>
  1008. <member name="M:NPOI.POIXMLFactory.CreateDocumentPart(NPOI.POIXMLDocumentPart,NPOI.OpenXml4Net.OPC.PackageRelationship,NPOI.OpenXml4Net.OPC.PackagePart)">
  1009. Create a POIXMLDocumentPart from existing package part and relation. This method is called
  1010. from {@link POIXMLDocument#load(POIXMLFactory)} when parsing a document
  1011. @param parent parent part
  1012. @param rel the package part relationship
  1013. @param part the PackagePart representing the created instance
  1014. @return A new instance of a POIXMLDocumentPart.
  1015. @deprecated in POI 3.14, scheduled for removal in POI 3.16
  1016. </member>
  1017. <member name="M:NPOI.POIXMLFactory.NewDocumentPart(NPOI.POIXMLRelation)">
  1018. Create a new POIXMLDocumentPart using the supplied descriptor. This method is used when adding new parts
  1019. to a document, for example, when adding a sheet to a workbook, slide to a presentation, etc.
  1020. @param descriptor describes the object to create
  1021. @return A new instance of a POIXMLDocumentPart.
  1022. </member>
  1023. <member name="M:NPOI.POIXMLFactory.GetPackageRelationship(NPOI.POIXMLDocumentPart,NPOI.OpenXml4Net.OPC.PackagePart)">
  1024. Retrieves the package relationship of the child part within the parent
  1025. @since POI 3.14-Beta1
  1026. </member>
  1027. <member name="T:NPOI.CoreProperties">
  1028. The core document properties
  1029. </member>
  1030. <member name="T:NPOI.ExtendedProperties">
  1031. Extended document properties
  1032. </member>
  1033. <member name="T:NPOI.CustomProperties">
  1034. Custom document properties
  1035. </member>
  1036. <member name="F:NPOI.CustomProperties.FORMAT_ID">
  1037. Each custom property element Contains an fmtid attribute
  1038. with the same GUID value ({D5CDD505-2E9C-101B-9397-08002B2CF9AE}).
  1039. </member>
  1040. <member name="M:NPOI.CustomProperties.Add(System.String)">
  1041. Add a new property
  1042. @param name the property name
  1043. @throws IllegalArgumentException if a property with this name already exists
  1044. </member>
  1045. <member name="M:NPOI.CustomProperties.AddProperty(System.String,System.String)">
  1046. Add a new string property
  1047. @throws IllegalArgumentException if a property with this name already exists
  1048. </member>
  1049. <member name="M:NPOI.CustomProperties.AddProperty(System.String,System.Double)">
  1050. Add a new double property
  1051. @throws IllegalArgumentException if a property with this name already exists
  1052. </member>
  1053. <member name="M:NPOI.CustomProperties.AddProperty(System.String,System.Int32)">
  1054. Add a new integer property
  1055. @throws IllegalArgumentException if a property with this name already exists
  1056. </member>
  1057. <member name="M:NPOI.CustomProperties.AddProperty(System.String,System.Boolean)">
  1058. Add a new bool property
  1059. @throws IllegalArgumentException if a property with this name already exists
  1060. </member>
  1061. <member name="M:NPOI.CustomProperties.NextPid">
  1062. Generate next id that uniquely relates a custom property
  1063. @return next property id starting with 2
  1064. </member>
  1065. <member name="M:NPOI.CustomProperties.Contains(System.String)">
  1066. Check if a property with this name already exists in the collection of custom properties
  1067. @param name the name to check
  1068. @return whether a property with the given name exists in the custom properties
  1069. </member>
  1070. <member name="M:NPOI.CustomProperties.GetProperty(System.String)">
  1071. Retrieve the custom property with this name, or null if none exists.
  1072. You will need to test the various isSetX methods to work out
  1073. what the type of the property is, before fetching the
  1074. appropriate value for it.
  1075. @param name the name of the property to fetch
  1076. </member>
  1077. <member name="T:NPOI.POIXMLProperties">
  1078. Wrapper around the three different kinds of OOXML properties
  1079. and metadata a document can have (Core, Extended and Custom),
  1080. as well Thumbnails.
  1081. </member>
  1082. <member name="P:NPOI.POIXMLProperties.CoreProperties">
  1083. Returns the core document properties
  1084. </member>
  1085. <member name="P:NPOI.POIXMLProperties.ExtendedProperties">
  1086. Returns the extended document properties
  1087. </member>
  1088. <member name="P:NPOI.POIXMLProperties.CustomProperties">
  1089. Returns the custom document properties
  1090. </member>
  1091. <member name="P:NPOI.POIXMLProperties.ThumbnailPart">
  1092. Returns the {@link PackagePart} for the Document
  1093. Thumbnail, or <code>null</code> if there isn't one
  1094. @return The Document Thumbnail part or null
  1095. </member>
  1096. <member name="P:NPOI.POIXMLProperties.ThumbnailFilename">
  1097. Returns the name of the Document thumbnail, eg
  1098. <code>thumbnail.jpeg</code>, or <code>null</code> if there
  1099. isn't one.
  1100. @return The thumbnail filename, or null
  1101. </member>
  1102. <member name="P:NPOI.POIXMLProperties.ThumbnailImage">
  1103. Returns the Document thumbnail image data, or
  1104. <code>null</code> if there isn't one.
  1105. @return The thumbnail data, or null
  1106. </member>
  1107. <member name="M:NPOI.POIXMLProperties.SetThumbnail(System.String,System.IO.Stream)">
  1108. Sets the Thumbnail for the document, replacing any existing
  1109. one.
  1110. @param name The filename for the thumbnail image, eg <code>thumbnail.jpg</code>
  1111. @param imageData The inputstream to read the thumbnail image from
  1112. </member>
  1113. <member name="M:NPOI.POIXMLProperties.Commit">
  1114. Commit Changes to the underlying OPC namespace
  1115. </member>
  1116. <member name="T:NPOI.POIXMLPropertiesTextExtractor">
  1117. A {@link POITextExtractor} for returning the textual
  1118. content of the OOXML file properties, eg author
  1119. and title.
  1120. </member>
  1121. <member name="M:NPOI.POIXMLPropertiesTextExtractor.#ctor(NPOI.POIXMLDocument)">
  1122. Creates a new POIXMLPropertiesTextExtractor for the
  1123. given open document.
  1124. </member>
  1125. <member name="M:NPOI.POIXMLPropertiesTextExtractor.#ctor(NPOI.POIXMLTextExtractor)">
  1126. Creates a new POIXMLPropertiesTextExtractor, for the
  1127. same file that another TextExtractor is already
  1128. working on.
  1129. </member>
  1130. <member name="M:NPOI.POIXMLPropertiesTextExtractor.GetCorePropertiesText">
  1131. Returns the core document properties, eg author
  1132. </member>
  1133. <member name="M:NPOI.POIXMLPropertiesTextExtractor.GetExtendedPropertiesText">
  1134. Returns the extended document properties, eg
  1135. application
  1136. </member>
  1137. <member name="M:NPOI.POIXMLPropertiesTextExtractor.GetCustomPropertiesText">
  1138. Returns the custom document properties, if
  1139. there are any
  1140. </member>
  1141. <member name="T:NPOI.POIXMLRelation">
  1142. Represents a descriptor of a OOXML relation.
  1143. @author Yegor Kozlov
  1144. </member>
  1145. <member name="F:NPOI.POIXMLRelation._type">
  1146. Describes the content stored in a part.
  1147. </member>
  1148. <member name="F:NPOI.POIXMLRelation._relation">
  1149. The kind of connection between a source part and a target part in a namespace.
  1150. </member>
  1151. <member name="F:NPOI.POIXMLRelation._defaultName">
  1152. The path component of a pack URI.
  1153. </member>
  1154. <member name="F:NPOI.POIXMLRelation._cls">
  1155. Defines what object is used to construct instances of this relationship
  1156. </member>
  1157. <member name="M:NPOI.POIXMLRelation.#ctor(System.String,System.String,System.String,System.Type)">
  1158. Instantiates a POIXMLRelation.
  1159. @param type content type
  1160. @param rel relationship
  1161. @param defaultName default item name
  1162. @param cls defines what object is used to construct instances of this relationship
  1163. </member>
  1164. <member name="M:NPOI.POIXMLRelation.#ctor(System.String,System.String,System.String)">
  1165. Instantiates a POIXMLRelation.
  1166. @param type content type
  1167. @param rel relationship
  1168. @param defaultName default item name
  1169. </member>
  1170. <member name="P:NPOI.POIXMLRelation.ContentType">
  1171. Return the content type. Content types define a media type, a subtype, and an
  1172. optional set of parameters, as defined in RFC 2616.
  1173. @return the content type
  1174. </member>
  1175. <member name="P:NPOI.POIXMLRelation.Relation">
  1176. Return the relationship, the kind of connection between a source part and a target part in a namespace.
  1177. Relationships make the connections between parts directly discoverable without looking at the content
  1178. in the parts, and without altering the parts themselves.
  1179. @return the relationship
  1180. </member>
  1181. <member name="P:NPOI.POIXMLRelation.DefaultFileName">
  1182. Return the default part name. Part names are used to refer to a part in the context of a
  1183. namespace, typically as part of a URI.
  1184. @return the default part name
  1185. </member>
  1186. <member name="M:NPOI.POIXMLRelation.GetFileName(System.Int32)">
  1187. Returns the filename for the nth one of these,
  1188. e.g. /xl/comments4.xml
  1189. </member>
  1190. <member name="M:NPOI.POIXMLRelation.GetFileNameIndex(NPOI.POIXMLDocumentPart)">
  1191. Returns the index of the filename within the package for the given part.
  1192. e.g. 4 for /xl/comments4.xml
  1193. </member>
  1194. <member name="P:NPOI.POIXMLRelation.RelationClass">
  1195. Return type of the obejct used to construct instances of this relationship
  1196. @return the class of the object used to construct instances of this relation
  1197. </member>
  1198. <member name="F:NPOI.POIXMLTextExtractor._document">
  1199. The POIXMLDocument that's open
  1200. </member>
  1201. <member name="M:NPOI.POIXMLTextExtractor.#ctor(NPOI.POIXMLDocument)">
  1202. Creates a new text extractor for the given document
  1203. </member>
  1204. <member name="M:NPOI.POIXMLTextExtractor.GetCoreProperties">
  1205. Returns the core document properties
  1206. </member>
  1207. <member name="M:NPOI.POIXMLTextExtractor.GetExtendedProperties">
  1208. Returns the extended document properties
  1209. </member>
  1210. <member name="M:NPOI.POIXMLTextExtractor.GetCustomProperties">
  1211. Returns the custom document properties
  1212. </member>
  1213. <member name="P:NPOI.POIXMLTextExtractor.Document">
  1214. Returns opened document
  1215. </member>
  1216. <member name="P:NPOI.POIXMLTextExtractor.Package">
  1217. Returns the opened OPCPackage that Contains the document
  1218. </member>
  1219. <member name="P:NPOI.POIXMLTextExtractor.MetadataTextExtractor">
  1220. Returns an OOXML properties text extractor for the
  1221. document properties metadata, such as title and author.
  1222. </member>
  1223. <member name="P:NPOI.SS.Converter.ExcelToHtmlConverter.OutputColumnHeaders">
  1224. <summary>
  1225. 是否输出列头
  1226. </summary>
  1227. </member>
  1228. <member name="P:NPOI.SS.Converter.ExcelToHtmlConverter.OutputHiddenColumns">
  1229. <summary>
  1230. 是否输出隐藏的列
  1231. </summary>
  1232. </member>
  1233. <member name="P:NPOI.SS.Converter.ExcelToHtmlConverter.OutputHiddenRows">
  1234. <summary>
  1235. 是否输出隐藏的行
  1236. </summary>
  1237. </member>
  1238. <member name="P:NPOI.SS.Converter.ExcelToHtmlConverter.OutputLeadingSpacesAsNonBreaking">
  1239. <summary>
  1240. 是否输出文本前的空格
  1241. </summary>
  1242. </member>
  1243. <member name="P:NPOI.SS.Converter.ExcelToHtmlConverter.OutputRowNumbers">
  1244. <summary>
  1245. 是否输出行号
  1246. </summary>
  1247. </member>
  1248. <member name="P:NPOI.SS.Converter.ExcelToHtmlConverter.UseDivsToSpan">
  1249. <summary>
  1250. 在跨列的单元格使用DIV标记
  1251. </summary>
  1252. </member>
  1253. <member name="M:NPOI.SS.Converter.ExcelToHtmlConverter.ProcessRow(NPOI.SS.Util.CellRangeAddress[][],NPOI.SS.UserModel.IRow,System.Xml.XmlElement)">
  1254. @return maximum 1-base index of column that were rendered, zero if none
  1255. </member>
  1256. <member name="M:NPOI.SS.Converter.ExcelToHtmlConverter.ProcessColumnWidths(NPOI.SS.UserModel.ISheet,System.Int32,System.Xml.XmlElement)">
  1257. Creates COLGROUP element with width specified for all columns. (Except
  1258. first if <tt>{@link #isOutputRowNumbers()}==true</tt>)
  1259. </member>
  1260. <member name="M:NPOI.SS.Converter.ExcelToHtmlUtils.BuildMergedRangesMap(NPOI.SS.UserModel.ISheet)">
  1261. Creates a map (i.e. two-dimensional array) filled with ranges. Allow fast
  1262. retrieving {@link CellRangeAddress} of any cell, if cell is contained in
  1263. range.
  1264. @see #getMergedRange(CellRangeAddress[][], int, int)
  1265. </member>
  1266. <member name="M:NPOI.SS.Converter.ExcelToHtmlUtils.GetColumnWidthInPx(System.Int32)">
  1267. See <a href=
  1268. "http://apache-poi.1045710.n5.nabble.com/Excel-Column-Width-Unit-Converter-pixels-excel-column-width-units-td2301481.html"
  1269. >here</a> for Xio explanation and details
  1270. </member>
  1271. <member name="M:NPOI.SS.Converter.ExcelToHtmlUtils.GetMergedRange(NPOI.SS.Util.CellRangeAddress[][],System.Int32,System.Int32)">
  1272. @param mergedRanges
  1273. map of sheet merged ranges built with
  1274. {@link #buildMergedRangesMap(HSSFSheet)}
  1275. @return {@link CellRangeAddress} from map if cell with specified row and
  1276. column numbers contained in found range, <tt>null</tt> otherwise
  1277. </member>
  1278. <member name="F:NPOI.SS.UserModel.ImportOption.SheetContentOnly">
  1279. <summary>
  1280. Only Text and Formulas are imported. Pictures, Drawing, Styles etc. are all ignored.
  1281. </summary>
  1282. </member>
  1283. <member name="F:NPOI.SS.UserModel.ImportOption.TextOnly">
  1284. <summary>
  1285. Only Text, Comments and Formulas are imported. Pictures, Drawing, Styles etc. are all ignored.
  1286. </summary>
  1287. </member>
  1288. <member name="F:NPOI.SS.UserModel.ImportOption.All">
  1289. <summary>
  1290. Everything is imported - this is the same as NONE.
  1291. </summary>
  1292. </member>
  1293. <member name="T:NPOI.SS.UserModel.WorkbookFactory">
  1294. <summary>
  1295. Factory for creating the appropriate kind of Workbook
  1296. (be it HSSFWorkbook or XSSFWorkbook), from the given input
  1297. </summary>
  1298. </member>
  1299. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  1300. <summary>
  1301. Creates an HSSFWorkbook from the given POIFSFileSystem
  1302. </summary>
  1303. </member>
  1304. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(NPOI.POIFS.FileSystem.NPOIFSFileSystem)">
  1305. Creates an HSSFWorkbook from the given NPOIFSFileSystem
  1306. </member>
  1307. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(NPOI.POIFS.FileSystem.NPOIFSFileSystem,System.String)">
  1308. Creates a Workbook from the given NPOIFSFileSystem, which may
  1309. be password protected
  1310. </member>
  1311. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(NPOI.OpenXml4Net.OPC.OPCPackage)">
  1312. <summary>
  1313. Creates an XSSFWorkbook from the given OOXML Package
  1314. </summary>
  1315. </member>
  1316. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(System.IO.Stream,System.Boolean)">
  1317. <summary>
  1318. Creates the appropriate HSSFWorkbook / XSSFWorkbook from
  1319. the given InputStream. The Stream is wraped inside a PushbackInputStream.
  1320. </summary>
  1321. <param name="inputStream">Input Stream of .xls or .xlsx file</param>
  1322. <param name="password"></param>
  1323. <returns>IWorkbook depending on the input HSSFWorkbook or XSSFWorkbook is returned.</returns>
  1324. </member>
  1325. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(System.String,System.String,System.Boolean)">
  1326. <summary>
  1327. Creates the appropriate HSSFWorkbook / XSSFWorkbook from
  1328. the given File, which must exist and be readable.
  1329. </summary>
  1330. <param name="file"></param>
  1331. <param name="password"></param>
  1332. <param name="readOnly"></param>
  1333. <returns></returns>
  1334. <remarks>
  1335. Note that for Workbooks opened this way, it is not possible
  1336. to explicitly close the underlying File resource.
  1337. </remarks>
  1338. </member>
  1339. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(System.IO.Stream,NPOI.SS.UserModel.ImportOption)">
  1340. <summary>
  1341. Creates the appropriate HSSFWorkbook / XSSFWorkbook from
  1342. the given InputStream. The Stream is wraped inside a PushbackInputStream.
  1343. </summary>
  1344. <param name="inputStream">Input Stream of .xls or .xlsx file</param>
  1345. <param name="importOption">Customize the elements that are processed on the next import</param>
  1346. <returns>IWorkbook depending on the input HSSFWorkbook or XSSFWorkbook is returned.</returns>
  1347. </member>
  1348. <member name="M:NPOI.SS.UserModel.WorkbookFactory.CreateFormulaEvaluator(NPOI.SS.UserModel.IWorkbook)">
  1349. <summary>
  1350. Creates a specific FormulaEvaluator for the given workbook.
  1351. </summary>
  1352. </member>
  1353. <member name="M:NPOI.SS.UserModel.WorkbookFactory.SetImportOption(NPOI.SS.UserModel.ImportOption)">
  1354. <summary>
  1355. Sets the import option when opening the next workbook.
  1356. Works only for XSSF. For HSSF workbooks this option is ignored.
  1357. </summary>
  1358. <param name="importOption">Customize the elements that are processed on the next import</param>
  1359. </member>
  1360. <member name="T:NPOI.Util.IdentifierManager">
  1361. <summary>
  1362. 24.08.2009 @author Stefan Stern
  1363. </summary>
  1364. </member>
  1365. <member name="F:NPOI.Util.IdentifierManager.upperbound">
  1366. </member>
  1367. <member name="F:NPOI.Util.IdentifierManager.lowerbound">
  1368. </member>
  1369. <member name="F:NPOI.Util.IdentifierManager.segments">
  1370. List of segments of available identifiers
  1371. </member>
  1372. <member name="M:NPOI.Util.IdentifierManager.#ctor(System.Int64,System.Int64)">
  1373. @param lowerbound the lower limit of the id-range to manage. Must be greater than or equal to {@link #MIN_ID}.
  1374. @param upperbound the upper limit of the id-range to manage. Must be less then or equal {@link #MAX_ID}.
  1375. </member>
  1376. <member name="M:NPOI.Util.IdentifierManager.ReserveNew">
  1377. @return a new identifier.
  1378. @throws InvalidOperationException if no more identifiers are available, then an Exception is raised.
  1379. </member>
  1380. <member name="M:NPOI.Util.IdentifierManager.Release(System.Int64)">
  1381. @param id
  1382. the identifier to release. Must be greater than or equal to
  1383. {@link #lowerbound} and must be less than or equal to {@link #upperbound}
  1384. @return true, if the identifier was reserved and has been successfully
  1385. released, false, if the identifier was not reserved.
  1386. </member>
  1387. <member name="M:NPOI.Util.IdentifierManager.VerifyIdentifiersLeft">
  1388. </member>
  1389. <member name="T:NPOI.Util.PackageHelper">
  1390. Provides handy methods to work with OOXML namespaces
  1391. @author Yegor Kozlov
  1392. </member>
  1393. <member name="M:NPOI.Util.PackageHelper.Clone(NPOI.OpenXml4Net.OPC.OPCPackage,System.String)">
  1394. Clone the specified namespace.
  1395. @param pkg the namespace to clone
  1396. @param file the destination file
  1397. @return the Cloned namespace
  1398. </member>
  1399. <member name="M:NPOI.Util.PackageHelper.CreateTempFile">
  1400. Creates an empty file in the default temporary-file directory,
  1401. </member>
  1402. <member name="M:NPOI.Util.PackageHelper.Copy(NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePart)">
  1403. Recursively copy namespace parts to the destination namespace
  1404. </member>
  1405. <member name="M:NPOI.Util.PackageHelper.CopyProperties(NPOI.OpenXml4Net.OPC.PackageProperties,NPOI.OpenXml4Net.OPC.PackageProperties)">
  1406. Copy core namespace properties
  1407. @param src source properties
  1408. @param tgt target properties
  1409. </member>
  1410. <member name="T:NPOI.XSSF.Extractor.XSSFExcelExtractor">
  1411. Helper class to extract text from an OOXML Excel file
  1412. </member>
  1413. <member name="P:NPOI.XSSF.Extractor.XSSFExcelExtractor.IncludeHeaderFooter">
  1414. <summary>
  1415. Should header and footer be included? Default is true
  1416. </summary>
  1417. </member>
  1418. <member name="P:NPOI.XSSF.Extractor.XSSFExcelExtractor.IncludeSheetNames">
  1419. <summary>
  1420. Should sheet names be included? Default is true
  1421. </summary>
  1422. <value>if set to <c>true</c> [include sheet names].</value>
  1423. </member>
  1424. <member name="P:NPOI.XSSF.Extractor.XSSFExcelExtractor.FormulasNotResults">
  1425. <summary>
  1426. Should we return the formula itself, and not
  1427. the result it produces? Default is false
  1428. </summary>
  1429. <value>if set to <c>true</c> [formulas not results].</value>
  1430. </member>
  1431. <member name="P:NPOI.XSSF.Extractor.XSSFExcelExtractor.IncludeCellComments">
  1432. <summary>
  1433. Should cell comments be included? Default is false
  1434. </summary>
  1435. <value>if set to <c>true</c> [include cell comments].</value>
  1436. </member>
  1437. <member name="M:NPOI.XSSF.Extractor.XSSFExcelExtractor.SetIncludeSheetNames(System.Boolean)">
  1438. Should sheet names be included? Default is true
  1439. </member>
  1440. <member name="M:NPOI.XSSF.Extractor.XSSFExcelExtractor.SetFormulasNotResults(System.Boolean)">
  1441. Should we return the formula itself, and not
  1442. the result it produces? Default is false
  1443. </member>
  1444. <member name="M:NPOI.XSSF.Extractor.XSSFExcelExtractor.SetIncludeCellComments(System.Boolean)">
  1445. Should cell comments be included? Default is false
  1446. </member>
  1447. <member name="M:NPOI.XSSF.Extractor.XSSFExcelExtractor.SetIncludeHeadersFooters(System.Boolean)">
  1448. Should headers and footers be included? Default is true
  1449. </member>
  1450. <member name="M:NPOI.XSSF.Extractor.XSSFExcelExtractor.SetIncludeTextBoxes(System.Boolean)">
  1451. Should text within textboxes be included? Default is true
  1452. @param includeTextBoxes
  1453. </member>
  1454. <member name="P:NPOI.XSSF.Extractor.XSSFExcelExtractor.Text">
  1455. Retreives the text contents of the file
  1456. </member>
  1457. <member name="T:NPOI.XSSF.Extractor.XSSFExportToXml">
  1458. Maps an XLSX to an XML according to one of the mapping defined.
  1459. The output XML Schema must respect this limitations:
  1460. <ul>
  1461. <li> all mandatory elements and attributes must be mapped (enable validation to check this)</li>
  1462. <li> no &lt;any&gt; in complex type/element declaration </li>
  1463. <li> no &lt;anyAttribute&gt; attributes declaration </li>
  1464. <li> no recursive structures: recursive structures can't be nested more than one level </li>
  1465. <li> no abstract elements: abstract complex types can be declared but must not be used in elements. </li>
  1466. <li> no mixed content: an element can't contain simple text and child element(s) together </li>
  1467. <li> no &lt;substitutionGroup&gt; in complex type/element declaration </li>
  1468. </ul>
  1469. </member>
  1470. <member name="M:NPOI.XSSF.Extractor.XSSFExportToXml.#ctor(NPOI.XSSF.UserModel.XSSFMap)">
  1471. Creates a new exporter and Sets the mapping to be used when generating the XML output document
  1472. @param map the mapping rule to be used
  1473. </member>
  1474. <member name="M:NPOI.XSSF.Extractor.XSSFExportToXml.ExportToXML(System.IO.Stream,System.Boolean)">
  1475. Exports the data in an XML stream
  1476. @param os OutputStream in which will contain the output XML
  1477. @param validate if true, validates the XML againts the XML Schema
  1478. @throws SAXException
  1479. @throws TransformerException
  1480. @throws ParserConfigurationException
  1481. </member>
  1482. <member name="M:NPOI.XSSF.Extractor.XSSFExportToXml.ExportToXML(System.IO.Stream,System.String,System.Boolean)">
  1483. Exports the data in an XML stream
  1484. @param os OutputStream in which will contain the output XML
  1485. @param encoding the output charset encoding
  1486. @param validate if true, validates the XML againts the XML Schema
  1487. @throws SAXException
  1488. @throws ParserConfigurationException
  1489. @throws TransformerException
  1490. @throws InvalidFormatException
  1491. </member>
  1492. <member name="M:NPOI.XSSF.Extractor.XSSFExportToXml.IsValid(System.Xml.XmlDocument)">
  1493. Validate the generated XML against the XML Schema associated with the XSSFMap
  1494. @param xml the XML to validate
  1495. @return
  1496. </member>
  1497. <member name="M:NPOI.XSSF.Extractor.XSSFExportToXml.Compare(System.String,System.String)">
  1498. Compares two xpaths to define an ordering according to the XML Schema
  1499. </member>
  1500. <member name="T:NPOI.XSSF.Model.CalculationChain">
  1501. The cells in a workbook can be calculated in different orders depending on various optimizations and
  1502. dependencies. The calculation chain object specifies the order in which the cells in a workbook were last calculated.
  1503. @author Yegor Kozlov
  1504. </member>
  1505. <member name="M:NPOI.XSSF.Model.CalculationChain.RemoveItem(System.Int32,System.String)">
  1506. Remove a formula reference from the calculation chain
  1507. @param sheetId the sheet Id of a sheet the formula belongs to.
  1508. @param ref A1 style reference to the cell Containing the formula.
  1509. </member>
  1510. <member name="F:NPOI.XSSF.Model.CommentsTable.commentRefs">
  1511. XML Beans uses a list, which is very slow
  1512. to search, so we wrap things with our own
  1513. map for fast Lookup.
  1514. </member>
  1515. <member name="M:NPOI.XSSF.Model.CommentsTable.ReferenceUpdated(System.String,NPOI.OpenXmlFormats.Spreadsheet.CT_Comment)">
  1516. Called after the reference is updated, so that
  1517. we can reflect that in our cache
  1518. </member>
  1519. <member name="M:NPOI.XSSF.Model.CommentsTable.ReferenceUpdated(NPOI.SS.Util.CellAddress,NPOI.OpenXmlFormats.Spreadsheet.CT_Comment)">
  1520. Called after the reference is updated, so that
  1521. we can reflect that in our cache
  1522. @param oldReference the comment to remove from the commentRefs map
  1523. @param comment the comment to replace in the commentRefs map
  1524. </member>
  1525. <member name="M:NPOI.XSSF.Model.CommentsTable.FindAuthor(System.String)">
  1526. <summary>
  1527. Searches the author. If not found he is added to the list of authors.
  1528. </summary>
  1529. <param name="author">author to search</param>
  1530. <returns>index of the author</returns>
  1531. </member>
  1532. <member name="M:NPOI.XSSF.Model.CommentsTable.FindCellComment(System.String)">
  1533. Finds the cell comment at cellAddress, if one exists
  1534. @param cellAddress the address of the cell to find a comment
  1535. @return cell comment if one exists, otherwise returns null
  1536. @
  1537. </member>
  1538. <member name="M:NPOI.XSSF.Model.CommentsTable.FindCellComment(NPOI.SS.Util.CellAddress)">
  1539. Finds the cell comment at cellAddress, if one exists
  1540. @param cellAddress the address of the cell to find a comment
  1541. @return cell comment if one exists, otherwise returns null
  1542. </member>
  1543. <member name="M:NPOI.XSSF.Model.CommentsTable.GetCTComment(System.String)">
  1544. Get the underlying CTComment xmlbean for a comment located at cellRef, if it exists
  1545. @param cellRef the location of the cell comment
  1546. @return CTComment xmlbean if comment exists, otherwise return null.
  1547. @
  1548. </member>
  1549. <member name="M:NPOI.XSSF.Model.CommentsTable.GetCTComment(NPOI.SS.Util.CellAddress)">
  1550. Get the underlying CTComment xmlbean for a comment located at cellRef, if it exists
  1551. @param cellRef the location of the cell comment
  1552. @return CTComment xmlbean if comment exists, otherwise return null.
  1553. </member>
  1554. <member name="M:NPOI.XSSF.Model.CommentsTable.GetCellComments">
  1555. Returns all cell comments on this sheet.
  1556. @return A map of each Comment in this sheet, keyed on the cell address where
  1557. the comment is located.
  1558. </member>
  1559. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.Model.CommentsTable.PrepareCTCommentCache" -->
  1560. <member name="M:NPOI.XSSF.Model.CommentsTable.NewComment(System.String)">
  1561. Create a new comment located at cell address
  1562. @param ref the location to add the comment
  1563. @return a new CTComment located at ref with default author
  1564. </member>
  1565. <member name="M:NPOI.XSSF.Model.CommentsTable.NewComment(NPOI.SS.Util.CellAddress)">
  1566. Create a new comment located` at cell address
  1567. @param ref the location to add the comment
  1568. @return a new CTComment located at ref with default author
  1569. </member>
  1570. <member name="M:NPOI.XSSF.Model.CommentsTable.RemoveComment(System.String)">
  1571. Remove the comment at cellRef location, if one exists
  1572. @param cellRef the location of the comment to remove
  1573. @return returns true if a comment was removed
  1574. @deprecated 2015-11-23 (circa POI 3.14beta1). Use {@link #removeComment(CellAddress)} instead
  1575. </member>
  1576. <member name="M:NPOI.XSSF.Model.CommentsTable.RemoveComment(NPOI.SS.Util.CellAddress)">
  1577. Remove the comment at cellRef location, if one exists
  1578. @param cellRef the location of the comment to remove
  1579. @return returns true if a comment was removed
  1580. </member>
  1581. <member name="M:NPOI.XSSF.Model.CommentsTable.AddNewAuthor(System.String)">
  1582. Add a new author to the CommentsTable.
  1583. This does not check if the author already exists.
  1584. @param author the name of the comment author
  1585. @return the index of the new author
  1586. </member>
  1587. <member name="M:NPOI.XSSF.Model.CommentsTable.GetCTComments">
  1588. Returns the underlying CTComments list xmlbean
  1589. @return underlying comments list xmlbean
  1590. </member>
  1591. <member name="T:NPOI.XSSF.Model.ExternalLinksTable">
  1592. Holds details of links to parts of other workbooks (eg named ranges),
  1593. along with the most recently seen values for what they point to.
  1594. </member>
  1595. <member name="P:NPOI.XSSF.Model.ExternalLinksTable.CTExternalLink">
  1596. Returns the underlying xmlbeans object for the external
  1597. link table
  1598. </member>
  1599. <member name="P:NPOI.XSSF.Model.ExternalLinksTable.LinkedFileName">
  1600. get or set the last recorded name of the file that this
  1601. is linked to
  1602. </member>
  1603. <member name="T:NPOI.XSSF.Model.MapInfo">
  1604. This class : the Custom XML Mapping Part (Open Office XML Part 1:
  1605. chapter 12.3.6)
  1606. An instance of this part type Contains a schema for an XML file, and
  1607. information on the behavior that is used when allowing this custom XML schema
  1608. to be mapped into the spreadsheet.
  1609. @author Roberto Manicardi
  1610. </member>
  1611. <member name="P:NPOI.XSSF.Model.MapInfo.Workbook">
  1612. Returns the parent XSSFWorkbook
  1613. @return the parent XSSFWorkbook
  1614. </member>
  1615. <member name="M:NPOI.XSSF.Model.MapInfo.GetCTMapInfo">
  1616. @return the internal data object
  1617. </member>
  1618. <member name="M:NPOI.XSSF.Model.MapInfo.GetCTSchemaById(System.String)">
  1619. Gets the
  1620. @param schemaId the schema ID
  1621. @return CTSchema by it's ID
  1622. </member>
  1623. <member name="M:NPOI.XSSF.Model.MapInfo.GetAllXSSFMaps">
  1624. @return all the mappings configured in this document
  1625. </member>
  1626. <member name="T:NPOI.XSSF.Model.ParagraphPropertyFetcher">
  1627. Used internally to navigate the paragraph text style hierarchy within a shape and fetch properties
  1628. </member>
  1629. <member name="M:NPOI.XSSF.Model.ParagraphPropertyFetcher`1.Fetch(NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Shape)">
  1630. @param shape the shape being examined
  1631. @return true if the desired property was fetched
  1632. </member>
  1633. <member name="T:NPOI.XSSF.Model.SharedStringsTable">
  1634. Table of strings shared across all sheets in a workbook.
  1635. <p>
  1636. A workbook may contain thousands of cells Containing string (non-numeric) data. Furthermore this data is very
  1637. likely to be repeated across many rows or columns. The goal of implementing a single string table that is shared
  1638. across the workbook is to improve performance in opening and saving the file by only Reading and writing the
  1639. repetitive information once.
  1640. </p>
  1641. <p>
  1642. Consider for example a workbook summarizing information for cities within various countries. There may be a
  1643. column for the name of the country, a column for the name of each city in that country, and a column
  1644. Containing the data for each city. In this case the country name is repetitive, being duplicated in many cells.
  1645. In many cases the repetition is extensive, and a tremendous savings is realized by making use of a shared string
  1646. table when saving the workbook. When displaying text in the spreadsheet, the cell table will just contain an
  1647. index into the string table as the value of a cell, instead of the full string.
  1648. </p>
  1649. <p>
  1650. The shared string table Contains all the necessary information for displaying the string: the text, formatting
  1651. properties, and phonetic properties (for East Asian languages).
  1652. </p>
  1653. @author Nick Birch
  1654. @author Yegor Kozlov
  1655. </member>
  1656. <member name="F:NPOI.XSSF.Model.SharedStringsTable.strings">
  1657. Array of individual string items in the Shared String table.
  1658. </member>
  1659. <member name="F:NPOI.XSSF.Model.SharedStringsTable.stmap">
  1660. Maps strings and their indexes in the <code>strings</code> arrays
  1661. </member>
  1662. <member name="F:NPOI.XSSF.Model.SharedStringsTable.count">
  1663. An integer representing the total count of strings in the workbook. This count does not
  1664. include any numbers, it counts only the total of text strings in the workbook.
  1665. </member>
  1666. <member name="F:NPOI.XSSF.Model.SharedStringsTable.uniqueCount">
  1667. An integer representing the total count of unique strings in the Shared String Table.
  1668. A string is unique even if it is a copy of another string, but has different formatting applied
  1669. at the character level.
  1670. </member>
  1671. <member name="M:NPOI.XSSF.Model.SharedStringsTable.GetEntryAt(System.Int32)">
  1672. Return a string item by index
  1673. @param idx index of item to return.
  1674. @return the item at the specified position in this Shared String table.
  1675. </member>
  1676. <member name="P:NPOI.XSSF.Model.SharedStringsTable.Count">
  1677. Return an integer representing the total count of strings in the workbook. This count does not
  1678. include any numbers, it counts only the total of text strings in the workbook.
  1679. @return the total count of strings in the workbook
  1680. </member>
  1681. <member name="P:NPOI.XSSF.Model.SharedStringsTable.UniqueCount">
  1682. Returns an integer representing the total count of unique strings in the Shared String Table.
  1683. A string is unique even if it is a copy of another string, but has different formatting applied
  1684. at the character level.
  1685. @return the total count of unique strings in the workbook
  1686. </member>
  1687. <member name="M:NPOI.XSSF.Model.SharedStringsTable.AddEntry(NPOI.OpenXmlFormats.Spreadsheet.CT_Rst)">
  1688. Add an entry to this Shared String table (a new value is appened to the end).
  1689. <p>
  1690. If the Shared String table already Contains this <code>CT_Rst</code> bean, its index is returned.
  1691. Otherwise a new entry is aded.
  1692. </p>
  1693. @param st the entry to add
  1694. @return index the index of Added entry
  1695. </member>
  1696. <member name="P:NPOI.XSSF.Model.SharedStringsTable.Items">
  1697. Provide low-level access to the underlying array of CT_Rst beans
  1698. @return array of CT_Rst beans
  1699. </member>
  1700. <member name="M:NPOI.XSSF.Model.SharedStringsTable.WriteTo(System.IO.Stream)">
  1701. this table out as XML.
  1702. @param out The stream to write to.
  1703. @throws IOException if an error occurs while writing.
  1704. </member>
  1705. <member name="T:NPOI.XSSF.Model.SingleXmlCells">
  1706. This class : the Single Cell Tables Part (Open Office XML Part 4:
  1707. chapter 3.5.2)
  1708. @author Roberto Manicardi
  1709. </member>
  1710. <member name="M:NPOI.XSSF.Model.SingleXmlCells.GetAllSimpleXmlCell">
  1711. @return all the SimpleXmlCell Contained in this SingleXmlCells element
  1712. </member>
  1713. <member name="T:NPOI.XSSF.Model.StylesTable">
  1714. Table of styles shared across all sheets in a workbook.
  1715. @author ugo
  1716. </member>
  1717. <member name="F:NPOI.XSSF.Model.StylesTable.FIRST_CUSTOM_STYLE_ID">
  1718. The first style id available for use as a custom style
  1719. </member>
  1720. <member name="F:NPOI.XSSF.Model.StylesTable.MAXIMUM_NUMBER_OF_DATA_FORMATS">
  1721. Depending on the version of Excel, the maximum number of number formats in a workbook is between 200 and 250
  1722. See https://support.office.com/en-us/article/excel-specifications-and-limits-1672b34d-7043-467e-8e27-269d656771c3
  1723. POI defaults this limit to 250, but can be increased or decreased on a per-StylesTable basis with
  1724. {@link #setMaxNumberOfDataFormats(int)} if needed.
  1725. </member>
  1726. <member name="P:NPOI.XSSF.Model.StylesTable.MaxNumberOfDataFormats">
  1727. Get the upper limit on the number of data formats that has been set for the style table.
  1728. To get the current number of data formats in use, use {@link #getNumDataFormats()}.
  1729. @return the maximum number of data formats allowed in the workbook
  1730. </member>
  1731. <member name="M:NPOI.XSSF.Model.StylesTable.#ctor">
  1732. Create a new, empty StylesTable
  1733. </member>
  1734. <member name="M:NPOI.XSSF.Model.StylesTable.EnsureThemesTable">
  1735. If there isn't currently a {@link ThemesTable} for the
  1736. current Workbook, then creates one and sets it up.
  1737. After this, calls to {@link #getTheme()} won't give null
  1738. </member>
  1739. <member name="M:NPOI.XSSF.Model.StylesTable.ReadFrom(System.Xml.XmlDocument)">
  1740. Read this shared styles table from an XML file.
  1741. @param is The input stream Containing the XML document.
  1742. @throws IOException if an error occurs while Reading.
  1743. </member>
  1744. <member name="M:NPOI.XSSF.Model.StylesTable.GetNumberFormatAt(System.Int32)">
  1745. Get number format string given its id
  1746. @param idx number format id
  1747. @return number format code
  1748. </member>
  1749. <member name="M:NPOI.XSSF.Model.StylesTable.GetNumberFormatAt(System.Int16)">
  1750. Get number format string given its id
  1751. @param fmtId number format id
  1752. @return number format code
  1753. </member>
  1754. <member name="M:NPOI.XSSF.Model.StylesTable.PutNumberFormat(System.String)">
  1755. Puts <code>fmt</code> in the numberFormats map if the format is not
  1756. already in the the number format style table.
  1757. Does nothing if <code>fmt</code> is already in number format style table.
  1758. @param fmt the number format to add to number format style table
  1759. @return the index of <code>fmt</code> in the number format style table
  1760. </member>
  1761. <member name="M:NPOI.XSSF.Model.StylesTable.PutNumberFormat(System.Int16,System.String)">
  1762. Add a number format with a specific ID into the numberFormats map.
  1763. If a format with the same ID already exists, overwrite the format code
  1764. with <code>fmt</code>
  1765. This may be used to override built-in number formats.
  1766. @param index the number format ID
  1767. @param fmt the number format code
  1768. </member>
  1769. <member name="M:NPOI.XSSF.Model.StylesTable.RemoveNumberFormat(System.Int16)">
  1770. Remove a number format from the style table if it exists.
  1771. All cell styles with this number format will be modified to use the default number format.
  1772. @param fmt the number format to remove
  1773. @return true if the number format was removed
  1774. </member>
  1775. <member name="M:NPOI.XSSF.Model.StylesTable.RemoveNumberFormat(System.String)">
  1776. Remove a number format from the style table if it exists
  1777. All cell styles with this number format will be modified to use the default number format
  1778. @param fmt the number format to remove
  1779. @return true if the number format was removed
  1780. </member>
  1781. <member name="M:NPOI.XSSF.Model.StylesTable.PutFont(NPOI.XSSF.UserModel.XSSFFont,System.Boolean)">
  1782. Records the given font in the font table.
  1783. Will re-use an existing font index if this
  1784. font matches another, EXCEPT if forced
  1785. registration is requested.
  1786. This allows people to create several fonts
  1787. then customise them later.
  1788. Note - End Users probably want to call
  1789. {@link XSSFFont#registerTo(StylesTable)}
  1790. </member>
  1791. <member name="M:NPOI.XSSF.Model.StylesTable.PutBorder(NPOI.XSSF.UserModel.Extensions.XSSFCellBorder)">
  1792. <summary>
  1793. Adds a border to the border style table if it isn't already in the style table
  1794. Does nothing if border is already in borders style table
  1795. </summary>
  1796. <param name="border">border to add</param>
  1797. <returns>return the index of the added border</returns>
  1798. </member>
  1799. <member name="M:NPOI.XSSF.Model.StylesTable.PutFill(NPOI.XSSF.UserModel.Extensions.XSSFCellFill)">
  1800. <summary>
  1801. Adds a fill to the fill style table if it isn't already in the style table
  1802. Does nothing if fill is already in fill style table
  1803. </summary>
  1804. <param name="fill">fill to add</param>
  1805. <returns>return the index of the added fill</returns>
  1806. </member>
  1807. <member name="M:NPOI.XSSF.Model.StylesTable.PutCellXf(NPOI.OpenXmlFormats.Spreadsheet.CT_Xf)">
  1808. <summary>
  1809. Adds a cell to the styles table. Does not check for duplicates
  1810. </summary>
  1811. <param name="cellXf">the cell to add to the styles table</param>
  1812. <returns>return the added cell ID in the style table</returns>
  1813. </member>
  1814. <member name="M:NPOI.XSSF.Model.StylesTable.PutCellStyleXf(NPOI.OpenXmlFormats.Spreadsheet.CT_Xf)">
  1815. <summary>
  1816. Adds a cell style to the styles table.Does not check for duplicates.
  1817. </summary>
  1818. <param name="cellStyleXf">the cell style to add to the styles table</param>
  1819. <returns>return the cell style ID in the style table</returns>
  1820. </member>
  1821. <member name="P:NPOI.XSSF.Model.StylesTable.NumCellStyles">
  1822. get the size of cell styles
  1823. </member>
  1824. <member name="P:NPOI.XSSF.Model.StylesTable.NumDataFormats">
  1825. @return number of data formats in the styles table
  1826. </member>
  1827. <member name="P:NPOI.XSSF.Model.StylesTable.NumberFormatSize">
  1828. For unit testing only
  1829. </member>
  1830. <member name="P:NPOI.XSSF.Model.StylesTable.XfsSize">
  1831. For unit testing only
  1832. </member>
  1833. <member name="P:NPOI.XSSF.Model.StylesTable.StyleXfsSize">
  1834. For unit testing only
  1835. </member>
  1836. <member name="M:NPOI.XSSF.Model.StylesTable.GetCTStylesheet">
  1837. For unit testing only!
  1838. </member>
  1839. <member name="M:NPOI.XSSF.Model.StylesTable.WriteTo(System.IO.Stream)">
  1840. Write this table out as XML.
  1841. @param out The stream to write to.
  1842. @throws IOException if an error occurs while writing.
  1843. </member>
  1844. <member name="M:NPOI.XSSF.Model.StylesTable.PutDxf(NPOI.OpenXmlFormats.Spreadsheet.CT_Dxf)">
  1845. <summary>
  1846. Adds a Dxf to the style table Does not check for duplicates.
  1847. </summary>
  1848. <param name="dxf">the Dxf to add</param>
  1849. <returns>added dxf ID in the style table</returns>
  1850. </member>
  1851. <member name="M:NPOI.XSSF.Model.StylesTable.CreateCellStyle">
  1852. Create a cell style in this style table.
  1853. Note - End users probably want to call {@link XSSFWorkbook#createCellStyle()}
  1854. rather than working with the styles table directly.
  1855. </member>
  1856. <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)">
  1857. Finds a font that matches the one with the supplied attributes
  1858. </member>
  1859. <member name="M:NPOI.XSSF.Model.StylesTable.FindFont(System.Boolean,System.Int16,System.Int16,System.String,System.Boolean,System.Boolean,NPOI.SS.UserModel.FontSuperScript,NPOI.SS.UserModel.FontUnderlineType)">
  1860. Finds a font that matches the one with the supplied attributes
  1861. </member>
  1862. <member name="T:NPOI.XSSF.Model.ThemesTable">
  1863. Class that represents theme of XLSX document. The theme includes specific
  1864. colors and fonts.
  1865. </member>
  1866. <member name="M:NPOI.XSSF.Model.ThemesTable.#ctor">
  1867. Create a new, empty ThemesTable
  1868. </member>
  1869. <member name="M:NPOI.XSSF.Model.ThemesTable.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  1870. Construct a ThemesTable.
  1871. @param part A PackagePart.
  1872. @param rel A PackageRelationship.
  1873. </member>
  1874. <member name="M:NPOI.XSSF.Model.ThemesTable.#ctor(NPOI.OpenXmlFormats.Spreadsheet.ThemeDocument)">
  1875. Construct a ThemesTable from an existing ThemeDocument.
  1876. @param theme A ThemeDocument.
  1877. </member>
  1878. <member name="M:NPOI.XSSF.Model.ThemesTable.GetThemeColor(System.Int32)">
  1879. Convert a theme "index" into a color.
  1880. @param idx A theme "index"
  1881. @return The mapped XSSFColor, or null if not mapped.
  1882. </member>
  1883. <member name="M:NPOI.XSSF.Model.ThemesTable.InheritFromThemeAsRequired(NPOI.XSSF.UserModel.XSSFColor)">
  1884. If the colour is based on a theme, then inherit
  1885. information (currently just colours) from it as
  1886. required.
  1887. </member>
  1888. <member name="M:NPOI.XSSF.Model.ThemesTable.writeTo(System.IO.Stream)">
  1889. Write this table out as XML.
  1890. @param out The stream to write to.
  1891. @throws IOException if an error occurs while writing.
  1892. </member>
  1893. <member name="F:NPOI.XSSF.Streaming.AutoSizeColumnTracker.maxColumnWidths">
  1894. <summary>
  1895. map of tracked columns, with values containing the best-fit width for the column
  1896. Using a HashMap instead of a TreeMap because insertion (trackColumn), removal (untrackColumn), and membership (everything)
  1897. will be called more frequently than getTrackedColumns(). The O(1) cost of insertion, removal, and membership operations
  1898. outweigh the infrequent O(n*log n) cost of sorting getTrackedColumns().
  1899. Memory consumption for a HashMap and TreeMap is about the same
  1900. </summary>
  1901. </member>
  1902. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.ColumnWidthPair.GetMaxColumnWidth(System.Boolean)">
  1903. Gets the current best-fit column width for the provided settings
  1904. @param useMergedCells true if merged cells are considered into the best-fit column width calculation
  1905. @return best fit column width, measured in default character widths.
  1906. </member>
  1907. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.ColumnWidthPair.SetMaxColumnWidths(System.Double,System.Double)">
  1908. Sets the best-fit column width to the maximum of the current width and the provided width
  1909. @param unmergedWidth the best-fit column width calculated with useMergedCells=False
  1910. @param mergedWidth the best-fit column width calculated with useMergedCells=True
  1911. </member>
  1912. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.#ctor(NPOI.SS.UserModel.ISheet)">
  1913. AutoSizeColumnTracker constructor. Holds no reference to <code>sheet</code>
  1914. @param sheet the sheet associated with this auto-size column tracker
  1915. @since 3.14beta1
  1916. </member>
  1917. <member name="P:NPOI.XSSF.Streaming.AutoSizeColumnTracker.TrackedColumns">
  1918. Get the currently tracked columns, naturally ordered.
  1919. Note if all columns are tracked, this will only return the columns that have been explicitly or implicitly tracked,
  1920. which is probably only columns containing 1 or more non-blank values
  1921. @return a set of the indices of all tracked columns
  1922. @since 3.14beta1
  1923. </member>
  1924. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.IsColumnTracked(System.Int32)">
  1925. Returns true if column is currently tracked for auto-sizing.
  1926. @param column the index of the column to check
  1927. @return true if column is tracked
  1928. @since 3.14beta1
  1929. </member>
  1930. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.IsAllColumnsTracked">
  1931. Returns true if all columns are implicitly tracked.
  1932. @return true if all columns are implicitly tracked
  1933. @since 3.14beta1
  1934. </member>
  1935. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.TrackAllColumns">
  1936. Tracks all non-blank columns
  1937. Allows columns that have been explicitly untracked to be tracked
  1938. @since 3.14beta1
  1939. </member>
  1940. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.UntrackAllColumns">
  1941. Untrack all columns that were previously tracked for auto-sizing.
  1942. All best-fit column widths are forgotten.
  1943. @since 3.14beta1
  1944. </member>
  1945. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.TrackColumns(System.Collections.Generic.ICollection{System.Int32})">
  1946. Marks multiple columns for inclusion in auto-size column tracking.
  1947. Note this has undefined behavior if columns are tracked after one or more rows are written to the sheet.
  1948. Any column in <code>columns</code> that are already tracked are ignored by this call.
  1949. @param columns the indices of the columns to track
  1950. @since 3.14beta1
  1951. </member>
  1952. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.TrackColumn(System.Int32)">
  1953. Marks a column for inclusion in auto-size column tracking.
  1954. Note this has undefined behavior if a column is tracked after one or more rows are written to the sheet.
  1955. If <code>column</code> is already tracked, this call does nothing.
  1956. @param column the index of the column to track for auto-sizing
  1957. @return if column is already tracked, the call does nothing and returns false
  1958. @since 3.14beta1
  1959. </member>
  1960. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.ImplicitlyTrackColumn(System.Int32)">
  1961. Implicitly track a column if it has not been explicitly untracked
  1962. If it has been explicitly untracked, this call does nothing and returns false.
  1963. Otherwise return true
  1964. @param column the column to implicitly track
  1965. @return false if column has been explicitly untracked, otherwise return true
  1966. </member>
  1967. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.UntrackColumns(System.Collections.Generic.ICollection{System.Int32})">
  1968. Removes columns that were previously marked for inclusion in auto-size column tracking.
  1969. When a column is untracked, the best-fit width is forgotten.
  1970. Any column in <code>columns</code> that is not tracked will be ignored by this call.
  1971. @param columns the indices of the columns to track for auto-sizing
  1972. @return true if one or more columns were untracked as a result of this call
  1973. @since 3.14beta1
  1974. </member>
  1975. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.UntrackColumn(System.Int32)">
  1976. Removes a column that was previously marked for inclusion in auto-size column tracking.
  1977. When a column is untracked, the best-fit width is forgotten.
  1978. If <code>column</code> is not tracked, it will be ignored by this call.
  1979. @param column the index of the column to track for auto-sizing
  1980. @return true if column was tracked prior this call, false if no action was taken
  1981. @since 3.14beta1
  1982. </member>
  1983. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.GetBestFitColumnWidth(System.Int32,System.Boolean)">
  1984. Get the best-fit width of a tracked column
  1985. @param column the index of the column to get the current best-fit width of
  1986. @param useMergedCells true if merged cells should be considered when computing the best-fit width
  1987. @return best-fit column width, measured in number of characters
  1988. @throws InvalidOperationException if column is not tracked and trackAllColumns is false
  1989. @since 3.14beta1
  1990. </member>
  1991. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.UpdateColumnWidths(NPOI.SS.UserModel.IRow)">
  1992. Calculate the best fit width for each tracked column in row
  1993. @param row the row to get the cells
  1994. @since 3.14beta1
  1995. </member>
  1996. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.ImplicitlyTrackColumnsInRow(NPOI.SS.UserModel.IRow)">
  1997. Helper for {@link #updateColumnWidths(Row)}.
  1998. Implicitly track the columns corresponding to the cells in row.
  1999. If all columns in the row are already tracked, this call does nothing.
  2000. Explicitly untracked columns will not be tracked.
  2001. @param row the row containing cells to implicitly track the columns
  2002. @since 3.14beta1
  2003. </member>
  2004. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.UpdateColumnWidth(NPOI.SS.UserModel.ICell,NPOI.XSSF.Streaming.AutoSizeColumnTracker.ColumnWidthPair)">
  2005. Helper for {@link #updateColumnWidths(Row)}.
  2006. @param cell the cell to compute the best fit width on
  2007. @param pair the column width pair to update
  2008. @since 3.14beta1
  2009. </member>
  2010. <member name="M:NPOI.XSSF.Streaming.GZIPSheetDataWriter.#ctor(NPOI.XSSF.Model.SharedStringsTable)">
  2011. @param sharedStringsTable the shared strings table, or null if inline text is used
  2012. </member>
  2013. <member name="M:NPOI.XSSF.Streaming.GZIPSheetDataWriter.CreateTempFile">
  2014. @return temp file to write sheet data
  2015. </member>
  2016. <member name="F:NPOI.XSSF.Streaming.SheetDataWriter._sharedStringSource">
  2017. Table of strings shared across this workbook.
  2018. If two cells contain the same string, then the cell value is the same index into SharedStringsTable
  2019. </member>
  2020. <member name="M:NPOI.XSSF.Streaming.SheetDataWriter.CreateTempFile">
  2021. Create a temp file to write sheet data.
  2022. By default, temp files are created in the default temporary-file directory
  2023. with a prefix "poi-sxssf-sheet" and suffix ".xml". Subclasses can override
  2024. it and specify a different temp directory or filename or suffix, e.g. <code>.gz</code>
  2025. @return temp file to write sheet data
  2026. </member>
  2027. <member name="M:NPOI.XSSF.Streaming.SheetDataWriter.CreateWriter(System.IO.FileInfo)">
  2028. Create a writer for the sheet data.
  2029. @param fd the file to write to
  2030. </member>
  2031. <member name="M:NPOI.XSSF.Streaming.SheetDataWriter.DecorateOutputStream(System.IO.Stream)">
  2032. Override this to translate (such as encrypt or compress) the file output stream
  2033. as it is being written to disk.
  2034. The default behavior is to to pass the stream through unmodified.
  2035. @param fos the stream to decorate
  2036. @return a decorated stream
  2037. @throws IOException
  2038. @see #decorateInputStream(FileInputStream)
  2039. </member>
  2040. <member name="M:NPOI.XSSF.Streaming.SheetDataWriter.Close">
  2041. flush and close the temp data writer.
  2042. This method <em>must</em> be invoked before calling {@link #getWorksheetXMLInputStream()}
  2043. </member>
  2044. <member name="M:NPOI.XSSF.Streaming.SheetDataWriter.GetWorksheetXmlInputStream">
  2045. @return a stream to read temp file with the sheet data
  2046. </member>
  2047. <member name="M:NPOI.XSSF.Streaming.SheetDataWriter.DecorateInputStream(System.IO.Stream)">
  2048. Override this to translate (such as decrypt or expand) the file input stream
  2049. as it is being read from disk.
  2050. The default behavior is to to pass the stream through unmodified.
  2051. @param fis the stream to decorate
  2052. @return a decorated stream
  2053. @throws IOException
  2054. @see #decorateOutputStream(FileOutputStream)
  2055. </member>
  2056. <member name="M:NPOI.XSSF.Streaming.SheetDataWriter.WriteRow(System.Int32,NPOI.XSSF.Streaming.SXSSFRow)">
  2057. Write a row to the file
  2058. @param rownum 0-based row number
  2059. @param row a row
  2060. </member>
  2061. <member name="M:NPOI.XSSF.Streaming.SheetDataWriter.HasLeadingTrailingSpaces(System.String)">
  2062. @return whether the string has leading / trailing spaces that
  2063. need to be preserved with the xml:space=\"preserve\" attribute
  2064. </member>
  2065. <member name="M:NPOI.XSSF.Streaming.SheetDataWriter.Dispose">
  2066. Deletes the temporary file that backed this sheet on disk.
  2067. @return true if the file was deleted, false if it wasn't.
  2068. </member>
  2069. <member name="M:NPOI.XSSF.Streaming.SXSSFCell.typeMismatch(NPOI.SS.UserModel.CellType,NPOI.SS.UserModel.CellType,System.Boolean)">
  2070. Used to help format error messages
  2071. </member>
  2072. <member name="P:NPOI.XSSF.Streaming.SXSSFEvaluationCell.CellType">
  2073. Will return {@link CellType} in a future version of POI.
  2074. For forwards compatibility, do not hard-code cell type literals in your code.
  2075. @return cell type
  2076. </member>
  2077. <member name="P:NPOI.XSSF.Streaming.SXSSFEvaluationCell.CellTypeEnum">
  2078. @since POI 3.15 beta 3
  2079. @deprecated POI 3.15 beta 3.
  2080. Will be deleted when we make the CellType enum transition. See bug 59791.
  2081. </member>
  2082. <member name="P:NPOI.XSSF.Streaming.SXSSFEvaluationCell.CachedFormulaResultType">
  2083. Will return {@link CellType} in a future version of POI.
  2084. For forwards compatibility, do not hard-code cell type literals in your code.
  2085. @return cell type of cached formula result
  2086. </member>
  2087. <member name="M:NPOI.XSSF.Streaming.SXSSFEvaluationCell.GetCachedFormulaResultTypeEnum">
  2088. @since POI 3.15 beta 3
  2089. @deprecated POI 3.15 beta 3.
  2090. Will be deleted when we make the CellType enum transition. See bug 59791.
  2091. </member>
  2092. <member name="M:NPOI.XSSF.Streaming.SXSSFFormulaEvaluator.EvaluateAll">
  2093. Loops over rows and cells, evaluating formula cells there.
  2094. If any sheets are inactive, or any cells outside of the window,
  2095. will give an Exception.
  2096. For SXSSF, you generally don't want to use this method, instead
  2097. evaluate your formulas as you go before they leave the window.
  2098. </member>
  2099. <member name="M:NPOI.XSSF.Streaming.SXSSFRow.CompareTo(NPOI.XSSF.Streaming.SXSSFRow)">
  2100. Compares two <code>SXSSFRow</code> objects. Two rows are equal if they belong to the same worksheet and
  2101. their row indexes are equal.
  2102. @param other the <code>SXSSFRow</code> to be compared.
  2103. @return <ul>
  2104. <li>
  2105. the value <code>0</code> if the row number of this <code>SXSSFRow</code> is
  2106. equal to the row number of the argument <code>SXSSFRow</code>
  2107. </li>
  2108. <li>
  2109. a value less than <code>0</code> if the row number of this this <code>SXSSFRow</code> is
  2110. numerically less than the row number of the argument <code>SXSSFRow</code>
  2111. </li>
  2112. <li>
  2113. a value greater than <code>0</code> if the row number of this this <code>SXSSFRow</code> is
  2114. numerically greater than the row number of the argument <code>SXSSFRow</code>
  2115. </li>
  2116. </ul>
  2117. @throws IllegalArgumentException if the argument row belongs to a different worksheet
  2118. </member>
  2119. <member name="M:NPOI.XSSF.Streaming.SXSSFRow.CheckBounds(System.Int32)">
  2120. <summary>
  2121. throws RuntimeException if the bounds are exceeded.
  2122. </summary>
  2123. <param name="cellIndex"></param>
  2124. </member>
  2125. <member name="M:NPOI.XSSF.Streaming.SXSSFRow.GetCellIndex(NPOI.XSSF.Streaming.SXSSFCell)">
  2126. Return the column number of a cell if it is in this row
  2127. Otherwise return -1
  2128. @param cell the cell to get the index of
  2129. @return cell column index if it is in this row, -1 otherwise
  2130. </member>
  2131. <member name="T:NPOI.XSSF.Streaming.SXSSFRow.FilledCellIterator">
  2132. Create an iterator over the cells from [0, getLastCellNum()).
  2133. Includes blank cells, excludes empty cells
  2134. Returns an iterator over all filled cells (created via Row.createCell())
  2135. Throws ConcurrentModificationException if cells are added, moved, or
  2136. removed after the iterator is created.
  2137. </member>
  2138. <member name="P:NPOI.XSSF.Streaming.SXSSFSheet.IsPrintRowAndColumnHeadings">
  2139. Returns whether row and column headings are printed.
  2140. @return whether row and column headings are printed
  2141. </member>
  2142. <member name="P:NPOI.XSSF.Streaming.SXSSFSheet.MergedRegions">
  2143. Returns the list of merged regions. If you want multiple regions, this is
  2144. faster than calling {@link #getMergedRegion(int)} each time.
  2145. @return the list of merged regions
  2146. </member>
  2147. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.AddMergedRegionUnsafe(NPOI.SS.Util.CellRangeAddress)">
  2148. <summary>
  2149. Adds a merged region of cells (hence those cells form one).
  2150. Skips validation.It is possible to create overlapping merged regions
  2151. or create a merged region that intersects a multi-cell array formula
  2152. with this formula, which may result in a corrupt workbook.
  2153. </summary>
  2154. <param name="region">region to merge</param>
  2155. <returns>index of this region</returns>
  2156. <exception cref="T:System.ArgumentException">if region contains fewer than 2 cells</exception>
  2157. </member>
  2158. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.ValidateMergedRegions">
  2159. Verify that merged regions do not intersect multi-cell array formulas and
  2160. no merged regions intersect another merged region in this sheet.
  2161. @throws InvalidOperationException if region intersects with a multi-cell array formula
  2162. @throws InvalidOperationException if at least one region intersects with another merged region in this sheet
  2163. </member>
  2164. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.AutoSizeColumn(System.Int32)">
  2165. Adjusts the column width to fit the contents.
  2166. <p>
  2167. This process can be relatively slow on large sheets, so this should
  2168. normally only be called once per column, at the end of your
  2169. processing.
  2170. </p>
  2171. You can specify whether the content of merged cells should be considered or ignored.
  2172. Default is to ignore merged cells.
  2173. <p>
  2174. Special note about SXSSF implementation: You must register the columns you wish to track with
  2175. the SXSSFSheet using {@link #trackColumnForAutoSizing(int)} or {@link #trackAllColumnsForAutoSizing()}.
  2176. This is needed because the rows needed to compute the column width may have fallen outside the
  2177. random access window and been flushed to disk.
  2178. Tracking columns is required even if all rows are in the random access window.
  2179. </p>
  2180. <p><i>New in POI 3.14 beta 1: auto-sizes columns using cells from current and flushed rows.</i></p>
  2181. @param column the column index to auto-size
  2182. </member>
  2183. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.AutoSizeColumn(System.Int32,System.Boolean)">
  2184. Adjusts the column width to fit the contents.
  2185. <p>
  2186. This process can be relatively slow on large sheets, so this should
  2187. normally only be called once per column, at the end of your
  2188. processing.
  2189. </p>
  2190. You can specify whether the content of merged cells should be considered or ignored.
  2191. Default is to ignore merged cells.
  2192. <p>
  2193. Special note about SXSSF implementation: You must register the columns you wish to track with
  2194. the SXSSFSheet using {@link #trackColumnForAutoSizing(int)} or {@link #trackAllColumnsForAutoSizing()}.
  2195. This is needed because the rows needed to compute the column width may have fallen outside the
  2196. random access window and been flushed to disk.
  2197. Tracking columns is required even if all rows are in the random access window.
  2198. </p>
  2199. <p><i>New in POI 3.14 beta 1: auto-sizes columns using cells from current and flushed rows.</i></p>
  2200. @param column the column index to auto-size
  2201. @param useMergedCells whether to use the contents of merged cells when calculating the width of the column
  2202. </member>
  2203. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.GetHyperlink(System.Int32,System.Int32)">
  2204. <summary>
  2205. Get a Hyperlink in this sheet anchored at row, column
  2206. </summary>
  2207. <param name="row">The index of the row of the hyperlink, zero-based</param>
  2208. <param name="column">the index of the column of the hyperlink, zero-based</param>
  2209. <returns>return hyperlink if there is a hyperlink anchored at row, column; otherwise returns null</returns>
  2210. </member>
  2211. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.GetHyperlink(NPOI.SS.Util.CellAddress)">
  2212. <summary>
  2213. Get a Hyperlink in this sheet located in a cell specified by {code addr}
  2214. </summary>
  2215. <param name="addr">The address of the cell containing the hyperlink</param>
  2216. <returns>return hyperlink if there is a hyperlink anchored at {@code addr}; otherwise returns {@code null}</returns>
  2217. </member>
  2218. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.GetHyperlinkList">
  2219. Get a list of Hyperlinks in this sheet
  2220. @return Hyperlinks for the sheet
  2221. </member>
  2222. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.GetCellComment(System.Int32,System.Int32)">
  2223. <summary>
  2224. Returns cell comment for the specified row and column
  2225. </summary>
  2226. <param name="row">The row.</param>
  2227. <param name="column">The column.</param>
  2228. <returns>cell comment or <code>null</code> if not found</returns>
  2229. </member>
  2230. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.GetCellComment(NPOI.SS.Util.CellAddress)">
  2231. <summary>
  2232. Returns cell comment for the specified location
  2233. </summary>
  2234. <param name="ref1">cell location</param>
  2235. <returns>return cell comment or null if not found</returns>
  2236. </member>
  2237. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.GetCellComments">
  2238. <summary>
  2239. Returns all cell comments on this sheet.
  2240. </summary>
  2241. <returns>return A Dictionary of each Comment in the sheet, keyed on the cell address where the comment is located.</returns>
  2242. </member>
  2243. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.SetRowOutlineLevel(System.Int32,System.Int32)">
  2244. Set row groupings (like groupRow) in a stream-friendly manner
  2245. <p>
  2246. groupRows requires all rows in the group to be in the current window.
  2247. This is not always practical. Instead use setRowOutlineLevel to
  2248. explicitly set the group level. Level 1 is the top level group,
  2249. followed by 2, etc. It is up to the user to ensure that level 2
  2250. groups are correctly nested under level 1, etc.
  2251. </p>
  2252. @param rownum index of row to update (0-based)
  2253. @param level outline level (greater than 0)
  2254. </member>
  2255. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.RemoveMergedRegions(System.Collections.Generic.IList{System.Int32})">
  2256. Removes a merged region of cells (hence letting them free)
  2257. @param indices of the regions to unmerge
  2258. </member>
  2259. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.TrackColumnForAutoSizing(System.Int32)">
  2260. Track a column in the sheet for auto-sizing.
  2261. Note this has undefined behavior if a column is tracked after one or more rows are written to the sheet.
  2262. If <code>column</code> is already tracked, this call does nothing.
  2263. @param column the column to track for autosizing
  2264. @since 3.14beta1
  2265. @see #trackColumnsForAutoSizing(Collection)
  2266. @see #trackAllColumnsForAutoSizing()
  2267. </member>
  2268. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.TrackColumnsForAutoSizing(System.Collections.Generic.ICollection{System.Int32})">
  2269. Track several columns in the sheet for auto-sizing.
  2270. Note this has undefined behavior if columns are tracked after one or more rows are written to the sheet.
  2271. Any column in <code>columns</code> that are already tracked are ignored by this call.
  2272. @param columns the columns to track for autosizing
  2273. @since 3.14beta1
  2274. </member>
  2275. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.TrackAllColumnsForAutoSizing">
  2276. Tracks all columns in the sheet for auto-sizing. If this is called, individual columns do not need to be tracked.
  2277. Because determining the best-fit width for a cell is expensive, this may affect the performance.
  2278. @since 3.14beta1
  2279. </member>
  2280. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.UntrackColumnForAutoSizing(System.Int32)">
  2281. Removes a column that was previously marked for inclusion in auto-size column tracking.
  2282. When a column is untracked, the best-fit width is forgotten.
  2283. If <code>column</code> is not tracked, it will be ignored by this call.
  2284. @param column the index of the column to track for auto-sizing
  2285. @return true if column was tracked prior to this call, false if no action was taken
  2286. @since 3.14beta1
  2287. @see #untrackColumnsForAutoSizing(Collection)
  2288. @see #untrackAllColumnsForAutoSizing(int)
  2289. </member>
  2290. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.UntrackColumnsForAutoSizing(System.Collections.Generic.ICollection{System.Int32})">
  2291. Untracks several columns in the sheet for auto-sizing.
  2292. When a column is untracked, the best-fit width is forgotten.
  2293. Any column in <code>columns</code> that is not tracked will be ignored by this call.
  2294. @param columns the indices of the columns to track for auto-sizing
  2295. @return true if one or more columns were untracked as a result of this call
  2296. @param columns the columns to track for autosizing
  2297. @since 3.14beta1
  2298. </member>
  2299. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.UntrackAllColumnsForAutoSizing">
  2300. Untracks all columns in the sheet for auto-sizing. Best-fit column widths are forgotten.
  2301. If this is called, individual columns do not need to be untracked.
  2302. @since 3.14beta1
  2303. </member>
  2304. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.IsColumnTrackedForAutoSizing(System.Int32)">
  2305. Returns true if column is currently tracked for auto-sizing.
  2306. @param column the index of the column to check
  2307. @return true if column is tracked
  2308. @since 3.14beta1
  2309. </member>
  2310. <member name="P:NPOI.XSSF.Streaming.SXSSFSheet.TrackedColumnsForAutoSizing">
  2311. Get the currently tracked columns for auto-sizing.
  2312. Note if all columns are tracked, this will only return the columns that have been explicitly or implicitly tracked,
  2313. which is probably only columns containing 1 or more non-blank values
  2314. @return a set of the indices of all tracked columns
  2315. @since 3.14beta1
  2316. </member>
  2317. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.FindStartOfRowOutlineGroup(System.Int32)">
  2318. @param rowIndex the zero based row index to find from
  2319. </member>
  2320. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.Streaming.SXSSFSheet.SetZoom(System.Int32)" -->
  2321. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.FlushRows(System.Int32,System.Boolean)">
  2322. Specifies how many rows can be accessed at most via getRow().
  2323. The exceeding rows (if any) are flushed to the disk while rows
  2324. with lower index values are flushed first.
  2325. </member>
  2326. <member name="P:NPOI.XSSF.Streaming.SXSSFSheet.LastFlushedRowNumber">
  2327. @return Last row number to be flushed to disk, or -1 if none flushed yet
  2328. </member>
  2329. <member name="T:NPOI.XSSF.Streaming.SXSSFWorkbook">
  2330. Streaming version of XSSFWorkbook implementing the "BigGridDemo" strategy.
  2331. This allows to write very large files without running out of memory as only
  2332. a configurable portion of the rows are kept in memory at any one time.
  2333. You can provide a template workbook which is used as basis for the written
  2334. data.
  2335. See https://poi.apache.org/spreadsheet/how-to.html#sxssf for details.
  2336. Please note that there are still things that still may consume a large
  2337. amount of memory based on which features you are using, e.g. merged regions,
  2338. comments, ... are still only stored in memory and thus may require a lot of
  2339. memory if used extensively.
  2340. SXSSFWorkbook defaults to using inline strings instead of a shared strings
  2341. table. This is very efficient, since no document content needs to be kept in
  2342. memory, but is also known to produce documents that are incompatible with
  2343. some clients. With shared strings enabled all unique strings in the document
  2344. has to be kept in memory. Depending on your document content this could use
  2345. a lot more resources than with shared strings disabled.
  2346. Carefully review your memory budget and compatibility needs before deciding
  2347. whether to enable shared strings or not.
  2348. <summary>
  2349. Streaming version of the XSSFWorkbook, originally implemented in the "BigGridDemo".
  2350. </summary>
  2351. </member>
  2352. <member name="P:NPOI.XSSF.Streaming.SXSSFWorkbook.RandomAccessWindowSize">
  2353. See the constructors for a more detailed description of the sliding window of rows.
  2354. @return The number of rows that are kept in memory at once before flushing them out.
  2355. </member>
  2356. <member name="F:NPOI.XSSF.Streaming.SXSSFWorkbook._compressTmpFiles">
  2357. <summary>
  2358. whether temp file should be compresss.
  2359. </summary>
  2360. </member>
  2361. <member name="F:NPOI.XSSF.Streaming.SXSSFWorkbook._sharedStringSource">
  2362. <summary>
  2363. shared string table - a cache of strings in this workbook.
  2364. </summary>
  2365. </member>
  2366. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.#ctor(System.Int32)">
  2367. Construct an empty workbook and specify the window for row access.
  2368. <p>
  2369. When a new node is created via createRow() and the total number
  2370. of unflushed records would exceed the specified value, then the
  2371. row with the lowest index value is flushed and cannot be accessed
  2372. via getRow() anymore.
  2373. </p>
  2374. <p>
  2375. A value of -1 indicates unlimited access. In this case all
  2376. records that have not been flushed by a call to flush() are available
  2377. for random access.
  2378. </p>
  2379. <p>
  2380. A value of 0 is not allowed because it would flush any newly created row
  2381. without having a chance to specify any cells.
  2382. </p>
  2383. @param rowAccessWindowSize the number of rows that are kept in memory until flushed out, see above.
  2384. </member>
  2385. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.#ctor">
  2386. <summary>
  2387. Construct a new workbook with default row window size
  2388. </summary>
  2389. </member>
  2390. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.#ctor(NPOI.XSSF.UserModel.XSSFWorkbook)">
  2391. Construct a workbook from a template.
  2392. <p>
  2393. There are three use-cases to use SXSSFWorkbook(XSSFWorkbook) :
  2394. <ol>
  2395. <li>
  2396. Append new sheets to existing workbooks. You can open existing
  2397. workbook from a file or create on the fly with XSSF.
  2398. </li>
  2399. <li>
  2400. Append rows to existing sheets. The row number MUST be greater
  2401. than max(rownum) in the template sheet.
  2402. </li>
  2403. <li>
  2404. Use existing workbook as a template and re-use global objects such
  2405. as cell styles, formats, images, etc.
  2406. </li>
  2407. </ol>
  2408. All three use cases can work in a combination.
  2409. </p>
  2410. What is not supported:
  2411. <ul>
  2412. <li>
  2413. Access initial cells and rows in the template. After constructing
  2414. SXSSFWorkbook(XSSFWorkbook) all internal windows are empty and
  2415. SXSSFSheet@getRow and SXSSFRow#getCell return null.
  2416. </li>
  2417. <li>
  2418. Override existing cells and rows. The API silently allows that but
  2419. the output file is invalid and Excel cannot read it.
  2420. </li>
  2421. </ul>
  2422. @param workbook the template workbook
  2423. </member>
  2424. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.#ctor(NPOI.XSSF.UserModel.XSSFWorkbook,System.Int32)">
  2425. Constructs an workbook from an existing workbook.
  2426. <p>
  2427. When a new node is created via createRow() and the total number
  2428. of unflushed records would exceed the specified value, then the
  2429. row with the lowest index value is flushed and cannot be accessed
  2430. via getRow() anymore.
  2431. </p>
  2432. <p>
  2433. A value of -1 indicates unlimited access. In this case all
  2434. records that have not been flushed by a call to flush() are available
  2435. for random access.
  2436. </p>
  2437. <p>
  2438. A value of 0 is not allowed because it would flush any newly created row
  2439. without having a chance to specify any cells.
  2440. </p>
  2441. @param rowAccessWindowSize the number of rows that are kept in memory until flushed out, see above.
  2442. </member>
  2443. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.#ctor(NPOI.XSSF.UserModel.XSSFWorkbook,System.Int32,System.Boolean)">
  2444. Constructs an workbook from an existing workbook.
  2445. <p>
  2446. When a new node is created via createRow() and the total number
  2447. of unflushed records would exceed the specified value, then the
  2448. row with the lowest index value is flushed and cannot be accessed
  2449. via getRow() anymore.
  2450. </p>
  2451. <p>
  2452. A value of -1 indicates unlimited access. In this case all
  2453. records that have not been flushed by a call to flush() are available
  2454. for random access.
  2455. </p>
  2456. <p>
  2457. A value of 0 is not allowed because it would flush any newly created row
  2458. without having a chance to specify any cells.
  2459. </p>
  2460. @param rowAccessWindowSize the number of rows that are kept in memory until flushed out, see above.
  2461. @param compressTmpFiles whether to use gzip compression for temporary files
  2462. </member>
  2463. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.#ctor(NPOI.XSSF.UserModel.XSSFWorkbook,System.Int32,System.Boolean,System.Boolean)">
  2464. Constructs an workbook from an existing workbook.
  2465. <p>
  2466. When a new node is created via createRow() and the total number
  2467. of unflushed records would exceed the specified value, then the
  2468. row with the lowest index value is flushed and cannot be accessed
  2469. via getRow() anymore.
  2470. </p>
  2471. <p>
  2472. A value of -1 indicates unlimited access. In this case all
  2473. records that have not been flushed by a call to flush() are available
  2474. for random access.
  2475. </p>
  2476. <p>
  2477. A value of 0 is not allowed because it would flush any newly created row
  2478. without having a chance to specify any cells.
  2479. </p>
  2480. @param workbook the template workbook
  2481. @param rowAccessWindowSize the number of rows that are kept in memory until flushed out, see above.
  2482. @param compressTmpFiles whether to use gzip compression for temporary files
  2483. @param useSharedStringsTable whether to use a shared strings table
  2484. <summary>
  2485. Currently only supports writing not reading. E.g. the number of rows returned from a worksheet will be wrong etc.
  2486. </summary>
  2487. <param name="workbook"></param>
  2488. <param name="rowAccessWindowSize"></param>
  2489. <param name="compressTmpFiles"></param>
  2490. <param name="useSharedStringsTable"></param>
  2491. </member>
  2492. <member name="P:NPOI.XSSF.Streaming.SXSSFWorkbook.CompressTempFiles">
  2493. Set whether temp files should be compressed.
  2494. <p>
  2495. SXSSF writes sheet data in temporary files (a temp file per-sheet)
  2496. and the size of these temp files can grow to to a very large size,
  2497. e.g. for a 20 MB csv data the size of the temp xml file become few GB large.
  2498. If the "compress" flag is set to <code>true</code> then the temporary XML is gzipped.
  2499. </p>
  2500. <p>
  2501. Please note the the "compress" option may cause performance penalty.
  2502. </p>
  2503. @param compress whether to compress temp files
  2504. </member>
  2505. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.FindFont(System.Boolean,System.Int16,System.Int16,System.String,System.Boolean,System.Boolean,NPOI.SS.UserModel.FontSuperScript,NPOI.SS.UserModel.FontUnderlineType)">
  2506. Finds a font that matches the one with the supplied attributes
  2507. @return the font with the matched attributes or <code>null</code>
  2508. </member>
  2509. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.Dispose">
  2510. Dispose of temporary files backing this workbook on disk.
  2511. Calling this method will render the workbook unusable.
  2512. @return true if all temporary files were deleted successfully.
  2513. </member>
  2514. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.GetNames(System.String)">
  2515. Returns all defined names with the given name.
  2516. @param name the name of the defined name
  2517. @return a list of the defined names with the specified name. An empty list is returned if none is found.
  2518. </member>
  2519. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.GetAllNames">
  2520. <summary>
  2521. Returns all defined names
  2522. </summary>
  2523. <returns>Returns all defined names</returns>
  2524. </member>
  2525. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.RemoveName(NPOI.SS.UserModel.IName)">
  2526. <summary>
  2527. Remove the given defined name
  2528. </summary>
  2529. <param name="name">the name to remove</param>
  2530. </member>
  2531. <member name="P:NPOI.XSSF.Streaming.SXSSFWorkbook.SpreadsheetVersion">
  2532. <summary>
  2533. Returns the spreadsheet version (EXCLE2007) of this workbook
  2534. </summary>
  2535. </member>
  2536. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.IsDate1904">
  2537. <summary>
  2538. Gets a bool value that indicates whether the date systems used in the workbook starts in 1904.
  2539. The default value is false, meaning that the workbook uses the 1900 date system,
  2540. where 1/1/1900 is the first day in the system.
  2541. </summary>
  2542. <returns>True if the date systems used in the workbook starts in 1904</returns>
  2543. </member>
  2544. <member name="T:NPOI.XSSF.UserModel.BaseXSSFEvaluationWorkbook">
  2545. Internal POI use only - parent of XSSF and SXSSF Evaluation workbooks
  2546. </member>
  2547. <member name="M:NPOI.XSSF.UserModel.BaseXSSFEvaluationWorkbook.ConvertFromExternSheetIndex(System.Int32)">
  2548. XSSF doesn't use external sheet indexes, so when asked treat
  2549. it just as a local index
  2550. </member>
  2551. <member name="M:NPOI.XSSF.UserModel.BaseXSSFEvaluationWorkbook.ConvertToExternalSheetIndex(System.Int32)">
  2552. @return the external sheet index of the sheet with the given internal
  2553. index. Used by some of the more obscure formula and named range things.
  2554. Fairly easy on XSSF (we think...) since the internal and external
  2555. indices are the same
  2556. </member>
  2557. <member name="M:NPOI.XSSF.UserModel.BaseXSSFEvaluationWorkbook.GetName(System.String,System.Int32)">
  2558. <summary>
  2559. Return EvaluationName wrapper around the matching XSSFName (named range)
  2560. </summary>
  2561. <param name="name">case-aware but case-insensitive named range in workbook</param>
  2562. <param name="sheetIndex">index of sheet if named range scope is limited to one sheet
  2563. if named range scope is global to the workbook, sheetIndex is -1.</param>
  2564. <returns>If name is a named range in the workbook, returns
  2565. EvaluationName corresponding to that named range
  2566. Returns null if there is no named range with the same name and scope in the workbook
  2567. </returns>
  2568. </member>
  2569. <member name="M:NPOI.XSSF.UserModel.BaseXSSFEvaluationWorkbook.GetNameXPtg(System.String,NPOI.SS.Formula.SheetIdentifier)">
  2570. <summary>
  2571. Return an external name (named range, function, user-defined function) Pxg
  2572. </summary>
  2573. <param name="name"></param>
  2574. <param name="sheet"></param>
  2575. <returns></returns>
  2576. </member>
  2577. <member name="M:NPOI.XSSF.UserModel.BaseXSSFEvaluationWorkbook.GetTable(System.String)">
  2578. Returns the data table with the given name (case insensitive).
  2579. Tables are cached for performance (formula evaluation looks them up by name repeatedly).
  2580. After the first table lookup, adding or removing a table from the document structure will cause trouble.
  2581. This is meant to be used on documents whose structure is essentially static at the point formulas are evaluated.
  2582. @param name the data table name (case-insensitive)
  2583. @return The Data table in the workbook named <tt>name</tt>, or <tt>null</tt> if no table is named <tt>name</tt>.
  2584. @since 3.15 beta 2
  2585. </member>
  2586. <member name="T:NPOI.XSSF.UserModel.BaseXSSFFormulaEvaluator">
  2587. Internal POI use only - parent of XSSF and SXSSF formula Evaluators
  2588. </member>
  2589. <member name="M:NPOI.XSSF.UserModel.BaseXSSFFormulaEvaluator.ToEvaluationCell(NPOI.SS.UserModel.ICell)">
  2590. Turns a XSSFCell / SXSSFCell into a XSSFEvaluationCell
  2591. </member>
  2592. <member name="M:NPOI.XSSF.UserModel.BaseXSSFFormulaEvaluator.EvaluateFormulaCellValue(NPOI.SS.UserModel.ICell)">
  2593. Returns a CellValue wrapper around the supplied ValueEval instance.
  2594. </member>
  2595. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFBarChartData`2">
  2596. <summary>
  2597. Holds data for a XSSF Line Chart
  2598. </summary>
  2599. <typeparam name="Tx"></typeparam>
  2600. <typeparam name="Ty"></typeparam>
  2601. </member>
  2602. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFBarChartData`2.series">
  2603. List of all data series.
  2604. </member>
  2605. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFChartAxis">
  2606. Base class for all axis types.
  2607. @author Roman Kashitsyn
  2608. </member>
  2609. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFChartDataFactory">
  2610. @author Roman Kashitsyn
  2611. </member>
  2612. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartDataFactory.CreateScatterChartData``2">
  2613. @return new scatter chart data instance
  2614. </member>
  2615. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartDataFactory.GetInstance">
  2616. @return factory instance
  2617. </member>
  2618. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFChartLegend">
  2619. Represents a SpreadsheetML chart legend
  2620. @author Roman Kashitsyn
  2621. </member>
  2622. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFChartLegend.legend">
  2623. Underlaying CTLagend bean
  2624. </member>
  2625. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartLegend.#ctor(NPOI.XSSF.UserModel.XSSFChart)">
  2626. Create a new SpreadsheetML chart legend
  2627. </member>
  2628. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartLegend.SetDefaults">
  2629. Set sensible default styling.
  2630. </member>
  2631. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartLegend.GetCTLegend">
  2632. Return the underlying CTLegend bean.
  2633. @return the underlying CTLegend bean
  2634. </member>
  2635. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFChartUtil">
  2636. Package private class with utility methods.
  2637. @author Roman Kashitsyn
  2638. </member>
  2639. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartUtil.BuildAxDataSource``1(NPOI.OpenXmlFormats.Dml.Chart.CT_AxDataSource,NPOI.SS.UserModel.Charts.IChartDataSource{``0})">
  2640. Builds CTAxDataSource object content from POI ChartDataSource.
  2641. @param ctAxDataSource OOXML data source to build
  2642. @param dataSource POI data source to use
  2643. </member>
  2644. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartUtil.BuildNumDataSource``1(NPOI.OpenXmlFormats.Dml.Chart.CT_NumDataSource,NPOI.SS.UserModel.Charts.IChartDataSource{``0})">
  2645. Builds CTNumDataSource object content from POI ChartDataSource
  2646. @param ctNumDataSource OOXML data source to build
  2647. @param dataSource POI data source to use
  2648. </member>
  2649. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFLineChartData`2">
  2650. <summary>
  2651. Holds data for a XSSF Line Chart
  2652. </summary>
  2653. <typeparam name="Tx"></typeparam>
  2654. <typeparam name="Ty"></typeparam>
  2655. </member>
  2656. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFLineChartData`2.series">
  2657. List of all data series.
  2658. </member>
  2659. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFManualLayout">
  2660. Represents a SpreadsheetML manual layout.
  2661. @author Roman Kashitsyn
  2662. </member>
  2663. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFManualLayout.layout">
  2664. Underlaying CTManualLayout bean.
  2665. </member>
  2666. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFManualLayout.#ctor(NPOI.OpenXmlFormats.Dml.Chart.CT_Layout)">
  2667. Create a new SpreadsheetML manual layout.
  2668. @param layout a Spreadsheet ML layout that should be used as base.
  2669. </member>
  2670. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFManualLayout.#ctor(NPOI.XSSF.UserModel.XSSFChart)">
  2671. Create a new SpreadsheetML manual layout for chart.
  2672. @param chart a chart to create layout for.
  2673. </member>
  2674. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFManualLayout.GetCTManualLayout">
  2675. Return the underlying CTManualLayout bean.
  2676. @return the underlying CTManualLayout bean.
  2677. </member>
  2678. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2">
  2679. Represents DrawingML scatter chart.
  2680. @author Roman Kashitsyn
  2681. </member>
  2682. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.series">
  2683. List of all data series.
  2684. </member>
  2685. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.Series">
  2686. Package private ScatterChartSerie implementation.
  2687. </member>
  2688. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.Series.GetXValues">
  2689. Returns data source used for X axis values.
  2690. @return data source used for X axis values
  2691. </member>
  2692. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.Series.GetYValues">
  2693. Returns data source used for Y axis values.
  2694. @return data source used for Y axis values
  2695. </member>
  2696. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.Series.SetUseCache(System.Boolean)">
  2697. @param useCache if true, cached results will be Added on plot
  2698. </member>
  2699. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFValueAxis">
  2700. Value axis type.
  2701. @author Roman Kashitsyn
  2702. </member>
  2703. <member name="T:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment">
  2704. Cell Settings avaiable in the Format/Alignment tab
  2705. </member>
  2706. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_CellAlignment)">
  2707. Creates a Cell Alignment from the supplied XML defInition
  2708. @param cellAlignment
  2709. </member>
  2710. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.Vertical">
  2711. Get the type of vertical alignment for the cell
  2712. @return the type of aligment
  2713. @see VerticalAlignment
  2714. </member>
  2715. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.Horizontal">
  2716. Get the type of horizontal alignment for the cell
  2717. @return the type of aligment
  2718. @see HorizontalAlignment
  2719. </member>
  2720. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.Indent">
  2721. Get the number of spaces to indent the text in the cell
  2722. @return indent - number of spaces
  2723. </member>
  2724. <!-- Badly formed XML comment ignored for member "P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.TextRotation" -->
  2725. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.WrapText">
  2726. Whether the text should be wrapped
  2727. @return a bool value indicating if the text in a cell should be line-wrapped within the cell.
  2728. </member>
  2729. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.GetCTCellAlignment">
  2730. Access to low-level data
  2731. </member>
  2732. <member name="T:NPOI.XSSF.UserModel.Extensions.BorderSide">
  2733. The enumeration value indicating the side being used for a cell border.
  2734. </member>
  2735. <member name="T:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder">
  2736. This element Contains border formatting information, specifying border defInition formats (left, right, top, bottom, diagonal)
  2737. for cells in the workbook.
  2738. Color is optional.
  2739. </member>
  2740. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Border,NPOI.XSSF.Model.ThemesTable)">
  2741. Creates a Cell Border from the supplied XML defInition
  2742. </member>
  2743. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Border)">
  2744. Creates a Cell Border from the supplied XML defInition
  2745. </member>
  2746. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.#ctor">
  2747. Creates a new, empty Cell Border.
  2748. You need to attach this to the Styles Table
  2749. </member>
  2750. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.SetThemesTable(NPOI.XSSF.Model.ThemesTable)">
  2751. Records the Themes Table that is associated with
  2752. the current font, used when looking up theme
  2753. based colours and properties.
  2754. </member>
  2755. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.GetCTBorder">
  2756. Returns the underlying XML bean.
  2757. @return CT_Border
  2758. </member>
  2759. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.GetBorderStyle(NPOI.XSSF.UserModel.Extensions.BorderSide)">
  2760. Get the type of border to use for the selected border
  2761. @param side - - where to apply the color defInition
  2762. @return borderstyle - the type of border to use. default value is NONE if border style is not Set.
  2763. @see BorderStyle
  2764. </member>
  2765. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.SetBorderStyle(NPOI.XSSF.UserModel.Extensions.BorderSide,NPOI.SS.UserModel.BorderStyle)">
  2766. Set the type of border to use for the selected border
  2767. @param side - - where to apply the color defInition
  2768. @param style - border style
  2769. @see BorderStyle
  2770. </member>
  2771. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.GetBorderColor(NPOI.XSSF.UserModel.Extensions.BorderSide)">
  2772. Get the color to use for the selected border
  2773. @param side - where to apply the color defInition
  2774. @return color - color to use as XSSFColor. null if color is not set
  2775. </member>
  2776. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.SetBorderColor(NPOI.XSSF.UserModel.Extensions.BorderSide,NPOI.XSSF.UserModel.XSSFColor)">
  2777. Set the color to use for the selected border
  2778. @param side - where to apply the color defInition
  2779. @param color - the color to use
  2780. </member>
  2781. <member name="T:NPOI.XSSF.UserModel.Extensions.XSSFCellFill">
  2782. This element specifies fill formatting.
  2783. A cell fill consists of a background color, foreground color, and pattern to be applied across the cell.
  2784. </member>
  2785. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Fill)">
  2786. Creates a CellFill from the supplied parts
  2787. @param fill - fill
  2788. </member>
  2789. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.#ctor">
  2790. Creates an empty CellFill
  2791. </member>
  2792. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.GetFillBackgroundColor">
  2793. Get the background fill color.
  2794. @return fill color, null if color is not set
  2795. </member>
  2796. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetFillBackgroundColor(System.Int32)">
  2797. Set the background fill color represented as a indexed color value.
  2798. @param index
  2799. </member>
  2800. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetFillBackgroundColor(NPOI.XSSF.UserModel.XSSFColor)">
  2801. Set the background fill color represented as a {@link XSSFColor} value.
  2802. @param color
  2803. </member>
  2804. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.GetFillForegroundColor">
  2805. Get the foreground fill color.
  2806. @return XSSFColor - foreground color. null if color is not set
  2807. </member>
  2808. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetFillForegroundColor(System.Int32)">
  2809. Set the foreground fill color as a indexed color value
  2810. @param index - the color to use
  2811. </member>
  2812. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetFillForegroundColor(NPOI.XSSF.UserModel.XSSFColor)">
  2813. Set the foreground fill color represented as a {@link XSSFColor} value.
  2814. @param color - the color to use
  2815. </member>
  2816. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.GetPatternType">
  2817. get the fill pattern
  2818. @return fill pattern type. null if fill pattern is not set
  2819. </member>
  2820. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetPatternType(NPOI.OpenXmlFormats.Spreadsheet.ST_PatternType)">
  2821. set the fill pattern
  2822. @param patternType fill pattern to use
  2823. </member>
  2824. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.GetCTFill">
  2825. Returns the underlying XML bean.
  2826. @return CT_Fill
  2827. </member>
  2828. <member name="T:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter">
  2829. <summary>
  2830. Parent class of all XSSF headers and footers.
  2831. </summary>
  2832. </member>
  2833. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  2834. Create an instance of XSSFHeaderFooter from the supplied XML bean
  2835. @param headerFooter
  2836. </member>
  2837. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.GetHeaderFooter">
  2838. Returns the underlying CTHeaderFooter xml bean
  2839. @return the underlying CTHeaderFooter xml bean
  2840. </member>
  2841. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.AreFieldsStripped">
  2842. Are fields currently being stripped from the text that this
  2843. {@link XSSFHeaderFooter} returns? Default is false, but can be Changed
  2844. </member>
  2845. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.SetAreFieldsStripped(System.Boolean)">
  2846. Should fields (eg macros) be stripped from the text that this class
  2847. returns? Default is not to strip.
  2848. @param StripFields
  2849. </member>
  2850. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.StripFields(System.String)">
  2851. Removes any fields (eg macros, page markers etc) from the string.
  2852. Normally used to make some text suitable for showing to humans, and the
  2853. resultant text should not normally be saved back into the document!
  2854. </member>
  2855. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.Center">
  2856. get the text representing the center part of this element
  2857. </member>
  2858. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.Left">
  2859. get the text representing the left part of this element
  2860. </member>
  2861. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.Right">
  2862. get the text representing the right part of this element
  2863. </member>
  2864. <member name="T:NPOI.XSSF.UserModel.Helpers.ColumnHelper">
  2865. Helper class for dealing with the Column Settings on
  2866. a CT_Worksheet (the data part of a sheet).
  2867. Note - within POI, we use 0 based column indexes, but
  2868. the column defInitions in the XML are 1 based!
  2869. </member>
  2870. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.GetColumn(System.Int64,System.Boolean)">
  2871. Returns the Column at the given 0 based index
  2872. </member>
  2873. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.GetColumn1Based(System.Int64,System.Boolean)">
  2874. Returns the Column at the given 1 based index.
  2875. POI default is 0 based, but the file stores
  2876. as 1 based.
  2877. </member>
  2878. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.TreeSet`1.TailSet(`0,System.Boolean)">
  2879. <summary>
  2880. Returns a view of the portion of this map whose keys are greater than (or
  2881. equal to, if inclusive is true) fromKey.
  2882. </summary>
  2883. <param name="fromElement"></param>
  2884. <param name="inclusive"></param>
  2885. <returns></returns>
  2886. </member>
  2887. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.SweepCleanColumns(NPOI.OpenXmlFormats.Spreadsheet.CT_Cols,NPOI.OpenXmlFormats.Spreadsheet.CT_Col[],NPOI.OpenXmlFormats.Spreadsheet.CT_Col)">
  2888. @see <a href="http://en.wikipedia.org/wiki/Sweep_line_algorithm">Sweep line algorithm</a>
  2889. </member>
  2890. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.ColumnExists(NPOI.OpenXmlFormats.Spreadsheet.CT_Cols,System.Int64)">
  2891. Does the column at the given 0 based index exist
  2892. in the supplied list of column defInitions?
  2893. </member>
  2894. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.GetOrCreateColumn1Based(System.Int64,System.Boolean)">
  2895. Return the CT_Col at the given (0 based) column index,
  2896. creating it if required.
  2897. </member>
  2898. <member name="M:NPOI.XSSF.UserModel.Helpers.HeaderFooterHelper.GetParts(System.String)">
  2899. Split into left, center, right
  2900. </member>
  2901. <member name="T:NPOI.XSSF.UserModel.Helpers.XSSFFormulaUtils">
  2902. Utility to update formulas and named ranges when a sheet name was Changed
  2903. @author Yegor Kozlov
  2904. </member>
  2905. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFFormulaUtils.UpdateSheetName(System.Int32,System.String,System.String)">
  2906. Update sheet name in all formulas and named ranges.
  2907. Called from {@link XSSFWorkbook#setSheetName(int, String)}
  2908. <p/>
  2909. <p>
  2910. The idea is to parse every formula and render it back to string
  2911. with the updated sheet name. This is done by parsing into Ptgs,
  2912. looking for ones with sheet references in them, and changing those
  2913. </p>
  2914. @param sheetIndex the 0-based index of the sheet being changed
  2915. @param oldName the old sheet name
  2916. @param newName the new sheet name
  2917. </member>
  2918. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFFormulaUtils.UpdateFormula(NPOI.XSSF.UserModel.XSSFCell,System.String,System.String)">
  2919. Parse cell formula and re-assemble it back using the specified FormulaRenderingWorkbook.
  2920. @param cell the cell to update
  2921. @param frwb the formula rendering workbbok that returns new sheet name
  2922. </member>
  2923. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFFormulaUtils.UpdateName(NPOI.SS.UserModel.IName,System.String,System.String)">
  2924. Parse formula in the named range and re-assemble it back using the specified FormulaRenderingWorkbook.
  2925. @param name the name to update
  2926. @param frwb the formula rendering workbbok that returns new sheet name
  2927. </member>
  2928. <member name="T:NPOI.XSSF.UserModel.Helpers.XSSFIgnoredErrorHelper">
  2929. XSSF-specific code for working with ignored errors
  2930. </member>
  2931. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFPasswordHelper.SetPassword(System.Xml.XmlNode,System.String,NPOI.POIFS.Crypt.HashAlgorithm,System.String)">
  2932. Sets the XORed or hashed password
  2933. @param xobj the xmlbeans object which Contains the password attributes
  2934. @param password the password, if null, the password attributes will be Removed
  2935. @param hashAlgo the hash algorithm, if null the password will be XORed
  2936. @param prefix the prefix of the password attributes, may be null
  2937. </member>
  2938. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFPasswordHelper.ValidatePassword(System.Xml.XmlNode,System.String,System.String)">
  2939. Validates the password, i.e.
  2940. calculates the hash of the given password and Compares it against the stored hash
  2941. @param xobj the xmlbeans object which Contains the password attributes
  2942. @param password the password, if null the method will always return false,
  2943. even if there's no password Set
  2944. @param prefix the prefix of the password attributes, may be null
  2945. @return true, if the hashes match
  2946. </member>
  2947. <member name="T:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter">
  2948. @author Yegor Kozlov
  2949. </member>
  2950. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.ShiftMerged(System.Int32,System.Int32,System.Int32)">
  2951. Shift merged regions
  2952. @param startRow the row to start Shifting
  2953. @param endRow the row to end Shifting
  2954. @param n the number of rows to shift
  2955. @return an array of affected cell regions
  2956. </member>
  2957. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.UpdateNamedRanges(NPOI.SS.Formula.FormulaShifter)">
  2958. Updated named ranges
  2959. </member>
  2960. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.UpdateFormulas(NPOI.SS.Formula.FormulaShifter)">
  2961. Update formulas.
  2962. </member>
  2963. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.UpdateRowFormulas(NPOI.SS.UserModel.IRow,NPOI.SS.Formula.FormulaShifter)">
  2964. <summary>
  2965. Update the formulas in specified row using the formula shifting policy specified by shifter
  2966. </summary>
  2967. <param name="row">the row to update the formulas on</param>
  2968. <param name="Shifter">the formula shifting policy</param>
  2969. </member>
  2970. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.ShiftFormula(NPOI.SS.UserModel.IRow,System.String,NPOI.SS.Formula.FormulaShifter)">
  2971. Shift a formula using the supplied FormulaShifter
  2972. @param row the row of the cell this formula belongs to. Used to get a reference to the parent workbook.
  2973. @param formula the formula to shift
  2974. @param Shifter the FormulaShifter object that operates on the Parsed formula tokens
  2975. @return the Shifted formula if the formula was Changed,
  2976. <code>null</code> if the formula wasn't modified
  2977. </member>
  2978. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.UpdateHyperlinks(NPOI.SS.Formula.FormulaShifter)">
  2979. Shift the Hyperlink anchors (not the hyperlink text, even if the hyperlink
  2980. is of type LINK_DOCUMENT and refers to a cell that was shifted). Hyperlinks
  2981. do not track the content they point to.
  2982. @param shifter
  2983. </member>
  2984. <member name="T:NPOI.XSSF.UserModel.Helpers.XSSFSingleXmlCell">
  2985. *
  2986. * This class is a wrapper around the CTSingleXmlCell (Open Office XML Part 4:
  2987. * chapter 3.5.2.1)
  2988. *
  2989. *
  2990. * @author Roberto Manicardi
  2991. *
  2992. </member>
  2993. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFSingleXmlCell.GetReferencedCell">
  2994. Gets the XSSFCell referenced by the R attribute or Creates a new one if cell doesn't exists
  2995. @return the referenced XSSFCell, null if the cell reference is invalid
  2996. </member>
  2997. <member name="T:NPOI.XSSF.UserModel.Helpers.XSSFXmlColumnPr">
  2998. This class is a wrapper around the CT_XmlColumnPr (Open Office XML Part 4:
  2999. chapter 3.5.1.7)
  3000. @author Roberto Manicardi
  3001. </member>
  3002. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFXmlColumnPr.GetId">
  3003. (see Open Office XML Part 4: chapter 3.5.1.3)
  3004. @return An integer representing the unique identifier of this column.
  3005. </member>
  3006. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFXmlColumnPr.GetLocalXPath">
  3007. If the XPath is, for example, /Node1/Node2/Node3 and /Node1/Node2 is the common XPath for the table, the local XPath is /Node3
  3008. @return the local XPath
  3009. </member>
  3010. <member name="T:NPOI.XSSF.UserModel.ListAutoNumber">
  3011. Specifies type of automatic numbered bullet points that should be applied to a paragraph.
  3012. </member>
  3013. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ALPHA_LC_PARENT_BOTH">
  3014. (a), (b), (c), ...
  3015. </member>
  3016. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ALPHA_UC_PARENT_BOTH">
  3017. (A), (B), (C), ...
  3018. </member>
  3019. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ALPHA_LC_PARENT_R">
  3020. a), b), c), ...
  3021. </member>
  3022. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ALPHA_UC_PARENT_R">
  3023. A), B), C), ...
  3024. </member>
  3025. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ALPHA_LC_PERIOD">
  3026. a., b., c., ...
  3027. </member>
  3028. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ALPHA_UC_PERIOD">
  3029. A., B., C., ...
  3030. </member>
  3031. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ARABIC_PARENT_BOTH">
  3032. (1), (2), (3), ...
  3033. </member>
  3034. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ARABIC_PARENT_R">
  3035. 1), 2), 3), ...
  3036. </member>
  3037. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ARABIC_PERIOD">
  3038. 1., 2., 3., ...
  3039. </member>
  3040. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ARABIC_PLAIN">
  3041. 1, 2, 3, ...
  3042. </member>
  3043. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ROMAN_LC_PARENT_BOTH">
  3044. (i), (ii), (iii), ...
  3045. </member>
  3046. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ROMAN_UC_PARENT_BOTH">
  3047. (I), (II), (III), ...
  3048. </member>
  3049. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ROMAN_LC_PARENT_R">
  3050. i), ii), iii), ...
  3051. </member>
  3052. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ROMAN_UC_PARENT_R">
  3053. I), II), III), ...
  3054. </member>
  3055. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ROMAN_LC_PERIOD">
  3056. i., ii., iii., ...
  3057. </member>
  3058. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ROMAN_UC_PERIOD">
  3059. I., II., III., ...
  3060. </member>
  3061. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.CIRCLE_NUM_DB_PLAIN">
  3062. Dbl-byte circle numbers
  3063. </member>
  3064. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.CIRCLE_NUM_WD_BLACK_PLAIN">
  3065. Wingdings black circle numbers
  3066. </member>
  3067. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.CIRCLE_NUM_WD_WHITE_PLAIN">
  3068. Wingdings white circle numbers
  3069. </member>
  3070. <member name="T:NPOI.XSSF.UserModel.TextAlign">
  3071. Specified a list of text alignment types
  3072. </member>
  3073. <member name="F:NPOI.XSSF.UserModel.TextAlign.LEFT">
  3074. Align text to the left margin.
  3075. </member>
  3076. <member name="F:NPOI.XSSF.UserModel.TextAlign.CENTER">
  3077. Align text in the center.
  3078. </member>
  3079. <member name="F:NPOI.XSSF.UserModel.TextAlign.RIGHT">
  3080. Align text to the right margin.
  3081. </member>
  3082. <member name="F:NPOI.XSSF.UserModel.TextAlign.JUSTIFY">
  3083. Align text so that it is justified across the whole line. It
  3084. is smart in the sense that it will not justify sentences
  3085. which are short
  3086. </member>
  3087. <member name="T:NPOI.XSSF.UserModel.TextAutofit">
  3088. Specifies a list of auto-fit types.
  3089. <p>
  3090. Autofit specifies that a shape should be auto-fit to fully contain the text described within it.
  3091. Auto-fitting is when text within a shape is scaled in order to contain all the text inside
  3092. </p>
  3093. </member>
  3094. <member name="F:NPOI.XSSF.UserModel.TextAutofit.NONE">
  3095. Specifies that text within the text body should not be auto-fit to the bounding box.
  3096. Auto-fitting is when text within a text box is scaled in order to remain inside
  3097. the text box.
  3098. </member>
  3099. <member name="F:NPOI.XSSF.UserModel.TextAutofit.NORMAL">
  3100. Specifies that text within the text body should be normally auto-fit to the bounding box.
  3101. Autofitting is when text within a text box is scaled in order to remain inside the text box.
  3102. <p>
  3103. <em>Example:</em> Consider the situation where a user is building a diagram and needs
  3104. to have the text for each shape that they are using stay within the bounds of the shape.
  3105. An easy way this might be done is by using NORMAL autofit
  3106. </p>
  3107. </member>
  3108. <member name="F:NPOI.XSSF.UserModel.TextAutofit.SHAPE">
  3109. Specifies that a shape should be auto-fit to fully contain the text described within it.
  3110. Auto-fitting is when text within a shape is scaled in order to contain all the text inside.
  3111. <p>
  3112. <em>Example:</em> Consider the situation where a user is building a diagram and needs to have
  3113. the text for each shape that they are using stay within the bounds of the shape.
  3114. An easy way this might be done is by using SHAPE autofit
  3115. </p>
  3116. </member>
  3117. <member name="T:NPOI.XSSF.UserModel.TextCap">
  3118. Text Capitalization that is to be applied to the text Run. This is a render-only
  3119. modification and does not affect the actual characters stored in the text Run.
  3120. </member>
  3121. <member name="T:NPOI.XSSF.UserModel.TextDirection">
  3122. Vertical Text Types
  3123. </member>
  3124. <member name="F:NPOI.XSSF.UserModel.TextDirection.HORIZONTAL">
  3125. Horizontal text. This should be default.
  3126. </member>
  3127. <member name="F:NPOI.XSSF.UserModel.TextDirection.VERTICAL">
  3128. Vertical orientation.
  3129. (each line is 90 degrees rotated clockwise, so it goes
  3130. from top to bottom; each next line is to the left from
  3131. the previous one).
  3132. </member>
  3133. <member name="F:NPOI.XSSF.UserModel.TextDirection.VERTICAL_270">
  3134. Vertical orientation.
  3135. (each line is 270 degrees rotated clockwise, so it goes
  3136. from bottom to top; each next line is to the right from
  3137. the previous one).
  3138. </member>
  3139. <member name="F:NPOI.XSSF.UserModel.TextDirection.STACKED">
  3140. Determines if all of the text is vertical
  3141. ("one letter on top of another").
  3142. </member>
  3143. <member name="T:NPOI.XSSF.UserModel.TextFontAlign">
  3144. Specified a list of text font alignment types
  3145. </member>
  3146. <member name="F:NPOI.XSSF.UserModel.TextFontAlign.AUTO">
  3147. Automatic alignment
  3148. </member>
  3149. <member name="F:NPOI.XSSF.UserModel.TextFontAlign.TOP">
  3150. Align text to the top.
  3151. </member>
  3152. <member name="F:NPOI.XSSF.UserModel.TextFontAlign.CENTER">
  3153. Align text in the center.
  3154. </member>
  3155. <member name="F:NPOI.XSSF.UserModel.TextFontAlign.BASELINE">
  3156. Align text to the baseline.
  3157. </member>
  3158. <member name="F:NPOI.XSSF.UserModel.TextFontAlign.BOTTOM">
  3159. Align text to the bottom.
  3160. </member>
  3161. <member name="T:NPOI.XSSF.UserModel.TextHorizontalOverflow">
  3162. Text Horizontal Overflow
  3163. </member>
  3164. <member name="F:NPOI.XSSF.UserModel.TextHorizontalOverflow.OVERFLOW">
  3165. When a big character does not fit into a line, allow a
  3166. horizontal overflow.
  3167. </member>
  3168. <member name="F:NPOI.XSSF.UserModel.TextHorizontalOverflow.CLIP">
  3169. When a big character does not fit into a line, clip it at
  3170. the proper horizontal overflow.
  3171. </member>
  3172. <member name="T:NPOI.XSSF.UserModel.TextVerticalOverflow">
  3173. Text Vertical Overflow
  3174. </member>
  3175. <member name="F:NPOI.XSSF.UserModel.TextVerticalOverflow.OVERFLOW">
  3176. Overflow the text and pay no attention to top and bottom barriers.
  3177. </member>
  3178. <member name="F:NPOI.XSSF.UserModel.TextVerticalOverflow.ELLIPSIS">
  3179. Pay attention to top and bottom barriers. Use an
  3180. ellipsis to denote that there is text which is not visible.
  3181. </member>
  3182. <member name="F:NPOI.XSSF.UserModel.TextVerticalOverflow.CLIP">
  3183. Pay attention to top and bottom barriers. Provide no
  3184. indication that there is text which is not visible.
  3185. </member>
  3186. <member name="T:NPOI.XSSF.UserModel.XSSFAnchor">
  3187. An anchor is what specifics the position of a shape within a client object
  3188. or within another containing shape.
  3189. @author Yegor Kozlov
  3190. </member>
  3191. <member name="T:NPOI.XSSF.UserModel.XSSFAutoFilter">
  3192. Represents autofiltering for the specified worksheet.
  3193. @author Yegor Kozlov
  3194. </member>
  3195. <member name="T:NPOI.XSSF.UserModel.XSSFBorderFormatting">
  3196. @author Yegor Kozlov
  3197. </member>
  3198. <member name="T:NPOI.XSSF.UserModel.XSSFCell">
  3199. High level representation of a cell in a row of a spreadsheet.
  3200. <p>
  3201. Cells can be numeric, formula-based or string-based (text). The cell type
  3202. specifies this. String cells cannot conatin numbers and numeric cells cannot
  3203. contain strings (at least according to our model). Client apps should do the
  3204. conversions themselves. Formula cells have the formula string, as well as
  3205. the formula result, which can be numeric or string.
  3206. </p>
  3207. <p>
  3208. Cells should have their number (0 based) before being Added to a row. Only
  3209. cells that have values should be Added.
  3210. </p>
  3211. </member>
  3212. <member name="F:NPOI.XSSF.UserModel.XSSFCell._cell">
  3213. the xml bean Containing information about the cell's location, value,
  3214. data type, formatting, and formula
  3215. </member>
  3216. <member name="F:NPOI.XSSF.UserModel.XSSFCell._row">
  3217. the XSSFRow this cell belongs to
  3218. </member>
  3219. <member name="F:NPOI.XSSF.UserModel.XSSFCell._cellNum">
  3220. 0-based column index
  3221. </member>
  3222. <member name="F:NPOI.XSSF.UserModel.XSSFCell._sharedStringSource">
  3223. Table of strings shared across this workbook.
  3224. If two cells contain the same string, then the cell value is the same index into SharedStringsTable
  3225. </member>
  3226. <member name="F:NPOI.XSSF.UserModel.XSSFCell._stylesSource">
  3227. Table of cell styles shared across all cells in a workbook.
  3228. </member>
  3229. <member name="M:NPOI.XSSF.UserModel.XSSFCell.#ctor(NPOI.XSSF.UserModel.XSSFRow,NPOI.OpenXmlFormats.Spreadsheet.CT_Cell)">
  3230. Construct a XSSFCell.
  3231. @param row the parent row.
  3232. @param cell the xml bean Containing information about the cell.
  3233. </member>
  3234. <member name="M:NPOI.XSSF.UserModel.XSSFCell.CopyCellFrom(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.CellCopyPolicy)">
  3235. <summary>
  3236. Copy cell value, formula and style, from srcCell per cell copy policy
  3237. If srcCell is null, clears the cell value and cell style per cell copy policy
  3238. This does not shift references in formulas. Use {@link XSSFRowShifter} to shift references in formulas.
  3239. </summary>
  3240. <param name="srcCell">The cell to take value, formula and style from</param>
  3241. <param name="policy">The policy for copying the information, see {@link CellCopyPolicy}</param>
  3242. <exception cref="T:System.ArgumentException">if copy cell style and srcCell is from a different workbook</exception>
  3243. </member>
  3244. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetSharedStringSource">
  3245. @return table of strings shared across this workbook
  3246. </member>
  3247. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetStylesSource">
  3248. @return table of cell styles shared across this workbook
  3249. </member>
  3250. <member name="P:NPOI.XSSF.UserModel.XSSFCell.Sheet">
  3251. Returns the sheet this cell belongs to
  3252. @return the sheet this cell belongs to
  3253. </member>
  3254. <member name="P:NPOI.XSSF.UserModel.XSSFCell.Row">
  3255. Returns the row this cell belongs to
  3256. @return the row this cell belongs to
  3257. </member>
  3258. <member name="P:NPOI.XSSF.UserModel.XSSFCell.BooleanCellValue">
  3259. Get the value of the cell as a bool.
  3260. <p>
  3261. For strings, numbers, and errors, we throw an exception. For blank cells we return a false.
  3262. </p>
  3263. @return the value of the cell as a bool
  3264. @throws InvalidOperationException if the cell type returned by {@link #CellType}
  3265. is not CellType.Boolean, CellType.Blank or CellType.Formula
  3266. </member>
  3267. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(System.Boolean)">
  3268. Set a bool value for the cell
  3269. @param value the bool value to Set this cell to. For formulas we'll Set the
  3270. precalculated value, for bools we'll Set its value. For other types we
  3271. will change the cell to a bool cell and Set its value.
  3272. </member>
  3273. <member name="P:NPOI.XSSF.UserModel.XSSFCell.NumericCellValue">
  3274. Get the value of the cell as a number.
  3275. <p>
  3276. For strings we throw an exception. For blank cells we return a 0.
  3277. For formulas or error cells we return the precalculated value;
  3278. </p>
  3279. @return the value of the cell as a number
  3280. @throws InvalidOperationException if the cell type returned by {@link #CellType} is CellType.String
  3281. @exception NumberFormatException if the cell value isn't a parsable <code>double</code>.
  3282. @see DataFormatter for turning this number into a string similar to that which Excel would render this number as.
  3283. </member>
  3284. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(System.Double)">
  3285. Set a numeric value for the cell
  3286. @param value the numeric value to Set this cell to. For formulas we'll Set the
  3287. precalculated value, for numerics we'll Set its value. For other types we
  3288. will change the cell to a numeric cell and Set its value.
  3289. </member>
  3290. <member name="P:NPOI.XSSF.UserModel.XSSFCell.StringCellValue">
  3291. Get the value of the cell as a string
  3292. <p>
  3293. For numeric cells we throw an exception. For blank cells we return an empty string.
  3294. For formulaCells that are not string Formulas, we throw an exception
  3295. </p>
  3296. @return the value of the cell as a string
  3297. </member>
  3298. <member name="P:NPOI.XSSF.UserModel.XSSFCell.RichStringCellValue">
  3299. Get the value of the cell as a XSSFRichTextString
  3300. <p>
  3301. For numeric cells we throw an exception. For blank cells we return an empty string.
  3302. For formula cells we return the pre-calculated value if a string, otherwise an exception
  3303. </p>
  3304. @return the value of the cell as a XSSFRichTextString
  3305. </member>
  3306. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(System.String)">
  3307. Set a string value for the cell.
  3308. @param str value to Set the cell to. For formulas we'll Set the formula
  3309. cached string result, for String cells we'll Set its value. For other types we will
  3310. change the cell to a string cell and Set its value.
  3311. If value is null then we will change the cell to a Blank cell.
  3312. </member>
  3313. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(NPOI.SS.UserModel.IRichTextString)">
  3314. Set a string value for the cell.
  3315. @param str value to Set the cell to. For formulas we'll Set the 'pre-Evaluated result string,
  3316. for String cells we'll Set its value. For other types we will
  3317. change the cell to a string cell and Set its value.
  3318. If value is null then we will change the cell to a Blank cell.
  3319. </member>
  3320. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CellFormula">
  3321. <summary>
  3322. Return a formula for the cell, for example, <code>SUM(C4:E4)</code>
  3323. </summary>
  3324. </member>
  3325. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetCellFormula(NPOI.XSSF.UserModel.XSSFEvaluationWorkbook)">
  3326. package/hierarchy use only - reuse an existing evaluation workbook if available for caching
  3327. @param fpb evaluation workbook for reuse, if available, or null to create a new one as needed
  3328. @return a formula for the cell
  3329. @throws InvalidOperationException if the cell type returned by {@link #getCellType()} is not CELL_TYPE_FORMULA
  3330. </member>
  3331. <member name="M:NPOI.XSSF.UserModel.XSSFCell.ConvertSharedFormula(System.Int32,NPOI.XSSF.UserModel.XSSFEvaluationWorkbook)">
  3332. <summary>
  3333. Creates a non shared formula from the shared formula counterpart
  3334. </summary>
  3335. <param name="si">Shared Group Index</param>
  3336. <param name="fpb"></param>
  3337. <returns>non shared formula created for the given shared formula and this cell</returns>
  3338. </member>
  3339. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellFormula(System.String)">
  3340. Sets formula for this cell.
  3341. <p>
  3342. Note, this method only Sets the formula string and does not calculate the formula value.
  3343. To Set the precalculated value use {@link #setCellValue(double)} or {@link #setCellValue(String)}
  3344. </p>
  3345. @param formula the formula to Set, e.g. <code>"SUM(C4:E4)"</code>.
  3346. If the argument is <code>null</code> then the current formula is Removed.
  3347. @throws NPOI.ss.formula.FormulaParseException if the formula has incorrect syntax or is otherwise invalid
  3348. @throws InvalidOperationException if the operation is not allowed, for example,
  3349. when the cell is a part of a multi-cell array formula
  3350. </member>
  3351. <member name="P:NPOI.XSSF.UserModel.XSSFCell.ColumnIndex">
  3352. <summary>
  3353. Returns zero-based column index of this cell
  3354. </summary>
  3355. </member>
  3356. <member name="P:NPOI.XSSF.UserModel.XSSFCell.RowIndex">
  3357. <summary>
  3358. Returns zero-based row index of a row in the sheet that contains this cell
  3359. </summary>
  3360. </member>
  3361. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetReference">
  3362. <summary>
  3363. Returns an A1 style reference to the location of this cell
  3364. </summary>
  3365. <returns>A1 style reference to the location of this cell</returns>
  3366. </member>
  3367. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CellStyle">
  3368. <summary>
  3369. Return the cell's style.
  3370. </summary>
  3371. </member>
  3372. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CellType">
  3373. <summary>
  3374. Return the cell type.
  3375. </summary>
  3376. </member>
  3377. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CachedFormulaResultType">
  3378. <summary>
  3379. Only valid for formula cells
  3380. </summary>
  3381. </member>
  3382. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetBaseCellType(System.Boolean)">
  3383. <summary>
  3384. Detect cell type based on the "t" attribute of the CT_Cell bean
  3385. </summary>
  3386. <param name="blankCells"></param>
  3387. <returns></returns>
  3388. </member>
  3389. <member name="P:NPOI.XSSF.UserModel.XSSFCell.DateCellValue">
  3390. <summary>
  3391. Get the value of the cell as a date.
  3392. </summary>
  3393. </member>
  3394. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(System.DateTime)">
  3395. <summary>
  3396. Set a date value for the cell. Excel treats dates as numeric so you will need to format the cell as a date.
  3397. </summary>
  3398. <param name="value">the date value to Set this cell to. For formulas we'll set the precalculated value,
  3399. for numerics we'll Set its value. For other types we will change the cell to a numeric cell and Set its value. </param>
  3400. </member>
  3401. <member name="P:NPOI.XSSF.UserModel.XSSFCell.ErrorCellString">
  3402. <summary>
  3403. Returns the error message, such as #VALUE!
  3404. </summary>
  3405. </member>
  3406. <member name="P:NPOI.XSSF.UserModel.XSSFCell.ErrorCellValue">
  3407. <summary>
  3408. Get the value of the cell as an error code.
  3409. For strings, numbers, and bools, we throw an exception.
  3410. For blank cells we return a 0.
  3411. </summary>
  3412. </member>
  3413. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellErrorValue(NPOI.SS.UserModel.FormulaError)">
  3414. <summary>
  3415. Set a error value for the cell
  3416. </summary>
  3417. <param name="error">the error value to Set this cell to.
  3418. For formulas we'll Set the precalculated value , for errors we'll set
  3419. its value. For other types we will change the cell to an error cell and Set its value.
  3420. </param>
  3421. </member>
  3422. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetAsActiveCell">
  3423. <summary>
  3424. Sets this cell as the active cell for the worksheet.
  3425. </summary>
  3426. </member>
  3427. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetBlankInternal">
  3428. <summary>
  3429. Blanks this cell. Blank cells have no formula or value but may have styling.
  3430. This method erases all the data previously associated with this cell.
  3431. </summary>
  3432. </member>
  3433. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellNum(System.Int32)">
  3434. <summary>
  3435. Sets column index of this cell
  3436. </summary>
  3437. <param name="num"></param>
  3438. </member>
  3439. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellType(NPOI.SS.UserModel.CellType)">
  3440. <summary>
  3441. Set the cells type (numeric, formula or string)
  3442. </summary>
  3443. <param name="cellType"></param>
  3444. </member>
  3445. <member name="M:NPOI.XSSF.UserModel.XSSFCell.ToString">
  3446. <summary>
  3447. Returns a string representation of the cell
  3448. </summary>
  3449. <returns>Formula cells return the formula string, rather than the formula result.
  3450. Dates are displayed in dd-MMM-yyyy format
  3451. Errors are displayed as #ERR&lt;errIdx&gt;
  3452. </returns>
  3453. </member>
  3454. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetRawValue">
  3455. Returns the raw, underlying ooxml value for the cell
  3456. <p>
  3457. If the cell Contains a string, then this value is an index into
  3458. the shared string table, pointing to the actual string value. Otherwise,
  3459. the value of the cell is expressed directly in this element. Cells Containing formulas express
  3460. the last calculated result of the formula in this element.
  3461. </p>
  3462. @return the raw cell value as Contained in the underlying CT_Cell bean,
  3463. <code>null</code> for blank cells.
  3464. </member>
  3465. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetCellTypeName(NPOI.SS.UserModel.CellType)">
  3466. <summary>
  3467. Used to help format error messages
  3468. </summary>
  3469. <param name="cellTypeCode"></param>
  3470. <returns></returns>
  3471. </member>
  3472. <member name="M:NPOI.XSSF.UserModel.XSSFCell.TypeMismatch(NPOI.SS.UserModel.CellType,NPOI.SS.UserModel.CellType,System.Boolean)">
  3473. Used to help format error messages
  3474. </member>
  3475. <member name="M:NPOI.XSSF.UserModel.XSSFCell.CheckBounds(System.Int32)">
  3476. @throws RuntimeException if the bounds are exceeded.
  3477. </member>
  3478. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CellComment">
  3479. <summary>
  3480. Returns cell comment associated with this cell
  3481. </summary>
  3482. </member>
  3483. <member name="M:NPOI.XSSF.UserModel.XSSFCell.RemoveCellComment">
  3484. <summary>
  3485. Removes the comment for this cell, if there is one.
  3486. </summary>
  3487. </member>
  3488. <member name="P:NPOI.XSSF.UserModel.XSSFCell.Hyperlink">
  3489. <summary>
  3490. Get or set hyperlink associated with this cell
  3491. If the supplied hyperlink is null on setting, the hyperlink for this cell will be removed.
  3492. </summary>
  3493. </member>
  3494. <member name="M:NPOI.XSSF.UserModel.XSSFCell.RemoveHyperlink">
  3495. Removes the hyperlink for this cell, if there is one.
  3496. </member>
  3497. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetCTCell">
  3498. Returns the xml bean containing information about the cell's location (reference), value,
  3499. data type, formatting, and formula
  3500. @return the xml bean containing information about this cell
  3501. </member>
  3502. <member name="M:NPOI.XSSF.UserModel.XSSFCell.ConvertCellValueToBoolean">
  3503. Chooses a new bool value for the cell when its type is changing.<p/>
  3504. Usually the caller is calling SetCellType() with the intention of calling
  3505. SetCellValue(bool) straight afterwards. This method only exists to give
  3506. the cell a somewhat reasonable value until the SetCellValue() call (if at all).
  3507. TODO - perhaps a method like SetCellTypeAndValue(int, Object) should be introduced to avoid this
  3508. </member>
  3509. <member name="M:NPOI.XSSF.UserModel.XSSFCell.NotifyArrayFormulaChanging(System.String)">
  3510. The purpose of this method is to validate the cell state prior to modification
  3511. @see #NotifyArrayFormulaChanging()
  3512. </member>
  3513. <member name="M:NPOI.XSSF.UserModel.XSSFCell.NotifyArrayFormulaChanging">
  3514. <summary>
  3515. Called when this cell is modified.The purpose of this method is to validate the cell state prior to modification.
  3516. </summary>
  3517. <exception cref="T:System.InvalidOperationException">if modification is not allowed</exception>
  3518. </member>
  3519. <member name="T:NPOI.XSSF.UserModel.XSSFCellStyle">
  3520. High level representation of the the possible formatting information for the contents of the cells on a sheet in a
  3521. SpreadsheetML document.
  3522. @see NPOI.xssf.usermodel.XSSFWorkbook#CreateCellStyle()
  3523. @see NPOI.xssf.usermodel.XSSFWorkbook#getCellStyleAt(short)
  3524. @see NPOI.xssf.usermodel.XSSFCell#setCellStyle(NPOI.ss.usermodel.CellStyle)
  3525. </member>
  3526. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.#ctor(System.Int32,System.Int32,NPOI.XSSF.Model.StylesTable,NPOI.XSSF.Model.ThemesTable)">
  3527. Creates a Cell Style from the supplied parts
  3528. @param cellXfId The main XF for the cell. Must be a valid 0-based index into the XF table
  3529. @param cellStyleXfId Optional, style xf. A value of <code>-1</code> means no xf.
  3530. @param stylesSource Styles Source to work off
  3531. </member>
  3532. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCoreXf">
  3533. Used so that StylesSource can figure out our location
  3534. </member>
  3535. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetStyleXf">
  3536. Used so that StylesSource can figure out our location
  3537. </member>
  3538. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.#ctor(NPOI.XSSF.Model.StylesTable)">
  3539. <summary>
  3540. Creates an empty Cell Style
  3541. </summary>
  3542. <param name="stylesSource"></param>
  3543. </member>
  3544. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.VerifyBelongsToStylesSource(NPOI.XSSF.Model.StylesTable)">
  3545. Verifies that this style belongs to the supplied Workbook
  3546. Styles Source.
  3547. Will throw an exception if it belongs to a different one.
  3548. This is normally called when trying to assign a style to a
  3549. cell, to ensure the cell and the style are from the same
  3550. workbook (if they're not, it won't work)
  3551. @throws ArgumentException if there's a workbook mis-match
  3552. </member>
  3553. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.CloneStyleFrom(NPOI.SS.UserModel.ICellStyle)">
  3554. Clones all the style information from another
  3555. XSSFCellStyle, onto this one. This
  3556. XSSFCellStyle will then have all the same
  3557. properties as the source, but the two may
  3558. be edited independently.
  3559. Any stylings on this XSSFCellStyle will be lost!
  3560. The source XSSFCellStyle could be from another
  3561. XSSFWorkbook if you like. This allows you to
  3562. copy styles from one XSSFWorkbook to another.
  3563. </member>
  3564. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetAlignmentEnum">
  3565. <summary>
  3566. Get the type of horizontal alignment for the cell
  3567. </summary>
  3568. <returns>the type of alignment</returns>
  3569. </member>
  3570. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.BorderBottom">
  3571. <summary>
  3572. Get or set the type of border to use for the bottom border of the cell
  3573. </summary>
  3574. </member>
  3575. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.BorderLeft">
  3576. <summary>
  3577. Get or set the type of border to use for the left border of the cell
  3578. </summary>
  3579. </member>
  3580. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.BorderRight">
  3581. <summary>
  3582. Get or set the type of border to use for the right border of the cell
  3583. </summary>
  3584. </member>
  3585. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.BorderTop">
  3586. <summary>
  3587. Get or set the type of border to use for the top border of the cell
  3588. </summary>
  3589. </member>
  3590. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.BottomBorderColor">
  3591. Get the color to use for the bottom border
  3592. Color is optional. When missing, IndexedColors.Automatic is implied.
  3593. @return the index of the color defInition, default value is {@link NPOI.ss.usermodel.IndexedColors#AUTOMATIC}
  3594. @see NPOI.ss.usermodel.IndexedColors
  3595. </member>
  3596. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.BottomBorderXSSFColor">
  3597. Get the color to use for the bottom border as a {@link XSSFColor}
  3598. @return the used color or <code>null</code> if not Set
  3599. </member>
  3600. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.DataFormat">
  3601. Get the index of the number format (numFmt) record used by this cell format.
  3602. @return the index of the number format
  3603. </member>
  3604. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetDataFormat(System.Int32)">
  3605. Set the index of a data format
  3606. @param fmt the index of a data format
  3607. </member>
  3608. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetDataFormatString">
  3609. Get the contents of the format string, by looking up
  3610. the StylesSource
  3611. @return the number format string
  3612. </member>
  3613. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillBackgroundColor">
  3614. <summary>
  3615. Get the background fill color.
  3616. Note - many cells are actually filled with a foreground fill, not a background fill
  3617. </summary>
  3618. </member>
  3619. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillBackgroundColorColor">
  3620. Get the background fill color.
  3621. <p>
  3622. Note - many cells are actually Filled with a foreground
  3623. Fill, not a background fill - see {@link #getFillForegroundColor()}
  3624. </p>
  3625. @see NPOI.xssf.usermodel.XSSFColor#getRgb()
  3626. @return XSSFColor - fill color or <code>null</code> if not Set
  3627. </member>
  3628. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillForegroundColor">
  3629. Get the foreground fill color.
  3630. <p>
  3631. Many cells are Filled with this, instead of a
  3632. background color ({@link #getFillBackgroundColor()})
  3633. </p>
  3634. @see IndexedColors
  3635. @return fill color, default value is {@link NPOI.ss.usermodel.IndexedColors#AUTOMATIC}
  3636. </member>
  3637. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillForegroundColorColor">
  3638. <summary>
  3639. Get the foreground fill color.
  3640. </summary>
  3641. </member>
  3642. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillForegroundXSSFColor">
  3643. <summary>
  3644. Get the foreground fill color.
  3645. </summary>
  3646. </member>
  3647. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetFont">
  3648. Gets the font for this style
  3649. @return Font - font
  3650. </member>
  3651. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FontIndex">
  3652. Gets the index of the font for this style
  3653. @return short - font index
  3654. @see NPOI.xssf.usermodel.XSSFWorkbook#getFontAt(short)
  3655. </member>
  3656. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.IsHidden">
  3657. Get whether the cell's using this style are to be hidden
  3658. @return bool - whether the cell using this style is hidden
  3659. </member>
  3660. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.Indention">
  3661. Get the number of spaces to indent the text in the cell
  3662. @return indent - number of spaces
  3663. </member>
  3664. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.Index">
  3665. Get the index within the StylesTable (sequence within the collection of CT_Xf elements)
  3666. @return unique index number of the underlying record this style represents
  3667. </member>
  3668. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.LeftBorderColor">
  3669. Get the color to use for the left border
  3670. @return the index of the color defInition, default value is {@link NPOI.ss.usermodel.IndexedColors#BLACK}
  3671. @see NPOI.ss.usermodel.IndexedColors
  3672. </member>
  3673. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.LeftBorderXSSFColor">
  3674. Get the color to use for the left border
  3675. @return the index of the color defInition or <code>null</code> if not Set
  3676. @see NPOI.ss.usermodel.IndexedColors
  3677. </member>
  3678. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.IsLocked">
  3679. <summary>
  3680. Get whether the cell's using this style are locked
  3681. </summary>
  3682. </member>
  3683. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.RightBorderColor">
  3684. <summary>
  3685. Get the color to use for the right border
  3686. </summary>
  3687. </member>
  3688. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.RightBorderXSSFColor">
  3689. <summary>
  3690. Get the color to use for the right border
  3691. </summary>
  3692. <returns></returns>
  3693. </member>
  3694. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.Rotation">
  3695. <summary>
  3696. Get the degree of rotation (between 0 and 180 degrees) for the text in the cell
  3697. Note: HSSF uses values from -90 to 90 degrees, whereas XSSF
  3698. uses values from 0 to 180 degrees.The implementations of this method will map between these two value-ranges
  3699. accordingly, however the corresponding getter is returning values in the range mandated by the current type
  3700. of Excel file-format that this CellStyle is applied to.
  3701. </summary>
  3702. <example>
  3703. Expressed in degrees. Values range from 0 to 180. The first letter of
  3704. the text is considered the center-point of the arc.
  3705. For 0 - 90, the value represents degrees above horizon. For 91-180 the degrees below the horizon is calculated as:
  3706. <code>[degrees below horizon] = 90 - textRotation.</code>
  3707. </example>
  3708. </member>
  3709. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.TopBorderColor">
  3710. Get the color to use for the top border
  3711. @return the index of the color defInition, default value is {@link NPOI.ss.usermodel.IndexedColors#BLACK}
  3712. @see NPOI.ss.usermodel.IndexedColors
  3713. </member>
  3714. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.TopBorderXSSFColor">
  3715. <summary>
  3716. Get the color to use for the top border
  3717. </summary>
  3718. <returns></returns>
  3719. </member>
  3720. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.VerticalAlignment">
  3721. <summary>
  3722. Get the type of vertical alignment for the cell
  3723. </summary>
  3724. </member>
  3725. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetVerticalAlignmentEnum">
  3726. <summary>
  3727. Get the type of vertical alignment for the cell
  3728. </summary>
  3729. <returns></returns>
  3730. </member>
  3731. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.WrapText">
  3732. <summary>
  3733. Whether the text in a cell should be line-wrapped within the cell.
  3734. </summary>
  3735. </member>
  3736. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetBottomBorderColor(NPOI.XSSF.UserModel.XSSFColor)">
  3737. Set the color to use for the bottom border
  3738. @param color the color to use, null means no color
  3739. </member>
  3740. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFCellStyle.SetFillBackgroundColor(NPOI.XSSF.UserModel.XSSFColor)" -->
  3741. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetFillForegroundColor(NPOI.XSSF.UserModel.XSSFColor)">
  3742. * Set the foreground fill color represented as a {@link XSSFColor} value.
  3743. * <br/>
  3744. * <i>Note: Ensure Foreground color is Set prior to background color.</i>
  3745. * @param color the color to use
  3746. * @see #setFillBackgroundColor(NPOI.xssf.usermodel.XSSFColor) )
  3747. </member>
  3748. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCTFill">
  3749. Get a <b>copy</b> of the currently used CT_Fill, if none is used, return a new instance.
  3750. </member>
  3751. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCTBorder(System.Boolean)">
  3752. Get a <b>copy</b> of the currently used CT_Border, if none is used, return a new instance.
  3753. </member>
  3754. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetFont(NPOI.SS.UserModel.IFont)">
  3755. Set the font for this style
  3756. @param font a font object Created or retrieved from the XSSFWorkbook object
  3757. @see NPOI.xssf.usermodel.XSSFWorkbook#CreateFont()
  3758. @see NPOI.xssf.usermodel.XSSFWorkbook#getFontAt(short)
  3759. </member>
  3760. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetLeftBorderColor(NPOI.XSSF.UserModel.XSSFColor)">
  3761. Set the color to use for the left border as a {@link XSSFColor} value
  3762. @param color the color to use
  3763. </member>
  3764. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetRightBorderColor(NPOI.XSSF.UserModel.XSSFColor)">
  3765. Set the color to use for the right border as a {@link XSSFColor} value
  3766. @param color the color to use
  3767. </member>
  3768. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetTopBorderColor(NPOI.XSSF.UserModel.XSSFColor)">
  3769. Set the color to use for the top border as a {@link XSSFColor} value
  3770. @param color the color to use
  3771. </member>
  3772. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetVerticalAlignment(System.Int16)">
  3773. Set the type of vertical alignment for the cell
  3774. @param align - align the type of alignment
  3775. @see NPOI.ss.usermodel.CellStyle#VERTICAL_TOP
  3776. @see NPOI.ss.usermodel.CellStyle#VERTICAL_CENTER
  3777. @see NPOI.ss.usermodel.CellStyle#VERTICAL_BOTTOM
  3778. @see NPOI.ss.usermodel.CellStyle#VERTICAL_JUSTIFY
  3779. @see NPOI.ss.usermodel.VerticalAlignment
  3780. </member>
  3781. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetBorderColor(NPOI.XSSF.UserModel.Extensions.BorderSide)">
  3782. Gets border color
  3783. @param side the border side
  3784. @return the used color
  3785. </member>
  3786. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetBorderColor(NPOI.XSSF.UserModel.Extensions.BorderSide,NPOI.XSSF.UserModel.XSSFColor)">
  3787. Set the color to use for the selected border
  3788. @param side - where to apply the color defInition
  3789. @param color - the color to use
  3790. </member>
  3791. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCellAlignment">
  3792. Get the cellAlignment object to use for manage alignment
  3793. @return XSSFCellAlignment - cell alignment
  3794. </member>
  3795. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCTCellAlignment">
  3796. Return the CT_CellAlignment instance for alignment
  3797. @return CT_CellAlignment
  3798. </member>
  3799. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetHashCode">
  3800. Returns a hash code value for the object. The hash is derived from the underlying CT_Xf bean.
  3801. @return the hash code value for this style
  3802. </member>
  3803. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.Equals(System.Object)">
  3804. Checks is the supplied style is equal to this style
  3805. @param o the style to check
  3806. @return true if the supplied style is equal to this style
  3807. </member>
  3808. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.Clone">
  3809. Make a copy of this style. The underlying CT_Xf bean is Cloned,
  3810. the references to Fills and borders remain.
  3811. @return a copy of this style
  3812. </member>
  3813. <member name="T:NPOI.XSSF.UserModel.XSSFChart">
  3814. Represents a SpreadsheetML Chart
  3815. @author Nick Burch
  3816. @author Roman Kashitsyn
  3817. </member>
  3818. <member name="F:NPOI.XSSF.UserModel.XSSFChart.frame">
  3819. Parent graphic frame.
  3820. </member>
  3821. <member name="F:NPOI.XSSF.UserModel.XSSFChart.chartSpaceDocument">
  3822. Root element of the SpreadsheetML Chart part
  3823. </member>
  3824. <member name="F:NPOI.XSSF.UserModel.XSSFChart.chart">
  3825. The Chart within that
  3826. </member>
  3827. <member name="M:NPOI.XSSF.UserModel.XSSFChart.#ctor">
  3828. Create a new SpreadsheetML chart
  3829. </member>
  3830. <member name="M:NPOI.XSSF.UserModel.XSSFChart.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  3831. Construct a SpreadsheetML chart from a namespace part.
  3832. @param part the namespace part holding the chart data,
  3833. the content type must be <code>application/vnd.Openxmlformats-officedocument.Drawingml.chart+xml</code>
  3834. @param rel the namespace relationship holding this chart,
  3835. the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/chart
  3836. </member>
  3837. <member name="M:NPOI.XSSF.UserModel.XSSFChart.CreateChart">
  3838. Construct a new CTChartSpace bean.
  3839. By default, it's just an empty placeholder for chart objects.
  3840. @return a new CTChartSpace bean
  3841. </member>
  3842. <member name="M:NPOI.XSSF.UserModel.XSSFChart.GetCTChartSpace">
  3843. <summary>
  3844. Return the underlying CTChartSpace bean, the root element of the SpreadsheetML Chart part.
  3845. </summary>
  3846. <returns></returns>
  3847. </member>
  3848. <member name="M:NPOI.XSSF.UserModel.XSSFChart.GetCTChart">
  3849. <summary>
  3850. Return the underlying CTChart bean, within the Chart Space
  3851. </summary>
  3852. <returns></returns>
  3853. </member>
  3854. <member name="M:NPOI.XSSF.UserModel.XSSFChart.GetGraphicFrame">
  3855. <summary>
  3856. Returns the parent graphic frame.
  3857. </summary>
  3858. <returns></returns>
  3859. </member>
  3860. <member name="M:NPOI.XSSF.UserModel.XSSFChart.SetGraphicFrame(NPOI.XSSF.UserModel.XSSFGraphicFrame)">
  3861. Sets the parent graphic frame.
  3862. </member>
  3863. <member name="M:NPOI.XSSF.UserModel.XSSFChart.IsPlotOnlyVisibleCells">
  3864. @return true if only visible cells will be present on the chart,
  3865. false otherwise
  3866. </member>
  3867. <member name="M:NPOI.XSSF.UserModel.XSSFChart.SetPlotOnlyVisibleCells(System.Boolean)">
  3868. @param plotVisOnly a flag specifying if only visible cells should be
  3869. present on the chart
  3870. </member>
  3871. <member name="P:NPOI.XSSF.UserModel.XSSFChart.Title">
  3872. Returns the title, or null if none is Set
  3873. </member>
  3874. <member name="M:NPOI.XSSF.UserModel.XSSFChart.SetTitle(System.String)">
  3875. Sets the title text.
  3876. </member>
  3877. <member name="T:NPOI.XSSF.UserModel.XSSFChartSheet">
  3878. High level representation of Sheet Parts that are of type 'chartsheet'.
  3879. <p>
  3880. Chart sheet is a special kind of Sheet that Contains only chart and no data.
  3881. </p>
  3882. @author Yegor Kozlov
  3883. </member>
  3884. <member name="M:NPOI.XSSF.UserModel.XSSFChartSheet.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  3885. @since POI 3.14-Beta1
  3886. </member>
  3887. <member name="M:NPOI.XSSF.UserModel.XSSFChartSheet.GetCTChartsheet">
  3888. Provide access to the CTChartsheet bean holding this sheet's data
  3889. @return the CTChartsheet bean holding this sheet's data
  3890. </member>
  3891. <member name="T:NPOI.XSSF.UserModel.XSSFClientAnchor">
  3892. A client anchor is attached to an excel worksheet. It anchors against
  3893. top-left and bottom-right cells.
  3894. @author Yegor Kozlov
  3895. </member>
  3896. <member name="F:NPOI.XSSF.UserModel.XSSFClientAnchor.cell1">
  3897. Starting anchor point
  3898. </member>
  3899. <member name="F:NPOI.XSSF.UserModel.XSSFClientAnchor.cell2">
  3900. Ending anchor point
  3901. </member>
  3902. <member name="M:NPOI.XSSF.UserModel.XSSFClientAnchor.#ctor">
  3903. Creates a new client anchor and defaults all the anchor positions to 0.
  3904. </member>
  3905. <member name="M:NPOI.XSSF.UserModel.XSSFClientAnchor.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  3906. Creates a new client anchor and Sets the top-left and bottom-right
  3907. coordinates of the anchor.
  3908. @param dx1 the x coordinate within the first cell.
  3909. @param dy1 the y coordinate within the first cell.
  3910. @param dx2 the x coordinate within the second cell.
  3911. @param dy2 the y coordinate within the second cell.
  3912. @param col1 the column (0 based) of the first cell.
  3913. @param row1 the row (0 based) of the first cell.
  3914. @param col2 the column (0 based) of the second cell.
  3915. @param row2 the row (0 based) of the second cell.
  3916. </member>
  3917. <member name="M:NPOI.XSSF.UserModel.XSSFClientAnchor.#ctor(NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Marker,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Marker)">
  3918. Create XSSFClientAnchor from existing xml beans
  3919. @param cell1 starting anchor point
  3920. @param cell2 ending anchor point
  3921. </member>
  3922. <member name="P:NPOI.XSSF.UserModel.XSSFClientAnchor.From">
  3923. Return starting anchor point
  3924. @return starting anchor point
  3925. </member>
  3926. <member name="P:NPOI.XSSF.UserModel.XSSFClientAnchor.To">
  3927. Return ending anchor point
  3928. @return ending anchor point
  3929. </member>
  3930. <member name="T:NPOI.XSSF.UserModel.XSSFColor">
  3931. Represents a color in SpreadsheetML
  3932. </member>
  3933. <member name="M:NPOI.XSSF.UserModel.XSSFColor.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Color)">
  3934. Create an instance of XSSFColor from the supplied XML bean
  3935. </member>
  3936. <member name="M:NPOI.XSSF.UserModel.XSSFColor.#ctor">
  3937. Create an new instance of XSSFColor
  3938. </member>
  3939. <member name="P:NPOI.XSSF.UserModel.XSSFColor.IsAuto">
  3940. <summary>
  3941. A bool value indicating the ctColor is automatic and system ctColor dependent.
  3942. </summary>
  3943. </member>
  3944. <member name="P:NPOI.XSSF.UserModel.XSSFColor.HasAlpha">
  3945. A bool value indicating if the ctColor has a alpha or not
  3946. </member>
  3947. <member name="P:NPOI.XSSF.UserModel.XSSFColor.HasTint">
  3948. A bool value indicating if the ctColor has a tint or not
  3949. </member>
  3950. <member name="P:NPOI.XSSF.UserModel.XSSFColor.Indexed">
  3951. Indexed ctColor value. Only used for backwards compatibility. References a ctColor in indexedColors.
  3952. </member>
  3953. <member name="P:NPOI.XSSF.UserModel.XSSFColor.RGB">
  3954. Standard Red Green Blue ctColor value (RGB).
  3955. If there was an A (Alpha) value, it will be stripped.
  3956. </member>
  3957. <member name="P:NPOI.XSSF.UserModel.XSSFColor.ARGB">
  3958. Standard Alpha Red Green Blue ctColor value (ARGB).
  3959. </member>
  3960. <member name="M:NPOI.XSSF.UserModel.XSSFColor.GetARgb">
  3961. Standard Alpha Red Green Blue ctColor value (ARGB).
  3962. </member>
  3963. <member name="M:NPOI.XSSF.UserModel.XSSFColor.GetRgbWithTint">
  3964. Standard Red Green Blue ctColor value (RGB) with applied tint.
  3965. Alpha values are ignored.
  3966. </member>
  3967. <member name="M:NPOI.XSSF.UserModel.XSSFColor.SetRgb(System.Byte[])">
  3968. Standard Alpha Red Green Blue ctColor value (ARGB).
  3969. </member>
  3970. <member name="P:NPOI.XSSF.UserModel.XSSFColor.Theme">
  3971. Index into the clrScheme collection, referencing a particular sysClr or
  3972. srgbClr value expressed in the Theme part.
  3973. </member>
  3974. <member name="P:NPOI.XSSF.UserModel.XSSFColor.Tint">
  3975. Specifies the tint value applied to the ctColor.
  3976. <p>
  3977. If tint is supplied, then it is applied to the RGB value of the ctColor to determine the final
  3978. ctColor applied.
  3979. </p>
  3980. <p>
  3981. The tint value is stored as a double from -1.0 .. 1.0, where -1.0 means 100% darken and
  3982. 1.0 means 100% lighten. Also, 0.0 means no Change.
  3983. </p>
  3984. <p>
  3985. In loading the RGB value, it is Converted to HLS where HLS values are (0..HLSMAX), where
  3986. HLSMAX is currently 255.
  3987. </p>
  3988. Here are some examples of how to apply tint to ctColor:
  3989. <blockquote>
  3990. <pre>
  3991. If (tint &lt; 0)
  3992. Lum' = Lum * (1.0 + tint)
  3993. For example: Lum = 200; tint = -0.5; Darken 50%
  3994. Lum' = 200 * (0.5) =&gt; 100
  3995. For example: Lum = 200; tint = -1.0; Darken 100% (make black)
  3996. Lum' = 200 * (1.0-1.0) =&gt; 0
  3997. If (tint &gt; 0)
  3998. Lum' = Lum * (1.0-tint) + (HLSMAX - HLSMAX * (1.0-tint))
  3999. For example: Lum = 100; tint = 0.75; Lighten 75%
  4000. Lum' = 100 * (1-.75) + (HLSMAX - HLSMAX*(1-.75))
  4001. = 100 * .25 + (255 - 255 * .25)
  4002. = 25 + (255 - 63) = 25 + 192 = 217
  4003. For example: Lum = 100; tint = 1.0; Lighten 100% (make white)
  4004. Lum' = 100 * (1-1) + (HLSMAX - HLSMAX*(1-1))
  4005. = 100 * 0 + (255 - 255 * 0)
  4006. = 0 + (255 - 0) = 255
  4007. </pre>
  4008. </blockquote>
  4009. @return the tint value
  4010. </member>
  4011. <member name="M:NPOI.XSSF.UserModel.XSSFColor.GetCTColor">
  4012. Returns the underlying XML bean
  4013. @return the underlying XML bean
  4014. </member>
  4015. <member name="M:NPOI.XSSF.UserModel.XSSFColor.ToXSSFColor(NPOI.SS.UserModel.IColor)">
  4016. <summary>
  4017. Checked type cast <tt>color</tt> to an XSSFColor.
  4018. </summary>
  4019. <param name="color">the color to type cast</param>
  4020. <returns>the type casted color</returns>
  4021. <exception cref="T:System.ArgumentException">if color is null or is not an instance of XSSFColor</exception>
  4022. </member>
  4023. <member name="T:NPOI.XSSF.UserModel.XSSFColorScaleFormatting">
  4024. High level representation for Color Scale / Color Gradient Formatting
  4025. component of Conditional Formatting Settings
  4026. </member>
  4027. <member name="F:NPOI.XSSF.UserModel.XSSFComment._str">
  4028. cached reference to the string with the comment text
  4029. </member>
  4030. <member name="M:NPOI.XSSF.UserModel.XSSFComment.#ctor(NPOI.XSSF.Model.CommentsTable,NPOI.OpenXmlFormats.Spreadsheet.CT_Comment,NPOI.OpenXmlFormats.Vml.CT_Shape)">
  4031. Creates a new XSSFComment, associated with a given
  4032. low level comment object.
  4033. </member>
  4034. <member name="P:NPOI.XSSF.UserModel.XSSFComment.Author">
  4035. @return Name of the original comment author. Default value is blank.
  4036. </member>
  4037. <member name="P:NPOI.XSSF.UserModel.XSSFComment.Column">
  4038. @return the 0-based column of the cell that the comment is associated with.
  4039. </member>
  4040. <member name="P:NPOI.XSSF.UserModel.XSSFComment.Row">
  4041. @return the 0-based row index of the cell that the comment is associated with.
  4042. </member>
  4043. <member name="P:NPOI.XSSF.UserModel.XSSFComment.Visible">
  4044. @return whether the comment is visible
  4045. </member>
  4046. <member name="P:NPOI.XSSF.UserModel.XSSFComment.String">
  4047. @return the rich text string of the comment
  4048. </member>
  4049. <member name="M:NPOI.XSSF.UserModel.XSSFComment.SetString(System.String)">
  4050. Sets the rich text string used by this comment.
  4051. @param string the XSSFRichTextString used by this object.
  4052. </member>
  4053. <member name="M:NPOI.XSSF.UserModel.XSSFComment.GetCTComment">
  4054. @return the xml bean holding this comment's properties
  4055. </member>
  4056. <member name="T:NPOI.XSSF.UserModel.XSSFConditionalFormatting">
  4057. @author Yegor Kozlov
  4058. </member>
  4059. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormatting.GetFormattingRanges">
  4060. @return array of <tt>CellRangeAddress</tt>s. Never <code>null</code>
  4061. </member>
  4062. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormatting.SetRule(System.Int32,NPOI.SS.UserModel.IConditionalFormattingRule)">
  4063. Replaces an existing Conditional Formatting rule at position idx.
  4064. Excel allows to create up to 3 Conditional Formatting rules.
  4065. This method can be useful to modify existing Conditional Formatting rules.
  4066. @param idx position of the rule. Should be between 0 and 2.
  4067. @param cfRule - Conditional Formatting rule
  4068. </member>
  4069. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormatting.AddRule(NPOI.SS.UserModel.IConditionalFormattingRule)">
  4070. Add a Conditional Formatting rule.
  4071. Excel allows to create up to 3 Conditional Formatting rules.
  4072. @param cfRule - Conditional Formatting rule
  4073. </member>
  4074. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormatting.GetRule(System.Int32)">
  4075. @return the Conditional Formatting rule at position idx.
  4076. </member>
  4077. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormatting.NumberOfRules">
  4078. @return number of Conditional Formatting rules.
  4079. </member>
  4080. <member name="T:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule">
  4081. @author Yegor Kozlov
  4082. </member>
  4083. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.CreateBorderFormatting">
  4084. Create a new border formatting structure if it does not exist,
  4085. otherwise just return existing object.
  4086. @return - border formatting object, never returns <code>null</code>.
  4087. </member>
  4088. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.BorderFormatting">
  4089. @return - border formatting object if defined, <code>null</code> otherwise
  4090. </member>
  4091. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.CreateFontFormatting">
  4092. Create a new font formatting structure if it does not exist,
  4093. otherwise just return existing object.
  4094. @return - font formatting object, never returns <code>null</code>.
  4095. </member>
  4096. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.FontFormatting">
  4097. @return - font formatting object if defined, <code>null</code> otherwise
  4098. </member>
  4099. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.CreatePatternFormatting">
  4100. Create a new pattern formatting structure if it does not exist,
  4101. otherwise just return existing object.
  4102. @return - pattern formatting object, never returns <code>null</code>.
  4103. </member>
  4104. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.PatternFormatting">
  4105. @return - pattern formatting object if defined, <code>null</code> otherwise
  4106. </member>
  4107. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.ConditionType">
  4108. Type of conditional formatting rule.
  4109. </member>
  4110. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.ComparisonOperation">
  4111. The comparison function used when the type of conditional formatting is Set to
  4112. {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS}
  4113. <p>
  4114. MUST be a constant from {@link NPOI.ss.usermodel.ComparisonOperator}
  4115. </p>
  4116. @return the conditional format operator
  4117. </member>
  4118. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.Formula1">
  4119. The formula used to Evaluate the first operand for the conditional formatting rule.
  4120. <p>
  4121. If the condition type is {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS},
  4122. this field is the first operand of the comparison.
  4123. If type is {@link ConditionalFormattingRule#CONDITION_TYPE_FORMULA}, this formula is used
  4124. to determine if the conditional formatting is applied.
  4125. </p>
  4126. <p>
  4127. If comparison type is {@link ConditionalFormattingRule#CONDITION_TYPE_FORMULA} the formula MUST be a Boolean function
  4128. </p>
  4129. @return the first formula
  4130. </member>
  4131. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.Formula2">
  4132. The formula used to Evaluate the second operand of the comparison when
  4133. comparison type is {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS} and operator
  4134. is either {@link NPOI.ss.usermodel.ComparisonOperator#BETWEEN} or {@link NPOI.ss.usermodel.ComparisonOperator#NOT_BETWEEN}
  4135. @return the second formula
  4136. </member>
  4137. <member name="T:NPOI.XSSF.UserModel.XSSFConditionalFormattingThreshold">
  4138. High level representation for Icon / Multi-State / Databar /
  4139. Colour Scale change thresholds
  4140. </member>
  4141. <member name="T:NPOI.XSSF.UserModel.XSSFConnector">
  4142. A connection shape Drawing element. A connection shape is a line, etc.
  4143. that connects two other shapes in this Drawing.
  4144. @author Yegor Kozlov
  4145. </member>
  4146. <member name="M:NPOI.XSSF.UserModel.XSSFConnector.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Connector)">
  4147. Construct a new XSSFConnector object.
  4148. @param Drawing the XSSFDrawing that owns this shape
  4149. @param ctShape the shape bean that holds all the shape properties
  4150. </member>
  4151. <member name="M:NPOI.XSSF.UserModel.XSSFConnector.Prototype">
  4152. Initialize default structure of a new auto-shape
  4153. </member>
  4154. <member name="P:NPOI.XSSF.UserModel.XSSFConnector.ShapeType">
  4155. Gets the shape type, one of the constants defined in {@link NPOI.ss.usermodel.ShapeTypes}.
  4156. @return the shape type
  4157. @see NPOI.ss.usermodel.ShapeTypes
  4158. </member>
  4159. <member name="M:NPOI.XSSF.UserModel.XSSFCreationHelper.CreateRichTextString(System.String)">
  4160. Creates a new XSSFRichTextString for you.
  4161. </member>
  4162. <member name="M:NPOI.XSSF.UserModel.XSSFCreationHelper.CreateFormulaEvaluator">
  4163. Creates a XSSFFormulaEvaluator, the object that Evaluates formula cells.
  4164. @return a XSSFFormulaEvaluator instance
  4165. </member>
  4166. <member name="M:NPOI.XSSF.UserModel.XSSFCreationHelper.CreateClientAnchor">
  4167. Creates a XSSFClientAnchor. Use this object to position Drawing object in
  4168. a sheet
  4169. @return a XSSFClientAnchor instance
  4170. @see NPOI.ss.usermodel.Drawing
  4171. </member>
  4172. <member name="T:NPOI.XSSF.UserModel.XSSFDataBarFormatting">
  4173. High level representation for DataBar / Data Bar Formatting
  4174. component of Conditional Formatting Settings
  4175. </member>
  4176. <member name="T:NPOI.XSSF.UserModel.XSSFDataFormat">
  4177. Handles data formats for XSSF.
  4178. Per Microsoft Excel 2007+ format limitations:
  4179. Workbooks support between 200 and 250 "number formats"
  4180. (POI calls them "data formats") So short or even byte
  4181. would be acceptable data types to use for referring to
  4182. data format indices.
  4183. https://support.office.com/en-us/article/excel-specifications-and-limits-1672b34d-7043-467e-8e27-269d656771c3
  4184. </member>
  4185. <member name="M:NPOI.XSSF.UserModel.XSSFDataFormat.GetFormat(System.String)">
  4186. Get the format index that matches the given format
  4187. string, creating a new format entry if required.
  4188. Aliases text to the proper format as required.
  4189. @param format string matching a built in format
  4190. @return index of format.
  4191. </member>
  4192. <member name="M:NPOI.XSSF.UserModel.XSSFDataFormat.GetFormat(System.Int16)">
  4193. Get the format string that matches the given format index
  4194. @param index of a format
  4195. @return string represented at index of format or null if there is not a format at that index
  4196. </member>
  4197. <member name="M:NPOI.XSSF.UserModel.XSSFDataFormat.GetFormat(System.Int32)">
  4198. get the format string that matches the given format index
  4199. @param index of a format
  4200. @return string represented at index of format or null if there is not a format at that index
  4201. </member>
  4202. <member name="M:NPOI.XSSF.UserModel.XSSFDataFormat.PutFormat(System.Int16,System.String)">
  4203. Add a number format with a specific ID into the number format style table.
  4204. If a format with the same ID already exists, overwrite the format code
  4205. with <code>fmt</code>
  4206. This may be used to override built-in number formats.
  4207. @param index the number format ID
  4208. @param format the number format code
  4209. </member>
  4210. <member name="T:NPOI.XSSF.UserModel.XSSFDataValidation">
  4211. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  4212. </member>
  4213. <member name="T:NPOI.XSSF.UserModel.XSSFDataValidationConstraint">
  4214. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  4215. </member>
  4216. <member name="F:NPOI.XSSF.UserModel.XSSFDataValidationConstraint.LIST_SEPARATOR">
  4217. Excel validation constraints with static lists are delimited with optional whitespace and the Windows List Separator,
  4218. which is typically comma, but can be changed by users. POI will just assume comma.
  4219. </member>
  4220. <member name="M:NPOI.XSSF.UserModel.XSSFDataValidationConstraint.#ctor(System.Int32,System.Int32,System.String,System.String)">
  4221. <summary>
  4222. This is the constructor called using the OOXML raw data. Excel overloads formula1 to also encode explicit value lists,
  4223. so this constructor has to check for and parse that syntax.
  4224. </summary>
  4225. <param name="validationType"></param>
  4226. <param name="operator1"></param>
  4227. <param name="formula1">Overloaded: formula1 or list of explicit values</param>
  4228. <param name="formula2">formula1 is a list of explicit values, this is ignored: use <code>null</code></param>
  4229. </member>
  4230. <member name="T:NPOI.XSSF.UserModel.XSSFDataValidationHelper">
  4231. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  4232. </member>
  4233. <member name="T:NPOI.XSSF.UserModel.XSSFDrawing">
  4234. Represents a SpreadsheetML Drawing
  4235. @author Yegor Kozlov
  4236. </member>
  4237. <member name="F:NPOI.XSSF.UserModel.XSSFDrawing.drawing">
  4238. Root element of the SpreadsheetML Drawing part
  4239. </member>
  4240. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.#ctor">
  4241. Create a new SpreadsheetML Drawing
  4242. @see NPOI.xssf.usermodel.XSSFSheet#CreateDrawingPatriarch()
  4243. </member>
  4244. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  4245. Construct a SpreadsheetML Drawing from a namespace part
  4246. @param part the namespace part holding the Drawing data,
  4247. the content type must be <code>application/vnd.openxmlformats-officedocument.Drawing+xml</code>
  4248. @param rel the namespace relationship holding this Drawing,
  4249. the relationship type must be http://schemas.openxmlformats.org/officeDocument/2006/relationships/drawing
  4250. </member>
  4251. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.NewDrawing">
  4252. Construct a new CT_Drawing bean. By default, it's just an empty placeholder for Drawing objects
  4253. @return a new CT_Drawing bean
  4254. </member>
  4255. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.GetCTDrawing">
  4256. Return the underlying CT_Drawing bean, the root element of the SpreadsheetML Drawing part.
  4257. @return the underlying CT_Drawing bean
  4258. </member>
  4259. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateTextbox(NPOI.SS.UserModel.IClientAnchor)">
  4260. Constructs a textbox under the Drawing.
  4261. @param anchor the client anchor describes how this group is attached
  4262. to the sheet.
  4263. @return the newly Created textbox.
  4264. </member>
  4265. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreatePicture(NPOI.XSSF.UserModel.XSSFClientAnchor,System.Int32)">
  4266. Creates a picture.
  4267. @param anchor the client anchor describes how this picture is attached to the sheet.
  4268. @param pictureIndex the index of the picture in the workbook collection of pictures,
  4269. {@link NPOI.xssf.usermodel.XSSFWorkbook#getAllPictures()} .
  4270. @return the newly Created picture shape.
  4271. </member>
  4272. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateChart(NPOI.SS.UserModel.IClientAnchor)">
  4273. <summary>
  4274. Creates a chart.
  4275. </summary>
  4276. <param name="anchor">the client anchor describes how this chart is attached to</param>
  4277. <returns>the newly created chart</returns>
  4278. </member>
  4279. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.AddPictureReference(System.Int32)">
  4280. Add the indexed picture to this Drawing relations
  4281. @param pictureIndex the index of the picture in the workbook collection of pictures,
  4282. {@link NPOI.xssf.usermodel.XSSFWorkbook#getAllPictures()} .
  4283. </member>
  4284. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateSimpleShape(NPOI.XSSF.UserModel.XSSFClientAnchor)">
  4285. Creates a simple shape. This includes such shapes as lines, rectangles,
  4286. and ovals.
  4287. @param anchor the client anchor describes how this group is attached
  4288. to the sheet.
  4289. @return the newly Created shape.
  4290. </member>
  4291. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateConnector(NPOI.XSSF.UserModel.XSSFClientAnchor)">
  4292. Creates a simple shape. This includes such shapes as lines, rectangles,
  4293. and ovals.
  4294. @param anchor the client anchor describes how this group is attached
  4295. to the sheet.
  4296. @return the newly Created shape.
  4297. </member>
  4298. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateGroup(NPOI.XSSF.UserModel.XSSFClientAnchor)">
  4299. Creates a simple shape. This includes such shapes as lines, rectangles,
  4300. and ovals.
  4301. @param anchor the client anchor describes how this group is attached
  4302. to the sheet.
  4303. @return the newly Created shape.
  4304. </member>
  4305. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateCellComment(NPOI.SS.UserModel.IClientAnchor)">
  4306. Creates a comment.
  4307. @param anchor the client anchor describes how this comment is attached
  4308. to the sheet.
  4309. @return the newly Created comment.
  4310. </member>
  4311. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateGraphicFrame(NPOI.XSSF.UserModel.XSSFClientAnchor)">
  4312. Creates a new graphic frame.
  4313. @param anchor the client anchor describes how this frame is attached
  4314. to the sheet
  4315. @return the newly Created graphic frame
  4316. </member>
  4317. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.GetCharts">
  4318. Returns all charts in this Drawing.
  4319. </member>
  4320. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateTwoCellAnchor(NPOI.SS.UserModel.IClientAnchor)">
  4321. Create and Initialize a CT_TwoCellAnchor that anchors a shape against top-left and bottom-right cells.
  4322. @return a new CT_TwoCellAnchor
  4323. </member>
  4324. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.GetShapes">
  4325. @return list of shapes in this drawing
  4326. </member>
  4327. <member name="T:NPOI.XSSF.UserModel.XSSFEvaluationCell">
  4328. XSSF wrapper for a cell under Evaluation
  4329. @author Josh Micich
  4330. </member>
  4331. <member name="T:NPOI.XSSF.UserModel.XSSFEvaluationSheet">
  4332. XSSF wrapper for a sheet under Evaluation
  4333. @author Josh Micich
  4334. </member>
  4335. <member name="T:NPOI.XSSF.UserModel.XSSFEvaluationWorkbook">
  4336. Internal POI use only
  4337. @author Josh Micich
  4338. </member>
  4339. <member name="T:NPOI.XSSF.UserModel.XSSFEvenFooter">
  4340. Even page footer value. Corresponds to even printed pages.
  4341. Even page(s) in the sheet may not be printed, for example, if the print area is specified to be
  4342. a range such that it falls outside an even page's scope.
  4343. If no even footer is specified, then the odd footer's value is assumed for even page footers.
  4344. </member>
  4345. <member name="M:NPOI.XSSF.UserModel.XSSFEvenFooter.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  4346. Create an instance of XSSFEvenFooter from the supplied XML bean
  4347. @see XSSFSheet#GetEvenFooter()
  4348. @param headerFooter
  4349. </member>
  4350. <member name="P:NPOI.XSSF.UserModel.XSSFEvenFooter.Text">
  4351. Get the content text representing the footer
  4352. @return text
  4353. </member>
  4354. <member name="T:NPOI.XSSF.UserModel.XSSFEvenHeader">
  4355. <p>
  4356. Even page header value. Corresponds to even printed pages.
  4357. Even page(s) in the sheet may not be printed, for example, if the print area is specified to be
  4358. a range such that it falls outside an even page's scope.
  4359. If no even header is specified, then odd header value is assumed for even page headers.
  4360. </p>
  4361. </member>
  4362. <member name="M:NPOI.XSSF.UserModel.XSSFEvenHeader.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  4363. Create an instance of XSSFEvenHeader from the supplied XML bean
  4364. @see XSSFSheet#GetEvenHeader()
  4365. @param headerFooter
  4366. </member>
  4367. <member name="P:NPOI.XSSF.UserModel.XSSFEvenHeader.Text">
  4368. Get the content text representing this header
  4369. @return text
  4370. </member>
  4371. <member name="T:NPOI.XSSF.UserModel.XSSFFactory">
  4372. Instantiates sub-classes of POIXMLDocumentPart depending on their relationship type
  4373. @author Yegor Kozlov
  4374. </member>
  4375. <member name="M:NPOI.XSSF.UserModel.XSSFFactory.GetDescriptor(System.String)">
  4376. @since POI 3.14-Beta1
  4377. </member>
  4378. <member name="M:NPOI.XSSF.UserModel.XSSFFactory.CreateDocumentPart(System.Type,System.Type[],System.Object[])">
  4379. @since POI 3.14-Beta1
  4380. </member>
  4381. <member name="T:NPOI.XSSF.UserModel.XSSFFirstFooter">
  4382. First page footer content. Corresponds to first printed page.
  4383. The first logical page in the sheet may not be printed, for example, if the print area is specified to
  4384. be a range such that it falls outside the first page's scope.
  4385. </member>
  4386. <member name="M:NPOI.XSSF.UserModel.XSSFFirstFooter.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  4387. Create an instance of XSSFFirstFooter from the supplied XML bean
  4388. @see XSSFSheet#getFirstFooter()
  4389. @param headerFooter
  4390. </member>
  4391. <member name="P:NPOI.XSSF.UserModel.XSSFFirstFooter.Text">
  4392. Get the content text representing the footer
  4393. @return text
  4394. </member>
  4395. <member name="T:NPOI.XSSF.UserModel.XSSFFirstHeader">
  4396. First page header content. Corresponds to first printed page.
  4397. The first logical page in the sheet may not be printed, for example, if the print area is specified to
  4398. be a range such that it falls outside the first page's scope.
  4399. </member>
  4400. <member name="M:NPOI.XSSF.UserModel.XSSFFirstHeader.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  4401. Create an instance of XSSFFirstHeader from the supplied XML bean
  4402. @see XSSFSheet#getFirstHeader()
  4403. @param headerFooter
  4404. </member>
  4405. <member name="P:NPOI.XSSF.UserModel.XSSFFirstHeader.Text">
  4406. Get the content text representing this header
  4407. @return text
  4408. </member>
  4409. <member name="T:NPOI.XSSF.UserModel.XSSFFont">
  4410. Represents a font used in a workbook.
  4411. @author Gisella Bronzetti
  4412. </member>
  4413. <member name="F:NPOI.XSSF.UserModel.XSSFFont.DEFAULT_FONT_NAME">
  4414. By default, Microsoft Office Excel 2007 uses the Calibry font in font size 11
  4415. </member>
  4416. <member name="F:NPOI.XSSF.UserModel.XSSFFont.DEFAULT_FONT_SIZE">
  4417. By default, Microsoft Office Excel 2007 uses the Calibry font in font size 11
  4418. </member>
  4419. <member name="F:NPOI.XSSF.UserModel.XSSFFont.DEFAULT_FONT_COLOR">
  4420. Default font color is black
  4421. @see NPOI.SS.usermodel.IndexedColors#BLACK
  4422. </member>
  4423. <member name="M:NPOI.XSSF.UserModel.XSSFFont.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Font)">
  4424. Create a new XSSFFont
  4425. @param font the underlying CT_Font bean
  4426. </member>
  4427. <member name="M:NPOI.XSSF.UserModel.XSSFFont.#ctor">
  4428. Create a new XSSFont. This method is protected to be used only by XSSFWorkbook
  4429. </member>
  4430. <member name="M:NPOI.XSSF.UserModel.XSSFFont.GetCTFont">
  4431. get the underlying CT_Font font
  4432. </member>
  4433. <member name="P:NPOI.XSSF.UserModel.XSSFFont.IsBold">
  4434. get a bool value for the boldness to use.
  4435. @return bool - bold
  4436. </member>
  4437. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Charset">
  4438. get character-set to use.
  4439. @return int - character-set (0-255)
  4440. @see NPOI.SS.usermodel.FontCharset
  4441. </member>
  4442. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Color">
  4443. get the indexed color value for the font
  4444. References a color defined in IndexedColors.
  4445. @return short - indexed color to use
  4446. @see IndexedColors
  4447. </member>
  4448. <member name="M:NPOI.XSSF.UserModel.XSSFFont.GetXSSFColor">
  4449. get the color value for the font
  4450. References a color defined as Standard Alpha Red Green Blue color value (ARGB).
  4451. @return XSSFColor - rgb color to use
  4452. </member>
  4453. <member name="M:NPOI.XSSF.UserModel.XSSFFont.GetThemeColor">
  4454. get the color value for the font
  4455. References a color defined in theme.
  4456. @return short - theme defined to use
  4457. </member>
  4458. <member name="P:NPOI.XSSF.UserModel.XSSFFont.FontHeight">
  4459. <summary>
  4460. Get the font height in unit's of 1/20th of a point.
  4461. </summary>
  4462. </member>
  4463. <member name="P:NPOI.XSSF.UserModel.XSSFFont.FontHeightInPoints">
  4464. <summary>
  4465. Get the font height in points.
  4466. </summary>
  4467. </member>
  4468. <member name="P:NPOI.XSSF.UserModel.XSSFFont.FontName">
  4469. get the name of the font (i.e. Arial)
  4470. @return String - a string representing the name of the font to use
  4471. </member>
  4472. <member name="P:NPOI.XSSF.UserModel.XSSFFont.IsItalic">
  4473. get a bool value that specify whether to use italics or not
  4474. @return bool - value for italic
  4475. </member>
  4476. <member name="P:NPOI.XSSF.UserModel.XSSFFont.IsStrikeout">
  4477. get a bool value that specify whether to use a strikeout horizontal line through the text or not
  4478. @return bool - value for strikeout
  4479. </member>
  4480. <member name="P:NPOI.XSSF.UserModel.XSSFFont.TypeOffset">
  4481. get normal,super or subscript.
  4482. @return short - offset type to use (none,super,sub)
  4483. @see Font#SS_NONE
  4484. @see Font#SS_SUPER
  4485. @see Font#SS_SUB
  4486. </member>
  4487. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Underline">
  4488. get type of text underlining to use
  4489. @return byte - underlining type
  4490. @see NPOI.SS.usermodel.FontUnderline
  4491. </member>
  4492. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Boldweight">
  4493. get the boldness to use
  4494. @return boldweight
  4495. @see #BOLDWEIGHT_NORMAL
  4496. @see #BOLDWEIGHT_BOLD
  4497. </member>
  4498. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetCharSet(System.Byte)">
  4499. set character-set to use.
  4500. @param charset - charset
  4501. @see FontCharset
  4502. </member>
  4503. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetCharSet(System.Int32)">
  4504. set character-set to use.
  4505. @param charset - charset
  4506. @see FontCharset
  4507. </member>
  4508. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetCharSet(NPOI.SS.UserModel.FontCharset)">
  4509. set character-set to use.
  4510. @param charSet
  4511. </member>
  4512. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetColor(NPOI.XSSF.UserModel.XSSFColor)">
  4513. set the color for the font in Standard Alpha Red Green Blue color value
  4514. @param color - color to use
  4515. </member>
  4516. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetThemeColor(System.Int16)">
  4517. set the theme color for the font to use
  4518. @param theme - theme color to use
  4519. </member>
  4520. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetUnderline(NPOI.SS.UserModel.FontUnderlineType)">
  4521. set an enumeration representing the style of underlining that is used.
  4522. The none style is equivalent to not using underlining at all.
  4523. The possible values for this attribute are defined by the FontUnderline
  4524. @param underline - FontUnderline enum value
  4525. </member>
  4526. <member name="M:NPOI.XSSF.UserModel.XSSFFont.RegisterTo(NPOI.XSSF.Model.StylesTable)">
  4527. **
  4528. </member>
  4529. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetThemesTable(NPOI.XSSF.Model.ThemesTable)">
  4530. Records the Themes Table that is associated with
  4531. the current font, used when looking up theme
  4532. based colours and properties.
  4533. </member>
  4534. <member name="M:NPOI.XSSF.UserModel.XSSFFont.GetScheme">
  4535. get the font scheme property.
  4536. is used only in StylesTable to create the default instance of font
  4537. @return FontScheme
  4538. @see NPOI.XSSF.model.StylesTable#CreateDefaultFont()
  4539. </member>
  4540. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetScheme(NPOI.SS.UserModel.FontScheme)">
  4541. set font scheme property
  4542. @param scheme - FontScheme enum value
  4543. @see FontScheme
  4544. </member>
  4545. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Family">
  4546. get the font family to use.
  4547. @return the font family to use
  4548. @see NPOI.SS.usermodel.FontFamily
  4549. </member>
  4550. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetFamily(NPOI.SS.UserModel.FontFamily)">
  4551. set an enumeration representing the font family this font belongs to.
  4552. A font family is a set of fonts having common stroke width and serif characteristics.
  4553. @param family font family
  4554. @link #SetFamily(int value)
  4555. </member>
  4556. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Index">
  4557. get the index within the XSSFWorkbook (sequence within the collection of Font objects)
  4558. @return unique index number of the underlying record this Font represents (probably you don't care
  4559. unless you're comparing which one is which)
  4560. </member>
  4561. <member name="T:NPOI.XSSF.UserModel.XSSFFontFormatting">
  4562. @author Yegor Kozlov
  4563. </member>
  4564. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.EscapementType">
  4565. Get the type of super or subscript for the font
  4566. @return super or subscript option
  4567. @see #SS_NONE
  4568. @see #SS_SUPER
  4569. @see #SS_SUB
  4570. </member>
  4571. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.FontColorIndex">
  4572. @return font color index
  4573. </member>
  4574. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.FontHeight">
  4575. Gets the height of the font in 1/20th point units
  4576. @return fontheight (in points/20); or -1 if not modified
  4577. </member>
  4578. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.UnderlineType">
  4579. Get the type of underlining for the font
  4580. @return font underlining type
  4581. @see #U_NONE
  4582. @see #U_SINGLE
  4583. @see #U_DOUBLE
  4584. @see #U_SINGLE_ACCOUNTING
  4585. @see #U_DOUBLE_ACCOUNTING
  4586. </member>
  4587. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.IsBold">
  4588. Get whether the font weight is Set to bold or not
  4589. @return bold - whether the font is bold or not
  4590. </member>
  4591. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.IsItalic">
  4592. @return true if font style was Set to <i>italic</i>
  4593. </member>
  4594. <member name="M:NPOI.XSSF.UserModel.XSSFFontFormatting.SetFontStyle(System.Boolean,System.Boolean)">
  4595. Set font style options.
  4596. @param italic - if true, Set posture style to italic, otherwise to normal
  4597. @param bold if true, Set font weight to bold, otherwise to normal
  4598. </member>
  4599. <member name="M:NPOI.XSSF.UserModel.XSSFFontFormatting.ResetFontStyle">
  4600. Set font style options to default values (non-italic, non-bold)
  4601. </member>
  4602. <member name="T:NPOI.XSSF.UserModel.XSSFFormulaEvaluator">
  4603. Evaluates formula cells.<p/>
  4604. For performance reasons, this class keeps a cache of all previously calculated intermediate
  4605. cell values. Be sure to call {@link #ClearAllCachedResultValues()} if any workbook cells are Changed between
  4606. calls to Evaluate~ methods on this class.
  4607. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  4608. @author Josh Micich
  4609. </member>
  4610. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.Create(NPOI.XSSF.UserModel.XSSFWorkbook,NPOI.SS.Formula.IStabilityClassifier,NPOI.SS.Formula.UDF.UDFFinder)">
  4611. @param stabilityClassifier used to optimise caching performance. Pass <code>null</code>
  4612. for the (conservative) assumption that any cell may have its defInition Changed After
  4613. Evaluation begins.
  4614. @param udfFinder pass <code>null</code> for default (AnalysisToolPak only)
  4615. </member>
  4616. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.EvaluateAllFormulaCells(NPOI.XSSF.UserModel.XSSFWorkbook)">
  4617. Loops over all cells in all sheets of the supplied
  4618. workbook.
  4619. For cells that contain formulas, their formulas are
  4620. Evaluated, and the results are saved. These cells
  4621. remain as formula cells.
  4622. For cells that do not contain formulas, no Changes
  4623. are made.
  4624. This is a helpful wrapper around looping over all
  4625. cells, and calling EvaluateFormulaCell on each one.
  4626. </member>
  4627. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.EvaluateAll">
  4628. Loops over all cells in all sheets of the supplied
  4629. workbook.
  4630. For cells that contain formulas, their formulas are
  4631. Evaluated, and the results are saved. These cells
  4632. remain as formula cells.
  4633. For cells that do not contain formulas, no Changes
  4634. are made.
  4635. This is a helpful wrapper around looping over all
  4636. cells, and calling EvaluateFormulaCell on each one.
  4637. </member>
  4638. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.ToEvaluationCell(NPOI.SS.UserModel.ICell)">
  4639. Turns a XSSFCell into a XSSFEvaluationCell
  4640. </member>
  4641. <member name="T:NPOI.XSSF.UserModel.XSSFGraphicFrame">
  4642. Represents DrawingML GraphicalObjectFrame.
  4643. @author Roman Kashitsyn
  4644. </member>
  4645. <member name="M:NPOI.XSSF.UserModel.XSSFGraphicFrame.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_GraphicalObjectFrame)">
  4646. Construct a new XSSFGraphicFrame object.
  4647. @param Drawing the XSSFDrawing that owns this frame
  4648. @param ctGraphicFrame the XML bean that stores this frame content
  4649. </member>
  4650. <member name="M:NPOI.XSSF.UserModel.XSSFGraphicFrame.Prototype">
  4651. Initialize default structure of a new graphic frame
  4652. </member>
  4653. <member name="M:NPOI.XSSF.UserModel.XSSFGraphicFrame.SetMacro(System.String)">
  4654. Sets the frame macro.
  4655. </member>
  4656. <member name="P:NPOI.XSSF.UserModel.XSSFGraphicFrame.Name">
  4657. Returns the frame name.
  4658. @return name of the frame
  4659. </member>
  4660. <member name="P:NPOI.XSSF.UserModel.XSSFGraphicFrame.Anchor">
  4661. Returns the frame anchor.
  4662. @return the anchor this frame is attached to
  4663. </member>
  4664. <member name="M:NPOI.XSSF.UserModel.XSSFGraphicFrame.SetChart(NPOI.XSSF.UserModel.XSSFChart,System.String)">
  4665. Assign a DrawingML chart to the graphic frame.
  4666. </member>
  4667. <member name="P:NPOI.XSSF.UserModel.XSSFGraphicFrame.Id">
  4668. Gets the frame id.
  4669. </member>
  4670. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFGraphicFrame.AppendChartElement(NPOI.OpenXmlFormats.Dml.CT_GraphicalObjectData,System.String)" -->
  4671. <member name="T:NPOI.XSSF.UserModel.XSSFIconMultiStateFormatting">
  4672. High level representation for Icon / Multi-State Formatting
  4673. component of Conditional Formatting Settings
  4674. </member>
  4675. <member name="M:NPOI.XSSF.UserModel.XSSFLineBreak.SetText(System.String)">
  4676. Always . You cannot change text of a line break.
  4677. </member>
  4678. <member name="T:NPOI.XSSF.UserModel.XSSFMap">
  4679. This class : the Map element (Open Office XML Part 4:
  4680. chapter 3.16.2)
  4681. This element Contains all of the properties related to the XML map,
  4682. and the behaviors expected during data refresh operations.
  4683. @author Roberto Manicardi
  4684. </member>
  4685. <member name="M:NPOI.XSSF.UserModel.XSSFMap.GetRelatedSingleXMLCell">
  4686. @return the list of Single Xml Cells that provide a map rule to this mapping.
  4687. </member>
  4688. <member name="M:NPOI.XSSF.UserModel.XSSFMap.GetRelatedTables">
  4689. @return the list of all Tables that provide a map rule to this mapping
  4690. </member>
  4691. <member name="T:NPOI.XSSF.UserModel.XSSFName">
  4692. Represents a defined named range in a SpreadsheetML workbook.
  4693. <p>
  4694. Defined names are descriptive text that is used to represents a cell, range of cells, formula, or constant value.
  4695. Use easy-to-understand names, such as Products, to refer to hard to understand ranges, such as <code>Sales!C20:C30</code>.
  4696. </p>
  4697. Example:
  4698. <pre><blockquote>
  4699. XSSFWorkbook wb = new XSSFWorkbook();
  4700. XSSFSheet sh = wb.CreateSheet("Sheet1");
  4701. //applies to the entire workbook
  4702. XSSFName name1 = wb.CreateName();
  4703. name1.SetNameName("FMLA");
  4704. name1.SetRefersToFormula("Sheet1!$B$3");
  4705. //applies to Sheet1
  4706. XSSFName name2 = wb.CreateName();
  4707. name2.SetNameName("SheetLevelName");
  4708. name2.SetComment("This name is scoped to Sheet1");
  4709. name2.SetLocalSheetId(0);
  4710. name2.SetRefersToFormula("Sheet1!$B$3");
  4711. </blockquote></pre>
  4712. @author Nick Burch
  4713. @author Yegor Kozlov
  4714. </member>
  4715. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_PRINT_AREA">
  4716. A built-in defined name that specifies the workbook's print area
  4717. </member>
  4718. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_PRINT_TITLE">
  4719. A built-in defined name that specifies the row(s) or column(s) to repeat
  4720. at the top of each printed page.
  4721. </member>
  4722. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_CRITERIA">
  4723. A built-in defined name that refers to a range Containing the criteria values
  4724. to be used in Applying an advanced filter to a range of data
  4725. </member>
  4726. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_EXTRACT">
  4727. this defined name refers to the range Containing the filtered
  4728. output values resulting from Applying an advanced filter criteria to a source
  4729. range
  4730. </member>
  4731. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_FILTER_DB">
  4732. ?an be one of the following
  4733. 1 this defined name refers to a range to which an advanced filter has been
  4734. applied. This represents the source data range, unfiltered.
  4735. 2 This defined name refers to a range to which an AutoFilter has been
  4736. applied
  4737. </member>
  4738. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_CONSOLIDATE_AREA">
  4739. A built-in defined name that refers to a consolidation area
  4740. </member>
  4741. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_DATABASE">
  4742. A built-in defined name that specified that the range specified is from a database data source
  4743. </member>
  4744. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_SHEET_TITLE">
  4745. A built-in defined name that refers to a sheet title.
  4746. </member>
  4747. <member name="M:NPOI.XSSF.UserModel.XSSFName.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_DefinedName,NPOI.XSSF.UserModel.XSSFWorkbook)">
  4748. Creates an XSSFName object - called internally by XSSFWorkbook.
  4749. @param name - the xml bean that holds data represenring this defined name.
  4750. @param workbook - the workbook object associated with the name
  4751. @see NPOI.XSSF.usermodel.XSSFWorkbook#CreateName()
  4752. </member>
  4753. <member name="M:NPOI.XSSF.UserModel.XSSFName.GetCTName">
  4754. Returns the underlying named range object
  4755. </member>
  4756. <member name="P:NPOI.XSSF.UserModel.XSSFName.NameName">
  4757. Returns the name that will appear in the user interface for the defined name.
  4758. @return text name of this defined name
  4759. </member>
  4760. <member name="P:NPOI.XSSF.UserModel.XSSFName.SheetIndex">
  4761. Returns the sheet index this name applies to.
  4762. @return the sheet index this name applies to, -1 if this name applies to the entire workbook
  4763. </member>
  4764. <member name="P:NPOI.XSSF.UserModel.XSSFName.Function">
  4765. Indicates that the defined name refers to a user-defined function.
  4766. This attribute is used when there is an Add-in or other code project associated with the file.
  4767. @return <code>true</code> indicates the name refers to a function.
  4768. </member>
  4769. <member name="P:NPOI.XSSF.UserModel.XSSFName.FunctionGroupId">
  4770. Returns the function group index if the defined name refers to a function. The function
  4771. group defines the general category for the function. This attribute is used when there is
  4772. an Add-in or other code project associated with the file.
  4773. @return the function group index that defines the general category for the function
  4774. </member>
  4775. <member name="P:NPOI.XSSF.UserModel.XSSFName.SheetName">
  4776. Get the sheets name which this named range is referenced to
  4777. @return sheet name, which this named range referred to.
  4778. Empty string if the referenced sheet name weas not found.
  4779. </member>
  4780. <member name="P:NPOI.XSSF.UserModel.XSSFName.IsFunctionName">
  4781. Is the name refers to a user-defined function ?
  4782. @return <code>true</code> if this name refers to a user-defined function
  4783. </member>
  4784. <member name="P:NPOI.XSSF.UserModel.XSSFName.Comment">
  4785. Returns the comment the user provided when the name was Created.
  4786. @return the user comment for this named range
  4787. </member>
  4788. <member name="M:NPOI.XSSF.UserModel.XSSFName.Equals(System.Object)">
  4789. Compares this name to the specified object.
  4790. The result is <code>true</code> if the argument is XSSFName and the
  4791. underlying CTDefinedName bean Equals to the CTDefinedName representing this name
  4792. @param o the object to compare this <code>XSSFName</code> against.
  4793. @return <code>true</code> if the <code>XSSFName </code>are Equal;
  4794. <code>false</code> otherwise.
  4795. </member>
  4796. <member name="T:NPOI.XSSF.UserModel.XSSFHyperlink">
  4797. XSSF Implementation of a Hyperlink.
  4798. Note - unlike with HSSF, many kinds of hyperlink
  4799. are largely stored as relations of the sheet
  4800. </member>
  4801. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.#ctor(NPOI.SS.UserModel.HyperlinkType)">
  4802. Create a new XSSFHyperlink. This method is protected to be used only by XSSFCreationHelper
  4803. @param type - the type of hyperlink to create
  4804. </member>
  4805. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Hyperlink,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  4806. Create a XSSFHyperlink amd Initialize it from the supplied CTHyperlink bean and namespace relationship
  4807. @param ctHyperlink the xml bean Containing xml properties
  4808. @param hyperlinkRel the relationship in the underlying OPC namespace which stores the actual link's Address
  4809. </member>
  4810. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.#ctor(NPOI.SS.UserModel.IHyperlink)">
  4811. Create a new XSSFHyperlink. This method is for Internal use only.
  4812. XSSFHyperlinks can be created by XSSFCreationHelper.
  4813. @param type - the type of hyperlink to create, see {@link Hyperlink}
  4814. </member>
  4815. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.GetCTHyperlink">
  4816. @return the underlying CTHyperlink object
  4817. </member>
  4818. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.NeedsRelationToo">
  4819. Do we need to a relation too, to represent
  4820. this hyperlink?
  4821. </member>
  4822. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.GenerateRelationIfNeeded(NPOI.OpenXml4Net.OPC.PackagePart)">
  4823. Generates the relation if required
  4824. </member>
  4825. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Type">
  4826. Return the type of this hyperlink
  4827. @return the type of this hyperlink
  4828. </member>
  4829. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.CellRef">
  4830. Get the reference of the cell this applies to,
  4831. es A55
  4832. </member>
  4833. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Address">
  4834. Hyperlink Address. Depending on the hyperlink type it can be URL, e-mail, path to a file
  4835. @return the Address of this hyperlink
  4836. </member>
  4837. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Label">
  4838. Return text label for this hyperlink
  4839. @return text to display
  4840. </member>
  4841. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Location">
  4842. Location within target. If target is a workbook (or this workbook) this shall refer to a
  4843. sheet and cell or a defined name. Can also be an HTML anchor if target is HTML file.
  4844. @return location
  4845. </member>
  4846. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.SetCellReference(System.String)">
  4847. Assigns this hyperlink to the given cell reference
  4848. </member>
  4849. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.FirstColumn">
  4850. Return the column of the first cell that Contains the hyperlink
  4851. @return the 0-based column of the first cell that Contains the hyperlink
  4852. </member>
  4853. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.LastColumn">
  4854. Return the column of the last cell that Contains the hyperlink
  4855. For XSSF, a Hyperlink may only reference one cell
  4856. @return the 0-based column of the last cell that Contains the hyperlink
  4857. </member>
  4858. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.FirstRow">
  4859. Return the row of the first cell that Contains the hyperlink
  4860. @return the 0-based row of the cell that Contains the hyperlink
  4861. </member>
  4862. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.LastRow">
  4863. Return the row of the last cell that Contains the hyperlink
  4864. For XSSF, a Hyperlink may only reference one cell
  4865. @return the 0-based row of the last cell that Contains the hyperlink
  4866. </member>
  4867. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Tooltip">
  4868. <summary>
  4869. get or set additional text to help the user understand more about the hyperlink
  4870. </summary>
  4871. </member>
  4872. <member name="T:NPOI.XSSF.UserModel.XSSFOddFooter">
  4873. Odd page footer value. Corresponds to odd printed pages.
  4874. Odd page(s) in the sheet may not be printed, for example, if the print area is specified to be
  4875. a range such that it falls outside an odd page's scope.
  4876. </member>
  4877. <member name="M:NPOI.XSSF.UserModel.XSSFOddFooter.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  4878. Create an instance of XSSFOddFooter from the supplied XML bean
  4879. @see XSSFSheet#GetOddFooter()
  4880. @param headerFooter
  4881. </member>
  4882. <member name="P:NPOI.XSSF.UserModel.XSSFOddFooter.Text">
  4883. Get the content text representing the footer
  4884. @return text
  4885. </member>
  4886. <member name="T:NPOI.XSSF.UserModel.XSSFOddHeader">
  4887. Odd page header value. Corresponds to odd printed pages.
  4888. Odd page(s) in the sheet may not be printed, for example, if the print area is specified to be
  4889. a range such that it falls outside an odd page's scope.
  4890. </member>
  4891. <member name="M:NPOI.XSSF.UserModel.XSSFOddHeader.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  4892. Create an instance of XSSFOddHeader from the supplied XML bean
  4893. @see XSSFSheet#GetOddHeader()
  4894. @param headerFooter
  4895. </member>
  4896. <member name="P:NPOI.XSSF.UserModel.XSSFOddHeader.Text">
  4897. Get the content text representing this header
  4898. @return text
  4899. </member>
  4900. <member name="T:NPOI.XSSF.UserModel.XSSFPatternFormatting">
  4901. @author Yegor Kozlov
  4902. </member>
  4903. <member name="T:NPOI.XSSF.UserModel.XSSFPicture">
  4904. Represents a picture shape in a SpreadsheetML Drawing.
  4905. @author Yegor Kozlov
  4906. </member>
  4907. <member name="F:NPOI.XSSF.UserModel.XSSFPicture.prototype">
  4908. A default instance of CTShape used for creating new shapes.
  4909. </member>
  4910. <member name="F:NPOI.XSSF.UserModel.XSSFPicture.ctPicture">
  4911. This object specifies a picture object and all its properties
  4912. </member>
  4913. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Picture)">
  4914. Construct a new XSSFPicture object. This constructor is called from
  4915. {@link XSSFDrawing#CreatePicture(XSSFClientAnchor, int)}
  4916. @param Drawing the XSSFDrawing that owns this picture
  4917. </member>
  4918. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,System.Xml.XmlNode)">
  4919. Returns a prototype that is used to construct new shapes
  4920. @return a prototype that is used to construct new shapes
  4921. </member>
  4922. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.SetPictureReference(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  4923. Link this shape with the picture data
  4924. @param rel relationship referring the picture data
  4925. </member>
  4926. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetCTPicture">
  4927. Return the underlying CT_Picture bean that holds all properties for this picture
  4928. @return the underlying CT_Picture bean
  4929. </member>
  4930. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.Resize">
  4931. Reset the image to the original size.
  4932. <p>
  4933. Please note, that this method works correctly only for workbooks
  4934. with the default font size (Calibri 11pt for .xlsx).
  4935. If the default font is Changed the resized image can be streched vertically or horizontally.
  4936. </p>
  4937. </member>
  4938. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.Resize(System.Double)">
  4939. Resize the image proportionally.
  4940. @see #resize(double, double)
  4941. </member>
  4942. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.Resize(System.Double,System.Double)">
  4943. Resize the image relatively to its current size.
  4944. <p>
  4945. Please note, that this method works correctly only for workbooks
  4946. with the default font size (Calibri 11pt for .xlsx).
  4947. If the default font is changed the resized image can be streched vertically or horizontally.
  4948. </p>
  4949. <p>
  4950. <code>resize(1.0,1.0)</code> keeps the original size,<br/>
  4951. <code>resize(0.5,0.5)</code> resize to 50% of the original,<br/>
  4952. <code>resize(2.0,2.0)</code> resizes to 200% of the original.<br/>
  4953. <code>resize({@link Double#MAX_VALUE},{@link Double#MAX_VALUE})</code> resizes to the dimension of the embedded image.
  4954. </p>
  4955. @param scaleX the amount by which the image width is multiplied relative to the original width,
  4956. when set to {@link java.lang.Double#MAX_VALUE} the width of the embedded image is used
  4957. @param scaleY the amount by which the image height is multiplied relative to the original height,
  4958. when set to {@link java.lang.Double#MAX_VALUE} the height of the embedded image is used
  4959. </member>
  4960. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetPreferredSize">
  4961. Calculate the preferred size for this picture.
  4962. @return XSSFClientAnchor with the preferred size for this image
  4963. </member>
  4964. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetPreferredSize(System.Double)">
  4965. Calculate the preferred size for this picture.
  4966. @param scale the amount by which image dimensions are multiplied relative to the original size.
  4967. @return XSSFClientAnchor with the preferred size for this image
  4968. </member>
  4969. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetPreferredSize(System.Double,System.Double)">
  4970. Calculate the preferred size for this picture.
  4971. @param scaleX the amount by which image width is multiplied relative to the original width.
  4972. @param scaleY the amount by which image height is multiplied relative to the original height.
  4973. @return XSSFClientAnchor with the preferred size for this image
  4974. </member>
  4975. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetImageDimension(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.SS.UserModel.PictureType)">
  4976. Return the dimension of this image
  4977. @param part the namespace part holding raw picture data
  4978. @param type type of the picture: {@link Workbook#PICTURE_TYPE_JPEG},
  4979. {@link Workbook#PICTURE_TYPE_PNG} or {@link Workbook#PICTURE_TYPE_DIB}
  4980. @return image dimension in pixels
  4981. </member>
  4982. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetImageDimension">
  4983. Return the dimension of the embedded image in pixel
  4984. @return image dimension in pixels
  4985. </member>
  4986. <member name="P:NPOI.XSSF.UserModel.XSSFPicture.ClientAnchor">
  4987. @return the anchor that is used by this shape.
  4988. </member>
  4989. <member name="P:NPOI.XSSF.UserModel.XSSFPicture.Sheet">
  4990. @return the sheet which contains the picture shape
  4991. </member>
  4992. <member name="T:NPOI.XSSF.UserModel.XSSFPictureData">
  4993. Raw picture data, normally attached to a SpreadsheetML Drawing.
  4994. As a rule, pictures are stored in the /xl/media/ part of a SpreadsheetML package.
  4995. </member>
  4996. <member name="F:NPOI.XSSF.UserModel.XSSFPictureData.RELATIONS">
  4997. Relationships for each known picture type
  4998. </member>
  4999. <member name="M:NPOI.XSSF.UserModel.XSSFPictureData.#ctor">
  5000. Create a new XSSFPictureData node
  5001. @see NPOI.xssf.usermodel.XSSFWorkbook#AddPicture(byte[], int)
  5002. </member>
  5003. <member name="M:NPOI.XSSF.UserModel.XSSFPictureData.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  5004. Construct XSSFPictureData from a namespace part
  5005. @param part the namespace part holding the Drawing data,
  5006. @param rel the namespace relationship holding this Drawing,
  5007. the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/image
  5008. </member>
  5009. <member name="M:NPOI.XSSF.UserModel.XSSFPictureData.SuggestFileExtension">
  5010. Suggests a file extension for this image.
  5011. @return the file extension.
  5012. </member>
  5013. <member name="P:NPOI.XSSF.UserModel.XSSFPictureData.PictureType">
  5014. Return an integer constant that specifies type of this picture
  5015. @return an integer constant that specifies type of this picture
  5016. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_EMF
  5017. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_WMF
  5018. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_PICT
  5019. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_JPEG
  5020. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_PNG
  5021. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_DIB
  5022. </member>
  5023. <member name="P:NPOI.XSSF.UserModel.XSSFPictureData.Data">
  5024. <summary>
  5025. Gets the picture data as a byte array.
  5026. </summary>
  5027. </member>
  5028. <member name="M:NPOI.XSSF.UserModel.XSSFPictureData.PrepareForCommit">
  5029. *PictureData objects store the actual content in the part directly without keeping a
  5030. copy like all others therefore we need to handle them differently.
  5031. </member>
  5032. <member name="M:NPOI.XSSF.UserModel.XSSFPivotCache.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  5033. Creates n XSSFPivotCache representing the given package part and relationship.
  5034. Should only be called when Reading in an existing file.
  5035. @param part - The package part that holds xml data representing this pivot cache defInition.
  5036. @param rel - the relationship of the given package part in the underlying OPC package
  5037. </member>
  5038. <member name="M:NPOI.XSSF.UserModel.XSSFPivotCacheDefinition.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  5039. Creates an XSSFPivotCacheDefintion representing the given package part and relationship.
  5040. Should only be called when Reading in an existing file.
  5041. @param part - The package part that holds xml data representing this pivot cache defInition.
  5042. @param rel - the relationship of the given package part in the underlying OPC package
  5043. </member>
  5044. <member name="M:NPOI.XSSF.UserModel.XSSFPivotCacheDefinition.GetPivotArea(NPOI.SS.UserModel.IWorkbook)">
  5045. Find the 2D base data area for the pivot table, either from its direct reference or named table/range.
  5046. @return AreaReference representing the current area defined by the pivot table
  5047. @ if the ref1 attribute is not contiguous or the name attribute is not found.
  5048. </member>
  5049. <member name="M:NPOI.XSSF.UserModel.XSSFPivotCacheDefinition.CreateCacheFields(NPOI.SS.UserModel.ISheet)">
  5050. Generates a cache field for each column in the reference area for the pivot table.
  5051. @param sheet The sheet where the data i collected from
  5052. </member>
  5053. <member name="M:NPOI.XSSF.UserModel.XSSFPivotCacheRecords.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  5054. Creates an XSSFPivotCacheRecords representing the given package part and relationship.
  5055. Should only be called when Reading in an existing file.
  5056. @param part - The package part that holds xml data representing this pivot cache records.
  5057. @param rel - the relationship of the given package part in the underlying OPC package
  5058. </member>
  5059. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  5060. Creates an XSSFPivotTable representing the given package part and relationship.
  5061. Should only be called when Reading in an existing file.
  5062. @param part - The package part that holds xml data representing this pivot table.
  5063. @param rel - the relationship of the given package part in the underlying OPC package
  5064. </member>
  5065. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.SetDefaultPivotTableDefinition">
  5066. Set default values for the table defInition.
  5067. </member>
  5068. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.CheckColumnIndex(System.Int32)">
  5069. Verify column index (relative to first column in1 pivot area) is within the
  5070. pivot area
  5071. @param columnIndex
  5072. @
  5073. </member>
  5074. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.AddRowLabel(System.Int32)">
  5075. Add a row label using data from the given column.
  5076. @param columnIndex the index of the column to be used as row label.
  5077. </member>
  5078. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.AddColumnLabel(NPOI.SS.UserModel.DataConsolidateFunction,System.Int32,System.String)">
  5079. Add a column label using data from the given column and specified function
  5080. @param columnIndex the index of the column to be used as column label.
  5081. @param function the function to be used on the data
  5082. The following functions exists:
  5083. Sum, Count, Average, Max, Min, Product, Count numbers, StdDev, StdDevp, Var, Varp
  5084. @param valueFieldName the name of pivot table value field
  5085. </member>
  5086. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.AddColumnLabel(NPOI.SS.UserModel.DataConsolidateFunction,System.Int32)">
  5087. Add a column label using data from the given column and specified function
  5088. @param columnIndex the index of the column to be used as column label.
  5089. @param function the function to be used on the data
  5090. The following functions exists:
  5091. Sum, Count, Average, Max, Min, Product, Count numbers, StdDev, StdDevp, Var, Varp
  5092. </member>
  5093. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.AddDataField(NPOI.SS.UserModel.DataConsolidateFunction,System.Int32,System.String)">
  5094. Add data field with data from the given column and specified function.
  5095. @param function the function to be used on the data
  5096. The following functions exists:
  5097. Sum, Count, Average, Max, Min, Product, Count numbers, StdDev, StdDevp, Var, Varp
  5098. @param columnIndex the index of the column to be used as column label.
  5099. @param valueFieldName the name of pivot table value field
  5100. </member>
  5101. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.AddDataColumn(System.Int32,System.Boolean)">
  5102. Add column Containing data from the referenced area.
  5103. @param columnIndex the index of the column Containing the data
  5104. @param isDataField true if the data should be displayed in the pivot table.
  5105. </member>
  5106. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.AddReportFilter(System.Int32)">
  5107. Add filter for the column with the corresponding index and cell value
  5108. @param columnIndex index of column to filter on
  5109. </member>
  5110. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.CreateSourceReferences(NPOI.SS.Util.CellReference,NPOI.SS.UserModel.ISheet,NPOI.XSSF.UserModel.XSSFPivotTable.IPivotTableReferenceConfigurator)">
  5111. Creates cacheSource and workSheetSource for pivot table and sets the source reference as well assets the location of the pivot table
  5112. @param sourceRef Source for data for pivot table - mutually exclusive with sourceName
  5113. @param sourceName Source for data for pivot table - mutually exclusive with sourceRef
  5114. @param position Position for pivot table in sheet
  5115. @param sourceSheet Sheet where the source will be collected from
  5116. </member>
  5117. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.IPivotTableReferenceConfigurator.ConfigureReference(NPOI.OpenXmlFormats.Spreadsheet.CT_WorksheetSource)">
  5118. Configure the name or area reference for the pivot table
  5119. @param wsSource CTWorksheetSource that needs the pivot source reference assignment
  5120. </member>
  5121. <member name="T:NPOI.XSSF.UserModel.XSSFPrintSetup">
  5122. Page Setup and page margins Settings for the worksheet.
  5123. </member>
  5124. <member name="M:NPOI.XSSF.UserModel.XSSFPrintSetup.SetPaperSize(NPOI.SS.UserModel.PaperSize)">
  5125. Set the paper size as enum value.
  5126. @param size value for the paper size.
  5127. </member>
  5128. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Orientation">
  5129. Orientation of the page: landscape - portrait.
  5130. @return Orientation of the page
  5131. @see PrintOrientation
  5132. </member>
  5133. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.PageOrder">
  5134. Get print page order.
  5135. @return PageOrder
  5136. </member>
  5137. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.PaperSize">
  5138. Returns the paper size.
  5139. @return short - paper size
  5140. </member>
  5141. <member name="M:NPOI.XSSF.UserModel.XSSFPrintSetup.GetPaperSizeEnum">
  5142. Returns the paper size as enum.
  5143. @return PaperSize paper size
  5144. @see PaperSize
  5145. </member>
  5146. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Scale">
  5147. Returns the scale.
  5148. @return short - scale
  5149. </member>
  5150. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.PageStart">
  5151. Set the page numbering start.
  5152. Page number for first printed page. If no value is specified, then 'automatic' is assumed.
  5153. @return page number for first printed page
  5154. </member>
  5155. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.FitWidth">
  5156. Returns the number of pages wide to fit sheet in.
  5157. @return number of pages wide to fit sheet in
  5158. </member>
  5159. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.FitHeight">
  5160. Returns the number of pages high to fit the sheet in.
  5161. @return number of pages high to fit the sheet in
  5162. </member>
  5163. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.LeftToRight">
  5164. Returns the left to right print order.
  5165. @return left to right print order
  5166. </member>
  5167. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Landscape">
  5168. Returns the landscape mode.
  5169. @return landscape mode
  5170. </member>
  5171. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.ValidSettings">
  5172. Use the printer's defaults Settings for page Setup values and don't use the default values
  5173. specified in the schema. For example, if dpi is not present or specified in the XML, the
  5174. application shall not assume 600dpi as specified in the schema as a default and instead
  5175. shall let the printer specify the default dpi.
  5176. @return valid Settings
  5177. </member>
  5178. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.NoColor">
  5179. Returns the black and white Setting.
  5180. @return black and white Setting
  5181. </member>
  5182. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Draft">
  5183. Returns the draft mode.
  5184. @return draft mode
  5185. </member>
  5186. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Notes">
  5187. Returns the print notes.
  5188. @return print notes
  5189. </member>
  5190. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.NoOrientation">
  5191. Returns the no orientation.
  5192. @return no orientation
  5193. </member>
  5194. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.UsePage">
  5195. Returns the use page numbers.
  5196. @return use page numbers
  5197. </member>
  5198. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.HResolution">
  5199. Returns the horizontal resolution.
  5200. @return horizontal resolution
  5201. </member>
  5202. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.VResolution">
  5203. Returns the vertical resolution.
  5204. @return vertical resolution
  5205. </member>
  5206. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.HeaderMargin">
  5207. Returns the header margin.
  5208. @return header margin
  5209. </member>
  5210. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.FooterMargin">
  5211. Returns the footer margin.
  5212. @return footer margin
  5213. </member>
  5214. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Copies">
  5215. Returns the number of copies.
  5216. @return number of copies
  5217. </member>
  5218. <member name="T:NPOI.XSSF.UserModel.XSSFRelation">
  5219. <summary>
  5220. Defines namespaces, content types and normal file names / naming
  5221. patterns, for the well-known XSSF format parts.
  5222. </summary>
  5223. </member>
  5224. <member name="F:NPOI.XSSF.UserModel.XSSFRelation._table">
  5225. A map to lookup POIXMLRelation by its relation type
  5226. </member>
  5227. <member name="F:NPOI.XSSF.UserModel.XSSFRelation.IMAGE_JPG">
  5228. JPG is an intentional duplicate of JPEG, to handle documents generated by other software. *
  5229. </member>
  5230. <member name="M:NPOI.XSSF.UserModel.XSSFRelation.GetContents(NPOI.OpenXml4Net.OPC.PackagePart)">
  5231. Fetches the InputStream to read the contents, based
  5232. of the specified core part, for which we are defined
  5233. as a suitable relationship
  5234. </member>
  5235. <member name="M:NPOI.XSSF.UserModel.XSSFRelation.GetInstance(System.String)">
  5236. Get POIXMLRelation by relation type
  5237. @param rel relation type, for example,
  5238. <code>http://schemas.openxmlformats.org/officeDocument/2006/relationships/image</code>
  5239. @return registered POIXMLRelation or null if not found
  5240. </member>
  5241. <member name="M:NPOI.XSSF.UserModel.XSSFRelation.RemoveRelation(NPOI.XSSF.UserModel.XSSFRelation)">
  5242. <summary>
  5243. Removes the relation from the internal table.
  5244. Following readings of files will ignoring the removed relation.
  5245. </summary>
  5246. <param name="relation">Relation to remove</param>
  5247. </member>
  5248. <member name="M:NPOI.XSSF.UserModel.XSSFRelation.AddRelation(NPOI.XSSF.UserModel.XSSFRelation)">
  5249. <summary>
  5250. Adds the relation to the internal table.
  5251. Following readings of files will process the given relation.
  5252. </summary>
  5253. <param name="relation">Relation to add</param>
  5254. </member>
  5255. <member name="T:NPOI.XSSF.UserModel.XSSFRichTextString">
  5256. Rich text unicode string. These strings can have fonts applied to arbitary parts of the string.
  5257. <p>
  5258. Most strings in a workbook have formatting applied at the cell level, that is, the entire string in the cell has the
  5259. same formatting applied. In these cases, the formatting for the cell is stored in the styles part,
  5260. and the string for the cell can be shared across the workbook. The following code illustrates the example.
  5261. </p>
  5262. <blockquote>
  5263. <pre>
  5264. cell1.SetCellValue(new XSSFRichTextString("Apache POI"));
  5265. cell2.SetCellValue(new XSSFRichTextString("Apache POI"));
  5266. cell3.SetCellValue(new XSSFRichTextString("Apache POI"));
  5267. </pre>
  5268. </blockquote>
  5269. In the above example all three cells will use the same string cached on workbook level.
  5270. <p>
  5271. Some strings in the workbook may have formatting applied at a level that is more granular than the cell level.
  5272. For instance, specific characters within the string may be bolded, have coloring, italicizing, etc.
  5273. In these cases, the formatting is stored along with the text in the string table, and is treated as
  5274. a unique entry in the workbook. The following xml and code snippet illustrate this.
  5275. </p>
  5276. <blockquote>
  5277. <pre>
  5278. XSSFRichTextString s1 = new XSSFRichTextString("Apache POI");
  5279. s1.ApplyFont(boldArial);
  5280. cell1.SetCellValue(s1);
  5281. XSSFRichTextString s2 = new XSSFRichTextString("Apache POI");
  5282. s2.ApplyFont(italicCourier);
  5283. cell2.SetCellValue(s2);
  5284. </pre>
  5285. </blockquote>
  5286. @author Yegor Kozlov
  5287. </member>
  5288. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.#ctor(System.String)">
  5289. Create a rich text string
  5290. </member>
  5291. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.#ctor">
  5292. Create empty rich text string and Initialize it with empty string
  5293. </member>
  5294. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Rst)">
  5295. Create a rich text string from the supplied XML bean
  5296. </member>
  5297. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ApplyFont(System.Int32,System.Int32,System.Int16)">
  5298. Applies a font to the specified characters of a string.
  5299. @param startIndex The start index to apply the font to (inclusive)
  5300. @param endIndex The end index to apply the font to (exclusive)
  5301. @param fontIndex The font to use.
  5302. </member>
  5303. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ApplyFont(System.Int32,System.Int32,NPOI.SS.UserModel.IFont)">
  5304. Applies a font to the specified characters of a string.
  5305. @param startIndex The start index to apply the font to (inclusive)
  5306. @param endIndex The end index to apply to font to (exclusive)
  5307. @param font The index of the font to use.
  5308. </member>
  5309. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ApplyFont(NPOI.SS.UserModel.IFont)">
  5310. Sets the font of the entire string.
  5311. @param font The font to use.
  5312. </member>
  5313. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ApplyFont(System.Int16)">
  5314. Applies the specified font to the entire string.
  5315. @param fontIndex the font to Apply.
  5316. </member>
  5317. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.Append(System.String,NPOI.XSSF.UserModel.XSSFFont)">
  5318. Append new text to this text run and apply the specify font to it
  5319. @param text the text to append
  5320. @param font the font to apply to the Appended text or <code>null</code> if no formatting is required
  5321. </member>
  5322. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.Append(System.String)">
  5323. Append new text to this text run
  5324. @param text the text to append
  5325. </member>
  5326. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.SetRunAttributes(NPOI.OpenXmlFormats.Spreadsheet.CT_Font,NPOI.OpenXmlFormats.Spreadsheet.CT_RPrElt)">
  5327. Copy font attributes from CTFont bean into CTRPrElt bean
  5328. </member>
  5329. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.HasFormatting">
  5330. Does this string have any explicit formatting applied, or is
  5331. it just text in the default style?
  5332. </member>
  5333. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ClearFormatting">
  5334. Removes any formatting that may have been applied to the string.
  5335. </member>
  5336. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetIndexOfFormattingRun(System.Int32)">
  5337. The index within the string to which the specified formatting run applies.
  5338. @param index the index of the formatting run
  5339. @return the index within the string.
  5340. </member>
  5341. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetLengthOfFormattingRun(System.Int32)">
  5342. Returns the number of characters this format run covers.
  5343. @param index the index of the formatting run
  5344. @return the number of characters this format run covers
  5345. </member>
  5346. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ToString">
  5347. Returns the plain string representation.
  5348. </member>
  5349. <member name="P:NPOI.XSSF.UserModel.XSSFRichTextString.Length">
  5350. Returns the number of characters in this string.
  5351. </member>
  5352. <member name="P:NPOI.XSSF.UserModel.XSSFRichTextString.NumFormattingRuns">
  5353. @return The number of formatting Runs used.
  5354. </member>
  5355. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetFontOfFormattingRun(System.Int32)">
  5356. Gets a copy of the font used in a particular formatting Run.
  5357. @param index the index of the formatting run
  5358. @return A copy of the font used or null if no formatting is applied to the specified text Run.
  5359. </member>
  5360. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetFontAtIndex(System.Int32)">
  5361. Return a copy of the font in use at a particular index.
  5362. @param index The index.
  5363. @return A copy of the font that's currently being applied at that
  5364. index or null if no font is being applied or the
  5365. index is out of range.
  5366. </member>
  5367. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetCTRst">
  5368. Return the underlying xml bean
  5369. </member>
  5370. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ToCTFont(NPOI.OpenXmlFormats.Spreadsheet.CT_RPrElt)">
  5371. CTRPrElt --> CTFont adapter
  5372. </member>
  5373. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.PreserveSpaces(System.String)">
  5374. **
  5375. </member>
  5376. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.UtfDecode(System.String)">
  5377. For all characters which cannot be represented in XML as defined by the XML 1.0 specification,
  5378. the characters are escaped using the Unicode numerical character representation escape character
  5379. format _xHHHH_, where H represents a hexadecimal character in the character's value.
  5380. <p>
  5381. Example: The Unicode character 0D is invalid in an XML 1.0 document,
  5382. so it shall be escaped as <code>_x000D_</code>.
  5383. </p>
  5384. See section 3.18.9 in the OOXML spec.
  5385. @param value the string to decode
  5386. @return the decoded string
  5387. </member>
  5388. <member name="T:NPOI.XSSF.UserModel.XSSFRow">
  5389. High level representation of a row of a spreadsheet.
  5390. </member>
  5391. <member name="F:NPOI.XSSF.UserModel.XSSFRow._row">
  5392. the xml bean Containing all cell defInitions for this row
  5393. </member>
  5394. <member name="F:NPOI.XSSF.UserModel.XSSFRow._cells">
  5395. Cells of this row keyed by their column indexes.
  5396. The TreeMap ensures that the cells are ordered by columnIndex in the ascending order.
  5397. </member>
  5398. <member name="F:NPOI.XSSF.UserModel.XSSFRow._sheet">
  5399. the parent sheet
  5400. </member>
  5401. <member name="M:NPOI.XSSF.UserModel.XSSFRow.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Row,NPOI.XSSF.UserModel.XSSFSheet)">
  5402. Construct a XSSFRow.
  5403. @param row the xml bean Containing all cell defInitions for this row.
  5404. @param sheet the parent sheet.
  5405. </member>
  5406. <member name="P:NPOI.XSSF.UserModel.XSSFRow.Sheet">
  5407. Returns the XSSFSheet this row belongs to
  5408. @return the XSSFSheet that owns this row
  5409. </member>
  5410. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFRow.CellIterator" -->
  5411. <member name="M:NPOI.XSSF.UserModel.XSSFRow.GetEnumerator">
  5412. Alias for {@link #cellIterator()} to allow foreach loops:
  5413. <blockquote><pre>
  5414. for(Cell cell : row){
  5415. ...
  5416. }
  5417. </pre></blockquote>
  5418. @return an iterator over cells in this row.
  5419. </member>
  5420. <member name="M:NPOI.XSSF.UserModel.XSSFRow.CompareTo(NPOI.XSSF.UserModel.XSSFRow)">
  5421. Compares two <code>XSSFRow</code> objects. Two rows are equal if they belong to the same worksheet and
  5422. their row indexes are equal.
  5423. @param row the <code>XSSFRow</code> to be compared.
  5424. @return <ul>
  5425. <li>
  5426. the value <code>0</code> if the row number of this <code>XSSFRow</code> is
  5427. equal to the row number of the argument <code>XSSFRow</code>
  5428. </li>
  5429. <li>
  5430. a value less than <code>0</code> if the row number of this this <code>XSSFRow</code> is
  5431. numerically less than the row number of the argument <code>XSSFRow</code>
  5432. </li>
  5433. <li>
  5434. a value greater than <code>0</code> if the row number of this this <code>XSSFRow</code> is
  5435. numerically greater than the row number of the argument <code>XSSFRow</code>
  5436. </li>
  5437. </ul>
  5438. @throws IllegalArgumentException if the argument row belongs to a different worksheet
  5439. </member>
  5440. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFRow.CreateCell(System.Int32)" -->
  5441. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFRow.CreateCell(System.Int32,NPOI.SS.UserModel.CellType)" -->
  5442. <member name="M:NPOI.XSSF.UserModel.XSSFRow.GetCell(System.Int32)">
  5443. Returns the cell at the given (0 based) index,
  5444. with the {@link NPOI.SS.usermodel.Row.MissingCellPolicy} from the parent Workbook.
  5445. @return the cell at the given (0 based) index
  5446. </member>
  5447. <member name="M:NPOI.XSSF.UserModel.XSSFRow.RetrieveCell(System.Int32)">
  5448. <summary>
  5449. Get the hssfcell representing a given column (logical cell)
  5450. 0-based. If you ask for a cell that is not defined, then
  5451. you Get a null.
  5452. This is the basic call, with no policies applied
  5453. </summary>
  5454. <param name="cellnum">0 based column number</param>
  5455. <returns>Cell representing that column or null if Undefined.</returns>
  5456. </member>
  5457. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFRow.GetCell(System.Int32,NPOI.SS.UserModel.MissingCellPolicy)" -->
  5458. <member name="P:NPOI.XSSF.UserModel.XSSFRow.FirstCellNum">
  5459. Get the number of the first cell Contained in this row.
  5460. @return short representing the first logical cell in the row,
  5461. or -1 if the row does not contain any cells.
  5462. </member>
  5463. <member name="P:NPOI.XSSF.UserModel.XSSFRow.LastCellNum">
  5464. Gets the index of the last cell Contained in this row <b>PLUS ONE</b>. The result also
  5465. happens to be the 1-based column number of the last cell. This value can be used as a
  5466. standard upper bound when iterating over cells:
  5467. <pre>
  5468. short minColIx = row.GetFirstCellNum();
  5469. short maxColIx = row.GetLastCellNum();
  5470. for(short colIx=minColIx; colIx&lt;maxColIx; colIx++) {
  5471. XSSFCell cell = row.GetCell(colIx);
  5472. if(cell == null) {
  5473. continue;
  5474. }
  5475. //... do something with cell
  5476. }
  5477. </pre>
  5478. @return short representing the last logical cell in the row <b>PLUS ONE</b>,
  5479. or -1 if the row does not contain any cells.
  5480. </member>
  5481. <member name="P:NPOI.XSSF.UserModel.XSSFRow.Height">
  5482. 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,
  5483. See {@link NPOI.XSSF.usermodel.XSSFSheet#GetDefaultRowHeightInPoints()}
  5484. @return row height measured in twips (1/20th of a point)
  5485. </member>
  5486. <member name="P:NPOI.XSSF.UserModel.XSSFRow.HeightInPoints">
  5487. Returns row height measured in point size. If the height is not Set, the default worksheet value is returned,
  5488. See {@link NPOI.XSSF.usermodel.XSSFSheet#GetDefaultRowHeightInPoints()}
  5489. @return row height measured in point size
  5490. @see NPOI.XSSF.usermodel.XSSFSheet#GetDefaultRowHeightInPoints()
  5491. </member>
  5492. <member name="P:NPOI.XSSF.UserModel.XSSFRow.PhysicalNumberOfCells">
  5493. Gets the number of defined cells (NOT number of cells in the actual row!).
  5494. That is to say if only columns 0,4,5 have values then there would be 3.
  5495. @return int representing the number of defined cells in the row.
  5496. </member>
  5497. <member name="P:NPOI.XSSF.UserModel.XSSFRow.RowNum">
  5498. Get row number this row represents
  5499. @return the row number (0 based)
  5500. </member>
  5501. <member name="P:NPOI.XSSF.UserModel.XSSFRow.ZeroHeight">
  5502. Get whether or not to display this row with 0 height
  5503. @return - height is zero or not.
  5504. </member>
  5505. <member name="P:NPOI.XSSF.UserModel.XSSFRow.IsFormatted">
  5506. Is this row formatted? Most aren't, but some rows
  5507. do have whole-row styles. For those that do, you
  5508. can get the formatting from {@link #GetRowStyle()}
  5509. </member>
  5510. <member name="P:NPOI.XSSF.UserModel.XSSFRow.RowStyle">
  5511. Returns the whole-row cell style. Most rows won't
  5512. have one of these, so will return null. Call
  5513. {@link #isFormatted()} to check first.
  5514. </member>
  5515. <member name="M:NPOI.XSSF.UserModel.XSSFRow.SetRowStyle(NPOI.SS.UserModel.ICellStyle)">
  5516. Applies a whole-row cell styling to the row.
  5517. If the value is null then the style information is Removed,
  5518. causing the cell to used the default workbook style.
  5519. </member>
  5520. <member name="M:NPOI.XSSF.UserModel.XSSFRow.RemoveCell(NPOI.SS.UserModel.ICell)">
  5521. Remove the Cell from this row.
  5522. @param cell the cell to remove
  5523. </member>
  5524. <member name="M:NPOI.XSSF.UserModel.XSSFRow.GetCTRow">
  5525. Returns the underlying CT_Row xml bean Containing all cell defInitions in this row
  5526. @return the underlying CT_Row xml bean
  5527. </member>
  5528. <member name="M:NPOI.XSSF.UserModel.XSSFRow.OnDocumentWrite">
  5529. Fired when the document is written to an output stream.
  5530. @see NPOI.XSSF.usermodel.XSSFSheet#Write(java.io.OutputStream) ()
  5531. </member>
  5532. <member name="M:NPOI.XSSF.UserModel.XSSFRow.ToString">
  5533. @return formatted xml representation of this row
  5534. </member>
  5535. <member name="M:NPOI.XSSF.UserModel.XSSFRow.Shift(System.Int32)">
  5536. update cell references when Shifting rows
  5537. @param n the number of rows to move
  5538. </member>
  5539. <member name="M:NPOI.XSSF.UserModel.XSSFRow.CopyRowFrom(NPOI.SS.UserModel.IRow,NPOI.SS.UserModel.CellCopyPolicy)">
  5540. Copy the cells from srcRow to this row
  5541. If this row is not a blank row, this will merge the two rows, overwriting
  5542. the cells in this row with the cells in srcRow
  5543. If srcRow is null, overwrite cells in destination row with blank values, styles, etc per cell copy policy
  5544. srcRow may be from a different sheet in the same workbook
  5545. @param srcRow the rows to copy from
  5546. @param policy the policy to determine what gets copied
  5547. </member>
  5548. <member name="T:NPOI.XSSF.UserModel.XSSFShape">
  5549. Represents a shape in a SpreadsheetML Drawing.
  5550. @author Yegor Kozlov
  5551. </member>
  5552. <member name="F:NPOI.XSSF.UserModel.XSSFShape.drawing">
  5553. Parent Drawing
  5554. </member>
  5555. <member name="F:NPOI.XSSF.UserModel.XSSFShape.parent">
  5556. The parent shape, always not-null for shapes in groups
  5557. </member>
  5558. <member name="F:NPOI.XSSF.UserModel.XSSFShape.anchor">
  5559. anchor that is used by this shape
  5560. </member>
  5561. <member name="M:NPOI.XSSF.UserModel.XSSFShape.GetDrawing">
  5562. Return the Drawing that owns this shape
  5563. @return the parent Drawing that owns this shape
  5564. </member>
  5565. <member name="P:NPOI.XSSF.UserModel.XSSFShape.Parent">
  5566. Gets the parent shape.
  5567. </member>
  5568. <member name="M:NPOI.XSSF.UserModel.XSSFShape.GetAnchor">
  5569. @return the anchor that is used by this shape.
  5570. </member>
  5571. <member name="M:NPOI.XSSF.UserModel.XSSFShape.GetShapeProperties">
  5572. Returns xml bean with shape properties.
  5573. @return xml bean with shape properties.
  5574. </member>
  5575. <member name="P:NPOI.XSSF.UserModel.XSSFShape.IsNoFill">
  5576. Whether this shape is not Filled with a color
  5577. @return true if this shape is not Filled with a color.
  5578. </member>
  5579. <member name="M:NPOI.XSSF.UserModel.XSSFShape.SetFillColor(System.Int32,System.Int32,System.Int32)">
  5580. Sets the color used to fill this shape using the solid fill pattern.
  5581. </member>
  5582. <member name="M:NPOI.XSSF.UserModel.XSSFShape.SetLineStyleColor(System.Int32,System.Int32,System.Int32)">
  5583. The color applied to the lines of this shape.
  5584. </member>
  5585. <member name="T:NPOI.XSSF.UserModel.XSSFShapeGroup">
  5586. This object specifies a group shape that represents many shapes grouped together. This shape is to be treated
  5587. just as if it were a regular shape but instead of being described by a single geometry it is made up of all the
  5588. shape geometries encompassed within it. Within a group shape each of the shapes that make up the group are
  5589. specified just as they normally would.
  5590. @author Yegor Kozlov
  5591. </member>
  5592. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_GroupShape)">
  5593. Construct a new XSSFSimpleShape object.
  5594. @param Drawing the XSSFDrawing that owns this shape
  5595. @param ctGroup the XML bean that stores this group content
  5596. </member>
  5597. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.Prototype">
  5598. Initialize default structure of a new shape group
  5599. </member>
  5600. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.CreateTextbox(NPOI.XSSF.UserModel.XSSFChildAnchor)">
  5601. Constructs a textbox.
  5602. @param anchor the child anchor describes how this shape is attached
  5603. to the group.
  5604. @return the newly Created textbox.
  5605. </member>
  5606. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.CreateSimpleShape(NPOI.XSSF.UserModel.XSSFChildAnchor)">
  5607. Creates a simple shape. This includes such shapes as lines, rectangles,
  5608. and ovals.
  5609. @param anchor the child anchor describes how this shape is attached
  5610. to the group.
  5611. @return the newly Created shape.
  5612. </member>
  5613. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.CreateConnector(NPOI.XSSF.UserModel.XSSFChildAnchor)">
  5614. Creates a simple shape. This includes such shapes as lines, rectangles,
  5615. and ovals.
  5616. @param anchor the child anchor describes how this shape is attached
  5617. to the group.
  5618. @return the newly Created shape.
  5619. </member>
  5620. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.CreatePicture(NPOI.XSSF.UserModel.XSSFClientAnchor,System.Int32)">
  5621. Creates a picture.
  5622. @param anchor the client anchor describes how this picture is attached to the sheet.
  5623. @param pictureIndex the index of the picture in the workbook collection of pictures,
  5624. {@link XSSFWorkbook#getAllPictures()} .
  5625. @return the newly Created picture shape.
  5626. </member>
  5627. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.SetCoordinates(System.Int32,System.Int32,System.Int32,System.Int32)">
  5628. Sets the coordinate space of this group. All children are constrained
  5629. to these coordinates.
  5630. </member>
  5631. <member name="T:NPOI.XSSF.UserModel.XSSFSheet">
  5632. High level representation of a SpreadsheetML worksheet.
  5633. <p>
  5634. Sheets are the central structures within a workbook, and are where a user does most of his spreadsheet work.
  5635. The most common type of sheet is the worksheet, which is represented as a grid of cells. Worksheet cells can
  5636. contain text, numbers, dates, and formulas. Cells can also be formatted.
  5637. </p>
  5638. </member>
  5639. <member name="F:NPOI.XSSF.UserModel.XSSFSheet.sharedFormulas">
  5640. cache of master shared formulas in this sheet.
  5641. Master shared formula is the first formula in a group of shared formulas is saved in the f element.
  5642. </member>
  5643. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.#ctor">
  5644. Creates new XSSFSheet - called by XSSFWorkbook to create a sheet from scratch.
  5645. @see NPOI.XSSF.usermodel.XSSFWorkbook#CreateSheet()
  5646. </member>
  5647. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  5648. Creates an XSSFSheet representing the given namespace part and relationship.
  5649. Should only be called by XSSFWorkbook when Reading in an exisiting file.
  5650. @param part - The namespace part that holds xml data represenring this sheet.
  5651. @param rel - the relationship of the given namespace part in the underlying OPC namespace
  5652. </member>
  5653. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Workbook">
  5654. Returns the parent XSSFWorkbook
  5655. @return the parent XSSFWorkbook
  5656. </member>
  5657. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.OnDocumentRead">
  5658. Initialize worksheet data when Reading in an exisiting file.
  5659. </member>
  5660. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.OnDocumentCreate">
  5661. Initialize worksheet data when creating a new sheet.
  5662. </member>
  5663. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.InitHyperlinks">
  5664. Read hyperlink relations, link them with CT_Hyperlink beans in this worksheet
  5665. and Initialize the internal array of XSSFHyperlink objects
  5666. </member>
  5667. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.NewSheet">
  5668. Create a new CT_Worksheet instance with all values set to defaults
  5669. @return a new instance
  5670. </member>
  5671. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCTWorksheet">
  5672. Provide access to the CT_Worksheet bean holding this sheet's data
  5673. @return the CT_Worksheet bean holding this sheet's data
  5674. </member>
  5675. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.SheetName">
  5676. Returns the name of this sheet
  5677. @return the name of this sheet
  5678. </member>
  5679. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AddMergedRegion(NPOI.SS.Util.CellRangeAddress)">
  5680. <summary>
  5681. Adds a merged region of cells on a sheet.
  5682. </summary>
  5683. <param name="region">region to merge</param>
  5684. <returns>index of this region</returns>
  5685. <exception cref="T:System.ArgumentException">if region contains fewer than 2 cells</exception>
  5686. <exception cref="T:System.InvalidOperationException">if region intersects with an existing merged region
  5687. or multi-cell array formula on this sheet</exception>
  5688. </member>
  5689. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AddMergedRegionUnsafe(NPOI.SS.Util.CellRangeAddress)">
  5690. <summary>
  5691. Adds a merged region of cells (hence those cells form one).
  5692. Skips validation.It is possible to create overlapping merged regions
  5693. or create a merged region that intersects a multi-cell array formula
  5694. with this formula, which may result in a corrupt workbook.
  5695. </summary>
  5696. <param name="region">region to merge</param>
  5697. <returns>index of this region</returns>
  5698. <exception cref="T:System.ArgumentException">if region contains fewer than 2 cells</exception>
  5699. </member>
  5700. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AddMergedRegion(NPOI.SS.Util.CellRangeAddress,System.Boolean)">
  5701. <summary>
  5702. Adds a merged region of cells (hence those cells form one).
  5703. </summary>
  5704. <param name="region">region (rowfrom/colfrom-rowto/colto) to merge</param>
  5705. <param name="validate">whether to validate merged region</param>
  5706. <returns>index of this region</returns>
  5707. <exception cref="T:System.InvalidOperationException">if region intersects with a multi-cell array formula or
  5708. if region intersects with an existing region on this sheet</exception>
  5709. <exception cref="T:System.ArgumentException">if region contains fewer than 2 cells</exception>
  5710. </member>
  5711. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ValidateArrayFormulas(NPOI.SS.Util.CellRangeAddress)">
  5712. Verify that the candidate region does not intersect with an existing multi-cell array formula in this sheet
  5713. @param region
  5714. @throws InvalidOperationException if candidate region intersects an existing array formula in this sheet
  5715. </member>
  5716. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CheckForMergedRegionsIntersectingArrayFormulas">
  5717. Verify that none of the merged regions intersect a multi-cell array formula in this sheet
  5718. @param region
  5719. @throws InvalidOperationException if candidate region intersects an existing array formula in this sheet
  5720. </member>
  5721. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ValidateMergedRegions(NPOI.SS.Util.CellRangeAddress)">
  5722. Verify that candidate region does not intersect with an existing merged region in this sheet
  5723. @param candidateRegion
  5724. @throws InvalidOperationException if candidate region intersects an existing merged region in this sheet
  5725. </member>
  5726. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CheckForIntersectingMergedRegions">
  5727. Verify that no merged regions intersect another merged region in this sheet.
  5728. @throws InvalidOperationException if at least one region intersects with another merged region in this sheet
  5729. </member>
  5730. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ValidateMergedRegions">
  5731. Verify that merged regions do not intersect multi-cell array formulas and
  5732. no merged regions intersect another merged region in this sheet.
  5733. @throws InvalidOperationException if region intersects with a multi-cell array formula
  5734. @throws InvalidOperationException if at least one region intersects with another merged region in this sheet
  5735. </member>
  5736. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AutoSizeColumn(System.Int32)">
  5737. Adjusts the column width to fit the contents.
  5738. This process can be relatively slow on large sheets, so this should
  5739. normally only be called once per column, at the end of your
  5740. Processing.
  5741. @param column the column index
  5742. </member>
  5743. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AutoSizeColumn(System.Int32,System.Boolean)">
  5744. Adjusts the column width to fit the contents.
  5745. <p>
  5746. This process can be relatively slow on large sheets, so this should
  5747. normally only be called once per column, at the end of your
  5748. Processing.
  5749. </p>
  5750. You can specify whether the content of merged cells should be considered or ignored.
  5751. Default is to ignore merged cells.
  5752. @param column the column index
  5753. @param useMergedCells whether to use the contents of merged cells when calculating the width of the column
  5754. </member>
  5755. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetDrawingPatriarch">
  5756. Return the sheet's existing Drawing, or null if there isn't yet one.
  5757. Use {@link #CreateDrawingPatriarch()} to Get or create
  5758. @return a SpreadsheetML Drawing
  5759. </member>
  5760. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateDrawingPatriarch">
  5761. Create a new SpreadsheetML Drawing. If this sheet already Contains a Drawing - return that.
  5762. @return a SpreadsheetML Drawing
  5763. </member>
  5764. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetVMLDrawing(System.Boolean)">
  5765. Get VML drawing for this sheet (aka 'legacy' drawig)
  5766. @param autoCreate if true, then a new VML drawing part is Created
  5767. @return the VML drawing of <code>null</code> if the drawing was not found and autoCreate=false
  5768. </member>
  5769. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateFreezePane(System.Int32,System.Int32)">
  5770. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  5771. @param colSplit Horizonatal position of split.
  5772. @param rowSplit Vertical position of split.
  5773. </member>
  5774. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateFreezePane(System.Int32,System.Int32,System.Int32,System.Int32)">
  5775. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  5776. <p>
  5777. If both colSplit and rowSplit are zero then the existing freeze pane is Removed
  5778. </p>
  5779. @param colSplit Horizonatal position of split.
  5780. @param rowSplit Vertical position of split.
  5781. @param leftmostColumn Left column visible in right pane.
  5782. @param topRow Top row visible in bottom pane
  5783. </member>
  5784. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateRow(System.Int32)">
  5785. Create a new row within the sheet and return the high level representation
  5786. @param rownum row number
  5787. @return High level {@link XSSFRow} object representing a row in the sheet
  5788. @see #RemoveRow(NPOI.SS.usermodel.Row)
  5789. </member>
  5790. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateSplitPane(System.Int32,System.Int32,System.Int32,System.Int32,NPOI.SS.UserModel.PanePosition)">
  5791. Creates a split pane. Any existing freezepane or split pane is overwritten.
  5792. @param xSplitPos Horizonatal position of split (in 1/20th of a point).
  5793. @param ySplitPos Vertical position of split (in 1/20th of a point).
  5794. @param topRow Top row visible in bottom pane
  5795. @param leftmostColumn Left column visible in right pane.
  5796. @param activePane Active pane. One of: PANE_LOWER_RIGHT,
  5797. PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFT
  5798. @see NPOI.SS.usermodel.Sheet#PANE_LOWER_LEFT
  5799. @see NPOI.SS.usermodel.Sheet#PANE_LOWER_RIGHT
  5800. @see NPOI.SS.usermodel.Sheet#PANE_UPPER_LEFT
  5801. @see NPOI.SS.usermodel.Sheet#PANE_UPPER_RIGHT
  5802. </member>
  5803. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCellComment(System.Int32,System.Int32)">
  5804. <summary>
  5805. Returns cell comment for the specified row and column
  5806. </summary>
  5807. <param name="row">The row.</param>
  5808. <param name="column">The column.</param>
  5809. <returns>cell comment or <code>null</code> if not found</returns>
  5810. </member>
  5811. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCellComment(NPOI.SS.Util.CellAddress)">
  5812. <summary>
  5813. Returns cell comment for the specified location
  5814. </summary>
  5815. <param name="address">cell location</param>
  5816. <returns>return cell comment or null if not found</returns>
  5817. </member>
  5818. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCellComments">
  5819. <summary>
  5820. Returns all cell comments on this sheet.
  5821. </summary>
  5822. <returns>return A Dictionary of each Comment in the sheet, keyed on the cell address where the comment is located.</returns>
  5823. </member>
  5824. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetHyperlink(System.Int32,System.Int32)">
  5825. <summary>
  5826. Get a Hyperlink in this sheet anchored at row, column
  5827. </summary>
  5828. <param name="row"></param>
  5829. <param name="column"></param>
  5830. <returns>return hyperlink if there is a hyperlink anchored at row, column; otherwise returns null</returns>
  5831. </member>
  5832. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetHyperlink(NPOI.SS.Util.CellAddress)">
  5833. <summary>
  5834. Get a Hyperlink in this sheet located in a cell specified by {code addr}
  5835. </summary>
  5836. <param name="addr">The address of the cell containing the hyperlink</param>
  5837. <returns>return hyperlink if there is a hyperlink anchored at {@code addr}; otherwise returns {@code null}</returns>
  5838. </member>
  5839. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetHyperlinkList">
  5840. <summary>
  5841. Get a list of Hyperlinks in this sheet
  5842. </summary>
  5843. <returns></returns>
  5844. </member>
  5845. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.ColumnBreaks">
  5846. Vertical page break information used for print layout view, page layout view, drawing print breaks
  5847. in normal view, and for printing the worksheet.
  5848. @return column indexes of all the vertical page breaks, never <code>null</code>
  5849. </member>
  5850. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetColumnWidth(System.Int32)">
  5851. Get the actual column width (in units of 1/256th of a character width )
  5852. <p>
  5853. Note, the returned value is always gerater that {@link #GetDefaultColumnWidth()} because the latter does not include margins.
  5854. Actual column width measured as the number of characters of the maximum digit width of the
  5855. numbers 0, 1, 2, ..., 9 as rendered in the normal style's font. There are 4 pixels of margin
  5856. pAdding (two on each side), plus 1 pixel pAdding for the gridlines.
  5857. </p>
  5858. @param columnIndex - the column to set (0-based)
  5859. @return width - the width in units of 1/256th of a character width
  5860. </member>
  5861. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetColumnWidthInPixels(System.Int32)">
  5862. Get the actual column width in pixels
  5863. <p>
  5864. Please note, that this method works correctly only for workbooks
  5865. with the default font size (Calibri 11pt for .xlsx).
  5866. </p>
  5867. </member>
  5868. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DefaultColumnWidth">
  5869. Get the default column width for the sheet (if the columns do not define their own width) in
  5870. characters.
  5871. <p>
  5872. Note, this value is different from {@link #GetColumnWidth(int)}. The latter is always greater and includes
  5873. 4 pixels of margin pAdding (two on each side), plus 1 pixel pAdding for the gridlines.
  5874. </p>
  5875. @return column width, default value is 8
  5876. </member>
  5877. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DefaultRowHeight">
  5878. Get the default row height for the sheet (if the rows do not define their own height) in
  5879. twips (1/20 of a point)
  5880. @return default row height
  5881. </member>
  5882. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DefaultRowHeightInPoints">
  5883. Get the default row height for the sheet measued in point size (if the rows do not define their own height).
  5884. @return default row height in points
  5885. </member>
  5886. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetColumnStyle(System.Int32)">
  5887. Returns the CellStyle that applies to the given
  5888. (0 based) column, or null if no style has been
  5889. set for that column
  5890. </member>
  5891. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.RightToLeft">
  5892. Whether the text is displayed in right-to-left mode in the window
  5893. @return whether the text is displayed in right-to-left mode in the window
  5894. </member>
  5895. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayGuts">
  5896. Get whether to display the guts or not,
  5897. default value is true
  5898. @return bool - guts or no guts
  5899. </member>
  5900. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayZeros">
  5901. Gets the flag indicating whether the window should show 0 (zero) in cells Containing zero value.
  5902. When false, cells with zero value appear blank instead of Showing the number zero.
  5903. @return whether all zero values on the worksheet are displayed
  5904. </member>
  5905. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.FirstRowNum">
  5906. Gets the first row on the sheet
  5907. @return the number of the first logical row on the sheet, zero based
  5908. </member>
  5909. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.FitToPage">
  5910. Flag indicating whether the Fit to Page print option is enabled.
  5911. @return <code>true</code>
  5912. </member>
  5913. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Footer">
  5914. Returns the default footer for the sheet,
  5915. creating one as needed.
  5916. You may also want to look at
  5917. {@link #GetFirstFooter()},
  5918. {@link #GetOddFooter()} and
  5919. {@link #GetEvenFooter()}
  5920. </member>
  5921. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Header">
  5922. Returns the default header for the sheet,
  5923. creating one as needed.
  5924. You may also want to look at
  5925. {@link #GetFirstHeader()},
  5926. {@link #GetOddHeader()} and
  5927. {@link #GetEvenHeader()}
  5928. </member>
  5929. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.OddFooter">
  5930. Returns the odd footer. Used on all pages unless
  5931. other footers also present, when used on only
  5932. odd pages.
  5933. </member>
  5934. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.EvenFooter">
  5935. Returns the even footer. Not there by default, but
  5936. when Set, used on even pages.
  5937. </member>
  5938. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.FirstFooter">
  5939. Returns the first page footer. Not there by
  5940. default, but when Set, used on the first page.
  5941. </member>
  5942. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.OddHeader">
  5943. Returns the odd header. Used on all pages unless
  5944. other headers also present, when used on only
  5945. odd pages.
  5946. </member>
  5947. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.EvenHeader">
  5948. Returns the even header. Not there by default, but
  5949. when Set, used on even pages.
  5950. </member>
  5951. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.FirstHeader">
  5952. Returns the first page header. Not there by
  5953. default, but when Set, used on the first page.
  5954. </member>
  5955. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.HorizontallyCenter">
  5956. Determine whether printed output for this sheet will be horizontally centered.
  5957. </member>
  5958. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetMargin(NPOI.SS.UserModel.MarginType)">
  5959. Gets the size of the margin in inches.
  5960. @param margin which margin to get
  5961. @return the size of the margin
  5962. @see Sheet#LeftMargin
  5963. @see Sheet#RightMargin
  5964. @see Sheet#TopMargin
  5965. @see Sheet#BottomMargin
  5966. @see Sheet#HeaderMargin
  5967. @see Sheet#FooterMargin
  5968. </member>
  5969. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetMargin(NPOI.SS.UserModel.MarginType,System.Double)">
  5970. Sets the size of the margin in inches.
  5971. @param margin which margin to get
  5972. @param size the size of the margin
  5973. @see Sheet#LeftMargin
  5974. @see Sheet#RightMargin
  5975. @see Sheet#TopMargin
  5976. @see Sheet#BottomMargin
  5977. @see Sheet#HeaderMargin
  5978. @see Sheet#FooterMargin
  5979. </member>
  5980. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetMergedRegion(System.Int32)">
  5981. @return the merged region at the specified index
  5982. @throws InvalidOperationException if this worksheet does not contain merged regions
  5983. </member>
  5984. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.MergedRegions">
  5985. Returns the list of merged regions. If you want multiple regions, this is
  5986. faster than calling {@link #getMergedRegion(int)} each time.
  5987. @return the list of merged regions
  5988. @throws InvalidOperationException if this worksheet does not contain merged regions
  5989. </member>
  5990. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.NumMergedRegions">
  5991. Returns the number of merged regions defined in this worksheet
  5992. @return number of merged regions in this worksheet
  5993. </member>
  5994. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.PaneInformation">
  5995. Returns the information regarding the currently configured pane (split or freeze).
  5996. @return null if no pane configured, or the pane information.
  5997. </member>
  5998. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.PhysicalNumberOfRows">
  5999. Returns the number of phsyically defined rows (NOT the number of rows in the sheet)
  6000. @return the number of phsyically defined rows
  6001. </member>
  6002. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.PrintSetup">
  6003. Gets the print Setup object.
  6004. @return The user model for the print Setup object.
  6005. </member>
  6006. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Protect">
  6007. Answer whether protection is enabled or disabled
  6008. @return true => protection enabled; false => protection disabled
  6009. </member>
  6010. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ProtectSheet(System.String)">
  6011. Enables sheet protection and Sets the password for the sheet.
  6012. Also Sets some attributes on the {@link CT_SheetProtection} that correspond to
  6013. the default values used by Excel
  6014. @param password to set for protection. Pass <code>null</code> to remove protection
  6015. </member>
  6016. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetSheetPassword(System.String,NPOI.POIFS.Crypt.HashAlgorithm)">
  6017. Sets the sheet password.
  6018. @param password if null, the password will be removed
  6019. @param hashAlgo if null, the password will be set as XOR password (Excel 2010 and earlier)
  6020. otherwise the given algorithm is used for calculating the hash password (Excel 2013)
  6021. </member>
  6022. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ValidateSheetPassword(System.String)">
  6023. Validate the password against the stored hash, the hashing method will be determined
  6024. by the existing password attributes
  6025. @return true, if the hashes match (... though original password may differ ...)
  6026. </member>
  6027. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetRow(System.Int32)">
  6028. Returns the logical row ( 0-based). If you ask for a row that is not
  6029. defined you get a null. This is to say row 4 represents the fifth row on a sheet.
  6030. @param rownum row to get
  6031. @return <code>XSSFRow</code> representing the rownumber or <code>null</code> if its not defined on the sheet
  6032. </member>
  6033. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetRows(System.Int32,System.Int32,System.Boolean)">
  6034. returns all rows between startRow and endRow, inclusive.
  6035. Rows between startRow and endRow that haven't been created are not included
  6036. in result unless createRowIfMissing is true
  6037. @param startRow the first row number in this sheet to return
  6038. @param endRow the last row number in this sheet to return
  6039. @param createRowIfMissing
  6040. @return
  6041. @throws IllegalArgumentException if startRowNum and endRowNum are not in ascending order
  6042. </member>
  6043. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.RowBreaks">
  6044. Horizontal page break information used for print layout view, page layout view, drawing print breaks in normal
  6045. view, and for printing the worksheet.
  6046. @return row indexes of all the horizontal page breaks, never <code>null</code>
  6047. </member>
  6048. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.RowSumsBelow">
  6049. Flag indicating whether summary rows appear below detail in an outline, when Applying an outline.
  6050. <p>
  6051. When true a summary row is inserted below the detailed data being summarized and a
  6052. new outline level is established on that row.
  6053. </p>
  6054. <p>
  6055. When false a summary row is inserted above the detailed data being summarized and a new outline level
  6056. is established on that row.
  6057. </p>
  6058. @return <code>true</code> if row summaries appear below detail in the outline
  6059. </member>
  6060. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.RowSumsRight">
  6061. Flag indicating whether summary columns appear to the right of detail in an outline, when Applying an outline.
  6062. <p>
  6063. When true a summary column is inserted to the right of the detailed data being summarized
  6064. and a new outline level is established on that column.
  6065. </p>
  6066. <p>
  6067. When false a summary column is inserted to the left of the detailed data being
  6068. summarized and a new outline level is established on that column.
  6069. </p>
  6070. @return <code>true</code> if col summaries appear right of the detail in the outline
  6071. </member>
  6072. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ensureOutlinePr">
  6073. Ensure CT_Worksheet.CT_SheetPr.CT_OutlinePr
  6074. </member>
  6075. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.ScenarioProtect">
  6076. <summary>
  6077. A flag indicating whether scenarios are locked when the sheet is protected.
  6078. </summary>
  6079. </member>
  6080. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.TopRow">
  6081. <summary>
  6082. The top row in the visible view when the sheet is first viewed after opening it in a viewer
  6083. </summary>
  6084. </member>
  6085. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.VerticallyCenter">
  6086. Determine whether printed output for this sheet will be vertically centered.
  6087. @return whether printed output for this sheet will be vertically centered.
  6088. </member>
  6089. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GroupColumn(System.Int32,System.Int32)">
  6090. Group between (0 based) columns
  6091. </member>
  6092. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetColWidthAttribute(NPOI.OpenXmlFormats.Spreadsheet.CT_Cols)">
  6093. Do not leave the width attribute undefined (see #52186).
  6094. </member>
  6095. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GroupRow(System.Int32,System.Int32)">
  6096. Tie a range of cell toGether so that they can be collapsed or expanded
  6097. @param fromRow start row (0-based)
  6098. @param toRow end row (0-based)
  6099. </member>
  6100. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsColumnBroken(System.Int32)">
  6101. Determines if there is a page break at the indicated column
  6102. </member>
  6103. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsColumnHidden(System.Int32)">
  6104. Get the hidden state for a given column.
  6105. @param columnIndex - the column to set (0-based)
  6106. @return hidden - <code>false</code> if the column is visible
  6107. </member>
  6108. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayFormulas">
  6109. Gets the flag indicating whether this sheet should display formulas.
  6110. @return <code>true</code> if this sheet should display formulas.
  6111. </member>
  6112. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayGridlines">
  6113. Gets the flag indicating whether this sheet displays the lines
  6114. between rows and columns to make editing and Reading easier.
  6115. @return <code>true</code> if this sheet displays gridlines.
  6116. @see #isPrintGridlines() to check if printing of gridlines is turned on or off
  6117. </member>
  6118. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayRowColHeadings">
  6119. Gets the flag indicating whether this sheet should display row and column headings.
  6120. <p>
  6121. Row heading are the row numbers to the side of the sheet
  6122. </p>
  6123. <p>
  6124. Column heading are the letters or numbers that appear above the columns of the sheet
  6125. </p>
  6126. @return <code>true</code> if this sheet should display row and column headings.
  6127. </member>
  6128. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsPrintGridlines">
  6129. Returns whether gridlines are printed.
  6130. @return whether gridlines are printed
  6131. </member>
  6132. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsPrintRowAndColumnHeadings">
  6133. Returns whether row and column headings are printed.
  6134. @return whether row and column headings are printed
  6135. </member>
  6136. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsRowBroken(System.Int32)">
  6137. Tests if there is a page break at the indicated row
  6138. @param row index of the row to test
  6139. @return <code>true</code> if there is a page break at the indicated row
  6140. </member>
  6141. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetRowBreak(System.Int32)">
  6142. Sets a page break at the indicated row
  6143. Breaks occur above the specified row and left of the specified column inclusive.
  6144. For example, <code>sheet.SetColumnBreak(2);</code> breaks the sheet into two parts
  6145. with columns A,B,C in the first and D,E,... in the second. Simuilar, <code>sheet.SetRowBreak(2);</code>
  6146. breaks the sheet into two parts with first three rows (rownum=1...3) in the first part
  6147. and rows starting with rownum=4 in the second.
  6148. @param row the row to break, inclusive
  6149. </member>
  6150. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveColumnBreak(System.Int32)">
  6151. Removes a page break at the indicated column
  6152. </member>
  6153. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveMergedRegion(System.Int32)">
  6154. Removes a merged region of cells (hence letting them free)
  6155. @param index of the region to unmerge
  6156. </member>
  6157. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveMergedRegions(System.Collections.Generic.IList{System.Int32})">
  6158. Removes a number of merged regions of cells (hence letting them free)
  6159. This method can be used to bulk-remove merged regions in a way
  6160. much faster than calling RemoveMergedRegion() for every single
  6161. merged region.
  6162. @param indices A Set of the regions to unmerge
  6163. </member>
  6164. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveRow(NPOI.SS.UserModel.IRow)">
  6165. Remove a row from this sheet. All cells Contained in the row are Removed as well
  6166. @param row the row to Remove.
  6167. </member>
  6168. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveRowBreak(System.Int32)">
  6169. Removes the page break at the indicated row
  6170. </member>
  6171. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.ForceFormulaRecalculation">
  6172. Whether Excel will be asked to recalculate all formulas when the
  6173. workbook is opened.
  6174. </member>
  6175. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Autobreaks">
  6176. Flag indicating whether the sheet displays Automatic Page Breaks.
  6177. @return <code>true</code> if the sheet displays Automatic Page Breaks.
  6178. </member>
  6179. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetColumnBreak(System.Int32)">
  6180. Sets a page break at the indicated column.
  6181. Breaks occur above the specified row and left of the specified column inclusive.
  6182. For example, <code>sheet.SetColumnBreak(2);</code> breaks the sheet into two parts
  6183. with columns A,B,C in the first and D,E,... in the second. Simuilar, <code>sheet.SetRowBreak(2);</code>
  6184. breaks the sheet into two parts with first three rows (rownum=1...3) in the first part
  6185. and rows starting with rownum=4 in the second.
  6186. @param column the column to break, inclusive
  6187. </member>
  6188. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetGroupHidden(System.Int32,System.Int32,System.Boolean)">
  6189. Sets all adjacent columns of the same outline level to the specified
  6190. hidden status.
  6191. @param pIdx
  6192. the col info index of the start of the outline group
  6193. @return the column index of the last column in the outline group
  6194. </member>
  6195. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsColumnGroupCollapsed(System.Int32)">
  6196. 'Collapsed' state is stored in a single column col info record
  6197. immediately after the outline group
  6198. @param idx
  6199. @return a bool represented if the column is collapsed
  6200. </member>
  6201. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetColumnHidden(System.Int32,System.Boolean)">
  6202. Get the visibility state for a given column.
  6203. @param columnIndex - the column to get (0-based)
  6204. @param hidden - the visiblity state of the column
  6205. </member>
  6206. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetColumnWidth(System.Int32,System.Int32)">
  6207. * Set the width (in units of 1/256th of a character width)
  6208. *
  6209. * <p>
  6210. * The maximum column width for an individual cell is 255 characters.
  6211. * This value represents the number of characters that can be displayed
  6212. * in a cell that is formatted with the standard font (first font in the workbook).
  6213. * </p>
  6214. *
  6215. * <p>
  6216. * Character width is defined as the maximum digit width
  6217. * of the numbers <code>0, 1, 2, ... 9</code> as rendered
  6218. * using the default font (first font in the workbook).
  6219. * <br/>
  6220. * Unless you are using a very special font, the default character is '0' (zero),
  6221. * this is true for Arial (default font font in HSSF) and Calibri (default font in XSSF)
  6222. * </p>
  6223. *
  6224. * <p>
  6225. * Please note, that the width set by this method includes 4 pixels of margin pAdding (two on each side),
  6226. * plus 1 pixel pAdding for the gridlines (Section 3.3.1.12 of the OOXML spec).
  6227. * This results is a slightly less value of visible characters than passed to this method (approx. 1/2 of a character).
  6228. * </p>
  6229. * <p>
  6230. * To compute the actual number of visible characters,
  6231. * Excel uses the following formula (Section 3.3.1.12 of the OOXML spec):
  6232. * </p>
  6233. * <code>
  6234. * width = TRuncate([{Number of Visible Characters} *
  6235. * {Maximum Digit Width} + {5 pixel pAdding}]/{Maximum Digit Width}*256)/256
  6236. * </code>
  6237. * <p>Using the Calibri font as an example, the maximum digit width of 11 point font size is 7 pixels (at 96 dpi).
  6238. * If you set a column width to be eight characters wide, e.g. <code>SetColumnWidth(columnIndex, 8*256)</code>,
  6239. * then the actual value of visible characters (the value Shown in Excel) is derived from the following equation:
  6240. * <code>
  6241. TRuncate([numChars*7+5]/7*256)/256 = 8;
  6242. * </code>
  6243. *
  6244. * which gives <code>7.29</code>.
  6245. * </p>
  6246. * @param columnIndex - the column to set (0-based)
  6247. * @param width - the width in units of 1/256th of a character width
  6248. * @throws ArgumentException if width > 255*256 (the maximum column width in Excel is 255 characters)
  6249. </member>
  6250. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetRowGroupCollapsed(System.Int32,System.Boolean)">
  6251. group the row It is possible for collapsed to be false and yet still have
  6252. the rows in question hidden. This can be achieved by having a lower
  6253. outline level collapsed, thus hiding all the child rows. Note that in
  6254. this case, if the lowest level were expanded, the middle level would
  6255. remain collapsed.
  6256. @param rowIndex -
  6257. the row involved, 0 based
  6258. @param collapse -
  6259. bool value for collapse
  6260. </member>
  6261. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CollapseRow(System.Int32)">
  6262. @param rowIndex the zero based row index to collapse
  6263. </member>
  6264. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.FindStartOfRowOutlineGroup(System.Int32)">
  6265. @param rowIndex the zero based row index to find from
  6266. </member>
  6267. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ExpandRow(System.Int32)">
  6268. @param rowNumber the zero based row index to expand
  6269. </member>
  6270. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.FindEndOfRowOutlineGroup(System.Int32)">
  6271. @param row the zero based row index to find from
  6272. </member>
  6273. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsRowGroupHiddenByParent(System.Int32)">
  6274. @param row the zero based row index to find from
  6275. </member>
  6276. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsRowGroupCollapsed(System.Int32)">
  6277. @param row the zero based row index to find from
  6278. </member>
  6279. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetZoom(System.Int32,System.Int32)">
  6280. Sets the zoom magnification for the sheet. The zoom is expressed as a
  6281. fraction. For example to express a zoom of 75% use 3 for the numerator
  6282. and 4 for the denominator.
  6283. @param numerator The numerator for the zoom magnification.
  6284. @param denominator The denominator for the zoom magnification.
  6285. @see #SetZoom(int)
  6286. </member>
  6287. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetZoom(System.Int32)">
  6288. Window zoom magnification for current view representing percent values.
  6289. Valid values range from 10 to 400. Horizontal &amp; Vertical scale toGether.
  6290. For example:
  6291. <pre>
  6292. 10 - 10%
  6293. 20 - 20%
  6294. ...
  6295. 100 - 100%
  6296. ...
  6297. 400 - 400%
  6298. </pre>
  6299. Current view can be Normal, Page Layout, or Page Break Preview.
  6300. @param scale window zoom magnification
  6301. @throws ArgumentException if scale is invalid
  6302. </member>
  6303. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CopyRows(System.Collections.Generic.List{NPOI.XSSF.UserModel.XSSFRow},System.Int32,NPOI.SS.UserModel.CellCopyPolicy)">
  6304. copyRows rows from srcRows to this sheet starting at destStartRow
  6305. Additionally copies merged regions that are completely defined in these
  6306. rows (ie. merged 2 cells on a row to be shifted).
  6307. @param srcRows the rows to copy. Formulas will be offset by the difference
  6308. in the row number of the first row in srcRows and destStartRow (even if srcRows
  6309. are from a different sheet).
  6310. @param destStartRow the row in this sheet to paste the first row of srcRows
  6311. the remainder of srcRows will be pasted below destStartRow per the cell copy policy
  6312. @param policy is the cell copy policy, which can be used to merge the source and destination
  6313. when the source is blank, copy styles only, paste as value, etc
  6314. </member>
  6315. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CopyRows(System.Int32,System.Int32,System.Int32,NPOI.SS.UserModel.CellCopyPolicy)">
  6316. Copies rows between srcStartRow and srcEndRow to the same sheet, starting at destStartRow
  6317. Convenience function for {@link #copyRows(List, int, CellCopyPolicy)}
  6318. Equivalent to copyRows(getRows(srcStartRow, srcEndRow, false), destStartRow, cellCopyPolicy)
  6319. @param srcStartRow the index of the first row to copy the cells from in this sheet
  6320. @param srcEndRow the index of the last row to copy the cells from in this sheet
  6321. @param destStartRow the index of the first row to copy the cells to in this sheet
  6322. @param cellCopyPolicy the policy to use to determine how cells are copied
  6323. </member>
  6324. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32)">
  6325. Shifts rows between startRow and endRow n number of rows.
  6326. If you use a negative number, it will shift rows up.
  6327. Code ensures that rows don't wrap around.
  6328. Calls ShiftRows(startRow, endRow, n, false, false);
  6329. <p>
  6330. Additionally Shifts merged regions that are completely defined in these
  6331. rows (ie. merged 2 cells on a row to be Shifted).</p>
  6332. @param startRow the row to start Shifting
  6333. @param endRow the row to end Shifting
  6334. @param n the number of rows to shift
  6335. </member>
  6336. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean)">
  6337. Shifts rows between startRow and endRow n number of rows.
  6338. If you use a negative number, it will shift rows up.
  6339. Code ensures that rows don't wrap around
  6340. <p>
  6341. Additionally Shifts merged regions that are completely defined in these
  6342. rows (ie. merged 2 cells on a row to be Shifted).</p>
  6343. @param startRow the row to start Shifting
  6344. @param endRow the row to end Shifting
  6345. @param n the number of rows to shift
  6346. @param copyRowHeight whether to copy the row height during the shift
  6347. @param reSetOriginalRowHeight whether to set the original row's height to the default
  6348. </member>
  6349. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.UngroupRow(System.Int32,System.Int32)">
  6350. Ungroup a range of rows that were previously groupped
  6351. @param fromRow start row (0-based)
  6352. @param toRow end row (0-based)
  6353. </member>
  6354. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSelected">
  6355. Returns a flag indicating whether this sheet is selected.
  6356. <p>
  6357. When only 1 sheet is selected and active, this value should be in synch with the activeTab value.
  6358. In case of a conflict, the Start Part Setting wins and Sets the active sheet tab.
  6359. </p>
  6360. Note: multiple sheets can be selected, but only one sheet can be active at one time.
  6361. @return <code>true</code> if this sheet is selected
  6362. </member>
  6363. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AddHyperlink(NPOI.XSSF.UserModel.XSSFHyperlink)">
  6364. Register a hyperlink in the collection of hyperlinks on this sheet
  6365. @param hyperlink the link to add
  6366. </member>
  6367. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveHyperlink(System.Int32,System.Int32)">
  6368. Removes a hyperlink in the collection of hyperlinks on this sheet
  6369. @param row row index
  6370. @param column column index
  6371. </member>
  6372. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.ActiveCell">
  6373. Return location of the active cell, e.g. <code>A1</code>.
  6374. @return the location of the active cell.
  6375. </member>
  6376. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.HasComments">
  6377. Does this sheet have any comments on it? We need to know,
  6378. so we can decide about writing it to disk or not
  6379. </member>
  6380. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetDefaultSheetView">
  6381. Return the default sheet view. This is the last one if the sheet's views, according to sec. 3.3.1.83
  6382. of the OOXML spec: "A single sheet view defInition. When more than 1 sheet view is defined in the file,
  6383. it means that when opening the workbook, each sheet view corresponds to a separate window within the
  6384. spreadsheet application, where each window is Showing the particular sheet. Containing the same
  6385. workbookViewId value, the last sheetView defInition is loaded, and the others are discarded.
  6386. When multiple windows are viewing the same sheet, multiple sheetView elements (with corresponding
  6387. workbookView entries) are saved."
  6388. </member>
  6389. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCommentsTable(System.Boolean)">
  6390. Returns the sheet's comments object if there is one,
  6391. or null if not
  6392. @param create create a new comments table if it does not exist
  6393. </member>
  6394. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetSharedFormula(System.Int32)">
  6395. Return a master shared formula by index
  6396. @param sid shared group index
  6397. @return a CT_CellFormula bean holding shared formula or <code>null</code> if not found
  6398. </member>
  6399. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsAutoFilterLocked">
  6400. @return true when Autofilters are locked and the sheet is protected.
  6401. </member>
  6402. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsDeleteColumnsLocked">
  6403. @return true when Deleting columns is locked and the sheet is protected.
  6404. </member>
  6405. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsDeleteRowsLocked">
  6406. @return true when Deleting rows is locked and the sheet is protected.
  6407. </member>
  6408. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsFormatCellsLocked">
  6409. @return true when Formatting cells is locked and the sheet is protected.
  6410. </member>
  6411. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsFormatColumnsLocked">
  6412. @return true when Formatting columns is locked and the sheet is protected.
  6413. </member>
  6414. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsFormatRowsLocked">
  6415. @return true when Formatting rows is locked and the sheet is protected.
  6416. </member>
  6417. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsInsertColumnsLocked">
  6418. @return true when Inserting columns is locked and the sheet is protected.
  6419. </member>
  6420. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsInsertHyperlinksLocked">
  6421. @return true when Inserting hyperlinks is locked and the sheet is protected.
  6422. </member>
  6423. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsInsertRowsLocked">
  6424. @return true when Inserting rows is locked and the sheet is protected.
  6425. </member>
  6426. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsPivotTablesLocked">
  6427. @return true when Pivot tables are locked and the sheet is protected.
  6428. </member>
  6429. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSortLocked">
  6430. @return true when Sorting is locked and the sheet is protected.
  6431. </member>
  6432. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsObjectsLocked">
  6433. @return true when Objects are locked and the sheet is protected.
  6434. </member>
  6435. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsScenariosLocked">
  6436. @return true when Scenarios are locked and the sheet is protected.
  6437. </member>
  6438. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSelectLockedCellsLocked">
  6439. @return true when Selection of locked cells is locked and the sheet is protected.
  6440. </member>
  6441. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSelectUnlockedCellsLocked">
  6442. @return true when Selection of unlocked cells is locked and the sheet is protected.
  6443. </member>
  6444. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSheetLocked">
  6445. @return true when Sheet is Protected.
  6446. </member>
  6447. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.EnableLocking">
  6448. Enable sheet protection
  6449. </member>
  6450. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.DisableLocking">
  6451. Disable sheet protection
  6452. </member>
  6453. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockAutoFilter(System.Boolean)">
  6454. Enable or disable Autofilters locking.
  6455. This does not modify sheet protection status.
  6456. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  6457. </member>
  6458. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockDeleteColumns(System.Boolean)">
  6459. Enable or disable Deleting columns locking.
  6460. This does not modify sheet protection status.
  6461. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  6462. </member>
  6463. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockDeleteRows(System.Boolean)">
  6464. Enable or disable Deleting rows locking.
  6465. This does not modify sheet protection status.
  6466. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  6467. </member>
  6468. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockFormatCells(System.Boolean)">
  6469. Enable or disable Formatting cells locking.
  6470. This does not modify sheet protection status.
  6471. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  6472. </member>
  6473. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockFormatColumns(System.Boolean)">
  6474. Enable or disable Formatting columns locking.
  6475. This does not modify sheet protection status.
  6476. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  6477. </member>
  6478. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockFormatRows(System.Boolean)">
  6479. Enable or disable Formatting rows locking.
  6480. This does not modify sheet protection status.
  6481. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  6482. </member>
  6483. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockInsertColumns(System.Boolean)">
  6484. Enable or disable Inserting columns locking.
  6485. This does not modify sheet protection status.
  6486. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  6487. </member>
  6488. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockInsertHyperlinks(System.Boolean)">
  6489. Enable or disable Inserting hyperlinks locking.
  6490. This does not modify sheet protection status.
  6491. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  6492. </member>
  6493. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockInsertRows(System.Boolean)">
  6494. Enable or disable Inserting rows locking.
  6495. This does not modify sheet protection status.
  6496. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  6497. </member>
  6498. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockPivotTables(System.Boolean)">
  6499. Enable or disable Pivot Tables locking.
  6500. This does not modify sheet protection status.
  6501. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  6502. </member>
  6503. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockSort(System.Boolean)">
  6504. Enable or disable Sort locking.
  6505. This does not modify sheet protection status.
  6506. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  6507. </member>
  6508. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockObjects(System.Boolean)">
  6509. Enable or disable Objects locking.
  6510. This does not modify sheet protection status.
  6511. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  6512. </member>
  6513. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockScenarios(System.Boolean)">
  6514. Enable or disable Scenarios locking.
  6515. This does not modify sheet protection status.
  6516. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  6517. </member>
  6518. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockSelectLockedCells(System.Boolean)">
  6519. Enable or disable Selection of locked cells locking.
  6520. This does not modify sheet protection status.
  6521. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  6522. </member>
  6523. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockSelectUnlockedCells(System.Boolean)">
  6524. Enable or disable Selection of unlocked cells locking.
  6525. This does not modify sheet protection status.
  6526. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  6527. </member>
  6528. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCellRange(NPOI.SS.Util.CellRangeAddress)">
  6529. Also Creates cells if they don't exist
  6530. </member>
  6531. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateTable">
  6532. Creates a new Table, and associates it with this Sheet
  6533. </member>
  6534. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetTables">
  6535. Returns any tables associated with this Sheet
  6536. </member>
  6537. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetTabColor(System.Int32)">
  6538. Set background color of the sheet tab
  6539. @param colorIndex the indexed color to set, must be a constant from {@link IndexedColors}
  6540. </member>
  6541. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.TabColor">
  6542. <summary>
  6543. Get or set background color of the sheet tab.
  6544. The value is null if no sheet tab color is set.
  6545. </summary>
  6546. </member>
  6547. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreatePivotTable">
  6548. Creates an empty XSSFPivotTable and Sets up all its relationships
  6549. including: pivotCacheDefInition, pivotCacheRecords
  6550. @return returns a pivotTable
  6551. </member>
  6552. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreatePivotTable(NPOI.SS.Util.AreaReference,NPOI.SS.Util.CellReference,NPOI.SS.UserModel.ISheet)">
  6553. Create a pivot table using the AreaReference range on sourceSheet, at the given position.
  6554. If the source reference contains a sheet name, it must match the sourceSheet
  6555. @param source location of pivot data
  6556. @param position A reference to the top left cell where the pivot table will start
  6557. @param sourceSheet The sheet containing the source data, if the source reference doesn't contain a sheet name
  6558. @throws IllegalArgumentException if source references a sheet different than sourceSheet
  6559. @return The pivot table
  6560. </member>
  6561. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreatePivotTable(NPOI.SS.Util.CellReference,NPOI.SS.UserModel.ISheet,NPOI.XSSF.UserModel.XSSFPivotTable.IPivotTableReferenceConfigurator)">
  6562. Create a pivot table using the AreaReference or named/table range on sourceSheet, at the given position.
  6563. If the source reference contains a sheet name, it must match the sourceSheet.
  6564. @param sourceRef location of pivot data - mutually exclusive with SourceName
  6565. @param sourceName range or table name for pivot data - mutually exclusive with SourceRef
  6566. @param position A reference to the top left cell where the pivot table will start
  6567. @param sourceSheet The sheet containing the source data, if the source reference doesn't contain a sheet name
  6568. @throws IllegalArgumentException if source references a sheet different than sourceSheet
  6569. @return The pivot table
  6570. </member>
  6571. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreatePivotTable(NPOI.SS.Util.AreaReference,NPOI.SS.Util.CellReference)">
  6572. Create a pivot table using the AreaReference range, at the given position.
  6573. If the source reference contains a sheet name, that sheet is used, otherwise this sheet is assumed as the source sheet.
  6574. @param source location of pivot data
  6575. @param position A reference to the top left cell where the pivot table will start
  6576. @return The pivot table
  6577. </member>
  6578. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreatePivotTable(NPOI.SS.UserModel.IName,NPOI.SS.Util.CellReference,NPOI.SS.UserModel.ISheet)">
  6579. Create a pivot table using the Name range reference on sourceSheet, at the given position.
  6580. If the source reference contains a sheet name, it must match the sourceSheet
  6581. @param source location of pivot data
  6582. @param position A reference to the top left cell where the pivot table will start
  6583. @param sourceSheet The sheet containing the source data, if the source reference doesn't contain a sheet name
  6584. @ if source references a sheet different than sourceSheet
  6585. @return The pivot table
  6586. </member>
  6587. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreatePivotTable(NPOI.SS.UserModel.IName,NPOI.SS.Util.CellReference)">
  6588. Create a pivot table using the Name range, at the given position.
  6589. If the source reference contains a sheet name, that sheet is used, otherwise this sheet is assumed as the source sheet.
  6590. @param source location of pivot data
  6591. @param position A reference to the top left cell where the pivot table will start
  6592. @return The pivot table
  6593. </member>
  6594. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreatePivotTable(NPOI.SS.UserModel.ITable,NPOI.SS.Util.CellReference)">
  6595. Create a pivot table using the Table, at the given position.
  6596. Tables are required to have a sheet reference, so no additional logic around reference sheet is needed.
  6597. @param source location of pivot data
  6598. @param position A reference to the top left cell where the pivot table will start
  6599. @return The pivot table
  6600. </member>
  6601. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetPivotTables">
  6602. Returns all the pivot tables for this Sheet
  6603. </member>
  6604. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AddIgnoredErrors(NPOI.SS.Util.CellReference,NPOI.SS.UserModel.IgnoredErrorType[])">
  6605. Add ignored errors (usually to suppress them in the UI of a consuming
  6606. application).
  6607. @param cell Cell.
  6608. @param ignoredErrorTypes Types of error to ignore there.
  6609. </member>
  6610. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AddIgnoredErrors(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.IgnoredErrorType[])">
  6611. Ignore errors across a range of cells.
  6612. @param region Range of cells.
  6613. @param ignoredErrorTypes Types of error to ignore there.
  6614. </member>
  6615. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetIgnoredErrors">
  6616. Returns the errors currently being ignored and the ranges
  6617. where they are ignored.
  6618. @return Map of error type to the range(s) where they are ignored.
  6619. </member>
  6620. <member name="T:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting">
  6621. XSSF Conditional Formattings
  6622. </member>
  6623. <member name="F:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.CF_EXT_2009_NS_X14">
  6624. Office 2010 Conditional Formatting extensions namespace
  6625. </member>
  6626. <member name="M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.ComparisonOperator,System.String,System.String)">
  6627. A factory method allowing to create a conditional formatting rule
  6628. with a cell comparison operator<p/>
  6629. TODO - formulas Containing cell references are currently not Parsed properly
  6630. @param comparisonOperation - a constant value from
  6631. <tt>{@link NPOI.hssf.record.CFRuleRecord.ComparisonOperator}</tt>: <p>
  6632. <ul>
  6633. <li>BETWEEN</li>
  6634. <li>NOT_BETWEEN</li>
  6635. <li>EQUAL</li>
  6636. <li>NOT_EQUAL</li>
  6637. <li>GT</li>
  6638. <li>LT</li>
  6639. <li>GE</li>
  6640. <li>LE</li>
  6641. </ul>
  6642. </p>
  6643. @param formula1 - formula for the valued, Compared with the cell
  6644. @param formula2 - second formula (only used with
  6645. {@link NPOI.ss.usermodel.ComparisonOperator#BETWEEN}) and
  6646. {@link NPOI.ss.usermodel.ComparisonOperator#NOT_BETWEEN} operations)
  6647. </member>
  6648. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.CreateConditionalFormattingRule(System.String)" -->
  6649. <member name="M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.IconSet)">
  6650. A factory method allowing the creation of conditional formatting
  6651. rules using an Icon Set / Multi-State formatting.
  6652. The thresholds for it will be created, but will be empty
  6653. and require configuring with
  6654. {@link XSSFConditionalFormattingRule#getMultiStateFormatting()}
  6655. then
  6656. {@link XSSFIconMultiStateFormatting#getThresholds()}
  6657. </member>
  6658. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.XSSF.UserModel.XSSFColor)" -->
  6659. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.CreateConditionalFormattingColorScaleRule" -->
  6660. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.UserModel.IConditionalFormatting)" -->
  6661. <member name="M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.GetConditionalFormattingAt(System.Int32)">
  6662. Gets Conditional Formatting object at a particular index
  6663. @param index
  6664. of the Conditional Formatting object to fetch
  6665. @return Conditional Formatting object
  6666. </member>
  6667. <member name="P:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.NumConditionalFormattings">
  6668. @return number of Conditional Formatting objects of the sheet
  6669. </member>
  6670. <member name="M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.RemoveConditionalFormatting(System.Int32)">
  6671. Removes a Conditional Formatting object by index
  6672. @param index of a Conditional Formatting object to remove
  6673. </member>
  6674. <member name="T:NPOI.XSSF.UserModel.XSSFSimpleShape">
  6675. Represents a shape with a predefined geometry in a SpreadsheetML Drawing.
  6676. Possible shape types are defined in {@link NPOI.SS.UserModel.ShapeTypes}
  6677. </member>
  6678. <member name="F:NPOI.XSSF.UserModel.XSSFSimpleShape._paragraphs">
  6679. List of the paragraphs that make up the text in this shape
  6680. </member>
  6681. <member name="F:NPOI.XSSF.UserModel.XSSFSimpleShape.prototype">
  6682. A default instance of CTShape used for creating new shapes.
  6683. </member>
  6684. <member name="F:NPOI.XSSF.UserModel.XSSFSimpleShape.ctShape">
  6685. Xml bean that stores properties of this shape
  6686. </member>
  6687. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.Prototype">
  6688. Prototype with the default structure of a new auto-shape.
  6689. </member>
  6690. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.Text">
  6691. Returns the text from all paragraphs in the shape. Paragraphs are Separated by new lines.
  6692. @return text Contained within this shape or empty string
  6693. </member>
  6694. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.ProcessAutoNumGroup(System.Int32,System.Int32,System.Collections.Generic.List{System.Int32},System.Text.StringBuilder)">
  6695. </member>
  6696. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.GetBulletPrefix(NPOI.XSSF.UserModel.ListAutoNumber,System.Int32)">
  6697. Returns a string Containing an appropriate prefix for an auto-numbering bullet
  6698. @param scheme the auto-numbering scheme used by the bullet
  6699. @param value the value of the bullet
  6700. @return appropriate prefix for an auto-numbering bullet
  6701. </member>
  6702. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.valueToAlpha(System.Int32)">
  6703. Convert an integer to its alpha equivalent e.g. 1 = A, 2 = B, 27 = AA etc
  6704. </member>
  6705. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.valueToRoman(System.Int32)">
  6706. Convert an integer to its roman equivalent e.g. 1 = I, 9 = IX etc
  6707. </member>
  6708. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.ClearText">
  6709. Clear all text from this shape
  6710. </member>
  6711. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.SetText(System.String)">
  6712. Set a single paragraph of text on the shape. Note this will replace all existing paragraphs Created on the shape.
  6713. @param text string representing the paragraph text
  6714. </member>
  6715. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.SetText(NPOI.XSSF.UserModel.XSSFRichTextString)">
  6716. Set a single paragraph of text on the shape. Note this will replace all existing paragraphs Created on the shape.
  6717. @param str rich text string representing the paragraph text
  6718. </member>
  6719. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.TextParagraphs">
  6720. Returns a collection of the XSSFTextParagraphs that are attached to this shape
  6721. @return text paragraphs in this shape
  6722. </member>
  6723. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.AddNewTextParagraph">
  6724. Add a new paragraph run to this shape
  6725. @return Created paragraph run
  6726. </member>
  6727. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.AddNewTextParagraph(System.String)">
  6728. Add a new paragraph run to this shape, Set to the provided string
  6729. @return Created paragraph run
  6730. </member>
  6731. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.AddNewTextParagraph(NPOI.XSSF.UserModel.XSSFRichTextString)">
  6732. Add a new paragraph run to this shape, Set to the provided rich text string
  6733. @return Created paragraph run
  6734. </member>
  6735. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.TextHorizontalOverflow">
  6736. Returns the type of horizontal overflow for the text.
  6737. @return the type of horizontal overflow
  6738. </member>
  6739. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.TextVerticalOverflow">
  6740. Returns the type of vertical overflow for the text.
  6741. @return the type of vertical overflow
  6742. </member>
  6743. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.VerticalAlignment">
  6744. Returns the type of vertical alignment for the text within the shape.
  6745. @return the type of vertical alignment
  6746. </member>
  6747. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.TextDirection">
  6748. Gets the vertical orientation of the text
  6749. @return vertical orientation of the text
  6750. </member>
  6751. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.BottomInset">
  6752. Returns the distance (in points) between the bottom of the text frame
  6753. and the bottom of the inscribed rectangle of the shape that Contains the text.
  6754. @return the bottom inset in points
  6755. </member>
  6756. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.LeftInset">
  6757. Returns the distance (in points) between the left edge of the text frame
  6758. and the left edge of the inscribed rectangle of the shape that Contains
  6759. the text.
  6760. @return the left inset in points
  6761. </member>
  6762. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.RightInset">
  6763. Returns the distance (in points) between the right edge of the
  6764. text frame and the right edge of the inscribed rectangle of the shape
  6765. that Contains the text.
  6766. @return the right inset in points
  6767. </member>
  6768. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.TopInset">
  6769. Returns the distance (in points) between the top of the text frame
  6770. and the top of the inscribed rectangle of the shape that Contains the text.
  6771. @return the top inset in points
  6772. </member>
  6773. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.WordWrap">
  6774. @return whether to wrap words within the bounding rectangle
  6775. </member>
  6776. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.TextAutofit">
  6777. Specifies that a shape should be auto-fit to fully contain the text described within it.
  6778. Auto-fitting is when text within a shape is scaled in order to contain all the text inside
  6779. @param value type of autofit
  6780. @return type of autofit
  6781. </member>
  6782. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.ShapeType">
  6783. Gets the shape type, one of the constants defined in {@link NPOI.SS.UserModel.ShapeTypes}.
  6784. @return the shape type
  6785. @see NPOI.SS.UserModel.ShapeTypes
  6786. </member>
  6787. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.ApplyAttributes(NPOI.OpenXmlFormats.Spreadsheet.CT_RPrElt,NPOI.OpenXmlFormats.Dml.CT_TextCharacterProperties)">
  6788. org.Openxmlformats.schemas.spreadsheetml.x2006.main.CTRPrElt to
  6789. org.Openxmlformats.schemas.Drawingml.x2006.main.CTFont adapter
  6790. </member>
  6791. <member name="T:NPOI.XSSF.UserModel.XSSFTable">
  6792. This class : the Table Part (Open Office XML Part 4:
  6793. chapter 3.5.1)
  6794. This implementation works under the assumption that a table Contains mappings to a subtree of an XML.
  6795. The root element of this subtree an occur multiple times (one for each row of the table). The child nodes
  6796. of the root element can be only attributes or element with maxOccurs=1 property set
  6797. @author Roberto Manicardi
  6798. </member>
  6799. <member name="M:NPOI.XSSF.UserModel.XSSFTable.MapsTo(System.Int64)">
  6800. Checks if this Table element Contains even a single mapping to the map identified by id
  6801. @param id the XSSFMap ID
  6802. @return true if the Table element contain mappings
  6803. </member>
  6804. <member name="M:NPOI.XSSF.UserModel.XSSFTable.GetCommonXpath">
  6805. Calculates the xpath of the root element for the table. This will be the common part
  6806. of all the mapping's xpaths
  6807. @return the xpath of the table's root element
  6808. </member>
  6809. <member name="M:NPOI.XSSF.UserModel.XSSFTable.GetXmlColumnPrs">
  6810. Note this list is static - once read, it does not notice later changes to the underlying column structures
  6811. @return List of XSSFXmlColumnPr
  6812. </member>
  6813. <member name="P:NPOI.XSSF.UserModel.XSSFTable.Name">
  6814. @return the name of the Table, if set
  6815. </member>
  6816. <member name="P:NPOI.XSSF.UserModel.XSSFTable.DisplayName">
  6817. @return the display name of the Table, if set
  6818. </member>
  6819. <member name="P:NPOI.XSSF.UserModel.XSSFTable.NumberOfMappedColumns">
  6820. @return the number of mapped table columns (see Open Office XML Part 4: chapter 3.5.1.4)
  6821. </member>
  6822. <member name="P:NPOI.XSSF.UserModel.XSSFTable.StartCellReference">
  6823. @return The reference for the cell in the top-left part of the table
  6824. (see Open Office XML Part 4: chapter 3.5.1.2, attribute ref)
  6825. To synchronize with changes to the underlying CTTable,
  6826. call {@link #updateReferences()}.
  6827. </member>
  6828. <member name="P:NPOI.XSSF.UserModel.XSSFTable.EndCellReference">
  6829. @return The reference for the cell in the bottom-right part of the table
  6830. (see Open Office XML Part 4: chapter 3.5.1.2, attribute ref)
  6831. Does not track updates to underlying changes to CTTable
  6832. To synchronize with changes to the underlying CTTable,
  6833. call {@link #updateReferences()}.
  6834. </member>
  6835. <member name="M:NPOI.XSSF.UserModel.XSSFTable.SetCellReferences">
  6836. @since POI 3.15 beta 3
  6837. </member>
  6838. <member name="M:NPOI.XSSF.UserModel.XSSFTable.UpdateReferences">
  6839. Clears the cached values set by {@link #getStartCellReference()}
  6840. and {@link #getEndCellReference()}.
  6841. The next call to {@link #getStartCellReference()} and
  6842. {@link #getEndCellReference()} will synchronize the
  6843. cell references with the underlying <code>CTTable</code>.
  6844. Thus, {@link #updateReferences()} is inexpensive.
  6845. @since POI 3.15 beta 3
  6846. </member>
  6847. <member name="P:NPOI.XSSF.UserModel.XSSFTable.RowCount">
  6848. @return the total number of rows in the selection. (Note: in this version autofiltering is ignored)
  6849. Returns 0 if the start or end cell references are not set.
  6850. To synchronize with changes to the underlying CTTable,
  6851. call {@link #updateReferences()}.
  6852. </member>
  6853. <member name="M:NPOI.XSSF.UserModel.XSSFTable.UpdateHeaders">
  6854. Synchronize table headers with cell values in the parent sheet.
  6855. Headers <em>must</em> be in sync, otherwise Excel will display a
  6856. "Found unreadable content" message on startup.
  6857. If calling both {@link #updateReferences()} and
  6858. {@link #updateHeaders()}, {@link #updateReferences()}
  6859. should be called first.
  6860. </member>
  6861. <member name="M:NPOI.XSSF.UserModel.XSSFTable.FindColumnIndex(System.String)">
  6862. Gets the relative column index of a column in this table having the header name <code>column</code>.
  6863. The column index is relative to the left-most column in the table, 0-indexed.
  6864. Returns <code>-1</code> if <code>column</code> is not a header name in table.
  6865. Column Header names are case-insensitive
  6866. Note: this function caches column names for performance. To flush the cache (because columns
  6867. have been moved or column headers have been changed), {@link #updateHeaders()} must be called.
  6868. @since 3.15 beta 2
  6869. </member>
  6870. <member name="T:NPOI.XSSF.UserModel.XSSFTextBox">
  6871. Represents a text box in a SpreadsheetML Drawing.
  6872. @author Yegor Kozlov
  6873. </member>
  6874. <member name="T:NPOI.XSSF.UserModel.XSSFTextParagraph">
  6875. Represents a paragraph of text within the Containing text body.
  6876. The paragraph is the highest level text separation mechanism.
  6877. </member>
  6878. <member name="M:NPOI.XSSF.UserModel.XSSFTextParagraph.AddNewTextRun">
  6879. Add a new run of text
  6880. @return a new run of text
  6881. </member>
  6882. <member name="M:NPOI.XSSF.UserModel.XSSFTextParagraph.AddLineBreak">
  6883. Insert a line break
  6884. @return text run representing this line break ('\n')
  6885. </member>
  6886. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.TextAlign">
  6887. get or set the alignment that is to be applied to the paragraph.
  6888. Possible values for this include left, right, centered, justified and distributed,
  6889. If this attribute is omitted, then a value of left is implied.
  6890. @return alignment that is applied to the paragraph
  6891. </member>
  6892. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.TextFontAlign">
  6893. Determines where vertically on a line of text the actual words are positioned. This deals
  6894. with vertical placement of the characters with respect to the baselines. For instance
  6895. having text anchored to the top baseline, anchored to the bottom baseline, centered in
  6896. between, etc.
  6897. If this attribute is omitted, then a value of baseline is implied.
  6898. @return alignment that is applied to the paragraph
  6899. </member>
  6900. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.BulletFont">
  6901. @return the font to be used on bullet characters within a given paragraph
  6902. </member>
  6903. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.BulletCharacter">
  6904. @return the character to be used in place of the standard bullet point
  6905. </member>
  6906. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.BulletFontColor">
  6907. @return the color of bullet characters within a given paragraph.
  6908. A <code>null</code> value means to use the text font color.
  6909. </member>
  6910. <!-- Badly formed XML comment ignored for member "P:NPOI.XSSF.UserModel.XSSFTextParagraph.BulletFontSize" -->
  6911. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.Indent">
  6912. @return the indent applied to the first line of text in the paragraph.
  6913. </member>
  6914. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.LeftMargin">
  6915. Specifies the left margin of the paragraph. This is specified in Addition to the text body
  6916. inset and applies only to this text paragraph. That is the text body inset and the LeftMargin
  6917. attributes are Additive with respect to the text position.
  6918. @param value the left margin of the paragraph, -1 to clear the margin and use the default of 0.
  6919. </member>
  6920. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.RightMargin">
  6921. Specifies the right margin of the paragraph. This is specified in Addition to the text body
  6922. inset and applies only to this text paragraph. That is the text body inset and the marR
  6923. attributes are Additive with respect to the text position.
  6924. @param value the right margin of the paragraph, -1 to clear the margin and use the default of 0.
  6925. </member>
  6926. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.DefaultTabSize">
  6927. @return the default size for a tab character within this paragraph in points
  6928. </member>
  6929. <member name="M:NPOI.XSSF.UserModel.XSSFTextParagraph.AddTabStop(System.Double)">
  6930. Add a single tab stop to be used on a line of text when there are one or more tab characters
  6931. present within the text.
  6932. @param value the position of the tab stop relative to the left margin
  6933. </member>
  6934. <!-- Badly formed XML comment ignored for member "P:NPOI.XSSF.UserModel.XSSFTextParagraph.LineSpacing" -->
  6935. <!-- Badly formed XML comment ignored for member "P:NPOI.XSSF.UserModel.XSSFTextParagraph.SpaceBefore" -->
  6936. <!-- Badly formed XML comment ignored for member "P:NPOI.XSSF.UserModel.XSSFTextParagraph.SpaceAfter" -->
  6937. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.Level">
  6938. Specifies the particular level text properties that this paragraph will follow.
  6939. The value for this attribute formats the text according to the corresponding level
  6940. paragraph properties defined in the list of styles associated with the body of text
  6941. that this paragraph belongs to (therefore in the parent shape).
  6942. <p>
  6943. Note that the closest properties object to the text is used, therefore if there is
  6944. a conflict between the text paragraph properties and the list style properties for
  6945. this level then the text paragraph properties will take precedence.
  6946. </p>
  6947. Returns the level of text properties that this paragraph will follow.
  6948. @return the text level of this paragraph (0-based). Default is 0.
  6949. </member>
  6950. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.IsBullet">
  6951. Returns whether this paragraph has bullets
  6952. </member>
  6953. <member name="M:NPOI.XSSF.UserModel.XSSFTextParagraph.SetBullet(System.Boolean)">
  6954. Set or unset this paragraph as a bullet point
  6955. @param flag whether text in this paragraph has bullets
  6956. </member>
  6957. <member name="M:NPOI.XSSF.UserModel.XSSFTextParagraph.SetBullet(NPOI.XSSF.UserModel.ListAutoNumber,System.Int32)">
  6958. Set this paragraph as an automatic numbered bullet point
  6959. @param scheme type of auto-numbering
  6960. @param startAt the number that will start number for a given sequence of automatically
  6961. numbered bullets (1-based).
  6962. </member>
  6963. <member name="M:NPOI.XSSF.UserModel.XSSFTextParagraph.SetBullet(NPOI.XSSF.UserModel.ListAutoNumber)">
  6964. Set this paragraph as an automatic numbered bullet point
  6965. @param scheme type of auto-numbering
  6966. </member>
  6967. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.IsBulletAutoNumber">
  6968. Returns whether this paragraph has automatic numbered bullets
  6969. </member>
  6970. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.BulletAutoNumberStart">
  6971. Returns the starting number if this paragraph has automatic numbered bullets, otherwise returns 0
  6972. </member>
  6973. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.BulletAutoNumberScheme">
  6974. Returns the auto number scheme if this paragraph has automatic numbered bullets, otherwise returns ListAutoNumber.ARABIC_PLAIN
  6975. </member>
  6976. <member name="T:NPOI.XSSF.UserModel.XSSFTextRun">
  6977. Represents a run of text within the Containing text body. The run element is the
  6978. lowest level text separation mechanism within a text body.
  6979. </member>
  6980. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.FontSize">
  6981. @return font size in points or -1 if font size is not Set.
  6982. </member>
  6983. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.CharacterSpacing">
  6984. @return the spacing between characters within a text Run,
  6985. If this attribute is omitted then a value of 0 or no adjustment is assumed.
  6986. </member>
  6987. <member name="M:NPOI.XSSF.UserModel.XSSFTextRun.SetFont(System.String)">
  6988. Specifies the typeface, or name of the font that is to be used for this text Run.
  6989. @param typeface the font to apply to this text Run.
  6990. The value of <code>null</code> unsets the Typeface attribute from the underlying xml.
  6991. </member>
  6992. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.FontFamily">
  6993. @return font family or null if not Set
  6994. </member>
  6995. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.IsStrikethrough">
  6996. get or set whether a run of text will be formatted as strikethrough text. Default is false.
  6997. </member>
  6998. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.IsSuperscript">
  6999. get or set whether a run of text will be formatted as a superscript text. Default is false.
  7000. Default base line offset is 30%
  7001. </member>
  7002. <member name="M:NPOI.XSSF.UserModel.XSSFTextRun.SetBaselineOffset(System.Double)">
  7003. Set the baseline for both the superscript and subscript fonts.
  7004. <p>
  7005. The size is specified using a percentage.
  7006. Positive values indicate superscript, negative values indicate subscript.
  7007. </p>
  7008. @param baselineOffset
  7009. </member>
  7010. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.IsSubscript">
  7011. get or set whether a run of text will be formatted as a superscript text. Default is false.
  7012. Default base line offset is -25%.
  7013. </member>
  7014. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.TextCap">
  7015. @return whether a run of text will be formatted as a superscript text. Default is false.
  7016. </member>
  7017. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.IsBold">
  7018. get or set whether this run of text is formatted as bold text
  7019. </member>
  7020. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.IsItalic">
  7021. get or set whether this run of text is formatted as italic text
  7022. </member>
  7023. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.IsUnderline">
  7024. get or set whether this run of text is formatted as underlined text
  7025. </member>
  7026. <member name="M:NPOI.XSSF.UserModel.XSSFVBAPart.#ctor">
  7027. Create a new XSSFVBAPart node
  7028. </member>
  7029. <member name="M:NPOI.XSSF.UserModel.XSSFVBAPart.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  7030. Construct XSSFVBAPart from a package part
  7031. @param part the package part holding the VBA data,
  7032. @param rel the package relationship holding this part
  7033. </member>
  7034. <member name="M:NPOI.XSSF.UserModel.XSSFVBAPart.PrepareForCommit">
  7035. Like *PictureData, VBA objects store the actual content in the part
  7036. directly without keeping a copy like all others therefore we need to
  7037. handle them differently.
  7038. </member>
  7039. <member name="T:NPOI.XSSF.UserModel.XSSFVMLDrawing">
  7040. Represents a SpreadsheetML VML Drawing.
  7041. <p>
  7042. In Excel 2007 VML Drawings are used to describe properties of cell comments,
  7043. although the spec says that VML is deprecated:
  7044. </p>
  7045. <p>
  7046. The VML format is a legacy format originally introduced with Office 2000 and is included and fully defined
  7047. in this Standard for backwards compatibility reasons. The DrawingML format is a newer and richer format
  7048. Created with the goal of eventually replacing any uses of VML in the Office Open XML formats. VML should be
  7049. considered a deprecated format included in Office Open XML for legacy reasons only and new applications that
  7050. need a file format for Drawings are strongly encouraged to use preferentially DrawingML
  7051. </p>
  7052. <p>
  7053. Warning - Excel is known to Put invalid XML into these files!
  7054. For example, &gt;br&lt; without being closed or escaped crops up.
  7055. </p>
  7056. See 6.4 VML - SpreadsheetML Drawing in Office Open XML Part 4 - Markup Language Reference.pdf
  7057. @author Yegor Kozlov
  7058. </member>
  7059. <member name="F:NPOI.XSSF.UserModel.XSSFVMLDrawing.ptrn_shapeId">
  7060. regexp to parse shape ids, in VML they have weird form of id="_x0000_s1026"
  7061. </member>
  7062. <member name="M:NPOI.XSSF.UserModel.XSSFVMLDrawing.#ctor">
  7063. Create a new SpreadsheetML Drawing
  7064. @see XSSFSheet#CreateDrawingPatriarch()
  7065. </member>
  7066. <member name="M:NPOI.XSSF.UserModel.XSSFVMLDrawing.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  7067. Construct a SpreadsheetML Drawing from a namespace part
  7068. @param part the namespace part holding the Drawing data,
  7069. the content type must be <code>application/vnd.Openxmlformats-officedocument.Drawing+xml</code>
  7070. @param rel the namespace relationship holding this Drawing,
  7071. the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/drawing
  7072. </member>
  7073. <member name="M:NPOI.XSSF.UserModel.XSSFVMLDrawing.newDrawing">
  7074. Initialize a new Speadsheet VML Drawing
  7075. </member>
  7076. <member name="M:NPOI.XSSF.UserModel.XSSFVMLDrawing.FindCommentShape(System.Int32,System.Int32)">
  7077. Find a shape with ClientData of type "NOTE" and the specified row and column
  7078. @return the comment shape or <code>null</code>
  7079. </member>
  7080. <member name="T:NPOI.XSSF.UserModel.XSSFWorkbook">
  7081. High level representation of a SpreadsheetML workbook. This is the first object most users
  7082. will construct whether they are Reading or writing a workbook. It is also the
  7083. top level object for creating new sheets/etc.
  7084. </member>
  7085. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.DEFAULT_CHARACTER_WIDTH">
  7086. Width of one character of the default font in pixels. Same for Calibry and Arial.
  7087. </member>
  7088. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.Max_SENSITIVE_SHEET_NAME_LEN">
  7089. Excel silently tRuncates long sheet names to 31 chars.
  7090. This constant is used to ensure uniqueness in the first 31 chars
  7091. </member>
  7092. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_EMF">
  7093. Extended windows meta file
  7094. </member>
  7095. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_WMF">
  7096. Windows Meta File
  7097. </member>
  7098. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_PICT">
  7099. Mac PICT format
  7100. </member>
  7101. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_JPEG">
  7102. JPEG format
  7103. </member>
  7104. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_PNG">
  7105. PNG format
  7106. </member>
  7107. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_DIB">
  7108. Device independent bitmap
  7109. </member>
  7110. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_GIF">
  7111. Images formats supported by XSSF but not by HSSF
  7112. </member>
  7113. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.workbook">
  7114. The underlying XML bean
  7115. </member>
  7116. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.sheets">
  7117. this holds the XSSFSheet objects attached to this workbook
  7118. </member>
  7119. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.namedRangesByName">
  7120. this holds the XSSFName objects attached to this workbook, keyed by lower-case name
  7121. </member>
  7122. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.namedRanges">
  7123. this holds the XSSFName objects attached to this workbook
  7124. </member>
  7125. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.sharedStringSource">
  7126. shared string table - a cache of strings in this workbook
  7127. </member>
  7128. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.stylesSource">
  7129. A collection of shared objects used for styling content,
  7130. e.g. fonts, cell styles, colors, etc.
  7131. </member>
  7132. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook._udfFinder">
  7133. The locator of user-defined functions.
  7134. By default includes functions from the Excel Analysis Toolpack
  7135. </member>
  7136. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.calcChain">
  7137. TODO
  7138. </member>
  7139. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.externalLinks">
  7140. External Links, for referencing names or cells in other workbooks.
  7141. </member>
  7142. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.mapInfo">
  7143. A collection of custom XML mappings
  7144. </member>
  7145. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.formatter">
  7146. Used to keep track of the data formatter so that all
  7147. CreateDataFormatter calls return the same one for a given
  7148. book. This ensures that updates from one places is visible
  7149. someplace else.
  7150. </member>
  7151. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook._missingCellPolicy">
  7152. The policy to apply in the event of missing or
  7153. blank cells when fetching from a row.
  7154. See {@link NPOI.ss.usermodel.Row.MissingCellPolicy}
  7155. </member>
  7156. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.pictures">
  7157. array of pictures for this workbook
  7158. </member>
  7159. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook._creationHelper">
  7160. cached instance of XSSFCreationHelper for this workbook
  7161. @see {@link #getCreationHelper()}
  7162. </member>
  7163. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.pivotTables">
  7164. List of all pivot tables in workbook
  7165. </member>
  7166. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor">
  7167. Create a new SpreadsheetML workbook.
  7168. </member>
  7169. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor(NPOI.XSSF.UserModel.XSSFWorkbookType)">
  7170. Create a new SpreadsheetML workbook.
  7171. @param workbookType The type of workbook to make (.xlsx or .xlsm).
  7172. </member>
  7173. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage)">
  7174. Constructs a XSSFWorkbook object given a OpenXML4J <code>Package</code> object,
  7175. see <a href="http://poi.apache.org/oxml4j/">http://poi.apache.org/oxml4j/</a>.
  7176. Once you have finished working with the Workbook, you should close the package
  7177. by calling pkg.close, to avoid leaving file handles open.
  7178. Creating a XSSFWorkbook from a file-backed OPC Package has a lower memory
  7179. footprint than an InputStream backed one.
  7180. @param pkg the OpenXML4J <code>OPC Package</code> object.
  7181. </member>
  7182. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor(System.IO.Stream)">
  7183. Constructs a XSSFWorkbook object, by buffering the whole stream into memory
  7184. and then opening an {@link OPCPackage} object for it.
  7185. Using an {@link InputStream} requires more memory than using a File, so
  7186. if a {@link File} is available then you should instead do something like
  7187. <pre><code>
  7188. OPCPackage pkg = OPCPackage.open(path);
  7189. XSSFWorkbook wb = new XSSFWorkbook(pkg);
  7190. // work with the wb object
  7191. ......
  7192. pkg.close(); // gracefully closes the underlying zip file
  7193. </code></pre>
  7194. </member>
  7195. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor(System.IO.FileInfo)" -->
  7196. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor(System.String)" -->
  7197. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.ParseSheet(System.Collections.Generic.Dictionary{System.String,NPOI.XSSF.UserModel.XSSFSheet},NPOI.OpenXmlFormats.Spreadsheet.CT_Sheet)">
  7198. Not normally to be called externally, but possibly to be overridden to avoid
  7199. the DOM based parse of large sheets (see examples).
  7200. </member>
  7201. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.OnWorkbookCreate">
  7202. Create a new CT_Workbook with all values Set to default
  7203. </member>
  7204. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.newPackage(NPOI.XSSF.UserModel.XSSFWorkbookType)">
  7205. Create a new SpreadsheetML namespace and Setup the default minimal content
  7206. </member>
  7207. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCTWorkbook">
  7208. Return the underlying XML bean
  7209. @return the underlying CT_Workbook bean
  7210. </member>
  7211. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.AddPicture(System.Byte[],System.Int32)">
  7212. Adds a picture to the workbook.
  7213. @param pictureData The bytes of the picture
  7214. @param format The format of the picture.
  7215. @return the index to this picture (0 based), the Added picture can be obtained from {@link #getAllPictures()} .
  7216. @see Workbook#PICTURE_TYPE_EMF
  7217. @see Workbook#PICTURE_TYPE_WMF
  7218. @see Workbook#PICTURE_TYPE_PICT
  7219. @see Workbook#PICTURE_TYPE_JPEG
  7220. @see Workbook#PICTURE_TYPE_PNG
  7221. @see Workbook#PICTURE_TYPE_DIB
  7222. @see #getAllPictures()
  7223. </member>
  7224. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.AddPicture(System.IO.Stream,System.Int32)">
  7225. Adds a picture to the workbook.
  7226. @param is The sream to read image from
  7227. @param format The format of the picture.
  7228. @return the index to this picture (0 based), the Added picture can be obtained from {@link #getAllPictures()} .
  7229. @see Workbook#PICTURE_TYPE_EMF
  7230. @see Workbook#PICTURE_TYPE_WMF
  7231. @see Workbook#PICTURE_TYPE_PICT
  7232. @see Workbook#PICTURE_TYPE_JPEG
  7233. @see Workbook#PICTURE_TYPE_PNG
  7234. @see Workbook#PICTURE_TYPE_DIB
  7235. @see #getAllPictures()
  7236. </member>
  7237. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CloneSheet(System.Int32)">
  7238. Create an XSSFSheet from an existing sheet in the XSSFWorkbook.
  7239. The Cloned sheet is a deep copy of the original.
  7240. @param sheetNum The index of the sheet to clone
  7241. @return XSSFSheet representing the Cloned sheet.
  7242. @throws ArgumentException if the sheet index in invalid
  7243. @throws POIXMLException if there were errors when cloning
  7244. </member>
  7245. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CloneSheet(System.Int32,System.String)">
  7246. Create an XSSFSheet from an existing sheet in the XSSFWorkbook.
  7247. The cloned sheet is a deep copy of the original but with a new given
  7248. name.
  7249. @param sheetNum The index of the sheet to clone
  7250. @param newName The name to set for the newly created sheet
  7251. @return XSSFSheet representing the cloned sheet.
  7252. @throws IllegalArgumentException if the sheet index or the sheet
  7253. name is invalid
  7254. @throws POIXMLException if there were errors when cloning
  7255. </member>
  7256. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.AddRelation(NPOI.POIXMLDocumentPart.RelationPart,NPOI.POIXMLDocumentPart)">
  7257. @since 3.14-Beta1
  7258. </member>
  7259. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetUniqueSheetName(System.String)">
  7260. Generate a valid sheet name based on the existing one. Used when cloning sheets.
  7261. @param srcName the original sheet name to
  7262. @return clone sheet name
  7263. </member>
  7264. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateCellStyle">
  7265. <summary>
  7266. Create a new XSSFCellStyle and add it to the workbook's style table
  7267. </summary>
  7268. <returns>the new XSSFCellStyle object</returns>
  7269. </member>
  7270. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateDataFormat">
  7271. <summary>
  7272. Returns the workbook's data format table (a factory for creating data format strings).
  7273. </summary>
  7274. <returns>the XSSFDataFormat object</returns>
  7275. </member>
  7276. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateFont">
  7277. <summary>
  7278. Create a new Font and add it to the workbook's font table
  7279. </summary>
  7280. <returns></returns>
  7281. </member>
  7282. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateSheet">
  7283. Create an XSSFSheet for this workbook, Adds it to the sheets and returns
  7284. the high level representation. Use this to create new sheets.
  7285. @return XSSFSheet representing the new sheet.
  7286. </member>
  7287. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateSheet(System.String)">
  7288. Create a new sheet for this Workbook and return the high level representation.
  7289. Use this to create new sheets.
  7290. <p>
  7291. Note that Excel allows sheet names up to 31 chars in length but other applications
  7292. (such as OpenOffice) allow more. Some versions of Excel crash with names longer than 31 chars,
  7293. others - tRuncate such names to 31 character.
  7294. </p>
  7295. <p>
  7296. POI's SpreadsheetAPI silently tRuncates the input argument to 31 characters.
  7297. Example:
  7298. <pre><code>
  7299. Sheet sheet = workbook.CreateSheet("My very long sheet name which is longer than 31 chars"); // will be tRuncated
  7300. assert 31 == sheet.SheetName.Length;
  7301. assert "My very long sheet name which i" == sheet.SheetName;
  7302. </code></pre>
  7303. </p>
  7304. Except the 31-character constraint, Excel applies some other rules:
  7305. <p>
  7306. Sheet name MUST be unique in the workbook and MUST NOT contain the any of the following characters:
  7307. <ul>
  7308. <li> 0x0000 </li>
  7309. <li> 0x0003 </li>
  7310. <li> colon (:) </li>
  7311. <li> backslash (\) </li>
  7312. <li> asterisk (*) </li>
  7313. <li> question mark (?) </li>
  7314. <li> forward slash (/) </li>
  7315. <li> opening square bracket ([) </li>
  7316. <li> closing square bracket (]) </li>
  7317. </ul>
  7318. The string MUST NOT begin or end with the single quote (') character.
  7319. </p>
  7320. <p>
  7321. See {@link org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)}
  7322. for a safe way to create valid names
  7323. </p>
  7324. @param sheetname sheetname to set for the sheet.
  7325. @return Sheet representing the new sheet.
  7326. @throws IllegalArgumentException if the name is null or invalid
  7327. or workbook already contains a sheet with this name
  7328. @see org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)
  7329. </member>
  7330. <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)">
  7331. Finds a font that matches the one with the supplied attributes
  7332. </member>
  7333. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.FindFont(System.Boolean,System.Int16,System.Int16,System.String,System.Boolean,System.Boolean,NPOI.SS.UserModel.FontSuperScript,NPOI.SS.UserModel.FontUnderlineType)">
  7334. Finds a font that matches the one with the supplied attributes
  7335. </member>
  7336. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.ActiveSheetIndex">
  7337. Convenience method to Get the active sheet. The active sheet is is the sheet
  7338. which is currently displayed when the workbook is viewed in Excel.
  7339. 'Selected' sheet(s) is a distinct concept.
  7340. </member>
  7341. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetAllPictures">
  7342. Gets all pictures from the Workbook.
  7343. @return the list of pictures (a list of {@link XSSFPictureData} objects.)
  7344. @see #AddPicture(byte[], int)
  7345. </member>
  7346. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCellStyleAt(System.Int32)">
  7347. Get the cell style object at the given index
  7348. @param idx index within the set of styles
  7349. @return XSSFCellStyle object at the index
  7350. </member>
  7351. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetFontAt(System.Int16)">
  7352. Get the font at the given index number
  7353. @param idx index number
  7354. @return XSSFFont at the index
  7355. </member>
  7356. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetName(System.String)">
  7357. <summary>
  7358. Get the first named range with the given name.
  7359. Note: names of named ranges are not unique as they are scoped by sheet.
  7360. {@link #getNames(String name)} returns all named ranges with the given name.
  7361. </summary>
  7362. <param name="name">named range name</param>
  7363. <returns>return XSSFName with the given name. <code>null</code> is returned no named range could be found.</returns>
  7364. </member>
  7365. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetNames(System.String)">
  7366. <summary>
  7367. Get the named ranges with the given name.
  7368. <i>Note:</i>Excel named ranges are case-insensitive and
  7369. this method performs a case-insensitive search.
  7370. </summary>
  7371. <param name="name">named range name</param>
  7372. <returns>return list of XSSFNames with the given name. An empty list if no named ranges could be found</returns>
  7373. </member>
  7374. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetAllNames">
  7375. <summary>
  7376. Get a list of all the named ranges in the workbook.
  7377. </summary>
  7378. <returns>return list of XSSFNames in the workbook</returns>
  7379. </member>
  7380. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetNameIndex(System.String)">
  7381. Gets the named range index by his name
  7382. <i>Note:</i>Excel named ranges are case-insensitive and
  7383. this method performs a case-insensitive search.
  7384. @param name named range name
  7385. @return named range index
  7386. </member>
  7387. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.NumCellStyles">
  7388. Get the number of styles the workbook Contains
  7389. @return count of cell styles
  7390. </member>
  7391. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.NumberOfFonts">
  7392. Get the number of fonts in the this workbook
  7393. @return number of fonts
  7394. </member>
  7395. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.NumberOfNames">
  7396. Get the number of named ranges in the this workbook
  7397. @return number of named ranges
  7398. </member>
  7399. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.NumberOfSheets">
  7400. Get the number of worksheets in the this workbook
  7401. @return number of worksheets
  7402. </member>
  7403. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetPrintArea(System.Int32)">
  7404. Retrieves the reference for the printarea of the specified sheet, the sheet name is Appended to the reference even if it was not specified.
  7405. @param sheetIndex Zero-based sheet index (0 Represents the first sheet to keep consistent with java)
  7406. @return String Null if no print area has been defined
  7407. </member>
  7408. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheet(System.String)">
  7409. Get sheet with the given name (case insensitive match)
  7410. @param name of the sheet
  7411. @return XSSFSheet with the name provided or <code>null</code> if it does not exist
  7412. </member>
  7413. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheetAt(System.Int32)" -->
  7414. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheetIndex(System.String)">
  7415. <summary>
  7416. Returns the index of the sheet by his name (case insensitive match)
  7417. </summary>
  7418. <param name="name">the sheet name</param>
  7419. <returns>index of the sheet (0 based) or -1 if not found</returns>
  7420. </member>
  7421. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheetIndex(NPOI.SS.UserModel.ISheet)">
  7422. Returns the index of the given sheet
  7423. @param sheet the sheet to look up
  7424. @return index of the sheet (0 based). <tt>-1</tt> if not found
  7425. </member>
  7426. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheetName(System.Int32)">
  7427. Get the sheet name
  7428. @param sheetIx Number
  7429. @return Sheet name
  7430. </member>
  7431. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetEnumerator">
  7432. Allows foreach loops:
  7433. <pre><code>
  7434. XSSFWorkbook wb = new XSSFWorkbook(package);
  7435. for(XSSFSheet sheet : wb){
  7436. }
  7437. </code></pre>
  7438. </member>
  7439. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsMacroEnabled">
  7440. Are we a normal workbook (.xlsx), or a
  7441. macro enabled workbook (.xlsm)?
  7442. </member>
  7443. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.RemoveName(NPOI.SS.UserModel.IName)">
  7444. As {@link #removeName(String)} is not necessarily unique
  7445. (name + sheet index is unique), this method is more accurate.
  7446. @param name the name to remove.
  7447. </member>
  7448. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.RemovePrintArea(System.Int32)">
  7449. Delete the printarea for the sheet specified
  7450. @param sheetIndex 0-based sheet index (0 = First Sheet)
  7451. </member>
  7452. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.RemoveSheetAt(System.Int32)">
  7453. Removes sheet at the given index.<p/>
  7454. Care must be taken if the Removed sheet is the currently active or only selected sheet in
  7455. the workbook. There are a few situations when Excel must have a selection and/or active
  7456. sheet. (For example when printing - see Bug 40414).<br/>
  7457. This method Makes sure that if the Removed sheet was active, another sheet will become
  7458. active in its place. Furthermore, if the Removed sheet was the only selected sheet, another
  7459. sheet will become selected. The newly active/selected sheet will have the same index, or
  7460. one less if the Removed sheet was the last in the workbook.
  7461. @param index of the sheet (0-based)
  7462. </member>
  7463. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.OnSheetDelete(System.Int32)">
  7464. Gracefully remove references to the sheet being deleted
  7465. @param index the 0-based index of the sheet to delete
  7466. </member>
  7467. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.MissingCellPolicy">
  7468. Retrieves the current policy on what to do when
  7469. Getting missing or blank cells from a row.
  7470. The default is to return blank and null cells.
  7471. {@link MissingCellPolicy}
  7472. </member>
  7473. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.ValidateSheetIndex(System.Int32)">
  7474. Validate sheet index
  7475. @param index the index to validate
  7476. @throws ArgumentException if the index is out of range (index
  7477. &lt; 0 || index &gt;= NumberOfSheets).
  7478. </member>
  7479. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.FirstVisibleTab">
  7480. Gets the first tab that is displayed in the list of tabs in excel.
  7481. @return integer that Contains the index to the active sheet in this book view.
  7482. </member>
  7483. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFWorkbook.SetPrintArea(System.Int32,System.String)" -->
  7484. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetPrintArea(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  7485. For the Convenience of Java Programmers maintaining pointers.
  7486. @see #setPrintArea(int, String)
  7487. @param sheetIndex Zero-based sheet index (0 = First Sheet)
  7488. @param startColumn Column to begin printarea
  7489. @param endColumn Column to end the printarea
  7490. @param startRow Row to begin the printarea
  7491. @param endRow Row to end the printarea
  7492. </member>
  7493. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateBuiltInName(System.String,System.Int32)">
  7494. Generates a NameRecord to represent a built-in region
  7495. @return a new NameRecord
  7496. @throws ArgumentException if sheetNumber is invalid
  7497. @throws POIXMLException if such a name already exists in the workbook
  7498. </member>
  7499. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSelectedTab(System.Int32)">
  7500. We only Set one sheet as selected for compatibility with HSSF.
  7501. </member>
  7502. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetName(System.Int32,System.String)">
  7503. Set the sheet name.
  7504. @param sheetIndex sheet number (0 based)
  7505. @param sheetname the new sheet name
  7506. @throws ArgumentException if the name is null or invalid
  7507. or workbook already Contains a sheet with this name
  7508. @see {@link #CreateSheet(String)}
  7509. @see {@link NPOI.ss.util.WorkbookUtil#CreateSafeSheetName(String nameProposal)}
  7510. for a safe way to create valid names
  7511. </member>
  7512. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetOrder(System.String,System.Int32)">
  7513. Sets the order of appearance for a given sheet.
  7514. @param sheetname the name of the sheet to reorder
  7515. @param pos the position that we want to insert the sheet into (0 based)
  7516. </member>
  7517. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SaveNamedRanges">
  7518. marshal named ranges from the {@link #namedRanges} collection to the underlying CT_Workbook bean
  7519. </member>
  7520. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.Write(System.IO.Stream,System.Boolean)">
  7521. <summary>
  7522. Write the document to the specified stream, and optionally leave the stream open without closing it.
  7523. </summary>
  7524. </member>
  7525. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSharedStringSource">
  7526. Returns SharedStringsTable - the cache of strings for this workbook
  7527. @return the shared string table
  7528. </member>
  7529. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetStylesSource">
  7530. Return a object representing a collection of shared objects used for styling content,
  7531. e.g. fonts, cell styles, colors, etc.
  7532. </member>
  7533. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetTheme">
  7534. Returns the Theme of current workbook.
  7535. </member>
  7536. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCreationHelper">
  7537. Returns an object that handles instantiating concrete
  7538. classes of the various instances for XSSF.
  7539. </member>
  7540. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.ContainsSheet(System.String,System.Int32)">
  7541. Determines whether a workbook Contains the provided sheet name.
  7542. For the purpose of comparison, long names are tRuncated to 31 chars.
  7543. @param name the name to Test (case insensitive match)
  7544. @param excludeSheetIdx the sheet to exclude from the check or -1 to include all sheets in the Check.
  7545. @return true if the sheet Contains the name, false otherwise.
  7546. </member>
  7547. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsDate1904">
  7548. <summary>
  7549. Gets a bool value that indicates whether the date systems used in the workbook starts in 1904.
  7550. The default value is false, meaning that the workbook uses the 1900 date system,
  7551. where 1/1/1900 is the first day in the system.
  7552. </summary>
  7553. <returns>True if the date systems used in the workbook starts in 1904</returns>
  7554. </member>
  7555. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetAllEmbedds">
  7556. Get the document's embedded files.
  7557. </member>
  7558. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsSheetHidden(System.Int32)">
  7559. Check whether a sheet is hidden.
  7560. <p>
  7561. Note that a sheet could instead be Set to be very hidden, which is different
  7562. ({@link #isSheetVeryHidden(int)})
  7563. </p>
  7564. @param sheetIx Number
  7565. @return <code>true</code> if sheet is hidden
  7566. </member>
  7567. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsSheetVeryHidden(System.Int32)">
  7568. Check whether a sheet is very hidden.
  7569. <p>
  7570. This is different from the normal hidden status
  7571. ({@link #isSheetHidden(int)})
  7572. </p>
  7573. @param sheetIx sheet index to check
  7574. @return <code>true</code> if sheet is very hidden
  7575. </member>
  7576. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetHidden(System.Int32,System.Boolean)">
  7577. Sets the visible state of this sheet.
  7578. <p>
  7579. Calling <code>setSheetHidden(sheetIndex, true)</code> is equivalent to
  7580. <code>setSheetHidden(sheetIndex, Workbook.SHEET_STATE_HIDDEN)</code>.
  7581. <br/>
  7582. Calling <code>setSheetHidden(sheetIndex, false)</code> is equivalent to
  7583. <code>setSheetHidden(sheetIndex, Workbook.SHEET_STATE_VISIBLE)</code>.
  7584. </p>
  7585. @param sheetIx the 0-based index of the sheet
  7586. @param hidden whether this sheet is hidden
  7587. @see #setSheetHidden(int, int)
  7588. </member>
  7589. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetHidden(System.Int32,NPOI.SS.UserModel.SheetState)">
  7590. Hide or unhide a sheet.
  7591. <ul>
  7592. <li>0 - visible. </li>
  7593. <li>1 - hidden. </li>
  7594. <li>2 - very hidden.</li>
  7595. </ul>
  7596. @param sheetIx the sheet index (0-based)
  7597. @param state one of the following <code>Workbook</code> constants:
  7598. <code>Workbook.SHEET_STATE_VISIBLE</code>,
  7599. <code>Workbook.SHEET_STATE_HIDDEN</code>, or
  7600. <code>Workbook.SHEET_STATE_VERY_HIDDEN</code>.
  7601. @throws ArgumentException if the supplied sheet index or state is invalid
  7602. </member>
  7603. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetHidden(System.Int32,System.Int32)">
  7604. <summary>
  7605. Hide or unhide a sheet.
  7606. </summary>
  7607. <param name="sheetIx">The sheet number</param>
  7608. <param name="hidden">0 for not hidden, 1 for hidden, 2 for very hidden</param>
  7609. </member>
  7610. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.OnDeleteFormula(NPOI.XSSF.UserModel.XSSFCell)">
  7611. Fired when a formula is deleted from this workbook,
  7612. for example when calling cell.SetCellFormula(null)
  7613. @see XSSFCell#setCellFormula(String)
  7614. </member>
  7615. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCalculationChain">
  7616. Return the CalculationChain object for this workbook
  7617. <p>
  7618. The calculation chain object specifies the order in which the cells in a workbook were last calculated
  7619. </p>
  7620. @return the <code>CalculationChain</code> object or <code>null</code> if not defined
  7621. </member>
  7622. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.ExternalLinksTable">
  7623. * Returns the list of {@link ExternalLinksTable} object for this workbook
  7624. *
  7625. * <p>The external links table specifies details of named ranges etc
  7626. * that are referenced from other workbooks, along with the last seen
  7627. * values of what they point to.</p>
  7628. *
  7629. * <p>Note that Excel uses index 0 for the current workbook, so the first
  7630. * External Links in a formula would be '[1]Foo' which corresponds to
  7631. * entry 0 in this list.</p>
  7632. * @return the <code>ExternalLinksTable</code> list, which may be empty
  7633. </member>
  7634. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCustomXMLMappings">
  7635. @return a collection of custom XML mappings defined in this workbook
  7636. </member>
  7637. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetMapInfo">
  7638. @return the helper class used to query the custom XML mapping defined in this workbook
  7639. </member>
  7640. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.LinkExternalWorkbook(System.String,NPOI.SS.UserModel.IWorkbook)">
  7641. Adds the External Link Table part and relations required to allow formulas
  7642. referencing the specified external workbook to be added to this one. Allows
  7643. formulas such as "[MyOtherWorkbook.xlsx]Sheet3!$A$5" to be added to the
  7644. file, for workbooks not already linked / referenced.
  7645. @param name The name the workbook will be referenced as in formulas
  7646. @param workbook The open workbook to fetch the link required information from
  7647. </member>
  7648. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsStructureLocked">
  7649. Specifies a bool value that indicates whether structure of workbook is locked. <br/>
  7650. A value true indicates the structure of the workbook is locked. Worksheets in the workbook can't be Moved,
  7651. deleted, hidden, unhidden, or Renamed, and new worksheets can't be inserted.<br/>
  7652. A value of false indicates the structure of the workbook is not locked.<br/>
  7653. @return true if structure of workbook is locked
  7654. </member>
  7655. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsWindowsLocked">
  7656. Specifies a bool value that indicates whether the windows that comprise the workbook are locked. <br/>
  7657. A value of true indicates the workbook windows are locked. Windows are the same size and position each time the
  7658. workbook is opened.<br/>
  7659. A value of false indicates the workbook windows are not locked.
  7660. @return true if windows that comprise the workbook are locked
  7661. </member>
  7662. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsRevisionLocked">
  7663. Specifies a bool value that indicates whether the workbook is locked for revisions.
  7664. @return true if the workbook is locked for revisions.
  7665. </member>
  7666. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.LockStructure">
  7667. Locks the structure of workbook.
  7668. </member>
  7669. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.UnlockStructure">
  7670. Unlocks the structure of workbook.
  7671. </member>
  7672. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.LockWindows">
  7673. Locks the windows that comprise the workbook.
  7674. </member>
  7675. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.UnlockWindows">
  7676. Unlocks the windows that comprise the workbook.
  7677. </member>
  7678. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.LockRevision">
  7679. Locks the workbook for revisions.
  7680. </member>
  7681. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.UnlockRevision">
  7682. Unlocks the workbook for revisions.
  7683. </member>
  7684. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.RemovePivotTables">
  7685. Remove Pivot Tables and PivotCaches from the workbooka
  7686. </member>
  7687. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetUDFFinder">
  7688. Returns the locator of user-defined functions.
  7689. <p>
  7690. The default instance : the built-in functions with the Excel Analysis Tool Pack.
  7691. To Set / Evaluate custom functions you need to register them as follows:
  7692. </p>
  7693. @return wrapped instance of UDFFinder that allows seeking functions both by index and name
  7694. </member>
  7695. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.AddToolPack(NPOI.SS.Formula.UDF.UDFFinder)">
  7696. Register a new toolpack in this workbook.
  7697. @param toopack the toolpack to register
  7698. </member>
  7699. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetForceFormulaRecalculation(System.Boolean)">
  7700. Whether the application shall perform a full recalculation when the workbook is opened.
  7701. <p>
  7702. Typically you want to force formula recalculation when you modify cell formulas or values
  7703. of a workbook previously Created by Excel. When Set to true, this flag will tell Excel
  7704. that it needs to recalculate all formulas in the workbook the next time the file is opened.
  7705. </p>
  7706. <p>
  7707. Note, that recalculation updates cached formula results and, thus, modifies the workbook.
  7708. Depending on the version, Excel may prompt you with "Do you want to save the Changes in <em>filename</em>?"
  7709. on close.
  7710. </p>
  7711. @param value true if the application will perform a full recalculation of
  7712. workbook values when the workbook is opened
  7713. @since 3.8
  7714. </member>
  7715. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetForceFormulaRecalculation">
  7716. Whether Excel will be asked to recalculate all formulas when the workbook is opened.
  7717. @since 3.8
  7718. </member>
  7719. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.SpreadsheetVersion">
  7720. <summary>
  7721. Returns the spreadsheet version (EXCLE2007) of this workbook
  7722. </summary>
  7723. </member>
  7724. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetTable(System.String)">
  7725. Returns the data table with the given name (case insensitive).
  7726. @param name the data table name (case-insensitive)
  7727. @return The Data table in the workbook named <tt>name</tt>, or <tt>null</tt> if no table is named <tt>name</tt>.
  7728. @since 3.15 beta 2
  7729. </member>
  7730. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.AddPivotCache(System.String)">
  7731. Add pivotCache to the workbook
  7732. </member>
  7733. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetVBAProject(System.IO.Stream)">
  7734. Adds a vbaProject.bin file to the workbook. This will change the workbook
  7735. type if necessary.
  7736. @throws IOException
  7737. </member>
  7738. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetVBAProject(NPOI.XSSF.UserModel.XSSFWorkbook)">
  7739. Adds a vbaProject.bin file taken from another, given workbook to this one.
  7740. @throws IOException
  7741. @throws InvalidFormatException
  7742. </member>
  7743. <member name="T:NPOI.XSSF.Util.EvilUnclosedBRFixingInputStream">
  7744. This is a seriously sick fix for the fact that some .xlsx
  7745. files contain raw bits of HTML, without being escaped
  7746. or properly turned into XML.
  7747. The result is that they contain things like &gt;br&lt;,
  7748. which breaks the XML parsing.
  7749. This very sick InputStream wrapper attempts to spot
  7750. these go past, and fix them.
  7751. Only works for UTF-8 and US-ASCII based streams!
  7752. It should only be used where experience Shows the problem
  7753. can occur...
  7754. </member>
  7755. <member name="M:NPOI.XSSF.Util.EvilUnclosedBRFixingInputStream.Read">
  7756. Warning - doesn't fix!
  7757. </member>
  7758. <member name="M:NPOI.XSSF.Util.EvilUnclosedBRFixingInputStream.ReadFromSpare(System.Byte[],System.Int32,System.Int32)">
  7759. Reads into the buffer from the spare bytes
  7760. </member>
  7761. <member name="T:NPOI.XSSF.XLSBUnsupportedException">
  7762. We don't support .xlsb files, sorry
  7763. </member>
  7764. <member name="T:NPOI.XWPF.Extractor.XWPFWordExtractor">
  7765. Helper class to extract text from an OOXML Word file
  7766. </member>
  7767. <member name="M:NPOI.XWPF.Extractor.XWPFWordExtractor.SetFetchHyperlinks(System.Boolean)">
  7768. Should we also fetch the hyperlinks, when fetching
  7769. the text content? Default is to only output the
  7770. hyperlink label, and not the contents
  7771. </member>
  7772. <member name="T:NPOI.XWPF.Model.XMLParagraph">
  7773. Base class for XWPF paragraphs
  7774. @author Yury Batrakov (batrakov at gmail.com)
  7775. </member>
  7776. <member name="T:NPOI.XWPF.Model.XWPFCommentsDecorator">
  7777. Decorator class for XWPFParagraph allowing to add comments
  7778. found in paragraph to its text
  7779. @author Yury Batrakov (batrakov at gmail.com)
  7780. </member>
  7781. <member name="T:NPOI.XWPF.Model.XWPFHeaderFooterPolicy">
  7782. A .docx file can have no headers/footers, the same header/footer
  7783. on each page, odd/even page footers, and optionally also
  7784. a different header/footer on the first page.
  7785. This class handles sorting out what there is, and giving you
  7786. the right headers and footers for the document.
  7787. </member>
  7788. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.#ctor(NPOI.XWPF.UserModel.XWPFDocument)">
  7789. Figures out the policy for the given document,
  7790. and Creates any header and footer objects
  7791. as required.
  7792. </member>
  7793. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.#ctor(NPOI.XWPF.UserModel.XWPFDocument,NPOI.OpenXmlFormats.Wordprocessing.CT_SectPr)">
  7794. Figures out the policy for the given document,
  7795. and Creates any header and footer objects
  7796. as required.
  7797. </member>
  7798. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.buildHdrFtr(System.String,NPOI.XWPF.UserModel.XWPFParagraph[],NPOI.XWPF.UserModel.XWPFHeaderFooter)">
  7799. MB 24 May 2010. Created this overloaded buildHdrFtr() method because testing demonstrated
  7800. that the XWPFFooter or XWPFHeader object returned by calls to the CreateHeader(int, XWPFParagraph[])
  7801. and CreateFooter(int, XWPFParagraph[]) methods or the GetXXXXXHeader/Footer methods where
  7802. headers or footers had been Added to a document since it had been Created/opened, returned
  7803. an object that Contained no XWPFParagraph objects even if the header/footer itself did contain
  7804. text. The reason was that this line of code; CTHdrFtr ftr = CTHdrFtr.Factory.NewInstance();
  7805. Created a brand new instance of the CTHDRFtr class which was then populated with data when
  7806. it should have recovered the CTHdrFtr object encapsulated within the XWPFHeaderFooter object
  7807. that had previoulsy been instantiated in the CreateHeader(int, XWPFParagraph[]) or
  7808. CreateFooter(int, XWPFParagraph[]) methods.
  7809. </member>
  7810. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.GetOddPageHeader">
  7811. Returns the odd page header. This is
  7812. also the same as the default one...
  7813. </member>
  7814. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.GetOddPageFooter">
  7815. Returns the odd page footer. This is
  7816. also the same as the default one...
  7817. </member>
  7818. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.GetHeader(System.Int32)">
  7819. Get the header that applies to the given
  7820. (1 based) page.
  7821. @param pageNumber The one based page number
  7822. </member>
  7823. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.GetFooter(System.Int32)">
  7824. Get the footer that applies to the given
  7825. (1 based) page.
  7826. @param pageNumber The one based page number
  7827. </member>
  7828. <member name="T:NPOI.XWPF.Model.XWPFParagraphDecorator">
  7829. Base decorator class for XWPFParagraph
  7830. </member>
  7831. <member name="T:NPOI.XWPF.UserModel.AbstractXWPFSDT">
  7832. Experimental abstract class that is a base for XWPFSDT and XWPFSDTCell
  7833. <p/>
  7834. WARNING - APIs expected to change rapidly.
  7835. <p/>
  7836. These classes have so far been built only for Read-only Processing.
  7837. </member>
  7838. <member name="M:NPOI.XWPF.UserModel.AbstractXWPFSDT.GetTitle">
  7839. @return first SDT Title
  7840. </member>
  7841. <member name="M:NPOI.XWPF.UserModel.AbstractXWPFSDT.GetTag">
  7842. @return first SDT Tag
  7843. </member>
  7844. <member name="P:NPOI.XWPF.UserModel.AbstractXWPFSDT.Content">
  7845. @return the content object
  7846. </member>
  7847. <member name="M:NPOI.XWPF.UserModel.AbstractXWPFSDT.GetBody">
  7848. @return null
  7849. </member>
  7850. <member name="M:NPOI.XWPF.UserModel.AbstractXWPFSDT.GetPart">
  7851. @return document part
  7852. </member>
  7853. <member name="M:NPOI.XWPF.UserModel.AbstractXWPFSDT.GetPartType">
  7854. @return partType
  7855. </member>
  7856. <member name="M:NPOI.XWPF.UserModel.AbstractXWPFSDT.GetElementType">
  7857. @return element type
  7858. </member>
  7859. <member name="T:NPOI.XWPF.UserModel.BodyElementType">
  7860. <p>
  7861. 9 Jan 2010
  7862. </p>
  7863. <p>
  7864. // TODO insert Javadoc here!
  7865. </p>
  7866. @author epp
  7867. </member>
  7868. <member name="T:NPOI.XWPF.UserModel.BodyType">
  7869. The different kinds of {@link IBody} that exist
  7870. </member>
  7871. <member name="T:NPOI.XWPF.UserModel.Borders">
  7872. Specifies all types of borders which can be specified for WordProcessingML
  7873. objects which have a border. Borders can be Separated into two types:
  7874. <ul>
  7875. <li> Line borders: which specify a pattern to be used when Drawing a line around the
  7876. specified object.
  7877. </li>
  7878. <li> Art borders: which specify a repeated image to be used
  7879. when Drawing a border around the specified object. Line borders may be
  7880. specified on any object which allows a border, however, art borders may only
  7881. be used as a border at the page level - the borders under the pgBorders
  7882. element
  7883. </li>
  7884. </ul>
  7885. @author Gisella Bronzetti
  7886. </member>
  7887. <member name="F:NPOI.XWPF.UserModel.Borders.Single">
  7888. Specifies a line border consisting of a single line around the parent
  7889. object.
  7890. </member>
  7891. <member name="F:NPOI.XWPF.UserModel.Borders.Apples">
  7892. specifies an art border consisting of a repeated image of an apple
  7893. </member>
  7894. <member name="F:NPOI.XWPF.UserModel.Borders.ArchedScallops">
  7895. specifies an art border consisting of a repeated image of a shell pattern
  7896. </member>
  7897. <member name="F:NPOI.XWPF.UserModel.Borders.BabyPacifier">
  7898. specifies an art border consisting of a repeated image of a baby pacifier
  7899. </member>
  7900. <member name="F:NPOI.XWPF.UserModel.Borders.BabyRattle">
  7901. specifies an art border consisting of a repeated image of a baby rattle
  7902. </member>
  7903. <member name="F:NPOI.XWPF.UserModel.Borders.Balloons3Colors">
  7904. specifies an art border consisting of a repeated image of a set of
  7905. balloons
  7906. </member>
  7907. <member name="F:NPOI.XWPF.UserModel.Borders.BalloonsHotAir">
  7908. specifies an art border consisting of a repeated image of a hot air
  7909. balloon
  7910. </member>
  7911. <member name="F:NPOI.XWPF.UserModel.Borders.BasicBlackDashes">
  7912. specifies an art border consisting of a repeating image of a black and
  7913. white background.
  7914. </member>
  7915. <member name="F:NPOI.XWPF.UserModel.Borders.BasicBlackDots">
  7916. specifies an art border consisting of a repeating image of a black dot on
  7917. a white background.
  7918. </member>
  7919. <member name="F:NPOI.XWPF.UserModel.Borders.BasicBlackSquares">
  7920. specifies an art border consisting of a repeating image of a black and
  7921. white background
  7922. </member>
  7923. <member name="F:NPOI.XWPF.UserModel.Borders.BasicThinLines">
  7924. specifies an art border consisting of a repeating image of a black and
  7925. white background.
  7926. </member>
  7927. <member name="F:NPOI.XWPF.UserModel.Borders.BasicWhiteDashes">
  7928. specifies an art border consisting of a repeating image of a black and
  7929. white background.
  7930. </member>
  7931. <member name="F:NPOI.XWPF.UserModel.Borders.BasicWhiteDots">
  7932. specifies an art border consisting of a repeating image of a white dot on
  7933. a black background.
  7934. </member>
  7935. <member name="F:NPOI.XWPF.UserModel.Borders.BasicWhiteSquares">
  7936. specifies an art border consisting of a repeating image of a black and
  7937. white background.
  7938. </member>
  7939. <member name="F:NPOI.XWPF.UserModel.Borders.BasicWideInline">
  7940. specifies an art border consisting of a repeating image of a black and
  7941. white background.
  7942. </member>
  7943. <member name="F:NPOI.XWPF.UserModel.Borders.BasicWideMidline">
  7944. specifies an art border consisting of a repeating image of a black and
  7945. white background
  7946. </member>
  7947. <member name="F:NPOI.XWPF.UserModel.Borders.BasicWideOutline">
  7948. specifies an art border consisting of a repeating image of a black and
  7949. white background
  7950. </member>
  7951. <member name="F:NPOI.XWPF.UserModel.Borders.Bats">
  7952. specifies an art border consisting of a repeated image of bats
  7953. </member>
  7954. <member name="F:NPOI.XWPF.UserModel.Borders.Birds">
  7955. specifies an art border consisting of repeating images of birds
  7956. </member>
  7957. <member name="F:NPOI.XWPF.UserModel.Borders.BirdsFlight">
  7958. specifies an art border consisting of a repeated image of birds flying
  7959. </member>
  7960. <member name="F:NPOI.XWPF.UserModel.Borders.Cabins">
  7961. specifies an art border consisting of a repeated image of a cabin
  7962. </member>
  7963. <member name="F:NPOI.XWPF.UserModel.Borders.CakeSlice">
  7964. specifies an art border consisting of a repeated image of a piece of cake
  7965. </member>
  7966. <member name="F:NPOI.XWPF.UserModel.Borders.CandyCorn">
  7967. specifies an art border consisting of a repeated image of candy corn
  7968. </member>
  7969. <member name="F:NPOI.XWPF.UserModel.Borders.CelticKnotwork">
  7970. specifies an art border consisting of a repeated image of a knot work
  7971. pattern
  7972. </member>
  7973. <member name="F:NPOI.XWPF.UserModel.Borders.CertificateBanner">
  7974. specifies an art border consisting of a banner.
  7975. <p>
  7976. if the border is on the left or right, no border is displayed.
  7977. </p>
  7978. </member>
  7979. <member name="F:NPOI.XWPF.UserModel.Borders.ChainLink">
  7980. specifies an art border consisting of a repeating image of a chain link
  7981. pattern.
  7982. </member>
  7983. <member name="F:NPOI.XWPF.UserModel.Borders.ChampagneBottle">
  7984. specifies an art border consisting of a repeated image of a champagne
  7985. bottle
  7986. </member>
  7987. <member name="F:NPOI.XWPF.UserModel.Borders.CheckedBarBlack">
  7988. specifies an art border consisting of repeating images of a compass
  7989. </member>
  7990. <member name="F:NPOI.XWPF.UserModel.Borders.CheckedBarColor">
  7991. specifies an art border consisting of a repeating image of a colored
  7992. pattern.
  7993. </member>
  7994. <member name="F:NPOI.XWPF.UserModel.Borders.Checkered">
  7995. specifies an art border consisting of a repeated image of a checkerboard
  7996. </member>
  7997. <member name="F:NPOI.XWPF.UserModel.Borders.ChristmasTree">
  7998. specifies an art border consisting of a repeated image of a christmas
  7999. tree
  8000. </member>
  8001. <member name="F:NPOI.XWPF.UserModel.Borders.CirclesLines">
  8002. specifies an art border consisting of repeating images of lines and
  8003. circles
  8004. </member>
  8005. <member name="F:NPOI.XWPF.UserModel.Borders.CirclesRectangles">
  8006. specifies an art border consisting of a repeated image of a rectangular
  8007. pattern
  8008. </member>
  8009. <member name="F:NPOI.XWPF.UserModel.Borders.ClassicalWave">
  8010. specifies an art border consisting of a repeated image of a wave
  8011. </member>
  8012. <member name="F:NPOI.XWPF.UserModel.Borders.Clocks">
  8013. specifies an art border consisting of a repeated image of a clock
  8014. </member>
  8015. <member name="F:NPOI.XWPF.UserModel.Borders.Compass">
  8016. specifies an art border consisting of repeating images of a compass
  8017. </member>
  8018. <member name="F:NPOI.XWPF.UserModel.Borders.Confetti">
  8019. specifies an art border consisting of a repeated image of confetti
  8020. </member>
  8021. <member name="F:NPOI.XWPF.UserModel.Borders.ConfettiGrays">
  8022. specifies an art border consisting of a repeated image of confetti
  8023. </member>
  8024. <member name="F:NPOI.XWPF.UserModel.Borders.ConfettiOutline">
  8025. specifies an art border consisting of a repeated image of confetti
  8026. </member>
  8027. <member name="F:NPOI.XWPF.UserModel.Borders.ConfettiStreamers">
  8028. specifies an art border consisting of a repeated image of confetti
  8029. streamers
  8030. </member>
  8031. <member name="F:NPOI.XWPF.UserModel.Borders.ConfettiWhite">
  8032. specifies an art border consisting of a repeated image of confetti
  8033. </member>
  8034. <member name="F:NPOI.XWPF.UserModel.Borders.CornerTriangles">
  8035. specifies an art border consisting of a repeated image
  8036. </member>
  8037. <member name="F:NPOI.XWPF.UserModel.Borders.CouponCutoutDashes">
  8038. specifies an art border consisting of a dashed line
  8039. </member>
  8040. <member name="F:NPOI.XWPF.UserModel.Borders.CouponCutoutDots">
  8041. specifies an art border consisting of a dotted line
  8042. </member>
  8043. <member name="F:NPOI.XWPF.UserModel.Borders.CrazyMaze">
  8044. specifies an art border consisting of a repeated image of a maze-like
  8045. pattern
  8046. </member>
  8047. <member name="F:NPOI.XWPF.UserModel.Borders.CreaturesButterfly">
  8048. specifies an art border consisting of a repeated image of a butterfly
  8049. </member>
  8050. <member name="F:NPOI.XWPF.UserModel.Borders.CreaturesFish">
  8051. specifies an art border consisting of a repeated image of a fish
  8052. </member>
  8053. <member name="F:NPOI.XWPF.UserModel.Borders.CreaturesInsects">
  8054. specifies an art border consisting of repeating images of insects.
  8055. </member>
  8056. <member name="F:NPOI.XWPF.UserModel.Borders.CreaturesLadyBug">
  8057. specifies an art border consisting of a repeated image of a ladybug
  8058. </member>
  8059. <member name="F:NPOI.XWPF.UserModel.Borders.CrossStitch">
  8060. specifies an art border consisting of repeating images of a cross-stitch
  8061. pattern
  8062. </member>
  8063. <member name="F:NPOI.XWPF.UserModel.Borders.Cup">
  8064. specifies an art border consisting of a repeated image of cupid
  8065. </member>
  8066. <member name="T:NPOI.XWPF.UserModel.BreakClear">
  8067. Specifies the Set of possible restart locations which may be used as to
  8068. determine the next available line when a break's type attribute has a value
  8069. of textWrapping.
  8070. @author Gisella Bronzetti
  8071. </member>
  8072. <member name="F:NPOI.XWPF.UserModel.BreakClear.NONE">
  8073. Specifies that the text wrapping break shall advance the text to the next
  8074. line in the WordProcessingML document, regardless of its position left to
  8075. right or the presence of any floating objects which intersect with the
  8076. line,
  8077. This is the Setting for a typical line break in a document.
  8078. </member>
  8079. <member name="F:NPOI.XWPF.UserModel.BreakClear.LEFT">
  8080. Specifies that the text wrapping break shall behave as follows:
  8081. <ul>
  8082. <li> If this line is broken into multiple regions (a floating object in
  8083. the center of the page has text wrapping on both sides:
  8084. <ul>
  8085. <li> If this is the leftmost region of text flow on this line, advance
  8086. the text to the next position on the line </li>
  8087. <li>Otherwise, treat this as a text wrapping break of type all. </li>
  8088. </ul>
  8089. </li>
  8090. <li> If this line is not broken into multiple regions, then treat this
  8091. break as a text wrapping break of type none. </li>
  8092. </ul>
  8093. <li> If the parent paragraph is right to left, then these behaviors are
  8094. also reversed. </li>
  8095. </member>
  8096. <!-- Badly formed XML comment ignored for member "F:NPOI.XWPF.UserModel.BreakClear.RIGHT" -->
  8097. <member name="F:NPOI.XWPF.UserModel.BreakClear.ALL">
  8098. Specifies that the text wrapping break shall advance the text to the next
  8099. line in the WordProcessingML document which spans the full width of the
  8100. line.
  8101. </member>
  8102. <member name="T:NPOI.XWPF.UserModel.BreakType">
  8103. Specifies the possible types of break characters in a WordProcessingML
  8104. document.
  8105. The break type determines the next location where text shall be
  8106. placed After this manual break is applied to the text contents
  8107. @author Gisella Bronzetti
  8108. </member>
  8109. <member name="F:NPOI.XWPF.UserModel.BreakType.PAGE">
  8110. Specifies that the current break shall restart itself on the next page of
  8111. the document when the document is displayed in page view.
  8112. </member>
  8113. <member name="F:NPOI.XWPF.UserModel.BreakType.COLUMN">
  8114. Specifies that the current break shall restart itself on the next column
  8115. available on the current page when the document is displayed in page
  8116. view.
  8117. <p>
  8118. If the current section is not divided into columns, or the column break
  8119. occurs in the last column on the current page when displayed, then the
  8120. restart location for text shall be the next page in the document.
  8121. </p>
  8122. </member>
  8123. <member name="F:NPOI.XWPF.UserModel.BreakType.TEXTWRAPPING">
  8124. Specifies that the current break shall restart itself on the next line in
  8125. the document when the document is displayed in page view.
  8126. The determine of the next line shall be done subject to the value of the clear
  8127. attribute on the specified break character.
  8128. </member>
  8129. <member name="F:NPOI.XWPF.UserModel.PictureType.EMF">
  8130. Extended windows meta file
  8131. </member>
  8132. <member name="F:NPOI.XWPF.UserModel.PictureType.WMF">
  8133. Windows Meta File
  8134. </member>
  8135. <member name="F:NPOI.XWPF.UserModel.PictureType.PICT">
  8136. Mac PICT format
  8137. </member>
  8138. <member name="F:NPOI.XWPF.UserModel.PictureType.JPEG">
  8139. JPEG format
  8140. </member>
  8141. <member name="F:NPOI.XWPF.UserModel.PictureType.PNG">
  8142. PNG format
  8143. </member>
  8144. <member name="F:NPOI.XWPF.UserModel.PictureType.DIB">
  8145. Device independent bitmap
  8146. </member>
  8147. <member name="F:NPOI.XWPF.UserModel.PictureType.GIF">
  8148. GIF image format
  8149. </member>
  8150. <member name="F:NPOI.XWPF.UserModel.PictureType.TIFF">
  8151. Tag Image File (.tiff)
  8152. </member>
  8153. <member name="F:NPOI.XWPF.UserModel.PictureType.EPS">
  8154. Encapsulated Postscript (.eps)
  8155. </member>
  8156. <member name="F:NPOI.XWPF.UserModel.PictureType.BMP">
  8157. Windows Bitmap (.bmp)
  8158. </member>
  8159. <member name="F:NPOI.XWPF.UserModel.PictureType.WPG">
  8160. WordPerfect graphics (.wpg)
  8161. </member>
  8162. <member name="F:NPOI.XWPF.UserModel.PictureType.SVG">
  8163. Scalable Vector Graphics (.svg)
  8164. </member>
  8165. <member name="T:NPOI.XWPF.UserModel.IBody">
  8166. An IBody represents the different parts of the document which
  8167. can contain collections of Paragraphs and Tables. It provides a
  8168. common way to work with these and their contents.
  8169. Typically, this is something like a XWPFDocument, or one of
  8170. the parts in it like XWPFHeader, XWPFFooter, XWPFTableCell
  8171. </member>
  8172. <member name="P:NPOI.XWPF.UserModel.IBody.Part">
  8173. returns the Part, to which the body belongs, which you need for Adding relationship to other parts
  8174. Actually it is needed of the class XWPFTableCell. Because you have to know to which part the tableCell
  8175. belongs.
  8176. @return the Part, to which the body belongs
  8177. </member>
  8178. <member name="P:NPOI.XWPF.UserModel.IBody.PartType">
  8179. Get the PartType of the body, for example
  8180. DOCUMENT, HEADER, FOOTER, FOOTNOTE,
  8181. @return the PartType of the body
  8182. </member>
  8183. <member name="P:NPOI.XWPF.UserModel.IBody.BodyElements">
  8184. Returns an Iterator with paragraphs and tables,
  8185. in the order that they occur in the text.
  8186. </member>
  8187. <member name="P:NPOI.XWPF.UserModel.IBody.Paragraphs">
  8188. Returns the paragraph(s) that holds
  8189. the text of the header or footer.
  8190. </member>
  8191. <member name="P:NPOI.XWPF.UserModel.IBody.Tables">
  8192. Return the table(s) that holds the text
  8193. of the IBodyPart, for complex cases
  8194. where a paragraph isn't used.
  8195. </member>
  8196. <member name="M:NPOI.XWPF.UserModel.IBody.GetParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  8197. if there is a corresponding {@link XWPFParagraph} of the parameter ctTable in the paragraphList of this header or footer
  8198. the method will return this paragraph
  8199. if there is no corresponding {@link XWPFParagraph} the method will return null
  8200. @param p is instance of CTP and is searching for an XWPFParagraph
  8201. @return null if there is no XWPFParagraph with an corresponding CTPparagraph in the paragraphList of this header or footer
  8202. XWPFParagraph with the correspondig CTP p
  8203. </member>
  8204. <member name="M:NPOI.XWPF.UserModel.IBody.GetTable(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  8205. if there is a corresponding {@link XWPFTable} of the parameter ctTable in the tableList of this header
  8206. the method will return this table
  8207. if there is no corresponding {@link XWPFTable} the method will return null
  8208. @param ctTable
  8209. </member>
  8210. <member name="M:NPOI.XWPF.UserModel.IBody.GetParagraphArray(System.Int32)">
  8211. Returns the paragraph that of position pos
  8212. </member>
  8213. <member name="M:NPOI.XWPF.UserModel.IBody.GetTableArray(System.Int32)">
  8214. Returns the table at position pos
  8215. </member>
  8216. <member name="M:NPOI.XWPF.UserModel.IBody.InsertNewParagraph(System.Xml.XmlDocument)">
  8217. inserts a new paragraph at position of the cursor
  8218. @param cursor
  8219. </member>
  8220. <member name="M:NPOI.XWPF.UserModel.IBody.InsertNewTbl(System.Xml.XmlDocument)">
  8221. inserts a new Table at the cursor position.
  8222. @param cursor
  8223. </member>
  8224. <member name="M:NPOI.XWPF.UserModel.IBody.InsertTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  8225. inserts a new Table at position pos
  8226. @param pos
  8227. @param table
  8228. </member>
  8229. <member name="M:NPOI.XWPF.UserModel.IBody.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  8230. returns the TableCell to which the Table belongs
  8231. @param cell
  8232. </member>
  8233. <member name="M:NPOI.XWPF.UserModel.IBody.GetXWPFDocument">
  8234. Return XWPFDocument
  8235. </member>
  8236. <member name="T:NPOI.XWPF.UserModel.IBodyElement">
  8237. 9 Jan 2010
  8238. @author Philipp Epp
  8239. </member>
  8240. <!-- Badly formed XML comment ignored for member "T:NPOI.XWPF.UserModel.ICell" -->
  8241. <member name="T:NPOI.XWPF.UserModel.IRunBody">
  8242. Simple interface describing both {@link XWPFParagraph}
  8243. and {@link XWPFSDT}
  8244. </member>
  8245. <member name="T:NPOI.XWPF.UserModel.IRunElement">
  8246. Common interface for things that can occur
  8247. where a run (text with common stylings) can,
  8248. eg {@link XWPFRun} or {@link XWPFSDT}.
  8249. More methods to follow shortly!
  8250. </member>
  8251. <member name="T:NPOI.XWPF.UserModel.ISDTContent">
  8252. Experimental interface to offer rudimentary Read-only Processing of
  8253. of the contentblock of an SDT/ContentControl.
  8254. <p/>
  8255. <p/>
  8256. <p/>
  8257. WARNING - APIs expected to change rapidly
  8258. </member>
  8259. <member name="T:NPOI.XWPF.UserModel.ISDTContents">
  8260. Interface for anything that can be within an STD:
  8261. {@link XWPFRun}, {@link XWPFTable}, {@link XWPFParagraph},
  8262. {@link XWPFSDT} etc
  8263. </member>
  8264. <member name="T:NPOI.XWPF.UserModel.LineSpacingRule">
  8265. Specifies the logic which shall be used to calculate the line spacing of the
  8266. parent object when it is displayed in the document.
  8267. @author Gisella Bronzetti
  8268. </member>
  8269. <member name="F:NPOI.XWPF.UserModel.LineSpacingRule.AUTO">
  8270. Specifies that the line spacing of the parent object shall be
  8271. automatically determined by the size of its contents, with no
  8272. predetermined minimum or maximum size.
  8273. </member>
  8274. <member name="F:NPOI.XWPF.UserModel.LineSpacingRule.EXACT">
  8275. Specifies that the height of the line shall be exactly the value
  8276. specified, regardless of the size of the contents If the contents are too
  8277. large for the specified height, then they shall be clipped as necessary.
  8278. </member>
  8279. <member name="F:NPOI.XWPF.UserModel.LineSpacingRule.ATLEAST">
  8280. Specifies that the height of the line shall be at least the value
  8281. specified, but may be expanded to fit its content as needed.
  8282. </member>
  8283. <member name="T:NPOI.XWPF.UserModel.ParagraphAlignment">
  8284. Specifies all types of alignment which are available to be applied to objects in a
  8285. WordProcessingML document
  8286. @author Yegor Kozlov
  8287. </member>
  8288. <member name="T:NPOI.XWPF.UserModel.PositionInParagraph">
  8289. * postion of a character in a paragrapho
  8290. * 1st RunPositon
  8291. * 2nd TextPosition
  8292. * 3rd CharacterPosition
  8293. *
  8294. *
  8295. </member>
  8296. <member name="T:NPOI.XWPF.UserModel.TextAlignment">
  8297. Specifies all types of vertical alignment which are available to be applied to of all text
  8298. on each line displayed within a paragraph.
  8299. @author Gisella Bronzetti
  8300. </member>
  8301. <member name="F:NPOI.XWPF.UserModel.TextAlignment.TOP">
  8302. Specifies that all text in the parent object shall be
  8303. aligned to the top of each character when displayed
  8304. </member>
  8305. <member name="F:NPOI.XWPF.UserModel.TextAlignment.CENTER">
  8306. Specifies that all text in the parent object shall be
  8307. aligned to the center of each character when displayed.
  8308. </member>
  8309. <member name="F:NPOI.XWPF.UserModel.TextAlignment.BASELINE">
  8310. Specifies that all text in the parent object shall be
  8311. aligned to the baseline of each character when displayed.
  8312. </member>
  8313. <member name="F:NPOI.XWPF.UserModel.TextAlignment.BOTTOM">
  8314. Specifies that all text in the parent object shall be
  8315. aligned to the bottom of each character when displayed.
  8316. </member>
  8317. <member name="F:NPOI.XWPF.UserModel.TextAlignment.AUTO">
  8318. Specifies that all text in the parent object shall be
  8319. aligned automatically when displayed.
  8320. </member>
  8321. <member name="T:NPOI.XWPF.UserModel.TextSegment">
  8322. saves the begin and end position of a text in a Paragraph
  8323. </member>
  8324. <member name="P:NPOI.XWPF.UserModel.TextSegment.BeginRun">
  8325. <summary>
  8326. The index of the start run
  8327. </summary>
  8328. </member>
  8329. <member name="P:NPOI.XWPF.UserModel.TextSegment.BeginText">
  8330. <summary>
  8331. The index of the start CT_Text
  8332. </summary>
  8333. </member>
  8334. <member name="P:NPOI.XWPF.UserModel.TextSegment.BeginChar">
  8335. <summary>
  8336. The index of the start text character
  8337. </summary>
  8338. </member>
  8339. <member name="P:NPOI.XWPF.UserModel.TextSegment.EndText">
  8340. <summary>
  8341. the index of the end CT_Text
  8342. </summary>
  8343. </member>
  8344. <member name="P:NPOI.XWPF.UserModel.TextSegment.EndChar">
  8345. <summary>
  8346. the index of the end text character
  8347. </summary>
  8348. </member>
  8349. <member name="T:NPOI.XWPF.UserModel.UnderlinePatterns">
  8350. Specifies the types of patterns which may be used to create the underline
  8351. applied beneath the text in a Run.
  8352. @author Gisella Bronzetti
  8353. </member>
  8354. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Single">
  8355. Specifies an underline consisting of a single line beneath all characters
  8356. in this Run.
  8357. </member>
  8358. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Words">
  8359. Specifies an underline consisting of a single line beneath all non-space
  8360. characters in the Run. There shall be no underline beneath any space
  8361. character (breaking or non-breaking).
  8362. </member>
  8363. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Double">
  8364. Specifies an underline consisting of two lines beneath all characters in
  8365. this run
  8366. </member>
  8367. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Thick">
  8368. Specifies an underline consisting of a single thick line beneath all
  8369. characters in this Run.
  8370. </member>
  8371. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Dotted">
  8372. Specifies an underline consisting of a series of dot characters beneath
  8373. all characters in this Run.
  8374. </member>
  8375. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DottedHeavy">
  8376. Specifies an underline consisting of a series of thick dot characters
  8377. beneath all characters in this Run.
  8378. </member>
  8379. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Dash">
  8380. Specifies an underline consisting of a dashed line beneath all characters
  8381. in this Run.
  8382. </member>
  8383. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DashedHeavy">
  8384. Specifies an underline consisting of a series of thick dashes beneath all
  8385. characters in this Run.
  8386. </member>
  8387. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DashLong">
  8388. Specifies an underline consisting of long dashed characters beneath all
  8389. characters in this Run.
  8390. </member>
  8391. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DashLongHeavy">
  8392. Specifies an underline consisting of thick long dashed characters beneath
  8393. all characters in this Run.
  8394. </member>
  8395. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DotDash">
  8396. Specifies an underline consisting of a series of dash, dot characters
  8397. beneath all characters in this Run.
  8398. </member>
  8399. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DashDotHeavy">
  8400. Specifies an underline consisting of a series of thick dash, dot
  8401. characters beneath all characters in this Run.
  8402. </member>
  8403. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DotDotDash">
  8404. Specifies an underline consisting of a series of dash, dot, dot
  8405. characters beneath all characters in this Run.
  8406. </member>
  8407. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DashDotDotHeavy">
  8408. Specifies an underline consisting of a series of thick dash, dot, dot
  8409. characters beneath all characters in this Run.
  8410. </member>
  8411. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Wave">
  8412. Specifies an underline consisting of a single wavy line beneath all
  8413. characters in this Run.
  8414. </member>
  8415. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.WavyHeavy">
  8416. Specifies an underline consisting of a single thick wavy line beneath all
  8417. characters in this Run.
  8418. </member>
  8419. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.WavyDouble">
  8420. Specifies an underline consisting of a pair of wavy lines beneath all
  8421. characters in this Run.
  8422. </member>
  8423. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.None">
  8424. Specifies no underline beneath this Run.
  8425. </member>
  8426. <member name="T:NPOI.XWPF.UserModel.VerticalAlign">
  8427. Specifies possible values for the alignment of the contents of this run in
  8428. relation to the default appearance of the Run's text. This allows the text to
  8429. be repositioned as subscript or superscript without altering the font size of
  8430. the run properties.
  8431. @author Gisella Bronzetti
  8432. </member>
  8433. <member name="F:NPOI.XWPF.UserModel.VerticalAlign.BASELINE">
  8434. Specifies that the text in the parent run shall be located at the
  8435. baseline and presented in the same size as surrounding text.
  8436. </member>
  8437. <member name="F:NPOI.XWPF.UserModel.VerticalAlign.SUPERSCRIPT">
  8438. Specifies that this text should be subscript. This Setting shall lower
  8439. the text in this run below the baseline and change it to a smaller size,
  8440. if a smaller size is available.
  8441. </member>
  8442. <member name="F:NPOI.XWPF.UserModel.VerticalAlign.SUBSCRIPT">
  8443. Specifies that this text should be superscript. This Setting shall raise
  8444. the text in this run above the baseline and change it to a smaller size,
  8445. if a smaller size is available.
  8446. </member>
  8447. <member name="T:NPOI.XWPF.UserModel.XWPFAbstractNum">
  8448. @author Philipp Epp
  8449. </member>
  8450. <member name="P:NPOI.XWPF.UserModel.XWPFAbstractNum.MultiLevelType">
  8451. <summary>
  8452. Abstract Numbering Definition Type
  8453. </summary>
  8454. </member>
  8455. <member name="T:NPOI.XWPF.UserModel.MultiLevelType">
  8456. <summary>
  8457. Numbering Definition Type
  8458. </summary>
  8459. </member>
  8460. <member name="F:NPOI.XWPF.UserModel.MultiLevelType.SingleLevel">
  8461. <summary>
  8462. Single Level Numbering Definition
  8463. </summary>
  8464. </member>
  8465. <member name="F:NPOI.XWPF.UserModel.MultiLevelType.Multilevel">
  8466. <summary>
  8467. Multilevel Numbering Definition
  8468. </summary>
  8469. </member>
  8470. <member name="F:NPOI.XWPF.UserModel.MultiLevelType.HybridMultilevel">
  8471. <summary>
  8472. Hybrid Multilevel Numbering Definition
  8473. </summary>
  8474. </member>
  8475. <member name="T:NPOI.XWPF.UserModel.NumberFormat">
  8476. <summary>
  8477. Numbering Format
  8478. </summary>
  8479. </member>
  8480. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Decimal">
  8481. <summary>
  8482. Decimal Numbers
  8483. </summary>
  8484. </member>
  8485. <member name="F:NPOI.XWPF.UserModel.NumberFormat.UpperRoman">
  8486. <summary>
  8487. Uppercase Roman Numerals
  8488. </summary>
  8489. </member>
  8490. <member name="F:NPOI.XWPF.UserModel.NumberFormat.LowerRoman">
  8491. <summary>
  8492. Lowercase Roman Numerals
  8493. </summary>
  8494. </member>
  8495. <member name="F:NPOI.XWPF.UserModel.NumberFormat.UpperLetter">
  8496. <summary>
  8497. Uppercase Latin Alphabet
  8498. </summary>
  8499. </member>
  8500. <member name="F:NPOI.XWPF.UserModel.NumberFormat.LowerLetter">
  8501. <summary>
  8502. Lowercase Latin Alphabet
  8503. </summary>
  8504. </member>
  8505. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Ordinal">
  8506. <summary>
  8507. Ordinal
  8508. </summary>
  8509. </member>
  8510. <member name="F:NPOI.XWPF.UserModel.NumberFormat.CardinalText">
  8511. <summary>
  8512. Cardinal Text
  8513. </summary>
  8514. </member>
  8515. <member name="F:NPOI.XWPF.UserModel.NumberFormat.OrdinalText">
  8516. <summary>
  8517. Ordinal Text
  8518. </summary>
  8519. </member>
  8520. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Hex">
  8521. <summary>
  8522. Hexadecimal Numbering
  8523. </summary>
  8524. </member>
  8525. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Chicago">
  8526. <summary>
  8527. Chicago Manual of Style
  8528. </summary>
  8529. </member>
  8530. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographDigital">
  8531. <summary>
  8532. Ideographs
  8533. </summary>
  8534. </member>
  8535. <member name="F:NPOI.XWPF.UserModel.NumberFormat.JapaneseCounting">
  8536. <summary>
  8537. Japanese Counting System
  8538. </summary>
  8539. </member>
  8540. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Aiueo">
  8541. <summary>
  8542. AIUEO Order Hiragana
  8543. </summary>
  8544. </member>
  8545. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Iroha">
  8546. <summary>
  8547. Iroha Ordered Katakana
  8548. </summary>
  8549. </member>
  8550. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalFullWidth">
  8551. <summary>
  8552. Double Byte Arabic Numerals
  8553. </summary>
  8554. </member>
  8555. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalHalfWidth">
  8556. <summary>
  8557. Single Byte Arabic Numerals
  8558. </summary>
  8559. </member>
  8560. <member name="F:NPOI.XWPF.UserModel.NumberFormat.JapaneseLegal">
  8561. <summary>
  8562. Japanese Legal Numbering
  8563. </summary>
  8564. </member>
  8565. <member name="F:NPOI.XWPF.UserModel.NumberFormat.JapaneseDigitalTenThousand">
  8566. <summary>
  8567. Japanese Digital Ten Thousand Counting System
  8568. </summary>
  8569. </member>
  8570. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalEnclosedCircle">
  8571. <summary>
  8572. Decimal Numbers Enclosed in a Circle
  8573. </summary>
  8574. </member>
  8575. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalFullWidth2">
  8576. <summary>
  8577. Double Byte Arabic Numerals Alternate
  8578. </summary>
  8579. </member>
  8580. <member name="F:NPOI.XWPF.UserModel.NumberFormat.AiueoFullWidth">
  8581. <summary>
  8582. Full-Width AIUEO Order Hiragana
  8583. </summary>
  8584. </member>
  8585. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IrohaFullWidth">
  8586. <summary>
  8587. Full-Width Iroha Ordered Katakana
  8588. </summary>
  8589. </member>
  8590. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalZero">
  8591. <summary>
  8592. Initial Zero Arabic Numerals
  8593. </summary>
  8594. </member>
  8595. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Bullet">
  8596. <summary>
  8597. Bullet
  8598. </summary>
  8599. </member>
  8600. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Ganada">
  8601. <summary>
  8602. Korean Ganada Numbering
  8603. </summary>
  8604. </member>
  8605. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Chosung">
  8606. <summary>
  8607. Korean Chosung Numbering
  8608. </summary>
  8609. </member>
  8610. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalEnclosedFullstop">
  8611. <summary>
  8612. Decimal Numbers Followed by a Period
  8613. </summary>
  8614. </member>
  8615. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalEnclosedParen">
  8616. <summary>
  8617. Decimal Numbers Enclosed in Parenthesis
  8618. </summary>
  8619. </member>
  8620. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalEnclosedCircleChinese">
  8621. <summary>
  8622. Decimal Numbers Enclosed in a Circle
  8623. </summary>
  8624. </member>
  8625. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographEnclosedCircle">
  8626. <summary>
  8627. Ideographs Enclosed in a Circle
  8628. </summary>
  8629. </member>
  8630. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographTraditional">
  8631. <summary>
  8632. Traditional Ideograph Format
  8633. </summary>
  8634. </member>
  8635. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographZodiac">
  8636. <summary>
  8637. Zodiac Ideograph Format
  8638. </summary>
  8639. </member>
  8640. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographZodiacTraditional">
  8641. <summary>
  8642. Traditional Zodiac Ideograph Format
  8643. </summary>
  8644. </member>
  8645. <member name="F:NPOI.XWPF.UserModel.NumberFormat.TaiwaneseCounting">
  8646. <summary>
  8647. Taiwanese Counting System
  8648. </summary>
  8649. </member>
  8650. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographLegalTraditional">
  8651. <summary>
  8652. Traditional Legal Ideograph Format
  8653. </summary>
  8654. </member>
  8655. <member name="F:NPOI.XWPF.UserModel.NumberFormat.TaiwaneseCountingThousand">
  8656. <summary>
  8657. Taiwanese Counting Thousand System
  8658. </summary>
  8659. </member>
  8660. <member name="F:NPOI.XWPF.UserModel.NumberFormat.TaiwaneseDigital">
  8661. <summary>
  8662. Taiwanese Digital Counting System
  8663. </summary>
  8664. </member>
  8665. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ChineseCounting">
  8666. <summary>
  8667. Chinese Counting System
  8668. </summary>
  8669. </member>
  8670. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ChineseLegalSimplified">
  8671. <summary>
  8672. Chinese Legal Simplified Format
  8673. </summary>
  8674. </member>
  8675. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ChineseCountingThousand">
  8676. <summary>
  8677. Chinese Counting Thousand System
  8678. </summary>
  8679. </member>
  8680. <member name="F:NPOI.XWPF.UserModel.NumberFormat.KoreanDigital">
  8681. <summary>
  8682. Korean Digital Counting System
  8683. </summary>
  8684. </member>
  8685. <member name="F:NPOI.XWPF.UserModel.NumberFormat.KoreanCounting">
  8686. <summary>
  8687. Korean Counting System
  8688. </summary>
  8689. </member>
  8690. <member name="F:NPOI.XWPF.UserModel.NumberFormat.KoreanLegal">
  8691. <summary>
  8692. Korean Legal Numbering
  8693. </summary>
  8694. </member>
  8695. <member name="F:NPOI.XWPF.UserModel.NumberFormat.KoreanDigital2">
  8696. <summary>
  8697. Korean Digital Counting System Alternate
  8698. </summary>
  8699. </member>
  8700. <member name="F:NPOI.XWPF.UserModel.NumberFormat.VietnameseCounting">
  8701. <summary>
  8702. Vietnamese Numerals
  8703. </summary>
  8704. </member>
  8705. <member name="F:NPOI.XWPF.UserModel.NumberFormat.RussianLower">
  8706. <summary>
  8707. Lowercase Russian Alphabet
  8708. </summary>
  8709. </member>
  8710. <member name="F:NPOI.XWPF.UserModel.NumberFormat.RussianUpper">
  8711. <summary>
  8712. Uppercase Russian Alphabet
  8713. </summary>
  8714. </member>
  8715. <member name="F:NPOI.XWPF.UserModel.NumberFormat.None">
  8716. <summary>
  8717. No Numbering
  8718. </summary>
  8719. </member>
  8720. <member name="F:NPOI.XWPF.UserModel.NumberFormat.NumberInDash">
  8721. <summary>
  8722. Number With Dashes
  8723. </summary>
  8724. </member>
  8725. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Hebrew1">
  8726. <summary>
  8727. Hebrew Numerals
  8728. </summary>
  8729. </member>
  8730. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Hebrew2">
  8731. <summary>
  8732. Hebrew Alphabet
  8733. </summary>
  8734. </member>
  8735. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ArabicAlpha">
  8736. <summary>
  8737. Arabic Alphabet
  8738. </summary>
  8739. </member>
  8740. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ArabicAbjad">
  8741. <summary>
  8742. Arabic Abjad Numerals
  8743. </summary>
  8744. </member>
  8745. <member name="F:NPOI.XWPF.UserModel.NumberFormat.HindiVowels">
  8746. <summary>
  8747. Hindi Vowels
  8748. </summary>
  8749. </member>
  8750. <member name="F:NPOI.XWPF.UserModel.NumberFormat.HindiConsonants">
  8751. <summary>
  8752. Hindi Consonants
  8753. </summary>
  8754. </member>
  8755. <member name="F:NPOI.XWPF.UserModel.NumberFormat.HindiNumbers">
  8756. <summary>
  8757. Hindi Numbers
  8758. </summary>
  8759. </member>
  8760. <member name="F:NPOI.XWPF.UserModel.NumberFormat.HindiCounting">
  8761. <summary>
  8762. Hindi Counting System
  8763. </summary>
  8764. </member>
  8765. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ThaiLetters">
  8766. <summary>
  8767. Thai Letters
  8768. </summary>
  8769. </member>
  8770. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ThaiNumbers">
  8771. <summary>
  8772. Thai Numerals
  8773. </summary>
  8774. </member>
  8775. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ThaiCounting">
  8776. <summary>
  8777. Thai Counting System
  8778. </summary>
  8779. </member>
  8780. <member name="T:NPOI.XWPF.UserModel.XWPFComment">
  8781. * Sketch of XWPF comment class
  8782. *
  8783. * @author Yury Batrakov (batrakov at gmail.com)
  8784. *
  8785. </member>
  8786. <member name="T:NPOI.XWPF.UserModel.XWPFDefaultParagraphStyle">
  8787. Default Paragraph style, from which other styles will override
  8788. TODO Share logic with {@link XWPFParagraph} which also uses CTPPr
  8789. </member>
  8790. <member name="T:NPOI.XWPF.UserModel.XWPFDefaultRunStyle">
  8791. Default Character Run style, from which other styles will override
  8792. TODO Share logic with {@link XWPFRun} which also uses CTRPr
  8793. </member>
  8794. <member name="T:NPOI.XWPF.UserModel.XWPFDocument">
  8795. <p>High(ish) level class for working with .docx files.</p>
  8796. <p>This class tries to hide some of the complexity
  8797. of the underlying file format, but as it's not a
  8798. mature and stable API yet, certain parts of the
  8799. XML structure come through. You'll therefore almost
  8800. certainly need to refer to the OOXML specifications
  8801. from
  8802. http://www.ecma-international.org/publications/standards/Ecma-376.htm
  8803. at some point in your use.</p>
  8804. </member>
  8805. <member name="F:NPOI.XWPF.UserModel.XWPFDocument.drawingIdManager">
  8806. Keeps track on all id-values used in this document and included parts, like headers, footers, etc.
  8807. </member>
  8808. <member name="F:NPOI.XWPF.UserModel.XWPFDocument.headerFooterPolicy">
  8809. Handles the joy of different headers/footers for different pages
  8810. </member>
  8811. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.NewPackage">
  8812. Create a new WordProcessingML package and Setup the default minimal content
  8813. </member>
  8814. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.OnDocumentCreate">
  8815. Create a new CT_Document with all values Set to default
  8816. </member>
  8817. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.Document">
  8818. Returns the low level document base object
  8819. </member>
  8820. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.ColumnCount">
  8821. Sets columns on document base object
  8822. </member>
  8823. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.TextDirection">
  8824. Sets Text Direction of Document
  8825. </member>
  8826. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.BodyElements">
  8827. returns an Iterator with paragraphs and tables
  8828. @see NPOI.XWPF.UserModel.IBody#getBodyElements()
  8829. </member>
  8830. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.Paragraphs">
  8831. @see NPOI.XWPF.UserModel.IBody#getParagraphs()
  8832. </member>
  8833. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.Tables">
  8834. @see NPOI.XWPF.UserModel.IBody#getTables()
  8835. </member>
  8836. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetTableArray(System.Int32)">
  8837. @see NPOI.XWPF.UserModel.IBody#getTableArray(int)
  8838. </member>
  8839. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.FooterList">
  8840. @return the list of footers
  8841. </member>
  8842. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.HeaderList">
  8843. @return the list of headers
  8844. </member>
  8845. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetPartById(System.String)">
  8846. Get the document part that's defined as the
  8847. given relationship of the core document.
  8848. </member>
  8849. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetHeaderFooterPolicy">
  8850. Returns the policy on headers and footers, which
  8851. also provides a way to Get at them.
  8852. </member>
  8853. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetCTStyle">
  8854. Returns the styles object used
  8855. </member>
  8856. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetAllEmbedds">
  8857. Get the document's embedded files.
  8858. </member>
  8859. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetBodyElementSpecificPos(System.Int32,System.Collections.Generic.List{NPOI.XWPF.UserModel.IBodyElement})">
  8860. Finds that for example the 2nd entry in the body list is the 1st paragraph
  8861. </member>
  8862. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetParagraphPos(System.Int32)">
  8863. Look up the paragraph at the specified position in the body elemnts list
  8864. and return this paragraphs position in the paragraphs list
  8865. @param pos
  8866. The position of the relevant paragraph in the body elements
  8867. list
  8868. @return the position of the paragraph in the paragraphs list, if there is
  8869. a paragraph at the position in the bodyelements list. Else it
  8870. will return -1
  8871. </member>
  8872. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetTablePos(System.Int32)">
  8873. Get with the position of a table in the bodyelement array list
  8874. the position of this table in the table array list
  8875. @param pos position of the table in the bodyelement array list
  8876. @return if there is a table at the position in the bodyelement array list,
  8877. else it will return null.
  8878. </member>
  8879. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.InsertNewParagraph(System.Xml.XmlDocument)">
  8880. Add a new paragraph at position of the cursor. The cursor must be on the
  8881. {@link org.apache.xmlbeans.XmlCursor.TokenType#START} tag of an subelement
  8882. of the documents body. When this method is done, the cursor passed as
  8883. parameter points to the {@link org.apache.xmlbeans.XmlCursor.TokenType#END}
  8884. of the newly inserted paragraph.
  8885. @param cursor
  8886. @return the {@link XWPFParagraph} object representing the newly inserted
  8887. CTP object
  8888. </member>
  8889. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsCursorInBody(System.Xml.XmlDocument)">
  8890. verifies that cursor is on the right position
  8891. @param cursor
  8892. </member>
  8893. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetPosOfParagraph(NPOI.XWPF.UserModel.XWPFParagraph)">
  8894. Get the position of the paragraph, within the list
  8895. of all the body elements.
  8896. @param p The paragraph to find
  8897. @return The location, or -1 if the paragraph couldn't be found
  8898. </member>
  8899. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetPosOfTable(NPOI.XWPF.UserModel.XWPFTable)">
  8900. Get the position of the table, within the list of
  8901. all the body elements.
  8902. @param t The table to find
  8903. @return The location, or -1 if the table couldn't be found
  8904. </member>
  8905. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.Commit">
  8906. Commit and saves the document
  8907. </member>
  8908. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetRelationIndex(NPOI.XWPF.UserModel.XWPFRelation)">
  8909. Gets the index of the relation we're trying to create
  8910. @param relation
  8911. @return i
  8912. </member>
  8913. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateParagraph">
  8914. Appends a new paragraph to this document
  8915. @return a new paragraph
  8916. </member>
  8917. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateNumbering">
  8918. Creates an empty numbering if one does not already exist and Sets the numbering member
  8919. @return numbering
  8920. </member>
  8921. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateStyles">
  8922. Creates an empty styles for the document if one does not already exist
  8923. @return styles
  8924. </member>
  8925. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateFootnotes">
  8926. Creates an empty footnotes element for the document if one does not already exist
  8927. @return footnotes
  8928. </member>
  8929. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.RemoveBodyElement(System.Int32)">
  8930. remove a BodyElement from bodyElements array list
  8931. @param pos
  8932. @return true if removing was successfully, else return false
  8933. </member>
  8934. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.SetParagraph(NPOI.XWPF.UserModel.XWPFParagraph,System.Int32)">
  8935. copies content of a paragraph to a existing paragraph in the list paragraphs at position pos
  8936. @param paragraph
  8937. @param pos
  8938. </member>
  8939. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetLastParagraph">
  8940. @return the LastParagraph of the document
  8941. </member>
  8942. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateTable">
  8943. Create an empty table with one row and one column as default.
  8944. @return a new table
  8945. </member>
  8946. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateTable(System.Int32,System.Int32)">
  8947. Create an empty table with a number of rows and cols specified
  8948. @param rows
  8949. @param cols
  8950. @return table
  8951. </member>
  8952. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateTOC">
  8953. <summary>
  8954. Create a Table of Contents (TOC) at the end of the document.
  8955. Please set paragraphs style to "Heading{#}" and document
  8956. styles for TOC <see cref="M:NPOI.OOXML.XWPF.Util.DocumentStylesBuilder.BuildStylesForTOC(NPOI.XWPF.UserModel.XWPFDocument)"/>.
  8957. Otherwise, it renders an empty one.
  8958. </summary>
  8959. </member>
  8960. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.SetTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  8961. Replace content of table in array tables at position pos with a
  8962. @param pos
  8963. @param table
  8964. </member>
  8965. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsEnforcedProtection">
  8966. Verifies that the documentProtection tag in settings.xml file <br/>
  8967. specifies that the protection is enforced (w:enforcement="1") <br/>
  8968. <br/>
  8969. sample snippet from settings.xml
  8970. <pre>
  8971. &lt;w:settings ... &gt;
  8972. &lt;w:documentProtection w:edit=&quot;readOnly&quot; w:enforcement=&quot;1&quot;/&gt;
  8973. </pre>
  8974. @return true if documentProtection is enforced with option any
  8975. </member>
  8976. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsEnforcedReadonlyProtection">
  8977. Verifies that the documentProtection tag in Settings.xml file <br/>
  8978. specifies that the protection is enforced (w:enforcement="1") <br/>
  8979. and that the kind of protection is ReadOnly (w:edit="readOnly")<br/>
  8980. <br/>
  8981. sample snippet from Settings.xml
  8982. <pre>
  8983. &lt;w:settings ... &gt;
  8984. &lt;w:documentProtection w:edit=&quot;readOnly&quot; w:enforcement=&quot;1&quot;/&gt;
  8985. </pre>
  8986. @return true if documentProtection is enforced with option ReadOnly
  8987. </member>
  8988. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsEnforcedFillingFormsProtection">
  8989. Verifies that the documentProtection tag in Settings.xml file <br/>
  8990. specifies that the protection is enforced (w:enforcement="1") <br/>
  8991. and that the kind of protection is forms (w:edit="forms")<br/>
  8992. <br/>
  8993. sample snippet from Settings.xml
  8994. <pre>
  8995. &lt;w:settings ... &gt;
  8996. &lt;w:documentProtection w:edit=&quot;forms&quot; w:enforcement=&quot;1&quot;/&gt;
  8997. </pre>
  8998. @return true if documentProtection is enforced with option forms
  8999. </member>
  9000. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsEnforcedCommentsProtection">
  9001. Verifies that the documentProtection tag in Settings.xml file <br/>
  9002. specifies that the protection is enforced (w:enforcement="1") <br/>
  9003. and that the kind of protection is comments (w:edit="comments")<br/>
  9004. <br/>
  9005. sample snippet from Settings.xml
  9006. <pre>
  9007. &lt;w:settings ... &gt;
  9008. &lt;w:documentProtection w:edit=&quot;comments&quot; w:enforcement=&quot;1&quot;/&gt;
  9009. </pre>
  9010. @return true if documentProtection is enforced with option comments
  9011. </member>
  9012. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsEnforcedTrackedChangesProtection">
  9013. Verifies that the documentProtection tag in Settings.xml file <br/>
  9014. specifies that the protection is enforced (w:enforcement="1") <br/>
  9015. and that the kind of protection is trackedChanges (w:edit="trackedChanges")<br/>
  9016. <br/>
  9017. sample snippet from Settings.xml
  9018. <pre>
  9019. &lt;w:settings ... &gt;
  9020. &lt;w:documentProtection w:edit=&quot;trackedChanges&quot; w:enforcement=&quot;1&quot;/&gt;
  9021. </pre>
  9022. @return true if documentProtection is enforced with option trackedChanges
  9023. </member>
  9024. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.EnforceReadonlyProtection">
  9025. Enforces the ReadOnly protection.<br/>
  9026. In the documentProtection tag inside Settings.xml file, <br/>
  9027. it Sets the value of enforcement to "1" (w:enforcement="1") <br/>
  9028. and the value of edit to ReadOnly (w:edit="readOnly")<br/>
  9029. <br/>
  9030. sample snippet from Settings.xml
  9031. <pre>
  9032. &lt;w:settings ... &gt;
  9033. &lt;w:documentProtection w:edit=&quot;readOnly&quot; w:enforcement=&quot;1&quot;/&gt;
  9034. </pre>
  9035. </member>
  9036. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.EnforceFillingFormsProtection">
  9037. Enforce the Filling Forms protection.<br/>
  9038. In the documentProtection tag inside Settings.xml file, <br/>
  9039. it Sets the value of enforcement to "1" (w:enforcement="1") <br/>
  9040. and the value of edit to forms (w:edit="forms")<br/>
  9041. <br/>
  9042. sample snippet from Settings.xml
  9043. <pre>
  9044. &lt;w:settings ... &gt;
  9045. &lt;w:documentProtection w:edit=&quot;forms&quot; w:enforcement=&quot;1&quot;/&gt;
  9046. </pre>
  9047. </member>
  9048. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.EnforceCommentsProtection">
  9049. Enforce the Comments protection.<br/>
  9050. In the documentProtection tag inside Settings.xml file,<br/>
  9051. it Sets the value of enforcement to "1" (w:enforcement="1") <br/>
  9052. and the value of edit to comments (w:edit="comments")<br/>
  9053. <br/>
  9054. sample snippet from Settings.xml
  9055. <pre>
  9056. &lt;w:settings ... &gt;
  9057. &lt;w:documentProtection w:edit=&quot;comments&quot; w:enforcement=&quot;1&quot;/&gt;
  9058. </pre>
  9059. </member>
  9060. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.EnforceTrackedChangesProtection">
  9061. Enforce the Tracked Changes protection.<br/>
  9062. In the documentProtection tag inside Settings.xml file, <br/>
  9063. it Sets the value of enforcement to "1" (w:enforcement="1") <br/>
  9064. and the value of edit to trackedChanges (w:edit="trackedChanges")<br/>
  9065. <br/>
  9066. sample snippet from Settings.xml
  9067. <pre>
  9068. &lt;w:settings ... &gt;
  9069. &lt;w:documentProtection w:edit=&quot;trackedChanges&quot; w:enforcement=&quot;1&quot;/&gt;
  9070. </pre>
  9071. </member>
  9072. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.RemoveProtectionEnforcement">
  9073. Remove protection enforcement.<br/>
  9074. In the documentProtection tag inside Settings.xml file <br/>
  9075. it Sets the value of enforcement to "0" (w:enforcement="0") <br/>
  9076. </member>
  9077. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.EnforceUpdateFields">
  9078. Enforces fields update on document open (in Word).
  9079. In the settings.xml file <br/>
  9080. sets the updateSettings value to true (w:updateSettings w:val="true")
  9081. NOTICES:
  9082. <ul>
  9083. <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?"
  9084. (if "Update automatic links at open" is enabled)</li>
  9085. <li>Flag is removed after saving with changes in Word </li>
  9086. </ul>
  9087. </member>
  9088. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.IsTrackRevisions">
  9089. Check if revision tracking is turned on.
  9090. @return <code>true</code> if revision tracking is turned on
  9091. </member>
  9092. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.InsertTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  9093. inserts an existing XWPFTable to the arrays bodyElements and tables
  9094. @param pos
  9095. @param table
  9096. </member>
  9097. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.AllPictures">
  9098. Returns all Pictures, which are referenced from the document itself.
  9099. @return a {@link List} of {@link XWPFPictureData}. The returned {@link List} is unmodifiable. Use #a
  9100. </member>
  9101. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.AllPackagePictures">
  9102. @return all Pictures in this package
  9103. </member>
  9104. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetNextPicNameNumber(System.Int32)">
  9105. Get the next free ImageNumber
  9106. @param format
  9107. @return the next free ImageNumber
  9108. @throws InvalidFormatException
  9109. </member>
  9110. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetPictureDataByID(System.String)">
  9111. returns the PictureData by blipID
  9112. @param blipID
  9113. @return XWPFPictureData of a specificID
  9114. </member>
  9115. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetNumbering">
  9116. GetNumbering
  9117. @return numbering
  9118. </member>
  9119. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetStyles">
  9120. Get Styles
  9121. @return styles for this document
  9122. </member>
  9123. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  9124. Get the paragraph with the CTP class p
  9125. @param p
  9126. @return the paragraph with the CTP class p
  9127. </member>
  9128. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetTable(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  9129. Get a table by its CTTbl-Object
  9130. @param ctTbl
  9131. @see NPOI.XWPF.UserModel.IBody#getTable(org.Openxmlformats.schemas.wordProcessingml.x2006.main.CTTbl)
  9132. @return a table by its CTTbl-Object or null
  9133. </member>
  9134. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.ChangeOrientation(NPOI.OpenXmlFormats.Wordprocessing.ST_PageOrientation)">
  9135. <summary>
  9136. Change orientation of a Word file
  9137. </summary>
  9138. <param name="orientation"></param>
  9139. <remarks>https://stackoverflow.com/questions/26483837/landscape-and-portrait-pages-in-the-same-word-document-using-apache-poi-xwpf-in</remarks>
  9140. </member>
  9141. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetParagraphArray(System.Int32)">
  9142. Returns the paragraph that of position pos
  9143. @see NPOI.XWPF.UserModel.IBody#getParagraphArray(int)
  9144. </member>
  9145. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.Part">
  9146. returns the Part, to which the body belongs, which you need for Adding relationship to other parts
  9147. Actually it is needed of the class XWPFTableCell. Because you have to know to which part the tableCell
  9148. belongs.
  9149. @see NPOI.XWPF.UserModel.IBody#getPart()
  9150. </member>
  9151. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.PartType">
  9152. Get the PartType of the body, for example
  9153. DOCUMENT, HEADER, FOOTER, FOOTNOTE,
  9154. @see NPOI.XWPF.UserModel.IBody#getPartType()
  9155. </member>
  9156. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  9157. Get the TableCell which belongs to the TableCell
  9158. @param cell
  9159. </member>
  9160. <member name="T:NPOI.XWPF.UserModel.XWPFFactory">
  9161. @author Yegor Kozlov
  9162. </member>
  9163. <member name="M:NPOI.XWPF.UserModel.XWPFFactory.GetDescriptor(System.String)">
  9164. @since POI 3.14-Beta1
  9165. </member>
  9166. <member name="M:NPOI.XWPF.UserModel.XWPFFactory.CreateDocumentPart(System.Type,System.Type[],System.Object[])">
  9167. @since POI 3.14-Beta1
  9168. </member>
  9169. <member name="T:NPOI.XWPF.UserModel.XWPFFieldRun">
  9170. A run of text which is part of a field, such as Title
  9171. of Page number or Author.
  9172. Any given Field may be made up of multiple of these.
  9173. </member>
  9174. <member name="T:NPOI.XWPF.UserModel.XWPFFooter">
  9175. Sketch of XWPF footer class
  9176. </member>
  9177. <member name="M:NPOI.XWPF.UserModel.XWPFFooter.Commit">
  9178. save and Commit footer
  9179. </member>
  9180. <member name="P:NPOI.XWPF.UserModel.XWPFFooter.PartType">
  9181. Get the PartType of the body
  9182. @see NPOI.XWPF.UserModel.IBody#getPartType()
  9183. </member>
  9184. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetTableArray(System.Int32)">
  9185. <summary>
  9186. </summary>
  9187. <param name="pos">position in table array</param>
  9188. <returns>The table at position pos</returns>
  9189. </member>
  9190. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.InsertTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  9191. <summary>
  9192. inserts an existing XWPFTable to the arrays bodyElements and tables
  9193. </summary>
  9194. <param name="pos"></param>
  9195. <param name="table"></param>
  9196. </member>
  9197. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetTable(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  9198. if there is a corresponding {@link XWPFTable} of the parameter ctTable in the tableList of this header
  9199. the method will return this table
  9200. if there is no corresponding {@link XWPFTable} the method will return null
  9201. @param ctTable
  9202. @see NPOI.XWPF.UserModel.IBody#getTable(CTTbl ctTable)
  9203. </member>
  9204. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  9205. if there is a corresponding {@link XWPFParagraph} of the parameter ctTable in the paragraphList of this header or footer
  9206. the method will return this paragraph
  9207. if there is no corresponding {@link XWPFParagraph} the method will return null
  9208. @param p is instance of CTP and is searching for an XWPFParagraph
  9209. @return null if there is no XWPFParagraph with an corresponding CTPparagraph in the paragraphList of this header or footer
  9210. XWPFParagraph with the correspondig CTP p
  9211. @see NPOI.XWPF.UserModel.IBody#getParagraph(CTP p)
  9212. </member>
  9213. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetParagraphArray(System.Int32)">
  9214. <summary>
  9215. Returns the paragraph that holds the text of the header or footer.
  9216. </summary>
  9217. <param name="pos"></param>
  9218. <returns></returns>
  9219. </member>
  9220. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  9221. <summary>
  9222. Get the TableCell which belongs to the TableCell
  9223. </summary>
  9224. <param name="cell"></param>
  9225. <returns></returns>
  9226. </member>
  9227. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.IsCursorInFtn(System.Xml.XmlDocument)">
  9228. verifies that cursor is on the right position
  9229. @param cursor
  9230. </member>
  9231. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.InsertNewTbl(System.Xml.XmlDocument)">
  9232. @param cursor
  9233. @return the inserted table
  9234. @see NPOI.XWPF.UserModel.IBody#insertNewTbl(XmlCursor cursor)
  9235. </member>
  9236. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.InsertNewParagraph(System.Xml.XmlDocument)">
  9237. add a new paragraph at position of the cursor
  9238. @param cursor
  9239. @return the inserted paragraph
  9240. @see NPOI.XWPF.UserModel.IBody#insertNewParagraph(XmlCursor cursor)
  9241. </member>
  9242. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.AddNewTbl(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  9243. add a new table to the end of the footnote
  9244. @param table
  9245. @return the Added XWPFTable
  9246. </member>
  9247. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.AddNewParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  9248. add a new paragraph to the end of the footnote
  9249. @param paragraph
  9250. @return the Added XWPFParagraph
  9251. </member>
  9252. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetXWPFDocument">
  9253. @see NPOI.XWPF.UserModel.IBody#getXWPFDocument()
  9254. </member>
  9255. <member name="P:NPOI.XWPF.UserModel.XWPFFootnote.Part">
  9256. returns the Part, to which the body belongs, which you need for Adding relationship to other parts
  9257. @see NPOI.XWPF.UserModel.IBody#getPart()
  9258. </member>
  9259. <member name="P:NPOI.XWPF.UserModel.XWPFFootnote.PartType">
  9260. Get the PartType of the body
  9261. @see NPOI.XWPF.UserModel.IBody#getPartType()
  9262. </member>
  9263. <member name="T:NPOI.XWPF.UserModel.XWPFFootnotes">
  9264. Looks After the collection of Footnotes for a document
  9265. @author Mike McEuen (mceuen@hp.com)
  9266. </member>
  9267. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  9268. Construct XWPFFootnotes from a package part
  9269. @param part the package part holding the data of the footnotes,
  9270. @param rel the package relationship of type "http://schemas.Openxmlformats.org/officeDocument/2006/relationships/footnotes"
  9271. </member>
  9272. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.#ctor">
  9273. Construct XWPFFootnotes from scratch for a new document.
  9274. </member>
  9275. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.OnDocumentRead">
  9276. Read document
  9277. </member>
  9278. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.SetFootnotes(NPOI.OpenXmlFormats.Wordprocessing.CT_Footnotes)">
  9279. Sets the ctFootnotes
  9280. @param footnotes
  9281. </member>
  9282. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.AddFootnote(NPOI.XWPF.UserModel.XWPFFootnote)">
  9283. add an XWPFFootnote to the document
  9284. @param footnote
  9285. @throws IOException
  9286. </member>
  9287. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.AddFootnote(NPOI.OpenXmlFormats.Wordprocessing.CT_FtnEdn)">
  9288. add a footnote to the document
  9289. @param note
  9290. @throws IOException
  9291. </member>
  9292. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.GetXWPFDocument">
  9293. @see NPOI.XWPF.UserModel.IBody#getPart()
  9294. </member>
  9295. <member name="T:NPOI.XWPF.UserModel.XWPFHeader">
  9296. Sketch of XWPF header class
  9297. </member>
  9298. <member name="M:NPOI.XWPF.UserModel.XWPFHeader.Commit">
  9299. <summary>
  9300. Save and commit footer
  9301. </summary>
  9302. </member>
  9303. <member name="M:NPOI.XWPF.UserModel.XWPFHeader.OnDocumentRead">
  9304. <summary>
  9305. Read the document
  9306. </summary>
  9307. </member>
  9308. <member name="P:NPOI.XWPF.UserModel.XWPFHeader.PartType">
  9309. <summary>
  9310. Get the PartType of the body
  9311. </summary>
  9312. </member>
  9313. <member name="T:NPOI.XWPF.UserModel.XWPFHeaderFooter">
  9314. Parent of XWPF headers and footers
  9315. </member>
  9316. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.Paragraphs">
  9317. Returns the paragraph(s) that holds
  9318. the text of the header or footer.
  9319. Normally there is only the one paragraph, but
  9320. there could be more in certain cases, or
  9321. a table.
  9322. </member>
  9323. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.Tables">
  9324. Return the table(s) that holds the text
  9325. of the header or footer, for complex cases
  9326. where a paragraph isn't used.
  9327. Normally there's just one paragraph, but some
  9328. complex headers/footers have a table or two
  9329. in Addition.
  9330. </member>
  9331. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.Text">
  9332. Returns the textual content of the header/footer,
  9333. by flattening out the text of its paragraph(s)
  9334. </member>
  9335. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.SetHeaderFooter(NPOI.OpenXmlFormats.Wordprocessing.CT_HdrFtr)">
  9336. Set a new headerFooter
  9337. </member>
  9338. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetTable(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  9339. if there is a corresponding {@link XWPFTable} of the parameter ctTable in the tableList of this header
  9340. the method will return this table
  9341. if there is no corresponding {@link XWPFTable} the method will return null
  9342. @param ctTable
  9343. </member>
  9344. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  9345. if there is a corresponding {@link XWPFParagraph} of the parameter ctTable in the paragraphList of this header or footer
  9346. the method will return this paragraph
  9347. if there is no corresponding {@link XWPFParagraph} the method will return null
  9348. @param p is instance of CTP and is searching for an XWPFParagraph
  9349. @return null if there is no XWPFParagraph with an corresponding CTPparagraph in the paragraphList of this header or footer
  9350. XWPFParagraph with the correspondig CTP p
  9351. </member>
  9352. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetParagraphArray(System.Int32)">
  9353. Returns the paragraph that holds
  9354. the text of the header or footer.
  9355. </member>
  9356. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetListParagraph">
  9357. Get a List of all Paragraphs
  9358. @return a list of {@link XWPFParagraph}
  9359. </member>
  9360. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.AllPackagePictures">
  9361. Get all Pictures in this package
  9362. @return all Pictures in this package
  9363. </member>
  9364. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.AddPictureData(System.Byte[],System.Int32)">
  9365. Adds a picture to the document.
  9366. @param pictureData The picture data
  9367. @param format The format of the picture.
  9368. @return the index to this picture (0 based), the Added picture can be obtained from {@link #getAllPictures()} .
  9369. @throws InvalidFormatException
  9370. </member>
  9371. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.AddPictureData(System.IO.Stream,System.Int32)">
  9372. Adds a picture to the document.
  9373. @param is The stream to read image from
  9374. @param format The format of the picture.
  9375. @return the index to this picture (0 based), the Added picture can be obtained from {@link #getAllPictures()} .
  9376. @throws InvalidFormatException
  9377. @
  9378. </member>
  9379. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetPictureDataByID(System.String)">
  9380. returns the PictureData by blipID
  9381. @param blipID
  9382. @return XWPFPictureData of a specificID
  9383. @throws Exception
  9384. </member>
  9385. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.Owner">
  9386. verifies that cursor is on the right position
  9387. @param cursor
  9388. </member>
  9389. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetTableArray(System.Int32)">
  9390. Returns the table at position pos
  9391. @see NPOI.XWPF.UserModel.IBody#getTableArray(int)
  9392. </member>
  9393. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.InsertTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  9394. inserts an existing XWPFTable to the arrays bodyElements and tables
  9395. @param pos
  9396. @param table
  9397. </member>
  9398. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  9399. Get the TableCell which belongs to the TableCell
  9400. @param cell
  9401. </member>
  9402. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.Part">
  9403. returns the Part, to which the body belongs, which you need for Adding relationship to other parts
  9404. @see NPOI.XWPF.UserModel.IBody#getPart()
  9405. </member>
  9406. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.CreateParagraph">
  9407. Adds a new paragraph at the end of the header or footer
  9408. </member>
  9409. <member name="T:NPOI.XWPF.UserModel.XWPFHyperlink">
  9410. * Sketch of XWPF hyperlink class
  9411. *
  9412. * @author Yury Batrakov (batrakov at gmail.com)
  9413. *
  9414. </member>
  9415. <member name="T:NPOI.XWPF.UserModel.XWPFHyperlinkRun">
  9416. A run of text with a Hyperlink applied to it.
  9417. Any given Hyperlink may be made up of multiple of these.
  9418. </member>
  9419. <member name="P:NPOI.XWPF.UserModel.XWPFHyperlinkRun.HyperlinkId">
  9420. Returns the ID of the hyperlink, if one is Set.
  9421. </member>
  9422. <member name="M:NPOI.XWPF.UserModel.XWPFHyperlinkRun.GetHyperlink(NPOI.XWPF.UserModel.XWPFDocument)">
  9423. If this Hyperlink is an external reference hyperlink,
  9424. return the object for it.
  9425. </member>
  9426. <member name="M:NPOI.XWPF.UserModel.XWPFLatentStyles.IsLatentStyle(System.String)">
  9427. checks whether specific LatentStyleID is a latentStyle
  9428. </member>
  9429. <member name="T:NPOI.XWPF.UserModel.XWPFNum">
  9430. @author Philipp Epp
  9431. </member>
  9432. <member name="T:NPOI.XWPF.UserModel.XWPFNumbering">
  9433. @author Philipp Epp
  9434. </member>
  9435. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  9436. create a new styles object with an existing document
  9437. </member>
  9438. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.#ctor">
  9439. create a new XWPFNumbering object for use in a new document
  9440. </member>
  9441. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.OnDocumentRead">
  9442. read numbering form an existing package
  9443. </member>
  9444. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.Commit">
  9445. save and Commit numbering
  9446. </member>
  9447. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.SetNumbering(NPOI.OpenXmlFormats.Wordprocessing.CT_Numbering)">
  9448. Sets the ctNumbering
  9449. @param numbering
  9450. </member>
  9451. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.NumExist(System.String)">
  9452. Checks whether number with numID exists
  9453. @param numID
  9454. @return bool true if num exist, false if num not exist
  9455. </member>
  9456. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.AddNum(NPOI.XWPF.UserModel.XWPFNum)">
  9457. add a new number to the numbering document
  9458. @param num
  9459. </member>
  9460. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.AddNum(System.String)">
  9461. Add a new num with an abstractNumID
  9462. @return return NumId of the Added num
  9463. </member>
  9464. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.AddNum(System.String,System.String)">
  9465. Add a new num with an abstractNumID and a numID
  9466. @param abstractNumID
  9467. @param numID
  9468. </member>
  9469. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.GetNum(System.String)">
  9470. Get Num by NumID
  9471. @param numID
  9472. @return abstractNum with NumId if no Num exists with that NumID
  9473. null will be returned
  9474. </member>
  9475. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.GetAbstractNum(System.String)">
  9476. Get AbstractNum by abstractNumID
  9477. @param abstractNumID
  9478. @return abstractNum with abstractNumId if no abstractNum exists with that abstractNumID
  9479. null will be returned
  9480. </member>
  9481. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.GetIdOfAbstractNum(NPOI.XWPF.UserModel.XWPFAbstractNum)">
  9482. Compare AbstractNum with abstractNums of this numbering document.
  9483. If the content of abstractNum Equals with an abstractNum of the List in numbering
  9484. the Bigint Value of it will be returned.
  9485. If no equal abstractNum is existing null will be returned
  9486. @param abstractNum
  9487. @return Bigint
  9488. </member>
  9489. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.AddAbstractNum(NPOI.XWPF.UserModel.XWPFAbstractNum)">
  9490. add a new AbstractNum and return its AbstractNumID
  9491. @param abstractNum
  9492. </member>
  9493. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.AddAbstractNum">
  9494. <summary>
  9495. Add a new AbstractNum
  9496. </summary>
  9497. <returns></returns>
  9498. @author antony liu
  9499. </member>
  9500. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.RemoveAbstractNum(System.String)">
  9501. remove an existing abstractNum
  9502. @param abstractNumID
  9503. @return true if abstractNum with abstractNumID exists in NumberingArray,
  9504. false if abstractNum with abstractNumID not exists
  9505. </member>
  9506. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.GetAbstractNumID(System.String)">
  9507. return the abstractNumID
  9508. If the AbstractNumID not exists
  9509. return null
  9510. @param numID
  9511. @return abstractNumID
  9512. </member>
  9513. <member name="T:NPOI.XWPF.UserModel.XWPFParagraph">
  9514. <p>A Paragraph within a Document, Table, Header etc.</p>
  9515. <p>A paragraph has a lot of styling information, but the
  9516. actual text (possibly along with more styling) is held on
  9517. the child {@link XWPFRun}s.</p>
  9518. </member>
  9519. <member name="F:NPOI.XWPF.UserModel.XWPFParagraph.document">
  9520. For access to the document's hyperlink, comments, tables etc
  9521. </member>
  9522. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.BuildRunsInOrderFromXml(System.Collections.ArrayList)">
  9523. Identifies (in order) the parts of the paragraph /
  9524. sub-paragraph that correspond to character text
  9525. runs, and builds the appropriate runs for these.
  9526. </member>
  9527. <!-- Badly formed XML comment ignored for member "P:NPOI.XWPF.UserModel.XWPFParagraph.IRuns" -->
  9528. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.Text">
  9529. Return the textual content of the paragraph, including text from pictures
  9530. and std element in it.
  9531. </member>
  9532. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.StyleID">
  9533. Return styleID of the paragraph if style exist for this paragraph
  9534. if not, null will be returned
  9535. @return styleID as String
  9536. </member>
  9537. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetNumID">
  9538. If style exist for this paragraph
  9539. NumId of the paragraph will be returned.
  9540. If style not exist null will be returned
  9541. @return NumID as Bigint
  9542. </member>
  9543. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.SetNumILvl(System.String)">
  9544. <summary>
  9545. setNumILvl of Paragraph
  9546. </summary>
  9547. <param name="iLvl"></param>
  9548. </member>
  9549. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetNumIlvl">
  9550. <summary>
  9551. Returns Ilvl of the numeric style for this paragraph.
  9552. </summary>
  9553. <returns></returns>
  9554. </member>
  9555. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetNumFmt">
  9556. <summary>
  9557. Returns numbering format for this paragraph, eg bullet or lowerLetter.
  9558. </summary>
  9559. <returns></returns>
  9560. </member>
  9561. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.NumLevelText">
  9562. <summary>
  9563. Returns the text that should be used around the paragraph level numbers.
  9564. </summary>
  9565. </member>
  9566. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetNumStartOverride">
  9567. <summary>
  9568. Gets the numstartOverride for the paragraph numbering for this paragraph.
  9569. </summary>
  9570. <returns></returns>
  9571. </member>
  9572. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.SetNumID(System.String)">
  9573. <summary>
  9574. SetNumID of Paragraph
  9575. </summary>
  9576. <param name="numId"></param>
  9577. </member>
  9578. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.SetNumID(System.String,System.String)">
  9579. <summary>
  9580. Set NumID and level of Paragraph
  9581. </summary>
  9582. <param name="numId"></param>
  9583. <param name="ilvl"></param>
  9584. </member>
  9585. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.ParagraphText">
  9586. <summary>
  9587. Returns the text of the paragraph, but not of any objects in the paragraph
  9588. </summary>
  9589. </member>
  9590. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.PictureText">
  9591. <summary>
  9592. Returns any text from any suitable pictures in the paragraph
  9593. </summary>
  9594. </member>
  9595. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.FootnoteText">
  9596. <summary>
  9597. Returns the footnote text of the paragraph
  9598. </summary>
  9599. </member>
  9600. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.Alignment">
  9601. <summary>
  9602. Returns the paragraph alignment which shall be applied to text in this paragraph.
  9603. </summary>
  9604. </member>
  9605. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.FontAlignment">
  9606. <summary>
  9607. The raw alignment value
  9608. </summary>
  9609. </member>
  9610. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.VerticalAlignment">
  9611. Returns the text vertical alignment which shall be applied to text in
  9612. this paragraph.
  9613. <p>
  9614. If the line height (before any Added spacing) is larger than one or more
  9615. characters on the line, all characters will be aligned to each other as
  9616. specified by this element.
  9617. </p>
  9618. <p>
  9619. If this element is omitted on a given paragraph, its value is determined
  9620. by the Setting previously Set at any level of the style hierarchy (i.e.
  9621. that previous Setting remains unChanged). If this Setting is never
  9622. specified in the style hierarchy, then the vertical alignment of all
  9623. characters on the line shall be automatically determined by the consumer.
  9624. </p>
  9625. @return the vertical alignment of this paragraph.
  9626. </member>
  9627. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.BorderTop">
  9628. <summary>
  9629. the top border for the paragraph
  9630. </summary>
  9631. </member>
  9632. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.BorderBottom">
  9633. <summary>
  9634. Specifies the border which shall be displayed below a Set of
  9635. paragraphs which have the same Set of paragraph border Settings.
  9636. </summary>
  9637. <returns>the bottom border for the paragraph</returns>
  9638. </member>
  9639. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.BorderLeft">
  9640. <summary>
  9641. Specifies the border which shall be displayed on the left side of the
  9642. page around the specified paragraph.
  9643. </summary>
  9644. <returns>the left border for the paragraph</returns>
  9645. </member>
  9646. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.BorderRight">
  9647. Specifies the border which shall be displayed on the right side of the
  9648. page around the specified paragraph.
  9649. @return ParagraphBorder - the right border for the paragraph
  9650. @see #setBorderRight(Borders)
  9651. @see Borders for a list of all possible borders
  9652. </member>
  9653. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.BorderBetween">
  9654. Specifies the border which shall be displayed between each paragraph in a
  9655. Set of paragraphs which have the same Set of paragraph border Settings.
  9656. @return ParagraphBorder - the between border for the paragraph
  9657. @see #setBorderBetween(Borders)
  9658. @see Borders for a list of all possible borders
  9659. </member>
  9660. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IsPageBreak">
  9661. Specifies that when rendering this document in a paginated
  9662. view, the contents of this paragraph are rendered on the start of a new
  9663. page in the document.
  9664. <p>
  9665. If this element is omitted on a given paragraph,
  9666. its value is determined by the Setting previously Set at any level of the
  9667. style hierarchy (i.e. that previous Setting remains unChanged). If this
  9668. Setting is never specified in the style hierarchy, then this property
  9669. shall not be applied. Since the paragraph is specified to start on a new
  9670. page, it begins page two even though it could have fit on page one.
  9671. </p>
  9672. @return bool - if page break is Set
  9673. </member>
  9674. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.SpacingAfter">
  9675. Specifies the spacing that should be Added After the last line in this
  9676. paragraph in the document in absolute units.
  9677. @return int - value representing the spacing After the paragraph
  9678. </member>
  9679. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.SpacingAfterLines">
  9680. Specifies the spacing that should be Added After the last line in this
  9681. paragraph in the document in absolute units.
  9682. @return bigint - value representing the spacing After the paragraph
  9683. @see #setSpacingAfterLines(int)
  9684. </member>
  9685. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.SpacingBefore">
  9686. Specifies the spacing that should be Added above the first line in this
  9687. paragraph in the document in absolute units.
  9688. @return the spacing that should be Added above the first line
  9689. @see #setSpacingBefore(int)
  9690. </member>
  9691. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.SpacingBeforeLines">
  9692. Specifies the spacing that should be Added before the first line in this paragraph in the
  9693. document in line units.
  9694. The value of this attribute is specified in one hundredths of a line.
  9695. @return the spacing that should be Added before the first line in this paragraph
  9696. @see #setSpacingBeforeLines(int)
  9697. </member>
  9698. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.SpacingLineRule">
  9699. <summary>
  9700. Specifies how the spacing between lines is calculated as stored in the
  9701. line attribute. If this attribute is omitted, then it shall be assumed to
  9702. be of a value auto if a line attribute value is present.
  9703. </summary>
  9704. </member>
  9705. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.SpacingBetween">
  9706. <summary>
  9707. Return the spacing between lines of a paragraph. The units of the return value depends on the
  9708. <see cref="T:NPOI.XWPF.UserModel.LineSpacingRule"/>. If AUTO, the return value is in lines, otherwise the return
  9709. value is in points
  9710. <return>a double specifying points or lines.</return>
  9711. </summary>
  9712. </member>
  9713. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IndentationLeft">
  9714. Specifies the indentation which shall be placed between the left text
  9715. margin for this paragraph and the left edge of that paragraph's content
  9716. in a left to right paragraph, and the right text margin and the right
  9717. edge of that paragraph's text in a right to left paragraph
  9718. <p>
  9719. If this attribute is omitted, its value shall be assumed to be zero.
  9720. Negative values are defined such that the text is Moved past the text margin,
  9721. positive values Move the text inside the text margin.
  9722. </p>
  9723. @return indentation or null if indentation is not Set
  9724. </member>
  9725. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IndentationRight">
  9726. Specifies the indentation which shall be placed between the right text
  9727. margin for this paragraph and the right edge of that paragraph's content
  9728. in a left to right paragraph, and the right text margin and the right
  9729. edge of that paragraph's text in a right to left paragraph
  9730. <p>
  9731. If this attribute is omitted, its value shall be assumed to be zero.
  9732. Negative values are defined such that the text is Moved past the text margin,
  9733. positive values Move the text inside the text margin.
  9734. </p>
  9735. @return indentation or null if indentation is not Set
  9736. </member>
  9737. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IndentationHanging">
  9738. Specifies the indentation which shall be Removed from the first line of
  9739. the parent paragraph, by moving the indentation on the first line back
  9740. towards the beginning of the direction of text flow.
  9741. This indentation is
  9742. specified relative to the paragraph indentation which is specified for
  9743. all other lines in the parent paragraph.
  9744. The firstLine and hanging
  9745. attributes are mutually exclusive, if both are specified, then the
  9746. firstLine value is ignored.
  9747. @return indentation or null if indentation is not Set
  9748. </member>
  9749. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IndentationFirstLine">
  9750. Specifies the Additional indentation which shall be applied to the first
  9751. line of the parent paragraph. This Additional indentation is specified
  9752. relative to the paragraph indentation which is specified for all other
  9753. lines in the parent paragraph.
  9754. The firstLine and hanging attributes are
  9755. mutually exclusive, if both are specified, then the firstLine value is
  9756. ignored.
  9757. If the firstLineChars attribute is also specified, then this
  9758. value is ignored.
  9759. If this attribute is omitted, then its value shall be
  9760. assumed to be zero (if needed).
  9761. @return indentation or null if indentation is not Set
  9762. </member>
  9763. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IsWordWrapped">
  9764. This element specifies whether a consumer shall break Latin text which
  9765. exceeds the text extents of a line by breaking the word across two lines
  9766. (breaking on the character level) or by moving the word to the following
  9767. line (breaking on the word level).
  9768. @return bool
  9769. </member>
  9770. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.Style">
  9771. @return the style of the paragraph
  9772. </member>
  9773. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetCTPBrd(System.Boolean)">
  9774. Get a <b>copy</b> of the currently used CTPBrd, if none is used, return
  9775. a new instance.
  9776. </member>
  9777. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetCTSpacing(System.Boolean)">
  9778. Get a <b>copy</b> of the currently used CTSpacing, if none is used,
  9779. return a new instance.
  9780. </member>
  9781. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetCTInd(System.Boolean)">
  9782. Get a <b>copy</b> of the currently used CTPInd, if none is used, return
  9783. a new instance.
  9784. </member>
  9785. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetCTPPr">
  9786. Get a <b>copy</b> of the currently used CTPPr, if none is used, return
  9787. a new instance.
  9788. </member>
  9789. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.AddRun(NPOI.OpenXmlFormats.Wordprocessing.CT_R)">
  9790. add a new run at the end of the position of
  9791. the content of parameter run
  9792. @param run
  9793. </member>
  9794. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.ReplaceText(System.String,System.String)">
  9795. <summary>
  9796. Replace text inside each run (cross run is not supported yet)
  9797. </summary>
  9798. <param name="oldText">target text</param>
  9799. <param name="newText">replacement text</param>
  9800. </member>
  9801. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.SearchText(System.String,NPOI.XWPF.UserModel.PositionInParagraph)">
  9802. <summary>
  9803. this methods parse the paragraph and search for the string searched.
  9804. If it finds the string, it will return true and the position of the String will be saved in the parameter startPos.
  9805. </summary>
  9806. <param name="searched"></param>
  9807. <param name="startPos"></param>
  9808. <returns></returns>
  9809. </member>
  9810. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.CreateRun">
  9811. Appends a new run to this paragraph
  9812. @return a new text run
  9813. </member>
  9814. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.CreateOMath">
  9815. Appends a new OMath to this paragraph
  9816. @return a new text run
  9817. </member>
  9818. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.InsertNewRun(System.Int32)">
  9819. <summary>
  9820. insert a new Run in RunArray
  9821. </summary>
  9822. <param name="pos">The position at which the new run should be added.</param>
  9823. <returns>the inserted run or null if the given pos is out of bounds.</returns>
  9824. </member>
  9825. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetText(NPOI.XWPF.UserModel.TextSegment)">
  9826. Get a Text
  9827. @param segment
  9828. </member>
  9829. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.RemoveRun(System.Int32)">
  9830. Removes a Run at the position pos in the paragraph
  9831. @param pos
  9832. @return true if the run was Removed
  9833. </member>
  9834. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.ElementType">
  9835. returns the type of the BodyElement Paragraph
  9836. @see NPOI.XWPF.UserModel.IBodyElement#getElementType()
  9837. </member>
  9838. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.Part">
  9839. returns the part of the bodyElement
  9840. @see NPOI.XWPF.UserModel.IBody#getPart()
  9841. </member>
  9842. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.PartType">
  9843. returns the partType of the bodyPart which owns the bodyElement
  9844. @see NPOI.XWPF.UserModel.IBody#getPartType()
  9845. </member>
  9846. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.AddRun(NPOI.XWPF.UserModel.XWPFRun)">
  9847. Adds a new Run to the Paragraph
  9848. @param r
  9849. </member>
  9850. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetRun(NPOI.OpenXmlFormats.Wordprocessing.CT_R)">
  9851. return the XWPFRun-Element which owns the CTR Run-Element
  9852. @param r
  9853. </member>
  9854. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.CreateHyperlinkRun(System.String)">
  9855. <summary>
  9856. Appends a new hyperlink run to this paragraph
  9857. </summary>
  9858. <param name="rId">a new hyperlink run</param>
  9859. <returns></returns>
  9860. </member>
  9861. <member name="T:NPOI.XWPF.UserModel.XWPFPicture">
  9862. @author Philipp Epp
  9863. </member>
  9864. <member name="M:NPOI.XWPF.UserModel.XWPFPicture.SetPictureReference(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  9865. Link Picture with PictureData
  9866. @param rel
  9867. </member>
  9868. <member name="M:NPOI.XWPF.UserModel.XWPFPicture.GetCTPicture">
  9869. Return the underlying CTPicture bean that holds all properties for this picture
  9870. @return the underlying CTPicture bean
  9871. </member>
  9872. <member name="M:NPOI.XWPF.UserModel.XWPFPicture.GetPictureData">
  9873. Get the PictureData of the Picture, if present.
  9874. Note - not all kinds of picture have data
  9875. </member>
  9876. <member name="P:NPOI.XWPF.UserModel.XWPFPicture.Width">
  9877. <summary>
  9878. Returns the width of the picture (in points).
  9879. </summary>
  9880. </member>
  9881. <member name="P:NPOI.XWPF.UserModel.XWPFPicture.Height">
  9882. <summary>
  9883. Returns the depth of the picture (in points).
  9884. </summary>
  9885. </member>
  9886. <member name="T:NPOI.XWPF.UserModel.XWPFPictureData">
  9887. <summary>
  9888. Raw picture data, normally attached to a WordProcessingML Drawing. As a rule, pictures are stored in the /word/media/ part of a WordProcessingML package.
  9889. </summary>
  9890. <remarks>
  9891. @author Philipp Epp
  9892. </remarks>
  9893. </member>
  9894. <member name="F:NPOI.XWPF.UserModel.XWPFPictureData.RELATIONS">
  9895. Relationships for each known picture type
  9896. </member>
  9897. <member name="M:NPOI.XWPF.UserModel.XWPFPictureData.#ctor">
  9898. Create a new XWPFGraphicData node
  9899. </member>
  9900. <member name="M:NPOI.XWPF.UserModel.XWPFPictureData.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  9901. Construct XWPFPictureData from a package part
  9902. @param part the package part holding the Drawing data,
  9903. @param rel the package relationship holding this Drawing,
  9904. the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/image
  9905. </member>
  9906. <member name="P:NPOI.XWPF.UserModel.XWPFPictureData.Data">
  9907. Gets the picture data as a byte array.
  9908. <p>
  9909. Note, that this call might be expensive since all the picture data is copied into a temporary byte array.
  9910. You can grab the picture data directly from the underlying package part as follows:
  9911. <br/>
  9912. <code>
  9913. InputStream is1 = GetPackagePart().InputStream;
  9914. </code>
  9915. </p>
  9916. @return the Picture data.
  9917. </member>
  9918. <member name="P:NPOI.XWPF.UserModel.XWPFPictureData.FileName">
  9919. Returns the file name of the image, eg image7.jpg . The original filename
  9920. isn't always available, but if it can be found it's likely to be in the
  9921. CTDrawing
  9922. </member>
  9923. <member name="M:NPOI.XWPF.UserModel.XWPFPictureData.SuggestFileExtension">
  9924. Suggests a file extension for this image.
  9925. @return the file extension.
  9926. </member>
  9927. <member name="M:NPOI.XWPF.UserModel.XWPFPictureData.GetPictureType">
  9928. Return an integer constant that specifies type of this picture
  9929. @return an integer constant that specifies type of this picture
  9930. @see NPOI.XWPF.UserModel.PictureTypeEMF
  9931. @see NPOI.XWPF.UserModel.PictureTypeWMF
  9932. @see NPOI.XWPF.UserModel.PictureTypePICT
  9933. @see NPOI.XWPF.UserModel.PictureTypeJPEG
  9934. @see NPOI.XWPF.UserModel.PictureTypePNG
  9935. @see NPOI.XWPF.UserModel.PictureTypeDIB
  9936. </member>
  9937. <member name="M:NPOI.XWPF.UserModel.XWPFPictureData.PrepareForCommit">
  9938. *PictureData objects store the actual content in the part directly without keeping a
  9939. copy like all others therefore we need to handle them differently.
  9940. </member>
  9941. <member name="T:NPOI.XWPF.UserModel.XWPFRelation">
  9942. @author Yegor Kozlov
  9943. </member>
  9944. <member name="F:NPOI.XWPF.UserModel.XWPFRelation._table">
  9945. A map to lookup POIXMLRelation by its relation type
  9946. </member>
  9947. <member name="F:NPOI.XWPF.UserModel.XWPFRelation.IMAGE_EMF">
  9948. Supported image formats
  9949. </member>
  9950. <member name="M:NPOI.XWPF.UserModel.XWPFRelation.GetInstance(System.String)">
  9951. Get POIXMLRelation by relation type
  9952. @param rel relation type, for example,
  9953. <code>http://schemas.openxmlformats.org/officeDocument/2006/relationships/image</code>
  9954. @return registered POIXMLRelation or null if not found
  9955. </member>
  9956. <member name="T:NPOI.XWPF.UserModel.FontCharRange">
  9957. @see <a href="http://msdn.microsoft.com/en-us/library/ff533743(v=office.12).aspx">[MS-OI29500] Run Fonts</a>
  9958. </member>
  9959. <member name="T:NPOI.XWPF.UserModel.XWPFRun">
  9960. XWPFrun.object defines a region of text with a common Set of properties
  9961. @author Yegor Kozlov
  9962. @author Gregg Morris (gregg dot morris at gmail dot com) - added getColor(), setColor()
  9963. </member>
  9964. <member name="M:NPOI.XWPF.UserModel.XWPFRun.#ctor(NPOI.OpenXmlFormats.Wordprocessing.CT_R,NPOI.XWPF.UserModel.IRunBody)">
  9965. @param r the CT_R bean which holds the run.attributes
  9966. @param p the parent paragraph
  9967. </member>
  9968. <member name="M:NPOI.XWPF.UserModel.XWPFRun.#ctor(NPOI.OpenXmlFormats.Wordprocessing.CT_R,NPOI.XWPF.UserModel.XWPFParagraph)">
  9969. @deprecated Use {@link XWPFRun#XWPFRun(CTR, IRunBody)}
  9970. </member>
  9971. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetCTR">
  9972. Get the currently used CT_R object
  9973. @return CT_R object
  9974. </member>
  9975. <member name="P:NPOI.XWPF.UserModel.XWPFRun.Parent">
  9976. Get the currently referenced paragraph/SDT object
  9977. @return current parent
  9978. </member>
  9979. <member name="P:NPOI.XWPF.UserModel.XWPFRun.Paragraph">
  9980. Get the currently referenced paragraph, or null if a SDT object
  9981. @deprecated use {@link XWPFRun#getParent()} instead
  9982. </member>
  9983. <member name="P:NPOI.XWPF.UserModel.XWPFRun.Document">
  9984. @return The {@link XWPFDocument} instance, this run.belongs to, or
  9985. <code>null</code> if parent structure (paragraph > document) is not properly Set.
  9986. </member>
  9987. <member name="M:NPOI.XWPF.UserModel.XWPFRun.IsCTOnOff(NPOI.OpenXmlFormats.Wordprocessing.CT_OnOff)">
  9988. For isBold, isItalic etc
  9989. </member>
  9990. <member name="P:NPOI.XWPF.UserModel.XWPFRun.IsBold">
  9991. Whether the bold property shall be applied to all non-complex script
  9992. characters in the contents of this run.when displayed in a document.
  9993. <p>
  9994. This formatting property is a toggle property, which specifies that its
  9995. behavior differs between its use within a style defInition and its use as
  9996. direct formatting. When used as part of a style defInition, Setting this
  9997. property shall toggle the current state of that property as specified up
  9998. to this point in the hierarchy (i.e. applied to not applied, and vice
  9999. versa). Setting it to <code>false</code> (or an equivalent) shall
  10000. result in the current Setting remaining unChanged. However, when used as
  10001. direct formatting, Setting this property to true or false shall Set the
  10002. absolute state of the resulting property.
  10003. </p>
  10004. <p>
  10005. If this element is not present, the default value is to leave the
  10006. formatting applied at previous level in the style hierarchy. If this
  10007. element is never applied in the style hierarchy, then bold shall not be
  10008. applied to non-complex script characters.
  10009. </p>
  10010. @param value <code>true</code> if the bold property is applied to
  10011. this run
  10012. </member>
  10013. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetColor">
  10014. Get text color. The returned value is a string in the hex form "RRGGBB".
  10015. </member>
  10016. <member name="M:NPOI.XWPF.UserModel.XWPFRun.SetColor(System.String)">
  10017. Set text color.
  10018. @param rgbStr - the desired color, in the hex form "RRGGBB".
  10019. </member>
  10020. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetText(System.Int32)">
  10021. Return the string content of this text run
  10022. @return the text of this text run.or <code>null</code> if not Set
  10023. </member>
  10024. <member name="P:NPOI.XWPF.UserModel.XWPFRun.PictureText">
  10025. Returns text embedded in pictures
  10026. </member>
  10027. <member name="M:NPOI.XWPF.UserModel.XWPFRun.SetText(System.String)">
  10028. <summary>
  10029. Sets the text of this text run
  10030. </summary>
  10031. <param name="value">the literal text which shall be displayed in the document</param>
  10032. </member>
  10033. <member name="M:NPOI.XWPF.UserModel.XWPFRun.SetText(System.String,System.Int32)">
  10034. <summary>
  10035. Sets the text of this text run.in the
  10036. </summary>
  10037. <param name="value">the literal text which shall be displayed in the document</param>
  10038. <param name="pos">position in the text array (NB: 0 based)</param>
  10039. </member>
  10040. <member name="P:NPOI.XWPF.UserModel.XWPFRun.IsItalic">
  10041. Whether the italic property should be applied to all non-complex script
  10042. characters in the contents of this run.when displayed in a document.
  10043. @return <code>true</code> if the italic property is applied
  10044. </member>
  10045. <member name="P:NPOI.XWPF.UserModel.XWPFRun.Underline">
  10046. Specifies that the contents of this run.should be displayed along with an
  10047. underline appearing directly below the character heigh
  10048. @return the Underline pattern Applyed to this run
  10049. @see UnderlinePatterns
  10050. </member>
  10051. <member name="M:NPOI.XWPF.UserModel.XWPFRun.InsertText(System.String,System.Int32)">
  10052. <summary>
  10053. insert text at start index in the run
  10054. </summary>
  10055. <param name="text">insert text</param>
  10056. <param name="startIndex">start index of the insertion in the run text</param>
  10057. </member>
  10058. <member name="M:NPOI.XWPF.UserModel.XWPFRun.SetUnderline(NPOI.XWPF.UserModel.UnderlinePatterns)">
  10059. Specifies that the contents of this run.should be displayed along with an
  10060. underline appearing directly below the character heigh
  10061. If this element is not present, the default value is to leave the
  10062. formatting applied at previous level in the style hierarchy. If this
  10063. element is never applied in the style hierarchy, then an underline shall
  10064. not be applied to the contents of this run.
  10065. @param value -
  10066. underline type
  10067. @see UnderlinePatterns : all possible patterns that could be applied
  10068. </member>
  10069. <member name="P:NPOI.XWPF.UserModel.XWPFRun.IsStrikeThrough">
  10070. Specifies that the contents of this run.shall be displayed with a single
  10071. horizontal line through the center of the line.
  10072. @return <code>true</code> if the strike property is applied
  10073. </member>
  10074. <member name="P:NPOI.XWPF.UserModel.XWPFRun.IsStrike">
  10075. Specifies that the contents of this run.shall be displayed with a single
  10076. horizontal line through the center of the line.
  10077. <p>
  10078. This formatting property is a toggle property, which specifies that its
  10079. behavior differs between its use within a style defInition and its use as
  10080. direct formatting. When used as part of a style defInition, Setting this
  10081. property shall toggle the current state of that property as specified up
  10082. to this point in the hierarchy (i.e. applied to not applied, and vice
  10083. versa). Setting it to false (or an equivalent) shall result in the
  10084. current Setting remaining unChanged. However, when used as direct
  10085. formatting, Setting this property to true or false shall Set the absolute
  10086. state of the resulting property.
  10087. </p>
  10088. <p>
  10089. If this element is not present, the default value is to leave the
  10090. formatting applied at previous level in the style hierarchy. If this
  10091. element is never applied in the style hierarchy, then strikethrough shall
  10092. not be applied to the contents of this run.
  10093. </p>
  10094. @param value <code>true</code> if the strike property is applied to
  10095. this run
  10096. </member>
  10097. <member name="P:NPOI.XWPF.UserModel.XWPFRun.IsDoubleStrikeThrough">
  10098. Specifies that the contents of this run shall be displayed with a double
  10099. horizontal line through the center of the line.
  10100. @return <code>true</code> if the double strike property is applied
  10101. </member>
  10102. <member name="P:NPOI.XWPF.UserModel.XWPFRun.Subscript">
  10103. Specifies the alignment which shall be applied to the contents of this
  10104. run.in relation to the default appearance of the run.s text.
  10105. This allows the text to be repositioned as subscript or superscript without
  10106. altering the font size of the run.properties.
  10107. @return VerticalAlign
  10108. @see VerticalAlign all possible value that could be Applyed to this run
  10109. </member>
  10110. <member name="P:NPOI.XWPF.UserModel.XWPFRun.FontFamily">
  10111. Specifies the fonts which shall be used to display the text contents of
  10112. this run. Specifies a font which shall be used to format all characters
  10113. in the ASCII range (0 - 127) within the parent run
  10114. @return a string representing the font family
  10115. </member>
  10116. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetFontFamily(NPOI.XWPF.UserModel.FontCharRange)">
  10117. Gets the font family for the specified font char range.
  10118. If fcr is null, the font char range "ascii" is used
  10119. @param fcr the font char range, defaults to "ansi"
  10120. @return a string representing the font famil
  10121. </member>
  10122. <member name="M:NPOI.XWPF.UserModel.XWPFRun.SetFontFamily(System.String,NPOI.XWPF.UserModel.FontCharRange)">
  10123. Specifies the fonts which shall be used to display the text contents of
  10124. this run. The default handling for fcr == null is to overwrite the
  10125. ascii font char range with the given font family and also set all not
  10126. specified font ranges
  10127. @param fontFamily
  10128. @param fcr FontCharRange or null for default handling
  10129. </member>
  10130. <member name="P:NPOI.XWPF.UserModel.XWPFRun.FontSize">
  10131. Specifies the font size which shall be applied to all non complex script
  10132. characters in the contents of this run.when displayed.
  10133. @return value representing the font size
  10134. </member>
  10135. <member name="P:NPOI.XWPF.UserModel.XWPFRun.TextPosition">
  10136. This element specifies the amount by which text shall be raised or
  10137. lowered for this run.in relation to the default baseline of the
  10138. surrounding non-positioned text. This allows the text to be repositioned
  10139. without altering the font size of the contents.
  10140. If the val attribute is positive, then the parent run.shall be raised
  10141. above the baseline of the surrounding text by the specified number of
  10142. half-points. If the val attribute is negative, then the parent run.shall
  10143. be lowered below the baseline of the surrounding text by the specified
  10144. number of half-points.
  10145. *
  10146. If this element is not present, the default value is to leave the
  10147. formatting applied at previous level in the style hierarchy. If this
  10148. element is never applied in the style hierarchy, then the text shall not
  10149. be raised or lowered relative to the default baseline location for the
  10150. contents of this run.
  10151. @return a big integer representing the amount of text shall be "moved"
  10152. </member>
  10153. <member name="M:NPOI.XWPF.UserModel.XWPFRun.RemoveBreak">
  10154. </member>
  10155. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddBreak">
  10156. Specifies that a break shall be placed at the current location in the run
  10157. content.
  10158. A break is a special character which is used to override the
  10159. normal line breaking that would be performed based on the normal layout
  10160. of the document's contents.
  10161. @see #AddCarriageReturn()
  10162. </member>
  10163. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddBreak(NPOI.XWPF.UserModel.BreakType)">
  10164. Specifies that a break shall be placed at the current location in the run
  10165. content.
  10166. A break is a special character which is used to override the
  10167. normal line breaking that would be performed based on the normal layout
  10168. of the document's contents.
  10169. <p>
  10170. The behavior of this break character (the
  10171. location where text shall be restarted After this break) shall be
  10172. determined by its type values.
  10173. </p>
  10174. @see BreakType
  10175. </member>
  10176. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddBreak(NPOI.XWPF.UserModel.BreakClear)">
  10177. Specifies that a break shall be placed at the current location in the run
  10178. content. A break is a special character which is used to override the
  10179. normal line breaking that would be performed based on the normal layout
  10180. of the document's contents.
  10181. <p>
  10182. The behavior of this break character (the
  10183. location where text shall be restarted After this break) shall be
  10184. determined by its type (in this case is BreakType.TEXT_WRAPPING as default) and clear attribute values.
  10185. </p>
  10186. @see BreakClear
  10187. </member>
  10188. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddTab">
  10189. Specifies that a tab shall be placed at the current location in
  10190. the run content.
  10191. </member>
  10192. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddCarriageReturn">
  10193. Specifies that a carriage return shall be placed at the
  10194. current location in the run.content.
  10195. A carriage return is used to end the current line of text in
  10196. WordProcess.
  10197. The behavior of a carriage return in run.content shall be
  10198. identical to a break character with null type and clear attributes, which
  10199. shall end the current line and find the next available line on which to
  10200. continue.
  10201. The carriage return character forced the following text to be
  10202. restarted on the next available line in the document.
  10203. </member>
  10204. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddPicture(System.IO.Stream,System.Int32,System.String,System.Int32,System.Int32)">
  10205. Adds a picture to the run. This method handles
  10206. attaching the picture data to the overall file.
  10207. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_EMF
  10208. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_WMF
  10209. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_PICT
  10210. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_JPEG
  10211. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_PNG
  10212. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_DIB
  10213. @param pictureData The raw picture data
  10214. @param pictureType The type of the picture, eg {@link Document#PICTURE_TYPE_JPEG}
  10215. @param width width in EMUs. To convert to / from points use {@link org.apache.poi.util.Units}
  10216. @param height height in EMUs. To convert to / from points use {@link org.apache.poi.util.Units}
  10217. @throws NPOI.Openxml4j.exceptions.InvalidFormatException
  10218. @throws IOException
  10219. </member>
  10220. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetEmbeddedPictures">
  10221. Returns the embedded pictures of the run. These
  10222. are pictures which reference an external,
  10223. embedded picture image such as a .png or .jpg
  10224. </member>
  10225. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetStyle">
  10226. <summary>
  10227. Return this run's style ID. If this run has no style (no run properties or properties without a style), an empty string is returned.
  10228. </summary>
  10229. <returns></returns>
  10230. </member>
  10231. <member name="M:NPOI.XWPF.UserModel.XWPFRun.preserveSpaces(NPOI.OpenXmlFormats.Wordprocessing.CT_Text)">
  10232. Add the xml:spaces="preserve" attribute if the string has leading or trailing white spaces
  10233. @param xs the string to check
  10234. </member>
  10235. <member name="M:NPOI.XWPF.UserModel.XWPFRun.ToString">
  10236. Returns the string version of the text, with tabs and
  10237. carriage returns in place of their xml equivalents.
  10238. </member>
  10239. <member name="T:NPOI.XWPF.UserModel.XWPFSDT">
  10240. Experimental class to offer rudimentary Read-only Processing of
  10241. of StructuredDocumentTags/ContentControl
  10242. WARNING - APIs expected to change rapidly
  10243. </member>
  10244. <member name="T:NPOI.XWPF.UserModel.XWPFSDTCell">
  10245. Experimental class to offer rudimentary Read-only Processing of
  10246. of StructuredDocumentTags/ContentControl that can appear
  10247. in a table row as if a table cell.
  10248. <p/>
  10249. These can contain one or more cells or other SDTs within them.
  10250. <p/>
  10251. WARNING - APIs expected to change rapidly
  10252. </member>
  10253. <member name="T:NPOI.XWPF.UserModel.XWPFSDTContent">
  10254. Experimental class to offer rudimentary Read-only Processing of
  10255. of the contentblock of an SDT/ContentControl.
  10256. WARNING - APIs expected to change rapidly
  10257. </member>
  10258. <member name="T:NPOI.XWPF.UserModel.XWPFSDTContentCell">
  10259. Experimental class to offer rudimentary Read-only Processing of
  10260. of the XWPFSDTCellContent.
  10261. <p/>
  10262. WARNING - APIs expected to change rapidly
  10263. </member>
  10264. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.GetZoomPercent">
  10265. In the zoom tag inside Settings.xml file <br/>
  10266. it Sets the value of zoom
  10267. @return percentage as an integer of zoom level
  10268. </member>
  10269. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.SetZoomPercent(System.Int64)">
  10270. <summary>
  10271. Set zoom. In the zoom tag inside settings.xml file it sets the value of zoom
  10272. </summary>
  10273. <param name="zoomPercent"></param>
  10274. <example>
  10275. sample snippet from Settings.xml
  10276. &lt;w:zoom w:percent="50" /&gt;
  10277. </example>
  10278. </member>
  10279. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.IsEnforcedWith">
  10280. Verifies the documentProtection tag inside settings.xml file <br/>
  10281. if the protection is enforced (w:enforcement="1") <br/>
  10282. <p/>
  10283. <br/>
  10284. sample snippet from settings.xml
  10285. <pre>
  10286. &lt;w:settings ... &gt;
  10287. &lt;w:documentProtection w:edit=&quot;readOnly&quot; w:enforcement=&quot;1&quot;/&gt;
  10288. </pre>
  10289. @return true if documentProtection is enforced with option any
  10290. </member>
  10291. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.IsEnforcedWith(NPOI.OpenXmlFormats.Wordprocessing.ST_DocProtect)">
  10292. Verifies the documentProtection tag inside Settings.xml file <br/>
  10293. if the protection is enforced (w:enforcement="1") <br/>
  10294. and if the kind of protection Equals to passed (STDocProtect.Enum editValue) <br/>
  10295. <br/>
  10296. sample snippet from Settings.xml
  10297. <pre>
  10298. &lt;w:settings ... &gt;
  10299. &lt;w:documentProtection w:edit=&quot;readOnly&quot; w:enforcement=&quot;1&quot;/&gt;
  10300. </pre>
  10301. @return true if documentProtection is enforced with option ReadOnly
  10302. </member>
  10303. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.SetEnforcementEditValue(NPOI.OpenXmlFormats.Wordprocessing.ST_DocProtect)">
  10304. Enforces the protection with the option specified by passed editValue.<br/>
  10305. <br/>
  10306. In the documentProtection tag inside Settings.xml file <br/>
  10307. it Sets the value of enforcement to "1" (w:enforcement="1") <br/>
  10308. and the value of edit to the passed editValue (w:edit="[passed editValue]")<br/>
  10309. <br/>
  10310. sample snippet from Settings.xml
  10311. <pre>
  10312. &lt;w:settings ... &gt;
  10313. &lt;w:documentProtection w:edit=&quot;[passed editValue]&quot; w:enforcement=&quot;1&quot;/&gt;
  10314. </pre>
  10315. </member>
  10316. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.RemoveEnforcement">
  10317. Removes protection enforcement.<br/>
  10318. In the documentProtection tag inside Settings.xml file <br/>
  10319. it Sets the value of enforcement to "0" (w:enforcement="0") <br/>
  10320. </member>
  10321. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.SetUpdateFields">
  10322. Enforces fields update on document open (in Word).
  10323. In the settings.xml file <br/>
  10324. sets the updateSettings value to true (w:updateSettings w:val="true")
  10325. NOTICES:
  10326. <ul>
  10327. <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?"
  10328. (if "Update automatic links at open" is enabled)</li>
  10329. <li>Flag is removed after saving with changes in Word </li>
  10330. </ul>
  10331. </member>
  10332. <member name="P:NPOI.XWPF.UserModel.XWPFSettings.IsTrackRevisions">
  10333. get or set revision tracking
  10334. </member>
  10335. <member name="T:NPOI.XWPF.UserModel.XWPFStyle">
  10336. @author Philipp Epp
  10337. </member>
  10338. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.#ctor(NPOI.OpenXmlFormats.Wordprocessing.CT_Style)">
  10339. constructor
  10340. @param style
  10341. </member>
  10342. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.#ctor(NPOI.OpenXmlFormats.Wordprocessing.CT_Style,NPOI.XWPF.UserModel.XWPFStyles)">
  10343. constructor
  10344. @param style
  10345. @param styles
  10346. </member>
  10347. <member name="P:NPOI.XWPF.UserModel.XWPFStyle.StyleId">
  10348. Get StyleID of the style
  10349. @return styleID StyleID of the style
  10350. </member>
  10351. <member name="P:NPOI.XWPF.UserModel.XWPFStyle.StyleType">
  10352. Get Type of the Style
  10353. @return ctType
  10354. </member>
  10355. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.SetStyle(NPOI.OpenXmlFormats.Wordprocessing.CT_Style)">
  10356. Set style
  10357. @param style
  10358. </member>
  10359. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.GetCTStyle">
  10360. Get ctStyle
  10361. @return ctStyle
  10362. </member>
  10363. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.GetStyles">
  10364. Get styles
  10365. @return styles the styles to which this style belongs
  10366. </member>
  10367. <member name="P:NPOI.XWPF.UserModel.XWPFStyle.LinkStyleID">
  10368. Get StyleID of the linked Style
  10369. </member>
  10370. <member name="P:NPOI.XWPF.UserModel.XWPFStyle.NextStyleID">
  10371. Get StyleID of the next style
  10372. </member>
  10373. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.HasSameName(NPOI.XWPF.UserModel.XWPFStyle)">
  10374. Compares the names of the Styles
  10375. @param compStyle
  10376. </member>
  10377. <member name="T:NPOI.XWPF.UserModel.XWPFStyles">
  10378. Holds details of built-in, default and user styles, which
  10379. apply to tables / paragraphs / lists etc.
  10380. Text within one of those with custom stylings has the style
  10381. information stored in the {@link XWPFRun}
  10382. </member>
  10383. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  10384. Construct XWPFStyles from a package part
  10385. @param part the package part holding the data of the styles,
  10386. @param rel the package relationship of type "http://schemas.Openxmlformats.org/officeDocument/2006/relationships/styles"
  10387. </member>
  10388. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.#ctor">
  10389. Construct XWPFStyles from scratch for a new document.
  10390. </member>
  10391. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.OnDocumentRead">
  10392. Read document
  10393. </member>
  10394. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.SetStyles(NPOI.OpenXmlFormats.Wordprocessing.CT_Styles)">
  10395. Sets the ctStyles
  10396. @param styles
  10397. </member>
  10398. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.StyleExist(System.String)">
  10399. Checks whether style with styleID exist
  10400. @param styleID styleID of the Style in the style-Document
  10401. @return true if style exist, false if style not exist
  10402. </member>
  10403. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.AddStyle(NPOI.XWPF.UserModel.XWPFStyle)">
  10404. add a style to the document
  10405. @param style
  10406. @throws IOException
  10407. </member>
  10408. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.GetStyle(System.String)">
  10409. get style by a styleID
  10410. @param styleID styleID of the searched style
  10411. @return style
  10412. </member>
  10413. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.GetStyleWithName(System.String)">
  10414. get the style with the specified name, if any.
  10415. @param styleName The name of the style to get, e.g., "Heading 1"
  10416. @return style
  10417. </member>
  10418. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.GetUsedStyleList(NPOI.XWPF.UserModel.XWPFStyle)">
  10419. Get the styles which are related to the parameter style and their relatives
  10420. this method can be used to copy all styles from one document to another document
  10421. @param style
  10422. @return a list of all styles which were used by this method
  10423. </member>
  10424. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.GetUsedStyleList(NPOI.XWPF.UserModel.XWPFStyle,System.Collections.Generic.List{NPOI.XWPF.UserModel.XWPFStyle})">
  10425. Get the styles which are related to parameter style
  10426. @param style
  10427. @return all Styles of the parameterList
  10428. </member>
  10429. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.SetSpellingLanguage(System.String)">
  10430. Sets the default spelling language on ctStyles DocDefaults parameter
  10431. @param strSpellingLanguage
  10432. </member>
  10433. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.SetEastAsia(System.String)">
  10434. Sets the default East Asia spelling language on ctStyles DocDefaults parameter
  10435. @param strEastAsia
  10436. </member>
  10437. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.SetDefaultFonts(NPOI.OpenXmlFormats.Wordprocessing.CT_Fonts)">
  10438. Sets the default font on ctStyles DocDefaults parameter
  10439. TODO Replace this with specific Setters for each type, possibly
  10440. on XWPFDefaultRunStyle
  10441. </member>
  10442. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.GetStyleWithSameName(NPOI.XWPF.UserModel.XWPFStyle)">
  10443. Get the style with the same name
  10444. if this style is not existing, return null
  10445. </member>
  10446. <member name="P:NPOI.XWPF.UserModel.XWPFStyles.DefaultRunStyle">
  10447. Get the default style which applies text runs in the document
  10448. </member>
  10449. <member name="P:NPOI.XWPF.UserModel.XWPFStyles.DefaultParagraphStyle">
  10450. Get the default paragraph style which applies to the document
  10451. </member>
  10452. <member name="P:NPOI.XWPF.UserModel.XWPFStyles.LatentStyles">
  10453. Get the definition of all the Latent Styles
  10454. </member>
  10455. <member name="T:NPOI.XWPF.UserModel.XWPFTable">
  10456. <p>Sketch of XWPFTable class. Only table's text is being hold.</p>
  10457. <p>Specifies the contents of a table present in the document. A table is a set
  10458. of paragraphs (and other block-level content) arranged in rows and columns.</p>
  10459. </member>
  10460. <member name="M:NPOI.XWPF.UserModel.XWPFTable.GetCTTbl">
  10461. @return ctTbl object
  10462. </member>
  10463. <!-- Badly formed XML comment ignored for member "P:NPOI.XWPF.UserModel.XWPFTable.Text" -->
  10464. <member name="M:NPOI.XWPF.UserModel.XWPFTable.AddNewCol">
  10465. add a new column for each row in this table
  10466. </member>
  10467. <member name="M:NPOI.XWPF.UserModel.XWPFTable.CreateRow">
  10468. create a new XWPFTableRow object with as many cells as the number of columns defined in that moment
  10469. @return tableRow
  10470. </member>
  10471. <member name="M:NPOI.XWPF.UserModel.XWPFTable.GetRow(System.Int32)">
  10472. @param pos - index of the row
  10473. @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
  10474. </member>
  10475. <member name="P:NPOI.XWPF.UserModel.XWPFTable.Width">
  10476. @return width value
  10477. </member>
  10478. <member name="P:NPOI.XWPF.UserModel.XWPFTable.NumberOfRows">
  10479. @return number of rows in table
  10480. </member>
  10481. <member name="P:NPOI.XWPF.UserModel.XWPFTable.StyleID">
  10482. Get the StyleID of the table
  10483. @return style-ID of the table
  10484. </member>
  10485. <member name="M:NPOI.XWPF.UserModel.XWPFTable.AddRow(NPOI.XWPF.UserModel.XWPFTableRow)">
  10486. add a new Row to the table
  10487. @param row the row which should be Added
  10488. </member>
  10489. <member name="M:NPOI.XWPF.UserModel.XWPFTable.AddRow(NPOI.XWPF.UserModel.XWPFTableRow,System.Int32)">
  10490. add a new Row to the table
  10491. at position pos
  10492. @param row the row which should be Added
  10493. </member>
  10494. <member name="M:NPOI.XWPF.UserModel.XWPFTable.InsertNewTableRow(System.Int32)">
  10495. inserts a new tablerow
  10496. @param pos
  10497. @return the inserted row
  10498. </member>
  10499. <member name="M:NPOI.XWPF.UserModel.XWPFTable.RemoveRow(System.Int32)">
  10500. Remove a row at position pos from the table
  10501. @param pos position the Row in the Table
  10502. </member>
  10503. <member name="P:NPOI.XWPF.UserModel.XWPFTable.ElementType">
  10504. returns the type of the BodyElement Table
  10505. @see NPOI.XWPF.UserModel.IBodyElement#getElementType()
  10506. </member>
  10507. <member name="P:NPOI.XWPF.UserModel.XWPFTable.Part">
  10508. returns the part of the bodyElement
  10509. @see NPOI.XWPF.UserModel.IBody#getPart()
  10510. </member>
  10511. <member name="P:NPOI.XWPF.UserModel.XWPFTable.PartType">
  10512. returns the partType of the bodyPart which owns the bodyElement
  10513. @see NPOI.XWPF.UserModel.IBody#getPartType()
  10514. </member>
  10515. <member name="M:NPOI.XWPF.UserModel.XWPFTable.GetRow(NPOI.OpenXmlFormats.Wordprocessing.CT_Row)">
  10516. returns the XWPFRow which belongs to the CTRow row
  10517. if this row is not existing in the table null will be returned
  10518. </member>
  10519. <member name="T:NPOI.XWPF.UserModel.XWPFTableCell">
  10520. Represents a Cell within a {@link XWPFTable}. The
  10521. Cell is the thing that holds the actual content (paragraphs etc)
  10522. </member>
  10523. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.#ctor(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc,NPOI.XWPF.UserModel.XWPFTableRow,NPOI.XWPF.UserModel.IBody)">
  10524. If a table cell does not include at least one block-level element, then this document shall be considered corrupt
  10525. </member>
  10526. <member name="P:NPOI.XWPF.UserModel.XWPFTableCell.BodyElements">
  10527. returns an Iterator with paragraphs and tables
  10528. @see NPOI.XWPF.UserModel.IBody#getBodyElements()
  10529. </member>
  10530. <member name="P:NPOI.XWPF.UserModel.XWPFTableCell.Paragraphs">
  10531. returns a list of paragraphs
  10532. </member>
  10533. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.AddParagraph">
  10534. Add a Paragraph to this Table Cell
  10535. @return The paragraph which was Added
  10536. </member>
  10537. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.AddParagraph(NPOI.XWPF.UserModel.XWPFParagraph)">
  10538. add a Paragraph to this TableCell
  10539. @param p the paragaph which has to be Added
  10540. </member>
  10541. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.RemoveParagraph(System.Int32)">
  10542. Removes a paragraph of this tablecell
  10543. @param pos
  10544. </member>
  10545. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  10546. if there is a corresponding {@link XWPFParagraph} of the parameter ctTable in the paragraphList of this table
  10547. the method will return this paragraph
  10548. if there is no corresponding {@link XWPFParagraph} the method will return null
  10549. @param p is instance of CTP and is searching for an XWPFParagraph
  10550. @return null if there is no XWPFParagraph with an corresponding CTPparagraph in the paragraphList of this table
  10551. XWPFParagraph with the correspondig CTP p
  10552. </member>
  10553. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.SetBorderBottom(NPOI.XWPF.UserModel.XWPFTable.XWPFBorderType,System.Int32,System.Int32,System.String)">
  10554. <summary>
  10555. Add bottom border to cell
  10556. </summary>
  10557. <param name="type">Border Style</param>
  10558. <param name="size">Border Width</param>
  10559. <param name="space">Border Spacing Measurement</param>
  10560. <param name="rgbColor">Border Color</param>
  10561. </member>
  10562. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.SetBorderTop(NPOI.XWPF.UserModel.XWPFTable.XWPFBorderType,System.Int32,System.Int32,System.String)">
  10563. <summary>
  10564. Add top border to cell
  10565. </summary>
  10566. <param name="type">Border Style</param>
  10567. <param name="size">Border Width</param>
  10568. <param name="space">Border Spacing Measurement</param>
  10569. <param name="rgbColor">Border Color</param>
  10570. </member>
  10571. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.SetBorderLeft(NPOI.XWPF.UserModel.XWPFTable.XWPFBorderType,System.Int32,System.Int32,System.String)">
  10572. <summary>
  10573. Add left border to cell
  10574. </summary>
  10575. <param name="type">Border Style</param>
  10576. <param name="size">Border Width</param>
  10577. <param name="space">Border Spacing Measurement</param>
  10578. <param name="rgbColor">Border Color</param>
  10579. </member>
  10580. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.SetBorderRight(NPOI.XWPF.UserModel.XWPFTable.XWPFBorderType,System.Int32,System.Int32,System.String)">
  10581. <summary>
  10582. Add right border to cell
  10583. </summary>
  10584. <param name="type">Border Style</param>
  10585. <param name="size">Border Width</param>
  10586. <param name="space"></param>
  10587. <param name="rgbColor">Border Color</param>
  10588. </member>
  10589. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.CreateBorder(NPOI.XWPF.UserModel.XWPFTable.XWPFBorderType,System.Int32,System.Int32,System.String)">
  10590. <summary>
  10591. Creates border with parameters
  10592. </summary>
  10593. <param name="type">Border Style</param>
  10594. <param name="size">Border Width</param>
  10595. <param name="space">Border Spacing Measurement</param>
  10596. <param name="rgbColor">Border Color</param>
  10597. <returns>CT_Border object</returns>
  10598. </member>
  10599. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.SetColor(System.String)">
  10600. Set cell color. This sets some associated values; for finer control
  10601. you may want to access these elements individually.
  10602. @param rgbStr - the desired cell color, in the hex form "RRGGBB".
  10603. </member>
  10604. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetColor">
  10605. Get cell color. Note that this method only returns the "fill" value.
  10606. @return RGB string of cell color
  10607. </member>
  10608. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.SetVerticalAlignment(NPOI.XWPF.UserModel.XWPFTableCell.XWPFVertAlign)">
  10609. Set the vertical alignment of the cell.
  10610. @param vAlign - the desired alignment enum value
  10611. </member>
  10612. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetVerticalAlignment">
  10613. Get the vertical alignment of the cell.
  10614. @return the cell alignment enum value or null if no vertical alignment is set
  10615. </member>
  10616. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.InsertNewParagraph(System.Xml.XmlDocument)">
  10617. add a new paragraph at position of the cursor
  10618. @param cursor
  10619. @return the inserted paragraph
  10620. </member>
  10621. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.IsCursorInTableCell(System.Xml.XmlDocument)">
  10622. verifies that cursor is on the right position
  10623. </member>
  10624. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetParagraphArray(System.Int32)">
  10625. @see NPOI.XWPF.UserModel.IBody#getParagraphArray(int)
  10626. </member>
  10627. <member name="P:NPOI.XWPF.UserModel.XWPFTableCell.Part">
  10628. Get the to which the TableCell belongs
  10629. @see NPOI.XWPF.UserModel.IBody#getPart()
  10630. </member>
  10631. <member name="P:NPOI.XWPF.UserModel.XWPFTableCell.PartType">
  10632. @see NPOI.XWPF.UserModel.IBody#getPartType()
  10633. </member>
  10634. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetTable(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  10635. Get a table by its CTTbl-Object
  10636. @see NPOI.XWPF.UserModel.IBody#getTable(org.Openxmlformats.schemas.wordProcessingml.x2006.main.CTTbl)
  10637. </member>
  10638. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetTableArray(System.Int32)">
  10639. @see NPOI.XWPF.UserModel.IBody#getTableArray(int)
  10640. </member>
  10641. <member name="P:NPOI.XWPF.UserModel.XWPFTableCell.Tables">
  10642. @see NPOI.XWPF.UserModel.IBody#getTables()
  10643. </member>
  10644. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.InsertTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  10645. inserts an existing XWPFTable to the arrays bodyElements and tables
  10646. @see NPOI.XWPF.UserModel.IBody#insertTable(int, NPOI.XWPF.UserModel.XWPFTable)
  10647. </member>
  10648. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetTextRecursively">
  10649. extracts all text recursively through embedded tables and embedded SDTs
  10650. </member>
  10651. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  10652. Get the TableCell which belongs to the TableCell
  10653. </member>
  10654. <member name="T:NPOI.XWPF.UserModel.XWPFTableRow">
  10655. A row within an {@link XWPFTable}. Rows mostly just have
  10656. sizings and stylings, the interesting content lives inside
  10657. the child {@link XWPFTableCell}s
  10658. </member>
  10659. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.CreateCell">
  10660. create a new XWPFTableCell and add it to the tableCell-list of this tableRow
  10661. @return the newly Created XWPFTableCell
  10662. </member>
  10663. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.AddNewTableCell">
  10664. Adds a new TableCell at the end of this tableRow
  10665. </member>
  10666. <member name="P:NPOI.XWPF.UserModel.XWPFTableRow.Height">
  10667. This element specifies the height of the current table row within the
  10668. current table. This height shall be used to determine the resulting
  10669. height of the table row, which may be absolute or relative (depending on
  10670. its attribute values). If omitted, then the table row shall automatically
  10671. resize its height to the height required by its contents (the equivalent
  10672. of an hRule value of auto).
  10673. @return height
  10674. </member>
  10675. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.GetTableICells">
  10676. create and return a list of all XWPFTableCell
  10677. who belongs to this row
  10678. @return a list of {@link XWPFTableCell}
  10679. </member>
  10680. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.GetTableCells">
  10681. create and return a list of all XWPFTableCell
  10682. who belongs to this row
  10683. @return a list of {@link XWPFTableCell}
  10684. </member>
  10685. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  10686. returns the XWPFTableCell which belongs to the CTTC cell
  10687. if there is no XWPFTableCell which belongs to the parameter CTTc cell null will be returned
  10688. </member>
  10689. <member name="P:NPOI.XWPF.UserModel.XWPFTableRow.IsCantSplitRow">
  10690. Return true if the "can't split row" value is true. The logic for this
  10691. attribute is a little unusual: a TRUE value means DON'T allow rows to
  10692. split, FALSE means allow rows to split.
  10693. @return true if rows can't be split, false otherwise.
  10694. </member>
  10695. <member name="P:NPOI.XWPF.UserModel.XWPFTableRow.IsRepeatHeader">
  10696. Return true if a table's header row should be repeated at the top of a
  10697. table split across pages.
  10698. @return true if table's header row should be repeated at the top of each
  10699. page of table, false otherwise.
  10700. </member>
  10701. <member name="M:NPOI.XWPF.Usermodel.MathContainer.CreateAcc">
  10702. <summary>
  10703. Create Accent
  10704. </summary>
  10705. <returns></returns>
  10706. </member>
  10707. <member name="M:NPOI.XWPF.Usermodel.MathContainer.CreateNary">
  10708. <summary>
  10709. Create n-ary Operator Object
  10710. </summary>
  10711. <returns></returns>
  10712. </member>
  10713. <member name="M:NPOI.XWPF.Usermodel.MathContainer.CreateSSub">
  10714. <summary>
  10715. Subscript Object
  10716. </summary>
  10717. <returns></returns>
  10718. </member>
  10719. <member name="M:NPOI.XWPF.Usermodel.MathContainer.CreateSSup">
  10720. <summary>
  10721. Superscript Object
  10722. </summary>
  10723. <returns></returns>
  10724. </member>
  10725. <member name="M:NPOI.XWPF.Usermodel.MathContainer.CreateF">
  10726. <summary>
  10727. Fraction Object
  10728. </summary>
  10729. <returns></returns>
  10730. </member>
  10731. <member name="M:NPOI.XWPF.Usermodel.MathContainer.CreateRad">
  10732. <summary>
  10733. Radical Object
  10734. </summary>
  10735. <returns></returns>
  10736. </member>
  10737. <member name="T:NPOI.XWPF.Usermodel.XWPFAcc">
  10738. <summary>
  10739. Accent
  10740. This element specifies the accent function, consisting of a base
  10741. and a combining diacritical mark. If accPr is
  10742. omitted, the default accent is U+0302 (COMBINING CIRCUMFLEX ACCENT).
  10743. </summary>
  10744. </member>
  10745. <member name="P:NPOI.XWPF.Usermodel.XWPFAcc.AccPr">
  10746. <summary>
  10747. Single char or UTF, like: &#771;
  10748. </summary>
  10749. </member>
  10750. <member name="P:NPOI.XWPF.Usermodel.XWPFAcc.Element">
  10751. <summary>
  10752. This tag, which is an abbreviation for “element”, serves several functions (18 total) including that of the base
  10753. argument of a mathematical object or function, the elements in an array, and the elements in boxes.If all
  10754. subelements are omitted, this element specifies the presence of an empty argument.
  10755. </summary>
  10756. </member>
  10757. <member name="T:NPOI.XWPF.Usermodel.XWPFRad">
  10758. <summary>
  10759. Radical Object
  10760. This element specifies the radical object, consisting of a radical, a base e, and an optional degree deg. [Example:
  10761. Example of rad are √𝑥
  10762. </summary>
  10763. </member>
  10764. <member name="P:NPOI.XWPF.Usermodel.XWPFRad.Degree">
  10765. <summary>
  10766. This element specifies the degree in the mathematical radical. This element is optional. When omitted, the
  10767. square root function, as in √𝑥, is assumed.
  10768. </summary>
  10769. </member>
  10770. <member name="P:NPOI.XWPF.Usermodel.XWPFRad.Element">
  10771. <summary>
  10772. Radical expression element.
  10773. </summary>
  10774. </member>
  10775. <member name="T:NPOI.XWPF.Usermodel.XWPFF">
  10776. <summary>
  10777. Fraction Object
  10778. This element specifies the fraction object, consisting of a numerator and denominator separated by a fraction
  10779. bar.The fraction bar can be horizontal or diagonal, depending on the fraction properties.The fraction object is
  10780. also used to represent the stack function, which places one element above another, with no fraction bar.
  10781. </summary>
  10782. </member>
  10783. <member name="P:NPOI.XWPF.Usermodel.XWPFF.FractionType">
  10784. <summary>
  10785. This element specifies the properties of the fraction object f. Properties of the Fraction object include the type
  10786. or style of the fraction.The fraction bar can be horizontal or diagonal, depending on the fraction properties.The
  10787. fraction object is also used to represent the stack function, which places one element above another, with no
  10788. fraction bar.
  10789. </summary>
  10790. </member>
  10791. <member name="P:NPOI.XWPF.Usermodel.XWPFF.Numerator">
  10792. <summary>
  10793. This element specifies the numerator of the Fraction object f
  10794. </summary>
  10795. </member>
  10796. <member name="P:NPOI.XWPF.Usermodel.XWPFF.Denominator">
  10797. <summary>
  10798. This element specifies the denominator of a fraction
  10799. </summary>
  10800. </member>
  10801. <member name="T:NPOI.XWPF.Usermodel.XWPFNary">
  10802. <summary>
  10803. n-ary Operator Object
  10804. This element specifies an n-ary object, consisting of an n-ary object, a base (or operand), and optional upper and
  10805. lower limits
  10806. </summary>
  10807. </member>
  10808. <member name="P:NPOI.XWPF.Usermodel.XWPFNary.Element">
  10809. <summary>
  10810. This tag, which is an abbreviation for “element”, serves several functions (18 total) including that of the base
  10811. argument of a mathematical object or function, the elements in an array, and the elements in boxes.If all
  10812. subelements are omitted, this element specifies the presence of an empty argument.
  10813. </summary>
  10814. </member>
  10815. <member name="P:NPOI.XWPF.Usermodel.XWPFNary.Subscript">
  10816. <summary>
  10817. This element specifies the subscript of the Pre-Sub-Superscript object sPre
  10818. </summary>
  10819. </member>
  10820. <member name="P:NPOI.XWPF.Usermodel.XWPFNary.Superscript">
  10821. <summary>
  10822. This element specifies the superscript of the superscript object sSup.
  10823. </summary>
  10824. </member>
  10825. <member name="P:NPOI.XWPF.Usermodel.XWPFNary.NaryPr">
  10826. <summary>
  10827. Get Nary symbol
  10828. </summary>
  10829. </member>
  10830. <member name="M:NPOI.XWPF.Usermodel.XWPFNary.SetSumm">
  10831. <summary>
  10832. Sets ∑ char
  10833. </summary>
  10834. </member>
  10835. <member name="M:NPOI.XWPF.Usermodel.XWPFNary.SetUnion">
  10836. <summary>
  10837. Sets ⋃ char
  10838. </summary>
  10839. </member>
  10840. <member name="M:NPOI.XWPF.Usermodel.XWPFNary.SetIntegral">
  10841. <summary>
  10842. Sets ∫ char
  10843. </summary>
  10844. </member>
  10845. <member name="M:NPOI.XWPF.Usermodel.XWPFNary.SetAnd">
  10846. <summary>
  10847. Sets ⋀ char
  10848. </summary>
  10849. </member>
  10850. <member name="M:NPOI.XWPF.Usermodel.XWPFSharedRun.IsCTOnOff(NPOI.OpenXmlFormats.Wordprocessing.CT_OnOff)">
  10851. For isBold, isItalic etc
  10852. </member>
  10853. <member name="M:NPOI.XWPF.Usermodel.XWPFSharedRun.SetFontFamily(System.String,NPOI.XWPF.UserModel.FontCharRange)">
  10854. <summary>
  10855. Specifies the fonts which shall be used to display the text contents of
  10856. this run.The default handling for fcr == null is to overwrite the
  10857. ascii font char range with the given font family and also set all not
  10858. specified font ranges
  10859. </summary>
  10860. <param name="fontFamily">fontFamily</param>
  10861. <param name="fcr">FontCharRange or null for default handling</param>
  10862. </member>
  10863. <member name="M:NPOI.XWPF.Usermodel.XWPFSharedRun.GetFontFamily(NPOI.XWPF.UserModel.FontCharRange)">
  10864. <summary>
  10865. Gets the font family for the specified font char range.
  10866. If fcr is null, the font char range "ascii" is used
  10867. Please use "Cambria Math"(set as default) font otherwise MS Word
  10868. don't open file, LibreOffice Writer open it normaly.
  10869. I think this is MS Word bug, because this is not standart.
  10870. </summary>
  10871. <param name="fcr">the font char range, defaults to "ansi"</param>
  10872. <returns>a string representing the font famil</returns>
  10873. </member>
  10874. <member name="M:NPOI.XWPF.Usermodel.XWPFSharedRun.SetText(System.String)">
  10875. <summary>
  10876. Sets the text of this text run
  10877. </summary>
  10878. <param name="value">the literal text which shall be displayed in the document</param>
  10879. </member>
  10880. <member name="M:NPOI.XWPF.Usermodel.XWPFSharedRun.SetText(System.String,System.Int32)">
  10881. <summary>
  10882. Sets the text of this text run.in the
  10883. </summary>
  10884. <param name="value">the literal text which shall be displayed in the document</param>
  10885. <param name="pos">position in the text array (NB: 0 based)</param>
  10886. </member>
  10887. <member name="M:NPOI.XWPF.Usermodel.XWPFSharedRun.preserveSpaces(NPOI.OpenXmlFormats.Shared.CT_Text1)">
  10888. <summary>
  10889. Add the xml:spaces="preserve" attribute if the string has leading or trailing white spaces
  10890. </summary>
  10891. <param name="xs">the string to check</param>
  10892. </member>
  10893. <member name="T:NPOI.XWPF.Usermodel.XWPFSSup">
  10894. <summary>
  10895. Subscript Object
  10896. his element specifies the subscript object sSub, which consists of a base e and a reduced-size scr placed below
  10897. and to the right, as in Xn
  10898. </summary>
  10899. </member>
  10900. <member name="P:NPOI.XWPF.Usermodel.XWPFSSup.Element">
  10901. <summary>
  10902. This tag, which is an abbreviation for “element”, serves several functions (18 total) including that of the base
  10903. argument of a mathematical object or function, the elements in an array, and the elements in boxes.If all
  10904. subelements are omitted, this element specifies the presence of an empty argument.
  10905. </summary>
  10906. </member>
  10907. <member name="P:NPOI.XWPF.Usermodel.XWPFSSup.Superscript">
  10908. <summary>
  10909. This element specifies the Superscript of the Pre-Sub-Superscript object sPre
  10910. </summary>
  10911. </member>
  10912. <member name="T:NPOI.XWPF.Usermodel.XWPFSSub">
  10913. <summary>
  10914. Subscript Object
  10915. his element specifies the subscript object sSub, which consists of a base e and a reduced-size scr placed below
  10916. and to the right, as in Xn
  10917. </summary>
  10918. </member>
  10919. <member name="P:NPOI.XWPF.Usermodel.XWPFSSub.Element">
  10920. <summary>
  10921. This tag, which is an abbreviation for “element”, serves several functions (18 total) including that of the base
  10922. argument of a mathematical object or function, the elements in an array, and the elements in boxes.If all
  10923. subelements are omitted, this element specifies the presence of an empty argument.
  10924. </summary>
  10925. </member>
  10926. <member name="P:NPOI.XWPF.Usermodel.XWPFSSub.Subscript">
  10927. <summary>
  10928. This element specifies the subscript of the Pre-Sub-Superscript object sPre
  10929. </summary>
  10930. </member>
  10931. <member name="M:NPOI.OOXML.XWPF.Util.DocumentStylesBuilder.AddDefaultStyle">
  10932. <summary>
  10933. Sets default font, size for text in the document.
  10934. </summary>
  10935. </member>
  10936. <!-- Badly formed XML comment ignored for member "M:NPOI.OOXML.XWPF.Util.DocumentStylesBuilder.BuildStylesForTOC(NPOI.XWPF.UserModel.XWPFDocument)" -->
  10937. </members>
  10938. </doc>