NPOI.OOXML.XML 612 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>NPOI.OOXML</name>
  5. </assembly>
  6. <members>
  7. <member name="T:NPOI.POIFS.Crypt.Agile.AgileDecryptor">
  8. Decryptor implementation for Agile Encryption
  9. </member>
  10. <member name="M:NPOI.POIFS.Crypt.Agile.AgileDecryptor.VerifyPassword(System.String)">
  11. Set decryption password
  12. </member>
  13. <member name="M:NPOI.POIFS.Crypt.Agile.AgileDecryptor.VerifyPassword(NPOI.POIFS.Crypt.Agile.KeyPair,Org.BouncyCastle.X509.X509Certificate)">
  14. instead of a password, it's also possible to decrypt via certificate.
  15. Warning: this code is experimental and hasn't been validated
  16. @see <a href="http://social.msdn.microsoft.com/Forums/en-US/cc9092bb-0c82-4b5b-ae21-abf643bdb37c/agile-encryption-with-certificates">Agile encryption with certificates</a>
  17. @param keyPair
  18. @param x509
  19. @return true, when the data can be successfully decrypted with the given private key
  20. @throws GeneralSecurityException
  21. </member>
  22. <member name="T:NPOI.POIFS.Crypt.Agile.AgileDecryptor.AgileCipherInputStream">
  23. 2.3.4.15 Data Encryption (Agile Encryption)
  24. The EncryptedPackage stream (1) MUST be encrypted in 4096-byte segments to facilitate nearly
  25. random access while allowing CBC modes to be used in the encryption Process.
  26. The Initialization vector for the encryption process MUST be obtained by using the zero-based
  27. segment number as a blockKey and the binary form of the KeyData.saltValue as specified in
  28. section 2.3.4.12. The block number MUST be represented as a 32-bit unsigned integer.
  29. Data blocks MUST then be encrypted by using the Initialization vector and the intermediate key
  30. obtained by decrypting the encryptedKeyValue from a KeyEncryptor Contained within the
  31. KeyEncryptors sequence as specified in section 2.3.4.10. The data block MUST be pAdded to
  32. the next integral multiple of the KeyData.blockSize value. Any pAdding bytes can be used. Note
  33. that the StreamSize field of the EncryptedPackage field specifies the number of bytes of
  34. unencrypted data as specified in section 2.3.4.4.
  35. </member>
  36. <member name="T:NPOI.POIFS.Crypt.Agile.AgileEncryptionVerifier">
  37. Used when Checking if a key is valid for a document
  38. </member>
  39. <member name="M:NPOI.POIFS.Crypt.Agile.AgileEncryptor.UpdateIntegrityHMAC(System.IO.FileInfo,System.Int32)">
  40. Generate an HMAC, as specified in [RFC2104], of the encrypted form of the data (message),
  41. which the DataIntegrity element will verify by using the Salt generated in step 2 as the key.
  42. Note that the entire EncryptedPackage stream (1), including the StreamSize field, MUST be
  43. used as the message.
  44. Encrypt the HMAC as in step 3 by using a blockKey byte array consisting of the following bytes:
  45. 0xa0, 0x67, 0x7f, 0x02, 0xb2, 0x2c, 0x84, and 0x33.
  46. </member>
  47. <member name="T:NPOI.POIFS.Crypt.Agile.AgileEncryptor.AgileCipherOutputStream">
  48. 2.3.4.15 Data Encryption (Agile Encryption)
  49. The EncryptedPackage stream (1) MUST be encrypted in 4096-byte segments to facilitate nearly
  50. random access while allowing CBC modes to be used in the encryption Process.
  51. The Initialization vector for the encryption process MUST be obtained by using the zero-based
  52. segment number as a blockKey and the binary form of the KeyData.saltValue as specified in
  53. section 2.3.4.12. The block number MUST be represented as a 32-bit unsigned integer.
  54. Data blocks MUST then be encrypted by using the Initialization vector and the intermediate key
  55. obtained by decrypting the encryptedKeyValue from a KeyEncryptor Contained within the
  56. KeyEncryptors sequence as specified in section 2.3.4.10. The data block MUST be pAdded to
  57. the next integral multiple of the KeyData.blockSize value. Any pAdding bytes can be used. Note
  58. that the StreamSize field of the EncryptedPackage field specifies the number of bytes of
  59. unencrypted data as specified in section 2.3.4.4.
  60. </member>
  61. <member name="T:NPOI.POIFS.Crypt.Dsig.CertificateSecurityException">
  62. Exception thrown in case there is something wrong with the incoming eID
  63. certificate.
  64. @author Frank Cornelis
  65. </member>
  66. <member name="T:NPOI.POIFS.Crypt.Dsig.DigestInfo">
  67. Digest Information data transfer class.
  68. </member>
  69. <member name="M:NPOI.POIFS.Crypt.Dsig.DigestInfo.#ctor(System.Byte[],NPOI.POIFS.Crypt.HashAlgorithm,System.String)">
  70. Main constructor.
  71. @param digestValue
  72. @param hashAlgo
  73. @param description
  74. </member>
  75. <member name="T:NPOI.POIFS.Crypt.Dsig.ExpiredCertificateSecurityException">
  76. Exception thrown in case the incoming eID certificate is expired.
  77. @author Frank Cornelis
  78. </member>
  79. <member name="T:NPOI.POIFS.Crypt.Dsig.Facets.EnvelopedSignatureFacet">
  80. Signature Facet implementation to create enveloped signatures.
  81. @author Frank Cornelis
  82. </member>
  83. <member name="T:NPOI.POIFS.Crypt.Dsig.Facets.KeyInfoSignatureFacet">
  84. Signature Facet implementation that Adds ds:KeyInfo to the XML signature.
  85. @author Frank Cornelis
  86. </member>
  87. <member name="T:NPOI.POIFS.Crypt.Dsig.Facets.Office2010SignatureFacet">
  88. Work-around for Office2010 to accept the XAdES-BES/EPES signature.
  89. xades:UnsignedProperties/xades:UnsignedSignatureProperties needs to be
  90. present.
  91. @author Frank Cornelis
  92. </member>
  93. <member name="T:NPOI.POIFS.Crypt.Dsig.Facets.OOXMLSignatureFacet">
  94. Office OpenXML Signature Facet implementation.
  95. @author fcorneli
  96. @see <a href="http://msdn.microsoft.com/en-us/library/cc313071.aspx">[MS-OFFCRYPTO]: Office Document Cryptography Structure</a>
  97. </member>
  98. <member name="F:NPOI.POIFS.Crypt.Dsig.Facets.OOXMLSignatureFacet.signed">
  99. Office 2010 list of signed types (extensions).
  100. </member>
  101. <member name="T:NPOI.POIFS.Crypt.Dsig.Facets.SignatureFacet">
  102. JSR105 Signature Facet base class.
  103. </member>
  104. <member name="M:NPOI.POIFS.Crypt.Dsig.Facets.SignatureFacet.preSign(System.Xml.XmlDocument,System.Collections.Generic.List{System.Security.Cryptography.Xml.Reference},System.Collections.Generic.List{System.Xml.XmlNode})">
  105. This method is being invoked by the XML signature service engine during
  106. pre-sign phase. Via this method a signature facet implementation can add
  107. signature facets to an XML signature.
  108. @param document the signature document to be used for imports
  109. @param references list of reference defInitions
  110. @param objects objects to be signed/included in the signature document
  111. @throws XMLSignatureException
  112. </member>
  113. <member name="M:NPOI.POIFS.Crypt.Dsig.Facets.SignatureFacet.postSign(System.Xml.XmlDocument)">
  114. This method is being invoked by the XML signature service engine during
  115. the post-sign phase. Via this method a signature facet can extend the XML
  116. signatures with for example key information.
  117. @param document the signature document to be modified
  118. @throws MarshalException
  119. </member>
  120. <member name="T:NPOI.POIFS.Crypt.Dsig.Facets.XAdESSignatureFacet">
  121. XAdES Signature Facet. Implements XAdES v1.4.1 which is compatible with XAdES
  122. v1.3.2. The implemented XAdES format is XAdES-BES/EPES. It's up to another
  123. part of the signature service to upgrade the XAdES-BES to a XAdES-X-L.
  124. This implementation has been tested against an implementation that
  125. participated multiple ETSI XAdES plugtests.
  126. @author Frank Cornelis
  127. @see <a href="http://en.wikipedia.org/wiki/XAdES">XAdES</a>
  128. </member>
  129. <member name="M:NPOI.POIFS.Crypt.Dsig.Facets.XAdESSignatureFacet.AddMimeType(System.String,System.String)">
  130. Adds a mime-type for the given ds:Reference (referred via its @URI). This
  131. information is Added via the xades:DataObjectFormat element.
  132. @param dsReferenceUri
  133. @param mimetype
  134. </member>
  135. <member name="T:NPOI.POIFS.Crypt.Dsig.Facets.XAdESXLSignatureFacet">
  136. XAdES-X-L v1.4.1 signature facet. This signature facet implementation will
  137. upgrade a given XAdES-BES/EPES signature to XAdES-X-L.
  138. We don't inherit from XAdESSignatureFacet as we also want to be able to use
  139. this facet out of the context of a signature creation. This signature facet
  140. assumes that the signature is already XAdES-BES/EPES compliant.
  141. This implementation has been tested against an implementation that
  142. participated multiple ETSI XAdES plugtests.
  143. @author Frank Cornelis
  144. @see XAdESSignatureFacet
  145. </member>
  146. <member name="T:NPOI.POIFS.Crypt.Dsig.OOXMLURIDereferencer">
  147. JSR105 URI dereferencer for Office Open XML documents.
  148. </member>
  149. <member name="T:NPOI.POIFS.Crypt.Dsig.RevokedCertificateSecurityException">
  150. Exception thrown in case the incoming eID certificate has been revoked.
  151. @author Frank Cornelis
  152. </member>
  153. <member name="T:NPOI.POIFS.Crypt.Dsig.Services.RevocationData">
  154. Container class for PKI revocation data.
  155. @author Frank Cornelis
  156. </member>
  157. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.RevocationData.#ctor">
  158. Default constructor.
  159. </member>
  160. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.RevocationData.AddCRL(System.Byte[])">
  161. Adds a CRL to this revocation data Set.
  162. @param encodedCrl
  163. </member>
  164. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.RevocationData.AddCRL(NPOI.POIFS.Crypt.Dsig.Services.X509CRL)">
  165. Adds a CRL to this revocation data Set.
  166. @param crl
  167. </member>
  168. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.RevocationData.AddOCSP(System.Byte[])">
  169. Adds an OCSP response to this revocation data Set.
  170. @param encodedOcsp
  171. </member>
  172. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.RevocationData.GetCRLs">
  173. Gives back a list of all CRLs.
  174. @return a list of all CRLs
  175. </member>
  176. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.RevocationData.GetOCSPs">
  177. Gives back a list of all OCSP responses.
  178. @return a list of all OCSP response
  179. </member>
  180. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.RevocationData.HasOCSPs">
  181. Returns <code>true</code> if this revocation data Set holds OCSP
  182. responses.
  183. @return <code>true</code> if this revocation data Set holds OCSP
  184. responses.
  185. </member>
  186. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.RevocationData.HasCRLs">
  187. Returns <code>true</code> if this revocation data Set holds CRLs.
  188. @return <code>true</code> if this revocation data Set holds CRLs.
  189. </member>
  190. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.RevocationData.HasRevocationDataEntries">
  191. Returns <code>true</code> if this revocation data is not empty.
  192. @return <code>true</code> if this revocation data is not empty.
  193. </member>
  194. <member name="T:NPOI.POIFS.Crypt.Dsig.Services.IRevocationDataService">
  195. Interface for a service that retrieves revocation data about some given
  196. certificate chain.
  197. @author Frank Cornelis
  198. </member>
  199. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.IRevocationDataService.GetRevocationData(System.Collections.Generic.List{System.Security.Cryptography.X509Certificates.X509Certificate})">
  200. Gives back the revocation data corresponding with the given certificate
  201. chain.
  202. @param certificateChain the certificate chain
  203. @return the revocation data corresponding with the given certificate chain.
  204. </member>
  205. <member name="T:NPOI.POIFS.Crypt.Dsig.Services.ISignaturePolicyService">
  206. Interface for the signature policy service.
  207. @author Frank Cornelis
  208. </member>
  209. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.ISignaturePolicyService.GetSignaturePolicyIdentifier">
  210. Gives back the signature policy identifier URI.
  211. @return the signature policy identifier URI.
  212. </member>
  213. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.ISignaturePolicyService.GetSignaturePolicyDescription">
  214. Gives back the short description of the signature policy or
  215. <code>null</code> if a description is not available.
  216. @return the description, or <code>null</code>.
  217. </member>
  218. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.ISignaturePolicyService.GetSignaturePolicyDownloadUrl">
  219. Gives back the download URL where the signature policy document can be
  220. found. Can be <code>null</code> in case such a download location does not
  221. exist.
  222. @return the download URL, or <code>null</code>.
  223. </member>
  224. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.ISignaturePolicyService.GetSignaturePolicyDocument">
  225. Gives back the signature policy document.
  226. @return the bytes of the signature policy document.
  227. </member>
  228. <member name="T:NPOI.POIFS.Crypt.Dsig.Services.ITimeStampService">
  229. Interface for a time-stamp service.
  230. @author Frank Cornelis
  231. </member>
  232. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.ITimeStampService.TimeStamp(System.Byte[],NPOI.POIFS.Crypt.Dsig.Services.RevocationData)">
  233. Gives back the encoded time-stamp token for the given array of data
  234. bytes. We assume that the time-stamp token itself Contains its full
  235. certificate chain required for proper validation.
  236. @param data
  237. the data to be time-stamped.
  238. @param revocationData
  239. the optional Container that needs to be Filled up with the
  240. revocation data used to validate the TSA certificate chain.
  241. @return the DER encoded time-stamp token.
  242. @throws Exception
  243. in case something went wrong.
  244. </member>
  245. <member name="T:NPOI.POIFS.Crypt.Dsig.Services.ITimeStampServiceValidator">
  246. Interface for trust validator of a TSP.
  247. @author Frank Cornelis
  248. </member>
  249. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.ITimeStampServiceValidator.Validate(System.Collections.Generic.List{Org.BouncyCastle.X509.X509Certificate},NPOI.POIFS.Crypt.Dsig.Services.RevocationData)">
  250. Validates the given certificate chain.
  251. @param certificateChain
  252. @param revocationData
  253. the optional data Container that should be Filled with
  254. revocation data that was used to validate the given
  255. certificate chain.
  256. @throws Exception
  257. in case the certificate chain is invalid.
  258. </member>
  259. <member name="T:NPOI.POIFS.Crypt.Dsig.Services.TSPTimeStampService">
  260. A TSP time-stamp service implementation.
  261. @author Frank Cornelis
  262. </member>
  263. <member name="M:NPOI.POIFS.Crypt.Dsig.Services.TSPTimeStampService.mapDigestAlgoToOID(NPOI.POIFS.Crypt.HashAlgorithm)">
  264. Maps the digest algorithm to corresponding OID value.
  265. </member>
  266. <member name="T:NPOI.POIFS.Crypt.Dsig.SignatureConfig">
  267. This class bundles the configuration options used for the existing
  268. signature facets.
  269. Apart of the thread local members (e.g. opc-package) most values will probably be constant, so
  270. it might be configured centrally (e.g. by spring)
  271. </member>
  272. <!-- Badly formed XML comment ignored for member "F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.signatureFacets" -->
  273. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.signaturePolicyService">
  274. the optional signature policy service used for XAdES-EPES.
  275. </member>
  276. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.tspService">
  277. the time-stamp service used for XAdES-T and XAdES-X.
  278. </member>
  279. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.tspUrl">
  280. timestamp service provider URL
  281. </member>
  282. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.tspDigestAlgo">
  283. if not defined, it's the same as the main digest
  284. </member>
  285. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.tspRequestPolicy">
  286. the optional TSP request policy OID.
  287. </member>
  288. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.revocationDataService">
  289. the optional revocation data service used for XAdES-C and XAdES-X-L.
  290. When <code>null</code> the signature will be limited to XAdES-T only.
  291. </member>
  292. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.xadesDigestAlgo">
  293. if not defined, it's the same as the main digest
  294. </member>
  295. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.xadesIssuerNameNoReverseOrder">
  296. Work-around for Office 2010 IssuerName encoding.
  297. </member>
  298. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.packageSignatureId">
  299. The signature Id attribute value used to create the XML signature. A
  300. <code>null</code> value will trigger an automatically generated signature Id.
  301. </member>
  302. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.signatureDescription">
  303. Gives back the human-readable description of what the citizen will be
  304. signing. The default value is "Office OpenXML Document".
  305. </member>
  306. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.signatureMarshalListener">
  307. The process of signing includes the marshalling of xml structures.
  308. This also includes the canonicalization. Currently this leads to problems
  309. with certain namespaces, so this EventListener is used to interfere
  310. with the marshalling Process.
  311. </member>
  312. <member name="F:NPOI.POIFS.Crypt.Dsig.SignatureConfig.namespacePrefixes">
  313. Map of namespace uris to prefix
  314. If a mapping is specified, the corresponding elements will be prefixed
  315. </member>
  316. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.Init(System.Boolean)">
  317. Inits and Checks the config object.
  318. If not Set previously, complex configuration properties also Get
  319. Created/initialized via this Initialization call.
  320. @param onlyValidation if true, only a subset of the properties
  321. is Initialized, which are necessary for validation. If false,
  322. also the other properties needed for signing are been taken care of
  323. </member>
  324. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.AddSignatureFacet(NPOI.POIFS.Crypt.Dsig.Facets.SignatureFacet)">
  325. @param signatureFacet the signature facet is Appended to facet list
  326. </member>
  327. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetSignatureFacets">
  328. @return the list of facets, may be empty when the config object is not Initialized
  329. </member>
  330. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetSignatureFacets(System.Collections.Generic.List{NPOI.POIFS.Crypt.Dsig.Facets.SignatureFacet})">
  331. @param signatureFacets the new list of facets
  332. </member>
  333. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetDigestAlgo">
  334. @return the main digest algorithm, defaults to sha-1
  335. </member>
  336. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetDigestAlgo(NPOI.POIFS.Crypt.HashAlgorithm)">
  337. @param digestAlgo the main digest algorithm
  338. </member>
  339. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetOpcPackage">
  340. @return the opc package to be used by this thread, stored as thread-local
  341. </member>
  342. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetOpcPackage(NPOI.OpenXml4Net.OPC.OPCPackage)">
  343. @param opcPackage the opc package to be handled by this thread, stored as thread-local
  344. </member>
  345. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetKey">
  346. @return the private key
  347. </member>
  348. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetKey(NPOI.POIFS.Crypt.IPrivateKey)">
  349. @param key the private key
  350. </member>
  351. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetSigningCertificateChain">
  352. @return the certificate chain, index 0 is usually the certificate matching
  353. the private key
  354. </member>
  355. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetSigningCertificateChain(System.Collections.Generic.List{System.Security.Cryptography.X509Certificates.X509Certificate})">
  356. @param signingCertificateChain the certificate chain, index 0 should be
  357. the certificate matching the private key
  358. </member>
  359. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetExecutionTime">
  360. @return the time at which the document is signed, also used for the timestamp service.
  361. defaults to now
  362. </member>
  363. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetExecutionTime(System.DateTime)">
  364. @param executionTime Sets the time at which the document ought to be signed
  365. </member>
  366. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetSignaturePolicyService">
  367. @return the service to be used for XAdES-EPES properties. There's no default implementation
  368. </member>
  369. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetSignaturePolicyService(NPOI.POIFS.Crypt.Dsig.Services.ISignaturePolicyService)">
  370. @param signaturePolicyService the service to be used for XAdES-EPES properties
  371. </member>
  372. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetSignatureDescription">
  373. @return Gives back the human-readable description of what the citizen
  374. will be signing. The default value is "Office OpenXML Document".
  375. </member>
  376. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetSignatureDescription(System.String)">
  377. @param signatureDescription the human-readable description of
  378. what the citizen will be signing.
  379. </member>
  380. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetCanonicalizationMethod">
  381. @return the default canonicalization method, defaults to INCLUSIVE
  382. </member>
  383. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetCanonicalizationMethod(System.String)">
  384. @param canonicalizationMethod the default canonicalization method
  385. </member>
  386. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetPackageSignatureId">
  387. @return The signature Id attribute value used to create the XML signature.
  388. Defaults to "idPackageSignature"
  389. </member>
  390. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetPackageSignatureId(System.String)">
  391. @param packageSignatureId The signature Id attribute value used to create the XML signature.
  392. A <code>null</code> value will trigger an automatically generated signature Id.
  393. </member>
  394. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetTspUrl">
  395. @return the url of the timestamp provider (TSP)
  396. </member>
  397. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetTspUrl(System.String)">
  398. @param tspUrl the url of the timestamp provider (TSP)
  399. </member>
  400. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.IsTspOldProtocol">
  401. @return if true, uses timestamp-request/response mimetype,
  402. if false, timestamp-query/reply mimetype
  403. </member>
  404. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetTspOldProtocol(System.Boolean)">
  405. @param tspOldProtocol defines the timestamp-protocol mimetype
  406. @see #isTspOldProtocol
  407. </member>
  408. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetTspDigestAlgo">
  409. @return the hash algorithm to be used for the timestamp entry.
  410. Defaults to the hash algorithm of the main entry
  411. </member>
  412. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetTspDigestAlgo(NPOI.POIFS.Crypt.HashAlgorithm)">
  413. @param tspDigestAlgo the algorithm to be used for the timestamp entry.
  414. if <code>null</code>, the hash algorithm of the main entry
  415. </member>
  416. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetProxyUrl">
  417. @return the proxy url to be used for all communications.
  418. Currently this affects the timestamp service
  419. </member>
  420. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetProxyUrl(System.String)">
  421. @param proxyUrl the proxy url to be used for all communications.
  422. Currently this affects the timestamp service
  423. </member>
  424. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetTspService">
  425. @return the timestamp service. Defaults to {@link TSPTimeStampService}
  426. </member>
  427. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetTspService(NPOI.POIFS.Crypt.Dsig.Services.ITimeStampService)">
  428. @param tspService the timestamp service
  429. </member>
  430. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetTspUser">
  431. @return the user id for the timestamp service - currently only basic authorization is supported
  432. </member>
  433. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetTspUser(System.String)">
  434. @param tspUser the user id for the timestamp service - currently only basic authorization is supported
  435. </member>
  436. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetTspPass">
  437. @return the password for the timestamp service
  438. </member>
  439. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetTspPass(System.String)">
  440. @param tspPass the password for the timestamp service
  441. </member>
  442. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetTspValidator">
  443. @return the validator for the timestamp service (certificate)
  444. </member>
  445. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetTspValidator(NPOI.POIFS.Crypt.Dsig.Services.ITimeStampServiceValidator)">
  446. @param tspValidator the validator for the timestamp service (certificate)
  447. </member>
  448. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetRevocationDataService">
  449. @return the optional revocation data service used for XAdES-C and XAdES-X-L.
  450. When <code>null</code> the signature will be limited to XAdES-T only.
  451. </member>
  452. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetRevocationDataService(NPOI.POIFS.Crypt.Dsig.Services.IRevocationDataService)">
  453. @param revocationDataService the optional revocation data service used for XAdES-C and XAdES-X-L.
  454. When <code>null</code> the signature will be limited to XAdES-T only.
  455. </member>
  456. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetXadesDigestAlgo">
  457. @return hash algorithm used for XAdES. Defaults to the {@link #getDigestAlgo()}
  458. </member>
  459. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetXadesDigestAlgo(NPOI.POIFS.Crypt.HashAlgorithm)">
  460. @param xadesDigestAlgo hash algorithm used for XAdES.
  461. When <code>null</code>, defaults to {@link #getDigestAlgo()}
  462. </member>
  463. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetUserAgent">
  464. @return the user agent used for http communication (e.g. to the TSP)
  465. </member>
  466. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetUserAgent(System.String)">
  467. @param userAgent the user agent used for http communication (e.g. to the TSP)
  468. </member>
  469. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetTspRequestPolicy">
  470. @return the asn.1 object id for the tsp request policy.
  471. Defaults to <code>1.3.6.1.4.1.13762.3</code>
  472. </member>
  473. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetTspRequestPolicy(System.String)">
  474. @param tspRequestPolicy the asn.1 object id for the tsp request policy.
  475. </member>
  476. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.IsIncludeEntireCertificateChain">
  477. @return true, if the whole certificate chain is included in the signature.
  478. When false, only the signer cert will be included
  479. </member>
  480. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetIncludeEntireCertificateChain(System.Boolean)">
  481. @param includeEntireCertificateChain if true, include the whole certificate chain.
  482. If false, only include the signer cert
  483. </member>
  484. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.IsIncludeIssuerSerial">
  485. @return if true, issuer serial number is included
  486. </member>
  487. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetIncludeIssuerSerial(System.Boolean)">
  488. @param includeIssuerSerial if true, issuer serial number is included
  489. </member>
  490. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.IsIncludeKeyValue">
  491. @return if true, the key value of the public key (certificate) is included
  492. </member>
  493. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetIncludeKeyValue(System.Boolean)">
  494. @param includeKeyValue if true, the key value of the public key (certificate) is included
  495. </member>
  496. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetXadesRole">
  497. @return the xades role element. If <code>null</code> the claimed role element is omitted.
  498. Defaults to <code>null</code>
  499. </member>
  500. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetXadesRole(System.String)">
  501. @param xadesRole the xades role element. If <code>null</code> the claimed role element is omitted.
  502. </member>
  503. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetXadesSignatureId">
  504. @return the Id for the XAdES SignedProperties element.
  505. Defaults to <code>idSignedProperties</code>
  506. </member>
  507. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetXadesSignatureId(System.String)">
  508. @param xadesSignatureId the Id for the XAdES SignedProperties element.
  509. When <code>null</code> defaults to <code>idSignedProperties</code>
  510. </member>
  511. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.IsXadesSignaturePolicyImplied">
  512. @return when true, include the policy-implied block.
  513. Defaults to <code>true</code>
  514. </member>
  515. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetXadesSignaturePolicyImplied(System.Boolean)">
  516. @param xadesSignaturePolicyImplied when true, include the policy-implied block
  517. </member>
  518. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.IsXadesIssuerNameNoReverseOrder">
  519. Make sure the DN is encoded using the same order as present
  520. within the certificate. This is an Office2010 work-around.
  521. Should be reverted back.
  522. XXX: not correct according to RFC 4514.
  523. @return when true, the issuer DN is used instead of the issuer X500 principal
  524. </member>
  525. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetXadesIssuerNameNoReverseOrder(System.Boolean)">
  526. @param xadesIssuerNameNoReverseOrder when true, the issuer DN instead of the issuer X500 prinicpal is used
  527. </member>
  528. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetNamespacePrefixes">
  529. @return the map of namespace uri (key) to prefix (value)
  530. </member>
  531. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetNamespacePrefixes(System.Collections.Generic.Dictionary{System.String,System.String})">
  532. @param namespacePrefixes the map of namespace uri (key) to prefix (value)
  533. </member>
  534. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.nvl``1(``0,``0)">
  535. helper method for null/default value handling
  536. @param value
  537. @param defaultValue
  538. @return if value is not null, return value otherwise defaultValue
  539. </member>
  540. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetHashMagic">
  541. Each digest method has its own IV (Initial vector)
  542. @return the IV depending on the main digest method
  543. </member>
  544. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetSignatureMethodUri">
  545. @return the uri for the signature method, i.e. currently only rsa is
  546. supported, so it's the rsa variant of the main digest
  547. </member>
  548. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetDigestMethodUri">
  549. @return the uri for the main digest
  550. </member>
  551. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetDigestMethodUri(NPOI.POIFS.Crypt.HashAlgorithm)">
  552. @param digestAlgo the digest algo, currently only sha* and ripemd160 is supported
  553. @return the uri for the given digest
  554. </member>
  555. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.GetXadesCanonicalizationMethod">
  556. @return the cannonicalization method for XAdES-XL signing.
  557. Defaults to <code>EXCLUSIVE</code>
  558. @see <a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/crypto/dsig/CanonicalizationMethod.html">javax.xml.Crypto.dsig.CanonicalizationMethod</a>
  559. </member>
  560. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureConfig.SetXadesCanonicalizationMethod(System.String)">
  561. @param xadesCanonicalizationMethod the cannonicalization method for XAdES-XL signing
  562. @see <a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/crypto/dsig/CanonicalizationMethod.html">javax.xml.Crypto.dsig.CanonicalizationMethod</a>
  563. </member>
  564. <!-- Badly formed XML comment ignored for member "T:NPOI.POIFS.Crypt.Dsig.IURIReference" -->
  565. <member name="M:NPOI.POIFS.Crypt.Dsig.IURIReference.getURI">
  566. Returns the URI of the referenced data object.
  567. @return the URI of the data object in RFC 2396 format (may be
  568. <code>null</code> if not specified)
  569. </member>
  570. <member name="M:NPOI.POIFS.Crypt.Dsig.IURIReference.getType">
  571. Returns the type of data referenced by this URI.
  572. @return the type (a URI) of the data object (may be <code>null</code>
  573. if not specified)
  574. </member>
  575. <!-- Badly formed XML comment ignored for member "T:NPOI.POIFS.Crypt.Dsig.IURIDereferencer" -->
  576. <member name="M:NPOI.POIFS.Crypt.Dsig.IURIDereferencer.dereference(NPOI.POIFS.Crypt.Dsig.IURIReference,System.Security.Cryptography.Xml.SignedXml)">
  577. Dereferences the specified <code>URIReference</code> and returns the
  578. dereferenced data.
  579. @param uriReference the <code>URIReference</code>
  580. @param context an <code>XMLCryptoContext</code> that may
  581. contain additional useful information for dereferencing the URI. This
  582. implementation should dereference the specified
  583. <code>URIReference</code> against the context's <code>baseURI</code>
  584. parameter, if specified.
  585. @return the dereferenced data
  586. @throws NullPointerException if <code>uriReference</code> or
  587. <code>context</code> are <code>null</code>
  588. @throws URIReferenceException if an exception occurs while
  589. dereferencing the specified <code>uriReference</code>
  590. </member>
  591. <!-- Badly formed XML comment ignored for member "T:NPOI.POIFS.Crypt.Dsig.IEventListener" -->
  592. <member name="M:NPOI.POIFS.Crypt.Dsig.IEventListener.handleEvent(NPOI.POIFS.Crypt.Dsig.IEvent)">
  593. This method is called whenever an event occurs of the type for which
  594. the <code> EventListener</code> interface was registered.
  595. @param evt The <code>Event</code> contains contextual information
  596. about the event. It also contains the <code>stopPropagation</code>
  597. and <code>preventDefault</code> methods which are used in
  598. determining the event's flow and default action.
  599. </member>
  600. <member name="T:NPOI.POIFS.Crypt.Dsig.SignatureInfo">
  601. <p>This class is the default entry point for XML signatures and can be used for
  602. validating an existing signed office document and signing a office document.</p>
  603. <p><b>Validating a signed office document</b></p>
  604. <pre>
  605. OPCPackage pkg = OPCPackage.open(..., PackageAccess.READ);
  606. SignatureConfig sic = new SignatureConfig();
  607. sic.setOpcPackage(pkg);
  608. SignatureInfo si = new SignatureInfo();
  609. si.setSignatureConfig(sic);
  610. boolean isValid = si.validate();
  611. ...
  612. </pre>
  613. <p><b>Signing an office document</b></p>
  614. <pre>
  615. // loading the keystore - pkcs12 is used here, but of course jks &amp; co are also valid
  616. // the keystore needs to contain a private key and it's certificate having a
  617. // 'digitalSignature' key usage
  618. char password[] = "test".toCharArray();
  619. File file = new File("test.pfx");
  620. KeyStore keystore = KeyStore.getInstance("PKCS12");
  621. FileInputStream fis = new FileInputStream(file);
  622. keystore.load(fis, password);
  623. fis.close();
  624. // extracting private key and certificate
  625. String alias = "xyz"; // alias of the keystore entry
  626. Key key = keystore.getKey(alias, password);
  627. X509Certificate x509 = (X509Certificate)keystore.getCertificate(alias);
  628. // filling the SignatureConfig entries (minimum fields, more options are available ...)
  629. SignatureConfig signatureConfig = new SignatureConfig();
  630. signatureConfig.setKey(keyPair.getPrivate());
  631. signatureConfig.setSigningCertificateChain(Collections.singletonList(x509));
  632. OPCPackage pkg = OPCPackage.open(..., PackageAccess.READ_WRITE);
  633. signatureConfig.setOpcPackage(pkg);
  634. // adding the signature document to the package
  635. SignatureInfo si = new SignatureInfo();
  636. si.setSignatureConfig(signatureConfig);
  637. si.confirmSignature();
  638. // optionally verify the generated signature
  639. boolean b = si.verifySignature();
  640. assert (b);
  641. // write the changes back to disc
  642. pkg.close();
  643. </pre>
  644. <p><b>Implementation notes:</b></p>
  645. <p>Although there's a XML signature implementation in the Oracle JDKs 6 and higher,
  646. compatibility with IBM JDKs is also in focus (... but maybe not thoroughly tested ...).
  647. Therefore we are using the Apache Santuario libs (xmlsec) instead of the built-in classes,
  648. as the compatibility seems to be provided there.</p>
  649. <p>To use SignatureInfo and its sibling classes, you'll need to have the following libs
  650. in the classpath:</p>
  651. <ul>
  652. <li>BouncyCastle bcpkix and bcprov (tested against 1.51)</li>
  653. <li>Apache Santuario "xmlsec" (tested against 2.0.1)</li>
  654. <li>and slf4j-api (tested against 1.7.7)</li>
  655. </ul>
  656. </member>
  657. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.SignaturePart.GetPackagePart">
  658. @return the package part Containing the signature
  659. </member>
  660. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.SignaturePart.GetSigner">
  661. @return the signer certificate
  662. </member>
  663. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.SignaturePart.GetCertChain">
  664. @return the certificate chain of the signer
  665. </member>
  666. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.SignaturePart.Validate">
  667. @return true, when the xml signature is valid, false otherwise
  668. @throws EncryptedDocumentException if the signature can't be extracted or if its malformed
  669. </member>
  670. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.#ctor">
  671. Constructor Initializes xml signature environment, if it hasn't been Initialized before
  672. </member>
  673. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.GetSignatureConfig">
  674. @return the signature config
  675. </member>
  676. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.SetSignatureConfig(NPOI.POIFS.Crypt.Dsig.SignatureConfig)">
  677. @param signatureConfig the signature config, needs to be Set before a SignatureInfo object is used
  678. </member>
  679. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.VerifySignature">
  680. @return true, if first signature part is valid
  681. </member>
  682. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.ConfirmSignature">
  683. add the xml signature to the document
  684. @throws XMLSignatureException
  685. @throws MarshalException
  686. </member>
  687. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.signDigest(System.Byte[])">
  688. Sign (encrypt) the digest with the private key.
  689. Currently only rsa is supported.
  690. @param digest the hashed input
  691. @return the encrypted hash
  692. </member>
  693. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.GetSignatureParts">
  694. @return a signature part for each signature document.
  695. the parts can be validated independently.
  696. </member>
  697. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.InitXmlProvider">
  698. Initialize the xml signing environment and the bouncycastle provider
  699. </member>
  700. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.preSign(System.Xml.XmlDocument,System.Collections.Generic.List{NPOI.POIFS.Crypt.Dsig.DigestInfo})">
  701. Helper method for Adding informations before the signing.
  702. Normally {@link #ConfirmSignature()} is sufficient to be used.
  703. </member>
  704. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.postSign(System.Xml.XmlDocument,System.Byte[])">
  705. Helper method for Adding informations After the signing.
  706. Normally {@link #ConfirmSignature()} is sufficient to be used.
  707. </member>
  708. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.WriteDocument(System.Xml.XmlDocument)">
  709. Write XML signature into the OPC package
  710. @param document the xml signature document
  711. @throws MarshalException
  712. </member>
  713. <member name="M:NPOI.POIFS.Crypt.Dsig.SignatureInfo.safe``1(System.Collections.Generic.List{``0})">
  714. Helper method for null lists, which are Converted to empty lists
  715. @param other the reference to wrap, if null
  716. @return if other is null, an empty lists is returned, otherwise other is returned
  717. </member>
  718. <member name="T:NPOI.POIFS.Crypt.Dsig.SignatureMarshalListener">
  719. This listener class is used, to modify the to be digested xml document,
  720. e.g. to register id attributes or Set prefixes for registered namespaces
  721. </member>
  722. <!-- Badly formed XML comment ignored for member "F:NPOI.POIFS.Crypt.Dsig.SignatureMarshalListener.signatureConfig" -->
  723. <member name="T:NPOI.POIFS.Crypt.Dsig.TrustCertificateSecurityException">
  724. Exception thrown in case the incoming eID certificate is not trusted.
  725. @author Frank Cornelis
  726. </member>
  727. <member name="F:NPOI.POIXMLDocument.pkg">
  728. The OPC Package
  729. </member>
  730. <member name="F:NPOI.POIXMLDocument.properties">
  731. The properties of the OPC namespace, opened as needed
  732. </member>
  733. <member name="M:NPOI.POIXMLDocument.OpenPackage(System.String)">
  734. Wrapper to open a namespace, returning an IOException
  735. in the event of a problem.
  736. Works around shortcomings in java's this() constructor calls
  737. </member>
  738. <member name="M:NPOI.POIXMLDocument.GetRelatedByType(System.String)">
  739. Retrieves all the PackageParts which are defined as
  740. relationships of the base document with the
  741. specified content type.
  742. </member>
  743. <member name="M:NPOI.POIXMLDocument.HasOOXMLHeader(System.IO.Stream)">
  744. Checks that the supplied Stream (which MUST
  745. support mark and reSet, or be a PushbackStream)
  746. has a OOXML (zip) header at the start of it.
  747. If your Stream does not support mark / reSet,
  748. then wrap it in a PushBackStream, then be
  749. sure to always use that, and not the original!
  750. @param inp An Stream which supports either mark/reSet, or is a PushbackStream
  751. </member>
  752. <member name="M:NPOI.POIXMLDocument.GetProperties">
  753. Get the document properties. This gives you access to the
  754. core ooxml properties, and the extended ooxml properties.
  755. </member>
  756. <member name="M:NPOI.POIXMLDocument.GetAllEmbedds">
  757. Get the document's embedded files.
  758. </member>
  759. <member name="M:NPOI.POIXMLDocument.Close">
  760. Closes the underlying {@link OPCPackage} from which this
  761. document was read, if there is one
  762. </member>
  763. <member name="M:NPOI.POIXMLDocument.Write(System.IO.Stream)">
  764. Write out this document to an Outputstream.
  765. Note - if the Document was opened from a {@link File} rather
  766. than an {@link InputStream}, you <b>must</b> write out to
  767. a different file, overwriting via an OutputStream isn't possible.
  768. If {@code stream} is a {@link java.io.FileOutputStream} on a networked drive
  769. or has a high cost/latency associated with each written byte,
  770. consider wrapping the OutputStream in a {@link java.io.BufferedOutputStream}
  771. to improve write performance.
  772. @param stream - the java Stream you wish to write the file to
  773. @exception IOException if anything can't be written.
  774. </member>
  775. <member name="T:NPOI.POIXMLDocumentPart">
  776. Represents an entry of a OOXML namespace.
  777. <p>
  778. Each POIXMLDocumentPart keeps a reference to the underlying a {@link org.apache.poi.openxml4j.opc.PackagePart}.
  779. </p>
  780. @author Yegor Kozlov
  781. </member>
  782. <member name="T:NPOI.POIXMLDocumentPart.RelationPart">
  783. The RelationPart is a cached relationship between the document, which contains the RelationPart,
  784. and one of its referenced child document parts.
  785. The child document parts may only belong to one parent, but it's often referenced by other
  786. parents too, having varying {@link PackageRelationship#getId() relationship ids} pointing to it.
  787. </member>
  788. <member name="P:NPOI.POIXMLDocumentPart.RelationPart.Relationship">
  789. @return the cached relationship, which uniquely identifies this child document part within the parent
  790. </member>
  791. <member name="M:NPOI.POIXMLDocumentPart.RelationPart.GetDocumentPart``1">
  792. @return the child document part
  793. </member>
  794. <member name="F:NPOI.POIXMLDocumentPart.relationCounter">
  795. Counter that provides the amount of incoming relations from other parts
  796. to this part.
  797. </member>
  798. <member name="M:NPOI.POIXMLDocumentPart.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage)">
  799. Construct POIXMLDocumentPart representing a "core document" namespace part.
  800. </member>
  801. <member name="M:NPOI.POIXMLDocumentPart.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage,System.String)">
  802. Construct POIXMLDocumentPart representing a custom "core document" package part.
  803. </member>
  804. <member name="M:NPOI.POIXMLDocumentPart.#ctor">
  805. Creates new POIXMLDocumentPart - called by client code to create new parts from scratch.
  806. @see #CreateRelationship(POIXMLRelation, POIXMLFactory, int, bool)
  807. </member>
  808. <member name="M:NPOI.POIXMLDocumentPart.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  809. Creates an POIXMLDocumentPart representing the given package part and relationship.
  810. Called by {@link #read(POIXMLFactory, java.util.Map)} when reading in an existing file.
  811. @param part - The package part that holds xml data representing this sheet.
  812. @see #read(POIXMLFactory, java.util.Map)
  813. @since POI 3.14-Beta1
  814. </member>
  815. <member name="M:NPOI.POIXMLDocumentPart.#ctor(NPOI.POIXMLDocumentPart,NPOI.OpenXml4Net.OPC.PackagePart)">
  816. Creates an POIXMLDocumentPart representing the given package part, relationship and parent
  817. Called by {@link #read(POIXMLFactory, java.util.Map)} when reading in an existing file.
  818. @param parent - Parent part
  819. @param part - The package part that holds xml data representing this sheet.
  820. @see #read(POIXMLFactory, java.util.Map)
  821. @since POI 3.14-Beta1
  822. </member>
  823. <member name="M:NPOI.POIXMLDocumentPart.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  824. Creates an POIXMLDocumentPart representing the given namespace part and relationship.
  825. Called by {@link #read(POIXMLFactory, java.util.Map)} when Reading in an exisiting file.
  826. @param part - The namespace part that holds xml data represenring this sheet.
  827. @param rel - the relationship of the given namespace part
  828. @see #read(POIXMLFactory, java.util.Map)
  829. </member>
  830. <member name="M:NPOI.POIXMLDocumentPart.#ctor(NPOI.POIXMLDocumentPart,NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  831. Creates an POIXMLDocumentPart representing the given namespace part, relationship and parent
  832. Called by {@link #read(POIXMLFactory, java.util.Map)} when Reading in an exisiting file.
  833. @param parent - Parent part
  834. @param part - The namespace part that holds xml data represenring this sheet.
  835. @param rel - the relationship of the given namespace part
  836. @see #read(POIXMLFactory, java.util.Map)
  837. </member>
  838. <member name="M:NPOI.POIXMLDocumentPart.Rebase(NPOI.OpenXml4Net.OPC.OPCPackage)">
  839. When you open something like a theme, call this to
  840. re-base the XML Document onto the core child of the
  841. current core document
  842. </member>
  843. <member name="M:NPOI.POIXMLDocumentPart.GetPackagePart">
  844. Provides access to the underlying PackagePart
  845. @return the underlying PackagePart
  846. </member>
  847. <member name="M:NPOI.POIXMLDocumentPart.GetPackageRelationship">
  848. Provides access to the PackageRelationship that identifies this POIXMLDocumentPart
  849. @return the PackageRelationship that identifies this POIXMLDocumentPart
  850. </member>
  851. <member name="M:NPOI.POIXMLDocumentPart.GetRelations">
  852. Returns the list of child relations for this POIXMLDocumentPart
  853. @return child relations
  854. </member>
  855. <member name="P:NPOI.POIXMLDocumentPart.RelationParts">
  856. Returns the list of child relations for this POIXMLDocumentPart
  857. @return child relations
  858. </member>
  859. <member name="M:NPOI.POIXMLDocumentPart.GetRelationById(System.String)">
  860. Returns the target {@link POIXMLDocumentPart}, where a
  861. {@link PackageRelationship} is set from the {@link PackagePart} of this
  862. {@link POIXMLDocumentPart} to the {@link PackagePart} of the target
  863. {@link POIXMLDocumentPart} with a {@link PackageRelationship#GetId()}
  864. matching the given parameter value.
  865. @param id
  866. The relation id to look for
  867. @return the target part of the relation, or null, if none exists
  868. </member>
  869. <member name="M:NPOI.POIXMLDocumentPart.GetRelationId(NPOI.POIXMLDocumentPart)">
  870. Returns the {@link PackageRelationship#GetId()} of the
  871. {@link PackageRelationship}, that sources from the {@link PackagePart} of
  872. this {@link POIXMLDocumentPart} to the {@link PackagePart} of the given
  873. parameter value.
  874. @param part
  875. The {@link POIXMLDocumentPart} for which the according
  876. relation-id shall be found.
  877. @return The value of the {@link PackageRelationship#GetId()} or null, if
  878. parts are not related.
  879. </member>
  880. <member name="M:NPOI.POIXMLDocumentPart.AddRelation(System.String,NPOI.POIXMLDocumentPart)">
  881. <summary>
  882. Add a new child POIXMLDocumentPart
  883. </summary>
  884. <param name="id"></param>
  885. <param name="part">the child to add</param>
  886. </member>
  887. <member name="M:NPOI.POIXMLDocumentPart.AddRelation(System.String,NPOI.POIXMLRelation,NPOI.POIXMLDocumentPart)">
  888. <summary>
  889. Add a new child POIXMLDocumentPart
  890. </summary>
  891. <param name="relId">the preferred relation id, when null the next free relation id will be used</param>
  892. <param name="relationshipType">the package relationship type</param>
  893. <param name="part">the child to add</param>
  894. <returns></returns>
  895. </member>
  896. <member name="M:NPOI.POIXMLDocumentPart.AddRelation(NPOI.OpenXml4Net.OPC.PackageRelationship,NPOI.POIXMLDocumentPart)">
  897. <summary>
  898. Add a new child POIXMLDocumentPart
  899. </summary>
  900. <param name="pr">the relationship of the child</param>
  901. <param name="part">the child to add</param>
  902. </member>
  903. <member name="M:NPOI.POIXMLDocumentPart.RemoveRelation(NPOI.POIXMLDocumentPart)">
  904. Remove the relation to the specified part in this namespace and remove the
  905. part, if it is no longer needed.
  906. </member>
  907. <member name="M:NPOI.POIXMLDocumentPart.RemoveRelation(NPOI.POIXMLDocumentPart,System.Boolean)">
  908. Remove the relation to the specified part in this namespace and remove the
  909. part, if it is no longer needed and flag is set to true.
  910. @param part
  911. The related part, to which the relation shall be Removed.
  912. @param RemoveUnusedParts
  913. true, if the part shall be Removed from the namespace if not
  914. needed any longer.
  915. </member>
  916. <member name="M:NPOI.POIXMLDocumentPart.GetParent">
  917. Returns the parent POIXMLDocumentPart. All parts except root have not-null parent.
  918. @return the parent POIXMLDocumentPart or <code>null</code> for the root element.
  919. </member>
  920. <member name="M:NPOI.POIXMLDocumentPart.Commit">
  921. Save the content in the underlying namespace part.
  922. Default implementation is empty meaning that the namespace part is left unmodified.
  923. Sub-classes should override and add logic to marshal the "model" into Ooxml4J.
  924. For example, the code saving a generic XML entry may look as follows:
  925. <pre><code>
  926. protected void commit() {
  927. PackagePart part = GetPackagePart();
  928. Stream out = part.GetStream();
  929. XmlObject bean = GetXmlBean(); //the "model" which holds Changes in memory
  930. bean.save(out, DEFAULT_XML_OPTIONS);
  931. out.close();
  932. }
  933. </code></pre>
  934. </member>
  935. <member name="M:NPOI.POIXMLDocumentPart.OnSave(System.Collections.Generic.List{NPOI.OpenXml4Net.OPC.PackagePart})">
  936. Save Changes in the underlying OOXML namespace.
  937. Recursively fires {@link #commit()} for each namespace part
  938. @param alreadySaved context set Containing already visited nodes
  939. </member>
  940. <member name="M:NPOI.POIXMLDocumentPart.PrepareForCommit">
  941. Ensure that a memory based package part does not have lingering data from previous
  942. commit() calls.
  943. Note: This is overwritten for some objects, as *PictureData seem to store the actual content
  944. in the part directly without keeping a copy like all others therefore we need to handle them differently.
  945. </member>
  946. <member name="M:NPOI.POIXMLDocumentPart.CreateRelationship(NPOI.POIXMLRelation,NPOI.POIXMLFactory)">
  947. Create a new child POIXMLDocumentPart
  948. @param descriptor the part descriptor
  949. @param factory the factory that will create an instance of the requested relation
  950. @return the Created child POIXMLDocumentPart
  951. </member>
  952. <member name="M:NPOI.POIXMLDocumentPart.CreateRelationship(NPOI.POIXMLRelation,NPOI.POIXMLFactory,System.Int32,System.Boolean)">
  953. Create a new child POIXMLDocumentPart
  954. @param descriptor the part descriptor
  955. @param factory the factory that will create an instance of the requested relation
  956. @param idx part number
  957. @param noRelation if true, then no relationship is Added.
  958. @return the Created child POIXMLDocumentPart
  959. </member>
  960. <member name="M:NPOI.POIXMLDocumentPart.Read(NPOI.POIXMLFactory,System.Collections.Generic.Dictionary{NPOI.OpenXml4Net.OPC.PackagePart,NPOI.POIXMLDocumentPart})">
  961. Iterate through the underlying PackagePart and create child POIXMLFactory instances
  962. using the specified factory
  963. @param factory the factory object that Creates POIXMLFactory instances
  964. @param context context map Containing already visited noted keyed by tarGetURI
  965. </member>
  966. <member name="M:NPOI.POIXMLDocumentPart.GetTargetPart(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  967. Get the PackagePart that is the target of a relationship.
  968. @param rel The relationship
  969. @return The target part
  970. @throws InvalidFormatException
  971. </member>
  972. <member name="M:NPOI.POIXMLDocumentPart.OnDocumentCreate">
  973. Fired when a new namespace part is Created
  974. </member>
  975. <member name="M:NPOI.POIXMLDocumentPart.OnDocumentRead">
  976. Fired when a namespace part is read
  977. </member>
  978. <member name="M:NPOI.POIXMLDocumentPart.onDocumentRemove">
  979. Fired when a namespace part is about to be Removed from the namespace
  980. </member>
  981. <member name="M:NPOI.POIXMLDocumentPart.GetPartFromOPCPackage(NPOI.OpenXml4Net.OPC.OPCPackage,System.String)">
  982. Retrieves the core document part
  983. @since POI 3.14-Beta1
  984. </member>
  985. <member name="T:NPOI.POIXMLFactory">
  986. Defines a factory API that enables sub-classes to create instances of <code>POIXMLDocumentPart</code>
  987. @author Yegor Kozlov
  988. </member>
  989. <member name="M:NPOI.POIXMLFactory.CreateDocumentPart(NPOI.POIXMLDocumentPart,NPOI.OpenXml4Net.OPC.PackagePart)">
  990. Create a POIXMLDocumentPart from existing package part and relation. This method is called
  991. from {@link POIXMLDocument#load(POIXMLFactory)} when parsing a document
  992. @param parent parent part
  993. @param rel the package part relationship
  994. @param part the PackagePart representing the created instance
  995. @return A new instance of a POIXMLDocumentPart.
  996. @since by POI 3.14-Beta1
  997. </member>
  998. <member name="M:NPOI.POIXMLFactory.CreateDocumentPart(System.Type,System.Type[],System.Object[])">
  999. Need to delegate instantiation to sub class because of constructor visibility
  1000. @since POI 3.14-Beta1
  1001. </member>
  1002. <member name="M:NPOI.POIXMLFactory.GetDescriptor(System.String)">
  1003. returns the descriptor for the given relationship type
  1004. @return the descriptor or null if type is unknown
  1005. @since POI 3.14-Beta1
  1006. </member>
  1007. <member name="M:NPOI.POIXMLFactory.CreateDocumentPart(NPOI.POIXMLDocumentPart,NPOI.OpenXml4Net.OPC.PackageRelationship,NPOI.OpenXml4Net.OPC.PackagePart)">
  1008. Create a POIXMLDocumentPart from existing package part and relation. This method is called
  1009. from {@link POIXMLDocument#load(POIXMLFactory)} when parsing a document
  1010. @param parent parent part
  1011. @param rel the package part relationship
  1012. @param part the PackagePart representing the created instance
  1013. @return A new instance of a POIXMLDocumentPart.
  1014. @deprecated in POI 3.14, scheduled for removal in POI 3.16
  1015. </member>
  1016. <member name="M:NPOI.POIXMLFactory.NewDocumentPart(NPOI.POIXMLRelation)">
  1017. Create a new POIXMLDocumentPart using the supplied descriptor. This method is used when adding new parts
  1018. to a document, for example, when adding a sheet to a workbook, slide to a presentation, etc.
  1019. @param descriptor describes the object to create
  1020. @return A new instance of a POIXMLDocumentPart.
  1021. </member>
  1022. <member name="M:NPOI.POIXMLFactory.GetPackageRelationship(NPOI.POIXMLDocumentPart,NPOI.OpenXml4Net.OPC.PackagePart)">
  1023. Retrieves the package relationship of the child part within the parent
  1024. @since POI 3.14-Beta1
  1025. </member>
  1026. <member name="T:NPOI.CoreProperties">
  1027. The core document properties
  1028. </member>
  1029. <member name="T:NPOI.ExtendedProperties">
  1030. Extended document properties
  1031. </member>
  1032. <member name="T:NPOI.CustomProperties">
  1033. Custom document properties
  1034. </member>
  1035. <member name="F:NPOI.CustomProperties.FORMAT_ID">
  1036. Each custom property element Contains an fmtid attribute
  1037. with the same GUID value ({D5CDD505-2E9C-101B-9397-08002B2CF9AE}).
  1038. </member>
  1039. <member name="M:NPOI.CustomProperties.Add(System.String)">
  1040. Add a new property
  1041. @param name the property name
  1042. @throws IllegalArgumentException if a property with this name already exists
  1043. </member>
  1044. <member name="M:NPOI.CustomProperties.AddProperty(System.String,System.String)">
  1045. Add a new string property
  1046. @throws IllegalArgumentException if a property with this name already exists
  1047. </member>
  1048. <member name="M:NPOI.CustomProperties.AddProperty(System.String,System.Double)">
  1049. Add a new double property
  1050. @throws IllegalArgumentException if a property with this name already exists
  1051. </member>
  1052. <member name="M:NPOI.CustomProperties.AddProperty(System.String,System.Int32)">
  1053. Add a new integer property
  1054. @throws IllegalArgumentException if a property with this name already exists
  1055. </member>
  1056. <member name="M:NPOI.CustomProperties.AddProperty(System.String,System.Boolean)">
  1057. Add a new bool property
  1058. @throws IllegalArgumentException if a property with this name already exists
  1059. </member>
  1060. <member name="M:NPOI.CustomProperties.NextPid">
  1061. Generate next id that uniquely relates a custom property
  1062. @return next property id starting with 2
  1063. </member>
  1064. <member name="M:NPOI.CustomProperties.Contains(System.String)">
  1065. Check if a property with this name already exists in the collection of custom properties
  1066. @param name the name to check
  1067. @return whether a property with the given name exists in the custom properties
  1068. </member>
  1069. <member name="M:NPOI.CustomProperties.GetProperty(System.String)">
  1070. Retrieve the custom property with this name, or null if none exists.
  1071. You will need to test the various isSetX methods to work out
  1072. what the type of the property is, before fetching the
  1073. appropriate value for it.
  1074. @param name the name of the property to fetch
  1075. </member>
  1076. <member name="T:NPOI.POIXMLProperties">
  1077. Wrapper around the three different kinds of OOXML properties
  1078. and metadata a document can have (Core, Extended and Custom),
  1079. as well Thumbnails.
  1080. </member>
  1081. <member name="P:NPOI.POIXMLProperties.CoreProperties">
  1082. Returns the core document properties
  1083. </member>
  1084. <member name="P:NPOI.POIXMLProperties.ExtendedProperties">
  1085. Returns the extended document properties
  1086. </member>
  1087. <member name="P:NPOI.POIXMLProperties.CustomProperties">
  1088. Returns the custom document properties
  1089. </member>
  1090. <member name="P:NPOI.POIXMLProperties.ThumbnailPart">
  1091. Returns the {@link PackagePart} for the Document
  1092. Thumbnail, or <code>null</code> if there isn't one
  1093. @return The Document Thumbnail part or null
  1094. </member>
  1095. <member name="P:NPOI.POIXMLProperties.ThumbnailFilename">
  1096. Returns the name of the Document thumbnail, eg
  1097. <code>thumbnail.jpeg</code>, or <code>null</code> if there
  1098. isn't one.
  1099. @return The thumbnail filename, or null
  1100. </member>
  1101. <member name="P:NPOI.POIXMLProperties.ThumbnailImage">
  1102. Returns the Document thumbnail image data, or
  1103. <code>null</code> if there isn't one.
  1104. @return The thumbnail data, or null
  1105. </member>
  1106. <member name="M:NPOI.POIXMLProperties.SetThumbnail(System.String,System.IO.Stream)">
  1107. Sets the Thumbnail for the document, replacing any existing
  1108. one.
  1109. @param name The filename for the thumbnail image, eg <code>thumbnail.jpg</code>
  1110. @param imageData The inputstream to read the thumbnail image from
  1111. </member>
  1112. <member name="M:NPOI.POIXMLProperties.Commit">
  1113. Commit Changes to the underlying OPC namespace
  1114. </member>
  1115. <member name="T:NPOI.POIXMLPropertiesTextExtractor">
  1116. A {@link POITextExtractor} for returning the textual
  1117. content of the OOXML file properties, eg author
  1118. and title.
  1119. </member>
  1120. <member name="M:NPOI.POIXMLPropertiesTextExtractor.#ctor(NPOI.POIXMLDocument)">
  1121. Creates a new POIXMLPropertiesTextExtractor for the
  1122. given open document.
  1123. </member>
  1124. <member name="M:NPOI.POIXMLPropertiesTextExtractor.#ctor(NPOI.POIXMLTextExtractor)">
  1125. Creates a new POIXMLPropertiesTextExtractor, for the
  1126. same file that another TextExtractor is already
  1127. working on.
  1128. </member>
  1129. <member name="M:NPOI.POIXMLPropertiesTextExtractor.GetCorePropertiesText">
  1130. Returns the core document properties, eg author
  1131. </member>
  1132. <member name="M:NPOI.POIXMLPropertiesTextExtractor.GetExtendedPropertiesText">
  1133. Returns the extended document properties, eg
  1134. application
  1135. </member>
  1136. <member name="M:NPOI.POIXMLPropertiesTextExtractor.GetCustomPropertiesText">
  1137. Returns the custom document properties, if
  1138. there are any
  1139. </member>
  1140. <member name="T:NPOI.POIXMLRelation">
  1141. Represents a descriptor of a OOXML relation.
  1142. @author Yegor Kozlov
  1143. </member>
  1144. <member name="F:NPOI.POIXMLRelation._type">
  1145. Describes the content stored in a part.
  1146. </member>
  1147. <member name="F:NPOI.POIXMLRelation._relation">
  1148. The kind of connection between a source part and a target part in a namespace.
  1149. </member>
  1150. <member name="F:NPOI.POIXMLRelation._defaultName">
  1151. The path component of a pack URI.
  1152. </member>
  1153. <member name="F:NPOI.POIXMLRelation._cls">
  1154. Defines what object is used to construct instances of this relationship
  1155. </member>
  1156. <member name="M:NPOI.POIXMLRelation.#ctor(System.String,System.String,System.String,System.Type)">
  1157. Instantiates a POIXMLRelation.
  1158. @param type content type
  1159. @param rel relationship
  1160. @param defaultName default item name
  1161. @param cls defines what object is used to construct instances of this relationship
  1162. </member>
  1163. <member name="M:NPOI.POIXMLRelation.#ctor(System.String,System.String,System.String)">
  1164. Instantiates a POIXMLRelation.
  1165. @param type content type
  1166. @param rel relationship
  1167. @param defaultName default item name
  1168. </member>
  1169. <member name="P:NPOI.POIXMLRelation.ContentType">
  1170. Return the content type. Content types define a media type, a subtype, and an
  1171. optional set of parameters, as defined in RFC 2616.
  1172. @return the content type
  1173. </member>
  1174. <member name="P:NPOI.POIXMLRelation.Relation">
  1175. Return the relationship, the kind of connection between a source part and a target part in a namespace.
  1176. Relationships make the connections between parts directly discoverable without looking at the content
  1177. in the parts, and without altering the parts themselves.
  1178. @return the relationship
  1179. </member>
  1180. <member name="P:NPOI.POIXMLRelation.DefaultFileName">
  1181. Return the default part name. Part names are used to refer to a part in the context of a
  1182. namespace, typically as part of a URI.
  1183. @return the default part name
  1184. </member>
  1185. <member name="M:NPOI.POIXMLRelation.GetFileName(System.Int32)">
  1186. Returns the filename for the nth one of these,
  1187. e.g. /xl/comments4.xml
  1188. </member>
  1189. <member name="M:NPOI.POIXMLRelation.GetFileNameIndex(NPOI.POIXMLDocumentPart)">
  1190. Returns the index of the filename within the package for the given part.
  1191. e.g. 4 for /xl/comments4.xml
  1192. </member>
  1193. <member name="P:NPOI.POIXMLRelation.RelationClass">
  1194. Return type of the obejct used to construct instances of this relationship
  1195. @return the class of the object used to construct instances of this relation
  1196. </member>
  1197. <member name="F:NPOI.POIXMLTextExtractor._document">
  1198. The POIXMLDocument that's open
  1199. </member>
  1200. <member name="M:NPOI.POIXMLTextExtractor.#ctor(NPOI.POIXMLDocument)">
  1201. Creates a new text extractor for the given document
  1202. </member>
  1203. <member name="M:NPOI.POIXMLTextExtractor.GetCoreProperties">
  1204. Returns the core document properties
  1205. </member>
  1206. <member name="M:NPOI.POIXMLTextExtractor.GetExtendedProperties">
  1207. Returns the extended document properties
  1208. </member>
  1209. <member name="M:NPOI.POIXMLTextExtractor.GetCustomProperties">
  1210. Returns the custom document properties
  1211. </member>
  1212. <member name="P:NPOI.POIXMLTextExtractor.Document">
  1213. Returns opened document
  1214. </member>
  1215. <member name="P:NPOI.POIXMLTextExtractor.Package">
  1216. Returns the opened OPCPackage that Contains the document
  1217. </member>
  1218. <member name="P:NPOI.POIXMLTextExtractor.MetadataTextExtractor">
  1219. Returns an OOXML properties text extractor for the
  1220. document properties metadata, such as title and author.
  1221. </member>
  1222. <member name="P:NPOI.SS.Converter.ExcelToHtmlConverter.OutputColumnHeaders">
  1223. <summary>
  1224. 是否输出列头
  1225. </summary>
  1226. </member>
  1227. <member name="P:NPOI.SS.Converter.ExcelToHtmlConverter.OutputHiddenColumns">
  1228. <summary>
  1229. 是否输出隐藏的列
  1230. </summary>
  1231. </member>
  1232. <member name="P:NPOI.SS.Converter.ExcelToHtmlConverter.OutputHiddenRows">
  1233. <summary>
  1234. 是否输出隐藏的行
  1235. </summary>
  1236. </member>
  1237. <member name="P:NPOI.SS.Converter.ExcelToHtmlConverter.OutputLeadingSpacesAsNonBreaking">
  1238. <summary>
  1239. 是否输出文本前的空格
  1240. </summary>
  1241. </member>
  1242. <member name="P:NPOI.SS.Converter.ExcelToHtmlConverter.OutputRowNumbers">
  1243. <summary>
  1244. 是否输出行号
  1245. </summary>
  1246. </member>
  1247. <member name="P:NPOI.SS.Converter.ExcelToHtmlConverter.UseDivsToSpan">
  1248. <summary>
  1249. 在跨列的单元格使用DIV标记
  1250. </summary>
  1251. </member>
  1252. <member name="M:NPOI.SS.Converter.ExcelToHtmlConverter.ProcessRow(NPOI.SS.Util.CellRangeAddress[][],NPOI.SS.UserModel.IRow,System.Xml.XmlElement)">
  1253. @return maximum 1-base index of column that were rendered, zero if none
  1254. </member>
  1255. <member name="M:NPOI.SS.Converter.ExcelToHtmlConverter.ProcessColumnWidths(NPOI.SS.UserModel.ISheet,System.Int32,System.Xml.XmlElement)">
  1256. Creates COLGROUP element with width specified for all columns. (Except
  1257. first if <tt>{@link #isOutputRowNumbers()}==true</tt>)
  1258. </member>
  1259. <member name="M:NPOI.SS.Converter.ExcelToHtmlUtils.BuildMergedRangesMap(NPOI.SS.UserModel.ISheet)">
  1260. Creates a map (i.e. two-dimensional array) filled with ranges. Allow fast
  1261. retrieving {@link CellRangeAddress} of any cell, if cell is contained in
  1262. range.
  1263. @see #getMergedRange(CellRangeAddress[][], int, int)
  1264. </member>
  1265. <member name="M:NPOI.SS.Converter.ExcelToHtmlUtils.GetColumnWidthInPx(System.Int32)">
  1266. See <a href=
  1267. "http://apache-poi.1045710.n5.nabble.com/Excel-Column-Width-Unit-Converter-pixels-excel-column-width-units-td2301481.html"
  1268. >here</a> for Xio explanation and details
  1269. </member>
  1270. <member name="M:NPOI.SS.Converter.ExcelToHtmlUtils.GetMergedRange(NPOI.SS.Util.CellRangeAddress[][],System.Int32,System.Int32)">
  1271. @param mergedRanges
  1272. map of sheet merged ranges built with
  1273. {@link #buildMergedRangesMap(HSSFSheet)}
  1274. @return {@link CellRangeAddress} from map if cell with specified row and
  1275. column numbers contained in found range, <tt>null</tt> otherwise
  1276. </member>
  1277. <member name="F:NPOI.SS.UserModel.ImportOption.SheetContentOnly">
  1278. <summary>
  1279. Only Text and Formulas are imported. Pictures, Drawing, Styles etc. are all ignored.
  1280. </summary>
  1281. </member>
  1282. <member name="F:NPOI.SS.UserModel.ImportOption.TextOnly">
  1283. <summary>
  1284. Only Text, Comments and Formulas are imported. Pictures, Drawing, Styles etc. are all ignored.
  1285. </summary>
  1286. </member>
  1287. <member name="F:NPOI.SS.UserModel.ImportOption.All">
  1288. <summary>
  1289. Everything is imported - this is the same as NONE.
  1290. </summary>
  1291. </member>
  1292. <member name="T:NPOI.SS.UserModel.WorkbookFactory">
  1293. <summary>
  1294. Factory for creating the appropriate kind of Workbook
  1295. (be it HSSFWorkbook or XSSFWorkbook), from the given input
  1296. </summary>
  1297. </member>
  1298. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  1299. <summary>
  1300. Creates an HSSFWorkbook from the given POIFSFileSystem
  1301. </summary>
  1302. </member>
  1303. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(NPOI.POIFS.FileSystem.NPOIFSFileSystem)">
  1304. Creates an HSSFWorkbook from the given NPOIFSFileSystem
  1305. </member>
  1306. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(NPOI.POIFS.FileSystem.NPOIFSFileSystem,System.String)">
  1307. Creates a Workbook from the given NPOIFSFileSystem, which may
  1308. be password protected
  1309. </member>
  1310. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(NPOI.OpenXml4Net.OPC.OPCPackage)">
  1311. <summary>
  1312. Creates an XSSFWorkbook from the given OOXML Package
  1313. </summary>
  1314. </member>
  1315. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(System.IO.Stream,System.Boolean)">
  1316. <summary>
  1317. Creates the appropriate HSSFWorkbook / XSSFWorkbook from
  1318. the given InputStream. The Stream is wraped inside a PushbackInputStream.
  1319. </summary>
  1320. <param name="inputStream">Input Stream of .xls or .xlsx file</param>
  1321. <param name="password"></param>
  1322. <returns>IWorkbook depending on the input HSSFWorkbook or XSSFWorkbook is returned.</returns>
  1323. </member>
  1324. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(System.String,System.String,System.Boolean)">
  1325. <summary>
  1326. Creates the appropriate HSSFWorkbook / XSSFWorkbook from
  1327. the given File, which must exist and be readable.
  1328. </summary>
  1329. <param name="file"></param>
  1330. <param name="password"></param>
  1331. <param name="readOnly"></param>
  1332. <returns></returns>
  1333. <remarks>
  1334. Note that for Workbooks opened this way, it is not possible
  1335. to explicitly close the underlying File resource.
  1336. </remarks>
  1337. </member>
  1338. <member name="M:NPOI.SS.UserModel.WorkbookFactory.Create(System.IO.Stream,NPOI.SS.UserModel.ImportOption)">
  1339. <summary>
  1340. Creates the appropriate HSSFWorkbook / XSSFWorkbook from
  1341. the given InputStream. The Stream is wraped inside a PushbackInputStream.
  1342. </summary>
  1343. <param name="inputStream">Input Stream of .xls or .xlsx file</param>
  1344. <param name="importOption">Customize the elements that are processed on the next import</param>
  1345. <returns>IWorkbook depending on the input HSSFWorkbook or XSSFWorkbook is returned.</returns>
  1346. </member>
  1347. <member name="M:NPOI.SS.UserModel.WorkbookFactory.CreateFormulaEvaluator(NPOI.SS.UserModel.IWorkbook)">
  1348. <summary>
  1349. Creates a specific FormulaEvaluator for the given workbook.
  1350. </summary>
  1351. </member>
  1352. <member name="M:NPOI.SS.UserModel.WorkbookFactory.SetImportOption(NPOI.SS.UserModel.ImportOption)">
  1353. <summary>
  1354. Sets the import option when opening the next workbook.
  1355. Works only for XSSF. For HSSF workbooks this option is ignored.
  1356. </summary>
  1357. <param name="importOption">Customize the elements that are processed on the next import</param>
  1358. </member>
  1359. <member name="T:NPOI.Util.IdentifierManager">
  1360. <summary>
  1361. 24.08.2009 @author Stefan Stern
  1362. </summary>
  1363. </member>
  1364. <member name="F:NPOI.Util.IdentifierManager.upperbound">
  1365. </member>
  1366. <member name="F:NPOI.Util.IdentifierManager.lowerbound">
  1367. </member>
  1368. <member name="F:NPOI.Util.IdentifierManager.segments">
  1369. List of segments of available identifiers
  1370. </member>
  1371. <member name="M:NPOI.Util.IdentifierManager.#ctor(System.Int64,System.Int64)">
  1372. @param lowerbound the lower limit of the id-range to manage. Must be greater than or equal to {@link #MIN_ID}.
  1373. @param upperbound the upper limit of the id-range to manage. Must be less then or equal {@link #MAX_ID}.
  1374. </member>
  1375. <member name="M:NPOI.Util.IdentifierManager.ReserveNew">
  1376. @return a new identifier.
  1377. @throws InvalidOperationException if no more identifiers are available, then an Exception is raised.
  1378. </member>
  1379. <member name="M:NPOI.Util.IdentifierManager.Release(System.Int64)">
  1380. @param id
  1381. the identifier to release. Must be greater than or equal to
  1382. {@link #lowerbound} and must be less than or equal to {@link #upperbound}
  1383. @return true, if the identifier was reserved and has been successfully
  1384. released, false, if the identifier was not reserved.
  1385. </member>
  1386. <member name="M:NPOI.Util.IdentifierManager.VerifyIdentifiersLeft">
  1387. </member>
  1388. <member name="T:NPOI.Util.PackageHelper">
  1389. Provides handy methods to work with OOXML namespaces
  1390. @author Yegor Kozlov
  1391. </member>
  1392. <member name="M:NPOI.Util.PackageHelper.Clone(NPOI.OpenXml4Net.OPC.OPCPackage,System.String)">
  1393. Clone the specified namespace.
  1394. @param pkg the namespace to clone
  1395. @param file the destination file
  1396. @return the Cloned namespace
  1397. </member>
  1398. <member name="M:NPOI.Util.PackageHelper.CreateTempFile">
  1399. Creates an empty file in the default temporary-file directory,
  1400. </member>
  1401. <member name="M:NPOI.Util.PackageHelper.Copy(NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.OPCPackage,NPOI.OpenXml4Net.OPC.PackagePart)">
  1402. Recursively copy namespace parts to the destination namespace
  1403. </member>
  1404. <member name="M:NPOI.Util.PackageHelper.CopyProperties(NPOI.OpenXml4Net.OPC.PackageProperties,NPOI.OpenXml4Net.OPC.PackageProperties)">
  1405. Copy core namespace properties
  1406. @param src source properties
  1407. @param tgt target properties
  1408. </member>
  1409. <member name="T:NPOI.XSSF.Extractor.XSSFExcelExtractor">
  1410. Helper class to extract text from an OOXML Excel file
  1411. </member>
  1412. <member name="P:NPOI.XSSF.Extractor.XSSFExcelExtractor.IncludeHeaderFooter">
  1413. <summary>
  1414. Should header and footer be included? Default is true
  1415. </summary>
  1416. </member>
  1417. <member name="P:NPOI.XSSF.Extractor.XSSFExcelExtractor.IncludeSheetNames">
  1418. <summary>
  1419. Should sheet names be included? Default is true
  1420. </summary>
  1421. <value>if set to <c>true</c> [include sheet names].</value>
  1422. </member>
  1423. <member name="P:NPOI.XSSF.Extractor.XSSFExcelExtractor.FormulasNotResults">
  1424. <summary>
  1425. Should we return the formula itself, and not
  1426. the result it produces? Default is false
  1427. </summary>
  1428. <value>if set to <c>true</c> [formulas not results].</value>
  1429. </member>
  1430. <member name="P:NPOI.XSSF.Extractor.XSSFExcelExtractor.IncludeCellComments">
  1431. <summary>
  1432. Should cell comments be included? Default is false
  1433. </summary>
  1434. <value>if set to <c>true</c> [include cell comments].</value>
  1435. </member>
  1436. <member name="M:NPOI.XSSF.Extractor.XSSFExcelExtractor.SetIncludeSheetNames(System.Boolean)">
  1437. Should sheet names be included? Default is true
  1438. </member>
  1439. <member name="M:NPOI.XSSF.Extractor.XSSFExcelExtractor.SetFormulasNotResults(System.Boolean)">
  1440. Should we return the formula itself, and not
  1441. the result it produces? Default is false
  1442. </member>
  1443. <member name="M:NPOI.XSSF.Extractor.XSSFExcelExtractor.SetIncludeCellComments(System.Boolean)">
  1444. Should cell comments be included? Default is false
  1445. </member>
  1446. <member name="M:NPOI.XSSF.Extractor.XSSFExcelExtractor.SetIncludeHeadersFooters(System.Boolean)">
  1447. Should headers and footers be included? Default is true
  1448. </member>
  1449. <member name="M:NPOI.XSSF.Extractor.XSSFExcelExtractor.SetIncludeTextBoxes(System.Boolean)">
  1450. Should text within textboxes be included? Default is true
  1451. @param includeTextBoxes
  1452. </member>
  1453. <member name="P:NPOI.XSSF.Extractor.XSSFExcelExtractor.Text">
  1454. Retreives the text contents of the file
  1455. </member>
  1456. <member name="T:NPOI.XSSF.Extractor.XSSFExportToXml">
  1457. Maps an XLSX to an XML according to one of the mapping defined.
  1458. The output XML Schema must respect this limitations:
  1459. <ul>
  1460. <li> all mandatory elements and attributes must be mapped (enable validation to check this)</li>
  1461. <li> no &lt;any&gt; in complex type/element declaration </li>
  1462. <li> no &lt;anyAttribute&gt; attributes declaration </li>
  1463. <li> no recursive structures: recursive structures can't be nested more than one level </li>
  1464. <li> no abstract elements: abstract complex types can be declared but must not be used in elements. </li>
  1465. <li> no mixed content: an element can't contain simple text and child element(s) together </li>
  1466. <li> no &lt;substitutionGroup&gt; in complex type/element declaration </li>
  1467. </ul>
  1468. </member>
  1469. <member name="M:NPOI.XSSF.Extractor.XSSFExportToXml.#ctor(NPOI.XSSF.UserModel.XSSFMap)">
  1470. Creates a new exporter and Sets the mapping to be used when generating the XML output document
  1471. @param map the mapping rule to be used
  1472. </member>
  1473. <member name="M:NPOI.XSSF.Extractor.XSSFExportToXml.ExportToXML(System.IO.Stream,System.Boolean)">
  1474. Exports the data in an XML stream
  1475. @param os OutputStream in which will contain the output XML
  1476. @param validate if true, validates the XML againts the XML Schema
  1477. @throws SAXException
  1478. @throws TransformerException
  1479. @throws ParserConfigurationException
  1480. </member>
  1481. <member name="M:NPOI.XSSF.Extractor.XSSFExportToXml.ExportToXML(System.IO.Stream,System.String,System.Boolean)">
  1482. Exports the data in an XML stream
  1483. @param os OutputStream in which will contain the output XML
  1484. @param encoding the output charset encoding
  1485. @param validate if true, validates the XML againts the XML Schema
  1486. @throws SAXException
  1487. @throws ParserConfigurationException
  1488. @throws TransformerException
  1489. @throws InvalidFormatException
  1490. </member>
  1491. <member name="M:NPOI.XSSF.Extractor.XSSFExportToXml.IsValid(System.Xml.XmlDocument)">
  1492. Validate the generated XML against the XML Schema associated with the XSSFMap
  1493. @param xml the XML to validate
  1494. @return
  1495. </member>
  1496. <member name="M:NPOI.XSSF.Extractor.XSSFExportToXml.Compare(System.String,System.String)">
  1497. Compares two xpaths to define an ordering according to the XML Schema
  1498. </member>
  1499. <member name="T:NPOI.XSSF.Model.CalculationChain">
  1500. The cells in a workbook can be calculated in different orders depending on various optimizations and
  1501. dependencies. The calculation chain object specifies the order in which the cells in a workbook were last calculated.
  1502. @author Yegor Kozlov
  1503. </member>
  1504. <member name="M:NPOI.XSSF.Model.CalculationChain.RemoveItem(System.Int32,System.String)">
  1505. Remove a formula reference from the calculation chain
  1506. @param sheetId the sheet Id of a sheet the formula belongs to.
  1507. @param ref A1 style reference to the cell Containing the formula.
  1508. </member>
  1509. <member name="F:NPOI.XSSF.Model.CommentsTable.commentRefs">
  1510. XML Beans uses a list, which is very slow
  1511. to search, so we wrap things with our own
  1512. map for fast Lookup.
  1513. </member>
  1514. <member name="M:NPOI.XSSF.Model.CommentsTable.ReferenceUpdated(System.String,NPOI.OpenXmlFormats.Spreadsheet.CT_Comment)">
  1515. Called after the reference is updated, so that
  1516. we can reflect that in our cache
  1517. </member>
  1518. <member name="M:NPOI.XSSF.Model.CommentsTable.ReferenceUpdated(NPOI.SS.Util.CellAddress,NPOI.OpenXmlFormats.Spreadsheet.CT_Comment)">
  1519. Called after the reference is updated, so that
  1520. we can reflect that in our cache
  1521. @param oldReference the comment to remove from the commentRefs map
  1522. @param comment the comment to replace in the commentRefs map
  1523. </member>
  1524. <member name="M:NPOI.XSSF.Model.CommentsTable.FindAuthor(System.String)">
  1525. <summary>
  1526. Searches the author. If not found he is added to the list of authors.
  1527. </summary>
  1528. <param name="author">author to search</param>
  1529. <returns>index of the author</returns>
  1530. </member>
  1531. <member name="M:NPOI.XSSF.Model.CommentsTable.FindCellComment(System.String)">
  1532. Finds the cell comment at cellAddress, if one exists
  1533. @param cellAddress the address of the cell to find a comment
  1534. @return cell comment if one exists, otherwise returns null
  1535. @
  1536. </member>
  1537. <member name="M:NPOI.XSSF.Model.CommentsTable.FindCellComment(NPOI.SS.Util.CellAddress)">
  1538. Finds the cell comment at cellAddress, if one exists
  1539. @param cellAddress the address of the cell to find a comment
  1540. @return cell comment if one exists, otherwise returns null
  1541. </member>
  1542. <member name="M:NPOI.XSSF.Model.CommentsTable.GetCTComment(System.String)">
  1543. Get the underlying CTComment xmlbean for a comment located at cellRef, if it exists
  1544. @param cellRef the location of the cell comment
  1545. @return CTComment xmlbean if comment exists, otherwise return null.
  1546. @
  1547. </member>
  1548. <member name="M:NPOI.XSSF.Model.CommentsTable.GetCTComment(NPOI.SS.Util.CellAddress)">
  1549. Get the underlying CTComment xmlbean for a comment located at cellRef, if it exists
  1550. @param cellRef the location of the cell comment
  1551. @return CTComment xmlbean if comment exists, otherwise return null.
  1552. </member>
  1553. <member name="M:NPOI.XSSF.Model.CommentsTable.GetCellComments">
  1554. Returns all cell comments on this sheet.
  1555. @return A map of each Comment in this sheet, keyed on the cell address where
  1556. the comment is located.
  1557. </member>
  1558. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.Model.CommentsTable.PrepareCTCommentCache" -->
  1559. <member name="M:NPOI.XSSF.Model.CommentsTable.NewComment(System.String)">
  1560. Create a new comment located at cell address
  1561. @param ref the location to add the comment
  1562. @return a new CTComment located at ref with default author
  1563. </member>
  1564. <member name="M:NPOI.XSSF.Model.CommentsTable.NewComment(NPOI.SS.Util.CellAddress)">
  1565. Create a new comment located` at cell address
  1566. @param ref the location to add the comment
  1567. @return a new CTComment located at ref with default author
  1568. </member>
  1569. <member name="M:NPOI.XSSF.Model.CommentsTable.RemoveComment(System.String)">
  1570. Remove the comment at cellRef location, if one exists
  1571. @param cellRef the location of the comment to remove
  1572. @return returns true if a comment was removed
  1573. @deprecated 2015-11-23 (circa POI 3.14beta1). Use {@link #removeComment(CellAddress)} instead
  1574. </member>
  1575. <member name="M:NPOI.XSSF.Model.CommentsTable.RemoveComment(NPOI.SS.Util.CellAddress)">
  1576. Remove the comment at cellRef location, if one exists
  1577. @param cellRef the location of the comment to remove
  1578. @return returns true if a comment was removed
  1579. </member>
  1580. <member name="M:NPOI.XSSF.Model.CommentsTable.AddNewAuthor(System.String)">
  1581. Add a new author to the CommentsTable.
  1582. This does not check if the author already exists.
  1583. @param author the name of the comment author
  1584. @return the index of the new author
  1585. </member>
  1586. <member name="M:NPOI.XSSF.Model.CommentsTable.GetCTComments">
  1587. Returns the underlying CTComments list xmlbean
  1588. @return underlying comments list xmlbean
  1589. </member>
  1590. <member name="T:NPOI.XSSF.Model.ExternalLinksTable">
  1591. Holds details of links to parts of other workbooks (eg named ranges),
  1592. along with the most recently seen values for what they point to.
  1593. </member>
  1594. <member name="P:NPOI.XSSF.Model.ExternalLinksTable.CTExternalLink">
  1595. Returns the underlying xmlbeans object for the external
  1596. link table
  1597. </member>
  1598. <member name="P:NPOI.XSSF.Model.ExternalLinksTable.LinkedFileName">
  1599. get or set the last recorded name of the file that this
  1600. is linked to
  1601. </member>
  1602. <member name="T:NPOI.XSSF.Model.MapInfo">
  1603. This class : the Custom XML Mapping Part (Open Office XML Part 1:
  1604. chapter 12.3.6)
  1605. An instance of this part type Contains a schema for an XML file, and
  1606. information on the behavior that is used when allowing this custom XML schema
  1607. to be mapped into the spreadsheet.
  1608. @author Roberto Manicardi
  1609. </member>
  1610. <member name="P:NPOI.XSSF.Model.MapInfo.Workbook">
  1611. Returns the parent XSSFWorkbook
  1612. @return the parent XSSFWorkbook
  1613. </member>
  1614. <member name="M:NPOI.XSSF.Model.MapInfo.GetCTMapInfo">
  1615. @return the internal data object
  1616. </member>
  1617. <member name="M:NPOI.XSSF.Model.MapInfo.GetCTSchemaById(System.String)">
  1618. Gets the
  1619. @param schemaId the schema ID
  1620. @return CTSchema by it's ID
  1621. </member>
  1622. <member name="M:NPOI.XSSF.Model.MapInfo.GetAllXSSFMaps">
  1623. @return all the mappings configured in this document
  1624. </member>
  1625. <member name="T:NPOI.XSSF.Model.ParagraphPropertyFetcher">
  1626. Used internally to navigate the paragraph text style hierarchy within a shape and fetch properties
  1627. </member>
  1628. <member name="M:NPOI.XSSF.Model.ParagraphPropertyFetcher`1.Fetch(NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Shape)">
  1629. @param shape the shape being examined
  1630. @return true if the desired property was fetched
  1631. </member>
  1632. <member name="T:NPOI.XSSF.Model.SharedStringsTable">
  1633. Table of strings shared across all sheets in a workbook.
  1634. <p>
  1635. A workbook may contain thousands of cells Containing string (non-numeric) data. Furthermore this data is very
  1636. likely to be repeated across many rows or columns. The goal of implementing a single string table that is shared
  1637. across the workbook is to improve performance in opening and saving the file by only Reading and writing the
  1638. repetitive information once.
  1639. </p>
  1640. <p>
  1641. Consider for example a workbook summarizing information for cities within various countries. There may be a
  1642. column for the name of the country, a column for the name of each city in that country, and a column
  1643. Containing the data for each city. In this case the country name is repetitive, being duplicated in many cells.
  1644. In many cases the repetition is extensive, and a tremendous savings is realized by making use of a shared string
  1645. table when saving the workbook. When displaying text in the spreadsheet, the cell table will just contain an
  1646. index into the string table as the value of a cell, instead of the full string.
  1647. </p>
  1648. <p>
  1649. The shared string table Contains all the necessary information for displaying the string: the text, formatting
  1650. properties, and phonetic properties (for East Asian languages).
  1651. </p>
  1652. @author Nick Birch
  1653. @author Yegor Kozlov
  1654. </member>
  1655. <member name="F:NPOI.XSSF.Model.SharedStringsTable.strings">
  1656. Array of individual string items in the Shared String table.
  1657. </member>
  1658. <member name="F:NPOI.XSSF.Model.SharedStringsTable.stmap">
  1659. Maps strings and their indexes in the <code>strings</code> arrays
  1660. </member>
  1661. <member name="F:NPOI.XSSF.Model.SharedStringsTable.count">
  1662. An integer representing the total count of strings in the workbook. This count does not
  1663. include any numbers, it counts only the total of text strings in the workbook.
  1664. </member>
  1665. <member name="F:NPOI.XSSF.Model.SharedStringsTable.uniqueCount">
  1666. An integer representing the total count of unique strings in the Shared String Table.
  1667. A string is unique even if it is a copy of another string, but has different formatting applied
  1668. at the character level.
  1669. </member>
  1670. <member name="M:NPOI.XSSF.Model.SharedStringsTable.GetEntryAt(System.Int32)">
  1671. Return a string item by index
  1672. @param idx index of item to return.
  1673. @return the item at the specified position in this Shared String table.
  1674. </member>
  1675. <member name="P:NPOI.XSSF.Model.SharedStringsTable.Count">
  1676. Return an integer representing the total count of strings in the workbook. This count does not
  1677. include any numbers, it counts only the total of text strings in the workbook.
  1678. @return the total count of strings in the workbook
  1679. </member>
  1680. <member name="P:NPOI.XSSF.Model.SharedStringsTable.UniqueCount">
  1681. Returns an integer representing the total count of unique strings in the Shared String Table.
  1682. A string is unique even if it is a copy of another string, but has different formatting applied
  1683. at the character level.
  1684. @return the total count of unique strings in the workbook
  1685. </member>
  1686. <member name="M:NPOI.XSSF.Model.SharedStringsTable.AddEntry(NPOI.OpenXmlFormats.Spreadsheet.CT_Rst)">
  1687. Add an entry to this Shared String table (a new value is appened to the end).
  1688. <p>
  1689. If the Shared String table already Contains this <code>CT_Rst</code> bean, its index is returned.
  1690. Otherwise a new entry is aded.
  1691. </p>
  1692. @param st the entry to add
  1693. @return index the index of Added entry
  1694. </member>
  1695. <member name="P:NPOI.XSSF.Model.SharedStringsTable.Items">
  1696. Provide low-level access to the underlying array of CT_Rst beans
  1697. @return array of CT_Rst beans
  1698. </member>
  1699. <member name="M:NPOI.XSSF.Model.SharedStringsTable.WriteTo(System.IO.Stream)">
  1700. this table out as XML.
  1701. @param out The stream to write to.
  1702. @throws IOException if an error occurs while writing.
  1703. </member>
  1704. <member name="T:NPOI.XSSF.Model.SingleXmlCells">
  1705. This class : the Single Cell Tables Part (Open Office XML Part 4:
  1706. chapter 3.5.2)
  1707. @author Roberto Manicardi
  1708. </member>
  1709. <member name="M:NPOI.XSSF.Model.SingleXmlCells.GetAllSimpleXmlCell">
  1710. @return all the SimpleXmlCell Contained in this SingleXmlCells element
  1711. </member>
  1712. <member name="T:NPOI.XSSF.Model.StylesTable">
  1713. Table of styles shared across all sheets in a workbook.
  1714. @author ugo
  1715. </member>
  1716. <member name="F:NPOI.XSSF.Model.StylesTable.FIRST_CUSTOM_STYLE_ID">
  1717. The first style id available for use as a custom style
  1718. </member>
  1719. <member name="F:NPOI.XSSF.Model.StylesTable.MAXIMUM_NUMBER_OF_DATA_FORMATS">
  1720. Depending on the version of Excel, the maximum number of number formats in a workbook is between 200 and 250
  1721. See https://support.office.com/en-us/article/excel-specifications-and-limits-1672b34d-7043-467e-8e27-269d656771c3
  1722. POI defaults this limit to 250, but can be increased or decreased on a per-StylesTable basis with
  1723. {@link #setMaxNumberOfDataFormats(int)} if needed.
  1724. </member>
  1725. <member name="P:NPOI.XSSF.Model.StylesTable.MaxNumberOfDataFormats">
  1726. Get the upper limit on the number of data formats that has been set for the style table.
  1727. To get the current number of data formats in use, use {@link #getNumDataFormats()}.
  1728. @return the maximum number of data formats allowed in the workbook
  1729. </member>
  1730. <member name="M:NPOI.XSSF.Model.StylesTable.#ctor">
  1731. Create a new, empty StylesTable
  1732. </member>
  1733. <member name="M:NPOI.XSSF.Model.StylesTable.EnsureThemesTable">
  1734. If there isn't currently a {@link ThemesTable} for the
  1735. current Workbook, then creates one and sets it up.
  1736. After this, calls to {@link #getTheme()} won't give null
  1737. </member>
  1738. <member name="M:NPOI.XSSF.Model.StylesTable.ReadFrom(System.Xml.XmlDocument)">
  1739. Read this shared styles table from an XML file.
  1740. @param is The input stream Containing the XML document.
  1741. @throws IOException if an error occurs while Reading.
  1742. </member>
  1743. <member name="M:NPOI.XSSF.Model.StylesTable.GetNumberFormatAt(System.Int32)">
  1744. Get number format string given its id
  1745. @param idx number format id
  1746. @return number format code
  1747. </member>
  1748. <member name="M:NPOI.XSSF.Model.StylesTable.GetNumberFormatAt(System.Int16)">
  1749. Get number format string given its id
  1750. @param fmtId number format id
  1751. @return number format code
  1752. </member>
  1753. <member name="M:NPOI.XSSF.Model.StylesTable.PutNumberFormat(System.String)">
  1754. Puts <code>fmt</code> in the numberFormats map if the format is not
  1755. already in the the number format style table.
  1756. Does nothing if <code>fmt</code> is already in number format style table.
  1757. @param fmt the number format to add to number format style table
  1758. @return the index of <code>fmt</code> in the number format style table
  1759. </member>
  1760. <member name="M:NPOI.XSSF.Model.StylesTable.PutNumberFormat(System.Int16,System.String)">
  1761. Add a number format with a specific ID into the numberFormats map.
  1762. If a format with the same ID already exists, overwrite the format code
  1763. with <code>fmt</code>
  1764. This may be used to override built-in number formats.
  1765. @param index the number format ID
  1766. @param fmt the number format code
  1767. </member>
  1768. <member name="M:NPOI.XSSF.Model.StylesTable.RemoveNumberFormat(System.Int16)">
  1769. Remove a number format from the style table if it exists.
  1770. All cell styles with this number format will be modified to use the default number format.
  1771. @param fmt the number format to remove
  1772. @return true if the number format was removed
  1773. </member>
  1774. <member name="M:NPOI.XSSF.Model.StylesTable.RemoveNumberFormat(System.String)">
  1775. Remove a number format from the style table if it exists
  1776. All cell styles with this number format will be modified to use the default number format
  1777. @param fmt the number format to remove
  1778. @return true if the number format was removed
  1779. </member>
  1780. <member name="M:NPOI.XSSF.Model.StylesTable.PutFont(NPOI.XSSF.UserModel.XSSFFont,System.Boolean)">
  1781. Records the given font in the font table.
  1782. Will re-use an existing font index if this
  1783. font matches another, EXCEPT if forced
  1784. registration is requested.
  1785. This allows people to create several fonts
  1786. then customise them later.
  1787. Note - End Users probably want to call
  1788. {@link XSSFFont#registerTo(StylesTable)}
  1789. </member>
  1790. <member name="M:NPOI.XSSF.Model.StylesTable.PutBorder(NPOI.XSSF.UserModel.Extensions.XSSFCellBorder)">
  1791. <summary>
  1792. Adds a border to the border style table if it isn't already in the style table
  1793. Does nothing if border is already in borders style table
  1794. </summary>
  1795. <param name="border">border to add</param>
  1796. <returns>return the index of the added border</returns>
  1797. </member>
  1798. <member name="M:NPOI.XSSF.Model.StylesTable.PutFill(NPOI.XSSF.UserModel.Extensions.XSSFCellFill)">
  1799. <summary>
  1800. Adds a fill to the fill style table if it isn't already in the style table
  1801. Does nothing if fill is already in fill style table
  1802. </summary>
  1803. <param name="fill">fill to add</param>
  1804. <returns>return the index of the added fill</returns>
  1805. </member>
  1806. <member name="M:NPOI.XSSF.Model.StylesTable.PutCellXf(NPOI.OpenXmlFormats.Spreadsheet.CT_Xf)">
  1807. <summary>
  1808. Adds a cell to the styles table. Does not check for duplicates
  1809. </summary>
  1810. <param name="cellXf">the cell to add to the styles table</param>
  1811. <returns>return the added cell ID in the style table</returns>
  1812. </member>
  1813. <member name="M:NPOI.XSSF.Model.StylesTable.PutCellStyleXf(NPOI.OpenXmlFormats.Spreadsheet.CT_Xf)">
  1814. <summary>
  1815. Adds a cell style to the styles table.Does not check for duplicates.
  1816. </summary>
  1817. <param name="cellStyleXf">the cell style to add to the styles table</param>
  1818. <returns>return the cell style ID in the style table</returns>
  1819. </member>
  1820. <member name="P:NPOI.XSSF.Model.StylesTable.NumCellStyles">
  1821. get the size of cell styles
  1822. </member>
  1823. <member name="P:NPOI.XSSF.Model.StylesTable.NumDataFormats">
  1824. @return number of data formats in the styles table
  1825. </member>
  1826. <member name="P:NPOI.XSSF.Model.StylesTable.NumberFormatSize">
  1827. For unit testing only
  1828. </member>
  1829. <member name="P:NPOI.XSSF.Model.StylesTable.XfsSize">
  1830. For unit testing only
  1831. </member>
  1832. <member name="P:NPOI.XSSF.Model.StylesTable.StyleXfsSize">
  1833. For unit testing only
  1834. </member>
  1835. <member name="M:NPOI.XSSF.Model.StylesTable.GetCTStylesheet">
  1836. For unit testing only!
  1837. </member>
  1838. <member name="M:NPOI.XSSF.Model.StylesTable.WriteTo(System.IO.Stream)">
  1839. Write this table out as XML.
  1840. @param out The stream to write to.
  1841. @throws IOException if an error occurs while writing.
  1842. </member>
  1843. <member name="M:NPOI.XSSF.Model.StylesTable.PutDxf(NPOI.OpenXmlFormats.Spreadsheet.CT_Dxf)">
  1844. <summary>
  1845. Adds a Dxf to the style table Does not check for duplicates.
  1846. </summary>
  1847. <param name="dxf">the Dxf to add</param>
  1848. <returns>added dxf ID in the style table</returns>
  1849. </member>
  1850. <member name="M:NPOI.XSSF.Model.StylesTable.CreateCellStyle">
  1851. Create a cell style in this style table.
  1852. Note - End users probably want to call {@link XSSFWorkbook#createCellStyle()}
  1853. rather than working with the styles table directly.
  1854. </member>
  1855. <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)">
  1856. Finds a font that matches the one with the supplied attributes
  1857. </member>
  1858. <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)">
  1859. Finds a font that matches the one with the supplied attributes
  1860. </member>
  1861. <member name="T:NPOI.XSSF.Model.ThemesTable">
  1862. Class that represents theme of XLSX document. The theme includes specific
  1863. colors and fonts.
  1864. </member>
  1865. <member name="M:NPOI.XSSF.Model.ThemesTable.#ctor">
  1866. Create a new, empty ThemesTable
  1867. </member>
  1868. <member name="M:NPOI.XSSF.Model.ThemesTable.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  1869. Construct a ThemesTable.
  1870. @param part A PackagePart.
  1871. @param rel A PackageRelationship.
  1872. </member>
  1873. <member name="M:NPOI.XSSF.Model.ThemesTable.#ctor(NPOI.OpenXmlFormats.Spreadsheet.ThemeDocument)">
  1874. Construct a ThemesTable from an existing ThemeDocument.
  1875. @param theme A ThemeDocument.
  1876. </member>
  1877. <member name="M:NPOI.XSSF.Model.ThemesTable.GetThemeColor(System.Int32)">
  1878. Convert a theme "index" into a color.
  1879. @param idx A theme "index"
  1880. @return The mapped XSSFColor, or null if not mapped.
  1881. </member>
  1882. <member name="M:NPOI.XSSF.Model.ThemesTable.InheritFromThemeAsRequired(NPOI.XSSF.UserModel.XSSFColor)">
  1883. If the colour is based on a theme, then inherit
  1884. information (currently just colours) from it as
  1885. required.
  1886. </member>
  1887. <member name="M:NPOI.XSSF.Model.ThemesTable.writeTo(System.IO.Stream)">
  1888. Write this table out as XML.
  1889. @param out The stream to write to.
  1890. @throws IOException if an error occurs while writing.
  1891. </member>
  1892. <member name="F:NPOI.XSSF.Streaming.AutoSizeColumnTracker.maxColumnWidths">
  1893. <summary>
  1894. map of tracked columns, with values containing the best-fit width for the column
  1895. Using a HashMap instead of a TreeMap because insertion (trackColumn), removal (untrackColumn), and membership (everything)
  1896. will be called more frequently than getTrackedColumns(). The O(1) cost of insertion, removal, and membership operations
  1897. outweigh the infrequent O(n*log n) cost of sorting getTrackedColumns().
  1898. Memory consumption for a HashMap and TreeMap is about the same
  1899. </summary>
  1900. </member>
  1901. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.ColumnWidthPair.GetMaxColumnWidth(System.Boolean)">
  1902. Gets the current best-fit column width for the provided settings
  1903. @param useMergedCells true if merged cells are considered into the best-fit column width calculation
  1904. @return best fit column width, measured in default character widths.
  1905. </member>
  1906. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.ColumnWidthPair.SetMaxColumnWidths(System.Double,System.Double)">
  1907. Sets the best-fit column width to the maximum of the current width and the provided width
  1908. @param unmergedWidth the best-fit column width calculated with useMergedCells=False
  1909. @param mergedWidth the best-fit column width calculated with useMergedCells=True
  1910. </member>
  1911. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.#ctor(NPOI.SS.UserModel.ISheet)">
  1912. AutoSizeColumnTracker constructor. Holds no reference to <code>sheet</code>
  1913. @param sheet the sheet associated with this auto-size column tracker
  1914. @since 3.14beta1
  1915. </member>
  1916. <member name="P:NPOI.XSSF.Streaming.AutoSizeColumnTracker.TrackedColumns">
  1917. Get the currently tracked columns, naturally ordered.
  1918. Note if all columns are tracked, this will only return the columns that have been explicitly or implicitly tracked,
  1919. which is probably only columns containing 1 or more non-blank values
  1920. @return a set of the indices of all tracked columns
  1921. @since 3.14beta1
  1922. </member>
  1923. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.IsColumnTracked(System.Int32)">
  1924. Returns true if column is currently tracked for auto-sizing.
  1925. @param column the index of the column to check
  1926. @return true if column is tracked
  1927. @since 3.14beta1
  1928. </member>
  1929. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.IsAllColumnsTracked">
  1930. Returns true if all columns are implicitly tracked.
  1931. @return true if all columns are implicitly tracked
  1932. @since 3.14beta1
  1933. </member>
  1934. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.TrackAllColumns">
  1935. Tracks all non-blank columns
  1936. Allows columns that have been explicitly untracked to be tracked
  1937. @since 3.14beta1
  1938. </member>
  1939. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.UntrackAllColumns">
  1940. Untrack all columns that were previously tracked for auto-sizing.
  1941. All best-fit column widths are forgotten.
  1942. @since 3.14beta1
  1943. </member>
  1944. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.TrackColumns(System.Collections.Generic.ICollection{System.Int32})">
  1945. Marks multiple columns for inclusion in auto-size column tracking.
  1946. Note this has undefined behavior if columns are tracked after one or more rows are written to the sheet.
  1947. Any column in <code>columns</code> that are already tracked are ignored by this call.
  1948. @param columns the indices of the columns to track
  1949. @since 3.14beta1
  1950. </member>
  1951. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.TrackColumn(System.Int32)">
  1952. Marks a column for inclusion in auto-size column tracking.
  1953. Note this has undefined behavior if a column is tracked after one or more rows are written to the sheet.
  1954. If <code>column</code> is already tracked, this call does nothing.
  1955. @param column the index of the column to track for auto-sizing
  1956. @return if column is already tracked, the call does nothing and returns false
  1957. @since 3.14beta1
  1958. </member>
  1959. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.ImplicitlyTrackColumn(System.Int32)">
  1960. Implicitly track a column if it has not been explicitly untracked
  1961. If it has been explicitly untracked, this call does nothing and returns false.
  1962. Otherwise return true
  1963. @param column the column to implicitly track
  1964. @return false if column has been explicitly untracked, otherwise return true
  1965. </member>
  1966. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.UntrackColumns(System.Collections.Generic.ICollection{System.Int32})">
  1967. Removes columns that were previously marked for inclusion in auto-size column tracking.
  1968. When a column is untracked, the best-fit width is forgotten.
  1969. Any column in <code>columns</code> that is not tracked will be ignored by this call.
  1970. @param columns the indices of the columns to track for auto-sizing
  1971. @return true if one or more columns were untracked as a result of this call
  1972. @since 3.14beta1
  1973. </member>
  1974. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.UntrackColumn(System.Int32)">
  1975. Removes a column that was previously marked for inclusion in auto-size column tracking.
  1976. When a column is untracked, the best-fit width is forgotten.
  1977. If <code>column</code> is not tracked, it will be ignored by this call.
  1978. @param column the index of the column to track for auto-sizing
  1979. @return true if column was tracked prior this call, false if no action was taken
  1980. @since 3.14beta1
  1981. </member>
  1982. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.GetBestFitColumnWidth(System.Int32,System.Boolean)">
  1983. Get the best-fit width of a tracked column
  1984. @param column the index of the column to get the current best-fit width of
  1985. @param useMergedCells true if merged cells should be considered when computing the best-fit width
  1986. @return best-fit column width, measured in number of characters
  1987. @throws InvalidOperationException if column is not tracked and trackAllColumns is false
  1988. @since 3.14beta1
  1989. </member>
  1990. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.UpdateColumnWidths(NPOI.SS.UserModel.IRow)">
  1991. Calculate the best fit width for each tracked column in row
  1992. @param row the row to get the cells
  1993. @since 3.14beta1
  1994. </member>
  1995. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.ImplicitlyTrackColumnsInRow(NPOI.SS.UserModel.IRow)">
  1996. Helper for {@link #updateColumnWidths(Row)}.
  1997. Implicitly track the columns corresponding to the cells in row.
  1998. If all columns in the row are already tracked, this call does nothing.
  1999. Explicitly untracked columns will not be tracked.
  2000. @param row the row containing cells to implicitly track the columns
  2001. @since 3.14beta1
  2002. </member>
  2003. <member name="M:NPOI.XSSF.Streaming.AutoSizeColumnTracker.UpdateColumnWidth(NPOI.SS.UserModel.ICell,NPOI.XSSF.Streaming.AutoSizeColumnTracker.ColumnWidthPair)">
  2004. Helper for {@link #updateColumnWidths(Row)}.
  2005. @param cell the cell to compute the best fit width on
  2006. @param pair the column width pair to update
  2007. @since 3.14beta1
  2008. </member>
  2009. <member name="M:NPOI.XSSF.Streaming.GZIPSheetDataWriter.#ctor(NPOI.XSSF.Model.SharedStringsTable)">
  2010. @param sharedStringsTable the shared strings table, or null if inline text is used
  2011. </member>
  2012. <member name="M:NPOI.XSSF.Streaming.GZIPSheetDataWriter.CreateTempFile">
  2013. @return temp file to write sheet data
  2014. </member>
  2015. <member name="F:NPOI.XSSF.Streaming.SheetDataWriter._sharedStringSource">
  2016. Table of strings shared across this workbook.
  2017. If two cells contain the same string, then the cell value is the same index into SharedStringsTable
  2018. </member>
  2019. <member name="M:NPOI.XSSF.Streaming.SheetDataWriter.CreateTempFile">
  2020. Create a temp file to write sheet data.
  2021. By default, temp files are created in the default temporary-file directory
  2022. with a prefix "poi-sxssf-sheet" and suffix ".xml". Subclasses can override
  2023. it and specify a different temp directory or filename or suffix, e.g. <code>.gz</code>
  2024. @return temp file to write sheet data
  2025. </member>
  2026. <member name="M:NPOI.XSSF.Streaming.SheetDataWriter.CreateWriter(System.IO.FileInfo)">
  2027. Create a writer for the sheet data.
  2028. @param fd the file to write to
  2029. </member>
  2030. <member name="M:NPOI.XSSF.Streaming.SheetDataWriter.DecorateOutputStream(System.IO.Stream)">
  2031. Override this to translate (such as encrypt or compress) the file output stream
  2032. as it is being written to disk.
  2033. The default behavior is to to pass the stream through unmodified.
  2034. @param fos the stream to decorate
  2035. @return a decorated stream
  2036. @throws IOException
  2037. @see #decorateInputStream(FileInputStream)
  2038. </member>
  2039. <member name="M:NPOI.XSSF.Streaming.SheetDataWriter.Close">
  2040. flush and close the temp data writer.
  2041. This method <em>must</em> be invoked before calling {@link #getWorksheetXMLInputStream()}
  2042. </member>
  2043. <member name="M:NPOI.XSSF.Streaming.SheetDataWriter.GetWorksheetXmlInputStream">
  2044. @return a stream to read temp file with the sheet data
  2045. </member>
  2046. <member name="M:NPOI.XSSF.Streaming.SheetDataWriter.DecorateInputStream(System.IO.Stream)">
  2047. Override this to translate (such as decrypt or expand) the file input stream
  2048. as it is being read from disk.
  2049. The default behavior is to to pass the stream through unmodified.
  2050. @param fis the stream to decorate
  2051. @return a decorated stream
  2052. @throws IOException
  2053. @see #decorateOutputStream(FileOutputStream)
  2054. </member>
  2055. <member name="M:NPOI.XSSF.Streaming.SheetDataWriter.WriteRow(System.Int32,NPOI.XSSF.Streaming.SXSSFRow)">
  2056. Write a row to the file
  2057. @param rownum 0-based row number
  2058. @param row a row
  2059. </member>
  2060. <member name="M:NPOI.XSSF.Streaming.SheetDataWriter.HasLeadingTrailingSpaces(System.String)">
  2061. @return whether the string has leading / trailing spaces that
  2062. need to be preserved with the xml:space=\"preserve\" attribute
  2063. </member>
  2064. <member name="M:NPOI.XSSF.Streaming.SheetDataWriter.Dispose">
  2065. Deletes the temporary file that backed this sheet on disk.
  2066. @return true if the file was deleted, false if it wasn't.
  2067. </member>
  2068. <member name="M:NPOI.XSSF.Streaming.SXSSFCell.typeMismatch(NPOI.SS.UserModel.CellType,NPOI.SS.UserModel.CellType,System.Boolean)">
  2069. Used to help format error messages
  2070. </member>
  2071. <member name="P:NPOI.XSSF.Streaming.SXSSFEvaluationCell.CellType">
  2072. Will return {@link CellType} in a future version of POI.
  2073. For forwards compatibility, do not hard-code cell type literals in your code.
  2074. @return cell type
  2075. </member>
  2076. <member name="P:NPOI.XSSF.Streaming.SXSSFEvaluationCell.CellTypeEnum">
  2077. @since POI 3.15 beta 3
  2078. @deprecated POI 3.15 beta 3.
  2079. Will be deleted when we make the CellType enum transition. See bug 59791.
  2080. </member>
  2081. <member name="P:NPOI.XSSF.Streaming.SXSSFEvaluationCell.CachedFormulaResultType">
  2082. Will return {@link CellType} in a future version of POI.
  2083. For forwards compatibility, do not hard-code cell type literals in your code.
  2084. @return cell type of cached formula result
  2085. </member>
  2086. <member name="M:NPOI.XSSF.Streaming.SXSSFEvaluationCell.GetCachedFormulaResultTypeEnum">
  2087. @since POI 3.15 beta 3
  2088. @deprecated POI 3.15 beta 3.
  2089. Will be deleted when we make the CellType enum transition. See bug 59791.
  2090. </member>
  2091. <member name="M:NPOI.XSSF.Streaming.SXSSFFormulaEvaluator.EvaluateAll">
  2092. Loops over rows and cells, evaluating formula cells there.
  2093. If any sheets are inactive, or any cells outside of the window,
  2094. will give an Exception.
  2095. For SXSSF, you generally don't want to use this method, instead
  2096. evaluate your formulas as you go before they leave the window.
  2097. </member>
  2098. <member name="M:NPOI.XSSF.Streaming.SXSSFRow.CompareTo(NPOI.XSSF.Streaming.SXSSFRow)">
  2099. Compares two <code>SXSSFRow</code> objects. Two rows are equal if they belong to the same worksheet and
  2100. their row indexes are equal.
  2101. @param other the <code>SXSSFRow</code> to be compared.
  2102. @return <ul>
  2103. <li>
  2104. the value <code>0</code> if the row number of this <code>SXSSFRow</code> is
  2105. equal to the row number of the argument <code>SXSSFRow</code>
  2106. </li>
  2107. <li>
  2108. a value less than <code>0</code> if the row number of this this <code>SXSSFRow</code> is
  2109. numerically less than the row number of the argument <code>SXSSFRow</code>
  2110. </li>
  2111. <li>
  2112. a value greater than <code>0</code> if the row number of this this <code>SXSSFRow</code> is
  2113. numerically greater than the row number of the argument <code>SXSSFRow</code>
  2114. </li>
  2115. </ul>
  2116. @throws IllegalArgumentException if the argument row belongs to a different worksheet
  2117. </member>
  2118. <member name="M:NPOI.XSSF.Streaming.SXSSFRow.CheckBounds(System.Int32)">
  2119. <summary>
  2120. throws RuntimeException if the bounds are exceeded.
  2121. </summary>
  2122. <param name="cellIndex"></param>
  2123. </member>
  2124. <member name="M:NPOI.XSSF.Streaming.SXSSFRow.GetCellIndex(NPOI.XSSF.Streaming.SXSSFCell)">
  2125. Return the column number of a cell if it is in this row
  2126. Otherwise return -1
  2127. @param cell the cell to get the index of
  2128. @return cell column index if it is in this row, -1 otherwise
  2129. </member>
  2130. <member name="T:NPOI.XSSF.Streaming.SXSSFRow.FilledCellIterator">
  2131. Create an iterator over the cells from [0, getLastCellNum()).
  2132. Includes blank cells, excludes empty cells
  2133. Returns an iterator over all filled cells (created via Row.createCell())
  2134. Throws ConcurrentModificationException if cells are added, moved, or
  2135. removed after the iterator is created.
  2136. </member>
  2137. <member name="P:NPOI.XSSF.Streaming.SXSSFSheet.IsPrintRowAndColumnHeadings">
  2138. Returns whether row and column headings are printed.
  2139. @return whether row and column headings are printed
  2140. </member>
  2141. <member name="P:NPOI.XSSF.Streaming.SXSSFSheet.MergedRegions">
  2142. Returns the list of merged regions. If you want multiple regions, this is
  2143. faster than calling {@link #getMergedRegion(int)} each time.
  2144. @return the list of merged regions
  2145. </member>
  2146. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.AddMergedRegionUnsafe(NPOI.SS.Util.CellRangeAddress)">
  2147. <summary>
  2148. Adds a merged region of cells (hence those cells form one).
  2149. Skips validation.It is possible to create overlapping merged regions
  2150. or create a merged region that intersects a multi-cell array formula
  2151. with this formula, which may result in a corrupt workbook.
  2152. </summary>
  2153. <param name="region">region to merge</param>
  2154. <returns>index of this region</returns>
  2155. <exception cref="T:System.ArgumentException">if region contains fewer than 2 cells</exception>
  2156. </member>
  2157. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.ValidateMergedRegions">
  2158. Verify that merged regions do not intersect multi-cell array formulas and
  2159. no merged regions intersect another merged region in this sheet.
  2160. @throws InvalidOperationException if region intersects with a multi-cell array formula
  2161. @throws InvalidOperationException if at least one region intersects with another merged region in this sheet
  2162. </member>
  2163. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.AutoSizeColumn(System.Int32)">
  2164. Adjusts the column width to fit the contents.
  2165. <p>
  2166. This process can be relatively slow on large sheets, so this should
  2167. normally only be called once per column, at the end of your
  2168. processing.
  2169. </p>
  2170. You can specify whether the content of merged cells should be considered or ignored.
  2171. Default is to ignore merged cells.
  2172. <p>
  2173. Special note about SXSSF implementation: You must register the columns you wish to track with
  2174. the SXSSFSheet using {@link #trackColumnForAutoSizing(int)} or {@link #trackAllColumnsForAutoSizing()}.
  2175. This is needed because the rows needed to compute the column width may have fallen outside the
  2176. random access window and been flushed to disk.
  2177. Tracking columns is required even if all rows are in the random access window.
  2178. </p>
  2179. <p><i>New in POI 3.14 beta 1: auto-sizes columns using cells from current and flushed rows.</i></p>
  2180. @param column the column index to auto-size
  2181. </member>
  2182. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.AutoSizeColumn(System.Int32,System.Boolean)">
  2183. Adjusts the column width to fit the contents.
  2184. <p>
  2185. This process can be relatively slow on large sheets, so this should
  2186. normally only be called once per column, at the end of your
  2187. processing.
  2188. </p>
  2189. You can specify whether the content of merged cells should be considered or ignored.
  2190. Default is to ignore merged cells.
  2191. <p>
  2192. Special note about SXSSF implementation: You must register the columns you wish to track with
  2193. the SXSSFSheet using {@link #trackColumnForAutoSizing(int)} or {@link #trackAllColumnsForAutoSizing()}.
  2194. This is needed because the rows needed to compute the column width may have fallen outside the
  2195. random access window and been flushed to disk.
  2196. Tracking columns is required even if all rows are in the random access window.
  2197. </p>
  2198. <p><i>New in POI 3.14 beta 1: auto-sizes columns using cells from current and flushed rows.</i></p>
  2199. @param column the column index to auto-size
  2200. @param useMergedCells whether to use the contents of merged cells when calculating the width of the column
  2201. </member>
  2202. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.GetHyperlink(System.Int32,System.Int32)">
  2203. <summary>
  2204. Get a Hyperlink in this sheet anchored at row, column
  2205. </summary>
  2206. <param name="row">The index of the row of the hyperlink, zero-based</param>
  2207. <param name="column">the index of the column of the hyperlink, zero-based</param>
  2208. <returns>return hyperlink if there is a hyperlink anchored at row, column; otherwise returns null</returns>
  2209. </member>
  2210. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.GetHyperlink(NPOI.SS.Util.CellAddress)">
  2211. <summary>
  2212. Get a Hyperlink in this sheet located in a cell specified by {code addr}
  2213. </summary>
  2214. <param name="addr">The address of the cell containing the hyperlink</param>
  2215. <returns>return hyperlink if there is a hyperlink anchored at {@code addr}; otherwise returns {@code null}</returns>
  2216. </member>
  2217. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.GetHyperlinkList">
  2218. Get a list of Hyperlinks in this sheet
  2219. @return Hyperlinks for the sheet
  2220. </member>
  2221. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.GetCellComment(System.Int32,System.Int32)">
  2222. <summary>
  2223. Returns cell comment for the specified row and column
  2224. </summary>
  2225. <param name="row">The row.</param>
  2226. <param name="column">The column.</param>
  2227. <returns>cell comment or <code>null</code> if not found</returns>
  2228. </member>
  2229. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.GetCellComment(NPOI.SS.Util.CellAddress)">
  2230. <summary>
  2231. Returns cell comment for the specified location
  2232. </summary>
  2233. <param name="ref1">cell location</param>
  2234. <returns>return cell comment or null if not found</returns>
  2235. </member>
  2236. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.GetCellComments">
  2237. <summary>
  2238. Returns all cell comments on this sheet.
  2239. </summary>
  2240. <returns>return A Dictionary of each Comment in the sheet, keyed on the cell address where the comment is located.</returns>
  2241. </member>
  2242. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.SetRowOutlineLevel(System.Int32,System.Int32)">
  2243. Set row groupings (like groupRow) in a stream-friendly manner
  2244. <p>
  2245. groupRows requires all rows in the group to be in the current window.
  2246. This is not always practical. Instead use setRowOutlineLevel to
  2247. explicitly set the group level. Level 1 is the top level group,
  2248. followed by 2, etc. It is up to the user to ensure that level 2
  2249. groups are correctly nested under level 1, etc.
  2250. </p>
  2251. @param rownum index of row to update (0-based)
  2252. @param level outline level (greater than 0)
  2253. </member>
  2254. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.RemoveMergedRegions(System.Collections.Generic.IList{System.Int32})">
  2255. Removes a merged region of cells (hence letting them free)
  2256. @param indices of the regions to unmerge
  2257. </member>
  2258. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.TrackColumnForAutoSizing(System.Int32)">
  2259. Track a column in the sheet for auto-sizing.
  2260. Note this has undefined behavior if a column is tracked after one or more rows are written to the sheet.
  2261. If <code>column</code> is already tracked, this call does nothing.
  2262. @param column the column to track for autosizing
  2263. @since 3.14beta1
  2264. @see #trackColumnsForAutoSizing(Collection)
  2265. @see #trackAllColumnsForAutoSizing()
  2266. </member>
  2267. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.TrackColumnsForAutoSizing(System.Collections.Generic.ICollection{System.Int32})">
  2268. Track several columns in the sheet for auto-sizing.
  2269. Note this has undefined behavior if columns are tracked after one or more rows are written to the sheet.
  2270. Any column in <code>columns</code> that are already tracked are ignored by this call.
  2271. @param columns the columns to track for autosizing
  2272. @since 3.14beta1
  2273. </member>
  2274. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.TrackAllColumnsForAutoSizing">
  2275. Tracks all columns in the sheet for auto-sizing. If this is called, individual columns do not need to be tracked.
  2276. Because determining the best-fit width for a cell is expensive, this may affect the performance.
  2277. @since 3.14beta1
  2278. </member>
  2279. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.UntrackColumnForAutoSizing(System.Int32)">
  2280. Removes a column that was previously marked for inclusion in auto-size column tracking.
  2281. When a column is untracked, the best-fit width is forgotten.
  2282. If <code>column</code> is not tracked, it will be ignored by this call.
  2283. @param column the index of the column to track for auto-sizing
  2284. @return true if column was tracked prior to this call, false if no action was taken
  2285. @since 3.14beta1
  2286. @see #untrackColumnsForAutoSizing(Collection)
  2287. @see #untrackAllColumnsForAutoSizing(int)
  2288. </member>
  2289. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.UntrackColumnsForAutoSizing(System.Collections.Generic.ICollection{System.Int32})">
  2290. Untracks several columns in the sheet for auto-sizing.
  2291. When a column is untracked, the best-fit width is forgotten.
  2292. Any column in <code>columns</code> that is not tracked will be ignored by this call.
  2293. @param columns the indices of the columns to track for auto-sizing
  2294. @return true if one or more columns were untracked as a result of this call
  2295. @param columns the columns to track for autosizing
  2296. @since 3.14beta1
  2297. </member>
  2298. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.UntrackAllColumnsForAutoSizing">
  2299. Untracks all columns in the sheet for auto-sizing. Best-fit column widths are forgotten.
  2300. If this is called, individual columns do not need to be untracked.
  2301. @since 3.14beta1
  2302. </member>
  2303. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.IsColumnTrackedForAutoSizing(System.Int32)">
  2304. Returns true if column is currently tracked for auto-sizing.
  2305. @param column the index of the column to check
  2306. @return true if column is tracked
  2307. @since 3.14beta1
  2308. </member>
  2309. <member name="P:NPOI.XSSF.Streaming.SXSSFSheet.TrackedColumnsForAutoSizing">
  2310. Get the currently tracked columns for auto-sizing.
  2311. Note if all columns are tracked, this will only return the columns that have been explicitly or implicitly tracked,
  2312. which is probably only columns containing 1 or more non-blank values
  2313. @return a set of the indices of all tracked columns
  2314. @since 3.14beta1
  2315. </member>
  2316. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.FindStartOfRowOutlineGroup(System.Int32)">
  2317. @param rowIndex the zero based row index to find from
  2318. </member>
  2319. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.Streaming.SXSSFSheet.SetZoom(System.Int32)" -->
  2320. <member name="M:NPOI.XSSF.Streaming.SXSSFSheet.FlushRows(System.Int32,System.Boolean)">
  2321. Specifies how many rows can be accessed at most via getRow().
  2322. The exceeding rows (if any) are flushed to the disk while rows
  2323. with lower index values are flushed first.
  2324. </member>
  2325. <member name="P:NPOI.XSSF.Streaming.SXSSFSheet.LastFlushedRowNumber">
  2326. @return Last row number to be flushed to disk, or -1 if none flushed yet
  2327. </member>
  2328. <member name="T:NPOI.XSSF.Streaming.SXSSFWorkbook">
  2329. Streaming version of XSSFWorkbook implementing the "BigGridDemo" strategy.
  2330. This allows to write very large files without running out of memory as only
  2331. a configurable portion of the rows are kept in memory at any one time.
  2332. You can provide a template workbook which is used as basis for the written
  2333. data.
  2334. See https://poi.apache.org/spreadsheet/how-to.html#sxssf for details.
  2335. Please note that there are still things that still may consume a large
  2336. amount of memory based on which features you are using, e.g. merged regions,
  2337. comments, ... are still only stored in memory and thus may require a lot of
  2338. memory if used extensively.
  2339. SXSSFWorkbook defaults to using inline strings instead of a shared strings
  2340. table. This is very efficient, since no document content needs to be kept in
  2341. memory, but is also known to produce documents that are incompatible with
  2342. some clients. With shared strings enabled all unique strings in the document
  2343. has to be kept in memory. Depending on your document content this could use
  2344. a lot more resources than with shared strings disabled.
  2345. Carefully review your memory budget and compatibility needs before deciding
  2346. whether to enable shared strings or not.
  2347. <summary>
  2348. Streaming version of the XSSFWorkbook, originally implemented in the "BigGridDemo".
  2349. </summary>
  2350. </member>
  2351. <member name="P:NPOI.XSSF.Streaming.SXSSFWorkbook.RandomAccessWindowSize">
  2352. See the constructors for a more detailed description of the sliding window of rows.
  2353. @return The number of rows that are kept in memory at once before flushing them out.
  2354. </member>
  2355. <member name="F:NPOI.XSSF.Streaming.SXSSFWorkbook._compressTmpFiles">
  2356. <summary>
  2357. whether temp file should be compresss.
  2358. </summary>
  2359. </member>
  2360. <member name="F:NPOI.XSSF.Streaming.SXSSFWorkbook._sharedStringSource">
  2361. <summary>
  2362. shared string table - a cache of strings in this workbook.
  2363. </summary>
  2364. </member>
  2365. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.#ctor(System.Int32)">
  2366. Construct an empty workbook and specify the window for row access.
  2367. <p>
  2368. When a new node is created via createRow() and the total number
  2369. of unflushed records would exceed the specified value, then the
  2370. row with the lowest index value is flushed and cannot be accessed
  2371. via getRow() anymore.
  2372. </p>
  2373. <p>
  2374. A value of -1 indicates unlimited access. In this case all
  2375. records that have not been flushed by a call to flush() are available
  2376. for random access.
  2377. </p>
  2378. <p>
  2379. A value of 0 is not allowed because it would flush any newly created row
  2380. without having a chance to specify any cells.
  2381. </p>
  2382. @param rowAccessWindowSize the number of rows that are kept in memory until flushed out, see above.
  2383. </member>
  2384. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.#ctor">
  2385. <summary>
  2386. Construct a new workbook with default row window size
  2387. </summary>
  2388. </member>
  2389. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.#ctor(NPOI.XSSF.UserModel.XSSFWorkbook)">
  2390. Construct a workbook from a template.
  2391. <p>
  2392. There are three use-cases to use SXSSFWorkbook(XSSFWorkbook) :
  2393. <ol>
  2394. <li>
  2395. Append new sheets to existing workbooks. You can open existing
  2396. workbook from a file or create on the fly with XSSF.
  2397. </li>
  2398. <li>
  2399. Append rows to existing sheets. The row number MUST be greater
  2400. than max(rownum) in the template sheet.
  2401. </li>
  2402. <li>
  2403. Use existing workbook as a template and re-use global objects such
  2404. as cell styles, formats, images, etc.
  2405. </li>
  2406. </ol>
  2407. All three use cases can work in a combination.
  2408. </p>
  2409. What is not supported:
  2410. <ul>
  2411. <li>
  2412. Access initial cells and rows in the template. After constructing
  2413. SXSSFWorkbook(XSSFWorkbook) all internal windows are empty and
  2414. SXSSFSheet@getRow and SXSSFRow#getCell return null.
  2415. </li>
  2416. <li>
  2417. Override existing cells and rows. The API silently allows that but
  2418. the output file is invalid and Excel cannot read it.
  2419. </li>
  2420. </ul>
  2421. @param workbook the template workbook
  2422. </member>
  2423. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.#ctor(NPOI.XSSF.UserModel.XSSFWorkbook,System.Int32)">
  2424. Constructs an workbook from an existing workbook.
  2425. <p>
  2426. When a new node is created via createRow() and the total number
  2427. of unflushed records would exceed the specified value, then the
  2428. row with the lowest index value is flushed and cannot be accessed
  2429. via getRow() anymore.
  2430. </p>
  2431. <p>
  2432. A value of -1 indicates unlimited access. In this case all
  2433. records that have not been flushed by a call to flush() are available
  2434. for random access.
  2435. </p>
  2436. <p>
  2437. A value of 0 is not allowed because it would flush any newly created row
  2438. without having a chance to specify any cells.
  2439. </p>
  2440. @param rowAccessWindowSize the number of rows that are kept in memory until flushed out, see above.
  2441. </member>
  2442. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.#ctor(NPOI.XSSF.UserModel.XSSFWorkbook,System.Int32,System.Boolean)">
  2443. Constructs an workbook from an existing workbook.
  2444. <p>
  2445. When a new node is created via createRow() and the total number
  2446. of unflushed records would exceed the specified value, then the
  2447. row with the lowest index value is flushed and cannot be accessed
  2448. via getRow() anymore.
  2449. </p>
  2450. <p>
  2451. A value of -1 indicates unlimited access. In this case all
  2452. records that have not been flushed by a call to flush() are available
  2453. for random access.
  2454. </p>
  2455. <p>
  2456. A value of 0 is not allowed because it would flush any newly created row
  2457. without having a chance to specify any cells.
  2458. </p>
  2459. @param rowAccessWindowSize the number of rows that are kept in memory until flushed out, see above.
  2460. @param compressTmpFiles whether to use gzip compression for temporary files
  2461. </member>
  2462. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.#ctor(NPOI.XSSF.UserModel.XSSFWorkbook,System.Int32,System.Boolean,System.Boolean)">
  2463. Constructs an workbook from an existing workbook.
  2464. <p>
  2465. When a new node is created via createRow() and the total number
  2466. of unflushed records would exceed the specified value, then the
  2467. row with the lowest index value is flushed and cannot be accessed
  2468. via getRow() anymore.
  2469. </p>
  2470. <p>
  2471. A value of -1 indicates unlimited access. In this case all
  2472. records that have not been flushed by a call to flush() are available
  2473. for random access.
  2474. </p>
  2475. <p>
  2476. A value of 0 is not allowed because it would flush any newly created row
  2477. without having a chance to specify any cells.
  2478. </p>
  2479. @param workbook the template workbook
  2480. @param rowAccessWindowSize the number of rows that are kept in memory until flushed out, see above.
  2481. @param compressTmpFiles whether to use gzip compression for temporary files
  2482. @param useSharedStringsTable whether to use a shared strings table
  2483. <summary>
  2484. Currently only supports writing not reading. E.g. the number of rows returned from a worksheet will be wrong etc.
  2485. </summary>
  2486. <param name="workbook"></param>
  2487. <param name="rowAccessWindowSize"></param>
  2488. <param name="compressTmpFiles"></param>
  2489. <param name="useSharedStringsTable"></param>
  2490. </member>
  2491. <member name="P:NPOI.XSSF.Streaming.SXSSFWorkbook.CompressTempFiles">
  2492. Set whether temp files should be compressed.
  2493. <p>
  2494. SXSSF writes sheet data in temporary files (a temp file per-sheet)
  2495. and the size of these temp files can grow to to a very large size,
  2496. e.g. for a 20 MB csv data the size of the temp xml file become few GB large.
  2497. If the "compress" flag is set to <code>true</code> then the temporary XML is gzipped.
  2498. </p>
  2499. <p>
  2500. Please note the the "compress" option may cause performance penalty.
  2501. </p>
  2502. @param compress whether to compress temp files
  2503. </member>
  2504. <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)">
  2505. Finds a font that matches the one with the supplied attributes
  2506. @return the font with the matched attributes or <code>null</code>
  2507. </member>
  2508. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.Dispose">
  2509. Dispose of temporary files backing this workbook on disk.
  2510. Calling this method will render the workbook unusable.
  2511. @return true if all temporary files were deleted successfully.
  2512. </member>
  2513. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.GetNames(System.String)">
  2514. Returns all defined names with the given name.
  2515. @param name the name of the defined name
  2516. @return a list of the defined names with the specified name. An empty list is returned if none is found.
  2517. </member>
  2518. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.GetAllNames">
  2519. <summary>
  2520. Returns all defined names
  2521. </summary>
  2522. <returns>Returns all defined names</returns>
  2523. </member>
  2524. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.RemoveName(NPOI.SS.UserModel.IName)">
  2525. <summary>
  2526. Remove the given defined name
  2527. </summary>
  2528. <param name="name">the name to remove</param>
  2529. </member>
  2530. <member name="P:NPOI.XSSF.Streaming.SXSSFWorkbook.SpreadsheetVersion">
  2531. <summary>
  2532. Returns the spreadsheet version (EXCLE2007) of this workbook
  2533. </summary>
  2534. </member>
  2535. <member name="M:NPOI.XSSF.Streaming.SXSSFWorkbook.IsDate1904">
  2536. <summary>
  2537. Gets a bool value that indicates whether the date systems used in the workbook starts in 1904.
  2538. The default value is false, meaning that the workbook uses the 1900 date system,
  2539. where 1/1/1900 is the first day in the system.
  2540. </summary>
  2541. <returns>True if the date systems used in the workbook starts in 1904</returns>
  2542. </member>
  2543. <member name="T:NPOI.XSSF.UserModel.BaseXSSFEvaluationWorkbook">
  2544. Internal POI use only - parent of XSSF and SXSSF Evaluation workbooks
  2545. </member>
  2546. <member name="M:NPOI.XSSF.UserModel.BaseXSSFEvaluationWorkbook.ConvertFromExternSheetIndex(System.Int32)">
  2547. XSSF doesn't use external sheet indexes, so when asked treat
  2548. it just as a local index
  2549. </member>
  2550. <member name="M:NPOI.XSSF.UserModel.BaseXSSFEvaluationWorkbook.ConvertToExternalSheetIndex(System.Int32)">
  2551. @return the external sheet index of the sheet with the given internal
  2552. index. Used by some of the more obscure formula and named range things.
  2553. Fairly easy on XSSF (we think...) since the internal and external
  2554. indices are the same
  2555. </member>
  2556. <member name="M:NPOI.XSSF.UserModel.BaseXSSFEvaluationWorkbook.GetName(System.String,System.Int32)">
  2557. <summary>
  2558. Return EvaluationName wrapper around the matching XSSFName (named range)
  2559. </summary>
  2560. <param name="name">case-aware but case-insensitive named range in workbook</param>
  2561. <param name="sheetIndex">index of sheet if named range scope is limited to one sheet
  2562. if named range scope is global to the workbook, sheetIndex is -1.</param>
  2563. <returns>If name is a named range in the workbook, returns
  2564. EvaluationName corresponding to that named range
  2565. Returns null if there is no named range with the same name and scope in the workbook
  2566. </returns>
  2567. </member>
  2568. <member name="M:NPOI.XSSF.UserModel.BaseXSSFEvaluationWorkbook.GetNameXPtg(System.String,NPOI.SS.Formula.SheetIdentifier)">
  2569. <summary>
  2570. Return an external name (named range, function, user-defined function) Pxg
  2571. </summary>
  2572. <param name="name"></param>
  2573. <param name="sheet"></param>
  2574. <returns></returns>
  2575. </member>
  2576. <member name="M:NPOI.XSSF.UserModel.BaseXSSFEvaluationWorkbook.GetTable(System.String)">
  2577. Returns the data table with the given name (case insensitive).
  2578. Tables are cached for performance (formula evaluation looks them up by name repeatedly).
  2579. After the first table lookup, adding or removing a table from the document structure will cause trouble.
  2580. This is meant to be used on documents whose structure is essentially static at the point formulas are evaluated.
  2581. @param name the data table name (case-insensitive)
  2582. @return The Data table in the workbook named <tt>name</tt>, or <tt>null</tt> if no table is named <tt>name</tt>.
  2583. @since 3.15 beta 2
  2584. </member>
  2585. <member name="T:NPOI.XSSF.UserModel.BaseXSSFFormulaEvaluator">
  2586. Internal POI use only - parent of XSSF and SXSSF formula Evaluators
  2587. </member>
  2588. <member name="M:NPOI.XSSF.UserModel.BaseXSSFFormulaEvaluator.ToEvaluationCell(NPOI.SS.UserModel.ICell)">
  2589. Turns a XSSFCell / SXSSFCell into a XSSFEvaluationCell
  2590. </member>
  2591. <member name="M:NPOI.XSSF.UserModel.BaseXSSFFormulaEvaluator.EvaluateFormulaCellValue(NPOI.SS.UserModel.ICell)">
  2592. Returns a CellValue wrapper around the supplied ValueEval instance.
  2593. </member>
  2594. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFBarChartData`2">
  2595. <summary>
  2596. Holds data for a XSSF Line Chart
  2597. </summary>
  2598. <typeparam name="Tx"></typeparam>
  2599. <typeparam name="Ty"></typeparam>
  2600. </member>
  2601. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFBarChartData`2.series">
  2602. List of all data series.
  2603. </member>
  2604. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFChartAxis">
  2605. Base class for all axis types.
  2606. @author Roman Kashitsyn
  2607. </member>
  2608. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFChartDataFactory">
  2609. @author Roman Kashitsyn
  2610. </member>
  2611. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartDataFactory.CreateScatterChartData``2">
  2612. @return new scatter chart data instance
  2613. </member>
  2614. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartDataFactory.GetInstance">
  2615. @return factory instance
  2616. </member>
  2617. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFChartLegend">
  2618. Represents a SpreadsheetML chart legend
  2619. @author Roman Kashitsyn
  2620. </member>
  2621. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFChartLegend.legend">
  2622. Underlaying CTLagend bean
  2623. </member>
  2624. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartLegend.#ctor(NPOI.XSSF.UserModel.XSSFChart)">
  2625. Create a new SpreadsheetML chart legend
  2626. </member>
  2627. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartLegend.SetDefaults">
  2628. Set sensible default styling.
  2629. </member>
  2630. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartLegend.GetCTLegend">
  2631. Return the underlying CTLegend bean.
  2632. @return the underlying CTLegend bean
  2633. </member>
  2634. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFChartUtil">
  2635. Package private class with utility methods.
  2636. @author Roman Kashitsyn
  2637. </member>
  2638. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartUtil.BuildAxDataSource``1(NPOI.OpenXmlFormats.Dml.Chart.CT_AxDataSource,NPOI.SS.UserModel.Charts.IChartDataSource{``0})">
  2639. Builds CTAxDataSource object content from POI ChartDataSource.
  2640. @param ctAxDataSource OOXML data source to build
  2641. @param dataSource POI data source to use
  2642. </member>
  2643. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFChartUtil.BuildNumDataSource``1(NPOI.OpenXmlFormats.Dml.Chart.CT_NumDataSource,NPOI.SS.UserModel.Charts.IChartDataSource{``0})">
  2644. Builds CTNumDataSource object content from POI ChartDataSource
  2645. @param ctNumDataSource OOXML data source to build
  2646. @param dataSource POI data source to use
  2647. </member>
  2648. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFLineChartData`2">
  2649. <summary>
  2650. Holds data for a XSSF Line Chart
  2651. </summary>
  2652. <typeparam name="Tx"></typeparam>
  2653. <typeparam name="Ty"></typeparam>
  2654. </member>
  2655. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFLineChartData`2.series">
  2656. List of all data series.
  2657. </member>
  2658. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFManualLayout">
  2659. Represents a SpreadsheetML manual layout.
  2660. @author Roman Kashitsyn
  2661. </member>
  2662. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFManualLayout.layout">
  2663. Underlaying CTManualLayout bean.
  2664. </member>
  2665. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFManualLayout.#ctor(NPOI.OpenXmlFormats.Dml.Chart.CT_Layout)">
  2666. Create a new SpreadsheetML manual layout.
  2667. @param layout a Spreadsheet ML layout that should be used as base.
  2668. </member>
  2669. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFManualLayout.#ctor(NPOI.XSSF.UserModel.XSSFChart)">
  2670. Create a new SpreadsheetML manual layout for chart.
  2671. @param chart a chart to create layout for.
  2672. </member>
  2673. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFManualLayout.GetCTManualLayout">
  2674. Return the underlying CTManualLayout bean.
  2675. @return the underlying CTManualLayout bean.
  2676. </member>
  2677. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2">
  2678. Represents DrawingML scatter chart.
  2679. @author Roman Kashitsyn
  2680. </member>
  2681. <member name="F:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.series">
  2682. List of all data series.
  2683. </member>
  2684. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.Series">
  2685. Package private ScatterChartSerie implementation.
  2686. </member>
  2687. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.Series.GetXValues">
  2688. Returns data source used for X axis values.
  2689. @return data source used for X axis values
  2690. </member>
  2691. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.Series.GetYValues">
  2692. Returns data source used for Y axis values.
  2693. @return data source used for Y axis values
  2694. </member>
  2695. <member name="M:NPOI.XSSF.UserModel.Charts.XSSFScatterChartData`2.Series.SetUseCache(System.Boolean)">
  2696. @param useCache if true, cached results will be Added on plot
  2697. </member>
  2698. <member name="T:NPOI.XSSF.UserModel.Charts.XSSFValueAxis">
  2699. Value axis type.
  2700. @author Roman Kashitsyn
  2701. </member>
  2702. <member name="T:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment">
  2703. Cell Settings avaiable in the Format/Alignment tab
  2704. </member>
  2705. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_CellAlignment)">
  2706. Creates a Cell Alignment from the supplied XML defInition
  2707. @param cellAlignment
  2708. </member>
  2709. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.Vertical">
  2710. Get the type of vertical alignment for the cell
  2711. @return the type of aligment
  2712. @see VerticalAlignment
  2713. </member>
  2714. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.Horizontal">
  2715. Get the type of horizontal alignment for the cell
  2716. @return the type of aligment
  2717. @see HorizontalAlignment
  2718. </member>
  2719. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.Indent">
  2720. Get the number of spaces to indent the text in the cell
  2721. @return indent - number of spaces
  2722. </member>
  2723. <!-- Badly formed XML comment ignored for member "P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.TextRotation" -->
  2724. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.WrapText">
  2725. Whether the text should be wrapped
  2726. @return a bool value indicating if the text in a cell should be line-wrapped within the cell.
  2727. </member>
  2728. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellAlignment.GetCTCellAlignment">
  2729. Access to low-level data
  2730. </member>
  2731. <member name="T:NPOI.XSSF.UserModel.Extensions.BorderSide">
  2732. The enumeration value indicating the side being used for a cell border.
  2733. </member>
  2734. <member name="T:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder">
  2735. This element Contains border formatting information, specifying border defInition formats (left, right, top, bottom, diagonal)
  2736. for cells in the workbook.
  2737. Color is optional.
  2738. </member>
  2739. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Border,NPOI.XSSF.Model.ThemesTable)">
  2740. Creates a Cell Border from the supplied XML defInition
  2741. </member>
  2742. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Border)">
  2743. Creates a Cell Border from the supplied XML defInition
  2744. </member>
  2745. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.#ctor">
  2746. Creates a new, empty Cell Border.
  2747. You need to attach this to the Styles Table
  2748. </member>
  2749. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.SetThemesTable(NPOI.XSSF.Model.ThemesTable)">
  2750. Records the Themes Table that is associated with
  2751. the current font, used when looking up theme
  2752. based colours and properties.
  2753. </member>
  2754. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.GetCTBorder">
  2755. Returns the underlying XML bean.
  2756. @return CT_Border
  2757. </member>
  2758. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.GetBorderStyle(NPOI.XSSF.UserModel.Extensions.BorderSide)">
  2759. Get the type of border to use for the selected border
  2760. @param side - - where to apply the color defInition
  2761. @return borderstyle - the type of border to use. default value is NONE if border style is not Set.
  2762. @see BorderStyle
  2763. </member>
  2764. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.SetBorderStyle(NPOI.XSSF.UserModel.Extensions.BorderSide,NPOI.SS.UserModel.BorderStyle)">
  2765. Set the type of border to use for the selected border
  2766. @param side - - where to apply the color defInition
  2767. @param style - border style
  2768. @see BorderStyle
  2769. </member>
  2770. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.GetBorderColor(NPOI.XSSF.UserModel.Extensions.BorderSide)">
  2771. Get the color to use for the selected border
  2772. @param side - where to apply the color defInition
  2773. @return color - color to use as XSSFColor. null if color is not set
  2774. </member>
  2775. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellBorder.SetBorderColor(NPOI.XSSF.UserModel.Extensions.BorderSide,NPOI.XSSF.UserModel.XSSFColor)">
  2776. Set the color to use for the selected border
  2777. @param side - where to apply the color defInition
  2778. @param color - the color to use
  2779. </member>
  2780. <member name="T:NPOI.XSSF.UserModel.Extensions.XSSFCellFill">
  2781. This element specifies fill formatting.
  2782. A cell fill consists of a background color, foreground color, and pattern to be applied across the cell.
  2783. </member>
  2784. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Fill)">
  2785. Creates a CellFill from the supplied parts
  2786. @param fill - fill
  2787. </member>
  2788. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.#ctor">
  2789. Creates an empty CellFill
  2790. </member>
  2791. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.GetFillBackgroundColor">
  2792. Get the background fill color.
  2793. @return fill color, null if color is not set
  2794. </member>
  2795. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetFillBackgroundColor(System.Int32)">
  2796. Set the background fill color represented as a indexed color value.
  2797. @param index
  2798. </member>
  2799. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetFillBackgroundColor(NPOI.XSSF.UserModel.XSSFColor)">
  2800. Set the background fill color represented as a {@link XSSFColor} value.
  2801. @param color
  2802. </member>
  2803. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.GetFillForegroundColor">
  2804. Get the foreground fill color.
  2805. @return XSSFColor - foreground color. null if color is not set
  2806. </member>
  2807. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetFillForegroundColor(System.Int32)">
  2808. Set the foreground fill color as a indexed color value
  2809. @param index - the color to use
  2810. </member>
  2811. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetFillForegroundColor(NPOI.XSSF.UserModel.XSSFColor)">
  2812. Set the foreground fill color represented as a {@link XSSFColor} value.
  2813. @param color - the color to use
  2814. </member>
  2815. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.GetPatternType">
  2816. get the fill pattern
  2817. @return fill pattern type. null if fill pattern is not set
  2818. </member>
  2819. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.SetPatternType(NPOI.OpenXmlFormats.Spreadsheet.ST_PatternType)">
  2820. set the fill pattern
  2821. @param patternType fill pattern to use
  2822. </member>
  2823. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFCellFill.GetCTFill">
  2824. Returns the underlying XML bean.
  2825. @return CT_Fill
  2826. </member>
  2827. <member name="T:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter">
  2828. <summary>
  2829. Parent class of all XSSF headers and footers.
  2830. </summary>
  2831. </member>
  2832. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  2833. Create an instance of XSSFHeaderFooter from the supplied XML bean
  2834. @param headerFooter
  2835. </member>
  2836. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.GetHeaderFooter">
  2837. Returns the underlying CTHeaderFooter xml bean
  2838. @return the underlying CTHeaderFooter xml bean
  2839. </member>
  2840. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.AreFieldsStripped">
  2841. Are fields currently being stripped from the text that this
  2842. {@link XSSFHeaderFooter} returns? Default is false, but can be Changed
  2843. </member>
  2844. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.SetAreFieldsStripped(System.Boolean)">
  2845. Should fields (eg macros) be stripped from the text that this class
  2846. returns? Default is not to strip.
  2847. @param StripFields
  2848. </member>
  2849. <member name="M:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.StripFields(System.String)">
  2850. Removes any fields (eg macros, page markers etc) from the string.
  2851. Normally used to make some text suitable for showing to humans, and the
  2852. resultant text should not normally be saved back into the document!
  2853. </member>
  2854. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.Center">
  2855. get the text representing the center part of this element
  2856. </member>
  2857. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.Left">
  2858. get the text representing the left part of this element
  2859. </member>
  2860. <member name="P:NPOI.XSSF.UserModel.Extensions.XSSFHeaderFooter.Right">
  2861. get the text representing the right part of this element
  2862. </member>
  2863. <member name="T:NPOI.XSSF.UserModel.Helpers.ColumnHelper">
  2864. Helper class for dealing with the Column Settings on
  2865. a CT_Worksheet (the data part of a sheet).
  2866. Note - within POI, we use 0 based column indexes, but
  2867. the column defInitions in the XML are 1 based!
  2868. </member>
  2869. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.GetColumn(System.Int64,System.Boolean)">
  2870. Returns the Column at the given 0 based index
  2871. </member>
  2872. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.GetColumn1Based(System.Int64,System.Boolean)">
  2873. Returns the Column at the given 1 based index.
  2874. POI default is 0 based, but the file stores
  2875. as 1 based.
  2876. </member>
  2877. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.TreeSet`1.TailSet(`0,System.Boolean)">
  2878. <summary>
  2879. Returns a view of the portion of this map whose keys are greater than (or
  2880. equal to, if inclusive is true) fromKey.
  2881. </summary>
  2882. <param name="fromElement"></param>
  2883. <param name="inclusive"></param>
  2884. <returns></returns>
  2885. </member>
  2886. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.SweepCleanColumns(NPOI.OpenXmlFormats.Spreadsheet.CT_Cols,NPOI.OpenXmlFormats.Spreadsheet.CT_Col[],NPOI.OpenXmlFormats.Spreadsheet.CT_Col)">
  2887. @see <a href="http://en.wikipedia.org/wiki/Sweep_line_algorithm">Sweep line algorithm</a>
  2888. </member>
  2889. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.ColumnExists(NPOI.OpenXmlFormats.Spreadsheet.CT_Cols,System.Int64)">
  2890. Does the column at the given 0 based index exist
  2891. in the supplied list of column defInitions?
  2892. </member>
  2893. <member name="M:NPOI.XSSF.UserModel.Helpers.ColumnHelper.GetOrCreateColumn1Based(System.Int64,System.Boolean)">
  2894. Return the CT_Col at the given (0 based) column index,
  2895. creating it if required.
  2896. </member>
  2897. <member name="M:NPOI.XSSF.UserModel.Helpers.HeaderFooterHelper.GetParts(System.String)">
  2898. Split into left, center, right
  2899. </member>
  2900. <member name="T:NPOI.XSSF.UserModel.Helpers.XSSFFormulaUtils">
  2901. Utility to update formulas and named ranges when a sheet name was Changed
  2902. @author Yegor Kozlov
  2903. </member>
  2904. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFFormulaUtils.UpdateSheetName(System.Int32,System.String,System.String)">
  2905. Update sheet name in all formulas and named ranges.
  2906. Called from {@link XSSFWorkbook#setSheetName(int, String)}
  2907. <p/>
  2908. <p>
  2909. The idea is to parse every formula and render it back to string
  2910. with the updated sheet name. This is done by parsing into Ptgs,
  2911. looking for ones with sheet references in them, and changing those
  2912. </p>
  2913. @param sheetIndex the 0-based index of the sheet being changed
  2914. @param oldName the old sheet name
  2915. @param newName the new sheet name
  2916. </member>
  2917. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFFormulaUtils.UpdateFormula(NPOI.XSSF.UserModel.XSSFCell,System.String,System.String)">
  2918. Parse cell formula and re-assemble it back using the specified FormulaRenderingWorkbook.
  2919. @param cell the cell to update
  2920. @param frwb the formula rendering workbbok that returns new sheet name
  2921. </member>
  2922. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFFormulaUtils.UpdateName(NPOI.SS.UserModel.IName,System.String,System.String)">
  2923. Parse formula in the named range and re-assemble it back using the specified FormulaRenderingWorkbook.
  2924. @param name the name to update
  2925. @param frwb the formula rendering workbbok that returns new sheet name
  2926. </member>
  2927. <member name="T:NPOI.XSSF.UserModel.Helpers.XSSFIgnoredErrorHelper">
  2928. XSSF-specific code for working with ignored errors
  2929. </member>
  2930. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFPasswordHelper.SetPassword(System.Xml.XmlNode,System.String,NPOI.POIFS.Crypt.HashAlgorithm,System.String)">
  2931. Sets the XORed or hashed password
  2932. @param xobj the xmlbeans object which Contains the password attributes
  2933. @param password the password, if null, the password attributes will be Removed
  2934. @param hashAlgo the hash algorithm, if null the password will be XORed
  2935. @param prefix the prefix of the password attributes, may be null
  2936. </member>
  2937. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFPasswordHelper.ValidatePassword(System.Xml.XmlNode,System.String,System.String)">
  2938. Validates the password, i.e.
  2939. calculates the hash of the given password and Compares it against the stored hash
  2940. @param xobj the xmlbeans object which Contains the password attributes
  2941. @param password the password, if null the method will always return false,
  2942. even if there's no password Set
  2943. @param prefix the prefix of the password attributes, may be null
  2944. @return true, if the hashes match
  2945. </member>
  2946. <member name="T:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter">
  2947. @author Yegor Kozlov
  2948. </member>
  2949. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.ShiftMerged(System.Int32,System.Int32,System.Int32)">
  2950. Shift merged regions
  2951. @param startRow the row to start Shifting
  2952. @param endRow the row to end Shifting
  2953. @param n the number of rows to shift
  2954. @return an array of affected cell regions
  2955. </member>
  2956. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.UpdateNamedRanges(NPOI.SS.Formula.FormulaShifter)">
  2957. Updated named ranges
  2958. </member>
  2959. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.UpdateFormulas(NPOI.SS.Formula.FormulaShifter)">
  2960. Update formulas.
  2961. </member>
  2962. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.UpdateRowFormulas(NPOI.SS.UserModel.IRow,NPOI.SS.Formula.FormulaShifter)">
  2963. <summary>
  2964. Update the formulas in specified row using the formula shifting policy specified by shifter
  2965. </summary>
  2966. <param name="row">the row to update the formulas on</param>
  2967. <param name="Shifter">the formula shifting policy</param>
  2968. </member>
  2969. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.ShiftFormula(NPOI.SS.UserModel.IRow,System.String,NPOI.SS.Formula.FormulaShifter)">
  2970. Shift a formula using the supplied FormulaShifter
  2971. @param row the row of the cell this formula belongs to. Used to get a reference to the parent workbook.
  2972. @param formula the formula to shift
  2973. @param Shifter the FormulaShifter object that operates on the Parsed formula tokens
  2974. @return the Shifted formula if the formula was Changed,
  2975. <code>null</code> if the formula wasn't modified
  2976. </member>
  2977. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFRowShifter.UpdateHyperlinks(NPOI.SS.Formula.FormulaShifter)">
  2978. Shift the Hyperlink anchors (not the hyperlink text, even if the hyperlink
  2979. is of type LINK_DOCUMENT and refers to a cell that was shifted). Hyperlinks
  2980. do not track the content they point to.
  2981. @param shifter
  2982. </member>
  2983. <member name="T:NPOI.XSSF.UserModel.Helpers.XSSFSingleXmlCell">
  2984. *
  2985. * This class is a wrapper around the CTSingleXmlCell (Open Office XML Part 4:
  2986. * chapter 3.5.2.1)
  2987. *
  2988. *
  2989. * @author Roberto Manicardi
  2990. *
  2991. </member>
  2992. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFSingleXmlCell.GetReferencedCell">
  2993. Gets the XSSFCell referenced by the R attribute or Creates a new one if cell doesn't exists
  2994. @return the referenced XSSFCell, null if the cell reference is invalid
  2995. </member>
  2996. <member name="T:NPOI.XSSF.UserModel.Helpers.XSSFXmlColumnPr">
  2997. This class is a wrapper around the CT_XmlColumnPr (Open Office XML Part 4:
  2998. chapter 3.5.1.7)
  2999. @author Roberto Manicardi
  3000. </member>
  3001. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFXmlColumnPr.GetId">
  3002. (see Open Office XML Part 4: chapter 3.5.1.3)
  3003. @return An integer representing the unique identifier of this column.
  3004. </member>
  3005. <member name="M:NPOI.XSSF.UserModel.Helpers.XSSFXmlColumnPr.GetLocalXPath">
  3006. If the XPath is, for example, /Node1/Node2/Node3 and /Node1/Node2 is the common XPath for the table, the local XPath is /Node3
  3007. @return the local XPath
  3008. </member>
  3009. <member name="T:NPOI.XSSF.UserModel.ListAutoNumber">
  3010. Specifies type of automatic numbered bullet points that should be applied to a paragraph.
  3011. </member>
  3012. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ALPHA_LC_PARENT_BOTH">
  3013. (a), (b), (c), ...
  3014. </member>
  3015. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ALPHA_UC_PARENT_BOTH">
  3016. (A), (B), (C), ...
  3017. </member>
  3018. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ALPHA_LC_PARENT_R">
  3019. a), b), c), ...
  3020. </member>
  3021. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ALPHA_UC_PARENT_R">
  3022. A), B), C), ...
  3023. </member>
  3024. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ALPHA_LC_PERIOD">
  3025. a., b., c., ...
  3026. </member>
  3027. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ALPHA_UC_PERIOD">
  3028. A., B., C., ...
  3029. </member>
  3030. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ARABIC_PARENT_BOTH">
  3031. (1), (2), (3), ...
  3032. </member>
  3033. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ARABIC_PARENT_R">
  3034. 1), 2), 3), ...
  3035. </member>
  3036. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ARABIC_PERIOD">
  3037. 1., 2., 3., ...
  3038. </member>
  3039. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ARABIC_PLAIN">
  3040. 1, 2, 3, ...
  3041. </member>
  3042. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ROMAN_LC_PARENT_BOTH">
  3043. (i), (ii), (iii), ...
  3044. </member>
  3045. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ROMAN_UC_PARENT_BOTH">
  3046. (I), (II), (III), ...
  3047. </member>
  3048. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ROMAN_LC_PARENT_R">
  3049. i), ii), iii), ...
  3050. </member>
  3051. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ROMAN_UC_PARENT_R">
  3052. I), II), III), ...
  3053. </member>
  3054. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ROMAN_LC_PERIOD">
  3055. i., ii., iii., ...
  3056. </member>
  3057. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.ROMAN_UC_PERIOD">
  3058. I., II., III., ...
  3059. </member>
  3060. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.CIRCLE_NUM_DB_PLAIN">
  3061. Dbl-byte circle numbers
  3062. </member>
  3063. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.CIRCLE_NUM_WD_BLACK_PLAIN">
  3064. Wingdings black circle numbers
  3065. </member>
  3066. <member name="F:NPOI.XSSF.UserModel.ListAutoNumber.CIRCLE_NUM_WD_WHITE_PLAIN">
  3067. Wingdings white circle numbers
  3068. </member>
  3069. <member name="T:NPOI.XSSF.UserModel.TextAlign">
  3070. Specified a list of text alignment types
  3071. </member>
  3072. <member name="F:NPOI.XSSF.UserModel.TextAlign.LEFT">
  3073. Align text to the left margin.
  3074. </member>
  3075. <member name="F:NPOI.XSSF.UserModel.TextAlign.CENTER">
  3076. Align text in the center.
  3077. </member>
  3078. <member name="F:NPOI.XSSF.UserModel.TextAlign.RIGHT">
  3079. Align text to the right margin.
  3080. </member>
  3081. <member name="F:NPOI.XSSF.UserModel.TextAlign.JUSTIFY">
  3082. Align text so that it is justified across the whole line. It
  3083. is smart in the sense that it will not justify sentences
  3084. which are short
  3085. </member>
  3086. <member name="T:NPOI.XSSF.UserModel.TextAutofit">
  3087. Specifies a list of auto-fit types.
  3088. <p>
  3089. Autofit specifies that a shape should be auto-fit to fully contain the text described within it.
  3090. Auto-fitting is when text within a shape is scaled in order to contain all the text inside
  3091. </p>
  3092. </member>
  3093. <member name="F:NPOI.XSSF.UserModel.TextAutofit.NONE">
  3094. Specifies that text within the text body should not be auto-fit to the bounding box.
  3095. Auto-fitting is when text within a text box is scaled in order to remain inside
  3096. the text box.
  3097. </member>
  3098. <member name="F:NPOI.XSSF.UserModel.TextAutofit.NORMAL">
  3099. Specifies that text within the text body should be normally auto-fit to the bounding box.
  3100. Autofitting is when text within a text box is scaled in order to remain inside the text box.
  3101. <p>
  3102. <em>Example:</em> Consider the situation where a user is building a diagram and needs
  3103. to have the text for each shape that they are using stay within the bounds of the shape.
  3104. An easy way this might be done is by using NORMAL autofit
  3105. </p>
  3106. </member>
  3107. <member name="F:NPOI.XSSF.UserModel.TextAutofit.SHAPE">
  3108. Specifies that a shape should be auto-fit to fully contain the text described within it.
  3109. Auto-fitting is when text within a shape is scaled in order to contain all the text inside.
  3110. <p>
  3111. <em>Example:</em> Consider the situation where a user is building a diagram and needs to have
  3112. the text for each shape that they are using stay within the bounds of the shape.
  3113. An easy way this might be done is by using SHAPE autofit
  3114. </p>
  3115. </member>
  3116. <member name="T:NPOI.XSSF.UserModel.TextCap">
  3117. Text Capitalization that is to be applied to the text Run. This is a render-only
  3118. modification and does not affect the actual characters stored in the text Run.
  3119. </member>
  3120. <member name="T:NPOI.XSSF.UserModel.TextDirection">
  3121. Vertical Text Types
  3122. </member>
  3123. <member name="F:NPOI.XSSF.UserModel.TextDirection.HORIZONTAL">
  3124. Horizontal text. This should be default.
  3125. </member>
  3126. <member name="F:NPOI.XSSF.UserModel.TextDirection.VERTICAL">
  3127. Vertical orientation.
  3128. (each line is 90 degrees rotated clockwise, so it goes
  3129. from top to bottom; each next line is to the left from
  3130. the previous one).
  3131. </member>
  3132. <member name="F:NPOI.XSSF.UserModel.TextDirection.VERTICAL_270">
  3133. Vertical orientation.
  3134. (each line is 270 degrees rotated clockwise, so it goes
  3135. from bottom to top; each next line is to the right from
  3136. the previous one).
  3137. </member>
  3138. <member name="F:NPOI.XSSF.UserModel.TextDirection.STACKED">
  3139. Determines if all of the text is vertical
  3140. ("one letter on top of another").
  3141. </member>
  3142. <member name="T:NPOI.XSSF.UserModel.TextFontAlign">
  3143. Specified a list of text font alignment types
  3144. </member>
  3145. <member name="F:NPOI.XSSF.UserModel.TextFontAlign.AUTO">
  3146. Automatic alignment
  3147. </member>
  3148. <member name="F:NPOI.XSSF.UserModel.TextFontAlign.TOP">
  3149. Align text to the top.
  3150. </member>
  3151. <member name="F:NPOI.XSSF.UserModel.TextFontAlign.CENTER">
  3152. Align text in the center.
  3153. </member>
  3154. <member name="F:NPOI.XSSF.UserModel.TextFontAlign.BASELINE">
  3155. Align text to the baseline.
  3156. </member>
  3157. <member name="F:NPOI.XSSF.UserModel.TextFontAlign.BOTTOM">
  3158. Align text to the bottom.
  3159. </member>
  3160. <member name="T:NPOI.XSSF.UserModel.TextHorizontalOverflow">
  3161. Text Horizontal Overflow
  3162. </member>
  3163. <member name="F:NPOI.XSSF.UserModel.TextHorizontalOverflow.OVERFLOW">
  3164. When a big character does not fit into a line, allow a
  3165. horizontal overflow.
  3166. </member>
  3167. <member name="F:NPOI.XSSF.UserModel.TextHorizontalOverflow.CLIP">
  3168. When a big character does not fit into a line, clip it at
  3169. the proper horizontal overflow.
  3170. </member>
  3171. <member name="T:NPOI.XSSF.UserModel.TextVerticalOverflow">
  3172. Text Vertical Overflow
  3173. </member>
  3174. <member name="F:NPOI.XSSF.UserModel.TextVerticalOverflow.OVERFLOW">
  3175. Overflow the text and pay no attention to top and bottom barriers.
  3176. </member>
  3177. <member name="F:NPOI.XSSF.UserModel.TextVerticalOverflow.ELLIPSIS">
  3178. Pay attention to top and bottom barriers. Use an
  3179. ellipsis to denote that there is text which is not visible.
  3180. </member>
  3181. <member name="F:NPOI.XSSF.UserModel.TextVerticalOverflow.CLIP">
  3182. Pay attention to top and bottom barriers. Provide no
  3183. indication that there is text which is not visible.
  3184. </member>
  3185. <member name="T:NPOI.XSSF.UserModel.XSSFAnchor">
  3186. An anchor is what specifics the position of a shape within a client object
  3187. or within another containing shape.
  3188. @author Yegor Kozlov
  3189. </member>
  3190. <member name="T:NPOI.XSSF.UserModel.XSSFAutoFilter">
  3191. Represents autofiltering for the specified worksheet.
  3192. @author Yegor Kozlov
  3193. </member>
  3194. <member name="T:NPOI.XSSF.UserModel.XSSFBorderFormatting">
  3195. @author Yegor Kozlov
  3196. </member>
  3197. <member name="T:NPOI.XSSF.UserModel.XSSFCell">
  3198. High level representation of a cell in a row of a spreadsheet.
  3199. <p>
  3200. Cells can be numeric, formula-based or string-based (text). The cell type
  3201. specifies this. String cells cannot conatin numbers and numeric cells cannot
  3202. contain strings (at least according to our model). Client apps should do the
  3203. conversions themselves. Formula cells have the formula string, as well as
  3204. the formula result, which can be numeric or string.
  3205. </p>
  3206. <p>
  3207. Cells should have their number (0 based) before being Added to a row. Only
  3208. cells that have values should be Added.
  3209. </p>
  3210. </member>
  3211. <member name="F:NPOI.XSSF.UserModel.XSSFCell._cell">
  3212. the xml bean Containing information about the cell's location, value,
  3213. data type, formatting, and formula
  3214. </member>
  3215. <member name="F:NPOI.XSSF.UserModel.XSSFCell._row">
  3216. the XSSFRow this cell belongs to
  3217. </member>
  3218. <member name="F:NPOI.XSSF.UserModel.XSSFCell._cellNum">
  3219. 0-based column index
  3220. </member>
  3221. <member name="F:NPOI.XSSF.UserModel.XSSFCell._sharedStringSource">
  3222. Table of strings shared across this workbook.
  3223. If two cells contain the same string, then the cell value is the same index into SharedStringsTable
  3224. </member>
  3225. <member name="F:NPOI.XSSF.UserModel.XSSFCell._stylesSource">
  3226. Table of cell styles shared across all cells in a workbook.
  3227. </member>
  3228. <member name="M:NPOI.XSSF.UserModel.XSSFCell.#ctor(NPOI.XSSF.UserModel.XSSFRow,NPOI.OpenXmlFormats.Spreadsheet.CT_Cell)">
  3229. Construct a XSSFCell.
  3230. @param row the parent row.
  3231. @param cell the xml bean Containing information about the cell.
  3232. </member>
  3233. <member name="M:NPOI.XSSF.UserModel.XSSFCell.CopyCellFrom(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.CellCopyPolicy)">
  3234. <summary>
  3235. Copy cell value, formula and style, from srcCell per cell copy policy
  3236. If srcCell is null, clears the cell value and cell style per cell copy policy
  3237. This does not shift references in formulas. Use {@link XSSFRowShifter} to shift references in formulas.
  3238. </summary>
  3239. <param name="srcCell">The cell to take value, formula and style from</param>
  3240. <param name="policy">The policy for copying the information, see {@link CellCopyPolicy}</param>
  3241. <exception cref="T:System.ArgumentException">if copy cell style and srcCell is from a different workbook</exception>
  3242. </member>
  3243. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetSharedStringSource">
  3244. @return table of strings shared across this workbook
  3245. </member>
  3246. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetStylesSource">
  3247. @return table of cell styles shared across this workbook
  3248. </member>
  3249. <member name="P:NPOI.XSSF.UserModel.XSSFCell.Sheet">
  3250. Returns the sheet this cell belongs to
  3251. @return the sheet this cell belongs to
  3252. </member>
  3253. <member name="P:NPOI.XSSF.UserModel.XSSFCell.Row">
  3254. Returns the row this cell belongs to
  3255. @return the row this cell belongs to
  3256. </member>
  3257. <member name="P:NPOI.XSSF.UserModel.XSSFCell.BooleanCellValue">
  3258. Get the value of the cell as a bool.
  3259. <p>
  3260. For strings, numbers, and errors, we throw an exception. For blank cells we return a false.
  3261. </p>
  3262. @return the value of the cell as a bool
  3263. @throws InvalidOperationException if the cell type returned by {@link #CellType}
  3264. is not CellType.Boolean, CellType.Blank or CellType.Formula
  3265. </member>
  3266. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(System.Boolean)">
  3267. Set a bool value for the cell
  3268. @param value the bool value to Set this cell to. For formulas we'll Set the
  3269. precalculated value, for bools we'll Set its value. For other types we
  3270. will change the cell to a bool cell and Set its value.
  3271. </member>
  3272. <member name="P:NPOI.XSSF.UserModel.XSSFCell.NumericCellValue">
  3273. Get the value of the cell as a number.
  3274. <p>
  3275. For strings we throw an exception. For blank cells we return a 0.
  3276. For formulas or error cells we return the precalculated value;
  3277. </p>
  3278. @return the value of the cell as a number
  3279. @throws InvalidOperationException if the cell type returned by {@link #CellType} is CellType.String
  3280. @exception NumberFormatException if the cell value isn't a parsable <code>double</code>.
  3281. @see DataFormatter for turning this number into a string similar to that which Excel would render this number as.
  3282. </member>
  3283. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(System.Double)">
  3284. Set a numeric value for the cell
  3285. @param value the numeric value to Set this cell to. For formulas we'll Set the
  3286. precalculated value, for numerics we'll Set its value. For other types we
  3287. will change the cell to a numeric cell and Set its value.
  3288. </member>
  3289. <member name="P:NPOI.XSSF.UserModel.XSSFCell.StringCellValue">
  3290. Get the value of the cell as a string
  3291. <p>
  3292. For numeric cells we throw an exception. For blank cells we return an empty string.
  3293. For formulaCells that are not string Formulas, we throw an exception
  3294. </p>
  3295. @return the value of the cell as a string
  3296. </member>
  3297. <member name="P:NPOI.XSSF.UserModel.XSSFCell.RichStringCellValue">
  3298. Get the value of the cell as a XSSFRichTextString
  3299. <p>
  3300. For numeric cells we throw an exception. For blank cells we return an empty string.
  3301. For formula cells we return the pre-calculated value if a string, otherwise an exception
  3302. </p>
  3303. @return the value of the cell as a XSSFRichTextString
  3304. </member>
  3305. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(System.String)">
  3306. Set a string value for the cell.
  3307. @param str value to Set the cell to. For formulas we'll Set the formula
  3308. cached string result, for String cells we'll Set its value. For other types we will
  3309. change the cell to a string cell and Set its value.
  3310. If value is null then we will change the cell to a Blank cell.
  3311. </member>
  3312. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(NPOI.SS.UserModel.IRichTextString)">
  3313. Set a string value for the cell.
  3314. @param str value to Set the cell to. For formulas we'll Set the 'pre-Evaluated result string,
  3315. for String cells we'll Set its value. For other types we will
  3316. change the cell to a string cell and Set its value.
  3317. If value is null then we will change the cell to a Blank cell.
  3318. </member>
  3319. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CellFormula">
  3320. <summary>
  3321. Return a formula for the cell, for example, <code>SUM(C4:E4)</code>
  3322. </summary>
  3323. </member>
  3324. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetCellFormula(NPOI.XSSF.UserModel.XSSFEvaluationWorkbook)">
  3325. package/hierarchy use only - reuse an existing evaluation workbook if available for caching
  3326. @param fpb evaluation workbook for reuse, if available, or null to create a new one as needed
  3327. @return a formula for the cell
  3328. @throws InvalidOperationException if the cell type returned by {@link #getCellType()} is not CELL_TYPE_FORMULA
  3329. </member>
  3330. <member name="M:NPOI.XSSF.UserModel.XSSFCell.ConvertSharedFormula(System.Int32,NPOI.XSSF.UserModel.XSSFEvaluationWorkbook)">
  3331. <summary>
  3332. Creates a non shared formula from the shared formula counterpart
  3333. </summary>
  3334. <param name="si">Shared Group Index</param>
  3335. <param name="fpb"></param>
  3336. <returns>non shared formula created for the given shared formula and this cell</returns>
  3337. </member>
  3338. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellFormula(System.String)">
  3339. Sets formula for this cell.
  3340. <p>
  3341. Note, this method only Sets the formula string and does not calculate the formula value.
  3342. To Set the precalculated value use {@link #setCellValue(double)} or {@link #setCellValue(String)}
  3343. </p>
  3344. @param formula the formula to Set, e.g. <code>"SUM(C4:E4)"</code>.
  3345. If the argument is <code>null</code> then the current formula is Removed.
  3346. @throws NPOI.ss.formula.FormulaParseException if the formula has incorrect syntax or is otherwise invalid
  3347. @throws InvalidOperationException if the operation is not allowed, for example,
  3348. when the cell is a part of a multi-cell array formula
  3349. </member>
  3350. <member name="P:NPOI.XSSF.UserModel.XSSFCell.ColumnIndex">
  3351. <summary>
  3352. Returns zero-based column index of this cell
  3353. </summary>
  3354. </member>
  3355. <member name="P:NPOI.XSSF.UserModel.XSSFCell.RowIndex">
  3356. <summary>
  3357. Returns zero-based row index of a row in the sheet that contains this cell
  3358. </summary>
  3359. </member>
  3360. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetReference">
  3361. <summary>
  3362. Returns an A1 style reference to the location of this cell
  3363. </summary>
  3364. <returns>A1 style reference to the location of this cell</returns>
  3365. </member>
  3366. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CellStyle">
  3367. <summary>
  3368. Return the cell's style.
  3369. </summary>
  3370. </member>
  3371. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CellType">
  3372. <summary>
  3373. Return the cell type.
  3374. </summary>
  3375. </member>
  3376. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CachedFormulaResultType">
  3377. <summary>
  3378. Only valid for formula cells
  3379. </summary>
  3380. </member>
  3381. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetBaseCellType(System.Boolean)">
  3382. <summary>
  3383. Detect cell type based on the "t" attribute of the CT_Cell bean
  3384. </summary>
  3385. <param name="blankCells"></param>
  3386. <returns></returns>
  3387. </member>
  3388. <member name="P:NPOI.XSSF.UserModel.XSSFCell.DateCellValue">
  3389. <summary>
  3390. Get the value of the cell as a date.
  3391. </summary>
  3392. </member>
  3393. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellValue(System.DateTime)">
  3394. <summary>
  3395. Set a date value for the cell. Excel treats dates as numeric so you will need to format the cell as a date.
  3396. </summary>
  3397. <param name="value">the date value to Set this cell to. For formulas we'll set the precalculated value,
  3398. for numerics we'll Set its value. For other types we will change the cell to a numeric cell and Set its value. </param>
  3399. </member>
  3400. <member name="P:NPOI.XSSF.UserModel.XSSFCell.ErrorCellString">
  3401. <summary>
  3402. Returns the error message, such as #VALUE!
  3403. </summary>
  3404. </member>
  3405. <member name="P:NPOI.XSSF.UserModel.XSSFCell.ErrorCellValue">
  3406. <summary>
  3407. Get the value of the cell as an error code.
  3408. For strings, numbers, and bools, we throw an exception.
  3409. For blank cells we return a 0.
  3410. </summary>
  3411. </member>
  3412. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellErrorValue(NPOI.SS.UserModel.FormulaError)">
  3413. <summary>
  3414. Set a error value for the cell
  3415. </summary>
  3416. <param name="error">the error value to Set this cell to.
  3417. For formulas we'll Set the precalculated value , for errors we'll set
  3418. its value. For other types we will change the cell to an error cell and Set its value.
  3419. </param>
  3420. </member>
  3421. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetAsActiveCell">
  3422. <summary>
  3423. Sets this cell as the active cell for the worksheet.
  3424. </summary>
  3425. </member>
  3426. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetBlankInternal">
  3427. <summary>
  3428. Blanks this cell. Blank cells have no formula or value but may have styling.
  3429. This method erases all the data previously associated with this cell.
  3430. </summary>
  3431. </member>
  3432. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellNum(System.Int32)">
  3433. <summary>
  3434. Sets column index of this cell
  3435. </summary>
  3436. <param name="num"></param>
  3437. </member>
  3438. <member name="M:NPOI.XSSF.UserModel.XSSFCell.SetCellType(NPOI.SS.UserModel.CellType)">
  3439. <summary>
  3440. Set the cells type (numeric, formula or string)
  3441. </summary>
  3442. <param name="cellType"></param>
  3443. </member>
  3444. <member name="M:NPOI.XSSF.UserModel.XSSFCell.ToString">
  3445. <summary>
  3446. Returns a string representation of the cell
  3447. </summary>
  3448. <returns>Formula cells return the formula string, rather than the formula result.
  3449. Dates are displayed in dd-MMM-yyyy format
  3450. Errors are displayed as #ERR&lt;errIdx&gt;
  3451. </returns>
  3452. </member>
  3453. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetRawValue">
  3454. Returns the raw, underlying ooxml value for the cell
  3455. <p>
  3456. If the cell Contains a string, then this value is an index into
  3457. the shared string table, pointing to the actual string value. Otherwise,
  3458. the value of the cell is expressed directly in this element. Cells Containing formulas express
  3459. the last calculated result of the formula in this element.
  3460. </p>
  3461. @return the raw cell value as Contained in the underlying CT_Cell bean,
  3462. <code>null</code> for blank cells.
  3463. </member>
  3464. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetCellTypeName(NPOI.SS.UserModel.CellType)">
  3465. <summary>
  3466. Used to help format error messages
  3467. </summary>
  3468. <param name="cellTypeCode"></param>
  3469. <returns></returns>
  3470. </member>
  3471. <member name="M:NPOI.XSSF.UserModel.XSSFCell.TypeMismatch(NPOI.SS.UserModel.CellType,NPOI.SS.UserModel.CellType,System.Boolean)">
  3472. Used to help format error messages
  3473. </member>
  3474. <member name="M:NPOI.XSSF.UserModel.XSSFCell.CheckBounds(System.Int32)">
  3475. @throws RuntimeException if the bounds are exceeded.
  3476. </member>
  3477. <member name="P:NPOI.XSSF.UserModel.XSSFCell.CellComment">
  3478. <summary>
  3479. Returns cell comment associated with this cell
  3480. </summary>
  3481. </member>
  3482. <member name="M:NPOI.XSSF.UserModel.XSSFCell.RemoveCellComment">
  3483. <summary>
  3484. Removes the comment for this cell, if there is one.
  3485. </summary>
  3486. </member>
  3487. <member name="P:NPOI.XSSF.UserModel.XSSFCell.Hyperlink">
  3488. <summary>
  3489. Get or set hyperlink associated with this cell
  3490. If the supplied hyperlink is null on setting, the hyperlink for this cell will be removed.
  3491. </summary>
  3492. </member>
  3493. <member name="M:NPOI.XSSF.UserModel.XSSFCell.RemoveHyperlink">
  3494. Removes the hyperlink for this cell, if there is one.
  3495. </member>
  3496. <member name="M:NPOI.XSSF.UserModel.XSSFCell.GetCTCell">
  3497. Returns the xml bean containing information about the cell's location (reference), value,
  3498. data type, formatting, and formula
  3499. @return the xml bean containing information about this cell
  3500. </member>
  3501. <member name="M:NPOI.XSSF.UserModel.XSSFCell.ConvertCellValueToBoolean">
  3502. Chooses a new bool value for the cell when its type is changing.<p/>
  3503. Usually the caller is calling SetCellType() with the intention of calling
  3504. SetCellValue(bool) straight afterwards. This method only exists to give
  3505. the cell a somewhat reasonable value until the SetCellValue() call (if at all).
  3506. TODO - perhaps a method like SetCellTypeAndValue(int, Object) should be introduced to avoid this
  3507. </member>
  3508. <member name="M:NPOI.XSSF.UserModel.XSSFCell.NotifyArrayFormulaChanging(System.String)">
  3509. The purpose of this method is to validate the cell state prior to modification
  3510. @see #NotifyArrayFormulaChanging()
  3511. </member>
  3512. <member name="M:NPOI.XSSF.UserModel.XSSFCell.NotifyArrayFormulaChanging">
  3513. <summary>
  3514. Called when this cell is modified.The purpose of this method is to validate the cell state prior to modification.
  3515. </summary>
  3516. <exception cref="T:System.InvalidOperationException">if modification is not allowed</exception>
  3517. </member>
  3518. <member name="T:NPOI.XSSF.UserModel.XSSFCellStyle">
  3519. High level representation of the the possible formatting information for the contents of the cells on a sheet in a
  3520. SpreadsheetML document.
  3521. @see NPOI.xssf.usermodel.XSSFWorkbook#CreateCellStyle()
  3522. @see NPOI.xssf.usermodel.XSSFWorkbook#getCellStyleAt(short)
  3523. @see NPOI.xssf.usermodel.XSSFCell#setCellStyle(NPOI.ss.usermodel.CellStyle)
  3524. </member>
  3525. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.#ctor(System.Int32,System.Int32,NPOI.XSSF.Model.StylesTable,NPOI.XSSF.Model.ThemesTable)">
  3526. Creates a Cell Style from the supplied parts
  3527. @param cellXfId The main XF for the cell. Must be a valid 0-based index into the XF table
  3528. @param cellStyleXfId Optional, style xf. A value of <code>-1</code> means no xf.
  3529. @param stylesSource Styles Source to work off
  3530. </member>
  3531. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCoreXf">
  3532. Used so that StylesSource can figure out our location
  3533. </member>
  3534. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetStyleXf">
  3535. Used so that StylesSource can figure out our location
  3536. </member>
  3537. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.#ctor(NPOI.XSSF.Model.StylesTable)">
  3538. <summary>
  3539. Creates an empty Cell Style
  3540. </summary>
  3541. <param name="stylesSource"></param>
  3542. </member>
  3543. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.VerifyBelongsToStylesSource(NPOI.XSSF.Model.StylesTable)">
  3544. Verifies that this style belongs to the supplied Workbook
  3545. Styles Source.
  3546. Will throw an exception if it belongs to a different one.
  3547. This is normally called when trying to assign a style to a
  3548. cell, to ensure the cell and the style are from the same
  3549. workbook (if they're not, it won't work)
  3550. @throws ArgumentException if there's a workbook mis-match
  3551. </member>
  3552. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.CloneStyleFrom(NPOI.SS.UserModel.ICellStyle)">
  3553. Clones all the style information from another
  3554. XSSFCellStyle, onto this one. This
  3555. XSSFCellStyle will then have all the same
  3556. properties as the source, but the two may
  3557. be edited independently.
  3558. Any stylings on this XSSFCellStyle will be lost!
  3559. The source XSSFCellStyle could be from another
  3560. XSSFWorkbook if you like. This allows you to
  3561. copy styles from one XSSFWorkbook to another.
  3562. </member>
  3563. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetAlignmentEnum">
  3564. <summary>
  3565. Get the type of horizontal alignment for the cell
  3566. </summary>
  3567. <returns>the type of alignment</returns>
  3568. </member>
  3569. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.BorderBottom">
  3570. <summary>
  3571. Get or set the type of border to use for the bottom border of the cell
  3572. </summary>
  3573. </member>
  3574. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.BorderLeft">
  3575. <summary>
  3576. Get or set the type of border to use for the left border of the cell
  3577. </summary>
  3578. </member>
  3579. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.BorderRight">
  3580. <summary>
  3581. Get or set the type of border to use for the right border of the cell
  3582. </summary>
  3583. </member>
  3584. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.BorderTop">
  3585. <summary>
  3586. Get or set the type of border to use for the top border of the cell
  3587. </summary>
  3588. </member>
  3589. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.BottomBorderColor">
  3590. Get the color to use for the bottom border
  3591. Color is optional. When missing, IndexedColors.Automatic is implied.
  3592. @return the index of the color defInition, default value is {@link NPOI.ss.usermodel.IndexedColors#AUTOMATIC}
  3593. @see NPOI.ss.usermodel.IndexedColors
  3594. </member>
  3595. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.BottomBorderXSSFColor">
  3596. Get the color to use for the bottom border as a {@link XSSFColor}
  3597. @return the used color or <code>null</code> if not Set
  3598. </member>
  3599. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.DataFormat">
  3600. Get the index of the number format (numFmt) record used by this cell format.
  3601. @return the index of the number format
  3602. </member>
  3603. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetDataFormat(System.Int32)">
  3604. Set the index of a data format
  3605. @param fmt the index of a data format
  3606. </member>
  3607. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetDataFormatString">
  3608. Get the contents of the format string, by looking up
  3609. the StylesSource
  3610. @return the number format string
  3611. </member>
  3612. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillBackgroundColor">
  3613. <summary>
  3614. Get the background fill color.
  3615. Note - many cells are actually filled with a foreground fill, not a background fill
  3616. </summary>
  3617. </member>
  3618. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillBackgroundColorColor">
  3619. Get the background fill color.
  3620. <p>
  3621. Note - many cells are actually Filled with a foreground
  3622. Fill, not a background fill - see {@link #getFillForegroundColor()}
  3623. </p>
  3624. @see NPOI.xssf.usermodel.XSSFColor#getRgb()
  3625. @return XSSFColor - fill color or <code>null</code> if not Set
  3626. </member>
  3627. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillForegroundColor">
  3628. Get the foreground fill color.
  3629. <p>
  3630. Many cells are Filled with this, instead of a
  3631. background color ({@link #getFillBackgroundColor()})
  3632. </p>
  3633. @see IndexedColors
  3634. @return fill color, default value is {@link NPOI.ss.usermodel.IndexedColors#AUTOMATIC}
  3635. </member>
  3636. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillForegroundColorColor">
  3637. <summary>
  3638. Get the foreground fill color.
  3639. </summary>
  3640. </member>
  3641. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FillForegroundXSSFColor">
  3642. <summary>
  3643. Get the foreground fill color.
  3644. </summary>
  3645. </member>
  3646. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetFont">
  3647. Gets the font for this style
  3648. @return Font - font
  3649. </member>
  3650. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.FontIndex">
  3651. Gets the index of the font for this style
  3652. @return short - font index
  3653. @see NPOI.xssf.usermodel.XSSFWorkbook#getFontAt(short)
  3654. </member>
  3655. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.IsHidden">
  3656. Get whether the cell's using this style are to be hidden
  3657. @return bool - whether the cell using this style is hidden
  3658. </member>
  3659. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.Indention">
  3660. Get the number of spaces to indent the text in the cell
  3661. @return indent - number of spaces
  3662. </member>
  3663. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.Index">
  3664. Get the index within the StylesTable (sequence within the collection of CT_Xf elements)
  3665. @return unique index number of the underlying record this style represents
  3666. </member>
  3667. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.LeftBorderColor">
  3668. Get the color to use for the left border
  3669. @return the index of the color defInition, default value is {@link NPOI.ss.usermodel.IndexedColors#BLACK}
  3670. @see NPOI.ss.usermodel.IndexedColors
  3671. </member>
  3672. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.LeftBorderXSSFColor">
  3673. Get the color to use for the left border
  3674. @return the index of the color defInition or <code>null</code> if not Set
  3675. @see NPOI.ss.usermodel.IndexedColors
  3676. </member>
  3677. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.IsLocked">
  3678. <summary>
  3679. Get whether the cell's using this style are locked
  3680. </summary>
  3681. </member>
  3682. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.RightBorderColor">
  3683. <summary>
  3684. Get the color to use for the right border
  3685. </summary>
  3686. </member>
  3687. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.RightBorderXSSFColor">
  3688. <summary>
  3689. Get the color to use for the right border
  3690. </summary>
  3691. <returns></returns>
  3692. </member>
  3693. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.Rotation">
  3694. <summary>
  3695. Get the degree of rotation (between 0 and 180 degrees) for the text in the cell
  3696. Note: HSSF uses values from -90 to 90 degrees, whereas XSSF
  3697. uses values from 0 to 180 degrees.The implementations of this method will map between these two value-ranges
  3698. accordingly, however the corresponding getter is returning values in the range mandated by the current type
  3699. of Excel file-format that this CellStyle is applied to.
  3700. </summary>
  3701. <example>
  3702. Expressed in degrees. Values range from 0 to 180. The first letter of
  3703. the text is considered the center-point of the arc.
  3704. For 0 - 90, the value represents degrees above horizon. For 91-180 the degrees below the horizon is calculated as:
  3705. <code>[degrees below horizon] = 90 - textRotation.</code>
  3706. </example>
  3707. </member>
  3708. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.TopBorderColor">
  3709. Get the color to use for the top border
  3710. @return the index of the color defInition, default value is {@link NPOI.ss.usermodel.IndexedColors#BLACK}
  3711. @see NPOI.ss.usermodel.IndexedColors
  3712. </member>
  3713. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.TopBorderXSSFColor">
  3714. <summary>
  3715. Get the color to use for the top border
  3716. </summary>
  3717. <returns></returns>
  3718. </member>
  3719. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.VerticalAlignment">
  3720. <summary>
  3721. Get the type of vertical alignment for the cell
  3722. </summary>
  3723. </member>
  3724. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetVerticalAlignmentEnum">
  3725. <summary>
  3726. Get the type of vertical alignment for the cell
  3727. </summary>
  3728. <returns></returns>
  3729. </member>
  3730. <member name="P:NPOI.XSSF.UserModel.XSSFCellStyle.WrapText">
  3731. <summary>
  3732. Whether the text in a cell should be line-wrapped within the cell.
  3733. </summary>
  3734. </member>
  3735. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetBottomBorderColor(NPOI.XSSF.UserModel.XSSFColor)">
  3736. Set the color to use for the bottom border
  3737. @param color the color to use, null means no color
  3738. </member>
  3739. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFCellStyle.SetFillBackgroundColor(NPOI.XSSF.UserModel.XSSFColor)" -->
  3740. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetFillForegroundColor(NPOI.XSSF.UserModel.XSSFColor)">
  3741. * Set the foreground fill color represented as a {@link XSSFColor} value.
  3742. * <br/>
  3743. * <i>Note: Ensure Foreground color is Set prior to background color.</i>
  3744. * @param color the color to use
  3745. * @see #setFillBackgroundColor(NPOI.xssf.usermodel.XSSFColor) )
  3746. </member>
  3747. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCTFill">
  3748. Get a <b>copy</b> of the currently used CT_Fill, if none is used, return a new instance.
  3749. </member>
  3750. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCTBorder(System.Boolean)">
  3751. Get a <b>copy</b> of the currently used CT_Border, if none is used, return a new instance.
  3752. </member>
  3753. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetFont(NPOI.SS.UserModel.IFont)">
  3754. Set the font for this style
  3755. @param font a font object Created or retrieved from the XSSFWorkbook object
  3756. @see NPOI.xssf.usermodel.XSSFWorkbook#CreateFont()
  3757. @see NPOI.xssf.usermodel.XSSFWorkbook#getFontAt(short)
  3758. </member>
  3759. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetLeftBorderColor(NPOI.XSSF.UserModel.XSSFColor)">
  3760. Set the color to use for the left border as a {@link XSSFColor} value
  3761. @param color the color to use
  3762. </member>
  3763. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetRightBorderColor(NPOI.XSSF.UserModel.XSSFColor)">
  3764. Set the color to use for the right border as a {@link XSSFColor} value
  3765. @param color the color to use
  3766. </member>
  3767. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetTopBorderColor(NPOI.XSSF.UserModel.XSSFColor)">
  3768. Set the color to use for the top border as a {@link XSSFColor} value
  3769. @param color the color to use
  3770. </member>
  3771. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetVerticalAlignment(System.Int16)">
  3772. Set the type of vertical alignment for the cell
  3773. @param align - align the type of alignment
  3774. @see NPOI.ss.usermodel.CellStyle#VERTICAL_TOP
  3775. @see NPOI.ss.usermodel.CellStyle#VERTICAL_CENTER
  3776. @see NPOI.ss.usermodel.CellStyle#VERTICAL_BOTTOM
  3777. @see NPOI.ss.usermodel.CellStyle#VERTICAL_JUSTIFY
  3778. @see NPOI.ss.usermodel.VerticalAlignment
  3779. </member>
  3780. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetBorderColor(NPOI.XSSF.UserModel.Extensions.BorderSide)">
  3781. Gets border color
  3782. @param side the border side
  3783. @return the used color
  3784. </member>
  3785. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.SetBorderColor(NPOI.XSSF.UserModel.Extensions.BorderSide,NPOI.XSSF.UserModel.XSSFColor)">
  3786. Set the color to use for the selected border
  3787. @param side - where to apply the color defInition
  3788. @param color - the color to use
  3789. </member>
  3790. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCellAlignment">
  3791. Get the cellAlignment object to use for manage alignment
  3792. @return XSSFCellAlignment - cell alignment
  3793. </member>
  3794. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetCTCellAlignment">
  3795. Return the CT_CellAlignment instance for alignment
  3796. @return CT_CellAlignment
  3797. </member>
  3798. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.GetHashCode">
  3799. Returns a hash code value for the object. The hash is derived from the underlying CT_Xf bean.
  3800. @return the hash code value for this style
  3801. </member>
  3802. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.Equals(System.Object)">
  3803. Checks is the supplied style is equal to this style
  3804. @param o the style to check
  3805. @return true if the supplied style is equal to this style
  3806. </member>
  3807. <member name="M:NPOI.XSSF.UserModel.XSSFCellStyle.Clone">
  3808. Make a copy of this style. The underlying CT_Xf bean is Cloned,
  3809. the references to Fills and borders remain.
  3810. @return a copy of this style
  3811. </member>
  3812. <member name="T:NPOI.XSSF.UserModel.XSSFChart">
  3813. Represents a SpreadsheetML Chart
  3814. @author Nick Burch
  3815. @author Roman Kashitsyn
  3816. </member>
  3817. <member name="F:NPOI.XSSF.UserModel.XSSFChart.frame">
  3818. Parent graphic frame.
  3819. </member>
  3820. <member name="F:NPOI.XSSF.UserModel.XSSFChart.chartSpaceDocument">
  3821. Root element of the SpreadsheetML Chart part
  3822. </member>
  3823. <member name="F:NPOI.XSSF.UserModel.XSSFChart.chart">
  3824. The Chart within that
  3825. </member>
  3826. <member name="M:NPOI.XSSF.UserModel.XSSFChart.#ctor">
  3827. Create a new SpreadsheetML chart
  3828. </member>
  3829. <member name="M:NPOI.XSSF.UserModel.XSSFChart.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  3830. Construct a SpreadsheetML chart from a namespace part.
  3831. @param part the namespace part holding the chart data,
  3832. the content type must be <code>application/vnd.Openxmlformats-officedocument.Drawingml.chart+xml</code>
  3833. @param rel the namespace relationship holding this chart,
  3834. the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/chart
  3835. </member>
  3836. <member name="M:NPOI.XSSF.UserModel.XSSFChart.CreateChart">
  3837. Construct a new CTChartSpace bean.
  3838. By default, it's just an empty placeholder for chart objects.
  3839. @return a new CTChartSpace bean
  3840. </member>
  3841. <member name="M:NPOI.XSSF.UserModel.XSSFChart.GetCTChartSpace">
  3842. <summary>
  3843. Return the underlying CTChartSpace bean, the root element of the SpreadsheetML Chart part.
  3844. </summary>
  3845. <returns></returns>
  3846. </member>
  3847. <member name="M:NPOI.XSSF.UserModel.XSSFChart.GetCTChart">
  3848. <summary>
  3849. Return the underlying CTChart bean, within the Chart Space
  3850. </summary>
  3851. <returns></returns>
  3852. </member>
  3853. <member name="M:NPOI.XSSF.UserModel.XSSFChart.GetGraphicFrame">
  3854. <summary>
  3855. Returns the parent graphic frame.
  3856. </summary>
  3857. <returns></returns>
  3858. </member>
  3859. <member name="M:NPOI.XSSF.UserModel.XSSFChart.SetGraphicFrame(NPOI.XSSF.UserModel.XSSFGraphicFrame)">
  3860. Sets the parent graphic frame.
  3861. </member>
  3862. <member name="M:NPOI.XSSF.UserModel.XSSFChart.IsPlotOnlyVisibleCells">
  3863. @return true if only visible cells will be present on the chart,
  3864. false otherwise
  3865. </member>
  3866. <member name="M:NPOI.XSSF.UserModel.XSSFChart.SetPlotOnlyVisibleCells(System.Boolean)">
  3867. @param plotVisOnly a flag specifying if only visible cells should be
  3868. present on the chart
  3869. </member>
  3870. <member name="P:NPOI.XSSF.UserModel.XSSFChart.Title">
  3871. Returns the title, or null if none is Set
  3872. </member>
  3873. <member name="M:NPOI.XSSF.UserModel.XSSFChart.SetTitle(System.String)">
  3874. Sets the title text.
  3875. </member>
  3876. <member name="T:NPOI.XSSF.UserModel.XSSFChartSheet">
  3877. High level representation of Sheet Parts that are of type 'chartsheet'.
  3878. <p>
  3879. Chart sheet is a special kind of Sheet that Contains only chart and no data.
  3880. </p>
  3881. @author Yegor Kozlov
  3882. </member>
  3883. <member name="M:NPOI.XSSF.UserModel.XSSFChartSheet.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  3884. @since POI 3.14-Beta1
  3885. </member>
  3886. <member name="M:NPOI.XSSF.UserModel.XSSFChartSheet.GetCTChartsheet">
  3887. Provide access to the CTChartsheet bean holding this sheet's data
  3888. @return the CTChartsheet bean holding this sheet's data
  3889. </member>
  3890. <member name="T:NPOI.XSSF.UserModel.XSSFClientAnchor">
  3891. A client anchor is attached to an excel worksheet. It anchors against
  3892. top-left and bottom-right cells.
  3893. @author Yegor Kozlov
  3894. </member>
  3895. <member name="F:NPOI.XSSF.UserModel.XSSFClientAnchor.cell1">
  3896. Starting anchor point
  3897. </member>
  3898. <member name="F:NPOI.XSSF.UserModel.XSSFClientAnchor.cell2">
  3899. Ending anchor point
  3900. </member>
  3901. <member name="M:NPOI.XSSF.UserModel.XSSFClientAnchor.#ctor">
  3902. Creates a new client anchor and defaults all the anchor positions to 0.
  3903. </member>
  3904. <member name="M:NPOI.XSSF.UserModel.XSSFClientAnchor.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  3905. Creates a new client anchor and Sets the top-left and bottom-right
  3906. coordinates of the anchor.
  3907. @param dx1 the x coordinate within the first cell.
  3908. @param dy1 the y coordinate within the first cell.
  3909. @param dx2 the x coordinate within the second cell.
  3910. @param dy2 the y coordinate within the second cell.
  3911. @param col1 the column (0 based) of the first cell.
  3912. @param row1 the row (0 based) of the first cell.
  3913. @param col2 the column (0 based) of the second cell.
  3914. @param row2 the row (0 based) of the second cell.
  3915. </member>
  3916. <member name="M:NPOI.XSSF.UserModel.XSSFClientAnchor.#ctor(NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Marker,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Marker)">
  3917. Create XSSFClientAnchor from existing xml beans
  3918. @param cell1 starting anchor point
  3919. @param cell2 ending anchor point
  3920. </member>
  3921. <member name="P:NPOI.XSSF.UserModel.XSSFClientAnchor.From">
  3922. Return starting anchor point
  3923. @return starting anchor point
  3924. </member>
  3925. <member name="P:NPOI.XSSF.UserModel.XSSFClientAnchor.To">
  3926. Return ending anchor point
  3927. @return ending anchor point
  3928. </member>
  3929. <member name="T:NPOI.XSSF.UserModel.XSSFColor">
  3930. Represents a color in SpreadsheetML
  3931. </member>
  3932. <member name="M:NPOI.XSSF.UserModel.XSSFColor.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Color)">
  3933. Create an instance of XSSFColor from the supplied XML bean
  3934. </member>
  3935. <member name="M:NPOI.XSSF.UserModel.XSSFColor.#ctor">
  3936. Create an new instance of XSSFColor
  3937. </member>
  3938. <member name="P:NPOI.XSSF.UserModel.XSSFColor.IsAuto">
  3939. <summary>
  3940. A bool value indicating the ctColor is automatic and system ctColor dependent.
  3941. </summary>
  3942. </member>
  3943. <member name="P:NPOI.XSSF.UserModel.XSSFColor.HasAlpha">
  3944. A bool value indicating if the ctColor has a alpha or not
  3945. </member>
  3946. <member name="P:NPOI.XSSF.UserModel.XSSFColor.HasTint">
  3947. A bool value indicating if the ctColor has a tint or not
  3948. </member>
  3949. <member name="P:NPOI.XSSF.UserModel.XSSFColor.Indexed">
  3950. Indexed ctColor value. Only used for backwards compatibility. References a ctColor in indexedColors.
  3951. </member>
  3952. <member name="P:NPOI.XSSF.UserModel.XSSFColor.RGB">
  3953. Standard Red Green Blue ctColor value (RGB).
  3954. If there was an A (Alpha) value, it will be stripped.
  3955. </member>
  3956. <member name="P:NPOI.XSSF.UserModel.XSSFColor.ARGB">
  3957. Standard Alpha Red Green Blue ctColor value (ARGB).
  3958. </member>
  3959. <member name="M:NPOI.XSSF.UserModel.XSSFColor.GetARgb">
  3960. Standard Alpha Red Green Blue ctColor value (ARGB).
  3961. </member>
  3962. <member name="M:NPOI.XSSF.UserModel.XSSFColor.GetRgbWithTint">
  3963. Standard Red Green Blue ctColor value (RGB) with applied tint.
  3964. Alpha values are ignored.
  3965. </member>
  3966. <member name="M:NPOI.XSSF.UserModel.XSSFColor.SetRgb(System.Byte[])">
  3967. Standard Alpha Red Green Blue ctColor value (ARGB).
  3968. </member>
  3969. <member name="P:NPOI.XSSF.UserModel.XSSFColor.Theme">
  3970. Index into the clrScheme collection, referencing a particular sysClr or
  3971. srgbClr value expressed in the Theme part.
  3972. </member>
  3973. <member name="P:NPOI.XSSF.UserModel.XSSFColor.Tint">
  3974. Specifies the tint value applied to the ctColor.
  3975. <p>
  3976. If tint is supplied, then it is applied to the RGB value of the ctColor to determine the final
  3977. ctColor applied.
  3978. </p>
  3979. <p>
  3980. The tint value is stored as a double from -1.0 .. 1.0, where -1.0 means 100% darken and
  3981. 1.0 means 100% lighten. Also, 0.0 means no Change.
  3982. </p>
  3983. <p>
  3984. In loading the RGB value, it is Converted to HLS where HLS values are (0..HLSMAX), where
  3985. HLSMAX is currently 255.
  3986. </p>
  3987. Here are some examples of how to apply tint to ctColor:
  3988. <blockquote>
  3989. <pre>
  3990. If (tint &lt; 0)
  3991. Lum' = Lum * (1.0 + tint)
  3992. For example: Lum = 200; tint = -0.5; Darken 50%
  3993. Lum' = 200 * (0.5) =&gt; 100
  3994. For example: Lum = 200; tint = -1.0; Darken 100% (make black)
  3995. Lum' = 200 * (1.0-1.0) =&gt; 0
  3996. If (tint &gt; 0)
  3997. Lum' = Lum * (1.0-tint) + (HLSMAX - HLSMAX * (1.0-tint))
  3998. For example: Lum = 100; tint = 0.75; Lighten 75%
  3999. Lum' = 100 * (1-.75) + (HLSMAX - HLSMAX*(1-.75))
  4000. = 100 * .25 + (255 - 255 * .25)
  4001. = 25 + (255 - 63) = 25 + 192 = 217
  4002. For example: Lum = 100; tint = 1.0; Lighten 100% (make white)
  4003. Lum' = 100 * (1-1) + (HLSMAX - HLSMAX*(1-1))
  4004. = 100 * 0 + (255 - 255 * 0)
  4005. = 0 + (255 - 0) = 255
  4006. </pre>
  4007. </blockquote>
  4008. @return the tint value
  4009. </member>
  4010. <member name="M:NPOI.XSSF.UserModel.XSSFColor.GetCTColor">
  4011. Returns the underlying XML bean
  4012. @return the underlying XML bean
  4013. </member>
  4014. <member name="M:NPOI.XSSF.UserModel.XSSFColor.ToXSSFColor(NPOI.SS.UserModel.IColor)">
  4015. <summary>
  4016. Checked type cast <tt>color</tt> to an XSSFColor.
  4017. </summary>
  4018. <param name="color">the color to type cast</param>
  4019. <returns>the type casted color</returns>
  4020. <exception cref="T:System.ArgumentException">if color is null or is not an instance of XSSFColor</exception>
  4021. </member>
  4022. <member name="T:NPOI.XSSF.UserModel.XSSFColorScaleFormatting">
  4023. High level representation for Color Scale / Color Gradient Formatting
  4024. component of Conditional Formatting Settings
  4025. </member>
  4026. <member name="F:NPOI.XSSF.UserModel.XSSFComment._str">
  4027. cached reference to the string with the comment text
  4028. </member>
  4029. <member name="M:NPOI.XSSF.UserModel.XSSFComment.#ctor(NPOI.XSSF.Model.CommentsTable,NPOI.OpenXmlFormats.Spreadsheet.CT_Comment,NPOI.OpenXmlFormats.Vml.CT_Shape)">
  4030. Creates a new XSSFComment, associated with a given
  4031. low level comment object.
  4032. </member>
  4033. <member name="P:NPOI.XSSF.UserModel.XSSFComment.Author">
  4034. @return Name of the original comment author. Default value is blank.
  4035. </member>
  4036. <member name="P:NPOI.XSSF.UserModel.XSSFComment.Column">
  4037. @return the 0-based column of the cell that the comment is associated with.
  4038. </member>
  4039. <member name="P:NPOI.XSSF.UserModel.XSSFComment.Row">
  4040. @return the 0-based row index of the cell that the comment is associated with.
  4041. </member>
  4042. <member name="P:NPOI.XSSF.UserModel.XSSFComment.Visible">
  4043. @return whether the comment is visible
  4044. </member>
  4045. <member name="P:NPOI.XSSF.UserModel.XSSFComment.String">
  4046. @return the rich text string of the comment
  4047. </member>
  4048. <member name="M:NPOI.XSSF.UserModel.XSSFComment.SetString(System.String)">
  4049. Sets the rich text string used by this comment.
  4050. @param string the XSSFRichTextString used by this object.
  4051. </member>
  4052. <member name="M:NPOI.XSSF.UserModel.XSSFComment.GetCTComment">
  4053. @return the xml bean holding this comment's properties
  4054. </member>
  4055. <member name="T:NPOI.XSSF.UserModel.XSSFConditionalFormatting">
  4056. @author Yegor Kozlov
  4057. </member>
  4058. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormatting.GetFormattingRanges">
  4059. @return array of <tt>CellRangeAddress</tt>s. Never <code>null</code>
  4060. </member>
  4061. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormatting.SetRule(System.Int32,NPOI.SS.UserModel.IConditionalFormattingRule)">
  4062. Replaces an existing Conditional Formatting rule at position idx.
  4063. Excel allows to create up to 3 Conditional Formatting rules.
  4064. This method can be useful to modify existing Conditional Formatting rules.
  4065. @param idx position of the rule. Should be between 0 and 2.
  4066. @param cfRule - Conditional Formatting rule
  4067. </member>
  4068. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormatting.AddRule(NPOI.SS.UserModel.IConditionalFormattingRule)">
  4069. Add a Conditional Formatting rule.
  4070. Excel allows to create up to 3 Conditional Formatting rules.
  4071. @param cfRule - Conditional Formatting rule
  4072. </member>
  4073. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormatting.GetRule(System.Int32)">
  4074. @return the Conditional Formatting rule at position idx.
  4075. </member>
  4076. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormatting.NumberOfRules">
  4077. @return number of Conditional Formatting rules.
  4078. </member>
  4079. <member name="T:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule">
  4080. @author Yegor Kozlov
  4081. </member>
  4082. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.CreateBorderFormatting">
  4083. Create a new border formatting structure if it does not exist,
  4084. otherwise just return existing object.
  4085. @return - border formatting object, never returns <code>null</code>.
  4086. </member>
  4087. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.BorderFormatting">
  4088. @return - border formatting object if defined, <code>null</code> otherwise
  4089. </member>
  4090. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.CreateFontFormatting">
  4091. Create a new font formatting structure if it does not exist,
  4092. otherwise just return existing object.
  4093. @return - font formatting object, never returns <code>null</code>.
  4094. </member>
  4095. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.FontFormatting">
  4096. @return - font formatting object if defined, <code>null</code> otherwise
  4097. </member>
  4098. <member name="M:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.CreatePatternFormatting">
  4099. Create a new pattern formatting structure if it does not exist,
  4100. otherwise just return existing object.
  4101. @return - pattern formatting object, never returns <code>null</code>.
  4102. </member>
  4103. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.PatternFormatting">
  4104. @return - pattern formatting object if defined, <code>null</code> otherwise
  4105. </member>
  4106. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.ConditionType">
  4107. Type of conditional formatting rule.
  4108. </member>
  4109. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.ComparisonOperation">
  4110. The comparison function used when the type of conditional formatting is Set to
  4111. {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS}
  4112. <p>
  4113. MUST be a constant from {@link NPOI.ss.usermodel.ComparisonOperator}
  4114. </p>
  4115. @return the conditional format operator
  4116. </member>
  4117. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.Formula1">
  4118. The formula used to Evaluate the first operand for the conditional formatting rule.
  4119. <p>
  4120. If the condition type is {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS},
  4121. this field is the first operand of the comparison.
  4122. If type is {@link ConditionalFormattingRule#CONDITION_TYPE_FORMULA}, this formula is used
  4123. to determine if the conditional formatting is applied.
  4124. </p>
  4125. <p>
  4126. If comparison type is {@link ConditionalFormattingRule#CONDITION_TYPE_FORMULA} the formula MUST be a Boolean function
  4127. </p>
  4128. @return the first formula
  4129. </member>
  4130. <member name="P:NPOI.XSSF.UserModel.XSSFConditionalFormattingRule.Formula2">
  4131. The formula used to Evaluate the second operand of the comparison when
  4132. comparison type is {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS} and operator
  4133. is either {@link NPOI.ss.usermodel.ComparisonOperator#BETWEEN} or {@link NPOI.ss.usermodel.ComparisonOperator#NOT_BETWEEN}
  4134. @return the second formula
  4135. </member>
  4136. <member name="T:NPOI.XSSF.UserModel.XSSFConditionalFormattingThreshold">
  4137. High level representation for Icon / Multi-State / Databar /
  4138. Colour Scale change thresholds
  4139. </member>
  4140. <member name="T:NPOI.XSSF.UserModel.XSSFConnector">
  4141. A connection shape Drawing element. A connection shape is a line, etc.
  4142. that connects two other shapes in this Drawing.
  4143. @author Yegor Kozlov
  4144. </member>
  4145. <member name="M:NPOI.XSSF.UserModel.XSSFConnector.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Connector)">
  4146. Construct a new XSSFConnector object.
  4147. @param Drawing the XSSFDrawing that owns this shape
  4148. @param ctShape the shape bean that holds all the shape properties
  4149. </member>
  4150. <member name="M:NPOI.XSSF.UserModel.XSSFConnector.Prototype">
  4151. Initialize default structure of a new auto-shape
  4152. </member>
  4153. <member name="P:NPOI.XSSF.UserModel.XSSFConnector.ShapeType">
  4154. Gets the shape type, one of the constants defined in {@link NPOI.ss.usermodel.ShapeTypes}.
  4155. @return the shape type
  4156. @see NPOI.ss.usermodel.ShapeTypes
  4157. </member>
  4158. <member name="M:NPOI.XSSF.UserModel.XSSFCreationHelper.CreateRichTextString(System.String)">
  4159. Creates a new XSSFRichTextString for you.
  4160. </member>
  4161. <member name="M:NPOI.XSSF.UserModel.XSSFCreationHelper.CreateFormulaEvaluator">
  4162. Creates a XSSFFormulaEvaluator, the object that Evaluates formula cells.
  4163. @return a XSSFFormulaEvaluator instance
  4164. </member>
  4165. <member name="M:NPOI.XSSF.UserModel.XSSFCreationHelper.CreateClientAnchor">
  4166. Creates a XSSFClientAnchor. Use this object to position Drawing object in
  4167. a sheet
  4168. @return a XSSFClientAnchor instance
  4169. @see NPOI.ss.usermodel.Drawing
  4170. </member>
  4171. <member name="T:NPOI.XSSF.UserModel.XSSFDataBarFormatting">
  4172. High level representation for DataBar / Data Bar Formatting
  4173. component of Conditional Formatting Settings
  4174. </member>
  4175. <member name="T:NPOI.XSSF.UserModel.XSSFDataFormat">
  4176. Handles data formats for XSSF.
  4177. Per Microsoft Excel 2007+ format limitations:
  4178. Workbooks support between 200 and 250 "number formats"
  4179. (POI calls them "data formats") So short or even byte
  4180. would be acceptable data types to use for referring to
  4181. data format indices.
  4182. https://support.office.com/en-us/article/excel-specifications-and-limits-1672b34d-7043-467e-8e27-269d656771c3
  4183. </member>
  4184. <member name="M:NPOI.XSSF.UserModel.XSSFDataFormat.GetFormat(System.String)">
  4185. Get the format index that matches the given format
  4186. string, creating a new format entry if required.
  4187. Aliases text to the proper format as required.
  4188. @param format string matching a built in format
  4189. @return index of format.
  4190. </member>
  4191. <member name="M:NPOI.XSSF.UserModel.XSSFDataFormat.GetFormat(System.Int16)">
  4192. Get the format string that matches the given format index
  4193. @param index of a format
  4194. @return string represented at index of format or null if there is not a format at that index
  4195. </member>
  4196. <member name="M:NPOI.XSSF.UserModel.XSSFDataFormat.GetFormat(System.Int32)">
  4197. get the format string that matches the given format index
  4198. @param index of a format
  4199. @return string represented at index of format or null if there is not a format at that index
  4200. </member>
  4201. <member name="M:NPOI.XSSF.UserModel.XSSFDataFormat.PutFormat(System.Int16,System.String)">
  4202. Add a number format with a specific ID into the number format style table.
  4203. If a format with the same ID already exists, overwrite the format code
  4204. with <code>fmt</code>
  4205. This may be used to override built-in number formats.
  4206. @param index the number format ID
  4207. @param format the number format code
  4208. </member>
  4209. <member name="T:NPOI.XSSF.UserModel.XSSFDataValidation">
  4210. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  4211. </member>
  4212. <member name="T:NPOI.XSSF.UserModel.XSSFDataValidationConstraint">
  4213. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  4214. </member>
  4215. <member name="F:NPOI.XSSF.UserModel.XSSFDataValidationConstraint.LIST_SEPARATOR">
  4216. Excel validation constraints with static lists are delimited with optional whitespace and the Windows List Separator,
  4217. which is typically comma, but can be changed by users. POI will just assume comma.
  4218. </member>
  4219. <member name="M:NPOI.XSSF.UserModel.XSSFDataValidationConstraint.#ctor(System.Int32,System.Int32,System.String,System.String)">
  4220. <summary>
  4221. This is the constructor called using the OOXML raw data. Excel overloads formula1 to also encode explicit value lists,
  4222. so this constructor has to check for and parse that syntax.
  4223. </summary>
  4224. <param name="validationType"></param>
  4225. <param name="operator1"></param>
  4226. <param name="formula1">Overloaded: formula1 or list of explicit values</param>
  4227. <param name="formula2">formula1 is a list of explicit values, this is ignored: use <code>null</code></param>
  4228. </member>
  4229. <member name="T:NPOI.XSSF.UserModel.XSSFDataValidationHelper">
  4230. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  4231. </member>
  4232. <member name="T:NPOI.XSSF.UserModel.XSSFDrawing">
  4233. Represents a SpreadsheetML Drawing
  4234. @author Yegor Kozlov
  4235. </member>
  4236. <member name="F:NPOI.XSSF.UserModel.XSSFDrawing.drawing">
  4237. Root element of the SpreadsheetML Drawing part
  4238. </member>
  4239. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.#ctor">
  4240. Create a new SpreadsheetML Drawing
  4241. @see NPOI.xssf.usermodel.XSSFSheet#CreateDrawingPatriarch()
  4242. </member>
  4243. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  4244. Construct a SpreadsheetML Drawing from a namespace part
  4245. @param part the namespace part holding the Drawing data,
  4246. the content type must be <code>application/vnd.openxmlformats-officedocument.Drawing+xml</code>
  4247. @param rel the namespace relationship holding this Drawing,
  4248. the relationship type must be http://schemas.openxmlformats.org/officeDocument/2006/relationships/drawing
  4249. </member>
  4250. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.NewDrawing">
  4251. Construct a new CT_Drawing bean. By default, it's just an empty placeholder for Drawing objects
  4252. @return a new CT_Drawing bean
  4253. </member>
  4254. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.GetCTDrawing">
  4255. Return the underlying CT_Drawing bean, the root element of the SpreadsheetML Drawing part.
  4256. @return the underlying CT_Drawing bean
  4257. </member>
  4258. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateTextbox(NPOI.SS.UserModel.IClientAnchor)">
  4259. Constructs a textbox under the Drawing.
  4260. @param anchor the client anchor describes how this group is attached
  4261. to the sheet.
  4262. @return the newly Created textbox.
  4263. </member>
  4264. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreatePicture(NPOI.XSSF.UserModel.XSSFClientAnchor,System.Int32)">
  4265. Creates a picture.
  4266. @param anchor the client anchor describes how this picture is attached to the sheet.
  4267. @param pictureIndex the index of the picture in the workbook collection of pictures,
  4268. {@link NPOI.xssf.usermodel.XSSFWorkbook#getAllPictures()} .
  4269. @return the newly Created picture shape.
  4270. </member>
  4271. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateChart(NPOI.SS.UserModel.IClientAnchor)">
  4272. <summary>
  4273. Creates a chart.
  4274. </summary>
  4275. <param name="anchor">the client anchor describes how this chart is attached to</param>
  4276. <returns>the newly created chart</returns>
  4277. </member>
  4278. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.AddPictureReference(System.Int32)">
  4279. Add the indexed picture to this Drawing relations
  4280. @param pictureIndex the index of the picture in the workbook collection of pictures,
  4281. {@link NPOI.xssf.usermodel.XSSFWorkbook#getAllPictures()} .
  4282. </member>
  4283. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateSimpleShape(NPOI.XSSF.UserModel.XSSFClientAnchor)">
  4284. Creates a simple shape. This includes such shapes as lines, rectangles,
  4285. and ovals.
  4286. @param anchor the client anchor describes how this group is attached
  4287. to the sheet.
  4288. @return the newly Created shape.
  4289. </member>
  4290. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateConnector(NPOI.XSSF.UserModel.XSSFClientAnchor)">
  4291. Creates a simple shape. This includes such shapes as lines, rectangles,
  4292. and ovals.
  4293. @param anchor the client anchor describes how this group is attached
  4294. to the sheet.
  4295. @return the newly Created shape.
  4296. </member>
  4297. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateGroup(NPOI.XSSF.UserModel.XSSFClientAnchor)">
  4298. Creates a simple shape. This includes such shapes as lines, rectangles,
  4299. and ovals.
  4300. @param anchor the client anchor describes how this group is attached
  4301. to the sheet.
  4302. @return the newly Created shape.
  4303. </member>
  4304. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateCellComment(NPOI.SS.UserModel.IClientAnchor)">
  4305. Creates a comment.
  4306. @param anchor the client anchor describes how this comment is attached
  4307. to the sheet.
  4308. @return the newly Created comment.
  4309. </member>
  4310. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateGraphicFrame(NPOI.XSSF.UserModel.XSSFClientAnchor)">
  4311. Creates a new graphic frame.
  4312. @param anchor the client anchor describes how this frame is attached
  4313. to the sheet
  4314. @return the newly Created graphic frame
  4315. </member>
  4316. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.GetCharts">
  4317. Returns all charts in this Drawing.
  4318. </member>
  4319. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.CreateTwoCellAnchor(NPOI.SS.UserModel.IClientAnchor)">
  4320. Create and Initialize a CT_TwoCellAnchor that anchors a shape against top-left and bottom-right cells.
  4321. @return a new CT_TwoCellAnchor
  4322. </member>
  4323. <member name="M:NPOI.XSSF.UserModel.XSSFDrawing.GetShapes">
  4324. @return list of shapes in this drawing
  4325. </member>
  4326. <member name="T:NPOI.XSSF.UserModel.XSSFEvaluationCell">
  4327. XSSF wrapper for a cell under Evaluation
  4328. @author Josh Micich
  4329. </member>
  4330. <member name="T:NPOI.XSSF.UserModel.XSSFEvaluationSheet">
  4331. XSSF wrapper for a sheet under Evaluation
  4332. @author Josh Micich
  4333. </member>
  4334. <member name="T:NPOI.XSSF.UserModel.XSSFEvaluationWorkbook">
  4335. Internal POI use only
  4336. @author Josh Micich
  4337. </member>
  4338. <member name="T:NPOI.XSSF.UserModel.XSSFEvenFooter">
  4339. Even page footer value. Corresponds to even printed pages.
  4340. Even page(s) in the sheet may not be printed, for example, if the print area is specified to be
  4341. a range such that it falls outside an even page's scope.
  4342. If no even footer is specified, then the odd footer's value is assumed for even page footers.
  4343. </member>
  4344. <member name="M:NPOI.XSSF.UserModel.XSSFEvenFooter.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  4345. Create an instance of XSSFEvenFooter from the supplied XML bean
  4346. @see XSSFSheet#GetEvenFooter()
  4347. @param headerFooter
  4348. </member>
  4349. <member name="P:NPOI.XSSF.UserModel.XSSFEvenFooter.Text">
  4350. Get the content text representing the footer
  4351. @return text
  4352. </member>
  4353. <member name="T:NPOI.XSSF.UserModel.XSSFEvenHeader">
  4354. <p>
  4355. Even page header value. Corresponds to even printed pages.
  4356. Even page(s) in the sheet may not be printed, for example, if the print area is specified to be
  4357. a range such that it falls outside an even page's scope.
  4358. If no even header is specified, then odd header value is assumed for even page headers.
  4359. </p>
  4360. </member>
  4361. <member name="M:NPOI.XSSF.UserModel.XSSFEvenHeader.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  4362. Create an instance of XSSFEvenHeader from the supplied XML bean
  4363. @see XSSFSheet#GetEvenHeader()
  4364. @param headerFooter
  4365. </member>
  4366. <member name="P:NPOI.XSSF.UserModel.XSSFEvenHeader.Text">
  4367. Get the content text representing this header
  4368. @return text
  4369. </member>
  4370. <member name="T:NPOI.XSSF.UserModel.XSSFFactory">
  4371. Instantiates sub-classes of POIXMLDocumentPart depending on their relationship type
  4372. @author Yegor Kozlov
  4373. </member>
  4374. <member name="M:NPOI.XSSF.UserModel.XSSFFactory.GetDescriptor(System.String)">
  4375. @since POI 3.14-Beta1
  4376. </member>
  4377. <member name="M:NPOI.XSSF.UserModel.XSSFFactory.CreateDocumentPart(System.Type,System.Type[],System.Object[])">
  4378. @since POI 3.14-Beta1
  4379. </member>
  4380. <member name="T:NPOI.XSSF.UserModel.XSSFFirstFooter">
  4381. First page footer content. Corresponds to first printed page.
  4382. The first logical page in the sheet may not be printed, for example, if the print area is specified to
  4383. be a range such that it falls outside the first page's scope.
  4384. </member>
  4385. <member name="M:NPOI.XSSF.UserModel.XSSFFirstFooter.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  4386. Create an instance of XSSFFirstFooter from the supplied XML bean
  4387. @see XSSFSheet#getFirstFooter()
  4388. @param headerFooter
  4389. </member>
  4390. <member name="P:NPOI.XSSF.UserModel.XSSFFirstFooter.Text">
  4391. Get the content text representing the footer
  4392. @return text
  4393. </member>
  4394. <member name="T:NPOI.XSSF.UserModel.XSSFFirstHeader">
  4395. First page header content. Corresponds to first printed page.
  4396. The first logical page in the sheet may not be printed, for example, if the print area is specified to
  4397. be a range such that it falls outside the first page's scope.
  4398. </member>
  4399. <member name="M:NPOI.XSSF.UserModel.XSSFFirstHeader.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  4400. Create an instance of XSSFFirstHeader from the supplied XML bean
  4401. @see XSSFSheet#getFirstHeader()
  4402. @param headerFooter
  4403. </member>
  4404. <member name="P:NPOI.XSSF.UserModel.XSSFFirstHeader.Text">
  4405. Get the content text representing this header
  4406. @return text
  4407. </member>
  4408. <member name="T:NPOI.XSSF.UserModel.XSSFFont">
  4409. Represents a font used in a workbook.
  4410. @author Gisella Bronzetti
  4411. </member>
  4412. <member name="F:NPOI.XSSF.UserModel.XSSFFont.DEFAULT_FONT_NAME">
  4413. By default, Microsoft Office Excel 2007 uses the Calibry font in font size 11
  4414. </member>
  4415. <member name="F:NPOI.XSSF.UserModel.XSSFFont.DEFAULT_FONT_SIZE">
  4416. By default, Microsoft Office Excel 2007 uses the Calibry font in font size 11
  4417. </member>
  4418. <member name="F:NPOI.XSSF.UserModel.XSSFFont.DEFAULT_FONT_COLOR">
  4419. Default font color is black
  4420. @see NPOI.SS.usermodel.IndexedColors#BLACK
  4421. </member>
  4422. <member name="M:NPOI.XSSF.UserModel.XSSFFont.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Font)">
  4423. Create a new XSSFFont
  4424. @param font the underlying CT_Font bean
  4425. </member>
  4426. <member name="M:NPOI.XSSF.UserModel.XSSFFont.#ctor">
  4427. Create a new XSSFont. This method is protected to be used only by XSSFWorkbook
  4428. </member>
  4429. <member name="M:NPOI.XSSF.UserModel.XSSFFont.GetCTFont">
  4430. get the underlying CT_Font font
  4431. </member>
  4432. <member name="P:NPOI.XSSF.UserModel.XSSFFont.IsBold">
  4433. get a bool value for the boldness to use.
  4434. @return bool - bold
  4435. </member>
  4436. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Charset">
  4437. get character-set to use.
  4438. @return int - character-set (0-255)
  4439. @see NPOI.SS.usermodel.FontCharset
  4440. </member>
  4441. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Color">
  4442. get the indexed color value for the font
  4443. References a color defined in IndexedColors.
  4444. @return short - indexed color to use
  4445. @see IndexedColors
  4446. </member>
  4447. <member name="M:NPOI.XSSF.UserModel.XSSFFont.GetXSSFColor">
  4448. get the color value for the font
  4449. References a color defined as Standard Alpha Red Green Blue color value (ARGB).
  4450. @return XSSFColor - rgb color to use
  4451. </member>
  4452. <member name="M:NPOI.XSSF.UserModel.XSSFFont.GetThemeColor">
  4453. get the color value for the font
  4454. References a color defined in theme.
  4455. @return short - theme defined to use
  4456. </member>
  4457. <member name="P:NPOI.XSSF.UserModel.XSSFFont.FontHeight">
  4458. <summary>
  4459. Get the font height in unit's of 1/20th of a point.
  4460. </summary>
  4461. </member>
  4462. <member name="P:NPOI.XSSF.UserModel.XSSFFont.FontHeightInPoints">
  4463. <summary>
  4464. Get the font height in points.
  4465. </summary>
  4466. </member>
  4467. <member name="P:NPOI.XSSF.UserModel.XSSFFont.FontName">
  4468. get the name of the font (i.e. Arial)
  4469. @return String - a string representing the name of the font to use
  4470. </member>
  4471. <member name="P:NPOI.XSSF.UserModel.XSSFFont.IsItalic">
  4472. get a bool value that specify whether to use italics or not
  4473. @return bool - value for italic
  4474. </member>
  4475. <member name="P:NPOI.XSSF.UserModel.XSSFFont.IsStrikeout">
  4476. get a bool value that specify whether to use a strikeout horizontal line through the text or not
  4477. @return bool - value for strikeout
  4478. </member>
  4479. <member name="P:NPOI.XSSF.UserModel.XSSFFont.TypeOffset">
  4480. get normal,super or subscript.
  4481. @return short - offset type to use (none,super,sub)
  4482. @see Font#SS_NONE
  4483. @see Font#SS_SUPER
  4484. @see Font#SS_SUB
  4485. </member>
  4486. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Underline">
  4487. get type of text underlining to use
  4488. @return byte - underlining type
  4489. @see NPOI.SS.usermodel.FontUnderline
  4490. </member>
  4491. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Boldweight">
  4492. get the boldness to use
  4493. @return boldweight
  4494. @see #BOLDWEIGHT_NORMAL
  4495. @see #BOLDWEIGHT_BOLD
  4496. </member>
  4497. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetCharSet(System.Byte)">
  4498. set character-set to use.
  4499. @param charset - charset
  4500. @see FontCharset
  4501. </member>
  4502. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetCharSet(System.Int32)">
  4503. set character-set to use.
  4504. @param charset - charset
  4505. @see FontCharset
  4506. </member>
  4507. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetCharSet(NPOI.SS.UserModel.FontCharset)">
  4508. set character-set to use.
  4509. @param charSet
  4510. </member>
  4511. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetColor(NPOI.XSSF.UserModel.XSSFColor)">
  4512. set the color for the font in Standard Alpha Red Green Blue color value
  4513. @param color - color to use
  4514. </member>
  4515. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetThemeColor(System.Int16)">
  4516. set the theme color for the font to use
  4517. @param theme - theme color to use
  4518. </member>
  4519. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetUnderline(NPOI.SS.UserModel.FontUnderlineType)">
  4520. set an enumeration representing the style of underlining that is used.
  4521. The none style is equivalent to not using underlining at all.
  4522. The possible values for this attribute are defined by the FontUnderline
  4523. @param underline - FontUnderline enum value
  4524. </member>
  4525. <member name="M:NPOI.XSSF.UserModel.XSSFFont.RegisterTo(NPOI.XSSF.Model.StylesTable)">
  4526. **
  4527. </member>
  4528. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetThemesTable(NPOI.XSSF.Model.ThemesTable)">
  4529. Records the Themes Table that is associated with
  4530. the current font, used when looking up theme
  4531. based colours and properties.
  4532. </member>
  4533. <member name="M:NPOI.XSSF.UserModel.XSSFFont.GetScheme">
  4534. get the font scheme property.
  4535. is used only in StylesTable to create the default instance of font
  4536. @return FontScheme
  4537. @see NPOI.XSSF.model.StylesTable#CreateDefaultFont()
  4538. </member>
  4539. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetScheme(NPOI.SS.UserModel.FontScheme)">
  4540. set font scheme property
  4541. @param scheme - FontScheme enum value
  4542. @see FontScheme
  4543. </member>
  4544. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Family">
  4545. get the font family to use.
  4546. @return the font family to use
  4547. @see NPOI.SS.usermodel.FontFamily
  4548. </member>
  4549. <member name="M:NPOI.XSSF.UserModel.XSSFFont.SetFamily(NPOI.SS.UserModel.FontFamily)">
  4550. set an enumeration representing the font family this font belongs to.
  4551. A font family is a set of fonts having common stroke width and serif characteristics.
  4552. @param family font family
  4553. @link #SetFamily(int value)
  4554. </member>
  4555. <member name="P:NPOI.XSSF.UserModel.XSSFFont.Index">
  4556. get the index within the XSSFWorkbook (sequence within the collection of Font objects)
  4557. @return unique index number of the underlying record this Font represents (probably you don't care
  4558. unless you're comparing which one is which)
  4559. </member>
  4560. <member name="T:NPOI.XSSF.UserModel.XSSFFontFormatting">
  4561. @author Yegor Kozlov
  4562. </member>
  4563. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.EscapementType">
  4564. Get the type of super or subscript for the font
  4565. @return super or subscript option
  4566. @see #SS_NONE
  4567. @see #SS_SUPER
  4568. @see #SS_SUB
  4569. </member>
  4570. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.FontColorIndex">
  4571. @return font color index
  4572. </member>
  4573. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.FontHeight">
  4574. Gets the height of the font in 1/20th point units
  4575. @return fontheight (in points/20); or -1 if not modified
  4576. </member>
  4577. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.UnderlineType">
  4578. Get the type of underlining for the font
  4579. @return font underlining type
  4580. @see #U_NONE
  4581. @see #U_SINGLE
  4582. @see #U_DOUBLE
  4583. @see #U_SINGLE_ACCOUNTING
  4584. @see #U_DOUBLE_ACCOUNTING
  4585. </member>
  4586. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.IsBold">
  4587. Get whether the font weight is Set to bold or not
  4588. @return bold - whether the font is bold or not
  4589. </member>
  4590. <member name="P:NPOI.XSSF.UserModel.XSSFFontFormatting.IsItalic">
  4591. @return true if font style was Set to <i>italic</i>
  4592. </member>
  4593. <member name="M:NPOI.XSSF.UserModel.XSSFFontFormatting.SetFontStyle(System.Boolean,System.Boolean)">
  4594. Set font style options.
  4595. @param italic - if true, Set posture style to italic, otherwise to normal
  4596. @param bold if true, Set font weight to bold, otherwise to normal
  4597. </member>
  4598. <member name="M:NPOI.XSSF.UserModel.XSSFFontFormatting.ResetFontStyle">
  4599. Set font style options to default values (non-italic, non-bold)
  4600. </member>
  4601. <member name="T:NPOI.XSSF.UserModel.XSSFFormulaEvaluator">
  4602. Evaluates formula cells.<p/>
  4603. For performance reasons, this class keeps a cache of all previously calculated intermediate
  4604. cell values. Be sure to call {@link #ClearAllCachedResultValues()} if any workbook cells are Changed between
  4605. calls to Evaluate~ methods on this class.
  4606. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  4607. @author Josh Micich
  4608. </member>
  4609. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.Create(NPOI.XSSF.UserModel.XSSFWorkbook,NPOI.SS.Formula.IStabilityClassifier,NPOI.SS.Formula.UDF.UDFFinder)">
  4610. @param stabilityClassifier used to optimise caching performance. Pass <code>null</code>
  4611. for the (conservative) assumption that any cell may have its defInition Changed After
  4612. Evaluation begins.
  4613. @param udfFinder pass <code>null</code> for default (AnalysisToolPak only)
  4614. </member>
  4615. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.EvaluateAllFormulaCells(NPOI.XSSF.UserModel.XSSFWorkbook)">
  4616. Loops over all cells in all sheets of the supplied
  4617. workbook.
  4618. For cells that contain formulas, their formulas are
  4619. Evaluated, and the results are saved. These cells
  4620. remain as formula cells.
  4621. For cells that do not contain formulas, no Changes
  4622. are made.
  4623. This is a helpful wrapper around looping over all
  4624. cells, and calling EvaluateFormulaCell on each one.
  4625. </member>
  4626. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.EvaluateAll">
  4627. Loops over all cells in all sheets of the supplied
  4628. workbook.
  4629. For cells that contain formulas, their formulas are
  4630. Evaluated, and the results are saved. These cells
  4631. remain as formula cells.
  4632. For cells that do not contain formulas, no Changes
  4633. are made.
  4634. This is a helpful wrapper around looping over all
  4635. cells, and calling EvaluateFormulaCell on each one.
  4636. </member>
  4637. <member name="M:NPOI.XSSF.UserModel.XSSFFormulaEvaluator.ToEvaluationCell(NPOI.SS.UserModel.ICell)">
  4638. Turns a XSSFCell into a XSSFEvaluationCell
  4639. </member>
  4640. <member name="T:NPOI.XSSF.UserModel.XSSFGraphicFrame">
  4641. Represents DrawingML GraphicalObjectFrame.
  4642. @author Roman Kashitsyn
  4643. </member>
  4644. <member name="M:NPOI.XSSF.UserModel.XSSFGraphicFrame.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_GraphicalObjectFrame)">
  4645. Construct a new XSSFGraphicFrame object.
  4646. @param Drawing the XSSFDrawing that owns this frame
  4647. @param ctGraphicFrame the XML bean that stores this frame content
  4648. </member>
  4649. <member name="M:NPOI.XSSF.UserModel.XSSFGraphicFrame.Prototype">
  4650. Initialize default structure of a new graphic frame
  4651. </member>
  4652. <member name="M:NPOI.XSSF.UserModel.XSSFGraphicFrame.SetMacro(System.String)">
  4653. Sets the frame macro.
  4654. </member>
  4655. <member name="P:NPOI.XSSF.UserModel.XSSFGraphicFrame.Name">
  4656. Returns the frame name.
  4657. @return name of the frame
  4658. </member>
  4659. <member name="P:NPOI.XSSF.UserModel.XSSFGraphicFrame.Anchor">
  4660. Returns the frame anchor.
  4661. @return the anchor this frame is attached to
  4662. </member>
  4663. <member name="M:NPOI.XSSF.UserModel.XSSFGraphicFrame.SetChart(NPOI.XSSF.UserModel.XSSFChart,System.String)">
  4664. Assign a DrawingML chart to the graphic frame.
  4665. </member>
  4666. <member name="P:NPOI.XSSF.UserModel.XSSFGraphicFrame.Id">
  4667. Gets the frame id.
  4668. </member>
  4669. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFGraphicFrame.AppendChartElement(NPOI.OpenXmlFormats.Dml.CT_GraphicalObjectData,System.String)" -->
  4670. <member name="T:NPOI.XSSF.UserModel.XSSFIconMultiStateFormatting">
  4671. High level representation for Icon / Multi-State Formatting
  4672. component of Conditional Formatting Settings
  4673. </member>
  4674. <member name="M:NPOI.XSSF.UserModel.XSSFLineBreak.SetText(System.String)">
  4675. Always . You cannot change text of a line break.
  4676. </member>
  4677. <member name="T:NPOI.XSSF.UserModel.XSSFMap">
  4678. This class : the Map element (Open Office XML Part 4:
  4679. chapter 3.16.2)
  4680. This element Contains all of the properties related to the XML map,
  4681. and the behaviors expected during data refresh operations.
  4682. @author Roberto Manicardi
  4683. </member>
  4684. <member name="M:NPOI.XSSF.UserModel.XSSFMap.GetRelatedSingleXMLCell">
  4685. @return the list of Single Xml Cells that provide a map rule to this mapping.
  4686. </member>
  4687. <member name="M:NPOI.XSSF.UserModel.XSSFMap.GetRelatedTables">
  4688. @return the list of all Tables that provide a map rule to this mapping
  4689. </member>
  4690. <member name="T:NPOI.XSSF.UserModel.XSSFName">
  4691. Represents a defined named range in a SpreadsheetML workbook.
  4692. <p>
  4693. Defined names are descriptive text that is used to represents a cell, range of cells, formula, or constant value.
  4694. Use easy-to-understand names, such as Products, to refer to hard to understand ranges, such as <code>Sales!C20:C30</code>.
  4695. </p>
  4696. Example:
  4697. <pre><blockquote>
  4698. XSSFWorkbook wb = new XSSFWorkbook();
  4699. XSSFSheet sh = wb.CreateSheet("Sheet1");
  4700. //applies to the entire workbook
  4701. XSSFName name1 = wb.CreateName();
  4702. name1.SetNameName("FMLA");
  4703. name1.SetRefersToFormula("Sheet1!$B$3");
  4704. //applies to Sheet1
  4705. XSSFName name2 = wb.CreateName();
  4706. name2.SetNameName("SheetLevelName");
  4707. name2.SetComment("This name is scoped to Sheet1");
  4708. name2.SetLocalSheetId(0);
  4709. name2.SetRefersToFormula("Sheet1!$B$3");
  4710. </blockquote></pre>
  4711. @author Nick Burch
  4712. @author Yegor Kozlov
  4713. </member>
  4714. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_PRINT_AREA">
  4715. A built-in defined name that specifies the workbook's print area
  4716. </member>
  4717. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_PRINT_TITLE">
  4718. A built-in defined name that specifies the row(s) or column(s) to repeat
  4719. at the top of each printed page.
  4720. </member>
  4721. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_CRITERIA">
  4722. A built-in defined name that refers to a range Containing the criteria values
  4723. to be used in Applying an advanced filter to a range of data
  4724. </member>
  4725. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_EXTRACT">
  4726. this defined name refers to the range Containing the filtered
  4727. output values resulting from Applying an advanced filter criteria to a source
  4728. range
  4729. </member>
  4730. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_FILTER_DB">
  4731. ?an be one of the following
  4732. 1 this defined name refers to a range to which an advanced filter has been
  4733. applied. This represents the source data range, unfiltered.
  4734. 2 This defined name refers to a range to which an AutoFilter has been
  4735. applied
  4736. </member>
  4737. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_CONSOLIDATE_AREA">
  4738. A built-in defined name that refers to a consolidation area
  4739. </member>
  4740. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_DATABASE">
  4741. A built-in defined name that specified that the range specified is from a database data source
  4742. </member>
  4743. <member name="F:NPOI.XSSF.UserModel.XSSFName.BUILTIN_SHEET_TITLE">
  4744. A built-in defined name that refers to a sheet title.
  4745. </member>
  4746. <member name="M:NPOI.XSSF.UserModel.XSSFName.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_DefinedName,NPOI.XSSF.UserModel.XSSFWorkbook)">
  4747. Creates an XSSFName object - called internally by XSSFWorkbook.
  4748. @param name - the xml bean that holds data represenring this defined name.
  4749. @param workbook - the workbook object associated with the name
  4750. @see NPOI.XSSF.usermodel.XSSFWorkbook#CreateName()
  4751. </member>
  4752. <member name="M:NPOI.XSSF.UserModel.XSSFName.GetCTName">
  4753. Returns the underlying named range object
  4754. </member>
  4755. <member name="P:NPOI.XSSF.UserModel.XSSFName.NameName">
  4756. Returns the name that will appear in the user interface for the defined name.
  4757. @return text name of this defined name
  4758. </member>
  4759. <member name="P:NPOI.XSSF.UserModel.XSSFName.SheetIndex">
  4760. Returns the sheet index this name applies to.
  4761. @return the sheet index this name applies to, -1 if this name applies to the entire workbook
  4762. </member>
  4763. <member name="P:NPOI.XSSF.UserModel.XSSFName.Function">
  4764. Indicates that the defined name refers to a user-defined function.
  4765. This attribute is used when there is an Add-in or other code project associated with the file.
  4766. @return <code>true</code> indicates the name refers to a function.
  4767. </member>
  4768. <member name="P:NPOI.XSSF.UserModel.XSSFName.FunctionGroupId">
  4769. Returns the function group index if the defined name refers to a function. The function
  4770. group defines the general category for the function. This attribute is used when there is
  4771. an Add-in or other code project associated with the file.
  4772. @return the function group index that defines the general category for the function
  4773. </member>
  4774. <member name="P:NPOI.XSSF.UserModel.XSSFName.SheetName">
  4775. Get the sheets name which this named range is referenced to
  4776. @return sheet name, which this named range referred to.
  4777. Empty string if the referenced sheet name weas not found.
  4778. </member>
  4779. <member name="P:NPOI.XSSF.UserModel.XSSFName.IsFunctionName">
  4780. Is the name refers to a user-defined function ?
  4781. @return <code>true</code> if this name refers to a user-defined function
  4782. </member>
  4783. <member name="P:NPOI.XSSF.UserModel.XSSFName.Comment">
  4784. Returns the comment the user provided when the name was Created.
  4785. @return the user comment for this named range
  4786. </member>
  4787. <member name="M:NPOI.XSSF.UserModel.XSSFName.Equals(System.Object)">
  4788. Compares this name to the specified object.
  4789. The result is <code>true</code> if the argument is XSSFName and the
  4790. underlying CTDefinedName bean Equals to the CTDefinedName representing this name
  4791. @param o the object to compare this <code>XSSFName</code> against.
  4792. @return <code>true</code> if the <code>XSSFName </code>are Equal;
  4793. <code>false</code> otherwise.
  4794. </member>
  4795. <member name="T:NPOI.XSSF.UserModel.XSSFHyperlink">
  4796. XSSF Implementation of a Hyperlink.
  4797. Note - unlike with HSSF, many kinds of hyperlink
  4798. are largely stored as relations of the sheet
  4799. </member>
  4800. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.#ctor(NPOI.SS.UserModel.HyperlinkType)">
  4801. Create a new XSSFHyperlink. This method is protected to be used only by XSSFCreationHelper
  4802. @param type - the type of hyperlink to create
  4803. </member>
  4804. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Hyperlink,NPOI.OpenXml4Net.OPC.PackageRelationship)">
  4805. Create a XSSFHyperlink amd Initialize it from the supplied CTHyperlink bean and namespace relationship
  4806. @param ctHyperlink the xml bean Containing xml properties
  4807. @param hyperlinkRel the relationship in the underlying OPC namespace which stores the actual link's Address
  4808. </member>
  4809. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.#ctor(NPOI.SS.UserModel.IHyperlink)">
  4810. Create a new XSSFHyperlink. This method is for Internal use only.
  4811. XSSFHyperlinks can be created by XSSFCreationHelper.
  4812. @param type - the type of hyperlink to create, see {@link Hyperlink}
  4813. </member>
  4814. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.GetCTHyperlink">
  4815. @return the underlying CTHyperlink object
  4816. </member>
  4817. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.NeedsRelationToo">
  4818. Do we need to a relation too, to represent
  4819. this hyperlink?
  4820. </member>
  4821. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.GenerateRelationIfNeeded(NPOI.OpenXml4Net.OPC.PackagePart)">
  4822. Generates the relation if required
  4823. </member>
  4824. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Type">
  4825. Return the type of this hyperlink
  4826. @return the type of this hyperlink
  4827. </member>
  4828. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.CellRef">
  4829. Get the reference of the cell this applies to,
  4830. es A55
  4831. </member>
  4832. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Address">
  4833. Hyperlink Address. Depending on the hyperlink type it can be URL, e-mail, path to a file
  4834. @return the Address of this hyperlink
  4835. </member>
  4836. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Label">
  4837. Return text label for this hyperlink
  4838. @return text to display
  4839. </member>
  4840. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Location">
  4841. Location within target. If target is a workbook (or this workbook) this shall refer to a
  4842. sheet and cell or a defined name. Can also be an HTML anchor if target is HTML file.
  4843. @return location
  4844. </member>
  4845. <member name="M:NPOI.XSSF.UserModel.XSSFHyperlink.SetCellReference(System.String)">
  4846. Assigns this hyperlink to the given cell reference
  4847. </member>
  4848. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.FirstColumn">
  4849. Return the column of the first cell that Contains the hyperlink
  4850. @return the 0-based column of the first cell that Contains the hyperlink
  4851. </member>
  4852. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.LastColumn">
  4853. Return the column of the last cell that Contains the hyperlink
  4854. For XSSF, a Hyperlink may only reference one cell
  4855. @return the 0-based column of the last cell that Contains the hyperlink
  4856. </member>
  4857. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.FirstRow">
  4858. Return the row of the first cell that Contains the hyperlink
  4859. @return the 0-based row of the cell that Contains the hyperlink
  4860. </member>
  4861. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.LastRow">
  4862. Return the row of the last cell that Contains the hyperlink
  4863. For XSSF, a Hyperlink may only reference one cell
  4864. @return the 0-based row of the last cell that Contains the hyperlink
  4865. </member>
  4866. <member name="P:NPOI.XSSF.UserModel.XSSFHyperlink.Tooltip">
  4867. <summary>
  4868. get or set additional text to help the user understand more about the hyperlink
  4869. </summary>
  4870. </member>
  4871. <member name="T:NPOI.XSSF.UserModel.XSSFOddFooter">
  4872. Odd page footer value. Corresponds to odd printed pages.
  4873. Odd page(s) in the sheet may not be printed, for example, if the print area is specified to be
  4874. a range such that it falls outside an odd page's scope.
  4875. </member>
  4876. <member name="M:NPOI.XSSF.UserModel.XSSFOddFooter.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  4877. Create an instance of XSSFOddFooter from the supplied XML bean
  4878. @see XSSFSheet#GetOddFooter()
  4879. @param headerFooter
  4880. </member>
  4881. <member name="P:NPOI.XSSF.UserModel.XSSFOddFooter.Text">
  4882. Get the content text representing the footer
  4883. @return text
  4884. </member>
  4885. <member name="T:NPOI.XSSF.UserModel.XSSFOddHeader">
  4886. Odd page header value. Corresponds to odd printed pages.
  4887. Odd page(s) in the sheet may not be printed, for example, if the print area is specified to be
  4888. a range such that it falls outside an odd page's scope.
  4889. </member>
  4890. <member name="M:NPOI.XSSF.UserModel.XSSFOddHeader.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_HeaderFooter)">
  4891. Create an instance of XSSFOddHeader from the supplied XML bean
  4892. @see XSSFSheet#GetOddHeader()
  4893. @param headerFooter
  4894. </member>
  4895. <member name="P:NPOI.XSSF.UserModel.XSSFOddHeader.Text">
  4896. Get the content text representing this header
  4897. @return text
  4898. </member>
  4899. <member name="T:NPOI.XSSF.UserModel.XSSFPatternFormatting">
  4900. @author Yegor Kozlov
  4901. </member>
  4902. <member name="T:NPOI.XSSF.UserModel.XSSFPicture">
  4903. Represents a picture shape in a SpreadsheetML Drawing.
  4904. @author Yegor Kozlov
  4905. </member>
  4906. <member name="F:NPOI.XSSF.UserModel.XSSFPicture.prototype">
  4907. A default instance of CTShape used for creating new shapes.
  4908. </member>
  4909. <member name="F:NPOI.XSSF.UserModel.XSSFPicture.ctPicture">
  4910. This object specifies a picture object and all its properties
  4911. </member>
  4912. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_Picture)">
  4913. Construct a new XSSFPicture object. This constructor is called from
  4914. {@link XSSFDrawing#CreatePicture(XSSFClientAnchor, int)}
  4915. @param Drawing the XSSFDrawing that owns this picture
  4916. </member>
  4917. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,System.Xml.XmlNode)">
  4918. Returns a prototype that is used to construct new shapes
  4919. @return a prototype that is used to construct new shapes
  4920. </member>
  4921. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.SetPictureReference(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  4922. Link this shape with the picture data
  4923. @param rel relationship referring the picture data
  4924. </member>
  4925. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetCTPicture">
  4926. Return the underlying CT_Picture bean that holds all properties for this picture
  4927. @return the underlying CT_Picture bean
  4928. </member>
  4929. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.Resize">
  4930. Reset the image to the original size.
  4931. <p>
  4932. Please note, that this method works correctly only for workbooks
  4933. with the default font size (Calibri 11pt for .xlsx).
  4934. If the default font is Changed the resized image can be streched vertically or horizontally.
  4935. </p>
  4936. </member>
  4937. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.Resize(System.Double)">
  4938. Resize the image proportionally.
  4939. @see #resize(double, double)
  4940. </member>
  4941. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.Resize(System.Double,System.Double)">
  4942. Resize the image relatively to its current size.
  4943. <p>
  4944. Please note, that this method works correctly only for workbooks
  4945. with the default font size (Calibri 11pt for .xlsx).
  4946. If the default font is changed the resized image can be streched vertically or horizontally.
  4947. </p>
  4948. <p>
  4949. <code>resize(1.0,1.0)</code> keeps the original size,<br/>
  4950. <code>resize(0.5,0.5)</code> resize to 50% of the original,<br/>
  4951. <code>resize(2.0,2.0)</code> resizes to 200% of the original.<br/>
  4952. <code>resize({@link Double#MAX_VALUE},{@link Double#MAX_VALUE})</code> resizes to the dimension of the embedded image.
  4953. </p>
  4954. @param scaleX the amount by which the image width is multiplied relative to the original width,
  4955. when set to {@link java.lang.Double#MAX_VALUE} the width of the embedded image is used
  4956. @param scaleY the amount by which the image height is multiplied relative to the original height,
  4957. when set to {@link java.lang.Double#MAX_VALUE} the height of the embedded image is used
  4958. </member>
  4959. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetPreferredSize">
  4960. Calculate the preferred size for this picture.
  4961. @return XSSFClientAnchor with the preferred size for this image
  4962. </member>
  4963. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetPreferredSize(System.Double)">
  4964. Calculate the preferred size for this picture.
  4965. @param scale the amount by which image dimensions are multiplied relative to the original size.
  4966. @return XSSFClientAnchor with the preferred size for this image
  4967. </member>
  4968. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetPreferredSize(System.Double,System.Double)">
  4969. Calculate the preferred size for this picture.
  4970. @param scaleX the amount by which image width is multiplied relative to the original width.
  4971. @param scaleY the amount by which image height is multiplied relative to the original height.
  4972. @return XSSFClientAnchor with the preferred size for this image
  4973. </member>
  4974. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetImageDimension(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.SS.UserModel.PictureType)">
  4975. Return the dimension of this image
  4976. @param part the namespace part holding raw picture data
  4977. @param type type of the picture: {@link Workbook#PICTURE_TYPE_JPEG},
  4978. {@link Workbook#PICTURE_TYPE_PNG} or {@link Workbook#PICTURE_TYPE_DIB}
  4979. @return image dimension in pixels
  4980. </member>
  4981. <member name="M:NPOI.XSSF.UserModel.XSSFPicture.GetImageDimension">
  4982. Return the dimension of the embedded image in pixel
  4983. @return image dimension in pixels
  4984. </member>
  4985. <member name="P:NPOI.XSSF.UserModel.XSSFPicture.ClientAnchor">
  4986. @return the anchor that is used by this shape.
  4987. </member>
  4988. <member name="P:NPOI.XSSF.UserModel.XSSFPicture.Sheet">
  4989. @return the sheet which contains the picture shape
  4990. </member>
  4991. <member name="T:NPOI.XSSF.UserModel.XSSFPictureData">
  4992. Raw picture data, normally attached to a SpreadsheetML Drawing.
  4993. As a rule, pictures are stored in the /xl/media/ part of a SpreadsheetML package.
  4994. </member>
  4995. <member name="F:NPOI.XSSF.UserModel.XSSFPictureData.RELATIONS">
  4996. Relationships for each known picture type
  4997. </member>
  4998. <member name="M:NPOI.XSSF.UserModel.XSSFPictureData.#ctor">
  4999. Create a new XSSFPictureData node
  5000. @see NPOI.xssf.usermodel.XSSFWorkbook#AddPicture(byte[], int)
  5001. </member>
  5002. <member name="M:NPOI.XSSF.UserModel.XSSFPictureData.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  5003. Construct XSSFPictureData from a namespace part
  5004. @param part the namespace part holding the Drawing data,
  5005. @param rel the namespace relationship holding this Drawing,
  5006. the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/image
  5007. </member>
  5008. <member name="M:NPOI.XSSF.UserModel.XSSFPictureData.SuggestFileExtension">
  5009. Suggests a file extension for this image.
  5010. @return the file extension.
  5011. </member>
  5012. <member name="P:NPOI.XSSF.UserModel.XSSFPictureData.PictureType">
  5013. Return an integer constant that specifies type of this picture
  5014. @return an integer constant that specifies type of this picture
  5015. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_EMF
  5016. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_WMF
  5017. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_PICT
  5018. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_JPEG
  5019. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_PNG
  5020. @see NPOI.ss.usermodel.Workbook#PICTURE_TYPE_DIB
  5021. </member>
  5022. <member name="P:NPOI.XSSF.UserModel.XSSFPictureData.Data">
  5023. <summary>
  5024. Gets the picture data as a byte array.
  5025. </summary>
  5026. </member>
  5027. <member name="M:NPOI.XSSF.UserModel.XSSFPictureData.PrepareForCommit">
  5028. *PictureData objects store the actual content in the part directly without keeping a
  5029. copy like all others therefore we need to handle them differently.
  5030. </member>
  5031. <member name="M:NPOI.XSSF.UserModel.XSSFPivotCache.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  5032. Creates n XSSFPivotCache representing the given package part and relationship.
  5033. Should only be called when Reading in an existing file.
  5034. @param part - The package part that holds xml data representing this pivot cache defInition.
  5035. @param rel - the relationship of the given package part in the underlying OPC package
  5036. </member>
  5037. <member name="M:NPOI.XSSF.UserModel.XSSFPivotCacheDefinition.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  5038. Creates an XSSFPivotCacheDefintion representing the given package part and relationship.
  5039. Should only be called when Reading in an existing file.
  5040. @param part - The package part that holds xml data representing this pivot cache defInition.
  5041. @param rel - the relationship of the given package part in the underlying OPC package
  5042. </member>
  5043. <member name="M:NPOI.XSSF.UserModel.XSSFPivotCacheDefinition.GetPivotArea(NPOI.SS.UserModel.IWorkbook)">
  5044. Find the 2D base data area for the pivot table, either from its direct reference or named table/range.
  5045. @return AreaReference representing the current area defined by the pivot table
  5046. @ if the ref1 attribute is not contiguous or the name attribute is not found.
  5047. </member>
  5048. <member name="M:NPOI.XSSF.UserModel.XSSFPivotCacheDefinition.CreateCacheFields(NPOI.SS.UserModel.ISheet)">
  5049. Generates a cache field for each column in the reference area for the pivot table.
  5050. @param sheet The sheet where the data i collected from
  5051. </member>
  5052. <member name="M:NPOI.XSSF.UserModel.XSSFPivotCacheRecords.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  5053. Creates an XSSFPivotCacheRecords representing the given package part and relationship.
  5054. Should only be called when Reading in an existing file.
  5055. @param part - The package part that holds xml data representing this pivot cache records.
  5056. @param rel - the relationship of the given package part in the underlying OPC package
  5057. </member>
  5058. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  5059. Creates an XSSFPivotTable representing the given package part and relationship.
  5060. Should only be called when Reading in an existing file.
  5061. @param part - The package part that holds xml data representing this pivot table.
  5062. @param rel - the relationship of the given package part in the underlying OPC package
  5063. </member>
  5064. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.SetDefaultPivotTableDefinition">
  5065. Set default values for the table defInition.
  5066. </member>
  5067. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.CheckColumnIndex(System.Int32)">
  5068. Verify column index (relative to first column in1 pivot area) is within the
  5069. pivot area
  5070. @param columnIndex
  5071. @
  5072. </member>
  5073. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.AddRowLabel(System.Int32)">
  5074. Add a row label using data from the given column.
  5075. @param columnIndex the index of the column to be used as row label.
  5076. </member>
  5077. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.AddColumnLabel(NPOI.SS.UserModel.DataConsolidateFunction,System.Int32,System.String)">
  5078. Add a column label using data from the given column and specified function
  5079. @param columnIndex the index of the column to be used as column label.
  5080. @param function the function to be used on the data
  5081. The following functions exists:
  5082. Sum, Count, Average, Max, Min, Product, Count numbers, StdDev, StdDevp, Var, Varp
  5083. @param valueFieldName the name of pivot table value field
  5084. </member>
  5085. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.AddColumnLabel(NPOI.SS.UserModel.DataConsolidateFunction,System.Int32)">
  5086. Add a column label using data from the given column and specified function
  5087. @param columnIndex the index of the column to be used as column label.
  5088. @param function the function to be used on the data
  5089. The following functions exists:
  5090. Sum, Count, Average, Max, Min, Product, Count numbers, StdDev, StdDevp, Var, Varp
  5091. </member>
  5092. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.AddDataField(NPOI.SS.UserModel.DataConsolidateFunction,System.Int32,System.String)">
  5093. Add data field with data from the given column and specified function.
  5094. @param function the function to be used on the data
  5095. The following functions exists:
  5096. Sum, Count, Average, Max, Min, Product, Count numbers, StdDev, StdDevp, Var, Varp
  5097. @param columnIndex the index of the column to be used as column label.
  5098. @param valueFieldName the name of pivot table value field
  5099. </member>
  5100. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.AddDataColumn(System.Int32,System.Boolean)">
  5101. Add column Containing data from the referenced area.
  5102. @param columnIndex the index of the column Containing the data
  5103. @param isDataField true if the data should be displayed in the pivot table.
  5104. </member>
  5105. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.AddReportFilter(System.Int32)">
  5106. Add filter for the column with the corresponding index and cell value
  5107. @param columnIndex index of column to filter on
  5108. </member>
  5109. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.CreateSourceReferences(NPOI.SS.Util.CellReference,NPOI.SS.UserModel.ISheet,NPOI.XSSF.UserModel.XSSFPivotTable.IPivotTableReferenceConfigurator)">
  5110. Creates cacheSource and workSheetSource for pivot table and sets the source reference as well assets the location of the pivot table
  5111. @param sourceRef Source for data for pivot table - mutually exclusive with sourceName
  5112. @param sourceName Source for data for pivot table - mutually exclusive with sourceRef
  5113. @param position Position for pivot table in sheet
  5114. @param sourceSheet Sheet where the source will be collected from
  5115. </member>
  5116. <member name="M:NPOI.XSSF.UserModel.XSSFPivotTable.IPivotTableReferenceConfigurator.ConfigureReference(NPOI.OpenXmlFormats.Spreadsheet.CT_WorksheetSource)">
  5117. Configure the name or area reference for the pivot table
  5118. @param wsSource CTWorksheetSource that needs the pivot source reference assignment
  5119. </member>
  5120. <member name="T:NPOI.XSSF.UserModel.XSSFPrintSetup">
  5121. Page Setup and page margins Settings for the worksheet.
  5122. </member>
  5123. <member name="M:NPOI.XSSF.UserModel.XSSFPrintSetup.SetPaperSize(NPOI.SS.UserModel.PaperSize)">
  5124. Set the paper size as enum value.
  5125. @param size value for the paper size.
  5126. </member>
  5127. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Orientation">
  5128. Orientation of the page: landscape - portrait.
  5129. @return Orientation of the page
  5130. @see PrintOrientation
  5131. </member>
  5132. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.PageOrder">
  5133. Get print page order.
  5134. @return PageOrder
  5135. </member>
  5136. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.PaperSize">
  5137. Returns the paper size.
  5138. @return short - paper size
  5139. </member>
  5140. <member name="M:NPOI.XSSF.UserModel.XSSFPrintSetup.GetPaperSizeEnum">
  5141. Returns the paper size as enum.
  5142. @return PaperSize paper size
  5143. @see PaperSize
  5144. </member>
  5145. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Scale">
  5146. Returns the scale.
  5147. @return short - scale
  5148. </member>
  5149. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.PageStart">
  5150. Set the page numbering start.
  5151. Page number for first printed page. If no value is specified, then 'automatic' is assumed.
  5152. @return page number for first printed page
  5153. </member>
  5154. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.FitWidth">
  5155. Returns the number of pages wide to fit sheet in.
  5156. @return number of pages wide to fit sheet in
  5157. </member>
  5158. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.FitHeight">
  5159. Returns the number of pages high to fit the sheet in.
  5160. @return number of pages high to fit the sheet in
  5161. </member>
  5162. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.LeftToRight">
  5163. Returns the left to right print order.
  5164. @return left to right print order
  5165. </member>
  5166. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Landscape">
  5167. Returns the landscape mode.
  5168. @return landscape mode
  5169. </member>
  5170. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.ValidSettings">
  5171. Use the printer's defaults Settings for page Setup values and don't use the default values
  5172. specified in the schema. For example, if dpi is not present or specified in the XML, the
  5173. application shall not assume 600dpi as specified in the schema as a default and instead
  5174. shall let the printer specify the default dpi.
  5175. @return valid Settings
  5176. </member>
  5177. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.NoColor">
  5178. Returns the black and white Setting.
  5179. @return black and white Setting
  5180. </member>
  5181. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Draft">
  5182. Returns the draft mode.
  5183. @return draft mode
  5184. </member>
  5185. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Notes">
  5186. Returns the print notes.
  5187. @return print notes
  5188. </member>
  5189. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.NoOrientation">
  5190. Returns the no orientation.
  5191. @return no orientation
  5192. </member>
  5193. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.UsePage">
  5194. Returns the use page numbers.
  5195. @return use page numbers
  5196. </member>
  5197. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.HResolution">
  5198. Returns the horizontal resolution.
  5199. @return horizontal resolution
  5200. </member>
  5201. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.VResolution">
  5202. Returns the vertical resolution.
  5203. @return vertical resolution
  5204. </member>
  5205. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.HeaderMargin">
  5206. Returns the header margin.
  5207. @return header margin
  5208. </member>
  5209. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.FooterMargin">
  5210. Returns the footer margin.
  5211. @return footer margin
  5212. </member>
  5213. <member name="P:NPOI.XSSF.UserModel.XSSFPrintSetup.Copies">
  5214. Returns the number of copies.
  5215. @return number of copies
  5216. </member>
  5217. <member name="T:NPOI.XSSF.UserModel.XSSFRelation">
  5218. <summary>
  5219. Defines namespaces, content types and normal file names / naming
  5220. patterns, for the well-known XSSF format parts.
  5221. </summary>
  5222. </member>
  5223. <member name="F:NPOI.XSSF.UserModel.XSSFRelation._table">
  5224. A map to lookup POIXMLRelation by its relation type
  5225. </member>
  5226. <member name="F:NPOI.XSSF.UserModel.XSSFRelation.IMAGE_JPG">
  5227. JPG is an intentional duplicate of JPEG, to handle documents generated by other software. *
  5228. </member>
  5229. <member name="M:NPOI.XSSF.UserModel.XSSFRelation.GetContents(NPOI.OpenXml4Net.OPC.PackagePart)">
  5230. Fetches the InputStream to read the contents, based
  5231. of the specified core part, for which we are defined
  5232. as a suitable relationship
  5233. </member>
  5234. <member name="M:NPOI.XSSF.UserModel.XSSFRelation.GetInstance(System.String)">
  5235. Get POIXMLRelation by relation type
  5236. @param rel relation type, for example,
  5237. <code>http://schemas.openxmlformats.org/officeDocument/2006/relationships/image</code>
  5238. @return registered POIXMLRelation or null if not found
  5239. </member>
  5240. <member name="M:NPOI.XSSF.UserModel.XSSFRelation.RemoveRelation(NPOI.XSSF.UserModel.XSSFRelation)">
  5241. <summary>
  5242. Removes the relation from the internal table.
  5243. Following readings of files will ignoring the removed relation.
  5244. </summary>
  5245. <param name="relation">Relation to remove</param>
  5246. </member>
  5247. <member name="M:NPOI.XSSF.UserModel.XSSFRelation.AddRelation(NPOI.XSSF.UserModel.XSSFRelation)">
  5248. <summary>
  5249. Adds the relation to the internal table.
  5250. Following readings of files will process the given relation.
  5251. </summary>
  5252. <param name="relation">Relation to add</param>
  5253. </member>
  5254. <member name="T:NPOI.XSSF.UserModel.XSSFRichTextString">
  5255. Rich text unicode string. These strings can have fonts applied to arbitary parts of the string.
  5256. <p>
  5257. Most strings in a workbook have formatting applied at the cell level, that is, the entire string in the cell has the
  5258. same formatting applied. In these cases, the formatting for the cell is stored in the styles part,
  5259. and the string for the cell can be shared across the workbook. The following code illustrates the example.
  5260. </p>
  5261. <blockquote>
  5262. <pre>
  5263. cell1.SetCellValue(new XSSFRichTextString("Apache POI"));
  5264. cell2.SetCellValue(new XSSFRichTextString("Apache POI"));
  5265. cell3.SetCellValue(new XSSFRichTextString("Apache POI"));
  5266. </pre>
  5267. </blockquote>
  5268. In the above example all three cells will use the same string cached on workbook level.
  5269. <p>
  5270. Some strings in the workbook may have formatting applied at a level that is more granular than the cell level.
  5271. For instance, specific characters within the string may be bolded, have coloring, italicizing, etc.
  5272. In these cases, the formatting is stored along with the text in the string table, and is treated as
  5273. a unique entry in the workbook. The following xml and code snippet illustrate this.
  5274. </p>
  5275. <blockquote>
  5276. <pre>
  5277. XSSFRichTextString s1 = new XSSFRichTextString("Apache POI");
  5278. s1.ApplyFont(boldArial);
  5279. cell1.SetCellValue(s1);
  5280. XSSFRichTextString s2 = new XSSFRichTextString("Apache POI");
  5281. s2.ApplyFont(italicCourier);
  5282. cell2.SetCellValue(s2);
  5283. </pre>
  5284. </blockquote>
  5285. @author Yegor Kozlov
  5286. </member>
  5287. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.#ctor(System.String)">
  5288. Create a rich text string
  5289. </member>
  5290. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.#ctor">
  5291. Create empty rich text string and Initialize it with empty string
  5292. </member>
  5293. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Rst)">
  5294. Create a rich text string from the supplied XML bean
  5295. </member>
  5296. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ApplyFont(System.Int32,System.Int32,System.Int16)">
  5297. Applies a font to the specified characters of a string.
  5298. @param startIndex The start index to apply the font to (inclusive)
  5299. @param endIndex The end index to apply the font to (exclusive)
  5300. @param fontIndex The font to use.
  5301. </member>
  5302. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ApplyFont(System.Int32,System.Int32,NPOI.SS.UserModel.IFont)">
  5303. Applies a font to the specified characters of a string.
  5304. @param startIndex The start index to apply the font to (inclusive)
  5305. @param endIndex The end index to apply to font to (exclusive)
  5306. @param font The index of the font to use.
  5307. </member>
  5308. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ApplyFont(NPOI.SS.UserModel.IFont)">
  5309. Sets the font of the entire string.
  5310. @param font The font to use.
  5311. </member>
  5312. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ApplyFont(System.Int16)">
  5313. Applies the specified font to the entire string.
  5314. @param fontIndex the font to Apply.
  5315. </member>
  5316. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.Append(System.String,NPOI.XSSF.UserModel.XSSFFont)">
  5317. Append new text to this text run and apply the specify font to it
  5318. @param text the text to append
  5319. @param font the font to apply to the Appended text or <code>null</code> if no formatting is required
  5320. </member>
  5321. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.Append(System.String)">
  5322. Append new text to this text run
  5323. @param text the text to append
  5324. </member>
  5325. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.SetRunAttributes(NPOI.OpenXmlFormats.Spreadsheet.CT_Font,NPOI.OpenXmlFormats.Spreadsheet.CT_RPrElt)">
  5326. Copy font attributes from CTFont bean into CTRPrElt bean
  5327. </member>
  5328. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.HasFormatting">
  5329. Does this string have any explicit formatting applied, or is
  5330. it just text in the default style?
  5331. </member>
  5332. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ClearFormatting">
  5333. Removes any formatting that may have been applied to the string.
  5334. </member>
  5335. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetIndexOfFormattingRun(System.Int32)">
  5336. The index within the string to which the specified formatting run applies.
  5337. @param index the index of the formatting run
  5338. @return the index within the string.
  5339. </member>
  5340. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetLengthOfFormattingRun(System.Int32)">
  5341. Returns the number of characters this format run covers.
  5342. @param index the index of the formatting run
  5343. @return the number of characters this format run covers
  5344. </member>
  5345. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ToString">
  5346. Returns the plain string representation.
  5347. </member>
  5348. <member name="P:NPOI.XSSF.UserModel.XSSFRichTextString.Length">
  5349. Returns the number of characters in this string.
  5350. </member>
  5351. <member name="P:NPOI.XSSF.UserModel.XSSFRichTextString.NumFormattingRuns">
  5352. @return The number of formatting Runs used.
  5353. </member>
  5354. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetFontOfFormattingRun(System.Int32)">
  5355. Gets a copy of the font used in a particular formatting Run.
  5356. @param index the index of the formatting run
  5357. @return A copy of the font used or null if no formatting is applied to the specified text Run.
  5358. </member>
  5359. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetFontAtIndex(System.Int32)">
  5360. Return a copy of the font in use at a particular index.
  5361. @param index The index.
  5362. @return A copy of the font that's currently being applied at that
  5363. index or null if no font is being applied or the
  5364. index is out of range.
  5365. </member>
  5366. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.GetCTRst">
  5367. Return the underlying xml bean
  5368. </member>
  5369. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.ToCTFont(NPOI.OpenXmlFormats.Spreadsheet.CT_RPrElt)">
  5370. CTRPrElt --> CTFont adapter
  5371. </member>
  5372. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.PreserveSpaces(System.String)">
  5373. **
  5374. </member>
  5375. <member name="M:NPOI.XSSF.UserModel.XSSFRichTextString.UtfDecode(System.String)">
  5376. For all characters which cannot be represented in XML as defined by the XML 1.0 specification,
  5377. the characters are escaped using the Unicode numerical character representation escape character
  5378. format _xHHHH_, where H represents a hexadecimal character in the character's value.
  5379. <p>
  5380. Example: The Unicode character 0D is invalid in an XML 1.0 document,
  5381. so it shall be escaped as <code>_x000D_</code>.
  5382. </p>
  5383. See section 3.18.9 in the OOXML spec.
  5384. @param value the string to decode
  5385. @return the decoded string
  5386. </member>
  5387. <member name="T:NPOI.XSSF.UserModel.XSSFRow">
  5388. High level representation of a row of a spreadsheet.
  5389. </member>
  5390. <member name="F:NPOI.XSSF.UserModel.XSSFRow._row">
  5391. the xml bean Containing all cell defInitions for this row
  5392. </member>
  5393. <member name="F:NPOI.XSSF.UserModel.XSSFRow._cells">
  5394. Cells of this row keyed by their column indexes.
  5395. The TreeMap ensures that the cells are ordered by columnIndex in the ascending order.
  5396. </member>
  5397. <member name="F:NPOI.XSSF.UserModel.XSSFRow._sheet">
  5398. the parent sheet
  5399. </member>
  5400. <member name="M:NPOI.XSSF.UserModel.XSSFRow.#ctor(NPOI.OpenXmlFormats.Spreadsheet.CT_Row,NPOI.XSSF.UserModel.XSSFSheet)">
  5401. Construct a XSSFRow.
  5402. @param row the xml bean Containing all cell defInitions for this row.
  5403. @param sheet the parent sheet.
  5404. </member>
  5405. <member name="P:NPOI.XSSF.UserModel.XSSFRow.Sheet">
  5406. Returns the XSSFSheet this row belongs to
  5407. @return the XSSFSheet that owns this row
  5408. </member>
  5409. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFRow.CellIterator" -->
  5410. <member name="M:NPOI.XSSF.UserModel.XSSFRow.GetEnumerator">
  5411. Alias for {@link #cellIterator()} to allow foreach loops:
  5412. <blockquote><pre>
  5413. for(Cell cell : row){
  5414. ...
  5415. }
  5416. </pre></blockquote>
  5417. @return an iterator over cells in this row.
  5418. </member>
  5419. <member name="M:NPOI.XSSF.UserModel.XSSFRow.CompareTo(NPOI.XSSF.UserModel.XSSFRow)">
  5420. Compares two <code>XSSFRow</code> objects. Two rows are equal if they belong to the same worksheet and
  5421. their row indexes are equal.
  5422. @param row the <code>XSSFRow</code> to be compared.
  5423. @return <ul>
  5424. <li>
  5425. the value <code>0</code> if the row number of this <code>XSSFRow</code> is
  5426. equal to the row number of the argument <code>XSSFRow</code>
  5427. </li>
  5428. <li>
  5429. a value less than <code>0</code> if the row number of this this <code>XSSFRow</code> is
  5430. numerically less than the row number of the argument <code>XSSFRow</code>
  5431. </li>
  5432. <li>
  5433. a value greater than <code>0</code> if the row number of this this <code>XSSFRow</code> is
  5434. numerically greater than the row number of the argument <code>XSSFRow</code>
  5435. </li>
  5436. </ul>
  5437. @throws IllegalArgumentException if the argument row belongs to a different worksheet
  5438. </member>
  5439. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFRow.CreateCell(System.Int32)" -->
  5440. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFRow.CreateCell(System.Int32,NPOI.SS.UserModel.CellType)" -->
  5441. <member name="M:NPOI.XSSF.UserModel.XSSFRow.GetCell(System.Int32)">
  5442. Returns the cell at the given (0 based) index,
  5443. with the {@link NPOI.SS.usermodel.Row.MissingCellPolicy} from the parent Workbook.
  5444. @return the cell at the given (0 based) index
  5445. </member>
  5446. <member name="M:NPOI.XSSF.UserModel.XSSFRow.RetrieveCell(System.Int32)">
  5447. <summary>
  5448. Get the hssfcell representing a given column (logical cell)
  5449. 0-based. If you ask for a cell that is not defined, then
  5450. you Get a null.
  5451. This is the basic call, with no policies applied
  5452. </summary>
  5453. <param name="cellnum">0 based column number</param>
  5454. <returns>Cell representing that column or null if Undefined.</returns>
  5455. </member>
  5456. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFRow.GetCell(System.Int32,NPOI.SS.UserModel.MissingCellPolicy)" -->
  5457. <member name="P:NPOI.XSSF.UserModel.XSSFRow.FirstCellNum">
  5458. Get the number of the first cell Contained in this row.
  5459. @return short representing the first logical cell in the row,
  5460. or -1 if the row does not contain any cells.
  5461. </member>
  5462. <member name="P:NPOI.XSSF.UserModel.XSSFRow.LastCellNum">
  5463. Gets the index of the last cell Contained in this row <b>PLUS ONE</b>. The result also
  5464. happens to be the 1-based column number of the last cell. This value can be used as a
  5465. standard upper bound when iterating over cells:
  5466. <pre>
  5467. short minColIx = row.GetFirstCellNum();
  5468. short maxColIx = row.GetLastCellNum();
  5469. for(short colIx=minColIx; colIx&lt;maxColIx; colIx++) {
  5470. XSSFCell cell = row.GetCell(colIx);
  5471. if(cell == null) {
  5472. continue;
  5473. }
  5474. //... do something with cell
  5475. }
  5476. </pre>
  5477. @return short representing the last logical cell in the row <b>PLUS ONE</b>,
  5478. or -1 if the row does not contain any cells.
  5479. </member>
  5480. <member name="P:NPOI.XSSF.UserModel.XSSFRow.Height">
  5481. Get the row's height measured in twips (1/20th of a point). If the height is not Set, the default worksheet value is returned,
  5482. See {@link NPOI.XSSF.usermodel.XSSFSheet#GetDefaultRowHeightInPoints()}
  5483. @return row height measured in twips (1/20th of a point)
  5484. </member>
  5485. <member name="P:NPOI.XSSF.UserModel.XSSFRow.HeightInPoints">
  5486. Returns row height measured in point size. If the height is not Set, the default worksheet value is returned,
  5487. See {@link NPOI.XSSF.usermodel.XSSFSheet#GetDefaultRowHeightInPoints()}
  5488. @return row height measured in point size
  5489. @see NPOI.XSSF.usermodel.XSSFSheet#GetDefaultRowHeightInPoints()
  5490. </member>
  5491. <member name="P:NPOI.XSSF.UserModel.XSSFRow.PhysicalNumberOfCells">
  5492. Gets the number of defined cells (NOT number of cells in the actual row!).
  5493. That is to say if only columns 0,4,5 have values then there would be 3.
  5494. @return int representing the number of defined cells in the row.
  5495. </member>
  5496. <member name="P:NPOI.XSSF.UserModel.XSSFRow.RowNum">
  5497. Get row number this row represents
  5498. @return the row number (0 based)
  5499. </member>
  5500. <member name="P:NPOI.XSSF.UserModel.XSSFRow.ZeroHeight">
  5501. Get whether or not to display this row with 0 height
  5502. @return - height is zero or not.
  5503. </member>
  5504. <member name="P:NPOI.XSSF.UserModel.XSSFRow.IsFormatted">
  5505. Is this row formatted? Most aren't, but some rows
  5506. do have whole-row styles. For those that do, you
  5507. can get the formatting from {@link #GetRowStyle()}
  5508. </member>
  5509. <member name="P:NPOI.XSSF.UserModel.XSSFRow.RowStyle">
  5510. Returns the whole-row cell style. Most rows won't
  5511. have one of these, so will return null. Call
  5512. {@link #isFormatted()} to check first.
  5513. </member>
  5514. <member name="M:NPOI.XSSF.UserModel.XSSFRow.SetRowStyle(NPOI.SS.UserModel.ICellStyle)">
  5515. Applies a whole-row cell styling to the row.
  5516. If the value is null then the style information is Removed,
  5517. causing the cell to used the default workbook style.
  5518. </member>
  5519. <member name="M:NPOI.XSSF.UserModel.XSSFRow.RemoveCell(NPOI.SS.UserModel.ICell)">
  5520. Remove the Cell from this row.
  5521. @param cell the cell to remove
  5522. </member>
  5523. <member name="M:NPOI.XSSF.UserModel.XSSFRow.GetCTRow">
  5524. Returns the underlying CT_Row xml bean Containing all cell defInitions in this row
  5525. @return the underlying CT_Row xml bean
  5526. </member>
  5527. <member name="M:NPOI.XSSF.UserModel.XSSFRow.OnDocumentWrite">
  5528. Fired when the document is written to an output stream.
  5529. @see NPOI.XSSF.usermodel.XSSFSheet#Write(java.io.OutputStream) ()
  5530. </member>
  5531. <member name="M:NPOI.XSSF.UserModel.XSSFRow.ToString">
  5532. @return formatted xml representation of this row
  5533. </member>
  5534. <member name="M:NPOI.XSSF.UserModel.XSSFRow.Shift(System.Int32)">
  5535. update cell references when Shifting rows
  5536. @param n the number of rows to move
  5537. </member>
  5538. <member name="M:NPOI.XSSF.UserModel.XSSFRow.CopyRowFrom(NPOI.SS.UserModel.IRow,NPOI.SS.UserModel.CellCopyPolicy)">
  5539. Copy the cells from srcRow to this row
  5540. If this row is not a blank row, this will merge the two rows, overwriting
  5541. the cells in this row with the cells in srcRow
  5542. If srcRow is null, overwrite cells in destination row with blank values, styles, etc per cell copy policy
  5543. srcRow may be from a different sheet in the same workbook
  5544. @param srcRow the rows to copy from
  5545. @param policy the policy to determine what gets copied
  5546. </member>
  5547. <member name="T:NPOI.XSSF.UserModel.XSSFShape">
  5548. Represents a shape in a SpreadsheetML Drawing.
  5549. @author Yegor Kozlov
  5550. </member>
  5551. <member name="F:NPOI.XSSF.UserModel.XSSFShape.drawing">
  5552. Parent Drawing
  5553. </member>
  5554. <member name="F:NPOI.XSSF.UserModel.XSSFShape.parent">
  5555. The parent shape, always not-null for shapes in groups
  5556. </member>
  5557. <member name="F:NPOI.XSSF.UserModel.XSSFShape.anchor">
  5558. anchor that is used by this shape
  5559. </member>
  5560. <member name="M:NPOI.XSSF.UserModel.XSSFShape.GetDrawing">
  5561. Return the Drawing that owns this shape
  5562. @return the parent Drawing that owns this shape
  5563. </member>
  5564. <member name="P:NPOI.XSSF.UserModel.XSSFShape.Parent">
  5565. Gets the parent shape.
  5566. </member>
  5567. <member name="M:NPOI.XSSF.UserModel.XSSFShape.GetAnchor">
  5568. @return the anchor that is used by this shape.
  5569. </member>
  5570. <member name="M:NPOI.XSSF.UserModel.XSSFShape.GetShapeProperties">
  5571. Returns xml bean with shape properties.
  5572. @return xml bean with shape properties.
  5573. </member>
  5574. <member name="P:NPOI.XSSF.UserModel.XSSFShape.IsNoFill">
  5575. Whether this shape is not Filled with a color
  5576. @return true if this shape is not Filled with a color.
  5577. </member>
  5578. <member name="M:NPOI.XSSF.UserModel.XSSFShape.SetFillColor(System.Int32,System.Int32,System.Int32)">
  5579. Sets the color used to fill this shape using the solid fill pattern.
  5580. </member>
  5581. <member name="M:NPOI.XSSF.UserModel.XSSFShape.SetLineStyleColor(System.Int32,System.Int32,System.Int32)">
  5582. The color applied to the lines of this shape.
  5583. </member>
  5584. <member name="T:NPOI.XSSF.UserModel.XSSFShapeGroup">
  5585. This object specifies a group shape that represents many shapes grouped together. This shape is to be treated
  5586. just as if it were a regular shape but instead of being described by a single geometry it is made up of all the
  5587. shape geometries encompassed within it. Within a group shape each of the shapes that make up the group are
  5588. specified just as they normally would.
  5589. @author Yegor Kozlov
  5590. </member>
  5591. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.#ctor(NPOI.XSSF.UserModel.XSSFDrawing,NPOI.OpenXmlFormats.Dml.Spreadsheet.CT_GroupShape)">
  5592. Construct a new XSSFSimpleShape object.
  5593. @param Drawing the XSSFDrawing that owns this shape
  5594. @param ctGroup the XML bean that stores this group content
  5595. </member>
  5596. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.Prototype">
  5597. Initialize default structure of a new shape group
  5598. </member>
  5599. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.CreateTextbox(NPOI.XSSF.UserModel.XSSFChildAnchor)">
  5600. Constructs a textbox.
  5601. @param anchor the child anchor describes how this shape is attached
  5602. to the group.
  5603. @return the newly Created textbox.
  5604. </member>
  5605. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.CreateSimpleShape(NPOI.XSSF.UserModel.XSSFChildAnchor)">
  5606. Creates a simple shape. This includes such shapes as lines, rectangles,
  5607. and ovals.
  5608. @param anchor the child anchor describes how this shape is attached
  5609. to the group.
  5610. @return the newly Created shape.
  5611. </member>
  5612. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.CreateConnector(NPOI.XSSF.UserModel.XSSFChildAnchor)">
  5613. Creates a simple shape. This includes such shapes as lines, rectangles,
  5614. and ovals.
  5615. @param anchor the child anchor describes how this shape is attached
  5616. to the group.
  5617. @return the newly Created shape.
  5618. </member>
  5619. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.CreatePicture(NPOI.XSSF.UserModel.XSSFClientAnchor,System.Int32)">
  5620. Creates a picture.
  5621. @param anchor the client anchor describes how this picture is attached to the sheet.
  5622. @param pictureIndex the index of the picture in the workbook collection of pictures,
  5623. {@link XSSFWorkbook#getAllPictures()} .
  5624. @return the newly Created picture shape.
  5625. </member>
  5626. <member name="M:NPOI.XSSF.UserModel.XSSFShapeGroup.SetCoordinates(System.Int32,System.Int32,System.Int32,System.Int32)">
  5627. Sets the coordinate space of this group. All children are constrained
  5628. to these coordinates.
  5629. </member>
  5630. <member name="T:NPOI.XSSF.UserModel.XSSFSheet">
  5631. High level representation of a SpreadsheetML worksheet.
  5632. <p>
  5633. Sheets are the central structures within a workbook, and are where a user does most of his spreadsheet work.
  5634. The most common type of sheet is the worksheet, which is represented as a grid of cells. Worksheet cells can
  5635. contain text, numbers, dates, and formulas. Cells can also be formatted.
  5636. </p>
  5637. </member>
  5638. <member name="F:NPOI.XSSF.UserModel.XSSFSheet.sharedFormulas">
  5639. cache of master shared formulas in this sheet.
  5640. Master shared formula is the first formula in a group of shared formulas is saved in the f element.
  5641. </member>
  5642. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.#ctor">
  5643. Creates new XSSFSheet - called by XSSFWorkbook to create a sheet from scratch.
  5644. @see NPOI.XSSF.usermodel.XSSFWorkbook#CreateSheet()
  5645. </member>
  5646. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  5647. Creates an XSSFSheet representing the given namespace part and relationship.
  5648. Should only be called by XSSFWorkbook when Reading in an exisiting file.
  5649. @param part - The namespace part that holds xml data represenring this sheet.
  5650. @param rel - the relationship of the given namespace part in the underlying OPC namespace
  5651. </member>
  5652. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Workbook">
  5653. Returns the parent XSSFWorkbook
  5654. @return the parent XSSFWorkbook
  5655. </member>
  5656. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.OnDocumentRead">
  5657. Initialize worksheet data when Reading in an exisiting file.
  5658. </member>
  5659. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.OnDocumentCreate">
  5660. Initialize worksheet data when creating a new sheet.
  5661. </member>
  5662. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.InitHyperlinks">
  5663. Read hyperlink relations, link them with CT_Hyperlink beans in this worksheet
  5664. and Initialize the internal array of XSSFHyperlink objects
  5665. </member>
  5666. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.NewSheet">
  5667. Create a new CT_Worksheet instance with all values set to defaults
  5668. @return a new instance
  5669. </member>
  5670. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCTWorksheet">
  5671. Provide access to the CT_Worksheet bean holding this sheet's data
  5672. @return the CT_Worksheet bean holding this sheet's data
  5673. </member>
  5674. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.SheetName">
  5675. Returns the name of this sheet
  5676. @return the name of this sheet
  5677. </member>
  5678. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AddMergedRegion(NPOI.SS.Util.CellRangeAddress)">
  5679. <summary>
  5680. Adds a merged region of cells on a sheet.
  5681. </summary>
  5682. <param name="region">region to merge</param>
  5683. <returns>index of this region</returns>
  5684. <exception cref="T:System.ArgumentException">if region contains fewer than 2 cells</exception>
  5685. <exception cref="T:System.InvalidOperationException">if region intersects with an existing merged region
  5686. or multi-cell array formula on this sheet</exception>
  5687. </member>
  5688. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AddMergedRegionUnsafe(NPOI.SS.Util.CellRangeAddress)">
  5689. <summary>
  5690. Adds a merged region of cells (hence those cells form one).
  5691. Skips validation.It is possible to create overlapping merged regions
  5692. or create a merged region that intersects a multi-cell array formula
  5693. with this formula, which may result in a corrupt workbook.
  5694. </summary>
  5695. <param name="region">region to merge</param>
  5696. <returns>index of this region</returns>
  5697. <exception cref="T:System.ArgumentException">if region contains fewer than 2 cells</exception>
  5698. </member>
  5699. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AddMergedRegion(NPOI.SS.Util.CellRangeAddress,System.Boolean)">
  5700. <summary>
  5701. Adds a merged region of cells (hence those cells form one).
  5702. </summary>
  5703. <param name="region">region (rowfrom/colfrom-rowto/colto) to merge</param>
  5704. <param name="validate">whether to validate merged region</param>
  5705. <returns>index of this region</returns>
  5706. <exception cref="T:System.InvalidOperationException">if region intersects with a multi-cell array formula or
  5707. if region intersects with an existing region on this sheet</exception>
  5708. <exception cref="T:System.ArgumentException">if region contains fewer than 2 cells</exception>
  5709. </member>
  5710. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ValidateArrayFormulas(NPOI.SS.Util.CellRangeAddress)">
  5711. Verify that the candidate region does not intersect with an existing multi-cell array formula in this sheet
  5712. @param region
  5713. @throws InvalidOperationException if candidate region intersects an existing array formula in this sheet
  5714. </member>
  5715. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CheckForMergedRegionsIntersectingArrayFormulas">
  5716. Verify that none of the merged regions intersect a multi-cell array formula in this sheet
  5717. @param region
  5718. @throws InvalidOperationException if candidate region intersects an existing array formula in this sheet
  5719. </member>
  5720. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ValidateMergedRegions(NPOI.SS.Util.CellRangeAddress)">
  5721. Verify that candidate region does not intersect with an existing merged region in this sheet
  5722. @param candidateRegion
  5723. @throws InvalidOperationException if candidate region intersects an existing merged region in this sheet
  5724. </member>
  5725. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CheckForIntersectingMergedRegions">
  5726. Verify that no merged regions intersect another merged region in this sheet.
  5727. @throws InvalidOperationException if at least one region intersects with another merged region in this sheet
  5728. </member>
  5729. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ValidateMergedRegions">
  5730. Verify that merged regions do not intersect multi-cell array formulas and
  5731. no merged regions intersect another merged region in this sheet.
  5732. @throws InvalidOperationException if region intersects with a multi-cell array formula
  5733. @throws InvalidOperationException if at least one region intersects with another merged region in this sheet
  5734. </member>
  5735. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AutoSizeColumn(System.Int32)">
  5736. Adjusts the column width to fit the contents.
  5737. This process can be relatively slow on large sheets, so this should
  5738. normally only be called once per column, at the end of your
  5739. Processing.
  5740. @param column the column index
  5741. </member>
  5742. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AutoSizeColumn(System.Int32,System.Boolean)">
  5743. Adjusts the column width to fit the contents.
  5744. <p>
  5745. This process can be relatively slow on large sheets, so this should
  5746. normally only be called once per column, at the end of your
  5747. Processing.
  5748. </p>
  5749. You can specify whether the content of merged cells should be considered or ignored.
  5750. Default is to ignore merged cells.
  5751. @param column the column index
  5752. @param useMergedCells whether to use the contents of merged cells when calculating the width of the column
  5753. </member>
  5754. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetDrawingPatriarch">
  5755. Return the sheet's existing Drawing, or null if there isn't yet one.
  5756. Use {@link #CreateDrawingPatriarch()} to Get or create
  5757. @return a SpreadsheetML Drawing
  5758. </member>
  5759. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateDrawingPatriarch">
  5760. Create a new SpreadsheetML Drawing. If this sheet already Contains a Drawing - return that.
  5761. @return a SpreadsheetML Drawing
  5762. </member>
  5763. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetVMLDrawing(System.Boolean)">
  5764. Get VML drawing for this sheet (aka 'legacy' drawig)
  5765. @param autoCreate if true, then a new VML drawing part is Created
  5766. @return the VML drawing of <code>null</code> if the drawing was not found and autoCreate=false
  5767. </member>
  5768. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateFreezePane(System.Int32,System.Int32)">
  5769. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  5770. @param colSplit Horizonatal position of split.
  5771. @param rowSplit Vertical position of split.
  5772. </member>
  5773. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateFreezePane(System.Int32,System.Int32,System.Int32,System.Int32)">
  5774. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  5775. <p>
  5776. If both colSplit and rowSplit are zero then the existing freeze pane is Removed
  5777. </p>
  5778. @param colSplit Horizonatal position of split.
  5779. @param rowSplit Vertical position of split.
  5780. @param leftmostColumn Left column visible in right pane.
  5781. @param topRow Top row visible in bottom pane
  5782. </member>
  5783. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateRow(System.Int32)">
  5784. Create a new row within the sheet and return the high level representation
  5785. @param rownum row number
  5786. @return High level {@link XSSFRow} object representing a row in the sheet
  5787. @see #RemoveRow(NPOI.SS.usermodel.Row)
  5788. </member>
  5789. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateSplitPane(System.Int32,System.Int32,System.Int32,System.Int32,NPOI.SS.UserModel.PanePosition)">
  5790. Creates a split pane. Any existing freezepane or split pane is overwritten.
  5791. @param xSplitPos Horizonatal position of split (in 1/20th of a point).
  5792. @param ySplitPos Vertical position of split (in 1/20th of a point).
  5793. @param topRow Top row visible in bottom pane
  5794. @param leftmostColumn Left column visible in right pane.
  5795. @param activePane Active pane. One of: PANE_LOWER_RIGHT,
  5796. PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFT
  5797. @see NPOI.SS.usermodel.Sheet#PANE_LOWER_LEFT
  5798. @see NPOI.SS.usermodel.Sheet#PANE_LOWER_RIGHT
  5799. @see NPOI.SS.usermodel.Sheet#PANE_UPPER_LEFT
  5800. @see NPOI.SS.usermodel.Sheet#PANE_UPPER_RIGHT
  5801. </member>
  5802. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCellComment(System.Int32,System.Int32)">
  5803. <summary>
  5804. Returns cell comment for the specified row and column
  5805. </summary>
  5806. <param name="row">The row.</param>
  5807. <param name="column">The column.</param>
  5808. <returns>cell comment or <code>null</code> if not found</returns>
  5809. </member>
  5810. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCellComment(NPOI.SS.Util.CellAddress)">
  5811. <summary>
  5812. Returns cell comment for the specified location
  5813. </summary>
  5814. <param name="address">cell location</param>
  5815. <returns>return cell comment or null if not found</returns>
  5816. </member>
  5817. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCellComments">
  5818. <summary>
  5819. Returns all cell comments on this sheet.
  5820. </summary>
  5821. <returns>return A Dictionary of each Comment in the sheet, keyed on the cell address where the comment is located.</returns>
  5822. </member>
  5823. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetHyperlink(System.Int32,System.Int32)">
  5824. <summary>
  5825. Get a Hyperlink in this sheet anchored at row, column
  5826. </summary>
  5827. <param name="row"></param>
  5828. <param name="column"></param>
  5829. <returns>return hyperlink if there is a hyperlink anchored at row, column; otherwise returns null</returns>
  5830. </member>
  5831. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetHyperlink(NPOI.SS.Util.CellAddress)">
  5832. <summary>
  5833. Get a Hyperlink in this sheet located in a cell specified by {code addr}
  5834. </summary>
  5835. <param name="addr">The address of the cell containing the hyperlink</param>
  5836. <returns>return hyperlink if there is a hyperlink anchored at {@code addr}; otherwise returns {@code null}</returns>
  5837. </member>
  5838. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetHyperlinkList">
  5839. <summary>
  5840. Get a list of Hyperlinks in this sheet
  5841. </summary>
  5842. <returns></returns>
  5843. </member>
  5844. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.ColumnBreaks">
  5845. Vertical page break information used for print layout view, page layout view, drawing print breaks
  5846. in normal view, and for printing the worksheet.
  5847. @return column indexes of all the vertical page breaks, never <code>null</code>
  5848. </member>
  5849. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetColumnWidth(System.Int32)">
  5850. Get the actual column width (in units of 1/256th of a character width )
  5851. <p>
  5852. Note, the returned value is always gerater that {@link #GetDefaultColumnWidth()} because the latter does not include margins.
  5853. Actual column width measured as the number of characters of the maximum digit width of the
  5854. numbers 0, 1, 2, ..., 9 as rendered in the normal style's font. There are 4 pixels of margin
  5855. pAdding (two on each side), plus 1 pixel pAdding for the gridlines.
  5856. </p>
  5857. @param columnIndex - the column to set (0-based)
  5858. @return width - the width in units of 1/256th of a character width
  5859. </member>
  5860. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetColumnWidthInPixels(System.Int32)">
  5861. Get the actual column width in pixels
  5862. <p>
  5863. Please note, that this method works correctly only for workbooks
  5864. with the default font size (Calibri 11pt for .xlsx).
  5865. </p>
  5866. </member>
  5867. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DefaultColumnWidth">
  5868. Get the default column width for the sheet (if the columns do not define their own width) in
  5869. characters.
  5870. <p>
  5871. Note, this value is different from {@link #GetColumnWidth(int)}. The latter is always greater and includes
  5872. 4 pixels of margin pAdding (two on each side), plus 1 pixel pAdding for the gridlines.
  5873. </p>
  5874. @return column width, default value is 8
  5875. </member>
  5876. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DefaultRowHeight">
  5877. Get the default row height for the sheet (if the rows do not define their own height) in
  5878. twips (1/20 of a point)
  5879. @return default row height
  5880. </member>
  5881. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DefaultRowHeightInPoints">
  5882. Get the default row height for the sheet measued in point size (if the rows do not define their own height).
  5883. @return default row height in points
  5884. </member>
  5885. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetColumnStyle(System.Int32)">
  5886. Returns the CellStyle that applies to the given
  5887. (0 based) column, or null if no style has been
  5888. set for that column
  5889. </member>
  5890. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.RightToLeft">
  5891. Whether the text is displayed in right-to-left mode in the window
  5892. @return whether the text is displayed in right-to-left mode in the window
  5893. </member>
  5894. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayGuts">
  5895. Get whether to display the guts or not,
  5896. default value is true
  5897. @return bool - guts or no guts
  5898. </member>
  5899. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayZeros">
  5900. Gets the flag indicating whether the window should show 0 (zero) in cells Containing zero value.
  5901. When false, cells with zero value appear blank instead of Showing the number zero.
  5902. @return whether all zero values on the worksheet are displayed
  5903. </member>
  5904. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.FirstRowNum">
  5905. Gets the first row on the sheet
  5906. @return the number of the first logical row on the sheet, zero based
  5907. </member>
  5908. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.FitToPage">
  5909. Flag indicating whether the Fit to Page print option is enabled.
  5910. @return <code>true</code>
  5911. </member>
  5912. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Footer">
  5913. Returns the default footer for the sheet,
  5914. creating one as needed.
  5915. You may also want to look at
  5916. {@link #GetFirstFooter()},
  5917. {@link #GetOddFooter()} and
  5918. {@link #GetEvenFooter()}
  5919. </member>
  5920. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Header">
  5921. Returns the default header for the sheet,
  5922. creating one as needed.
  5923. You may also want to look at
  5924. {@link #GetFirstHeader()},
  5925. {@link #GetOddHeader()} and
  5926. {@link #GetEvenHeader()}
  5927. </member>
  5928. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.OddFooter">
  5929. Returns the odd footer. Used on all pages unless
  5930. other footers also present, when used on only
  5931. odd pages.
  5932. </member>
  5933. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.EvenFooter">
  5934. Returns the even footer. Not there by default, but
  5935. when Set, used on even pages.
  5936. </member>
  5937. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.FirstFooter">
  5938. Returns the first page footer. Not there by
  5939. default, but when Set, used on the first page.
  5940. </member>
  5941. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.OddHeader">
  5942. Returns the odd header. Used on all pages unless
  5943. other headers also present, when used on only
  5944. odd pages.
  5945. </member>
  5946. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.EvenHeader">
  5947. Returns the even header. Not there by default, but
  5948. when Set, used on even pages.
  5949. </member>
  5950. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.FirstHeader">
  5951. Returns the first page header. Not there by
  5952. default, but when Set, used on the first page.
  5953. </member>
  5954. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.HorizontallyCenter">
  5955. Determine whether printed output for this sheet will be horizontally centered.
  5956. </member>
  5957. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetMargin(NPOI.SS.UserModel.MarginType)">
  5958. Gets the size of the margin in inches.
  5959. @param margin which margin to get
  5960. @return the size of the margin
  5961. @see Sheet#LeftMargin
  5962. @see Sheet#RightMargin
  5963. @see Sheet#TopMargin
  5964. @see Sheet#BottomMargin
  5965. @see Sheet#HeaderMargin
  5966. @see Sheet#FooterMargin
  5967. </member>
  5968. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetMargin(NPOI.SS.UserModel.MarginType,System.Double)">
  5969. Sets the size of the margin in inches.
  5970. @param margin which margin to get
  5971. @param size the size of the margin
  5972. @see Sheet#LeftMargin
  5973. @see Sheet#RightMargin
  5974. @see Sheet#TopMargin
  5975. @see Sheet#BottomMargin
  5976. @see Sheet#HeaderMargin
  5977. @see Sheet#FooterMargin
  5978. </member>
  5979. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetMergedRegion(System.Int32)">
  5980. @return the merged region at the specified index
  5981. @throws InvalidOperationException if this worksheet does not contain merged regions
  5982. </member>
  5983. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.MergedRegions">
  5984. Returns the list of merged regions. If you want multiple regions, this is
  5985. faster than calling {@link #getMergedRegion(int)} each time.
  5986. @return the list of merged regions
  5987. @throws InvalidOperationException if this worksheet does not contain merged regions
  5988. </member>
  5989. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.NumMergedRegions">
  5990. Returns the number of merged regions defined in this worksheet
  5991. @return number of merged regions in this worksheet
  5992. </member>
  5993. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.PaneInformation">
  5994. Returns the information regarding the currently configured pane (split or freeze).
  5995. @return null if no pane configured, or the pane information.
  5996. </member>
  5997. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.PhysicalNumberOfRows">
  5998. Returns the number of phsyically defined rows (NOT the number of rows in the sheet)
  5999. @return the number of phsyically defined rows
  6000. </member>
  6001. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.PrintSetup">
  6002. Gets the print Setup object.
  6003. @return The user model for the print Setup object.
  6004. </member>
  6005. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Protect">
  6006. Answer whether protection is enabled or disabled
  6007. @return true => protection enabled; false => protection disabled
  6008. </member>
  6009. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ProtectSheet(System.String)">
  6010. Enables sheet protection and Sets the password for the sheet.
  6011. Also Sets some attributes on the {@link CT_SheetProtection} that correspond to
  6012. the default values used by Excel
  6013. @param password to set for protection. Pass <code>null</code> to remove protection
  6014. </member>
  6015. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetSheetPassword(System.String,NPOI.POIFS.Crypt.HashAlgorithm)">
  6016. Sets the sheet password.
  6017. @param password if null, the password will be removed
  6018. @param hashAlgo if null, the password will be set as XOR password (Excel 2010 and earlier)
  6019. otherwise the given algorithm is used for calculating the hash password (Excel 2013)
  6020. </member>
  6021. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ValidateSheetPassword(System.String)">
  6022. Validate the password against the stored hash, the hashing method will be determined
  6023. by the existing password attributes
  6024. @return true, if the hashes match (... though original password may differ ...)
  6025. </member>
  6026. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetRow(System.Int32)">
  6027. Returns the logical row ( 0-based). If you ask for a row that is not
  6028. defined you get a null. This is to say row 4 represents the fifth row on a sheet.
  6029. @param rownum row to get
  6030. @return <code>XSSFRow</code> representing the rownumber or <code>null</code> if its not defined on the sheet
  6031. </member>
  6032. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetRows(System.Int32,System.Int32,System.Boolean)">
  6033. returns all rows between startRow and endRow, inclusive.
  6034. Rows between startRow and endRow that haven't been created are not included
  6035. in result unless createRowIfMissing is true
  6036. @param startRow the first row number in this sheet to return
  6037. @param endRow the last row number in this sheet to return
  6038. @param createRowIfMissing
  6039. @return
  6040. @throws IllegalArgumentException if startRowNum and endRowNum are not in ascending order
  6041. </member>
  6042. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.RowBreaks">
  6043. Horizontal page break information used for print layout view, page layout view, drawing print breaks in normal
  6044. view, and for printing the worksheet.
  6045. @return row indexes of all the horizontal page breaks, never <code>null</code>
  6046. </member>
  6047. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.RowSumsBelow">
  6048. Flag indicating whether summary rows appear below detail in an outline, when Applying an outline.
  6049. <p>
  6050. When true a summary row is inserted below the detailed data being summarized and a
  6051. new outline level is established on that row.
  6052. </p>
  6053. <p>
  6054. When false a summary row is inserted above the detailed data being summarized and a new outline level
  6055. is established on that row.
  6056. </p>
  6057. @return <code>true</code> if row summaries appear below detail in the outline
  6058. </member>
  6059. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.RowSumsRight">
  6060. Flag indicating whether summary columns appear to the right of detail in an outline, when Applying an outline.
  6061. <p>
  6062. When true a summary column is inserted to the right of the detailed data being summarized
  6063. and a new outline level is established on that column.
  6064. </p>
  6065. <p>
  6066. When false a summary column is inserted to the left of the detailed data being
  6067. summarized and a new outline level is established on that column.
  6068. </p>
  6069. @return <code>true</code> if col summaries appear right of the detail in the outline
  6070. </member>
  6071. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ensureOutlinePr">
  6072. Ensure CT_Worksheet.CT_SheetPr.CT_OutlinePr
  6073. </member>
  6074. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.ScenarioProtect">
  6075. <summary>
  6076. A flag indicating whether scenarios are locked when the sheet is protected.
  6077. </summary>
  6078. </member>
  6079. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.TopRow">
  6080. <summary>
  6081. The top row in the visible view when the sheet is first viewed after opening it in a viewer
  6082. </summary>
  6083. </member>
  6084. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.VerticallyCenter">
  6085. Determine whether printed output for this sheet will be vertically centered.
  6086. @return whether printed output for this sheet will be vertically centered.
  6087. </member>
  6088. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GroupColumn(System.Int32,System.Int32)">
  6089. Group between (0 based) columns
  6090. </member>
  6091. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetColWidthAttribute(NPOI.OpenXmlFormats.Spreadsheet.CT_Cols)">
  6092. Do not leave the width attribute undefined (see #52186).
  6093. </member>
  6094. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GroupRow(System.Int32,System.Int32)">
  6095. Tie a range of cell toGether so that they can be collapsed or expanded
  6096. @param fromRow start row (0-based)
  6097. @param toRow end row (0-based)
  6098. </member>
  6099. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsColumnBroken(System.Int32)">
  6100. Determines if there is a page break at the indicated column
  6101. </member>
  6102. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsColumnHidden(System.Int32)">
  6103. Get the hidden state for a given column.
  6104. @param columnIndex - the column to set (0-based)
  6105. @return hidden - <code>false</code> if the column is visible
  6106. </member>
  6107. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayFormulas">
  6108. Gets the flag indicating whether this sheet should display formulas.
  6109. @return <code>true</code> if this sheet should display formulas.
  6110. </member>
  6111. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayGridlines">
  6112. Gets the flag indicating whether this sheet displays the lines
  6113. between rows and columns to make editing and Reading easier.
  6114. @return <code>true</code> if this sheet displays gridlines.
  6115. @see #isPrintGridlines() to check if printing of gridlines is turned on or off
  6116. </member>
  6117. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.DisplayRowColHeadings">
  6118. Gets the flag indicating whether this sheet should display row and column headings.
  6119. <p>
  6120. Row heading are the row numbers to the side of the sheet
  6121. </p>
  6122. <p>
  6123. Column heading are the letters or numbers that appear above the columns of the sheet
  6124. </p>
  6125. @return <code>true</code> if this sheet should display row and column headings.
  6126. </member>
  6127. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsPrintGridlines">
  6128. Returns whether gridlines are printed.
  6129. @return whether gridlines are printed
  6130. </member>
  6131. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsPrintRowAndColumnHeadings">
  6132. Returns whether row and column headings are printed.
  6133. @return whether row and column headings are printed
  6134. </member>
  6135. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsRowBroken(System.Int32)">
  6136. Tests if there is a page break at the indicated row
  6137. @param row index of the row to test
  6138. @return <code>true</code> if there is a page break at the indicated row
  6139. </member>
  6140. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetRowBreak(System.Int32)">
  6141. Sets a page break at the indicated row
  6142. Breaks occur above the specified row and left of the specified column inclusive.
  6143. For example, <code>sheet.SetColumnBreak(2);</code> breaks the sheet into two parts
  6144. with columns A,B,C in the first and D,E,... in the second. Simuilar, <code>sheet.SetRowBreak(2);</code>
  6145. breaks the sheet into two parts with first three rows (rownum=1...3) in the first part
  6146. and rows starting with rownum=4 in the second.
  6147. @param row the row to break, inclusive
  6148. </member>
  6149. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveColumnBreak(System.Int32)">
  6150. Removes a page break at the indicated column
  6151. </member>
  6152. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveMergedRegion(System.Int32)">
  6153. Removes a merged region of cells (hence letting them free)
  6154. @param index of the region to unmerge
  6155. </member>
  6156. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveMergedRegions(System.Collections.Generic.IList{System.Int32})">
  6157. Removes a number of merged regions of cells (hence letting them free)
  6158. This method can be used to bulk-remove merged regions in a way
  6159. much faster than calling RemoveMergedRegion() for every single
  6160. merged region.
  6161. @param indices A Set of the regions to unmerge
  6162. </member>
  6163. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveRow(NPOI.SS.UserModel.IRow)">
  6164. Remove a row from this sheet. All cells Contained in the row are Removed as well
  6165. @param row the row to Remove.
  6166. </member>
  6167. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveRowBreak(System.Int32)">
  6168. Removes the page break at the indicated row
  6169. </member>
  6170. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.ForceFormulaRecalculation">
  6171. Whether Excel will be asked to recalculate all formulas when the
  6172. workbook is opened.
  6173. </member>
  6174. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.Autobreaks">
  6175. Flag indicating whether the sheet displays Automatic Page Breaks.
  6176. @return <code>true</code> if the sheet displays Automatic Page Breaks.
  6177. </member>
  6178. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetColumnBreak(System.Int32)">
  6179. Sets a page break at the indicated column.
  6180. Breaks occur above the specified row and left of the specified column inclusive.
  6181. For example, <code>sheet.SetColumnBreak(2);</code> breaks the sheet into two parts
  6182. with columns A,B,C in the first and D,E,... in the second. Simuilar, <code>sheet.SetRowBreak(2);</code>
  6183. breaks the sheet into two parts with first three rows (rownum=1...3) in the first part
  6184. and rows starting with rownum=4 in the second.
  6185. @param column the column to break, inclusive
  6186. </member>
  6187. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetGroupHidden(System.Int32,System.Int32,System.Boolean)">
  6188. Sets all adjacent columns of the same outline level to the specified
  6189. hidden status.
  6190. @param pIdx
  6191. the col info index of the start of the outline group
  6192. @return the column index of the last column in the outline group
  6193. </member>
  6194. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsColumnGroupCollapsed(System.Int32)">
  6195. 'Collapsed' state is stored in a single column col info record
  6196. immediately after the outline group
  6197. @param idx
  6198. @return a bool represented if the column is collapsed
  6199. </member>
  6200. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetColumnHidden(System.Int32,System.Boolean)">
  6201. Get the visibility state for a given column.
  6202. @param columnIndex - the column to get (0-based)
  6203. @param hidden - the visiblity state of the column
  6204. </member>
  6205. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetColumnWidth(System.Int32,System.Int32)">
  6206. * Set the width (in units of 1/256th of a character width)
  6207. *
  6208. * <p>
  6209. * The maximum column width for an individual cell is 255 characters.
  6210. * This value represents the number of characters that can be displayed
  6211. * in a cell that is formatted with the standard font (first font in the workbook).
  6212. * </p>
  6213. *
  6214. * <p>
  6215. * Character width is defined as the maximum digit width
  6216. * of the numbers <code>0, 1, 2, ... 9</code> as rendered
  6217. * using the default font (first font in the workbook).
  6218. * <br/>
  6219. * Unless you are using a very special font, the default character is '0' (zero),
  6220. * this is true for Arial (default font font in HSSF) and Calibri (default font in XSSF)
  6221. * </p>
  6222. *
  6223. * <p>
  6224. * Please note, that the width set by this method includes 4 pixels of margin pAdding (two on each side),
  6225. * plus 1 pixel pAdding for the gridlines (Section 3.3.1.12 of the OOXML spec).
  6226. * This results is a slightly less value of visible characters than passed to this method (approx. 1/2 of a character).
  6227. * </p>
  6228. * <p>
  6229. * To compute the actual number of visible characters,
  6230. * Excel uses the following formula (Section 3.3.1.12 of the OOXML spec):
  6231. * </p>
  6232. * <code>
  6233. * width = TRuncate([{Number of Visible Characters} *
  6234. * {Maximum Digit Width} + {5 pixel pAdding}]/{Maximum Digit Width}*256)/256
  6235. * </code>
  6236. * <p>Using the Calibri font as an example, the maximum digit width of 11 point font size is 7 pixels (at 96 dpi).
  6237. * If you set a column width to be eight characters wide, e.g. <code>SetColumnWidth(columnIndex, 8*256)</code>,
  6238. * then the actual value of visible characters (the value Shown in Excel) is derived from the following equation:
  6239. * <code>
  6240. TRuncate([numChars*7+5]/7*256)/256 = 8;
  6241. * </code>
  6242. *
  6243. * which gives <code>7.29</code>.
  6244. * </p>
  6245. * @param columnIndex - the column to set (0-based)
  6246. * @param width - the width in units of 1/256th of a character width
  6247. * @throws ArgumentException if width > 255*256 (the maximum column width in Excel is 255 characters)
  6248. </member>
  6249. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetRowGroupCollapsed(System.Int32,System.Boolean)">
  6250. group the row It is possible for collapsed to be false and yet still have
  6251. the rows in question hidden. This can be achieved by having a lower
  6252. outline level collapsed, thus hiding all the child rows. Note that in
  6253. this case, if the lowest level were expanded, the middle level would
  6254. remain collapsed.
  6255. @param rowIndex -
  6256. the row involved, 0 based
  6257. @param collapse -
  6258. bool value for collapse
  6259. </member>
  6260. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CollapseRow(System.Int32)">
  6261. @param rowIndex the zero based row index to collapse
  6262. </member>
  6263. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.FindStartOfRowOutlineGroup(System.Int32)">
  6264. @param rowIndex the zero based row index to find from
  6265. </member>
  6266. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ExpandRow(System.Int32)">
  6267. @param rowNumber the zero based row index to expand
  6268. </member>
  6269. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.FindEndOfRowOutlineGroup(System.Int32)">
  6270. @param row the zero based row index to find from
  6271. </member>
  6272. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsRowGroupHiddenByParent(System.Int32)">
  6273. @param row the zero based row index to find from
  6274. </member>
  6275. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.IsRowGroupCollapsed(System.Int32)">
  6276. @param row the zero based row index to find from
  6277. </member>
  6278. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetZoom(System.Int32,System.Int32)">
  6279. Sets the zoom magnification for the sheet. The zoom is expressed as a
  6280. fraction. For example to express a zoom of 75% use 3 for the numerator
  6281. and 4 for the denominator.
  6282. @param numerator The numerator for the zoom magnification.
  6283. @param denominator The denominator for the zoom magnification.
  6284. @see #SetZoom(int)
  6285. </member>
  6286. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetZoom(System.Int32)">
  6287. Window zoom magnification for current view representing percent values.
  6288. Valid values range from 10 to 400. Horizontal &amp; Vertical scale toGether.
  6289. For example:
  6290. <pre>
  6291. 10 - 10%
  6292. 20 - 20%
  6293. ...
  6294. 100 - 100%
  6295. ...
  6296. 400 - 400%
  6297. </pre>
  6298. Current view can be Normal, Page Layout, or Page Break Preview.
  6299. @param scale window zoom magnification
  6300. @throws ArgumentException if scale is invalid
  6301. </member>
  6302. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CopyRows(System.Collections.Generic.List{NPOI.XSSF.UserModel.XSSFRow},System.Int32,NPOI.SS.UserModel.CellCopyPolicy)">
  6303. copyRows rows from srcRows to this sheet starting at destStartRow
  6304. Additionally copies merged regions that are completely defined in these
  6305. rows (ie. merged 2 cells on a row to be shifted).
  6306. @param srcRows the rows to copy. Formulas will be offset by the difference
  6307. in the row number of the first row in srcRows and destStartRow (even if srcRows
  6308. are from a different sheet).
  6309. @param destStartRow the row in this sheet to paste the first row of srcRows
  6310. the remainder of srcRows will be pasted below destStartRow per the cell copy policy
  6311. @param policy is the cell copy policy, which can be used to merge the source and destination
  6312. when the source is blank, copy styles only, paste as value, etc
  6313. </member>
  6314. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CopyRows(System.Int32,System.Int32,System.Int32,NPOI.SS.UserModel.CellCopyPolicy)">
  6315. Copies rows between srcStartRow and srcEndRow to the same sheet, starting at destStartRow
  6316. Convenience function for {@link #copyRows(List, int, CellCopyPolicy)}
  6317. Equivalent to copyRows(getRows(srcStartRow, srcEndRow, false), destStartRow, cellCopyPolicy)
  6318. @param srcStartRow the index of the first row to copy the cells from in this sheet
  6319. @param srcEndRow the index of the last row to copy the cells from in this sheet
  6320. @param destStartRow the index of the first row to copy the cells to in this sheet
  6321. @param cellCopyPolicy the policy to use to determine how cells are copied
  6322. </member>
  6323. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32)">
  6324. Shifts rows between startRow and endRow n number of rows.
  6325. If you use a negative number, it will shift rows up.
  6326. Code ensures that rows don't wrap around.
  6327. Calls ShiftRows(startRow, endRow, n, false, false);
  6328. <p>
  6329. Additionally Shifts merged regions that are completely defined in these
  6330. rows (ie. merged 2 cells on a row to be Shifted).</p>
  6331. @param startRow the row to start Shifting
  6332. @param endRow the row to end Shifting
  6333. @param n the number of rows to shift
  6334. </member>
  6335. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean)">
  6336. Shifts rows between startRow and endRow n number of rows.
  6337. If you use a negative number, it will shift rows up.
  6338. Code ensures that rows don't wrap around
  6339. <p>
  6340. Additionally Shifts merged regions that are completely defined in these
  6341. rows (ie. merged 2 cells on a row to be Shifted).</p>
  6342. @param startRow the row to start Shifting
  6343. @param endRow the row to end Shifting
  6344. @param n the number of rows to shift
  6345. @param copyRowHeight whether to copy the row height during the shift
  6346. @param reSetOriginalRowHeight whether to set the original row's height to the default
  6347. </member>
  6348. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.UngroupRow(System.Int32,System.Int32)">
  6349. Ungroup a range of rows that were previously groupped
  6350. @param fromRow start row (0-based)
  6351. @param toRow end row (0-based)
  6352. </member>
  6353. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSelected">
  6354. Returns a flag indicating whether this sheet is selected.
  6355. <p>
  6356. When only 1 sheet is selected and active, this value should be in synch with the activeTab value.
  6357. In case of a conflict, the Start Part Setting wins and Sets the active sheet tab.
  6358. </p>
  6359. Note: multiple sheets can be selected, but only one sheet can be active at one time.
  6360. @return <code>true</code> if this sheet is selected
  6361. </member>
  6362. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AddHyperlink(NPOI.XSSF.UserModel.XSSFHyperlink)">
  6363. Register a hyperlink in the collection of hyperlinks on this sheet
  6364. @param hyperlink the link to add
  6365. </member>
  6366. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.RemoveHyperlink(System.Int32,System.Int32)">
  6367. Removes a hyperlink in the collection of hyperlinks on this sheet
  6368. @param row row index
  6369. @param column column index
  6370. </member>
  6371. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.ActiveCell">
  6372. Return location of the active cell, e.g. <code>A1</code>.
  6373. @return the location of the active cell.
  6374. </member>
  6375. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.HasComments">
  6376. Does this sheet have any comments on it? We need to know,
  6377. so we can decide about writing it to disk or not
  6378. </member>
  6379. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetDefaultSheetView">
  6380. Return the default sheet view. This is the last one if the sheet's views, according to sec. 3.3.1.83
  6381. of the OOXML spec: "A single sheet view defInition. When more than 1 sheet view is defined in the file,
  6382. it means that when opening the workbook, each sheet view corresponds to a separate window within the
  6383. spreadsheet application, where each window is Showing the particular sheet. Containing the same
  6384. workbookViewId value, the last sheetView defInition is loaded, and the others are discarded.
  6385. When multiple windows are viewing the same sheet, multiple sheetView elements (with corresponding
  6386. workbookView entries) are saved."
  6387. </member>
  6388. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCommentsTable(System.Boolean)">
  6389. Returns the sheet's comments object if there is one,
  6390. or null if not
  6391. @param create create a new comments table if it does not exist
  6392. </member>
  6393. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetSharedFormula(System.Int32)">
  6394. Return a master shared formula by index
  6395. @param sid shared group index
  6396. @return a CT_CellFormula bean holding shared formula or <code>null</code> if not found
  6397. </member>
  6398. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsAutoFilterLocked">
  6399. @return true when Autofilters are locked and the sheet is protected.
  6400. </member>
  6401. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsDeleteColumnsLocked">
  6402. @return true when Deleting columns is locked and the sheet is protected.
  6403. </member>
  6404. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsDeleteRowsLocked">
  6405. @return true when Deleting rows is locked and the sheet is protected.
  6406. </member>
  6407. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsFormatCellsLocked">
  6408. @return true when Formatting cells is locked and the sheet is protected.
  6409. </member>
  6410. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsFormatColumnsLocked">
  6411. @return true when Formatting columns is locked and the sheet is protected.
  6412. </member>
  6413. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsFormatRowsLocked">
  6414. @return true when Formatting rows is locked and the sheet is protected.
  6415. </member>
  6416. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsInsertColumnsLocked">
  6417. @return true when Inserting columns is locked and the sheet is protected.
  6418. </member>
  6419. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsInsertHyperlinksLocked">
  6420. @return true when Inserting hyperlinks is locked and the sheet is protected.
  6421. </member>
  6422. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsInsertRowsLocked">
  6423. @return true when Inserting rows is locked and the sheet is protected.
  6424. </member>
  6425. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsPivotTablesLocked">
  6426. @return true when Pivot tables are locked and the sheet is protected.
  6427. </member>
  6428. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSortLocked">
  6429. @return true when Sorting is locked and the sheet is protected.
  6430. </member>
  6431. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsObjectsLocked">
  6432. @return true when Objects are locked and the sheet is protected.
  6433. </member>
  6434. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsScenariosLocked">
  6435. @return true when Scenarios are locked and the sheet is protected.
  6436. </member>
  6437. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSelectLockedCellsLocked">
  6438. @return true when Selection of locked cells is locked and the sheet is protected.
  6439. </member>
  6440. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSelectUnlockedCellsLocked">
  6441. @return true when Selection of unlocked cells is locked and the sheet is protected.
  6442. </member>
  6443. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.IsSheetLocked">
  6444. @return true when Sheet is Protected.
  6445. </member>
  6446. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.EnableLocking">
  6447. Enable sheet protection
  6448. </member>
  6449. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.DisableLocking">
  6450. Disable sheet protection
  6451. </member>
  6452. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockAutoFilter(System.Boolean)">
  6453. Enable or disable Autofilters locking.
  6454. This does not modify sheet protection status.
  6455. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  6456. </member>
  6457. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockDeleteColumns(System.Boolean)">
  6458. Enable or disable Deleting columns locking.
  6459. This does not modify sheet protection status.
  6460. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  6461. </member>
  6462. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockDeleteRows(System.Boolean)">
  6463. Enable or disable Deleting rows locking.
  6464. This does not modify sheet protection status.
  6465. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  6466. </member>
  6467. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockFormatCells(System.Boolean)">
  6468. Enable or disable Formatting cells locking.
  6469. This does not modify sheet protection status.
  6470. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  6471. </member>
  6472. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockFormatColumns(System.Boolean)">
  6473. Enable or disable Formatting columns locking.
  6474. This does not modify sheet protection status.
  6475. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  6476. </member>
  6477. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockFormatRows(System.Boolean)">
  6478. Enable or disable Formatting rows locking.
  6479. This does not modify sheet protection status.
  6480. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  6481. </member>
  6482. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockInsertColumns(System.Boolean)">
  6483. Enable or disable Inserting columns locking.
  6484. This does not modify sheet protection status.
  6485. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  6486. </member>
  6487. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockInsertHyperlinks(System.Boolean)">
  6488. Enable or disable Inserting hyperlinks locking.
  6489. This does not modify sheet protection status.
  6490. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  6491. </member>
  6492. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockInsertRows(System.Boolean)">
  6493. Enable or disable Inserting rows locking.
  6494. This does not modify sheet protection status.
  6495. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  6496. </member>
  6497. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockPivotTables(System.Boolean)">
  6498. Enable or disable Pivot Tables locking.
  6499. This does not modify sheet protection status.
  6500. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  6501. </member>
  6502. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockSort(System.Boolean)">
  6503. Enable or disable Sort locking.
  6504. This does not modify sheet protection status.
  6505. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  6506. </member>
  6507. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockObjects(System.Boolean)">
  6508. Enable or disable Objects locking.
  6509. This does not modify sheet protection status.
  6510. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  6511. </member>
  6512. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockScenarios(System.Boolean)">
  6513. Enable or disable Scenarios locking.
  6514. This does not modify sheet protection status.
  6515. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  6516. </member>
  6517. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockSelectLockedCells(System.Boolean)">
  6518. Enable or disable Selection of locked cells locking.
  6519. This does not modify sheet protection status.
  6520. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  6521. </member>
  6522. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.LockSelectUnlockedCells(System.Boolean)">
  6523. Enable or disable Selection of unlocked cells locking.
  6524. This does not modify sheet protection status.
  6525. To enforce this un-/locking, call {@link #disableLocking()} or {@link #enableLocking()}
  6526. </member>
  6527. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetCellRange(NPOI.SS.Util.CellRangeAddress)">
  6528. Also Creates cells if they don't exist
  6529. </member>
  6530. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreateTable">
  6531. Creates a new Table, and associates it with this Sheet
  6532. </member>
  6533. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetTables">
  6534. Returns any tables associated with this Sheet
  6535. </member>
  6536. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.SetTabColor(System.Int32)">
  6537. Set background color of the sheet tab
  6538. @param colorIndex the indexed color to set, must be a constant from {@link IndexedColors}
  6539. </member>
  6540. <member name="P:NPOI.XSSF.UserModel.XSSFSheet.TabColor">
  6541. <summary>
  6542. Get or set background color of the sheet tab.
  6543. The value is null if no sheet tab color is set.
  6544. </summary>
  6545. </member>
  6546. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreatePivotTable">
  6547. Creates an empty XSSFPivotTable and Sets up all its relationships
  6548. including: pivotCacheDefInition, pivotCacheRecords
  6549. @return returns a pivotTable
  6550. </member>
  6551. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreatePivotTable(NPOI.SS.Util.AreaReference,NPOI.SS.Util.CellReference,NPOI.SS.UserModel.ISheet)">
  6552. Create a pivot table using the AreaReference range on sourceSheet, at the given position.
  6553. If the source reference contains a sheet name, it must match the sourceSheet
  6554. @param source location of pivot data
  6555. @param position A reference to the top left cell where the pivot table will start
  6556. @param sourceSheet The sheet containing the source data, if the source reference doesn't contain a sheet name
  6557. @throws IllegalArgumentException if source references a sheet different than sourceSheet
  6558. @return The pivot table
  6559. </member>
  6560. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreatePivotTable(NPOI.SS.Util.CellReference,NPOI.SS.UserModel.ISheet,NPOI.XSSF.UserModel.XSSFPivotTable.IPivotTableReferenceConfigurator)">
  6561. Create a pivot table using the AreaReference or named/table range on sourceSheet, at the given position.
  6562. If the source reference contains a sheet name, it must match the sourceSheet.
  6563. @param sourceRef location of pivot data - mutually exclusive with SourceName
  6564. @param sourceName range or table name for pivot data - mutually exclusive with SourceRef
  6565. @param position A reference to the top left cell where the pivot table will start
  6566. @param sourceSheet The sheet containing the source data, if the source reference doesn't contain a sheet name
  6567. @throws IllegalArgumentException if source references a sheet different than sourceSheet
  6568. @return The pivot table
  6569. </member>
  6570. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreatePivotTable(NPOI.SS.Util.AreaReference,NPOI.SS.Util.CellReference)">
  6571. Create a pivot table using the AreaReference range, at the given position.
  6572. If the source reference contains a sheet name, that sheet is used, otherwise this sheet is assumed as the source sheet.
  6573. @param source location of pivot data
  6574. @param position A reference to the top left cell where the pivot table will start
  6575. @return The pivot table
  6576. </member>
  6577. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreatePivotTable(NPOI.SS.UserModel.IName,NPOI.SS.Util.CellReference,NPOI.SS.UserModel.ISheet)">
  6578. Create a pivot table using the Name range reference on sourceSheet, at the given position.
  6579. If the source reference contains a sheet name, it must match the sourceSheet
  6580. @param source location of pivot data
  6581. @param position A reference to the top left cell where the pivot table will start
  6582. @param sourceSheet The sheet containing the source data, if the source reference doesn't contain a sheet name
  6583. @ if source references a sheet different than sourceSheet
  6584. @return The pivot table
  6585. </member>
  6586. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreatePivotTable(NPOI.SS.UserModel.IName,NPOI.SS.Util.CellReference)">
  6587. Create a pivot table using the Name range, at the given position.
  6588. If the source reference contains a sheet name, that sheet is used, otherwise this sheet is assumed as the source sheet.
  6589. @param source location of pivot data
  6590. @param position A reference to the top left cell where the pivot table will start
  6591. @return The pivot table
  6592. </member>
  6593. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.CreatePivotTable(NPOI.SS.UserModel.ITable,NPOI.SS.Util.CellReference)">
  6594. Create a pivot table using the Table, at the given position.
  6595. Tables are required to have a sheet reference, so no additional logic around reference sheet is needed.
  6596. @param source location of pivot data
  6597. @param position A reference to the top left cell where the pivot table will start
  6598. @return The pivot table
  6599. </member>
  6600. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetPivotTables">
  6601. Returns all the pivot tables for this Sheet
  6602. </member>
  6603. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AddIgnoredErrors(NPOI.SS.Util.CellReference,NPOI.SS.UserModel.IgnoredErrorType[])">
  6604. Add ignored errors (usually to suppress them in the UI of a consuming
  6605. application).
  6606. @param cell Cell.
  6607. @param ignoredErrorTypes Types of error to ignore there.
  6608. </member>
  6609. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.AddIgnoredErrors(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.IgnoredErrorType[])">
  6610. Ignore errors across a range of cells.
  6611. @param region Range of cells.
  6612. @param ignoredErrorTypes Types of error to ignore there.
  6613. </member>
  6614. <member name="M:NPOI.XSSF.UserModel.XSSFSheet.GetIgnoredErrors">
  6615. Returns the errors currently being ignored and the ranges
  6616. where they are ignored.
  6617. @return Map of error type to the range(s) where they are ignored.
  6618. </member>
  6619. <member name="T:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting">
  6620. XSSF Conditional Formattings
  6621. </member>
  6622. <member name="F:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.CF_EXT_2009_NS_X14">
  6623. Office 2010 Conditional Formatting extensions namespace
  6624. </member>
  6625. <member name="M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.ComparisonOperator,System.String,System.String)">
  6626. A factory method allowing to create a conditional formatting rule
  6627. with a cell comparison operator<p/>
  6628. TODO - formulas Containing cell references are currently not Parsed properly
  6629. @param comparisonOperation - a constant value from
  6630. <tt>{@link NPOI.hssf.record.CFRuleRecord.ComparisonOperator}</tt>: <p>
  6631. <ul>
  6632. <li>BETWEEN</li>
  6633. <li>NOT_BETWEEN</li>
  6634. <li>EQUAL</li>
  6635. <li>NOT_EQUAL</li>
  6636. <li>GT</li>
  6637. <li>LT</li>
  6638. <li>GE</li>
  6639. <li>LE</li>
  6640. </ul>
  6641. </p>
  6642. @param formula1 - formula for the valued, Compared with the cell
  6643. @param formula2 - second formula (only used with
  6644. {@link NPOI.ss.usermodel.ComparisonOperator#BETWEEN}) and
  6645. {@link NPOI.ss.usermodel.ComparisonOperator#NOT_BETWEEN} operations)
  6646. </member>
  6647. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.CreateConditionalFormattingRule(System.String)" -->
  6648. <member name="M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.IconSet)">
  6649. A factory method allowing the creation of conditional formatting
  6650. rules using an Icon Set / Multi-State formatting.
  6651. The thresholds for it will be created, but will be empty
  6652. and require configuring with
  6653. {@link XSSFConditionalFormattingRule#getMultiStateFormatting()}
  6654. then
  6655. {@link XSSFIconMultiStateFormatting#getThresholds()}
  6656. </member>
  6657. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.XSSF.UserModel.XSSFColor)" -->
  6658. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.CreateConditionalFormattingColorScaleRule" -->
  6659. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.UserModel.IConditionalFormatting)" -->
  6660. <member name="M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.GetConditionalFormattingAt(System.Int32)">
  6661. Gets Conditional Formatting object at a particular index
  6662. @param index
  6663. of the Conditional Formatting object to fetch
  6664. @return Conditional Formatting object
  6665. </member>
  6666. <member name="P:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.NumConditionalFormattings">
  6667. @return number of Conditional Formatting objects of the sheet
  6668. </member>
  6669. <member name="M:NPOI.XSSF.UserModel.XSSFSheetConditionalFormatting.RemoveConditionalFormatting(System.Int32)">
  6670. Removes a Conditional Formatting object by index
  6671. @param index of a Conditional Formatting object to remove
  6672. </member>
  6673. <member name="T:NPOI.XSSF.UserModel.XSSFSimpleShape">
  6674. Represents a shape with a predefined geometry in a SpreadsheetML Drawing.
  6675. Possible shape types are defined in {@link NPOI.SS.UserModel.ShapeTypes}
  6676. </member>
  6677. <member name="F:NPOI.XSSF.UserModel.XSSFSimpleShape._paragraphs">
  6678. List of the paragraphs that make up the text in this shape
  6679. </member>
  6680. <member name="F:NPOI.XSSF.UserModel.XSSFSimpleShape.prototype">
  6681. A default instance of CTShape used for creating new shapes.
  6682. </member>
  6683. <member name="F:NPOI.XSSF.UserModel.XSSFSimpleShape.ctShape">
  6684. Xml bean that stores properties of this shape
  6685. </member>
  6686. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.Prototype">
  6687. Prototype with the default structure of a new auto-shape.
  6688. </member>
  6689. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.Text">
  6690. Returns the text from all paragraphs in the shape. Paragraphs are Separated by new lines.
  6691. @return text Contained within this shape or empty string
  6692. </member>
  6693. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.ProcessAutoNumGroup(System.Int32,System.Int32,System.Collections.Generic.List{System.Int32},System.Text.StringBuilder)">
  6694. </member>
  6695. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.GetBulletPrefix(NPOI.XSSF.UserModel.ListAutoNumber,System.Int32)">
  6696. Returns a string Containing an appropriate prefix for an auto-numbering bullet
  6697. @param scheme the auto-numbering scheme used by the bullet
  6698. @param value the value of the bullet
  6699. @return appropriate prefix for an auto-numbering bullet
  6700. </member>
  6701. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.valueToAlpha(System.Int32)">
  6702. Convert an integer to its alpha equivalent e.g. 1 = A, 2 = B, 27 = AA etc
  6703. </member>
  6704. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.valueToRoman(System.Int32)">
  6705. Convert an integer to its roman equivalent e.g. 1 = I, 9 = IX etc
  6706. </member>
  6707. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.ClearText">
  6708. Clear all text from this shape
  6709. </member>
  6710. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.SetText(System.String)">
  6711. Set a single paragraph of text on the shape. Note this will replace all existing paragraphs Created on the shape.
  6712. @param text string representing the paragraph text
  6713. </member>
  6714. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.SetText(NPOI.XSSF.UserModel.XSSFRichTextString)">
  6715. Set a single paragraph of text on the shape. Note this will replace all existing paragraphs Created on the shape.
  6716. @param str rich text string representing the paragraph text
  6717. </member>
  6718. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.TextParagraphs">
  6719. Returns a collection of the XSSFTextParagraphs that are attached to this shape
  6720. @return text paragraphs in this shape
  6721. </member>
  6722. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.AddNewTextParagraph">
  6723. Add a new paragraph run to this shape
  6724. @return Created paragraph run
  6725. </member>
  6726. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.AddNewTextParagraph(System.String)">
  6727. Add a new paragraph run to this shape, Set to the provided string
  6728. @return Created paragraph run
  6729. </member>
  6730. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.AddNewTextParagraph(NPOI.XSSF.UserModel.XSSFRichTextString)">
  6731. Add a new paragraph run to this shape, Set to the provided rich text string
  6732. @return Created paragraph run
  6733. </member>
  6734. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.TextHorizontalOverflow">
  6735. Returns the type of horizontal overflow for the text.
  6736. @return the type of horizontal overflow
  6737. </member>
  6738. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.TextVerticalOverflow">
  6739. Returns the type of vertical overflow for the text.
  6740. @return the type of vertical overflow
  6741. </member>
  6742. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.VerticalAlignment">
  6743. Returns the type of vertical alignment for the text within the shape.
  6744. @return the type of vertical alignment
  6745. </member>
  6746. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.TextDirection">
  6747. Gets the vertical orientation of the text
  6748. @return vertical orientation of the text
  6749. </member>
  6750. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.BottomInset">
  6751. Returns the distance (in points) between the bottom of the text frame
  6752. and the bottom of the inscribed rectangle of the shape that Contains the text.
  6753. @return the bottom inset in points
  6754. </member>
  6755. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.LeftInset">
  6756. Returns the distance (in points) between the left edge of the text frame
  6757. and the left edge of the inscribed rectangle of the shape that Contains
  6758. the text.
  6759. @return the left inset in points
  6760. </member>
  6761. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.RightInset">
  6762. Returns the distance (in points) between the right edge of the
  6763. text frame and the right edge of the inscribed rectangle of the shape
  6764. that Contains the text.
  6765. @return the right inset in points
  6766. </member>
  6767. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.TopInset">
  6768. Returns the distance (in points) between the top of the text frame
  6769. and the top of the inscribed rectangle of the shape that Contains the text.
  6770. @return the top inset in points
  6771. </member>
  6772. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.WordWrap">
  6773. @return whether to wrap words within the bounding rectangle
  6774. </member>
  6775. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.TextAutofit">
  6776. Specifies that a shape should be auto-fit to fully contain the text described within it.
  6777. Auto-fitting is when text within a shape is scaled in order to contain all the text inside
  6778. @param value type of autofit
  6779. @return type of autofit
  6780. </member>
  6781. <member name="P:NPOI.XSSF.UserModel.XSSFSimpleShape.ShapeType">
  6782. Gets the shape type, one of the constants defined in {@link NPOI.SS.UserModel.ShapeTypes}.
  6783. @return the shape type
  6784. @see NPOI.SS.UserModel.ShapeTypes
  6785. </member>
  6786. <member name="M:NPOI.XSSF.UserModel.XSSFSimpleShape.ApplyAttributes(NPOI.OpenXmlFormats.Spreadsheet.CT_RPrElt,NPOI.OpenXmlFormats.Dml.CT_TextCharacterProperties)">
  6787. org.Openxmlformats.schemas.spreadsheetml.x2006.main.CTRPrElt to
  6788. org.Openxmlformats.schemas.Drawingml.x2006.main.CTFont adapter
  6789. </member>
  6790. <member name="T:NPOI.XSSF.UserModel.XSSFTable">
  6791. This class : the Table Part (Open Office XML Part 4:
  6792. chapter 3.5.1)
  6793. This implementation works under the assumption that a table Contains mappings to a subtree of an XML.
  6794. The root element of this subtree an occur multiple times (one for each row of the table). The child nodes
  6795. of the root element can be only attributes or element with maxOccurs=1 property set
  6796. @author Roberto Manicardi
  6797. </member>
  6798. <member name="M:NPOI.XSSF.UserModel.XSSFTable.MapsTo(System.Int64)">
  6799. Checks if this Table element Contains even a single mapping to the map identified by id
  6800. @param id the XSSFMap ID
  6801. @return true if the Table element contain mappings
  6802. </member>
  6803. <member name="M:NPOI.XSSF.UserModel.XSSFTable.GetCommonXpath">
  6804. Calculates the xpath of the root element for the table. This will be the common part
  6805. of all the mapping's xpaths
  6806. @return the xpath of the table's root element
  6807. </member>
  6808. <member name="M:NPOI.XSSF.UserModel.XSSFTable.GetXmlColumnPrs">
  6809. Note this list is static - once read, it does not notice later changes to the underlying column structures
  6810. @return List of XSSFXmlColumnPr
  6811. </member>
  6812. <member name="P:NPOI.XSSF.UserModel.XSSFTable.Name">
  6813. @return the name of the Table, if set
  6814. </member>
  6815. <member name="P:NPOI.XSSF.UserModel.XSSFTable.DisplayName">
  6816. @return the display name of the Table, if set
  6817. </member>
  6818. <member name="P:NPOI.XSSF.UserModel.XSSFTable.NumberOfMappedColumns">
  6819. @return the number of mapped table columns (see Open Office XML Part 4: chapter 3.5.1.4)
  6820. </member>
  6821. <member name="P:NPOI.XSSF.UserModel.XSSFTable.StartCellReference">
  6822. @return The reference for the cell in the top-left part of the table
  6823. (see Open Office XML Part 4: chapter 3.5.1.2, attribute ref)
  6824. To synchronize with changes to the underlying CTTable,
  6825. call {@link #updateReferences()}.
  6826. </member>
  6827. <member name="P:NPOI.XSSF.UserModel.XSSFTable.EndCellReference">
  6828. @return The reference for the cell in the bottom-right part of the table
  6829. (see Open Office XML Part 4: chapter 3.5.1.2, attribute ref)
  6830. Does not track updates to underlying changes to CTTable
  6831. To synchronize with changes to the underlying CTTable,
  6832. call {@link #updateReferences()}.
  6833. </member>
  6834. <member name="M:NPOI.XSSF.UserModel.XSSFTable.SetCellReferences">
  6835. @since POI 3.15 beta 3
  6836. </member>
  6837. <member name="M:NPOI.XSSF.UserModel.XSSFTable.UpdateReferences">
  6838. Clears the cached values set by {@link #getStartCellReference()}
  6839. and {@link #getEndCellReference()}.
  6840. The next call to {@link #getStartCellReference()} and
  6841. {@link #getEndCellReference()} will synchronize the
  6842. cell references with the underlying <code>CTTable</code>.
  6843. Thus, {@link #updateReferences()} is inexpensive.
  6844. @since POI 3.15 beta 3
  6845. </member>
  6846. <member name="P:NPOI.XSSF.UserModel.XSSFTable.RowCount">
  6847. @return the total number of rows in the selection. (Note: in this version autofiltering is ignored)
  6848. Returns 0 if the start or end cell references are not set.
  6849. To synchronize with changes to the underlying CTTable,
  6850. call {@link #updateReferences()}.
  6851. </member>
  6852. <member name="M:NPOI.XSSF.UserModel.XSSFTable.UpdateHeaders">
  6853. Synchronize table headers with cell values in the parent sheet.
  6854. Headers <em>must</em> be in sync, otherwise Excel will display a
  6855. "Found unreadable content" message on startup.
  6856. If calling both {@link #updateReferences()} and
  6857. {@link #updateHeaders()}, {@link #updateReferences()}
  6858. should be called first.
  6859. </member>
  6860. <member name="M:NPOI.XSSF.UserModel.XSSFTable.FindColumnIndex(System.String)">
  6861. Gets the relative column index of a column in this table having the header name <code>column</code>.
  6862. The column index is relative to the left-most column in the table, 0-indexed.
  6863. Returns <code>-1</code> if <code>column</code> is not a header name in table.
  6864. Column Header names are case-insensitive
  6865. Note: this function caches column names for performance. To flush the cache (because columns
  6866. have been moved or column headers have been changed), {@link #updateHeaders()} must be called.
  6867. @since 3.15 beta 2
  6868. </member>
  6869. <member name="T:NPOI.XSSF.UserModel.XSSFTextBox">
  6870. Represents a text box in a SpreadsheetML Drawing.
  6871. @author Yegor Kozlov
  6872. </member>
  6873. <member name="T:NPOI.XSSF.UserModel.XSSFTextParagraph">
  6874. Represents a paragraph of text within the Containing text body.
  6875. The paragraph is the highest level text separation mechanism.
  6876. </member>
  6877. <member name="M:NPOI.XSSF.UserModel.XSSFTextParagraph.AddNewTextRun">
  6878. Add a new run of text
  6879. @return a new run of text
  6880. </member>
  6881. <member name="M:NPOI.XSSF.UserModel.XSSFTextParagraph.AddLineBreak">
  6882. Insert a line break
  6883. @return text run representing this line break ('\n')
  6884. </member>
  6885. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.TextAlign">
  6886. get or set the alignment that is to be applied to the paragraph.
  6887. Possible values for this include left, right, centered, justified and distributed,
  6888. If this attribute is omitted, then a value of left is implied.
  6889. @return alignment that is applied to the paragraph
  6890. </member>
  6891. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.TextFontAlign">
  6892. Determines where vertically on a line of text the actual words are positioned. This deals
  6893. with vertical placement of the characters with respect to the baselines. For instance
  6894. having text anchored to the top baseline, anchored to the bottom baseline, centered in
  6895. between, etc.
  6896. If this attribute is omitted, then a value of baseline is implied.
  6897. @return alignment that is applied to the paragraph
  6898. </member>
  6899. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.BulletFont">
  6900. @return the font to be used on bullet characters within a given paragraph
  6901. </member>
  6902. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.BulletCharacter">
  6903. @return the character to be used in place of the standard bullet point
  6904. </member>
  6905. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.BulletFontColor">
  6906. @return the color of bullet characters within a given paragraph.
  6907. A <code>null</code> value means to use the text font color.
  6908. </member>
  6909. <!-- Badly formed XML comment ignored for member "P:NPOI.XSSF.UserModel.XSSFTextParagraph.BulletFontSize" -->
  6910. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.Indent">
  6911. @return the indent applied to the first line of text in the paragraph.
  6912. </member>
  6913. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.LeftMargin">
  6914. Specifies the left margin of the paragraph. This is specified in Addition to the text body
  6915. inset and applies only to this text paragraph. That is the text body inset and the LeftMargin
  6916. attributes are Additive with respect to the text position.
  6917. @param value the left margin of the paragraph, -1 to clear the margin and use the default of 0.
  6918. </member>
  6919. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.RightMargin">
  6920. Specifies the right margin of the paragraph. This is specified in Addition to the text body
  6921. inset and applies only to this text paragraph. That is the text body inset and the marR
  6922. attributes are Additive with respect to the text position.
  6923. @param value the right margin of the paragraph, -1 to clear the margin and use the default of 0.
  6924. </member>
  6925. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.DefaultTabSize">
  6926. @return the default size for a tab character within this paragraph in points
  6927. </member>
  6928. <member name="M:NPOI.XSSF.UserModel.XSSFTextParagraph.AddTabStop(System.Double)">
  6929. Add a single tab stop to be used on a line of text when there are one or more tab characters
  6930. present within the text.
  6931. @param value the position of the tab stop relative to the left margin
  6932. </member>
  6933. <!-- Badly formed XML comment ignored for member "P:NPOI.XSSF.UserModel.XSSFTextParagraph.LineSpacing" -->
  6934. <!-- Badly formed XML comment ignored for member "P:NPOI.XSSF.UserModel.XSSFTextParagraph.SpaceBefore" -->
  6935. <!-- Badly formed XML comment ignored for member "P:NPOI.XSSF.UserModel.XSSFTextParagraph.SpaceAfter" -->
  6936. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.Level">
  6937. Specifies the particular level text properties that this paragraph will follow.
  6938. The value for this attribute formats the text according to the corresponding level
  6939. paragraph properties defined in the list of styles associated with the body of text
  6940. that this paragraph belongs to (therefore in the parent shape).
  6941. <p>
  6942. Note that the closest properties object to the text is used, therefore if there is
  6943. a conflict between the text paragraph properties and the list style properties for
  6944. this level then the text paragraph properties will take precedence.
  6945. </p>
  6946. Returns the level of text properties that this paragraph will follow.
  6947. @return the text level of this paragraph (0-based). Default is 0.
  6948. </member>
  6949. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.IsBullet">
  6950. Returns whether this paragraph has bullets
  6951. </member>
  6952. <member name="M:NPOI.XSSF.UserModel.XSSFTextParagraph.SetBullet(System.Boolean)">
  6953. Set or unset this paragraph as a bullet point
  6954. @param flag whether text in this paragraph has bullets
  6955. </member>
  6956. <member name="M:NPOI.XSSF.UserModel.XSSFTextParagraph.SetBullet(NPOI.XSSF.UserModel.ListAutoNumber,System.Int32)">
  6957. Set this paragraph as an automatic numbered bullet point
  6958. @param scheme type of auto-numbering
  6959. @param startAt the number that will start number for a given sequence of automatically
  6960. numbered bullets (1-based).
  6961. </member>
  6962. <member name="M:NPOI.XSSF.UserModel.XSSFTextParagraph.SetBullet(NPOI.XSSF.UserModel.ListAutoNumber)">
  6963. Set this paragraph as an automatic numbered bullet point
  6964. @param scheme type of auto-numbering
  6965. </member>
  6966. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.IsBulletAutoNumber">
  6967. Returns whether this paragraph has automatic numbered bullets
  6968. </member>
  6969. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.BulletAutoNumberStart">
  6970. Returns the starting number if this paragraph has automatic numbered bullets, otherwise returns 0
  6971. </member>
  6972. <member name="P:NPOI.XSSF.UserModel.XSSFTextParagraph.BulletAutoNumberScheme">
  6973. Returns the auto number scheme if this paragraph has automatic numbered bullets, otherwise returns ListAutoNumber.ARABIC_PLAIN
  6974. </member>
  6975. <member name="T:NPOI.XSSF.UserModel.XSSFTextRun">
  6976. Represents a run of text within the Containing text body. The run element is the
  6977. lowest level text separation mechanism within a text body.
  6978. </member>
  6979. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.FontSize">
  6980. @return font size in points or -1 if font size is not Set.
  6981. </member>
  6982. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.CharacterSpacing">
  6983. @return the spacing between characters within a text Run,
  6984. If this attribute is omitted then a value of 0 or no adjustment is assumed.
  6985. </member>
  6986. <member name="M:NPOI.XSSF.UserModel.XSSFTextRun.SetFont(System.String)">
  6987. Specifies the typeface, or name of the font that is to be used for this text Run.
  6988. @param typeface the font to apply to this text Run.
  6989. The value of <code>null</code> unsets the Typeface attribute from the underlying xml.
  6990. </member>
  6991. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.FontFamily">
  6992. @return font family or null if not Set
  6993. </member>
  6994. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.IsStrikethrough">
  6995. get or set whether a run of text will be formatted as strikethrough text. Default is false.
  6996. </member>
  6997. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.IsSuperscript">
  6998. get or set whether a run of text will be formatted as a superscript text. Default is false.
  6999. Default base line offset is 30%
  7000. </member>
  7001. <member name="M:NPOI.XSSF.UserModel.XSSFTextRun.SetBaselineOffset(System.Double)">
  7002. Set the baseline for both the superscript and subscript fonts.
  7003. <p>
  7004. The size is specified using a percentage.
  7005. Positive values indicate superscript, negative values indicate subscript.
  7006. </p>
  7007. @param baselineOffset
  7008. </member>
  7009. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.IsSubscript">
  7010. get or set whether a run of text will be formatted as a superscript text. Default is false.
  7011. Default base line offset is -25%.
  7012. </member>
  7013. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.TextCap">
  7014. @return whether a run of text will be formatted as a superscript text. Default is false.
  7015. </member>
  7016. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.IsBold">
  7017. get or set whether this run of text is formatted as bold text
  7018. </member>
  7019. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.IsItalic">
  7020. get or set whether this run of text is formatted as italic text
  7021. </member>
  7022. <member name="P:NPOI.XSSF.UserModel.XSSFTextRun.IsUnderline">
  7023. get or set whether this run of text is formatted as underlined text
  7024. </member>
  7025. <member name="M:NPOI.XSSF.UserModel.XSSFVBAPart.#ctor">
  7026. Create a new XSSFVBAPart node
  7027. </member>
  7028. <member name="M:NPOI.XSSF.UserModel.XSSFVBAPart.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  7029. Construct XSSFVBAPart from a package part
  7030. @param part the package part holding the VBA data,
  7031. @param rel the package relationship holding this part
  7032. </member>
  7033. <member name="M:NPOI.XSSF.UserModel.XSSFVBAPart.PrepareForCommit">
  7034. Like *PictureData, VBA objects store the actual content in the part
  7035. directly without keeping a copy like all others therefore we need to
  7036. handle them differently.
  7037. </member>
  7038. <member name="T:NPOI.XSSF.UserModel.XSSFVMLDrawing">
  7039. Represents a SpreadsheetML VML Drawing.
  7040. <p>
  7041. In Excel 2007 VML Drawings are used to describe properties of cell comments,
  7042. although the spec says that VML is deprecated:
  7043. </p>
  7044. <p>
  7045. The VML format is a legacy format originally introduced with Office 2000 and is included and fully defined
  7046. in this Standard for backwards compatibility reasons. The DrawingML format is a newer and richer format
  7047. Created with the goal of eventually replacing any uses of VML in the Office Open XML formats. VML should be
  7048. considered a deprecated format included in Office Open XML for legacy reasons only and new applications that
  7049. need a file format for Drawings are strongly encouraged to use preferentially DrawingML
  7050. </p>
  7051. <p>
  7052. Warning - Excel is known to Put invalid XML into these files!
  7053. For example, &gt;br&lt; without being closed or escaped crops up.
  7054. </p>
  7055. See 6.4 VML - SpreadsheetML Drawing in Office Open XML Part 4 - Markup Language Reference.pdf
  7056. @author Yegor Kozlov
  7057. </member>
  7058. <member name="F:NPOI.XSSF.UserModel.XSSFVMLDrawing.ptrn_shapeId">
  7059. regexp to parse shape ids, in VML they have weird form of id="_x0000_s1026"
  7060. </member>
  7061. <member name="M:NPOI.XSSF.UserModel.XSSFVMLDrawing.#ctor">
  7062. Create a new SpreadsheetML Drawing
  7063. @see XSSFSheet#CreateDrawingPatriarch()
  7064. </member>
  7065. <member name="M:NPOI.XSSF.UserModel.XSSFVMLDrawing.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  7066. Construct a SpreadsheetML Drawing from a namespace part
  7067. @param part the namespace part holding the Drawing data,
  7068. the content type must be <code>application/vnd.Openxmlformats-officedocument.Drawing+xml</code>
  7069. @param rel the namespace relationship holding this Drawing,
  7070. the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/drawing
  7071. </member>
  7072. <member name="M:NPOI.XSSF.UserModel.XSSFVMLDrawing.newDrawing">
  7073. Initialize a new Speadsheet VML Drawing
  7074. </member>
  7075. <member name="M:NPOI.XSSF.UserModel.XSSFVMLDrawing.FindCommentShape(System.Int32,System.Int32)">
  7076. Find a shape with ClientData of type "NOTE" and the specified row and column
  7077. @return the comment shape or <code>null</code>
  7078. </member>
  7079. <member name="T:NPOI.XSSF.UserModel.XSSFWorkbook">
  7080. High level representation of a SpreadsheetML workbook. This is the first object most users
  7081. will construct whether they are Reading or writing a workbook. It is also the
  7082. top level object for creating new sheets/etc.
  7083. </member>
  7084. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.DEFAULT_CHARACTER_WIDTH">
  7085. Width of one character of the default font in pixels. Same for Calibry and Arial.
  7086. </member>
  7087. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.Max_SENSITIVE_SHEET_NAME_LEN">
  7088. Excel silently tRuncates long sheet names to 31 chars.
  7089. This constant is used to ensure uniqueness in the first 31 chars
  7090. </member>
  7091. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_EMF">
  7092. Extended windows meta file
  7093. </member>
  7094. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_WMF">
  7095. Windows Meta File
  7096. </member>
  7097. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_PICT">
  7098. Mac PICT format
  7099. </member>
  7100. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_JPEG">
  7101. JPEG format
  7102. </member>
  7103. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_PNG">
  7104. PNG format
  7105. </member>
  7106. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_DIB">
  7107. Device independent bitmap
  7108. </member>
  7109. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.PICTURE_TYPE_GIF">
  7110. Images formats supported by XSSF but not by HSSF
  7111. </member>
  7112. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.workbook">
  7113. The underlying XML bean
  7114. </member>
  7115. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.sheets">
  7116. this holds the XSSFSheet objects attached to this workbook
  7117. </member>
  7118. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.namedRangesByName">
  7119. this holds the XSSFName objects attached to this workbook, keyed by lower-case name
  7120. </member>
  7121. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.namedRanges">
  7122. this holds the XSSFName objects attached to this workbook
  7123. </member>
  7124. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.sharedStringSource">
  7125. shared string table - a cache of strings in this workbook
  7126. </member>
  7127. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.stylesSource">
  7128. A collection of shared objects used for styling content,
  7129. e.g. fonts, cell styles, colors, etc.
  7130. </member>
  7131. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook._udfFinder">
  7132. The locator of user-defined functions.
  7133. By default includes functions from the Excel Analysis Toolpack
  7134. </member>
  7135. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.calcChain">
  7136. TODO
  7137. </member>
  7138. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.externalLinks">
  7139. External Links, for referencing names or cells in other workbooks.
  7140. </member>
  7141. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.mapInfo">
  7142. A collection of custom XML mappings
  7143. </member>
  7144. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.formatter">
  7145. Used to keep track of the data formatter so that all
  7146. CreateDataFormatter calls return the same one for a given
  7147. book. This ensures that updates from one places is visible
  7148. someplace else.
  7149. </member>
  7150. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook._missingCellPolicy">
  7151. The policy to apply in the event of missing or
  7152. blank cells when fetching from a row.
  7153. See {@link NPOI.ss.usermodel.Row.MissingCellPolicy}
  7154. </member>
  7155. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.pictures">
  7156. array of pictures for this workbook
  7157. </member>
  7158. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook._creationHelper">
  7159. cached instance of XSSFCreationHelper for this workbook
  7160. @see {@link #getCreationHelper()}
  7161. </member>
  7162. <member name="F:NPOI.XSSF.UserModel.XSSFWorkbook.pivotTables">
  7163. List of all pivot tables in workbook
  7164. </member>
  7165. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor">
  7166. Create a new SpreadsheetML workbook.
  7167. </member>
  7168. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor(NPOI.XSSF.UserModel.XSSFWorkbookType)">
  7169. Create a new SpreadsheetML workbook.
  7170. @param workbookType The type of workbook to make (.xlsx or .xlsm).
  7171. </member>
  7172. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage)">
  7173. Constructs a XSSFWorkbook object given a OpenXML4J <code>Package</code> object,
  7174. see <a href="http://poi.apache.org/oxml4j/">http://poi.apache.org/oxml4j/</a>.
  7175. Once you have finished working with the Workbook, you should close the package
  7176. by calling pkg.close, to avoid leaving file handles open.
  7177. Creating a XSSFWorkbook from a file-backed OPC Package has a lower memory
  7178. footprint than an InputStream backed one.
  7179. @param pkg the OpenXML4J <code>OPC Package</code> object.
  7180. </member>
  7181. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor(System.IO.Stream)">
  7182. Constructs a XSSFWorkbook object, by buffering the whole stream into memory
  7183. and then opening an {@link OPCPackage} object for it.
  7184. Using an {@link InputStream} requires more memory than using a File, so
  7185. if a {@link File} is available then you should instead do something like
  7186. <pre><code>
  7187. OPCPackage pkg = OPCPackage.open(path);
  7188. XSSFWorkbook wb = new XSSFWorkbook(pkg);
  7189. // work with the wb object
  7190. ......
  7191. pkg.close(); // gracefully closes the underlying zip file
  7192. </code></pre>
  7193. </member>
  7194. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor(System.IO.FileInfo)" -->
  7195. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFWorkbook.#ctor(System.String)" -->
  7196. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.ParseSheet(System.Collections.Generic.Dictionary{System.String,NPOI.XSSF.UserModel.XSSFSheet},NPOI.OpenXmlFormats.Spreadsheet.CT_Sheet)">
  7197. Not normally to be called externally, but possibly to be overridden to avoid
  7198. the DOM based parse of large sheets (see examples).
  7199. </member>
  7200. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.OnWorkbookCreate">
  7201. Create a new CT_Workbook with all values Set to default
  7202. </member>
  7203. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.newPackage(NPOI.XSSF.UserModel.XSSFWorkbookType)">
  7204. Create a new SpreadsheetML namespace and Setup the default minimal content
  7205. </member>
  7206. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCTWorkbook">
  7207. Return the underlying XML bean
  7208. @return the underlying CT_Workbook bean
  7209. </member>
  7210. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.AddPicture(System.Byte[],System.Int32)">
  7211. Adds a picture to the workbook.
  7212. @param pictureData The bytes of the picture
  7213. @param format The format of the picture.
  7214. @return the index to this picture (0 based), the Added picture can be obtained from {@link #getAllPictures()} .
  7215. @see Workbook#PICTURE_TYPE_EMF
  7216. @see Workbook#PICTURE_TYPE_WMF
  7217. @see Workbook#PICTURE_TYPE_PICT
  7218. @see Workbook#PICTURE_TYPE_JPEG
  7219. @see Workbook#PICTURE_TYPE_PNG
  7220. @see Workbook#PICTURE_TYPE_DIB
  7221. @see #getAllPictures()
  7222. </member>
  7223. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.AddPicture(System.IO.Stream,System.Int32)">
  7224. Adds a picture to the workbook.
  7225. @param is The sream to read image from
  7226. @param format The format of the picture.
  7227. @return the index to this picture (0 based), the Added picture can be obtained from {@link #getAllPictures()} .
  7228. @see Workbook#PICTURE_TYPE_EMF
  7229. @see Workbook#PICTURE_TYPE_WMF
  7230. @see Workbook#PICTURE_TYPE_PICT
  7231. @see Workbook#PICTURE_TYPE_JPEG
  7232. @see Workbook#PICTURE_TYPE_PNG
  7233. @see Workbook#PICTURE_TYPE_DIB
  7234. @see #getAllPictures()
  7235. </member>
  7236. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CloneSheet(System.Int32)">
  7237. Create an XSSFSheet from an existing sheet in the XSSFWorkbook.
  7238. The Cloned sheet is a deep copy of the original.
  7239. @param sheetNum The index of the sheet to clone
  7240. @return XSSFSheet representing the Cloned sheet.
  7241. @throws ArgumentException if the sheet index in invalid
  7242. @throws POIXMLException if there were errors when cloning
  7243. </member>
  7244. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CloneSheet(System.Int32,System.String)">
  7245. Create an XSSFSheet from an existing sheet in the XSSFWorkbook.
  7246. The cloned sheet is a deep copy of the original but with a new given
  7247. name.
  7248. @param sheetNum The index of the sheet to clone
  7249. @param newName The name to set for the newly created sheet
  7250. @return XSSFSheet representing the cloned sheet.
  7251. @throws IllegalArgumentException if the sheet index or the sheet
  7252. name is invalid
  7253. @throws POIXMLException if there were errors when cloning
  7254. </member>
  7255. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.AddRelation(NPOI.POIXMLDocumentPart.RelationPart,NPOI.POIXMLDocumentPart)">
  7256. @since 3.14-Beta1
  7257. </member>
  7258. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetUniqueSheetName(System.String)">
  7259. Generate a valid sheet name based on the existing one. Used when cloning sheets.
  7260. @param srcName the original sheet name to
  7261. @return clone sheet name
  7262. </member>
  7263. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateCellStyle">
  7264. <summary>
  7265. Create a new XSSFCellStyle and add it to the workbook's style table
  7266. </summary>
  7267. <returns>the new XSSFCellStyle object</returns>
  7268. </member>
  7269. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateDataFormat">
  7270. <summary>
  7271. Returns the workbook's data format table (a factory for creating data format strings).
  7272. </summary>
  7273. <returns>the XSSFDataFormat object</returns>
  7274. </member>
  7275. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateFont">
  7276. <summary>
  7277. Create a new Font and add it to the workbook's font table
  7278. </summary>
  7279. <returns></returns>
  7280. </member>
  7281. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateSheet">
  7282. Create an XSSFSheet for this workbook, Adds it to the sheets and returns
  7283. the high level representation. Use this to create new sheets.
  7284. @return XSSFSheet representing the new sheet.
  7285. </member>
  7286. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateSheet(System.String)">
  7287. Create a new sheet for this Workbook and return the high level representation.
  7288. Use this to create new sheets.
  7289. <p>
  7290. Note that Excel allows sheet names up to 31 chars in length but other applications
  7291. (such as OpenOffice) allow more. Some versions of Excel crash with names longer than 31 chars,
  7292. others - tRuncate such names to 31 character.
  7293. </p>
  7294. <p>
  7295. POI's SpreadsheetAPI silently tRuncates the input argument to 31 characters.
  7296. Example:
  7297. <pre><code>
  7298. Sheet sheet = workbook.CreateSheet("My very long sheet name which is longer than 31 chars"); // will be tRuncated
  7299. assert 31 == sheet.SheetName.Length;
  7300. assert "My very long sheet name which i" == sheet.SheetName;
  7301. </code></pre>
  7302. </p>
  7303. Except the 31-character constraint, Excel applies some other rules:
  7304. <p>
  7305. Sheet name MUST be unique in the workbook and MUST NOT contain the any of the following characters:
  7306. <ul>
  7307. <li> 0x0000 </li>
  7308. <li> 0x0003 </li>
  7309. <li> colon (:) </li>
  7310. <li> backslash (\) </li>
  7311. <li> asterisk (*) </li>
  7312. <li> question mark (?) </li>
  7313. <li> forward slash (/) </li>
  7314. <li> opening square bracket ([) </li>
  7315. <li> closing square bracket (]) </li>
  7316. </ul>
  7317. The string MUST NOT begin or end with the single quote (') character.
  7318. </p>
  7319. <p>
  7320. See {@link org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)}
  7321. for a safe way to create valid names
  7322. </p>
  7323. @param sheetname sheetname to set for the sheet.
  7324. @return Sheet representing the new sheet.
  7325. @throws IllegalArgumentException if the name is null or invalid
  7326. or workbook already contains a sheet with this name
  7327. @see org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)
  7328. </member>
  7329. <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)">
  7330. Finds a font that matches the one with the supplied attributes
  7331. </member>
  7332. <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)">
  7333. Finds a font that matches the one with the supplied attributes
  7334. </member>
  7335. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.ActiveSheetIndex">
  7336. Convenience method to Get the active sheet. The active sheet is is the sheet
  7337. which is currently displayed when the workbook is viewed in Excel.
  7338. 'Selected' sheet(s) is a distinct concept.
  7339. </member>
  7340. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetAllPictures">
  7341. Gets all pictures from the Workbook.
  7342. @return the list of pictures (a list of {@link XSSFPictureData} objects.)
  7343. @see #AddPicture(byte[], int)
  7344. </member>
  7345. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCellStyleAt(System.Int32)">
  7346. Get the cell style object at the given index
  7347. @param idx index within the set of styles
  7348. @return XSSFCellStyle object at the index
  7349. </member>
  7350. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetFontAt(System.Int16)">
  7351. Get the font at the given index number
  7352. @param idx index number
  7353. @return XSSFFont at the index
  7354. </member>
  7355. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetName(System.String)">
  7356. <summary>
  7357. Get the first named range with the given name.
  7358. Note: names of named ranges are not unique as they are scoped by sheet.
  7359. {@link #getNames(String name)} returns all named ranges with the given name.
  7360. </summary>
  7361. <param name="name">named range name</param>
  7362. <returns>return XSSFName with the given name. <code>null</code> is returned no named range could be found.</returns>
  7363. </member>
  7364. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetNames(System.String)">
  7365. <summary>
  7366. Get the named ranges with the given name.
  7367. <i>Note:</i>Excel named ranges are case-insensitive and
  7368. this method performs a case-insensitive search.
  7369. </summary>
  7370. <param name="name">named range name</param>
  7371. <returns>return list of XSSFNames with the given name. An empty list if no named ranges could be found</returns>
  7372. </member>
  7373. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetAllNames">
  7374. <summary>
  7375. Get a list of all the named ranges in the workbook.
  7376. </summary>
  7377. <returns>return list of XSSFNames in the workbook</returns>
  7378. </member>
  7379. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetNameIndex(System.String)">
  7380. Gets the named range index by his name
  7381. <i>Note:</i>Excel named ranges are case-insensitive and
  7382. this method performs a case-insensitive search.
  7383. @param name named range name
  7384. @return named range index
  7385. </member>
  7386. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.NumCellStyles">
  7387. Get the number of styles the workbook Contains
  7388. @return count of cell styles
  7389. </member>
  7390. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.NumberOfFonts">
  7391. Get the number of fonts in the this workbook
  7392. @return number of fonts
  7393. </member>
  7394. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.NumberOfNames">
  7395. Get the number of named ranges in the this workbook
  7396. @return number of named ranges
  7397. </member>
  7398. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.NumberOfSheets">
  7399. Get the number of worksheets in the this workbook
  7400. @return number of worksheets
  7401. </member>
  7402. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetPrintArea(System.Int32)">
  7403. Retrieves the reference for the printarea of the specified sheet, the sheet name is Appended to the reference even if it was not specified.
  7404. @param sheetIndex Zero-based sheet index (0 Represents the first sheet to keep consistent with java)
  7405. @return String Null if no print area has been defined
  7406. </member>
  7407. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheet(System.String)">
  7408. Get sheet with the given name (case insensitive match)
  7409. @param name of the sheet
  7410. @return XSSFSheet with the name provided or <code>null</code> if it does not exist
  7411. </member>
  7412. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheetAt(System.Int32)" -->
  7413. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheetIndex(System.String)">
  7414. <summary>
  7415. Returns the index of the sheet by his name (case insensitive match)
  7416. </summary>
  7417. <param name="name">the sheet name</param>
  7418. <returns>index of the sheet (0 based) or -1 if not found</returns>
  7419. </member>
  7420. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheetIndex(NPOI.SS.UserModel.ISheet)">
  7421. Returns the index of the given sheet
  7422. @param sheet the sheet to look up
  7423. @return index of the sheet (0 based). <tt>-1</tt> if not found
  7424. </member>
  7425. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSheetName(System.Int32)">
  7426. Get the sheet name
  7427. @param sheetIx Number
  7428. @return Sheet name
  7429. </member>
  7430. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetEnumerator">
  7431. Allows foreach loops:
  7432. <pre><code>
  7433. XSSFWorkbook wb = new XSSFWorkbook(package);
  7434. for(XSSFSheet sheet : wb){
  7435. }
  7436. </code></pre>
  7437. </member>
  7438. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsMacroEnabled">
  7439. Are we a normal workbook (.xlsx), or a
  7440. macro enabled workbook (.xlsm)?
  7441. </member>
  7442. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.RemoveName(NPOI.SS.UserModel.IName)">
  7443. As {@link #removeName(String)} is not necessarily unique
  7444. (name + sheet index is unique), this method is more accurate.
  7445. @param name the name to remove.
  7446. </member>
  7447. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.RemovePrintArea(System.Int32)">
  7448. Delete the printarea for the sheet specified
  7449. @param sheetIndex 0-based sheet index (0 = First Sheet)
  7450. </member>
  7451. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.RemoveSheetAt(System.Int32)">
  7452. Removes sheet at the given index.<p/>
  7453. Care must be taken if the Removed sheet is the currently active or only selected sheet in
  7454. the workbook. There are a few situations when Excel must have a selection and/or active
  7455. sheet. (For example when printing - see Bug 40414).<br/>
  7456. This method Makes sure that if the Removed sheet was active, another sheet will become
  7457. active in its place. Furthermore, if the Removed sheet was the only selected sheet, another
  7458. sheet will become selected. The newly active/selected sheet will have the same index, or
  7459. one less if the Removed sheet was the last in the workbook.
  7460. @param index of the sheet (0-based)
  7461. </member>
  7462. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.OnSheetDelete(System.Int32)">
  7463. Gracefully remove references to the sheet being deleted
  7464. @param index the 0-based index of the sheet to delete
  7465. </member>
  7466. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.MissingCellPolicy">
  7467. Retrieves the current policy on what to do when
  7468. Getting missing or blank cells from a row.
  7469. The default is to return blank and null cells.
  7470. {@link MissingCellPolicy}
  7471. </member>
  7472. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.ValidateSheetIndex(System.Int32)">
  7473. Validate sheet index
  7474. @param index the index to validate
  7475. @throws ArgumentException if the index is out of range (index
  7476. &lt; 0 || index &gt;= NumberOfSheets).
  7477. </member>
  7478. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.FirstVisibleTab">
  7479. Gets the first tab that is displayed in the list of tabs in excel.
  7480. @return integer that Contains the index to the active sheet in this book view.
  7481. </member>
  7482. <!-- Badly formed XML comment ignored for member "M:NPOI.XSSF.UserModel.XSSFWorkbook.SetPrintArea(System.Int32,System.String)" -->
  7483. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetPrintArea(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  7484. For the Convenience of Java Programmers maintaining pointers.
  7485. @see #setPrintArea(int, String)
  7486. @param sheetIndex Zero-based sheet index (0 = First Sheet)
  7487. @param startColumn Column to begin printarea
  7488. @param endColumn Column to end the printarea
  7489. @param startRow Row to begin the printarea
  7490. @param endRow Row to end the printarea
  7491. </member>
  7492. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.CreateBuiltInName(System.String,System.Int32)">
  7493. Generates a NameRecord to represent a built-in region
  7494. @return a new NameRecord
  7495. @throws ArgumentException if sheetNumber is invalid
  7496. @throws POIXMLException if such a name already exists in the workbook
  7497. </member>
  7498. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSelectedTab(System.Int32)">
  7499. We only Set one sheet as selected for compatibility with HSSF.
  7500. </member>
  7501. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetName(System.Int32,System.String)">
  7502. Set the sheet name.
  7503. @param sheetIndex sheet number (0 based)
  7504. @param sheetname the new sheet name
  7505. @throws ArgumentException if the name is null or invalid
  7506. or workbook already Contains a sheet with this name
  7507. @see {@link #CreateSheet(String)}
  7508. @see {@link NPOI.ss.util.WorkbookUtil#CreateSafeSheetName(String nameProposal)}
  7509. for a safe way to create valid names
  7510. </member>
  7511. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetOrder(System.String,System.Int32)">
  7512. Sets the order of appearance for a given sheet.
  7513. @param sheetname the name of the sheet to reorder
  7514. @param pos the position that we want to insert the sheet into (0 based)
  7515. </member>
  7516. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SaveNamedRanges">
  7517. marshal named ranges from the {@link #namedRanges} collection to the underlying CT_Workbook bean
  7518. </member>
  7519. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.Write(System.IO.Stream,System.Boolean)">
  7520. <summary>
  7521. Write the document to the specified stream, and optionally leave the stream open without closing it.
  7522. </summary>
  7523. </member>
  7524. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetSharedStringSource">
  7525. Returns SharedStringsTable - the cache of strings for this workbook
  7526. @return the shared string table
  7527. </member>
  7528. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetStylesSource">
  7529. Return a object representing a collection of shared objects used for styling content,
  7530. e.g. fonts, cell styles, colors, etc.
  7531. </member>
  7532. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetTheme">
  7533. Returns the Theme of current workbook.
  7534. </member>
  7535. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCreationHelper">
  7536. Returns an object that handles instantiating concrete
  7537. classes of the various instances for XSSF.
  7538. </member>
  7539. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.ContainsSheet(System.String,System.Int32)">
  7540. Determines whether a workbook Contains the provided sheet name.
  7541. For the purpose of comparison, long names are tRuncated to 31 chars.
  7542. @param name the name to Test (case insensitive match)
  7543. @param excludeSheetIdx the sheet to exclude from the check or -1 to include all sheets in the Check.
  7544. @return true if the sheet Contains the name, false otherwise.
  7545. </member>
  7546. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsDate1904">
  7547. <summary>
  7548. Gets a bool value that indicates whether the date systems used in the workbook starts in 1904.
  7549. The default value is false, meaning that the workbook uses the 1900 date system,
  7550. where 1/1/1900 is the first day in the system.
  7551. </summary>
  7552. <returns>True if the date systems used in the workbook starts in 1904</returns>
  7553. </member>
  7554. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetAllEmbedds">
  7555. Get the document's embedded files.
  7556. </member>
  7557. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsSheetHidden(System.Int32)">
  7558. Check whether a sheet is hidden.
  7559. <p>
  7560. Note that a sheet could instead be Set to be very hidden, which is different
  7561. ({@link #isSheetVeryHidden(int)})
  7562. </p>
  7563. @param sheetIx Number
  7564. @return <code>true</code> if sheet is hidden
  7565. </member>
  7566. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsSheetVeryHidden(System.Int32)">
  7567. Check whether a sheet is very hidden.
  7568. <p>
  7569. This is different from the normal hidden status
  7570. ({@link #isSheetHidden(int)})
  7571. </p>
  7572. @param sheetIx sheet index to check
  7573. @return <code>true</code> if sheet is very hidden
  7574. </member>
  7575. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetHidden(System.Int32,System.Boolean)">
  7576. Sets the visible state of this sheet.
  7577. <p>
  7578. Calling <code>setSheetHidden(sheetIndex, true)</code> is equivalent to
  7579. <code>setSheetHidden(sheetIndex, Workbook.SHEET_STATE_HIDDEN)</code>.
  7580. <br/>
  7581. Calling <code>setSheetHidden(sheetIndex, false)</code> is equivalent to
  7582. <code>setSheetHidden(sheetIndex, Workbook.SHEET_STATE_VISIBLE)</code>.
  7583. </p>
  7584. @param sheetIx the 0-based index of the sheet
  7585. @param hidden whether this sheet is hidden
  7586. @see #setSheetHidden(int, int)
  7587. </member>
  7588. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetHidden(System.Int32,NPOI.SS.UserModel.SheetState)">
  7589. Hide or unhide a sheet.
  7590. <ul>
  7591. <li>0 - visible. </li>
  7592. <li>1 - hidden. </li>
  7593. <li>2 - very hidden.</li>
  7594. </ul>
  7595. @param sheetIx the sheet index (0-based)
  7596. @param state one of the following <code>Workbook</code> constants:
  7597. <code>Workbook.SHEET_STATE_VISIBLE</code>,
  7598. <code>Workbook.SHEET_STATE_HIDDEN</code>, or
  7599. <code>Workbook.SHEET_STATE_VERY_HIDDEN</code>.
  7600. @throws ArgumentException if the supplied sheet index or state is invalid
  7601. </member>
  7602. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetSheetHidden(System.Int32,System.Int32)">
  7603. <summary>
  7604. Hide or unhide a sheet.
  7605. </summary>
  7606. <param name="sheetIx">The sheet number</param>
  7607. <param name="hidden">0 for not hidden, 1 for hidden, 2 for very hidden</param>
  7608. </member>
  7609. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.OnDeleteFormula(NPOI.XSSF.UserModel.XSSFCell)">
  7610. Fired when a formula is deleted from this workbook,
  7611. for example when calling cell.SetCellFormula(null)
  7612. @see XSSFCell#setCellFormula(String)
  7613. </member>
  7614. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCalculationChain">
  7615. Return the CalculationChain object for this workbook
  7616. <p>
  7617. The calculation chain object specifies the order in which the cells in a workbook were last calculated
  7618. </p>
  7619. @return the <code>CalculationChain</code> object or <code>null</code> if not defined
  7620. </member>
  7621. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.ExternalLinksTable">
  7622. * Returns the list of {@link ExternalLinksTable} object for this workbook
  7623. *
  7624. * <p>The external links table specifies details of named ranges etc
  7625. * that are referenced from other workbooks, along with the last seen
  7626. * values of what they point to.</p>
  7627. *
  7628. * <p>Note that Excel uses index 0 for the current workbook, so the first
  7629. * External Links in a formula would be '[1]Foo' which corresponds to
  7630. * entry 0 in this list.</p>
  7631. * @return the <code>ExternalLinksTable</code> list, which may be empty
  7632. </member>
  7633. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetCustomXMLMappings">
  7634. @return a collection of custom XML mappings defined in this workbook
  7635. </member>
  7636. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetMapInfo">
  7637. @return the helper class used to query the custom XML mapping defined in this workbook
  7638. </member>
  7639. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.LinkExternalWorkbook(System.String,NPOI.SS.UserModel.IWorkbook)">
  7640. Adds the External Link Table part and relations required to allow formulas
  7641. referencing the specified external workbook to be added to this one. Allows
  7642. formulas such as "[MyOtherWorkbook.xlsx]Sheet3!$A$5" to be added to the
  7643. file, for workbooks not already linked / referenced.
  7644. @param name The name the workbook will be referenced as in formulas
  7645. @param workbook The open workbook to fetch the link required information from
  7646. </member>
  7647. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsStructureLocked">
  7648. Specifies a bool value that indicates whether structure of workbook is locked. <br/>
  7649. A value true indicates the structure of the workbook is locked. Worksheets in the workbook can't be Moved,
  7650. deleted, hidden, unhidden, or Renamed, and new worksheets can't be inserted.<br/>
  7651. A value of false indicates the structure of the workbook is not locked.<br/>
  7652. @return true if structure of workbook is locked
  7653. </member>
  7654. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsWindowsLocked">
  7655. Specifies a bool value that indicates whether the windows that comprise the workbook are locked. <br/>
  7656. A value of true indicates the workbook windows are locked. Windows are the same size and position each time the
  7657. workbook is opened.<br/>
  7658. A value of false indicates the workbook windows are not locked.
  7659. @return true if windows that comprise the workbook are locked
  7660. </member>
  7661. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.IsRevisionLocked">
  7662. Specifies a bool value that indicates whether the workbook is locked for revisions.
  7663. @return true if the workbook is locked for revisions.
  7664. </member>
  7665. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.LockStructure">
  7666. Locks the structure of workbook.
  7667. </member>
  7668. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.UnlockStructure">
  7669. Unlocks the structure of workbook.
  7670. </member>
  7671. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.LockWindows">
  7672. Locks the windows that comprise the workbook.
  7673. </member>
  7674. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.UnlockWindows">
  7675. Unlocks the windows that comprise the workbook.
  7676. </member>
  7677. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.LockRevision">
  7678. Locks the workbook for revisions.
  7679. </member>
  7680. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.UnlockRevision">
  7681. Unlocks the workbook for revisions.
  7682. </member>
  7683. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.RemovePivotTables">
  7684. Remove Pivot Tables and PivotCaches from the workbooka
  7685. </member>
  7686. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetUDFFinder">
  7687. Returns the locator of user-defined functions.
  7688. <p>
  7689. The default instance : the built-in functions with the Excel Analysis Tool Pack.
  7690. To Set / Evaluate custom functions you need to register them as follows:
  7691. </p>
  7692. @return wrapped instance of UDFFinder that allows seeking functions both by index and name
  7693. </member>
  7694. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.AddToolPack(NPOI.SS.Formula.UDF.UDFFinder)">
  7695. Register a new toolpack in this workbook.
  7696. @param toopack the toolpack to register
  7697. </member>
  7698. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetForceFormulaRecalculation(System.Boolean)">
  7699. Whether the application shall perform a full recalculation when the workbook is opened.
  7700. <p>
  7701. Typically you want to force formula recalculation when you modify cell formulas or values
  7702. of a workbook previously Created by Excel. When Set to true, this flag will tell Excel
  7703. that it needs to recalculate all formulas in the workbook the next time the file is opened.
  7704. </p>
  7705. <p>
  7706. Note, that recalculation updates cached formula results and, thus, modifies the workbook.
  7707. Depending on the version, Excel may prompt you with "Do you want to save the Changes in <em>filename</em>?"
  7708. on close.
  7709. </p>
  7710. @param value true if the application will perform a full recalculation of
  7711. workbook values when the workbook is opened
  7712. @since 3.8
  7713. </member>
  7714. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetForceFormulaRecalculation">
  7715. Whether Excel will be asked to recalculate all formulas when the workbook is opened.
  7716. @since 3.8
  7717. </member>
  7718. <member name="P:NPOI.XSSF.UserModel.XSSFWorkbook.SpreadsheetVersion">
  7719. <summary>
  7720. Returns the spreadsheet version (EXCLE2007) of this workbook
  7721. </summary>
  7722. </member>
  7723. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.GetTable(System.String)">
  7724. Returns the data table with the given name (case insensitive).
  7725. @param name the data table name (case-insensitive)
  7726. @return The Data table in the workbook named <tt>name</tt>, or <tt>null</tt> if no table is named <tt>name</tt>.
  7727. @since 3.15 beta 2
  7728. </member>
  7729. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.AddPivotCache(System.String)">
  7730. Add pivotCache to the workbook
  7731. </member>
  7732. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetVBAProject(System.IO.Stream)">
  7733. Adds a vbaProject.bin file to the workbook. This will change the workbook
  7734. type if necessary.
  7735. @throws IOException
  7736. </member>
  7737. <member name="M:NPOI.XSSF.UserModel.XSSFWorkbook.SetVBAProject(NPOI.XSSF.UserModel.XSSFWorkbook)">
  7738. Adds a vbaProject.bin file taken from another, given workbook to this one.
  7739. @throws IOException
  7740. @throws InvalidFormatException
  7741. </member>
  7742. <member name="T:NPOI.XSSF.Util.EvilUnclosedBRFixingInputStream">
  7743. This is a seriously sick fix for the fact that some .xlsx
  7744. files contain raw bits of HTML, without being escaped
  7745. or properly turned into XML.
  7746. The result is that they contain things like &gt;br&lt;,
  7747. which breaks the XML parsing.
  7748. This very sick InputStream wrapper attempts to spot
  7749. these go past, and fix them.
  7750. Only works for UTF-8 and US-ASCII based streams!
  7751. It should only be used where experience Shows the problem
  7752. can occur...
  7753. </member>
  7754. <member name="M:NPOI.XSSF.Util.EvilUnclosedBRFixingInputStream.Read">
  7755. Warning - doesn't fix!
  7756. </member>
  7757. <member name="M:NPOI.XSSF.Util.EvilUnclosedBRFixingInputStream.ReadFromSpare(System.Byte[],System.Int32,System.Int32)">
  7758. Reads into the buffer from the spare bytes
  7759. </member>
  7760. <member name="T:NPOI.XSSF.XLSBUnsupportedException">
  7761. We don't support .xlsb files, sorry
  7762. </member>
  7763. <member name="T:NPOI.XWPF.Extractor.XWPFWordExtractor">
  7764. Helper class to extract text from an OOXML Word file
  7765. </member>
  7766. <member name="M:NPOI.XWPF.Extractor.XWPFWordExtractor.SetFetchHyperlinks(System.Boolean)">
  7767. Should we also fetch the hyperlinks, when fetching
  7768. the text content? Default is to only output the
  7769. hyperlink label, and not the contents
  7770. </member>
  7771. <member name="T:NPOI.XWPF.Model.XMLParagraph">
  7772. Base class for XWPF paragraphs
  7773. @author Yury Batrakov (batrakov at gmail.com)
  7774. </member>
  7775. <member name="T:NPOI.XWPF.Model.XWPFCommentsDecorator">
  7776. Decorator class for XWPFParagraph allowing to add comments
  7777. found in paragraph to its text
  7778. @author Yury Batrakov (batrakov at gmail.com)
  7779. </member>
  7780. <member name="T:NPOI.XWPF.Model.XWPFHeaderFooterPolicy">
  7781. A .docx file can have no headers/footers, the same header/footer
  7782. on each page, odd/even page footers, and optionally also
  7783. a different header/footer on the first page.
  7784. This class handles sorting out what there is, and giving you
  7785. the right headers and footers for the document.
  7786. </member>
  7787. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.#ctor(NPOI.XWPF.UserModel.XWPFDocument)">
  7788. Figures out the policy for the given document,
  7789. and Creates any header and footer objects
  7790. as required.
  7791. </member>
  7792. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.#ctor(NPOI.XWPF.UserModel.XWPFDocument,NPOI.OpenXmlFormats.Wordprocessing.CT_SectPr)">
  7793. Figures out the policy for the given document,
  7794. and Creates any header and footer objects
  7795. as required.
  7796. </member>
  7797. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.buildHdrFtr(System.String,NPOI.XWPF.UserModel.XWPFParagraph[],NPOI.XWPF.UserModel.XWPFHeaderFooter)">
  7798. MB 24 May 2010. Created this overloaded buildHdrFtr() method because testing demonstrated
  7799. that the XWPFFooter or XWPFHeader object returned by calls to the CreateHeader(int, XWPFParagraph[])
  7800. and CreateFooter(int, XWPFParagraph[]) methods or the GetXXXXXHeader/Footer methods where
  7801. headers or footers had been Added to a document since it had been Created/opened, returned
  7802. an object that Contained no XWPFParagraph objects even if the header/footer itself did contain
  7803. text. The reason was that this line of code; CTHdrFtr ftr = CTHdrFtr.Factory.NewInstance();
  7804. Created a brand new instance of the CTHDRFtr class which was then populated with data when
  7805. it should have recovered the CTHdrFtr object encapsulated within the XWPFHeaderFooter object
  7806. that had previoulsy been instantiated in the CreateHeader(int, XWPFParagraph[]) or
  7807. CreateFooter(int, XWPFParagraph[]) methods.
  7808. </member>
  7809. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.GetOddPageHeader">
  7810. Returns the odd page header. This is
  7811. also the same as the default one...
  7812. </member>
  7813. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.GetOddPageFooter">
  7814. Returns the odd page footer. This is
  7815. also the same as the default one...
  7816. </member>
  7817. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.GetHeader(System.Int32)">
  7818. Get the header that applies to the given
  7819. (1 based) page.
  7820. @param pageNumber The one based page number
  7821. </member>
  7822. <member name="M:NPOI.XWPF.Model.XWPFHeaderFooterPolicy.GetFooter(System.Int32)">
  7823. Get the footer that applies to the given
  7824. (1 based) page.
  7825. @param pageNumber The one based page number
  7826. </member>
  7827. <member name="T:NPOI.XWPF.Model.XWPFParagraphDecorator">
  7828. Base decorator class for XWPFParagraph
  7829. </member>
  7830. <member name="T:NPOI.XWPF.UserModel.AbstractXWPFSDT">
  7831. Experimental abstract class that is a base for XWPFSDT and XWPFSDTCell
  7832. <p/>
  7833. WARNING - APIs expected to change rapidly.
  7834. <p/>
  7835. These classes have so far been built only for Read-only Processing.
  7836. </member>
  7837. <member name="M:NPOI.XWPF.UserModel.AbstractXWPFSDT.GetTitle">
  7838. @return first SDT Title
  7839. </member>
  7840. <member name="M:NPOI.XWPF.UserModel.AbstractXWPFSDT.GetTag">
  7841. @return first SDT Tag
  7842. </member>
  7843. <member name="P:NPOI.XWPF.UserModel.AbstractXWPFSDT.Content">
  7844. @return the content object
  7845. </member>
  7846. <member name="M:NPOI.XWPF.UserModel.AbstractXWPFSDT.GetBody">
  7847. @return null
  7848. </member>
  7849. <member name="M:NPOI.XWPF.UserModel.AbstractXWPFSDT.GetPart">
  7850. @return document part
  7851. </member>
  7852. <member name="M:NPOI.XWPF.UserModel.AbstractXWPFSDT.GetPartType">
  7853. @return partType
  7854. </member>
  7855. <member name="M:NPOI.XWPF.UserModel.AbstractXWPFSDT.GetElementType">
  7856. @return element type
  7857. </member>
  7858. <member name="T:NPOI.XWPF.UserModel.BodyElementType">
  7859. <p>
  7860. 9 Jan 2010
  7861. </p>
  7862. <p>
  7863. // TODO insert Javadoc here!
  7864. </p>
  7865. @author epp
  7866. </member>
  7867. <member name="T:NPOI.XWPF.UserModel.BodyType">
  7868. The different kinds of {@link IBody} that exist
  7869. </member>
  7870. <member name="T:NPOI.XWPF.UserModel.Borders">
  7871. Specifies all types of borders which can be specified for WordProcessingML
  7872. objects which have a border. Borders can be Separated into two types:
  7873. <ul>
  7874. <li> Line borders: which specify a pattern to be used when Drawing a line around the
  7875. specified object.
  7876. </li>
  7877. <li> Art borders: which specify a repeated image to be used
  7878. when Drawing a border around the specified object. Line borders may be
  7879. specified on any object which allows a border, however, art borders may only
  7880. be used as a border at the page level - the borders under the pgBorders
  7881. element
  7882. </li>
  7883. </ul>
  7884. @author Gisella Bronzetti
  7885. </member>
  7886. <member name="F:NPOI.XWPF.UserModel.Borders.Single">
  7887. Specifies a line border consisting of a single line around the parent
  7888. object.
  7889. </member>
  7890. <member name="F:NPOI.XWPF.UserModel.Borders.Apples">
  7891. specifies an art border consisting of a repeated image of an apple
  7892. </member>
  7893. <member name="F:NPOI.XWPF.UserModel.Borders.ArchedScallops">
  7894. specifies an art border consisting of a repeated image of a shell pattern
  7895. </member>
  7896. <member name="F:NPOI.XWPF.UserModel.Borders.BabyPacifier">
  7897. specifies an art border consisting of a repeated image of a baby pacifier
  7898. </member>
  7899. <member name="F:NPOI.XWPF.UserModel.Borders.BabyRattle">
  7900. specifies an art border consisting of a repeated image of a baby rattle
  7901. </member>
  7902. <member name="F:NPOI.XWPF.UserModel.Borders.Balloons3Colors">
  7903. specifies an art border consisting of a repeated image of a set of
  7904. balloons
  7905. </member>
  7906. <member name="F:NPOI.XWPF.UserModel.Borders.BalloonsHotAir">
  7907. specifies an art border consisting of a repeated image of a hot air
  7908. balloon
  7909. </member>
  7910. <member name="F:NPOI.XWPF.UserModel.Borders.BasicBlackDashes">
  7911. specifies an art border consisting of a repeating image of a black and
  7912. white background.
  7913. </member>
  7914. <member name="F:NPOI.XWPF.UserModel.Borders.BasicBlackDots">
  7915. specifies an art border consisting of a repeating image of a black dot on
  7916. a white background.
  7917. </member>
  7918. <member name="F:NPOI.XWPF.UserModel.Borders.BasicBlackSquares">
  7919. specifies an art border consisting of a repeating image of a black and
  7920. white background
  7921. </member>
  7922. <member name="F:NPOI.XWPF.UserModel.Borders.BasicThinLines">
  7923. specifies an art border consisting of a repeating image of a black and
  7924. white background.
  7925. </member>
  7926. <member name="F:NPOI.XWPF.UserModel.Borders.BasicWhiteDashes">
  7927. specifies an art border consisting of a repeating image of a black and
  7928. white background.
  7929. </member>
  7930. <member name="F:NPOI.XWPF.UserModel.Borders.BasicWhiteDots">
  7931. specifies an art border consisting of a repeating image of a white dot on
  7932. a black background.
  7933. </member>
  7934. <member name="F:NPOI.XWPF.UserModel.Borders.BasicWhiteSquares">
  7935. specifies an art border consisting of a repeating image of a black and
  7936. white background.
  7937. </member>
  7938. <member name="F:NPOI.XWPF.UserModel.Borders.BasicWideInline">
  7939. specifies an art border consisting of a repeating image of a black and
  7940. white background.
  7941. </member>
  7942. <member name="F:NPOI.XWPF.UserModel.Borders.BasicWideMidline">
  7943. specifies an art border consisting of a repeating image of a black and
  7944. white background
  7945. </member>
  7946. <member name="F:NPOI.XWPF.UserModel.Borders.BasicWideOutline">
  7947. specifies an art border consisting of a repeating image of a black and
  7948. white background
  7949. </member>
  7950. <member name="F:NPOI.XWPF.UserModel.Borders.Bats">
  7951. specifies an art border consisting of a repeated image of bats
  7952. </member>
  7953. <member name="F:NPOI.XWPF.UserModel.Borders.Birds">
  7954. specifies an art border consisting of repeating images of birds
  7955. </member>
  7956. <member name="F:NPOI.XWPF.UserModel.Borders.BirdsFlight">
  7957. specifies an art border consisting of a repeated image of birds flying
  7958. </member>
  7959. <member name="F:NPOI.XWPF.UserModel.Borders.Cabins">
  7960. specifies an art border consisting of a repeated image of a cabin
  7961. </member>
  7962. <member name="F:NPOI.XWPF.UserModel.Borders.CakeSlice">
  7963. specifies an art border consisting of a repeated image of a piece of cake
  7964. </member>
  7965. <member name="F:NPOI.XWPF.UserModel.Borders.CandyCorn">
  7966. specifies an art border consisting of a repeated image of candy corn
  7967. </member>
  7968. <member name="F:NPOI.XWPF.UserModel.Borders.CelticKnotwork">
  7969. specifies an art border consisting of a repeated image of a knot work
  7970. pattern
  7971. </member>
  7972. <member name="F:NPOI.XWPF.UserModel.Borders.CertificateBanner">
  7973. specifies an art border consisting of a banner.
  7974. <p>
  7975. if the border is on the left or right, no border is displayed.
  7976. </p>
  7977. </member>
  7978. <member name="F:NPOI.XWPF.UserModel.Borders.ChainLink">
  7979. specifies an art border consisting of a repeating image of a chain link
  7980. pattern.
  7981. </member>
  7982. <member name="F:NPOI.XWPF.UserModel.Borders.ChampagneBottle">
  7983. specifies an art border consisting of a repeated image of a champagne
  7984. bottle
  7985. </member>
  7986. <member name="F:NPOI.XWPF.UserModel.Borders.CheckedBarBlack">
  7987. specifies an art border consisting of repeating images of a compass
  7988. </member>
  7989. <member name="F:NPOI.XWPF.UserModel.Borders.CheckedBarColor">
  7990. specifies an art border consisting of a repeating image of a colored
  7991. pattern.
  7992. </member>
  7993. <member name="F:NPOI.XWPF.UserModel.Borders.Checkered">
  7994. specifies an art border consisting of a repeated image of a checkerboard
  7995. </member>
  7996. <member name="F:NPOI.XWPF.UserModel.Borders.ChristmasTree">
  7997. specifies an art border consisting of a repeated image of a christmas
  7998. tree
  7999. </member>
  8000. <member name="F:NPOI.XWPF.UserModel.Borders.CirclesLines">
  8001. specifies an art border consisting of repeating images of lines and
  8002. circles
  8003. </member>
  8004. <member name="F:NPOI.XWPF.UserModel.Borders.CirclesRectangles">
  8005. specifies an art border consisting of a repeated image of a rectangular
  8006. pattern
  8007. </member>
  8008. <member name="F:NPOI.XWPF.UserModel.Borders.ClassicalWave">
  8009. specifies an art border consisting of a repeated image of a wave
  8010. </member>
  8011. <member name="F:NPOI.XWPF.UserModel.Borders.Clocks">
  8012. specifies an art border consisting of a repeated image of a clock
  8013. </member>
  8014. <member name="F:NPOI.XWPF.UserModel.Borders.Compass">
  8015. specifies an art border consisting of repeating images of a compass
  8016. </member>
  8017. <member name="F:NPOI.XWPF.UserModel.Borders.Confetti">
  8018. specifies an art border consisting of a repeated image of confetti
  8019. </member>
  8020. <member name="F:NPOI.XWPF.UserModel.Borders.ConfettiGrays">
  8021. specifies an art border consisting of a repeated image of confetti
  8022. </member>
  8023. <member name="F:NPOI.XWPF.UserModel.Borders.ConfettiOutline">
  8024. specifies an art border consisting of a repeated image of confetti
  8025. </member>
  8026. <member name="F:NPOI.XWPF.UserModel.Borders.ConfettiStreamers">
  8027. specifies an art border consisting of a repeated image of confetti
  8028. streamers
  8029. </member>
  8030. <member name="F:NPOI.XWPF.UserModel.Borders.ConfettiWhite">
  8031. specifies an art border consisting of a repeated image of confetti
  8032. </member>
  8033. <member name="F:NPOI.XWPF.UserModel.Borders.CornerTriangles">
  8034. specifies an art border consisting of a repeated image
  8035. </member>
  8036. <member name="F:NPOI.XWPF.UserModel.Borders.CouponCutoutDashes">
  8037. specifies an art border consisting of a dashed line
  8038. </member>
  8039. <member name="F:NPOI.XWPF.UserModel.Borders.CouponCutoutDots">
  8040. specifies an art border consisting of a dotted line
  8041. </member>
  8042. <member name="F:NPOI.XWPF.UserModel.Borders.CrazyMaze">
  8043. specifies an art border consisting of a repeated image of a maze-like
  8044. pattern
  8045. </member>
  8046. <member name="F:NPOI.XWPF.UserModel.Borders.CreaturesButterfly">
  8047. specifies an art border consisting of a repeated image of a butterfly
  8048. </member>
  8049. <member name="F:NPOI.XWPF.UserModel.Borders.CreaturesFish">
  8050. specifies an art border consisting of a repeated image of a fish
  8051. </member>
  8052. <member name="F:NPOI.XWPF.UserModel.Borders.CreaturesInsects">
  8053. specifies an art border consisting of repeating images of insects.
  8054. </member>
  8055. <member name="F:NPOI.XWPF.UserModel.Borders.CreaturesLadyBug">
  8056. specifies an art border consisting of a repeated image of a ladybug
  8057. </member>
  8058. <member name="F:NPOI.XWPF.UserModel.Borders.CrossStitch">
  8059. specifies an art border consisting of repeating images of a cross-stitch
  8060. pattern
  8061. </member>
  8062. <member name="F:NPOI.XWPF.UserModel.Borders.Cup">
  8063. specifies an art border consisting of a repeated image of cupid
  8064. </member>
  8065. <member name="T:NPOI.XWPF.UserModel.BreakClear">
  8066. Specifies the Set of possible restart locations which may be used as to
  8067. determine the next available line when a break's type attribute has a value
  8068. of textWrapping.
  8069. @author Gisella Bronzetti
  8070. </member>
  8071. <member name="F:NPOI.XWPF.UserModel.BreakClear.NONE">
  8072. Specifies that the text wrapping break shall advance the text to the next
  8073. line in the WordProcessingML document, regardless of its position left to
  8074. right or the presence of any floating objects which intersect with the
  8075. line,
  8076. This is the Setting for a typical line break in a document.
  8077. </member>
  8078. <member name="F:NPOI.XWPF.UserModel.BreakClear.LEFT">
  8079. Specifies that the text wrapping break shall behave as follows:
  8080. <ul>
  8081. <li> If this line is broken into multiple regions (a floating object in
  8082. the center of the page has text wrapping on both sides:
  8083. <ul>
  8084. <li> If this is the leftmost region of text flow on this line, advance
  8085. the text to the next position on the line </li>
  8086. <li>Otherwise, treat this as a text wrapping break of type all. </li>
  8087. </ul>
  8088. </li>
  8089. <li> If this line is not broken into multiple regions, then treat this
  8090. break as a text wrapping break of type none. </li>
  8091. </ul>
  8092. <li> If the parent paragraph is right to left, then these behaviors are
  8093. also reversed. </li>
  8094. </member>
  8095. <!-- Badly formed XML comment ignored for member "F:NPOI.XWPF.UserModel.BreakClear.RIGHT" -->
  8096. <member name="F:NPOI.XWPF.UserModel.BreakClear.ALL">
  8097. Specifies that the text wrapping break shall advance the text to the next
  8098. line in the WordProcessingML document which spans the full width of the
  8099. line.
  8100. </member>
  8101. <member name="T:NPOI.XWPF.UserModel.BreakType">
  8102. Specifies the possible types of break characters in a WordProcessingML
  8103. document.
  8104. The break type determines the next location where text shall be
  8105. placed After this manual break is applied to the text contents
  8106. @author Gisella Bronzetti
  8107. </member>
  8108. <member name="F:NPOI.XWPF.UserModel.BreakType.PAGE">
  8109. Specifies that the current break shall restart itself on the next page of
  8110. the document when the document is displayed in page view.
  8111. </member>
  8112. <member name="F:NPOI.XWPF.UserModel.BreakType.COLUMN">
  8113. Specifies that the current break shall restart itself on the next column
  8114. available on the current page when the document is displayed in page
  8115. view.
  8116. <p>
  8117. If the current section is not divided into columns, or the column break
  8118. occurs in the last column on the current page when displayed, then the
  8119. restart location for text shall be the next page in the document.
  8120. </p>
  8121. </member>
  8122. <member name="F:NPOI.XWPF.UserModel.BreakType.TEXTWRAPPING">
  8123. Specifies that the current break shall restart itself on the next line in
  8124. the document when the document is displayed in page view.
  8125. The determine of the next line shall be done subject to the value of the clear
  8126. attribute on the specified break character.
  8127. </member>
  8128. <member name="F:NPOI.XWPF.UserModel.PictureType.EMF">
  8129. Extended windows meta file
  8130. </member>
  8131. <member name="F:NPOI.XWPF.UserModel.PictureType.WMF">
  8132. Windows Meta File
  8133. </member>
  8134. <member name="F:NPOI.XWPF.UserModel.PictureType.PICT">
  8135. Mac PICT format
  8136. </member>
  8137. <member name="F:NPOI.XWPF.UserModel.PictureType.JPEG">
  8138. JPEG format
  8139. </member>
  8140. <member name="F:NPOI.XWPF.UserModel.PictureType.PNG">
  8141. PNG format
  8142. </member>
  8143. <member name="F:NPOI.XWPF.UserModel.PictureType.DIB">
  8144. Device independent bitmap
  8145. </member>
  8146. <member name="F:NPOI.XWPF.UserModel.PictureType.GIF">
  8147. GIF image format
  8148. </member>
  8149. <member name="F:NPOI.XWPF.UserModel.PictureType.TIFF">
  8150. Tag Image File (.tiff)
  8151. </member>
  8152. <member name="F:NPOI.XWPF.UserModel.PictureType.EPS">
  8153. Encapsulated Postscript (.eps)
  8154. </member>
  8155. <member name="F:NPOI.XWPF.UserModel.PictureType.BMP">
  8156. Windows Bitmap (.bmp)
  8157. </member>
  8158. <member name="F:NPOI.XWPF.UserModel.PictureType.WPG">
  8159. WordPerfect graphics (.wpg)
  8160. </member>
  8161. <member name="F:NPOI.XWPF.UserModel.PictureType.SVG">
  8162. Scalable Vector Graphics (.svg)
  8163. </member>
  8164. <member name="T:NPOI.XWPF.UserModel.IBody">
  8165. An IBody represents the different parts of the document which
  8166. can contain collections of Paragraphs and Tables. It provides a
  8167. common way to work with these and their contents.
  8168. Typically, this is something like a XWPFDocument, or one of
  8169. the parts in it like XWPFHeader, XWPFFooter, XWPFTableCell
  8170. </member>
  8171. <member name="P:NPOI.XWPF.UserModel.IBody.Part">
  8172. returns the Part, to which the body belongs, which you need for Adding relationship to other parts
  8173. Actually it is needed of the class XWPFTableCell. Because you have to know to which part the tableCell
  8174. belongs.
  8175. @return the Part, to which the body belongs
  8176. </member>
  8177. <member name="P:NPOI.XWPF.UserModel.IBody.PartType">
  8178. Get the PartType of the body, for example
  8179. DOCUMENT, HEADER, FOOTER, FOOTNOTE,
  8180. @return the PartType of the body
  8181. </member>
  8182. <member name="P:NPOI.XWPF.UserModel.IBody.BodyElements">
  8183. Returns an Iterator with paragraphs and tables,
  8184. in the order that they occur in the text.
  8185. </member>
  8186. <member name="P:NPOI.XWPF.UserModel.IBody.Paragraphs">
  8187. Returns the paragraph(s) that holds
  8188. the text of the header or footer.
  8189. </member>
  8190. <member name="P:NPOI.XWPF.UserModel.IBody.Tables">
  8191. Return the table(s) that holds the text
  8192. of the IBodyPart, for complex cases
  8193. where a paragraph isn't used.
  8194. </member>
  8195. <member name="M:NPOI.XWPF.UserModel.IBody.GetParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  8196. if there is a corresponding {@link XWPFParagraph} of the parameter ctTable in the paragraphList of this header or footer
  8197. the method will return this paragraph
  8198. if there is no corresponding {@link XWPFParagraph} the method will return null
  8199. @param p is instance of CTP and is searching for an XWPFParagraph
  8200. @return null if there is no XWPFParagraph with an corresponding CTPparagraph in the paragraphList of this header or footer
  8201. XWPFParagraph with the correspondig CTP p
  8202. </member>
  8203. <member name="M:NPOI.XWPF.UserModel.IBody.GetTable(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  8204. if there is a corresponding {@link XWPFTable} of the parameter ctTable in the tableList of this header
  8205. the method will return this table
  8206. if there is no corresponding {@link XWPFTable} the method will return null
  8207. @param ctTable
  8208. </member>
  8209. <member name="M:NPOI.XWPF.UserModel.IBody.GetParagraphArray(System.Int32)">
  8210. Returns the paragraph that of position pos
  8211. </member>
  8212. <member name="M:NPOI.XWPF.UserModel.IBody.GetTableArray(System.Int32)">
  8213. Returns the table at position pos
  8214. </member>
  8215. <member name="M:NPOI.XWPF.UserModel.IBody.InsertNewParagraph(System.Xml.XmlDocument)">
  8216. inserts a new paragraph at position of the cursor
  8217. @param cursor
  8218. </member>
  8219. <member name="M:NPOI.XWPF.UserModel.IBody.InsertNewTbl(System.Xml.XmlDocument)">
  8220. inserts a new Table at the cursor position.
  8221. @param cursor
  8222. </member>
  8223. <member name="M:NPOI.XWPF.UserModel.IBody.InsertTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  8224. inserts a new Table at position pos
  8225. @param pos
  8226. @param table
  8227. </member>
  8228. <member name="M:NPOI.XWPF.UserModel.IBody.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  8229. returns the TableCell to which the Table belongs
  8230. @param cell
  8231. </member>
  8232. <member name="M:NPOI.XWPF.UserModel.IBody.GetXWPFDocument">
  8233. Return XWPFDocument
  8234. </member>
  8235. <member name="T:NPOI.XWPF.UserModel.IBodyElement">
  8236. 9 Jan 2010
  8237. @author Philipp Epp
  8238. </member>
  8239. <!-- Badly formed XML comment ignored for member "T:NPOI.XWPF.UserModel.ICell" -->
  8240. <member name="T:NPOI.XWPF.UserModel.IRunBody">
  8241. Simple interface describing both {@link XWPFParagraph}
  8242. and {@link XWPFSDT}
  8243. </member>
  8244. <member name="T:NPOI.XWPF.UserModel.IRunElement">
  8245. Common interface for things that can occur
  8246. where a run (text with common stylings) can,
  8247. eg {@link XWPFRun} or {@link XWPFSDT}.
  8248. More methods to follow shortly!
  8249. </member>
  8250. <member name="T:NPOI.XWPF.UserModel.ISDTContent">
  8251. Experimental interface to offer rudimentary Read-only Processing of
  8252. of the contentblock of an SDT/ContentControl.
  8253. <p/>
  8254. <p/>
  8255. <p/>
  8256. WARNING - APIs expected to change rapidly
  8257. </member>
  8258. <member name="T:NPOI.XWPF.UserModel.ISDTContents">
  8259. Interface for anything that can be within an STD:
  8260. {@link XWPFRun}, {@link XWPFTable}, {@link XWPFParagraph},
  8261. {@link XWPFSDT} etc
  8262. </member>
  8263. <member name="T:NPOI.XWPF.UserModel.LineSpacingRule">
  8264. Specifies the logic which shall be used to calculate the line spacing of the
  8265. parent object when it is displayed in the document.
  8266. @author Gisella Bronzetti
  8267. </member>
  8268. <member name="F:NPOI.XWPF.UserModel.LineSpacingRule.AUTO">
  8269. Specifies that the line spacing of the parent object shall be
  8270. automatically determined by the size of its contents, with no
  8271. predetermined minimum or maximum size.
  8272. </member>
  8273. <member name="F:NPOI.XWPF.UserModel.LineSpacingRule.EXACT">
  8274. Specifies that the height of the line shall be exactly the value
  8275. specified, regardless of the size of the contents If the contents are too
  8276. large for the specified height, then they shall be clipped as necessary.
  8277. </member>
  8278. <member name="F:NPOI.XWPF.UserModel.LineSpacingRule.ATLEAST">
  8279. Specifies that the height of the line shall be at least the value
  8280. specified, but may be expanded to fit its content as needed.
  8281. </member>
  8282. <member name="T:NPOI.XWPF.UserModel.ParagraphAlignment">
  8283. Specifies all types of alignment which are available to be applied to objects in a
  8284. WordProcessingML document
  8285. @author Yegor Kozlov
  8286. </member>
  8287. <member name="T:NPOI.XWPF.UserModel.PositionInParagraph">
  8288. * postion of a character in a paragrapho
  8289. * 1st RunPositon
  8290. * 2nd TextPosition
  8291. * 3rd CharacterPosition
  8292. *
  8293. *
  8294. </member>
  8295. <member name="T:NPOI.XWPF.UserModel.TextAlignment">
  8296. Specifies all types of vertical alignment which are available to be applied to of all text
  8297. on each line displayed within a paragraph.
  8298. @author Gisella Bronzetti
  8299. </member>
  8300. <member name="F:NPOI.XWPF.UserModel.TextAlignment.TOP">
  8301. Specifies that all text in the parent object shall be
  8302. aligned to the top of each character when displayed
  8303. </member>
  8304. <member name="F:NPOI.XWPF.UserModel.TextAlignment.CENTER">
  8305. Specifies that all text in the parent object shall be
  8306. aligned to the center of each character when displayed.
  8307. </member>
  8308. <member name="F:NPOI.XWPF.UserModel.TextAlignment.BASELINE">
  8309. Specifies that all text in the parent object shall be
  8310. aligned to the baseline of each character when displayed.
  8311. </member>
  8312. <member name="F:NPOI.XWPF.UserModel.TextAlignment.BOTTOM">
  8313. Specifies that all text in the parent object shall be
  8314. aligned to the bottom of each character when displayed.
  8315. </member>
  8316. <member name="F:NPOI.XWPF.UserModel.TextAlignment.AUTO">
  8317. Specifies that all text in the parent object shall be
  8318. aligned automatically when displayed.
  8319. </member>
  8320. <member name="T:NPOI.XWPF.UserModel.TextSegment">
  8321. saves the begin and end position of a text in a Paragraph
  8322. </member>
  8323. <member name="P:NPOI.XWPF.UserModel.TextSegment.BeginRun">
  8324. <summary>
  8325. The index of the start run
  8326. </summary>
  8327. </member>
  8328. <member name="P:NPOI.XWPF.UserModel.TextSegment.BeginText">
  8329. <summary>
  8330. The index of the start CT_Text
  8331. </summary>
  8332. </member>
  8333. <member name="P:NPOI.XWPF.UserModel.TextSegment.BeginChar">
  8334. <summary>
  8335. The index of the start text character
  8336. </summary>
  8337. </member>
  8338. <member name="P:NPOI.XWPF.UserModel.TextSegment.EndText">
  8339. <summary>
  8340. the index of the end CT_Text
  8341. </summary>
  8342. </member>
  8343. <member name="P:NPOI.XWPF.UserModel.TextSegment.EndChar">
  8344. <summary>
  8345. the index of the end text character
  8346. </summary>
  8347. </member>
  8348. <member name="T:NPOI.XWPF.UserModel.UnderlinePatterns">
  8349. Specifies the types of patterns which may be used to create the underline
  8350. applied beneath the text in a Run.
  8351. @author Gisella Bronzetti
  8352. </member>
  8353. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Single">
  8354. Specifies an underline consisting of a single line beneath all characters
  8355. in this Run.
  8356. </member>
  8357. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Words">
  8358. Specifies an underline consisting of a single line beneath all non-space
  8359. characters in the Run. There shall be no underline beneath any space
  8360. character (breaking or non-breaking).
  8361. </member>
  8362. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Double">
  8363. Specifies an underline consisting of two lines beneath all characters in
  8364. this run
  8365. </member>
  8366. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Thick">
  8367. Specifies an underline consisting of a single thick line beneath all
  8368. characters in this Run.
  8369. </member>
  8370. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Dotted">
  8371. Specifies an underline consisting of a series of dot characters beneath
  8372. all characters in this Run.
  8373. </member>
  8374. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DottedHeavy">
  8375. Specifies an underline consisting of a series of thick dot characters
  8376. beneath all characters in this Run.
  8377. </member>
  8378. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Dash">
  8379. Specifies an underline consisting of a dashed line beneath all characters
  8380. in this Run.
  8381. </member>
  8382. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DashedHeavy">
  8383. Specifies an underline consisting of a series of thick dashes beneath all
  8384. characters in this Run.
  8385. </member>
  8386. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DashLong">
  8387. Specifies an underline consisting of long dashed characters beneath all
  8388. characters in this Run.
  8389. </member>
  8390. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DashLongHeavy">
  8391. Specifies an underline consisting of thick long dashed characters beneath
  8392. all characters in this Run.
  8393. </member>
  8394. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DotDash">
  8395. Specifies an underline consisting of a series of dash, dot characters
  8396. beneath all characters in this Run.
  8397. </member>
  8398. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DashDotHeavy">
  8399. Specifies an underline consisting of a series of thick dash, dot
  8400. characters beneath all characters in this Run.
  8401. </member>
  8402. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DotDotDash">
  8403. Specifies an underline consisting of a series of dash, dot, dot
  8404. characters beneath all characters in this Run.
  8405. </member>
  8406. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.DashDotDotHeavy">
  8407. Specifies an underline consisting of a series of thick dash, dot, dot
  8408. characters beneath all characters in this Run.
  8409. </member>
  8410. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.Wave">
  8411. Specifies an underline consisting of a single wavy line beneath all
  8412. characters in this Run.
  8413. </member>
  8414. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.WavyHeavy">
  8415. Specifies an underline consisting of a single thick wavy line beneath all
  8416. characters in this Run.
  8417. </member>
  8418. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.WavyDouble">
  8419. Specifies an underline consisting of a pair of wavy lines beneath all
  8420. characters in this Run.
  8421. </member>
  8422. <member name="F:NPOI.XWPF.UserModel.UnderlinePatterns.None">
  8423. Specifies no underline beneath this Run.
  8424. </member>
  8425. <member name="T:NPOI.XWPF.UserModel.VerticalAlign">
  8426. Specifies possible values for the alignment of the contents of this run in
  8427. relation to the default appearance of the Run's text. This allows the text to
  8428. be repositioned as subscript or superscript without altering the font size of
  8429. the run properties.
  8430. @author Gisella Bronzetti
  8431. </member>
  8432. <member name="F:NPOI.XWPF.UserModel.VerticalAlign.BASELINE">
  8433. Specifies that the text in the parent run shall be located at the
  8434. baseline and presented in the same size as surrounding text.
  8435. </member>
  8436. <member name="F:NPOI.XWPF.UserModel.VerticalAlign.SUPERSCRIPT">
  8437. Specifies that this text should be subscript. This Setting shall lower
  8438. the text in this run below the baseline and change it to a smaller size,
  8439. if a smaller size is available.
  8440. </member>
  8441. <member name="F:NPOI.XWPF.UserModel.VerticalAlign.SUBSCRIPT">
  8442. Specifies that this text should be superscript. This Setting shall raise
  8443. the text in this run above the baseline and change it to a smaller size,
  8444. if a smaller size is available.
  8445. </member>
  8446. <member name="T:NPOI.XWPF.UserModel.XWPFAbstractNum">
  8447. @author Philipp Epp
  8448. </member>
  8449. <member name="P:NPOI.XWPF.UserModel.XWPFAbstractNum.MultiLevelType">
  8450. <summary>
  8451. Abstract Numbering Definition Type
  8452. </summary>
  8453. </member>
  8454. <member name="T:NPOI.XWPF.UserModel.MultiLevelType">
  8455. <summary>
  8456. Numbering Definition Type
  8457. </summary>
  8458. </member>
  8459. <member name="F:NPOI.XWPF.UserModel.MultiLevelType.SingleLevel">
  8460. <summary>
  8461. Single Level Numbering Definition
  8462. </summary>
  8463. </member>
  8464. <member name="F:NPOI.XWPF.UserModel.MultiLevelType.Multilevel">
  8465. <summary>
  8466. Multilevel Numbering Definition
  8467. </summary>
  8468. </member>
  8469. <member name="F:NPOI.XWPF.UserModel.MultiLevelType.HybridMultilevel">
  8470. <summary>
  8471. Hybrid Multilevel Numbering Definition
  8472. </summary>
  8473. </member>
  8474. <member name="T:NPOI.XWPF.UserModel.NumberFormat">
  8475. <summary>
  8476. Numbering Format
  8477. </summary>
  8478. </member>
  8479. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Decimal">
  8480. <summary>
  8481. Decimal Numbers
  8482. </summary>
  8483. </member>
  8484. <member name="F:NPOI.XWPF.UserModel.NumberFormat.UpperRoman">
  8485. <summary>
  8486. Uppercase Roman Numerals
  8487. </summary>
  8488. </member>
  8489. <member name="F:NPOI.XWPF.UserModel.NumberFormat.LowerRoman">
  8490. <summary>
  8491. Lowercase Roman Numerals
  8492. </summary>
  8493. </member>
  8494. <member name="F:NPOI.XWPF.UserModel.NumberFormat.UpperLetter">
  8495. <summary>
  8496. Uppercase Latin Alphabet
  8497. </summary>
  8498. </member>
  8499. <member name="F:NPOI.XWPF.UserModel.NumberFormat.LowerLetter">
  8500. <summary>
  8501. Lowercase Latin Alphabet
  8502. </summary>
  8503. </member>
  8504. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Ordinal">
  8505. <summary>
  8506. Ordinal
  8507. </summary>
  8508. </member>
  8509. <member name="F:NPOI.XWPF.UserModel.NumberFormat.CardinalText">
  8510. <summary>
  8511. Cardinal Text
  8512. </summary>
  8513. </member>
  8514. <member name="F:NPOI.XWPF.UserModel.NumberFormat.OrdinalText">
  8515. <summary>
  8516. Ordinal Text
  8517. </summary>
  8518. </member>
  8519. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Hex">
  8520. <summary>
  8521. Hexadecimal Numbering
  8522. </summary>
  8523. </member>
  8524. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Chicago">
  8525. <summary>
  8526. Chicago Manual of Style
  8527. </summary>
  8528. </member>
  8529. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographDigital">
  8530. <summary>
  8531. Ideographs
  8532. </summary>
  8533. </member>
  8534. <member name="F:NPOI.XWPF.UserModel.NumberFormat.JapaneseCounting">
  8535. <summary>
  8536. Japanese Counting System
  8537. </summary>
  8538. </member>
  8539. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Aiueo">
  8540. <summary>
  8541. AIUEO Order Hiragana
  8542. </summary>
  8543. </member>
  8544. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Iroha">
  8545. <summary>
  8546. Iroha Ordered Katakana
  8547. </summary>
  8548. </member>
  8549. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalFullWidth">
  8550. <summary>
  8551. Double Byte Arabic Numerals
  8552. </summary>
  8553. </member>
  8554. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalHalfWidth">
  8555. <summary>
  8556. Single Byte Arabic Numerals
  8557. </summary>
  8558. </member>
  8559. <member name="F:NPOI.XWPF.UserModel.NumberFormat.JapaneseLegal">
  8560. <summary>
  8561. Japanese Legal Numbering
  8562. </summary>
  8563. </member>
  8564. <member name="F:NPOI.XWPF.UserModel.NumberFormat.JapaneseDigitalTenThousand">
  8565. <summary>
  8566. Japanese Digital Ten Thousand Counting System
  8567. </summary>
  8568. </member>
  8569. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalEnclosedCircle">
  8570. <summary>
  8571. Decimal Numbers Enclosed in a Circle
  8572. </summary>
  8573. </member>
  8574. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalFullWidth2">
  8575. <summary>
  8576. Double Byte Arabic Numerals Alternate
  8577. </summary>
  8578. </member>
  8579. <member name="F:NPOI.XWPF.UserModel.NumberFormat.AiueoFullWidth">
  8580. <summary>
  8581. Full-Width AIUEO Order Hiragana
  8582. </summary>
  8583. </member>
  8584. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IrohaFullWidth">
  8585. <summary>
  8586. Full-Width Iroha Ordered Katakana
  8587. </summary>
  8588. </member>
  8589. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalZero">
  8590. <summary>
  8591. Initial Zero Arabic Numerals
  8592. </summary>
  8593. </member>
  8594. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Bullet">
  8595. <summary>
  8596. Bullet
  8597. </summary>
  8598. </member>
  8599. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Ganada">
  8600. <summary>
  8601. Korean Ganada Numbering
  8602. </summary>
  8603. </member>
  8604. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Chosung">
  8605. <summary>
  8606. Korean Chosung Numbering
  8607. </summary>
  8608. </member>
  8609. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalEnclosedFullstop">
  8610. <summary>
  8611. Decimal Numbers Followed by a Period
  8612. </summary>
  8613. </member>
  8614. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalEnclosedParen">
  8615. <summary>
  8616. Decimal Numbers Enclosed in Parenthesis
  8617. </summary>
  8618. </member>
  8619. <member name="F:NPOI.XWPF.UserModel.NumberFormat.DecimalEnclosedCircleChinese">
  8620. <summary>
  8621. Decimal Numbers Enclosed in a Circle
  8622. </summary>
  8623. </member>
  8624. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographEnclosedCircle">
  8625. <summary>
  8626. Ideographs Enclosed in a Circle
  8627. </summary>
  8628. </member>
  8629. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographTraditional">
  8630. <summary>
  8631. Traditional Ideograph Format
  8632. </summary>
  8633. </member>
  8634. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographZodiac">
  8635. <summary>
  8636. Zodiac Ideograph Format
  8637. </summary>
  8638. </member>
  8639. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographZodiacTraditional">
  8640. <summary>
  8641. Traditional Zodiac Ideograph Format
  8642. </summary>
  8643. </member>
  8644. <member name="F:NPOI.XWPF.UserModel.NumberFormat.TaiwaneseCounting">
  8645. <summary>
  8646. Taiwanese Counting System
  8647. </summary>
  8648. </member>
  8649. <member name="F:NPOI.XWPF.UserModel.NumberFormat.IdeographLegalTraditional">
  8650. <summary>
  8651. Traditional Legal Ideograph Format
  8652. </summary>
  8653. </member>
  8654. <member name="F:NPOI.XWPF.UserModel.NumberFormat.TaiwaneseCountingThousand">
  8655. <summary>
  8656. Taiwanese Counting Thousand System
  8657. </summary>
  8658. </member>
  8659. <member name="F:NPOI.XWPF.UserModel.NumberFormat.TaiwaneseDigital">
  8660. <summary>
  8661. Taiwanese Digital Counting System
  8662. </summary>
  8663. </member>
  8664. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ChineseCounting">
  8665. <summary>
  8666. Chinese Counting System
  8667. </summary>
  8668. </member>
  8669. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ChineseLegalSimplified">
  8670. <summary>
  8671. Chinese Legal Simplified Format
  8672. </summary>
  8673. </member>
  8674. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ChineseCountingThousand">
  8675. <summary>
  8676. Chinese Counting Thousand System
  8677. </summary>
  8678. </member>
  8679. <member name="F:NPOI.XWPF.UserModel.NumberFormat.KoreanDigital">
  8680. <summary>
  8681. Korean Digital Counting System
  8682. </summary>
  8683. </member>
  8684. <member name="F:NPOI.XWPF.UserModel.NumberFormat.KoreanCounting">
  8685. <summary>
  8686. Korean Counting System
  8687. </summary>
  8688. </member>
  8689. <member name="F:NPOI.XWPF.UserModel.NumberFormat.KoreanLegal">
  8690. <summary>
  8691. Korean Legal Numbering
  8692. </summary>
  8693. </member>
  8694. <member name="F:NPOI.XWPF.UserModel.NumberFormat.KoreanDigital2">
  8695. <summary>
  8696. Korean Digital Counting System Alternate
  8697. </summary>
  8698. </member>
  8699. <member name="F:NPOI.XWPF.UserModel.NumberFormat.VietnameseCounting">
  8700. <summary>
  8701. Vietnamese Numerals
  8702. </summary>
  8703. </member>
  8704. <member name="F:NPOI.XWPF.UserModel.NumberFormat.RussianLower">
  8705. <summary>
  8706. Lowercase Russian Alphabet
  8707. </summary>
  8708. </member>
  8709. <member name="F:NPOI.XWPF.UserModel.NumberFormat.RussianUpper">
  8710. <summary>
  8711. Uppercase Russian Alphabet
  8712. </summary>
  8713. </member>
  8714. <member name="F:NPOI.XWPF.UserModel.NumberFormat.None">
  8715. <summary>
  8716. No Numbering
  8717. </summary>
  8718. </member>
  8719. <member name="F:NPOI.XWPF.UserModel.NumberFormat.NumberInDash">
  8720. <summary>
  8721. Number With Dashes
  8722. </summary>
  8723. </member>
  8724. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Hebrew1">
  8725. <summary>
  8726. Hebrew Numerals
  8727. </summary>
  8728. </member>
  8729. <member name="F:NPOI.XWPF.UserModel.NumberFormat.Hebrew2">
  8730. <summary>
  8731. Hebrew Alphabet
  8732. </summary>
  8733. </member>
  8734. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ArabicAlpha">
  8735. <summary>
  8736. Arabic Alphabet
  8737. </summary>
  8738. </member>
  8739. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ArabicAbjad">
  8740. <summary>
  8741. Arabic Abjad Numerals
  8742. </summary>
  8743. </member>
  8744. <member name="F:NPOI.XWPF.UserModel.NumberFormat.HindiVowels">
  8745. <summary>
  8746. Hindi Vowels
  8747. </summary>
  8748. </member>
  8749. <member name="F:NPOI.XWPF.UserModel.NumberFormat.HindiConsonants">
  8750. <summary>
  8751. Hindi Consonants
  8752. </summary>
  8753. </member>
  8754. <member name="F:NPOI.XWPF.UserModel.NumberFormat.HindiNumbers">
  8755. <summary>
  8756. Hindi Numbers
  8757. </summary>
  8758. </member>
  8759. <member name="F:NPOI.XWPF.UserModel.NumberFormat.HindiCounting">
  8760. <summary>
  8761. Hindi Counting System
  8762. </summary>
  8763. </member>
  8764. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ThaiLetters">
  8765. <summary>
  8766. Thai Letters
  8767. </summary>
  8768. </member>
  8769. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ThaiNumbers">
  8770. <summary>
  8771. Thai Numerals
  8772. </summary>
  8773. </member>
  8774. <member name="F:NPOI.XWPF.UserModel.NumberFormat.ThaiCounting">
  8775. <summary>
  8776. Thai Counting System
  8777. </summary>
  8778. </member>
  8779. <member name="T:NPOI.XWPF.UserModel.XWPFComment">
  8780. * Sketch of XWPF comment class
  8781. *
  8782. * @author Yury Batrakov (batrakov at gmail.com)
  8783. *
  8784. </member>
  8785. <member name="T:NPOI.XWPF.UserModel.XWPFDefaultParagraphStyle">
  8786. Default Paragraph style, from which other styles will override
  8787. TODO Share logic with {@link XWPFParagraph} which also uses CTPPr
  8788. </member>
  8789. <member name="T:NPOI.XWPF.UserModel.XWPFDefaultRunStyle">
  8790. Default Character Run style, from which other styles will override
  8791. TODO Share logic with {@link XWPFRun} which also uses CTRPr
  8792. </member>
  8793. <member name="T:NPOI.XWPF.UserModel.XWPFDocument">
  8794. <p>High(ish) level class for working with .docx files.</p>
  8795. <p>This class tries to hide some of the complexity
  8796. of the underlying file format, but as it's not a
  8797. mature and stable API yet, certain parts of the
  8798. XML structure come through. You'll therefore almost
  8799. certainly need to refer to the OOXML specifications
  8800. from
  8801. http://www.ecma-international.org/publications/standards/Ecma-376.htm
  8802. at some point in your use.</p>
  8803. </member>
  8804. <member name="F:NPOI.XWPF.UserModel.XWPFDocument.drawingIdManager">
  8805. Keeps track on all id-values used in this document and included parts, like headers, footers, etc.
  8806. </member>
  8807. <member name="F:NPOI.XWPF.UserModel.XWPFDocument.headerFooterPolicy">
  8808. Handles the joy of different headers/footers for different pages
  8809. </member>
  8810. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.NewPackage">
  8811. Create a new WordProcessingML package and Setup the default minimal content
  8812. </member>
  8813. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.OnDocumentCreate">
  8814. Create a new CT_Document with all values Set to default
  8815. </member>
  8816. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.Document">
  8817. Returns the low level document base object
  8818. </member>
  8819. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.ColumnCount">
  8820. Sets columns on document base object
  8821. </member>
  8822. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.TextDirection">
  8823. Sets Text Direction of Document
  8824. </member>
  8825. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.BodyElements">
  8826. returns an Iterator with paragraphs and tables
  8827. @see NPOI.XWPF.UserModel.IBody#getBodyElements()
  8828. </member>
  8829. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.Paragraphs">
  8830. @see NPOI.XWPF.UserModel.IBody#getParagraphs()
  8831. </member>
  8832. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.Tables">
  8833. @see NPOI.XWPF.UserModel.IBody#getTables()
  8834. </member>
  8835. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetTableArray(System.Int32)">
  8836. @see NPOI.XWPF.UserModel.IBody#getTableArray(int)
  8837. </member>
  8838. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.FooterList">
  8839. @return the list of footers
  8840. </member>
  8841. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.HeaderList">
  8842. @return the list of headers
  8843. </member>
  8844. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetPartById(System.String)">
  8845. Get the document part that's defined as the
  8846. given relationship of the core document.
  8847. </member>
  8848. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetHeaderFooterPolicy">
  8849. Returns the policy on headers and footers, which
  8850. also provides a way to Get at them.
  8851. </member>
  8852. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetCTStyle">
  8853. Returns the styles object used
  8854. </member>
  8855. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetAllEmbedds">
  8856. Get the document's embedded files.
  8857. </member>
  8858. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetBodyElementSpecificPos(System.Int32,System.Collections.Generic.List{NPOI.XWPF.UserModel.IBodyElement})">
  8859. Finds that for example the 2nd entry in the body list is the 1st paragraph
  8860. </member>
  8861. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetParagraphPos(System.Int32)">
  8862. Look up the paragraph at the specified position in the body elemnts list
  8863. and return this paragraphs position in the paragraphs list
  8864. @param pos
  8865. The position of the relevant paragraph in the body elements
  8866. list
  8867. @return the position of the paragraph in the paragraphs list, if there is
  8868. a paragraph at the position in the bodyelements list. Else it
  8869. will return -1
  8870. </member>
  8871. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetTablePos(System.Int32)">
  8872. Get with the position of a table in the bodyelement array list
  8873. the position of this table in the table array list
  8874. @param pos position of the table in the bodyelement array list
  8875. @return if there is a table at the position in the bodyelement array list,
  8876. else it will return null.
  8877. </member>
  8878. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.InsertNewParagraph(System.Xml.XmlDocument)">
  8879. Add a new paragraph at position of the cursor. The cursor must be on the
  8880. {@link org.apache.xmlbeans.XmlCursor.TokenType#START} tag of an subelement
  8881. of the documents body. When this method is done, the cursor passed as
  8882. parameter points to the {@link org.apache.xmlbeans.XmlCursor.TokenType#END}
  8883. of the newly inserted paragraph.
  8884. @param cursor
  8885. @return the {@link XWPFParagraph} object representing the newly inserted
  8886. CTP object
  8887. </member>
  8888. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsCursorInBody(System.Xml.XmlDocument)">
  8889. verifies that cursor is on the right position
  8890. @param cursor
  8891. </member>
  8892. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetPosOfParagraph(NPOI.XWPF.UserModel.XWPFParagraph)">
  8893. Get the position of the paragraph, within the list
  8894. of all the body elements.
  8895. @param p The paragraph to find
  8896. @return The location, or -1 if the paragraph couldn't be found
  8897. </member>
  8898. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetPosOfTable(NPOI.XWPF.UserModel.XWPFTable)">
  8899. Get the position of the table, within the list of
  8900. all the body elements.
  8901. @param t The table to find
  8902. @return The location, or -1 if the table couldn't be found
  8903. </member>
  8904. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.Commit">
  8905. Commit and saves the document
  8906. </member>
  8907. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetRelationIndex(NPOI.XWPF.UserModel.XWPFRelation)">
  8908. Gets the index of the relation we're trying to create
  8909. @param relation
  8910. @return i
  8911. </member>
  8912. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateParagraph">
  8913. Appends a new paragraph to this document
  8914. @return a new paragraph
  8915. </member>
  8916. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateNumbering">
  8917. Creates an empty numbering if one does not already exist and Sets the numbering member
  8918. @return numbering
  8919. </member>
  8920. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateStyles">
  8921. Creates an empty styles for the document if one does not already exist
  8922. @return styles
  8923. </member>
  8924. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateFootnotes">
  8925. Creates an empty footnotes element for the document if one does not already exist
  8926. @return footnotes
  8927. </member>
  8928. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.RemoveBodyElement(System.Int32)">
  8929. remove a BodyElement from bodyElements array list
  8930. @param pos
  8931. @return true if removing was successfully, else return false
  8932. </member>
  8933. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.SetParagraph(NPOI.XWPF.UserModel.XWPFParagraph,System.Int32)">
  8934. copies content of a paragraph to a existing paragraph in the list paragraphs at position pos
  8935. @param paragraph
  8936. @param pos
  8937. </member>
  8938. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetLastParagraph">
  8939. @return the LastParagraph of the document
  8940. </member>
  8941. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateTable">
  8942. Create an empty table with one row and one column as default.
  8943. @return a new table
  8944. </member>
  8945. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateTable(System.Int32,System.Int32)">
  8946. Create an empty table with a number of rows and cols specified
  8947. @param rows
  8948. @param cols
  8949. @return table
  8950. </member>
  8951. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.CreateTOC">
  8952. <summary>
  8953. Create a Table of Contents (TOC) at the end of the document.
  8954. Please set paragraphs style to "Heading{#}" and document
  8955. styles for TOC <see cref="M:NPOI.OOXML.XWPF.Util.DocumentStylesBuilder.BuildStylesForTOC(NPOI.XWPF.UserModel.XWPFDocument)"/>.
  8956. Otherwise, it renders an empty one.
  8957. </summary>
  8958. </member>
  8959. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.SetTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  8960. Replace content of table in array tables at position pos with a
  8961. @param pos
  8962. @param table
  8963. </member>
  8964. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsEnforcedProtection">
  8965. Verifies that the documentProtection tag in settings.xml file <br/>
  8966. specifies that the protection is enforced (w:enforcement="1") <br/>
  8967. <br/>
  8968. sample snippet from settings.xml
  8969. <pre>
  8970. &lt;w:settings ... &gt;
  8971. &lt;w:documentProtection w:edit=&quot;readOnly&quot; w:enforcement=&quot;1&quot;/&gt;
  8972. </pre>
  8973. @return true if documentProtection is enforced with option any
  8974. </member>
  8975. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsEnforcedReadonlyProtection">
  8976. Verifies that the documentProtection tag in Settings.xml file <br/>
  8977. specifies that the protection is enforced (w:enforcement="1") <br/>
  8978. and that the kind of protection is ReadOnly (w:edit="readOnly")<br/>
  8979. <br/>
  8980. sample snippet from Settings.xml
  8981. <pre>
  8982. &lt;w:settings ... &gt;
  8983. &lt;w:documentProtection w:edit=&quot;readOnly&quot; w:enforcement=&quot;1&quot;/&gt;
  8984. </pre>
  8985. @return true if documentProtection is enforced with option ReadOnly
  8986. </member>
  8987. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsEnforcedFillingFormsProtection">
  8988. Verifies that the documentProtection tag in Settings.xml file <br/>
  8989. specifies that the protection is enforced (w:enforcement="1") <br/>
  8990. and that the kind of protection is forms (w:edit="forms")<br/>
  8991. <br/>
  8992. sample snippet from Settings.xml
  8993. <pre>
  8994. &lt;w:settings ... &gt;
  8995. &lt;w:documentProtection w:edit=&quot;forms&quot; w:enforcement=&quot;1&quot;/&gt;
  8996. </pre>
  8997. @return true if documentProtection is enforced with option forms
  8998. </member>
  8999. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsEnforcedCommentsProtection">
  9000. Verifies that the documentProtection tag in Settings.xml file <br/>
  9001. specifies that the protection is enforced (w:enforcement="1") <br/>
  9002. and that the kind of protection is comments (w:edit="comments")<br/>
  9003. <br/>
  9004. sample snippet from Settings.xml
  9005. <pre>
  9006. &lt;w:settings ... &gt;
  9007. &lt;w:documentProtection w:edit=&quot;comments&quot; w:enforcement=&quot;1&quot;/&gt;
  9008. </pre>
  9009. @return true if documentProtection is enforced with option comments
  9010. </member>
  9011. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.IsEnforcedTrackedChangesProtection">
  9012. Verifies that the documentProtection tag in Settings.xml file <br/>
  9013. specifies that the protection is enforced (w:enforcement="1") <br/>
  9014. and that the kind of protection is trackedChanges (w:edit="trackedChanges")<br/>
  9015. <br/>
  9016. sample snippet from Settings.xml
  9017. <pre>
  9018. &lt;w:settings ... &gt;
  9019. &lt;w:documentProtection w:edit=&quot;trackedChanges&quot; w:enforcement=&quot;1&quot;/&gt;
  9020. </pre>
  9021. @return true if documentProtection is enforced with option trackedChanges
  9022. </member>
  9023. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.EnforceReadonlyProtection">
  9024. Enforces the ReadOnly protection.<br/>
  9025. In the documentProtection tag inside Settings.xml file, <br/>
  9026. it Sets the value of enforcement to "1" (w:enforcement="1") <br/>
  9027. and the value of edit to ReadOnly (w:edit="readOnly")<br/>
  9028. <br/>
  9029. sample snippet from Settings.xml
  9030. <pre>
  9031. &lt;w:settings ... &gt;
  9032. &lt;w:documentProtection w:edit=&quot;readOnly&quot; w:enforcement=&quot;1&quot;/&gt;
  9033. </pre>
  9034. </member>
  9035. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.EnforceFillingFormsProtection">
  9036. Enforce the Filling Forms protection.<br/>
  9037. In the documentProtection tag inside Settings.xml file, <br/>
  9038. it Sets the value of enforcement to "1" (w:enforcement="1") <br/>
  9039. and the value of edit to forms (w:edit="forms")<br/>
  9040. <br/>
  9041. sample snippet from Settings.xml
  9042. <pre>
  9043. &lt;w:settings ... &gt;
  9044. &lt;w:documentProtection w:edit=&quot;forms&quot; w:enforcement=&quot;1&quot;/&gt;
  9045. </pre>
  9046. </member>
  9047. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.EnforceCommentsProtection">
  9048. Enforce the Comments protection.<br/>
  9049. In the documentProtection tag inside Settings.xml file,<br/>
  9050. it Sets the value of enforcement to "1" (w:enforcement="1") <br/>
  9051. and the value of edit to comments (w:edit="comments")<br/>
  9052. <br/>
  9053. sample snippet from Settings.xml
  9054. <pre>
  9055. &lt;w:settings ... &gt;
  9056. &lt;w:documentProtection w:edit=&quot;comments&quot; w:enforcement=&quot;1&quot;/&gt;
  9057. </pre>
  9058. </member>
  9059. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.EnforceTrackedChangesProtection">
  9060. Enforce the Tracked Changes protection.<br/>
  9061. In the documentProtection tag inside Settings.xml file, <br/>
  9062. it Sets the value of enforcement to "1" (w:enforcement="1") <br/>
  9063. and the value of edit to trackedChanges (w:edit="trackedChanges")<br/>
  9064. <br/>
  9065. sample snippet from Settings.xml
  9066. <pre>
  9067. &lt;w:settings ... &gt;
  9068. &lt;w:documentProtection w:edit=&quot;trackedChanges&quot; w:enforcement=&quot;1&quot;/&gt;
  9069. </pre>
  9070. </member>
  9071. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.RemoveProtectionEnforcement">
  9072. Remove protection enforcement.<br/>
  9073. In the documentProtection tag inside Settings.xml file <br/>
  9074. it Sets the value of enforcement to "0" (w:enforcement="0") <br/>
  9075. </member>
  9076. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.EnforceUpdateFields">
  9077. Enforces fields update on document open (in Word).
  9078. In the settings.xml file <br/>
  9079. sets the updateSettings value to true (w:updateSettings w:val="true")
  9080. NOTICES:
  9081. <ul>
  9082. <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?"
  9083. (if "Update automatic links at open" is enabled)</li>
  9084. <li>Flag is removed after saving with changes in Word </li>
  9085. </ul>
  9086. </member>
  9087. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.IsTrackRevisions">
  9088. Check if revision tracking is turned on.
  9089. @return <code>true</code> if revision tracking is turned on
  9090. </member>
  9091. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.InsertTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  9092. inserts an existing XWPFTable to the arrays bodyElements and tables
  9093. @param pos
  9094. @param table
  9095. </member>
  9096. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.AllPictures">
  9097. Returns all Pictures, which are referenced from the document itself.
  9098. @return a {@link List} of {@link XWPFPictureData}. The returned {@link List} is unmodifiable. Use #a
  9099. </member>
  9100. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.AllPackagePictures">
  9101. @return all Pictures in this package
  9102. </member>
  9103. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetNextPicNameNumber(System.Int32)">
  9104. Get the next free ImageNumber
  9105. @param format
  9106. @return the next free ImageNumber
  9107. @throws InvalidFormatException
  9108. </member>
  9109. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetPictureDataByID(System.String)">
  9110. returns the PictureData by blipID
  9111. @param blipID
  9112. @return XWPFPictureData of a specificID
  9113. </member>
  9114. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetNumbering">
  9115. GetNumbering
  9116. @return numbering
  9117. </member>
  9118. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetStyles">
  9119. Get Styles
  9120. @return styles for this document
  9121. </member>
  9122. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  9123. Get the paragraph with the CTP class p
  9124. @param p
  9125. @return the paragraph with the CTP class p
  9126. </member>
  9127. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetTable(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  9128. Get a table by its CTTbl-Object
  9129. @param ctTbl
  9130. @see NPOI.XWPF.UserModel.IBody#getTable(org.Openxmlformats.schemas.wordProcessingml.x2006.main.CTTbl)
  9131. @return a table by its CTTbl-Object or null
  9132. </member>
  9133. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.ChangeOrientation(NPOI.OpenXmlFormats.Wordprocessing.ST_PageOrientation)">
  9134. <summary>
  9135. Change orientation of a Word file
  9136. </summary>
  9137. <param name="orientation"></param>
  9138. <remarks>https://stackoverflow.com/questions/26483837/landscape-and-portrait-pages-in-the-same-word-document-using-apache-poi-xwpf-in</remarks>
  9139. </member>
  9140. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetParagraphArray(System.Int32)">
  9141. Returns the paragraph that of position pos
  9142. @see NPOI.XWPF.UserModel.IBody#getParagraphArray(int)
  9143. </member>
  9144. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.Part">
  9145. returns the Part, to which the body belongs, which you need for Adding relationship to other parts
  9146. Actually it is needed of the class XWPFTableCell. Because you have to know to which part the tableCell
  9147. belongs.
  9148. @see NPOI.XWPF.UserModel.IBody#getPart()
  9149. </member>
  9150. <member name="P:NPOI.XWPF.UserModel.XWPFDocument.PartType">
  9151. Get the PartType of the body, for example
  9152. DOCUMENT, HEADER, FOOTER, FOOTNOTE,
  9153. @see NPOI.XWPF.UserModel.IBody#getPartType()
  9154. </member>
  9155. <member name="M:NPOI.XWPF.UserModel.XWPFDocument.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  9156. Get the TableCell which belongs to the TableCell
  9157. @param cell
  9158. </member>
  9159. <member name="T:NPOI.XWPF.UserModel.XWPFFactory">
  9160. @author Yegor Kozlov
  9161. </member>
  9162. <member name="M:NPOI.XWPF.UserModel.XWPFFactory.GetDescriptor(System.String)">
  9163. @since POI 3.14-Beta1
  9164. </member>
  9165. <member name="M:NPOI.XWPF.UserModel.XWPFFactory.CreateDocumentPart(System.Type,System.Type[],System.Object[])">
  9166. @since POI 3.14-Beta1
  9167. </member>
  9168. <member name="T:NPOI.XWPF.UserModel.XWPFFieldRun">
  9169. A run of text which is part of a field, such as Title
  9170. of Page number or Author.
  9171. Any given Field may be made up of multiple of these.
  9172. </member>
  9173. <member name="T:NPOI.XWPF.UserModel.XWPFFooter">
  9174. Sketch of XWPF footer class
  9175. </member>
  9176. <member name="M:NPOI.XWPF.UserModel.XWPFFooter.Commit">
  9177. save and Commit footer
  9178. </member>
  9179. <member name="P:NPOI.XWPF.UserModel.XWPFFooter.PartType">
  9180. Get the PartType of the body
  9181. @see NPOI.XWPF.UserModel.IBody#getPartType()
  9182. </member>
  9183. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetTableArray(System.Int32)">
  9184. <summary>
  9185. </summary>
  9186. <param name="pos">position in table array</param>
  9187. <returns>The table at position pos</returns>
  9188. </member>
  9189. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.InsertTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  9190. <summary>
  9191. inserts an existing XWPFTable to the arrays bodyElements and tables
  9192. </summary>
  9193. <param name="pos"></param>
  9194. <param name="table"></param>
  9195. </member>
  9196. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetTable(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  9197. if there is a corresponding {@link XWPFTable} of the parameter ctTable in the tableList of this header
  9198. the method will return this table
  9199. if there is no corresponding {@link XWPFTable} the method will return null
  9200. @param ctTable
  9201. @see NPOI.XWPF.UserModel.IBody#getTable(CTTbl ctTable)
  9202. </member>
  9203. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  9204. if there is a corresponding {@link XWPFParagraph} of the parameter ctTable in the paragraphList of this header or footer
  9205. the method will return this paragraph
  9206. if there is no corresponding {@link XWPFParagraph} the method will return null
  9207. @param p is instance of CTP and is searching for an XWPFParagraph
  9208. @return null if there is no XWPFParagraph with an corresponding CTPparagraph in the paragraphList of this header or footer
  9209. XWPFParagraph with the correspondig CTP p
  9210. @see NPOI.XWPF.UserModel.IBody#getParagraph(CTP p)
  9211. </member>
  9212. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetParagraphArray(System.Int32)">
  9213. <summary>
  9214. Returns the paragraph that holds the text of the header or footer.
  9215. </summary>
  9216. <param name="pos"></param>
  9217. <returns></returns>
  9218. </member>
  9219. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  9220. <summary>
  9221. Get the TableCell which belongs to the TableCell
  9222. </summary>
  9223. <param name="cell"></param>
  9224. <returns></returns>
  9225. </member>
  9226. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.IsCursorInFtn(System.Xml.XmlDocument)">
  9227. verifies that cursor is on the right position
  9228. @param cursor
  9229. </member>
  9230. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.InsertNewTbl(System.Xml.XmlDocument)">
  9231. @param cursor
  9232. @return the inserted table
  9233. @see NPOI.XWPF.UserModel.IBody#insertNewTbl(XmlCursor cursor)
  9234. </member>
  9235. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.InsertNewParagraph(System.Xml.XmlDocument)">
  9236. add a new paragraph at position of the cursor
  9237. @param cursor
  9238. @return the inserted paragraph
  9239. @see NPOI.XWPF.UserModel.IBody#insertNewParagraph(XmlCursor cursor)
  9240. </member>
  9241. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.AddNewTbl(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  9242. add a new table to the end of the footnote
  9243. @param table
  9244. @return the Added XWPFTable
  9245. </member>
  9246. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.AddNewParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  9247. add a new paragraph to the end of the footnote
  9248. @param paragraph
  9249. @return the Added XWPFParagraph
  9250. </member>
  9251. <member name="M:NPOI.XWPF.UserModel.XWPFFootnote.GetXWPFDocument">
  9252. @see NPOI.XWPF.UserModel.IBody#getXWPFDocument()
  9253. </member>
  9254. <member name="P:NPOI.XWPF.UserModel.XWPFFootnote.Part">
  9255. returns the Part, to which the body belongs, which you need for Adding relationship to other parts
  9256. @see NPOI.XWPF.UserModel.IBody#getPart()
  9257. </member>
  9258. <member name="P:NPOI.XWPF.UserModel.XWPFFootnote.PartType">
  9259. Get the PartType of the body
  9260. @see NPOI.XWPF.UserModel.IBody#getPartType()
  9261. </member>
  9262. <member name="T:NPOI.XWPF.UserModel.XWPFFootnotes">
  9263. Looks After the collection of Footnotes for a document
  9264. @author Mike McEuen (mceuen@hp.com)
  9265. </member>
  9266. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  9267. Construct XWPFFootnotes from a package part
  9268. @param part the package part holding the data of the footnotes,
  9269. @param rel the package relationship of type "http://schemas.Openxmlformats.org/officeDocument/2006/relationships/footnotes"
  9270. </member>
  9271. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.#ctor">
  9272. Construct XWPFFootnotes from scratch for a new document.
  9273. </member>
  9274. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.OnDocumentRead">
  9275. Read document
  9276. </member>
  9277. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.SetFootnotes(NPOI.OpenXmlFormats.Wordprocessing.CT_Footnotes)">
  9278. Sets the ctFootnotes
  9279. @param footnotes
  9280. </member>
  9281. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.AddFootnote(NPOI.XWPF.UserModel.XWPFFootnote)">
  9282. add an XWPFFootnote to the document
  9283. @param footnote
  9284. @throws IOException
  9285. </member>
  9286. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.AddFootnote(NPOI.OpenXmlFormats.Wordprocessing.CT_FtnEdn)">
  9287. add a footnote to the document
  9288. @param note
  9289. @throws IOException
  9290. </member>
  9291. <member name="M:NPOI.XWPF.UserModel.XWPFFootnotes.GetXWPFDocument">
  9292. @see NPOI.XWPF.UserModel.IBody#getPart()
  9293. </member>
  9294. <member name="T:NPOI.XWPF.UserModel.XWPFHeader">
  9295. Sketch of XWPF header class
  9296. </member>
  9297. <member name="M:NPOI.XWPF.UserModel.XWPFHeader.Commit">
  9298. <summary>
  9299. Save and commit footer
  9300. </summary>
  9301. </member>
  9302. <member name="M:NPOI.XWPF.UserModel.XWPFHeader.OnDocumentRead">
  9303. <summary>
  9304. Read the document
  9305. </summary>
  9306. </member>
  9307. <member name="P:NPOI.XWPF.UserModel.XWPFHeader.PartType">
  9308. <summary>
  9309. Get the PartType of the body
  9310. </summary>
  9311. </member>
  9312. <member name="T:NPOI.XWPF.UserModel.XWPFHeaderFooter">
  9313. Parent of XWPF headers and footers
  9314. </member>
  9315. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.Paragraphs">
  9316. Returns the paragraph(s) that holds
  9317. the text of the header or footer.
  9318. Normally there is only the one paragraph, but
  9319. there could be more in certain cases, or
  9320. a table.
  9321. </member>
  9322. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.Tables">
  9323. Return the table(s) that holds the text
  9324. of the header or footer, for complex cases
  9325. where a paragraph isn't used.
  9326. Normally there's just one paragraph, but some
  9327. complex headers/footers have a table or two
  9328. in Addition.
  9329. </member>
  9330. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.Text">
  9331. Returns the textual content of the header/footer,
  9332. by flattening out the text of its paragraph(s)
  9333. </member>
  9334. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.SetHeaderFooter(NPOI.OpenXmlFormats.Wordprocessing.CT_HdrFtr)">
  9335. Set a new headerFooter
  9336. </member>
  9337. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetTable(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  9338. if there is a corresponding {@link XWPFTable} of the parameter ctTable in the tableList of this header
  9339. the method will return this table
  9340. if there is no corresponding {@link XWPFTable} the method will return null
  9341. @param ctTable
  9342. </member>
  9343. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  9344. if there is a corresponding {@link XWPFParagraph} of the parameter ctTable in the paragraphList of this header or footer
  9345. the method will return this paragraph
  9346. if there is no corresponding {@link XWPFParagraph} the method will return null
  9347. @param p is instance of CTP and is searching for an XWPFParagraph
  9348. @return null if there is no XWPFParagraph with an corresponding CTPparagraph in the paragraphList of this header or footer
  9349. XWPFParagraph with the correspondig CTP p
  9350. </member>
  9351. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetParagraphArray(System.Int32)">
  9352. Returns the paragraph that holds
  9353. the text of the header or footer.
  9354. </member>
  9355. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetListParagraph">
  9356. Get a List of all Paragraphs
  9357. @return a list of {@link XWPFParagraph}
  9358. </member>
  9359. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.AllPackagePictures">
  9360. Get all Pictures in this package
  9361. @return all Pictures in this package
  9362. </member>
  9363. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.AddPictureData(System.Byte[],System.Int32)">
  9364. Adds a picture to the document.
  9365. @param pictureData The picture data
  9366. @param format The format of the picture.
  9367. @return the index to this picture (0 based), the Added picture can be obtained from {@link #getAllPictures()} .
  9368. @throws InvalidFormatException
  9369. </member>
  9370. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.AddPictureData(System.IO.Stream,System.Int32)">
  9371. Adds a picture to the document.
  9372. @param is The stream to read image from
  9373. @param format The format of the picture.
  9374. @return the index to this picture (0 based), the Added picture can be obtained from {@link #getAllPictures()} .
  9375. @throws InvalidFormatException
  9376. @
  9377. </member>
  9378. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetPictureDataByID(System.String)">
  9379. returns the PictureData by blipID
  9380. @param blipID
  9381. @return XWPFPictureData of a specificID
  9382. @throws Exception
  9383. </member>
  9384. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.Owner">
  9385. verifies that cursor is on the right position
  9386. @param cursor
  9387. </member>
  9388. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetTableArray(System.Int32)">
  9389. Returns the table at position pos
  9390. @see NPOI.XWPF.UserModel.IBody#getTableArray(int)
  9391. </member>
  9392. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.InsertTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  9393. inserts an existing XWPFTable to the arrays bodyElements and tables
  9394. @param pos
  9395. @param table
  9396. </member>
  9397. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  9398. Get the TableCell which belongs to the TableCell
  9399. @param cell
  9400. </member>
  9401. <member name="P:NPOI.XWPF.UserModel.XWPFHeaderFooter.Part">
  9402. returns the Part, to which the body belongs, which you need for Adding relationship to other parts
  9403. @see NPOI.XWPF.UserModel.IBody#getPart()
  9404. </member>
  9405. <member name="M:NPOI.XWPF.UserModel.XWPFHeaderFooter.CreateParagraph">
  9406. Adds a new paragraph at the end of the header or footer
  9407. </member>
  9408. <member name="T:NPOI.XWPF.UserModel.XWPFHyperlink">
  9409. * Sketch of XWPF hyperlink class
  9410. *
  9411. * @author Yury Batrakov (batrakov at gmail.com)
  9412. *
  9413. </member>
  9414. <member name="T:NPOI.XWPF.UserModel.XWPFHyperlinkRun">
  9415. A run of text with a Hyperlink applied to it.
  9416. Any given Hyperlink may be made up of multiple of these.
  9417. </member>
  9418. <member name="P:NPOI.XWPF.UserModel.XWPFHyperlinkRun.HyperlinkId">
  9419. Returns the ID of the hyperlink, if one is Set.
  9420. </member>
  9421. <member name="M:NPOI.XWPF.UserModel.XWPFHyperlinkRun.GetHyperlink(NPOI.XWPF.UserModel.XWPFDocument)">
  9422. If this Hyperlink is an external reference hyperlink,
  9423. return the object for it.
  9424. </member>
  9425. <member name="M:NPOI.XWPF.UserModel.XWPFLatentStyles.IsLatentStyle(System.String)">
  9426. checks whether specific LatentStyleID is a latentStyle
  9427. </member>
  9428. <member name="T:NPOI.XWPF.UserModel.XWPFNum">
  9429. @author Philipp Epp
  9430. </member>
  9431. <member name="T:NPOI.XWPF.UserModel.XWPFNumbering">
  9432. @author Philipp Epp
  9433. </member>
  9434. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  9435. create a new styles object with an existing document
  9436. </member>
  9437. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.#ctor">
  9438. create a new XWPFNumbering object for use in a new document
  9439. </member>
  9440. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.OnDocumentRead">
  9441. read numbering form an existing package
  9442. </member>
  9443. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.Commit">
  9444. save and Commit numbering
  9445. </member>
  9446. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.SetNumbering(NPOI.OpenXmlFormats.Wordprocessing.CT_Numbering)">
  9447. Sets the ctNumbering
  9448. @param numbering
  9449. </member>
  9450. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.NumExist(System.String)">
  9451. Checks whether number with numID exists
  9452. @param numID
  9453. @return bool true if num exist, false if num not exist
  9454. </member>
  9455. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.AddNum(NPOI.XWPF.UserModel.XWPFNum)">
  9456. add a new number to the numbering document
  9457. @param num
  9458. </member>
  9459. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.AddNum(System.String)">
  9460. Add a new num with an abstractNumID
  9461. @return return NumId of the Added num
  9462. </member>
  9463. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.AddNum(System.String,System.String)">
  9464. Add a new num with an abstractNumID and a numID
  9465. @param abstractNumID
  9466. @param numID
  9467. </member>
  9468. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.GetNum(System.String)">
  9469. Get Num by NumID
  9470. @param numID
  9471. @return abstractNum with NumId if no Num exists with that NumID
  9472. null will be returned
  9473. </member>
  9474. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.GetAbstractNum(System.String)">
  9475. Get AbstractNum by abstractNumID
  9476. @param abstractNumID
  9477. @return abstractNum with abstractNumId if no abstractNum exists with that abstractNumID
  9478. null will be returned
  9479. </member>
  9480. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.GetIdOfAbstractNum(NPOI.XWPF.UserModel.XWPFAbstractNum)">
  9481. Compare AbstractNum with abstractNums of this numbering document.
  9482. If the content of abstractNum Equals with an abstractNum of the List in numbering
  9483. the Bigint Value of it will be returned.
  9484. If no equal abstractNum is existing null will be returned
  9485. @param abstractNum
  9486. @return Bigint
  9487. </member>
  9488. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.AddAbstractNum(NPOI.XWPF.UserModel.XWPFAbstractNum)">
  9489. add a new AbstractNum and return its AbstractNumID
  9490. @param abstractNum
  9491. </member>
  9492. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.AddAbstractNum">
  9493. <summary>
  9494. Add a new AbstractNum
  9495. </summary>
  9496. <returns></returns>
  9497. @author antony liu
  9498. </member>
  9499. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.RemoveAbstractNum(System.String)">
  9500. remove an existing abstractNum
  9501. @param abstractNumID
  9502. @return true if abstractNum with abstractNumID exists in NumberingArray,
  9503. false if abstractNum with abstractNumID not exists
  9504. </member>
  9505. <member name="M:NPOI.XWPF.UserModel.XWPFNumbering.GetAbstractNumID(System.String)">
  9506. return the abstractNumID
  9507. If the AbstractNumID not exists
  9508. return null
  9509. @param numID
  9510. @return abstractNumID
  9511. </member>
  9512. <member name="T:NPOI.XWPF.UserModel.XWPFParagraph">
  9513. <p>A Paragraph within a Document, Table, Header etc.</p>
  9514. <p>A paragraph has a lot of styling information, but the
  9515. actual text (possibly along with more styling) is held on
  9516. the child {@link XWPFRun}s.</p>
  9517. </member>
  9518. <member name="F:NPOI.XWPF.UserModel.XWPFParagraph.document">
  9519. For access to the document's hyperlink, comments, tables etc
  9520. </member>
  9521. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.BuildRunsInOrderFromXml(System.Collections.ArrayList)">
  9522. Identifies (in order) the parts of the paragraph /
  9523. sub-paragraph that correspond to character text
  9524. runs, and builds the appropriate runs for these.
  9525. </member>
  9526. <!-- Badly formed XML comment ignored for member "P:NPOI.XWPF.UserModel.XWPFParagraph.IRuns" -->
  9527. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.Text">
  9528. Return the textual content of the paragraph, including text from pictures
  9529. and std element in it.
  9530. </member>
  9531. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.StyleID">
  9532. Return styleID of the paragraph if style exist for this paragraph
  9533. if not, null will be returned
  9534. @return styleID as String
  9535. </member>
  9536. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetNumID">
  9537. If style exist for this paragraph
  9538. NumId of the paragraph will be returned.
  9539. If style not exist null will be returned
  9540. @return NumID as Bigint
  9541. </member>
  9542. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.SetNumILvl(System.String)">
  9543. <summary>
  9544. setNumILvl of Paragraph
  9545. </summary>
  9546. <param name="iLvl"></param>
  9547. </member>
  9548. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetNumIlvl">
  9549. <summary>
  9550. Returns Ilvl of the numeric style for this paragraph.
  9551. </summary>
  9552. <returns></returns>
  9553. </member>
  9554. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetNumFmt">
  9555. <summary>
  9556. Returns numbering format for this paragraph, eg bullet or lowerLetter.
  9557. </summary>
  9558. <returns></returns>
  9559. </member>
  9560. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.NumLevelText">
  9561. <summary>
  9562. Returns the text that should be used around the paragraph level numbers.
  9563. </summary>
  9564. </member>
  9565. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetNumStartOverride">
  9566. <summary>
  9567. Gets the numstartOverride for the paragraph numbering for this paragraph.
  9568. </summary>
  9569. <returns></returns>
  9570. </member>
  9571. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.SetNumID(System.String)">
  9572. <summary>
  9573. SetNumID of Paragraph
  9574. </summary>
  9575. <param name="numId"></param>
  9576. </member>
  9577. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.SetNumID(System.String,System.String)">
  9578. <summary>
  9579. Set NumID and level of Paragraph
  9580. </summary>
  9581. <param name="numId"></param>
  9582. <param name="ilvl"></param>
  9583. </member>
  9584. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.ParagraphText">
  9585. <summary>
  9586. Returns the text of the paragraph, but not of any objects in the paragraph
  9587. </summary>
  9588. </member>
  9589. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.PictureText">
  9590. <summary>
  9591. Returns any text from any suitable pictures in the paragraph
  9592. </summary>
  9593. </member>
  9594. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.FootnoteText">
  9595. <summary>
  9596. Returns the footnote text of the paragraph
  9597. </summary>
  9598. </member>
  9599. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.Alignment">
  9600. <summary>
  9601. Returns the paragraph alignment which shall be applied to text in this paragraph.
  9602. </summary>
  9603. </member>
  9604. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.FontAlignment">
  9605. <summary>
  9606. The raw alignment value
  9607. </summary>
  9608. </member>
  9609. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.VerticalAlignment">
  9610. Returns the text vertical alignment which shall be applied to text in
  9611. this paragraph.
  9612. <p>
  9613. If the line height (before any Added spacing) is larger than one or more
  9614. characters on the line, all characters will be aligned to each other as
  9615. specified by this element.
  9616. </p>
  9617. <p>
  9618. If this element is omitted on a given paragraph, its value is determined
  9619. by the Setting previously Set at any level of the style hierarchy (i.e.
  9620. that previous Setting remains unChanged). If this Setting is never
  9621. specified in the style hierarchy, then the vertical alignment of all
  9622. characters on the line shall be automatically determined by the consumer.
  9623. </p>
  9624. @return the vertical alignment of this paragraph.
  9625. </member>
  9626. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.BorderTop">
  9627. <summary>
  9628. the top border for the paragraph
  9629. </summary>
  9630. </member>
  9631. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.BorderBottom">
  9632. <summary>
  9633. Specifies the border which shall be displayed below a Set of
  9634. paragraphs which have the same Set of paragraph border Settings.
  9635. </summary>
  9636. <returns>the bottom border for the paragraph</returns>
  9637. </member>
  9638. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.BorderLeft">
  9639. <summary>
  9640. Specifies the border which shall be displayed on the left side of the
  9641. page around the specified paragraph.
  9642. </summary>
  9643. <returns>the left border for the paragraph</returns>
  9644. </member>
  9645. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.BorderRight">
  9646. Specifies the border which shall be displayed on the right side of the
  9647. page around the specified paragraph.
  9648. @return ParagraphBorder - the right border for the paragraph
  9649. @see #setBorderRight(Borders)
  9650. @see Borders for a list of all possible borders
  9651. </member>
  9652. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.BorderBetween">
  9653. Specifies the border which shall be displayed between each paragraph in a
  9654. Set of paragraphs which have the same Set of paragraph border Settings.
  9655. @return ParagraphBorder - the between border for the paragraph
  9656. @see #setBorderBetween(Borders)
  9657. @see Borders for a list of all possible borders
  9658. </member>
  9659. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IsPageBreak">
  9660. Specifies that when rendering this document in a paginated
  9661. view, the contents of this paragraph are rendered on the start of a new
  9662. page in the document.
  9663. <p>
  9664. If this element is omitted on a given paragraph,
  9665. its value is determined by the Setting previously Set at any level of the
  9666. style hierarchy (i.e. that previous Setting remains unChanged). If this
  9667. Setting is never specified in the style hierarchy, then this property
  9668. shall not be applied. Since the paragraph is specified to start on a new
  9669. page, it begins page two even though it could have fit on page one.
  9670. </p>
  9671. @return bool - if page break is Set
  9672. </member>
  9673. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.SpacingAfter">
  9674. Specifies the spacing that should be Added After the last line in this
  9675. paragraph in the document in absolute units.
  9676. @return int - value representing the spacing After the paragraph
  9677. </member>
  9678. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.SpacingAfterLines">
  9679. Specifies the spacing that should be Added After the last line in this
  9680. paragraph in the document in absolute units.
  9681. @return bigint - value representing the spacing After the paragraph
  9682. @see #setSpacingAfterLines(int)
  9683. </member>
  9684. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.SpacingBefore">
  9685. Specifies the spacing that should be Added above the first line in this
  9686. paragraph in the document in absolute units.
  9687. @return the spacing that should be Added above the first line
  9688. @see #setSpacingBefore(int)
  9689. </member>
  9690. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.SpacingBeforeLines">
  9691. Specifies the spacing that should be Added before the first line in this paragraph in the
  9692. document in line units.
  9693. The value of this attribute is specified in one hundredths of a line.
  9694. @return the spacing that should be Added before the first line in this paragraph
  9695. @see #setSpacingBeforeLines(int)
  9696. </member>
  9697. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.SpacingLineRule">
  9698. <summary>
  9699. Specifies how the spacing between lines is calculated as stored in the
  9700. line attribute. If this attribute is omitted, then it shall be assumed to
  9701. be of a value auto if a line attribute value is present.
  9702. </summary>
  9703. </member>
  9704. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.SpacingBetween">
  9705. <summary>
  9706. Return the spacing between lines of a paragraph. The units of the return value depends on the
  9707. <see cref="T:NPOI.XWPF.UserModel.LineSpacingRule"/>. If AUTO, the return value is in lines, otherwise the return
  9708. value is in points
  9709. <return>a double specifying points or lines.</return>
  9710. </summary>
  9711. </member>
  9712. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IndentationLeft">
  9713. Specifies the indentation which shall be placed between the left text
  9714. margin for this paragraph and the left edge of that paragraph's content
  9715. in a left to right paragraph, and the right text margin and the right
  9716. edge of that paragraph's text in a right to left paragraph
  9717. <p>
  9718. If this attribute is omitted, its value shall be assumed to be zero.
  9719. Negative values are defined such that the text is Moved past the text margin,
  9720. positive values Move the text inside the text margin.
  9721. </p>
  9722. @return indentation or null if indentation is not Set
  9723. </member>
  9724. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IndentationRight">
  9725. Specifies the indentation which shall be placed between the right text
  9726. margin for this paragraph and the right edge of that paragraph's content
  9727. in a left to right paragraph, and the right text margin and the right
  9728. edge of that paragraph's text in a right to left paragraph
  9729. <p>
  9730. If this attribute is omitted, its value shall be assumed to be zero.
  9731. Negative values are defined such that the text is Moved past the text margin,
  9732. positive values Move the text inside the text margin.
  9733. </p>
  9734. @return indentation or null if indentation is not Set
  9735. </member>
  9736. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IndentationHanging">
  9737. Specifies the indentation which shall be Removed from the first line of
  9738. the parent paragraph, by moving the indentation on the first line back
  9739. towards the beginning of the direction of text flow.
  9740. This indentation is
  9741. specified relative to the paragraph indentation which is specified for
  9742. all other lines in the parent paragraph.
  9743. The firstLine and hanging
  9744. attributes are mutually exclusive, if both are specified, then the
  9745. firstLine value is ignored.
  9746. @return indentation or null if indentation is not Set
  9747. </member>
  9748. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IndentationFirstLine">
  9749. Specifies the Additional indentation which shall be applied to the first
  9750. line of the parent paragraph. This Additional indentation is specified
  9751. relative to the paragraph indentation which is specified for all other
  9752. lines in the parent paragraph.
  9753. The firstLine and hanging attributes are
  9754. mutually exclusive, if both are specified, then the firstLine value is
  9755. ignored.
  9756. If the firstLineChars attribute is also specified, then this
  9757. value is ignored.
  9758. If this attribute is omitted, then its value shall be
  9759. assumed to be zero (if needed).
  9760. @return indentation or null if indentation is not Set
  9761. </member>
  9762. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.IsWordWrapped">
  9763. This element specifies whether a consumer shall break Latin text which
  9764. exceeds the text extents of a line by breaking the word across two lines
  9765. (breaking on the character level) or by moving the word to the following
  9766. line (breaking on the word level).
  9767. @return bool
  9768. </member>
  9769. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.Style">
  9770. @return the style of the paragraph
  9771. </member>
  9772. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetCTPBrd(System.Boolean)">
  9773. Get a <b>copy</b> of the currently used CTPBrd, if none is used, return
  9774. a new instance.
  9775. </member>
  9776. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetCTSpacing(System.Boolean)">
  9777. Get a <b>copy</b> of the currently used CTSpacing, if none is used,
  9778. return a new instance.
  9779. </member>
  9780. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetCTInd(System.Boolean)">
  9781. Get a <b>copy</b> of the currently used CTPInd, if none is used, return
  9782. a new instance.
  9783. </member>
  9784. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetCTPPr">
  9785. Get a <b>copy</b> of the currently used CTPPr, if none is used, return
  9786. a new instance.
  9787. </member>
  9788. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.AddRun(NPOI.OpenXmlFormats.Wordprocessing.CT_R)">
  9789. add a new run at the end of the position of
  9790. the content of parameter run
  9791. @param run
  9792. </member>
  9793. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.ReplaceText(System.String,System.String)">
  9794. <summary>
  9795. Replace text inside each run (cross run is not supported yet)
  9796. </summary>
  9797. <param name="oldText">target text</param>
  9798. <param name="newText">replacement text</param>
  9799. </member>
  9800. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.SearchText(System.String,NPOI.XWPF.UserModel.PositionInParagraph)">
  9801. <summary>
  9802. this methods parse the paragraph and search for the string searched.
  9803. If it finds the string, it will return true and the position of the String will be saved in the parameter startPos.
  9804. </summary>
  9805. <param name="searched"></param>
  9806. <param name="startPos"></param>
  9807. <returns></returns>
  9808. </member>
  9809. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.CreateRun">
  9810. Appends a new run to this paragraph
  9811. @return a new text run
  9812. </member>
  9813. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.CreateOMath">
  9814. Appends a new OMath to this paragraph
  9815. @return a new text run
  9816. </member>
  9817. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.InsertNewRun(System.Int32)">
  9818. <summary>
  9819. insert a new Run in RunArray
  9820. </summary>
  9821. <param name="pos">The position at which the new run should be added.</param>
  9822. <returns>the inserted run or null if the given pos is out of bounds.</returns>
  9823. </member>
  9824. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetText(NPOI.XWPF.UserModel.TextSegment)">
  9825. Get a Text
  9826. @param segment
  9827. </member>
  9828. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.RemoveRun(System.Int32)">
  9829. Removes a Run at the position pos in the paragraph
  9830. @param pos
  9831. @return true if the run was Removed
  9832. </member>
  9833. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.ElementType">
  9834. returns the type of the BodyElement Paragraph
  9835. @see NPOI.XWPF.UserModel.IBodyElement#getElementType()
  9836. </member>
  9837. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.Part">
  9838. returns the part of the bodyElement
  9839. @see NPOI.XWPF.UserModel.IBody#getPart()
  9840. </member>
  9841. <member name="P:NPOI.XWPF.UserModel.XWPFParagraph.PartType">
  9842. returns the partType of the bodyPart which owns the bodyElement
  9843. @see NPOI.XWPF.UserModel.IBody#getPartType()
  9844. </member>
  9845. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.AddRun(NPOI.XWPF.UserModel.XWPFRun)">
  9846. Adds a new Run to the Paragraph
  9847. @param r
  9848. </member>
  9849. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.GetRun(NPOI.OpenXmlFormats.Wordprocessing.CT_R)">
  9850. return the XWPFRun-Element which owns the CTR Run-Element
  9851. @param r
  9852. </member>
  9853. <member name="M:NPOI.XWPF.UserModel.XWPFParagraph.CreateHyperlinkRun(System.String)">
  9854. <summary>
  9855. Appends a new hyperlink run to this paragraph
  9856. </summary>
  9857. <param name="rId">a new hyperlink run</param>
  9858. <returns></returns>
  9859. </member>
  9860. <member name="T:NPOI.XWPF.UserModel.XWPFPicture">
  9861. @author Philipp Epp
  9862. </member>
  9863. <member name="M:NPOI.XWPF.UserModel.XWPFPicture.SetPictureReference(NPOI.OpenXml4Net.OPC.PackageRelationship)">
  9864. Link Picture with PictureData
  9865. @param rel
  9866. </member>
  9867. <member name="M:NPOI.XWPF.UserModel.XWPFPicture.GetCTPicture">
  9868. Return the underlying CTPicture bean that holds all properties for this picture
  9869. @return the underlying CTPicture bean
  9870. </member>
  9871. <member name="M:NPOI.XWPF.UserModel.XWPFPicture.GetPictureData">
  9872. Get the PictureData of the Picture, if present.
  9873. Note - not all kinds of picture have data
  9874. </member>
  9875. <member name="P:NPOI.XWPF.UserModel.XWPFPicture.Width">
  9876. <summary>
  9877. Returns the width of the picture (in points).
  9878. </summary>
  9879. </member>
  9880. <member name="P:NPOI.XWPF.UserModel.XWPFPicture.Height">
  9881. <summary>
  9882. Returns the depth of the picture (in points).
  9883. </summary>
  9884. </member>
  9885. <member name="T:NPOI.XWPF.UserModel.XWPFPictureData">
  9886. <summary>
  9887. Raw picture data, normally attached to a WordProcessingML Drawing. As a rule, pictures are stored in the /word/media/ part of a WordProcessingML package.
  9888. </summary>
  9889. <remarks>
  9890. @author Philipp Epp
  9891. </remarks>
  9892. </member>
  9893. <member name="F:NPOI.XWPF.UserModel.XWPFPictureData.RELATIONS">
  9894. Relationships for each known picture type
  9895. </member>
  9896. <member name="M:NPOI.XWPF.UserModel.XWPFPictureData.#ctor">
  9897. Create a new XWPFGraphicData node
  9898. </member>
  9899. <member name="M:NPOI.XWPF.UserModel.XWPFPictureData.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  9900. Construct XWPFPictureData from a package part
  9901. @param part the package part holding the Drawing data,
  9902. @param rel the package relationship holding this Drawing,
  9903. the relationship type must be http://schemas.Openxmlformats.org/officeDocument/2006/relationships/image
  9904. </member>
  9905. <member name="P:NPOI.XWPF.UserModel.XWPFPictureData.Data">
  9906. Gets the picture data as a byte array.
  9907. <p>
  9908. Note, that this call might be expensive since all the picture data is copied into a temporary byte array.
  9909. You can grab the picture data directly from the underlying package part as follows:
  9910. <br/>
  9911. <code>
  9912. InputStream is1 = GetPackagePart().InputStream;
  9913. </code>
  9914. </p>
  9915. @return the Picture data.
  9916. </member>
  9917. <member name="P:NPOI.XWPF.UserModel.XWPFPictureData.FileName">
  9918. Returns the file name of the image, eg image7.jpg . The original filename
  9919. isn't always available, but if it can be found it's likely to be in the
  9920. CTDrawing
  9921. </member>
  9922. <member name="M:NPOI.XWPF.UserModel.XWPFPictureData.SuggestFileExtension">
  9923. Suggests a file extension for this image.
  9924. @return the file extension.
  9925. </member>
  9926. <member name="M:NPOI.XWPF.UserModel.XWPFPictureData.GetPictureType">
  9927. Return an integer constant that specifies type of this picture
  9928. @return an integer constant that specifies type of this picture
  9929. @see NPOI.XWPF.UserModel.PictureTypeEMF
  9930. @see NPOI.XWPF.UserModel.PictureTypeWMF
  9931. @see NPOI.XWPF.UserModel.PictureTypePICT
  9932. @see NPOI.XWPF.UserModel.PictureTypeJPEG
  9933. @see NPOI.XWPF.UserModel.PictureTypePNG
  9934. @see NPOI.XWPF.UserModel.PictureTypeDIB
  9935. </member>
  9936. <member name="M:NPOI.XWPF.UserModel.XWPFPictureData.PrepareForCommit">
  9937. *PictureData objects store the actual content in the part directly without keeping a
  9938. copy like all others therefore we need to handle them differently.
  9939. </member>
  9940. <member name="T:NPOI.XWPF.UserModel.XWPFRelation">
  9941. @author Yegor Kozlov
  9942. </member>
  9943. <member name="F:NPOI.XWPF.UserModel.XWPFRelation._table">
  9944. A map to lookup POIXMLRelation by its relation type
  9945. </member>
  9946. <member name="F:NPOI.XWPF.UserModel.XWPFRelation.IMAGE_EMF">
  9947. Supported image formats
  9948. </member>
  9949. <member name="M:NPOI.XWPF.UserModel.XWPFRelation.GetInstance(System.String)">
  9950. Get POIXMLRelation by relation type
  9951. @param rel relation type, for example,
  9952. <code>http://schemas.openxmlformats.org/officeDocument/2006/relationships/image</code>
  9953. @return registered POIXMLRelation or null if not found
  9954. </member>
  9955. <member name="T:NPOI.XWPF.UserModel.FontCharRange">
  9956. @see <a href="http://msdn.microsoft.com/en-us/library/ff533743(v=office.12).aspx">[MS-OI29500] Run Fonts</a>
  9957. </member>
  9958. <member name="T:NPOI.XWPF.UserModel.XWPFRun">
  9959. XWPFrun.object defines a region of text with a common Set of properties
  9960. @author Yegor Kozlov
  9961. @author Gregg Morris (gregg dot morris at gmail dot com) - added getColor(), setColor()
  9962. </member>
  9963. <member name="M:NPOI.XWPF.UserModel.XWPFRun.#ctor(NPOI.OpenXmlFormats.Wordprocessing.CT_R,NPOI.XWPF.UserModel.IRunBody)">
  9964. @param r the CT_R bean which holds the run.attributes
  9965. @param p the parent paragraph
  9966. </member>
  9967. <member name="M:NPOI.XWPF.UserModel.XWPFRun.#ctor(NPOI.OpenXmlFormats.Wordprocessing.CT_R,NPOI.XWPF.UserModel.XWPFParagraph)">
  9968. @deprecated Use {@link XWPFRun#XWPFRun(CTR, IRunBody)}
  9969. </member>
  9970. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetCTR">
  9971. Get the currently used CT_R object
  9972. @return CT_R object
  9973. </member>
  9974. <member name="P:NPOI.XWPF.UserModel.XWPFRun.Parent">
  9975. Get the currently referenced paragraph/SDT object
  9976. @return current parent
  9977. </member>
  9978. <member name="P:NPOI.XWPF.UserModel.XWPFRun.Paragraph">
  9979. Get the currently referenced paragraph, or null if a SDT object
  9980. @deprecated use {@link XWPFRun#getParent()} instead
  9981. </member>
  9982. <member name="P:NPOI.XWPF.UserModel.XWPFRun.Document">
  9983. @return The {@link XWPFDocument} instance, this run.belongs to, or
  9984. <code>null</code> if parent structure (paragraph > document) is not properly Set.
  9985. </member>
  9986. <member name="M:NPOI.XWPF.UserModel.XWPFRun.IsCTOnOff(NPOI.OpenXmlFormats.Wordprocessing.CT_OnOff)">
  9987. For isBold, isItalic etc
  9988. </member>
  9989. <member name="P:NPOI.XWPF.UserModel.XWPFRun.IsBold">
  9990. Whether the bold property shall be applied to all non-complex script
  9991. characters in the contents of this run.when displayed in a document.
  9992. <p>
  9993. This formatting property is a toggle property, which specifies that its
  9994. behavior differs between its use within a style defInition and its use as
  9995. direct formatting. When used as part of a style defInition, Setting this
  9996. property shall toggle the current state of that property as specified up
  9997. to this point in the hierarchy (i.e. applied to not applied, and vice
  9998. versa). Setting it to <code>false</code> (or an equivalent) shall
  9999. result in the current Setting remaining unChanged. However, when used as
  10000. direct formatting, Setting this property to true or false shall Set the
  10001. absolute state of the resulting property.
  10002. </p>
  10003. <p>
  10004. If this element is not present, the default value is to leave the
  10005. formatting applied at previous level in the style hierarchy. If this
  10006. element is never applied in the style hierarchy, then bold shall not be
  10007. applied to non-complex script characters.
  10008. </p>
  10009. @param value <code>true</code> if the bold property is applied to
  10010. this run
  10011. </member>
  10012. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetColor">
  10013. Get text color. The returned value is a string in the hex form "RRGGBB".
  10014. </member>
  10015. <member name="M:NPOI.XWPF.UserModel.XWPFRun.SetColor(System.String)">
  10016. Set text color.
  10017. @param rgbStr - the desired color, in the hex form "RRGGBB".
  10018. </member>
  10019. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetText(System.Int32)">
  10020. Return the string content of this text run
  10021. @return the text of this text run.or <code>null</code> if not Set
  10022. </member>
  10023. <member name="P:NPOI.XWPF.UserModel.XWPFRun.PictureText">
  10024. Returns text embedded in pictures
  10025. </member>
  10026. <member name="M:NPOI.XWPF.UserModel.XWPFRun.SetText(System.String)">
  10027. <summary>
  10028. Sets the text of this text run
  10029. </summary>
  10030. <param name="value">the literal text which shall be displayed in the document</param>
  10031. </member>
  10032. <member name="M:NPOI.XWPF.UserModel.XWPFRun.SetText(System.String,System.Int32)">
  10033. <summary>
  10034. Sets the text of this text run.in the
  10035. </summary>
  10036. <param name="value">the literal text which shall be displayed in the document</param>
  10037. <param name="pos">position in the text array (NB: 0 based)</param>
  10038. </member>
  10039. <member name="P:NPOI.XWPF.UserModel.XWPFRun.IsItalic">
  10040. Whether the italic property should be applied to all non-complex script
  10041. characters in the contents of this run.when displayed in a document.
  10042. @return <code>true</code> if the italic property is applied
  10043. </member>
  10044. <member name="P:NPOI.XWPF.UserModel.XWPFRun.Underline">
  10045. Specifies that the contents of this run.should be displayed along with an
  10046. underline appearing directly below the character heigh
  10047. @return the Underline pattern Applyed to this run
  10048. @see UnderlinePatterns
  10049. </member>
  10050. <member name="M:NPOI.XWPF.UserModel.XWPFRun.InsertText(System.String,System.Int32)">
  10051. <summary>
  10052. insert text at start index in the run
  10053. </summary>
  10054. <param name="text">insert text</param>
  10055. <param name="startIndex">start index of the insertion in the run text</param>
  10056. </member>
  10057. <member name="M:NPOI.XWPF.UserModel.XWPFRun.SetUnderline(NPOI.XWPF.UserModel.UnderlinePatterns)">
  10058. Specifies that the contents of this run.should be displayed along with an
  10059. underline appearing directly below the character heigh
  10060. If this element is not present, the default value is to leave the
  10061. formatting applied at previous level in the style hierarchy. If this
  10062. element is never applied in the style hierarchy, then an underline shall
  10063. not be applied to the contents of this run.
  10064. @param value -
  10065. underline type
  10066. @see UnderlinePatterns : all possible patterns that could be applied
  10067. </member>
  10068. <member name="P:NPOI.XWPF.UserModel.XWPFRun.IsStrikeThrough">
  10069. Specifies that the contents of this run.shall be displayed with a single
  10070. horizontal line through the center of the line.
  10071. @return <code>true</code> if the strike property is applied
  10072. </member>
  10073. <member name="P:NPOI.XWPF.UserModel.XWPFRun.IsStrike">
  10074. Specifies that the contents of this run.shall be displayed with a single
  10075. horizontal line through the center of the line.
  10076. <p>
  10077. This formatting property is a toggle property, which specifies that its
  10078. behavior differs between its use within a style defInition and its use as
  10079. direct formatting. When used as part of a style defInition, Setting this
  10080. property shall toggle the current state of that property as specified up
  10081. to this point in the hierarchy (i.e. applied to not applied, and vice
  10082. versa). Setting it to false (or an equivalent) shall result in the
  10083. current Setting remaining unChanged. However, when used as direct
  10084. formatting, Setting this property to true or false shall Set the absolute
  10085. state of the resulting property.
  10086. </p>
  10087. <p>
  10088. If this element is not present, the default value is to leave the
  10089. formatting applied at previous level in the style hierarchy. If this
  10090. element is never applied in the style hierarchy, then strikethrough shall
  10091. not be applied to the contents of this run.
  10092. </p>
  10093. @param value <code>true</code> if the strike property is applied to
  10094. this run
  10095. </member>
  10096. <member name="P:NPOI.XWPF.UserModel.XWPFRun.IsDoubleStrikeThrough">
  10097. Specifies that the contents of this run shall be displayed with a double
  10098. horizontal line through the center of the line.
  10099. @return <code>true</code> if the double strike property is applied
  10100. </member>
  10101. <member name="P:NPOI.XWPF.UserModel.XWPFRun.Subscript">
  10102. Specifies the alignment which shall be applied to the contents of this
  10103. run.in relation to the default appearance of the run.s text.
  10104. This allows the text to be repositioned as subscript or superscript without
  10105. altering the font size of the run.properties.
  10106. @return VerticalAlign
  10107. @see VerticalAlign all possible value that could be Applyed to this run
  10108. </member>
  10109. <member name="P:NPOI.XWPF.UserModel.XWPFRun.FontFamily">
  10110. Specifies the fonts which shall be used to display the text contents of
  10111. this run. Specifies a font which shall be used to format all characters
  10112. in the ASCII range (0 - 127) within the parent run
  10113. @return a string representing the font family
  10114. </member>
  10115. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetFontFamily(NPOI.XWPF.UserModel.FontCharRange)">
  10116. Gets the font family for the specified font char range.
  10117. If fcr is null, the font char range "ascii" is used
  10118. @param fcr the font char range, defaults to "ansi"
  10119. @return a string representing the font famil
  10120. </member>
  10121. <member name="M:NPOI.XWPF.UserModel.XWPFRun.SetFontFamily(System.String,NPOI.XWPF.UserModel.FontCharRange)">
  10122. Specifies the fonts which shall be used to display the text contents of
  10123. this run. The default handling for fcr == null is to overwrite the
  10124. ascii font char range with the given font family and also set all not
  10125. specified font ranges
  10126. @param fontFamily
  10127. @param fcr FontCharRange or null for default handling
  10128. </member>
  10129. <member name="P:NPOI.XWPF.UserModel.XWPFRun.FontSize">
  10130. Specifies the font size which shall be applied to all non complex script
  10131. characters in the contents of this run.when displayed.
  10132. @return value representing the font size
  10133. </member>
  10134. <member name="P:NPOI.XWPF.UserModel.XWPFRun.TextPosition">
  10135. This element specifies the amount by which text shall be raised or
  10136. lowered for this run.in relation to the default baseline of the
  10137. surrounding non-positioned text. This allows the text to be repositioned
  10138. without altering the font size of the contents.
  10139. If the val attribute is positive, then the parent run.shall be raised
  10140. above the baseline of the surrounding text by the specified number of
  10141. half-points. If the val attribute is negative, then the parent run.shall
  10142. be lowered below the baseline of the surrounding text by the specified
  10143. number of half-points.
  10144. *
  10145. If this element is not present, the default value is to leave the
  10146. formatting applied at previous level in the style hierarchy. If this
  10147. element is never applied in the style hierarchy, then the text shall not
  10148. be raised or lowered relative to the default baseline location for the
  10149. contents of this run.
  10150. @return a big integer representing the amount of text shall be "moved"
  10151. </member>
  10152. <member name="M:NPOI.XWPF.UserModel.XWPFRun.RemoveBreak">
  10153. </member>
  10154. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddBreak">
  10155. Specifies that a break shall be placed at the current location in the run
  10156. content.
  10157. A break is a special character which is used to override the
  10158. normal line breaking that would be performed based on the normal layout
  10159. of the document's contents.
  10160. @see #AddCarriageReturn()
  10161. </member>
  10162. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddBreak(NPOI.XWPF.UserModel.BreakType)">
  10163. Specifies that a break shall be placed at the current location in the run
  10164. content.
  10165. A break is a special character which is used to override the
  10166. normal line breaking that would be performed based on the normal layout
  10167. of the document's contents.
  10168. <p>
  10169. The behavior of this break character (the
  10170. location where text shall be restarted After this break) shall be
  10171. determined by its type values.
  10172. </p>
  10173. @see BreakType
  10174. </member>
  10175. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddBreak(NPOI.XWPF.UserModel.BreakClear)">
  10176. Specifies that a break shall be placed at the current location in the run
  10177. content. A break is a special character which is used to override the
  10178. normal line breaking that would be performed based on the normal layout
  10179. of the document's contents.
  10180. <p>
  10181. The behavior of this break character (the
  10182. location where text shall be restarted After this break) shall be
  10183. determined by its type (in this case is BreakType.TEXT_WRAPPING as default) and clear attribute values.
  10184. </p>
  10185. @see BreakClear
  10186. </member>
  10187. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddTab">
  10188. Specifies that a tab shall be placed at the current location in
  10189. the run content.
  10190. </member>
  10191. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddCarriageReturn">
  10192. Specifies that a carriage return shall be placed at the
  10193. current location in the run.content.
  10194. A carriage return is used to end the current line of text in
  10195. WordProcess.
  10196. The behavior of a carriage return in run.content shall be
  10197. identical to a break character with null type and clear attributes, which
  10198. shall end the current line and find the next available line on which to
  10199. continue.
  10200. The carriage return character forced the following text to be
  10201. restarted on the next available line in the document.
  10202. </member>
  10203. <member name="M:NPOI.XWPF.UserModel.XWPFRun.AddPicture(System.IO.Stream,System.Int32,System.String,System.Int32,System.Int32)">
  10204. Adds a picture to the run. This method handles
  10205. attaching the picture data to the overall file.
  10206. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_EMF
  10207. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_WMF
  10208. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_PICT
  10209. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_JPEG
  10210. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_PNG
  10211. @see NPOI.XWPF.UserModel.Document#PICTURE_TYPE_DIB
  10212. @param pictureData The raw picture data
  10213. @param pictureType The type of the picture, eg {@link Document#PICTURE_TYPE_JPEG}
  10214. @param width width in EMUs. To convert to / from points use {@link org.apache.poi.util.Units}
  10215. @param height height in EMUs. To convert to / from points use {@link org.apache.poi.util.Units}
  10216. @throws NPOI.Openxml4j.exceptions.InvalidFormatException
  10217. @throws IOException
  10218. </member>
  10219. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetEmbeddedPictures">
  10220. Returns the embedded pictures of the run. These
  10221. are pictures which reference an external,
  10222. embedded picture image such as a .png or .jpg
  10223. </member>
  10224. <member name="M:NPOI.XWPF.UserModel.XWPFRun.GetStyle">
  10225. <summary>
  10226. 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.
  10227. </summary>
  10228. <returns></returns>
  10229. </member>
  10230. <member name="M:NPOI.XWPF.UserModel.XWPFRun.preserveSpaces(NPOI.OpenXmlFormats.Wordprocessing.CT_Text)">
  10231. Add the xml:spaces="preserve" attribute if the string has leading or trailing white spaces
  10232. @param xs the string to check
  10233. </member>
  10234. <member name="M:NPOI.XWPF.UserModel.XWPFRun.ToString">
  10235. Returns the string version of the text, with tabs and
  10236. carriage returns in place of their xml equivalents.
  10237. </member>
  10238. <member name="T:NPOI.XWPF.UserModel.XWPFSDT">
  10239. Experimental class to offer rudimentary Read-only Processing of
  10240. of StructuredDocumentTags/ContentControl
  10241. WARNING - APIs expected to change rapidly
  10242. </member>
  10243. <member name="T:NPOI.XWPF.UserModel.XWPFSDTCell">
  10244. Experimental class to offer rudimentary Read-only Processing of
  10245. of StructuredDocumentTags/ContentControl that can appear
  10246. in a table row as if a table cell.
  10247. <p/>
  10248. These can contain one or more cells or other SDTs within them.
  10249. <p/>
  10250. WARNING - APIs expected to change rapidly
  10251. </member>
  10252. <member name="T:NPOI.XWPF.UserModel.XWPFSDTContent">
  10253. Experimental class to offer rudimentary Read-only Processing of
  10254. of the contentblock of an SDT/ContentControl.
  10255. WARNING - APIs expected to change rapidly
  10256. </member>
  10257. <member name="T:NPOI.XWPF.UserModel.XWPFSDTContentCell">
  10258. Experimental class to offer rudimentary Read-only Processing of
  10259. of the XWPFSDTCellContent.
  10260. <p/>
  10261. WARNING - APIs expected to change rapidly
  10262. </member>
  10263. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.GetZoomPercent">
  10264. In the zoom tag inside Settings.xml file <br/>
  10265. it Sets the value of zoom
  10266. @return percentage as an integer of zoom level
  10267. </member>
  10268. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.SetZoomPercent(System.Int64)">
  10269. <summary>
  10270. Set zoom. In the zoom tag inside settings.xml file it sets the value of zoom
  10271. </summary>
  10272. <param name="zoomPercent"></param>
  10273. <example>
  10274. sample snippet from Settings.xml
  10275. &lt;w:zoom w:percent="50" /&gt;
  10276. </example>
  10277. </member>
  10278. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.IsEnforcedWith">
  10279. Verifies the documentProtection tag inside settings.xml file <br/>
  10280. if the protection is enforced (w:enforcement="1") <br/>
  10281. <p/>
  10282. <br/>
  10283. sample snippet from settings.xml
  10284. <pre>
  10285. &lt;w:settings ... &gt;
  10286. &lt;w:documentProtection w:edit=&quot;readOnly&quot; w:enforcement=&quot;1&quot;/&gt;
  10287. </pre>
  10288. @return true if documentProtection is enforced with option any
  10289. </member>
  10290. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.IsEnforcedWith(NPOI.OpenXmlFormats.Wordprocessing.ST_DocProtect)">
  10291. Verifies the documentProtection tag inside Settings.xml file <br/>
  10292. if the protection is enforced (w:enforcement="1") <br/>
  10293. and if the kind of protection Equals to passed (STDocProtect.Enum editValue) <br/>
  10294. <br/>
  10295. sample snippet from Settings.xml
  10296. <pre>
  10297. &lt;w:settings ... &gt;
  10298. &lt;w:documentProtection w:edit=&quot;readOnly&quot; w:enforcement=&quot;1&quot;/&gt;
  10299. </pre>
  10300. @return true if documentProtection is enforced with option ReadOnly
  10301. </member>
  10302. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.SetEnforcementEditValue(NPOI.OpenXmlFormats.Wordprocessing.ST_DocProtect)">
  10303. Enforces the protection with the option specified by passed editValue.<br/>
  10304. <br/>
  10305. In the documentProtection tag inside Settings.xml file <br/>
  10306. it Sets the value of enforcement to "1" (w:enforcement="1") <br/>
  10307. and the value of edit to the passed editValue (w:edit="[passed editValue]")<br/>
  10308. <br/>
  10309. sample snippet from Settings.xml
  10310. <pre>
  10311. &lt;w:settings ... &gt;
  10312. &lt;w:documentProtection w:edit=&quot;[passed editValue]&quot; w:enforcement=&quot;1&quot;/&gt;
  10313. </pre>
  10314. </member>
  10315. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.RemoveEnforcement">
  10316. Removes protection enforcement.<br/>
  10317. In the documentProtection tag inside Settings.xml file <br/>
  10318. it Sets the value of enforcement to "0" (w:enforcement="0") <br/>
  10319. </member>
  10320. <member name="M:NPOI.XWPF.UserModel.XWPFSettings.SetUpdateFields">
  10321. Enforces fields update on document open (in Word).
  10322. In the settings.xml file <br/>
  10323. sets the updateSettings value to true (w:updateSettings w:val="true")
  10324. NOTICES:
  10325. <ul>
  10326. <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?"
  10327. (if "Update automatic links at open" is enabled)</li>
  10328. <li>Flag is removed after saving with changes in Word </li>
  10329. </ul>
  10330. </member>
  10331. <member name="P:NPOI.XWPF.UserModel.XWPFSettings.IsTrackRevisions">
  10332. get or set revision tracking
  10333. </member>
  10334. <member name="T:NPOI.XWPF.UserModel.XWPFStyle">
  10335. @author Philipp Epp
  10336. </member>
  10337. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.#ctor(NPOI.OpenXmlFormats.Wordprocessing.CT_Style)">
  10338. constructor
  10339. @param style
  10340. </member>
  10341. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.#ctor(NPOI.OpenXmlFormats.Wordprocessing.CT_Style,NPOI.XWPF.UserModel.XWPFStyles)">
  10342. constructor
  10343. @param style
  10344. @param styles
  10345. </member>
  10346. <member name="P:NPOI.XWPF.UserModel.XWPFStyle.StyleId">
  10347. Get StyleID of the style
  10348. @return styleID StyleID of the style
  10349. </member>
  10350. <member name="P:NPOI.XWPF.UserModel.XWPFStyle.StyleType">
  10351. Get Type of the Style
  10352. @return ctType
  10353. </member>
  10354. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.SetStyle(NPOI.OpenXmlFormats.Wordprocessing.CT_Style)">
  10355. Set style
  10356. @param style
  10357. </member>
  10358. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.GetCTStyle">
  10359. Get ctStyle
  10360. @return ctStyle
  10361. </member>
  10362. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.GetStyles">
  10363. Get styles
  10364. @return styles the styles to which this style belongs
  10365. </member>
  10366. <member name="P:NPOI.XWPF.UserModel.XWPFStyle.LinkStyleID">
  10367. Get StyleID of the linked Style
  10368. </member>
  10369. <member name="P:NPOI.XWPF.UserModel.XWPFStyle.NextStyleID">
  10370. Get StyleID of the next style
  10371. </member>
  10372. <member name="M:NPOI.XWPF.UserModel.XWPFStyle.HasSameName(NPOI.XWPF.UserModel.XWPFStyle)">
  10373. Compares the names of the Styles
  10374. @param compStyle
  10375. </member>
  10376. <member name="T:NPOI.XWPF.UserModel.XWPFStyles">
  10377. Holds details of built-in, default and user styles, which
  10378. apply to tables / paragraphs / lists etc.
  10379. Text within one of those with custom stylings has the style
  10380. information stored in the {@link XWPFRun}
  10381. </member>
  10382. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.#ctor(NPOI.OpenXml4Net.OPC.PackagePart)">
  10383. Construct XWPFStyles from a package part
  10384. @param part the package part holding the data of the styles,
  10385. @param rel the package relationship of type "http://schemas.Openxmlformats.org/officeDocument/2006/relationships/styles"
  10386. </member>
  10387. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.#ctor">
  10388. Construct XWPFStyles from scratch for a new document.
  10389. </member>
  10390. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.OnDocumentRead">
  10391. Read document
  10392. </member>
  10393. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.SetStyles(NPOI.OpenXmlFormats.Wordprocessing.CT_Styles)">
  10394. Sets the ctStyles
  10395. @param styles
  10396. </member>
  10397. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.StyleExist(System.String)">
  10398. Checks whether style with styleID exist
  10399. @param styleID styleID of the Style in the style-Document
  10400. @return true if style exist, false if style not exist
  10401. </member>
  10402. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.AddStyle(NPOI.XWPF.UserModel.XWPFStyle)">
  10403. add a style to the document
  10404. @param style
  10405. @throws IOException
  10406. </member>
  10407. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.GetStyle(System.String)">
  10408. get style by a styleID
  10409. @param styleID styleID of the searched style
  10410. @return style
  10411. </member>
  10412. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.GetStyleWithName(System.String)">
  10413. get the style with the specified name, if any.
  10414. @param styleName The name of the style to get, e.g., "Heading 1"
  10415. @return style
  10416. </member>
  10417. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.GetUsedStyleList(NPOI.XWPF.UserModel.XWPFStyle)">
  10418. Get the styles which are related to the parameter style and their relatives
  10419. this method can be used to copy all styles from one document to another document
  10420. @param style
  10421. @return a list of all styles which were used by this method
  10422. </member>
  10423. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.GetUsedStyleList(NPOI.XWPF.UserModel.XWPFStyle,System.Collections.Generic.List{NPOI.XWPF.UserModel.XWPFStyle})">
  10424. Get the styles which are related to parameter style
  10425. @param style
  10426. @return all Styles of the parameterList
  10427. </member>
  10428. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.SetSpellingLanguage(System.String)">
  10429. Sets the default spelling language on ctStyles DocDefaults parameter
  10430. @param strSpellingLanguage
  10431. </member>
  10432. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.SetEastAsia(System.String)">
  10433. Sets the default East Asia spelling language on ctStyles DocDefaults parameter
  10434. @param strEastAsia
  10435. </member>
  10436. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.SetDefaultFonts(NPOI.OpenXmlFormats.Wordprocessing.CT_Fonts)">
  10437. Sets the default font on ctStyles DocDefaults parameter
  10438. TODO Replace this with specific Setters for each type, possibly
  10439. on XWPFDefaultRunStyle
  10440. </member>
  10441. <member name="M:NPOI.XWPF.UserModel.XWPFStyles.GetStyleWithSameName(NPOI.XWPF.UserModel.XWPFStyle)">
  10442. Get the style with the same name
  10443. if this style is not existing, return null
  10444. </member>
  10445. <member name="P:NPOI.XWPF.UserModel.XWPFStyles.DefaultRunStyle">
  10446. Get the default style which applies text runs in the document
  10447. </member>
  10448. <member name="P:NPOI.XWPF.UserModel.XWPFStyles.DefaultParagraphStyle">
  10449. Get the default paragraph style which applies to the document
  10450. </member>
  10451. <member name="P:NPOI.XWPF.UserModel.XWPFStyles.LatentStyles">
  10452. Get the definition of all the Latent Styles
  10453. </member>
  10454. <member name="T:NPOI.XWPF.UserModel.XWPFTable">
  10455. <p>Sketch of XWPFTable class. Only table's text is being hold.</p>
  10456. <p>Specifies the contents of a table present in the document. A table is a set
  10457. of paragraphs (and other block-level content) arranged in rows and columns.</p>
  10458. </member>
  10459. <member name="M:NPOI.XWPF.UserModel.XWPFTable.GetCTTbl">
  10460. @return ctTbl object
  10461. </member>
  10462. <!-- Badly formed XML comment ignored for member "P:NPOI.XWPF.UserModel.XWPFTable.Text" -->
  10463. <member name="M:NPOI.XWPF.UserModel.XWPFTable.AddNewCol">
  10464. add a new column for each row in this table
  10465. </member>
  10466. <member name="M:NPOI.XWPF.UserModel.XWPFTable.CreateRow">
  10467. create a new XWPFTableRow object with as many cells as the number of columns defined in that moment
  10468. @return tableRow
  10469. </member>
  10470. <member name="M:NPOI.XWPF.UserModel.XWPFTable.GetRow(System.Int32)">
  10471. @param pos - index of the row
  10472. @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
  10473. </member>
  10474. <member name="P:NPOI.XWPF.UserModel.XWPFTable.Width">
  10475. @return width value
  10476. </member>
  10477. <member name="P:NPOI.XWPF.UserModel.XWPFTable.NumberOfRows">
  10478. @return number of rows in table
  10479. </member>
  10480. <member name="P:NPOI.XWPF.UserModel.XWPFTable.StyleID">
  10481. Get the StyleID of the table
  10482. @return style-ID of the table
  10483. </member>
  10484. <member name="M:NPOI.XWPF.UserModel.XWPFTable.AddRow(NPOI.XWPF.UserModel.XWPFTableRow)">
  10485. add a new Row to the table
  10486. @param row the row which should be Added
  10487. </member>
  10488. <member name="M:NPOI.XWPF.UserModel.XWPFTable.AddRow(NPOI.XWPF.UserModel.XWPFTableRow,System.Int32)">
  10489. add a new Row to the table
  10490. at position pos
  10491. @param row the row which should be Added
  10492. </member>
  10493. <member name="M:NPOI.XWPF.UserModel.XWPFTable.InsertNewTableRow(System.Int32)">
  10494. inserts a new tablerow
  10495. @param pos
  10496. @return the inserted row
  10497. </member>
  10498. <member name="M:NPOI.XWPF.UserModel.XWPFTable.RemoveRow(System.Int32)">
  10499. Remove a row at position pos from the table
  10500. @param pos position the Row in the Table
  10501. </member>
  10502. <member name="P:NPOI.XWPF.UserModel.XWPFTable.ElementType">
  10503. returns the type of the BodyElement Table
  10504. @see NPOI.XWPF.UserModel.IBodyElement#getElementType()
  10505. </member>
  10506. <member name="P:NPOI.XWPF.UserModel.XWPFTable.Part">
  10507. returns the part of the bodyElement
  10508. @see NPOI.XWPF.UserModel.IBody#getPart()
  10509. </member>
  10510. <member name="P:NPOI.XWPF.UserModel.XWPFTable.PartType">
  10511. returns the partType of the bodyPart which owns the bodyElement
  10512. @see NPOI.XWPF.UserModel.IBody#getPartType()
  10513. </member>
  10514. <member name="M:NPOI.XWPF.UserModel.XWPFTable.GetRow(NPOI.OpenXmlFormats.Wordprocessing.CT_Row)">
  10515. returns the XWPFRow which belongs to the CTRow row
  10516. if this row is not existing in the table null will be returned
  10517. </member>
  10518. <member name="T:NPOI.XWPF.UserModel.XWPFTableCell">
  10519. Represents a Cell within a {@link XWPFTable}. The
  10520. Cell is the thing that holds the actual content (paragraphs etc)
  10521. </member>
  10522. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.#ctor(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc,NPOI.XWPF.UserModel.XWPFTableRow,NPOI.XWPF.UserModel.IBody)">
  10523. If a table cell does not include at least one block-level element, then this document shall be considered corrupt
  10524. </member>
  10525. <member name="P:NPOI.XWPF.UserModel.XWPFTableCell.BodyElements">
  10526. returns an Iterator with paragraphs and tables
  10527. @see NPOI.XWPF.UserModel.IBody#getBodyElements()
  10528. </member>
  10529. <member name="P:NPOI.XWPF.UserModel.XWPFTableCell.Paragraphs">
  10530. returns a list of paragraphs
  10531. </member>
  10532. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.AddParagraph">
  10533. Add a Paragraph to this Table Cell
  10534. @return The paragraph which was Added
  10535. </member>
  10536. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.AddParagraph(NPOI.XWPF.UserModel.XWPFParagraph)">
  10537. add a Paragraph to this TableCell
  10538. @param p the paragaph which has to be Added
  10539. </member>
  10540. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.RemoveParagraph(System.Int32)">
  10541. Removes a paragraph of this tablecell
  10542. @param pos
  10543. </member>
  10544. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetParagraph(NPOI.OpenXmlFormats.Wordprocessing.CT_P)">
  10545. if there is a corresponding {@link XWPFParagraph} of the parameter ctTable in the paragraphList of this table
  10546. the method will return this paragraph
  10547. if there is no corresponding {@link XWPFParagraph} the method will return null
  10548. @param p is instance of CTP and is searching for an XWPFParagraph
  10549. @return null if there is no XWPFParagraph with an corresponding CTPparagraph in the paragraphList of this table
  10550. XWPFParagraph with the correspondig CTP p
  10551. </member>
  10552. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.SetBorderBottom(NPOI.XWPF.UserModel.XWPFTable.XWPFBorderType,System.Int32,System.Int32,System.String)">
  10553. <summary>
  10554. Add bottom border to cell
  10555. </summary>
  10556. <param name="type">Border Style</param>
  10557. <param name="size">Border Width</param>
  10558. <param name="space">Border Spacing Measurement</param>
  10559. <param name="rgbColor">Border Color</param>
  10560. </member>
  10561. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.SetBorderTop(NPOI.XWPF.UserModel.XWPFTable.XWPFBorderType,System.Int32,System.Int32,System.String)">
  10562. <summary>
  10563. Add top border to cell
  10564. </summary>
  10565. <param name="type">Border Style</param>
  10566. <param name="size">Border Width</param>
  10567. <param name="space">Border Spacing Measurement</param>
  10568. <param name="rgbColor">Border Color</param>
  10569. </member>
  10570. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.SetBorderLeft(NPOI.XWPF.UserModel.XWPFTable.XWPFBorderType,System.Int32,System.Int32,System.String)">
  10571. <summary>
  10572. Add left border to cell
  10573. </summary>
  10574. <param name="type">Border Style</param>
  10575. <param name="size">Border Width</param>
  10576. <param name="space">Border Spacing Measurement</param>
  10577. <param name="rgbColor">Border Color</param>
  10578. </member>
  10579. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.SetBorderRight(NPOI.XWPF.UserModel.XWPFTable.XWPFBorderType,System.Int32,System.Int32,System.String)">
  10580. <summary>
  10581. Add right border to cell
  10582. </summary>
  10583. <param name="type">Border Style</param>
  10584. <param name="size">Border Width</param>
  10585. <param name="space"></param>
  10586. <param name="rgbColor">Border Color</param>
  10587. </member>
  10588. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.CreateBorder(NPOI.XWPF.UserModel.XWPFTable.XWPFBorderType,System.Int32,System.Int32,System.String)">
  10589. <summary>
  10590. Creates border with parameters
  10591. </summary>
  10592. <param name="type">Border Style</param>
  10593. <param name="size">Border Width</param>
  10594. <param name="space">Border Spacing Measurement</param>
  10595. <param name="rgbColor">Border Color</param>
  10596. <returns>CT_Border object</returns>
  10597. </member>
  10598. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.SetColor(System.String)">
  10599. Set cell color. This sets some associated values; for finer control
  10600. you may want to access these elements individually.
  10601. @param rgbStr - the desired cell color, in the hex form "RRGGBB".
  10602. </member>
  10603. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetColor">
  10604. Get cell color. Note that this method only returns the "fill" value.
  10605. @return RGB string of cell color
  10606. </member>
  10607. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.SetVerticalAlignment(NPOI.XWPF.UserModel.XWPFTableCell.XWPFVertAlign)">
  10608. Set the vertical alignment of the cell.
  10609. @param vAlign - the desired alignment enum value
  10610. </member>
  10611. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetVerticalAlignment">
  10612. Get the vertical alignment of the cell.
  10613. @return the cell alignment enum value or null if no vertical alignment is set
  10614. </member>
  10615. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.InsertNewParagraph(System.Xml.XmlDocument)">
  10616. add a new paragraph at position of the cursor
  10617. @param cursor
  10618. @return the inserted paragraph
  10619. </member>
  10620. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.IsCursorInTableCell(System.Xml.XmlDocument)">
  10621. verifies that cursor is on the right position
  10622. </member>
  10623. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetParagraphArray(System.Int32)">
  10624. @see NPOI.XWPF.UserModel.IBody#getParagraphArray(int)
  10625. </member>
  10626. <member name="P:NPOI.XWPF.UserModel.XWPFTableCell.Part">
  10627. Get the to which the TableCell belongs
  10628. @see NPOI.XWPF.UserModel.IBody#getPart()
  10629. </member>
  10630. <member name="P:NPOI.XWPF.UserModel.XWPFTableCell.PartType">
  10631. @see NPOI.XWPF.UserModel.IBody#getPartType()
  10632. </member>
  10633. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetTable(NPOI.OpenXmlFormats.Wordprocessing.CT_Tbl)">
  10634. Get a table by its CTTbl-Object
  10635. @see NPOI.XWPF.UserModel.IBody#getTable(org.Openxmlformats.schemas.wordProcessingml.x2006.main.CTTbl)
  10636. </member>
  10637. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetTableArray(System.Int32)">
  10638. @see NPOI.XWPF.UserModel.IBody#getTableArray(int)
  10639. </member>
  10640. <member name="P:NPOI.XWPF.UserModel.XWPFTableCell.Tables">
  10641. @see NPOI.XWPF.UserModel.IBody#getTables()
  10642. </member>
  10643. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.InsertTable(System.Int32,NPOI.XWPF.UserModel.XWPFTable)">
  10644. inserts an existing XWPFTable to the arrays bodyElements and tables
  10645. @see NPOI.XWPF.UserModel.IBody#insertTable(int, NPOI.XWPF.UserModel.XWPFTable)
  10646. </member>
  10647. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetTextRecursively">
  10648. extracts all text recursively through embedded tables and embedded SDTs
  10649. </member>
  10650. <member name="M:NPOI.XWPF.UserModel.XWPFTableCell.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  10651. Get the TableCell which belongs to the TableCell
  10652. </member>
  10653. <member name="T:NPOI.XWPF.UserModel.XWPFTableRow">
  10654. A row within an {@link XWPFTable}. Rows mostly just have
  10655. sizings and stylings, the interesting content lives inside
  10656. the child {@link XWPFTableCell}s
  10657. </member>
  10658. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.CreateCell">
  10659. create a new XWPFTableCell and add it to the tableCell-list of this tableRow
  10660. @return the newly Created XWPFTableCell
  10661. </member>
  10662. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.AddNewTableCell">
  10663. Adds a new TableCell at the end of this tableRow
  10664. </member>
  10665. <member name="P:NPOI.XWPF.UserModel.XWPFTableRow.Height">
  10666. This element specifies the height of the current table row within the
  10667. current table. This height shall be used to determine the resulting
  10668. height of the table row, which may be absolute or relative (depending on
  10669. its attribute values). If omitted, then the table row shall automatically
  10670. resize its height to the height required by its contents (the equivalent
  10671. of an hRule value of auto).
  10672. @return height
  10673. </member>
  10674. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.GetTableICells">
  10675. create and return a list of all XWPFTableCell
  10676. who belongs to this row
  10677. @return a list of {@link XWPFTableCell}
  10678. </member>
  10679. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.GetTableCells">
  10680. create and return a list of all XWPFTableCell
  10681. who belongs to this row
  10682. @return a list of {@link XWPFTableCell}
  10683. </member>
  10684. <member name="M:NPOI.XWPF.UserModel.XWPFTableRow.GetTableCell(NPOI.OpenXmlFormats.Wordprocessing.CT_Tc)">
  10685. returns the XWPFTableCell which belongs to the CTTC cell
  10686. if there is no XWPFTableCell which belongs to the parameter CTTc cell null will be returned
  10687. </member>
  10688. <member name="P:NPOI.XWPF.UserModel.XWPFTableRow.IsCantSplitRow">
  10689. Return true if the "can't split row" value is true. The logic for this
  10690. attribute is a little unusual: a TRUE value means DON'T allow rows to
  10691. split, FALSE means allow rows to split.
  10692. @return true if rows can't be split, false otherwise.
  10693. </member>
  10694. <member name="P:NPOI.XWPF.UserModel.XWPFTableRow.IsRepeatHeader">
  10695. Return true if a table's header row should be repeated at the top of a
  10696. table split across pages.
  10697. @return true if table's header row should be repeated at the top of each
  10698. page of table, false otherwise.
  10699. </member>
  10700. <member name="M:NPOI.XWPF.Usermodel.MathContainer.CreateAcc">
  10701. <summary>
  10702. Create Accent
  10703. </summary>
  10704. <returns></returns>
  10705. </member>
  10706. <member name="M:NPOI.XWPF.Usermodel.MathContainer.CreateNary">
  10707. <summary>
  10708. Create n-ary Operator Object
  10709. </summary>
  10710. <returns></returns>
  10711. </member>
  10712. <member name="M:NPOI.XWPF.Usermodel.MathContainer.CreateSSub">
  10713. <summary>
  10714. Subscript Object
  10715. </summary>
  10716. <returns></returns>
  10717. </member>
  10718. <member name="M:NPOI.XWPF.Usermodel.MathContainer.CreateSSup">
  10719. <summary>
  10720. Superscript Object
  10721. </summary>
  10722. <returns></returns>
  10723. </member>
  10724. <member name="M:NPOI.XWPF.Usermodel.MathContainer.CreateF">
  10725. <summary>
  10726. Fraction Object
  10727. </summary>
  10728. <returns></returns>
  10729. </member>
  10730. <member name="M:NPOI.XWPF.Usermodel.MathContainer.CreateRad">
  10731. <summary>
  10732. Radical Object
  10733. </summary>
  10734. <returns></returns>
  10735. </member>
  10736. <member name="T:NPOI.XWPF.Usermodel.XWPFAcc">
  10737. <summary>
  10738. Accent
  10739. This element specifies the accent function, consisting of a base
  10740. and a combining diacritical mark. If accPr is
  10741. omitted, the default accent is U+0302 (COMBINING CIRCUMFLEX ACCENT).
  10742. </summary>
  10743. </member>
  10744. <member name="P:NPOI.XWPF.Usermodel.XWPFAcc.AccPr">
  10745. <summary>
  10746. Single char or UTF, like: &#771;
  10747. </summary>
  10748. </member>
  10749. <member name="P:NPOI.XWPF.Usermodel.XWPFAcc.Element">
  10750. <summary>
  10751. This tag, which is an abbreviation for “element”, serves several functions (18 total) including that of the base
  10752. argument of a mathematical object or function, the elements in an array, and the elements in boxes.If all
  10753. subelements are omitted, this element specifies the presence of an empty argument.
  10754. </summary>
  10755. </member>
  10756. <member name="T:NPOI.XWPF.Usermodel.XWPFRad">
  10757. <summary>
  10758. Radical Object
  10759. This element specifies the radical object, consisting of a radical, a base e, and an optional degree deg. [Example:
  10760. Example of rad are √𝑥
  10761. </summary>
  10762. </member>
  10763. <member name="P:NPOI.XWPF.Usermodel.XWPFRad.Degree">
  10764. <summary>
  10765. This element specifies the degree in the mathematical radical. This element is optional. When omitted, the
  10766. square root function, as in √𝑥, is assumed.
  10767. </summary>
  10768. </member>
  10769. <member name="P:NPOI.XWPF.Usermodel.XWPFRad.Element">
  10770. <summary>
  10771. Radical expression element.
  10772. </summary>
  10773. </member>
  10774. <member name="T:NPOI.XWPF.Usermodel.XWPFF">
  10775. <summary>
  10776. Fraction Object
  10777. This element specifies the fraction object, consisting of a numerator and denominator separated by a fraction
  10778. bar.The fraction bar can be horizontal or diagonal, depending on the fraction properties.The fraction object is
  10779. also used to represent the stack function, which places one element above another, with no fraction bar.
  10780. </summary>
  10781. </member>
  10782. <member name="P:NPOI.XWPF.Usermodel.XWPFF.FractionType">
  10783. <summary>
  10784. This element specifies the properties of the fraction object f. Properties of the Fraction object include the type
  10785. or style of the fraction.The fraction bar can be horizontal or diagonal, depending on the fraction properties.The
  10786. fraction object is also used to represent the stack function, which places one element above another, with no
  10787. fraction bar.
  10788. </summary>
  10789. </member>
  10790. <member name="P:NPOI.XWPF.Usermodel.XWPFF.Numerator">
  10791. <summary>
  10792. This element specifies the numerator of the Fraction object f
  10793. </summary>
  10794. </member>
  10795. <member name="P:NPOI.XWPF.Usermodel.XWPFF.Denominator">
  10796. <summary>
  10797. This element specifies the denominator of a fraction
  10798. </summary>
  10799. </member>
  10800. <member name="T:NPOI.XWPF.Usermodel.XWPFNary">
  10801. <summary>
  10802. n-ary Operator Object
  10803. This element specifies an n-ary object, consisting of an n-ary object, a base (or operand), and optional upper and
  10804. lower limits
  10805. </summary>
  10806. </member>
  10807. <member name="P:NPOI.XWPF.Usermodel.XWPFNary.Element">
  10808. <summary>
  10809. This tag, which is an abbreviation for “element”, serves several functions (18 total) including that of the base
  10810. argument of a mathematical object or function, the elements in an array, and the elements in boxes.If all
  10811. subelements are omitted, this element specifies the presence of an empty argument.
  10812. </summary>
  10813. </member>
  10814. <member name="P:NPOI.XWPF.Usermodel.XWPFNary.Subscript">
  10815. <summary>
  10816. This element specifies the subscript of the Pre-Sub-Superscript object sPre
  10817. </summary>
  10818. </member>
  10819. <member name="P:NPOI.XWPF.Usermodel.XWPFNary.Superscript">
  10820. <summary>
  10821. This element specifies the superscript of the superscript object sSup.
  10822. </summary>
  10823. </member>
  10824. <member name="P:NPOI.XWPF.Usermodel.XWPFNary.NaryPr">
  10825. <summary>
  10826. Get Nary symbol
  10827. </summary>
  10828. </member>
  10829. <member name="M:NPOI.XWPF.Usermodel.XWPFNary.SetSumm">
  10830. <summary>
  10831. Sets ∑ char
  10832. </summary>
  10833. </member>
  10834. <member name="M:NPOI.XWPF.Usermodel.XWPFNary.SetUnion">
  10835. <summary>
  10836. Sets ⋃ char
  10837. </summary>
  10838. </member>
  10839. <member name="M:NPOI.XWPF.Usermodel.XWPFNary.SetIntegral">
  10840. <summary>
  10841. Sets ∫ char
  10842. </summary>
  10843. </member>
  10844. <member name="M:NPOI.XWPF.Usermodel.XWPFNary.SetAnd">
  10845. <summary>
  10846. Sets ⋀ char
  10847. </summary>
  10848. </member>
  10849. <member name="M:NPOI.XWPF.Usermodel.XWPFSharedRun.IsCTOnOff(NPOI.OpenXmlFormats.Wordprocessing.CT_OnOff)">
  10850. For isBold, isItalic etc
  10851. </member>
  10852. <member name="M:NPOI.XWPF.Usermodel.XWPFSharedRun.SetFontFamily(System.String,NPOI.XWPF.UserModel.FontCharRange)">
  10853. <summary>
  10854. Specifies the fonts which shall be used to display the text contents of
  10855. this run.The default handling for fcr == null is to overwrite the
  10856. ascii font char range with the given font family and also set all not
  10857. specified font ranges
  10858. </summary>
  10859. <param name="fontFamily">fontFamily</param>
  10860. <param name="fcr">FontCharRange or null for default handling</param>
  10861. </member>
  10862. <member name="M:NPOI.XWPF.Usermodel.XWPFSharedRun.GetFontFamily(NPOI.XWPF.UserModel.FontCharRange)">
  10863. <summary>
  10864. Gets the font family for the specified font char range.
  10865. If fcr is null, the font char range "ascii" is used
  10866. Please use "Cambria Math"(set as default) font otherwise MS Word
  10867. don't open file, LibreOffice Writer open it normaly.
  10868. I think this is MS Word bug, because this is not standart.
  10869. </summary>
  10870. <param name="fcr">the font char range, defaults to "ansi"</param>
  10871. <returns>a string representing the font famil</returns>
  10872. </member>
  10873. <member name="M:NPOI.XWPF.Usermodel.XWPFSharedRun.SetText(System.String)">
  10874. <summary>
  10875. Sets the text of this text run
  10876. </summary>
  10877. <param name="value">the literal text which shall be displayed in the document</param>
  10878. </member>
  10879. <member name="M:NPOI.XWPF.Usermodel.XWPFSharedRun.SetText(System.String,System.Int32)">
  10880. <summary>
  10881. Sets the text of this text run.in the
  10882. </summary>
  10883. <param name="value">the literal text which shall be displayed in the document</param>
  10884. <param name="pos">position in the text array (NB: 0 based)</param>
  10885. </member>
  10886. <member name="M:NPOI.XWPF.Usermodel.XWPFSharedRun.preserveSpaces(NPOI.OpenXmlFormats.Shared.CT_Text1)">
  10887. <summary>
  10888. Add the xml:spaces="preserve" attribute if the string has leading or trailing white spaces
  10889. </summary>
  10890. <param name="xs">the string to check</param>
  10891. </member>
  10892. <member name="T:NPOI.XWPF.Usermodel.XWPFSSup">
  10893. <summary>
  10894. Subscript Object
  10895. his element specifies the subscript object sSub, which consists of a base e and a reduced-size scr placed below
  10896. and to the right, as in Xn
  10897. </summary>
  10898. </member>
  10899. <member name="P:NPOI.XWPF.Usermodel.XWPFSSup.Element">
  10900. <summary>
  10901. This tag, which is an abbreviation for “element”, serves several functions (18 total) including that of the base
  10902. argument of a mathematical object or function, the elements in an array, and the elements in boxes.If all
  10903. subelements are omitted, this element specifies the presence of an empty argument.
  10904. </summary>
  10905. </member>
  10906. <member name="P:NPOI.XWPF.Usermodel.XWPFSSup.Superscript">
  10907. <summary>
  10908. This element specifies the Superscript of the Pre-Sub-Superscript object sPre
  10909. </summary>
  10910. </member>
  10911. <member name="T:NPOI.XWPF.Usermodel.XWPFSSub">
  10912. <summary>
  10913. Subscript Object
  10914. his element specifies the subscript object sSub, which consists of a base e and a reduced-size scr placed below
  10915. and to the right, as in Xn
  10916. </summary>
  10917. </member>
  10918. <member name="P:NPOI.XWPF.Usermodel.XWPFSSub.Element">
  10919. <summary>
  10920. This tag, which is an abbreviation for “element”, serves several functions (18 total) including that of the base
  10921. argument of a mathematical object or function, the elements in an array, and the elements in boxes.If all
  10922. subelements are omitted, this element specifies the presence of an empty argument.
  10923. </summary>
  10924. </member>
  10925. <member name="P:NPOI.XWPF.Usermodel.XWPFSSub.Subscript">
  10926. <summary>
  10927. This element specifies the subscript of the Pre-Sub-Superscript object sPre
  10928. </summary>
  10929. </member>
  10930. <member name="M:NPOI.OOXML.XWPF.Util.DocumentStylesBuilder.AddDefaultStyle">
  10931. <summary>
  10932. Sets default font, size for text in the document.
  10933. </summary>
  10934. </member>
  10935. <!-- Badly formed XML comment ignored for member "M:NPOI.OOXML.XWPF.Util.DocumentStylesBuilder.BuildStylesForTOC(NPOI.XWPF.UserModel.XWPFDocument)" -->
  10936. </members>
  10937. </doc>