NPOI.OOXML.xml 642 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589
  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. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.signaturePolicyService">
  273. the optional signature policy service used for XAdES-EPES.
  274. </member>
  275. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.tspService">
  276. the time-stamp service used for XAdES-T and XAdES-X.
  277. </member>
  278. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.tspUrl">
  279. timestamp service provider URL
  280. </member>
  281. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.tspDigestAlgo">
  282. if not defined, it's the same as the main digest
  283. </member>
  284. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.tspRequestPolicy">
  285. the optional TSP request policy OID.
  286. </member>
  287. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.revocationDataService">
  288. the optional revocation data service used for XAdES-C and XAdES-X-L.
  289. When <code>null</code> the signature will be limited to XAdES-T only.
  290. </member>
  291. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.xadesDigestAlgo">
  292. if not defined, it's the same as the main digest
  293. </member>
  294. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.xadesIssuerNameNoReverseOrder">
  295. Work-around for Office 2010 IssuerName encoding.
  296. </member>
  297. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.packageSignatureId">
  298. The signature Id attribute value used to create the XML signature. A
  299. <code>null</code> value will trigger an automatically generated signature Id.
  300. </member>
  301. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.signatureDescription">
  302. Gives back the human-readable description of what the citizen will be
  303. signing. The default value is "Office OpenXML Document".
  304. </member>
  305. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.signatureMarshalListener">
  306. The process of signing includes the marshalling of xml structures.
  307. This also includes the canonicalization. Currently this leads to problems
  308. with certain namespaces, so this EventListener is used to interfere
  309. with the marshalling Process.
  310. </member>
  311. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.namespacePrefixes">
  312. Map of namespace uris to prefix
  313. If a mapping is specified, the corresponding elements will be prefixed
  314. </member>
  315. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.Init(System.Boolean)">
  316. Inits and Checks the config object.
  317. If not Set previously, complex configuration properties also Get
  318. Created/initialized via this Initialization call.
  319. @param onlyValidation if true, only a subset of the properties
  320. is Initialized, which are necessary for validation. If false,
  321. also the other properties needed for signing are been taken care of
  322. </member>
  323. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.AddSignatureFacet(NPOI.POIFS.Crypt.Dsig.Facets.SignatureFacet)">
  324. @param signatureFacet the signature facet is Appended to facet list
  325. </member>
  326. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetSignatureFacets">
  327. @return the list of facets, may be empty when the config object is not Initialized
  328. </member>
  329. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetSignatureFacets(System.Collections.Generic.List{NPOI.POIFS.Crypt.Dsig.Facets.SignatureFacet})">
  330. @param signatureFacets the new list of facets
  331. </member>
  332. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetDigestAlgo">
  333. @return the main digest algorithm, defaults to sha-1
  334. </member>
  335. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetDigestAlgo(NPOI.POIFS.Crypt.HashAlgorithm)">
  336. @param digestAlgo the main digest algorithm
  337. </member>
  338. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetOpcPackage">
  339. @return the opc package to be used by this thread, stored as thread-local
  340. </member>
  341. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetOpcPackage(NPOI.OpenXml4Net.OPC.OPCPackage)">
  342. @param opcPackage the opc package to be handled by this thread, stored as thread-local
  343. </member>
  344. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetKey">
  345. @return the private key
  346. </member>
  347. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetKey(NPOI.POIFS.Crypt.IPrivateKey)">
  348. @param key the private key
  349. </member>
  350. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetSigningCertificateChain">
  351. @return the certificate chain, index 0 is usually the certificate matching
  352. the private key
  353. </member>
  354. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetSigningCertificateChain(System.Collections.Generic.List{System.Security.Cryptography.X509Certificates.X509Certificate})">
  355. @param signingCertificateChain the certificate chain, index 0 should be
  356. the certificate matching the private key
  357. </member>
  358. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetExecutionTime">
  359. @return the time at which the document is signed, also used for the timestamp service.
  360. defaults to now
  361. </member>
  362. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetExecutionTime(System.DateTime)">
  363. @param executionTime Sets the time at which the document ought to be signed
  364. </member>
  365. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetSignaturePolicyService">
  366. @return the service to be used for XAdES-EPES properties. There's no default implementation
  367. </member>
  368. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetSignaturePolicyService(NPOI.POIFS.Crypt.Dsig.Services.ISignaturePolicyService)">
  369. @param signaturePolicyService the service to be used for XAdES-EPES properties
  370. </member>
  371. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetSignatureDescription">
  372. @return Gives back the human-readable description of what the citizen
  373. will be signing. The default value is "Office OpenXML Document".
  374. </member>
  375. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetSignatureDescription(System.String)">
  376. @param signatureDescription the human-readable description of
  377. what the citizen will be signing.
  378. </member>
  379. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetCanonicalizationMethod">
  380. @return the default canonicalization method, defaults to INCLUSIVE
  381. </member>
  382. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetCanonicalizationMethod(System.String)">
  383. @param canonicalizationMethod the default canonicalization method
  384. </member>
  385. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetPackageSignatureId">
  386. @return The signature Id attribute value used to create the XML signature.
  387. Defaults to "idPackageSignature"
  388. </member>
  389. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetPackageSignatureId(System.String)">
  390. @param packageSignatureId The signature Id attribute value used to create the XML signature.
  391. A <code>null</code> value will trigger an automatically generated signature Id.
  392. </member>
  393. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetTspUrl">
  394. @return the url of the timestamp provider (TSP)
  395. </member>
  396. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetTspUrl(System.String)">
  397. @param tspUrl the url of the timestamp provider (TSP)
  398. </member>
  399. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.IsTspOldProtocol">
  400. @return if true, uses timestamp-request/response mimetype,
  401. if false, timestamp-query/reply mimetype
  402. </member>
  403. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetTspOldProtocol(System.Boolean)">
  404. @param tspOldProtocol defines the timestamp-protocol mimetype
  405. @see #isTspOldProtocol
  406. </member>
  407. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetTspDigestAlgo">
  408. @return the hash algorithm to be used for the timestamp entry.
  409. Defaults to the hash algorithm of the main entry
  410. </member>
  411. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetTspDigestAlgo(NPOI.POIFS.Crypt.HashAlgorithm)">
  412. @param tspDigestAlgo the algorithm to be used for the timestamp entry.
  413. if <code>null</code>, the hash algorithm of the main entry
  414. </member>
  415. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetProxyUrl">
  416. @return the proxy url to be used for all communications.
  417. Currently this affects the timestamp service
  418. </member>
  419. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetProxyUrl(System.String)">
  420. @param proxyUrl the proxy url to be used for all communications.
  421. Currently this affects the timestamp service
  422. </member>
  423. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetTspService">
  424. @return the timestamp service. Defaults to {@link TSPTimeStampService}
  425. </member>
  426. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetTspService(NPOI.POIFS.Crypt.Dsig.Services.ITimeStampService)">
  427. @param tspService the timestamp service
  428. </member>
  429. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetTspUser">
  430. @return the user id for the timestamp service - currently only basic authorization is supported
  431. </member>
  432. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetTspUser(System.String)">
  433. @param tspUser the user id for the timestamp service - currently only basic authorization is supported
  434. </member>
  435. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetTspPass">
  436. @return the password for the timestamp service
  437. </member>
  438. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetTspPass(System.String)">
  439. @param tspPass the password for the timestamp service
  440. </member>
  441. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetTspValidator">
  442. @return the validator for the timestamp service (certificate)
  443. </member>
  444. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetTspValidator(NPOI.POIFS.Crypt.Dsig.Services.ITimeStampServiceValidator)">
  445. @param tspValidator the validator for the timestamp service (certificate)
  446. </member>
  447. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetRevocationDataService">
  448. @return the optional revocation data service used for XAdES-C and XAdES-X-L.
  449. When <code>null</code> the signature will be limited to XAdES-T only.
  450. </member>
  451. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetRevocationDataService(NPOI.POIFS.Crypt.Dsig.Services.IRevocationDataService)">
  452. @param revocationDataService the optional revocation data service used for XAdES-C and XAdES-X-L.
  453. When <code>null</code> the signature will be limited to XAdES-T only.
  454. </member>
  455. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetXadesDigestAlgo">
  456. @return hash algorithm used for XAdES. Defaults to the {@link #getDigestAlgo()}
  457. </member>
  458. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetXadesDigestAlgo(NPOI.POIFS.Crypt.HashAlgorithm)">
  459. @param xadesDigestAlgo hash algorithm used for XAdES.
  460. When <code>null</code>, defaults to {@link #getDigestAlgo()}
  461. </member>
  462. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetUserAgent">
  463. @return the user agent used for http communication (e.g. to the TSP)
  464. </member>
  465. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetUserAgent(System.String)">
  466. @param userAgent the user agent used for http communication (e.g. to the TSP)
  467. </member>
  468. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetTspRequestPolicy">
  469. @return the asn.1 object id for the tsp request policy.
  470. Defaults to <code>1.3.6.1.4.1.13762.3</code>
  471. </member>
  472. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetTspRequestPolicy(System.String)">
  473. @param tspRequestPolicy the asn.1 object id for the tsp request policy.
  474. </member>
  475. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.IsIncludeEntireCertificateChain">
  476. @return true, if the whole certificate chain is included in the signature.
  477. When false, only the signer cert will be included
  478. </member>
  479. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetIncludeEntireCertificateChain(System.Boolean)">
  480. @param includeEntireCertificateChain if true, include the whole certificate chain.
  481. If false, only include the signer cert
  482. </member>
  483. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.IsIncludeIssuerSerial">
  484. @return if true, issuer serial number is included
  485. </member>
  486. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetIncludeIssuerSerial(System.Boolean)">
  487. @param includeIssuerSerial if true, issuer serial number is included
  488. </member>
  489. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.IsIncludeKeyValue">
  490. @return if true, the key value of the public key (certificate) is included
  491. </member>
  492. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetIncludeKeyValue(System.Boolean)">
  493. @param includeKeyValue if true, the key value of the public key (certificate) is included
  494. </member>
  495. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetXadesRole">
  496. @return the xades role element. If <code>null</code> the claimed role element is omitted.
  497. Defaults to <code>null</code>
  498. </member>
  499. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetXadesRole(System.String)">
  500. @param xadesRole the xades role element. If <code>null</code> the claimed role element is omitted.
  501. </member>
  502. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetXadesSignatureId">
  503. @return the Id for the XAdES SignedProperties element.
  504. Defaults to <code>idSignedProperties</code>
  505. </member>
  506. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetXadesSignatureId(System.String)">
  507. @param xadesSignatureId the Id for the XAdES SignedProperties element.
  508. When <code>null</code> defaults to <code>idSignedProperties</code>
  509. </member>
  510. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.IsXadesSignaturePolicyImplied">
  511. @return when true, include the policy-implied block.
  512. Defaults to <code>true</code>
  513. </member>
  514. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetXadesSignaturePolicyImplied(System.Boolean)">
  515. @param xadesSignaturePolicyImplied when true, include the policy-implied block
  516. </member>
  517. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.IsXadesIssuerNameNoReverseOrder">
  518. Make sure the DN is encoded using the same order as present
  519. within the certificate. This is an Office2010 work-around.
  520. Should be reverted back.
  521. XXX: not correct according to RFC 4514.
  522. @return when true, the issuer DN is used instead of the issuer X500 principal
  523. </member>
  524. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetXadesIssuerNameNoReverseOrder(System.Boolean)">
  525. @param xadesIssuerNameNoReverseOrder when true, the issuer DN instead of the issuer X500 prinicpal is used
  526. </member>
  527. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetNamespacePrefixes">
  528. @return the map of namespace uri (key) to prefix (value)
  529. </member>
  530. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetNamespacePrefixes(System.Collections.Generic.Dictionary{System.String,System.String})">
  531. @param namespacePrefixes the map of namespace uri (key) to prefix (value)
  532. </member>
  533. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.nvl``1(``0,``0)">
  534. helper method for null/default value handling
  535. @param value
  536. @param defaultValue
  537. @return if value is not null, return value otherwise defaultValue
  538. </member>
  539. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetHashMagic">
  540. Each digest method has its own IV (Initial vector)
  541. @return the IV depending on the main digest method
  542. </member>
  543. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetSignatureMethodUri">
  544. @return the uri for the signature method, i.e. currently only rsa is
  545. supported, so it's the rsa variant of the main digest
  546. </member>
  547. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetDigestMethodUri">
  548. @return the uri for the main digest
  549. </member>
  550. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetDigestMethodUri(NPOI.POIFS.Crypt.HashAlgorithm)">
  551. @param digestAlgo the digest algo, currently only sha* and ripemd160 is supported
  552. @return the uri for the given digest
  553. </member>
  554. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetXadesCanonicalizationMethod">
  555. @return the cannonicalization method for XAdES-XL signing.
  556. Defaults to <code>EXCLUSIVE</code>
  557. @see <a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/crypto/dsig/CanonicalizationMethod.html">javax.xml.Crypto.dsig.CanonicalizationMethod</a>
  558. </member>
  559. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetXadesCanonicalizationMethod(System.String)">
  560. @param xadesCanonicalizationMethod the cannonicalization method for XAdES-XL signing
  561. @see <a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/crypto/dsig/CanonicalizationMethod.html">javax.xml.Crypto.dsig.CanonicalizationMethod</a>
  562. </member>
  563. <!-- Badly formed XML comment ignored for member "T:NPOI.POIFS.Crypt.Dsig.IURIReference" -->
  564. <member name="M:NPOI.POIFS.Crypt.Dsig.IURIReference.getURI">
  565. Returns the URI of the referenced data object.
  566. @return the URI of the data object in RFC 2396 format (may be
  567. <code>null</code> if not specified)
  568. </member>
  569. <member name="M:NPOI.POIFS.Crypt.Dsig.IURIReference.getType">
  570. Returns the type of data referenced by this URI.
  571. @return the type (a URI) of the data object (may be <code>null</code>
  572. if not specified)
  573. </member>
  574. <!-- Badly formed XML comment ignored for member "T:NPOI.POIFS.Crypt.Dsig.IURIDereferencer" -->
  575. <member name="M:NPOI.POIFS.Crypt.Dsig.IURIDereferencer.dereference(NPOI.POIFS.Crypt.Dsig.IURIReference,System.Security.Cryptography.Xml.SignedXml)">
  576. Dereferences the specified <code>URIReference</code> and returns the
  577. dereferenced data.
  578. @param uriReference the <code>URIReference</code>
  579. @param context an <code>XMLCryptoContext</code> that may
  580. contain additional useful information for dereferencing the URI. This
  581. implementation should dereference the specified
  582. <code>URIReference</code> against the context's <code>baseURI</code>
  583. parameter, if specified.
  584. @return the dereferenced data
  585. @throws NullPointerException if <code>uriReference</code> or
  586. <code>context</code> are <code>null</code>
  587. @throws URIReferenceException if an exception occurs while
  588. dereferencing the specified <code>uriReference</code>
  589. </member>
  590. <!-- Badly formed XML comment ignored for member "T:NPOI.POIFS.Crypt.Dsig.IEventListener" -->
  591. <member name="M:NPOI.POIFS.Crypt.Dsig.IEventListener.handleEvent(NPOI.POIFS.Crypt.Dsig.IEvent)">
  592. This method is called whenever an event occurs of the type for which
  593. the <code> EventListener</code> interface was registered.
  594. @param evt The <code>Event</code> contains contextual information
  595. about the event. It also contains the <code>stopPropagation</code>
  596. and <code>preventDefault</code> methods which are used in
  597. determining the event's flow and default action.
  598. </member>
  599. <member name="T:NPOI.POIFS.Crypt.Dsig.SignatureInfo">
  600. <p>This class is the default entry point for XML signatures and can be used for
  601. validating an existing signed office document and signing a office document.</p>
  602. <p><b>Validating a signed office document</b></p>
  603. <pre>
  604. OPCPackage pkg = OPCPackage.open(..., PackageAccess.READ);
  605. SignatureConfig sic = new SignatureConfig();
  606. sic.setOpcPackage(pkg);
  607. SignatureInfo si = new SignatureInfo();
  608. si.setSignatureConfig(sic);
  609. boolean isValid = si.validate();
  610. ...
  611. </pre>
  612. <p><b>Signing an office document</b></p>
  613. <pre>
  614. // loading the keystore - pkcs12 is used here, but of course jks &amp; co are also valid
  615. // the keystore needs to contain a private key and it's certificate having a
  616. // 'digitalSignature' key usage
  617. char password[] = "test".toCharArray();
  618. File file = new File("test.pfx");
  619. KeyStore keystore = KeyStore.getInstance("PKCS12");
  620. FileInputStream fis = new FileInputStream(file);
  621. keystore.load(fis, password);
  622. fis.close();
  623. // extracting private key and certificate
  624. String alias = "xyz"; // alias of the keystore entry
  625. Key key = keystore.getKey(alias, password);
  626. X509Certificate x509 = (X509Certificate)keystore.getCertificate(alias);
  627. // filling the SignatureConfig entries (minimum fields, more options are available ...)
  628. SignatureConfig signatureConfig = new SignatureConfig();
  629. signatureConfig.setKey(keyPair.getPrivate());
  630. signatureConfig.setSigningCertificateChain(Collections.singletonList(x509));
  631. OPCPackage pkg = OPCPackage.open(..., PackageAccess.READ_WRITE);
  632. signatureConfig.setOpcPackage(pkg);
  633. // adding the signature document to the package
  634. SignatureInfo si = new SignatureInfo();
  635. si.setSignatureConfig(signatureConfig);
  636. si.confirmSignature();
  637. // optionally verify the generated signature
  638. boolean b = si.verifySignature();
  639. assert (b);
  640. // write the changes back to disc
  641. pkg.close();
  642. </pre>
  643. <p><b>Implementation notes:</b></p>
  644. <p>Although there's a XML signature implementation in the Oracle JDKs 6 and higher,
  645. compatibility with IBM JDKs is also in focus (... but maybe not thoroughly tested ...).
  646. Therefore we are using the Apache Santuario libs (xmlsec) instead of the built-in classes,
  647. as the compatibility seems to be provided there.</p>
  648. <p>To use SignatureInfo and its sibling classes, you'll need to have the following libs
  649. in the classpath:</p>
  650. <ul>
  651. <li>BouncyCastle bcpkix and bcprov (tested against 1.51)</li>
  652. <li>Apache Santuario "xmlsec" (tested against 2.0.1)</li>
  653. <li>and slf4j-api (tested against 1.7.7)</li>
  654. </ul>
  655. </member>
  656. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.SignaturePart.GetPackagePart">
  657. @return the package part Containing the signature
  658. </member>
  659. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.SignaturePart.GetSigner">
  660. @return the signer certificate
  661. </member>
  662. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.SignaturePart.GetCertChain">
  663. @return the certificate chain of the signer
  664. </member>
  665. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.SignaturePart.Validate">
  666. @return true, when the xml signature is valid, false otherwise
  667. @throws EncryptedDocumentException if the signature can't be extracted or if its malformed
  668. </member>
  669. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.#ctor">
  670. Constructor Initializes xml signature environment, if it hasn't been Initialized before
  671. </member>
  672. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.GetSignatureConfig">
  673. @return the signature config
  674. </member>
  675. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.SetSignatureConfig(NPOI.POIFS.Crypt.Dsig.SignatureConfig)">
  676. @param signatureConfig the signature config, needs to be Set before a SignatureInfo object is used
  677. </member>
  678. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.VerifySignature">
  679. @return true, if first signature part is valid
  680. </member>
  681. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.ConfirmSignature">
  682. add the xml signature to the document
  683. @throws XMLSignatureException
  684. @throws MarshalException
  685. </member>
  686. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.signDigest(System.Byte[])">
  687. Sign (encrypt) the digest with the private key.
  688. Currently only rsa is supported.
  689. @param digest the hashed input
  690. @return the encrypted hash
  691. </member>
  692. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.GetSignatureParts">
  693. @return a signature part for each signature document.
  694. the parts can be validated independently.
  695. </member>
  696. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.InitXmlProvider">
  697. Initialize the xml signing environment and the bouncycastle provider
  698. </member>
  699. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.preSign(System.Xml.XmlDocument,System.Collections.Generic.List{NPOI.POIFS.Crypt.Dsig.DigestInfo})">
  700. Helper method for Adding informations before the signing.
  701. Normally {@link #ConfirmSignature()} is sufficient to be used.
  702. </member>
  703. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.postSign(System.Xml.XmlDocument,System.Byte[])">
  704. Helper method for Adding informations After the signing.
  705. Normally {@link #ConfirmSignature()} is sufficient to be used.
  706. </member>
  707. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.WriteDocument(System.Xml.XmlDocument)">
  708. Write XML signature into the OPC package
  709. @param document the xml signature document
  710. @throws MarshalException
  711. </member>
  712. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.safe``1(System.Collections.Generic.List{``0})">
  713. Helper method for null lists, which are Converted to empty lists
  714. @param other the reference to wrap, if null
  715. @return if other is null, an empty lists is returned, otherwise other is returned
  716. </member>
  717. <member name="T:NPOI.POIFS.Crypt.Dsig.SignatureMarshalListener">
  718. This listener class is used, to modify the to be digested xml document,
  719. e.g. to register id attributes or Set prefixes for registered namespaces
  720. </member>
  721. <!-- Badly formed XML comment ignored for member "F:NPOI.POIFS.Crypt.Dsig.SignatureMarshalListener.signatureConfig" -->
  722. <member name="T:NPOI.POIFS.Crypt.Dsig.TrustCertificateSecurityException">
  723. Exception thrown in case the incoming eID certificate is not trusted.
  724. @author Frank Cornelis
  725. </member>
  726. <member name="F:NPOI.POIXMLDocument.pkg">
  727. The OPC Package
  728. </member>
  729. <member name="F:NPOI.POIXMLDocument.properties">
  730. The properties of the OPC namespace, opened as needed
  731. </member>
  732. <member name="M:NPOI.POIXMLDocument.OpenPackage(System.String)">
  733. Wrapper to open a namespace, returning an IOException
  734. in the event of a problem.
  735. Works around shortcomings in java's this() constructor calls
  736. </member>
  737. <member name="M:NPOI.POIXMLDocument.GetRelatedByType(System.String)">
  738. Retrieves all the PackageParts which are defined as
  739. relationships of the base document with the
  740. specified content type.
  741. </member>
  742. <member name="M:NPOI.POIXMLDocument.HasOOXMLHeader(System.IO.Stream)">
  743. Checks that the supplied Stream (which MUST
  744. support mark and reSet, or be a PushbackStream)
  745. has a OOXML (zip) header at the start of it.
  746. If your Stream does not support mark / reSet,
  747. then wrap it in a PushBackStream, then be
  748. sure to always use that, and not the original!
  749. @param inp An Stream which supports either mark/reSet, or is a PushbackStream
  750. </member>
  751. <member name="M:NPOI.POIXMLDocument.GetProperties">
  752. Get the document properties. This gives you access to the
  753. core ooxml properties, and the extended ooxml properties.
  754. </member>
  755. <member name="M:NPOI.POIXMLDocument.GetAllEmbedds">
  756. Get the document's embedded files.
  757. </member>
  758. <member name="M:NPOI.POIXMLDocument.Close">
  759. Closes the underlying {@link OPCPackage} from which this
  760. document was read, if there is one
  761. </member>
  762. <member name="M:NPOI.POIXMLDocument.Write(System.IO.Stream)">
  763. Write out this document to an Outputstream.
  764. Note - if the Document was opened from a {@link File} rather
  765. than an {@link InputStream}, you <b>must</b> write out to
  766. a different file, overwriting via an OutputStream isn't possible.
  767. If {@code stream} is a {@link java.io.FileOutputStream} on a networked drive
  768. or has a high cost/latency associated with each written byte,
  769. consider wrapping the OutputStream in a {@link java.io.BufferedOutputStream}
  770. to improve write performance.
  771. @param stream - the java Stream you wish to write the file to
  772. @exception IOException if anything can't be written.
  773. </member>
  774. <member name="T:NPOI.POIXMLDocumentPart">
  775. Represents an entry of a OOXML namespace.
  776. <p>
  777. Each POIXMLDocumentPart keeps a reference to the underlying a {@link org.apache.poi.openxml4j.opc.PackagePart}.
  778. </p>
  779. @author Yegor Kozlov
  780. </member>
  781. <member name="T:NPOI.POIXMLDocumentPart.RelationPart">
  782. The RelationPart is a cached relationship between the document, which contains the RelationPart,
  783. and one of its referenced child document parts.
  784. The child document parts may only belong to one parent, but it's often referenced by other
  785. parents too, having varying {@link PackageRelationship#getId() relationship ids} pointing to it.
  786. </member>
  787. <member name="P:NPOI.POIXMLDocumentPart.RelationPart.Relationship">
  788. @return the cached relationship, which uniquely identifies this child document part within the parent
  789. </member>
  790. <member name="M:NPOI.POIXMLDocumentPart.RelationPart.GetDocumentPart``1">
  791. @return the child document part
  792. </member>
  793. <member name="F:NPOI.POIXMLDocumentPart.relationCounter">
  794. Counter that provides the amount of incoming relations from other parts
  795. to this part.
  796. </member>
  797. <member name="M:NPOI.POIXMLDocumentPart.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage)">
  798. Construct POIXMLDocumentPart representing a "core document" namespace part.
  799. </member>
  800. <member name="M:NPOI.POIXMLDocumentPart.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage,System.String)">
  801. Construct POIXMLDocumentPart representing a custom "core document" package part.
  802. </member>
  803. <member name="M:NPOI.POIXMLDocumentPart.#ctor">
  804. Creates new POIXMLDocumentPart - called by client code to create new parts from scratch.
  805. @see #CreateRelationship(POIXMLRelation, POIXMLFactory, int, bool)
  806. </member>
  807. <member name="M:NPOI.POIXMLDocumentPart.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  808. Creates an POIXMLDocumentPart representing the given package part and relationship.
  809. Called by {@link #read(POIXMLFactory, java.util.Map)} when reading in an existing file.
  810. @param part - The package part that holds xml data representing this sheet.
  811. @see #read(POIXMLFactory, java.util.Map)
  812. @since POI 3.14-Beta1
  813. </member>
  814. <member name="M:NPOI.POIXMLDocumentPart.#ctor(NPOI.POIXMLDocumentPart,NPOI.OpenXml4Net.OPC.PackagePart)">
  815. Creates an POIXMLDocumentPart representing the given package part, relationship and parent
  816. Called by {@link #read(POIXMLFactory, java.util.Map)} when reading in an existing file.
  817. @param parent - Parent part
  818. @param part - The package part that holds xml data representing this sheet.
  819. @see #read(POIXMLFactory, java.util.Map)
  820. @since POI 3.14-Beta1
  821. </member>
  822. <member name="M:NPOI.POIXMLDocumentPart.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  823. Creates an POIXMLDocumentPart representing the given namespace part and relationship.
  824. Called by {@link #read(POIXMLFactory, java.util.Map)} when Reading in an exisiting file.
  825. @param part - The namespace part that holds xml data represenring this sheet.
  826. @param rel - the relationship of the given namespace part
  827. @see #read(POIXMLFactory, java.util.Map)
  828. </member>
  829. <member name="M:NPOI.POIXMLDocumentPart.#ctor(NPOI.POIXMLDocumentPart,NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  830. Creates an POIXMLDocumentPart representing the given namespace part, relationship and parent
  831. Called by {@link #read(POIXMLFactory, java.util.Map)} when Reading in an exisiting file.
  832. @param parent - Parent part
  833. @param part - The namespace part that holds xml data represenring this sheet.
  834. @param rel - the relationship of the given namespace part
  835. @see #read(POIXMLFactory, java.util.Map)
  836. </member>
  837. <member name="M:NPOI.POIXMLDocumentPart.Rebase(NPOI.OpenXml4Net.OPC.OPCPackage)">
  838. When you open something like a theme, call this to
  839. re-base the XML Document onto the core child of the
  840. current core document
  841. </member>
  842. <member name="M:NPOI.POIXMLDocumentPart.GetPackagePart">
  843. Provides access to the underlying PackagePart
  844. @return the underlying PackagePart
  845. </member>
  846. <member name="M:NPOI.POIXMLDocumentPart.GetPackageRelationship">
  847. Provides access to the PackageRelationship that identifies this POIXMLDocumentPart
  848. @return the PackageRelationship that identifies this POIXMLDocumentPart
  849. </member>
  850. <member name="M:NPOI.POIXMLDocumentPart.GetRelations">
  851. Returns the list of child relations for this POIXMLDocumentPart
  852. @return child relations
  853. </member>
  854. <member name="P:NPOI.POIXMLDocumentPart.RelationParts">
  855. Returns the list of child relations for this POIXMLDocumentPart
  856. @return child relations
  857. </member>
  858. <member name="M:NPOI.POIXMLDocumentPart.GetRelationById(System.String)">
  859. Returns the target {@link POIXMLDocumentPart}, where a
  860. {@link PackageRelationship} is set from the {@link PackagePart} of this
  861. {@link POIXMLDocumentPart} to the {@link PackagePart} of the target
  862. {@link POIXMLDocumentPart} with a {@link PackageRelationship#GetId()}
  863. matching the given parameter value.
  864. @param id
  865. The relation id to look for
  866. @return the target part of the relation, or null, if none exists
  867. </member>
  868. <member name="M:NPOI.POIXMLDocumentPart.GetRelationId(NPOI.POIXMLDocumentPart)">
  869. Returns the {@link PackageRelationship#GetId()} of the
  870. {@link PackageRelationship}, that sources from the {@link PackagePart} of
  871. this {@link POIXMLDocumentPart} to the {@link PackagePart} of the given
  872. parameter value.
  873. @param part
  874. The {@link POIXMLDocumentPart} for which the according
  875. relation-id shall be found.
  876. @return The value of the {@link PackageRelationship#GetId()} or null, if
  877. parts are not related.
  878. </member>
  879. <member name="M:NPOI.POIXMLDocumentPart.AddRelation(System.String,NPOI.POIXMLDocumentPart)">
  880. <summary>
  881. Add a new child POIXMLDocumentPart
  882. </summary>
  883. <param name="id"></param>
  884. <param name="part">the child to add</param>
  885. </member>
  886. <member name="M:NPOI.POIXMLDocumentPart.AddRelation(System.String,NPOI.POIXMLRelation,NPOI.POIXMLDocumentPart)">
  887. <summary>
  888. Add a new child POIXMLDocumentPart
  889. </summary>
  890. <param name="relId">the preferred relation id, when null the next free relation id will be used</param>
  891. <param name="relationshipType">the package relationship type</param>
  892. <param name="part">the child to add</param>
  893. <returns></returns>
  894. </member>
  895. <member name="M:NPOI.POIXMLDocumentPart.AddRelation(NPOI.OpenXml4Net.OPC.PackageRelationship,NPOI.POIXMLDocumentPart)">
  896. <summary>
  897. Add a new child POIXMLDocumentPart
  898. </summary>
  899. <param name="pr">the relationship of the child</param>
  900. <param name="part">the child to add</param>
  901. </member>
  902. <member name="M:NPOI.POIXMLDocumentPart.RemoveRelation(NPOI.POIXMLDocumentPart)">
  903. Remove the relation to the specified part in this namespace and remove the
  904. part, if it is no longer needed.
  905. </member>
  906. <member name="M:NPOI.POIXMLDocumentPart.RemoveRelation(NPOI.POIXMLDocumentPart,System.Boolean)">
  907. Remove the relation to the specified part in this namespace and remove the
  908. part, if it is no longer needed and flag is set to true.
  909. @param part
  910. The related part, to which the relation shall be Removed.
  911. @param RemoveUnusedParts
  912. true, if the part shall be Removed from the namespace if not
  913. needed any longer.
  914. </member>
  915. <member name="M:NPOI.POIXMLDocumentPart.GetParent">
  916. Returns the parent POIXMLDocumentPart. All parts except root have not-null parent.
  917. @return the parent POIXMLDocumentPart or <code>null</code> for the root element.
  918. </member>
  919. <member name="M:NPOI.POIXMLDocumentPart.Commit">
  920. Save the content in the underlying namespace part.
  921. Default implementation is empty meaning that the namespace part is left unmodified.
  922. Sub-classes should override and add logic to marshal the "model" into Ooxml4J.
  923. For example, the code saving a generic XML entry may look as follows:
  924. <pre><code>
  925. protected void commit() {
  926. PackagePart part = GetPackagePart();
  927. Stream out = part.GetStream();
  928. XmlObject bean = GetXmlBean(); //the "model" which holds Changes in memory
  929. bean.save(out, DEFAULT_XML_OPTIONS);
  930. out.close();
  931. }
  932. </code></pre>
  933. </member>
  934. <member name="M:NPOI.POIXMLDocumentPart.OnSave(System.Collections.Generic.List{NPOI.OpenXml4Net.OPC.PackagePart})">
  935. Save Changes in the underlying OOXML namespace.
  936. Recursively fires {@link #commit()} for each namespace part
  937. @param alreadySaved context set Containing already visited nodes
  938. </member>
  939. <member name="M:NPOI.POIXMLDocumentPart.PrepareForCommit">
  940. Ensure that a memory based package part does not have lingering data from previous
  941. commit() calls.
  942. Note: This is overwritten for some objects, as *PictureData seem to store the actual content
  943. in the part directly without keeping a copy like all others therefore we need to handle them differently.
  944. </member>
  945. <member name="M:NPOI.POIXMLDocumentPart.CreateRelationship(NPOI.POIXMLRelation,NPOI.POIXMLFactory)">
  946. Create a new child POIXMLDocumentPart
  947. @param descriptor the part descriptor
  948. @param factory the factory that will create an instance of the requested relation
  949. @return the Created child POIXMLDocumentPart
  950. </member>
  951. <member name="M:NPOI.POIXMLDocumentPart.CreateRelationship(NPOI.POIXMLRelation,NPOI.POIXMLFactory,System.Int32,System.Boolean)">
  952. Create a new child POIXMLDocumentPart
  953. @param descriptor the part descriptor
  954. @param factory the factory that will create an instance of the requested relation
  955. @param idx part number
  956. @param noRelation if true, then no relationship is Added.
  957. @return the Created child POIXMLDocumentPart
  958. </member>
  959. <member name="M:NPOI.POIXMLDocumentPart.Read(NPOI.POIXMLFactory,System.Collections.Generic.Dictionary{NPOI.OpenXml4Net.OPC.PackagePart,NPOI.POIXMLDocumentPart})">
  960. Iterate through the underlying PackagePart and create child POIXMLFactory instances
  961. using the specified factory
  962. @param factory the factory object that Creates POIXMLFactory instances
  963. @param context context map Containing already visited noted keyed by tarGetURI
  964. </member>
  965. <member name="M:NPOI.POIXMLDocumentPart.GetTargetPart(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  966. Get the PackagePart that is the target of a relationship.
  967. @param rel The relationship
  968. @return The target part
  969. @throws InvalidFormatException
  970. </member>
  971. <member name="M:NPOI.POIXMLDocumentPart.OnDocumentCreate">
  972. Fired when a new namespace part is Created
  973. </member>
  974. <member name="M:NPOI.POIXMLDocumentPart.OnDocumentRead">
  975. Fired when a namespace part is read
  976. </member>
  977. <member name="M:NPOI.POIXMLDocumentPart.onDocumentRemove">
  978. Fired when a namespace part is about to be Removed from the namespace
  979. </member>
  980. <member name="M:NPOI.POIXMLDocumentPart.GetPartFromOPCPackage(NPOI.OpenXml4Net.OPC.OPCPackage,System.String)">
  981. Retrieves the core document part
  982. @since POI 3.14-Beta1
  983. </member>
  984. <member name="T:NPOI.POIXMLFactory">
  985. Defines a factory API that enables sub-classes to create instances of <code>POIXMLDocumentPart</code>
  986. @author Yegor Kozlov
  987. </member>
  988. <member name="M:NPOI.POIXMLFactory.CreateDocumentPart(NPOI.POIXMLDocumentPart,NPOI.OpenXml4Net.OPC.PackagePart)">
  989. Create a POIXMLDocumentPart from existing package part and relation. This method is called
  990. from {@link POIXMLDocument#load(POIXMLFactory)} when parsing a document
  991. @param parent parent part
  992. @param rel the package part relationship
  993. @param part the PackagePart representing the created instance
  994. @return A new instance of a POIXMLDocumentPart.
  995. @since by POI 3.14-Beta1
  996. </member>
  997. <member name="M:NPOI.POIXMLFactory.CreateDocumentPart(System.Type,System.Type[],System.Object[])">
  998. Need to delegate instantiation to sub class because of constructor visibility
  999. @since POI 3.14-Beta1
  1000. </member>
  1001. <member name="M:NPOI.POIXMLFactory.GetDescriptor(System.String)">
  1002. returns the descriptor for the given relationship type
  1003. @return the descriptor or null if type is unknown
  1004. @since POI 3.14-Beta1
  1005. </member>
  1006. <member name="M:NPOI.POIXMLFactory.CreateDocumentPart(NPOI.POIXMLDocumentPart,NPOI.OpenXml4Net.OPC.PackageRelationship,NPOI.OpenXml4Net.OPC.PackagePart)">
  1007. Create a POIXMLDocumentPart from existing package part and relation. This method is called
  1008. from {@link POIXMLDocument#load(POIXMLFactory)} when parsing a document
  1009. @param parent parent part
  1010. @param rel the package part relationship
  1011. @param part the PackagePart representing the created instance
  1012. @return A new instance of a POIXMLDocumentPart.
  1013. @deprecated in POI 3.14, scheduled for removal in POI 3.16
  1014. </member>
  1015. <member name="M:NPOI.POIXMLFactory.NewDocumentPart(NPOI.POIXMLRelation)">
  1016. Create a new POIXMLDocumentPart using the supplied descriptor. This method is used when adding new parts
  1017. to a document, for example, when adding a sheet to a workbook, slide to a presentation, etc.
  1018. @param descriptor describes the object to create
  1019. @return A new instance of a POIXMLDocumentPart.
  1020. </member>
  1021. <member name="M:NPOI.POIXMLFactory.GetPackageRelationship(NPOI.POIXMLDocumentPart,NPOI.OpenXml4Net.OPC.PackagePart)">
  1022. Retrieves the package relationship of the child part within the parent
  1023. @since POI 3.14-Beta1
  1024. </member>
  1025. <member name="T:NPOI.CoreProperties">
  1026. The core document properties
  1027. </member>
  1028. <member name="T:NPOI.ExtendedProperties">
  1029. Extended document properties
  1030. </member>
  1031. <member name="T:NPOI.CustomProperties">
  1032. Custom document properties
  1033. </member>
  1034. <member name="F:NPOI.CustomProperties.FORMAT_ID">
  1035. Each custom property element Contains an fmtid attribute
  1036. with the same GUID value ({D5CDD505-2E9C-101B-9397-08002B2CF9AE}).
  1037. </member>
  1038. <member name="M:NPOI.CustomProperties.Add(System.String)">
  1039. Add a new property
  1040. @param name the property name
  1041. @throws IllegalArgumentException if a property with this name already exists
  1042. </member>
  1043. <member name="M:NPOI.CustomProperties.AddProperty(System.String,System.String)">
  1044. Add a new string property
  1045. @throws IllegalArgumentException if a property with this name already exists
  1046. </member>
  1047. <member name="M:NPOI.CustomProperties.AddProperty(System.String,System.Double)">
  1048. Add a new double property
  1049. @throws IllegalArgumentException if a property with this name already exists
  1050. </member>
  1051. <member name="M:NPOI.CustomProperties.AddProperty(System.String,System.Int32)">
  1052. Add a new integer property
  1053. @throws IllegalArgumentException if a property with this name already exists
  1054. </member>
  1055. <member name="M:NPOI.CustomProperties.AddProperty(System.String,System.Boolean)">
  1056. Add a new bool property
  1057. @throws IllegalArgumentException if a property with this name already exists
  1058. </member>
  1059. <member name="M:NPOI.CustomProperties.NextPid">
  1060. Generate next id that uniquely relates a custom property
  1061. @return next property id starting with 2
  1062. </member>
  1063. <member name="M:NPOI.CustomProperties.Contains(System.String)">
  1064. Check if a property with this name already exists in the collection of custom properties
  1065. @param name the name to check
  1066. @return whether a property with the given name exists in the custom properties
  1067. </member>
  1068. <member name="M:NPOI.CustomProperties.GetProperty(System.String)">
  1069. Retrieve the custom property with this name, or null if none exists.
  1070. You will need to test the various isSetX methods to work out
  1071. what the type of the property is, before fetching the
  1072. appropriate value for it.
  1073. @param name the name of the property to fetch
  1074. </member>
  1075. <member name="T:NPOI.POIXMLProperties">
  1076. Wrapper around the three different kinds of OOXML properties
  1077. and metadata a document can have (Core, Extended and Custom),
  1078. as well Thumbnails.
  1079. </member>
  1080. <member name="P:NPOI.POIXMLProperties.CoreProperties">
  1081. Returns the core document properties
  1082. </member>
  1083. <member name="P:NPOI.POIXMLProperties.ExtendedProperties">
  1084. Returns the extended document properties
  1085. </member>
  1086. <member name="P:NPOI.POIXMLProperties.CustomProperties">
  1087. Returns the custom document properties
  1088. </member>
  1089. <member name="P:NPOI.POIXMLProperties.ThumbnailPart">
  1090. Returns the {@link PackagePart} for the Document
  1091. Thumbnail, or <code>null</code> if there isn't one
  1092. @return The Document Thumbnail part or null
  1093. </member>
  1094. <member name="P:NPOI.POIXMLProperties.ThumbnailFilename">
  1095. Returns the name of the Document thumbnail, eg
  1096. <code>thumbnail.jpeg</code>, or <code>null</code> if there
  1097. isn't one.
  1098. @return The thumbnail filename, or null
  1099. </member>
  1100. <member name="P:NPOI.POIXMLProperties.ThumbnailImage">
  1101. Returns the Document thumbnail image data, or
  1102. <code>null</code> if there isn't one.
  1103. @return The thumbnail data, or null
  1104. </member>
  1105. <member name="M:NPOI.POIXMLProperties.SetThumbnail(System.String,System.IO.Stream)">
  1106. Sets the Thumbnail for the document, replacing any existing
  1107. one.
  1108. @param name The filename for the thumbnail image, eg <code>thumbnail.jpg</code>
  1109. @param imageData The inputstream to read the thumbnail image from
  1110. </member>
  1111. <member name="M:NPOI.POIXMLProperties.Commit">
  1112. Commit Changes to the underlying OPC namespace
  1113. </member>
  1114. <member name="T:NPOI.POIXMLPropertiesTextExtractor">
  1115. A {@link POITextExtractor} for returning the textual
  1116. content of the OOXML file properties, eg author
  1117. and title.
  1118. </member>
  1119. <member name="M:NPOI.POIXMLPropertiesTextExtractor.#ctor(NPOI.POIXMLDocument)">
  1120. Creates a new POIXMLPropertiesTextExtractor for the
  1121. given open document.
  1122. </member>
  1123. <member name="M:NPOI.POIXMLPropertiesTextExtractor.#ctor(NPOI.POIXMLTextExtractor)">
  1124. Creates a new POIXMLPropertiesTextExtractor, for the
  1125. same file that another TextExtractor is already
  1126. working on.
  1127. </member>
  1128. <member name="M:NPOI.POIXMLPropertiesTextExtractor.GetCorePropertiesText">
  1129. Returns the core document properties, eg author
  1130. </member>
  1131. <member name="M:NPOI.POIXMLPropertiesTextExtractor.GetExtendedPropertiesText">
  1132. Returns the extended document properties, eg
  1133. application
  1134. </member>
  1135. <member name="M:NPOI.POIXMLPropertiesTextExtractor.GetCustomPropertiesText">
  1136. Returns the custom document properties, if
  1137. there are any
  1138. </member>
  1139. <member name="T:NPOI.POIXMLRelation">
  1140. Represents a descriptor of a OOXML relation.
  1141. @author Yegor Kozlov
  1142. </member>
  1143. <member name="F:NPOI.POIXMLRelation._type">
  1144. Describes the content stored in a part.
  1145. </member>
  1146. <member name="F:NPOI.POIXMLRelation._relation">
  1147. The kind of connection between a source part and a target part in a namespace.
  1148. </member>
  1149. <member name="F:NPOI.POIXMLRelation._defaultName">
  1150. The path component of a pack URI.
  1151. </member>
  1152. <member name="F:NPOI.POIXMLRelation._cls">
  1153. Defines what object is used to construct instances of this relationship
  1154. </member>
  1155. <member name="M:NPOI.POIXMLRelation.#ctor(System.String,System.String,System.String,System.Type)">
  1156. Instantiates a POIXMLRelation.
  1157. @param type content type
  1158. @param rel relationship
  1159. @param defaultName default item name
  1160. @param cls defines what object is used to construct instances of this relationship
  1161. </member>
  1162. <member name="M:NPOI.POIXMLRelation.#ctor(System.String,System.String,System.String)">
  1163. Instantiates a POIXMLRelation.
  1164. @param type content type
  1165. @param rel relationship
  1166. @param defaultName default item name
  1167. </member>
  1168. <member name="P:NPOI.POIXMLRelation.ContentType">
  1169. Return the content type. Content types define a media type, a subtype, and an
  1170. optional set of parameters, as defined in RFC 2616.
  1171. @return the content type
  1172. </member>
  1173. <member name="P:NPOI.POIXMLRelation.Relation">
  1174. Return the relationship, the kind of connection between a source part and a target part in a namespace.
  1175. Relationships make the connections between parts directly discoverable without looking at the content
  1176. in the parts, and without altering the parts themselves.
  1177. @return the relationship
  1178. </member>
  1179. <member name="P:NPOI.POIXMLRelation.DefaultFileName">
  1180. Return the default part name. Part names are used to refer to a part in the context of a
  1181. namespace, typically as part of a URI.
  1182. @return the default part name
  1183. </member>
  1184. <member name="M:NPOI.POIXMLRelation.GetFileName(System.Int32)">
  1185. Returns the filename for the nth one of these,
  1186. e.g. /xl/comments4.xml
  1187. </member>
  1188. <member name="M:NPOI.POIXMLRelation.GetFileNameIndex(NPOI.POIXMLDocumentPart)">
  1189. Returns the index of the filename within the package for the given part.
  1190. e.g. 4 for /xl/comments4.xml
  1191. </member>
  1192. <member name="P:NPOI.POIXMLRelation.RelationClass">
  1193. Return type of the obejct used to construct instances of this relationship
  1194. @return the class of the object used to construct instances of this relation
  1195. </member>
  1196. <member name="F:NPOI.POIXMLTextExtractor._document">
  1197. The POIXMLDocument that's open
  1198. </member>
  1199. <member name="M:NPOI.POIXMLTextExtractor.#ctor(NPOI.POIXMLDocument)">
  1200. Creates a new text extractor for the given document
  1201. </member>
  1202. <member name="M:NPOI.POIXMLTextExtractor.GetCoreProperties">
  1203. Returns the core document properties
  1204. </member>
  1205. <member name="M:NPOI.POIXMLTextExtractor.GetExtendedProperties">
  1206. Returns the extended document properties
  1207. </member>
  1208. <member name="M:NPOI.POIXMLTextExtractor.GetCustomProperties">
  1209. Returns the custom document properties
  1210. </member>
  1211. <member name="P:NPOI.POIXMLTextExtractor.Document">
  1212. Returns opened document
  1213. </member>
  1214. <member name="P:NPOI.POIXMLTextExtractor.Package">
  1215. Returns the opened OPCPackage that Contains the document
  1216. </member>
  1217. <member name="P:NPOI.POIXMLTextExtractor.MetadataTextExtractor">
  1218. Returns an OOXML properties text extractor for the
  1219. document properties metadata, such as title and author.
  1220. </member>
  1221. <member name="P:NPOI.SS.Converter.ExcelToHtmlConverter.OutputColumnHeaders">
  1222. <summary>
  1223. 是否输出列头
  1224. </summary>
  1225. </member>
  1226. <member name="P:NPOI.SS.Converter.ExcelToHtmlConverter.OutputHiddenColumns">
  1227. <summary>
  1228. 是否输出隐藏的列
  1229. </summary>
  1230. </member>
  1231. <member name="P:NPOI.SS.Converter.ExcelToHtmlConverter.OutputHiddenRows">
  1232. <summary>
  1233. 是否输出隐藏的行
  1234. </summary>
  1235. </member>
  1236. <member name="P:NPOI.SS.Converter.ExcelToHtmlConverter.OutputLeadingSpacesAsNonBreaking">
  1237. <summary>
  1238. 是否输出文本前的空格
  1239. </summary>
  1240. </member>
  1241. <member name="P:NPOI.SS.Converter.ExcelToHtmlConverter.OutputRowNumbers">
  1242. <summary>
  1243. 是否输出行号
  1244. </summary>
  1245. </member>
  1246. <member name="P:NPOI.SS.Converter.ExcelToHtmlConverter.UseDivsToSpan">
  1247. <summary>
  1248. 在跨列的单元格使用DIV标记
  1249. </summary>
  1250. </member>
  1251. <member name="M:NPOI.SS.Converter.ExcelToHtmlConverter.ProcessRow(NPOI.SS.Util.CellRangeAddress[][],NPOI.SS.UserModel.IRow,System.Xml.XmlElement)">
  1252. @return maximum 1-base index of column that were rendered, zero if none
  1253. </member>
  1254. <member name="M:NPOI.SS.Converter.ExcelToHtmlConverter.ProcessColumnWidths(NPOI.SS.UserModel.ISheet,System.Int32,System.Xml.XmlElement)">
  1255. Creates COLGROUP element with width specified for all columns. (Except
  1256. first if <tt>{@link #isOutputRowNumbers()}==true</tt>)
  1257. </member>
  1258. <member name="M:NPOI.SS.Converter.ExcelToHtmlUtils.BuildMergedRangesMap(NPOI.SS.UserModel.ISheet)">
  1259. Creates a map (i.e. two-dimensional array) filled with ranges. Allow fast
  1260. retrieving {@link CellRangeAddress} of any cell, if cell is contained in
  1261. range.
  1262. @see #getMergedRange(CellRangeAddress[][], int, int)
  1263. </member>
  1264. <member name="M:NPOI.SS.Converter.ExcelToHtmlUtils.GetColumnWidthInPx(System.Int32)">
  1265. See <a href=
  1266. "http://apache-poi.1045710.n5.nabble.com/Excel-Column-Width-Unit-Converter-pixels-excel-column-width-units-td2301481.html"
  1267. >here</a> for Xio explanation and details
  1268. </member>
  1269. <member name="M:NPOI.SS.Converter.ExcelToHtmlUtils.GetMergedRange(NPOI.SS.Util.CellRangeAddress[][],System.Int32,System.Int32)">
  1270. @param mergedRanges
  1271. map of sheet merged ranges built with
  1272. {@link #buildMergedRangesMap(HSSFSheet)}
  1273. @return {@link CellRangeAddress} from map if cell with specified row and
  1274. column numbers contained in found range, <tt>null</tt> otherwise
  1275. </member>
  1276. <member name="F:NPOI.SS.UserModel.ImportOption.SheetContentOnly">
  1277. <summary>
  1278. Only Text and Formulas are imported. Pictures, Drawing, Styles etc. are all ignored.
  1279. </summary>
  1280. </member>
  1281. <member name="F:NPOI.SS.UserModel.ImportOption.TextOnly">
  1282. <summary>
  1283. Only Text, Comments and Formulas are imported. Pictures, Drawing, Styles etc. are all ignored.
  1284. </summary>
  1285. </member>
  1286. <member name="F:NPOI.SS.UserModel.ImportOption.All">
  1287. <summary>
  1288. Everything is imported - this is the same as NONE.
  1289. </summary>
  1290. </member>
  1291. <member name="T:NPOI.SS.UserModel.WorkbookFactory">
  1292. <summary>
  1293. Factory for creating the appropriate kind of Workbook
  1294. (be it HSSFWorkbook or XSSFWorkbook), from the given input
  1295. </summary>
  1296. </member>
  1297. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  1298. <summary>
  1299. Creates an HSSFWorkbook from the given POIFSFileSystem
  1300. </summary>
  1301. </member>
  1302. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(NPOI.POIFS.FileSystem.NPOIFSFileSystem)">
  1303. <summary>
  1304. Creates an HSSFWorkbook from the given NPOIFSFileSystem
  1305. </summary>
  1306. <param name="fs"></param>
  1307. <returns></returns>
  1308. </member>
  1309. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(NPOI.POIFS.FileSystem.NPOIFSFileSystem,System.String)">
  1310. <summary>
  1311. Creates a Workbook from the given NPOIFSFileSystem, which may be password protected
  1312. </summary>
  1313. <param name="fs"></param>
  1314. <param name="password"></param>
  1315. <returns></returns>
  1316. </member>
  1317. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(NPOI.OpenXml4Net.OPC.OPCPackage)">
  1318. <summary>
  1319. Creates an XSSFWorkbook from the given OOXML Package
  1320. </summary>
  1321. </member>
  1322. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(System.IO.Stream,System.Boolean)">
  1323. <summary>
  1324. Creates the appropriate HSSFWorkbook / XSSFWorkbook from
  1325. the given InputStream. The Stream is wraped inside a PushbackInputStream.
  1326. </summary>
  1327. <param name="inputStream">Input Stream of .xls or .xlsx file</param>
  1328. <returns>IWorkbook depending on the input HSSFWorkbook or XSSFWorkbook is returned.</returns>
  1329. <remarks>Your input stream MUST either support mark/reset, or
  1330. be wrapped as a {@link PushbackInputStream}!</remarks>
  1331. </member>
  1332. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(System.IO.Stream,System.String,System.Boolean)">
  1333. <summary>
  1334. Creates the appropriate HSSFWorkbook / XSSFWorkbook from
  1335. the given File, which must exist and be readable.
  1336. </summary>
  1337. <param name="file"></param>
  1338. <param name="password"></param>
  1339. <param name="readOnly"></param>
  1340. <returns></returns>
  1341. <remarks>
  1342. Note that for Workbooks opened this way, it is not possible
  1343. to explicitly close the underlying File resource.
  1344. </remarks>
  1345. </member>
  1346. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(System.IO.Stream,NPOI.SS.UserModel.ImportOption)">
  1347. <summary>
  1348. Creates the appropriate HSSFWorkbook / XSSFWorkbook from
  1349. the given InputStream. The Stream is wraped inside a PushbackInputStream.
  1350. </summary>
  1351. <param name="inputStream">Input Stream of .xls or .xlsx file</param>
  1352. <param name="importOption">Customize the elements that are processed on the next import</param>
  1353. <returns>IWorkbook depending on the input HSSFWorkbook or XSSFWorkbook is returned.</returns>
  1354. </member>
  1355. <member name="M:NPOI.SS.UserModel.WorkbookFactory.CreateFormulaEvaluator(NPOI.SS.UserModel.IWorkbook)">
  1356. <summary>
  1357. Creates a specific FormulaEvaluator for the given workbook.
  1358. </summary>
  1359. </member>
  1360. <member name="M:NPOI.SS.UserModel.WorkbookFactory.SetImportOption(NPOI.SS.UserModel.ImportOption)">
  1361. <summary>
  1362. Sets the import option when opening the next workbook.
  1363. Works only for XSSF. For HSSF workbooks this option is ignored.
  1364. </summary>
  1365. <param name="importOption">Customize the elements that are processed on the next import</param>
  1366. </member>
  1367. <member name="T:NPOI.Util.IdentifierManager">
  1368. <summary>
  1369. 24.08.2009 @author Stefan Stern
  1370. </summary>
  1371. </member>
  1372. <member name="F:NPOI.Util.IdentifierManager.upperbound">
  1373. </member>
  1374. <member name="F:NPOI.Util.IdentifierManager.lowerbound">
  1375. </member>
  1376. <member name="F:NPOI.Util.IdentifierManager.segments">
  1377. List of segments of available identifiers
  1378. </member>
  1379. <member name="M:NPOI.Util.IdentifierManager.#ctor(System.Int64,System.Int64)">
  1380. @param lowerbound the lower limit of the id-range to manage. Must be greater than or equal to {@link #MIN_ID}.
  1381. @param upperbound the upper limit of the id-range to manage. Must be less then or equal {@link #MAX_ID}.
  1382. </member>
  1383. <member name="M:NPOI.Util.IdentifierManager.ReserveNew">
  1384. @return a new identifier.
  1385. @throws InvalidOperationException if no more identifiers are available, then an Exception is raised.
  1386. </member>
  1387. <member name="M:NPOI.Util.IdentifierManager.Release(System.Int64)">
  1388. @param id
  1389. the identifier to release. Must be greater than or equal to
  1390. {@link #lowerbound} and must be less than or equal to {@link #upperbound}
  1391. @return true, if the identifier was reserved and has been successfully
  1392. released, false, if the identifier was not reserved.
  1393. </member>
  1394. <member name="M:NPOI.Util.IdentifierManager.VerifyIdentifiersLeft">
  1395. </member>
  1396. <member name="T:NPOI.Util.PackageHelper">
  1397. Provides handy methods to work with OOXML namespaces
  1398. @author Yegor Kozlov
  1399. </member>
  1400. <member name="M:NPOI.Util.PackageHelper.Clone(NPOI.OpenXml4Net.OPC.OPCPackage,System.String)">
  1401. Clone the specified namespace.
  1402. @param pkg the namespace to clone
  1403. @param file the destination file
  1404. @return the Cloned namespace
  1405. </member>
  1406. <member name="M:NPOI.Util.PackageHelper.CreateTempFile">
  1407. Creates an empty file in the default temporary-file directory,
  1408. </member>
  1409. <member name="M:NPOI.Util.PackageHelper.Copy(NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePart)">
  1410. Recursively copy namespace parts to the destination namespace
  1411. </member>
  1412. <member name="M:NPOI.Util.PackageHelper.CopyProperties(NPOI.OpenXml4Net.OPC.PackageProperties,NPOI.OpenXml4Net.OPC.PackageProperties)">
  1413. Copy core namespace properties
  1414. @param src source properties
  1415. @param tgt target properties
  1416. </member>
  1417. <member name="T:NPOI.XSSF.Extractor.XSSFExcelExtractor">
  1418. Helper class to extract text from an OOXML Excel file
  1419. </member>
  1420. <member name="P:NPOI.XSSF.Extractor.XSSFExcelExtractor.IncludeHeaderFooter">
  1421. <summary>
  1422. Should header and footer be included? Default is true
  1423. </summary>
  1424. </member>
  1425. <member name="P:NPOI.XSSF.Extractor.XSSFExcelExtractor.IncludeSheetNames">
  1426. <summary>
  1427. Should sheet names be included? Default is true
  1428. </summary>
  1429. <value>if set to <c>true</c> [include sheet names].</value>
  1430. </member>
  1431. <member name="P:NPOI.XSSF.Extractor.XSSFExcelExtractor.FormulasNotResults">
  1432. <summary>
  1433. Should we return the formula itself, and not
  1434. the result it produces? Default is false
  1435. </summary>
  1436. <value>if set to <c>true</c> [formulas not results].</value>
  1437. </member>
  1438. <member name="P:NPOI.XSSF.Extractor.XSSFExcelExtractor.IncludeCellComments">
  1439. <summary>
  1440. Should cell comments be included? Default is false
  1441. </summary>
  1442. <value>if set to <c>true</c> [include cell comments].</value>
  1443. </member>
  1444. <member name="M:NPOI.XSSF.Extractor.XSSFExcelExtractor.SetIncludeSheetNames(System.Boolean)">
  1445. Should sheet names be included? Default is true
  1446. </member>
  1447. <member name="M:NPOI.XSSF.Extractor.XSSFExcelExtractor.SetFormulasNotResults(System.Boolean)">
  1448. Should we return the formula itself, and not
  1449. the result it produces? Default is false
  1450. </member>
  1451. <member name="M:NPOI.XSSF.Extractor.XSSFExcelExtractor.SetIncludeCellComments(System.Boolean)">
  1452. Should cell comments be included? Default is false
  1453. </member>
  1454. <member name="M:NPOI.XSSF.Extractor.XSSFExcelExtractor.SetIncludeHeadersFooters(System.Boolean)">
  1455. Should headers and footers be included? Default is true
  1456. </member>
  1457. <member name="M:NPOI.XSSF.Extractor.XSSFExcelExtractor.SetIncludeTextBoxes(System.Boolean)">
  1458. Should text within textboxes be included? Default is true
  1459. @param includeTextBoxes
  1460. </member>
  1461. <member name="P:NPOI.XSSF.Extractor.XSSFExcelExtractor.Text">
  1462. Retreives the text contents of the file
  1463. </member>
  1464. <member name="T:NPOI.XSSF.Extractor.XSSFExportToXml">
  1465. Maps an XLSX to an XML according to one of the mapping defined.
  1466. The output XML Schema must respect this limitations:
  1467. <ul>
  1468. <li> all mandatory elements and attributes must be mapped (enable validation to check this)</li>
  1469. <li> no &lt;any&gt; in complex type/element declaration </li>
  1470. <li> no &lt;anyAttribute&gt; attributes declaration </li>
  1471. <li> no recursive structures: recursive structures can't be nested more than one level </li>
  1472. <li> no abstract elements: abstract complex types can be declared but must not be used in elements. </li>
  1473. <li> no mixed content: an element can't contain simple text and child element(s) together </li>
  1474. <li> no &lt;substitutionGroup&gt; in complex type/element declaration </li>
  1475. </ul>
  1476. </member>
  1477. <member name="M:NPOI.XSSF.Extractor.XSSFExportToXml.#ctor(NPOI.XSSF.UserModel.XSSFMap)">
  1478. Creates a new exporter and Sets the mapping to be used when generating the XML output document
  1479. @param map the mapping rule to be used
  1480. </member>
  1481. <member name="M:NPOI.XSSF.Extractor.XSSFExportToXml.ExportToXML(System.IO.Stream,System.Boolean)">
  1482. Exports the data in an XML stream
  1483. @param os OutputStream in which will contain the output XML
  1484. @param validate if true, validates the XML againts the XML Schema
  1485. @throws SAXException
  1486. @throws TransformerException
  1487. @throws ParserConfigurationException
  1488. </member>
  1489. <member name="M:NPOI.XSSF.Extractor.XSSFExportToXml.ExportToXML(System.IO.Stream,System.String,System.Boolean)">
  1490. Exports the data in an XML stream
  1491. @param os OutputStream in which will contain the output XML
  1492. @param encoding the output charset encoding
  1493. @param validate if true, validates the XML againts the XML Schema
  1494. @throws SAXException
  1495. @throws ParserConfigurationException
  1496. @throws TransformerException
  1497. @throws InvalidFormatException
  1498. </member>
  1499. <member name="M:NPOI.XSSF.Extractor.XSSFExportToXml.IsValid(System.Xml.XmlDocument)">
  1500. Validate the generated XML against the XML Schema associated with the XSSFMap
  1501. @param xml the XML to validate
  1502. @return
  1503. </member>
  1504. <member name="M:NPOI.XSSF.Extractor.XSSFExportToXml.Compare(System.String,System.String)">
  1505. Compares two xpaths to define an ordering according to the XML Schema
  1506. </member>
  1507. <member name="T:NPOI.XSSF.Model.CalculationChain">
  1508. The cells in a workbook can be calculated in different orders depending on various optimizations and
  1509. dependencies. The calculation chain object specifies the order in which the cells in a workbook were last calculated.
  1510. @author Yegor Kozlov
  1511. </member>
  1512. <member name="M:NPOI.XSSF.Model.CalculationChain.RemoveItem(System.Int32,System.String)">
  1513. Remove a formula reference from the calculation chain
  1514. @param sheetId the sheet Id of a sheet the formula belongs to.
  1515. @param ref A1 style reference to the cell Containing the formula.
  1516. </member>
  1517. <member name="F:NPOI.XSSF.Model.CommentsTable.commentRefs">
  1518. XML Beans uses a list, which is very slow
  1519. to search, so we wrap things with our own
  1520. map for fast Lookup.
  1521. </member>
  1522. <member name="M:NPOI.XSSF.Model.CommentsTable.ReferenceUpdated(System.String,NPOI.OpenXmlFormats.Spreadsheet.CT_Comment)">
  1523. Called after the reference is updated, so that
  1524. we can reflect that in our cache
  1525. </member>
  1526. <member name="M:NPOI.XSSF.Model.CommentsTable.ReferenceUpdated(NPOI.SS.Util.CellAddress,NPOI.OpenXmlFormats.Spreadsheet.CT_Comment)">
  1527. Called after the reference is updated, so that
  1528. we can reflect that in our cache
  1529. @param oldReference the comment to remove from the commentRefs map
  1530. @param comment the comment to replace in the commentRefs map
  1531. </member>
  1532. <member name="M:NPOI.XSSF.Model.CommentsTable.FindAuthor(System.String)">
  1533. <summary>
  1534. Searches the author. If not found he is added to the list of authors.
  1535. </summary>
  1536. <param name="author">author to search</param>
  1537. <returns>index of the author</returns>
  1538. </member>
  1539. <member name="M:NPOI.XSSF.Model.CommentsTable.FindCellComment(System.String)">
  1540. Finds the cell comment at cellAddress, if one exists
  1541. @param cellAddress the address of the cell to find a comment
  1542. @return cell comment if one exists, otherwise returns null
  1543. @
  1544. </member>
  1545. <member name="M:NPOI.XSSF.Model.CommentsTable.FindCellComment(NPOI.SS.Util.CellAddress)">
  1546. Finds the cell comment at cellAddress, if one exists
  1547. @param cellAddress the address of the cell to find a comment
  1548. @return cell comment if one exists, otherwise returns null
  1549. </member>
  1550. <member name="M:NPOI.XSSF.Model.CommentsTable.GetCTComment(System.String)">
  1551. Get the underlying CTComment xmlbean for a comment located at cellRef, if it exists
  1552. @param cellRef the location of the cell comment
  1553. @return CTComment xmlbean if comment exists, otherwise return null.
  1554. @
  1555. </member>
  1556. <member name="M:NPOI.XSSF.Model.CommentsTable.GetCTComment(NPOI.SS.Util.CellAddress)">
  1557. Get the underlying CTComment xmlbean for a comment located at cellRef, if it exists
  1558. @param cellRef the location of the cell comment
  1559. @return CTComment xmlbean if comment exists, otherwise return null.
  1560. </member>
  1561. <member name="M:NPOI.XSSF.Model.CommentsTable.GetCellComments">
  1562. Returns all cell comments on this sheet.
  1563. @return A map of each Comment in this sheet, keyed on the cell address where
  1564. the comment is located.
  1565. </member>
  1566. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.Model.CommentsTable.PrepareCTCommentCache" -->
  1567. <member name="M:NPOI.XSSF.Model.CommentsTable.NewComment(System.String)">
  1568. Create a new comment located at cell address
  1569. @param ref the location to add the comment
  1570. @return a new CTComment located at ref with default author
  1571. </member>
  1572. <member name="M:NPOI.XSSF.Model.CommentsTable.NewComment(NPOI.SS.Util.CellAddress)">
  1573. Create a new comment located` at cell address
  1574. @param ref the location to add the comment
  1575. @return a new CTComment located at ref with default author
  1576. </member>
  1577. <member name="M:NPOI.XSSF.Model.CommentsTable.RemoveComment(System.String)">
  1578. Remove the comment at cellRef location, if one exists
  1579. @param cellRef the location of the comment to remove
  1580. @return returns true if a comment was removed
  1581. @deprecated 2015-11-23 (circa POI 3.14beta1). Use {@link #removeComment(CellAddress)} instead
  1582. </member>
  1583. <member name="M:NPOI.XSSF.Model.CommentsTable.RemoveComment(NPOI.SS.Util.CellAddress)">
  1584. Remove the comment at cellRef location, if one exists
  1585. @param cellRef the location of the comment to remove
  1586. @return returns true if a comment was removed
  1587. </member>
  1588. <member name="M:NPOI.XSSF.Model.CommentsTable.AddNewAuthor(System.String)">
  1589. Add a new author to the CommentsTable.
  1590. This does not check if the author already exists.
  1591. @param author the name of the comment author
  1592. @return the index of the new author
  1593. </member>
  1594. <member name="M:NPOI.XSSF.Model.CommentsTable.GetCTComments">
  1595. Returns the underlying CTComments list xmlbean
  1596. @return underlying comments list xmlbean
  1597. </member>
  1598. <member name="T:NPOI.XSSF.Model.ExternalLinksTable">
  1599. Holds details of links to parts of other workbooks (eg named ranges),
  1600. along with the most recently seen values for what they point to.
  1601. </member>
  1602. <member name="P:NPOI.XSSF.Model.ExternalLinksTable.CTExternalLink">
  1603. Returns the underlying xmlbeans object for the external
  1604. link table
  1605. </member>
  1606. <member name="P:NPOI.XSSF.Model.ExternalLinksTable.LinkedFileName">
  1607. get or set the last recorded name of the file that this
  1608. is linked to
  1609. </member>
  1610. <member name="T:NPOI.XSSF.Model.MapInfo">
  1611. This class : the Custom XML Mapping Part (Open Office XML Part 1:
  1612. chapter 12.3.6)
  1613. An instance of this part type Contains a schema for an XML file, and
  1614. information on the behavior that is used when allowing this custom XML schema
  1615. to be mapped into the spreadsheet.
  1616. @author Roberto Manicardi
  1617. </member>
  1618. <member name="P:NPOI.XSSF.Model.MapInfo.Workbook">
  1619. Returns the parent XSSFWorkbook
  1620. @return the parent XSSFWorkbook
  1621. </member>
  1622. <member name="M:NPOI.XSSF.Model.MapInfo.GetCTMapInfo">
  1623. @return the internal data object
  1624. </member>
  1625. <member name="M:NPOI.XSSF.Model.MapInfo.GetCTSchemaById(System.String)">
  1626. Gets the
  1627. @param schemaId the schema ID
  1628. @return CTSchema by it's ID
  1629. </member>
  1630. <member name="M:NPOI.XSSF.Model.MapInfo.GetAllXSSFMaps">
  1631. @return all the mappings configured in this document
  1632. </member>
  1633. <member name="T:NPOI.XSSF.Model.ParagraphPropertyFetcher">
  1634. Used internally to navigate the paragraph text style hierarchy within a shape and fetch properties
  1635. </member>
  1636. <member name="M:NPOI.XSSF.Model.ParagraphPropertyFetcher`1.Fetch(NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Shape)">
  1637. @param shape the shape being examined
  1638. @return true if the desired property was fetched
  1639. </member>
  1640. <member name="T:NPOI.XSSF.Model.SharedStringsTable">
  1641. Table of strings shared across all sheets in a workbook.
  1642. <p>
  1643. A workbook may contain thousands of cells Containing string (non-numeric) data. Furthermore this data is very
  1644. likely to be repeated across many rows or columns. The goal of implementing a single string table that is shared
  1645. across the workbook is to improve performance in opening and saving the file by only Reading and writing the
  1646. repetitive information once.
  1647. </p>
  1648. <p>
  1649. Consider for example a workbook summarizing information for cities within various countries. There may be a
  1650. column for the name of the country, a column for the name of each city in that country, and a column
  1651. Containing the data for each city. In this case the country name is repetitive, being duplicated in many cells.
  1652. In many cases the repetition is extensive, and a tremendous savings is realized by making use of a shared string
  1653. table when saving the workbook. When displaying text in the spreadsheet, the cell table will just contain an
  1654. index into the string table as the value of a cell, instead of the full string.
  1655. </p>
  1656. <p>
  1657. The shared string table Contains all the necessary information for displaying the string: the text, formatting
  1658. properties, and phonetic properties (for East Asian languages).
  1659. </p>
  1660. @author Nick Birch
  1661. @author Yegor Kozlov
  1662. </member>
  1663. <member name="F:NPOI.XSSF.Model.SharedStringsTable.strings">
  1664. Array of individual string items in the Shared String table.
  1665. </member>
  1666. <member name="F:NPOI.XSSF.Model.SharedStringsTable.stmap">
  1667. Maps strings and their indexes in the <code>strings</code> arrays
  1668. </member>
  1669. <member name="F:NPOI.XSSF.Model.SharedStringsTable.count">
  1670. An integer representing the total count of strings in the workbook. This count does not
  1671. include any numbers, it counts only the total of text strings in the workbook.
  1672. </member>
  1673. <member name="F:NPOI.XSSF.Model.SharedStringsTable.uniqueCount">
  1674. An integer representing the total count of unique strings in the Shared String Table.
  1675. A string is unique even if it is a copy of another string, but has different formatting applied
  1676. at the character level.
  1677. </member>
  1678. <member name="M:NPOI.XSSF.Model.SharedStringsTable.GetEntryAt(System.Int32)">
  1679. Return a string item by index
  1680. @param idx index of item to return.
  1681. @return the item at the specified position in this Shared String table.
  1682. </member>
  1683. <member name="P:NPOI.XSSF.Model.SharedStringsTable.Count">
  1684. Return an integer representing the total count of strings in the workbook. This count does not
  1685. include any numbers, it counts only the total of text strings in the workbook.
  1686. @return the total count of strings in the workbook
  1687. </member>
  1688. <member name="P:NPOI.XSSF.Model.SharedStringsTable.UniqueCount">
  1689. Returns an integer representing the total count of unique strings in the Shared String Table.
  1690. A string is unique even if it is a copy of another string, but has different formatting applied
  1691. at the character level.
  1692. @return the total count of unique strings in the workbook
  1693. </member>
  1694. <member name="M:NPOI.XSSF.Model.SharedStringsTable.AddEntry(NPOI.OpenXmlFormats.Spreadsheet.CT_Rst)">
  1695. Add an entry to this Shared String table (a new value is appened to the end).
  1696. <p>
  1697. If the Shared String table already Contains this <code>CT_Rst</code> bean, its index is returned.
  1698. Otherwise a new entry is aded.
  1699. </p>
  1700. @param st the entry to add
  1701. @return index the index of Added entry
  1702. </member>
  1703. <member name="P:NPOI.XSSF.Model.SharedStringsTable.Items">
  1704. Provide low-level access to the underlying array of CT_Rst beans
  1705. @return array of CT_Rst beans
  1706. </member>
  1707. <member name="M:NPOI.XSSF.Model.SharedStringsTable.WriteTo(System.IO.Stream)">
  1708. this table out as XML.
  1709. @param out The stream to write to.
  1710. @throws IOException if an error occurs while writing.
  1711. </member>
  1712. <member name="T:NPOI.XSSF.Model.SingleXmlCells">
  1713. This class : the Single Cell Tables Part (Open Office XML Part 4:
  1714. chapter 3.5.2)
  1715. @author Roberto Manicardi
  1716. </member>
  1717. <member name="M:NPOI.XSSF.Model.SingleXmlCells.GetAllSimpleXmlCell">
  1718. @return all the SimpleXmlCell Contained in this SingleXmlCells element
  1719. </member>
  1720. <member name="T:NPOI.XSSF.Model.StylesTable">
  1721. Table of styles shared across all sheets in a workbook.
  1722. @author ugo
  1723. </member>
  1724. <member name="F:NPOI.XSSF.Model.StylesTable.FIRST_CUSTOM_STYLE_ID">
  1725. The first style id available for use as a custom style
  1726. </member>
  1727. <member name="F:NPOI.XSSF.Model.StylesTable.MAXIMUM_NUMBER_OF_DATA_FORMATS">
  1728. Depending on the version of Excel, the maximum number of number formats in a workbook is between 200 and 250
  1729. See https://support.office.com/en-us/article/excel-specifications-and-limits-1672b34d-7043-467e-8e27-269d656771c3
  1730. POI defaults this limit to 250, but can be increased or decreased on a per-StylesTable basis with
  1731. {@link #setMaxNumberOfDataFormats(int)} if needed.
  1732. </member>
  1733. <member name="P:NPOI.XSSF.Model.StylesTable.MaxNumberOfDataFormats">
  1734. Get the upper limit on the number of data formats that has been set for the style table.
  1735. To get the current number of data formats in use, use {@link #getNumDataFormats()}.
  1736. @return the maximum number of data formats allowed in the workbook
  1737. </member>
  1738. <member name="M:NPOI.XSSF.Model.StylesTable.#ctor">
  1739. Create a new, empty StylesTable
  1740. </member>
  1741. <member name="M:NPOI.XSSF.Model.StylesTable.EnsureThemesTable">
  1742. If there isn't currently a {@link ThemesTable} for the
  1743. current Workbook, then creates one and sets it up.
  1744. After this, calls to {@link #getTheme()} won't give null
  1745. </member>
  1746. <member name="M:NPOI.XSSF.Model.StylesTable.ReadFrom(System.Xml.XmlDocument)">
  1747. Read this shared styles table from an XML file.
  1748. @param is The input stream Containing the XML document.
  1749. @throws IOException if an error occurs while Reading.
  1750. </member>
  1751. <member name="M:NPOI.XSSF.Model.StylesTable.GetNumberFormatAt(System.Int32)">
  1752. Get number format string given its id
  1753. @param idx number format id
  1754. @return number format code
  1755. </member>
  1756. <member name="M:NPOI.XSSF.Model.StylesTable.GetNumberFormatAt(System.Int16)">
  1757. Get number format string given its id
  1758. @param fmtId number format id
  1759. @return number format code
  1760. </member>
  1761. <member name="M:NPOI.XSSF.Model.StylesTable.PutNumberFormat(System.String)">
  1762. Puts <code>fmt</code> in the numberFormats map if the format is not
  1763. already in the the number format style table.
  1764. Does nothing if <code>fmt</code> is already in number format style table.
  1765. @param fmt the number format to add to number format style table
  1766. @return the index of <code>fmt</code> in the number format style table
  1767. </member>
  1768. <member name="M:NPOI.XSSF.Model.StylesTable.PutNumberFormat(System.Int16,System.String)">
  1769. Add a number format with a specific ID into the numberFormats map.
  1770. If a format with the same ID already exists, overwrite the format code
  1771. with <code>fmt</code>
  1772. This may be used to override built-in number formats.
  1773. @param index the number format ID
  1774. @param fmt the number format code
  1775. </member>
  1776. <member name="M:NPOI.XSSF.Model.StylesTable.RemoveNumberFormat(System.Int16)">
  1777. Remove a number format from the style table if it exists.
  1778. All cell styles with this number format will be modified to use the default number format.
  1779. @param fmt the number format to remove
  1780. @return true if the number format was removed
  1781. </member>
  1782. <member name="M:NPOI.XSSF.Model.StylesTable.RemoveNumberFormat(System.String)">
  1783. Remove a number format from the style table if it exists
  1784. All cell styles with this number format will be modified to use the default number format
  1785. @param fmt the number format to remove
  1786. @return true if the number format was removed
  1787. </member>
  1788. <member name="M:NPOI.XSSF.Model.StylesTable.PutFont(NPOI.XSSF.UserModel.XSSFFont,System.Boolean)">
  1789. Records the given font in the font table.
  1790. Will re-use an existing font index if this
  1791. font matches another, EXCEPT if forced
  1792. registration is requested.
  1793. This allows people to create several fonts
  1794. then customise them later.
  1795. Note - End Users probably want to call
  1796. {@link XSSFFont#registerTo(StylesTable)}
  1797. </member>
  1798. <member name="M:NPOI.XSSF.Model.StylesTable.PutBorder(NPOI.XSSF.UserModel.Extensions.XSSFCellBorder)">
  1799. <summary>
  1800. Adds a border to the border style table if it isn't already in the style table
  1801. Does nothing if border is already in borders style table
  1802. </summary>
  1803. <param name="border">border to add</param>
  1804. <returns>return the index of the added border</returns>
  1805. </member>
  1806. <member name="M:NPOI.XSSF.Model.StylesTable.PutFill(NPOI.XSSF.UserModel.Extensions.XSSFCellFill)">
  1807. <summary>
  1808. Adds a fill to the fill style table if it isn't already in the style table
  1809. Does nothing if fill is already in fill style table
  1810. </summary>
  1811. <param name="fill">fill to add</param>
  1812. <returns>return the index of the added fill</returns>
  1813. </member>
  1814. <member name="M:NPOI.XSSF.Model.StylesTable.PutCellXf(NPOI.OpenXmlFormats.Spreadsheet.CT_Xf)">
  1815. <summary>
  1816. Adds a cell to the styles table. Does not check for duplicates
  1817. </summary>
  1818. <param name="cellXf">the cell to add to the styles table</param>
  1819. <returns>return the added cell ID in the style table</returns>
  1820. </member>
  1821. <member name="M:NPOI.XSSF.Model.StylesTable.PutCellStyleXf(NPOI.OpenXmlFormats.Spreadsheet.CT_Xf)">
  1822. <summary>
  1823. Adds a cell style to the styles table.Does not check for duplicates.
  1824. </summary>
  1825. <param name="cellStyleXf">the cell style to add to the styles table</param>
  1826. <returns>return the cell style ID in the style table</returns>
  1827. </member>
  1828. <member name="P:NPOI.XSSF.Model.StylesTable.NumCellStyles">
  1829. get the size of cell styles
  1830. </member>
  1831. <member name="P:NPOI.XSSF.Model.StylesTable.NumDataFormats">
  1832. @return number of data formats in the styles table
  1833. </member>
  1834. <member name="P:NPOI.XSSF.Model.StylesTable.NumberFormatSize">
  1835. For unit testing only
  1836. </member>
  1837. <member name="P:NPOI.XSSF.Model.StylesTable.XfsSize">
  1838. For unit testing only
  1839. </member>
  1840. <member name="P:NPOI.XSSF.Model.StylesTable.StyleXfsSize">
  1841. For unit testing only
  1842. </member>
  1843. <member name="M:NPOI.XSSF.Model.StylesTable.GetCTStylesheet">
  1844. For unit testing only!
  1845. </member>
  1846. <member name="M:NPOI.XSSF.Model.StylesTable.WriteTo(System.IO.Stream)">
  1847. Write this table out as XML.
  1848. @param out The stream to write to.
  1849. @throws IOException if an error occurs while writing.
  1850. </member>
  1851. <member name="M:NPOI.XSSF.Model.StylesTable.PutDxf(NPOI.OpenXmlFormats.Spreadsheet.CT_Dxf)">
  1852. <summary>
  1853. Adds a Dxf to the style table Does not check for duplicates.
  1854. </summary>
  1855. <param name="dxf">the Dxf to add</param>
  1856. <returns>added dxf ID in the style table</returns>
  1857. </member>
  1858. <member name="M:NPOI.XSSF.Model.StylesTable.CreateCellStyle">
  1859. Create a cell style in this style table.
  1860. Note - End users probably want to call {@link XSSFWorkbook#createCellStyle()}
  1861. rather than working with the styles table directly.
  1862. </member>
  1863. <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)">
  1864. Finds a font that matches the one with the supplied attributes
  1865. </member>
  1866. <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)">
  1867. Finds a font that matches the one with the supplied attributes
  1868. </member>
  1869. <member name="T:NPOI.XSSF.Model.ThemesTable">
  1870. Class that represents theme of XLSX document. The theme includes specific
  1871. colors and fonts.
  1872. </member>
  1873. <member name="M:NPOI.XSSF.Model.ThemesTable.#ctor">
  1874. Create a new, empty ThemesTable
  1875. </member>
  1876. <member name="M:NPOI.XSSF.Model.ThemesTable.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  1877. Construct a ThemesTable.
  1878. @param part A PackagePart.
  1879. @param rel A PackageRelationship.
  1880. </member>
  1881. <member name="M:NPOI.XSSF.Model.ThemesTable.#ctor(NPOI.OpenXmlFormats.Spreadsheet.ThemeDocument)">
  1882. Construct a ThemesTable from an existing ThemeDocument.
  1883. @param theme A ThemeDocument.
  1884. </member>
  1885. <member name="M:NPOI.XSSF.Model.ThemesTable.GetThemeColor(System.Int32)">
  1886. Convert a theme "index" into a color.
  1887. @param idx A theme "index"
  1888. @return The mapped XSSFColor, or null if not mapped.
  1889. </member>
  1890. <member name="M:NPOI.XSSF.Model.ThemesTable.InheritFromThemeAsRequired(NPOI.XSSF.UserModel.XSSFColor)">
  1891. If the colour is based on a theme, then inherit
  1892. information (currently just colours) from it as
  1893. required.
  1894. </member>
  1895. <member name="M:NPOI.XSSF.Model.ThemesTable.writeTo(System.IO.Stream)">
  1896. Write this table out as XML.
  1897. @param out The stream to write to.
  1898. @throws IOException if an error occurs while writing.
  1899. </member>
  1900. <member name="F:NPOI.XSSF.Streaming.AutoSizeColumnTracker.maxColumnWidths">
  1901. <summary>
  1902. map of tracked columns, with values containing the best-fit width for the column
  1903. Using a HashMap instead of a TreeMap because insertion (trackColumn), removal (untrackColumn), and membership (everything)
  1904. will be called more frequently than getTrackedColumns(). The O(1) cost of insertion, removal, and membership operations
  1905. outweigh the infrequent O(n*log n) cost of sorting getTrackedColumns().
  1906. Memory consumption for a HashMap and TreeMap is about the same
  1907. </summary>
  1908. </member>
  1909. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.ColumnWidthPair.GetMaxColumnWidth(System.Boolean)">
  1910. Gets the current best-fit column width for the provided settings
  1911. @param useMergedCells true if merged cells are considered into the best-fit column width calculation
  1912. @return best fit column width, measured in default character widths.
  1913. </member>
  1914. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.ColumnWidthPair.SetMaxColumnWidths(System.Double,System.Double)">
  1915. Sets the best-fit column width to the maximum of the current width and the provided width
  1916. @param unmergedWidth the best-fit column width calculated with useMergedCells=False
  1917. @param mergedWidth the best-fit column width calculated with useMergedCells=True
  1918. </member>
  1919. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.#ctor(NPOI.SS.UserModel.ISheet)">
  1920. AutoSizeColumnTracker constructor. Holds no reference to <code>sheet</code>
  1921. @param sheet the sheet associated with this auto-size column tracker
  1922. @since 3.14beta1
  1923. </member>
  1924. <member name="P:NPOI.XSSF.Streaming.AutoSizeColumnTracker.TrackedColumns">
  1925. Get the currently tracked columns, naturally ordered.
  1926. Note if all columns are tracked, this will only return the columns that have been explicitly or implicitly tracked,
  1927. which is probably only columns containing 1 or more non-blank values
  1928. @return a set of the indices of all tracked columns
  1929. @since 3.14beta1
  1930. </member>
  1931. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.IsColumnTracked(System.Int32)">
  1932. Returns true if column is currently tracked for auto-sizing.
  1933. @param column the index of the column to check
  1934. @return true if column is tracked
  1935. @since 3.14beta1
  1936. </member>
  1937. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.IsAllColumnsTracked">
  1938. Returns true if all columns are implicitly tracked.
  1939. @return true if all columns are implicitly tracked
  1940. @since 3.14beta1
  1941. </member>
  1942. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.TrackAllColumns">
  1943. Tracks all non-blank columns
  1944. Allows columns that have been explicitly untracked to be tracked
  1945. @since 3.14beta1
  1946. </member>
  1947. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.UntrackAllColumns">
  1948. Untrack all columns that were previously tracked for auto-sizing.
  1949. All best-fit column widths are forgotten.
  1950. @since 3.14beta1
  1951. </member>
  1952. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.TrackColumns(System.Collections.Generic.ICollection{System.Int32})">
  1953. Marks multiple columns for inclusion in auto-size column tracking.
  1954. Note this has undefined behavior if columns are tracked after one or more rows are written to the sheet.
  1955. Any column in <code>columns</code> that are already tracked are ignored by this call.
  1956. @param columns the indices of the columns to track
  1957. @since 3.14beta1
  1958. </member>
  1959. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.TrackColumn(System.Int32)">
  1960. Marks a column for inclusion in auto-size column tracking.
  1961. Note this has undefined behavior if a column is tracked after one or more rows are written to the sheet.
  1962. If <code>column</code> is already tracked, this call does nothing.
  1963. @param column the index of the column to track for auto-sizing
  1964. @return if column is already tracked, the call does nothing and returns false
  1965. @since 3.14beta1
  1966. </member>
  1967. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.ImplicitlyTrackColumn(System.Int32)">
  1968. Implicitly track a column if it has not been explicitly untracked
  1969. If it has been explicitly untracked, this call does nothing and returns false.
  1970. Otherwise return true
  1971. @param column the column to implicitly track
  1972. @return false if column has been explicitly untracked, otherwise return true
  1973. </member>
  1974. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.UntrackColumns(System.Collections.Generic.ICollection{System.Int32})">
  1975. Removes columns that were previously marked for inclusion in auto-size column tracking.
  1976. When a column is untracked, the best-fit width is forgotten.
  1977. Any column in <code>columns</code> that is not tracked will be ignored by this call.
  1978. @param columns the indices of the columns to track for auto-sizing
  1979. @return true if one or more columns were untracked as a result of this call
  1980. @since 3.14beta1
  1981. </member>
  1982. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.UntrackColumn(System.Int32)">
  1983. Removes a column that was previously marked for inclusion in auto-size column tracking.
  1984. When a column is untracked, the best-fit width is forgotten.
  1985. If <code>column</code> is not tracked, it will be ignored by this call.
  1986. @param column the index of the column to track for auto-sizing
  1987. @return true if column was tracked prior this call, false if no action was taken
  1988. @since 3.14beta1
  1989. </member>
  1990. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.GetBestFitColumnWidth(System.Int32,System.Boolean)">
  1991. Get the best-fit width of a tracked column
  1992. @param column the index of the column to get the current best-fit width of
  1993. @param useMergedCells true if merged cells should be considered when computing the best-fit width
  1994. @return best-fit column width, measured in number of characters
  1995. @throws InvalidOperationException if column is not tracked and trackAllColumns is false
  1996. @since 3.14beta1
  1997. </member>
  1998. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.UpdateColumnWidths(NPOI.SS.UserModel.IRow)">
  1999. Calculate the best fit width for each tracked column in row
  2000. @param row the row to get the cells
  2001. @since 3.14beta1
  2002. </member>
  2003. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.ImplicitlyTrackColumnsInRow(NPOI.SS.UserModel.IRow)">
  2004. Helper for {@link #updateColumnWidths(Row)}.
  2005. Implicitly track the columns corresponding to the cells in row.
  2006. If all columns in the row are already tracked, this call does nothing.
  2007. Explicitly untracked columns will not be tracked.
  2008. @param row the row containing cells to implicitly track the columns
  2009. @since 3.14beta1
  2010. </member>
  2011. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.UpdateColumnWidth(NPOI.SS.UserModel.ICell,NPOI.XSSF.Streaming.AutoSizeColumnTracker.ColumnWidthPair)">
  2012. Helper for {@link #updateColumnWidths(Row)}.
  2013. @param cell the cell to compute the best fit width on
  2014. @param pair the column width pair to update
  2015. @since 3.14beta1
  2016. </member>
  2017. <member name="M:NPOI.XSSF.Streaming.GZIPSheetDataWriter.#ctor(NPOI.XSSF.Model.SharedStringsTable)">
  2018. @param sharedStringsTable the shared strings table, or null if inline text is used
  2019. </member>
  2020. <member name="M:NPOI.XSSF.Streaming.GZIPSheetDataWriter.CreateTempFile">
  2021. @return temp file to write sheet data
  2022. </member>
  2023. <member name="F:NPOI.XSSF.Streaming.SheetDataWriter._sharedStringSource">
  2024. Table of strings shared across this workbook.
  2025. If two cells contain the same string, then the cell value is the same index into SharedStringsTable
  2026. </member>
  2027. <member name="M:NPOI.XSSF.Streaming.SheetDataWriter.CreateTempFile">
  2028. Create a temp file to write sheet data.
  2029. By default, temp files are created in the default temporary-file directory
  2030. with a prefix "poi-sxssf-sheet" and suffix ".xml". Subclasses can override
  2031. it and specify a different temp directory or filename or suffix, e.g. <code>.gz</code>
  2032. @return temp file to write sheet data
  2033. </member>
  2034. <member name="M:NPOI.XSSF.Streaming.SheetDataWriter.CreateWriter(System.IO.FileInfo)">
  2035. Create a writer for the sheet data.
  2036. @param fd the file to write to
  2037. </member>
  2038. <member name="M:NPOI.XSSF.Streaming.SheetDataWriter.DecorateOutputStream(System.IO.Stream)">
  2039. Override this to translate (such as encrypt or compress) the file output stream
  2040. as it is being written to disk.
  2041. The default behavior is to to pass the stream through unmodified.
  2042. @param fos the stream to decorate
  2043. @return a decorated stream
  2044. @throws IOException
  2045. @see #decorateInputStream(FileInputStream)
  2046. </member>
  2047. <member name="M:NPOI.XSSF.Streaming.SheetDataWriter.Close">
  2048. flush and close the temp data writer.
  2049. This method <em>must</em> be invoked before calling {@link #getWorksheetXMLInputStream()}
  2050. </member>
  2051. <member name="M:NPOI.XSSF.Streaming.SheetDataWriter.GetWorksheetXmlInputStream">
  2052. @return a stream to read temp file with the sheet data
  2053. </member>
  2054. <member name="M:NPOI.XSSF.Streaming.SheetDataWriter.DecorateInputStream(System.IO.Stream)">
  2055. Override this to translate (such as decrypt or expand) the file input stream
  2056. as it is being read from disk.
  2057. The default behavior is to to pass the stream through unmodified.
  2058. @param fis the stream to decorate
  2059. @return a decorated stream
  2060. @throws IOException
  2061. @see #decorateOutputStream(FileOutputStream)
  2062. </member>
  2063. <member name="M:NPOI.XSSF.Streaming.SheetDataWriter.WriteRow(System.Int32,NPOI.XSSF.Streaming.SXSSFRow)">
  2064. Write a row to the file
  2065. @param rownum 0-based row number
  2066. @param row a row
  2067. </member>
  2068. <member name="M:NPOI.XSSF.Streaming.SheetDataWriter.HasLeadingTrailingSpaces(System.String)">
  2069. @return whether the string has leading / trailing spaces that
  2070. need to be preserved with the xml:space=\"preserve\" attribute
  2071. </member>
  2072. <member name="M:NPOI.XSSF.Streaming.SheetDataWriter.Dispose">
  2073. Deletes the temporary file that backed this sheet on disk.
  2074. @return true if the file was deleted, false if it wasn't.
  2075. </member>
  2076. <member name="M:NPOI.XSSF.Streaming.SXSSFCell.typeMismatch(NPOI.SS.UserModel.CellType,NPOI.SS.UserModel.CellType,System.Boolean)">
  2077. Used to help format error messages
  2078. </member>
  2079. <member name="P:NPOI.XSSF.Streaming.SXSSFEvaluationCell.CellType">
  2080. Will return {@link CellType} in a future version of POI.
  2081. For forwards compatibility, do not hard-code cell type literals in your code.
  2082. @return cell type
  2083. </member>
  2084. <member name="P:NPOI.XSSF.Streaming.SXSSFEvaluationCell.CellTypeEnum">
  2085. @since POI 3.15 beta 3
  2086. @deprecated POI 3.15 beta 3.
  2087. Will be deleted when we make the CellType enum transition. See bug 59791.
  2088. </member>
  2089. <member name="P:NPOI.XSSF.Streaming.SXSSFEvaluationCell.CachedFormulaResultType">
  2090. <summary>
  2091. Will return CellType in a future version of POI. For forwards compatibility, do not hard-code cell type literals in your code.
  2092. </summary>
  2093. </member>
  2094. <member name="M:NPOI.XSSF.Streaming.SXSSFEvaluationCell.GetCachedFormulaResultTypeEnum">
  2095. @since POI 3.15 beta 3
  2096. @deprecated POI 3.15 beta 3.
  2097. Will be deleted when we make the CellType enum transition. See bug 59791.
  2098. </member>
  2099. <member name="M:NPOI.XSSF.Streaming.SXSSFFormulaEvaluator.EvaluateAll">
  2100. Loops over rows and cells, evaluating formula cells there.
  2101. If any sheets are inactive, or any cells outside of the window,
  2102. will give an Exception.
  2103. For SXSSF, you generally don't want to use this method, instead
  2104. evaluate your formulas as you go before they leave the window.
  2105. </member>
  2106. <member name="M:NPOI.XSSF.Streaming.SXSSFRow.CompareTo(NPOI.XSSF.Streaming.SXSSFRow)">
  2107. Compares two <code>SXSSFRow</code> objects. Two rows are equal if they belong to the same worksheet and
  2108. their row indexes are equal.
  2109. @param other the <code>SXSSFRow</code> to be compared.
  2110. @return <ul>
  2111. <li>
  2112. the value <code>0</code> if the row number of this <code>SXSSFRow</code> is
  2113. equal to the row number of the argument <code>SXSSFRow</code>
  2114. </li>
  2115. <li>
  2116. a value less than <code>0</code> if the row number of this this <code>SXSSFRow</code> is
  2117. numerically less than the row number of the argument <code>SXSSFRow</code>
  2118. </li>
  2119. <li>
  2120. a value greater than <code>0</code> if the row number of this this <code>SXSSFRow</code> is
  2121. numerically greater than the row number of the argument <code>SXSSFRow</code>
  2122. </li>
  2123. </ul>
  2124. @throws IllegalArgumentException if the argument row belongs to a different worksheet
  2125. </member>
  2126. <member name="M:NPOI.XSSF.Streaming.SXSSFRow.CheckBounds(System.Int32)">
  2127. <summary>
  2128. throws RuntimeException if the bounds are exceeded.
  2129. </summary>
  2130. <param name="cellIndex"></param>
  2131. </member>
  2132. <member name="M:NPOI.XSSF.Streaming.SXSSFRow.GetCellIndex(NPOI.XSSF.Streaming.SXSSFCell)">
  2133. Return the column number of a cell if it is in this row
  2134. Otherwise return -1
  2135. @param cell the cell to get the index of
  2136. @return cell column index if it is in this row, -1 otherwise
  2137. </member>
  2138. <member name="T:NPOI.XSSF.Streaming.SXSSFRow.FilledCellIterator">
  2139. Create an iterator over the cells from [0, getLastCellNum()).
  2140. Includes blank cells, excludes empty cells
  2141. Returns an iterator over all filled cells (created via Row.createCell())
  2142. Throws ConcurrentModificationException if cells are added, moved, or
  2143. removed after the iterator is created.
  2144. </member>
  2145. <member name="P:NPOI.XSSF.Streaming.SXSSFSheet.IsPrintRowAndColumnHeadings">
  2146. Returns whether row and column headings are printed.
  2147. @return whether row and column headings are printed
  2148. </member>
  2149. <member name="P:NPOI.XSSF.Streaming.SXSSFSheet.MergedRegions">
  2150. Returns the list of merged regions. If you want multiple regions, this is
  2151. faster than calling {@link #getMergedRegion(int)} each time.
  2152. @return the list of merged regions
  2153. </member>
  2154. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.AddMergedRegionUnsafe(NPOI.SS.Util.CellRangeAddress)">
  2155. <summary>
  2156. Adds a merged region of cells (hence those cells form one).
  2157. Skips validation.It is possible to create overlapping merged regions
  2158. or create a merged region that intersects a multi-cell array formula
  2159. with this formula, which may result in a corrupt workbook.
  2160. </summary>
  2161. <param name="region">region to merge</param>
  2162. <returns>index of this region</returns>
  2163. <exception cref="T:System.ArgumentException">if region contains fewer than 2 cells</exception>
  2164. </member>
  2165. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.ValidateMergedRegions">
  2166. Verify that merged regions do not intersect multi-cell array formulas and
  2167. no merged regions intersect another merged region in this sheet.
  2168. @throws InvalidOperationException if region intersects with a multi-cell array formula
  2169. @throws InvalidOperationException if at least one region intersects with another merged region in this sheet
  2170. </member>
  2171. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.AutoSizeColumn(System.Int32)">
  2172. Adjusts the column width to fit the contents.
  2173. <p>
  2174. This process can be relatively slow on large sheets, so this should
  2175. normally only be called once per column, at the end of your
  2176. processing.
  2177. </p>
  2178. You can specify whether the content of merged cells should be considered or ignored.
  2179. Default is to ignore merged cells.
  2180. <p>
  2181. Special note about SXSSF implementation: You must register the columns you wish to track with
  2182. the SXSSFSheet using {@link #trackColumnForAutoSizing(int)} or {@link #trackAllColumnsForAutoSizing()}.
  2183. This is needed because the rows needed to compute the column width may have fallen outside the
  2184. random access window and been flushed to disk.
  2185. Tracking columns is required even if all rows are in the random access window.
  2186. </p>
  2187. <p><i>New in POI 3.14 beta 1: auto-sizes columns using cells from current and flushed rows.</i></p>
  2188. @param column the column index to auto-size
  2189. </member>
  2190. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.AutoSizeColumn(System.Int32,System.Boolean)">
  2191. Adjusts the column width to fit the contents.
  2192. <p>
  2193. This process can be relatively slow on large sheets, so this should
  2194. normally only be called once per column, at the end of your
  2195. processing.
  2196. </p>
  2197. You can specify whether the content of merged cells should be considered or ignored.
  2198. Default is to ignore merged cells.
  2199. <p>
  2200. Special note about SXSSF implementation: You must register the columns you wish to track with
  2201. the SXSSFSheet using {@link #trackColumnForAutoSizing(int)} or {@link #trackAllColumnsForAutoSizing()}.
  2202. This is needed because the rows needed to compute the column width may have fallen outside the
  2203. random access window and been flushed to disk.
  2204. Tracking columns is required even if all rows are in the random access window.
  2205. </p>
  2206. <p><i>New in POI 3.14 beta 1: auto-sizes columns using cells from current and flushed rows.</i></p>
  2207. @param column the column index to auto-size
  2208. @param useMergedCells whether to use the contents of merged cells when calculating the width of the column
  2209. </member>
  2210. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.CopyComment(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.ICell)">
  2211. <summary>
  2212. Copies comment from one cell to another
  2213. </summary>
  2214. <param name="sourceCell">Cell with a comment to copy</param>
  2215. <param name="targetCell">Cell to paste the comment to</param>
  2216. <returns>Copied comment</returns>
  2217. </member>
  2218. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.GetHyperlink(System.Int32,System.Int32)">
  2219. <summary>
  2220. Get a Hyperlink in this sheet anchored at row, column
  2221. </summary>
  2222. <param name="row">The index of the row of the hyperlink, zero-based</param>
  2223. <param name="column">the index of the column of the hyperlink, zero-based</param>
  2224. <returns>return hyperlink if there is a hyperlink anchored at row, column; otherwise returns null</returns>
  2225. </member>
  2226. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.GetHyperlink(NPOI.SS.Util.CellAddress)">
  2227. <summary>
  2228. Get a Hyperlink in this sheet located in a cell specified by {code addr}
  2229. </summary>
  2230. <param name="addr">The address of the cell containing the hyperlink</param>
  2231. <returns>return hyperlink if there is a hyperlink anchored at {@code addr}; otherwise returns {@code null}</returns>
  2232. </member>
  2233. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.GetHyperlinkList">
  2234. Get a list of Hyperlinks in this sheet
  2235. @return Hyperlinks for the sheet
  2236. </member>
  2237. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.GetCellComment(System.Int32,System.Int32)">
  2238. <summary>
  2239. Returns cell comment for the specified row and column
  2240. </summary>
  2241. <param name="row">The row.</param>
  2242. <param name="column">The column.</param>
  2243. <returns>cell comment or <code>null</code> if not found</returns>
  2244. </member>
  2245. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.GetCellComment(NPOI.SS.Util.CellAddress)">
  2246. <summary>
  2247. Returns cell comment for the specified location
  2248. </summary>
  2249. <param name="ref1">cell location</param>
  2250. <returns>return cell comment or null if not found</returns>
  2251. </member>
  2252. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.GetCellComments">
  2253. <summary>
  2254. Returns all cell comments on this sheet.
  2255. </summary>
  2256. <returns>return A Dictionary of each Comment in the sheet, keyed on the cell address where the comment is located.</returns>
  2257. </member>
  2258. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.SetRowOutlineLevel(System.Int32,System.Int32)">
  2259. Set row groupings (like groupRow) in a stream-friendly manner
  2260. <p>
  2261. groupRows requires all rows in the group to be in the current window.
  2262. This is not always practical. Instead use setRowOutlineLevel to
  2263. explicitly set the group level. Level 1 is the top level group,
  2264. followed by 2, etc. It is up to the user to ensure that level 2
  2265. groups are correctly nested under level 1, etc.
  2266. </p>
  2267. @param rownum index of row to update (0-based)
  2268. @param level outline level (greater than 0)
  2269. </member>
  2270. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.RemoveMergedRegions(System.Collections.Generic.IList{System.Int32})">
  2271. Removes a merged region of cells (hence letting them free)
  2272. @param indices of the regions to unmerge
  2273. </member>
  2274. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.TrackColumnForAutoSizing(System.Int32)">
  2275. Track a column in the sheet for auto-sizing.
  2276. Note this has undefined behavior if a column is tracked after one or more rows are written to the sheet.
  2277. If <code>column</code> is already tracked, this call does nothing.
  2278. @param column the column to track for autosizing
  2279. @since 3.14beta1
  2280. @see #trackColumnsForAutoSizing(Collection)
  2281. @see #trackAllColumnsForAutoSizing()
  2282. </member>
  2283. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.TrackColumnsForAutoSizing(System.Collections.Generic.ICollection{System.Int32})">
  2284. Track several columns in the sheet for auto-sizing.
  2285. Note this has undefined behavior if columns are tracked after one or more rows are written to the sheet.
  2286. Any column in <code>columns</code> that are already tracked are ignored by this call.
  2287. @param columns the columns to track for autosizing
  2288. @since 3.14beta1
  2289. </member>
  2290. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.TrackAllColumnsForAutoSizing">
  2291. Tracks all columns in the sheet for auto-sizing. If this is called, individual columns do not need to be tracked.
  2292. Because determining the best-fit width for a cell is expensive, this may affect the performance.
  2293. @since 3.14beta1
  2294. </member>
  2295. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.UntrackColumnForAutoSizing(System.Int32)">
  2296. Removes a column that was previously marked for inclusion in auto-size column tracking.
  2297. When a column is untracked, the best-fit width is forgotten.
  2298. If <code>column</code> is not tracked, it will be ignored by this call.
  2299. @param column the index of the column to track for auto-sizing
  2300. @return true if column was tracked prior to this call, false if no action was taken
  2301. @since 3.14beta1
  2302. @see #untrackColumnsForAutoSizing(Collection)
  2303. @see #untrackAllColumnsForAutoSizing(int)
  2304. </member>
  2305. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.UntrackColumnsForAutoSizing(System.Collections.Generic.ICollection{System.Int32})">
  2306. Untracks several columns in the sheet for auto-sizing.
  2307. When a column is untracked, the best-fit width is forgotten.
  2308. Any column in <code>columns</code> that is not tracked will be ignored by this call.
  2309. @param columns the indices of the columns to track for auto-sizing
  2310. @return true if one or more columns were untracked as a result of this call
  2311. @param columns the columns to track for autosizing
  2312. @since 3.14beta1
  2313. </member>
  2314. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.UntrackAllColumnsForAutoSizing">
  2315. Untracks all columns in the sheet for auto-sizing. Best-fit column widths are forgotten.
  2316. If this is called, individual columns do not need to be untracked.
  2317. @since 3.14beta1
  2318. </member>
  2319. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.IsColumnTrackedForAutoSizing(System.Int32)">
  2320. Returns true if column is currently tracked for auto-sizing.
  2321. @param column the index of the column to check
  2322. @return true if column is tracked
  2323. @since 3.14beta1
  2324. </member>
  2325. <member name="P:NPOI.XSSF.Streaming.SXSSFSheet.TrackedColumnsForAutoSizing">
  2326. Get the currently tracked columns for auto-sizing.
  2327. Note if all columns are tracked, this will only return the columns that have been explicitly or implicitly tracked,
  2328. which is probably only columns containing 1 or more non-blank values
  2329. @return a set of the indices of all tracked columns
  2330. @since 3.14beta1
  2331. </member>
  2332. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.FindStartOfRowOutlineGroup(System.Int32)">
  2333. @param rowIndex the zero based row index to find from
  2334. </member>
  2335. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.Streaming.SXSSFSheet.SetZoom(System.Int32)" -->
  2336. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.FlushRows(System.Int32,System.Boolean)">
  2337. Specifies how many rows can be accessed at most via getRow().
  2338. The exceeding rows (if any) are flushed to the disk while rows
  2339. with lower index values are flushed first.
  2340. </member>
  2341. <member name="P:NPOI.XSSF.Streaming.SXSSFSheet.LastFlushedRowNumber">
  2342. @return Last row number to be flushed to disk, or -1 if none flushed yet
  2343. </member>
  2344. <member name="T:NPOI.XSSF.Streaming.SXSSFWorkbook">
  2345. Streaming version of XSSFWorkbook implementing the "BigGridDemo" strategy.
  2346. This allows to write very large files without running out of memory as only
  2347. a configurable portion of the rows are kept in memory at any one time.
  2348. You can provide a template workbook which is used as basis for the written
  2349. data.
  2350. See https://poi.apache.org/spreadsheet/how-to.html#sxssf for details.
  2351. Please note that there are still things that still may consume a large
  2352. amount of memory based on which features you are using, e.g. merged regions,
  2353. comments, ... are still only stored in memory and thus may require a lot of
  2354. memory if used extensively.
  2355. SXSSFWorkbook defaults to using inline strings instead of a shared strings
  2356. table. This is very efficient, since no document content needs to be kept in
  2357. memory, but is also known to produce documents that are incompatible with
  2358. some clients. With shared strings enabled all unique strings in the document
  2359. has to be kept in memory. Depending on your document content this could use
  2360. a lot more resources than with shared strings disabled.
  2361. Carefully review your memory budget and compatibility needs before deciding
  2362. whether to enable shared strings or not.
  2363. <summary>
  2364. Streaming version of the XSSFWorkbook, originally implemented in the "BigGridDemo".
  2365. </summary>
  2366. </member>
  2367. <member name="P:NPOI.XSSF.Streaming.SXSSFWorkbook.RandomAccessWindowSize">
  2368. See the constructors for a more detailed description of the sliding window of rows.
  2369. @return The number of rows that are kept in memory at once before flushing them out.
  2370. </member>
  2371. <member name="F:NPOI.XSSF.Streaming.SXSSFWorkbook._compressTmpFiles">
  2372. <summary>
  2373. whether temp file should be compresss.
  2374. </summary>
  2375. </member>
  2376. <member name="F:NPOI.XSSF.Streaming.SXSSFWorkbook._sharedStringSource">
  2377. <summary>
  2378. shared string table - a cache of strings in this workbook.
  2379. </summary>
  2380. </member>
  2381. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.#ctor(System.Int32)">
  2382. Construct an empty workbook and specify the window for row access.
  2383. <p>
  2384. When a new node is created via createRow() and the total number
  2385. of unflushed records would exceed the specified value, then the
  2386. row with the lowest index value is flushed and cannot be accessed
  2387. via getRow() anymore.
  2388. </p>
  2389. <p>
  2390. A value of -1 indicates unlimited access. In this case all
  2391. records that have not been flushed by a call to flush() are available
  2392. for random access.
  2393. </p>
  2394. <p>
  2395. A value of 0 is not allowed because it would flush any newly created row
  2396. without having a chance to specify any cells.
  2397. </p>
  2398. @param rowAccessWindowSize the number of rows that are kept in memory until flushed out, see above.
  2399. </member>
  2400. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.#ctor">
  2401. <summary>
  2402. Construct a new workbook with default row window size
  2403. </summary>
  2404. </member>
  2405. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.#ctor(NPOI.XSSF.UserModel.XSSFWorkbook)">
  2406. Construct a workbook from a template.
  2407. <p>
  2408. There are three use-cases to use SXSSFWorkbook(XSSFWorkbook) :
  2409. <ol>
  2410. <li>
  2411. Append new sheets to existing workbooks. You can open existing
  2412. workbook from a file or create on the fly with XSSF.
  2413. </li>
  2414. <li>
  2415. Append rows to existing sheets. The row number MUST be greater
  2416. than max(rownum) in the template sheet.
  2417. </li>
  2418. <li>
  2419. Use existing workbook as a template and re-use global objects such
  2420. as cell styles, formats, images, etc.
  2421. </li>
  2422. </ol>
  2423. All three use cases can work in a combination.
  2424. </p>
  2425. What is not supported:
  2426. <ul>
  2427. <li>
  2428. Access initial cells and rows in the template. After constructing
  2429. SXSSFWorkbook(XSSFWorkbook) all internal windows are empty and
  2430. SXSSFSheet@getRow and SXSSFRow#getCell return null.
  2431. </li>
  2432. <li>
  2433. Override existing cells and rows. The API silently allows that but
  2434. the output file is invalid and Excel cannot read it.
  2435. </li>
  2436. </ul>
  2437. @param workbook the template workbook
  2438. </member>
  2439. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.#ctor(NPOI.XSSF.UserModel.XSSFWorkbook,System.Int32)">
  2440. Constructs an workbook from an existing workbook.
  2441. <p>
  2442. When a new node is created via createRow() and the total number
  2443. of unflushed records would exceed the specified value, then the
  2444. row with the lowest index value is flushed and cannot be accessed
  2445. via getRow() anymore.
  2446. </p>
  2447. <p>
  2448. A value of -1 indicates unlimited access. In this case all
  2449. records that have not been flushed by a call to flush() are available
  2450. for random access.
  2451. </p>
  2452. <p>
  2453. A value of 0 is not allowed because it would flush any newly created row
  2454. without having a chance to specify any cells.
  2455. </p>
  2456. @param rowAccessWindowSize the number of rows that are kept in memory until flushed out, see above.
  2457. </member>
  2458. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.#ctor(NPOI.XSSF.UserModel.XSSFWorkbook,System.Int32,System.Boolean)">
  2459. Constructs an workbook from an existing workbook.
  2460. <p>
  2461. When a new node is created via createRow() and the total number
  2462. of unflushed records would exceed the specified value, then the
  2463. row with the lowest index value is flushed and cannot be accessed
  2464. via getRow() anymore.
  2465. </p>
  2466. <p>
  2467. A value of -1 indicates unlimited access. In this case all
  2468. records that have not been flushed by a call to flush() are available
  2469. for random access.
  2470. </p>
  2471. <p>
  2472. A value of 0 is not allowed because it would flush any newly created row
  2473. without having a chance to specify any cells.
  2474. </p>
  2475. @param rowAccessWindowSize the number of rows that are kept in memory until flushed out, see above.
  2476. @param compressTmpFiles whether to use gzip compression for temporary files
  2477. </member>
  2478. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.#ctor(NPOI.XSSF.UserModel.XSSFWorkbook,System.Int32,System.Boolean,System.Boolean)">
  2479. Constructs an workbook from an existing workbook.
  2480. <p>
  2481. When a new node is created via createRow() and the total number
  2482. of unflushed records would exceed the specified value, then the
  2483. row with the lowest index value is flushed and cannot be accessed
  2484. via getRow() anymore.
  2485. </p>
  2486. <p>
  2487. A value of -1 indicates unlimited access. In this case all
  2488. records that have not been flushed by a call to flush() are available
  2489. for random access.
  2490. </p>
  2491. <p>
  2492. A value of 0 is not allowed because it would flush any newly created row
  2493. without having a chance to specify any cells.
  2494. </p>
  2495. @param workbook the template workbook
  2496. @param rowAccessWindowSize the number of rows that are kept in memory until flushed out, see above.
  2497. @param compressTmpFiles whether to use gzip compression for temporary files
  2498. @param useSharedStringsTable whether to use a shared strings table
  2499. <summary>
  2500. Currently only supports writing not reading. E.g. the number of rows returned from a worksheet will be wrong etc.
  2501. </summary>
  2502. <param name="workbook"></param>
  2503. <param name="rowAccessWindowSize"></param>
  2504. <param name="compressTmpFiles"></param>
  2505. <param name="useSharedStringsTable"></param>
  2506. </member>
  2507. <member name="P:NPOI.XSSF.Streaming.SXSSFWorkbook.CompressTempFiles">
  2508. Set whether temp files should be compressed.
  2509. <p>
  2510. SXSSF writes sheet data in temporary files (a temp file per-sheet)
  2511. and the size of these temp files can grow to to a very large size,
  2512. e.g. for a 20 MB csv data the size of the temp xml file become few GB large.
  2513. If the "compress" flag is set to <code>true</code> then the temporary XML is gzipped.
  2514. </p>
  2515. <p>
  2516. Please note the the "compress" option may cause performance penalty.
  2517. </p>
  2518. @param compress whether to compress temp files
  2519. </member>
  2520. <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)">
  2521. Finds a font that matches the one with the supplied attributes
  2522. @return the font with the matched attributes or <code>null</code>
  2523. </member>
  2524. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.Dispose">
  2525. Dispose of temporary files backing this workbook on disk.
  2526. Calling this method will render the workbook unusable.
  2527. @return true if all temporary files were deleted successfully.
  2528. </member>
  2529. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.GetNames(System.String)">
  2530. Returns all defined names with the given name.
  2531. @param name the name of the defined name
  2532. @return a list of the defined names with the specified name. An empty list is returned if none is found.
  2533. </member>
  2534. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.GetAllNames">
  2535. <summary>
  2536. Returns all defined names
  2537. </summary>
  2538. <returns>Returns all defined names</returns>
  2539. </member>
  2540. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.RemoveName(NPOI.SS.UserModel.IName)">
  2541. <summary>
  2542. Remove the given defined name
  2543. </summary>
  2544. <param name="name">the name to remove</param>
  2545. </member>
  2546. <member name="P:NPOI.XSSF.Streaming.SXSSFWorkbook.SpreadsheetVersion">
  2547. <summary>
  2548. Returns the spreadsheet version (EXCLE2007) of this workbook
  2549. </summary>
  2550. </member>
  2551. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.IsDate1904">
  2552. <summary>
  2553. Gets a bool value that indicates whether the date systems used in the workbook starts in 1904.
  2554. The default value is false, meaning that the workbook uses the 1900 date system,
  2555. where 1/1/1900 is the first day in the system.
  2556. </summary>
  2557. <returns>True if the date systems used in the workbook starts in 1904</returns>
  2558. </member>
  2559. <member name="T:NPOI.XSSF.UserModel.BaseXSSFEvaluationWorkbook">
  2560. Internal POI use only - parent of XSSF and SXSSF Evaluation workbooks
  2561. </member>
  2562. <member name="M:NPOI.XSSF.UserModel.BaseXSSFEvaluationWorkbook.ConvertFromExternSheetIndex(System.Int32)">
  2563. XSSF doesn't use external sheet indexes, so when asked treat
  2564. it just as a local index
  2565. </member>
  2566. <member name="M:NPOI.XSSF.UserModel.BaseXSSFEvaluationWorkbook.ConvertToExternalSheetIndex(System.Int32)">
  2567. @return the external sheet index of the sheet with the given internal
  2568. index. Used by some of the more obscure formula and named range things.
  2569. Fairly easy on XSSF (we think...) since the internal and external
  2570. indices are the same
  2571. </member>
  2572. <member name="M:NPOI.XSSF.UserModel.BaseXSSFEvaluationWorkbook.GetName(System.String,System.Int32)">
  2573. <summary>
  2574. Return EvaluationName wrapper around the matching XSSFName (named range)
  2575. </summary>
  2576. <param name="name">case-aware but case-insensitive named range in workbook</param>
  2577. <param name="sheetIndex">index of sheet if named range scope is limited to one sheet
  2578. if named range scope is global to the workbook, sheetIndex is -1.</param>
  2579. <returns>If name is a named range in the workbook, returns
  2580. EvaluationName corresponding to that named range
  2581. Returns null if there is no named range with the same name and scope in the workbook
  2582. </returns>
  2583. </member>
  2584. <member name="M:NPOI.XSSF.UserModel.BaseXSSFEvaluationWorkbook.GetNameXPtg(System.String,NPOI.SS.Formula.SheetIdentifier)">
  2585. <summary>
  2586. Return an external name (named range, function, user-defined function) Pxg
  2587. </summary>
  2588. <param name="name"></param>
  2589. <param name="sheet"></param>
  2590. <returns></returns>
  2591. </member>
  2592. <member name="M:NPOI.XSSF.UserModel.BaseXSSFEvaluationWorkbook.GetTable(System.String)">
  2593. Returns the data table with the given name (case insensitive).
  2594. Tables are cached for performance (formula evaluation looks them up by name repeatedly).
  2595. After the first table lookup, adding or removing a table from the document structure will cause trouble.
  2596. This is meant to be used on documents whose structure is essentially static at the point formulas are evaluated.
  2597. @param name the data table name (case-insensitive)
  2598. @return The Data table in the workbook named <tt>name</tt>, or <tt>null</tt> if no table is named <tt>name</tt>.
  2599. @since 3.15 beta 2
  2600. </member>
  2601. <member name="T:NPOI.XSSF.UserModel.BaseXSSFFormulaEvaluator">
  2602. Internal POI use only - parent of XSSF and SXSSF formula Evaluators
  2603. </member>
  2604. <member name="M:NPOI.XSSF.UserModel.BaseXSSFFormulaEvaluator.ToEvaluationCell(NPOI.SS.UserModel.ICell)">
  2605. Turns a XSSFCell / SXSSFCell into a XSSFEvaluationCell
  2606. </member>
  2607. <member name="M:NPOI.XSSF.UserModel.BaseXSSFFormulaEvaluator.EvaluateFormulaCellValue(NPOI.SS.UserModel.ICell)">
  2608. Returns a CellValue wrapper around the supplied ValueEval instance.
  2609. </member>
  2610. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFAreaChartData`2">
  2611. <summary>
  2612. Holds data for a XSSF Area Chart
  2613. </summary>
  2614. <typeparam name="Tx"></typeparam>
  2615. <typeparam name="Ty"></typeparam>
  2616. </member>
  2617. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFAreaChartData`2.series">
  2618. List of all data series.
  2619. </member>
  2620. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFBarChartData`2">
  2621. <summary>
  2622. Holds data for a XSSF Bar Chart
  2623. </summary>
  2624. <typeparam name="Tx"></typeparam>
  2625. <typeparam name="Ty"></typeparam>
  2626. </member>
  2627. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFBarChartData`2.series">
  2628. List of all data series.
  2629. </member>
  2630. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFChartAxis">
  2631. Base class for all axis types.
  2632. @author Roman Kashitsyn
  2633. </member>
  2634. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFChartDataFactory">
  2635. @author Roman Kashitsyn
  2636. </member>
  2637. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartDataFactory.CreateScatterChartData``2">
  2638. @return new scatter chart data instance
  2639. </member>
  2640. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartDataFactory.GetInstance">
  2641. @return factory instance
  2642. </member>
  2643. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFChartLegend">
  2644. Represents a SpreadsheetML chart legend
  2645. @author Roman Kashitsyn
  2646. </member>
  2647. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFChartLegend.legend">
  2648. Underlaying CTLagend bean
  2649. </member>
  2650. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartLegend.#ctor(NPOI.XSSF.UserModel.XSSFChart)">
  2651. Create a new SpreadsheetML chart legend
  2652. </member>
  2653. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartLegend.SetDefaults">
  2654. Set sensible default styling.
  2655. </member>
  2656. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartLegend.GetCTLegend">
  2657. Return the underlying CTLegend bean.
  2658. @return the underlying CTLegend bean
  2659. </member>
  2660. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFChartUtil">
  2661. Package private class with utility methods.
  2662. @author Roman Kashitsyn
  2663. </member>
  2664. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartUtil.BuildAxDataSource``1(NPOI.OpenXmlFormats.Dml.Chart.CT_AxDataSource,NPOI.SS.UserModel.Charts.IChartDataSource{``0})">
  2665. Builds CTAxDataSource object content from POI ChartDataSource.
  2666. @param ctAxDataSource OOXML data source to build
  2667. @param dataSource POI data source to use
  2668. </member>
  2669. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartUtil.BuildNumDataSource``1(NPOI.OpenXmlFormats.Dml.Chart.CT_NumDataSource,NPOI.SS.UserModel.Charts.IChartDataSource{``0})">
  2670. Builds CTNumDataSource object content from POI ChartDataSource
  2671. @param ctNumDataSource OOXML data source to build
  2672. @param dataSource POI data source to use
  2673. </member>
  2674. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFColumnChartData`2">
  2675. <summary>
  2676. Holds data for a XSSF Column Chart
  2677. </summary>
  2678. <typeparam name="Tx"></typeparam>
  2679. <typeparam name="Ty"></typeparam>
  2680. </member>
  2681. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFColumnChartData`2.series">
  2682. List of all data series.
  2683. </member>
  2684. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFLineChartData`2">
  2685. <summary>
  2686. Holds data for a XSSF Line Chart
  2687. </summary>
  2688. <typeparam name="Tx"></typeparam>
  2689. <typeparam name="Ty"></typeparam>
  2690. </member>
  2691. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFLineChartData`2.series">
  2692. List of all data series.
  2693. </member>
  2694. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFManualLayout">
  2695. Represents a SpreadsheetML manual layout.
  2696. @author Roman Kashitsyn
  2697. </member>
  2698. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFManualLayout.layout">
  2699. Underlaying CTManualLayout bean.
  2700. </member>
  2701. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFManualLayout.#ctor(NPOI.OpenXmlFormats.Dml.Chart.CT_Layout)">
  2702. Create a new SpreadsheetML manual layout.
  2703. @param layout a Spreadsheet ML layout that should be used as base.
  2704. </member>
  2705. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFManualLayout.#ctor(NPOI.XSSF.UserModel.XSSFChart)">
  2706. Create a new SpreadsheetML manual layout for chart.
  2707. @param chart a chart to create layout for.
  2708. </member>
  2709. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFManualLayout.GetCTManualLayout">
  2710. Return the underlying CTManualLayout bean.
  2711. @return the underlying CTManualLayout bean.
  2712. </member>
  2713. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFPieChartData`2">
  2714. <summary>
  2715. Holds data for a XSSF Pie Chart
  2716. </summary>
  2717. <typeparam name="Tx"></typeparam>
  2718. <typeparam name="Ty"></typeparam>
  2719. </member>
  2720. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFPieChartData`2.series">
  2721. <summary>
  2722. List of all data series.
  2723. </summary>
  2724. </member>
  2725. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2">
  2726. Represents DrawingML scatter chart.
  2727. @author Roman Kashitsyn
  2728. </member>
  2729. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.series">
  2730. List of all data series.
  2731. </member>
  2732. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.Series">
  2733. Package private ScatterChartSerie implementation.
  2734. </member>
  2735. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.Series.GetXValues">
  2736. Returns data source used for X axis values.
  2737. @return data source used for X axis values
  2738. </member>
  2739. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.Series.GetYValues">
  2740. Returns data source used for Y axis values.
  2741. @return data source used for Y axis values
  2742. </member>
  2743. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.Series.SetUseCache(System.Boolean)">
  2744. @param useCache if true, cached results will be Added on plot
  2745. </member>
  2746. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFValueAxis">
  2747. Value axis type.
  2748. @author Roman Kashitsyn
  2749. </member>
  2750. <member name="T:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment">
  2751. Cell Settings avaiable in the Format/Alignment tab
  2752. </member>
  2753. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_CellAlignment)">
  2754. Creates a Cell Alignment from the supplied XML defInition
  2755. @param cellAlignment
  2756. </member>
  2757. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.Vertical">
  2758. Get the type of vertical alignment for the cell
  2759. @return the type of aligment
  2760. @see VerticalAlignment
  2761. </member>
  2762. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.Horizontal">
  2763. Get the type of horizontal alignment for the cell
  2764. @return the type of aligment
  2765. @see HorizontalAlignment
  2766. </member>
  2767. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.Indent">
  2768. Get the number of spaces to indent the text in the cell
  2769. @return indent - number of spaces
  2770. </member>
  2771. <!-- Badly formed XML comment ignored for member "P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.TextRotation" -->
  2772. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.WrapText">
  2773. Whether the text should be wrapped
  2774. @return a bool value indicating if the text in a cell should be line-wrapped within the cell.
  2775. </member>
  2776. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.GetCTCellAlignment">
  2777. Access to low-level data
  2778. </member>
  2779. <member name="T:NPOI.XSSF.UserModel.Extensions.BorderSide">
  2780. The enumeration value indicating the side being used for a cell border.
  2781. </member>
  2782. <member name="T:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder">
  2783. This element Contains border formatting information, specifying border defInition formats (left, right, top, bottom, diagonal)
  2784. for cells in the workbook.
  2785. Color is optional.
  2786. </member>
  2787. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Border,NPOI.XSSF.Model.ThemesTable)">
  2788. Creates a Cell Border from the supplied XML defInition
  2789. </member>
  2790. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Border)">
  2791. Creates a Cell Border from the supplied XML defInition
  2792. </member>
  2793. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.#ctor">
  2794. Creates a new, empty Cell Border.
  2795. You need to attach this to the Styles Table
  2796. </member>
  2797. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.SetThemesTable(NPOI.XSSF.Model.ThemesTable)">
  2798. Records the Themes Table that is associated with
  2799. the current font, used when looking up theme
  2800. based colours and properties.
  2801. </member>
  2802. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.GetCTBorder">
  2803. Returns the underlying XML bean.
  2804. @return CT_Border
  2805. </member>
  2806. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.GetBorderStyle(NPOI.XSSF.UserModel.Extensions.BorderSide)">
  2807. Get the type of border to use for the selected border
  2808. @param side - - where to apply the color defInition
  2809. @return borderstyle - the type of border to use. default value is NONE if border style is not Set.
  2810. @see BorderStyle
  2811. </member>
  2812. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.SetBorderStyle(NPOI.XSSF.UserModel.Extensions.BorderSide,NPOI.SS.UserModel.BorderStyle)">
  2813. Set the type of border to use for the selected border
  2814. @param side - - where to apply the color defInition
  2815. @param style - border style
  2816. @see BorderStyle
  2817. </member>
  2818. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.GetBorderColor(NPOI.XSSF.UserModel.Extensions.BorderSide)">
  2819. Get the color to use for the selected border
  2820. @param side - where to apply the color defInition
  2821. @return color - color to use as XSSFColor. null if color is not set
  2822. </member>
  2823. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.SetBorderColor(NPOI.XSSF.UserModel.Extensions.BorderSide,NPOI.XSSF.UserModel.XSSFColor)">
  2824. Set the color to use for the selected border
  2825. @param side - where to apply the color defInition
  2826. @param color - the color to use
  2827. </member>
  2828. <member name="T:NPOI.XSSF.UserModel.Extensions.XSSFCellFill">
  2829. This element specifies fill formatting.
  2830. A cell fill consists of a background color, foreground color, and pattern to be applied across the cell.
  2831. </member>
  2832. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Fill)">
  2833. Creates a CellFill from the supplied parts
  2834. @param fill - fill
  2835. </member>
  2836. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.#ctor">
  2837. Creates an empty CellFill
  2838. </member>
  2839. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.GetFillBackgroundColor">
  2840. Get the background fill color.
  2841. @return fill color, null if color is not set
  2842. </member>
  2843. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetFillBackgroundColor(System.Int32)">
  2844. Set the background fill color represented as a indexed color value.
  2845. @param index
  2846. </member>
  2847. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetFillBackgroundColor(NPOI.XSSF.UserModel.XSSFColor)">
  2848. Set the background fill color represented as a {@link XSSFColor} value.
  2849. @param color
  2850. </member>
  2851. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.GetFillForegroundColor">
  2852. Get the foreground fill color.
  2853. @return XSSFColor - foreground color. null if color is not set
  2854. </member>
  2855. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetFillForegroundColor(System.Int32)">
  2856. Set the foreground fill color as a indexed color value
  2857. @param index - the color to use
  2858. </member>
  2859. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetFillForegroundColor(NPOI.XSSF.UserModel.XSSFColor)">
  2860. Set the foreground fill color represented as a {@link XSSFColor} value.
  2861. @param color - the color to use
  2862. </member>
  2863. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.GetPatternType">
  2864. get the fill pattern
  2865. @return fill pattern type. null if fill pattern is not set
  2866. </member>
  2867. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetPatternType(NPOI.OpenXmlFormats.Spreadsheet.ST_PatternType)">
  2868. set the fill pattern
  2869. @param patternType fill pattern to use
  2870. </member>
  2871. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.GetCTFill">
  2872. Returns the underlying XML bean.
  2873. @return CT_Fill
  2874. </member>
  2875. <member name="T:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter">
  2876. <summary>
  2877. Parent class of all XSSF headers and footers.
  2878. </summary>
  2879. </member>
  2880. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  2881. Create an instance of XSSFHeaderFooter from the supplied XML bean
  2882. @param headerFooter
  2883. </member>
  2884. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.GetHeaderFooter">
  2885. Returns the underlying CTHeaderFooter xml bean
  2886. @return the underlying CTHeaderFooter xml bean
  2887. </member>
  2888. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.AreFieldsStripped">
  2889. Are fields currently being stripped from the text that this
  2890. {@link XSSFHeaderFooter} returns? Default is false, but can be Changed
  2891. </member>
  2892. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.SetAreFieldsStripped(System.Boolean)">
  2893. Should fields (eg macros) be stripped from the text that this class
  2894. returns? Default is not to strip.
  2895. @param StripFields
  2896. </member>
  2897. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.StripFields(System.String)">
  2898. Removes any fields (eg macros, page markers etc) from the string.
  2899. Normally used to make some text suitable for showing to humans, and the
  2900. resultant text should not normally be saved back into the document!
  2901. </member>
  2902. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.Center">
  2903. get the text representing the center part of this element
  2904. </member>
  2905. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.Left">
  2906. get the text representing the left part of this element
  2907. </member>
  2908. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.Right">
  2909. get the text representing the right part of this element
  2910. </member>
  2911. <member name="T:NPOI.XSSF.UserModel.Helpers.ColumnHelper">
  2912. <summary>
  2913. Helper class for dealing with the Column Settings on a CT_Worksheet
  2914. (the data part of a sheet). Note - within POI, we use 0 based column
  2915. indexes, but the column defInitions in the XML are 1 based!
  2916. </summary>
  2917. </member>
  2918. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.GetColumn(System.Int64,System.Boolean)">
  2919. <summary>
  2920. Returns the Column at the given 0 based index
  2921. </summary>
  2922. <param name="index"></param>
  2923. <param name="splitColumns"></param>
  2924. <returns></returns>
  2925. </member>
  2926. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.GetColumn1Based(System.Int64,System.Boolean)">
  2927. <summary>
  2928. Returns the Column at the given 1 based index. POI default is 0
  2929. based, but the file stores as 1 based.
  2930. </summary>
  2931. <param name="index1"></param>
  2932. <param name="splitColumns"></param>
  2933. <returns></returns>
  2934. </member>
  2935. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.ColumnExists(NPOI.OpenXmlFormats.Spreadsheet.CT_Cols,System.Int64)">
  2936. <summary>
  2937. Does the column at the given 0 based index exist in the supplied
  2938. list of column defInitions?
  2939. </summary>
  2940. <param name="cols"></param>
  2941. <param name="index"></param>
  2942. <returns></returns>
  2943. </member>
  2944. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.GetColDefaultStyle(System.Int64)">
  2945. <summary>
  2946. Returns -1 if no column is found for the given index
  2947. </summary>
  2948. <param name="index"></param>
  2949. <returns></returns>
  2950. </member>
  2951. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.GetOrCreateColumn1Based(System.Int64,System.Boolean)">
  2952. <summary>
  2953. Return the CT_Col at the given (0 based) column index, creating
  2954. it if required.
  2955. </summary>
  2956. <param name="index1"></param>
  2957. <param name="splitColumns"></param>
  2958. <returns></returns>
  2959. </member>
  2960. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.InsertCol(NPOI.OpenXmlFormats.Spreadsheet.CT_Cols,System.Int64,System.Int64,NPOI.OpenXmlFormats.Spreadsheet.CT_Col[])">
  2961. <summary>
  2962. Insert a new CT_Col at position 0 into cols, Setting min=min,
  2963. max=max and copying all the colsWithAttributes array cols
  2964. attributes into newCol
  2965. </summary>
  2966. <param name="cols"></param>
  2967. <param name="min"></param>
  2968. <param name="max"></param>
  2969. <param name="colsWithAttributes"></param>
  2970. <returns></returns>
  2971. </member>
  2972. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.TreeSet`1.TailSet(`0,System.Boolean)">
  2973. <summary>
  2974. Returns a view of the portion of this map whose keys are
  2975. greater than (or equal to, if inclusive is true) fromKey.
  2976. </summary>
  2977. <param name="fromElement"></param>
  2978. <param name="inclusive"></param>
  2979. <returns></returns>
  2980. </member>
  2981. <member name="M:NPOI.XSSF.UserModel.Helpers.HeaderFooterHelper.GetParts(System.String)">
  2982. Split into left, center, right
  2983. </member>
  2984. <member name="T:NPOI.XSSF.UserModel.Helpers.XSSFFormulaUtils">
  2985. Utility to update formulas and named ranges when a sheet name was Changed
  2986. @author Yegor Kozlov
  2987. </member>
  2988. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFFormulaUtils.UpdateSheetName(System.Int32,System.String,System.String)">
  2989. Update sheet name in all formulas and named ranges.
  2990. Called from {@link XSSFWorkbook#setSheetName(int, String)}
  2991. <p/>
  2992. <p>
  2993. The idea is to parse every formula and render it back to string
  2994. with the updated sheet name. This is done by parsing into Ptgs,
  2995. looking for ones with sheet references in them, and changing those
  2996. </p>
  2997. @param sheetIndex the 0-based index of the sheet being changed
  2998. @param oldName the old sheet name
  2999. @param newName the new sheet name
  3000. </member>
  3001. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFFormulaUtils.UpdateFormula(NPOI.XSSF.UserModel.XSSFCell,System.String,System.String)">
  3002. Parse cell formula and re-assemble it back using the specified FormulaRenderingWorkbook.
  3003. @param cell the cell to update
  3004. @param frwb the formula rendering workbbok that returns new sheet name
  3005. </member>
  3006. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFFormulaUtils.UpdateName(NPOI.SS.UserModel.IName,System.String,System.String)">
  3007. Parse formula in the named range and re-assemble it back using the specified FormulaRenderingWorkbook.
  3008. @param name the name to update
  3009. @param frwb the formula rendering workbbok that returns new sheet name
  3010. </member>
  3011. <member name="T:NPOI.XSSF.UserModel.Helpers.XSSFIgnoredErrorHelper">
  3012. XSSF-specific code for working with ignored errors
  3013. </member>
  3014. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFPasswordHelper.SetPassword(System.Xml.XmlNode,System.String,NPOI.POIFS.Crypt.HashAlgorithm,System.String)">
  3015. Sets the XORed or hashed password
  3016. @param xobj the xmlbeans object which Contains the password attributes
  3017. @param password the password, if null, the password attributes will be Removed
  3018. @param hashAlgo the hash algorithm, if null the password will be XORed
  3019. @param prefix the prefix of the password attributes, may be null
  3020. </member>
  3021. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFPasswordHelper.ValidatePassword(System.Xml.XmlNode,System.String,System.String)">
  3022. Validates the password, i.e.
  3023. calculates the hash of the given password and Compares it against the stored hash
  3024. @param xobj the xmlbeans object which Contains the password attributes
  3025. @param password the password, if null the method will always return false,
  3026. even if there's no password Set
  3027. @param prefix the prefix of the password attributes, may be null
  3028. @return true, if the hashes match
  3029. </member>
  3030. <member name="T:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter">
  3031. @author Yegor Kozlov
  3032. </member>
  3033. <member name="T:NPOI.XSSF.UserModel.Helpers.XSSFSingleXmlCell">
  3034. *
  3035. * This class is a wrapper around the CTSingleXmlCell (Open Office XML Part 4:
  3036. * chapter 3.5.2.1)
  3037. *
  3038. *
  3039. * @author Roberto Manicardi
  3040. *
  3041. </member>
  3042. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFSingleXmlCell.GetReferencedCell">
  3043. Gets the XSSFCell referenced by the R attribute or Creates a new one if cell doesn't exists
  3044. @return the referenced XSSFCell, null if the cell reference is invalid
  3045. </member>
  3046. <member name="T:NPOI.XSSF.UserModel.Helpers.XSSFXmlColumnPr">
  3047. This class is a wrapper around the CT_XmlColumnPr (Open Office XML Part 4:
  3048. chapter 3.5.1.7)
  3049. @author Roberto Manicardi
  3050. </member>
  3051. <member name="P:NPOI.XSSF.UserModel.Helpers.XSSFXmlColumnPr.Id">
  3052. <summary>
  3053. (see Open Office XML Part 4: chapter 3.5.1.3) An integer representing the unique identifier of this column.
  3054. </summary>
  3055. </member>
  3056. <member name="P:NPOI.XSSF.UserModel.Helpers.XSSFXmlColumnPr.LocalXPath">
  3057. If the XPath is, for example, /Node1/Node2/Node3 and /Node1/Node2 is the common XPath for the table, the local XPath is /Node3
  3058. @return the local XPath
  3059. </member>
  3060. <member name="T:NPOI.XSSF.UserModel.ListAutoNumber">
  3061. Specifies type of automatic numbered bullet points that should be applied to a paragraph.
  3062. </member>
  3063. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ALPHA_LC_PARENT_BOTH">
  3064. (a), (b), (c), ...
  3065. </member>
  3066. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ALPHA_UC_PARENT_BOTH">
  3067. (A), (B), (C), ...
  3068. </member>
  3069. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ALPHA_LC_PARENT_R">
  3070. a), b), c), ...
  3071. </member>
  3072. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ALPHA_UC_PARENT_R">
  3073. A), B), C), ...
  3074. </member>
  3075. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ALPHA_LC_PERIOD">
  3076. a., b., c., ...
  3077. </member>
  3078. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ALPHA_UC_PERIOD">
  3079. A., B., C., ...
  3080. </member>
  3081. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ARABIC_PARENT_BOTH">
  3082. (1), (2), (3), ...
  3083. </member>
  3084. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ARABIC_PARENT_R">
  3085. 1), 2), 3), ...
  3086. </member>
  3087. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ARABIC_PERIOD">
  3088. 1., 2., 3., ...
  3089. </member>
  3090. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ARABIC_PLAIN">
  3091. 1, 2, 3, ...
  3092. </member>
  3093. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ROMAN_LC_PARENT_BOTH">
  3094. (i), (ii), (iii), ...
  3095. </member>
  3096. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ROMAN_UC_PARENT_BOTH">
  3097. (I), (II), (III), ...
  3098. </member>
  3099. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ROMAN_LC_PARENT_R">
  3100. i), ii), iii), ...
  3101. </member>
  3102. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ROMAN_UC_PARENT_R">
  3103. I), II), III), ...
  3104. </member>
  3105. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ROMAN_LC_PERIOD">
  3106. i., ii., iii., ...
  3107. </member>
  3108. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ROMAN_UC_PERIOD">
  3109. I., II., III., ...
  3110. </member>
  3111. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.CIRCLE_NUM_DB_PLAIN">
  3112. Dbl-byte circle numbers
  3113. </member>
  3114. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.CIRCLE_NUM_WD_BLACK_PLAIN">
  3115. Wingdings black circle numbers
  3116. </member>
  3117. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.CIRCLE_NUM_WD_WHITE_PLAIN">
  3118. Wingdings white circle numbers
  3119. </member>
  3120. <member name="T:NPOI.XSSF.UserModel.TextAlign">
  3121. Specified a list of text alignment types
  3122. </member>
  3123. <member name="F:NPOI.XSSF.UserModel.TextAlign.LEFT">
  3124. Align text to the left margin.
  3125. </member>
  3126. <member name="F:NPOI.XSSF.UserModel.TextAlign.CENTER">
  3127. Align text in the center.
  3128. </member>
  3129. <member name="F:NPOI.XSSF.UserModel.TextAlign.RIGHT">
  3130. Align text to the right margin.
  3131. </member>
  3132. <member name="F:NPOI.XSSF.UserModel.TextAlign.JUSTIFY">
  3133. Align text so that it is justified across the whole line. It
  3134. is smart in the sense that it will not justify sentences
  3135. which are short
  3136. </member>
  3137. <member name="T:NPOI.XSSF.UserModel.TextAutofit">
  3138. Specifies a list of auto-fit types.
  3139. <p>
  3140. Autofit specifies that a shape should be auto-fit to fully contain the text described within it.
  3141. Auto-fitting is when text within a shape is scaled in order to contain all the text inside
  3142. </p>
  3143. </member>
  3144. <member name="F:NPOI.XSSF.UserModel.TextAutofit.NONE">
  3145. Specifies that text within the text body should not be auto-fit to the bounding box.
  3146. Auto-fitting is when text within a text box is scaled in order to remain inside
  3147. the text box.
  3148. </member>
  3149. <member name="F:NPOI.XSSF.UserModel.TextAutofit.NORMAL">
  3150. Specifies that text within the text body should be normally auto-fit to the bounding box.
  3151. Autofitting is when text within a text box is scaled in order to remain inside the text box.
  3152. <p>
  3153. <em>Example:</em> Consider the situation where a user is building a diagram and needs
  3154. to have the text for each shape that they are using stay within the bounds of the shape.
  3155. An easy way this might be done is by using NORMAL autofit
  3156. </p>
  3157. </member>
  3158. <member name="F:NPOI.XSSF.UserModel.TextAutofit.SHAPE">
  3159. Specifies that a shape should be auto-fit to fully contain the text described within it.
  3160. Auto-fitting is when text within a shape is scaled in order to contain all the text inside.
  3161. <p>
  3162. <em>Example:</em> Consider the situation where a user is building a diagram and needs to have
  3163. the text for each shape that they are using stay within the bounds of the shape.
  3164. An easy way this might be done is by using SHAPE autofit
  3165. </p>
  3166. </member>
  3167. <member name="T:NPOI.XSSF.UserModel.TextCap">
  3168. Text Capitalization that is to be applied to the text Run. This is a render-only
  3169. modification and does not affect the actual characters stored in the text Run.
  3170. </member>
  3171. <member name="T:NPOI.XSSF.UserModel.TextDirection">
  3172. Vertical Text Types
  3173. </member>
  3174. <member name="F:NPOI.XSSF.UserModel.TextDirection.HORIZONTAL">
  3175. Horizontal text. This should be default.
  3176. </member>
  3177. <member name="F:NPOI.XSSF.UserModel.TextDirection.VERTICAL">
  3178. Vertical orientation.
  3179. (each line is 90 degrees rotated clockwise, so it goes
  3180. from top to bottom; each next line is to the left from
  3181. the previous one).
  3182. </member>
  3183. <member name="F:NPOI.XSSF.UserModel.TextDirection.VERTICAL_270">
  3184. Vertical orientation.
  3185. (each line is 270 degrees rotated clockwise, so it goes
  3186. from bottom to top; each next line is to the right from
  3187. the previous one).
  3188. </member>
  3189. <member name="F:NPOI.XSSF.UserModel.TextDirection.STACKED">
  3190. Determines if all of the text is vertical
  3191. ("one letter on top of another").
  3192. </member>
  3193. <member name="T:NPOI.XSSF.UserModel.TextFontAlign">
  3194. Specified a list of text font alignment types
  3195. </member>
  3196. <member name="F:NPOI.XSSF.UserModel.TextFontAlign.AUTO">
  3197. Automatic alignment
  3198. </member>
  3199. <member name="F:NPOI.XSSF.UserModel.TextFontAlign.TOP">
  3200. Align text to the top.
  3201. </member>
  3202. <member name="F:NPOI.XSSF.UserModel.TextFontAlign.CENTER">
  3203. Align text in the center.
  3204. </member>
  3205. <member name="F:NPOI.XSSF.UserModel.TextFontAlign.BASELINE">
  3206. Align text to the baseline.
  3207. </member>
  3208. <member name="F:NPOI.XSSF.UserModel.TextFontAlign.BOTTOM">
  3209. Align text to the bottom.
  3210. </member>
  3211. <member name="T:NPOI.XSSF.UserModel.TextHorizontalOverflow">
  3212. Text Horizontal Overflow
  3213. </member>
  3214. <member name="F:NPOI.XSSF.UserModel.TextHorizontalOverflow.OVERFLOW">
  3215. When a big character does not fit into a line, allow a
  3216. horizontal overflow.
  3217. </member>
  3218. <member name="F:NPOI.XSSF.UserModel.TextHorizontalOverflow.CLIP">
  3219. When a big character does not fit into a line, clip it at
  3220. the proper horizontal overflow.
  3221. </member>
  3222. <member name="T:NPOI.XSSF.UserModel.TextVerticalOverflow">
  3223. Text Vertical Overflow
  3224. </member>
  3225. <member name="F:NPOI.XSSF.UserModel.TextVerticalOverflow.OVERFLOW">
  3226. Overflow the text and pay no attention to top and bottom barriers.
  3227. </member>
  3228. <member name="F:NPOI.XSSF.UserModel.TextVerticalOverflow.ELLIPSIS">
  3229. Pay attention to top and bottom barriers. Use an
  3230. ellipsis to denote that there is text which is not visible.
  3231. </member>
  3232. <member name="F:NPOI.XSSF.UserModel.TextVerticalOverflow.CLIP">
  3233. Pay attention to top and bottom barriers. Provide no
  3234. indication that there is text which is not visible.
  3235. </member>
  3236. <member name="T:NPOI.XSSF.UserModel.XSSFAnchor">
  3237. An anchor is what specifics the position of a shape within a client object
  3238. or within another containing shape.
  3239. @author Yegor Kozlov
  3240. </member>
  3241. <member name="T:NPOI.XSSF.UserModel.XSSFAutoFilter">
  3242. Represents autofiltering for the specified worksheet.
  3243. @author Yegor Kozlov
  3244. </member>
  3245. <member name="T:NPOI.XSSF.UserModel.XSSFBorderFormatting">
  3246. @author Yegor Kozlov
  3247. </member>
  3248. <member name="M:NPOI.XSSF.UserModel.XSSFBuiltinTableStyle.XSSFBuiltinTypeStyleStyle.#ctor(NPOI.XSSF.UserModel.XSSFBuiltinTableStyleEnum,NPOI.SS.UserModel.ITableStyle)">
  3249. @param builtIn
  3250. @param style
  3251. </member>
  3252. <member name="T:NPOI.XSSF.UserModel.XSSFCell">
  3253. High level representation of a cell in a row of a spreadsheet.
  3254. <p>
  3255. Cells can be numeric, formula-based or string-based (text). The cell type
  3256. specifies this. String cells cannot conatin numbers and numeric cells cannot
  3257. contain strings (at least according to our model). Client apps should do the
  3258. conversions themselves. Formula cells have the formula string, as well as
  3259. the formula result, which can be numeric or string.
  3260. </p>
  3261. <p>
  3262. Cells should have their number (0 based) before being Added to a row. Only
  3263. cells that have values should be Added.
  3264. </p>
  3265. </member>
  3266. <member name="F:NPOI.XSSF.UserModel.XSSFCell._cell">
  3267. the xml bean Containing information about the cell's location, value,
  3268. data type, formatting, and formula
  3269. </member>
  3270. <member name="F:NPOI.XSSF.UserModel.XSSFCell._row">
  3271. the XSSFRow this cell belongs to
  3272. </member>
  3273. <member name="F:NPOI.XSSF.UserModel.XSSFCell._cellNum">
  3274. 0-based column index
  3275. </member>
  3276. <member name="F:NPOI.XSSF.UserModel.XSSFCell._sharedStringSource">
  3277. Table of strings shared across this workbook.
  3278. If two cells contain the same string, then the cell value is the same index into SharedStringsTable
  3279. </member>
  3280. <member name="F:NPOI.XSSF.UserModel.XSSFCell._stylesSource">
  3281. Table of cell styles shared across all cells in a workbook.
  3282. </member>
  3283. <member name="M:NPOI.XSSF.UserModel.XSSFCell.#ctor(NPOI.XSSF.UserModel.XSSFRow,NPOI.OpenXmlFormats.Spreadsheet.CT_Cell)">
  3284. Construct a XSSFCell.
  3285. @param row the parent row.
  3286. @param cell the xml bean Containing information about the cell.
  3287. </member>
  3288. <member name="M:NPOI.XSSF.UserModel.XSSFCell.CopyCellFrom(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.CellCopyPolicy)">
  3289. <summary>
  3290. Copy cell value, formula and style, from srcCell per cell copy policy
  3291. If srcCell is null, clears the cell value and cell style per cell copy policy
  3292. This does not shift references in formulas. Use {@link XSSFRowShifter} to shift references in formulas.
  3293. </summary>
  3294. <param name="srcCell">The cell to take value, formula and style from</param>
  3295. <param name="policy">The policy for copying the information, see {@link CellCopyPolicy}</param>
  3296. <exception cref="T:System.ArgumentException">if copy cell style and srcCell is from a different workbook</exception>
  3297. </member>
  3298. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetSharedStringSource">
  3299. @return table of strings shared across this workbook
  3300. </member>
  3301. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetStylesSource">
  3302. @return table of cell styles shared across this workbook
  3303. </member>
  3304. <member name="P:NPOI.XSSF.UserModel.XSSFCell.Sheet">
  3305. Returns the sheet this cell belongs to
  3306. @return the sheet this cell belongs to
  3307. </member>
  3308. <member name="P:NPOI.XSSF.UserModel.XSSFCell.Row">
  3309. Returns the row this cell belongs to
  3310. @return the row this cell belongs to
  3311. </member>
  3312. <member name="P:NPOI.XSSF.UserModel.XSSFCell.BooleanCellValue">
  3313. Get the value of the cell as a bool.
  3314. <p>
  3315. For strings, numbers, and errors, we throw an exception. For blank cells we return a false.
  3316. </p>
  3317. @return the value of the cell as a bool
  3318. @throws InvalidOperationException if the cell type returned by {@link #CellType}
  3319. is not CellType.Boolean, CellType.Blank or CellType.Formula
  3320. </member>
  3321. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(System.Boolean)">
  3322. Set a bool value for the cell
  3323. @param value the bool value to Set this cell to. For formulas we'll Set the
  3324. precalculated value, for bools we'll Set its value. For other types we
  3325. will change the cell to a bool cell and Set its value.
  3326. </member>
  3327. <member name="P:NPOI.XSSF.UserModel.XSSFCell.NumericCellValue">
  3328. Get the value of the cell as a number.
  3329. <p>
  3330. For strings we throw an exception. For blank cells we return a 0.
  3331. For formulas or error cells we return the precalculated value;
  3332. </p>
  3333. @return the value of the cell as a number
  3334. @throws InvalidOperationException if the cell type returned by {@link #CellType} is CellType.String
  3335. @exception NumberFormatException if the cell value isn't a parsable <code>double</code>.
  3336. @see DataFormatter for turning this number into a string similar to that which Excel would render this number as.
  3337. </member>
  3338. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(System.Double)">
  3339. Set a numeric value for the cell
  3340. @param value the numeric value to Set this cell to. For formulas we'll Set the
  3341. precalculated value, for numerics we'll Set its value. For other types we
  3342. will change the cell to a numeric cell and Set its value.
  3343. </member>
  3344. <member name="P:NPOI.XSSF.UserModel.XSSFCell.StringCellValue">
  3345. Get the value of the cell as a string
  3346. <p>
  3347. For numeric cells we throw an exception. For blank cells we return an empty string.
  3348. For formulaCells that are not string Formulas, we throw an exception
  3349. </p>
  3350. @return the value of the cell as a string
  3351. </member>
  3352. <member name="P:NPOI.XSSF.UserModel.XSSFCell.RichStringCellValue">
  3353. Get the value of the cell as a XSSFRichTextString
  3354. <p>
  3355. For numeric cells we throw an exception. For blank cells we return an empty string.
  3356. For formula cells we return the pre-calculated value if a string, otherwise an exception
  3357. </p>
  3358. @return the value of the cell as a XSSFRichTextString
  3359. </member>
  3360. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(System.String)">
  3361. Set a string value for the cell.
  3362. @param str value to Set the cell to. For formulas we'll Set the formula
  3363. cached string result, for String cells we'll Set its value. For other types we will
  3364. change the cell to a string cell and Set its value.
  3365. If value is null then we will change the cell to a Blank cell.
  3366. </member>
  3367. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(NPOI.SS.UserModel.IRichTextString)">
  3368. Set a string value for the cell.
  3369. @param str value to Set the cell to. For formulas we'll Set the 'pre-Evaluated result string,
  3370. for String cells we'll Set its value. For other types we will
  3371. change the cell to a string cell and Set its value.
  3372. If value is null then we will change the cell to a Blank cell.
  3373. </member>
  3374. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CellFormula">
  3375. <summary>
  3376. Return a formula for the cell, for example, <code>SUM(C4:E4)</code>
  3377. </summary>
  3378. </member>
  3379. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetCellFormula(NPOI.XSSF.UserModel.XSSFEvaluationWorkbook)">
  3380. package/hierarchy use only - reuse an existing evaluation workbook if available for caching
  3381. @param fpb evaluation workbook for reuse, if available, or null to create a new one as needed
  3382. @return a formula for the cell
  3383. @throws InvalidOperationException if the cell type returned by {@link #getCellType()} is not CELL_TYPE_FORMULA
  3384. </member>
  3385. <member name="M:NPOI.XSSF.UserModel.XSSFCell.ConvertSharedFormula(System.Int32,NPOI.XSSF.UserModel.XSSFEvaluationWorkbook)">
  3386. <summary>
  3387. Creates a non shared formula from the shared formula counterpart
  3388. </summary>
  3389. <param name="si">Shared Group Index</param>
  3390. <param name="fpb"></param>
  3391. <returns>non shared formula created for the given shared formula and this cell</returns>
  3392. </member>
  3393. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellFormula(System.String)">
  3394. Sets formula for this cell.
  3395. <p>
  3396. Note, this method only Sets the formula string and does not calculate the formula value.
  3397. To Set the precalculated value use {@link #setCellValue(double)} or {@link #setCellValue(String)}
  3398. </p>
  3399. @param formula the formula to Set, e.g. <code>"SUM(C4:E4)"</code>.
  3400. If the argument is <code>null</code> then the current formula is Removed.
  3401. @throws NPOI.ss.formula.FormulaParseException if the formula has incorrect syntax or is otherwise invalid
  3402. @throws InvalidOperationException if the operation is not allowed, for example,
  3403. when the cell is a part of a multi-cell array formula
  3404. </member>
  3405. <member name="M:NPOI.XSSF.UserModel.XSSFCell.TryToDeleteArrayFormula(System.String)">
  3406. <summary>
  3407. Called when this an array formula in this cell is deleted.
  3408. </summary>
  3409. <param name="message">a customized exception message for the case if deletion of the cell is impossible. If null, a default message will be generated</param>
  3410. </member>
  3411. <member name="P:NPOI.XSSF.UserModel.XSSFCell.ColumnIndex">
  3412. <summary>
  3413. Returns zero-based column index of this cell
  3414. </summary>
  3415. </member>
  3416. <member name="P:NPOI.XSSF.UserModel.XSSFCell.RowIndex">
  3417. <summary>
  3418. Returns zero-based row index of a row in the sheet that contains this cell
  3419. </summary>
  3420. </member>
  3421. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetReference">
  3422. <summary>
  3423. Returns an A1 style reference to the location of this cell
  3424. </summary>
  3425. <returns>A1 style reference to the location of this cell</returns>
  3426. </member>
  3427. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CellStyle">
  3428. <summary>
  3429. Return the cell's style.
  3430. </summary>
  3431. </member>
  3432. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CellType">
  3433. <summary>
  3434. Return the cell type.
  3435. </summary>
  3436. </member>
  3437. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CachedFormulaResultType">
  3438. <summary>
  3439. Only valid for formula cells
  3440. </summary>
  3441. </member>
  3442. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetBaseCellType(System.Boolean)">
  3443. <summary>
  3444. Detect cell type based on the "t" attribute of the CT_Cell bean
  3445. </summary>
  3446. <param name="blankCells"></param>
  3447. <returns></returns>
  3448. </member>
  3449. <member name="P:NPOI.XSSF.UserModel.XSSFCell.DateCellValue">
  3450. <summary>
  3451. Get the value of the cell as a date.
  3452. </summary>
  3453. </member>
  3454. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(System.DateTime)">
  3455. <summary>
  3456. Set a date value for the cell. Excel treats dates as numeric so you will need to format the cell as a date.
  3457. </summary>
  3458. <param name="value">the date value to Set this cell to. For formulas we'll set the precalculated value,
  3459. for numerics we'll Set its value. For other types we will change the cell to a numeric cell and Set its value. </param>
  3460. </member>
  3461. <member name="P:NPOI.XSSF.UserModel.XSSFCell.ErrorCellString">
  3462. <summary>
  3463. Returns the error message, such as #VALUE!
  3464. </summary>
  3465. </member>
  3466. <member name="P:NPOI.XSSF.UserModel.XSSFCell.ErrorCellValue">
  3467. <summary>
  3468. Get the value of the cell as an error code.
  3469. For strings, numbers, and bools, we throw an exception.
  3470. For blank cells we return a 0.
  3471. </summary>
  3472. </member>
  3473. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellErrorValue(NPOI.SS.UserModel.FormulaError)">
  3474. <summary>
  3475. Set a error value for the cell
  3476. </summary>
  3477. <param name="error">the error value to Set this cell to.
  3478. For formulas we'll Set the precalculated value , for errors we'll set
  3479. its value. For other types we will change the cell to an error cell and Set its value.
  3480. </param>
  3481. </member>
  3482. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetAsActiveCell">
  3483. <summary>
  3484. Sets this cell as the active cell for the worksheet.
  3485. </summary>
  3486. </member>
  3487. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetBlankInternal">
  3488. <summary>
  3489. Blanks this cell. Blank cells have no formula or value but may have styling.
  3490. This method erases all the data previously associated with this cell.
  3491. </summary>
  3492. </member>
  3493. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellNum(System.Int32)">
  3494. <summary>
  3495. Sets column index of this cell
  3496. </summary>
  3497. <param name="num"></param>
  3498. </member>
  3499. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellType(NPOI.SS.UserModel.CellType)">
  3500. <summary>
  3501. Set the cells type (numeric, formula or string)
  3502. </summary>
  3503. <param name="cellType"></param>
  3504. </member>
  3505. <member name="M:NPOI.XSSF.UserModel.XSSFCell.ToString">
  3506. <summary>
  3507. Returns a string representation of the cell
  3508. </summary>
  3509. <returns>Formula cells return the formula string, rather than the formula result.
  3510. Dates are displayed in dd-MMM-yyyy format
  3511. Errors are displayed as #ERR&lt;errIdx&gt;
  3512. </returns>
  3513. </member>
  3514. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetRawValue">
  3515. Returns the raw, underlying ooxml value for the cell
  3516. <p>
  3517. If the cell Contains a string, then this value is an index into
  3518. the shared string table, pointing to the actual string value. Otherwise,
  3519. the value of the cell is expressed directly in this element. Cells Containing formulas express
  3520. the last calculated result of the formula in this element.
  3521. </p>
  3522. @return the raw cell value as Contained in the underlying CT_Cell bean,
  3523. <code>null</code> for blank cells.
  3524. </member>
  3525. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetCellTypeName(NPOI.SS.UserModel.CellType)">
  3526. <summary>
  3527. Used to help format error messages
  3528. </summary>
  3529. <param name="cellTypeCode"></param>
  3530. <returns></returns>
  3531. </member>
  3532. <member name="M:NPOI.XSSF.UserModel.XSSFCell.TypeMismatch(NPOI.SS.UserModel.CellType,NPOI.SS.UserModel.CellType,System.Boolean)">
  3533. Used to help format error messages
  3534. </member>
  3535. <member name="M:NPOI.XSSF.UserModel.XSSFCell.CheckBounds(System.Int32)">
  3536. @throws RuntimeException if the bounds are exceeded.
  3537. </member>
  3538. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CellComment">
  3539. <summary>
  3540. Returns cell comment associated with this cell
  3541. </summary>
  3542. </member>
  3543. <member name="M:NPOI.XSSF.UserModel.XSSFCell.RemoveCellComment">
  3544. <summary>
  3545. Removes the comment for this cell, if there is one.
  3546. </summary>
  3547. </member>
  3548. <member name="P:NPOI.XSSF.UserModel.XSSFCell.Hyperlink">
  3549. <summary>
  3550. Get or set hyperlink associated with this cell
  3551. If the supplied hyperlink is null on setting, the hyperlink for this cell will be removed.
  3552. </summary>
  3553. </member>
  3554. <member name="M:NPOI.XSSF.UserModel.XSSFCell.RemoveHyperlink">
  3555. Removes the hyperlink for this cell, if there is one.
  3556. </member>
  3557. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetCTCell">
  3558. Returns the xml bean containing information about the cell's location (reference), value,
  3559. data type, formatting, and formula
  3560. @return the xml bean containing information about this cell
  3561. </member>
  3562. <member name="M:NPOI.XSSF.UserModel.XSSFCell.ConvertCellValueToBoolean">
  3563. Chooses a new bool value for the cell when its type is changing.<p/>
  3564. Usually the caller is calling SetCellType() with the intention of calling
  3565. SetCellValue(bool) straight afterwards. This method only exists to give
  3566. the cell a somewhat reasonable value until the SetCellValue() call (if at all).
  3567. TODO - perhaps a method like SetCellTypeAndValue(int, Object) should be introduced to avoid this
  3568. </member>
  3569. <member name="M:NPOI.XSSF.UserModel.XSSFCell.NotifyArrayFormulaChanging(System.String)">
  3570. The purpose of this method is to validate the cell state prior to modification
  3571. @see #NotifyArrayFormulaChanging()
  3572. </member>
  3573. <member name="M:NPOI.XSSF.UserModel.XSSFCell.NotifyArrayFormulaChanging">
  3574. <summary>
  3575. Called when this cell is modified.The purpose of this method is to validate the cell state prior to modification.
  3576. </summary>
  3577. <exception cref="T:System.InvalidOperationException">if modification is not allowed</exception>
  3578. </member>
  3579. <member name="T:NPOI.XSSF.UserModel.XSSFCellStyle">
  3580. High level representation of the the possible formatting information for the contents of the cells on a sheet in a
  3581. SpreadsheetML document.
  3582. @see NPOI.xssf.usermodel.XSSFWorkbook#CreateCellStyle()
  3583. @see NPOI.xssf.usermodel.XSSFWorkbook#getCellStyleAt(short)
  3584. @see NPOI.xssf.usermodel.XSSFCell#setCellStyle(NPOI.ss.usermodel.CellStyle)
  3585. </member>
  3586. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.#ctor(System.Int32,System.Int32,NPOI.XSSF.Model.StylesTable,NPOI.XSSF.Model.ThemesTable)">
  3587. Creates a Cell Style from the supplied parts
  3588. @param cellXfId The main XF for the cell. Must be a valid 0-based index into the XF table
  3589. @param cellStyleXfId Optional, style xf. A value of <code>-1</code> means no xf.
  3590. @param stylesSource Styles Source to work off
  3591. </member>
  3592. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCoreXf">
  3593. Used so that StylesSource can figure out our location
  3594. </member>
  3595. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetStyleXf">
  3596. Used so that StylesSource can figure out our location
  3597. </member>
  3598. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.#ctor(NPOI.XSSF.Model.StylesTable)">
  3599. <summary>
  3600. Creates an empty Cell Style
  3601. </summary>
  3602. <param name="stylesSource"></param>
  3603. </member>
  3604. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.VerifyBelongsToStylesSource(NPOI.XSSF.Model.StylesTable)">
  3605. Verifies that this style belongs to the supplied Workbook
  3606. Styles Source.
  3607. Will throw an exception if it belongs to a different one.
  3608. This is normally called when trying to assign a style to a
  3609. cell, to ensure the cell and the style are from the same
  3610. workbook (if they're not, it won't work)
  3611. @throws ArgumentException if there's a workbook mis-match
  3612. </member>
  3613. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.CloneStyleFrom(NPOI.SS.UserModel.ICellStyle)">
  3614. Clones all the style information from another
  3615. XSSFCellStyle, onto this one. This
  3616. XSSFCellStyle will then have all the same
  3617. properties as the source, but the two may
  3618. be edited independently.
  3619. Any stylings on this XSSFCellStyle will be lost!
  3620. The source XSSFCellStyle could be from another
  3621. XSSFWorkbook if you like. This allows you to
  3622. copy styles from one XSSFWorkbook to another.
  3623. </member>
  3624. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetAlignmentEnum">
  3625. <summary>
  3626. Get the type of horizontal alignment for the cell
  3627. </summary>
  3628. <returns>the type of alignment</returns>
  3629. </member>
  3630. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.BorderBottom">
  3631. <summary>
  3632. Get or set the type of border to use for the bottom border of the cell
  3633. </summary>
  3634. </member>
  3635. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.BorderLeft">
  3636. <summary>
  3637. Get or set the type of border to use for the left border of the cell
  3638. </summary>
  3639. </member>
  3640. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.BorderRight">
  3641. <summary>
  3642. Get or set the type of border to use for the right border of the cell
  3643. </summary>
  3644. </member>
  3645. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.BorderTop">
  3646. <summary>
  3647. Get or set the type of border to use for the top border of the cell
  3648. </summary>
  3649. </member>
  3650. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.BottomBorderColor">
  3651. Get the color to use for the bottom border
  3652. Color is optional. When missing, IndexedColors.Automatic is implied.
  3653. @return the index of the color defInition, default value is {@link NPOI.ss.usermodel.IndexedColors#AUTOMATIC}
  3654. @see NPOI.ss.usermodel.IndexedColors
  3655. </member>
  3656. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.BottomBorderXSSFColor">
  3657. Get the color to use for the bottom border as a {@link XSSFColor}
  3658. @return the used color or <code>null</code> if not Set
  3659. </member>
  3660. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.DataFormat">
  3661. Get the index of the number format (numFmt) record used by this cell format.
  3662. @return the index of the number format
  3663. </member>
  3664. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetDataFormat(System.Int32)">
  3665. Set the index of a data format
  3666. @param fmt the index of a data format
  3667. </member>
  3668. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetDataFormatString">
  3669. Get the contents of the format string, by looking up
  3670. the StylesSource
  3671. @return the number format string
  3672. </member>
  3673. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillBackgroundColor">
  3674. <summary>
  3675. Get the background fill color.
  3676. Note - many cells are actually filled with a foreground fill, not a background fill
  3677. </summary>
  3678. </member>
  3679. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillBackgroundColorColor">
  3680. Get the background fill color.
  3681. <p>
  3682. Note - many cells are actually Filled with a foreground
  3683. Fill, not a background fill - see {@link #getFillForegroundColor()}
  3684. </p>
  3685. @see NPOI.xssf.usermodel.XSSFColor#getRgb()
  3686. @return XSSFColor - fill color or <code>null</code> if not Set
  3687. </member>
  3688. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillForegroundColor">
  3689. Get the foreground fill color.
  3690. <p>
  3691. Many cells are Filled with this, instead of a
  3692. background color ({@link #getFillBackgroundColor()})
  3693. </p>
  3694. @see IndexedColors
  3695. @return fill color, default value is {@link NPOI.ss.usermodel.IndexedColors#AUTOMATIC}
  3696. </member>
  3697. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillForegroundColorColor">
  3698. <summary>
  3699. Get the foreground fill color.
  3700. </summary>
  3701. </member>
  3702. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillForegroundXSSFColor">
  3703. <summary>
  3704. Get the foreground fill color.
  3705. </summary>
  3706. </member>
  3707. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetFont">
  3708. Gets the font for this style
  3709. @return Font - font
  3710. </member>
  3711. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FontIndex">
  3712. Gets the index of the font for this style
  3713. @return short - font index
  3714. @see NPOI.xssf.usermodel.XSSFWorkbook#getFontAt(short)
  3715. </member>
  3716. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.IsHidden">
  3717. Get whether the cell's using this style are to be hidden
  3718. @return bool - whether the cell using this style is hidden
  3719. </member>
  3720. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.Indention">
  3721. Get the number of spaces to indent the text in the cell
  3722. @return indent - number of spaces
  3723. </member>
  3724. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.Index">
  3725. Get the index within the StylesTable (sequence within the collection of CT_Xf elements)
  3726. @return unique index number of the underlying record this style represents
  3727. </member>
  3728. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.LeftBorderColor">
  3729. Get the color to use for the left border
  3730. @return the index of the color defInition, default value is {@link NPOI.ss.usermodel.IndexedColors#BLACK}
  3731. @see NPOI.ss.usermodel.IndexedColors
  3732. </member>
  3733. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.LeftBorderXSSFColor">
  3734. Get the color to use for the left border
  3735. @return the index of the color defInition or <code>null</code> if not Set
  3736. @see NPOI.ss.usermodel.IndexedColors
  3737. </member>
  3738. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.IsLocked">
  3739. <summary>
  3740. Get whether the cell's using this style are locked
  3741. </summary>
  3742. </member>
  3743. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.RightBorderColor">
  3744. <summary>
  3745. Get the color to use for the right border
  3746. </summary>
  3747. </member>
  3748. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.RightBorderXSSFColor">
  3749. <summary>
  3750. Get the color to use for the right border
  3751. </summary>
  3752. <returns></returns>
  3753. </member>
  3754. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.Rotation">
  3755. <summary>
  3756. Get the degree of rotation (between 0 and 180 degrees) for the text in the cell
  3757. Note: HSSF uses values from -90 to 90 degrees, whereas XSSF
  3758. uses values from 0 to 180 degrees.The implementations of this method will map between these two value-ranges
  3759. accordingly, however the corresponding getter is returning values in the range mandated by the current type
  3760. of Excel file-format that this CellStyle is applied to.
  3761. </summary>
  3762. <example>
  3763. Expressed in degrees. Values range from 0 to 180. The first letter of
  3764. the text is considered the center-point of the arc.
  3765. For 0 - 90, the value represents degrees above horizon. For 91-180 the degrees below the horizon is calculated as:
  3766. <code>[degrees below horizon] = 90 - textRotation.</code>
  3767. </example>
  3768. </member>
  3769. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.TopBorderColor">
  3770. Get the color to use for the top border
  3771. @return the index of the color defInition, default value is {@link NPOI.ss.usermodel.IndexedColors#BLACK}
  3772. @see NPOI.ss.usermodel.IndexedColors
  3773. </member>
  3774. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.TopBorderXSSFColor">
  3775. <summary>
  3776. Get the color to use for the top border
  3777. </summary>
  3778. <returns></returns>
  3779. </member>
  3780. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.VerticalAlignment">
  3781. <summary>
  3782. Get the type of vertical alignment for the cell
  3783. </summary>
  3784. </member>
  3785. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetVerticalAlignmentEnum">
  3786. <summary>
  3787. Get the type of vertical alignment for the cell
  3788. </summary>
  3789. <returns></returns>
  3790. </member>
  3791. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.WrapText">
  3792. <summary>
  3793. Whether the text in a cell should be line-wrapped within the cell.
  3794. </summary>
  3795. </member>
  3796. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetBottomBorderColor(NPOI.XSSF.UserModel.XSSFColor)">
  3797. Set the color to use for the bottom border
  3798. @param color the color to use, null means no color
  3799. </member>
  3800. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFCellStyle.SetFillBackgroundColor(NPOI.XSSF.UserModel.XSSFColor)" -->
  3801. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetFillForegroundColor(NPOI.XSSF.UserModel.XSSFColor)">
  3802. * Set the foreground fill color represented as a {@link XSSFColor} value.
  3803. * <br/>
  3804. * <i>Note: Ensure Foreground color is Set prior to background color.</i>
  3805. * @param color the color to use
  3806. * @see #setFillBackgroundColor(NPOI.xssf.usermodel.XSSFColor) )
  3807. </member>
  3808. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCTFill">
  3809. Get a <b>copy</b> of the currently used CT_Fill, if none is used, return a new instance.
  3810. </member>
  3811. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCTBorder(System.Boolean)">
  3812. Get a <b>copy</b> of the currently used CT_Border, if none is used, return a new instance.
  3813. </member>
  3814. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetFont(NPOI.SS.UserModel.IFont)">
  3815. Set the font for this style
  3816. @param font a font object Created or retrieved from the XSSFWorkbook object
  3817. @see NPOI.xssf.usermodel.XSSFWorkbook#CreateFont()
  3818. @see NPOI.xssf.usermodel.XSSFWorkbook#getFontAt(short)
  3819. </member>
  3820. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetLeftBorderColor(NPOI.XSSF.UserModel.XSSFColor)">
  3821. Set the color to use for the left border as a {@link XSSFColor} value
  3822. @param color the color to use
  3823. </member>
  3824. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetRightBorderColor(NPOI.XSSF.UserModel.XSSFColor)">
  3825. Set the color to use for the right border as a {@link XSSFColor} value
  3826. @param color the color to use
  3827. </member>
  3828. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetTopBorderColor(NPOI.XSSF.UserModel.XSSFColor)">
  3829. Set the color to use for the top border as a {@link XSSFColor} value
  3830. @param color the color to use
  3831. </member>
  3832. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetVerticalAlignment(System.Int16)">
  3833. Set the type of vertical alignment for the cell
  3834. @param align - align the type of alignment
  3835. @see NPOI.ss.usermodel.CellStyle#VERTICAL_TOP
  3836. @see NPOI.ss.usermodel.CellStyle#VERTICAL_CENTER
  3837. @see NPOI.ss.usermodel.CellStyle#VERTICAL_BOTTOM
  3838. @see NPOI.ss.usermodel.CellStyle#VERTICAL_JUSTIFY
  3839. @see NPOI.ss.usermodel.VerticalAlignment
  3840. </member>
  3841. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetBorderColor(NPOI.XSSF.UserModel.Extensions.BorderSide)">
  3842. Gets border color
  3843. @param side the border side
  3844. @return the used color
  3845. </member>
  3846. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetBorderColor(NPOI.XSSF.UserModel.Extensions.BorderSide,NPOI.XSSF.UserModel.XSSFColor)">
  3847. Set the color to use for the selected border
  3848. @param side - where to apply the color defInition
  3849. @param color - the color to use
  3850. </member>
  3851. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCellAlignment">
  3852. Get the cellAlignment object to use for manage alignment
  3853. @return XSSFCellAlignment - cell alignment
  3854. </member>
  3855. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCTCellAlignment">
  3856. Return the CT_CellAlignment instance for alignment
  3857. @return CT_CellAlignment
  3858. </member>
  3859. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetHashCode">
  3860. Returns a hash code value for the object. The hash is derived from the underlying CT_Xf bean.
  3861. @return the hash code value for this style
  3862. </member>
  3863. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.Equals(System.Object)">
  3864. Checks is the supplied style is equal to this style
  3865. @param o the style to check
  3866. @return true if the supplied style is equal to this style
  3867. </member>
  3868. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.Clone">
  3869. Make a copy of this style. The underlying CT_Xf bean is Cloned,
  3870. the references to Fills and borders remain.
  3871. @return a copy of this style
  3872. </member>
  3873. <member name="T:NPOI.XSSF.UserModel.XSSFChart">
  3874. Represents a SpreadsheetML Chart
  3875. @author Nick Burch
  3876. @author Roman Kashitsyn
  3877. </member>
  3878. <member name="F:NPOI.XSSF.UserModel.XSSFChart.frame">
  3879. Parent graphic frame.
  3880. </member>
  3881. <member name="F:NPOI.XSSF.UserModel.XSSFChart.chartSpaceDocument">
  3882. Root element of the SpreadsheetML Chart part
  3883. </member>
  3884. <member name="F:NPOI.XSSF.UserModel.XSSFChart.chart">
  3885. The Chart within that
  3886. </member>
  3887. <member name="M:NPOI.XSSF.UserModel.XSSFChart.#ctor">
  3888. Create a new SpreadsheetML chart
  3889. </member>
  3890. <member name="M:NPOI.XSSF.UserModel.XSSFChart.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  3891. Construct a SpreadsheetML chart from a namespace part.
  3892. @param part the namespace part holding the chart data,
  3893. the content type must be <code>application/vnd.Openxmlformats-officedocument.Drawingml.chart+xml</code>
  3894. @param rel the namespace relationship holding this chart,
  3895. the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/chart
  3896. </member>
  3897. <member name="M:NPOI.XSSF.UserModel.XSSFChart.CreateChart">
  3898. Construct a new CTChartSpace bean.
  3899. By default, it's just an empty placeholder for chart objects.
  3900. @return a new CTChartSpace bean
  3901. </member>
  3902. <member name="M:NPOI.XSSF.UserModel.XSSFChart.GetCTChartSpace">
  3903. <summary>
  3904. Return the underlying CTChartSpace bean, the root element of the SpreadsheetML Chart part.
  3905. </summary>
  3906. <returns></returns>
  3907. </member>
  3908. <member name="M:NPOI.XSSF.UserModel.XSSFChart.GetCTChart">
  3909. <summary>
  3910. Return the underlying CTChart bean, within the Chart Space
  3911. </summary>
  3912. <returns></returns>
  3913. </member>
  3914. <member name="M:NPOI.XSSF.UserModel.XSSFChart.GetGraphicFrame">
  3915. <summary>
  3916. Returns the parent graphic frame.
  3917. </summary>
  3918. <returns></returns>
  3919. </member>
  3920. <member name="M:NPOI.XSSF.UserModel.XSSFChart.SetGraphicFrame(NPOI.XSSF.UserModel.XSSFGraphicFrame)">
  3921. Sets the parent graphic frame.
  3922. </member>
  3923. <member name="M:NPOI.XSSF.UserModel.XSSFChart.IsPlotOnlyVisibleCells">
  3924. @return true if only visible cells will be present on the chart,
  3925. false otherwise
  3926. </member>
  3927. <member name="M:NPOI.XSSF.UserModel.XSSFChart.SetPlotOnlyVisibleCells(System.Boolean)">
  3928. @param plotVisOnly a flag specifying if only visible cells should be
  3929. present on the chart
  3930. </member>
  3931. <member name="P:NPOI.XSSF.UserModel.XSSFChart.Title">
  3932. Returns the title, or null if none is Set
  3933. </member>
  3934. <member name="M:NPOI.XSSF.UserModel.XSSFChart.SetTitle(System.String)">
  3935. Sets the title text.
  3936. </member>
  3937. <member name="T:NPOI.XSSF.UserModel.XSSFChartSheet">
  3938. High level representation of Sheet Parts that are of type 'chartsheet'.
  3939. <p>
  3940. Chart sheet is a special kind of Sheet that Contains only chart and no data.
  3941. </p>
  3942. @author Yegor Kozlov
  3943. </member>
  3944. <member name="M:NPOI.XSSF.UserModel.XSSFChartSheet.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  3945. @since POI 3.14-Beta1
  3946. </member>
  3947. <member name="M:NPOI.XSSF.UserModel.XSSFChartSheet.GetCTChartsheet">
  3948. Provide access to the CTChartsheet bean holding this sheet's data
  3949. @return the CTChartsheet bean holding this sheet's data
  3950. </member>
  3951. <member name="T:NPOI.XSSF.UserModel.XSSFClientAnchor">
  3952. A client anchor is attached to an excel worksheet. It anchors against
  3953. top-left and bottom-right cells.
  3954. @author Yegor Kozlov
  3955. </member>
  3956. <member name="F:NPOI.XSSF.UserModel.XSSFClientAnchor.cell1">
  3957. Starting anchor point
  3958. </member>
  3959. <member name="F:NPOI.XSSF.UserModel.XSSFClientAnchor.cell2">
  3960. Ending anchor point
  3961. </member>
  3962. <member name="M:NPOI.XSSF.UserModel.XSSFClientAnchor.#ctor">
  3963. Creates a new client anchor and defaults all the anchor positions to 0.
  3964. </member>
  3965. <member name="M:NPOI.XSSF.UserModel.XSSFClientAnchor.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  3966. Creates a new client anchor and Sets the top-left and bottom-right
  3967. coordinates of the anchor.
  3968. @param dx1 the x coordinate within the first cell.
  3969. @param dy1 the y coordinate within the first cell.
  3970. @param dx2 the x coordinate within the second cell.
  3971. @param dy2 the y coordinate within the second cell.
  3972. @param col1 the column (0 based) of the first cell.
  3973. @param row1 the row (0 based) of the first cell.
  3974. @param col2 the column (0 based) of the second cell.
  3975. @param row2 the row (0 based) of the second cell.
  3976. </member>
  3977. <member name="M:NPOI.XSSF.UserModel.XSSFClientAnchor.#ctor(NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Marker,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Marker)">
  3978. Create XSSFClientAnchor from existing xml beans
  3979. @param cell1 starting anchor point
  3980. @param cell2 ending anchor point
  3981. </member>
  3982. <member name="P:NPOI.XSSF.UserModel.XSSFClientAnchor.From">
  3983. Return starting anchor point
  3984. @return starting anchor point
  3985. </member>
  3986. <member name="P:NPOI.XSSF.UserModel.XSSFClientAnchor.To">
  3987. Return ending anchor point
  3988. @return ending anchor point
  3989. </member>
  3990. <member name="T:NPOI.XSSF.UserModel.XSSFColor">
  3991. Represents a color in SpreadsheetML
  3992. </member>
  3993. <member name="M:NPOI.XSSF.UserModel.XSSFColor.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Color)">
  3994. Create an instance of XSSFColor from the supplied XML bean
  3995. </member>
  3996. <member name="M:NPOI.XSSF.UserModel.XSSFColor.#ctor">
  3997. Create an new instance of XSSFColor
  3998. </member>
  3999. <member name="P:NPOI.XSSF.UserModel.XSSFColor.IsAuto">
  4000. <summary>
  4001. A bool value indicating the ctColor is automatic and system ctColor dependent.
  4002. </summary>
  4003. </member>
  4004. <member name="P:NPOI.XSSF.UserModel.XSSFColor.HasAlpha">
  4005. A bool value indicating if the ctColor has a alpha or not
  4006. </member>
  4007. <member name="P:NPOI.XSSF.UserModel.XSSFColor.HasTint">
  4008. A bool value indicating if the ctColor has a tint or not
  4009. </member>
  4010. <member name="P:NPOI.XSSF.UserModel.XSSFColor.Indexed">
  4011. Indexed ctColor value. Only used for backwards compatibility. References a ctColor in indexedColors.
  4012. </member>
  4013. <member name="P:NPOI.XSSF.UserModel.XSSFColor.RGB">
  4014. Standard Red Green Blue ctColor value (RGB).
  4015. If there was an A (Alpha) value, it will be stripped.
  4016. </member>
  4017. <member name="P:NPOI.XSSF.UserModel.XSSFColor.ARGB">
  4018. Standard Alpha Red Green Blue ctColor value (ARGB).
  4019. </member>
  4020. <member name="M:NPOI.XSSF.UserModel.XSSFColor.GetARgb">
  4021. Standard Alpha Red Green Blue ctColor value (ARGB).
  4022. </member>
  4023. <member name="M:NPOI.XSSF.UserModel.XSSFColor.GetRgbWithTint">
  4024. Standard Red Green Blue ctColor value (RGB) with applied tint.
  4025. Alpha values are ignored.
  4026. </member>
  4027. <member name="M:NPOI.XSSF.UserModel.XSSFColor.SetRgb(System.Byte[])">
  4028. Standard Alpha Red Green Blue ctColor value (ARGB).
  4029. </member>
  4030. <member name="P:NPOI.XSSF.UserModel.XSSFColor.Theme">
  4031. Index into the clrScheme collection, referencing a particular sysClr or
  4032. srgbClr value expressed in the Theme part.
  4033. </member>
  4034. <member name="P:NPOI.XSSF.UserModel.XSSFColor.Tint">
  4035. Specifies the tint value applied to the ctColor.
  4036. <p>
  4037. If tint is supplied, then it is applied to the RGB value of the ctColor to determine the final
  4038. ctColor applied.
  4039. </p>
  4040. <p>
  4041. The tint value is stored as a double from -1.0 .. 1.0, where -1.0 means 100% darken and
  4042. 1.0 means 100% lighten. Also, 0.0 means no Change.
  4043. </p>
  4044. <p>
  4045. In loading the RGB value, it is Converted to HLS where HLS values are (0..HLSMAX), where
  4046. HLSMAX is currently 255.
  4047. </p>
  4048. Here are some examples of how to apply tint to ctColor:
  4049. <blockquote>
  4050. <pre>
  4051. If (tint &lt; 0)
  4052. Lum' = Lum * (1.0 + tint)
  4053. For example: Lum = 200; tint = -0.5; Darken 50%
  4054. Lum' = 200 * (0.5) =&gt; 100
  4055. For example: Lum = 200; tint = -1.0; Darken 100% (make black)
  4056. Lum' = 200 * (1.0-1.0) =&gt; 0
  4057. If (tint &gt; 0)
  4058. Lum' = Lum * (1.0-tint) + (HLSMAX - HLSMAX * (1.0-tint))
  4059. For example: Lum = 100; tint = 0.75; Lighten 75%
  4060. Lum' = 100 * (1-.75) + (HLSMAX - HLSMAX*(1-.75))
  4061. = 100 * .25 + (255 - 255 * .25)
  4062. = 25 + (255 - 63) = 25 + 192 = 217
  4063. For example: Lum = 100; tint = 1.0; Lighten 100% (make white)
  4064. Lum' = 100 * (1-1) + (HLSMAX - HLSMAX*(1-1))
  4065. = 100 * 0 + (255 - 255 * 0)
  4066. = 0 + (255 - 0) = 255
  4067. </pre>
  4068. </blockquote>
  4069. @return the tint value
  4070. </member>
  4071. <member name="M:NPOI.XSSF.UserModel.XSSFColor.GetCTColor">
  4072. Returns the underlying XML bean
  4073. @return the underlying XML bean
  4074. </member>
  4075. <member name="M:NPOI.XSSF.UserModel.XSSFColor.ToXSSFColor(NPOI.SS.UserModel.IColor)">
  4076. <summary>
  4077. Checked type cast <tt>color</tt> to an XSSFColor.
  4078. </summary>
  4079. <param name="color">the color to type cast</param>
  4080. <returns>the type casted color</returns>
  4081. <exception cref="T:System.ArgumentException">if color is null or is not an instance of XSSFColor</exception>
  4082. </member>
  4083. <member name="T:NPOI.XSSF.UserModel.XSSFColorScaleFormatting">
  4084. High level representation for Color Scale / Color Gradient Formatting
  4085. component of Conditional Formatting Settings
  4086. </member>
  4087. <member name="F:NPOI.XSSF.UserModel.XSSFComment._str">
  4088. cached reference to the string with the comment text
  4089. </member>
  4090. <member name="M:NPOI.XSSF.UserModel.XSSFComment.#ctor(NPOI.XSSF.Model.CommentsTable,NPOI.OpenXmlFormats.Spreadsheet.CT_Comment,NPOI.OpenXmlFormats.Vml.CT_Shape)">
  4091. Creates a new XSSFComment, associated with a given
  4092. low level comment object.
  4093. </member>
  4094. <member name="P:NPOI.XSSF.UserModel.XSSFComment.Author">
  4095. @return Name of the original comment author. Default value is blank.
  4096. </member>
  4097. <member name="P:NPOI.XSSF.UserModel.XSSFComment.Column">
  4098. @return the 0-based column of the cell that the comment is associated with.
  4099. </member>
  4100. <member name="P:NPOI.XSSF.UserModel.XSSFComment.Row">
  4101. @return the 0-based row index of the cell that the comment is associated with.
  4102. </member>
  4103. <member name="P:NPOI.XSSF.UserModel.XSSFComment.Visible">
  4104. @return whether the comment is visible
  4105. </member>
  4106. <member name="P:NPOI.XSSF.UserModel.XSSFComment.String">
  4107. @return the rich text string of the comment
  4108. </member>
  4109. <member name="M:NPOI.XSSF.UserModel.XSSFComment.SetString(System.String)">
  4110. Sets the rich text string used by this comment.
  4111. @param string the XSSFRichTextString used by this object.
  4112. </member>
  4113. <member name="M:NPOI.XSSF.UserModel.XSSFComment.GetCTComment">
  4114. @return the xml bean holding this comment's properties
  4115. </member>
  4116. <member name="T:NPOI.XSSF.UserModel.XSSFConditionalFormatting">
  4117. @author Yegor Kozlov
  4118. </member>
  4119. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormatting.GetFormattingRanges">
  4120. @return array of <tt>CellRangeAddress</tt>s. Never <code>null</code>
  4121. </member>
  4122. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormatting.SetRule(System.Int32,NPOI.SS.UserModel.IConditionalFormattingRule)">
  4123. Replaces an existing Conditional Formatting rule at position idx.
  4124. Excel allows to create up to 3 Conditional Formatting rules.
  4125. This method can be useful to modify existing Conditional Formatting rules.
  4126. @param idx position of the rule. Should be between 0 and 2.
  4127. @param cfRule - Conditional Formatting rule
  4128. </member>
  4129. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormatting.AddRule(NPOI.SS.UserModel.IConditionalFormattingRule)">
  4130. Add a Conditional Formatting rule.
  4131. Excel allows to create up to 3 Conditional Formatting rules.
  4132. @param cfRule - Conditional Formatting rule
  4133. </member>
  4134. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormatting.GetRule(System.Int32)">
  4135. @return the Conditional Formatting rule at position idx.
  4136. </member>
  4137. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormatting.NumberOfRules">
  4138. @return number of Conditional Formatting rules.
  4139. </member>
  4140. <member name="T:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule">
  4141. @author Yegor Kozlov
  4142. </member>
  4143. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.CreateBorderFormatting">
  4144. Create a new border formatting structure if it does not exist,
  4145. otherwise just return existing object.
  4146. @return - border formatting object, never returns <code>null</code>.
  4147. </member>
  4148. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.BorderFormatting">
  4149. @return - border formatting object if defined, <code>null</code> otherwise
  4150. </member>
  4151. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.CreateFontFormatting">
  4152. Create a new font formatting structure if it does not exist,
  4153. otherwise just return existing object.
  4154. @return - font formatting object, never returns <code>null</code>.
  4155. </member>
  4156. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.FontFormatting">
  4157. @return - font formatting object if defined, <code>null</code> otherwise
  4158. </member>
  4159. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.CreatePatternFormatting">
  4160. Create a new pattern formatting structure if it does not exist,
  4161. otherwise just return existing object.
  4162. @return - pattern formatting object, never returns <code>null</code>.
  4163. </member>
  4164. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.PatternFormatting">
  4165. @return - pattern formatting object if defined, <code>null</code> otherwise
  4166. </member>
  4167. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.ConditionType">
  4168. Type of conditional formatting rule.
  4169. </member>
  4170. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.ComparisonOperation">
  4171. The comparison function used when the type of conditional formatting is Set to
  4172. {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS}
  4173. <p>
  4174. MUST be a constant from {@link NPOI.ss.usermodel.ComparisonOperator}
  4175. </p>
  4176. @return the conditional format operator
  4177. </member>
  4178. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.Formula1">
  4179. The formula used to Evaluate the first operand for the conditional formatting rule.
  4180. <p>
  4181. If the condition type is {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS},
  4182. this field is the first operand of the comparison.
  4183. If type is {@link ConditionalFormattingRule#CONDITION_TYPE_FORMULA}, this formula is used
  4184. to determine if the conditional formatting is applied.
  4185. </p>
  4186. <p>
  4187. If comparison type is {@link ConditionalFormattingRule#CONDITION_TYPE_FORMULA} the formula MUST be a Boolean function
  4188. </p>
  4189. @return the first formula
  4190. </member>
  4191. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.Formula2">
  4192. The formula used to Evaluate the second operand of the comparison when
  4193. comparison type is {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS} and operator
  4194. is either {@link NPOI.ss.usermodel.ComparisonOperator#BETWEEN} or {@link NPOI.ss.usermodel.ComparisonOperator#NOT_BETWEEN}
  4195. @return the second formula
  4196. </member>
  4197. <member name="T:NPOI.XSSF.UserModel.XSSFConditionalFormattingThreshold">
  4198. High level representation for Icon / Multi-State / Databar /
  4199. Colour Scale change thresholds
  4200. </member>
  4201. <member name="T:NPOI.XSSF.UserModel.XSSFConnector">
  4202. A connection shape Drawing element. A connection shape is a line, etc.
  4203. that connects two other shapes in this Drawing.
  4204. @author Yegor Kozlov
  4205. </member>
  4206. <member name="M:NPOI.XSSF.UserModel.XSSFConnector.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Connector)">
  4207. Construct a new XSSFConnector object.
  4208. @param Drawing the XSSFDrawing that owns this shape
  4209. @param ctShape the shape bean that holds all the shape properties
  4210. </member>
  4211. <member name="M:NPOI.XSSF.UserModel.XSSFConnector.Prototype">
  4212. Initialize default structure of a new auto-shape
  4213. </member>
  4214. <member name="P:NPOI.XSSF.UserModel.XSSFConnector.ShapeType">
  4215. Gets the shape type, one of the constants defined in {@link NPOI.ss.usermodel.ShapeTypes}.
  4216. @return the shape type
  4217. @see NPOI.ss.usermodel.ShapeTypes
  4218. </member>
  4219. <member name="M:NPOI.XSSF.UserModel.XSSFCreationHelper.CreateRichTextString(System.String)">
  4220. Creates a new XSSFRichTextString for you.
  4221. </member>
  4222. <member name="M:NPOI.XSSF.UserModel.XSSFCreationHelper.CreateFormulaEvaluator">
  4223. Creates a XSSFFormulaEvaluator, the object that Evaluates formula cells.
  4224. @return a XSSFFormulaEvaluator instance
  4225. </member>
  4226. <member name="M:NPOI.XSSF.UserModel.XSSFCreationHelper.CreateClientAnchor">
  4227. Creates a XSSFClientAnchor. Use this object to position Drawing object in
  4228. a sheet
  4229. @return a XSSFClientAnchor instance
  4230. @see NPOI.ss.usermodel.Drawing
  4231. </member>
  4232. <member name="T:NPOI.XSSF.UserModel.XSSFDataBarFormatting">
  4233. High level representation for DataBar / Data Bar Formatting
  4234. component of Conditional Formatting Settings
  4235. </member>
  4236. <member name="T:NPOI.XSSF.UserModel.XSSFDataFormat">
  4237. Handles data formats for XSSF.
  4238. Per Microsoft Excel 2007+ format limitations:
  4239. Workbooks support between 200 and 250 "number formats"
  4240. (POI calls them "data formats") So short or even byte
  4241. would be acceptable data types to use for referring to
  4242. data format indices.
  4243. https://support.office.com/en-us/article/excel-specifications-and-limits-1672b34d-7043-467e-8e27-269d656771c3
  4244. </member>
  4245. <member name="M:NPOI.XSSF.UserModel.XSSFDataFormat.GetFormat(System.String)">
  4246. Get the format index that matches the given format
  4247. string, creating a new format entry if required.
  4248. Aliases text to the proper format as required.
  4249. @param format string matching a built in format
  4250. @return index of format.
  4251. </member>
  4252. <member name="M:NPOI.XSSF.UserModel.XSSFDataFormat.GetFormat(System.Int16)">
  4253. Get the format string that matches the given format index
  4254. @param index of a format
  4255. @return string represented at index of format or null if there is not a format at that index
  4256. </member>
  4257. <member name="M:NPOI.XSSF.UserModel.XSSFDataFormat.GetFormat(System.Int32)">
  4258. get the format string that matches the given format index
  4259. @param index of a format
  4260. @return string represented at index of format or null if there is not a format at that index
  4261. </member>
  4262. <member name="M:NPOI.XSSF.UserModel.XSSFDataFormat.PutFormat(System.Int16,System.String)">
  4263. Add a number format with a specific ID into the number format style table.
  4264. If a format with the same ID already exists, overwrite the format code
  4265. with <code>fmt</code>
  4266. This may be used to override built-in number formats.
  4267. @param index the number format ID
  4268. @param format the number format code
  4269. </member>
  4270. <member name="T:NPOI.XSSF.UserModel.XSSFDataValidation">
  4271. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  4272. </member>
  4273. <member name="T:NPOI.XSSF.UserModel.XSSFDataValidationConstraint">
  4274. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  4275. </member>
  4276. <member name="F:NPOI.XSSF.UserModel.XSSFDataValidationConstraint.LIST_SEPARATOR">
  4277. Excel validation constraints with static lists are delimited with optional whitespace and the Windows List Separator,
  4278. which is typically comma, but can be changed by users. POI will just assume comma.
  4279. </member>
  4280. <member name="M:NPOI.XSSF.UserModel.XSSFDataValidationConstraint.#ctor(System.Int32,System.Int32,System.String,System.String)">
  4281. <summary>
  4282. This is the constructor called using the OOXML raw data. Excel overloads formula1 to also encode explicit value lists,
  4283. so this constructor has to check for and parse that syntax.
  4284. </summary>
  4285. <param name="validationType"></param>
  4286. <param name="operator1"></param>
  4287. <param name="formula1">Overloaded: formula1 or list of explicit values</param>
  4288. <param name="formula2">formula1 is a list of explicit values, this is ignored: use <code>null</code></param>
  4289. </member>
  4290. <member name="T:NPOI.XSSF.UserModel.XSSFDataValidationHelper">
  4291. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  4292. </member>
  4293. <member name="T:NPOI.XSSF.UserModel.XSSFDrawing">
  4294. Represents a SpreadsheetML Drawing
  4295. @author Yegor Kozlov
  4296. </member>
  4297. <member name="F:NPOI.XSSF.UserModel.XSSFDrawing.drawing">
  4298. Root element of the SpreadsheetML Drawing part
  4299. </member>
  4300. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.#ctor">
  4301. Create a new SpreadsheetML Drawing
  4302. @see NPOI.xssf.usermodel.XSSFSheet#CreateDrawingPatriarch()
  4303. </member>
  4304. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  4305. Construct a SpreadsheetML Drawing from a namespace part
  4306. @param part the namespace part holding the Drawing data,
  4307. the content type must be <code>application/vnd.openxmlformats-officedocument.Drawing+xml</code>
  4308. @param rel the namespace relationship holding this Drawing,
  4309. the relationship type must be http://schemas.openxmlformats.org/officeDocument/2006/relationships/drawing
  4310. </member>
  4311. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.NewDrawing">
  4312. Construct a new CT_Drawing bean. By default, it's just an empty placeholder for Drawing objects
  4313. @return a new CT_Drawing bean
  4314. </member>
  4315. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.GetCTDrawing">
  4316. Return the underlying CT_Drawing bean, the root element of the SpreadsheetML Drawing part.
  4317. @return the underlying CT_Drawing bean
  4318. </member>
  4319. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateTextbox(NPOI.SS.UserModel.IClientAnchor)">
  4320. Constructs a textbox under the Drawing.
  4321. @param anchor the client anchor describes how this group is attached
  4322. to the sheet.
  4323. @return the newly Created textbox.
  4324. </member>
  4325. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreatePicture(NPOI.XSSF.UserModel.XSSFClientAnchor,System.Int32)">
  4326. Creates a picture.
  4327. @param anchor the client anchor describes how this picture is attached to the sheet.
  4328. @param pictureIndex the index of the picture in the workbook collection of pictures,
  4329. {@link NPOI.xssf.usermodel.XSSFWorkbook#getAllPictures()} .
  4330. @return the newly Created picture shape.
  4331. </member>
  4332. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateChart(NPOI.SS.UserModel.IClientAnchor)">
  4333. <summary>
  4334. Creates a chart.
  4335. </summary>
  4336. <param name="anchor">the client anchor describes how this chart is attached to</param>
  4337. <returns>the newly created chart</returns>
  4338. </member>
  4339. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.RemoveChart(NPOI.XSSF.UserModel.XSSFChart)">
  4340. <summary>
  4341. Removes chart.
  4342. </summary>
  4343. <param name="chart">The chart to be removed.</param>
  4344. </member>
  4345. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.AddPictureReference(System.Int32)">
  4346. Add the indexed picture to this Drawing relations
  4347. @param pictureIndex the index of the picture in the workbook collection of pictures,
  4348. {@link NPOI.xssf.usermodel.XSSFWorkbook#getAllPictures()} .
  4349. </member>
  4350. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateSimpleShape(NPOI.XSSF.UserModel.XSSFClientAnchor)">
  4351. Creates a simple shape. This includes such shapes as lines, rectangles,
  4352. and ovals.
  4353. @param anchor the client anchor describes how this group is attached
  4354. to the sheet.
  4355. @return the newly Created shape.
  4356. </member>
  4357. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateConnector(NPOI.XSSF.UserModel.XSSFClientAnchor)">
  4358. Creates a simple shape. This includes such shapes as lines, rectangles,
  4359. and ovals.
  4360. @param anchor the client anchor describes how this group is attached
  4361. to the sheet.
  4362. @return the newly Created shape.
  4363. </member>
  4364. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateGroup(NPOI.XSSF.UserModel.XSSFClientAnchor)">
  4365. Creates a simple shape. This includes such shapes as lines, rectangles,
  4366. and ovals.
  4367. @param anchor the client anchor describes how this group is attached
  4368. to the sheet.
  4369. @return the newly Created shape.
  4370. </member>
  4371. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateCellComment(NPOI.SS.UserModel.IClientAnchor)">
  4372. Creates a comment.
  4373. @param anchor the client anchor describes how this comment is attached
  4374. to the sheet.
  4375. @return the newly Created comment.
  4376. </member>
  4377. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateGraphicFrame(NPOI.XSSF.UserModel.XSSFClientAnchor)">
  4378. Creates a new graphic frame.
  4379. @param anchor the client anchor describes how this frame is attached
  4380. to the sheet
  4381. @return the newly Created graphic frame
  4382. </member>
  4383. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.GetCharts">
  4384. Returns all charts in this Drawing.
  4385. </member>
  4386. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateTwoCellAnchor(NPOI.SS.UserModel.IClientAnchor)">
  4387. Create and Initialize a CT_TwoCellAnchor that anchors a shape against top-left and bottom-right cells.
  4388. @return a new CT_TwoCellAnchor
  4389. </member>
  4390. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.GetShapes">
  4391. @return list of shapes in this drawing
  4392. </member>
  4393. <member name="T:NPOI.XSSF.UserModel.XSSFEvaluationCell">
  4394. XSSF wrapper for a cell under Evaluation
  4395. @author Josh Micich
  4396. </member>
  4397. <member name="T:NPOI.XSSF.UserModel.XSSFEvaluationSheet">
  4398. XSSF wrapper for a sheet under Evaluation
  4399. @author Josh Micich
  4400. </member>
  4401. <member name="T:NPOI.XSSF.UserModel.XSSFEvaluationWorkbook">
  4402. Internal POI use only
  4403. @author Josh Micich
  4404. </member>
  4405. <member name="T:NPOI.XSSF.UserModel.XSSFEvenFooter">
  4406. Even page footer value. Corresponds to even printed pages.
  4407. Even page(s) in the sheet may not be printed, for example, if the print area is specified to be
  4408. a range such that it falls outside an even page's scope.
  4409. If no even footer is specified, then the odd footer's value is assumed for even page footers.
  4410. </member>
  4411. <member name="M:NPOI.XSSF.UserModel.XSSFEvenFooter.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  4412. Create an instance of XSSFEvenFooter from the supplied XML bean
  4413. @see XSSFSheet#GetEvenFooter()
  4414. @param headerFooter
  4415. </member>
  4416. <member name="P:NPOI.XSSF.UserModel.XSSFEvenFooter.Text">
  4417. Get the content text representing the footer
  4418. @return text
  4419. </member>
  4420. <member name="T:NPOI.XSSF.UserModel.XSSFEvenHeader">
  4421. <p>
  4422. Even page header value. Corresponds to even printed pages.
  4423. Even page(s) in the sheet may not be printed, for example, if the print area is specified to be
  4424. a range such that it falls outside an even page's scope.
  4425. If no even header is specified, then odd header value is assumed for even page headers.
  4426. </p>
  4427. </member>
  4428. <member name="M:NPOI.XSSF.UserModel.XSSFEvenHeader.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  4429. Create an instance of XSSFEvenHeader from the supplied XML bean
  4430. @see XSSFSheet#GetEvenHeader()
  4431. @param headerFooter
  4432. </member>
  4433. <member name="P:NPOI.XSSF.UserModel.XSSFEvenHeader.Text">
  4434. Get the content text representing this header
  4435. @return text
  4436. </member>
  4437. <member name="T:NPOI.XSSF.UserModel.XSSFFactory">
  4438. Instantiates sub-classes of POIXMLDocumentPart depending on their relationship type
  4439. @author Yegor Kozlov
  4440. </member>
  4441. <member name="M:NPOI.XSSF.UserModel.XSSFFactory.GetDescriptor(System.String)">
  4442. @since POI 3.14-Beta1
  4443. </member>
  4444. <member name="M:NPOI.XSSF.UserModel.XSSFFactory.CreateDocumentPart(System.Type,System.Type[],System.Object[])">
  4445. @since POI 3.14-Beta1
  4446. </member>
  4447. <member name="T:NPOI.XSSF.UserModel.XSSFFirstFooter">
  4448. First page footer content. Corresponds to first printed page.
  4449. The first logical page in the sheet may not be printed, for example, if the print area is specified to
  4450. be a range such that it falls outside the first page's scope.
  4451. </member>
  4452. <member name="M:NPOI.XSSF.UserModel.XSSFFirstFooter.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  4453. Create an instance of XSSFFirstFooter from the supplied XML bean
  4454. @see XSSFSheet#getFirstFooter()
  4455. @param headerFooter
  4456. </member>
  4457. <member name="P:NPOI.XSSF.UserModel.XSSFFirstFooter.Text">
  4458. Get the content text representing the footer
  4459. @return text
  4460. </member>
  4461. <member name="T:NPOI.XSSF.UserModel.XSSFFirstHeader">
  4462. First page header content. Corresponds to first printed page.
  4463. The first logical page in the sheet may not be printed, for example, if the print area is specified to
  4464. be a range such that it falls outside the first page's scope.
  4465. </member>
  4466. <member name="M:NPOI.XSSF.UserModel.XSSFFirstHeader.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  4467. Create an instance of XSSFFirstHeader from the supplied XML bean
  4468. @see XSSFSheet#getFirstHeader()
  4469. @param headerFooter
  4470. </member>
  4471. <member name="P:NPOI.XSSF.UserModel.XSSFFirstHeader.Text">
  4472. Get the content text representing this header
  4473. @return text
  4474. </member>
  4475. <member name="T:NPOI.XSSF.UserModel.XSSFFont">
  4476. Represents a font used in a workbook.
  4477. @author Gisella Bronzetti
  4478. </member>
  4479. <member name="F:NPOI.XSSF.UserModel.XSSFFont.DEFAULT_FONT_NAME">
  4480. By default, Microsoft Office Excel 2007 uses the Calibry font in font size 11
  4481. </member>
  4482. <member name="F:NPOI.XSSF.UserModel.XSSFFont.DEFAULT_FONT_SIZE">
  4483. By default, Microsoft Office Excel 2007 uses the Calibry font in font size 11
  4484. </member>
  4485. <member name="F:NPOI.XSSF.UserModel.XSSFFont.DEFAULT_FONT_COLOR">
  4486. Default font color is black
  4487. @see NPOI.SS.usermodel.IndexedColors#BLACK
  4488. </member>
  4489. <member name="M:NPOI.XSSF.UserModel.XSSFFont.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Font)">
  4490. Create a new XSSFFont
  4491. @param font the underlying CT_Font bean
  4492. </member>
  4493. <member name="M:NPOI.XSSF.UserModel.XSSFFont.#ctor">
  4494. Create a new XSSFont. This method is protected to be used only by XSSFWorkbook
  4495. </member>
  4496. <member name="M:NPOI.XSSF.UserModel.XSSFFont.GetCTFont">
  4497. get the underlying CT_Font font
  4498. </member>
  4499. <member name="P:NPOI.XSSF.UserModel.XSSFFont.IsBold">
  4500. get a bool value for the boldness to use.
  4501. @return bool - bold
  4502. </member>
  4503. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Charset">
  4504. get character-set to use.
  4505. @return int - character-set (0-255)
  4506. @see NPOI.SS.usermodel.FontCharset
  4507. </member>
  4508. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Color">
  4509. get the indexed color value for the font
  4510. References a color defined in IndexedColors.
  4511. @return short - indexed color to use
  4512. @see IndexedColors
  4513. </member>
  4514. <member name="M:NPOI.XSSF.UserModel.XSSFFont.GetXSSFColor">
  4515. get the color value for the font
  4516. References a color defined as Standard Alpha Red Green Blue color value (ARGB).
  4517. @return XSSFColor - rgb color to use
  4518. </member>
  4519. <member name="M:NPOI.XSSF.UserModel.XSSFFont.GetThemeColor">
  4520. get the color value for the font
  4521. References a color defined in theme.
  4522. @return short - theme defined to use
  4523. </member>
  4524. <member name="P:NPOI.XSSF.UserModel.XSSFFont.FontHeight">
  4525. <summary>
  4526. Get the font height in unit's of 1/20th of a point.
  4527. </summary>
  4528. </member>
  4529. <member name="P:NPOI.XSSF.UserModel.XSSFFont.FontHeightInPoints">
  4530. <summary>
  4531. Get the font height in points.
  4532. </summary>
  4533. </member>
  4534. <member name="P:NPOI.XSSF.UserModel.XSSFFont.FontName">
  4535. get the name of the font (i.e. Arial)
  4536. @return String - a string representing the name of the font to use
  4537. </member>
  4538. <member name="P:NPOI.XSSF.UserModel.XSSFFont.IsItalic">
  4539. get a bool value that specify whether to use italics or not
  4540. @return bool - value for italic
  4541. </member>
  4542. <member name="P:NPOI.XSSF.UserModel.XSSFFont.IsStrikeout">
  4543. get a bool value that specify whether to use a strikeout horizontal line through the text or not
  4544. @return bool - value for strikeout
  4545. </member>
  4546. <member name="P:NPOI.XSSF.UserModel.XSSFFont.TypeOffset">
  4547. get normal,super or subscript.
  4548. @return short - offset type to use (none,super,sub)
  4549. @see Font#SS_NONE
  4550. @see Font#SS_SUPER
  4551. @see Font#SS_SUB
  4552. </member>
  4553. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Underline">
  4554. get type of text underlining to use
  4555. @return byte - underlining type
  4556. @see NPOI.SS.usermodel.FontUnderline
  4557. </member>
  4558. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Boldweight">
  4559. get the boldness to use
  4560. @return boldweight
  4561. @see #BOLDWEIGHT_NORMAL
  4562. @see #BOLDWEIGHT_BOLD
  4563. </member>
  4564. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetCharSet(System.Byte)">
  4565. set character-set to use.
  4566. @param charset - charset
  4567. @see FontCharset
  4568. </member>
  4569. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetCharSet(System.Int32)">
  4570. set character-set to use.
  4571. @param charset - charset
  4572. @see FontCharset
  4573. </member>
  4574. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetCharSet(NPOI.SS.UserModel.FontCharset)">
  4575. set character-set to use.
  4576. @param charSet
  4577. </member>
  4578. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetColor(NPOI.XSSF.UserModel.XSSFColor)">
  4579. set the color for the font in Standard Alpha Red Green Blue color value
  4580. @param color - color to use
  4581. </member>
  4582. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetThemeColor(System.Int16)">
  4583. set the theme color for the font to use
  4584. @param theme - theme color to use
  4585. </member>
  4586. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetUnderline(NPOI.SS.UserModel.FontUnderlineType)">
  4587. set an enumeration representing the style of underlining that is used.
  4588. The none style is equivalent to not using underlining at all.
  4589. The possible values for this attribute are defined by the FontUnderline
  4590. @param underline - FontUnderline enum value
  4591. </member>
  4592. <member name="M:NPOI.XSSF.UserModel.XSSFFont.RegisterTo(NPOI.XSSF.Model.StylesTable)">
  4593. **
  4594. </member>
  4595. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetThemesTable(NPOI.XSSF.Model.ThemesTable)">
  4596. Records the Themes Table that is associated with
  4597. the current font, used when looking up theme
  4598. based colours and properties.
  4599. </member>
  4600. <member name="M:NPOI.XSSF.UserModel.XSSFFont.GetScheme">
  4601. get the font scheme property.
  4602. is used only in StylesTable to create the default instance of font
  4603. @return FontScheme
  4604. @see NPOI.XSSF.model.StylesTable#CreateDefaultFont()
  4605. </member>
  4606. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetScheme(NPOI.SS.UserModel.FontScheme)">
  4607. set font scheme property
  4608. @param scheme - FontScheme enum value
  4609. @see FontScheme
  4610. </member>
  4611. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Family">
  4612. get the font family to use.
  4613. @return the font family to use
  4614. @see NPOI.SS.usermodel.FontFamily
  4615. </member>
  4616. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetFamily(NPOI.SS.UserModel.FontFamily)">
  4617. set an enumeration representing the font family this font belongs to.
  4618. A font family is a set of fonts having common stroke width and serif characteristics.
  4619. @param family font family
  4620. @link #SetFamily(int value)
  4621. </member>
  4622. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Index">
  4623. get the index within the XSSFWorkbook (sequence within the collection of Font objects)
  4624. @return unique index number of the underlying record this Font represents (probably you don't care
  4625. unless you're comparing which one is which)
  4626. </member>
  4627. <member name="T:NPOI.XSSF.UserModel.XSSFFontFormatting">
  4628. @author Yegor Kozlov
  4629. </member>
  4630. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.EscapementType">
  4631. Get the type of super or subscript for the font
  4632. @return super or subscript option
  4633. @see #SS_NONE
  4634. @see #SS_SUPER
  4635. @see #SS_SUB
  4636. </member>
  4637. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.FontColorIndex">
  4638. @return font color index
  4639. </member>
  4640. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.FontHeight">
  4641. Gets the height of the font in 1/20th point units
  4642. @return fontheight (in points/20); or -1 if not modified
  4643. </member>
  4644. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.UnderlineType">
  4645. Get the type of underlining for the font
  4646. @return font underlining type
  4647. @see #U_NONE
  4648. @see #U_SINGLE
  4649. @see #U_DOUBLE
  4650. @see #U_SINGLE_ACCOUNTING
  4651. @see #U_DOUBLE_ACCOUNTING
  4652. </member>
  4653. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.IsBold">
  4654. Get whether the font weight is Set to bold or not
  4655. @return bold - whether the font is bold or not
  4656. </member>
  4657. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.IsItalic">
  4658. @return true if font style was Set to <i>italic</i>
  4659. </member>
  4660. <member name="M:NPOI.XSSF.UserModel.XSSFFontFormatting.SetFontStyle(System.Boolean,System.Boolean)">
  4661. Set font style options.
  4662. @param italic - if true, Set posture style to italic, otherwise to normal
  4663. @param bold if true, Set font weight to bold, otherwise to normal
  4664. </member>
  4665. <member name="M:NPOI.XSSF.UserModel.XSSFFontFormatting.ResetFontStyle">
  4666. Set font style options to default values (non-italic, non-bold)
  4667. </member>
  4668. <member name="T:NPOI.XSSF.UserModel.XSSFFormulaEvaluator">
  4669. Evaluates formula cells.<p/>
  4670. For performance reasons, this class keeps a cache of all previously calculated intermediate
  4671. cell values. Be sure to call {@link #ClearAllCachedResultValues()} if any workbook cells are Changed between
  4672. calls to Evaluate~ methods on this class.
  4673. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  4674. @author Josh Micich
  4675. </member>
  4676. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.Create(NPOI.XSSF.UserModel.XSSFWorkbook,NPOI.SS.Formula.IStabilityClassifier,NPOI.SS.Formula.UDF.UDFFinder)">
  4677. @param stabilityClassifier used to optimise caching performance. Pass <code>null</code>
  4678. for the (conservative) assumption that any cell may have its defInition Changed After
  4679. Evaluation begins.
  4680. @param udfFinder pass <code>null</code> for default (AnalysisToolPak only)
  4681. </member>
  4682. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.EvaluateAllFormulaCells(NPOI.XSSF.UserModel.XSSFWorkbook)">
  4683. Loops over all cells in all sheets of the supplied
  4684. workbook.
  4685. For cells that contain formulas, their formulas are
  4686. Evaluated, and the results are saved. These cells
  4687. remain as formula cells.
  4688. For cells that do not contain formulas, no Changes
  4689. are made.
  4690. This is a helpful wrapper around looping over all
  4691. cells, and calling EvaluateFormulaCell on each one.
  4692. </member>
  4693. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.EvaluateAll">
  4694. Loops over all cells in all sheets of the supplied
  4695. workbook.
  4696. For cells that contain formulas, their formulas are
  4697. Evaluated, and the results are saved. These cells
  4698. remain as formula cells.
  4699. For cells that do not contain formulas, no Changes
  4700. are made.
  4701. This is a helpful wrapper around looping over all
  4702. cells, and calling EvaluateFormulaCell on each one.
  4703. </member>
  4704. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.ToEvaluationCell(NPOI.SS.UserModel.ICell)">
  4705. Turns a XSSFCell into a XSSFEvaluationCell
  4706. </member>
  4707. <member name="T:NPOI.XSSF.UserModel.XSSFGraphicFrame">
  4708. Represents DrawingML GraphicalObjectFrame.
  4709. @author Roman Kashitsyn
  4710. </member>
  4711. <member name="M:NPOI.XSSF.UserModel.XSSFGraphicFrame.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_GraphicalObjectFrame)">
  4712. Construct a new XSSFGraphicFrame object.
  4713. @param Drawing the XSSFDrawing that owns this frame
  4714. @param ctGraphicFrame the XML bean that stores this frame content
  4715. </member>
  4716. <member name="M:NPOI.XSSF.UserModel.XSSFGraphicFrame.Prototype">
  4717. Initialize default structure of a new graphic frame
  4718. </member>
  4719. <member name="M:NPOI.XSSF.UserModel.XSSFGraphicFrame.SetMacro(System.String)">
  4720. Sets the frame macro.
  4721. </member>
  4722. <member name="P:NPOI.XSSF.UserModel.XSSFGraphicFrame.Name">
  4723. Returns the frame name.
  4724. @return name of the frame
  4725. </member>
  4726. <member name="P:NPOI.XSSF.UserModel.XSSFGraphicFrame.Anchor">
  4727. Returns the frame anchor.
  4728. @return the anchor this frame is attached to
  4729. </member>
  4730. <member name="M:NPOI.XSSF.UserModel.XSSFGraphicFrame.SetChart(NPOI.XSSF.UserModel.XSSFChart,System.String)">
  4731. Assign a DrawingML chart to the graphic frame.
  4732. </member>
  4733. <member name="P:NPOI.XSSF.UserModel.XSSFGraphicFrame.Id">
  4734. Gets the frame id.
  4735. </member>
  4736. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFGraphicFrame.AppendChartElement(NPOI.OpenXmlFormats.Dml.CT_GraphicalObjectData,System.String)" -->
  4737. <member name="T:NPOI.XSSF.UserModel.XSSFHyperlink">
  4738. XSSF Implementation of a Hyperlink.
  4739. Note - unlike with HSSF, many kinds of hyperlink
  4740. are largely stored as relations of the sheet
  4741. </member>
  4742. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.#ctor(NPOI.SS.UserModel.HyperlinkType)">
  4743. Create a new XSSFHyperlink. This method is protected to be used only by XSSFCreationHelper
  4744. @param type - the type of hyperlink to create
  4745. </member>
  4746. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Hyperlink,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  4747. Create a XSSFHyperlink amd Initialize it from the supplied CTHyperlink bean and namespace relationship
  4748. @param ctHyperlink the xml bean Containing xml properties
  4749. @param hyperlinkRel the relationship in the underlying OPC namespace which stores the actual link's Address
  4750. </member>
  4751. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.#ctor(NPOI.SS.UserModel.IHyperlink)">
  4752. Create a new XSSFHyperlink. This method is for Internal use only.
  4753. XSSFHyperlinks can be created by XSSFCreationHelper.
  4754. @param type - the type of hyperlink to create, see {@link Hyperlink}
  4755. </member>
  4756. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.GetCTHyperlink">
  4757. @return the underlying CTHyperlink object
  4758. </member>
  4759. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.NeedsRelationToo">
  4760. Do we need to a relation too, to represent
  4761. this hyperlink?
  4762. </member>
  4763. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.GenerateRelationIfNeeded(NPOI.OpenXml4Net.OPC.PackagePart)">
  4764. Generates the relation if required
  4765. </member>
  4766. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Type">
  4767. Return the type of this hyperlink
  4768. @return the type of this hyperlink
  4769. </member>
  4770. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.CellRef">
  4771. Get the reference of the cell this applies to,
  4772. es A55
  4773. </member>
  4774. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Address">
  4775. Hyperlink Address. Depending on the hyperlink type it can be URL, e-mail, path to a file
  4776. @return the Address of this hyperlink
  4777. </member>
  4778. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Label">
  4779. Return text label for this hyperlink
  4780. @return text to display
  4781. </member>
  4782. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Location">
  4783. Location within target. If target is a workbook (or this workbook) this shall refer to a
  4784. sheet and cell or a defined name. Can also be an HTML anchor if target is HTML file.
  4785. @return location
  4786. </member>
  4787. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.SetCellReference(System.String)">
  4788. Assigns this hyperlink to the given cell reference
  4789. </member>
  4790. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.FirstColumn">
  4791. Return the column of the first cell that Contains the hyperlink
  4792. @return the 0-based column of the first cell that Contains the hyperlink
  4793. </member>
  4794. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.LastColumn">
  4795. Return the column of the last cell that Contains the hyperlink
  4796. For XSSF, a Hyperlink may only reference one cell
  4797. @return the 0-based column of the last cell that Contains the hyperlink
  4798. </member>
  4799. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.FirstRow">
  4800. Return the row of the first cell that Contains the hyperlink
  4801. @return the 0-based row of the cell that Contains the hyperlink
  4802. </member>
  4803. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.LastRow">
  4804. Return the row of the last cell that Contains the hyperlink
  4805. For XSSF, a Hyperlink may only reference one cell
  4806. @return the 0-based row of the last cell that Contains the hyperlink
  4807. </member>
  4808. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Tooltip">
  4809. <summary>
  4810. get or set additional text to help the user understand more about the hyperlink
  4811. </summary>
  4812. </member>
  4813. <member name="T:NPOI.XSSF.UserModel.XSSFIconMultiStateFormatting">
  4814. High level representation for Icon / Multi-State Formatting
  4815. component of Conditional Formatting Settings
  4816. </member>
  4817. <member name="M:NPOI.XSSF.UserModel.XSSFLineBreak.SetText(System.String)">
  4818. Always . You cannot change text of a line break.
  4819. </member>
  4820. <member name="T:NPOI.XSSF.UserModel.XSSFMap">
  4821. This class : the Map element (Open Office XML Part 4:
  4822. chapter 3.16.2)
  4823. This element Contains all of the properties related to the XML map,
  4824. and the behaviors expected during data refresh operations.
  4825. @author Roberto Manicardi
  4826. </member>
  4827. <member name="M:NPOI.XSSF.UserModel.XSSFMap.GetRelatedSingleXMLCell">
  4828. @return the list of Single Xml Cells that provide a map rule to this mapping.
  4829. </member>
  4830. <member name="M:NPOI.XSSF.UserModel.XSSFMap.GetRelatedTables">
  4831. @return the list of all Tables that provide a map rule to this mapping
  4832. </member>
  4833. <member name="T:NPOI.XSSF.UserModel.XSSFName">
  4834. Represents a defined named range in a SpreadsheetML workbook.
  4835. <p>
  4836. Defined names are descriptive text that is used to represents a cell, range of cells, formula, or constant value.
  4837. Use easy-to-understand names, such as Products, to refer to hard to understand ranges, such as <code>Sales!C20:C30</code>.
  4838. </p>
  4839. Example:
  4840. <pre><blockquote>
  4841. XSSFWorkbook wb = new XSSFWorkbook();
  4842. XSSFSheet sh = wb.CreateSheet("Sheet1");
  4843. //applies to the entire workbook
  4844. XSSFName name1 = wb.CreateName();
  4845. name1.SetNameName("FMLA");
  4846. name1.SetRefersToFormula("Sheet1!$B$3");
  4847. //applies to Sheet1
  4848. XSSFName name2 = wb.CreateName();
  4849. name2.SetNameName("SheetLevelName");
  4850. name2.SetComment("This name is scoped to Sheet1");
  4851. name2.SetLocalSheetId(0);
  4852. name2.SetRefersToFormula("Sheet1!$B$3");
  4853. </blockquote></pre>
  4854. @author Nick Burch
  4855. @author Yegor Kozlov
  4856. </member>
  4857. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_PRINT_AREA">
  4858. A built-in defined name that specifies the workbook's print area
  4859. </member>
  4860. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_PRINT_TITLE">
  4861. A built-in defined name that specifies the row(s) or column(s) to repeat
  4862. at the top of each printed page.
  4863. </member>
  4864. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_CRITERIA">
  4865. A built-in defined name that refers to a range Containing the criteria values
  4866. to be used in Applying an advanced filter to a range of data
  4867. </member>
  4868. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_EXTRACT">
  4869. this defined name refers to the range Containing the filtered
  4870. output values resulting from Applying an advanced filter criteria to a source
  4871. range
  4872. </member>
  4873. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_FILTER_DB">
  4874. ?an be one of the following
  4875. 1 this defined name refers to a range to which an advanced filter has been
  4876. applied. This represents the source data range, unfiltered.
  4877. 2 This defined name refers to a range to which an AutoFilter has been
  4878. applied
  4879. </member>
  4880. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_CONSOLIDATE_AREA">
  4881. A built-in defined name that refers to a consolidation area
  4882. </member>
  4883. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_DATABASE">
  4884. A built-in defined name that specified that the range specified is from a database data source
  4885. </member>
  4886. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_SHEET_TITLE">
  4887. A built-in defined name that refers to a sheet title.
  4888. </member>
  4889. <member name="M:NPOI.XSSF.UserModel.XSSFName.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_DefinedName,NPOI.XSSF.UserModel.XSSFWorkbook)">
  4890. Creates an XSSFName object - called internally by XSSFWorkbook.
  4891. @param name - the xml bean that holds data represenring this defined name.
  4892. @param workbook - the workbook object associated with the name
  4893. @see NPOI.XSSF.usermodel.XSSFWorkbook#CreateName()
  4894. </member>
  4895. <member name="M:NPOI.XSSF.UserModel.XSSFName.GetCTName">
  4896. Returns the underlying named range object
  4897. </member>
  4898. <member name="P:NPOI.XSSF.UserModel.XSSFName.NameName">
  4899. Returns the name that will appear in the user interface for the defined name.
  4900. @return text name of this defined name
  4901. </member>
  4902. <member name="P:NPOI.XSSF.UserModel.XSSFName.SheetIndex">
  4903. Returns the sheet index this name applies to.
  4904. @return the sheet index this name applies to, -1 if this name applies to the entire workbook
  4905. </member>
  4906. <member name="P:NPOI.XSSF.UserModel.XSSFName.Function">
  4907. Indicates that the defined name refers to a user-defined function.
  4908. This attribute is used when there is an Add-in or other code project associated with the file.
  4909. @return <code>true</code> indicates the name refers to a function.
  4910. </member>
  4911. <member name="P:NPOI.XSSF.UserModel.XSSFName.FunctionGroupId">
  4912. Returns the function group index if the defined name refers to a function. The function
  4913. group defines the general category for the function. This attribute is used when there is
  4914. an Add-in or other code project associated with the file.
  4915. @return the function group index that defines the general category for the function
  4916. </member>
  4917. <member name="P:NPOI.XSSF.UserModel.XSSFName.SheetName">
  4918. Get the sheets name which this named range is referenced to
  4919. @return sheet name, which this named range referred to.
  4920. Empty string if the referenced sheet name weas not found.
  4921. </member>
  4922. <member name="P:NPOI.XSSF.UserModel.XSSFName.IsFunctionName">
  4923. Is the name refers to a user-defined function ?
  4924. @return <code>true</code> if this name refers to a user-defined function
  4925. </member>
  4926. <member name="P:NPOI.XSSF.UserModel.XSSFName.Comment">
  4927. Returns the comment the user provided when the name was Created.
  4928. @return the user comment for this named range
  4929. </member>
  4930. <member name="M:NPOI.XSSF.UserModel.XSSFName.Equals(System.Object)">
  4931. Compares this name to the specified object.
  4932. The result is <code>true</code> if the argument is XSSFName and the
  4933. underlying CTDefinedName bean Equals to the CTDefinedName representing this name
  4934. @param o the object to compare this <code>XSSFName</code> against.
  4935. @return <code>true</code> if the <code>XSSFName </code>are Equal;
  4936. <code>false</code> otherwise.
  4937. </member>
  4938. <member name="T:NPOI.XSSF.UserModel.XSSFOddFooter">
  4939. Odd page footer value. Corresponds to odd printed pages.
  4940. Odd page(s) in the sheet may not be printed, for example, if the print area is specified to be
  4941. a range such that it falls outside an odd page's scope.
  4942. </member>
  4943. <member name="M:NPOI.XSSF.UserModel.XSSFOddFooter.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  4944. Create an instance of XSSFOddFooter from the supplied XML bean
  4945. @see XSSFSheet#GetOddFooter()
  4946. @param headerFooter
  4947. </member>
  4948. <member name="P:NPOI.XSSF.UserModel.XSSFOddFooter.Text">
  4949. Get the content text representing the footer
  4950. @return text
  4951. </member>
  4952. <member name="T:NPOI.XSSF.UserModel.XSSFOddHeader">
  4953. Odd page header value. Corresponds to odd printed pages.
  4954. Odd page(s) in the sheet may not be printed, for example, if the print area is specified to be
  4955. a range such that it falls outside an odd page's scope.
  4956. </member>
  4957. <member name="M:NPOI.XSSF.UserModel.XSSFOddHeader.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  4958. Create an instance of XSSFOddHeader from the supplied XML bean
  4959. @see XSSFSheet#GetOddHeader()
  4960. @param headerFooter
  4961. </member>
  4962. <member name="P:NPOI.XSSF.UserModel.XSSFOddHeader.Text">
  4963. Get the content text representing this header
  4964. @return text
  4965. </member>
  4966. <member name="T:NPOI.XSSF.UserModel.XSSFPatternFormatting">
  4967. @author Yegor Kozlov
  4968. </member>
  4969. <member name="T:NPOI.XSSF.UserModel.XSSFPicture">
  4970. Represents a picture shape in a SpreadsheetML Drawing.
  4971. @author Yegor Kozlov
  4972. </member>
  4973. <member name="F:NPOI.XSSF.UserModel.XSSFPicture.prototype">
  4974. A default instance of CTShape used for creating new shapes.
  4975. </member>
  4976. <member name="F:NPOI.XSSF.UserModel.XSSFPicture.ctPicture">
  4977. This object specifies a picture object and all its properties
  4978. </member>
  4979. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Picture)">
  4980. Construct a new XSSFPicture object. This constructor is called from
  4981. {@link XSSFDrawing#CreatePicture(XSSFClientAnchor, int)}
  4982. @param Drawing the XSSFDrawing that owns this picture
  4983. </member>
  4984. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,System.Xml.XmlNode)">
  4985. Returns a prototype that is used to construct new shapes
  4986. @return a prototype that is used to construct new shapes
  4987. </member>
  4988. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.SetPictureReference(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  4989. Link this shape with the picture data
  4990. @param rel relationship referring the picture data
  4991. </member>
  4992. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetCTPicture">
  4993. Return the underlying CT_Picture bean that holds all properties for this picture
  4994. @return the underlying CT_Picture bean
  4995. </member>
  4996. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.Resize">
  4997. Reset the image to the original size.
  4998. <p>
  4999. Please note, that this method works correctly only for workbooks
  5000. with the default font size (Calibri 11pt for .xlsx).
  5001. If the default font is Changed the resized image can be streched vertically or horizontally.
  5002. </p>
  5003. </member>
  5004. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.Resize(System.Double)">
  5005. Resize the image proportionally.
  5006. @see #resize(double, double)
  5007. </member>
  5008. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.Resize(System.Double,System.Double)">
  5009. Resize the image relatively to its current size.
  5010. <p>
  5011. Please note, that this method works correctly only for workbooks
  5012. with the default font size (Calibri 11pt for .xlsx).
  5013. If the default font is changed the resized image can be streched vertically or horizontally.
  5014. </p>
  5015. <p>
  5016. <code>resize(1.0,1.0)</code> keeps the original size,<br/>
  5017. <code>resize(0.5,0.5)</code> resize to 50% of the original,<br/>
  5018. <code>resize(2.0,2.0)</code> resizes to 200% of the original.<br/>
  5019. <code>resize({@link Double#MAX_VALUE},{@link Double#MAX_VALUE})</code> resizes to the dimension of the embedded image.
  5020. </p>
  5021. @param scaleX the amount by which the image width is multiplied relative to the original width,
  5022. when set to {@link java.lang.Double#MAX_VALUE} the width of the embedded image is used
  5023. @param scaleY the amount by which the image height is multiplied relative to the original height,
  5024. when set to {@link java.lang.Double#MAX_VALUE} the height of the embedded image is used
  5025. </member>
  5026. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetPreferredSize">
  5027. Calculate the preferred size for this picture.
  5028. @return XSSFClientAnchor with the preferred size for this image
  5029. </member>
  5030. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetPreferredSize(System.Double)">
  5031. Calculate the preferred size for this picture.
  5032. @param scale the amount by which image dimensions are multiplied relative to the original size.
  5033. @return XSSFClientAnchor with the preferred size for this image
  5034. </member>
  5035. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetPreferredSize(System.Double,System.Double)">
  5036. Calculate the preferred size for this picture.
  5037. @param scaleX the amount by which image width is multiplied relative to the original width.
  5038. @param scaleY the amount by which image height is multiplied relative to the original height.
  5039. @return XSSFClientAnchor with the preferred size for this image
  5040. </member>
  5041. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetImageDimension(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.SS.UserModel.PictureType)">
  5042. Return the dimension of this image
  5043. @param part the namespace part holding raw picture data
  5044. @param type type of the picture: {@link Workbook#PICTURE_TYPE_JPEG},
  5045. {@link Workbook#PICTURE_TYPE_PNG} or {@link Workbook#PICTURE_TYPE_DIB}
  5046. @return image dimension in pixels
  5047. </member>
  5048. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetImageDimension">
  5049. Return the dimension of the embedded image in pixel
  5050. @return image dimension in pixels
  5051. </member>
  5052. <member name="P:NPOI.XSSF.UserModel.XSSFPicture.ClientAnchor">
  5053. @return the anchor that is used by this shape.
  5054. </member>
  5055. <member name="P:NPOI.XSSF.UserModel.XSSFPicture.Sheet">
  5056. @return the sheet which contains the picture shape
  5057. </member>
  5058. <member name="T:NPOI.XSSF.UserModel.XSSFPictureData">
  5059. Raw picture data, normally attached to a SpreadsheetML Drawing.
  5060. As a rule, pictures are stored in the /xl/media/ part of a SpreadsheetML package.
  5061. </member>
  5062. <member name="F:NPOI.XSSF.UserModel.XSSFPictureData.RELATIONS">
  5063. Relationships for each known picture type
  5064. </member>
  5065. <member name="M:NPOI.XSSF.UserModel.XSSFPictureData.#ctor">
  5066. Create a new XSSFPictureData node
  5067. @see NPOI.xssf.usermodel.XSSFWorkbook#AddPicture(byte[], int)
  5068. </member>
  5069. <member name="M:NPOI.XSSF.UserModel.XSSFPictureData.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  5070. Construct XSSFPictureData from a namespace part
  5071. @param part the namespace part holding the Drawing data,
  5072. @param rel the namespace relationship holding this Drawing,
  5073. the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/image
  5074. </member>
  5075. <member name="M:NPOI.XSSF.UserModel.XSSFPictureData.SuggestFileExtension">
  5076. Suggests a file extension for this image.
  5077. @return the file extension.
  5078. </member>
  5079. <member name="P:NPOI.XSSF.UserModel.XSSFPictureData.PictureType">
  5080. Return an integer constant that specifies type of this picture
  5081. @return an integer constant that specifies type of this picture
  5082. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_EMF
  5083. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_WMF
  5084. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_PICT
  5085. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_JPEG
  5086. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_PNG
  5087. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_DIB
  5088. </member>
  5089. <member name="P:NPOI.XSSF.UserModel.XSSFPictureData.Data">
  5090. <summary>
  5091. Gets the picture data as a byte array.
  5092. </summary>
  5093. </member>
  5094. <member name="M:NPOI.XSSF.UserModel.XSSFPictureData.PrepareForCommit">
  5095. *PictureData objects store the actual content in the part directly without keeping a
  5096. copy like all others therefore we need to handle them differently.
  5097. </member>
  5098. <member name="M:NPOI.XSSF.UserModel.XSSFPivotCache.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  5099. Creates n XSSFPivotCache representing the given package part and relationship.
  5100. Should only be called when Reading in an existing file.
  5101. @param part - The package part that holds xml data representing this pivot cache defInition.
  5102. @param rel - the relationship of the given package part in the underlying OPC package
  5103. </member>
  5104. <member name="M:NPOI.XSSF.UserModel.XSSFPivotCacheDefinition.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  5105. Creates an XSSFPivotCacheDefintion representing the given package part and relationship.
  5106. Should only be called when Reading in an existing file.
  5107. @param part - The package part that holds xml data representing this pivot cache defInition.
  5108. @param rel - the relationship of the given package part in the underlying OPC package
  5109. </member>
  5110. <member name="M:NPOI.XSSF.UserModel.XSSFPivotCacheDefinition.GetPivotArea(NPOI.SS.UserModel.IWorkbook)">
  5111. Find the 2D base data area for the pivot table, either from its direct reference or named table/range.
  5112. @return AreaReference representing the current area defined by the pivot table
  5113. @ if the ref1 attribute is not contiguous or the name attribute is not found.
  5114. </member>
  5115. <member name="M:NPOI.XSSF.UserModel.XSSFPivotCacheDefinition.CreateCacheFields(NPOI.SS.UserModel.ISheet)">
  5116. Generates a cache field for each column in the reference area for the pivot table.
  5117. @param sheet The sheet where the data i collected from
  5118. </member>
  5119. <member name="M:NPOI.XSSF.UserModel.XSSFPivotCacheRecords.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  5120. Creates an XSSFPivotCacheRecords representing the given package part and relationship.
  5121. Should only be called when Reading in an existing file.
  5122. @param part - The package part that holds xml data representing this pivot cache records.
  5123. @param rel - the relationship of the given package part in the underlying OPC package
  5124. </member>
  5125. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  5126. Creates an XSSFPivotTable representing the given package part and relationship.
  5127. Should only be called when Reading in an existing file.
  5128. @param part - The package part that holds xml data representing this pivot table.
  5129. @param rel - the relationship of the given package part in the underlying OPC package
  5130. </member>
  5131. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.SetDefaultPivotTableDefinition">
  5132. Set default values for the table defInition.
  5133. </member>
  5134. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.CheckColumnIndex(System.Int32)">
  5135. Verify column index (relative to first column in1 pivot area) is within the
  5136. pivot area
  5137. @param columnIndex
  5138. @
  5139. </member>
  5140. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.AddRowLabel(System.Int32)">
  5141. Add a row label using data from the given column.
  5142. @param columnIndex the index of the column to be used as row label.
  5143. </member>
  5144. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.AddColumnLabel(NPOI.SS.UserModel.DataConsolidateFunction,System.Int32,System.String)">
  5145. Add a column label using data from the given column and specified function
  5146. @param columnIndex the index of the column to be used as column label.
  5147. @param function the function to be used on the data
  5148. The following functions exists:
  5149. Sum, Count, Average, Max, Min, Product, Count numbers, StdDev, StdDevp, Var, Varp
  5150. @param valueFieldName the name of pivot table value field
  5151. </member>
  5152. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.AddColumnLabel(NPOI.SS.UserModel.DataConsolidateFunction,System.Int32)">
  5153. Add a column label using data from the given column and specified function
  5154. @param columnIndex the index of the column to be used as column label.
  5155. @param function the function to be used on the data
  5156. The following functions exists:
  5157. Sum, Count, Average, Max, Min, Product, Count numbers, StdDev, StdDevp, Var, Varp
  5158. </member>
  5159. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.AddDataField(NPOI.SS.UserModel.DataConsolidateFunction,System.Int32,System.String)">
  5160. Add data field with data from the given column and specified function.
  5161. @param function the function to be used on the data
  5162. The following functions exists:
  5163. Sum, Count, Average, Max, Min, Product, Count numbers, StdDev, StdDevp, Var, Varp
  5164. @param columnIndex the index of the column to be used as column label.
  5165. @param valueFieldName the name of pivot table value field
  5166. </member>
  5167. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.AddDataColumn(System.Int32,System.Boolean)">
  5168. Add column Containing data from the referenced area.
  5169. @param columnIndex the index of the column Containing the data
  5170. @param isDataField true if the data should be displayed in the pivot table.
  5171. </member>
  5172. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.AddReportFilter(System.Int32)">
  5173. Add filter for the column with the corresponding index and cell value
  5174. @param columnIndex index of column to filter on
  5175. </member>
  5176. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.CreateSourceReferences(NPOI.SS.Util.CellReference,NPOI.SS.UserModel.ISheet,NPOI.XSSF.UserModel.XSSFPivotTable.IPivotTableReferenceConfigurator)">
  5177. Creates cacheSource and workSheetSource for pivot table and sets the source reference as well assets the location of the pivot table
  5178. @param sourceRef Source for data for pivot table - mutually exclusive with sourceName
  5179. @param sourceName Source for data for pivot table - mutually exclusive with sourceRef
  5180. @param position Position for pivot table in sheet
  5181. @param sourceSheet Sheet where the source will be collected from
  5182. </member>
  5183. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.IPivotTableReferenceConfigurator.ConfigureReference(NPOI.OpenXmlFormats.Spreadsheet.CT_WorksheetSource)">
  5184. Configure the name or area reference for the pivot table
  5185. @param wsSource CTWorksheetSource that needs the pivot source reference assignment
  5186. </member>
  5187. <member name="T:NPOI.XSSF.UserModel.XSSFPrintSetup">
  5188. Page Setup and page margins Settings for the worksheet.
  5189. </member>
  5190. <member name="M:NPOI.XSSF.UserModel.XSSFPrintSetup.SetPaperSize(NPOI.SS.UserModel.PaperSize)">
  5191. Set the paper size as enum value.
  5192. @param size value for the paper size.
  5193. </member>
  5194. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Orientation">
  5195. Orientation of the page: landscape - portrait.
  5196. @return Orientation of the page
  5197. @see PrintOrientation
  5198. </member>
  5199. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.PageOrder">
  5200. Get print page order.
  5201. @return PageOrder
  5202. </member>
  5203. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.PaperSize">
  5204. Returns the paper size.
  5205. @return short - paper size
  5206. </member>
  5207. <member name="M:NPOI.XSSF.UserModel.XSSFPrintSetup.GetPaperSizeEnum">
  5208. Returns the paper size as enum.
  5209. @return PaperSize paper size
  5210. @see PaperSize
  5211. </member>
  5212. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Scale">
  5213. Returns the scale.
  5214. @return short - scale
  5215. </member>
  5216. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.PageStart">
  5217. Set the page numbering start.
  5218. Page number for first printed page. If no value is specified, then 'automatic' is assumed.
  5219. @return page number for first printed page
  5220. </member>
  5221. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.FitWidth">
  5222. Returns the number of pages wide to fit sheet in.
  5223. @return number of pages wide to fit sheet in
  5224. </member>
  5225. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.FitHeight">
  5226. Returns the number of pages high to fit the sheet in.
  5227. @return number of pages high to fit the sheet in
  5228. </member>
  5229. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.LeftToRight">
  5230. Returns the left to right print order.
  5231. @return left to right print order
  5232. </member>
  5233. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Landscape">
  5234. Returns the landscape mode.
  5235. @return landscape mode
  5236. </member>
  5237. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.ValidSettings">
  5238. Use the printer's defaults Settings for page Setup values and don't use the default values
  5239. specified in the schema. For example, if dpi is not present or specified in the XML, the
  5240. application shall not assume 600dpi as specified in the schema as a default and instead
  5241. shall let the printer specify the default dpi.
  5242. @return valid Settings
  5243. </member>
  5244. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.NoColor">
  5245. Returns the black and white Setting.
  5246. @return black and white Setting
  5247. </member>
  5248. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Draft">
  5249. Returns the draft mode.
  5250. @return draft mode
  5251. </member>
  5252. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Notes">
  5253. Returns the print notes.
  5254. @return print notes
  5255. </member>
  5256. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.NoOrientation">
  5257. Returns the no orientation.
  5258. @return no orientation
  5259. </member>
  5260. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.UsePage">
  5261. Returns the use page numbers.
  5262. @return use page numbers
  5263. </member>
  5264. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.HResolution">
  5265. Returns the horizontal resolution.
  5266. @return horizontal resolution
  5267. </member>
  5268. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.VResolution">
  5269. Returns the vertical resolution.
  5270. @return vertical resolution
  5271. </member>
  5272. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.HeaderMargin">
  5273. Returns the header margin.
  5274. @return header margin
  5275. </member>
  5276. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.FooterMargin">
  5277. Returns the footer margin.
  5278. @return footer margin
  5279. </member>
  5280. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Copies">
  5281. Returns the number of copies.
  5282. @return number of copies
  5283. </member>
  5284. <member name="T:NPOI.XSSF.UserModel.XSSFRelation">
  5285. <summary>
  5286. Defines namespaces, content types and normal file names / naming
  5287. patterns, for the well-known XSSF format parts.
  5288. </summary>
  5289. </member>
  5290. <member name="F:NPOI.XSSF.UserModel.XSSFRelation._table">
  5291. A map to lookup POIXMLRelation by its relation type
  5292. </member>
  5293. <member name="F:NPOI.XSSF.UserModel.XSSFRelation.IMAGE_JPG">
  5294. JPG is an intentional duplicate of JPEG, to handle documents generated by other software. *
  5295. </member>
  5296. <member name="M:NPOI.XSSF.UserModel.XSSFRelation.GetContents(NPOI.OpenXml4Net.OPC.PackagePart)">
  5297. Fetches the InputStream to read the contents, based
  5298. of the specified core part, for which we are defined
  5299. as a suitable relationship
  5300. </member>
  5301. <member name="M:NPOI.XSSF.UserModel.XSSFRelation.GetInstance(System.String)">
  5302. Get POIXMLRelation by relation type
  5303. @param rel relation type, for example,
  5304. <code>http://schemas.openxmlformats.org/officeDocument/2006/relationships/image</code>
  5305. @return registered POIXMLRelation or null if not found
  5306. </member>
  5307. <member name="M:NPOI.XSSF.UserModel.XSSFRelation.RemoveRelation(NPOI.XSSF.UserModel.XSSFRelation)">
  5308. <summary>
  5309. Removes the relation from the internal table.
  5310. Following readings of files will ignoring the removed relation.
  5311. </summary>
  5312. <param name="relation">Relation to remove</param>
  5313. </member>
  5314. <member name="M:NPOI.XSSF.UserModel.XSSFRelation.AddRelation(NPOI.XSSF.UserModel.XSSFRelation)">
  5315. <summary>
  5316. Adds the relation to the internal table.
  5317. Following readings of files will process the given relation.
  5318. </summary>
  5319. <param name="relation">Relation to add</param>
  5320. </member>
  5321. <member name="T:NPOI.XSSF.UserModel.XSSFRichTextString">
  5322. Rich text unicode string. These strings can have fonts applied to arbitary parts of the string.
  5323. <p>
  5324. Most strings in a workbook have formatting applied at the cell level, that is, the entire string in the cell has the
  5325. same formatting applied. In these cases, the formatting for the cell is stored in the styles part,
  5326. and the string for the cell can be shared across the workbook. The following code illustrates the example.
  5327. </p>
  5328. <blockquote>
  5329. <pre>
  5330. cell1.SetCellValue(new XSSFRichTextString("Apache POI"));
  5331. cell2.SetCellValue(new XSSFRichTextString("Apache POI"));
  5332. cell3.SetCellValue(new XSSFRichTextString("Apache POI"));
  5333. </pre>
  5334. </blockquote>
  5335. In the above example all three cells will use the same string cached on workbook level.
  5336. <p>
  5337. Some strings in the workbook may have formatting applied at a level that is more granular than the cell level.
  5338. For instance, specific characters within the string may be bolded, have coloring, italicizing, etc.
  5339. In these cases, the formatting is stored along with the text in the string table, and is treated as
  5340. a unique entry in the workbook. The following xml and code snippet illustrate this.
  5341. </p>
  5342. <blockquote>
  5343. <pre>
  5344. XSSFRichTextString s1 = new XSSFRichTextString("Apache POI");
  5345. s1.ApplyFont(boldArial);
  5346. cell1.SetCellValue(s1);
  5347. XSSFRichTextString s2 = new XSSFRichTextString("Apache POI");
  5348. s2.ApplyFont(italicCourier);
  5349. cell2.SetCellValue(s2);
  5350. </pre>
  5351. </blockquote>
  5352. @author Yegor Kozlov
  5353. </member>
  5354. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.#ctor(System.String)">
  5355. Create a rich text string
  5356. </member>
  5357. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.#ctor">
  5358. Create empty rich text string and Initialize it with empty string
  5359. </member>
  5360. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Rst)">
  5361. Create a rich text string from the supplied XML bean
  5362. </member>
  5363. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ApplyFont(System.Int32,System.Int32,System.Int16)">
  5364. Applies a font to the specified characters of a string.
  5365. @param startIndex The start index to apply the font to (inclusive)
  5366. @param endIndex The end index to apply the font to (exclusive)
  5367. @param fontIndex The font to use.
  5368. </member>
  5369. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ApplyFont(System.Int32,System.Int32,NPOI.SS.UserModel.IFont)">
  5370. Applies a font to the specified characters of a string.
  5371. @param startIndex The start index to apply the font to (inclusive)
  5372. @param endIndex The end index to apply to font to (exclusive)
  5373. @param font The index of the font to use.
  5374. </member>
  5375. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ApplyFont(NPOI.SS.UserModel.IFont)">
  5376. Sets the font of the entire string.
  5377. @param font The font to use.
  5378. </member>
  5379. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ApplyFont(System.Int16)">
  5380. Applies the specified font to the entire string.
  5381. @param fontIndex the font to Apply.
  5382. </member>
  5383. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.Append(System.String,NPOI.XSSF.UserModel.XSSFFont)">
  5384. Append new text to this text run and apply the specify font to it
  5385. @param text the text to append
  5386. @param font the font to apply to the Appended text or <code>null</code> if no formatting is required
  5387. </member>
  5388. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.Append(System.String)">
  5389. Append new text to this text run
  5390. @param text the text to append
  5391. </member>
  5392. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.SetRunAttributes(NPOI.OpenXmlFormats.Spreadsheet.CT_Font,NPOI.OpenXmlFormats.Spreadsheet.CT_RPrElt)">
  5393. Copy font attributes from CTFont bean into CTRPrElt bean
  5394. </member>
  5395. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.HasFormatting">
  5396. Does this string have any explicit formatting applied, or is
  5397. it just text in the default style?
  5398. </member>
  5399. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ClearFormatting">
  5400. Removes any formatting that may have been applied to the string.
  5401. </member>
  5402. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetIndexOfFormattingRun(System.Int32)">
  5403. The index within the string to which the specified formatting run applies.
  5404. @param index the index of the formatting run
  5405. @return the index within the string.
  5406. </member>
  5407. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetLengthOfFormattingRun(System.Int32)">
  5408. Returns the number of characters this format run covers.
  5409. @param index the index of the formatting run
  5410. @return the number of characters this format run covers
  5411. </member>
  5412. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ToString">
  5413. Returns the plain string representation.
  5414. </member>
  5415. <member name="P:NPOI.XSSF.UserModel.XSSFRichTextString.Length">
  5416. Returns the number of characters in this string.
  5417. </member>
  5418. <member name="P:NPOI.XSSF.UserModel.XSSFRichTextString.NumFormattingRuns">
  5419. @return The number of formatting Runs used.
  5420. </member>
  5421. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetFontOfFormattingRun(System.Int32)">
  5422. Gets a copy of the font used in a particular formatting Run.
  5423. @param index the index of the formatting run
  5424. @return A copy of the font used or null if no formatting is applied to the specified text Run.
  5425. </member>
  5426. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetFontAtIndex(System.Int32)">
  5427. Return a copy of the font in use at a particular index.
  5428. @param index The index.
  5429. @return A copy of the font that's currently being applied at that
  5430. index or null if no font is being applied or the
  5431. index is out of range.
  5432. </member>
  5433. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetCTRst">
  5434. Return the underlying xml bean
  5435. </member>
  5436. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ToCTFont(NPOI.OpenXmlFormats.Spreadsheet.CT_RPrElt)">
  5437. CTRPrElt --> CTFont adapter
  5438. </member>
  5439. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.PreserveSpaces(System.String)">
  5440. **
  5441. </member>
  5442. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.UtfDecode(System.String)">
  5443. For all characters which cannot be represented in XML as defined by the XML 1.0 specification,
  5444. the characters are escaped using the Unicode numerical character representation escape character
  5445. format _xHHHH_, where H represents a hexadecimal character in the character's value.
  5446. <p>
  5447. Example: The Unicode character 0D is invalid in an XML 1.0 document,
  5448. so it shall be escaped as <code>_x000D_</code>.
  5449. </p>
  5450. See section 3.18.9 in the OOXML spec.
  5451. @param value the string to decode
  5452. @return the decoded string
  5453. </member>
  5454. <member name="T:NPOI.XSSF.UserModel.XSSFRow">
  5455. <summary>
  5456. High level representation of a row of a spreadsheet.
  5457. </summary>
  5458. </member>
  5459. <member name="F:NPOI.XSSF.UserModel.XSSFRow._row">
  5460. <summary>
  5461. the xml node Containing all cell defInitions for this row
  5462. </summary>
  5463. </member>
  5464. <member name="F:NPOI.XSSF.UserModel.XSSFRow._cells">
  5465. <summary>
  5466. Cells of this row keyed by their column indexes.
  5467. The SortedDictionary ensures that the cells are ordered by columnIndex in the ascending order.
  5468. </summary>
  5469. </member>
  5470. <member name="F:NPOI.XSSF.UserModel.XSSFRow._sheet">
  5471. <summary>
  5472. the parent sheet
  5473. </summary>
  5474. </member>
  5475. <member name="P:NPOI.XSSF.UserModel.XSSFRow.Sheet">
  5476. <summary>
  5477. XSSFSheet this row belongs to
  5478. </summary>
  5479. </member>
  5480. <member name="P:NPOI.XSSF.UserModel.XSSFRow.FirstCellNum">
  5481. <summary>
  5482. Get the number of the first cell Contained in this row.
  5483. </summary>
  5484. <returns>short representing the first logical cell in the row,
  5485. or -1 if the row does not contain any cells.</returns>
  5486. </member>
  5487. <member name="P:NPOI.XSSF.UserModel.XSSFRow.LastCellNum">
  5488. <summary>
  5489. Gets the index of the last cell Contained in this row <b>PLUS ONE</b>. The result also
  5490. happens to be the 1-based column number of the last cell. This value can be used as a
  5491. standard upper bound when iterating over cells:
  5492. </summary>
  5493. <returns>short representing the last logical cell in the row <b>PLUS ONE</b>,
  5494. or -1 if the row does not contain any cells.</returns>
  5495. </member>
  5496. <member name="P:NPOI.XSSF.UserModel.XSSFRow.Height">
  5497. <summary>
  5498. Get the row's height measured in twips (1/20th of a point).
  5499. If the height is not Set, the default worksheet value is returned,
  5500. See <see cref="P:NPOI.XSSF.UserModel.XSSFSheet.DefaultRowHeight"/>
  5501. </summary>
  5502. <returns>row height measured in twips (1/20th of a point)</returns>
  5503. </member>
  5504. <member name="P:NPOI.XSSF.UserModel.XSSFRow.HeightInPoints">
  5505. <summary>
  5506. Returns row height measured in point size. If the height is not Set,
  5507. the default worksheet value is returned,See <see cref="P:NPOI.XSSF.UserModel.XSSFSheet.DefaultRowHeightInPoints"/>
  5508. </summary>
  5509. </member>
  5510. <member name="P:NPOI.XSSF.UserModel.XSSFRow.PhysicalNumberOfCells">
  5511. <summary>
  5512. Gets the number of defined cells (NOT number of cells in the actual row!).
  5513. That is to say if only columns 0,4,5 have values then there would be 3.
  5514. </summary>
  5515. <returns>int representing the number of defined cells in the row.</returns>
  5516. </member>
  5517. <member name="P:NPOI.XSSF.UserModel.XSSFRow.RowNum">
  5518. <summary>
  5519. Get row number this row represents
  5520. </summary>
  5521. <returns>the row number (0 based)</returns>
  5522. </member>
  5523. <member name="P:NPOI.XSSF.UserModel.XSSFRow.ZeroHeight">
  5524. <summary>
  5525. Get whether or not to display this row with 0 height
  5526. </summary>
  5527. </member>
  5528. <member name="P:NPOI.XSSF.UserModel.XSSFRow.IsFormatted">
  5529. <summary>
  5530. Is this row formatted? Most aren't, but some rows
  5531. do have whole-row styles. For those that do, you
  5532. can get the formatting from <see cref="P:NPOI.XSSF.UserModel.XSSFRow.RowStyle"/>
  5533. </summary>
  5534. </member>
  5535. <member name="P:NPOI.XSSF.UserModel.XSSFRow.RowStyle">
  5536. <summary>
  5537. Returns the whole-row cell style. Most rows won't
  5538. have one of these, so will return null. Call
  5539. <see cref="P:NPOI.XSSF.UserModel.XSSFRow.IsFormatted"/> to check first.
  5540. </summary>
  5541. </member>
  5542. <member name="M:NPOI.XSSF.UserModel.XSSFRow.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Row,NPOI.XSSF.UserModel.XSSFSheet)">
  5543. <summary>
  5544. Construct an XSSFRow.
  5545. </summary>
  5546. <param name="row">the xml node Containing all cell defInitions for this row.</param>
  5547. <param name="sheet">the parent sheet.</param>
  5548. </member>
  5549. <member name="M:NPOI.XSSF.UserModel.XSSFRow.CreateCell(System.Int32)">
  5550. <summary>
  5551. Use this to create new cells within the row and return it.
  5552. The cell that is returned is a <see cref="F:NPOI.SS.UserModel.CellType.Blank"/>. The type can be Changed
  5553. either through calling <see cref="M:NPOI.SS.UserModel.ICell.SetCellValue(System.Double)"/> or <see cref="M:NPOI.SS.UserModel.ICell.SetCellType(NPOI.SS.UserModel.CellType)"/>.
  5554. </summary>
  5555. <param name="columnIndex">the column number this cell represents</param>
  5556. <returns>a high level representation of the Created cell</returns>
  5557. <exception cref="T:System.ArgumentException">if columnIndex is less than 0 or greater than 16384,
  5558. the maximum number of columns supported by the SpreadsheetML format(.xlsx)</exception>
  5559. </member>
  5560. <member name="M:NPOI.XSSF.UserModel.XSSFRow.CreateCell(System.Int32,NPOI.SS.UserModel.CellType)">
  5561. <summary>
  5562. Use this to create new cells within the row and return it.
  5563. </summary>
  5564. <param name="columnIndex">the column number this cell represents</param>
  5565. <param name="type">the cell's data type</param>
  5566. <returns>a high level representation of the Created cell.</returns>
  5567. <exception cref="T:System.ArgumentException">if columnIndex is less than 0 or greater than 16384,
  5568. the maximum number of columns supported by the SpreadsheetML format(.xlsx)</exception>
  5569. </member>
  5570. <member name="M:NPOI.XSSF.UserModel.XSSFRow.GetCell(System.Int32)">
  5571. <summary>
  5572. Returns the cell at the given (0 based) index,
  5573. with the <see cref="T:NPOI.SS.UserModel.MissingCellPolicy"/> from the parent Workbook.
  5574. </summary>
  5575. <param name="cellnum"></param>
  5576. <returns>the cell at the given (0 based) index</returns>
  5577. </member>
  5578. <member name="M:NPOI.XSSF.UserModel.XSSFRow.GetCell(System.Int32,NPOI.SS.UserModel.MissingCellPolicy)">
  5579. <summary>
  5580. Returns the cell at the given (0 based) index, with the specified <see cref="T:NPOI.SS.UserModel.MissingCellPolicy"/>
  5581. </summary>
  5582. <param name="cellnum"></param>
  5583. <param name="policy"></param>
  5584. <returns>the cell at the given (0 based) index</returns>
  5585. <exception cref="T:System.ArgumentException">if cellnum is less than 0 or the specified MissingCellPolicy is invalid</exception>
  5586. </member>
  5587. <member name="M:NPOI.XSSF.UserModel.XSSFRow.RemoveCell(NPOI.SS.UserModel.ICell)">
  5588. <summary>
  5589. Remove the Cell from this row.
  5590. </summary>
  5591. <param name="cell">the cell to remove</param>
  5592. <exception cref="T:System.ArgumentException"></exception>
  5593. </member>
  5594. <member name="M:NPOI.XSSF.UserModel.XSSFRow.CopyRowFrom(NPOI.SS.UserModel.IRow,NPOI.SS.UserModel.CellCopyPolicy)">
  5595. <summary>
  5596. Copy the cells from srcRow to this row
  5597. If this row is not a blank row, this will merge the two rows, overwriting
  5598. the cells in this row with the cells in srcRow
  5599. If srcRow is null, overwrite cells in destination row with blank values, styles, etc per cell copy policy
  5600. srcRow may be from a different sheet in the same workbook
  5601. </summary>
  5602. <param name="srcRow">the rows to copy from</param>
  5603. <param name="policy">policy the policy to determine what gets copied</param>
  5604. </member>
  5605. <member name="M:NPOI.XSSF.UserModel.XSSFRow.SetRowStyle(NPOI.SS.UserModel.ICellStyle)">
  5606. <summary>
  5607. Applies a whole-row cell styling to the row.
  5608. If the value is null then the style information is Removed,
  5609. causing the cell to used the default workbook style.
  5610. </summary>
  5611. <param name="style"></param>
  5612. </member>
  5613. <member name="M:NPOI.XSSF.UserModel.XSSFRow.GetCTRow">
  5614. <summary>
  5615. Returns the underlying CT_Row xml node Containing all cell defInitions in this row
  5616. </summary>
  5617. <returns>the underlying CT_Row xml node</returns>
  5618. </member>
  5619. <member name="M:NPOI.XSSF.UserModel.XSSFRow.OnDocumentWrite">
  5620. <summary>
  5621. Fired when the document is written to an output stream.
  5622. See <see cref="M:NPOI.XSSF.UserModel.XSSFSheet.Write(System.IO.Stream,System.Boolean)"/>
  5623. </summary>
  5624. </member>
  5625. <member name="M:NPOI.XSSF.UserModel.XSSFRow.Shift(System.Int32)">
  5626. <summary>
  5627. update cell references when Shifting rows
  5628. </summary>
  5629. <param name="n">n the number of rows to move</param>
  5630. </member>
  5631. <member name="M:NPOI.XSSF.UserModel.XSSFRow.CellIterator">
  5632. <summary>
  5633. Cell iterator over the physically defined cell
  5634. </summary>
  5635. <returns>an iterator over cells in this row.</returns>
  5636. </member>
  5637. <member name="M:NPOI.XSSF.UserModel.XSSFRow.GetEnumerator">
  5638. <summary>
  5639. Alias for <see cref="M:NPOI.XSSF.UserModel.XSSFRow.CellIterator"/> to allow foreach loops
  5640. </summary>
  5641. <returns>an iterator over cells in this row.</returns>
  5642. </member>
  5643. <member name="M:NPOI.XSSF.UserModel.XSSFRow.CompareTo(NPOI.XSSF.UserModel.XSSFRow)">
  5644. <summary>
  5645. Compares two <see cref="T:NPOI.XSSF.UserModel.XSSFRow"/> objects. Two rows are equal if they belong to the
  5646. same worksheet and their row indexes are equal.
  5647. </summary>
  5648. <param name="other">the <see cref="T:NPOI.XSSF.UserModel.XSSFRow"/> to be compared.</param>
  5649. <returns>
  5650. the value 0 if the row number of this <see cref="T:NPOI.XSSF.UserModel.XSSFRow"/> is
  5651. equal to the row number of the argument <see cref="T:NPOI.XSSF.UserModel.XSSFRow"/>
  5652. a value less than 0 if the row number of this this <see cref="T:NPOI.XSSF.UserModel.XSSFRow"/> is
  5653. numerically less than the row number of the argument <see cref="T:NPOI.XSSF.UserModel.XSSFRow"/>
  5654. a value greater than 0 if the row number of this this <see cref="T:NPOI.XSSF.UserModel.XSSFRow"/> is
  5655. numerically greater than the row number of the argument <see cref="T:NPOI.XSSF.UserModel.XSSFRow"/>
  5656. </returns>
  5657. <exception cref="T:System.ArgumentException">if the argument row belongs to a different worksheet</exception>
  5658. </member>
  5659. <member name="M:NPOI.XSSF.UserModel.XSSFRow.ToString">
  5660. <summary>
  5661. formatted xml representation of this row
  5662. </summary>
  5663. <returns>formatted xml representation of this row</returns>
  5664. </member>
  5665. <member name="M:NPOI.XSSF.UserModel.XSSFRow.RetrieveCell(System.Int32)">
  5666. <summary>
  5667. Get the hssfcell representing a given column (logical cell)
  5668. 0-based. If you ask for a cell that is not defined, then
  5669. you Get a null.
  5670. This is the basic call, with no policies applied
  5671. </summary>
  5672. <param name="cellnum">0 based column number</param>
  5673. <returns>Cell representing that column or null if Undefined.</returns>
  5674. </member>
  5675. <member name="T:NPOI.XSSF.UserModel.XSSFShape">
  5676. Represents a shape in a SpreadsheetML Drawing.
  5677. @author Yegor Kozlov
  5678. </member>
  5679. <member name="F:NPOI.XSSF.UserModel.XSSFShape.drawing">
  5680. Parent Drawing
  5681. </member>
  5682. <member name="F:NPOI.XSSF.UserModel.XSSFShape.parent">
  5683. The parent shape, always not-null for shapes in groups
  5684. </member>
  5685. <member name="F:NPOI.XSSF.UserModel.XSSFShape.anchor">
  5686. anchor that is used by this shape
  5687. </member>
  5688. <member name="M:NPOI.XSSF.UserModel.XSSFShape.GetDrawing">
  5689. Return the Drawing that owns this shape
  5690. @return the parent Drawing that owns this shape
  5691. </member>
  5692. <member name="P:NPOI.XSSF.UserModel.XSSFShape.Parent">
  5693. Gets the parent shape.
  5694. </member>
  5695. <member name="M:NPOI.XSSF.UserModel.XSSFShape.GetAnchor">
  5696. @return the anchor that is used by this shape.
  5697. </member>
  5698. <member name="M:NPOI.XSSF.UserModel.XSSFShape.GetShapeProperties">
  5699. Returns xml bean with shape properties.
  5700. @return xml bean with shape properties.
  5701. </member>
  5702. <member name="P:NPOI.XSSF.UserModel.XSSFShape.IsNoFill">
  5703. Whether this shape is not Filled with a color
  5704. @return true if this shape is not Filled with a color.
  5705. </member>
  5706. <member name="M:NPOI.XSSF.UserModel.XSSFShape.SetFillColor(System.Int32,System.Int32,System.Int32)">
  5707. Sets the color used to fill this shape using the solid fill pattern.
  5708. </member>
  5709. <member name="M:NPOI.XSSF.UserModel.XSSFShape.SetLineStyleColor(System.Int32,System.Int32,System.Int32)">
  5710. The color applied to the lines of this shape.
  5711. </member>
  5712. <member name="T:NPOI.XSSF.UserModel.XSSFShapeGroup">
  5713. This object specifies a group shape that represents many shapes grouped together. This shape is to be treated
  5714. just as if it were a regular shape but instead of being described by a single geometry it is made up of all the
  5715. shape geometries encompassed within it. Within a group shape each of the shapes that make up the group are
  5716. specified just as they normally would.
  5717. @author Yegor Kozlov
  5718. </member>
  5719. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_GroupShape)">
  5720. Construct a new XSSFSimpleShape object.
  5721. @param Drawing the XSSFDrawing that owns this shape
  5722. @param ctGroup the XML bean that stores this group content
  5723. </member>
  5724. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.Prototype">
  5725. Initialize default structure of a new shape group
  5726. </member>
  5727. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.CreateTextbox(NPOI.XSSF.UserModel.XSSFChildAnchor)">
  5728. Constructs a textbox.
  5729. @param anchor the child anchor describes how this shape is attached
  5730. to the group.
  5731. @return the newly Created textbox.
  5732. </member>
  5733. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.CreateSimpleShape(NPOI.XSSF.UserModel.XSSFChildAnchor)">
  5734. Creates a simple shape. This includes such shapes as lines, rectangles,
  5735. and ovals.
  5736. @param anchor the child anchor describes how this shape is attached
  5737. to the group.
  5738. @return the newly Created shape.
  5739. </member>
  5740. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.CreateConnector(NPOI.XSSF.UserModel.XSSFChildAnchor)">
  5741. Creates a simple shape. This includes such shapes as lines, rectangles,
  5742. and ovals.
  5743. @param anchor the child anchor describes how this shape is attached
  5744. to the group.
  5745. @return the newly Created shape.
  5746. </member>
  5747. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.CreatePicture(NPOI.XSSF.UserModel.XSSFClientAnchor,System.Int32)">
  5748. Creates a picture.
  5749. @param anchor the client anchor describes how this picture is attached to the sheet.
  5750. @param pictureIndex the index of the picture in the workbook collection of pictures,
  5751. {@link XSSFWorkbook#getAllPictures()} .
  5752. @return the newly Created picture shape.
  5753. </member>
  5754. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.SetCoordinates(System.Int32,System.Int32,System.Int32,System.Int32)">
  5755. Sets the coordinate space of this group. All children are constrained
  5756. to these coordinates.
  5757. </member>
  5758. <member name="T:NPOI.XSSF.UserModel.XSSFSheet">
  5759. <summary>
  5760. High level representation of a SpreadsheetML worksheet. Sheets are the
  5761. central structures within a workbook, and are where a user does most of
  5762. his spreadsheet work. The most common type of sheet is the worksheet,
  5763. which is represented as a grid of cells.Worksheet cells can contain
  5764. text, numbers, dates, and formulas. Cells can also be formatted.
  5765. </summary>
  5766. </member>
  5767. <member name="F:NPOI.XSSF.UserModel.XSSFSheet.sharedFormulas">
  5768. <summary>
  5769. cache of master shared formulas in this sheet. Master shared
  5770. formula is the first formula in a group of shared formulas is saved
  5771. in the f element.
  5772. </summary>
  5773. </member>
  5774. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Workbook">
  5775. <summary>
  5776. Returns the parent XSSFWorkbook
  5777. </summary>
  5778. </member>
  5779. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.SheetName">
  5780. <summary>
  5781. Returns the name of this sheet
  5782. </summary>
  5783. </member>
  5784. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.ColumnBreaks">
  5785. <summary>
  5786. Vertical page break information used for print layout view, page
  5787. layout view, drawing print breaksin normal view, and for printing
  5788. the worksheet.
  5789. </summary>
  5790. </member>
  5791. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DefaultColumnWidth">
  5792. <summary>
  5793. Get the default column width for the sheet (if the columns do not
  5794. define their own width) in characters. Note, this value is different
  5795. from <see cref="M:NPOI.XSSF.UserModel.XSSFSheet.GetColumnWidth(System.Int32)"/>. The latter is always greater and
  5796. includes 4 pixels of margin pAdding(two on each side), plus 1 pixel
  5797. pAdding for the gridlines.
  5798. </summary>
  5799. </member>
  5800. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DefaultRowHeight">
  5801. <summary>
  5802. Get the default row height for the sheet (if the rows do not define
  5803. their own height) in twips(1/20 of a point)
  5804. </summary>
  5805. </member>
  5806. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DefaultRowHeightInPoints">
  5807. <summary>
  5808. Get the default row height for the sheet measued in point size
  5809. (if the rows do not define their own height).
  5810. </summary>
  5811. </member>
  5812. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.RightToLeft">
  5813. <summary>
  5814. Whether the text is displayed in right-to-left mode in the window
  5815. </summary>
  5816. </member>
  5817. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayGuts">
  5818. <summary>
  5819. Get whether to display the guts or not, default value is true
  5820. </summary>
  5821. </member>
  5822. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayZeros">
  5823. <summary>
  5824. Gets the flag indicating whether the window should show 0 (zero)
  5825. in cells Containing zero value. When false, cells with zero value
  5826. appear blank instead of Showing the number zero.
  5827. </summary>
  5828. </member>
  5829. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.FirstRowNum">
  5830. <summary>
  5831. Gets the first row on the sheet
  5832. </summary>
  5833. </member>
  5834. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.FitToPage">
  5835. <summary>
  5836. Flag indicating whether the Fit to Page print option is enabled.
  5837. </summary>
  5838. </member>
  5839. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Footer">
  5840. <summary>
  5841. Returns the default footer for the sheet, creating one as needed.
  5842. You may also want to look at <see cref="P:NPOI.XSSF.UserModel.XSSFSheet.FirstFooter"/>,
  5843. <see cref="P:NPOI.XSSF.UserModel.XSSFSheet.OddFooter"/> and <see cref="P:NPOI.XSSF.UserModel.XSSFSheet.EvenFooter"/>
  5844. </summary>
  5845. </member>
  5846. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Header">
  5847. <summary>
  5848. Returns the default header for the sheet, creating one as needed.
  5849. You may also want to look at <see cref="P:NPOI.XSSF.UserModel.XSSFSheet.FirstFooter"/>,
  5850. <see cref="P:NPOI.XSSF.UserModel.XSSFSheet.OddFooter"/> and <see cref="P:NPOI.XSSF.UserModel.XSSFSheet.EvenFooter"/>
  5851. </summary>
  5852. </member>
  5853. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.OddFooter">
  5854. <summary>
  5855. Returns the odd footer. Used on all pages unless other footers
  5856. also present, when used on only odd pages.
  5857. </summary>
  5858. </member>
  5859. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.EvenFooter">
  5860. <summary>
  5861. Returns the even footer. Not there by default, but when Set,
  5862. used on even pages.
  5863. </summary>
  5864. </member>
  5865. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.FirstFooter">
  5866. <summary>
  5867. Returns the first page footer. Not there by default, but when
  5868. Set, used on the first page.
  5869. </summary>
  5870. </member>
  5871. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.OddHeader">
  5872. <summary>
  5873. Returns the odd header. Used on all pages unless other headers
  5874. also present, when used on only odd pages.
  5875. </summary>
  5876. </member>
  5877. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.EvenHeader">
  5878. <summary>
  5879. Returns the even header. Not there by default, but when
  5880. Set, used on even pages.
  5881. </summary>
  5882. </member>
  5883. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.FirstHeader">
  5884. <summary>
  5885. Returns the first page header. Not there by default, but when
  5886. Set, used on the first page.
  5887. </summary>
  5888. </member>
  5889. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.HorizontallyCenter">
  5890. <summary>
  5891. Determine whether printed output for this sheet will be
  5892. horizontally centered.
  5893. </summary>
  5894. </member>
  5895. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.MergedRegions">
  5896. <summary>
  5897. Returns the list of merged regions. If you want multiple regions,
  5898. this is faster than calling {@link #getMergedRegion(int)} each time.
  5899. </summary>
  5900. </member>
  5901. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.NumMergedRegions">
  5902. <summary>
  5903. Returns the number of merged regions defined in this worksheet
  5904. </summary>
  5905. </member>
  5906. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.PaneInformation">
  5907. <summary>
  5908. Returns the information regarding the currently configured pane
  5909. (split or freeze).
  5910. </summary>
  5911. </member>
  5912. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.PhysicalNumberOfRows">
  5913. <summary>
  5914. Returns the number of phsyically defined rows (NOT the number of
  5915. rows in the sheet)
  5916. </summary>
  5917. </member>
  5918. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.PrintSetup">
  5919. <summary>
  5920. Gets the print Setup object.
  5921. </summary>
  5922. </member>
  5923. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Protect">
  5924. <summary>
  5925. Answer whether protection is enabled or disabled
  5926. </summary>
  5927. </member>
  5928. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.RowBreaks">
  5929. <summary>
  5930. Horizontal page break information used for print layout view, page
  5931. layout view, drawing print breaks in normal view, and for printing
  5932. the worksheet.
  5933. </summary>
  5934. </member>
  5935. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.RowSumsBelow">
  5936. <summary>
  5937. Flag indicating whether summary rows appear below detail in an
  5938. outline, when Applying an outline. When true a summary row is
  5939. inserted below the detailed data being summarized and a new outline
  5940. level is established on that row. When false a summary row is
  5941. inserted above the detailed data being summarized and a new outline
  5942. level is established on that row.
  5943. </summary>
  5944. </member>
  5945. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.RowSumsRight">
  5946. <summary>
  5947. When true a summary column is inserted to the right of the detailed
  5948. data being summarized and a new outline level is established on
  5949. that column. When false a summary column is inserted to the left of
  5950. the detailed data being summarized and a new outline level is
  5951. established on that column.
  5952. </summary>
  5953. </member>
  5954. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.ScenarioProtect">
  5955. <summary>
  5956. A flag indicating whether scenarios are locked when the sheet
  5957. is protected.
  5958. </summary>
  5959. </member>
  5960. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.TopRow">
  5961. <summary>
  5962. The top row in the visible view when the sheet is first viewed
  5963. after opening it in a viewer
  5964. </summary>
  5965. </member>
  5966. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.VerticallyCenter">
  5967. <summary>
  5968. Determine whether printed output for this sheet will be vertically
  5969. centered.
  5970. </summary>
  5971. </member>
  5972. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayFormulas">
  5973. <summary>
  5974. Gets the flag indicating whether this sheet should display formulas.
  5975. </summary>
  5976. </member>
  5977. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayGridlines">
  5978. <summary>
  5979. Gets the flag indicating whether this sheet displays the lines
  5980. between rows and columns to make editing and Reading easier.
  5981. </summary>
  5982. </member>
  5983. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayRowColHeadings">
  5984. <summary>
  5985. Gets the flag indicating whether this sheet should display row and
  5986. column headings. Row heading are the row numbers to the side of the
  5987. sheet Column heading are the letters or numbers that appear above
  5988. the columns of the sheet
  5989. </summary>
  5990. </member>
  5991. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsPrintGridlines">
  5992. <summary>
  5993. Returns whether gridlines are printed.
  5994. </summary>
  5995. </member>
  5996. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsPrintRowAndColumnHeadings">
  5997. <summary>
  5998. Returns whether row and column headings are printed.
  5999. </summary>
  6000. </member>
  6001. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.ForceFormulaRecalculation">
  6002. <summary>
  6003. Whether Excel will be asked to recalculate all formulas when the
  6004. workbook is opened.
  6005. </summary>
  6006. </member>
  6007. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Autobreaks">
  6008. <summary>
  6009. Flag indicating whether the sheet displays Automatic Page Breaks.
  6010. </summary>
  6011. </member>
  6012. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSelected">
  6013. <summary>
  6014. Returns a flag indicating whether this sheet is selected.
  6015. <para>
  6016. When only 1 sheet is selected and active, this value should be in
  6017. synch with the activeTab value. In case of a conflict, the Start
  6018. Part Setting wins and Sets the active sheet tab.
  6019. </para>
  6020. Note: multiple sheets can be selected, but only one sheet can be
  6021. active at one time.
  6022. </summary>
  6023. </member>
  6024. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.ActiveCell">
  6025. <summary>
  6026. Return location of the active cell, e.g. <code>A1</code>.
  6027. </summary>
  6028. </member>
  6029. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.HasComments">
  6030. <summary>
  6031. Does this sheet have any comments on it? We need to know, so we can
  6032. decide about writing it to disk or not
  6033. </summary>
  6034. </member>
  6035. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsAutoFilterLocked">
  6036. <summary>
  6037. true when Autofilters are locked and the sheet is protected.
  6038. </summary>
  6039. </member>
  6040. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsDeleteColumnsLocked">
  6041. <summary>
  6042. true when Deleting columns is locked and the sheet is protected.
  6043. </summary>
  6044. </member>
  6045. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsDeleteRowsLocked">
  6046. <summary>
  6047. true when Deleting rows is locked and the sheet is protected.
  6048. </summary>
  6049. </member>
  6050. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsFormatCellsLocked">
  6051. <summary>
  6052. true when Formatting cells is locked and the sheet is protected.
  6053. </summary>
  6054. </member>
  6055. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsFormatColumnsLocked">
  6056. <summary>
  6057. true when Formatting columns is locked and the sheet is protected.
  6058. </summary>
  6059. </member>
  6060. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsFormatRowsLocked">
  6061. <summary>
  6062. true when Formatting rows is locked and the sheet is protected.
  6063. </summary>
  6064. </member>
  6065. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsInsertColumnsLocked">
  6066. <summary>
  6067. true when Inserting columns is locked and the sheet is protected.
  6068. </summary>
  6069. </member>
  6070. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsInsertHyperlinksLocked">
  6071. <summary>
  6072. true when Inserting hyperlinks is locked and the sheet is protected.
  6073. </summary>
  6074. </member>
  6075. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsInsertRowsLocked">
  6076. <summary>
  6077. true when Inserting rows is locked and the sheet is protected.
  6078. </summary>
  6079. </member>
  6080. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsPivotTablesLocked">
  6081. <summary>
  6082. true when Pivot tables are locked and the sheet is protected.
  6083. </summary>
  6084. </member>
  6085. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSortLocked">
  6086. <summary>
  6087. true when Sorting is locked and the sheet is protected.
  6088. </summary>
  6089. </member>
  6090. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsObjectsLocked">
  6091. <summary>
  6092. true when Objects are locked and the sheet is protected.
  6093. </summary>
  6094. </member>
  6095. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsScenariosLocked">
  6096. <summary>
  6097. true when Scenarios are locked and the sheet is protected.
  6098. </summary>
  6099. </member>
  6100. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSelectLockedCellsLocked">
  6101. <summary>
  6102. true when Selection of locked cells is locked and the sheet is
  6103. protected.
  6104. </summary>
  6105. </member>
  6106. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSelectUnlockedCellsLocked">
  6107. <summary>
  6108. true when Selection of unlocked cells is locked and the sheet is
  6109. protected.
  6110. </summary>
  6111. </member>
  6112. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSheetLocked">
  6113. <summary>
  6114. true when Sheet is Protected.
  6115. </summary>
  6116. </member>
  6117. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.TabColor">
  6118. <summary>
  6119. Get or set background color of the sheet tab. The value is null
  6120. if no sheet tab color is set.
  6121. </summary>
  6122. </member>
  6123. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.#ctor">
  6124. <summary>
  6125. Creates new XSSFSheet - called by XSSFWorkbook to create a sheet
  6126. from scratch. See <see cref="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateSheet"/>
  6127. </summary>
  6128. </member>
  6129. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  6130. <summary>
  6131. Creates an XSSFSheet representing the given namespace part and
  6132. relationship. Should only be called by XSSFWorkbook when Reading in
  6133. an exisiting file.
  6134. </summary>
  6135. <param name="part">The namespace part that holds xml data
  6136. represenring this sheet.</param>
  6137. </member>
  6138. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.OnDocumentRead">
  6139. <summary>
  6140. Initialize worksheet data when Reading in an exisiting file.
  6141. </summary>
  6142. <exception cref="T:NPOI.POIXMLException"></exception>
  6143. </member>
  6144. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.OnDocumentCreate">
  6145. <summary>
  6146. Initialize worksheet data when creating a new sheet.
  6147. </summary>
  6148. </member>
  6149. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetVMLDrawing(System.Boolean)">
  6150. <summary>
  6151. Get VML drawing for this sheet (aka 'legacy' drawig)
  6152. </summary>
  6153. <param name="autoCreate">if true, then a new VML drawing part
  6154. is Created</param>
  6155. <returns>the VML drawing of null if the drawing was not found and
  6156. autoCreate=false</returns>
  6157. </member>
  6158. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCommentsTable(System.Boolean)">
  6159. <summary>
  6160. Returns the sheet's comments object if there is one, or null if not
  6161. </summary>
  6162. <param name="create">create a new comments table if it does not
  6163. exist</param>
  6164. <returns></returns>
  6165. </member>
  6166. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetSharedFormula(System.Int32)">
  6167. <summary>
  6168. Return a master shared formula by index
  6169. </summary>
  6170. <param name="sid">shared group index</param>
  6171. <returns>a CT_CellFormula bean holding shared formula or
  6172. <code>null</code> if not found</returns>
  6173. </member>
  6174. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.OnDeleteFormula(NPOI.XSSF.UserModel.XSSFCell,NPOI.XSSF.UserModel.XSSFEvaluationWorkbook)">
  6175. <summary>
  6176. when a cell with a 'master' shared formula is removed, the next
  6177. cell in the range becomes the master
  6178. </summary>
  6179. <param name="cell">The cell that is removed</param>
  6180. <param name="evalWb">in use, if one exists</param>
  6181. </member>
  6182. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCTWorksheet">
  6183. <summary>
  6184. Provide access to the CT_Worksheet bean holding this sheet's data
  6185. </summary>
  6186. <returns>the CT_Worksheet bean holding this sheet's data</returns>
  6187. </member>
  6188. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AddMergedRegion(NPOI.SS.Util.CellRangeAddress)">
  6189. <summary>
  6190. Adds a merged region of cells on a sheet.
  6191. </summary>
  6192. <param name="region">region to merge</param>
  6193. <returns>index of this region</returns>
  6194. <exception cref="T:System.ArgumentException">if region contains fewer
  6195. than 2 cells</exception>
  6196. <exception cref="T:System.InvalidOperationException">if region intersects
  6197. with an existing merged region or multi-cell array formula on
  6198. this sheet</exception>
  6199. </member>
  6200. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AddMergedRegionUnsafe(NPOI.SS.Util.CellRangeAddress)">
  6201. <summary>
  6202. Adds a merged region of cells (hence those cells form one).
  6203. Skips validation.It is possible to create overlapping merged regions
  6204. or create a merged region that intersects a multi-cell array formula
  6205. with this formula, which may result in a corrupt workbook.
  6206. </summary>
  6207. <param name="region">region to merge</param>
  6208. <returns>index of this region</returns>
  6209. <exception cref="T:System.ArgumentException">if region contains fewer
  6210. than 2 cells</exception>
  6211. </member>
  6212. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ValidateMergedRegions">
  6213. <summary>
  6214. Verify that merged regions do not intersect multi-cell array
  6215. formulas and no merged regions intersect another merged region
  6216. in this sheet.
  6217. </summary>
  6218. </member>
  6219. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AutoSizeColumn(System.Int32)">
  6220. <summary>
  6221. Adjusts the column width to fit the contents.
  6222. This process can be relatively slow on large sheets, so this should
  6223. normally only be called once per column, at the end of your
  6224. Processing.
  6225. </summary>
  6226. <param name="column">the column index</param>
  6227. </member>
  6228. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AutoSizeColumn(System.Int32,System.Boolean)">
  6229. <summary>
  6230. Adjusts the column width to fit the contents.
  6231. This process can be relatively slow on large sheets, so this should
  6232. normally only be called once per column, at the end of your
  6233. Processing.
  6234. </summary>
  6235. <param name="column">the column index</param>
  6236. <param name="useMergedCells">whether to use the contents of merged cells
  6237. when calculating the width of the column</param>
  6238. </member>
  6239. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AutoSizeRow(System.Int32)">
  6240. <summary>
  6241. Adjusts the row height to fit the contents.
  6242. This process can be relatively slow on large sheets, so this should
  6243. normally only be called once per row, at the end of your
  6244. Processing.
  6245. </summary>
  6246. <param name="row">the row index</param>
  6247. </member>
  6248. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AutoSizeRow(System.Int32,System.Boolean)">
  6249. <summary>
  6250. Adjusts the row height to fit the contents. This process can be
  6251. relatively slow on large sheets, so this should normally only be
  6252. called once per row, at the end of your Processing. You can specify
  6253. whether the content of merged cells should be considered or
  6254. ignored. Default is to ignore merged cells.
  6255. </summary>
  6256. <param name="row">the row index</param>
  6257. <param name="useMergedCells">whether to use the contents of merged
  6258. cells when calculating the height of the row</param>
  6259. </member>
  6260. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetDrawingPatriarch">
  6261. <summary>
  6262. Return the sheet's existing Drawing, or null if there isn't yet one.
  6263. Use <see cref="M:NPOI.XSSF.UserModel.XSSFSheet.CreateDrawingPatriarch"/> to Get or create
  6264. </summary>
  6265. <returns>a SpreadsheetML Drawing</returns>
  6266. </member>
  6267. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateDrawingPatriarch">
  6268. <summary>
  6269. Create a new SpreadsheetML Drawing. If this sheet already
  6270. Contains a Drawing - return that.
  6271. </summary>
  6272. <returns>a SpreadsheetML Drawing</returns>
  6273. </member>
  6274. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateFreezePane(System.Int32,System.Int32)">
  6275. <summary>
  6276. Creates a split (freezepane). Any existing freezepane or split
  6277. pane is overwritten.
  6278. </summary>
  6279. <param name="colSplit">Horizonatal position of split.</param>
  6280. <param name="rowSplit">Vertical position of split.</param>
  6281. </member>
  6282. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateFreezePane(System.Int32,System.Int32,System.Int32,System.Int32)">
  6283. <summary>
  6284. Creates a split (freezepane). Any existing freezepane or split pane
  6285. is overwritten. If both colSplit and rowSplit are zero then the
  6286. existing freeze pane is Removed
  6287. </summary>
  6288. <param name="colSplit">Horizonatal position of split.</param>
  6289. <param name="rowSplit">Vertical position of split.</param>
  6290. <param name="leftmostColumn">Left column visible in right pane.</param>
  6291. <param name="topRow">Top row visible in bottom pane</param>
  6292. </member>
  6293. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateRow(System.Int32)">
  6294. <summary>
  6295. Create a new row within the sheet and return the high level
  6296. representation. See <see cref="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveRow(NPOI.SS.UserModel.IRow)"/>
  6297. </summary>
  6298. <param name="rownum">row number</param>
  6299. <returns>High level <see cref="T:NPOI.XSSF.UserModel.XSSFRow"/> object representing a
  6300. row in the sheet</returns>
  6301. </member>
  6302. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateSplitPane(System.Int32,System.Int32,System.Int32,System.Int32,NPOI.SS.UserModel.PanePosition)">
  6303. <summary>
  6304. Creates a split pane. Any existing freezepane or split pane is
  6305. overwritten.
  6306. </summary>
  6307. <param name="xSplitPos">Horizonatal position of split (in 1/20th
  6308. of a point).</param>
  6309. <param name="ySplitPos">Vertical position of split (in 1/20th of
  6310. a point).</param>
  6311. <param name="leftmostColumn">Left column visible in right pane.</param>
  6312. <param name="topRow">Top row visible in bottom pane</param>
  6313. <param name="activePane">Active pane. One of: PANE_LOWER_RIGHT,
  6314. PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFT</param>
  6315. </member>
  6316. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCellComment(System.Int32,System.Int32)">
  6317. <summary>
  6318. Returns cell comment for the specified row and column
  6319. </summary>
  6320. <param name="row">The row.</param>
  6321. <param name="column">The column.</param>
  6322. <returns>cell comment or <code>null</code> if not found</returns>
  6323. </member>
  6324. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCellComment(NPOI.SS.Util.CellAddress)">
  6325. <summary>
  6326. Returns cell comment for the specified location
  6327. </summary>
  6328. <param name="address">cell location</param>
  6329. <returns>return cell comment or null if not found</returns>
  6330. </member>
  6331. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCellComments">
  6332. <summary>
  6333. Returns all cell comments on this sheet.
  6334. </summary>
  6335. <returns>return A Dictionary of each Comment in the sheet, keyed on
  6336. the cell address where the comment is located.</returns>
  6337. </member>
  6338. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetHyperlink(System.Int32,System.Int32)">
  6339. <summary>
  6340. Get a Hyperlink in this sheet anchored at row, column
  6341. </summary>
  6342. <param name="row"></param>
  6343. <param name="column"></param>
  6344. <returns>return hyperlink if there is a hyperlink anchored at row,
  6345. column; otherwise returns null</returns>
  6346. </member>
  6347. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetHyperlink(NPOI.SS.Util.CellAddress)">
  6348. <summary>
  6349. Get a Hyperlink in this sheet located in a cell specified
  6350. by {code addr}
  6351. </summary>
  6352. <param name="addr">The address of the cell containing the
  6353. hyperlink</param>
  6354. <returns>return hyperlink if there is a hyperlink anchored at
  6355. {@code addr}; otherwise returns {@code null}</returns>
  6356. </member>
  6357. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetHyperlinkList">
  6358. <summary>
  6359. Get a list of Hyperlinks in this sheet
  6360. </summary>
  6361. <returns></returns>
  6362. </member>
  6363. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetColumnWidth(System.Int32)">
  6364. <summary>
  6365. Get the actual column width (in units of 1/256th of a character width)
  6366. Note, the returned value is always gerater that <see cref="P:NPOI.XSSF.UserModel.XSSFSheet.DefaultColumnWidth"/>
  6367. because the latter does not include margins. Actual column width
  6368. measured as the number of characters of the maximum digit width of
  6369. thenumbers 0, 1, 2, ..., 9 as rendered in the normal style's font.
  6370. There are 4 pixels of margin pAdding(two on each side), plus 1 pixel
  6371. pAdding for the gridlines.
  6372. </summary>
  6373. <param name="columnIndex">the column to set (0-based)</param>
  6374. <returns>the width in units of 1/256th of a character width</returns>
  6375. </member>
  6376. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetColumnWidthInPixels(System.Int32)">
  6377. <summary>
  6378. Get the actual column width in pixels
  6379. Please note, that this method works correctly only for workbooks
  6380. with the default font size(Calibri 11pt for .xlsx).
  6381. </summary>
  6382. <param name="columnIndex"></param>
  6383. <returns></returns>
  6384. </member>
  6385. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetMargin(NPOI.SS.UserModel.MarginType)">
  6386. <summary>
  6387. Gets the size of the margin in inches.
  6388. </summary>
  6389. <param name="margin">which margin to get</param>
  6390. <returns>the size of the margin</returns>
  6391. <exception cref="T:System.ArgumentException"></exception>
  6392. </member>
  6393. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetMargin(NPOI.SS.UserModel.MarginType,System.Double)">
  6394. <summary>
  6395. Sets the size of the margin in inches.
  6396. </summary>
  6397. <param name="margin">which margin to get</param>
  6398. <param name="size">the size of the margin</param>
  6399. <exception cref="T:System.InvalidOperationException"></exception>
  6400. </member>
  6401. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetMergedRegion(System.Int32)">
  6402. <summary>
  6403. </summary>
  6404. <param name="index"></param>
  6405. <returns>the merged region at the specified index</returns>
  6406. <exception cref="T:System.InvalidOperationException">if this worksheet
  6407. does not contain merged regions</exception>
  6408. </member>
  6409. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ProtectSheet(System.String)">
  6410. <summary>
  6411. Enables sheet protection and Sets the password for the sheet.
  6412. Also Sets some attributes on the { @link CT_SheetProtection }
  6413. that correspond to the default values used by Excel
  6414. </summary>
  6415. <param name="password">password to set for protection. Pass null
  6416. to remove protection</param>
  6417. </member>
  6418. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetSheetPassword(System.String,NPOI.POIFS.Crypt.HashAlgorithm)">
  6419. <summary>
  6420. Sets the sheet password.
  6421. </summary>
  6422. <param name="password"> if null, the password will be removed</param>
  6423. <param name="hashAlgo">if null, the password will be set as XOR
  6424. password (Excel 2010 and earlier)otherwise the given algorithm is
  6425. used for calculating the hash password (Excel 2013)</param>
  6426. </member>
  6427. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ValidateSheetPassword(System.String)">
  6428. <summary>
  6429. Validate the password against the stored hash, the hashing method
  6430. will be determined by the existing password attributes
  6431. </summary>
  6432. <param name="password"></param>
  6433. <returns>true, if the hashes match (... though original password
  6434. may differ ...)</returns>
  6435. </member>
  6436. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetRow(System.Int32)">
  6437. <summary>
  6438. Returns the logical row ( 0-based). If you ask for a row that is
  6439. not defined you get a null. This is to say row 4 represents the
  6440. fifth row on a sheet.
  6441. </summary>
  6442. <param name="rownum">row to get</param>
  6443. <returns><see cref="T:NPOI.XSSF.UserModel.XSSFRow"/> representing the rownumber or null
  6444. if its not defined on the sheet</returns>
  6445. </member>
  6446. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GroupColumn(System.Int32,System.Int32)">
  6447. <summary>
  6448. Group between (0 based) columns
  6449. </summary>
  6450. <param name="fromColumn"></param>
  6451. <param name="toColumn"></param>
  6452. </member>
  6453. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsColumnBroken(System.Int32)">
  6454. <summary>
  6455. Determines if there is a page break at the indicated column
  6456. </summary>
  6457. <param name="column"></param>
  6458. <returns></returns>
  6459. </member>
  6460. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsColumnHidden(System.Int32)">
  6461. <summary>
  6462. Get the hidden state for a given column.
  6463. </summary>
  6464. <param name="columnIndex">the column to set (0-based)</param>
  6465. <returns>hidden - false if the column is visible</returns>
  6466. </member>
  6467. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsRowBroken(System.Int32)">
  6468. <summary>
  6469. Tests if there is a page break at the indicated row
  6470. </summary>
  6471. <param name="row">index of the row to test</param>
  6472. <returns>true if there is a page break at the indicated row</returns>
  6473. </member>
  6474. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetRowBreak(System.Int32)">
  6475. <summary>
  6476. Sets a page break at the indicated row Breaks occur above the
  6477. specified row and left of the specified column inclusive. For
  6478. example, sheet.SetColumnBreak(2); breaks the sheet into two parts
  6479. with columns A,B,C in the first and D,E,... in the second.
  6480. Simuilar, sheet.SetRowBreak(2); breaks the sheet into two parts
  6481. with first three rows (rownum=1...3) in the first part and rows
  6482. starting with rownum=4 in the second.
  6483. </summary>
  6484. <param name="row">the row to break, inclusive</param>
  6485. </member>
  6486. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveColumnBreak(System.Int32)">
  6487. <summary>
  6488. Removes a page break at the indicated column
  6489. </summary>
  6490. <param name="column"></param>
  6491. </member>
  6492. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveMergedRegion(System.Int32)">
  6493. <summary>
  6494. Removes a merged region of cells (hence letting them free)
  6495. </summary>
  6496. <param name="index"></param>
  6497. </member>
  6498. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveMergedRegions(System.Collections.Generic.IList{System.Int32})">
  6499. <summary>
  6500. Removes a number of merged regions of cells (hence letting them
  6501. free) This method can be used to bulk-remove merged regions in a
  6502. way much faster than calling RemoveMergedRegion() for every single
  6503. merged region.
  6504. </summary>
  6505. <param name="indices">A Set of the regions to unmerge</param>
  6506. </member>
  6507. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveRow(NPOI.SS.UserModel.IRow)">
  6508. <summary>
  6509. Remove a row from this sheet. All cells Contained in the row are
  6510. Removed as well
  6511. </summary>
  6512. <param name="row">the row to Remove.</param>
  6513. <exception cref="T:System.ArgumentException"></exception>
  6514. </member>
  6515. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveRowBreak(System.Int32)">
  6516. <summary>
  6517. Removes the page break at the indicated row
  6518. </summary>
  6519. <param name="row"></param>
  6520. </member>
  6521. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetColumnBreak(System.Int32)">
  6522. <summary>
  6523. Sets a page break at the indicated column. Breaks occur above the
  6524. specified row and left of the specified column inclusive. For
  6525. example, sheet.SetColumnBreak(2); breaks the sheet into two parts
  6526. with columns A,B,C in the first and D,E,... in the second.
  6527. Simuilar, sheet.SetRowBreak(2); breaks the sheet into two parts
  6528. with first three rows (rownum=1...3) in the first part and rows
  6529. starting with rownum=4 in the second.
  6530. </summary>
  6531. <param name="column">the column to break, inclusive</param>
  6532. </member>
  6533. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetColumnHidden(System.Int32,System.Boolean)">
  6534. <summary>
  6535. Get the visibility state for a given column.
  6536. </summary>
  6537. <param name="columnIndex">the column to get (0-based)</param>
  6538. <param name="hidden">the visiblity state of the column</param>
  6539. </member>
  6540. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetColumnWidth(System.Int32,System.Int32)">
  6541. <summary>
  6542. Set the width (in units of 1/256th of a character width)
  6543. <para>
  6544. The maximum column width for an individual cell is 255
  6545. characters. This value represents the number of characters that can
  6546. be displayed in a cell that is formatted with the standard font
  6547. (first font in the workbook).
  6548. </para>
  6549. <para>
  6550. Character width is defined as the maximum digit width of the
  6551. numbers
  6552. <code>
  6553. 0, 1, 2, ... 9
  6554. </code>
  6555. as rendered using the default
  6556. font (first font in the workbook). Unless you are using a very
  6557. special font, the default character is '0' (zero), this is true for
  6558. Arial (default font font in HSSF) and Calibri (default font in
  6559. XSSF)
  6560. </para>
  6561. <para>
  6562. Please note, that the width set by this method includes 4
  6563. pixels of margin pAdding (two on each side), plus 1 pixel pAdding
  6564. for the gridlines (Section 3.3.1.12 of the OOXML spec). This
  6565. results is a slightly less value of visible characters than passed
  6566. to this method (approx. 1/2 of a character).
  6567. </para>
  6568. <para>
  6569. To compute
  6570. the actual number of visible characters, Excel uses the following
  6571. formula (Section 3.3.1.12 of the OOXML spec):
  6572. </para>
  6573. <code>
  6574. width = TRuncate([{Number of Visible Characters} *
  6575. {Maximum Digit Width} + {5 pixel pAdding}]/{Maximum Digit Width}*256)/256
  6576. </code>
  6577. <para>
  6578. Using the Calibri font as an example, the maximum digit width
  6579. of 11 point font size is 7 pixels (at 96 dpi). If you set a column
  6580. width to be eight characters wide, e.g.
  6581. <code>
  6582. SetColumnWidth(columnIndex, 8*256)
  6583. </code>
  6584. , then the actual value of visible characters (the value Shown in
  6585. Excel) is derived from the following equation:
  6586. <code>
  6587. TRuncate([numChars*7+5]/7*256)/256 = 8;
  6588. </code>
  6589. which gives
  6590. <code>
  6591. 7.29
  6592. </code>.
  6593. </para>
  6594. </summary>
  6595. <param name="columnIndex">the column to set (0-based)</param>
  6596. <param name="width">the width in units of 1/256th of a character
  6597. width</param>
  6598. <exception cref="T:System.ArgumentException">if width more than 255*256 (the
  6599. maximum column width in Excel is 255 characters)</exception>
  6600. </member>
  6601. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetRowGroupCollapsed(System.Int32,System.Boolean)">
  6602. <summary>
  6603. group the row It is possible for collapsed to be false and yet
  6604. still have the rows in question hidden. This can be achieved by
  6605. having a lower outline level collapsed, thus hiding all the child
  6606. rows. Note that in this case, if the lowest level were expanded,
  6607. the middle level would remain collapsed.
  6608. </summary>
  6609. <param name="rowIndex">the row involved, 0 based</param>
  6610. <param name="collapse">bool value for collapse</param>
  6611. </member>
  6612. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetZoom(System.Int32,System.Int32)">
  6613. <summary>
  6614. Sets the zoom magnification for the sheet. The zoom is expressed
  6615. as a fraction. For example to express a zoom of 75% use 3 for the
  6616. numerator and 4 for the denominator.
  6617. </summary>
  6618. <param name="numerator">The numerator for the zoom
  6619. magnification.</param>
  6620. <param name="denominator">The denominator for the zoom
  6621. magnification.</param>
  6622. </member>
  6623. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetZoom(System.Int32)">
  6624. <summary>
  6625. Window zoom magnification for current view representing percent
  6626. values. Valid values range from 10 to 400. Horizontal &amp;
  6627. Vertical scale toGether. For example:
  6628. <code>
  6629. 10 - 10%
  6630. 20 - 20%
  6631. ...
  6632. 100 - 100%
  6633. ...
  6634. 400 - 400%
  6635. </code>
  6636. Current view can be Normal, Page Layout, or Page Break Preview.
  6637. </summary>
  6638. <param name="scale">window zoom magnification</param>
  6639. <exception cref="T:System.ArgumentException">if scale is invalid</exception>
  6640. </member>
  6641. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CopyRows(System.Collections.Generic.List{NPOI.XSSF.UserModel.XSSFRow},System.Int32,NPOI.SS.UserModel.CellCopyPolicy)">
  6642. <summary>
  6643. copyRows rows from srcRows to this sheet starting at destStartRow
  6644. Additionally copies merged regions that are completely defined in
  6645. these rows (ie. merged 2 cells on a row to be shifted).
  6646. </summary>
  6647. <param name="srcRows">the rows to copy. Formulas will be offset by
  6648. the difference in the row number of the first row in srcRows and
  6649. destStartRow (even if srcRows are from a different sheet).</param>
  6650. <param name="destStartRow">the row in this sheet to paste the first
  6651. row of srcRows the remainder of srcRows will be pasted below
  6652. destStartRow per the cell copy policy</param>
  6653. <param name="policy">is the cell copy policy, which can be used to
  6654. merge the source and destination when the source is blank, copy
  6655. styles only, paste as value, etc</param>
  6656. <exception cref="T:System.ArgumentException"></exception>
  6657. </member>
  6658. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CopyRows(System.Int32,System.Int32,System.Int32,NPOI.SS.UserModel.CellCopyPolicy)">
  6659. <summary>
  6660. Copies rows between srcStartRow and srcEndRow to the same sheet,
  6661. starting at destStartRow Convenience function for
  6662. <see cref="M:NPOI.XSSF.UserModel.XSSFSheet.CopyRows(System.Collections.Generic.List{NPOI.XSSF.UserModel.XSSFRow},System.Int32,NPOI.SS.UserModel.CellCopyPolicy)"/> Equivalent to
  6663. copyRows(getRows(srcStartRow, srcEndRow, false), destStartRow, cellCopyPolicy)
  6664. </summary>
  6665. <param name="srcStartRow">the index of the first row to copy the
  6666. cells from in this sheet</param>
  6667. <param name="srcEndRow">the index of the last row to copy the cells
  6668. from in this sheet</param>
  6669. <param name="destStartRow">the index of the first row to copy the
  6670. cells to in this sheet</param>
  6671. <param name="cellCopyPolicy">the policy to use to determine how
  6672. cells are copied</param>
  6673. </member>
  6674. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32)">
  6675. <summary>
  6676. Shifts rows between startRow and endRow n number of rows. If you
  6677. use a negative number, it will shift rows up. Code ensures that
  6678. rows don't wrap around.
  6679. Calls ShiftRows(startRow, endRow, n, false, false);
  6680. <para>
  6681. Additionally Shifts merged regions that are completely defined in
  6682. these rows (ie. merged 2 cells on a row to be Shifted).
  6683. </para>
  6684. </summary>
  6685. <param name="startRow">the row to start Shifting</param>
  6686. <param name="endRow">the row to end Shifting</param>
  6687. <param name="n">the number of rows to shift</param>
  6688. </member>
  6689. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean)">
  6690. <summary>
  6691. Shifts rows between startRow and endRow n number of rows. If you
  6692. use a negative number, it will shift rows up. Code ensures that
  6693. rows don't wrap around
  6694. <para>
  6695. Additionally Shifts merged regions thatare completely defined in
  6696. these rows (ie. merged 2 cells on a row to be Shifted).
  6697. </para>
  6698. </summary>
  6699. <param name="startRow">the row to start Shifting</param>
  6700. <param name="endRow">the row to end Shifting</param>
  6701. <param name="n">the number of rows to shift</param>
  6702. <param name="copyRowHeight">whether to copy the row height during
  6703. the shift</param>
  6704. <param name="resetOriginalRowHeight">whether to set the original
  6705. row's height to the default</param>
  6706. </member>
  6707. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetColumnStyle(System.Int32)">
  6708. <summary>
  6709. Returns the CellStyle that applies to the given (0 based) column,
  6710. or null if no style has been set for that column
  6711. </summary>
  6712. <param name="column"></param>
  6713. <returns></returns>
  6714. </member>
  6715. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GroupRow(System.Int32,System.Int32)">
  6716. <summary>
  6717. Tie a range of cell toGether so that they can be collapsed
  6718. or expanded
  6719. </summary>
  6720. <param name="fromRow">start row (0-based)</param>
  6721. <param name="toRow">end row (0-based)</param>
  6722. </member>
  6723. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.FindEndOfRowOutlineGroup(System.Int32)">
  6724. <summary>
  6725. </summary>
  6726. <param name="row">the zero based row index to find from</param>
  6727. <returns></returns>
  6728. </member>
  6729. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.UngroupRow(System.Int32,System.Int32)">
  6730. <summary>
  6731. Ungroup a range of rows that were previously groupped
  6732. </summary>
  6733. <param name="fromRow">start row (0-based)</param>
  6734. <param name="toRow">end row (0-based)</param>
  6735. </member>
  6736. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AddHyperlink(NPOI.XSSF.UserModel.XSSFHyperlink)">
  6737. <summary>
  6738. Register a hyperlink in the collection of hyperlinks on this sheet
  6739. </summary>
  6740. <param name="hyperlink">the link to add</param>
  6741. </member>
  6742. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveHyperlink(System.Int32,System.Int32)">
  6743. <summary>
  6744. Removes a hyperlink in the collection of hyperlinks on this sheet
  6745. </summary>
  6746. <param name="row">row index</param>
  6747. <param name="column">column index</param>
  6748. </member>
  6749. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.EnableLocking">
  6750. <summary>
  6751. Enable sheet protection
  6752. </summary>
  6753. </member>
  6754. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.DisableLocking">
  6755. <summary>
  6756. Disable sheet protection
  6757. </summary>
  6758. </member>
  6759. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockAutoFilter(System.Boolean)">
  6760. <summary>
  6761. Enable or disable Autofilters locking. This does not modify sheet
  6762. protection status. To enforce this un-/locking, call
  6763. <see cref="M:NPOI.XSSF.UserModel.XSSFSheet.DisableLocking"/> or <see cref="M:NPOI.XSSF.UserModel.XSSFSheet.EnableLocking"/>
  6764. </summary>
  6765. <param name="enabled"></param>
  6766. </member>
  6767. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockDeleteColumns(System.Boolean)">
  6768. <summary>
  6769. Enable or disable Deleting columns locking. This does not modify
  6770. sheet protection status. To enforce this un-/locking, call
  6771. <see cref="M:NPOI.XSSF.UserModel.XSSFSheet.DisableLocking"/> or <see cref="M:NPOI.XSSF.UserModel.XSSFSheet.EnableLocking"/>
  6772. </summary>
  6773. <param name="enabled"></param>
  6774. </member>
  6775. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockDeleteRows(System.Boolean)">
  6776. <summary>
  6777. Enable or disable Deleting rows locking. This does not modify
  6778. sheet protection status. To enforce this un-/locking, call
  6779. </summary>
  6780. <param name="enabled"></param>
  6781. </member>
  6782. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockFormatCells(System.Boolean)">
  6783. <summary>
  6784. Enable or disable Formatting cells locking. This does not modify
  6785. sheet protection status. To enforce this un-/locking, call
  6786. <see cref="M:NPOI.XSSF.UserModel.XSSFSheet.DisableLocking"/> or <see cref="M:NPOI.XSSF.UserModel.XSSFSheet.EnableLocking"/>
  6787. </summary>
  6788. <param name="enabled"></param>
  6789. </member>
  6790. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockFormatColumns(System.Boolean)">
  6791. <summary>
  6792. Enable or disable Formatting columns locking. This does not modify
  6793. sheet protection status. To enforce this un-/locking, call
  6794. <see cref="M:NPOI.XSSF.UserModel.XSSFSheet.DisableLocking"/> or <see cref="M:NPOI.XSSF.UserModel.XSSFSheet.EnableLocking"/>
  6795. </summary>
  6796. <param name="enabled"></param>
  6797. </member>
  6798. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockFormatRows(System.Boolean)">
  6799. <summary>
  6800. Enable or disable Formatting rows locking. This does not modify
  6801. sheet protection status. To enforce this un-/locking, call
  6802. <see cref="M:NPOI.XSSF.UserModel.XSSFSheet.DisableLocking"/> or <see cref="M:NPOI.XSSF.UserModel.XSSFSheet.EnableLocking"/>
  6803. </summary>
  6804. <param name="enabled"></param>
  6805. </member>
  6806. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockInsertColumns(System.Boolean)">
  6807. <summary>
  6808. Enable or disable Inserting columns locking. This does not modify
  6809. sheet protection status. To enforce this un-/locking, call
  6810. <see cref="M:NPOI.XSSF.UserModel.XSSFSheet.DisableLocking"/> or <see cref="M:NPOI.XSSF.UserModel.XSSFSheet.EnableLocking"/>
  6811. </summary>
  6812. <param name="enabled"></param>
  6813. </member>
  6814. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockInsertHyperlinks(System.Boolean)">
  6815. <summary>
  6816. Enable or disable Inserting hyperlinks locking. This does not
  6817. modify sheet protection status. To enforce this un-/locking, call
  6818. <see cref="M:NPOI.XSSF.UserModel.XSSFSheet.DisableLocking"/> or <see cref="M:NPOI.XSSF.UserModel.XSSFSheet.EnableLocking"/>
  6819. </summary>
  6820. <param name="enabled"></param>
  6821. </member>
  6822. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockInsertRows(System.Boolean)">
  6823. <summary>
  6824. Enable or disable Inserting rows locking. This does not modify
  6825. sheet protection status. To enforce this un-/locking, call
  6826. <see cref="M:NPOI.XSSF.UserModel.XSSFSheet.DisableLocking"/> or <see cref="M:NPOI.XSSF.UserModel.XSSFSheet.EnableLocking"/>
  6827. </summary>
  6828. <param name="enabled"></param>
  6829. </member>
  6830. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockPivotTables(System.Boolean)">
  6831. <summary>
  6832. Enable or disable Pivot Tables locking. This does not modify sheet
  6833. protection status. To enforce this un-/locking, call
  6834. <see cref="M:NPOI.XSSF.UserModel.XSSFSheet.DisableLocking"/> or <see cref="M:NPOI.XSSF.UserModel.XSSFSheet.EnableLocking"/>
  6835. </summary>
  6836. <param name="enabled"></param>
  6837. </member>
  6838. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockSort(System.Boolean)">
  6839. <summary>
  6840. Enable or disable Sort locking. This does not modify sheet
  6841. protection status. To enforce this un-/locking, call
  6842. <see cref="M:NPOI.XSSF.UserModel.XSSFSheet.DisableLocking"/> or <see cref="M:NPOI.XSSF.UserModel.XSSFSheet.EnableLocking"/>
  6843. </summary>
  6844. <param name="enabled"></param>
  6845. </member>
  6846. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockObjects(System.Boolean)">
  6847. <summary>
  6848. Enable or disable Objects locking. This does not modify sheet
  6849. protection status. To enforce this un-/locking, call
  6850. <see cref="M:NPOI.XSSF.UserModel.XSSFSheet.DisableLocking"/> or <see cref="M:NPOI.XSSF.UserModel.XSSFSheet.EnableLocking"/>
  6851. </summary>
  6852. <param name="enabled"></param>
  6853. </member>
  6854. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockScenarios(System.Boolean)">
  6855. <summary>
  6856. Enable or disable Scenarios locking. This does not modify sheet
  6857. protection status. To enforce this un-/locking, call
  6858. <see cref="M:NPOI.XSSF.UserModel.XSSFSheet.DisableLocking"/> or <see cref="M:NPOI.XSSF.UserModel.XSSFSheet.EnableLocking"/>
  6859. </summary>
  6860. <param name="enabled"></param>
  6861. </member>
  6862. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockSelectLockedCells(System.Boolean)">
  6863. <summary>
  6864. Enable or disable Selection of locked cells locking. This does not
  6865. modify sheet protection status. To enforce this un-/locking, call
  6866. </summary>
  6867. <param name="enabled"></param>
  6868. </member>
  6869. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockSelectUnlockedCells(System.Boolean)">
  6870. <summary>
  6871. Enable or disable Selection of unlocked cells locking. This does
  6872. not modify sheet protection status. To enforce this un-/locking,
  6873. call <see cref="M:NPOI.XSSF.UserModel.XSSFSheet.DisableLocking"/> or <see cref="M:NPOI.XSSF.UserModel.XSSFSheet.EnableLocking"/>
  6874. </summary>
  6875. <param name="enabled"></param>
  6876. </member>
  6877. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateTable">
  6878. <summary>
  6879. Creates a new Table, and associates it with this Sheet
  6880. </summary>
  6881. <returns></returns>
  6882. </member>
  6883. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetTables">
  6884. <summary>
  6885. Returns any tables associated with this Sheet
  6886. </summary>
  6887. <returns></returns>
  6888. </member>
  6889. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetTabColor(System.Int32)">
  6890. <summary>
  6891. Set background color of the sheet tab
  6892. </summary>
  6893. <param name="colorIndex">the indexed color to set, must be a
  6894. constant from <see cref="T:NPOI.SS.UserModel.IndexedColors"/></param>
  6895. </member>
  6896. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreatePivotTable(NPOI.SS.Util.AreaReference,NPOI.SS.Util.CellReference,NPOI.SS.UserModel.ISheet)">
  6897. <summary>
  6898. Create a pivot table using the AreaReference range on sourceSheet,
  6899. at the given position. If the source reference contains a sheet
  6900. name, it must match the sourceSheet
  6901. </summary>
  6902. <param name="source">location of pivot data</param>
  6903. <param name="position">A reference to the top left cell where the
  6904. pivot table will start</param>
  6905. <param name="sourceSheet">The sheet containing the source data, if
  6906. the source reference doesn't contain a sheet name</param>
  6907. <returns>The pivot table</returns>
  6908. <exception cref="T:System.ArgumentException">if source references a sheet
  6909. different than sourceSheet</exception>
  6910. </member>
  6911. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreatePivotTable(NPOI.SS.Util.AreaReference,NPOI.SS.Util.CellReference)">
  6912. <summary>
  6913. Create a pivot table using the AreaReference range, at the given
  6914. position. If the source reference contains a sheet name, that sheet
  6915. is used, otherwise this sheet is assumed as the source sheet.
  6916. </summary>
  6917. <param name="source">location of pivot data</param>
  6918. <param name="position">A reference to the top left cell where the
  6919. pivot table will start</param>
  6920. <returns>The pivot table</returns>
  6921. </member>
  6922. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreatePivotTable(NPOI.SS.UserModel.IName,NPOI.SS.Util.CellReference,NPOI.SS.UserModel.ISheet)">
  6923. <summary>
  6924. Create a pivot table using the Name range reference on sourceSheet,
  6925. at the given position. If the source reference contains a sheet
  6926. name, it must match the sourceSheet
  6927. </summary>
  6928. <param name="source">location of pivot data</param>
  6929. <param name="position">A reference to the top left cell where the
  6930. pivot table will start</param>
  6931. <param name="sourceSheet">The sheet containing the source data,
  6932. if the source reference doesn't contain a sheet name</param>
  6933. <returns>The pivot table</returns>
  6934. <exception cref="T:System.ArgumentException"></exception>
  6935. </member>
  6936. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreatePivotTable(NPOI.SS.UserModel.IName,NPOI.SS.Util.CellReference)">
  6937. <summary>
  6938. Create a pivot table using the Name range, at the given position.
  6939. If the source reference contains a sheet name, that sheet is used,
  6940. otherwise this sheet is assumed as the source sheet.
  6941. </summary>
  6942. <param name="source">location of pivot data</param>
  6943. <param name="position">A reference to the top left cell where the
  6944. pivot table will start</param>
  6945. <returns>The pivot table</returns>
  6946. </member>
  6947. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreatePivotTable(NPOI.SS.UserModel.ITable,NPOI.SS.Util.CellReference)">
  6948. <summary>
  6949. Create a pivot table using the Table, at the given position. Tables
  6950. are required to have a sheet reference, so no additional logic
  6951. around reference sheet is needed.
  6952. </summary>
  6953. <param name="source">location of pivot data</param>
  6954. <param name="position">A reference to the top left cell where the
  6955. pivot table will start</param>
  6956. <returns>The pivot table</returns>
  6957. </member>
  6958. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetPivotTables">
  6959. <summary>
  6960. Returns all the pivot tables for this Sheet
  6961. </summary>
  6962. <returns></returns>
  6963. </member>
  6964. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AddIgnoredErrors(NPOI.SS.Util.CellReference,NPOI.SS.UserModel.IgnoredErrorType[])">
  6965. <summary>
  6966. Add ignored errors (usually to suppress them in the UI of a
  6967. consuming application).
  6968. </summary>
  6969. <param name="cell">Cell</param>
  6970. <param name="ignoredErrorTypes">Types of error to ignore there.</param>
  6971. </member>
  6972. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AddIgnoredErrors(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.IgnoredErrorType[])">
  6973. <summary>
  6974. Ignore errors across a range of cells.
  6975. </summary>
  6976. <param name="region">Range of cells.</param>
  6977. <param name="ignoredErrorTypes">Types of error to ignore there.</param>
  6978. </member>
  6979. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetIgnoredErrors">
  6980. <summary>
  6981. Returns the errors currently being ignored and the ranges where
  6982. they are ignored.
  6983. </summary>
  6984. <returns>Map of error type to the range(s) where they are ignored.</returns>
  6985. </member>
  6986. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CopyComment(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.ICell)">
  6987. <summary>
  6988. Copies comment from one cell to another
  6989. </summary>
  6990. <param name="sourceCell">Cell with a comment to copy</param>
  6991. <param name="targetCell">Cell to paste the comment to</param>
  6992. <returns>Copied comment</returns>
  6993. </member>
  6994. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.InitHyperlinks">
  6995. <summary>
  6996. Read hyperlink relations, link them with CT_Hyperlink beans in this
  6997. worksheet and Initialize the internal array of XSSFHyperlink objects
  6998. </summary>
  6999. <exception cref="T:NPOI.POIXMLException"></exception>
  7000. </member>
  7001. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.NewSheet">
  7002. <summary>
  7003. Create a new CT_Worksheet instance with all values set to defaults
  7004. </summary>
  7005. <returns>a new instance</returns>
  7006. </member>
  7007. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AddMergedRegion(NPOI.SS.Util.CellRangeAddress,System.Boolean)">
  7008. <summary>
  7009. Adds a merged region of cells (hence those cells form one).
  7010. </summary>
  7011. <param name="region">region (rowfrom/colfrom-rowto/colto) to merge</param>
  7012. <param name="validate">whether to validate merged region</param>
  7013. <returns>index of this region</returns>
  7014. <exception cref="T:System.InvalidOperationException">if region intersects
  7015. with a multi-cell array formula or if region intersects with an
  7016. existing region on this sheet</exception>
  7017. <exception cref="T:System.ArgumentException">if region contains fewer
  7018. than 2 cells</exception>
  7019. </member>
  7020. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ValidateArrayFormulas(NPOI.SS.Util.CellRangeAddress)">
  7021. <summary>
  7022. Verify that the candidate region does not intersect with an
  7023. existing multi-cell array formula in this sheet
  7024. </summary>
  7025. <param name="region"></param>
  7026. <exception cref="T:System.InvalidOperationException">if candidate region
  7027. intersects an existing array formula in this sheet</exception>
  7028. </member>
  7029. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CheckForMergedRegionsIntersectingArrayFormulas">
  7030. <summary>
  7031. Verify that none of the merged regions intersect a multi-cell array
  7032. formula in this sheet
  7033. </summary>
  7034. </member>
  7035. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ValidateMergedRegions(NPOI.SS.Util.CellRangeAddress)">
  7036. <summary>
  7037. Verify that candidate region does not intersect with an existing
  7038. merged region in this sheet
  7039. </summary>
  7040. <param name="candidateRegion"></param>
  7041. <exception cref="T:System.InvalidOperationException">if candidate region
  7042. intersects an existing merged region in this sheet</exception>
  7043. </member>
  7044. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CheckForIntersectingMergedRegions">
  7045. <summary>
  7046. Verify that no merged regions intersect another merged
  7047. region in this sheet.
  7048. </summary>
  7049. <exception cref="T:System.InvalidOperationException">if at least one region
  7050. intersects with another merged region in this sheet</exception>
  7051. </member>
  7052. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetRows(System.Int32,System.Int32,System.Boolean)">
  7053. <summary>
  7054. returns all rows between startRow and endRow, inclusive. Rows
  7055. between startRow and endRow that haven't been created are not
  7056. included in result unless createRowIfMissing is true
  7057. </summary>
  7058. <param name="startRowNum">the first row number in this
  7059. sheet to return</param>
  7060. <param name="endRowNum">the last row number in this
  7061. sheet to return</param>
  7062. <param name="createRowIfMissing"></param>
  7063. <returns></returns>
  7064. <exception cref="T:System.ArgumentException">if startRowNum and endRowNum
  7065. are not in ascending order</exception>
  7066. </member>
  7067. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.EnsureOutlinePr">
  7068. <summary>
  7069. Ensure CT_Worksheet.CT_SheetPr.CT_OutlinePr
  7070. </summary>
  7071. <returns></returns>
  7072. </member>
  7073. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetColWidthAttribute(NPOI.OpenXmlFormats.Spreadsheet.CT_Cols)">
  7074. <summary>
  7075. Do not leave the width attribute undefined (see #52186).
  7076. </summary>
  7077. <param name="ctCols"></param>
  7078. </member>
  7079. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetGroupHidden(System.Int32,System.Int32,System.Boolean)">
  7080. <summary>
  7081. Sets all adjacent columns of the same outline level to the
  7082. specified hidden status.
  7083. </summary>
  7084. <param name="pIdx">the col info index of the start of the
  7085. outline group</param>
  7086. <param name="level"></param>
  7087. <param name="hidden"></param>
  7088. <returns>the column index of the last column in the
  7089. outline group</returns>
  7090. </member>
  7091. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsColumnGroupCollapsed(System.Int32)">
  7092. <summary>
  7093. 'Collapsed' state is stored in a single column col info record
  7094. immediately after the outline group
  7095. </summary>
  7096. <param name="idx"></param>
  7097. <returns>a bool represented if the column is collapsed</returns>
  7098. </member>
  7099. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CollapseRow(System.Int32)">
  7100. <summary>
  7101. </summary>
  7102. <param name="rowIndex">the zero based row index to collapse</param>
  7103. </member>
  7104. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.FindStartOfRowOutlineGroup(System.Int32)">
  7105. <summary>
  7106. </summary>
  7107. <param name="rowIndex">the zero based row index to find from</param>
  7108. <returns></returns>
  7109. </member>
  7110. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ExpandRow(System.Int32)">
  7111. <summary>
  7112. </summary>
  7113. <param name="rowNumber">the zero based row index to expand</param>
  7114. </member>
  7115. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsRowGroupHiddenByParent(System.Int32)">
  7116. <summary>
  7117. </summary>
  7118. <param name="row">the zero based row index to find from</param>
  7119. <returns></returns>
  7120. </member>
  7121. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsRowGroupCollapsed(System.Int32)">
  7122. <summary>
  7123. </summary>
  7124. <param name="row">the zero based row index to find from</param>
  7125. <returns></returns>
  7126. </member>
  7127. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetDefaultSheetView">
  7128. <summary>
  7129. Return the default sheet view. This is the last one if the sheet's
  7130. views, according to sec. 3.3.1.83 of the OOXML spec: "A single
  7131. sheet view defInition. When more than 1 sheet view is defined in
  7132. the file, it means that when opening the workbook, each sheet view
  7133. corresponds to a separate window within the spreadsheet
  7134. application, where each window is Showing the particular sheet.
  7135. Containing the same workbookViewId value, the last sheetView
  7136. defInition is loaded, and the others are discarded. When multiple
  7137. windows are viewing the same sheet, multiple sheetView elements
  7138. (with corresponding workbookView entries) are saved."
  7139. </summary>
  7140. <returns></returns>
  7141. </member>
  7142. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCellRange(NPOI.SS.Util.CellRangeAddress)">
  7143. <summary>
  7144. Also Creates cells if they don't exist
  7145. </summary>
  7146. <param name="range"></param>
  7147. <returns></returns>
  7148. </member>
  7149. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreatePivotTable">
  7150. <summary>
  7151. Creates an empty XSSFPivotTable and Sets up all its relationships
  7152. including: pivotCacheDefInition, pivotCacheRecords
  7153. </summary>
  7154. <returns>a pivotTable</returns>
  7155. </member>
  7156. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreatePivotTable(NPOI.SS.Util.CellReference,NPOI.SS.UserModel.ISheet,NPOI.XSSF.UserModel.XSSFPivotTable.IPivotTableReferenceConfigurator)">
  7157. <summary>
  7158. Create a pivot table using the AreaReference or named/table range
  7159. on sourceSheet, at the given position. If the source reference
  7160. contains a sheet name, it must match the sourceSheet.
  7161. </summary>
  7162. <param name="position">A reference to the top left cell where the
  7163. pivot table will start</param>
  7164. <param name="sourceSheet">The sheet containing the source data,
  7165. if the source reference doesn't contain a sheet name</param>
  7166. <param name="refConfig"></param>
  7167. <returns>The pivot table</returns>
  7168. </member>
  7169. <member name="T:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting">
  7170. XSSF Conditional Formattings
  7171. </member>
  7172. <member name="F:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.CF_EXT_2009_NS_X14">
  7173. Office 2010 Conditional Formatting extensions namespace
  7174. </member>
  7175. <member name="M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.ComparisonOperator,System.String,System.String)">
  7176. A factory method allowing to create a conditional formatting rule
  7177. with a cell comparison operator<p/>
  7178. TODO - formulas Containing cell references are currently not Parsed properly
  7179. @param comparisonOperation - a constant value from
  7180. <tt>{@link NPOI.hssf.record.CFRuleRecord.ComparisonOperator}</tt>: <p>
  7181. <ul>
  7182. <li>BETWEEN</li>
  7183. <li>NOT_BETWEEN</li>
  7184. <li>EQUAL</li>
  7185. <li>NOT_EQUAL</li>
  7186. <li>GT</li>
  7187. <li>LT</li>
  7188. <li>GE</li>
  7189. <li>LE</li>
  7190. </ul>
  7191. </p>
  7192. @param formula1 - formula for the valued, Compared with the cell
  7193. @param formula2 - second formula (only used with
  7194. {@link NPOI.ss.usermodel.ComparisonOperator#BETWEEN}) and
  7195. {@link NPOI.ss.usermodel.ComparisonOperator#NOT_BETWEEN} operations)
  7196. </member>
  7197. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.CreateConditionalFormattingRule(System.String)" -->
  7198. <member name="M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.IconSet)">
  7199. A factory method allowing the creation of conditional formatting
  7200. rules using an Icon Set / Multi-State formatting.
  7201. The thresholds for it will be created, but will be empty
  7202. and require configuring with
  7203. {@link XSSFConditionalFormattingRule#getMultiStateFormatting()}
  7204. then
  7205. {@link XSSFIconMultiStateFormatting#getThresholds()}
  7206. </member>
  7207. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.XSSF.UserModel.XSSFColor)" -->
  7208. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.CreateConditionalFormattingColorScaleRule" -->
  7209. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.UserModel.IConditionalFormatting)" -->
  7210. <member name="M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.GetConditionalFormattingAt(System.Int32)">
  7211. Gets Conditional Formatting object at a particular index
  7212. @param index
  7213. of the Conditional Formatting object to fetch
  7214. @return Conditional Formatting object
  7215. </member>
  7216. <member name="P:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.NumConditionalFormattings">
  7217. @return number of Conditional Formatting objects of the sheet
  7218. </member>
  7219. <member name="M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.RemoveConditionalFormatting(System.Int32)">
  7220. Removes a Conditional Formatting object by index
  7221. @param index of a Conditional Formatting object to remove
  7222. </member>
  7223. <member name="T:NPOI.XSSF.UserModel.XSSFSimpleShape">
  7224. Represents a shape with a predefined geometry in a SpreadsheetML Drawing.
  7225. Possible shape types are defined in {@link NPOI.SS.UserModel.ShapeTypes}
  7226. </member>
  7227. <member name="F:NPOI.XSSF.UserModel.XSSFSimpleShape._paragraphs">
  7228. List of the paragraphs that make up the text in this shape
  7229. </member>
  7230. <member name="F:NPOI.XSSF.UserModel.XSSFSimpleShape.prototype">
  7231. A default instance of CTShape used for creating new shapes.
  7232. </member>
  7233. <member name="F:NPOI.XSSF.UserModel.XSSFSimpleShape.ctShape">
  7234. Xml bean that stores properties of this shape
  7235. </member>
  7236. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.Prototype">
  7237. Prototype with the default structure of a new auto-shape.
  7238. </member>
  7239. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.Text">
  7240. Returns the text from all paragraphs in the shape. Paragraphs are Separated by new lines.
  7241. @return text Contained within this shape or empty string
  7242. </member>
  7243. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.ProcessAutoNumGroup(System.Int32,System.Int32,System.Collections.Generic.List{System.Int32},System.Text.StringBuilder)">
  7244. </member>
  7245. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.GetBulletPrefix(NPOI.XSSF.UserModel.ListAutoNumber,System.Int32)">
  7246. Returns a string Containing an appropriate prefix for an auto-numbering bullet
  7247. @param scheme the auto-numbering scheme used by the bullet
  7248. @param value the value of the bullet
  7249. @return appropriate prefix for an auto-numbering bullet
  7250. </member>
  7251. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.valueToAlpha(System.Int32)">
  7252. Convert an integer to its alpha equivalent e.g. 1 = A, 2 = B, 27 = AA etc
  7253. </member>
  7254. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.valueToRoman(System.Int32)">
  7255. Convert an integer to its roman equivalent e.g. 1 = I, 9 = IX etc
  7256. </member>
  7257. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.ClearText">
  7258. Clear all text from this shape
  7259. </member>
  7260. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.SetText(System.String)">
  7261. Set a single paragraph of text on the shape. Note this will replace all existing paragraphs Created on the shape.
  7262. @param text string representing the paragraph text
  7263. </member>
  7264. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.SetText(NPOI.XSSF.UserModel.XSSFRichTextString)">
  7265. Set a single paragraph of text on the shape. Note this will replace all existing paragraphs Created on the shape.
  7266. @param str rich text string representing the paragraph text
  7267. </member>
  7268. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.TextParagraphs">
  7269. Returns a collection of the XSSFTextParagraphs that are attached to this shape
  7270. @return text paragraphs in this shape
  7271. </member>
  7272. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.AddNewTextParagraph">
  7273. Add a new paragraph run to this shape
  7274. @return Created paragraph run
  7275. </member>
  7276. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.AddNewTextParagraph(System.String)">
  7277. Add a new paragraph run to this shape, Set to the provided string
  7278. @return Created paragraph run
  7279. </member>
  7280. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.AddNewTextParagraph(NPOI.XSSF.UserModel.XSSFRichTextString)">
  7281. Add a new paragraph run to this shape, Set to the provided rich text string
  7282. @return Created paragraph run
  7283. </member>
  7284. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.TextHorizontalOverflow">
  7285. Returns the type of horizontal overflow for the text.
  7286. @return the type of horizontal overflow
  7287. </member>
  7288. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.TextVerticalOverflow">
  7289. Returns the type of vertical overflow for the text.
  7290. @return the type of vertical overflow
  7291. </member>
  7292. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.VerticalAlignment">
  7293. Returns the type of vertical alignment for the text within the shape.
  7294. @return the type of vertical alignment
  7295. </member>
  7296. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.TextDirection">
  7297. Gets the vertical orientation of the text
  7298. @return vertical orientation of the text
  7299. </member>
  7300. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.BottomInset">
  7301. Returns the distance (in points) between the bottom of the text frame
  7302. and the bottom of the inscribed rectangle of the shape that Contains the text.
  7303. @return the bottom inset in points
  7304. </member>
  7305. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.LeftInset">
  7306. Returns the distance (in points) between the left edge of the text frame
  7307. and the left edge of the inscribed rectangle of the shape that Contains
  7308. the text.
  7309. @return the left inset in points
  7310. </member>
  7311. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.RightInset">
  7312. Returns the distance (in points) between the right edge of the
  7313. text frame and the right edge of the inscribed rectangle of the shape
  7314. that Contains the text.
  7315. @return the right inset in points
  7316. </member>
  7317. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.TopInset">
  7318. Returns the distance (in points) between the top of the text frame
  7319. and the top of the inscribed rectangle of the shape that Contains the text.
  7320. @return the top inset in points
  7321. </member>
  7322. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.WordWrap">
  7323. @return whether to wrap words within the bounding rectangle
  7324. </member>
  7325. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.TextAutofit">
  7326. Specifies that a shape should be auto-fit to fully contain the text described within it.
  7327. Auto-fitting is when text within a shape is scaled in order to contain all the text inside
  7328. @param value type of autofit
  7329. @return type of autofit
  7330. </member>
  7331. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.ShapeType">
  7332. Gets the shape type, one of the constants defined in {@link NPOI.SS.UserModel.ShapeTypes}.
  7333. @return the shape type
  7334. @see NPOI.SS.UserModel.ShapeTypes
  7335. </member>
  7336. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.ApplyAttributes(NPOI.OpenXmlFormats.Spreadsheet.CT_RPrElt,NPOI.OpenXmlFormats.Dml.CT_TextCharacterProperties)">
  7337. org.Openxmlformats.schemas.spreadsheetml.x2006.main.CTRPrElt to
  7338. org.Openxmlformats.schemas.Drawingml.x2006.main.CTFont adapter
  7339. </member>
  7340. <member name="T:NPOI.XSSF.UserModel.XSSFTable">
  7341. This class : the Table Part (Open Office XML Part 4:
  7342. chapter 3.5.1)
  7343. This implementation works under the assumption that a table Contains mappings to a subtree of an XML.
  7344. The root element of this subtree an occur multiple times (one for each row of the table). The child nodes
  7345. of the root element can be only attributes or element with maxOccurs=1 property set
  7346. @author Roberto Manicardi
  7347. </member>
  7348. <member name="M:NPOI.XSSF.UserModel.XSSFTable.MapsTo(System.Int64)">
  7349. Checks if this Table element Contains even a single mapping to the map identified by id
  7350. @param id the XSSFMap ID
  7351. @return true if the Table element contain mappings
  7352. </member>
  7353. <member name="M:NPOI.XSSF.UserModel.XSSFTable.GetCommonXpath">
  7354. Calculates the xpath of the root element for the table. This will be the common part
  7355. of all the mapping's xpaths
  7356. @return the xpath of the table's root element
  7357. </member>
  7358. <member name="M:NPOI.XSSF.UserModel.XSSFTable.GetXmlColumnPrs">
  7359. Note this list is static - once read, it does not notice later changes to the underlying column structures
  7360. @return List of XSSFXmlColumnPr
  7361. </member>
  7362. <member name="P:NPOI.XSSF.UserModel.XSSFTable.Name">
  7363. @return the name of the Table, if set
  7364. </member>
  7365. <member name="M:NPOI.XSSF.UserModel.XSSFTable.GetCellReferences">
  7366. Get the area reference for the cells which this table covers. The area
  7367. includes header rows and totals rows.
  7368. Does not track updates to underlying changes to CTTable To synchronize
  7369. with changes to the underlying CTTable, call {@link #updateReferences()}.
  7370. @return the area of the table
  7371. @see "Open Office XML Part 4: chapter 3.5.1.2, attribute ref"
  7372. </member>
  7373. <member name="M:NPOI.XSSF.UserModel.XSSFTable.SetCellReferences(NPOI.SS.Util.AreaReference)">
  7374. Set the area reference for the cells which this table covers. The area
  7375. includes includes header rows and totals rows. Automatically synchronizes
  7376. any changes by calling {@link #updateHeaders()}.
  7377. Note: The area's width should be identical to the amount of columns in
  7378. the table or the table may be invalid. All header rows, totals rows and
  7379. at least one data row must fit inside the area. Updating the area with
  7380. this method does not create or remove any columns and does not change any
  7381. cell values.
  7382. @see "Open Office XML Part 4: chapter 3.5.1.2, attribute ref"
  7383. </member>
  7384. <member name="P:NPOI.XSSF.UserModel.XSSFTable.DisplayName">
  7385. @return the display name of the Table, if set
  7386. </member>
  7387. <member name="P:NPOI.XSSF.UserModel.XSSFTable.NumberOfMappedColumns">
  7388. @return the number of mapped table columns (see Open Office XML Part 4: chapter 3.5.1.4)
  7389. </member>
  7390. <member name="P:NPOI.XSSF.UserModel.XSSFTable.TotalsRowCount">
  7391. <summary>
  7392. 0 for no totals rows, 1 for totals row shown.
  7393. Values > 1 are not currently used by Excel up through 2016, and the OOXML spec
  7394. doesn't define how they would be implemented.
  7395. </summary>
  7396. </member>
  7397. <member name="P:NPOI.XSSF.UserModel.XSSFTable.HeaderRowCount">
  7398. <summary>
  7399. 0 for no header rows, 1 for table headers shown.
  7400. Values > 1 might be used by Excel for pivot tables?
  7401. </summary>
  7402. </member>
  7403. <member name="P:NPOI.XSSF.UserModel.XSSFTable.StartCellReference">
  7404. @return The reference for the cell in the top-left part of the table
  7405. (see Open Office XML Part 4: chapter 3.5.1.2, attribute ref)
  7406. To synchronize with changes to the underlying CTTable,
  7407. call {@link #updateReferences()}.
  7408. </member>
  7409. <member name="P:NPOI.XSSF.UserModel.XSSFTable.EndCellReference">
  7410. @return The reference for the cell in the bottom-right part of the table
  7411. (see Open Office XML Part 4: chapter 3.5.1.2, attribute ref)
  7412. Does not track updates to underlying changes to CTTable
  7413. To synchronize with changes to the underlying CTTable,
  7414. call {@link #updateReferences()}.
  7415. </member>
  7416. <member name="M:NPOI.XSSF.UserModel.XSSFTable.SetCellReferences">
  7417. @since POI 3.15 beta 3
  7418. </member>
  7419. <member name="M:NPOI.XSSF.UserModel.XSSFTable.UpdateReferences">
  7420. Clears the cached values set by {@link #getStartCellReference()}
  7421. and {@link #getEndCellReference()}.
  7422. The next call to {@link #getStartCellReference()} and
  7423. {@link #getEndCellReference()} will synchronize the
  7424. cell references with the underlying <code>CTTable</code>.
  7425. Thus, {@link #updateReferences()} is inexpensive.
  7426. @since POI 3.15 beta 3
  7427. </member>
  7428. <member name="P:NPOI.XSSF.UserModel.XSSFTable.RowCount">
  7429. @return the total number of rows in the selection. (Note: in this version autofiltering is ignored)
  7430. Returns 0 if the start or end cell references are not set.
  7431. To synchronize with changes to the underlying CTTable,
  7432. call {@link #updateReferences()}.
  7433. </member>
  7434. <member name="M:NPOI.XSSF.UserModel.XSSFTable.UpdateHeaders">
  7435. Synchronize table headers with cell values in the parent sheet.
  7436. Headers <em>must</em> be in sync, otherwise Excel will display a
  7437. "Found unreadable content" message on startup.
  7438. If calling both {@link #updateReferences()} and
  7439. {@link #updateHeaders()}, {@link #updateReferences()}
  7440. should be called first.
  7441. </member>
  7442. <member name="M:NPOI.XSSF.UserModel.XSSFTable.FindColumnIndex(System.String)">
  7443. Gets the relative column index of a column in this table having the header name <code>column</code>.
  7444. The column index is relative to the left-most column in the table, 0-indexed.
  7445. Returns <code>-1</code> if <code>column</code> is not a header name in table.
  7446. Column Header names are case-insensitive
  7447. Note: this function caches column names for performance. To flush the cache (because columns
  7448. have been moved or column headers have been changed), {@link #updateHeaders()} must be called.
  7449. @since 3.15 beta 2
  7450. </member>
  7451. <member name="M:NPOI.XSSF.UserModel.XSSFTable.GetColumns">
  7452. <summary>
  7453. Note this list is static - once read, it does not notice later changes to the underlying column structures
  7454. </summary>
  7455. <returns></returns>
  7456. </member>
  7457. <member name="P:NPOI.XSSF.UserModel.XSSFTable.IsHasTotalsRow">
  7458. <summary>
  7459. This is misleading. The Spec indicates this is true if the totals row
  7460. has<b><i>ever</i></b> been shown, not whether or not it is currently displayed.
  7461. </summary>
  7462. </member>
  7463. <member name="M:NPOI.XSSF.UserModel.XSSFTableColumn.GetTable">
  7464. <summary>
  7465. Get the table which contains this column
  7466. </summary>
  7467. <returns>the table containing this column</returns>
  7468. </member>
  7469. <member name="T:NPOI.XSSF.UserModel.XSSFTextBox">
  7470. Represents a text box in a SpreadsheetML Drawing.
  7471. @author Yegor Kozlov
  7472. </member>
  7473. <member name="T:NPOI.XSSF.UserModel.XSSFTextParagraph">
  7474. Represents a paragraph of text within the Containing text body.
  7475. The paragraph is the highest level text separation mechanism.
  7476. </member>
  7477. <member name="M:NPOI.XSSF.UserModel.XSSFTextParagraph.AddNewTextRun">
  7478. Add a new run of text
  7479. @return a new run of text
  7480. </member>
  7481. <member name="M:NPOI.XSSF.UserModel.XSSFTextParagraph.AddLineBreak">
  7482. Insert a line break
  7483. @return text run representing this line break ('\n')
  7484. </member>
  7485. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.TextAlign">
  7486. get or set the alignment that is to be applied to the paragraph.
  7487. Possible values for this include left, right, centered, justified and distributed,
  7488. If this attribute is omitted, then a value of left is implied.
  7489. @return alignment that is applied to the paragraph
  7490. </member>
  7491. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.TextFontAlign">
  7492. Determines where vertically on a line of text the actual words are positioned. This deals
  7493. with vertical placement of the characters with respect to the baselines. For instance
  7494. having text anchored to the top baseline, anchored to the bottom baseline, centered in
  7495. between, etc.
  7496. If this attribute is omitted, then a value of baseline is implied.
  7497. @return alignment that is applied to the paragraph
  7498. </member>
  7499. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.BulletFont">
  7500. @return the font to be used on bullet characters within a given paragraph
  7501. </member>
  7502. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.BulletCharacter">
  7503. @return the character to be used in place of the standard bullet point
  7504. </member>
  7505. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.BulletFontColor">
  7506. @return the color of bullet characters within a given paragraph.
  7507. A <code>null</code> value means to use the text font color.
  7508. </member>
  7509. <!-- Badly formed XML comment ignored for member "P:NPOI.XSSF.UserModel.XSSFTextParagraph.BulletFontSize" -->
  7510. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.Indent">
  7511. @return the indent applied to the first line of text in the paragraph.
  7512. </member>
  7513. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.LeftMargin">
  7514. Specifies the left margin of the paragraph. This is specified in Addition to the text body
  7515. inset and applies only to this text paragraph. That is the text body inset and the LeftMargin
  7516. attributes are Additive with respect to the text position.
  7517. @param value the left margin of the paragraph, -1 to clear the margin and use the default of 0.
  7518. </member>
  7519. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.RightMargin">
  7520. Specifies the right margin of the paragraph. This is specified in Addition to the text body
  7521. inset and applies only to this text paragraph. That is the text body inset and the marR
  7522. attributes are Additive with respect to the text position.
  7523. @param value the right margin of the paragraph, -1 to clear the margin and use the default of 0.
  7524. </member>
  7525. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.DefaultTabSize">
  7526. @return the default size for a tab character within this paragraph in points
  7527. </member>
  7528. <member name="M:NPOI.XSSF.UserModel.XSSFTextParagraph.AddTabStop(System.Double)">
  7529. Add a single tab stop to be used on a line of text when there are one or more tab characters
  7530. present within the text.
  7531. @param value the position of the tab stop relative to the left margin
  7532. </member>
  7533. <!-- Badly formed XML comment ignored for member "P:NPOI.XSSF.UserModel.XSSFTextParagraph.LineSpacing" -->
  7534. <!-- Badly formed XML comment ignored for member "P:NPOI.XSSF.UserModel.XSSFTextParagraph.SpaceBefore" -->
  7535. <!-- Badly formed XML comment ignored for member "P:NPOI.XSSF.UserModel.XSSFTextParagraph.SpaceAfter" -->
  7536. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.Level">
  7537. Specifies the particular level text properties that this paragraph will follow.
  7538. The value for this attribute formats the text according to the corresponding level
  7539. paragraph properties defined in the list of styles associated with the body of text
  7540. that this paragraph belongs to (therefore in the parent shape).
  7541. <p>
  7542. Note that the closest properties object to the text is used, therefore if there is
  7543. a conflict between the text paragraph properties and the list style properties for
  7544. this level then the text paragraph properties will take precedence.
  7545. </p>
  7546. Returns the level of text properties that this paragraph will follow.
  7547. @return the text level of this paragraph (0-based). Default is 0.
  7548. </member>
  7549. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.IsBullet">
  7550. Returns whether this paragraph has bullets
  7551. </member>
  7552. <member name="M:NPOI.XSSF.UserModel.XSSFTextParagraph.SetBullet(System.Boolean)">
  7553. Set or unset this paragraph as a bullet point
  7554. @param flag whether text in this paragraph has bullets
  7555. </member>
  7556. <member name="M:NPOI.XSSF.UserModel.XSSFTextParagraph.SetBullet(NPOI.XSSF.UserModel.ListAutoNumber,System.Int32)">
  7557. Set this paragraph as an automatic numbered bullet point
  7558. @param scheme type of auto-numbering
  7559. @param startAt the number that will start number for a given sequence of automatically
  7560. numbered bullets (1-based).
  7561. </member>
  7562. <member name="M:NPOI.XSSF.UserModel.XSSFTextParagraph.SetBullet(NPOI.XSSF.UserModel.ListAutoNumber)">
  7563. Set this paragraph as an automatic numbered bullet point
  7564. @param scheme type of auto-numbering
  7565. </member>
  7566. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.IsBulletAutoNumber">
  7567. Returns whether this paragraph has automatic numbered bullets
  7568. </member>
  7569. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.BulletAutoNumberStart">
  7570. Returns the starting number if this paragraph has automatic numbered bullets, otherwise returns 0
  7571. </member>
  7572. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.BulletAutoNumberScheme">
  7573. Returns the auto number scheme if this paragraph has automatic numbered bullets, otherwise returns ListAutoNumber.ARABIC_PLAIN
  7574. </member>
  7575. <member name="T:NPOI.XSSF.UserModel.XSSFTextRun">
  7576. Represents a run of text within the Containing text body. The run element is the
  7577. lowest level text separation mechanism within a text body.
  7578. </member>
  7579. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.FontSize">
  7580. @return font size in points or -1 if font size is not Set.
  7581. </member>
  7582. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.CharacterSpacing">
  7583. @return the spacing between characters within a text Run,
  7584. If this attribute is omitted then a value of 0 or no adjustment is assumed.
  7585. </member>
  7586. <member name="M:NPOI.XSSF.UserModel.XSSFTextRun.SetFont(System.String)">
  7587. Specifies the typeface, or name of the font that is to be used for this text Run.
  7588. @param typeface the font to apply to this text Run.
  7589. The value of <code>null</code> unsets the Typeface attribute from the underlying xml.
  7590. </member>
  7591. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.FontFamily">
  7592. @return font family or null if not Set
  7593. </member>
  7594. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.IsStrikethrough">
  7595. get or set whether a run of text will be formatted as strikethrough text. Default is false.
  7596. </member>
  7597. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.IsSuperscript">
  7598. get or set whether a run of text will be formatted as a superscript text. Default is false.
  7599. Default base line offset is 30%
  7600. </member>
  7601. <member name="M:NPOI.XSSF.UserModel.XSSFTextRun.SetBaselineOffset(System.Double)">
  7602. Set the baseline for both the superscript and subscript fonts.
  7603. <p>
  7604. The size is specified using a percentage.
  7605. Positive values indicate superscript, negative values indicate subscript.
  7606. </p>
  7607. @param baselineOffset
  7608. </member>
  7609. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.IsSubscript">
  7610. get or set whether a run of text will be formatted as a superscript text. Default is false.
  7611. Default base line offset is -25%.
  7612. </member>
  7613. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.TextCap">
  7614. @return whether a run of text will be formatted as a superscript text. Default is false.
  7615. </member>
  7616. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.IsBold">
  7617. get or set whether this run of text is formatted as bold text
  7618. </member>
  7619. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.IsItalic">
  7620. get or set whether this run of text is formatted as italic text
  7621. </member>
  7622. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.IsUnderline">
  7623. get or set whether this run of text is formatted as underlined text
  7624. </member>
  7625. <member name="M:NPOI.XSSF.UserModel.XSSFVBAPart.#ctor">
  7626. Create a new XSSFVBAPart node
  7627. </member>
  7628. <member name="M:NPOI.XSSF.UserModel.XSSFVBAPart.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  7629. Construct XSSFVBAPart from a package part
  7630. @param part the package part holding the VBA data,
  7631. @param rel the package relationship holding this part
  7632. </member>
  7633. <member name="M:NPOI.XSSF.UserModel.XSSFVBAPart.PrepareForCommit">
  7634. Like *PictureData, VBA objects store the actual content in the part
  7635. directly without keeping a copy like all others therefore we need to
  7636. handle them differently.
  7637. </member>
  7638. <member name="T:NPOI.XSSF.UserModel.XSSFVMLDrawing">
  7639. Represents a SpreadsheetML VML Drawing.
  7640. <p>
  7641. In Excel 2007 VML Drawings are used to describe properties of cell comments,
  7642. although the spec says that VML is deprecated:
  7643. </p>
  7644. <p>
  7645. The VML format is a legacy format originally introduced with Office 2000 and is included and fully defined
  7646. in this Standard for backwards compatibility reasons. The DrawingML format is a newer and richer format
  7647. Created with the goal of eventually replacing any uses of VML in the Office Open XML formats. VML should be
  7648. considered a deprecated format included in Office Open XML for legacy reasons only and new applications that
  7649. need a file format for Drawings are strongly encouraged to use preferentially DrawingML
  7650. </p>
  7651. <p>
  7652. Warning - Excel is known to Put invalid XML into these files!
  7653. For example, &gt;br&lt; without being closed or escaped crops up.
  7654. </p>
  7655. See 6.4 VML - SpreadsheetML Drawing in Office Open XML Part 4 - Markup Language Reference.pdf
  7656. @author Yegor Kozlov
  7657. </member>
  7658. <member name="F:NPOI.XSSF.UserModel.XSSFVMLDrawing.ptrn_shapeId">
  7659. regexp to parse shape ids, in VML they have weird form of id="_x0000_s1026"
  7660. </member>
  7661. <member name="M:NPOI.XSSF.UserModel.XSSFVMLDrawing.#ctor">
  7662. Create a new SpreadsheetML Drawing
  7663. @see XSSFSheet#CreateDrawingPatriarch()
  7664. </member>
  7665. <member name="M:NPOI.XSSF.UserModel.XSSFVMLDrawing.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  7666. Construct a SpreadsheetML Drawing from a namespace part
  7667. @param part the namespace part holding the Drawing data,
  7668. the content type must be <code>application/vnd.Openxmlformats-officedocument.Drawing+xml</code>
  7669. @param rel the namespace relationship holding this Drawing,
  7670. the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/drawing
  7671. </member>
  7672. <member name="M:NPOI.XSSF.UserModel.XSSFVMLDrawing.newDrawing">
  7673. Initialize a new Speadsheet VML Drawing
  7674. </member>
  7675. <member name="M:NPOI.XSSF.UserModel.XSSFVMLDrawing.FindCommentShape(System.Int32,System.Int32)">
  7676. Find a shape with ClientData of type "NOTE" and the specified row and column
  7677. @return the comment shape or <code>null</code>
  7678. </member>
  7679. <member name="T:NPOI.XSSF.UserModel.XSSFWorkbook">
  7680. High level representation of a SpreadsheetML workbook. This is the first object most users
  7681. will construct whether they are Reading or writing a workbook. It is also the
  7682. top level object for creating new sheets/etc.
  7683. </member>
  7684. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.DEFAULT_CHARACTER_WIDTH">
  7685. Width of one character of the default font in pixels. Same for Calibry and Arial.
  7686. </member>
  7687. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.Max_SENSITIVE_SHEET_NAME_LEN">
  7688. Excel silently tRuncates long sheet names to 31 chars.
  7689. This constant is used to ensure uniqueness in the first 31 chars
  7690. </member>
  7691. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_EMF">
  7692. Extended windows meta file
  7693. </member>
  7694. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_WMF">
  7695. Windows Meta File
  7696. </member>
  7697. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_PICT">
  7698. Mac PICT format
  7699. </member>
  7700. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_JPEG">
  7701. JPEG format
  7702. </member>
  7703. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_PNG">
  7704. PNG format
  7705. </member>
  7706. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_DIB">
  7707. Device independent bitmap
  7708. </member>
  7709. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_GIF">
  7710. Images formats supported by XSSF but not by HSSF
  7711. </member>
  7712. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.workbook">
  7713. The underlying XML bean
  7714. </member>
  7715. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.sheets">
  7716. this holds the XSSFSheet objects attached to this workbook
  7717. </member>
  7718. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.namedRangesByName">
  7719. this holds the XSSFName objects attached to this workbook, keyed by lower-case name
  7720. </member>
  7721. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.namedRanges">
  7722. this holds the XSSFName objects attached to this workbook
  7723. </member>
  7724. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.sharedStringSource">
  7725. shared string table - a cache of strings in this workbook
  7726. </member>
  7727. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.stylesSource">
  7728. A collection of shared objects used for styling content,
  7729. e.g. fonts, cell styles, colors, etc.
  7730. </member>
  7731. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook._udfFinder">
  7732. The locator of user-defined functions.
  7733. By default includes functions from the Excel Analysis Toolpack
  7734. </member>
  7735. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.calcChain">
  7736. TODO
  7737. </member>
  7738. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.externalLinks">
  7739. External Links, for referencing names or cells in other workbooks.
  7740. </member>
  7741. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.mapInfo">
  7742. A collection of custom XML mappings
  7743. </member>
  7744. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.formatter">
  7745. Used to keep track of the data formatter so that all
  7746. CreateDataFormatter calls return the same one for a given
  7747. book. This ensures that updates from one places is visible
  7748. someplace else.
  7749. </member>
  7750. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook._missingCellPolicy">
  7751. The policy to apply in the event of missing or
  7752. blank cells when fetching from a row.
  7753. See {@link NPOI.ss.usermodel.Row.MissingCellPolicy}
  7754. </member>
  7755. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.pictures">
  7756. array of pictures for this workbook
  7757. </member>
  7758. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook._creationHelper">
  7759. cached instance of XSSFCreationHelper for this workbook
  7760. @see {@link #getCreationHelper()}
  7761. </member>
  7762. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.pivotTables">
  7763. List of all pivot tables in workbook
  7764. </member>
  7765. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor">
  7766. Create a new SpreadsheetML workbook.
  7767. </member>
  7768. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor(NPOI.XSSF.UserModel.XSSFWorkbookType)">
  7769. Create a new SpreadsheetML workbook.
  7770. @param workbookType The type of workbook to make (.xlsx or .xlsm).
  7771. </member>
  7772. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage)">
  7773. Constructs a XSSFWorkbook object given a OpenXML4J <code>Package</code> object,
  7774. see <a href="http://poi.apache.org/oxml4j/">http://poi.apache.org/oxml4j/</a>.
  7775. Once you have finished working with the Workbook, you should close the package
  7776. by calling pkg.close, to avoid leaving file handles open.
  7777. Creating a XSSFWorkbook from a file-backed OPC Package has a lower memory
  7778. footprint than an InputStream backed one.
  7779. @param pkg the OpenXML4J <code>OPC Package</code> object.
  7780. </member>
  7781. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor(System.IO.Stream)">
  7782. Constructs a XSSFWorkbook object, by buffering the whole stream into memory
  7783. and then opening an {@link OPCPackage} object for it.
  7784. Using an {@link InputStream} requires more memory than using a File, so
  7785. if a {@link File} is available then you should instead do something like
  7786. <pre><code>
  7787. OPCPackage pkg = OPCPackage.open(path);
  7788. XSSFWorkbook wb = new XSSFWorkbook(pkg);
  7789. // work with the wb object
  7790. ......
  7791. pkg.close(); // gracefully closes the underlying zip file
  7792. </code></pre>
  7793. </member>
  7794. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor(System.IO.FileInfo)" -->
  7795. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor(System.String)" -->
  7796. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.ParseSheet(System.Collections.Generic.Dictionary{System.String,NPOI.XSSF.UserModel.XSSFSheet},NPOI.OpenXmlFormats.Spreadsheet.CT_Sheet)">
  7797. Not normally to be called externally, but possibly to be overridden to avoid
  7798. the DOM based parse of large sheets (see examples).
  7799. </member>
  7800. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.OnWorkbookCreate">
  7801. Create a new CT_Workbook with all values Set to default
  7802. </member>
  7803. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.newPackage(NPOI.XSSF.UserModel.XSSFWorkbookType)">
  7804. Create a new SpreadsheetML namespace and Setup the default minimal content
  7805. </member>
  7806. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCTWorkbook">
  7807. Return the underlying XML bean
  7808. @return the underlying CT_Workbook bean
  7809. </member>
  7810. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.AddPicture(System.Byte[],System.Int32)">
  7811. Adds a picture to the workbook.
  7812. @param pictureData The bytes of the picture
  7813. @param format The format of the picture.
  7814. @return the index to this picture (0 based), the Added picture can be obtained from {@link #getAllPictures()} .
  7815. @see Workbook#PICTURE_TYPE_EMF
  7816. @see Workbook#PICTURE_TYPE_WMF
  7817. @see Workbook#PICTURE_TYPE_PICT
  7818. @see Workbook#PICTURE_TYPE_JPEG
  7819. @see Workbook#PICTURE_TYPE_PNG
  7820. @see Workbook#PICTURE_TYPE_DIB
  7821. @see #getAllPictures()
  7822. </member>
  7823. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.AddPicture(System.IO.Stream,System.Int32)">
  7824. Adds a picture to the workbook.
  7825. @param is The sream to read image from
  7826. @param format The format of the picture.
  7827. @return the index to this picture (0 based), the Added picture can be obtained from {@link #getAllPictures()} .
  7828. @see Workbook#PICTURE_TYPE_EMF
  7829. @see Workbook#PICTURE_TYPE_WMF
  7830. @see Workbook#PICTURE_TYPE_PICT
  7831. @see Workbook#PICTURE_TYPE_JPEG
  7832. @see Workbook#PICTURE_TYPE_PNG
  7833. @see Workbook#PICTURE_TYPE_DIB
  7834. @see #getAllPictures()
  7835. </member>
  7836. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CloneSheet(System.Int32)">
  7837. Create an XSSFSheet from an existing sheet in the XSSFWorkbook.
  7838. The Cloned sheet is a deep copy of the original.
  7839. @param sheetNum The index of the sheet to clone
  7840. @return XSSFSheet representing the Cloned sheet.
  7841. @throws ArgumentException if the sheet index in invalid
  7842. @throws POIXMLException if there were errors when cloning
  7843. </member>
  7844. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CloneSheet(System.Int32,System.String)">
  7845. Create an XSSFSheet from an existing sheet in the XSSFWorkbook.
  7846. The cloned sheet is a deep copy of the original but with a new given
  7847. name.
  7848. @param sheetNum The index of the sheet to clone
  7849. @param newName The name to set for the newly created sheet
  7850. @return XSSFSheet representing the cloned sheet.
  7851. @throws IllegalArgumentException if the sheet index or the sheet
  7852. name is invalid
  7853. @throws POIXMLException if there were errors when cloning
  7854. </member>
  7855. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.AddRelation(NPOI.POIXMLDocumentPart.RelationPart,NPOI.POIXMLDocumentPart)">
  7856. @since 3.14-Beta1
  7857. </member>
  7858. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetUniqueSheetName(System.String)">
  7859. Generate a valid sheet name based on the existing one. Used when cloning sheets.
  7860. @param srcName the original sheet name to
  7861. @return clone sheet name
  7862. </member>
  7863. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateCellStyle">
  7864. <summary>
  7865. Create a new XSSFCellStyle and add it to the workbook's style table
  7866. </summary>
  7867. <returns>the new XSSFCellStyle object</returns>
  7868. </member>
  7869. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateDataFormat">
  7870. <summary>
  7871. Returns the workbook's data format table (a factory for creating data format strings).
  7872. </summary>
  7873. <returns>the XSSFDataFormat object</returns>
  7874. </member>
  7875. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateFont">
  7876. <summary>
  7877. Create a new Font and add it to the workbook's font table
  7878. </summary>
  7879. <returns></returns>
  7880. </member>
  7881. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateSheet">
  7882. Create an XSSFSheet for this workbook, Adds it to the sheets and returns
  7883. the high level representation. Use this to create new sheets.
  7884. @return XSSFSheet representing the new sheet.
  7885. </member>
  7886. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateSheet(System.String)">
  7887. Create a new sheet for this Workbook and return the high level representation.
  7888. Use this to create new sheets.
  7889. <p>
  7890. Note that Excel allows sheet names up to 31 chars in length but other applications
  7891. (such as OpenOffice) allow more. Some versions of Excel crash with names longer than 31 chars,
  7892. others - tRuncate such names to 31 character.
  7893. </p>
  7894. <p>
  7895. POI's SpreadsheetAPI silently tRuncates the input argument to 31 characters.
  7896. Example:
  7897. <pre><code>
  7898. Sheet sheet = workbook.CreateSheet("My very long sheet name which is longer than 31 chars"); // will be tRuncated
  7899. assert 31 == sheet.SheetName.Length;
  7900. assert "My very long sheet name which i" == sheet.SheetName;
  7901. </code></pre>
  7902. </p>
  7903. Except the 31-character constraint, Excel applies some other rules:
  7904. <p>
  7905. Sheet name MUST be unique in the workbook and MUST NOT contain the any of the following characters:
  7906. <ul>
  7907. <li> 0x0000 </li>
  7908. <li> 0x0003 </li>
  7909. <li> colon (:) </li>
  7910. <li> backslash (\) </li>
  7911. <li> asterisk (*) </li>
  7912. <li> question mark (?) </li>
  7913. <li> forward slash (/) </li>
  7914. <li> opening square bracket ([) </li>
  7915. <li> closing square bracket (]) </li>
  7916. </ul>
  7917. The string MUST NOT begin or end with the single quote (') character.
  7918. </p>
  7919. <p>
  7920. See {@link org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)}
  7921. for a safe way to create valid names
  7922. </p>
  7923. @param sheetname sheetname to set for the sheet.
  7924. @return Sheet representing the new sheet.
  7925. @throws IllegalArgumentException if the name is null or invalid
  7926. or workbook already contains a sheet with this name
  7927. @see org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)
  7928. </member>
  7929. <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)">
  7930. Finds a font that matches the one with the supplied attributes
  7931. </member>
  7932. <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)">
  7933. Finds a font that matches the one with the supplied attributes
  7934. </member>
  7935. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.ActiveSheetIndex">
  7936. Convenience method to Get the active sheet. The active sheet is is the sheet
  7937. which is currently displayed when the workbook is viewed in Excel.
  7938. 'Selected' sheet(s) is a distinct concept.
  7939. </member>
  7940. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetAllPictures">
  7941. Gets all pictures from the Workbook.
  7942. @return the list of pictures (a list of {@link XSSFPictureData} objects.)
  7943. @see #AddPicture(byte[], int)
  7944. </member>
  7945. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCellStyleAt(System.Int32)">
  7946. Get the cell style object at the given index
  7947. @param idx index within the set of styles
  7948. @return XSSFCellStyle object at the index
  7949. </member>
  7950. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetFontAt(System.Int16)">
  7951. Get the font at the given index number
  7952. @param idx index number
  7953. @return XSSFFont at the index
  7954. </member>
  7955. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetName(System.String)">
  7956. <summary>
  7957. Get the first named range with the given name.
  7958. Note: names of named ranges are not unique as they are scoped by sheet.
  7959. {@link #getNames(String name)} returns all named ranges with the given name.
  7960. </summary>
  7961. <param name="name">named range name</param>
  7962. <returns>return XSSFName with the given name. <code>null</code> is returned no named range could be found.</returns>
  7963. </member>
  7964. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetNames(System.String)">
  7965. <summary>
  7966. Get the named ranges with the given name.
  7967. <i>Note:</i>Excel named ranges are case-insensitive and
  7968. this method performs a case-insensitive search.
  7969. </summary>
  7970. <param name="name">named range name</param>
  7971. <returns>return list of XSSFNames with the given name. An empty list if no named ranges could be found</returns>
  7972. </member>
  7973. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetAllNames">
  7974. <summary>
  7975. Get a list of all the named ranges in the workbook.
  7976. </summary>
  7977. <returns>return list of XSSFNames in the workbook</returns>
  7978. </member>
  7979. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetNameIndex(System.String)">
  7980. Gets the named range index by his name
  7981. <i>Note:</i>Excel named ranges are case-insensitive and
  7982. this method performs a case-insensitive search.
  7983. @param name named range name
  7984. @return named range index
  7985. </member>
  7986. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.NumCellStyles">
  7987. Get the number of styles the workbook Contains
  7988. @return count of cell styles
  7989. </member>
  7990. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.NumberOfFonts">
  7991. Get the number of fonts in the this workbook
  7992. @return number of fonts
  7993. </member>
  7994. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.NumberOfNames">
  7995. Get the number of named ranges in the this workbook
  7996. @return number of named ranges
  7997. </member>
  7998. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.NumberOfSheets">
  7999. Get the number of worksheets in the this workbook
  8000. @return number of worksheets
  8001. </member>
  8002. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetPrintArea(System.Int32)">
  8003. Retrieves the reference for the printarea of the specified sheet, the sheet name is Appended to the reference even if it was not specified.
  8004. @param sheetIndex Zero-based sheet index (0 Represents the first sheet to keep consistent with java)
  8005. @return String Null if no print area has been defined
  8006. </member>
  8007. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheet(System.String)">
  8008. Get sheet with the given name (case insensitive match)
  8009. @param name of the sheet
  8010. @return XSSFSheet with the name provided or <code>null</code> if it does not exist
  8011. </member>
  8012. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheetAt(System.Int32)" -->
  8013. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheetIndex(System.String)">
  8014. <summary>
  8015. Returns the index of the sheet by his name (case insensitive match)
  8016. </summary>
  8017. <param name="name">the sheet name</param>
  8018. <returns>index of the sheet (0 based) or -1 if not found</returns>
  8019. </member>
  8020. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheetIndex(NPOI.SS.UserModel.ISheet)">
  8021. Returns the index of the given sheet
  8022. @param sheet the sheet to look up
  8023. @return index of the sheet (0 based). <tt>-1</tt> if not found
  8024. </member>
  8025. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheetName(System.Int32)">
  8026. Get the sheet name
  8027. @param sheetIx Number
  8028. @return Sheet name
  8029. </member>
  8030. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetEnumerator">
  8031. Allows foreach loops:
  8032. <pre><code>
  8033. XSSFWorkbook wb = new XSSFWorkbook(package);
  8034. for(XSSFSheet sheet : wb){
  8035. }
  8036. </code></pre>
  8037. </member>
  8038. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsMacroEnabled">
  8039. Are we a normal workbook (.xlsx), or a
  8040. macro enabled workbook (.xlsm)?
  8041. </member>
  8042. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.RemoveName(NPOI.SS.UserModel.IName)">
  8043. As {@link #removeName(String)} is not necessarily unique
  8044. (name + sheet index is unique), this method is more accurate.
  8045. @param name the name to remove.
  8046. </member>
  8047. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.RemovePrintArea(System.Int32)">
  8048. Delete the printarea for the sheet specified
  8049. @param sheetIndex 0-based sheet index (0 = First Sheet)
  8050. </member>
  8051. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.RemoveSheetAt(System.Int32)">
  8052. Removes sheet at the given index.<p/>
  8053. Care must be taken if the Removed sheet is the currently active or only selected sheet in
  8054. the workbook. There are a few situations when Excel must have a selection and/or active
  8055. sheet. (For example when printing - see Bug 40414).<br/>
  8056. This method Makes sure that if the Removed sheet was active, another sheet will become
  8057. active in its place. Furthermore, if the Removed sheet was the only selected sheet, another
  8058. sheet will become selected. The newly active/selected sheet will have the same index, or
  8059. one less if the Removed sheet was the last in the workbook.
  8060. @param index of the sheet (0-based)
  8061. </member>
  8062. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.OnSheetDelete(System.Int32)">
  8063. Gracefully remove references to the sheet being deleted
  8064. @param index the 0-based index of the sheet to delete
  8065. </member>
  8066. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.MissingCellPolicy">
  8067. Retrieves the current policy on what to do when
  8068. Getting missing or blank cells from a row.
  8069. The default is to return blank and null cells.
  8070. {@link MissingCellPolicy}
  8071. </member>
  8072. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.ValidateSheetIndex(System.Int32)">
  8073. Validate sheet index
  8074. @param index the index to validate
  8075. @throws ArgumentException if the index is out of range (index
  8076. &lt; 0 || index &gt;= NumberOfSheets).
  8077. </member>
  8078. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.FirstVisibleTab">
  8079. Gets the first tab that is displayed in the list of tabs in excel.
  8080. @return integer that Contains the index to the active sheet in this book view.
  8081. </member>
  8082. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFWorkbook.SetPrintArea(System.Int32,System.String)" -->
  8083. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetPrintArea(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  8084. For the Convenience of Java Programmers maintaining pointers.
  8085. @see #setPrintArea(int, String)
  8086. @param sheetIndex Zero-based sheet index (0 = First Sheet)
  8087. @param startColumn Column to begin printarea
  8088. @param endColumn Column to end the printarea
  8089. @param startRow Row to begin the printarea
  8090. @param endRow Row to end the printarea
  8091. </member>
  8092. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateBuiltInName(System.String,System.Int32)">
  8093. Generates a NameRecord to represent a built-in region
  8094. @return a new NameRecord
  8095. @throws ArgumentException if sheetNumber is invalid
  8096. @throws POIXMLException if such a name already exists in the workbook
  8097. </member>
  8098. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSelectedTab(System.Int32)">
  8099. We only Set one sheet as selected for compatibility with HSSF.
  8100. </member>
  8101. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetName(System.Int32,System.String)">
  8102. Set the sheet name.
  8103. @param sheetIndex sheet number (0 based)
  8104. @param sheetname the new sheet name
  8105. @throws ArgumentException if the name is null or invalid
  8106. or workbook already Contains a sheet with this name
  8107. @see {@link #CreateSheet(String)}
  8108. @see {@link NPOI.ss.util.WorkbookUtil#CreateSafeSheetName(String nameProposal)}
  8109. for a safe way to create valid names
  8110. </member>
  8111. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetOrder(System.String,System.Int32)">
  8112. Sets the order of appearance for a given sheet.
  8113. @param sheetname the name of the sheet to reorder
  8114. @param pos the position that we want to insert the sheet into (0 based)
  8115. </member>
  8116. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.UpdateNamedRangesAfterSheetReorder(System.Int32,System.Int32)">
  8117. update sheet-scoped named ranges in this workbook after changing the sheet order
  8118. of a sheet at oldIndex to newIndex.
  8119. Sheets between these indices will move left or right by 1.
  8120. @param oldIndex the original index of the re-ordered sheet
  8121. @param newIndex the new index of the re-ordered sheet
  8122. </member>
  8123. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SaveNamedRanges">
  8124. marshal named ranges from the {@link #namedRanges} collection to the underlying CT_Workbook bean
  8125. </member>
  8126. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.Write(System.IO.Stream,System.Boolean)">
  8127. <summary>
  8128. Write the document to the specified stream, and optionally leave the stream open without closing it.
  8129. </summary>
  8130. <param name="stream">the stream you wish to write the xlsx to</param>
  8131. <param name="leaveOpen">leave stream open or not</param>
  8132. </member>
  8133. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSharedStringSource">
  8134. Returns SharedStringsTable - the cache of strings for this workbook
  8135. @return the shared string table
  8136. </member>
  8137. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetStylesSource">
  8138. Return a object representing a collection of shared objects used for styling content,
  8139. e.g. fonts, cell styles, colors, etc.
  8140. </member>
  8141. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetTheme">
  8142. Returns the Theme of current workbook.
  8143. </member>
  8144. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCreationHelper">
  8145. Returns an object that handles instantiating concrete
  8146. classes of the various instances for XSSF.
  8147. </member>
  8148. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.ContainsSheet(System.String,System.Int32)">
  8149. Determines whether a workbook Contains the provided sheet name.
  8150. For the purpose of comparison, long names are tRuncated to 31 chars.
  8151. @param name the name to Test (case insensitive match)
  8152. @param excludeSheetIdx the sheet to exclude from the check or -1 to include all sheets in the Check.
  8153. @return true if the sheet Contains the name, false otherwise.
  8154. </member>
  8155. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsDate1904">
  8156. <summary>
  8157. Gets a bool value that indicates whether the date systems used in the workbook starts in 1904.
  8158. The default value is false, meaning that the workbook uses the 1900 date system,
  8159. where 1/1/1900 is the first day in the system.
  8160. </summary>
  8161. <returns>True if the date systems used in the workbook starts in 1904</returns>
  8162. </member>
  8163. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetAllEmbedds">
  8164. Get the document's embedded files.
  8165. </member>
  8166. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsSheetHidden(System.Int32)">
  8167. Check whether a sheet is hidden.
  8168. <p>
  8169. Note that a sheet could instead be Set to be very hidden, which is different
  8170. ({@link #isSheetVeryHidden(int)})
  8171. </p>
  8172. @param sheetIx Number
  8173. @return <code>true</code> if sheet is hidden
  8174. </member>
  8175. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsSheetVeryHidden(System.Int32)">
  8176. Check whether a sheet is very hidden.
  8177. <p>
  8178. This is different from the normal hidden status
  8179. ({@link #isSheetHidden(int)})
  8180. </p>
  8181. @param sheetIx sheet index to check
  8182. @return <code>true</code> if sheet is very hidden
  8183. </member>
  8184. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetHidden(System.Int32,System.Boolean)">
  8185. Sets the visible state of this sheet.
  8186. <p>
  8187. Calling <code>setSheetHidden(sheetIndex, true)</code> is equivalent to
  8188. <code>setSheetHidden(sheetIndex, Workbook.SHEET_STATE_HIDDEN)</code>.
  8189. <br/>
  8190. Calling <code>setSheetHidden(sheetIndex, false)</code> is equivalent to
  8191. <code>setSheetHidden(sheetIndex, Workbook.SHEET_STATE_VISIBLE)</code>.
  8192. </p>
  8193. @param sheetIx the 0-based index of the sheet
  8194. @param hidden whether this sheet is hidden
  8195. @see #setSheetHidden(int, int)
  8196. </member>
  8197. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetHidden(System.Int32,NPOI.SS.UserModel.SheetState)">
  8198. Hide or unhide a sheet.
  8199. <ul>
  8200. <li>0 - visible. </li>
  8201. <li>1 - hidden. </li>
  8202. <li>2 - very hidden.</li>
  8203. </ul>
  8204. @param sheetIx the sheet index (0-based)
  8205. @param state one of the following <code>Workbook</code> constants:
  8206. <code>Workbook.SHEET_STATE_VISIBLE</code>,
  8207. <code>Workbook.SHEET_STATE_HIDDEN</code>, or
  8208. <code>Workbook.SHEET_STATE_VERY_HIDDEN</code>.
  8209. @throws ArgumentException if the supplied sheet index or state is invalid
  8210. </member>
  8211. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetHidden(System.Int32,System.Int32)">
  8212. <summary>
  8213. Hide or unhide a sheet.
  8214. </summary>
  8215. <param name="sheetIx">The sheet number</param>
  8216. <param name="hidden">0 for not hidden, 1 for hidden, 2 for very hidden</param>
  8217. </member>
  8218. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.OnDeleteFormula(NPOI.XSSF.UserModel.XSSFCell)">
  8219. Fired when a formula is deleted from this workbook,
  8220. for example when calling cell.SetCellFormula(null)
  8221. @see XSSFCell#setCellFormula(String)
  8222. </member>
  8223. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCalculationChain">
  8224. Return the CalculationChain object for this workbook
  8225. <p>
  8226. The calculation chain object specifies the order in which the cells in a workbook were last calculated
  8227. </p>
  8228. @return the <code>CalculationChain</code> object or <code>null</code> if not defined
  8229. </member>
  8230. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.ExternalLinksTable">
  8231. * Returns the list of {@link ExternalLinksTable} object for this workbook
  8232. *
  8233. * <p>The external links table specifies details of named ranges etc
  8234. * that are referenced from other workbooks, along with the last seen
  8235. * values of what they point to.</p>
  8236. *
  8237. * <p>Note that Excel uses index 0 for the current workbook, so the first
  8238. * External Links in a formula would be '[1]Foo' which corresponds to
  8239. * entry 0 in this list.</p>
  8240. * @return the <code>ExternalLinksTable</code> list, which may be empty
  8241. </member>
  8242. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCustomXMLMappings">
  8243. @return a collection of custom XML mappings defined in this workbook
  8244. </member>
  8245. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetMapInfo">
  8246. @return the helper class used to query the custom XML mapping defined in this workbook
  8247. </member>
  8248. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.LinkExternalWorkbook(System.String,NPOI.SS.UserModel.IWorkbook)">
  8249. Adds the External Link Table part and relations required to allow formulas
  8250. referencing the specified external workbook to be added to this one. Allows
  8251. formulas such as "[MyOtherWorkbook.xlsx]Sheet3!$A$5" to be added to the
  8252. file, for workbooks not already linked / referenced.
  8253. @param name The name the workbook will be referenced as in formulas
  8254. @param workbook The open workbook to fetch the link required information from
  8255. </member>
  8256. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsStructureLocked">
  8257. Specifies a bool value that indicates whether structure of workbook is locked. <br/>
  8258. A value true indicates the structure of the workbook is locked. Worksheets in the workbook can't be Moved,
  8259. deleted, hidden, unhidden, or Renamed, and new worksheets can't be inserted.<br/>
  8260. A value of false indicates the structure of the workbook is not locked.<br/>
  8261. @return true if structure of workbook is locked
  8262. </member>
  8263. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsWindowsLocked">
  8264. Specifies a bool value that indicates whether the windows that comprise the workbook are locked. <br/>
  8265. A value of true indicates the workbook windows are locked. Windows are the same size and position each time the
  8266. workbook is opened.<br/>
  8267. A value of false indicates the workbook windows are not locked.
  8268. @return true if windows that comprise the workbook are locked
  8269. </member>
  8270. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsRevisionLocked">
  8271. Specifies a bool value that indicates whether the workbook is locked for revisions.
  8272. @return true if the workbook is locked for revisions.
  8273. </member>
  8274. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.LockStructure">
  8275. Locks the structure of workbook.
  8276. </member>
  8277. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.UnlockStructure">
  8278. Unlocks the structure of workbook.
  8279. </member>
  8280. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.LockWindows">
  8281. Locks the windows that comprise the workbook.
  8282. </member>
  8283. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.UnlockWindows">
  8284. Unlocks the windows that comprise the workbook.
  8285. </member>
  8286. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.LockRevision">
  8287. Locks the workbook for revisions.
  8288. </member>
  8289. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.UnlockRevision">
  8290. Unlocks the workbook for revisions.
  8291. </member>
  8292. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.RemovePivotTables">
  8293. Remove Pivot Tables and PivotCaches from the workbooka
  8294. </member>
  8295. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetUDFFinder">
  8296. Returns the locator of user-defined functions.
  8297. <p>
  8298. The default instance : the built-in functions with the Excel Analysis Tool Pack.
  8299. To Set / Evaluate custom functions you need to register them as follows:
  8300. </p>
  8301. @return wrapped instance of UDFFinder that allows seeking functions both by index and name
  8302. </member>
  8303. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.AddToolPack(NPOI.SS.Formula.UDF.UDFFinder)">
  8304. Register a new toolpack in this workbook.
  8305. @param toopack the toolpack to register
  8306. </member>
  8307. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetForceFormulaRecalculation(System.Boolean)">
  8308. Whether the application shall perform a full recalculation when the workbook is opened.
  8309. <p>
  8310. Typically you want to force formula recalculation when you modify cell formulas or values
  8311. of a workbook previously Created by Excel. When Set to true, this flag will tell Excel
  8312. that it needs to recalculate all formulas in the workbook the next time the file is opened.
  8313. </p>
  8314. <p>
  8315. Note, that recalculation updates cached formula results and, thus, modifies the workbook.
  8316. Depending on the version, Excel may prompt you with "Do you want to save the Changes in <em>filename</em>?"
  8317. on close.
  8318. </p>
  8319. @param value true if the application will perform a full recalculation of
  8320. workbook values when the workbook is opened
  8321. @since 3.8
  8322. </member>
  8323. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetForceFormulaRecalculation">
  8324. Whether Excel will be asked to recalculate all formulas when the workbook is opened.
  8325. @since 3.8
  8326. </member>
  8327. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.SpreadsheetVersion">
  8328. <summary>
  8329. Returns the spreadsheet version (EXCLE2007) of this workbook
  8330. </summary>
  8331. </member>
  8332. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetTable(System.String)">
  8333. Returns the data table with the given name (case insensitive).
  8334. @param name the data table name (case-insensitive)
  8335. @return The Data table in the workbook named <tt>name</tt>, or <tt>null</tt> if no table is named <tt>name</tt>.
  8336. @since 3.15 beta 2
  8337. </member>
  8338. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.AddPivotCache(System.String)">
  8339. Add pivotCache to the workbook
  8340. </member>
  8341. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetVBAProject(System.IO.Stream)">
  8342. Adds a vbaProject.bin file to the workbook. This will change the workbook
  8343. type if necessary.
  8344. @throws IOException
  8345. </member>
  8346. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetVBAProject(NPOI.XSSF.UserModel.XSSFWorkbook)">
  8347. Adds a vbaProject.bin file taken from another, given workbook to this one.
  8348. @throws IOException
  8349. @throws InvalidFormatException
  8350. </member>
  8351. <member name="T:NPOI.XSSF.Util.EvilUnclosedBRFixingInputStream">
  8352. This is a seriously sick fix for the fact that some .xlsx
  8353. files contain raw bits of HTML, without being escaped
  8354. or properly turned into XML.
  8355. The result is that they contain things like &gt;br&lt;,
  8356. which breaks the XML parsing.
  8357. This very sick InputStream wrapper attempts to spot
  8358. these go past, and fix them.
  8359. Only works for UTF-8 and US-ASCII based streams!
  8360. It should only be used where experience Shows the problem
  8361. can occur...
  8362. </member>
  8363. <member name="M:NPOI.XSSF.Util.EvilUnclosedBRFixingInputStream.Read">
  8364. Warning - doesn't fix!
  8365. </member>
  8366. <member name="M:NPOI.XSSF.Util.EvilUnclosedBRFixingInputStream.ReadFromSpare(System.Byte[],System.Int32,System.Int32)">
  8367. Reads into the buffer from the spare bytes
  8368. </member>
  8369. <member name="T:NPOI.XSSF.XLSBUnsupportedException">
  8370. We don't support .xlsb files, sorry
  8371. </member>
  8372. <member name="M:NPOI.OOXML.XSSF.UserModel.Helpers.XSSFRowColShifter.UpdateNamedRanges(NPOI.SS.UserModel.ISheet,NPOI.SS.Formula.FormulaShifter)">
  8373. <summary>
  8374. Updated named ranges
  8375. </summary>
  8376. <param name="shifter"></param>
  8377. </member>
  8378. <member name="M:NPOI.OOXML.XSSF.UserModel.Helpers.XSSFRowColShifter.UpdateFormulas(NPOI.SS.UserModel.ISheet,NPOI.SS.Formula.FormulaShifter)">
  8379. <summary>
  8380. Update formulas.
  8381. </summary>
  8382. <param name="sheet"></param>
  8383. <param name="shifter"></param>
  8384. </member>
  8385. <member name="M:NPOI.OOXML.XSSF.UserModel.Helpers.XSSFRowColShifter.UpdateRowFormulas(NPOI.SS.UserModel.IRow,NPOI.SS.Formula.FormulaShifter)">
  8386. <summary>
  8387. Update the formulas in specified row using the formula shifting
  8388. policy specified by shifter
  8389. </summary>
  8390. <param name="row">the row to update the formulas on</param>
  8391. <param name="Shifter">the formula shifting policy</param>
  8392. </member>
  8393. <member name="M:NPOI.OOXML.XSSF.UserModel.Helpers.XSSFRowColShifter.ShiftFormula(NPOI.SS.UserModel.IRow,System.String,NPOI.SS.Formula.FormulaShifter)">
  8394. <summary>
  8395. Shift a formula using the supplied FormulaShifter
  8396. </summary>
  8397. <param name="row"> the row of the cell this formula belongs to.
  8398. Used to get a reference to the parent workbook.</param>
  8399. <param name="formula">the formula to shift</param>
  8400. <param name="Shifter">the FormulaShifter object that operates on
  8401. the Parsed formula tokens</param>
  8402. <returns>the Shifted formula if the formula was changed, null if
  8403. the formula wasn't modified</returns>
  8404. </member>
  8405. <member name="M:NPOI.OOXML.XSSF.UserModel.Helpers.XSSFRowColShifter.UpdateHyperlinks(NPOI.SS.UserModel.ISheet,NPOI.SS.Formula.FormulaShifter)">
  8406. <summary>
  8407. Shift the Hyperlink anchors(not the hyperlink text, even if the hyperlink is of type LINK_DOCUMENT and refers to a cell that was shifted). Hyperlinks do not track the content they point to.
  8408. </summary>
  8409. <param name="sheet"></param>
  8410. <param name="shifter"></param>
  8411. </member>
  8412. <member name="M:NPOI.OOXML.XWPF.Util.DocumentStylesBuilder.AddDefaultStyle">
  8413. <summary>
  8414. Sets default font, size for text in the document.
  8415. </summary>
  8416. </member>
  8417. <!-- Badly formed XML comment ignored for member "M:NPOI.OOXML.XWPF.Util.DocumentStylesBuilder.BuildStylesForTOC(NPOI.XWPF.UserModel.XWPFDocument)" -->
  8418. <member name="T:NPOI.XWPF.Extractor.XWPFWordExtractor">
  8419. Helper class to extract text from an OOXML Word file
  8420. </member>
  8421. <member name="M:NPOI.XWPF.Extractor.XWPFWordExtractor.SetFetchHyperlinks(System.Boolean)">
  8422. Should we also fetch the hyperlinks, when fetching
  8423. the text content? Default is to only output the
  8424. hyperlink label, and not the contents
  8425. </member>
  8426. <member name="T:NPOI.XWPF.Model.XMLParagraph">
  8427. Base class for XWPF paragraphs
  8428. @author Yury Batrakov (batrakov at gmail.com)
  8429. </member>
  8430. <member name="T:NPOI.XWPF.Model.XWPFCommentsDecorator">
  8431. Decorator class for XWPFParagraph allowing to add comments
  8432. found in paragraph to its text
  8433. @author Yury Batrakov (batrakov at gmail.com)
  8434. </member>
  8435. <member name="T:NPOI.XWPF.Model.XWPFHeaderFooterPolicy">
  8436. A .docx file can have no headers/footers, the same header/footer
  8437. on each page, odd/even page footers, and optionally also
  8438. a different header/footer on the first page.
  8439. This class handles sorting out what there is, and giving you
  8440. the right headers and footers for the document.
  8441. </member>
  8442. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.#ctor(NPOI.XWPF.UserModel.XWPFDocument)">
  8443. Figures out the policy for the given document,
  8444. and Creates any header and footer objects
  8445. as required.
  8446. </member>
  8447. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.#ctor(NPOI.XWPF.UserModel.XWPFDocument,NPOI.OpenXmlFormats.Wordprocessing.CT_SectPr)">
  8448. Figures out the policy for the given document,
  8449. and Creates any header and footer objects
  8450. as required.
  8451. </member>
  8452. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.buildHdrFtr(System.String,NPOI.XWPF.UserModel.XWPFParagraph[],NPOI.XWPF.UserModel.XWPFHeaderFooter)">
  8453. MB 24 May 2010. Created this overloaded buildHdrFtr() method because testing demonstrated
  8454. that the XWPFFooter or XWPFHeader object returned by calls to the CreateHeader(int, XWPFParagraph[])
  8455. and CreateFooter(int, XWPFParagraph[]) methods or the GetXXXXXHeader/Footer methods where
  8456. headers or footers had been Added to a document since it had been Created/opened, returned
  8457. an object that Contained no XWPFParagraph objects even if the header/footer itself did contain
  8458. text. The reason was that this line of code; CTHdrFtr ftr = CTHdrFtr.Factory.NewInstance();
  8459. Created a brand new instance of the CTHDRFtr class which was then populated with data when
  8460. it should have recovered the CTHdrFtr object encapsulated within the XWPFHeaderFooter object
  8461. that had previoulsy been instantiated in the CreateHeader(int, XWPFParagraph[]) or
  8462. CreateFooter(int, XWPFParagraph[]) methods.
  8463. </member>
  8464. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.GetOddPageHeader">
  8465. Returns the odd page header. This is
  8466. also the same as the default one...
  8467. </member>
  8468. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.GetOddPageFooter">
  8469. Returns the odd page footer. This is
  8470. also the same as the default one...
  8471. </member>
  8472. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.GetHeader(System.Int32)">
  8473. Get the header that applies to the given
  8474. (1 based) page.
  8475. @param pageNumber The one based page number
  8476. </member>
  8477. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.GetFooter(System.Int32)">
  8478. Get the footer that applies to the given
  8479. (1 based) page.
  8480. @param pageNumber The one based page number
  8481. </member>
  8482. <member name="T:NPOI.XWPF.Model.XWPFParagraphDecorator">
  8483. Base decorator class for XWPFParagraph
  8484. </member>
  8485. <member name="T:NPOI.XWPF.UserModel.AbstractXWPFSDT">
  8486. Experimental abstract class that is a base for XWPFSDT and XWPFSDTCell
  8487. <p/>
  8488. WARNING - APIs expected to change rapidly.
  8489. <p/>
  8490. These classes have so far been built only for Read-only Processing.
  8491. </member>
  8492. <member name="M:NPOI.XWPF.UserModel.AbstractXWPFSDT.GetTitle">
  8493. @return first SDT Title
  8494. </member>
  8495. <member name="M:NPOI.XWPF.UserModel.AbstractXWPFSDT.GetTag">
  8496. @return first SDT Tag
  8497. </member>
  8498. <member name="P:NPOI.XWPF.UserModel.AbstractXWPFSDT.Content">
  8499. @return the content object
  8500. </member>
  8501. <member name="M:NPOI.XWPF.UserModel.AbstractXWPFSDT.GetBody">
  8502. @return null
  8503. </member>
  8504. <member name="M:NPOI.XWPF.UserModel.AbstractXWPFSDT.GetPart">
  8505. @return document part
  8506. </member>
  8507. <member name="M:NPOI.XWPF.UserModel.AbstractXWPFSDT.GetPartType">
  8508. @return partType
  8509. </member>
  8510. <member name="M:NPOI.XWPF.UserModel.AbstractXWPFSDT.GetElementType">
  8511. @return element type
  8512. </member>
  8513. <member name="T:NPOI.XWPF.UserModel.BodyElementType">
  8514. <p>
  8515. 9 Jan 2010
  8516. </p>
  8517. <p>
  8518. // TODO insert Javadoc here!
  8519. </p>
  8520. @author epp
  8521. </member>
  8522. <member name="T:NPOI.XWPF.UserModel.BodyType">
  8523. The different kinds of {@link IBody} that exist
  8524. </member>
  8525. <member name="T:NPOI.XWPF.UserModel.Borders">
  8526. Specifies all types of borders which can be specified for WordProcessingML
  8527. objects which have a border. Borders can be Separated into two types:
  8528. <ul>
  8529. <li> Line borders: which specify a pattern to be used when Drawing a line around the
  8530. specified object.
  8531. </li>
  8532. <li> Art borders: which specify a repeated image to be used
  8533. when Drawing a border around the specified object. Line borders may be
  8534. specified on any object which allows a border, however, art borders may only
  8535. be used as a border at the page level - the borders under the pgBorders
  8536. element
  8537. </li>
  8538. </ul>
  8539. @author Gisella Bronzetti
  8540. </member>
  8541. <member name="F:NPOI.XWPF.UserModel.Borders.Single">
  8542. Specifies a line border consisting of a single line around the parent
  8543. object.
  8544. </member>
  8545. <member name="F:NPOI.XWPF.UserModel.Borders.Apples">
  8546. specifies an art border consisting of a repeated image of an apple
  8547. </member>
  8548. <member name="F:NPOI.XWPF.UserModel.Borders.ArchedScallops">
  8549. specifies an art border consisting of a repeated image of a shell pattern
  8550. </member>
  8551. <member name="F:NPOI.XWPF.UserModel.Borders.BabyPacifier">
  8552. specifies an art border consisting of a repeated image of a baby pacifier
  8553. </member>
  8554. <member name="F:NPOI.XWPF.UserModel.Borders.BabyRattle">
  8555. specifies an art border consisting of a repeated image of a baby rattle
  8556. </member>
  8557. <member name="F:NPOI.XWPF.UserModel.Borders.Balloons3Colors">
  8558. specifies an art border consisting of a repeated image of a set of
  8559. balloons
  8560. </member>
  8561. <member name="F:NPOI.XWPF.UserModel.Borders.BalloonsHotAir">
  8562. specifies an art border consisting of a repeated image of a hot air
  8563. balloon
  8564. </member>
  8565. <member name="F:NPOI.XWPF.UserModel.Borders.BasicBlackDashes">
  8566. specifies an art border consisting of a repeating image of a black and
  8567. white background.
  8568. </member>
  8569. <member name="F:NPOI.XWPF.UserModel.Borders.BasicBlackDots">
  8570. specifies an art border consisting of a repeating image of a black dot on
  8571. a white background.
  8572. </member>
  8573. <member name="F:NPOI.XWPF.UserModel.Borders.BasicBlackSquares">
  8574. specifies an art border consisting of a repeating image of a black and
  8575. white background
  8576. </member>
  8577. <member name="F:NPOI.XWPF.UserModel.Borders.BasicThinLines">
  8578. specifies an art border consisting of a repeating image of a black and
  8579. white background.
  8580. </member>
  8581. <member name="F:NPOI.XWPF.UserModel.Borders.BasicWhiteDashes">
  8582. specifies an art border consisting of a repeating image of a black and
  8583. white background.
  8584. </member>
  8585. <member name="F:NPOI.XWPF.UserModel.Borders.BasicWhiteDots">
  8586. specifies an art border consisting of a repeating image of a white dot on
  8587. a black background.
  8588. </member>
  8589. <member name="F:NPOI.XWPF.UserModel.Borders.BasicWhiteSquares">
  8590. specifies an art border consisting of a repeating image of a black and
  8591. white background.
  8592. </member>
  8593. <member name="F:NPOI.XWPF.UserModel.Borders.BasicWideInline">
  8594. specifies an art border consisting of a repeating image of a black and
  8595. white background.
  8596. </member>
  8597. <member name="F:NPOI.XWPF.UserModel.Borders.BasicWideMidline">
  8598. specifies an art border consisting of a repeating image of a black and
  8599. white background
  8600. </member>
  8601. <member name="F:NPOI.XWPF.UserModel.Borders.BasicWideOutline">
  8602. specifies an art border consisting of a repeating image of a black and
  8603. white background
  8604. </member>
  8605. <member name="F:NPOI.XWPF.UserModel.Borders.Bats">
  8606. specifies an art border consisting of a repeated image of bats
  8607. </member>
  8608. <member name="F:NPOI.XWPF.UserModel.Borders.Birds">
  8609. specifies an art border consisting of repeating images of birds
  8610. </member>
  8611. <member name="F:NPOI.XWPF.UserModel.Borders.BirdsFlight">
  8612. specifies an art border consisting of a repeated image of birds flying
  8613. </member>
  8614. <member name="F:NPOI.XWPF.UserModel.Borders.Cabins">
  8615. specifies an art border consisting of a repeated image of a cabin
  8616. </member>
  8617. <member name="F:NPOI.XWPF.UserModel.Borders.CakeSlice">
  8618. specifies an art border consisting of a repeated image of a piece of cake
  8619. </member>
  8620. <member name="F:NPOI.XWPF.UserModel.Borders.CandyCorn">
  8621. specifies an art border consisting of a repeated image of candy corn
  8622. </member>
  8623. <member name="F:NPOI.XWPF.UserModel.Borders.CelticKnotwork">
  8624. specifies an art border consisting of a repeated image of a knot work
  8625. pattern
  8626. </member>
  8627. <member name="F:NPOI.XWPF.UserModel.Borders.CertificateBanner">
  8628. specifies an art border consisting of a banner.
  8629. <p>
  8630. if the border is on the left or right, no border is displayed.
  8631. </p>
  8632. </member>
  8633. <member name="F:NPOI.XWPF.UserModel.Borders.ChainLink">
  8634. specifies an art border consisting of a repeating image of a chain link
  8635. pattern.
  8636. </member>
  8637. <member name="F:NPOI.XWPF.UserModel.Borders.ChampagneBottle">
  8638. specifies an art border consisting of a repeated image of a champagne
  8639. bottle
  8640. </member>
  8641. <member name="F:NPOI.XWPF.UserModel.Borders.CheckedBarBlack">
  8642. specifies an art border consisting of repeating images of a compass
  8643. </member>
  8644. <member name="F:NPOI.XWPF.UserModel.Borders.CheckedBarColor">
  8645. specifies an art border consisting of a repeating image of a colored
  8646. pattern.
  8647. </member>
  8648. <member name="F:NPOI.XWPF.UserModel.Borders.Checkered">
  8649. specifies an art border consisting of a repeated image of a checkerboard
  8650. </member>
  8651. <member name="F:NPOI.XWPF.UserModel.Borders.ChristmasTree">
  8652. specifies an art border consisting of a repeated image of a christmas
  8653. tree
  8654. </member>
  8655. <member name="F:NPOI.XWPF.UserModel.Borders.CirclesLines">
  8656. specifies an art border consisting of repeating images of lines and
  8657. circles
  8658. </member>
  8659. <member name="F:NPOI.XWPF.UserModel.Borders.CirclesRectangles">
  8660. specifies an art border consisting of a repeated image of a rectangular
  8661. pattern
  8662. </member>
  8663. <member name="F:NPOI.XWPF.UserModel.Borders.ClassicalWave">
  8664. specifies an art border consisting of a repeated image of a wave
  8665. </member>
  8666. <member name="F:NPOI.XWPF.UserModel.Borders.Clocks">
  8667. specifies an art border consisting of a repeated image of a clock
  8668. </member>
  8669. <member name="F:NPOI.XWPF.UserModel.Borders.Compass">
  8670. specifies an art border consisting of repeating images of a compass
  8671. </member>
  8672. <member name="F:NPOI.XWPF.UserModel.Borders.Confetti">
  8673. specifies an art border consisting of a repeated image of confetti
  8674. </member>
  8675. <member name="F:NPOI.XWPF.UserModel.Borders.ConfettiGrays">
  8676. specifies an art border consisting of a repeated image of confetti
  8677. </member>
  8678. <member name="F:NPOI.XWPF.UserModel.Borders.ConfettiOutline">
  8679. specifies an art border consisting of a repeated image of confetti
  8680. </member>
  8681. <member name="F:NPOI.XWPF.UserModel.Borders.ConfettiStreamers">
  8682. specifies an art border consisting of a repeated image of confetti
  8683. streamers
  8684. </member>
  8685. <member name="F:NPOI.XWPF.UserModel.Borders.ConfettiWhite">
  8686. specifies an art border consisting of a repeated image of confetti
  8687. </member>
  8688. <member name="F:NPOI.XWPF.UserModel.Borders.CornerTriangles">
  8689. specifies an art border consisting of a repeated image
  8690. </member>
  8691. <member name="F:NPOI.XWPF.UserModel.Borders.CouponCutoutDashes">
  8692. specifies an art border consisting of a dashed line
  8693. </member>
  8694. <member name="F:NPOI.XWPF.UserModel.Borders.CouponCutoutDots">
  8695. specifies an art border consisting of a dotted line
  8696. </member>
  8697. <member name="F:NPOI.XWPF.UserModel.Borders.CrazyMaze">
  8698. specifies an art border consisting of a repeated image of a maze-like
  8699. pattern
  8700. </member>
  8701. <member name="F:NPOI.XWPF.UserModel.Borders.CreaturesButterfly">
  8702. specifies an art border consisting of a repeated image of a butterfly
  8703. </member>
  8704. <member name="F:NPOI.XWPF.UserModel.Borders.CreaturesFish">
  8705. specifies an art border consisting of a repeated image of a fish
  8706. </member>
  8707. <member name="F:NPOI.XWPF.UserModel.Borders.CreaturesInsects">
  8708. specifies an art border consisting of repeating images of insects.
  8709. </member>
  8710. <member name="F:NPOI.XWPF.UserModel.Borders.CreaturesLadyBug">
  8711. specifies an art border consisting of a repeated image of a ladybug
  8712. </member>
  8713. <member name="F:NPOI.XWPF.UserModel.Borders.CrossStitch">
  8714. specifies an art border consisting of repeating images of a cross-stitch
  8715. pattern
  8716. </member>
  8717. <member name="F:NPOI.XWPF.UserModel.Borders.Cup">
  8718. specifies an art border consisting of a repeated image of cupid
  8719. </member>
  8720. <member name="T:NPOI.XWPF.UserModel.BreakClear">
  8721. Specifies the Set of possible restart locations which may be used as to
  8722. determine the next available line when a break's type attribute has a value
  8723. of textWrapping.
  8724. @author Gisella Bronzetti
  8725. </member>
  8726. <member name="F:NPOI.XWPF.UserModel.BreakClear.NONE">
  8727. Specifies that the text wrapping break shall advance the text to the next
  8728. line in the WordProcessingML document, regardless of its position left to
  8729. right or the presence of any floating objects which intersect with the
  8730. line,
  8731. This is the Setting for a typical line break in a document.
  8732. </member>
  8733. <member name="F:NPOI.XWPF.UserModel.BreakClear.LEFT">
  8734. Specifies that the text wrapping break shall behave as follows:
  8735. <ul>
  8736. <li> If this line is broken into multiple regions (a floating object in
  8737. the center of the page has text wrapping on both sides:
  8738. <ul>
  8739. <li> If this is the leftmost region of text flow on this line, advance
  8740. the text to the next position on the line </li>
  8741. <li>Otherwise, treat this as a text wrapping break of type all. </li>
  8742. </ul>
  8743. </li>
  8744. <li> If this line is not broken into multiple regions, then treat this
  8745. break as a text wrapping break of type none. </li>
  8746. </ul>
  8747. <li> If the parent paragraph is right to left, then these behaviors are
  8748. also reversed. </li>
  8749. </member>
  8750. <!-- Badly formed XML comment ignored for member "F:NPOI.XWPF.UserModel.BreakClear.RIGHT" -->
  8751. <member name="F:NPOI.XWPF.UserModel.BreakClear.ALL">
  8752. Specifies that the text wrapping break shall advance the text to the next
  8753. line in the WordProcessingML document which spans the full width of the
  8754. line.
  8755. </member>
  8756. <member name="T:NPOI.XWPF.UserModel.BreakType">
  8757. Specifies the possible types of break characters in a WordProcessingML
  8758. document.
  8759. The break type determines the next location where text shall be
  8760. placed After this manual break is applied to the text contents
  8761. @author Gisella Bronzetti
  8762. </member>
  8763. <member name="F:NPOI.XWPF.UserModel.BreakType.PAGE">
  8764. Specifies that the current break shall restart itself on the next page of
  8765. the document when the document is displayed in page view.
  8766. </member>
  8767. <member name="F:NPOI.XWPF.UserModel.BreakType.COLUMN">
  8768. Specifies that the current break shall restart itself on the next column
  8769. available on the current page when the document is displayed in page
  8770. view.
  8771. <p>
  8772. If the current section is not divided into columns, or the column break
  8773. occurs in the last column on the current page when displayed, then the
  8774. restart location for text shall be the next page in the document.
  8775. </p>
  8776. </member>
  8777. <member name="F:NPOI.XWPF.UserModel.BreakType.TEXTWRAPPING">
  8778. Specifies that the current break shall restart itself on the next line in
  8779. the document when the document is displayed in page view.
  8780. The determine of the next line shall be done subject to the value of the clear
  8781. attribute on the specified break character.
  8782. </member>
  8783. <member name="F:NPOI.XWPF.UserModel.PictureType.EMF">
  8784. Extended windows meta file
  8785. </member>
  8786. <member name="F:NPOI.XWPF.UserModel.PictureType.WMF">
  8787. Windows Meta File
  8788. </member>
  8789. <member name="F:NPOI.XWPF.UserModel.PictureType.PICT">
  8790. Mac PICT format
  8791. </member>
  8792. <member name="F:NPOI.XWPF.UserModel.PictureType.JPEG">
  8793. JPEG format
  8794. </member>
  8795. <member name="F:NPOI.XWPF.UserModel.PictureType.PNG">
  8796. PNG format
  8797. </member>
  8798. <member name="F:NPOI.XWPF.UserModel.PictureType.DIB">
  8799. Device independent bitmap
  8800. </member>
  8801. <member name="F:NPOI.XWPF.UserModel.PictureType.GIF">
  8802. GIF image format
  8803. </member>
  8804. <member name="F:NPOI.XWPF.UserModel.PictureType.TIFF">
  8805. Tag Image File (.tiff)
  8806. </member>
  8807. <member name="F:NPOI.XWPF.UserModel.PictureType.EPS">
  8808. Encapsulated Postscript (.eps)
  8809. </member>
  8810. <member name="F:NPOI.XWPF.UserModel.PictureType.BMP">
  8811. Windows Bitmap (.bmp)
  8812. </member>
  8813. <member name="F:NPOI.XWPF.UserModel.PictureType.WPG">
  8814. WordPerfect graphics (.wpg)
  8815. </member>
  8816. <member name="F:NPOI.XWPF.UserModel.PictureType.SVG">
  8817. Scalable Vector Graphics (.svg)
  8818. </member>
  8819. <member name="T:NPOI.XWPF.UserModel.IBody">
  8820. An IBody represents the different parts of the document which
  8821. can contain collections of Paragraphs and Tables. It provides a
  8822. common way to work with these and their contents.
  8823. Typically, this is something like a XWPFDocument, or one of
  8824. the parts in it like XWPFHeader, XWPFFooter, XWPFTableCell
  8825. </member>
  8826. <member name="P:NPOI.XWPF.UserModel.IBody.Part">
  8827. returns the Part, to which the body belongs, which you need for Adding relationship to other parts
  8828. Actually it is needed of the class XWPFTableCell. Because you have to know to which part the tableCell
  8829. belongs.
  8830. @return the Part, to which the body belongs
  8831. </member>
  8832. <member name="P:NPOI.XWPF.UserModel.IBody.PartType">
  8833. Get the PartType of the body, for example
  8834. DOCUMENT, HEADER, FOOTER, FOOTNOTE,
  8835. @return the PartType of the body
  8836. </member>
  8837. <member name="P:NPOI.XWPF.UserModel.IBody.BodyElements">
  8838. Returns an Iterator with paragraphs and tables,
  8839. in the order that they occur in the text.
  8840. </member>
  8841. <member name="P:NPOI.XWPF.UserModel.IBody.Paragraphs">
  8842. Returns the paragraph(s) that holds
  8843. the text of the header or footer.
  8844. </member>
  8845. <member name="P:NPOI.XWPF.UserModel.IBody.Tables">
  8846. Return the table(s) that holds the text
  8847. of the IBodyPart, for complex cases
  8848. where a paragraph isn't used.
  8849. </member>
  8850. <member name="M:NPOI.XWPF.UserModel.IBody.GetParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  8851. if there is a corresponding {@link XWPFParagraph} of the parameter ctTable in the paragraphList of this header or footer
  8852. the method will return this paragraph
  8853. if there is no corresponding {@link XWPFParagraph} the method will return null
  8854. @param p is instance of CTP and is searching for an XWPFParagraph
  8855. @return null if there is no XWPFParagraph with an corresponding CTPparagraph in the paragraphList of this header or footer
  8856. XWPFParagraph with the correspondig CTP p
  8857. </member>
  8858. <member name="M:NPOI.XWPF.UserModel.IBody.GetTable(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  8859. if there is a corresponding {@link XWPFTable} of the parameter ctTable in the tableList of this header
  8860. the method will return this table
  8861. if there is no corresponding {@link XWPFTable} the method will return null
  8862. @param ctTable
  8863. </member>
  8864. <member name="M:NPOI.XWPF.UserModel.IBody.GetParagraphArray(System.Int32)">
  8865. Returns the paragraph that of position pos
  8866. </member>
  8867. <member name="M:NPOI.XWPF.UserModel.IBody.GetTableArray(System.Int32)">
  8868. Returns the table at position pos
  8869. </member>
  8870. <member name="M:NPOI.XWPF.UserModel.IBody.InsertNewParagraph(System.Xml.XmlDocument)">
  8871. inserts a new paragraph at position of the cursor
  8872. @param cursor
  8873. </member>
  8874. <member name="M:NPOI.XWPF.UserModel.IBody.InsertNewTbl(System.Xml.XmlDocument)">
  8875. inserts a new Table at the cursor position.
  8876. @param cursor
  8877. </member>
  8878. <member name="M:NPOI.XWPF.UserModel.IBody.InsertTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  8879. inserts a new Table at position pos
  8880. @param pos
  8881. @param table
  8882. </member>
  8883. <member name="M:NPOI.XWPF.UserModel.IBody.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  8884. returns the TableCell to which the Table belongs
  8885. @param cell
  8886. </member>
  8887. <member name="M:NPOI.XWPF.UserModel.IBody.GetXWPFDocument">
  8888. Return XWPFDocument
  8889. </member>
  8890. <member name="T:NPOI.XWPF.UserModel.IBodyElement">
  8891. 9 Jan 2010
  8892. @author Philipp Epp
  8893. </member>
  8894. <!-- Badly formed XML comment ignored for member "T:NPOI.XWPF.UserModel.ICell" -->
  8895. <member name="T:NPOI.XWPF.UserModel.IRunBody">
  8896. Simple interface describing both {@link XWPFParagraph}
  8897. and {@link XWPFSDT}
  8898. </member>
  8899. <member name="T:NPOI.XWPF.UserModel.IRunElement">
  8900. Common interface for things that can occur
  8901. where a run (text with common stylings) can,
  8902. eg {@link XWPFRun} or {@link XWPFSDT}.
  8903. More methods to follow shortly!
  8904. </member>
  8905. <member name="T:NPOI.XWPF.UserModel.ISDTContent">
  8906. Experimental interface to offer rudimentary Read-only Processing of
  8907. of the contentblock of an SDT/ContentControl.
  8908. <p/>
  8909. <p/>
  8910. <p/>
  8911. WARNING - APIs expected to change rapidly
  8912. </member>
  8913. <member name="T:NPOI.XWPF.UserModel.ISDTContents">
  8914. Interface for anything that can be within an STD:
  8915. {@link XWPFRun}, {@link XWPFTable}, {@link XWPFParagraph},
  8916. {@link XWPFSDT} etc
  8917. </member>
  8918. <member name="T:NPOI.XWPF.UserModel.LineSpacingRule">
  8919. Specifies the logic which shall be used to calculate the line spacing of the
  8920. parent object when it is displayed in the document.
  8921. @author Gisella Bronzetti
  8922. </member>
  8923. <member name="F:NPOI.XWPF.UserModel.LineSpacingRule.AUTO">
  8924. Specifies that the line spacing of the parent object shall be
  8925. automatically determined by the size of its contents, with no
  8926. predetermined minimum or maximum size.
  8927. </member>
  8928. <member name="F:NPOI.XWPF.UserModel.LineSpacingRule.EXACT">
  8929. Specifies that the height of the line shall be exactly the value
  8930. specified, regardless of the size of the contents If the contents are too
  8931. large for the specified height, then they shall be clipped as necessary.
  8932. </member>
  8933. <member name="F:NPOI.XWPF.UserModel.LineSpacingRule.ATLEAST">
  8934. Specifies that the height of the line shall be at least the value
  8935. specified, but may be expanded to fit its content as needed.
  8936. </member>
  8937. <member name="T:NPOI.XWPF.UserModel.ParagraphAlignment">
  8938. Specifies all types of alignment which are available to be applied to objects in a
  8939. WordProcessingML document
  8940. @author Yegor Kozlov
  8941. </member>
  8942. <member name="T:NPOI.XWPF.UserModel.PositionInParagraph">
  8943. * postion of a character in a paragrapho
  8944. * 1st RunPositon
  8945. * 2nd TextPosition
  8946. * 3rd CharacterPosition
  8947. *
  8948. *
  8949. </member>
  8950. <member name="T:NPOI.XWPF.UserModel.TextAlignment">
  8951. Specifies all types of vertical alignment which are available to be applied to of all text
  8952. on each line displayed within a paragraph.
  8953. @author Gisella Bronzetti
  8954. </member>
  8955. <member name="F:NPOI.XWPF.UserModel.TextAlignment.TOP">
  8956. Specifies that all text in the parent object shall be
  8957. aligned to the top of each character when displayed
  8958. </member>
  8959. <member name="F:NPOI.XWPF.UserModel.TextAlignment.CENTER">
  8960. Specifies that all text in the parent object shall be
  8961. aligned to the center of each character when displayed.
  8962. </member>
  8963. <member name="F:NPOI.XWPF.UserModel.TextAlignment.BASELINE">
  8964. Specifies that all text in the parent object shall be
  8965. aligned to the baseline of each character when displayed.
  8966. </member>
  8967. <member name="F:NPOI.XWPF.UserModel.TextAlignment.BOTTOM">
  8968. Specifies that all text in the parent object shall be
  8969. aligned to the bottom of each character when displayed.
  8970. </member>
  8971. <member name="F:NPOI.XWPF.UserModel.TextAlignment.AUTO">
  8972. Specifies that all text in the parent object shall be
  8973. aligned automatically when displayed.
  8974. </member>
  8975. <member name="T:NPOI.XWPF.UserModel.TextSegment">
  8976. saves the begin and end position of a text in a Paragraph
  8977. </member>
  8978. <member name="P:NPOI.XWPF.UserModel.TextSegment.BeginRun">
  8979. <summary>
  8980. The index of the start run
  8981. </summary>
  8982. </member>
  8983. <member name="P:NPOI.XWPF.UserModel.TextSegment.BeginText">
  8984. <summary>
  8985. The index of the start CT_Text
  8986. </summary>
  8987. </member>
  8988. <member name="P:NPOI.XWPF.UserModel.TextSegment.BeginChar">
  8989. <summary>
  8990. The index of the start text character
  8991. </summary>
  8992. </member>
  8993. <member name="P:NPOI.XWPF.UserModel.TextSegment.EndText">
  8994. <summary>
  8995. the index of the end CT_Text
  8996. </summary>
  8997. </member>
  8998. <member name="P:NPOI.XWPF.UserModel.TextSegment.EndChar">
  8999. <summary>
  9000. the index of the end text character
  9001. </summary>
  9002. </member>
  9003. <member name="T:NPOI.XWPF.UserModel.UnderlinePatterns">
  9004. Specifies the types of patterns which may be used to create the underline
  9005. applied beneath the text in a Run.
  9006. @author Gisella Bronzetti
  9007. </member>
  9008. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Single">
  9009. Specifies an underline consisting of a single line beneath all characters
  9010. in this Run.
  9011. </member>
  9012. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Words">
  9013. Specifies an underline consisting of a single line beneath all non-space
  9014. characters in the Run. There shall be no underline beneath any space
  9015. character (breaking or non-breaking).
  9016. </member>
  9017. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Double">
  9018. Specifies an underline consisting of two lines beneath all characters in
  9019. this run
  9020. </member>
  9021. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Thick">
  9022. Specifies an underline consisting of a single thick line beneath all
  9023. characters in this Run.
  9024. </member>
  9025. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Dotted">
  9026. Specifies an underline consisting of a series of dot characters beneath
  9027. all characters in this Run.
  9028. </member>
  9029. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DottedHeavy">
  9030. Specifies an underline consisting of a series of thick dot characters
  9031. beneath all characters in this Run.
  9032. </member>
  9033. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Dash">
  9034. Specifies an underline consisting of a dashed line beneath all characters
  9035. in this Run.
  9036. </member>
  9037. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DashedHeavy">
  9038. Specifies an underline consisting of a series of thick dashes beneath all
  9039. characters in this Run.
  9040. </member>
  9041. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DashLong">
  9042. Specifies an underline consisting of long dashed characters beneath all
  9043. characters in this Run.
  9044. </member>
  9045. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DashLongHeavy">
  9046. Specifies an underline consisting of thick long dashed characters beneath
  9047. all characters in this Run.
  9048. </member>
  9049. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DotDash">
  9050. Specifies an underline consisting of a series of dash, dot characters
  9051. beneath all characters in this Run.
  9052. </member>
  9053. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DashDotHeavy">
  9054. Specifies an underline consisting of a series of thick dash, dot
  9055. characters beneath all characters in this Run.
  9056. </member>
  9057. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DotDotDash">
  9058. Specifies an underline consisting of a series of dash, dot, dot
  9059. characters beneath all characters in this Run.
  9060. </member>
  9061. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DashDotDotHeavy">
  9062. Specifies an underline consisting of a series of thick dash, dot, dot
  9063. characters beneath all characters in this Run.
  9064. </member>
  9065. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Wave">
  9066. Specifies an underline consisting of a single wavy line beneath all
  9067. characters in this Run.
  9068. </member>
  9069. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.WavyHeavy">
  9070. Specifies an underline consisting of a single thick wavy line beneath all
  9071. characters in this Run.
  9072. </member>
  9073. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.WavyDouble">
  9074. Specifies an underline consisting of a pair of wavy lines beneath all
  9075. characters in this Run.
  9076. </member>
  9077. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.None">
  9078. Specifies no underline beneath this Run.
  9079. </member>
  9080. <member name="T:NPOI.XWPF.UserModel.VerticalAlign">
  9081. Specifies possible values for the alignment of the contents of this run in
  9082. relation to the default appearance of the Run's text. This allows the text to
  9083. be repositioned as subscript or superscript without altering the font size of
  9084. the run properties.
  9085. @author Gisella Bronzetti
  9086. </member>
  9087. <member name="F:NPOI.XWPF.UserModel.VerticalAlign.BASELINE">
  9088. Specifies that the text in the parent run shall be located at the
  9089. baseline and presented in the same size as surrounding text.
  9090. </member>
  9091. <member name="F:NPOI.XWPF.UserModel.VerticalAlign.SUPERSCRIPT">
  9092. Specifies that this text should be subscript. This Setting shall lower
  9093. the text in this run below the baseline and change it to a smaller size,
  9094. if a smaller size is available.
  9095. </member>
  9096. <member name="F:NPOI.XWPF.UserModel.VerticalAlign.SUBSCRIPT">
  9097. Specifies that this text should be superscript. This Setting shall raise
  9098. the text in this run above the baseline and change it to a smaller size,
  9099. if a smaller size is available.
  9100. </member>
  9101. <member name="T:NPOI.XWPF.UserModel.XWPFAbstractNum">
  9102. @author Philipp Epp
  9103. </member>
  9104. <member name="P:NPOI.XWPF.UserModel.XWPFAbstractNum.MultiLevelType">
  9105. <summary>
  9106. Abstract Numbering Definition Type
  9107. </summary>
  9108. </member>
  9109. <member name="T:NPOI.XWPF.UserModel.MultiLevelType">
  9110. <summary>
  9111. Numbering Definition Type
  9112. </summary>
  9113. </member>
  9114. <member name="F:NPOI.XWPF.UserModel.MultiLevelType.SingleLevel">
  9115. <summary>
  9116. Single Level Numbering Definition
  9117. </summary>
  9118. </member>
  9119. <member name="F:NPOI.XWPF.UserModel.MultiLevelType.Multilevel">
  9120. <summary>
  9121. Multilevel Numbering Definition
  9122. </summary>
  9123. </member>
  9124. <member name="F:NPOI.XWPF.UserModel.MultiLevelType.HybridMultilevel">
  9125. <summary>
  9126. Hybrid Multilevel Numbering Definition
  9127. </summary>
  9128. </member>
  9129. <member name="T:NPOI.XWPF.UserModel.NumberFormat">
  9130. <summary>
  9131. Numbering Format
  9132. </summary>
  9133. </member>
  9134. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Decimal">
  9135. <summary>
  9136. Decimal Numbers
  9137. </summary>
  9138. </member>
  9139. <member name="F:NPOI.XWPF.UserModel.NumberFormat.UpperRoman">
  9140. <summary>
  9141. Uppercase Roman Numerals
  9142. </summary>
  9143. </member>
  9144. <member name="F:NPOI.XWPF.UserModel.NumberFormat.LowerRoman">
  9145. <summary>
  9146. Lowercase Roman Numerals
  9147. </summary>
  9148. </member>
  9149. <member name="F:NPOI.XWPF.UserModel.NumberFormat.UpperLetter">
  9150. <summary>
  9151. Uppercase Latin Alphabet
  9152. </summary>
  9153. </member>
  9154. <member name="F:NPOI.XWPF.UserModel.NumberFormat.LowerLetter">
  9155. <summary>
  9156. Lowercase Latin Alphabet
  9157. </summary>
  9158. </member>
  9159. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Ordinal">
  9160. <summary>
  9161. Ordinal
  9162. </summary>
  9163. </member>
  9164. <member name="F:NPOI.XWPF.UserModel.NumberFormat.CardinalText">
  9165. <summary>
  9166. Cardinal Text
  9167. </summary>
  9168. </member>
  9169. <member name="F:NPOI.XWPF.UserModel.NumberFormat.OrdinalText">
  9170. <summary>
  9171. Ordinal Text
  9172. </summary>
  9173. </member>
  9174. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Hex">
  9175. <summary>
  9176. Hexadecimal Numbering
  9177. </summary>
  9178. </member>
  9179. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Chicago">
  9180. <summary>
  9181. Chicago Manual of Style
  9182. </summary>
  9183. </member>
  9184. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographDigital">
  9185. <summary>
  9186. Ideographs
  9187. </summary>
  9188. </member>
  9189. <member name="F:NPOI.XWPF.UserModel.NumberFormat.JapaneseCounting">
  9190. <summary>
  9191. Japanese Counting System
  9192. </summary>
  9193. </member>
  9194. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Aiueo">
  9195. <summary>
  9196. AIUEO Order Hiragana
  9197. </summary>
  9198. </member>
  9199. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Iroha">
  9200. <summary>
  9201. Iroha Ordered Katakana
  9202. </summary>
  9203. </member>
  9204. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalFullWidth">
  9205. <summary>
  9206. Double Byte Arabic Numerals
  9207. </summary>
  9208. </member>
  9209. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalHalfWidth">
  9210. <summary>
  9211. Single Byte Arabic Numerals
  9212. </summary>
  9213. </member>
  9214. <member name="F:NPOI.XWPF.UserModel.NumberFormat.JapaneseLegal">
  9215. <summary>
  9216. Japanese Legal Numbering
  9217. </summary>
  9218. </member>
  9219. <member name="F:NPOI.XWPF.UserModel.NumberFormat.JapaneseDigitalTenThousand">
  9220. <summary>
  9221. Japanese Digital Ten Thousand Counting System
  9222. </summary>
  9223. </member>
  9224. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalEnclosedCircle">
  9225. <summary>
  9226. Decimal Numbers Enclosed in a Circle
  9227. </summary>
  9228. </member>
  9229. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalFullWidth2">
  9230. <summary>
  9231. Double Byte Arabic Numerals Alternate
  9232. </summary>
  9233. </member>
  9234. <member name="F:NPOI.XWPF.UserModel.NumberFormat.AiueoFullWidth">
  9235. <summary>
  9236. Full-Width AIUEO Order Hiragana
  9237. </summary>
  9238. </member>
  9239. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IrohaFullWidth">
  9240. <summary>
  9241. Full-Width Iroha Ordered Katakana
  9242. </summary>
  9243. </member>
  9244. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalZero">
  9245. <summary>
  9246. Initial Zero Arabic Numerals
  9247. </summary>
  9248. </member>
  9249. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Bullet">
  9250. <summary>
  9251. Bullet
  9252. </summary>
  9253. </member>
  9254. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Ganada">
  9255. <summary>
  9256. Korean Ganada Numbering
  9257. </summary>
  9258. </member>
  9259. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Chosung">
  9260. <summary>
  9261. Korean Chosung Numbering
  9262. </summary>
  9263. </member>
  9264. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalEnclosedFullstop">
  9265. <summary>
  9266. Decimal Numbers Followed by a Period
  9267. </summary>
  9268. </member>
  9269. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalEnclosedParen">
  9270. <summary>
  9271. Decimal Numbers Enclosed in Parenthesis
  9272. </summary>
  9273. </member>
  9274. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalEnclosedCircleChinese">
  9275. <summary>
  9276. Decimal Numbers Enclosed in a Circle
  9277. </summary>
  9278. </member>
  9279. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographEnclosedCircle">
  9280. <summary>
  9281. Ideographs Enclosed in a Circle
  9282. </summary>
  9283. </member>
  9284. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographTraditional">
  9285. <summary>
  9286. Traditional Ideograph Format
  9287. </summary>
  9288. </member>
  9289. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographZodiac">
  9290. <summary>
  9291. Zodiac Ideograph Format
  9292. </summary>
  9293. </member>
  9294. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographZodiacTraditional">
  9295. <summary>
  9296. Traditional Zodiac Ideograph Format
  9297. </summary>
  9298. </member>
  9299. <member name="F:NPOI.XWPF.UserModel.NumberFormat.TaiwaneseCounting">
  9300. <summary>
  9301. Taiwanese Counting System
  9302. </summary>
  9303. </member>
  9304. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographLegalTraditional">
  9305. <summary>
  9306. Traditional Legal Ideograph Format
  9307. </summary>
  9308. </member>
  9309. <member name="F:NPOI.XWPF.UserModel.NumberFormat.TaiwaneseCountingThousand">
  9310. <summary>
  9311. Taiwanese Counting Thousand System
  9312. </summary>
  9313. </member>
  9314. <member name="F:NPOI.XWPF.UserModel.NumberFormat.TaiwaneseDigital">
  9315. <summary>
  9316. Taiwanese Digital Counting System
  9317. </summary>
  9318. </member>
  9319. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ChineseCounting">
  9320. <summary>
  9321. Chinese Counting System
  9322. </summary>
  9323. </member>
  9324. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ChineseLegalSimplified">
  9325. <summary>
  9326. Chinese Legal Simplified Format
  9327. </summary>
  9328. </member>
  9329. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ChineseCountingThousand">
  9330. <summary>
  9331. Chinese Counting Thousand System
  9332. </summary>
  9333. </member>
  9334. <member name="F:NPOI.XWPF.UserModel.NumberFormat.KoreanDigital">
  9335. <summary>
  9336. Korean Digital Counting System
  9337. </summary>
  9338. </member>
  9339. <member name="F:NPOI.XWPF.UserModel.NumberFormat.KoreanCounting">
  9340. <summary>
  9341. Korean Counting System
  9342. </summary>
  9343. </member>
  9344. <member name="F:NPOI.XWPF.UserModel.NumberFormat.KoreanLegal">
  9345. <summary>
  9346. Korean Legal Numbering
  9347. </summary>
  9348. </member>
  9349. <member name="F:NPOI.XWPF.UserModel.NumberFormat.KoreanDigital2">
  9350. <summary>
  9351. Korean Digital Counting System Alternate
  9352. </summary>
  9353. </member>
  9354. <member name="F:NPOI.XWPF.UserModel.NumberFormat.VietnameseCounting">
  9355. <summary>
  9356. Vietnamese Numerals
  9357. </summary>
  9358. </member>
  9359. <member name="F:NPOI.XWPF.UserModel.NumberFormat.RussianLower">
  9360. <summary>
  9361. Lowercase Russian Alphabet
  9362. </summary>
  9363. </member>
  9364. <member name="F:NPOI.XWPF.UserModel.NumberFormat.RussianUpper">
  9365. <summary>
  9366. Uppercase Russian Alphabet
  9367. </summary>
  9368. </member>
  9369. <member name="F:NPOI.XWPF.UserModel.NumberFormat.None">
  9370. <summary>
  9371. No Numbering
  9372. </summary>
  9373. </member>
  9374. <member name="F:NPOI.XWPF.UserModel.NumberFormat.NumberInDash">
  9375. <summary>
  9376. Number With Dashes
  9377. </summary>
  9378. </member>
  9379. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Hebrew1">
  9380. <summary>
  9381. Hebrew Numerals
  9382. </summary>
  9383. </member>
  9384. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Hebrew2">
  9385. <summary>
  9386. Hebrew Alphabet
  9387. </summary>
  9388. </member>
  9389. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ArabicAlpha">
  9390. <summary>
  9391. Arabic Alphabet
  9392. </summary>
  9393. </member>
  9394. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ArabicAbjad">
  9395. <summary>
  9396. Arabic Abjad Numerals
  9397. </summary>
  9398. </member>
  9399. <member name="F:NPOI.XWPF.UserModel.NumberFormat.HindiVowels">
  9400. <summary>
  9401. Hindi Vowels
  9402. </summary>
  9403. </member>
  9404. <member name="F:NPOI.XWPF.UserModel.NumberFormat.HindiConsonants">
  9405. <summary>
  9406. Hindi Consonants
  9407. </summary>
  9408. </member>
  9409. <member name="F:NPOI.XWPF.UserModel.NumberFormat.HindiNumbers">
  9410. <summary>
  9411. Hindi Numbers
  9412. </summary>
  9413. </member>
  9414. <member name="F:NPOI.XWPF.UserModel.NumberFormat.HindiCounting">
  9415. <summary>
  9416. Hindi Counting System
  9417. </summary>
  9418. </member>
  9419. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ThaiLetters">
  9420. <summary>
  9421. Thai Letters
  9422. </summary>
  9423. </member>
  9424. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ThaiNumbers">
  9425. <summary>
  9426. Thai Numerals
  9427. </summary>
  9428. </member>
  9429. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ThaiCounting">
  9430. <summary>
  9431. Thai Counting System
  9432. </summary>
  9433. </member>
  9434. <member name="T:NPOI.XWPF.UserModel.XWPFComment">
  9435. Sketch of XWPF comment class
  9436. </member>
  9437. <member name="P:NPOI.XWPF.UserModel.XWPFComment.Part">
  9438. Get the Part to which the comment belongs, which you need for adding
  9439. relationships to other parts
  9440. @return {@link POIXMLDocumentPart} that contains the comment.
  9441. @see org.apache.poi.xwpf.usermodel.IBody#getPart()
  9442. </member>
  9443. <member name="P:NPOI.XWPF.UserModel.XWPFComment.PartType">
  9444. Get the part type {@link BodyType} of the comment.
  9445. @return The {@link BodyType} value.
  9446. @see org.apache.poi.xwpf.usermodel.IBody#getPartType()
  9447. </member>
  9448. <member name="P:NPOI.XWPF.UserModel.XWPFComment.BodyElements">
  9449. Gets the body elements ({@link IBodyElement}) of the comment.
  9450. @return List of body elements.
  9451. </member>
  9452. <member name="P:NPOI.XWPF.UserModel.XWPFComment.Paragraphs">
  9453. Returns the paragraph(s) that holds the text of the comment.
  9454. </member>
  9455. <member name="P:NPOI.XWPF.UserModel.XWPFComment.Tables">
  9456. Get the list of {@link XWPFTable}s in the comment.
  9457. @return List of tables
  9458. </member>
  9459. <member name="M:NPOI.XWPF.UserModel.XWPFComment.GetXWPFDocument">
  9460. Get the {@link XWPFDocument} the comment is part of.
  9461. @see org.apache.poi.xwpf.usermodel.IBody#getXWPFDocument()
  9462. </member>
  9463. <member name="M:NPOI.XWPF.UserModel.XWPFComment.GetCtComment">
  9464. Gets the underlying CT_Comment object for the comment.
  9465. @return CT_Comment object
  9466. </member>
  9467. <member name="M:NPOI.XWPF.UserModel.XWPFComment.GetComments">
  9468. The owning object for this comment
  9469. @return The {@link XWPFComments} object that contains this comment.
  9470. </member>
  9471. <member name="M:NPOI.XWPF.UserModel.XWPFComment.GetId">
  9472. Get a unique identifier for the current comment. The restrictions on the
  9473. id attribute, if any, are defined by the parent XML element. If this
  9474. attribute is omitted, then the document is non-conformant.
  9475. @return string id
  9476. </member>
  9477. <member name="M:NPOI.XWPF.UserModel.XWPFComment.GetAuthor">
  9478. Get the author of the current comment
  9479. @return author of the current comment
  9480. </member>
  9481. <member name="M:NPOI.XWPF.UserModel.XWPFComment.SetAuthor(System.String)">
  9482. Specifies the author for the current comment If this attribute is
  9483. omitted, then no author shall be associated with the parent annotation
  9484. type.
  9485. @param author author of the current comment
  9486. </member>
  9487. <member name="M:NPOI.XWPF.UserModel.XWPFComment.GetInitials">
  9488. Get the initials of the author of the current comment
  9489. @return initials the initials of the author of the current comment
  9490. </member>
  9491. <member name="M:NPOI.XWPF.UserModel.XWPFComment.SetInitials(System.String)">
  9492. Specifies the initials of the author of the current comment
  9493. @param initials the initials of the author of the current comment
  9494. </member>
  9495. <member name="M:NPOI.XWPF.UserModel.XWPFComment.GetDate">
  9496. Get the date information of the current comment
  9497. @return the date information for the current comment.
  9498. </member>
  9499. <member name="M:NPOI.XWPF.UserModel.XWPFComment.SetDate(System.String)">
  9500. Specifies the date information for the current comment. If this attribute
  9501. is omitted, then no date information shall be associated with the parent
  9502. annotation type.
  9503. @param date the date information for the current comment.
  9504. </member>
  9505. <member name="M:NPOI.XWPF.UserModel.XWPFComments.#ctor(NPOI.POIXMLDocumentPart,NPOI.OpenXml4Net.OPC.PackagePart)">
  9506. Construct XWPFComments from a package part
  9507. @param part the package part holding the data of the footnotes,
  9508. </member>
  9509. <member name="M:NPOI.XWPF.UserModel.XWPFComments.#ctor">
  9510. Construct XWPFComments from scratch for a new document.
  9511. </member>
  9512. <member name="M:NPOI.XWPF.UserModel.XWPFComments.OnDocumentRead">
  9513. read comments form an existing package
  9514. </member>
  9515. <member name="M:NPOI.XWPF.UserModel.XWPFComments.AddPictureData(System.IO.Stream,System.Int32)">
  9516. Adds a picture to the comments.
  9517. @param is The stream to read image from
  9518. @param format The format of the picture, see {@link Document}
  9519. @return the index to this picture (0 based), the added picture can be
  9520. obtained from {@link #getAllPictures()} .
  9521. @throws InvalidFormatException If the format of the picture is not known.
  9522. @throws IOException If reading the picture-data from the stream fails.
  9523. @see #addPictureData(InputStream, PictureType)
  9524. </member>
  9525. <member name="M:NPOI.XWPF.UserModel.XWPFComments.AddPictureData(System.Byte[],System.Int32)">
  9526. Adds a picture to the comments.
  9527. @param pictureData The picture data
  9528. @param format The format of the picture, see {@link Document}
  9529. @return the index to this picture (0 based), the added picture can be
  9530. obtained from {@link #getAllPictures()} .
  9531. @throws InvalidFormatException If the format of the picture is not known.
  9532. </member>
  9533. <member name="M:NPOI.XWPF.UserModel.XWPFComments.Commit">
  9534. save and commit comments
  9535. </member>
  9536. <member name="M:NPOI.XWPF.UserModel.XWPFComments.GetCtComments">
  9537. Gets the underlying CTComments object for the comments.
  9538. @return CTComments object
  9539. </member>
  9540. <member name="M:NPOI.XWPF.UserModel.XWPFComments.SetCtComments(NPOI.OpenXmlFormats.Wordprocessing.CT_Comments)">
  9541. set a new comments
  9542. </member>
  9543. <member name="M:NPOI.XWPF.UserModel.XWPFComments.GetComments">
  9544. Get the list of {@link XWPFComment} in the Comments part.
  9545. </member>
  9546. <member name="M:NPOI.XWPF.UserModel.XWPFComments.GetComment(System.Int32)">
  9547. Get the specified comment by position
  9548. @param pos Array position of the comment
  9549. </member>
  9550. <member name="M:NPOI.XWPF.UserModel.XWPFComments.GetCommentByID(System.String)">
  9551. Get the specified comment by comment id
  9552. @param id comment id
  9553. @return the specified comment
  9554. </member>
  9555. <member name="M:NPOI.XWPF.UserModel.XWPFComments.GetComment(NPOI.OpenXmlFormats.Wordprocessing.CT_Comment)">
  9556. Get the specified comment by ctComment
  9557. </member>
  9558. <member name="M:NPOI.XWPF.UserModel.XWPFComments.CreateComment(System.String)">
  9559. Create a new comment and add it to the document.
  9560. @param cid comment Id
  9561. </member>
  9562. <member name="M:NPOI.XWPF.UserModel.XWPFComments.RemoveComment(System.Int32)">
  9563. Remove the specified comment if present.
  9564. @param pos Array position of the comment to be removed
  9565. @return True if the comment was removed.
  9566. </member>
  9567. <member name="T:NPOI.XWPF.UserModel.XWPFDefaultParagraphStyle">
  9568. Default Paragraph style, from which other styles will override
  9569. TODO Share logic with {@link XWPFParagraph} which also uses CTPPr
  9570. </member>
  9571. <member name="T:NPOI.XWPF.UserModel.XWPFDefaultRunStyle">
  9572. Default Character Run style, from which other styles will override
  9573. TODO Share logic with {@link XWPFRun} which also uses CTRPr
  9574. </member>
  9575. <member name="T:NPOI.XWPF.UserModel.XWPFDocument">
  9576. <p>High(ish) level class for working with .docx files.</p>
  9577. <p>This class tries to hide some of the complexity
  9578. of the underlying file format, but as it's not a
  9579. mature and stable API yet, certain parts of the
  9580. XML structure come through. You'll therefore almost
  9581. certainly need to refer to the OOXML specifications
  9582. from
  9583. http://www.ecma-international.org/publications/standards/Ecma-376.htm
  9584. at some point in your use.</p>
  9585. </member>
  9586. <member name="F:NPOI.XWPF.UserModel.XWPFDocument.drawingIdManager">
  9587. Keeps track on all id-values used in this document and included parts, like headers, footers, etc.
  9588. </member>
  9589. <member name="F:NPOI.XWPF.UserModel.XWPFDocument.headerFooterPolicy">
  9590. Handles the joy of different headers/footers for different pages
  9591. </member>
  9592. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.NewPackage">
  9593. Create a new WordProcessingML package and Setup the default minimal content
  9594. </member>
  9595. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.OnDocumentCreate">
  9596. Create a new CT_Document with all values Set to default
  9597. </member>
  9598. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.Document">
  9599. Returns the low level document base object
  9600. </member>
  9601. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.ColumnCount">
  9602. Sets columns on document base object
  9603. </member>
  9604. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.TextDirection">
  9605. Sets Text Direction of Document
  9606. </member>
  9607. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.BodyElements">
  9608. returns an Iterator with paragraphs and tables
  9609. @see NPOI.XWPF.UserModel.IBody#getBodyElements()
  9610. </member>
  9611. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.Paragraphs">
  9612. @see NPOI.XWPF.UserModel.IBody#getParagraphs()
  9613. </member>
  9614. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.Tables">
  9615. @see NPOI.XWPF.UserModel.IBody#getTables()
  9616. </member>
  9617. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetTableArray(System.Int32)">
  9618. @see NPOI.XWPF.UserModel.IBody#getTableArray(int)
  9619. </member>
  9620. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.FooterList">
  9621. @return the list of footers
  9622. </member>
  9623. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.HeaderList">
  9624. @return the list of headers
  9625. </member>
  9626. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetDocComments">
  9627. Get Comments
  9628. @return comments
  9629. </member>
  9630. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetPartById(System.String)">
  9631. Get the document part that's defined as the
  9632. given relationship of the core document.
  9633. </member>
  9634. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetHeaderFooterPolicy">
  9635. Returns the policy on headers and footers, which
  9636. also provides a way to Get at them.
  9637. </member>
  9638. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetCTStyle">
  9639. Returns the styles object used
  9640. </member>
  9641. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetAllEmbedds">
  9642. Get the document's embedded files.
  9643. </member>
  9644. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetBodyElementSpecificPos(System.Int32,System.Collections.Generic.List{NPOI.XWPF.UserModel.IBodyElement})">
  9645. Finds that for example the 2nd entry in the body list is the 1st paragraph
  9646. </member>
  9647. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetParagraphPos(System.Int32)">
  9648. Look up the paragraph at the specified position in the body elemnts list
  9649. and return this paragraphs position in the paragraphs list
  9650. @param pos
  9651. The position of the relevant paragraph in the body elements
  9652. list
  9653. @return the position of the paragraph in the paragraphs list, if there is
  9654. a paragraph at the position in the bodyelements list. Else it
  9655. will return -1
  9656. </member>
  9657. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetTablePos(System.Int32)">
  9658. Get with the position of a table in the bodyelement array list
  9659. the position of this table in the table array list
  9660. @param pos position of the table in the bodyelement array list
  9661. @return if there is a table at the position in the bodyelement array list,
  9662. else it will return null.
  9663. </member>
  9664. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.InsertNewParagraph(System.Xml.XmlDocument)">
  9665. Add a new paragraph at position of the cursor. The cursor must be on the
  9666. {@link org.apache.xmlbeans.XmlCursor.TokenType#START} tag of an subelement
  9667. of the documents body. When this method is done, the cursor passed as
  9668. parameter points to the {@link org.apache.xmlbeans.XmlCursor.TokenType#END}
  9669. of the newly inserted paragraph.
  9670. @param cursor
  9671. @return the {@link XWPFParagraph} object representing the newly inserted
  9672. CTP object
  9673. </member>
  9674. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsCursorInBody(System.Xml.XmlDocument)">
  9675. verifies that cursor is on the right position
  9676. @param cursor
  9677. </member>
  9678. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetPosOfParagraph(NPOI.XWPF.UserModel.XWPFParagraph)">
  9679. Get the position of the paragraph, within the list
  9680. of all the body elements.
  9681. @param p The paragraph to find
  9682. @return The location, or -1 if the paragraph couldn't be found
  9683. </member>
  9684. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetPosOfTable(NPOI.XWPF.UserModel.XWPFTable)">
  9685. Get the position of the table, within the list of
  9686. all the body elements.
  9687. @param t The table to find
  9688. @return The location, or -1 if the table couldn't be found
  9689. </member>
  9690. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.Commit">
  9691. Commit and saves the document
  9692. </member>
  9693. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetRelationIndex(NPOI.XWPF.UserModel.XWPFRelation)">
  9694. Gets the index of the relation we're trying to create
  9695. @param relation
  9696. @return i
  9697. </member>
  9698. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateParagraph">
  9699. Appends a new paragraph to this document
  9700. @return a new paragraph
  9701. </member>
  9702. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateComments">
  9703. Creates an empty comments for the document if one does not already exist
  9704. @return comments
  9705. </member>
  9706. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateNumbering">
  9707. Creates an empty numbering if one does not already exist and Sets the numbering member
  9708. @return numbering
  9709. </member>
  9710. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateStyles">
  9711. Creates an empty styles for the document if one does not already exist
  9712. @return styles
  9713. </member>
  9714. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateFootnotes">
  9715. Creates an empty footnotes element for the document if one does not already exist
  9716. @return footnotes
  9717. </member>
  9718. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateFootnote">
  9719. <summary>
  9720. Create a new footnote and add it to the document.
  9721. </summary>
  9722. <remarks>
  9723. The new note will have one paragraph with the style "FootnoteText"
  9724. and one run containing the required footnote reference with the
  9725. style "FootnoteReference".
  9726. </remarks>
  9727. <returns>New XWPFFootnote.</returns>
  9728. </member>
  9729. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.RemoveFootnote(System.Int32)">
  9730. <summary>
  9731. Remove the specified footnote if present.
  9732. </summary>
  9733. <param name="pos"></param>
  9734. <returns></returns>
  9735. </member>
  9736. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.RemoveBodyElement(System.Int32)">
  9737. remove a BodyElement from bodyElements array list
  9738. @param pos
  9739. @return true if removing was successfully, else return false
  9740. </member>
  9741. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.SetParagraph(NPOI.XWPF.UserModel.XWPFParagraph,System.Int32)">
  9742. copies content of a paragraph to a existing paragraph in the list paragraphs at position pos
  9743. @param paragraph
  9744. @param pos
  9745. </member>
  9746. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetLastParagraph">
  9747. @return the LastParagraph of the document
  9748. </member>
  9749. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateTable">
  9750. Create an empty table with one row and one column as default.
  9751. @return a new table
  9752. </member>
  9753. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateTable(System.Int32,System.Int32)">
  9754. Create an empty table with a number of rows and cols specified
  9755. @param rows
  9756. @param cols
  9757. @return table
  9758. </member>
  9759. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateTOC">
  9760. <summary>
  9761. Create a Table of Contents (TOC) at the end of the document.
  9762. Please set paragraphs style to "Heading{#}" and document
  9763. styles for TOC <see cref="M:NPOI.OOXML.XWPF.Util.DocumentStylesBuilder.BuildStylesForTOC(NPOI.XWPF.UserModel.XWPFDocument)"/>.
  9764. Otherwise, it renders an empty one.
  9765. </summary>
  9766. </member>
  9767. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.SetTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  9768. Replace content of table in array tables at position pos with a
  9769. @param pos
  9770. @param table
  9771. </member>
  9772. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsEnforcedProtection">
  9773. Verifies that the documentProtection tag in settings.xml file <br/>
  9774. specifies that the protection is enforced (w:enforcement="1") <br/>
  9775. <br/>
  9776. sample snippet from settings.xml
  9777. <pre>
  9778. &lt;w:settings ... &gt;
  9779. &lt;w:documentProtection w:edit=&quot;readOnly&quot; w:enforcement=&quot;1&quot;/&gt;
  9780. </pre>
  9781. @return true if documentProtection is enforced with option any
  9782. </member>
  9783. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsEnforcedReadonlyProtection">
  9784. Verifies that the documentProtection tag in Settings.xml file <br/>
  9785. specifies that the protection is enforced (w:enforcement="1") <br/>
  9786. and that the kind of protection is ReadOnly (w:edit="readOnly")<br/>
  9787. <br/>
  9788. sample snippet from Settings.xml
  9789. <pre>
  9790. &lt;w:settings ... &gt;
  9791. &lt;w:documentProtection w:edit=&quot;readOnly&quot; w:enforcement=&quot;1&quot;/&gt;
  9792. </pre>
  9793. @return true if documentProtection is enforced with option ReadOnly
  9794. </member>
  9795. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsEnforcedFillingFormsProtection">
  9796. Verifies that the documentProtection tag in Settings.xml file <br/>
  9797. specifies that the protection is enforced (w:enforcement="1") <br/>
  9798. and that the kind of protection is forms (w:edit="forms")<br/>
  9799. <br/>
  9800. sample snippet from Settings.xml
  9801. <pre>
  9802. &lt;w:settings ... &gt;
  9803. &lt;w:documentProtection w:edit=&quot;forms&quot; w:enforcement=&quot;1&quot;/&gt;
  9804. </pre>
  9805. @return true if documentProtection is enforced with option forms
  9806. </member>
  9807. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsEnforcedCommentsProtection">
  9808. Verifies that the documentProtection tag in Settings.xml file <br/>
  9809. specifies that the protection is enforced (w:enforcement="1") <br/>
  9810. and that the kind of protection is comments (w:edit="comments")<br/>
  9811. <br/>
  9812. sample snippet from Settings.xml
  9813. <pre>
  9814. &lt;w:settings ... &gt;
  9815. &lt;w:documentProtection w:edit=&quot;comments&quot; w:enforcement=&quot;1&quot;/&gt;
  9816. </pre>
  9817. @return true if documentProtection is enforced with option comments
  9818. </member>
  9819. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsEnforcedTrackedChangesProtection">
  9820. Verifies that the documentProtection tag in Settings.xml file <br/>
  9821. specifies that the protection is enforced (w:enforcement="1") <br/>
  9822. and that the kind of protection is trackedChanges (w:edit="trackedChanges")<br/>
  9823. <br/>
  9824. sample snippet from Settings.xml
  9825. <pre>
  9826. &lt;w:settings ... &gt;
  9827. &lt;w:documentProtection w:edit=&quot;trackedChanges&quot; w:enforcement=&quot;1&quot;/&gt;
  9828. </pre>
  9829. @return true if documentProtection is enforced with option trackedChanges
  9830. </member>
  9831. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.EnforceReadonlyProtection">
  9832. Enforces the ReadOnly protection.<br/>
  9833. In the documentProtection tag inside Settings.xml file, <br/>
  9834. it Sets the value of enforcement to "1" (w:enforcement="1") <br/>
  9835. and the value of edit to ReadOnly (w:edit="readOnly")<br/>
  9836. <br/>
  9837. sample snippet from Settings.xml
  9838. <pre>
  9839. &lt;w:settings ... &gt;
  9840. &lt;w:documentProtection w:edit=&quot;readOnly&quot; w:enforcement=&quot;1&quot;/&gt;
  9841. </pre>
  9842. </member>
  9843. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.EnforceFillingFormsProtection">
  9844. Enforce the Filling Forms protection.<br/>
  9845. In the documentProtection tag inside Settings.xml file, <br/>
  9846. it Sets the value of enforcement to "1" (w:enforcement="1") <br/>
  9847. and the value of edit to forms (w:edit="forms")<br/>
  9848. <br/>
  9849. sample snippet from Settings.xml
  9850. <pre>
  9851. &lt;w:settings ... &gt;
  9852. &lt;w:documentProtection w:edit=&quot;forms&quot; w:enforcement=&quot;1&quot;/&gt;
  9853. </pre>
  9854. </member>
  9855. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.EnforceCommentsProtection">
  9856. Enforce the Comments protection.<br/>
  9857. In the documentProtection tag inside Settings.xml file,<br/>
  9858. it Sets the value of enforcement to "1" (w:enforcement="1") <br/>
  9859. and the value of edit to comments (w:edit="comments")<br/>
  9860. <br/>
  9861. sample snippet from Settings.xml
  9862. <pre>
  9863. &lt;w:settings ... &gt;
  9864. &lt;w:documentProtection w:edit=&quot;comments&quot; w:enforcement=&quot;1&quot;/&gt;
  9865. </pre>
  9866. </member>
  9867. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.EnforceTrackedChangesProtection">
  9868. Enforce the Tracked Changes protection.<br/>
  9869. In the documentProtection tag inside Settings.xml file, <br/>
  9870. it Sets the value of enforcement to "1" (w:enforcement="1") <br/>
  9871. and the value of edit to trackedChanges (w:edit="trackedChanges")<br/>
  9872. <br/>
  9873. sample snippet from Settings.xml
  9874. <pre>
  9875. &lt;w:settings ... &gt;
  9876. &lt;w:documentProtection w:edit=&quot;trackedChanges&quot; w:enforcement=&quot;1&quot;/&gt;
  9877. </pre>
  9878. </member>
  9879. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.RemoveProtectionEnforcement">
  9880. Remove protection enforcement.<br/>
  9881. In the documentProtection tag inside Settings.xml file <br/>
  9882. it Sets the value of enforcement to "0" (w:enforcement="0") <br/>
  9883. </member>
  9884. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.EnforceUpdateFields">
  9885. Enforces fields update on document open (in Word).
  9886. In the settings.xml file <br/>
  9887. sets the updateSettings value to true (w:updateSettings w:val="true")
  9888. NOTICES:
  9889. <ul>
  9890. <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?"
  9891. (if "Update automatic links at open" is enabled)</li>
  9892. <li>Flag is removed after saving with changes in Word </li>
  9893. </ul>
  9894. </member>
  9895. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.IsTrackRevisions">
  9896. Check if revision tracking is turned on.
  9897. @return <code>true</code> if revision tracking is turned on
  9898. </member>
  9899. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.InsertTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  9900. inserts an existing XWPFTable to the arrays bodyElements and tables
  9901. @param pos
  9902. @param table
  9903. </member>
  9904. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.AllPictures">
  9905. Returns all Pictures, which are referenced from the document itself.
  9906. @return a {@link List} of {@link XWPFPictureData}. The returned {@link List} is unmodifiable. Use #a
  9907. </member>
  9908. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.AllPackagePictures">
  9909. @return all Pictures in this package
  9910. </member>
  9911. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetNextPicNameNumber(System.Int32)">
  9912. Get the next free ImageNumber
  9913. @param format
  9914. @return the next free ImageNumber
  9915. @throws InvalidFormatException
  9916. </member>
  9917. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetPictureDataByID(System.String)">
  9918. returns the PictureData by blipID
  9919. @param blipID
  9920. @return XWPFPictureData of a specificID
  9921. </member>
  9922. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetNumbering">
  9923. GetNumbering
  9924. @return numbering
  9925. </member>
  9926. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetStyles">
  9927. Get Styles
  9928. @return styles for this document
  9929. </member>
  9930. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  9931. Get the paragraph with the CTP class p
  9932. @param p
  9933. @return the paragraph with the CTP class p
  9934. </member>
  9935. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetTable(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  9936. Get a table by its CTTbl-Object
  9937. @param ctTbl
  9938. @see NPOI.XWPF.UserModel.IBody#getTable(org.Openxmlformats.schemas.wordProcessingml.x2006.main.CTTbl)
  9939. @return a table by its CTTbl-Object or null
  9940. </member>
  9941. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.ChangeOrientation(NPOI.OpenXmlFormats.Wordprocessing.ST_PageOrientation)">
  9942. <summary>
  9943. Change orientation of a Word file
  9944. </summary>
  9945. <param name="orientation"></param>
  9946. <remarks>https://stackoverflow.com/questions/26483837/landscape-and-portrait-pages-in-the-same-word-document-using-apache-poi-xwpf-in</remarks>
  9947. </member>
  9948. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetParagraphArray(System.Int32)">
  9949. Returns the paragraph that of position pos
  9950. @see NPOI.XWPF.UserModel.IBody#getParagraphArray(int)
  9951. </member>
  9952. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.Part">
  9953. returns the Part, to which the body belongs, which you need for Adding relationship to other parts
  9954. Actually it is needed of the class XWPFTableCell. Because you have to know to which part the tableCell
  9955. belongs.
  9956. @see NPOI.XWPF.UserModel.IBody#getPart()
  9957. </member>
  9958. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.PartType">
  9959. Get the PartType of the body, for example
  9960. DOCUMENT, HEADER, FOOTER, FOOTNOTE,
  9961. @see NPOI.XWPF.UserModel.IBody#getPartType()
  9962. </member>
  9963. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  9964. Get the TableCell which belongs to the TableCell
  9965. @param cell
  9966. </member>
  9967. <member name="T:NPOI.XWPF.UserModel.XWPFFactory">
  9968. @author Yegor Kozlov
  9969. </member>
  9970. <member name="M:NPOI.XWPF.UserModel.XWPFFactory.GetDescriptor(System.String)">
  9971. @since POI 3.14-Beta1
  9972. </member>
  9973. <member name="M:NPOI.XWPF.UserModel.XWPFFactory.CreateDocumentPart(System.Type,System.Type[],System.Object[])">
  9974. @since POI 3.14-Beta1
  9975. </member>
  9976. <member name="T:NPOI.XWPF.UserModel.XWPFFieldRun">
  9977. A run of text which is part of a field, such as Title
  9978. of Page number or Author.
  9979. Any given Field may be made up of multiple of these.
  9980. </member>
  9981. <member name="T:NPOI.XWPF.UserModel.XWPFFooter">
  9982. Sketch of XWPF footer class
  9983. </member>
  9984. <member name="M:NPOI.XWPF.UserModel.XWPFFooter.Commit">
  9985. save and Commit footer
  9986. </member>
  9987. <member name="P:NPOI.XWPF.UserModel.XWPFFooter.PartType">
  9988. Get the PartType of the body
  9989. @see NPOI.XWPF.UserModel.IBody#getPartType()
  9990. </member>
  9991. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetTableArray(System.Int32)">
  9992. <summary>
  9993. </summary>
  9994. <param name="pos">position in table array</param>
  9995. <returns>The table at position pos</returns>
  9996. </member>
  9997. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.InsertTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  9998. <summary>
  9999. inserts an existing XWPFTable to the arrays bodyElements and tables
  10000. </summary>
  10001. <param name="pos"></param>
  10002. <param name="table"></param>
  10003. </member>
  10004. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetTable(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  10005. if there is a corresponding {@link XWPFTable} of the parameter ctTable in the tableList of this header
  10006. the method will return this table
  10007. if there is no corresponding {@link XWPFTable} the method will return null
  10008. @param ctTable
  10009. @see NPOI.XWPF.UserModel.IBody#getTable(CTTbl ctTable)
  10010. </member>
  10011. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  10012. if there is a corresponding {@link XWPFParagraph} of the parameter ctTable in the paragraphList of this header or footer
  10013. the method will return this paragraph
  10014. if there is no corresponding {@link XWPFParagraph} the method will return null
  10015. @param p is instance of CTP and is searching for an XWPFParagraph
  10016. @return null if there is no XWPFParagraph with an corresponding CTPparagraph in the paragraphList of this header or footer
  10017. XWPFParagraph with the correspondig CTP p
  10018. @see NPOI.XWPF.UserModel.IBody#getParagraph(CTP p)
  10019. </member>
  10020. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetParagraphArray(System.Int32)">
  10021. <summary>
  10022. Returns the paragraph that holds the text of the header or footer.
  10023. </summary>
  10024. <param name="pos"></param>
  10025. <returns></returns>
  10026. </member>
  10027. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  10028. <summary>
  10029. Get the TableCell which belongs to the TableCell
  10030. </summary>
  10031. <param name="cell"></param>
  10032. <returns></returns>
  10033. </member>
  10034. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.IsCursorInFtn(System.Xml.XmlDocument)">
  10035. verifies that cursor is on the right position
  10036. @param cursor
  10037. </member>
  10038. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.CreateParagraph">
  10039. Appends a new {@link XWPFParagraph} to this footnote.
  10040. @return The new {@link XWPFParagraph}
  10041. </member>
  10042. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.EnsureFootnoteRef(NPOI.XWPF.UserModel.XWPFParagraph)">
  10043. Ensure that the specified paragraph has a reference marker for this
  10044. footnote by adding a footnote reference if one is not found.
  10045. <p>This method is for the first paragraph in the footnote, not
  10046. paragraphs that will refer to the footnote. For references to
  10047. the footnote, use {@link XWPFParagraph#addFootnoteReference(XWPFFootnote)}.
  10048. </p>
  10049. <p>The first run of the first paragraph in a footnote should
  10050. contain a {@link CTFtnEdnRef} object.</p>
  10051. @param p The {@link XWPFParagraph} to ensure
  10052. </member>
  10053. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.CreateTable">
  10054. Appends a new {@link XWPFTable} to this footnote
  10055. @return The new {@link XWPFTable}
  10056. </member>
  10057. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.CreateTable(System.Int32,System.Int32)">
  10058. Appends a new {@link XWPFTable} to this footnote
  10059. @param rows Number of rows to initialize the table with
  10060. @param cols Number of columns to initialize the table with
  10061. @return the new {@link XWPFTable} with the specified number of rows and columns
  10062. </member>
  10063. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.InsertNewTbl(System.Xml.XmlDocument)">
  10064. @param cursor
  10065. @return the inserted table
  10066. @see NPOI.XWPF.UserModel.IBody#insertNewTbl(XmlCursor cursor)
  10067. </member>
  10068. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.InsertNewParagraph(System.Xml.XmlDocument)">
  10069. add a new paragraph at position of the cursor
  10070. @param cursor
  10071. @return the inserted paragraph
  10072. @see NPOI.XWPF.UserModel.IBody#insertNewParagraph(XmlCursor cursor)
  10073. </member>
  10074. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.AddNewTbl(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  10075. add a new table to the end of the footnote
  10076. @param table
  10077. @return the Added XWPFTable
  10078. </member>
  10079. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.AddNewParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  10080. add a new paragraph to the end of the footnote
  10081. @param paragraph
  10082. @return the Added XWPFParagraph
  10083. </member>
  10084. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetXWPFDocument">
  10085. @see NPOI.XWPF.UserModel.IBody#getXWPFDocument()
  10086. </member>
  10087. <member name="P:NPOI.XWPF.UserModel.XWPFFootnote.Part">
  10088. returns the Part, to which the body belongs, which you need for Adding relationship to other parts
  10089. @see NPOI.XWPF.UserModel.IBody#getPart()
  10090. </member>
  10091. <member name="P:NPOI.XWPF.UserModel.XWPFFootnote.PartType">
  10092. Get the PartType of the body
  10093. @see NPOI.XWPF.UserModel.IBody#getPartType()
  10094. </member>
  10095. <member name="T:NPOI.XWPF.UserModel.XWPFFootnotes">
  10096. Looks After the collection of Footnotes for a document
  10097. @author Mike McEuen (mceuen@hp.com)
  10098. </member>
  10099. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  10100. Construct XWPFFootnotes from a package part
  10101. @param part the package part holding the data of the footnotes,
  10102. @param rel the package relationship of type "http://schemas.Openxmlformats.org/officeDocument/2006/relationships/footnotes"
  10103. </member>
  10104. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.#ctor">
  10105. Construct XWPFFootnotes from scratch for a new document.
  10106. </member>
  10107. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.OnDocumentRead">
  10108. Read document
  10109. </member>
  10110. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.SetFootnotes(NPOI.OpenXmlFormats.Wordprocessing.CT_Footnotes)">
  10111. Sets the ctFootnotes
  10112. @param footnotes
  10113. </member>
  10114. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.AddFootnote(NPOI.XWPF.UserModel.XWPFFootnote)">
  10115. add an XWPFFootnote to the document
  10116. @param footnote
  10117. @throws IOException
  10118. </member>
  10119. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.AddFootnote(NPOI.OpenXmlFormats.Wordprocessing.CT_FtnEdn)">
  10120. add a footnote to the document
  10121. @param note
  10122. @throws IOException
  10123. </member>
  10124. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.CreateFootnote">
  10125. <summary>
  10126. Create a new footnote and add it to the document.
  10127. </summary>
  10128. <remarks>
  10129. The new note will have one paragraph with the style "FootnoteText"
  10130. and one run containing the required footnote reference with the
  10131. style "FootnoteReference".
  10132. </remarks>
  10133. <returns>New XWPFFootnote</returns>
  10134. </member>
  10135. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.RemoveFootnote(System.Int32)">
  10136. <summary>
  10137. Remove the specified footnote if present.
  10138. </summary>
  10139. <param name="pos"></param>
  10140. <returns></returns>
  10141. </member>
  10142. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.GetXWPFDocument">
  10143. @see NPOI.XWPF.UserModel.IBody#getPart()
  10144. </member>
  10145. <member name="T:NPOI.XWPF.UserModel.XWPFHeader">
  10146. Sketch of XWPF header class
  10147. </member>
  10148. <member name="M:NPOI.XWPF.UserModel.XWPFHeader.Commit">
  10149. <summary>
  10150. Save and commit footer
  10151. </summary>
  10152. </member>
  10153. <member name="M:NPOI.XWPF.UserModel.XWPFHeader.OnDocumentRead">
  10154. <summary>
  10155. Read the document
  10156. </summary>
  10157. </member>
  10158. <member name="P:NPOI.XWPF.UserModel.XWPFHeader.PartType">
  10159. <summary>
  10160. Get the PartType of the body
  10161. </summary>
  10162. </member>
  10163. <member name="T:NPOI.XWPF.UserModel.XWPFHeaderFooter">
  10164. Parent of XWPF headers and footers
  10165. </member>
  10166. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.Paragraphs">
  10167. Returns the paragraph(s) that holds
  10168. the text of the header or footer.
  10169. Normally there is only the one paragraph, but
  10170. there could be more in certain cases, or
  10171. a table.
  10172. </member>
  10173. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.Tables">
  10174. Return the table(s) that holds the text
  10175. of the header or footer, for complex cases
  10176. where a paragraph isn't used.
  10177. Normally there's just one paragraph, but some
  10178. complex headers/footers have a table or two
  10179. in Addition.
  10180. </member>
  10181. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.Text">
  10182. Returns the textual content of the header/footer,
  10183. by flattening out the text of its paragraph(s)
  10184. </member>
  10185. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.SetHeaderFooter(NPOI.OpenXmlFormats.Wordprocessing.CT_HdrFtr)">
  10186. Set a new headerFooter
  10187. </member>
  10188. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetTable(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  10189. if there is a corresponding {@link XWPFTable} of the parameter ctTable in the tableList of this header
  10190. the method will return this table
  10191. if there is no corresponding {@link XWPFTable} the method will return null
  10192. @param ctTable
  10193. </member>
  10194. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  10195. if there is a corresponding {@link XWPFParagraph} of the parameter ctTable in the paragraphList of this header or footer
  10196. the method will return this paragraph
  10197. if there is no corresponding {@link XWPFParagraph} the method will return null
  10198. @param p is instance of CTP and is searching for an XWPFParagraph
  10199. @return null if there is no XWPFParagraph with an corresponding CTPparagraph in the paragraphList of this header or footer
  10200. XWPFParagraph with the correspondig CTP p
  10201. </member>
  10202. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetParagraphArray(System.Int32)">
  10203. Returns the paragraph that holds
  10204. the text of the header or footer.
  10205. </member>
  10206. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetListParagraph">
  10207. Get a List of all Paragraphs
  10208. @return a list of {@link XWPFParagraph}
  10209. </member>
  10210. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.AllPackagePictures">
  10211. Get all Pictures in this package
  10212. @return all Pictures in this package
  10213. </member>
  10214. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.AddPictureData(System.Byte[],System.Int32)">
  10215. Adds a picture to the document.
  10216. @param pictureData The picture data
  10217. @param format The format of the picture.
  10218. @return the index to this picture (0 based), the Added picture can be obtained from {@link #getAllPictures()} .
  10219. @throws InvalidFormatException
  10220. </member>
  10221. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.AddPictureData(System.IO.Stream,System.Int32)">
  10222. Adds a picture to the document.
  10223. @param is The stream to read image from
  10224. @param format The format of the picture.
  10225. @return the index to this picture (0 based), the Added picture can be obtained from {@link #getAllPictures()} .
  10226. @throws InvalidFormatException
  10227. @
  10228. </member>
  10229. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetPictureDataByID(System.String)">
  10230. returns the PictureData by blipID
  10231. @param blipID
  10232. @return XWPFPictureData of a specificID
  10233. @throws Exception
  10234. </member>
  10235. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.Owner">
  10236. verifies that cursor is on the right position
  10237. @param cursor
  10238. </member>
  10239. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetTableArray(System.Int32)">
  10240. Returns the table at position pos
  10241. @see NPOI.XWPF.UserModel.IBody#getTableArray(int)
  10242. </member>
  10243. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.InsertTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  10244. inserts an existing XWPFTable to the arrays bodyElements and tables
  10245. @param pos
  10246. @param table
  10247. </member>
  10248. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  10249. Get the TableCell which belongs to the TableCell
  10250. @param cell
  10251. </member>
  10252. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.Part">
  10253. returns the Part, to which the body belongs, which you need for Adding relationship to other parts
  10254. @see NPOI.XWPF.UserModel.IBody#getPart()
  10255. </member>
  10256. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.CreateParagraph">
  10257. Adds a new paragraph at the end of the header or footer
  10258. </member>
  10259. <member name="T:NPOI.XWPF.UserModel.XWPFHyperlink">
  10260. * Sketch of XWPF hyperlink class
  10261. *
  10262. * @author Yury Batrakov (batrakov at gmail.com)
  10263. *
  10264. </member>
  10265. <member name="T:NPOI.XWPF.UserModel.XWPFHyperlinkRun">
  10266. A run of text with a Hyperlink applied to it.
  10267. Any given Hyperlink may be made up of multiple of these.
  10268. </member>
  10269. <member name="P:NPOI.XWPF.UserModel.XWPFHyperlinkRun.HyperlinkId">
  10270. Returns the ID of the hyperlink, if one is Set.
  10271. </member>
  10272. <member name="M:NPOI.XWPF.UserModel.XWPFHyperlinkRun.GetHyperlink(NPOI.XWPF.UserModel.XWPFDocument)">
  10273. If this Hyperlink is an external reference hyperlink,
  10274. return the object for it.
  10275. </member>
  10276. <member name="M:NPOI.XWPF.UserModel.XWPFLatentStyles.IsLatentStyle(System.String)">
  10277. checks whether specific LatentStyleID is a latentStyle
  10278. </member>
  10279. <member name="T:NPOI.XWPF.UserModel.XWPFNum">
  10280. @author Philipp Epp
  10281. </member>
  10282. <member name="T:NPOI.XWPF.UserModel.XWPFNumbering">
  10283. @author Philipp Epp
  10284. </member>
  10285. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  10286. create a new styles object with an existing document
  10287. </member>
  10288. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.#ctor">
  10289. create a new XWPFNumbering object for use in a new document
  10290. </member>
  10291. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.OnDocumentRead">
  10292. read numbering form an existing package
  10293. </member>
  10294. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.Commit">
  10295. save and Commit numbering
  10296. </member>
  10297. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.SetNumbering(NPOI.OpenXmlFormats.Wordprocessing.CT_Numbering)">
  10298. Sets the ctNumbering
  10299. @param numbering
  10300. </member>
  10301. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.NumExist(System.String)">
  10302. Checks whether number with numID exists
  10303. @param numID
  10304. @return bool true if num exist, false if num not exist
  10305. </member>
  10306. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.AddNum(NPOI.XWPF.UserModel.XWPFNum)">
  10307. add a new number to the numbering document
  10308. @param num
  10309. </member>
  10310. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.AddNum(System.String)">
  10311. Add a new num with an abstractNumID
  10312. @return return NumId of the Added num
  10313. </member>
  10314. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.AddNum(System.String,System.String)">
  10315. Add a new num with an abstractNumID and a numID
  10316. @param abstractNumID
  10317. @param numID
  10318. </member>
  10319. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.GetNum(System.String)">
  10320. Get Num by NumID
  10321. @param numID
  10322. @return abstractNum with NumId if no Num exists with that NumID
  10323. null will be returned
  10324. </member>
  10325. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.GetAbstractNum(System.String)">
  10326. Get AbstractNum by abstractNumID
  10327. @param abstractNumID
  10328. @return abstractNum with abstractNumId if no abstractNum exists with that abstractNumID
  10329. null will be returned
  10330. </member>
  10331. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.GetIdOfAbstractNum(NPOI.XWPF.UserModel.XWPFAbstractNum)">
  10332. Compare AbstractNum with abstractNums of this numbering document.
  10333. If the content of abstractNum Equals with an abstractNum of the List in numbering
  10334. the Bigint Value of it will be returned.
  10335. If no equal abstractNum is existing null will be returned
  10336. @param abstractNum
  10337. @return Bigint
  10338. </member>
  10339. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.AddAbstractNum(NPOI.XWPF.UserModel.XWPFAbstractNum)">
  10340. add a new AbstractNum and return its AbstractNumID
  10341. @param abstractNum
  10342. </member>
  10343. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.AddAbstractNum">
  10344. <summary>
  10345. Add a new AbstractNum
  10346. </summary>
  10347. <returns></returns>
  10348. @author antony liu
  10349. </member>
  10350. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.RemoveAbstractNum(System.String)">
  10351. remove an existing abstractNum
  10352. @param abstractNumID
  10353. @return true if abstractNum with abstractNumID exists in NumberingArray,
  10354. false if abstractNum with abstractNumID not exists
  10355. </member>
  10356. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.GetAbstractNumID(System.String)">
  10357. return the abstractNumID
  10358. If the AbstractNumID not exists
  10359. return null
  10360. @param numID
  10361. @return abstractNumID
  10362. </member>
  10363. <member name="T:NPOI.XWPF.UserModel.XWPFParagraph">
  10364. <p>A Paragraph within a Document, Table, Header etc.</p>
  10365. <p>A paragraph has a lot of styling information, but the
  10366. actual text (possibly along with more styling) is held on
  10367. the child {@link XWPFRun}s.</p>
  10368. </member>
  10369. <member name="F:NPOI.XWPF.UserModel.XWPFParagraph.document">
  10370. For access to the document's hyperlink, comments, tables etc
  10371. </member>
  10372. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.BuildRunsInOrderFromXml(System.Collections.ArrayList)">
  10373. Identifies (in order) the parts of the paragraph /
  10374. sub-paragraph that correspond to character text
  10375. runs, and builds the appropriate runs for these.
  10376. </member>
  10377. <!-- Badly formed XML comment ignored for member "P:NPOI.XWPF.UserModel.XWPFParagraph.IRuns" -->
  10378. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.Text">
  10379. Return the textual content of the paragraph, including text from pictures
  10380. and std element in it.
  10381. </member>
  10382. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.StyleID">
  10383. Return styleID of the paragraph if style exist for this paragraph
  10384. if not, null will be returned
  10385. @return styleID as String
  10386. </member>
  10387. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetNumID">
  10388. If style exist for this paragraph
  10389. NumId of the paragraph will be returned.
  10390. If style not exist null will be returned
  10391. @return NumID as Bigint
  10392. </member>
  10393. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.SetNumILvl(System.String)">
  10394. <summary>
  10395. setNumILvl of Paragraph
  10396. </summary>
  10397. <param name="iLvl"></param>
  10398. </member>
  10399. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetNumIlvl">
  10400. <summary>
  10401. Returns Ilvl of the numeric style for this paragraph.
  10402. </summary>
  10403. <returns></returns>
  10404. </member>
  10405. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetNumFmt">
  10406. <summary>
  10407. Returns numbering format for this paragraph, eg bullet or lowerLetter.
  10408. </summary>
  10409. <returns></returns>
  10410. </member>
  10411. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.NumLevelText">
  10412. <summary>
  10413. Returns the text that should be used around the paragraph level numbers.
  10414. </summary>
  10415. </member>
  10416. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetNumStartOverride">
  10417. <summary>
  10418. Gets the numstartOverride for the paragraph numbering for this paragraph.
  10419. </summary>
  10420. <returns></returns>
  10421. </member>
  10422. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.SetNumID(System.String)">
  10423. <summary>
  10424. SetNumID of Paragraph
  10425. </summary>
  10426. <param name="numId"></param>
  10427. </member>
  10428. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.SetNumID(System.String,System.String)">
  10429. <summary>
  10430. Set NumID and level of Paragraph
  10431. </summary>
  10432. <param name="numId"></param>
  10433. <param name="ilvl"></param>
  10434. </member>
  10435. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.ParagraphText">
  10436. <summary>
  10437. Returns the text of the paragraph, but not of any objects in the paragraph
  10438. </summary>
  10439. </member>
  10440. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.PictureText">
  10441. <summary>
  10442. Returns any text from any suitable pictures in the paragraph
  10443. </summary>
  10444. </member>
  10445. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.FootnoteText">
  10446. <summary>
  10447. Returns the footnote text of the paragraph
  10448. </summary>
  10449. </member>
  10450. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.Alignment">
  10451. <summary>
  10452. Returns the paragraph alignment which shall be applied to text in this paragraph.
  10453. </summary>
  10454. </member>
  10455. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.FontAlignment">
  10456. <summary>
  10457. The raw alignment value
  10458. </summary>
  10459. </member>
  10460. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.VerticalAlignment">
  10461. Returns the text vertical alignment which shall be applied to text in
  10462. this paragraph.
  10463. <p>
  10464. If the line height (before any Added spacing) is larger than one or more
  10465. characters on the line, all characters will be aligned to each other as
  10466. specified by this element.
  10467. </p>
  10468. <p>
  10469. If this element is omitted on a given paragraph, its value is determined
  10470. by the Setting previously Set at any level of the style hierarchy (i.e.
  10471. that previous Setting remains unChanged). If this Setting is never
  10472. specified in the style hierarchy, then the vertical alignment of all
  10473. characters on the line shall be automatically determined by the consumer.
  10474. </p>
  10475. @return the vertical alignment of this paragraph.
  10476. </member>
  10477. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.BorderTop">
  10478. <summary>
  10479. the top border for the paragraph
  10480. </summary>
  10481. </member>
  10482. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.BorderBottom">
  10483. <summary>
  10484. Specifies the border which shall be displayed below a Set of
  10485. paragraphs which have the same Set of paragraph border Settings.
  10486. </summary>
  10487. <returns>the bottom border for the paragraph</returns>
  10488. </member>
  10489. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.BorderLeft">
  10490. <summary>
  10491. Specifies the border which shall be displayed on the left side of the
  10492. page around the specified paragraph.
  10493. </summary>
  10494. <returns>the left border for the paragraph</returns>
  10495. </member>
  10496. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.BorderRight">
  10497. Specifies the border which shall be displayed on the right side of the
  10498. page around the specified paragraph.
  10499. @return ParagraphBorder - the right border for the paragraph
  10500. @see #setBorderRight(Borders)
  10501. @see Borders for a list of all possible borders
  10502. </member>
  10503. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.BorderBetween">
  10504. Specifies the border which shall be displayed between each paragraph in a
  10505. Set of paragraphs which have the same Set of paragraph border Settings.
  10506. @return ParagraphBorder - the between border for the paragraph
  10507. @see #setBorderBetween(Borders)
  10508. @see Borders for a list of all possible borders
  10509. </member>
  10510. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IsPageBreak">
  10511. Specifies that when rendering this document in a paginated
  10512. view, the contents of this paragraph are rendered on the start of a new
  10513. page in the document.
  10514. <p>
  10515. If this element is omitted on a given paragraph,
  10516. its value is determined by the Setting previously Set at any level of the
  10517. style hierarchy (i.e. that previous Setting remains unChanged). If this
  10518. Setting is never specified in the style hierarchy, then this property
  10519. shall not be applied. Since the paragraph is specified to start on a new
  10520. page, it begins page two even though it could have fit on page one.
  10521. </p>
  10522. @return bool - if page break is Set
  10523. </member>
  10524. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.SpacingAfter">
  10525. Specifies the spacing that should be Added After the last line in this
  10526. paragraph in the document in absolute units.
  10527. @return int - value representing the spacing After the paragraph
  10528. </member>
  10529. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.SpacingAfterLines">
  10530. Specifies the spacing that should be Added After the last line in this
  10531. paragraph in the document in absolute units.
  10532. @return bigint - value representing the spacing After the paragraph
  10533. @see #setSpacingAfterLines(int)
  10534. </member>
  10535. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.SpacingBefore">
  10536. Specifies the spacing that should be Added above the first line in this
  10537. paragraph in the document in absolute units.
  10538. @return the spacing that should be Added above the first line
  10539. @see #setSpacingBefore(int)
  10540. </member>
  10541. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.SpacingBeforeLines">
  10542. Specifies the spacing that should be Added before the first line in this paragraph in the
  10543. document in line units.
  10544. The value of this attribute is specified in one hundredths of a line.
  10545. @return the spacing that should be Added before the first line in this paragraph
  10546. @see #setSpacingBeforeLines(int)
  10547. </member>
  10548. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.SpacingLineRule">
  10549. <summary>
  10550. Specifies how the spacing between lines is calculated as stored in the
  10551. line attribute. If this attribute is omitted, then it shall be assumed to
  10552. be of a value auto if a line attribute value is present.
  10553. </summary>
  10554. </member>
  10555. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.SpacingBetween">
  10556. <summary>
  10557. Return the spacing between lines of a paragraph. The units of the return value depends on the
  10558. <see cref="T:NPOI.XWPF.UserModel.LineSpacingRule"/>. If AUTO, the return value is in lines, otherwise the return
  10559. value is in points
  10560. <return>a double specifying points or lines.</return>
  10561. </summary>
  10562. </member>
  10563. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IndentationLeft">
  10564. Specifies the indentation which shall be placed between the left text
  10565. margin for this paragraph and the left edge of that paragraph's content
  10566. in a left to right paragraph, and the right text margin and the right
  10567. edge of that paragraph's text in a right to left paragraph
  10568. <p>
  10569. If this attribute is omitted, its value shall be assumed to be zero.
  10570. Negative values are defined such that the text is Moved past the text margin,
  10571. positive values Move the text inside the text margin.
  10572. </p>
  10573. @return indentation or null if indentation is not Set
  10574. </member>
  10575. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IndentationRight">
  10576. Specifies the indentation which shall be placed between the right text
  10577. margin for this paragraph and the right edge of that paragraph's content
  10578. in a left to right paragraph, and the right text margin and the right
  10579. edge of that paragraph's text in a right to left paragraph
  10580. <p>
  10581. If this attribute is omitted, its value shall be assumed to be zero.
  10582. Negative values are defined such that the text is Moved past the text margin,
  10583. positive values Move the text inside the text margin.
  10584. </p>
  10585. @return indentation or null if indentation is not Set
  10586. </member>
  10587. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IndentationHanging">
  10588. Specifies the indentation which shall be Removed from the first line of
  10589. the parent paragraph, by moving the indentation on the first line back
  10590. towards the beginning of the direction of text flow.
  10591. This indentation is
  10592. specified relative to the paragraph indentation which is specified for
  10593. all other lines in the parent paragraph.
  10594. The firstLine and hanging
  10595. attributes are mutually exclusive, if both are specified, then the
  10596. firstLine value is ignored.
  10597. @return indentation or null if indentation is not Set
  10598. </member>
  10599. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IndentationFirstLine">
  10600. Specifies the Additional indentation which shall be applied to the first
  10601. line of the parent paragraph. This Additional indentation is specified
  10602. relative to the paragraph indentation which is specified for all other
  10603. lines in the parent paragraph.
  10604. The firstLine and hanging attributes are
  10605. mutually exclusive, if both are specified, then the firstLine value is
  10606. ignored.
  10607. If the firstLineChars attribute is also specified, then this
  10608. value is ignored.
  10609. If this attribute is omitted, then its value shall be
  10610. assumed to be zero (if needed).
  10611. @return indentation or null if indentation is not Set
  10612. </member>
  10613. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IsWordWrapped">
  10614. This element specifies whether a consumer shall break Latin text which
  10615. exceeds the text extents of a line by breaking the word across two lines
  10616. (breaking on the character level) or by moving the word to the following
  10617. line (breaking on the word level).
  10618. @return bool
  10619. </member>
  10620. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.Style">
  10621. @return the style of the paragraph
  10622. </member>
  10623. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetCTPBrd(System.Boolean)">
  10624. Get a <b>copy</b> of the currently used CTPBrd, if none is used, return
  10625. a new instance.
  10626. </member>
  10627. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetCTSpacing(System.Boolean)">
  10628. Get a <b>copy</b> of the currently used CTSpacing, if none is used,
  10629. return a new instance.
  10630. </member>
  10631. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetCTInd(System.Boolean)">
  10632. Get a <b>copy</b> of the currently used CTPInd, if none is used, return
  10633. a new instance.
  10634. </member>
  10635. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetCTPPr">
  10636. Get a <b>copy</b> of the currently used CTPPr, if none is used, return
  10637. a new instance.
  10638. </member>
  10639. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.AddRun(NPOI.OpenXmlFormats.Wordprocessing.CT_R)">
  10640. add a new run at the end of the position of
  10641. the content of parameter run
  10642. @param run
  10643. </member>
  10644. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.ReplaceText(System.String,System.String)">
  10645. <summary>
  10646. Replace text inside each run (cross run is not supported yet)
  10647. </summary>
  10648. <param name="oldText">target text</param>
  10649. <param name="newText">replacement text</param>
  10650. </member>
  10651. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.SearchText(System.String,NPOI.XWPF.UserModel.PositionInParagraph)">
  10652. <summary>
  10653. this methods parse the paragraph and search for the string searched.
  10654. If it finds the string, it will return true and the position of the String will be saved in the parameter startPos.
  10655. </summary>
  10656. <param name="searched"></param>
  10657. <param name="startPos"></param>
  10658. <returns></returns>
  10659. </member>
  10660. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.CreateRun">
  10661. Appends a new run to this paragraph
  10662. @return a new text run
  10663. </member>
  10664. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.CreateOMath">
  10665. Appends a new OMath to this paragraph
  10666. @return a new text run
  10667. </member>
  10668. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.InsertNewRun(System.Int32)">
  10669. <summary>
  10670. insert a new Run in RunArray
  10671. </summary>
  10672. <param name="pos">The position at which the new run should be added.</param>
  10673. <returns>the inserted run or null if the given pos is out of bounds.</returns>
  10674. </member>
  10675. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetText(NPOI.XWPF.UserModel.TextSegment)">
  10676. Get a Text
  10677. @param segment
  10678. </member>
  10679. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.RemoveRun(System.Int32)">
  10680. Removes a Run at the position pos in the paragraph
  10681. @param pos
  10682. @return true if the run was Removed
  10683. </member>
  10684. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.ElementType">
  10685. returns the type of the BodyElement Paragraph
  10686. @see NPOI.XWPF.UserModel.IBodyElement#getElementType()
  10687. </member>
  10688. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.Part">
  10689. returns the part of the bodyElement
  10690. @see NPOI.XWPF.UserModel.IBody#getPart()
  10691. </member>
  10692. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.PartType">
  10693. returns the partType of the bodyPart which owns the bodyElement
  10694. @see NPOI.XWPF.UserModel.IBody#getPartType()
  10695. </member>
  10696. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.AddRun(NPOI.XWPF.UserModel.XWPFRun)">
  10697. Adds a new Run to the Paragraph
  10698. @param r
  10699. </member>
  10700. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetRun(NPOI.OpenXmlFormats.Wordprocessing.CT_R)">
  10701. return the XWPFRun-Element which owns the CTR Run-Element
  10702. @param r
  10703. </member>
  10704. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.CreateHyperlinkRun(System.String)">
  10705. <summary>
  10706. Appends a new hyperlink run to this paragraph
  10707. </summary>
  10708. <param name="rId">a new hyperlink run</param>
  10709. <returns></returns>
  10710. </member>
  10711. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.AddFootnoteReference(NPOI.XWPF.UserModel.XWPFFootnote)">
  10712. <summary>
  10713. Add a new run with a reference to the specified footnote. The footnote reference run will have the style name "FootnoteReference".
  10714. </summary>
  10715. <param name="footnote">Footnote to which to add a reference.</param>
  10716. </member>
  10717. <member name="T:NPOI.XWPF.UserModel.XWPFPicture">
  10718. @author Philipp Epp
  10719. </member>
  10720. <member name="M:NPOI.XWPF.UserModel.XWPFPicture.SetPictureReference(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  10721. Link Picture with PictureData
  10722. @param rel
  10723. </member>
  10724. <member name="M:NPOI.XWPF.UserModel.XWPFPicture.GetCTPicture">
  10725. Return the underlying CTPicture bean that holds all properties for this picture
  10726. @return the underlying CTPicture bean
  10727. </member>
  10728. <member name="M:NPOI.XWPF.UserModel.XWPFPicture.GetPictureData">
  10729. Get the PictureData of the Picture, if present.
  10730. Note - not all kinds of picture have data
  10731. </member>
  10732. <member name="P:NPOI.XWPF.UserModel.XWPFPicture.Width">
  10733. <summary>
  10734. Returns the width of the picture (in points).
  10735. </summary>
  10736. </member>
  10737. <member name="P:NPOI.XWPF.UserModel.XWPFPicture.Height">
  10738. <summary>
  10739. Returns the depth of the picture (in points).
  10740. </summary>
  10741. </member>
  10742. <member name="T:NPOI.XWPF.UserModel.XWPFPictureData">
  10743. <summary>
  10744. Raw picture data, normally attached to a WordProcessingML Drawing. As a rule, pictures are stored in the /word/media/ part of a WordProcessingML package.
  10745. </summary>
  10746. <remarks>
  10747. @author Philipp Epp
  10748. </remarks>
  10749. </member>
  10750. <member name="F:NPOI.XWPF.UserModel.XWPFPictureData.RELATIONS">
  10751. Relationships for each known picture type
  10752. </member>
  10753. <member name="M:NPOI.XWPF.UserModel.XWPFPictureData.#ctor">
  10754. Create a new XWPFGraphicData node
  10755. </member>
  10756. <member name="M:NPOI.XWPF.UserModel.XWPFPictureData.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  10757. Construct XWPFPictureData from a package part
  10758. @param part the package part holding the Drawing data,
  10759. @param rel the package relationship holding this Drawing,
  10760. the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/image
  10761. </member>
  10762. <member name="P:NPOI.XWPF.UserModel.XWPFPictureData.Data">
  10763. Gets the picture data as a byte array.
  10764. <p>
  10765. Note, that this call might be expensive since all the picture data is copied into a temporary byte array.
  10766. You can grab the picture data directly from the underlying package part as follows:
  10767. <br/>
  10768. <code>
  10769. InputStream is1 = GetPackagePart().InputStream;
  10770. </code>
  10771. </p>
  10772. @return the Picture data.
  10773. </member>
  10774. <member name="P:NPOI.XWPF.UserModel.XWPFPictureData.FileName">
  10775. Returns the file name of the image, eg image7.jpg . The original filename
  10776. isn't always available, but if it can be found it's likely to be in the
  10777. CTDrawing
  10778. </member>
  10779. <member name="M:NPOI.XWPF.UserModel.XWPFPictureData.SuggestFileExtension">
  10780. Suggests a file extension for this image.
  10781. @return the file extension.
  10782. </member>
  10783. <member name="M:NPOI.XWPF.UserModel.XWPFPictureData.GetPictureType">
  10784. Return an integer constant that specifies type of this picture
  10785. @return an integer constant that specifies type of this picture
  10786. @see NPOI.XWPF.UserModel.PictureTypeEMF
  10787. @see NPOI.XWPF.UserModel.PictureTypeWMF
  10788. @see NPOI.XWPF.UserModel.PictureTypePICT
  10789. @see NPOI.XWPF.UserModel.PictureTypeJPEG
  10790. @see NPOI.XWPF.UserModel.PictureTypePNG
  10791. @see NPOI.XWPF.UserModel.PictureTypeDIB
  10792. </member>
  10793. <member name="M:NPOI.XWPF.UserModel.XWPFPictureData.PrepareForCommit">
  10794. *PictureData objects store the actual content in the part directly without keeping a
  10795. copy like all others therefore we need to handle them differently.
  10796. </member>
  10797. <member name="T:NPOI.XWPF.UserModel.XWPFRelation">
  10798. @author Yegor Kozlov
  10799. </member>
  10800. <member name="F:NPOI.XWPF.UserModel.XWPFRelation._table">
  10801. A map to lookup POIXMLRelation by its relation type
  10802. </member>
  10803. <member name="F:NPOI.XWPF.UserModel.XWPFRelation.IMAGE_EMF">
  10804. Supported image formats
  10805. </member>
  10806. <member name="M:NPOI.XWPF.UserModel.XWPFRelation.GetInstance(System.String)">
  10807. Get POIXMLRelation by relation type
  10808. @param rel relation type, for example,
  10809. <code>http://schemas.openxmlformats.org/officeDocument/2006/relationships/image</code>
  10810. @return registered POIXMLRelation or null if not found
  10811. </member>
  10812. <member name="T:NPOI.XWPF.UserModel.FontCharRange">
  10813. @see <a href="http://msdn.microsoft.com/en-us/library/ff533743(v=office.12).aspx">[MS-OI29500] Run Fonts</a>
  10814. </member>
  10815. <member name="T:NPOI.XWPF.UserModel.XWPFRun">
  10816. XWPFrun.object defines a region of text with a common Set of properties
  10817. @author Yegor Kozlov
  10818. @author Gregg Morris (gregg dot morris at gmail dot com) - added getColor(), setColor()
  10819. </member>
  10820. <member name="M:NPOI.XWPF.UserModel.XWPFRun.#ctor(NPOI.OpenXmlFormats.Wordprocessing.CT_R,NPOI.XWPF.UserModel.IRunBody)">
  10821. @param r the CT_R bean which holds the run.attributes
  10822. @param p the parent paragraph
  10823. </member>
  10824. <member name="M:NPOI.XWPF.UserModel.XWPFRun.#ctor(NPOI.OpenXmlFormats.Wordprocessing.CT_R,NPOI.XWPF.UserModel.XWPFParagraph)">
  10825. @deprecated Use {@link XWPFRun#XWPFRun(CTR, IRunBody)}
  10826. </member>
  10827. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetCTR">
  10828. Get the currently used CT_R object
  10829. @return CT_R object
  10830. </member>
  10831. <member name="P:NPOI.XWPF.UserModel.XWPFRun.Parent">
  10832. Get the currently referenced paragraph/SDT object
  10833. @return current parent
  10834. </member>
  10835. <member name="P:NPOI.XWPF.UserModel.XWPFRun.Paragraph">
  10836. Get the currently referenced paragraph, or null if a SDT object
  10837. @deprecated use {@link XWPFRun#getParent()} instead
  10838. </member>
  10839. <member name="P:NPOI.XWPF.UserModel.XWPFRun.Document">
  10840. @return The {@link XWPFDocument} instance, this run.belongs to, or
  10841. <code>null</code> if parent structure (paragraph > document) is not properly Set.
  10842. </member>
  10843. <member name="M:NPOI.XWPF.UserModel.XWPFRun.IsCTOnOff(NPOI.OpenXmlFormats.Wordprocessing.CT_OnOff)">
  10844. For isBold, isItalic etc
  10845. </member>
  10846. <member name="P:NPOI.XWPF.UserModel.XWPFRun.IsBold">
  10847. Whether the bold property shall be applied to all non-complex script
  10848. characters in the contents of this run.when displayed in a document.
  10849. <p>
  10850. This formatting property is a toggle property, which specifies that its
  10851. behavior differs between its use within a style defInition and its use as
  10852. direct formatting. When used as part of a style defInition, Setting this
  10853. property shall toggle the current state of that property as specified up
  10854. to this point in the hierarchy (i.e. applied to not applied, and vice
  10855. versa). Setting it to <code>false</code> (or an equivalent) shall
  10856. result in the current Setting remaining unChanged. However, when used as
  10857. direct formatting, Setting this property to true or false shall Set the
  10858. absolute state of the resulting property.
  10859. </p>
  10860. <p>
  10861. If this element is not present, the default value is to leave the
  10862. formatting applied at previous level in the style hierarchy. If this
  10863. element is never applied in the style hierarchy, then bold shall not be
  10864. applied to non-complex script characters.
  10865. </p>
  10866. @param value <code>true</code> if the bold property is applied to
  10867. this run
  10868. </member>
  10869. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetColor">
  10870. Get text color. The returned value is a string in the hex form "RRGGBB".
  10871. </member>
  10872. <member name="M:NPOI.XWPF.UserModel.XWPFRun.SetColor(System.String)">
  10873. Set text color.
  10874. @param rgbStr - the desired color, in the hex form "RRGGBB".
  10875. </member>
  10876. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetText(System.Int32)">
  10877. Return the string content of this text run
  10878. @return the text of this text run.or <code>null</code> if not Set
  10879. </member>
  10880. <member name="P:NPOI.XWPF.UserModel.XWPFRun.PictureText">
  10881. Returns text embedded in pictures
  10882. </member>
  10883. <member name="M:NPOI.XWPF.UserModel.XWPFRun.SetText(System.String)">
  10884. <summary>
  10885. Sets the text of this text run
  10886. </summary>
  10887. <param name="value">the literal text which shall be displayed in the document</param>
  10888. </member>
  10889. <member name="M:NPOI.XWPF.UserModel.XWPFRun.SetText(System.String,System.Int32)">
  10890. <summary>
  10891. Sets the text of this text run.in the
  10892. </summary>
  10893. <param name="value">the literal text which shall be displayed in the document</param>
  10894. <param name="pos">position in the text array (NB: 0 based)</param>
  10895. </member>
  10896. <member name="P:NPOI.XWPF.UserModel.XWPFRun.IsItalic">
  10897. Whether the italic property should be applied to all non-complex script
  10898. characters in the contents of this run.when displayed in a document.
  10899. @return <code>true</code> if the italic property is applied
  10900. </member>
  10901. <member name="P:NPOI.XWPF.UserModel.XWPFRun.Underline">
  10902. Specifies that the contents of this run.should be displayed along with an
  10903. underline appearing directly below the character heigh
  10904. @return the Underline pattern Applyed to this run
  10905. @see UnderlinePatterns
  10906. </member>
  10907. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetCTUnderline(System.Boolean)">
  10908. Get the CTUnderline for the run.
  10909. @param create Create a new underline if necessary
  10910. @return The underline, or null create is false and there is no underline.
  10911. </member>
  10912. <member name="M:NPOI.XWPF.UserModel.XWPFRun.InsertText(System.String,System.Int32)">
  10913. <summary>
  10914. insert text at start index in the run
  10915. </summary>
  10916. <param name="text">insert text</param>
  10917. <param name="startIndex">start index of the insertion in the run text</param>
  10918. </member>
  10919. <member name="P:NPOI.XWPF.UserModel.XWPFRun.IsStrikeThrough">
  10920. Specifies that the contents of this run.shall be displayed with a single
  10921. horizontal line through the center of the line.
  10922. @return <code>true</code> if the strike property is applied
  10923. </member>
  10924. <member name="P:NPOI.XWPF.UserModel.XWPFRun.IsStrike">
  10925. Specifies that the contents of this run.shall be displayed with a single
  10926. horizontal line through the center of the line.
  10927. <p>
  10928. This formatting property is a toggle property, which specifies that its
  10929. behavior differs between its use within a style defInition and its use as
  10930. direct formatting. When used as part of a style defInition, Setting this
  10931. property shall toggle the current state of that property as specified up
  10932. to this point in the hierarchy (i.e. applied to not applied, and vice
  10933. versa). Setting it to false (or an equivalent) shall result in the
  10934. current Setting remaining unChanged. However, when used as direct
  10935. formatting, Setting this property to true or false shall Set the absolute
  10936. state of the resulting property.
  10937. </p>
  10938. <p>
  10939. If this element is not present, the default value is to leave the
  10940. formatting applied at previous level in the style hierarchy. If this
  10941. element is never applied in the style hierarchy, then strikethrough shall
  10942. not be applied to the contents of this run.
  10943. </p>
  10944. @param value <code>true</code> if the strike property is applied to
  10945. this run
  10946. </member>
  10947. <member name="P:NPOI.XWPF.UserModel.XWPFRun.IsDoubleStrikeThrough">
  10948. Specifies that the contents of this run shall be displayed with a double
  10949. horizontal line through the center of the line.
  10950. @return <code>true</code> if the double strike property is applied
  10951. </member>
  10952. <member name="P:NPOI.XWPF.UserModel.XWPFRun.Subscript">
  10953. Specifies the alignment which shall be applied to the contents of this
  10954. run.in relation to the default appearance of the run.s text.
  10955. This allows the text to be repositioned as subscript or superscript without
  10956. altering the font size of the run.properties.
  10957. @return VerticalAlign
  10958. @see VerticalAlign all possible value that could be Applyed to this run
  10959. </member>
  10960. <member name="P:NPOI.XWPF.UserModel.XWPFRun.FontFamily">
  10961. Specifies the fonts which shall be used to display the text contents of
  10962. this run. Specifies a font which shall be used to format all characters
  10963. in the ASCII range (0 - 127) within the parent run
  10964. @return a string representing the font family
  10965. </member>
  10966. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetFontFamily(NPOI.XWPF.UserModel.FontCharRange)">
  10967. Gets the font family for the specified font char range.
  10968. If fcr is null, the font char range "ascii" is used
  10969. @param fcr the font char range, defaults to "ansi"
  10970. @return a string representing the font famil
  10971. </member>
  10972. <member name="M:NPOI.XWPF.UserModel.XWPFRun.SetFontFamily(System.String,NPOI.XWPF.UserModel.FontCharRange)">
  10973. Specifies the fonts which shall be used to display the text contents of
  10974. this run. The default handling for fcr == null is to overwrite the
  10975. ascii font char range with the given font family and also set all not
  10976. specified font ranges
  10977. @param fontFamily
  10978. @param fcr FontCharRange or null for default handling
  10979. </member>
  10980. <member name="P:NPOI.XWPF.UserModel.XWPFRun.FontSize">
  10981. Specifies the font size which shall be applied to all non complex script
  10982. characters in the contents of this run.when displayed.
  10983. @return value representing the font size
  10984. </member>
  10985. <member name="P:NPOI.XWPF.UserModel.XWPFRun.TextPosition">
  10986. This element specifies the amount by which text shall be raised or
  10987. lowered for this run.in relation to the default baseline of the
  10988. surrounding non-positioned text. This allows the text to be repositioned
  10989. without altering the font size of the contents.
  10990. If the val attribute is positive, then the parent run.shall be raised
  10991. above the baseline of the surrounding text by the specified number of
  10992. half-points. If the val attribute is negative, then the parent run.shall
  10993. be lowered below the baseline of the surrounding text by the specified
  10994. number of half-points.
  10995. *
  10996. If this element is not present, the default value is to leave the
  10997. formatting applied at previous level in the style hierarchy. If this
  10998. element is never applied in the style hierarchy, then the text shall not
  10999. be raised or lowered relative to the default baseline location for the
  11000. contents of this run.
  11001. @return a big integer representing the amount of text shall be "moved"
  11002. </member>
  11003. <member name="M:NPOI.XWPF.UserModel.XWPFRun.RemoveBreak">
  11004. </member>
  11005. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddBreak">
  11006. Specifies that a break shall be placed at the current location in the run
  11007. content.
  11008. A break is a special character which is used to override the
  11009. normal line breaking that would be performed based on the normal layout
  11010. of the document's contents.
  11011. @see #AddCarriageReturn()
  11012. </member>
  11013. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddBreak(NPOI.XWPF.UserModel.BreakType)">
  11014. Specifies that a break shall be placed at the current location in the run
  11015. content.
  11016. A break is a special character which is used to override the
  11017. normal line breaking that would be performed based on the normal layout
  11018. of the document's contents.
  11019. <p>
  11020. The behavior of this break character (the
  11021. location where text shall be restarted After this break) shall be
  11022. determined by its type values.
  11023. </p>
  11024. @see BreakType
  11025. </member>
  11026. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddBreak(NPOI.XWPF.UserModel.BreakClear)">
  11027. Specifies that a break shall be placed at the current location in the run
  11028. content. A break is a special character which is used to override the
  11029. normal line breaking that would be performed based on the normal layout
  11030. of the document's contents.
  11031. <p>
  11032. The behavior of this break character (the
  11033. location where text shall be restarted After this break) shall be
  11034. determined by its type (in this case is BreakType.TEXT_WRAPPING as default) and clear attribute values.
  11035. </p>
  11036. @see BreakClear
  11037. </member>
  11038. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddTab">
  11039. Specifies that a tab shall be placed at the current location in
  11040. the run content.
  11041. </member>
  11042. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddCarriageReturn">
  11043. Specifies that a carriage return shall be placed at the
  11044. current location in the run.content.
  11045. A carriage return is used to end the current line of text in
  11046. WordProcess.
  11047. The behavior of a carriage return in run.content shall be
  11048. identical to a break character with null type and clear attributes, which
  11049. shall end the current line and find the next available line on which to
  11050. continue.
  11051. The carriage return character forced the following text to be
  11052. restarted on the next available line in the document.
  11053. </member>
  11054. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddPicture(System.IO.Stream,System.Int32,System.String,System.Int32,System.Int32)">
  11055. Adds a picture to the run. This method handles
  11056. attaching the picture data to the overall file.
  11057. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_EMF
  11058. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_WMF
  11059. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_PICT
  11060. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_JPEG
  11061. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_PNG
  11062. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_DIB
  11063. @param pictureData The raw picture data
  11064. @param pictureType The type of the picture, eg {@link Document#PICTURE_TYPE_JPEG}
  11065. @param width width in EMUs. To convert to / from points use {@link org.apache.poi.util.Units}
  11066. @param height height in EMUs. To convert to / from points use {@link org.apache.poi.util.Units}
  11067. @throws NPOI.Openxml4j.exceptions.InvalidFormatException
  11068. @throws IOException
  11069. </member>
  11070. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetEmbeddedPictures">
  11071. Returns the embedded pictures of the run. These
  11072. are pictures which reference an external,
  11073. embedded picture image such as a .png or .jpg
  11074. </member>
  11075. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetStyle">
  11076. <summary>
  11077. 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.
  11078. </summary>
  11079. <returns></returns>
  11080. </member>
  11081. <member name="M:NPOI.XWPF.UserModel.XWPFRun.preserveSpaces(NPOI.OpenXmlFormats.Wordprocessing.CT_Text)">
  11082. Add the xml:spaces="preserve" attribute if the string has leading or trailing white spaces
  11083. @param xs the string to check
  11084. </member>
  11085. <member name="M:NPOI.XWPF.UserModel.XWPFRun.ToString">
  11086. Returns the string version of the text, with tabs and
  11087. carriage returns in place of their xml equivalents.
  11088. </member>
  11089. <member name="T:NPOI.XWPF.UserModel.XWPFSDT">
  11090. Experimental class to offer rudimentary Read-only Processing of
  11091. of StructuredDocumentTags/ContentControl
  11092. WARNING - APIs expected to change rapidly
  11093. </member>
  11094. <member name="T:NPOI.XWPF.UserModel.XWPFSDTCell">
  11095. Experimental class to offer rudimentary Read-only Processing of
  11096. of StructuredDocumentTags/ContentControl that can appear
  11097. in a table row as if a table cell.
  11098. <p/>
  11099. These can contain one or more cells or other SDTs within them.
  11100. <p/>
  11101. WARNING - APIs expected to change rapidly
  11102. </member>
  11103. <member name="T:NPOI.XWPF.UserModel.XWPFSDTContent">
  11104. Experimental class to offer rudimentary Read-only Processing of
  11105. of the contentblock of an SDT/ContentControl.
  11106. WARNING - APIs expected to change rapidly
  11107. </member>
  11108. <member name="T:NPOI.XWPF.UserModel.XWPFSDTContentCell">
  11109. Experimental class to offer rudimentary Read-only Processing of
  11110. of the XWPFSDTCellContent.
  11111. <p/>
  11112. WARNING - APIs expected to change rapidly
  11113. </member>
  11114. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.GetZoomPercent">
  11115. In the zoom tag inside Settings.xml file <br/>
  11116. it Sets the value of zoom
  11117. @return percentage as an integer of zoom level
  11118. </member>
  11119. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.SetZoomPercent(System.Int64)">
  11120. <summary>
  11121. Set zoom. In the zoom tag inside settings.xml file it sets the value of zoom
  11122. </summary>
  11123. <param name="zoomPercent"></param>
  11124. <example>
  11125. sample snippet from Settings.xml
  11126. &lt;w:zoom w:percent="50" /&gt;
  11127. </example>
  11128. </member>
  11129. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.IsEnforcedWith">
  11130. Verifies the documentProtection tag inside settings.xml file <br/>
  11131. if the protection is enforced (w:enforcement="1") <br/>
  11132. <p/>
  11133. <br/>
  11134. sample snippet from settings.xml
  11135. <pre>
  11136. &lt;w:settings ... &gt;
  11137. &lt;w:documentProtection w:edit=&quot;readOnly&quot; w:enforcement=&quot;1&quot;/&gt;
  11138. </pre>
  11139. @return true if documentProtection is enforced with option any
  11140. </member>
  11141. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.IsEnforcedWith(NPOI.OpenXmlFormats.Wordprocessing.ST_DocProtect)">
  11142. Verifies the documentProtection tag inside Settings.xml file <br/>
  11143. if the protection is enforced (w:enforcement="1") <br/>
  11144. and if the kind of protection Equals to passed (STDocProtect.Enum editValue) <br/>
  11145. <br/>
  11146. sample snippet from Settings.xml
  11147. <pre>
  11148. &lt;w:settings ... &gt;
  11149. &lt;w:documentProtection w:edit=&quot;readOnly&quot; w:enforcement=&quot;1&quot;/&gt;
  11150. </pre>
  11151. @return true if documentProtection is enforced with option ReadOnly
  11152. </member>
  11153. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.SetEnforcementEditValue(NPOI.OpenXmlFormats.Wordprocessing.ST_DocProtect)">
  11154. Enforces the protection with the option specified by passed editValue.<br/>
  11155. <br/>
  11156. In the documentProtection tag inside Settings.xml file <br/>
  11157. it Sets the value of enforcement to "1" (w:enforcement="1") <br/>
  11158. and the value of edit to the passed editValue (w:edit="[passed editValue]")<br/>
  11159. <br/>
  11160. sample snippet from Settings.xml
  11161. <pre>
  11162. &lt;w:settings ... &gt;
  11163. &lt;w:documentProtection w:edit=&quot;[passed editValue]&quot; w:enforcement=&quot;1&quot;/&gt;
  11164. </pre>
  11165. </member>
  11166. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.RemoveEnforcement">
  11167. Removes protection enforcement.<br/>
  11168. In the documentProtection tag inside Settings.xml file <br/>
  11169. it Sets the value of enforcement to "0" (w:enforcement="0") <br/>
  11170. </member>
  11171. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.SetUpdateFields">
  11172. Enforces fields update on document open (in Word).
  11173. In the settings.xml file <br/>
  11174. sets the updateSettings value to true (w:updateSettings w:val="true")
  11175. NOTICES:
  11176. <ul>
  11177. <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?"
  11178. (if "Update automatic links at open" is enabled)</li>
  11179. <li>Flag is removed after saving with changes in Word </li>
  11180. </ul>
  11181. </member>
  11182. <member name="P:NPOI.XWPF.UserModel.XWPFSettings.IsTrackRevisions">
  11183. get or set revision tracking
  11184. </member>
  11185. <member name="T:NPOI.XWPF.UserModel.XWPFStyle">
  11186. @author Philipp Epp
  11187. </member>
  11188. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.#ctor(NPOI.OpenXmlFormats.Wordprocessing.CT_Style)">
  11189. constructor
  11190. @param style
  11191. </member>
  11192. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.#ctor(NPOI.OpenXmlFormats.Wordprocessing.CT_Style,NPOI.XWPF.UserModel.XWPFStyles)">
  11193. constructor
  11194. @param style
  11195. @param styles
  11196. </member>
  11197. <member name="P:NPOI.XWPF.UserModel.XWPFStyle.StyleId">
  11198. Get StyleID of the style
  11199. @return styleID StyleID of the style
  11200. </member>
  11201. <member name="P:NPOI.XWPF.UserModel.XWPFStyle.StyleType">
  11202. Get Type of the Style
  11203. @return ctType
  11204. </member>
  11205. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.SetStyle(NPOI.OpenXmlFormats.Wordprocessing.CT_Style)">
  11206. Set style
  11207. @param style
  11208. </member>
  11209. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.GetCTStyle">
  11210. Get ctStyle
  11211. @return ctStyle
  11212. </member>
  11213. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.GetStyles">
  11214. Get styles
  11215. @return styles the styles to which this style belongs
  11216. </member>
  11217. <member name="P:NPOI.XWPF.UserModel.XWPFStyle.LinkStyleID">
  11218. Get StyleID of the linked Style
  11219. </member>
  11220. <member name="P:NPOI.XWPF.UserModel.XWPFStyle.NextStyleID">
  11221. Get StyleID of the next style
  11222. </member>
  11223. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.HasSameName(NPOI.XWPF.UserModel.XWPFStyle)">
  11224. Compares the names of the Styles
  11225. @param compStyle
  11226. </member>
  11227. <member name="T:NPOI.XWPF.UserModel.XWPFStyles">
  11228. Holds details of built-in, default and user styles, which
  11229. apply to tables / paragraphs / lists etc.
  11230. Text within one of those with custom stylings has the style
  11231. information stored in the {@link XWPFRun}
  11232. </member>
  11233. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  11234. Construct XWPFStyles from a package part
  11235. @param part the package part holding the data of the styles,
  11236. @param rel the package relationship of type "http://schemas.Openxmlformats.org/officeDocument/2006/relationships/styles"
  11237. </member>
  11238. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.#ctor">
  11239. Construct XWPFStyles from scratch for a new document.
  11240. </member>
  11241. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.OnDocumentRead">
  11242. Read document
  11243. </member>
  11244. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.SetStyles(NPOI.OpenXmlFormats.Wordprocessing.CT_Styles)">
  11245. Sets the ctStyles
  11246. @param styles
  11247. </member>
  11248. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.StyleExist(System.String)">
  11249. Checks whether style with styleID exist
  11250. @param styleID styleID of the Style in the style-Document
  11251. @return true if style exist, false if style not exist
  11252. </member>
  11253. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.AddStyle(NPOI.XWPF.UserModel.XWPFStyle)">
  11254. add a style to the document
  11255. @param style
  11256. @throws IOException
  11257. </member>
  11258. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.GetStyle(System.String)">
  11259. get style by a styleID
  11260. @param styleID styleID of the searched style
  11261. @return style
  11262. </member>
  11263. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.GetStyleWithName(System.String)">
  11264. get the style with the specified name, if any.
  11265. @param styleName The name of the style to get, e.g., "Heading 1"
  11266. @return style
  11267. </member>
  11268. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.GetUsedStyleList(NPOI.XWPF.UserModel.XWPFStyle)">
  11269. Get the styles which are related to the parameter style and their relatives
  11270. this method can be used to copy all styles from one document to another document
  11271. @param style
  11272. @return a list of all styles which were used by this method
  11273. </member>
  11274. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.GetUsedStyleList(NPOI.XWPF.UserModel.XWPFStyle,System.Collections.Generic.List{NPOI.XWPF.UserModel.XWPFStyle})">
  11275. Get the styles which are related to parameter style
  11276. @param style
  11277. @return all Styles of the parameterList
  11278. </member>
  11279. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.SetSpellingLanguage(System.String)">
  11280. Sets the default spelling language on ctStyles DocDefaults parameter
  11281. @param strSpellingLanguage
  11282. </member>
  11283. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.SetEastAsia(System.String)">
  11284. Sets the default East Asia spelling language on ctStyles DocDefaults parameter
  11285. @param strEastAsia
  11286. </member>
  11287. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.SetDefaultFonts(NPOI.OpenXmlFormats.Wordprocessing.CT_Fonts)">
  11288. Sets the default font on ctStyles DocDefaults parameter
  11289. TODO Replace this with specific Setters for each type, possibly
  11290. on XWPFDefaultRunStyle
  11291. </member>
  11292. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.GetStyleWithSameName(NPOI.XWPF.UserModel.XWPFStyle)">
  11293. Get the style with the same name
  11294. if this style is not existing, return null
  11295. </member>
  11296. <member name="P:NPOI.XWPF.UserModel.XWPFStyles.DefaultRunStyle">
  11297. Get the default style which applies text runs in the document
  11298. </member>
  11299. <member name="P:NPOI.XWPF.UserModel.XWPFStyles.DefaultParagraphStyle">
  11300. Get the default paragraph style which applies to the document
  11301. </member>
  11302. <member name="P:NPOI.XWPF.UserModel.XWPFStyles.LatentStyles">
  11303. Get the definition of all the Latent Styles
  11304. </member>
  11305. <member name="T:NPOI.XWPF.UserModel.XWPFTable">
  11306. <p>Sketch of XWPFTable class. Only table's text is being hold.</p>
  11307. <p>Specifies the contents of a table present in the document. A table is a set
  11308. of paragraphs (and other block-level content) arranged in rows and columns.</p>
  11309. </member>
  11310. <member name="M:NPOI.XWPF.UserModel.XWPFTable.GetCTTbl">
  11311. @return ctTbl object
  11312. </member>
  11313. <!-- Badly formed XML comment ignored for member "P:NPOI.XWPF.UserModel.XWPFTable.Text" -->
  11314. <member name="M:NPOI.XWPF.UserModel.XWPFTable.AddNewCol">
  11315. add a new column for each row in this table
  11316. </member>
  11317. <member name="M:NPOI.XWPF.UserModel.XWPFTable.CreateRow">
  11318. create a new XWPFTableRow object with as many cells as the number of columns defined in that moment
  11319. @return tableRow
  11320. </member>
  11321. <member name="M:NPOI.XWPF.UserModel.XWPFTable.GetRow(System.Int32)">
  11322. @param pos - index of the row
  11323. @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
  11324. </member>
  11325. <member name="P:NPOI.XWPF.UserModel.XWPFTable.Width">
  11326. @return width value
  11327. </member>
  11328. <member name="P:NPOI.XWPF.UserModel.XWPFTable.NumberOfRows">
  11329. @return number of rows in table
  11330. </member>
  11331. <member name="P:NPOI.XWPF.UserModel.XWPFTable.StyleID">
  11332. Get the StyleID of the table
  11333. @return style-ID of the table
  11334. </member>
  11335. <member name="M:NPOI.XWPF.UserModel.XWPFTable.AddRow(NPOI.XWPF.UserModel.XWPFTableRow)">
  11336. add a new Row to the table
  11337. @param row the row which should be Added
  11338. </member>
  11339. <member name="M:NPOI.XWPF.UserModel.XWPFTable.AddRow(NPOI.XWPF.UserModel.XWPFTableRow,System.Int32)">
  11340. add a new Row to the table
  11341. at position pos
  11342. @param row the row which should be Added
  11343. </member>
  11344. <member name="M:NPOI.XWPF.UserModel.XWPFTable.InsertNewTableRow(System.Int32)">
  11345. inserts a new tablerow
  11346. @param pos
  11347. @return the inserted row
  11348. </member>
  11349. <member name="M:NPOI.XWPF.UserModel.XWPFTable.RemoveRow(System.Int32)">
  11350. Remove a row at position pos from the table
  11351. @param pos position the Row in the Table
  11352. </member>
  11353. <member name="P:NPOI.XWPF.UserModel.XWPFTable.ElementType">
  11354. returns the type of the BodyElement Table
  11355. @see NPOI.XWPF.UserModel.IBodyElement#getElementType()
  11356. </member>
  11357. <member name="P:NPOI.XWPF.UserModel.XWPFTable.Part">
  11358. returns the part of the bodyElement
  11359. @see NPOI.XWPF.UserModel.IBody#getPart()
  11360. </member>
  11361. <member name="P:NPOI.XWPF.UserModel.XWPFTable.PartType">
  11362. returns the partType of the bodyPart which owns the bodyElement
  11363. @see NPOI.XWPF.UserModel.IBody#getPartType()
  11364. </member>
  11365. <member name="M:NPOI.XWPF.UserModel.XWPFTable.GetRow(NPOI.OpenXmlFormats.Wordprocessing.CT_Row)">
  11366. returns the XWPFRow which belongs to the CTRow row
  11367. if this row is not existing in the table null will be returned
  11368. </member>
  11369. <member name="T:NPOI.XWPF.UserModel.XWPFTableCell">
  11370. Represents a Cell within a {@link XWPFTable}. The
  11371. Cell is the thing that holds the actual content (paragraphs etc)
  11372. </member>
  11373. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.#ctor(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc,NPOI.XWPF.UserModel.XWPFTableRow,NPOI.XWPF.UserModel.IBody)">
  11374. If a table cell does not include at least one block-level element, then this document shall be considered corrupt
  11375. </member>
  11376. <member name="P:NPOI.XWPF.UserModel.XWPFTableCell.BodyElements">
  11377. returns an Iterator with paragraphs and tables
  11378. @see NPOI.XWPF.UserModel.IBody#getBodyElements()
  11379. </member>
  11380. <member name="P:NPOI.XWPF.UserModel.XWPFTableCell.Paragraphs">
  11381. returns a list of paragraphs
  11382. </member>
  11383. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.AddParagraph">
  11384. Add a Paragraph to this Table Cell
  11385. @return The paragraph which was Added
  11386. </member>
  11387. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.AddParagraph(NPOI.XWPF.UserModel.XWPFParagraph)">
  11388. add a Paragraph to this TableCell
  11389. @param p the paragaph which has to be Added
  11390. </member>
  11391. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.RemoveParagraph(System.Int32)">
  11392. Removes a paragraph of this tablecell
  11393. @param pos
  11394. </member>
  11395. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  11396. if there is a corresponding {@link XWPFParagraph} of the parameter ctTable in the paragraphList of this table
  11397. the method will return this paragraph
  11398. if there is no corresponding {@link XWPFParagraph} the method will return null
  11399. @param p is instance of CTP and is searching for an XWPFParagraph
  11400. @return null if there is no XWPFParagraph with an corresponding CTPparagraph in the paragraphList of this table
  11401. XWPFParagraph with the correspondig CTP p
  11402. </member>
  11403. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.SetBorderBottom(NPOI.XWPF.UserModel.XWPFTable.XWPFBorderType,System.Int32,System.Int32,System.String)">
  11404. <summary>
  11405. Add bottom border to cell
  11406. </summary>
  11407. <param name="type">Border Style</param>
  11408. <param name="size">Border Width</param>
  11409. <param name="space">Border Spacing Measurement</param>
  11410. <param name="rgbColor">Border Color</param>
  11411. </member>
  11412. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.SetBorderTop(NPOI.XWPF.UserModel.XWPFTable.XWPFBorderType,System.Int32,System.Int32,System.String)">
  11413. <summary>
  11414. Add top border to cell
  11415. </summary>
  11416. <param name="type">Border Style</param>
  11417. <param name="size">Border Width</param>
  11418. <param name="space">Border Spacing Measurement</param>
  11419. <param name="rgbColor">Border Color</param>
  11420. </member>
  11421. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.SetBorderLeft(NPOI.XWPF.UserModel.XWPFTable.XWPFBorderType,System.Int32,System.Int32,System.String)">
  11422. <summary>
  11423. Add left border to cell
  11424. </summary>
  11425. <param name="type">Border Style</param>
  11426. <param name="size">Border Width</param>
  11427. <param name="space">Border Spacing Measurement</param>
  11428. <param name="rgbColor">Border Color</param>
  11429. </member>
  11430. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.SetBorderRight(NPOI.XWPF.UserModel.XWPFTable.XWPFBorderType,System.Int32,System.Int32,System.String)">
  11431. <summary>
  11432. Add right border to cell
  11433. </summary>
  11434. <param name="type">Border Style</param>
  11435. <param name="size">Border Width</param>
  11436. <param name="space"></param>
  11437. <param name="rgbColor">Border Color</param>
  11438. </member>
  11439. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.CreateBorder(NPOI.XWPF.UserModel.XWPFTable.XWPFBorderType,System.Int32,System.Int32,System.String)">
  11440. <summary>
  11441. Creates border with parameters
  11442. </summary>
  11443. <param name="type">Border Style</param>
  11444. <param name="size">Border Width</param>
  11445. <param name="space">Border Spacing Measurement</param>
  11446. <param name="rgbColor">Border Color</param>
  11447. <returns>CT_Border object</returns>
  11448. </member>
  11449. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.SetColor(System.String)">
  11450. Set cell color. This sets some associated values; for finer control
  11451. you may want to access these elements individually.
  11452. @param rgbStr - the desired cell color, in the hex form "RRGGBB".
  11453. </member>
  11454. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetColor">
  11455. Get cell color. Note that this method only returns the "fill" value.
  11456. @return RGB string of cell color
  11457. </member>
  11458. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.SetVerticalAlignment(NPOI.XWPF.UserModel.XWPFTableCell.XWPFVertAlign)">
  11459. Set the vertical alignment of the cell.
  11460. @param vAlign - the desired alignment enum value
  11461. </member>
  11462. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetVerticalAlignment">
  11463. Get the vertical alignment of the cell.
  11464. @return the cell alignment enum value or null if no vertical alignment is set
  11465. </member>
  11466. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.InsertNewParagraph(System.Xml.XmlDocument)">
  11467. add a new paragraph at position of the cursor
  11468. @param cursor
  11469. @return the inserted paragraph
  11470. </member>
  11471. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.IsCursorInTableCell(System.Xml.XmlDocument)">
  11472. verifies that cursor is on the right position
  11473. </member>
  11474. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetParagraphArray(System.Int32)">
  11475. @see NPOI.XWPF.UserModel.IBody#getParagraphArray(int)
  11476. </member>
  11477. <member name="P:NPOI.XWPF.UserModel.XWPFTableCell.Part">
  11478. Get the to which the TableCell belongs
  11479. @see NPOI.XWPF.UserModel.IBody#getPart()
  11480. </member>
  11481. <member name="P:NPOI.XWPF.UserModel.XWPFTableCell.PartType">
  11482. @see NPOI.XWPF.UserModel.IBody#getPartType()
  11483. </member>
  11484. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetTable(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  11485. Get a table by its CTTbl-Object
  11486. @see NPOI.XWPF.UserModel.IBody#getTable(org.Openxmlformats.schemas.wordProcessingml.x2006.main.CTTbl)
  11487. </member>
  11488. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetTableArray(System.Int32)">
  11489. @see NPOI.XWPF.UserModel.IBody#getTableArray(int)
  11490. </member>
  11491. <member name="P:NPOI.XWPF.UserModel.XWPFTableCell.Tables">
  11492. @see NPOI.XWPF.UserModel.IBody#getTables()
  11493. </member>
  11494. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.InsertTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  11495. inserts an existing XWPFTable to the arrays bodyElements and tables
  11496. @see NPOI.XWPF.UserModel.IBody#insertTable(int, NPOI.XWPF.UserModel.XWPFTable)
  11497. </member>
  11498. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetTextRecursively">
  11499. extracts all text recursively through embedded tables and embedded SDTs
  11500. </member>
  11501. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  11502. Get the TableCell which belongs to the TableCell
  11503. </member>
  11504. <member name="T:NPOI.XWPF.UserModel.XWPFTableRow">
  11505. A row within an {@link XWPFTable}. Rows mostly just have
  11506. sizings and stylings, the interesting content lives inside
  11507. the child {@link XWPFTableCell}s
  11508. </member>
  11509. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.CreateCell">
  11510. create a new XWPFTableCell and add it to the tableCell-list of this tableRow
  11511. @return the newly Created XWPFTableCell
  11512. </member>
  11513. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.AddNewTableCell">
  11514. Adds a new TableCell at the end of this tableRow
  11515. </member>
  11516. <member name="P:NPOI.XWPF.UserModel.XWPFTableRow.Height">
  11517. This element specifies the height of the current table row within the
  11518. current table. This height shall be used to determine the resulting
  11519. height of the table row, which may be absolute or relative (depending on
  11520. its attribute values). If omitted, then the table row shall automatically
  11521. resize its height to the height required by its contents (the equivalent
  11522. of an hRule value of auto).
  11523. @return height
  11524. </member>
  11525. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.GetTableICells">
  11526. create and return a list of all XWPFTableCell
  11527. who belongs to this row
  11528. @return a list of {@link XWPFTableCell}
  11529. </member>
  11530. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.GetTableCells">
  11531. create and return a list of all XWPFTableCell
  11532. who belongs to this row
  11533. @return a list of {@link XWPFTableCell}
  11534. </member>
  11535. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  11536. returns the XWPFTableCell which belongs to the CTTC cell
  11537. if there is no XWPFTableCell which belongs to the parameter CTTc cell null will be returned
  11538. </member>
  11539. <member name="P:NPOI.XWPF.UserModel.XWPFTableRow.IsCantSplitRow">
  11540. Return true if the "can't split row" value is true. The logic for this
  11541. attribute is a little unusual: a TRUE value means DON'T allow rows to
  11542. split, FALSE means allow rows to split.
  11543. @return true if rows can't be split, false otherwise.
  11544. </member>
  11545. <member name="P:NPOI.XWPF.UserModel.XWPFTableRow.IsRepeatHeader">
  11546. Return true if a table's header row should be repeated at the top of a
  11547. table split across pages.
  11548. @return true if table's header row should be repeated at the top of each
  11549. page of table, false otherwise.
  11550. </member>
  11551. <member name="M:NPOI.XWPF.Usermodel.MathContainer.CreateAcc">
  11552. <summary>
  11553. Create Accent
  11554. </summary>
  11555. <returns></returns>
  11556. </member>
  11557. <member name="M:NPOI.XWPF.Usermodel.MathContainer.CreateNary">
  11558. <summary>
  11559. Create n-ary Operator Object
  11560. </summary>
  11561. <returns></returns>
  11562. </member>
  11563. <member name="M:NPOI.XWPF.Usermodel.MathContainer.CreateSSub">
  11564. <summary>
  11565. Subscript Object
  11566. </summary>
  11567. <returns></returns>
  11568. </member>
  11569. <member name="M:NPOI.XWPF.Usermodel.MathContainer.CreateSSup">
  11570. <summary>
  11571. Superscript Object
  11572. </summary>
  11573. <returns></returns>
  11574. </member>
  11575. <member name="M:NPOI.XWPF.Usermodel.MathContainer.CreateF">
  11576. <summary>
  11577. Fraction Object
  11578. </summary>
  11579. <returns></returns>
  11580. </member>
  11581. <member name="M:NPOI.XWPF.Usermodel.MathContainer.CreateRad">
  11582. <summary>
  11583. Radical Object
  11584. </summary>
  11585. <returns></returns>
  11586. </member>
  11587. <member name="T:NPOI.XWPF.Usermodel.XWPFAcc">
  11588. <summary>
  11589. Accent
  11590. This element specifies the accent function, consisting of a base
  11591. and a combining diacritical mark. If accPr is
  11592. omitted, the default accent is U+0302 (COMBINING CIRCUMFLEX ACCENT).
  11593. </summary>
  11594. </member>
  11595. <member name="P:NPOI.XWPF.Usermodel.XWPFAcc.AccPr">
  11596. <summary>
  11597. Single char or UTF, like: &#771;
  11598. </summary>
  11599. </member>
  11600. <member name="P:NPOI.XWPF.Usermodel.XWPFAcc.Element">
  11601. <summary>
  11602. This tag, which is an abbreviation for “element”, serves several functions (18 total) including that of the base
  11603. argument of a mathematical object or function, the elements in an array, and the elements in boxes.If all
  11604. subelements are omitted, this element specifies the presence of an empty argument.
  11605. </summary>
  11606. </member>
  11607. <member name="T:NPOI.XWPF.Usermodel.XWPFF">
  11608. <summary>
  11609. Fraction Object
  11610. This element specifies the fraction object, consisting of a numerator and denominator separated by a fraction
  11611. bar.The fraction bar can be horizontal or diagonal, depending on the fraction properties.The fraction object is
  11612. also used to represent the stack function, which places one element above another, with no fraction bar.
  11613. </summary>
  11614. </member>
  11615. <member name="P:NPOI.XWPF.Usermodel.XWPFF.FractionType">
  11616. <summary>
  11617. This element specifies the properties of the fraction object f. Properties of the Fraction object include the type
  11618. or style of the fraction.The fraction bar can be horizontal or diagonal, depending on the fraction properties.The
  11619. fraction object is also used to represent the stack function, which places one element above another, with no
  11620. fraction bar.
  11621. </summary>
  11622. </member>
  11623. <member name="P:NPOI.XWPF.Usermodel.XWPFF.Numerator">
  11624. <summary>
  11625. This element specifies the numerator of the Fraction object f
  11626. </summary>
  11627. </member>
  11628. <member name="P:NPOI.XWPF.Usermodel.XWPFF.Denominator">
  11629. <summary>
  11630. This element specifies the denominator of a fraction
  11631. </summary>
  11632. </member>
  11633. <member name="T:NPOI.XWPF.Usermodel.XWPFNary">
  11634. <summary>
  11635. n-ary Operator Object
  11636. This element specifies an n-ary object, consisting of an n-ary object, a base (or operand), and optional upper and
  11637. lower limits
  11638. </summary>
  11639. </member>
  11640. <member name="P:NPOI.XWPF.Usermodel.XWPFNary.Element">
  11641. <summary>
  11642. This tag, which is an abbreviation for “element”, serves several functions (18 total) including that of the base
  11643. argument of a mathematical object or function, the elements in an array, and the elements in boxes.If all
  11644. subelements are omitted, this element specifies the presence of an empty argument.
  11645. </summary>
  11646. </member>
  11647. <member name="P:NPOI.XWPF.Usermodel.XWPFNary.Subscript">
  11648. <summary>
  11649. This element specifies the subscript of the Pre-Sub-Superscript object sPre
  11650. </summary>
  11651. </member>
  11652. <member name="P:NPOI.XWPF.Usermodel.XWPFNary.Superscript">
  11653. <summary>
  11654. This element specifies the superscript of the superscript object sSup.
  11655. </summary>
  11656. </member>
  11657. <member name="P:NPOI.XWPF.Usermodel.XWPFNary.NaryPr">
  11658. <summary>
  11659. Get Nary symbol
  11660. </summary>
  11661. </member>
  11662. <member name="M:NPOI.XWPF.Usermodel.XWPFNary.SetSumm">
  11663. <summary>
  11664. Sets ∑ char
  11665. </summary>
  11666. </member>
  11667. <member name="M:NPOI.XWPF.Usermodel.XWPFNary.SetUnion">
  11668. <summary>
  11669. Sets ⋃ char
  11670. </summary>
  11671. </member>
  11672. <member name="M:NPOI.XWPF.Usermodel.XWPFNary.SetIntegral">
  11673. <summary>
  11674. Sets ∫ char
  11675. </summary>
  11676. </member>
  11677. <member name="M:NPOI.XWPF.Usermodel.XWPFNary.SetAnd">
  11678. <summary>
  11679. Sets ⋀ char
  11680. </summary>
  11681. </member>
  11682. <member name="T:NPOI.XWPF.Usermodel.XWPFRad">
  11683. <summary>
  11684. Radical Object
  11685. This element specifies the radical object, consisting of a radical, a base e, and an optional degree deg. [Example:
  11686. Example of rad are √𝑥
  11687. </summary>
  11688. </member>
  11689. <member name="P:NPOI.XWPF.Usermodel.XWPFRad.Degree">
  11690. <summary>
  11691. This element specifies the degree in the mathematical radical. This element is optional. When omitted, the
  11692. square root function, as in √𝑥, is assumed.
  11693. </summary>
  11694. </member>
  11695. <member name="P:NPOI.XWPF.Usermodel.XWPFRad.Element">
  11696. <summary>
  11697. Radical expression element.
  11698. </summary>
  11699. </member>
  11700. <member name="M:NPOI.XWPF.Usermodel.XWPFSharedRun.IsCTOnOff(NPOI.OpenXmlFormats.Wordprocessing.CT_OnOff)">
  11701. For isBold, isItalic etc
  11702. </member>
  11703. <member name="M:NPOI.XWPF.Usermodel.XWPFSharedRun.SetFontFamily(System.String,NPOI.XWPF.UserModel.FontCharRange)">
  11704. <summary>
  11705. Specifies the fonts which shall be used to display the text contents of
  11706. this run.The default handling for fcr == null is to overwrite the
  11707. ascii font char range with the given font family and also set all not
  11708. specified font ranges
  11709. </summary>
  11710. <param name="fontFamily">fontFamily</param>
  11711. <param name="fcr">FontCharRange or null for default handling</param>
  11712. </member>
  11713. <member name="M:NPOI.XWPF.Usermodel.XWPFSharedRun.GetFontFamily(NPOI.XWPF.UserModel.FontCharRange)">
  11714. <summary>
  11715. Gets the font family for the specified font char range.
  11716. If fcr is null, the font char range "ascii" is used
  11717. Please use "Cambria Math"(set as default) font otherwise MS Word
  11718. don't open file, LibreOffice Writer open it normaly.
  11719. I think this is MS Word bug, because this is not standart.
  11720. </summary>
  11721. <param name="fcr">the font char range, defaults to "ansi"</param>
  11722. <returns>a string representing the font famil</returns>
  11723. </member>
  11724. <member name="M:NPOI.XWPF.Usermodel.XWPFSharedRun.SetText(System.String)">
  11725. <summary>
  11726. Sets the text of this text run
  11727. </summary>
  11728. <param name="value">the literal text which shall be displayed in the document</param>
  11729. </member>
  11730. <member name="M:NPOI.XWPF.Usermodel.XWPFSharedRun.SetText(System.String,System.Int32)">
  11731. <summary>
  11732. Sets the text of this text run.in the
  11733. </summary>
  11734. <param name="value">the literal text which shall be displayed in the document</param>
  11735. <param name="pos">position in the text array (NB: 0 based)</param>
  11736. </member>
  11737. <member name="M:NPOI.XWPF.Usermodel.XWPFSharedRun.preserveSpaces(NPOI.OpenXmlFormats.Shared.CT_Text1)">
  11738. <summary>
  11739. Add the xml:spaces="preserve" attribute if the string has leading or trailing white spaces
  11740. </summary>
  11741. <param name="xs">the string to check</param>
  11742. </member>
  11743. <member name="T:NPOI.XWPF.Usermodel.XWPFSSub">
  11744. <summary>
  11745. Subscript Object
  11746. his element specifies the subscript object sSub, which consists of a base e and a reduced-size scr placed below
  11747. and to the right, as in Xn
  11748. </summary>
  11749. </member>
  11750. <member name="P:NPOI.XWPF.Usermodel.XWPFSSub.Element">
  11751. <summary>
  11752. This tag, which is an abbreviation for “element”, serves several functions (18 total) including that of the base
  11753. argument of a mathematical object or function, the elements in an array, and the elements in boxes.If all
  11754. subelements are omitted, this element specifies the presence of an empty argument.
  11755. </summary>
  11756. </member>
  11757. <member name="P:NPOI.XWPF.Usermodel.XWPFSSub.Subscript">
  11758. <summary>
  11759. This element specifies the subscript of the Pre-Sub-Superscript object sPre
  11760. </summary>
  11761. </member>
  11762. <member name="T:NPOI.XWPF.Usermodel.XWPFSSup">
  11763. <summary>
  11764. Subscript Object
  11765. his element specifies the subscript object sSub, which consists of a base e and a reduced-size scr placed below
  11766. and to the right, as in Xn
  11767. </summary>
  11768. </member>
  11769. <member name="P:NPOI.XWPF.Usermodel.XWPFSSup.Element">
  11770. <summary>
  11771. This tag, which is an abbreviation for “element”, serves several functions (18 total) including that of the base
  11772. argument of a mathematical object or function, the elements in an array, and the elements in boxes.If all
  11773. subelements are omitted, this element specifies the presence of an empty argument.
  11774. </summary>
  11775. </member>
  11776. <member name="P:NPOI.XWPF.Usermodel.XWPFSSup.Superscript">
  11777. <summary>
  11778. This element specifies the Superscript of the Pre-Sub-Superscript object sPre
  11779. </summary>
  11780. </member>
  11781. </members>
  11782. </doc>