暫無描述
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Enums.NET.xml 369KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Enums.NET</name>
  5. </assembly>
  6. <members>
  7. <member name="T:EnumsNET.AttributeCollection">
  8. <summary>
  9. An <see cref="T:System.Attribute"/> collection.
  10. </summary>
  11. </member>
  12. <member name="P:EnumsNET.AttributeCollection.Item(System.Int32)">
  13. <summary>
  14. The <see cref="T:EnumsNET.AttributeCollection"/> indexer.
  15. </summary>
  16. <param name="index">The index of the <see cref="T:System.Attribute"/> to retrieve.</param>
  17. <returns>The <see cref="T:System.Attribute"/> at the specified <paramref name="index"/></returns>
  18. </member>
  19. <member name="P:EnumsNET.AttributeCollection.Count">
  20. <summary>
  21. The number of <see cref="T:System.Attribute"/>s.
  22. </summary>
  23. </member>
  24. <member name="M:EnumsNET.AttributeCollection.Has``1">
  25. <summary>
  26. Indicates if the collection contains a <typeparamref name="TAttribute"/>.
  27. </summary>
  28. <typeparam name="TAttribute">The attribute type.</typeparam>
  29. <returns>Indication if the colleciton contains a <typeparamref name="TAttribute"/>.</returns>
  30. </member>
  31. <member name="M:EnumsNET.AttributeCollection.Has(System.Type)">
  32. <summary>
  33. Indicates if the collection contains an <see cref="T:System.Attribute"/> that is an instance of <paramref name="attributeType"/>.
  34. </summary>
  35. <param name="attributeType">The attribute type.</param>
  36. <returns>Indication if the colleciton contains an <see cref="T:System.Attribute"/> that is an instance of <paramref name="attributeType"/>.</returns>
  37. <exception cref="T:System.ArgumentNullException"><paramref name="attributeType"/> is <c>null</c>.</exception>
  38. </member>
  39. <member name="M:EnumsNET.AttributeCollection.Get``1">
  40. <summary>
  41. Retrieves the first <typeparamref name="TAttribute"/> in the collection if defined otherwise <c>null</c>.
  42. </summary>
  43. <typeparam name="TAttribute">The attribute type.</typeparam>
  44. <returns>The first <typeparamref name="TAttribute"/> in the collection if defined otherwise <c>null</c>.</returns>
  45. </member>
  46. <member name="M:EnumsNET.AttributeCollection.Get(System.Type)">
  47. <summary>
  48. Retrieves the first <see cref="T:System.Attribute"/> that is an instance of <paramref name="attributeType"/> in the collection if defined otherwise <c>null</c>.
  49. </summary>
  50. <param name="attributeType">The attribute type.</param>
  51. <returns>The first <see cref="T:System.Attribute"/> that is an instance of <paramref name="attributeType"/> in the collection if defined otherwise <c>null</c>.</returns>
  52. <exception cref="T:System.ArgumentNullException"><paramref name="attributeType"/> is <c>null</c>.</exception>
  53. </member>
  54. <member name="M:EnumsNET.AttributeCollection.GetAll``1">
  55. <summary>
  56. Retrieves all <typeparamref name="TAttribute"/>'s in the collection.
  57. </summary>
  58. <typeparam name="TAttribute">The attribute type.</typeparam>
  59. <returns>All <typeparamref name="TAttribute"/>'s in the collection.</returns>
  60. </member>
  61. <member name="M:EnumsNET.AttributeCollection.GetAll(System.Type)">
  62. <summary>
  63. Retrieves all <see cref="T:System.Attribute"/>s that are an instance of <paramref name="attributeType"/> in the collection.
  64. </summary>
  65. <param name="attributeType">The attribute type.</param>
  66. <returns>All <see cref="T:System.Attribute"/>s that are an instance of <paramref name="attributeType"/> in the collection.</returns>
  67. <exception cref="T:System.ArgumentNullException"><paramref name="attributeType"/> is <c>null</c>.</exception>
  68. </member>
  69. <member name="M:EnumsNET.AttributeCollection.GetEnumerator">
  70. <summary>
  71. Returns an enumerator that iterates through the collection.
  72. </summary>
  73. <returns>An enumerator that iterates through the collection.</returns>
  74. </member>
  75. <member name="T:EnumsNET.EnumComparer">
  76. <summary>
  77. An efficient enum comparer.
  78. </summary>
  79. </member>
  80. <member name="M:EnumsNET.EnumComparer.GetInstance(System.Type)">
  81. <summary>
  82. Gets a singleton instance of <see cref="T:EnumsNET.EnumComparer"/> for the enum type provided.
  83. </summary>
  84. <param name="enumType">The enum type.</param>
  85. <returns>A singleton instance of <see cref="T:EnumsNET.EnumComparer"/> for the enum type provided.</returns>
  86. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  87. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
  88. </member>
  89. <member name="M:EnumsNET.EnumComparer.Equals(System.Object,System.Object)">
  90. <summary>
  91. Indicates if <paramref name="x"/> equals <paramref name="y"/> without boxing the values.
  92. </summary>
  93. <param name="x">The first enum value.</param>
  94. <param name="y">The second enum value.</param>
  95. <returns>Indication if <paramref name="x"/> equals <paramref name="y"/> without boxing the values.</returns>
  96. </member>
  97. <member name="M:EnumsNET.EnumComparer.GetHashCode(System.Object)">
  98. <summary>
  99. Retrieves a hash code for <paramref name="obj"/> without boxing the value.
  100. </summary>
  101. <param name="obj">The enum value.</param>
  102. <returns>Hash code for <paramref name="obj"/> without boxing the value.</returns>
  103. </member>
  104. <member name="M:EnumsNET.EnumComparer.Compare(System.Object,System.Object)">
  105. <summary>
  106. Compares <paramref name="x"/> to <paramref name="y"/> without boxing the values.
  107. </summary>
  108. <param name="x">The first enum value.</param>
  109. <param name="y">The second enum value.</param>
  110. <returns>1 if <paramref name="x"/> is greater than <paramref name="y"/>, 0 if <paramref name="x"/> equals <paramref name="y"/>,
  111. and -1 if <paramref name="x"/> is less than <paramref name="y"/>.</returns>
  112. </member>
  113. <member name="T:EnumsNET.EnumComparer`1">
  114. <summary>
  115. An efficient enum comparer which doesn't box the values.
  116. </summary>
  117. <typeparam name="TEnum">The enum type.</typeparam>
  118. </member>
  119. <member name="P:EnumsNET.EnumComparer`1.Instance">
  120. <summary>
  121. The singleton instance of <see cref="T:EnumsNET.EnumComparer`1"/>.
  122. </summary>
  123. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  124. </member>
  125. <member name="M:EnumsNET.EnumComparer`1.Equals(`0,`0)">
  126. <summary>
  127. Indicates if <paramref name="x"/> equals <paramref name="y"/> without boxing the values.
  128. </summary>
  129. <param name="x">The first enum value.</param>
  130. <param name="y">The second enum value.</param>
  131. <returns>Indication if <paramref name="x"/> equals <paramref name="y"/> without boxing the values.</returns>
  132. </member>
  133. <member name="M:EnumsNET.EnumComparer`1.GetHashCode(`0)">
  134. <summary>
  135. Retrieves a hash code for <paramref name="obj"/> without boxing the value.
  136. </summary>
  137. <param name="obj">The enum value.</param>
  138. <returns>Hash code for <paramref name="obj"/> without boxing the value.</returns>
  139. </member>
  140. <member name="M:EnumsNET.EnumComparer`1.Compare(`0,`0)">
  141. <summary>
  142. Compares <paramref name="x"/> to <paramref name="y"/> without boxing the values.
  143. </summary>
  144. <param name="x">The first enum value.</param>
  145. <param name="y">The second enum value.</param>
  146. <returns>1 if <paramref name="x"/> is greater than <paramref name="y"/>, 0 if <paramref name="x"/> equals <paramref name="y"/>,
  147. and -1 if <paramref name="x"/> is less than <paramref name="y"/>.</returns>
  148. </member>
  149. <member name="T:EnumsNET.EnumFormat">
  150. <summary>
  151. Specifies the enum string representation formats.
  152. </summary>
  153. </member>
  154. <member name="F:EnumsNET.EnumFormat.DecimalValue">
  155. <summary>
  156. Enum is represented by its decimal value.
  157. </summary>
  158. </member>
  159. <member name="F:EnumsNET.EnumFormat.HexadecimalValue">
  160. <summary>
  161. Enum is represented by its hexadecimal value.
  162. </summary>
  163. </member>
  164. <member name="F:EnumsNET.EnumFormat.UnderlyingValue">
  165. <summary>
  166. Enum is represented by its underlying value.
  167. </summary>
  168. </member>
  169. <member name="F:EnumsNET.EnumFormat.Name">
  170. <summary>
  171. Enum is represented by its name.
  172. </summary>
  173. </member>
  174. <member name="F:EnumsNET.EnumFormat.Description">
  175. <summary>
  176. Enum is represented by its <see cref="P:System.ComponentModel.DescriptionAttribute.Description"/>.
  177. </summary>
  178. </member>
  179. <member name="F:EnumsNET.EnumFormat.EnumMemberValue">
  180. <summary>
  181. Enum is represented by its <see cref="P:System.Runtime.Serialization.EnumMemberAttribute.Value"/>.
  182. </summary>
  183. </member>
  184. <member name="F:EnumsNET.EnumFormat.DisplayName">
  185. <summary>
  186. Enum is represented by its <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.Name"/>.
  187. </summary>
  188. </member>
  189. <member name="T:EnumsNET.EnumMember">
  190. <summary>
  191. An enum member which is composed of its name, value, and attributes.
  192. </summary>
  193. </member>
  194. <member name="P:EnumsNET.EnumMember.Value">
  195. <summary>
  196. The enum member's value.
  197. </summary>
  198. </member>
  199. <member name="P:EnumsNET.EnumMember.Name">
  200. <summary>
  201. The enum member's name.
  202. </summary>
  203. </member>
  204. <member name="P:EnumsNET.EnumMember.Attributes">
  205. <summary>
  206. The enum member's attributes.
  207. </summary>
  208. </member>
  209. <member name="M:EnumsNET.EnumMember.ToString">
  210. <summary>
  211. Retrieves the enum member's name.
  212. </summary>
  213. <returns>The enum member's name.</returns>
  214. </member>
  215. <member name="M:EnumsNET.EnumMember.AsString">
  216. <summary>
  217. Retrieves the enum member's name.
  218. </summary>
  219. <returns>The enum member's name.</returns>
  220. </member>
  221. <member name="M:EnumsNET.EnumMember.AsString(System.String)">
  222. <summary>
  223. Converts the enum member to its string representation using the specified <paramref name="format"/>.
  224. </summary>
  225. <param name="format">The output format to use.</param>
  226. <returns>A string representation of the enum member.</returns>
  227. <exception cref="T:System.FormatException"><paramref name="format"/> is an invalid value.</exception>
  228. </member>
  229. <member name="M:EnumsNET.EnumMember.AsString(EnumsNET.EnumFormat)">
  230. <summary>
  231. Converts the enum member to its string representation using the specified <paramref name="format"/>.
  232. </summary>
  233. <param name="format">The output format to use.</param>
  234. <returns>A string representation of the enum member.</returns>
  235. <exception cref="T:System.ArgumentException"><paramref name="format"/> is an invalid value.</exception>
  236. </member>
  237. <member name="M:EnumsNET.EnumMember.AsString(EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  238. <summary>
  239. Converts the enum member to its string representation using the specified formats.
  240. </summary>
  241. <param name="format0">The first output format to use.</param>
  242. <param name="format1">The second output format to use if using the first resolves to <c>null</c>.</param>
  243. <returns>A string representation of the enum member.</returns>
  244. <exception cref="T:System.ArgumentException"><paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  245. </member>
  246. <member name="M:EnumsNET.EnumMember.AsString(EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  247. <summary>
  248. Converts the enum member to its string representation using the specified formats.
  249. </summary>
  250. <param name="format0">The first output format to use.</param>
  251. <param name="format1">The second output format to use if using the first resolves to <c>null</c>.</param>
  252. <param name="format2">The third output format to use if using the first and second both resolve to <c>null</c>.</param>
  253. <returns>A string representation of the enum member.</returns>
  254. <exception cref="T:System.ArgumentException"><paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  255. </member>
  256. <member name="M:EnumsNET.EnumMember.AsString(EnumsNET.EnumFormat[])">
  257. <summary>
  258. Converts the enum member to its string representation using the specified <paramref name="formats"/>.
  259. </summary>
  260. <param name="formats">The output formats to use.</param>
  261. <returns>A string representation of the enum member.</returns>
  262. <exception cref="T:System.ArgumentException"><paramref name="formats"/> contains an invalid value.</exception>
  263. </member>
  264. <member name="M:EnumsNET.EnumMember.TryFormat(System.Span{System.Char},System.Int32@)">
  265. <summary>
  266. Tries to format the value of the enum member into the provided span of characters.
  267. </summary>
  268. <param name="destination">When this method returns, value formatted as a span of characters.</param>
  269. <param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination"/>.</param>
  270. <returns><c>true</c> if the formatting was successful; otherwise, <c>false</c>.</returns>
  271. </member>
  272. <member name="M:EnumsNET.EnumMember.TryFormat(System.Span{System.Char},System.Int32@,System.ReadOnlySpan{System.Char})">
  273. <summary>
  274. Tries to format the value of the enum member into the provided span of characters.
  275. </summary>
  276. <param name="destination">When this method returns, value formatted as a span of characters.</param>
  277. <param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination"/>.</param>
  278. <param name="format">The output format to use.</param>
  279. <returns><c>true</c> if the formatting was successful; otherwise, <c>false</c>.</returns>
  280. <exception cref="T:System.FormatException"><paramref name="format"/> is an invalid value.</exception>
  281. </member>
  282. <member name="M:EnumsNET.EnumMember.TryFormat(System.Span{System.Char},System.Int32@,EnumsNET.EnumFormat[])">
  283. <summary>
  284. Tries to format the value of the enum member into the provided span of characters.
  285. </summary>
  286. <param name="destination">When this method returns, value formatted as a span of characters.</param>
  287. <param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination"/>.</param>
  288. <param name="formats">The output formats to use.</param>
  289. <returns><c>true</c> if the formatting was successful; otherwise, <c>false</c>.</returns>
  290. <exception cref="T:System.ArgumentException"><paramref name="formats"/> contains an invalid value.</exception>
  291. </member>
  292. <member name="M:EnumsNET.EnumMember.GetUnderlyingValue">
  293. <summary>
  294. Retrieves the enum member's underlying integral value.
  295. </summary>
  296. <returns>The enum member's underlying integral value.</returns>
  297. </member>
  298. <member name="M:EnumsNET.EnumMember.ToSByte">
  299. <summary>
  300. Converts <see cref="P:EnumsNET.EnumMember.Value"/> to an <see cref="T:System.SByte"/>.
  301. </summary>
  302. <returns><see cref="P:EnumsNET.EnumMember.Value"/> converted to an <see cref="T:System.SByte"/>.</returns>
  303. <exception cref="T:System.OverflowException"><see cref="P:EnumsNET.EnumMember.Value"/> cannot fit within <see cref="T:System.SByte"/>'s value range without overflowing.</exception>
  304. </member>
  305. <member name="M:EnumsNET.EnumMember.ToByte">
  306. <summary>
  307. Converts <see cref="P:EnumsNET.EnumMember.Value"/> to a <see cref="T:System.Byte"/>.
  308. </summary>
  309. <returns><see cref="P:EnumsNET.EnumMember.Value"/> converted to a <see cref="T:System.Byte"/>.</returns>
  310. <exception cref="T:System.OverflowException"><see cref="P:EnumsNET.EnumMember.Value"/> cannot fit within <see cref="T:System.Byte"/>'s value range without overflowing.</exception>
  311. </member>
  312. <member name="M:EnumsNET.EnumMember.ToInt16">
  313. <summary>
  314. Converts <see cref="P:EnumsNET.EnumMember.Value"/> to an <see cref="T:System.Int16"/>.
  315. </summary>
  316. <returns><see cref="P:EnumsNET.EnumMember.Value"/> converted to an <see cref="T:System.Int16"/>.</returns>
  317. <exception cref="T:System.OverflowException"><see cref="P:EnumsNET.EnumMember.Value"/> cannot fit within <see cref="T:System.Int16"/>'s value range without overflowing.</exception>
  318. </member>
  319. <member name="M:EnumsNET.EnumMember.ToUInt16">
  320. <summary>
  321. Converts <see cref="P:EnumsNET.EnumMember.Value"/> to a <see cref="T:System.UInt16"/>.
  322. </summary>
  323. <returns><see cref="P:EnumsNET.EnumMember.Value"/> converted to a <see cref="T:System.UInt16"/>.</returns>
  324. <exception cref="T:System.OverflowException"><see cref="P:EnumsNET.EnumMember.Value"/> cannot fit within <see cref="T:System.UInt16"/>'s value range without overflowing.</exception>
  325. </member>
  326. <member name="M:EnumsNET.EnumMember.ToInt32">
  327. <summary>
  328. Converts <see cref="P:EnumsNET.EnumMember.Value"/> to an <see cref="T:System.Int32"/>.
  329. </summary>
  330. <returns><see cref="P:EnumsNET.EnumMember.Value"/> converted to an <see cref="T:System.Int32"/>.</returns>
  331. <exception cref="T:System.OverflowException"><see cref="P:EnumsNET.EnumMember.Value"/> cannot fit within <see cref="T:System.Int32"/>'s value range without overflowing.</exception>
  332. </member>
  333. <member name="M:EnumsNET.EnumMember.ToUInt32">
  334. <summary>
  335. Converts <see cref="P:EnumsNET.EnumMember.Value"/> to a <see cref="T:System.UInt32"/>.
  336. </summary>
  337. <returns><see cref="P:EnumsNET.EnumMember.Value"/> converted to a <see cref="T:System.UInt32"/>.</returns>
  338. <exception cref="T:System.OverflowException"><see cref="P:EnumsNET.EnumMember.Value"/> cannot fit within <see cref="T:System.UInt32"/>'s value range without overflowing.</exception>
  339. </member>
  340. <member name="M:EnumsNET.EnumMember.ToInt64">
  341. <summary>
  342. Converts <see cref="P:EnumsNET.EnumMember.Value"/> to an <see cref="T:System.Int64"/>.
  343. </summary>
  344. <returns><see cref="P:EnumsNET.EnumMember.Value"/> converted to an <see cref="T:System.Int64"/>.</returns>
  345. <exception cref="T:System.OverflowException"><see cref="P:EnumsNET.EnumMember.Value"/> cannot fit within <see cref="T:System.Int64"/>'s value range without overflowing.</exception>
  346. </member>
  347. <member name="M:EnumsNET.EnumMember.ToUInt64">
  348. <summary>
  349. Converts <see cref="P:EnumsNET.EnumMember.Value"/> to a <see cref="T:System.UInt64"/>.
  350. </summary>
  351. <returns><see cref="P:EnumsNET.EnumMember.Value"/> converted to a <see cref="T:System.UInt64"/>.</returns>
  352. <exception cref="T:System.OverflowException"><see cref="P:EnumsNET.EnumMember.Value"/> cannot fit within <see cref="T:System.UInt64"/>'s value range without overflowing.</exception>
  353. </member>
  354. <member name="M:EnumsNET.EnumMember.GetHashCode">
  355. <summary>
  356. Retrieves the hash code of <see cref="P:EnumsNET.EnumMember.Value"/>.
  357. </summary>
  358. <returns>The hash code of <see cref="P:EnumsNET.EnumMember.Value"/>.</returns>
  359. </member>
  360. <member name="M:EnumsNET.EnumMember.Equals(EnumsNET.EnumMember)">
  361. <summary>
  362. Indicates whether the specified <see cref="T:EnumsNET.EnumMember"/> is equal to the current <see cref="T:EnumsNET.EnumMember"/>.
  363. </summary>
  364. <param name="other">The other <see cref="T:EnumsNET.EnumMember"/>.</param>
  365. <returns>Indication whether the specified <see cref="T:EnumsNET.EnumMember"/> is equal to the current <see cref="T:EnumsNET.EnumMember"/>.</returns>
  366. </member>
  367. <member name="M:EnumsNET.EnumMember.Equals(System.Object)">
  368. <summary>
  369. Indicates whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
  370. </summary>
  371. <param name="other">The other <see cref="T:System.Object"/>.</param>
  372. <returns>Indication whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.</returns>
  373. </member>
  374. <member name="T:EnumsNET.EnumMember`1">
  375. <summary>
  376. An enum member which is composed of its name, value, and attributes.
  377. </summary>
  378. <typeparam name="TEnum">The enum type.</typeparam>
  379. </member>
  380. <member name="P:EnumsNET.EnumMember`1.Value">
  381. <summary>
  382. The enum member's value.
  383. </summary>
  384. </member>
  385. <member name="M:EnumsNET.EnumMember`1.Equals(EnumsNET.EnumMember{`0})">
  386. <summary>
  387. Indicates whether the specified <see cref="T:EnumsNET.EnumMember`1"/> is equal to the current <see cref="T:EnumsNET.EnumMember`1"/>.
  388. </summary>
  389. <param name="other">The other <see cref="T:EnumsNET.EnumMember`1"/>.</param>
  390. <returns>Indication whether the specified <see cref="T:EnumsNET.EnumMember`1"/> is equal to the current <see cref="T:EnumsNET.EnumMember`1"/>.</returns>
  391. </member>
  392. <member name="T:EnumsNET.EnumMemberSelection">
  393. <summary>
  394. Specifies what enum members to include.
  395. </summary>
  396. </member>
  397. <member name="F:EnumsNET.EnumMemberSelection.All">
  398. <summary>
  399. Include all enum members.
  400. </summary>
  401. </member>
  402. <member name="F:EnumsNET.EnumMemberSelection.Distinct">
  403. <summary>
  404. Include only distinct valued enum members.
  405. </summary>
  406. </member>
  407. <member name="F:EnumsNET.EnumMemberSelection.Flags">
  408. <summary>
  409. Include each flag enum member.
  410. </summary>
  411. </member>
  412. <member name="F:EnumsNET.EnumMemberSelection.DisplayOrder">
  413. <summary>
  414. Include enum members in display order using <see cref="P:System.ComponentModel.DataAnnotations.DisplayAttribute.Order"/>.
  415. </summary>
  416. </member>
  417. <member name="T:EnumsNET.Enums">
  418. <summary>
  419. Static class that provides efficient type-safe enum operations through the use of cached enum members.
  420. Many operations are exposed as C# extension methods for convenience.
  421. </summary>
  422. </member>
  423. <member name="M:EnumsNET.Enums.RegisterCustomEnumFormat(System.Func{EnumsNET.EnumMember,System.String})">
  424. <summary>
  425. Registers a custom <see cref="T:EnumsNET.EnumFormat"/> with the specified <see cref="T:EnumsNET.EnumMember"/> formatter.
  426. </summary>
  427. <param name="enumMemberFormatter">The <see cref="T:EnumsNET.EnumMember"/> formatter.</param>
  428. <returns>A custom <see cref="T:EnumsNET.EnumFormat"/> that is registered with the specified <see cref="T:EnumsNET.EnumMember"/> formatter.</returns>
  429. <exception cref="T:System.ArgumentNullException"><paramref name="enumMemberFormatter"/> is <c>null</c>.</exception>
  430. </member>
  431. <member name="M:EnumsNET.Enums.GetUnderlyingType``1">
  432. <summary>
  433. Retrieves the underlying type of <typeparamref name="TEnum"/>.
  434. </summary>
  435. <typeparam name="TEnum">The enum type.</typeparam>
  436. <returns>The underlying type of <typeparamref name="TEnum"/>.</returns>
  437. </member>
  438. <member name="M:EnumsNET.Enums.GetTypeCode``1">
  439. <summary>
  440. Retrieves <typeparamref name="TEnum"/>'s underlying type's <see cref="T:System.TypeCode"/>.
  441. </summary>
  442. <typeparam name="TEnum">The enum type.</typeparam>
  443. <returns><typeparamref name="TEnum"/>'s underlying type's <see cref="T:System.TypeCode"/>.</returns>
  444. </member>
  445. <member name="M:EnumsNET.Enums.GetMemberCount``1(EnumsNET.EnumMemberSelection)">
  446. <summary>
  447. Retrieves <typeparamref name="TEnum"/>'s member count.
  448. The parameter <paramref name="selection"/> indicates what members to include.
  449. </summary>
  450. <typeparam name="TEnum">The enum type.</typeparam>
  451. <param name="selection">Indicates what members to include.</param>
  452. <returns><typeparamref name="TEnum"/>'s member count.</returns>
  453. <exception cref="T:System.ArgumentException"><paramref name="selection"/> is an invalid value.</exception>
  454. </member>
  455. <member name="M:EnumsNET.Enums.GetMembers``1(EnumsNET.EnumMemberSelection)">
  456. <summary>
  457. Retrieves <typeparamref name="TEnum"/>'s members in increasing value order.
  458. The parameter <paramref name="selection"/> indicates what members to include.
  459. </summary>
  460. <typeparam name="TEnum">The enum type.</typeparam>
  461. <param name="selection">Indicates what members to include.</param>
  462. <returns><typeparamref name="TEnum"/>'s members in increasing value order.</returns>
  463. <exception cref="T:System.ArgumentException"><paramref name="selection"/> is an invalid value.</exception>
  464. </member>
  465. <member name="M:EnumsNET.Enums.GetNames``1(EnumsNET.EnumMemberSelection)">
  466. <summary>
  467. Retrieves <typeparamref name="TEnum"/>'s members' names in increasing value order.
  468. The parameter <paramref name="selection"/> indicates what members to include.
  469. </summary>
  470. <typeparam name="TEnum">The enum type.</typeparam>
  471. <param name="selection">Indicates what members to include.</param>
  472. <returns><typeparamref name="TEnum"/>'s members' names in increasing value order.</returns>
  473. <exception cref="T:System.ArgumentException"><paramref name="selection"/> is an invalid value.</exception>
  474. </member>
  475. <member name="M:EnumsNET.Enums.GetValues``1(EnumsNET.EnumMemberSelection)">
  476. <summary>
  477. Retrieves <typeparamref name="TEnum"/>'s members' values in increasing value order.
  478. The parameter <paramref name="selection"/> indicates what members to include.
  479. </summary>
  480. <typeparam name="TEnum">The enum type.</typeparam>
  481. <param name="selection">Indicates what members to include.</param>
  482. <returns><typeparamref name="TEnum"/>'s members' values in increasing value order.</returns>
  483. <exception cref="T:System.ArgumentException"><paramref name="selection"/> is an invalid value.</exception>
  484. </member>
  485. <member name="M:EnumsNET.Enums.ToObject``1(System.Object,EnumsNET.EnumValidation)">
  486. <summary>
  487. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  488. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  489. </summary>
  490. <typeparam name="TEnum">The enum type.</typeparam>
  491. <param name="value">Value to convert. Must be an <see cref="T:System.SByte"/>, <see cref="T:System.Byte"/>, <see cref="T:System.Int16"/>, <see cref="T:System.UInt16"/>,
  492. <see cref="T:System.Int32"/>, <see cref="T:System.UInt32"/>, <see cref="T:System.Int64"/>, <see cref="T:System.UInt64"/>, <typeparamref name="TEnum"/>, <see cref="T:System.String"/>, or Nullable of one of these.</param>
  493. <param name="validation">The validation to perform on the result.</param>
  494. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  495. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  496. <exception cref="T:System.ArgumentException"><paramref name="value"/> is not a valid type
  497. -or-
  498. <paramref name="validation"/> is an invalid value
  499. -or-
  500. the result is invalid with the specified <paramref name="validation"/>.</exception>
  501. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  502. </member>
  503. <member name="M:EnumsNET.Enums.ToObject``1(System.SByte,EnumsNET.EnumValidation)">
  504. <summary>
  505. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  506. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  507. </summary>
  508. <typeparam name="TEnum">The enum type.</typeparam>
  509. <param name="value">Value to convert.</param>
  510. <param name="validation">The validation to perform on the result.</param>
  511. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  512. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value
  513. -or-
  514. the result is invalid with the specified <paramref name="validation"/>.</exception>
  515. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  516. </member>
  517. <member name="M:EnumsNET.Enums.ToObject``1(System.Byte,EnumsNET.EnumValidation)">
  518. <summary>
  519. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  520. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  521. </summary>
  522. <typeparam name="TEnum">The enum type.</typeparam>
  523. <param name="value">Value to convert.</param>
  524. <param name="validation">The validation to perform on the result.</param>
  525. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  526. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value
  527. -or-
  528. the result is invalid with the specified <paramref name="validation"/>.</exception>
  529. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  530. </member>
  531. <member name="M:EnumsNET.Enums.ToObject``1(System.Int16,EnumsNET.EnumValidation)">
  532. <summary>
  533. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  534. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  535. </summary>
  536. <typeparam name="TEnum">The enum type.</typeparam>
  537. <param name="value">Value to convert.</param>
  538. <param name="validation">The validation to perform on the result.</param>
  539. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  540. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value
  541. -or-
  542. the result is invalid with the specified <paramref name="validation"/>.</exception>
  543. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  544. </member>
  545. <member name="M:EnumsNET.Enums.ToObject``1(System.UInt16,EnumsNET.EnumValidation)">
  546. <summary>
  547. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  548. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  549. </summary>
  550. <typeparam name="TEnum">The enum type.</typeparam>
  551. <param name="value">Value to convert.</param>
  552. <param name="validation">The validation to perform on the result.</param>
  553. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  554. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value
  555. -or-
  556. the result is invalid with the specified <paramref name="validation"/>.</exception>
  557. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  558. </member>
  559. <member name="M:EnumsNET.Enums.ToObject``1(System.Int32,EnumsNET.EnumValidation)">
  560. <summary>
  561. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  562. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  563. </summary>
  564. <typeparam name="TEnum">The enum type.</typeparam>
  565. <param name="value">Value to convert.</param>
  566. <param name="validation">The validation to perform on the result.</param>
  567. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  568. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value
  569. -or-
  570. the result is invalid with the specified <paramref name="validation"/>.</exception>
  571. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  572. </member>
  573. <member name="M:EnumsNET.Enums.ToObject``1(System.UInt32,EnumsNET.EnumValidation)">
  574. <summary>
  575. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  576. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  577. </summary>
  578. <typeparam name="TEnum">The enum type.</typeparam>
  579. <param name="value">Value to convert.</param>
  580. <param name="validation">The validation to perform on the result.</param>
  581. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  582. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value
  583. -or-
  584. the result is invalid with the specified <paramref name="validation"/>.</exception>
  585. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  586. </member>
  587. <member name="M:EnumsNET.Enums.ToObject``1(System.Int64,EnumsNET.EnumValidation)">
  588. <summary>
  589. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  590. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  591. </summary>
  592. <typeparam name="TEnum">The enum type.</typeparam>
  593. <param name="value">Value to convert.</param>
  594. <param name="validation">The validation to perform on the result.</param>
  595. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  596. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value
  597. -or-
  598. the result is invalid with the specified <paramref name="validation"/>.</exception>
  599. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  600. </member>
  601. <member name="M:EnumsNET.Enums.ToObject``1(System.UInt64,EnumsNET.EnumValidation)">
  602. <summary>
  603. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  604. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  605. </summary>
  606. <typeparam name="TEnum">The enum type.</typeparam>
  607. <param name="value">Value to convert.</param>
  608. <param name="validation">The validation to perform on the result.</param>
  609. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  610. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value
  611. -or-
  612. the result is invalid with the specified <paramref name="validation"/>.</exception>
  613. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  614. </member>
  615. <member name="M:EnumsNET.Enums.TryToObject``1(System.Object,``0@,EnumsNET.EnumValidation)">
  616. <summary>
  617. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  618. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  619. The return value indicates whether the conversion succeeded.
  620. </summary>
  621. <typeparam name="TEnum">The enum type.</typeparam>
  622. <param name="value">Value to try to convert. Must be an <see cref="T:System.SByte"/>, <see cref="T:System.Byte"/>, <see cref="T:System.Int16"/>, <see cref="T:System.UInt16"/>,
  623. <see cref="T:System.Int32"/>, <see cref="T:System.UInt32"/>, <see cref="T:System.Int64"/>, <see cref="T:System.UInt64"/>, <typeparamref name="TEnum"/>, <see cref="T:System.String"/>, or Nullable of one of these.</param>
  624. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  625. <param name="validation">The validation to perform on the result.</param>
  626. <returns>Indication whether the conversion succeeded.</returns>
  627. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value.</exception>
  628. </member>
  629. <member name="M:EnumsNET.Enums.TryToObject``1(System.SByte,``0@,EnumsNET.EnumValidation)">
  630. <summary>
  631. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  632. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  633. The return value indicates whether the conversion succeeded.
  634. </summary>
  635. <typeparam name="TEnum">The enum type.</typeparam>
  636. <param name="value">Value to try to convert.</param>
  637. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  638. <param name="validation">The validation to perform on the result.</param>
  639. <returns>Indication whether the conversion succeeded.</returns>
  640. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value.</exception>
  641. </member>
  642. <member name="M:EnumsNET.Enums.TryToObject``1(System.Byte,``0@,EnumsNET.EnumValidation)">
  643. <summary>
  644. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  645. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  646. The return value indicates whether the conversion succeeded.
  647. </summary>
  648. <typeparam name="TEnum">The enum type.</typeparam>
  649. <param name="value">Value to try to convert.</param>
  650. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  651. <param name="validation">The validation to perform on the result.</param>
  652. <returns>Indication whether the conversion succeeded.</returns>
  653. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value.</exception>
  654. </member>
  655. <member name="M:EnumsNET.Enums.TryToObject``1(System.Int16,``0@,EnumsNET.EnumValidation)">
  656. <summary>
  657. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  658. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  659. The return value indicates whether the conversion succeeded.
  660. </summary>
  661. <typeparam name="TEnum">The enum type.</typeparam>
  662. <param name="value">Value to try to convert.</param>
  663. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  664. <param name="validation">The validation to perform on the result.</param>
  665. <returns>Indication whether the conversion succeeded.</returns>
  666. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value.</exception>
  667. </member>
  668. <member name="M:EnumsNET.Enums.TryToObject``1(System.UInt16,``0@,EnumsNET.EnumValidation)">
  669. <summary>
  670. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  671. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  672. The return value indicates whether the conversion succeeded.
  673. </summary>
  674. <typeparam name="TEnum">The enum type.</typeparam>
  675. <param name="value">Value to try to convert.</param>
  676. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  677. <param name="validation">The validation to perform on the result.</param>
  678. <returns>Indication whether the conversion succeeded.</returns>
  679. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value.</exception>
  680. </member>
  681. <member name="M:EnumsNET.Enums.TryToObject``1(System.Int32,``0@,EnumsNET.EnumValidation)">
  682. <summary>
  683. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  684. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  685. The return value indicates whether the conversion succeeded.
  686. </summary>
  687. <typeparam name="TEnum">The enum type.</typeparam>
  688. <param name="value">Value to try to convert.</param>
  689. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  690. <param name="validation">The validation to perform on the result.</param>
  691. <returns>Indication whether the conversion succeeded.</returns>
  692. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value.</exception>
  693. </member>
  694. <member name="M:EnumsNET.Enums.TryToObject``1(System.UInt32,``0@,EnumsNET.EnumValidation)">
  695. <summary>
  696. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  697. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  698. The return value indicates whether the conversion succeeded.
  699. </summary>
  700. <typeparam name="TEnum">The enum type.</typeparam>
  701. <param name="value">Value to try to convert.</param>
  702. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  703. <param name="validation">The validation to perform on the result.</param>
  704. <returns>Indication whether the conversion succeeded.</returns>
  705. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value.</exception>
  706. </member>
  707. <member name="M:EnumsNET.Enums.TryToObject``1(System.Int64,``0@,EnumsNET.EnumValidation)">
  708. <summary>
  709. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  710. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  711. The return value indicates whether the conversion succeeded.
  712. </summary>
  713. <typeparam name="TEnum">The enum type.</typeparam>
  714. <param name="value">Value to try to convert.</param>
  715. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  716. <param name="validation">The validation to perform on the result.</param>
  717. <returns>Indication whether the conversion succeeded.</returns>
  718. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value.</exception>
  719. </member>
  720. <member name="M:EnumsNET.Enums.TryToObject``1(System.UInt64,``0@,EnumsNET.EnumValidation)">
  721. <summary>
  722. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  723. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  724. The return value indicates whether the conversion succeeded.
  725. </summary>
  726. <typeparam name="TEnum">The enum type.</typeparam>
  727. <param name="value">Value to try to convert.</param>
  728. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  729. <param name="validation">The validation to perform on the result.</param>
  730. <returns>Indication whether the conversion succeeded.</returns>
  731. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value.</exception>
  732. </member>
  733. <member name="M:EnumsNET.Enums.IsValid``1(``0,EnumsNET.EnumValidation)">
  734. <summary>
  735. Indicates if <paramref name="value"/> is valid using the specified <paramref name="validation"/>.
  736. </summary>
  737. <typeparam name="TEnum">The enum type.</typeparam>
  738. <param name="value">The enum value.</param>
  739. <param name="validation">The validation to perform on the value.</param>
  740. <returns>Indication if <paramref name="value"/> is valid.</returns>
  741. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value.</exception>
  742. </member>
  743. <member name="M:EnumsNET.Enums.IsDefined``1(``0)">
  744. <summary>
  745. Indicates if <paramref name="value"/> is defined.
  746. </summary>
  747. <typeparam name="TEnum">The enum type.</typeparam>
  748. <param name="value">The enum value.</param>
  749. <returns>Indication if <paramref name="value"/> is defined.</returns>
  750. </member>
  751. <member name="M:EnumsNET.Enums.Validate``1(``0,System.String,EnumsNET.EnumValidation)">
  752. <summary>
  753. Validates that <paramref name="value"/> is valid using the specified <paramref name="validation"/>.
  754. If it's not it throws an <see cref="T:System.ArgumentException"/> with the specified <paramref name="paramName"/>.
  755. </summary>
  756. <typeparam name="TEnum">The enum type.</typeparam>
  757. <param name="value">The enum value.</param>
  758. <param name="paramName">The parameter name to be used if throwing an <see cref="T:System.ArgumentException"/>.</param>
  759. <param name="validation">The validation to perform on the value.</param>
  760. <returns><paramref name="value"/> for use in fluent API's and base constructor method calls.</returns>
  761. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value
  762. -or-
  763. <paramref name="value"/> is invalid.</exception>
  764. </member>
  765. <member name="M:EnumsNET.Enums.AsString``1(``0)">
  766. <summary>
  767. Converts the specified <paramref name="value"/> to its string representation.
  768. </summary>
  769. <typeparam name="TEnum">The enum type.</typeparam>
  770. <param name="value">The enum value.</param>
  771. <returns>A string representation of <paramref name="value"/>.</returns>
  772. </member>
  773. <member name="M:EnumsNET.Enums.AsString``1(``0,System.String)">
  774. <summary>
  775. Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="format"/>.
  776. </summary>
  777. <typeparam name="TEnum">The enum type.</typeparam>
  778. <param name="value">The enum value.</param>
  779. <param name="format">The output format to use.</param>
  780. <returns>A string representation of <paramref name="value"/>.</returns>
  781. <exception cref="T:System.FormatException"><paramref name="format"/> is an invalid value.</exception>
  782. </member>
  783. <member name="M:EnumsNET.Enums.AsString``1(``0,EnumsNET.EnumFormat)">
  784. <summary>
  785. Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="format"/>.
  786. </summary>
  787. <typeparam name="TEnum">The enum type.</typeparam>
  788. <param name="value">The enum value.</param>
  789. <param name="format">The output format to use.</param>
  790. <returns>A string representation of <paramref name="value"/>.</returns>
  791. <exception cref="T:System.ArgumentException"><paramref name="format"/> is an invalid value.</exception>
  792. </member>
  793. <member name="M:EnumsNET.Enums.AsString``1(``0,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  794. <summary>
  795. Converts the specified <paramref name="value"/> to its string representation using the specified formats.
  796. </summary>
  797. <typeparam name="TEnum">The enum type.</typeparam>
  798. <param name="value">The enum value.</param>
  799. <param name="format0">The first output format to use.</param>
  800. <param name="format1">The second output format to use if using the first resolves to <c>null</c>.</param>
  801. <returns>A string representation of <paramref name="value"/>.</returns>
  802. <exception cref="T:System.ArgumentException"><paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  803. </member>
  804. <member name="M:EnumsNET.Enums.AsString``1(``0,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  805. <summary>
  806. Converts the specified <paramref name="value"/> to its string representation using the specified formats.
  807. </summary>
  808. <typeparam name="TEnum">The enum type.</typeparam>
  809. <param name="value">The enum value.</param>
  810. <param name="format0">The first output format to use.</param>
  811. <param name="format1">The second output format to use if using the first resolves to <c>null</c>.</param>
  812. <param name="format2">The third output format to use if using the first and second both resolve to <c>null</c>.</param>
  813. <returns>A string representation of <paramref name="value"/>.</returns>
  814. <exception cref="T:System.ArgumentException"><paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  815. </member>
  816. <member name="M:EnumsNET.Enums.AsString``1(``0,EnumsNET.EnumFormat[])">
  817. <summary>
  818. Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="formats"/>.
  819. </summary>
  820. <typeparam name="TEnum">The enum type.</typeparam>
  821. <param name="value">The enum value.</param>
  822. <param name="formats">The output formats to use.</param>
  823. <returns>A string representation of <paramref name="value"/>.</returns>
  824. <exception cref="T:System.ArgumentException"><paramref name="formats"/> contains an invalid value.</exception>
  825. </member>
  826. <member name="M:EnumsNET.Enums.TryFormat``1(``0,System.Span{System.Char},System.Int32@)">
  827. <summary>
  828. Tries to format the value of the enum value into the provided span of characters.
  829. </summary>
  830. <typeparam name="TEnum">The enum type.</typeparam>
  831. <param name="value">The enum value.</param>
  832. <param name="destination">When this method returns, value formatted as a span of characters.</param>
  833. <param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination"/>.</param>
  834. <returns><c>true</c> if the formatting was successful; otherwise, <c>false</c>.</returns>
  835. </member>
  836. <member name="M:EnumsNET.Enums.TryFormat``1(``0,System.Span{System.Char},System.Int32@,System.ReadOnlySpan{System.Char})">
  837. <summary>
  838. Tries to format the value of the enum value into the provided span of characters.
  839. </summary>
  840. <typeparam name="TEnum">The enum type.</typeparam>
  841. <param name="value">The enum value.</param>
  842. <param name="destination">When this method returns, value formatted as a span of characters.</param>
  843. <param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination"/>.</param>
  844. <param name="format">The output format to use.</param>
  845. <returns><c>true</c> if the formatting was successful; otherwise, <c>false</c>.</returns>
  846. <exception cref="T:System.FormatException"><paramref name="format"/> is an invalid value.</exception>
  847. </member>
  848. <member name="M:EnumsNET.Enums.TryFormat``1(``0,System.Span{System.Char},System.Int32@,EnumsNET.EnumFormat[])">
  849. <summary>
  850. Tries to format the value of the enum value into the provided span of characters.
  851. </summary>
  852. <typeparam name="TEnum">The enum type.</typeparam>
  853. <param name="value">The enum value.</param>
  854. <param name="destination">When this method returns, value formatted as a span of characters.</param>
  855. <param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination"/>.</param>
  856. <param name="formats">The output formats to use.</param>
  857. <returns><c>true</c> if the formatting was successful; otherwise, <c>false</c>.</returns>
  858. <exception cref="T:System.ArgumentException"><paramref name="formats"/> contains an invalid value.</exception>
  859. </member>
  860. <member name="M:EnumsNET.Enums.Format``1(``0,System.String)">
  861. <summary>
  862. Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="format"/>.
  863. </summary>
  864. <typeparam name="TEnum">The enum type.</typeparam>
  865. <param name="value">The enum value.</param>
  866. <param name="format">The output format to use.</param>
  867. <returns>A string representation of <paramref name="value"/>.</returns>
  868. <exception cref="T:System.ArgumentNullException"><paramref name="format"/> is <c>null</c>.</exception>
  869. <exception cref="T:System.FormatException"><paramref name="format"/> is an invalid value.</exception>
  870. </member>
  871. <member name="M:EnumsNET.Enums.GetUnderlyingValue``1(``0)">
  872. <summary>
  873. Returns <paramref name="value"/>'s underlying integral value.
  874. </summary>
  875. <typeparam name="TEnum">The enum type.</typeparam>
  876. <param name="value">The enum value.</param>
  877. <returns><paramref name="value"/>'s underlying integral value.</returns>
  878. </member>
  879. <member name="M:EnumsNET.Enums.ToSByte``1(``0)">
  880. <summary>
  881. Converts <paramref name="value"/> to an <see cref="T:System.SByte"/>.
  882. </summary>
  883. <typeparam name="TEnum">The enum type.</typeparam>
  884. <param name="value">The enum value.</param>
  885. <returns><paramref name="value"/> converted to an <see cref="T:System.SByte"/>.</returns>
  886. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.SByte"/>'s value range without overflowing.</exception>
  887. </member>
  888. <member name="M:EnumsNET.Enums.ToByte``1(``0)">
  889. <summary>
  890. Converts <paramref name="value"/> to a <see cref="T:System.Byte"/>.
  891. </summary>
  892. <typeparam name="TEnum">The enum type.</typeparam>
  893. <param name="value">The enum value.</param>
  894. <returns><paramref name="value"/> converted to a <see cref="T:System.Byte"/>.</returns>
  895. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Byte"/>'s value range without overflowing.</exception>
  896. </member>
  897. <member name="M:EnumsNET.Enums.ToInt16``1(``0)">
  898. <summary>
  899. Converts <paramref name="value"/> to an <see cref="T:System.Int16"/>.
  900. </summary>
  901. <typeparam name="TEnum">The enum type.</typeparam>
  902. <param name="value">The enum value.</param>
  903. <returns><paramref name="value"/> converted to an <see cref="T:System.Int16"/>.</returns>
  904. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Int16"/>'s value range without overflowing.</exception>
  905. </member>
  906. <member name="M:EnumsNET.Enums.ToUInt16``1(``0)">
  907. <summary>
  908. Converts <paramref name="value"/> to a <see cref="T:System.UInt16"/>.
  909. </summary>
  910. <typeparam name="TEnum">The enum type.</typeparam>
  911. <param name="value">The enum value.</param>
  912. <returns><paramref name="value"/> converted to a <see cref="T:System.UInt16"/>.</returns>
  913. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.UInt16"/>'s value range without overflowing.</exception>
  914. </member>
  915. <member name="M:EnumsNET.Enums.ToInt32``1(``0)">
  916. <summary>
  917. Converts <paramref name="value"/> to an <see cref="T:System.Int32"/>.
  918. </summary>
  919. <typeparam name="TEnum">The enum type.</typeparam>
  920. <param name="value">The enum value.</param>
  921. <returns><paramref name="value"/> converted to an <see cref="T:System.Int32"/>.</returns>
  922. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Int32"/>'s value range without overflowing.</exception>
  923. </member>
  924. <member name="M:EnumsNET.Enums.ToUInt32``1(``0)">
  925. <summary>
  926. Converts <paramref name="value"/> to a <see cref="T:System.UInt32"/>.
  927. </summary>
  928. <typeparam name="TEnum">The enum type.</typeparam>
  929. <param name="value">The enum value.</param>
  930. <returns><paramref name="value"/> converted to a <see cref="T:System.UInt32"/>.</returns>
  931. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.UInt32"/>'s value range without overflowing.</exception>
  932. </member>
  933. <member name="M:EnumsNET.Enums.ToInt64``1(``0)">
  934. <summary>
  935. Converts <paramref name="value"/> to an <see cref="T:System.Int64"/>.
  936. </summary>
  937. <typeparam name="TEnum">The enum type.</typeparam>
  938. <param name="value">The enum value.</param>
  939. <returns><paramref name="value"/> converted to an <see cref="T:System.Int64"/>.</returns>
  940. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Int64"/>'s value range without overflowing.</exception>
  941. </member>
  942. <member name="M:EnumsNET.Enums.ToUInt64``1(``0)">
  943. <summary>
  944. Converts <paramref name="value"/> to a <see cref="T:System.UInt64"/>.
  945. </summary>
  946. <typeparam name="TEnum">The enum type.</typeparam>
  947. <param name="value">The enum value.</param>
  948. <returns><paramref name="value"/> converted to a <see cref="T:System.UInt64"/>.</returns>
  949. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.UInt64"/>'s value range without overflowing.</exception>
  950. </member>
  951. <member name="M:EnumsNET.Enums.GetHashCode``1(``0)">
  952. <summary>
  953. Retrieves the hash code of <paramref name="value"/>. It's more efficient as it doesn't require boxing and unboxing of <paramref name="value"/>.
  954. </summary>
  955. <typeparam name="TEnum">The enum type.</typeparam>
  956. <param name="value">The enum value.</param>
  957. <returns>Hash code of <paramref name="value"/>.</returns>
  958. </member>
  959. <member name="M:EnumsNET.Enums.Equals``1(``0,``0)">
  960. <summary>
  961. Indicates if <paramref name="value"/> equals <paramref name="other"/>.
  962. </summary>
  963. <typeparam name="TEnum">The enum type.</typeparam>
  964. <param name="value">The enum value.</param>
  965. <param name="other">The other enum value.</param>
  966. <returns>Indication if <paramref name="value"/> equals <paramref name="other"/>.</returns>
  967. </member>
  968. <member name="M:EnumsNET.Enums.CompareTo``1(``0,``0)">
  969. <summary>
  970. Compares <paramref name="value"/> to <paramref name="other"/> for ordering.
  971. </summary>
  972. <typeparam name="TEnum">The enum type.</typeparam>
  973. <param name="value">The enum value.</param>
  974. <param name="other">The other enum value.</param>
  975. <returns>1 if <paramref name="value"/> is greater than <paramref name="other"/>, 0 if <paramref name="value"/> equals <paramref name="other"/>,
  976. and -1 if <paramref name="value"/> is less than <paramref name="other"/>.</returns>
  977. </member>
  978. <member name="M:EnumsNET.Enums.GetName``1(``0)">
  979. <summary>
  980. Retrieves <paramref name="value"/>'s enum member name if defined otherwise <c>null</c>.
  981. </summary>
  982. <typeparam name="TEnum">The enum type.</typeparam>
  983. <param name="value">The enum value.</param>
  984. <returns><paramref name="value"/>'s enum member name if defined otherwise <c>null</c>.</returns>
  985. </member>
  986. <member name="M:EnumsNET.Enums.GetAttributes``1(``0)">
  987. <summary>
  988. Retrieves <paramref name="value"/>'s enum member attributes if defined otherwise <c>null</c>.
  989. </summary>
  990. <typeparam name="TEnum">The enum type.</typeparam>
  991. <param name="value">The enum value.</param>
  992. <returns><paramref name="value"/>'s enum member attributes if defined otherwise <c>null</c>.</returns>
  993. </member>
  994. <member name="M:EnumsNET.Enums.GetMember``1(``0)">
  995. <summary>
  996. Retrieves an enum member with the specified <paramref name="value"/> if defined otherwise <c>null</c>.
  997. </summary>
  998. <typeparam name="TEnum">The enum type.</typeparam>
  999. <param name="value">The enum value.</param>
  1000. <returns>Enum member with the specified <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
  1001. </member>
  1002. <member name="M:EnumsNET.Enums.GetMember``1(System.String)">
  1003. <summary>
  1004. Retrieves the enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.
  1005. </summary>
  1006. <typeparam name="TEnum">The enum type.</typeparam>
  1007. <param name="name">The enum member name.</param>
  1008. <returns>Enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.</returns>
  1009. <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <c>null</c>.</exception>
  1010. </member>
  1011. <member name="M:EnumsNET.Enums.GetMember``1(System.String,System.Boolean)">
  1012. <summary>
  1013. Retrieves the enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.
  1014. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  1015. </summary>
  1016. <typeparam name="TEnum">The enum type.</typeparam>
  1017. <param name="name">The enum member name.</param>
  1018. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1019. <returns>Enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.</returns>
  1020. <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <c>null</c>.</exception>
  1021. </member>
  1022. <member name="M:EnumsNET.Enums.GetMember``1(System.String,System.Boolean,EnumsNET.EnumFormat)">
  1023. <summary>
  1024. Retrieves an enum member whose string representation using the specified <paramref name="format"/> is <paramref name="value"/> if defined otherwise <c>null</c>.
  1025. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  1026. </summary>
  1027. <typeparam name="TEnum">The enum type.</typeparam>
  1028. <param name="value">The enum member's string representation.</param>
  1029. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1030. <param name="format">The parsing enum format.</param>
  1031. <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
  1032. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1033. <exception cref="T:System.ArgumentException"><paramref name="format"/> is an invalid value.</exception>
  1034. </member>
  1035. <member name="M:EnumsNET.Enums.GetMember``1(System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  1036. <summary>
  1037. Retrieves an enum member whose string representation using the specified formats is <paramref name="value"/> if defined otherwise <c>null</c>.
  1038. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  1039. </summary>
  1040. <typeparam name="TEnum">The enum type.</typeparam>
  1041. <param name="value">The enum member's string representation.</param>
  1042. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1043. <param name="format0">The first parsing enum format.</param>
  1044. <param name="format1">The second parsing enum format.</param>
  1045. <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
  1046. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1047. <exception cref="T:System.ArgumentException"><paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  1048. </member>
  1049. <member name="M:EnumsNET.Enums.GetMember``1(System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  1050. <summary>
  1051. Retrieves an enum member whose string representation using the specified formats is <paramref name="value"/> if defined otherwise <c>null</c>.
  1052. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  1053. </summary>
  1054. <typeparam name="TEnum">The enum type.</typeparam>
  1055. <param name="value">The enum member's string representation.</param>
  1056. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1057. <param name="format0">The first parsing enum format.</param>
  1058. <param name="format1">The second parsing enum format.</param>
  1059. <param name="format2">The third parsing enum format.</param>
  1060. <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
  1061. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1062. <exception cref="T:System.ArgumentException"><paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  1063. </member>
  1064. <member name="M:EnumsNET.Enums.GetMember``1(System.String,System.Boolean,EnumsNET.EnumFormat[])">
  1065. <summary>
  1066. Retrieves an enum member whose string representation using the specified <paramref name="formats"/> is <paramref name="value"/> if defined otherwise <c>null</c>.
  1067. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  1068. </summary>
  1069. <typeparam name="TEnum">The enum type.</typeparam>
  1070. <param name="value">The enum member's string representation.</param>
  1071. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1072. <param name="formats">The parsing enum formats.</param>
  1073. <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
  1074. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1075. <exception cref="T:System.ArgumentException"><paramref name="formats"/> contains an invalid value.</exception>
  1076. </member>
  1077. <member name="M:EnumsNET.Enums.Parse``1(System.String)">
  1078. <summary>
  1079. Converts the string representation of one or more member names or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value.
  1080. </summary>
  1081. <typeparam name="TEnum">The enum type.</typeparam>
  1082. <param name="value">The enum member names or values' string representation.</param>
  1083. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  1084. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1085. <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member name or value of <typeparamref name="TEnum"/>.</exception>
  1086. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  1087. </member>
  1088. <member name="M:EnumsNET.Enums.Parse``1(System.String,System.Boolean)">
  1089. <summary>
  1090. Converts the string representation of one or more member names or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value.
  1091. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  1092. </summary>
  1093. <typeparam name="TEnum">The enum type.</typeparam>
  1094. <param name="value">The enum member names or values' string representation.</param>
  1095. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1096. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  1097. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1098. <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member name or value of <typeparamref name="TEnum"/>.</exception>
  1099. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  1100. </member>
  1101. <member name="M:EnumsNET.Enums.Parse``1(System.String,System.Boolean,EnumsNET.EnumFormat)">
  1102. <summary>
  1103. Converts the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
  1104. using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  1105. </summary>
  1106. <typeparam name="TEnum">The enum type.</typeparam>
  1107. <param name="value">The enum members or values' string representation.</param>
  1108. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1109. <param name="format">The parsing enum format.</param>
  1110. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  1111. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1112. <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
  1113. -or-
  1114. <paramref name="format"/> is an invalid value.</exception>
  1115. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  1116. </member>
  1117. <member name="M:EnumsNET.Enums.Parse``1(System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  1118. <summary>
  1119. Converts the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
  1120. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  1121. </summary>
  1122. <typeparam name="TEnum">The enum type.</typeparam>
  1123. <param name="value">The enum members or values' string representation.</param>
  1124. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1125. <param name="format0">The first parsing enum format.</param>
  1126. <param name="format1">The second parsing enum format.</param>
  1127. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  1128. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1129. <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
  1130. -or-
  1131. <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  1132. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  1133. </member>
  1134. <member name="M:EnumsNET.Enums.Parse``1(System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  1135. <summary>
  1136. Converts the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
  1137. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  1138. </summary>
  1139. <typeparam name="TEnum">The enum type.</typeparam>
  1140. <param name="value">The enum members or values' string representation.</param>
  1141. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1142. <param name="format0">The first parsing enum format.</param>
  1143. <param name="format1">The second parsing enum format.</param>
  1144. <param name="format2">The third parsing enum format.</param>
  1145. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  1146. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1147. <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
  1148. -or-
  1149. <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  1150. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  1151. </member>
  1152. <member name="M:EnumsNET.Enums.Parse``1(System.String,System.Boolean,EnumsNET.EnumFormat[])">
  1153. <summary>
  1154. Converts the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
  1155. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  1156. </summary>
  1157. <typeparam name="TEnum">The enum type.</typeparam>
  1158. <param name="value">The enum members or values' string representation.</param>
  1159. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1160. <param name="formats">The parsing enum formats.</param>
  1161. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  1162. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1163. <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
  1164. -or-
  1165. <paramref name="formats"/> contains an invalid value.</exception>
  1166. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  1167. </member>
  1168. <member name="M:EnumsNET.Enums.TryParse``1(System.String,``0@)">
  1169. <summary>
  1170. Tries to convert the string representation of one or more member names or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value.
  1171. The return value indicates whether the conversion succeeded.
  1172. </summary>
  1173. <typeparam name="TEnum">The enum type.</typeparam>
  1174. <param name="value">The enum member names or values' string representation.</param>
  1175. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  1176. <returns>Indication whether the conversion succeeded.</returns>
  1177. </member>
  1178. <member name="M:EnumsNET.Enums.TryParse``1(System.String,System.Boolean,``0@)">
  1179. <summary>
  1180. Tries to convert the string representation of one or more member names or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value.
  1181. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive. The return value indicates whether the conversion succeeded.
  1182. </summary>
  1183. <typeparam name="TEnum">The enum type.</typeparam>
  1184. <param name="value">The enum member names or values' string representation.</param>
  1185. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1186. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  1187. <returns>Indication whether the conversion succeeded.</returns>
  1188. </member>
  1189. <member name="M:EnumsNET.Enums.TryParse``1(System.String,System.Boolean,``0@,EnumsNET.EnumFormat)">
  1190. <summary>
  1191. Tries to convert the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
  1192. using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  1193. The return value indicates whether the conversion succeeded.
  1194. </summary>
  1195. <typeparam name="TEnum">The enum type.</typeparam>
  1196. <param name="value">The enum members or values' string representation.</param>
  1197. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1198. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  1199. <param name="format">The parsing enum format.</param>
  1200. <returns>Indication whether the conversion succeeded.</returns>
  1201. <exception cref="T:System.ArgumentException"><paramref name="format"/> is an invalid value.</exception>
  1202. </member>
  1203. <member name="M:EnumsNET.Enums.TryParse``1(System.String,System.Boolean,``0@,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  1204. <summary>
  1205. Tries to convert the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
  1206. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  1207. The return value indicates whether the conversion succeeded.
  1208. </summary>
  1209. <typeparam name="TEnum">The enum type.</typeparam>
  1210. <param name="value">The enum members or values' string representation.</param>
  1211. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1212. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  1213. <param name="format0">The first parsing enum format.</param>
  1214. <param name="format1">The second parsing enum format.</param>
  1215. <returns>Indication whether the conversion succeeded.</returns>
  1216. <exception cref="T:System.ArgumentException"><paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  1217. </member>
  1218. <member name="M:EnumsNET.Enums.TryParse``1(System.String,System.Boolean,``0@,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  1219. <summary>
  1220. Tries to convert the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
  1221. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  1222. The return value indicates whether the conversion succeeded.
  1223. </summary>
  1224. <typeparam name="TEnum">The enum type.</typeparam>
  1225. <param name="value">The enum members or values' string representation.</param>
  1226. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1227. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  1228. <param name="format0">The first parsing enum format.</param>
  1229. <param name="format1">The second parsing enum format.</param>
  1230. <param name="format2">The third parsing enum format.</param>
  1231. <returns>Indication whether the conversion succeeded.</returns>
  1232. <exception cref="T:System.ArgumentException"><paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  1233. </member>
  1234. <member name="M:EnumsNET.Enums.TryParse``1(System.String,System.Boolean,``0@,EnumsNET.EnumFormat[])">
  1235. <summary>
  1236. Tries to convert the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
  1237. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  1238. The return value indicates whether the conversion succeeded.
  1239. </summary>
  1240. <typeparam name="TEnum">The enum type.</typeparam>
  1241. <param name="value">The enum members or values' string representation.</param>
  1242. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1243. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  1244. <param name="formats">The parsing enum formats.</param>
  1245. <returns>Indication whether the conversion succeeded.</returns>
  1246. <exception cref="T:System.ArgumentException"><paramref name="formats"/> contains an invalid value.</exception>
  1247. </member>
  1248. <member name="M:EnumsNET.Enums.GetUnderlyingTypeUnsafe``1">
  1249. <summary>
  1250. Retrieves the underlying type of <typeparamref name="TEnum"/>.
  1251. </summary>
  1252. <typeparam name="TEnum">The enum type.</typeparam>
  1253. <returns>The underlying type of <typeparamref name="TEnum"/>.</returns>
  1254. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1255. </member>
  1256. <member name="M:EnumsNET.Enums.GetTypeCodeUnsafe``1">
  1257. <summary>
  1258. Retrieves <typeparamref name="TEnum"/>'s underlying type's <see cref="T:System.TypeCode"/>.
  1259. </summary>
  1260. <typeparam name="TEnum">The enum type.</typeparam>
  1261. <returns><typeparamref name="TEnum"/>'s underlying type's <see cref="T:System.TypeCode"/>.</returns>
  1262. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1263. </member>
  1264. <member name="M:EnumsNET.Enums.GetMemberCountUnsafe``1(EnumsNET.EnumMemberSelection)">
  1265. <summary>
  1266. Retrieves <typeparamref name="TEnum"/>'s member count.
  1267. The parameter <paramref name="selection"/> indicates what members to include.
  1268. </summary>
  1269. <typeparam name="TEnum">The enum type.</typeparam>
  1270. <param name="selection">Indicates what members to include.</param>
  1271. <returns><typeparamref name="TEnum"/>'s member count.</returns>
  1272. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1273. -or-
  1274. <paramref name="selection"/> is an invalid value.</exception>
  1275. </member>
  1276. <member name="M:EnumsNET.Enums.GetMembersUnsafe``1(EnumsNET.EnumMemberSelection)">
  1277. <summary>
  1278. Retrieves <typeparamref name="TEnum"/>'s members in increasing value order.
  1279. The parameter <paramref name="selection"/> indicates what members to include.
  1280. </summary>
  1281. <typeparam name="TEnum">The enum type.</typeparam>
  1282. <param name="selection">Indicates what members to include.</param>
  1283. <returns><typeparamref name="TEnum"/>'s members in increasing value order.</returns>
  1284. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1285. -or-
  1286. <paramref name="selection"/> is an invalid value.</exception>
  1287. </member>
  1288. <member name="M:EnumsNET.Enums.GetNamesUnsafe``1(EnumsNET.EnumMemberSelection)">
  1289. <summary>
  1290. Retrieves <typeparamref name="TEnum"/>'s members' names in increasing value order.
  1291. The parameter <paramref name="selection"/> indicates what members to include.
  1292. </summary>
  1293. <typeparam name="TEnum">The enum type.</typeparam>
  1294. <param name="selection">Indicates what members to include.</param>
  1295. <returns><typeparamref name="TEnum"/>'s members' names in increasing value order.</returns>
  1296. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1297. -or-
  1298. <paramref name="selection"/> is an invalid value.</exception>
  1299. </member>
  1300. <member name="M:EnumsNET.Enums.GetValuesUnsafe``1(EnumsNET.EnumMemberSelection)">
  1301. <summary>
  1302. Retrieves <typeparamref name="TEnum"/>'s members' values in increasing value order.
  1303. The parameter <paramref name="selection"/> indicates what members to include.
  1304. </summary>
  1305. <typeparam name="TEnum">The enum type.</typeparam>
  1306. <param name="selection">Indicates what members to include.</param>
  1307. <returns><typeparamref name="TEnum"/>'s members' values in increasing value order.</returns>
  1308. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1309. -or-
  1310. <paramref name="selection"/> is an invalid value.</exception>
  1311. </member>
  1312. <member name="M:EnumsNET.Enums.ToObjectUnsafe``1(System.Object,EnumsNET.EnumValidation)">
  1313. <summary>
  1314. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1315. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1316. </summary>
  1317. <typeparam name="TEnum">The enum type.</typeparam>
  1318. <param name="value">Value to convert. Must be an <see cref="T:System.SByte"/>, <see cref="T:System.Byte"/>, <see cref="T:System.Int16"/>, <see cref="T:System.UInt16"/>,
  1319. <see cref="T:System.Int32"/>, <see cref="T:System.UInt32"/>, <see cref="T:System.Int64"/>, <see cref="T:System.UInt64"/>, <typeparamref name="TEnum"/>, <see cref="T:System.String"/>, or Nullable of one of these.</param>
  1320. <param name="validation">The validation to perform on the result.</param>
  1321. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  1322. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1323. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1324. -or-
  1325. <paramref name="value"/> is not a valid type
  1326. -or-
  1327. <paramref name="validation"/> is an invalid value
  1328. -or-
  1329. the result is invalid with the specified <paramref name="validation"/>.</exception>
  1330. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  1331. </member>
  1332. <member name="M:EnumsNET.Enums.ToObjectUnsafe``1(System.SByte,EnumsNET.EnumValidation)">
  1333. <summary>
  1334. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1335. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1336. </summary>
  1337. <typeparam name="TEnum">The enum type.</typeparam>
  1338. <param name="value">Value to convert.</param>
  1339. <param name="validation">The validation to perform on the result.</param>
  1340. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  1341. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1342. -or-
  1343. <paramref name="validation"/> is an invalid value
  1344. -or-
  1345. the result is invalid with the specified <paramref name="validation"/>.</exception>
  1346. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  1347. </member>
  1348. <member name="M:EnumsNET.Enums.ToObjectUnsafe``1(System.Byte,EnumsNET.EnumValidation)">
  1349. <summary>
  1350. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1351. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1352. </summary>
  1353. <typeparam name="TEnum">The enum type.</typeparam>
  1354. <param name="value">Value to convert.</param>
  1355. <param name="validation">The validation to perform on the result.</param>
  1356. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  1357. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1358. -or-
  1359. <paramref name="validation"/> is an invalid value
  1360. -or-
  1361. the result is invalid with the specified <paramref name="validation"/>.</exception>
  1362. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  1363. </member>
  1364. <member name="M:EnumsNET.Enums.ToObjectUnsafe``1(System.Int16,EnumsNET.EnumValidation)">
  1365. <summary>
  1366. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1367. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1368. </summary>
  1369. <typeparam name="TEnum">The enum type.</typeparam>
  1370. <param name="value">Value to convert.</param>
  1371. <param name="validation">The validation to perform on the result.</param>
  1372. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  1373. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1374. -or-
  1375. <paramref name="validation"/> is an invalid value
  1376. -or-
  1377. the result is invalid with the specified <paramref name="validation"/>.</exception>
  1378. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  1379. </member>
  1380. <member name="M:EnumsNET.Enums.ToObjectUnsafe``1(System.UInt16,EnumsNET.EnumValidation)">
  1381. <summary>
  1382. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1383. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1384. </summary>
  1385. <typeparam name="TEnum">The enum type.</typeparam>
  1386. <param name="value">Value to convert.</param>
  1387. <param name="validation">The validation to perform on the result.</param>
  1388. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  1389. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1390. -or-
  1391. <paramref name="validation"/> is an invalid value
  1392. -or-
  1393. the result is invalid with the specified <paramref name="validation"/>.</exception>
  1394. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  1395. </member>
  1396. <member name="M:EnumsNET.Enums.ToObjectUnsafe``1(System.Int32,EnumsNET.EnumValidation)">
  1397. <summary>
  1398. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1399. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1400. </summary>
  1401. <typeparam name="TEnum">The enum type.</typeparam>
  1402. <param name="value">Value to convert.</param>
  1403. <param name="validation">The validation to perform on the result.</param>
  1404. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  1405. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1406. -or-
  1407. <paramref name="validation"/> is an invalid value
  1408. -or-
  1409. the result is invalid with the specified <paramref name="validation"/>.</exception>
  1410. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  1411. </member>
  1412. <member name="M:EnumsNET.Enums.ToObjectUnsafe``1(System.UInt32,EnumsNET.EnumValidation)">
  1413. <summary>
  1414. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1415. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1416. </summary>
  1417. <typeparam name="TEnum">The enum type.</typeparam>
  1418. <param name="value">Value to convert.</param>
  1419. <param name="validation">The validation to perform on the result.</param>
  1420. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  1421. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1422. -or-
  1423. <paramref name="validation"/> is an invalid value
  1424. -or-
  1425. the result is invalid with the specified <paramref name="validation"/>.</exception>
  1426. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  1427. </member>
  1428. <member name="M:EnumsNET.Enums.ToObjectUnsafe``1(System.Int64,EnumsNET.EnumValidation)">
  1429. <summary>
  1430. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1431. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1432. </summary>
  1433. <typeparam name="TEnum">The enum type.</typeparam>
  1434. <param name="value">Value to convert.</param>
  1435. <param name="validation">The validation to perform on the result.</param>
  1436. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  1437. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1438. -or-
  1439. <paramref name="validation"/> is an invalid value
  1440. -or-
  1441. the result is invalid with the specified <paramref name="validation"/>.</exception>
  1442. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  1443. </member>
  1444. <member name="M:EnumsNET.Enums.ToObjectUnsafe``1(System.UInt64,EnumsNET.EnumValidation)">
  1445. <summary>
  1446. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1447. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1448. </summary>
  1449. <typeparam name="TEnum">The enum type.</typeparam>
  1450. <param name="value">Value to convert.</param>
  1451. <param name="validation">The validation to perform on the result.</param>
  1452. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  1453. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1454. -or-
  1455. <paramref name="validation"/> is an invalid value
  1456. -or-
  1457. the result is invalid with the specified <paramref name="validation"/>.</exception>
  1458. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  1459. </member>
  1460. <member name="M:EnumsNET.Enums.TryToObjectUnsafe``1(System.Object,``0@,EnumsNET.EnumValidation)">
  1461. <summary>
  1462. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1463. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1464. The return value indicates whether the conversion succeeded.
  1465. </summary>
  1466. <typeparam name="TEnum">The enum type.</typeparam>
  1467. <param name="value">Value to try to convert. Must be an <see cref="T:System.SByte"/>, <see cref="T:System.Byte"/>, <see cref="T:System.Int16"/>, <see cref="T:System.UInt16"/>,
  1468. <see cref="T:System.Int32"/>, <see cref="T:System.UInt32"/>, <see cref="T:System.Int64"/>, <see cref="T:System.UInt64"/>, <typeparamref name="TEnum"/>, <see cref="T:System.String"/>, or Nullable of one of these.</param>
  1469. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  1470. <param name="validation">The validation to perform on the result.</param>
  1471. <returns>Indication whether the conversion succeeded.</returns>
  1472. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1473. -or-
  1474. <paramref name="validation"/> is an invalid value.</exception>
  1475. </member>
  1476. <member name="M:EnumsNET.Enums.TryToObjectUnsafe``1(System.SByte,``0@,EnumsNET.EnumValidation)">
  1477. <summary>
  1478. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1479. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1480. The return value indicates whether the conversion succeeded.
  1481. </summary>
  1482. <typeparam name="TEnum">The enum type.</typeparam>
  1483. <param name="value">Value to try to convert.</param>
  1484. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  1485. <param name="validation">The validation to perform on the result.</param>
  1486. <returns>Indication whether the conversion succeeded.</returns>
  1487. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1488. -or-
  1489. <paramref name="validation"/> is an invalid value.</exception>
  1490. </member>
  1491. <member name="M:EnumsNET.Enums.TryToObjectUnsafe``1(System.Byte,``0@,EnumsNET.EnumValidation)">
  1492. <summary>
  1493. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1494. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1495. The return value indicates whether the conversion succeeded.
  1496. </summary>
  1497. <typeparam name="TEnum">The enum type.</typeparam>
  1498. <param name="value">Value to try to convert.</param>
  1499. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  1500. <param name="validation">The validation to perform on the result.</param>
  1501. <returns>Indication whether the conversion succeeded.</returns>
  1502. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1503. -or-
  1504. <paramref name="validation"/> is an invalid value.</exception>
  1505. </member>
  1506. <member name="M:EnumsNET.Enums.TryToObjectUnsafe``1(System.Int16,``0@,EnumsNET.EnumValidation)">
  1507. <summary>
  1508. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1509. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1510. The return value indicates whether the conversion succeeded.
  1511. </summary>
  1512. <typeparam name="TEnum">The enum type.</typeparam>
  1513. <param name="value">Value to try to convert.</param>
  1514. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  1515. <param name="validation">The validation to perform on the result.</param>
  1516. <returns>Indication whether the conversion succeeded.</returns>
  1517. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1518. -or-
  1519. <paramref name="validation"/> is an invalid value.</exception>
  1520. </member>
  1521. <member name="M:EnumsNET.Enums.TryToObjectUnsafe``1(System.UInt16,``0@,EnumsNET.EnumValidation)">
  1522. <summary>
  1523. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1524. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1525. The return value indicates whether the conversion succeeded.
  1526. </summary>
  1527. <typeparam name="TEnum">The enum type.</typeparam>
  1528. <param name="value">Value to try to convert.</param>
  1529. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  1530. <param name="validation">The validation to perform on the result.</param>
  1531. <returns>Indication whether the conversion succeeded.</returns>
  1532. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1533. -or-
  1534. <paramref name="validation"/> is an invalid value.</exception>
  1535. </member>
  1536. <member name="M:EnumsNET.Enums.TryToObjectUnsafe``1(System.Int32,``0@,EnumsNET.EnumValidation)">
  1537. <summary>
  1538. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1539. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1540. The return value indicates whether the conversion succeeded.
  1541. </summary>
  1542. <typeparam name="TEnum">The enum type.</typeparam>
  1543. <param name="value">Value to try to convert.</param>
  1544. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  1545. <param name="validation">The validation to perform on the result.</param>
  1546. <returns>Indication whether the conversion succeeded.</returns>
  1547. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1548. -or-
  1549. <paramref name="validation"/> is an invalid value.</exception>
  1550. </member>
  1551. <member name="M:EnumsNET.Enums.TryToObjectUnsafe``1(System.UInt32,``0@,EnumsNET.EnumValidation)">
  1552. <summary>
  1553. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1554. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1555. The return value indicates whether the conversion succeeded.
  1556. </summary>
  1557. <typeparam name="TEnum">The enum type.</typeparam>
  1558. <param name="value">Value to try to convert.</param>
  1559. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  1560. <param name="validation">The validation to perform on the result.</param>
  1561. <returns>Indication whether the conversion succeeded.</returns>
  1562. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1563. -or-
  1564. <paramref name="validation"/> is an invalid value.</exception>
  1565. </member>
  1566. <member name="M:EnumsNET.Enums.TryToObjectUnsafe``1(System.Int64,``0@,EnumsNET.EnumValidation)">
  1567. <summary>
  1568. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1569. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1570. The return value indicates whether the conversion succeeded.
  1571. </summary>
  1572. <typeparam name="TEnum">The enum type.</typeparam>
  1573. <param name="value">Value to try to convert.</param>
  1574. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  1575. <param name="validation">The validation to perform on the result.</param>
  1576. <returns>Indication whether the conversion succeeded.</returns>
  1577. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1578. -or-
  1579. <paramref name="validation"/> is an invalid value.</exception>
  1580. </member>
  1581. <member name="M:EnumsNET.Enums.TryToObjectUnsafe``1(System.UInt64,``0@,EnumsNET.EnumValidation)">
  1582. <summary>
  1583. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1584. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1585. The return value indicates whether the conversion succeeded.
  1586. </summary>
  1587. <typeparam name="TEnum">The enum type.</typeparam>
  1588. <param name="value">Value to try to convert.</param>
  1589. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  1590. <param name="validation">The validation to perform on the result.</param>
  1591. <returns>Indication whether the conversion succeeded.</returns>
  1592. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1593. -or-
  1594. <paramref name="validation"/> is an invalid value.</exception>
  1595. </member>
  1596. <member name="M:EnumsNET.Enums.IsValidUnsafe``1(``0,EnumsNET.EnumValidation)">
  1597. <summary>
  1598. Indicates if <paramref name="value"/> is valid using the specified <paramref name="validation"/>.
  1599. </summary>
  1600. <typeparam name="TEnum">The enum type.</typeparam>
  1601. <param name="value">The enum value.</param>
  1602. <param name="validation">The validation to perform on the value.</param>
  1603. <returns>Indication if <paramref name="value"/> is valid.</returns>
  1604. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1605. -or-
  1606. <paramref name="validation"/> is an invalid value.</exception>
  1607. </member>
  1608. <member name="M:EnumsNET.Enums.IsDefinedUnsafe``1(``0)">
  1609. <summary>
  1610. Indicates if <paramref name="value"/> is defined.
  1611. </summary>
  1612. <typeparam name="TEnum">The enum type.</typeparam>
  1613. <param name="value">The enum value.</param>
  1614. <returns>Indication if <paramref name="value"/> is defined.</returns>
  1615. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1616. </member>
  1617. <member name="M:EnumsNET.Enums.ValidateUnsafe``1(``0,System.String,EnumsNET.EnumValidation)">
  1618. <summary>
  1619. Validates that <paramref name="value"/> is valid using the specified <paramref name="validation"/>.
  1620. If it's not it throws an <see cref="T:System.ArgumentException"/> with the specified <paramref name="paramName"/>.
  1621. </summary>
  1622. <typeparam name="TEnum">The enum type.</typeparam>
  1623. <param name="value">The enum value.</param>
  1624. <param name="paramName">The parameter name to be used if throwing an <see cref="T:System.ArgumentException"/>.</param>
  1625. <param name="validation">The validation to perform on the value.</param>
  1626. <returns><paramref name="value"/> for use in fluent API's and base constructor method calls.</returns>
  1627. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1628. -or-
  1629. <paramref name="validation"/> is an invalid value
  1630. -or-
  1631. <paramref name="value"/> is invalid.</exception>
  1632. </member>
  1633. <member name="M:EnumsNET.Enums.AsStringUnsafe``1(``0)">
  1634. <summary>
  1635. Converts the specified <paramref name="value"/> to its string representation.
  1636. </summary>
  1637. <typeparam name="TEnum">The enum type.</typeparam>
  1638. <param name="value">The enum value.</param>
  1639. <returns>A string representation of <paramref name="value"/>.</returns>
  1640. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1641. </member>
  1642. <member name="M:EnumsNET.Enums.AsStringUnsafe``1(``0,System.String)">
  1643. <summary>
  1644. Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="format"/>.
  1645. </summary>
  1646. <typeparam name="TEnum">The enum type.</typeparam>
  1647. <param name="value">The enum value.</param>
  1648. <param name="format">The output format to use.</param>
  1649. <returns>A string representation of <paramref name="value"/>.</returns>
  1650. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1651. <exception cref="T:System.FormatException"><paramref name="format"/> is an invalid value.</exception>
  1652. </member>
  1653. <member name="M:EnumsNET.Enums.AsStringUnsafe``1(``0,EnumsNET.EnumFormat)">
  1654. <summary>
  1655. Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="format"/>.
  1656. </summary>
  1657. <typeparam name="TEnum">The enum type.</typeparam>
  1658. <param name="value">The enum value.</param>
  1659. <param name="format">The output format to use.</param>
  1660. <returns>A string representation of <paramref name="value"/>.</returns>
  1661. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1662. -or-
  1663. <paramref name="format"/> is an invalid value.</exception>
  1664. </member>
  1665. <member name="M:EnumsNET.Enums.AsStringUnsafe``1(``0,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  1666. <summary>
  1667. Converts the specified <paramref name="value"/> to its string representation using the specified formats.
  1668. </summary>
  1669. <typeparam name="TEnum">The enum type.</typeparam>
  1670. <param name="value">The enum value.</param>
  1671. <param name="format0">The first output format to use.</param>
  1672. <param name="format1">The second output format to use if using the first resolves to <c>null</c>.</param>
  1673. <returns>A string representation of <paramref name="value"/>.</returns>
  1674. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1675. -or-
  1676. <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  1677. </member>
  1678. <member name="M:EnumsNET.Enums.AsStringUnsafe``1(``0,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  1679. <summary>
  1680. Converts the specified <paramref name="value"/> to its string representation using the specified formats.
  1681. </summary>
  1682. <typeparam name="TEnum">The enum type.</typeparam>
  1683. <param name="value">The enum value.</param>
  1684. <param name="format0">The first output format to use.</param>
  1685. <param name="format1">The second output format to use if using the first resolves to <c>null</c>.</param>
  1686. <param name="format2">The third output format to use if using the first and second both resolve to <c>null</c>.</param>
  1687. <returns>A string representation of <paramref name="value"/>.</returns>
  1688. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1689. -or-
  1690. <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  1691. </member>
  1692. <member name="M:EnumsNET.Enums.AsStringUnsafe``1(``0,EnumsNET.EnumFormat[])">
  1693. <summary>
  1694. Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="formats"/>.
  1695. </summary>
  1696. <typeparam name="TEnum">The enum type.</typeparam>
  1697. <param name="value">The enum value.</param>
  1698. <param name="formats">The output formats to use.</param>
  1699. <returns>A string representation of <paramref name="value"/>.</returns>
  1700. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1701. -or-
  1702. <paramref name="formats"/> contains an invalid value.</exception>
  1703. </member>
  1704. <member name="M:EnumsNET.Enums.TryFormatUnsafe``1(``0,System.Span{System.Char},System.Int32@)">
  1705. <summary>
  1706. Tries to format the value of the enum value into the provided span of characters.
  1707. </summary>
  1708. <typeparam name="TEnum">The enum type.</typeparam>
  1709. <param name="value">The enum value.</param>
  1710. <param name="destination">When this method returns, value formatted as a span of characters.</param>
  1711. <param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination"/>.</param>
  1712. <returns><c>true</c> if the formatting was successful; otherwise, <c>false</c>.</returns>
  1713. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1714. </member>
  1715. <member name="M:EnumsNET.Enums.TryFormatUnsafe``1(``0,System.Span{System.Char},System.Int32@,System.ReadOnlySpan{System.Char})">
  1716. <summary>
  1717. Tries to format the value of the enum value into the provided span of characters.
  1718. </summary>
  1719. <typeparam name="TEnum">The enum type.</typeparam>
  1720. <param name="value">The enum value.</param>
  1721. <param name="destination">When this method returns, value formatted as a span of characters.</param>
  1722. <param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination"/>.</param>
  1723. <param name="format">The output format to use.</param>
  1724. <returns><c>true</c> if the formatting was successful; otherwise, <c>false</c>.</returns>
  1725. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1726. <exception cref="T:System.FormatException"><paramref name="format"/> is an invalid value.</exception>
  1727. </member>
  1728. <member name="M:EnumsNET.Enums.TryFormatUnsafe``1(``0,System.Span{System.Char},System.Int32@,EnumsNET.EnumFormat[])">
  1729. <summary>
  1730. Tries to format the value of the enum value into the provided span of characters.
  1731. </summary>
  1732. <typeparam name="TEnum">The enum type.</typeparam>
  1733. <param name="value">The enum value.</param>
  1734. <param name="destination">When this method returns, value formatted as a span of characters.</param>
  1735. <param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination"/>.</param>
  1736. <param name="formats">The output formats to use.</param>
  1737. <returns><c>true</c> if the formatting was successful; otherwise, <c>false</c>.</returns>
  1738. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1739. -or-
  1740. <paramref name="formats"/> contains an invalid value.</exception>
  1741. </member>
  1742. <member name="M:EnumsNET.Enums.FormatUnsafe``1(``0,System.String)">
  1743. <summary>
  1744. Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="format"/>.
  1745. </summary>
  1746. <typeparam name="TEnum">The enum type.</typeparam>
  1747. <param name="value">The enum value.</param>
  1748. <param name="format">The output format to use.</param>
  1749. <returns>A string representation of <paramref name="value"/>.</returns>
  1750. <exception cref="T:System.ArgumentNullException"><paramref name="format"/> is <c>null</c>.</exception>
  1751. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1752. <exception cref="T:System.FormatException"><paramref name="format"/> is an invalid value.</exception>
  1753. </member>
  1754. <member name="M:EnumsNET.Enums.GetUnderlyingValueUnsafe``1(``0)">
  1755. <summary>
  1756. Returns <paramref name="value"/>'s underlying integral value.
  1757. </summary>
  1758. <typeparam name="TEnum">The enum type.</typeparam>
  1759. <param name="value">The enum value.</param>
  1760. <returns><paramref name="value"/>'s underlying integral value.</returns>
  1761. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1762. </member>
  1763. <member name="M:EnumsNET.Enums.ToSByteUnsafe``1(``0)">
  1764. <summary>
  1765. Converts <paramref name="value"/> to an <see cref="T:System.SByte"/>.
  1766. </summary>
  1767. <typeparam name="TEnum">The enum type.</typeparam>
  1768. <param name="value">The enum value.</param>
  1769. <returns><paramref name="value"/> converted to an <see cref="T:System.SByte"/>.</returns>
  1770. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1771. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.SByte"/>'s value range without overflowing.</exception>
  1772. </member>
  1773. <member name="M:EnumsNET.Enums.ToByteUnsafe``1(``0)">
  1774. <summary>
  1775. Converts <paramref name="value"/> to a <see cref="T:System.Byte"/>.
  1776. </summary>
  1777. <typeparam name="TEnum">The enum type.</typeparam>
  1778. <param name="value">The enum value.</param>
  1779. <returns><paramref name="value"/> converted to a <see cref="T:System.Byte"/>.</returns>
  1780. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1781. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Byte"/>'s value range without overflowing.</exception>
  1782. </member>
  1783. <member name="M:EnumsNET.Enums.ToInt16Unsafe``1(``0)">
  1784. <summary>
  1785. Converts <paramref name="value"/> to an <see cref="T:System.Int16"/>.
  1786. </summary>
  1787. <typeparam name="TEnum">The enum type.</typeparam>
  1788. <param name="value">The enum value.</param>
  1789. <returns><paramref name="value"/> converted to an <see cref="T:System.Int16"/>.</returns>
  1790. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1791. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Int16"/>'s value range without overflowing.</exception>
  1792. </member>
  1793. <member name="M:EnumsNET.Enums.ToUInt16Unsafe``1(``0)">
  1794. <summary>
  1795. Converts <paramref name="value"/> to a <see cref="T:System.UInt16"/>.
  1796. </summary>
  1797. <typeparam name="TEnum">The enum type.</typeparam>
  1798. <param name="value">The enum value.</param>
  1799. <returns><paramref name="value"/> converted to a <see cref="T:System.UInt16"/>.</returns>
  1800. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1801. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.UInt16"/>'s value range without overflowing.</exception>
  1802. </member>
  1803. <member name="M:EnumsNET.Enums.ToInt32Unsafe``1(``0)">
  1804. <summary>
  1805. Converts <paramref name="value"/> to an <see cref="T:System.Int32"/>.
  1806. </summary>
  1807. <typeparam name="TEnum">The enum type.</typeparam>
  1808. <param name="value">The enum value.</param>
  1809. <returns><paramref name="value"/> converted to an <see cref="T:System.Int32"/>.</returns>
  1810. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1811. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Int32"/>'s value range without overflowing.</exception>
  1812. </member>
  1813. <member name="M:EnumsNET.Enums.ToUInt32Unsafe``1(``0)">
  1814. <summary>
  1815. Converts <paramref name="value"/> to a <see cref="T:System.UInt32"/>.
  1816. </summary>
  1817. <typeparam name="TEnum">The enum type.</typeparam>
  1818. <param name="value">The enum value.</param>
  1819. <returns><paramref name="value"/> converted to a <see cref="T:System.UInt32"/>.</returns>
  1820. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1821. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.UInt32"/>'s value range without overflowing.</exception>
  1822. </member>
  1823. <member name="M:EnumsNET.Enums.ToInt64Unsafe``1(``0)">
  1824. <summary>
  1825. Converts <paramref name="value"/> to an <see cref="T:System.Int64"/>.
  1826. </summary>
  1827. <typeparam name="TEnum">The enum type.</typeparam>
  1828. <param name="value">The enum value.</param>
  1829. <returns><paramref name="value"/> converted to an <see cref="T:System.Int64"/>.</returns>
  1830. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1831. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Int64"/>'s value range without overflowing.</exception>
  1832. </member>
  1833. <member name="M:EnumsNET.Enums.ToUInt64Unsafe``1(``0)">
  1834. <summary>
  1835. Converts <paramref name="value"/> to a <see cref="T:System.UInt64"/>.
  1836. </summary>
  1837. <typeparam name="TEnum">The enum type.</typeparam>
  1838. <param name="value">The enum value.</param>
  1839. <returns><paramref name="value"/> converted to a <see cref="T:System.UInt64"/>.</returns>
  1840. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1841. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.UInt64"/>'s value range without overflowing.</exception>
  1842. </member>
  1843. <member name="M:EnumsNET.Enums.GetHashCodeUnsafe``1(``0)">
  1844. <summary>
  1845. Retrieves the hash code of <paramref name="value"/>. It's more efficient as it doesn't require boxing and unboxing of <paramref name="value"/>.
  1846. </summary>
  1847. <typeparam name="TEnum">The enum type.</typeparam>
  1848. <param name="value">The enum value.</param>
  1849. <returns>Hash code of <paramref name="value"/>.</returns>
  1850. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1851. </member>
  1852. <member name="M:EnumsNET.Enums.EqualsUnsafe``1(``0,``0)">
  1853. <summary>
  1854. Indicates if <paramref name="value"/> equals <paramref name="other"/>.
  1855. </summary>
  1856. <typeparam name="TEnum">The enum type.</typeparam>
  1857. <param name="value">The enum value.</param>
  1858. <param name="other">The other enum value.</param>
  1859. <returns>Indication if <paramref name="value"/> equals <paramref name="other"/>.</returns>
  1860. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1861. </member>
  1862. <member name="M:EnumsNET.Enums.CompareToUnsafe``1(``0,``0)">
  1863. <summary>
  1864. Compares <paramref name="value"/> to <paramref name="other"/> for ordering.
  1865. </summary>
  1866. <typeparam name="TEnum">The enum type.</typeparam>
  1867. <param name="value">The enum value.</param>
  1868. <param name="other">The other enum value.</param>
  1869. <returns>1 if <paramref name="value"/> is greater than <paramref name="other"/>, 0 if <paramref name="value"/> equals <paramref name="other"/>,
  1870. and -1 if <paramref name="value"/> is less than <paramref name="other"/>.</returns>
  1871. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1872. </member>
  1873. <member name="M:EnumsNET.Enums.GetNameUnsafe``1(``0)">
  1874. <summary>
  1875. Retrieves <paramref name="value"/>'s enum member name if defined otherwise <c>null</c>.
  1876. </summary>
  1877. <typeparam name="TEnum">The enum type.</typeparam>
  1878. <param name="value">The enum value.</param>
  1879. <returns><paramref name="value"/>'s enum member name if defined otherwise <c>null</c>.</returns>
  1880. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1881. </member>
  1882. <member name="M:EnumsNET.Enums.GetAttributesUnsafe``1(``0)">
  1883. <summary>
  1884. Retrieves <paramref name="value"/>'s enum member attributes if defined otherwise <c>null</c>.
  1885. </summary>
  1886. <typeparam name="TEnum">The enum type.</typeparam>
  1887. <param name="value">The enum value.</param>
  1888. <returns><paramref name="value"/>'s enum member attributes if defined otherwise <c>null</c>.</returns>
  1889. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1890. </member>
  1891. <member name="M:EnumsNET.Enums.GetMemberUnsafe``1(``0)">
  1892. <summary>
  1893. Retrieves an enum member with the specified <paramref name="value"/> if defined otherwise <c>null</c>.
  1894. </summary>
  1895. <typeparam name="TEnum">The enum type.</typeparam>
  1896. <param name="value">The enum value.</param>
  1897. <returns>Enum member with the specified <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
  1898. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1899. </member>
  1900. <member name="M:EnumsNET.Enums.GetMemberUnsafe``1(System.String)">
  1901. <summary>
  1902. Retrieves the enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.
  1903. Is case-sensitive.
  1904. </summary>
  1905. <typeparam name="TEnum">The enum type.</typeparam>
  1906. <param name="name">The enum member name.</param>
  1907. <returns>Enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.</returns>
  1908. <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <c>null</c>.</exception>
  1909. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1910. </member>
  1911. <member name="M:EnumsNET.Enums.GetMemberUnsafe``1(System.String,System.Boolean)">
  1912. <summary>
  1913. Retrieves the enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.
  1914. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  1915. </summary>
  1916. <typeparam name="TEnum">The enum type.</typeparam>
  1917. <param name="name">The enum member name.</param>
  1918. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1919. <returns>Enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.</returns>
  1920. <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <c>null</c>.</exception>
  1921. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1922. </member>
  1923. <member name="M:EnumsNET.Enums.GetMemberUnsafe``1(System.String,System.Boolean,EnumsNET.EnumFormat)">
  1924. <summary>
  1925. Retrieves an enum member whose string representation using the specified <paramref name="format"/> is <paramref name="value"/> if defined otherwise <c>null</c>.
  1926. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  1927. </summary>
  1928. <typeparam name="TEnum">The enum type.</typeparam>
  1929. <param name="value">The enum member's string representation.</param>
  1930. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1931. <param name="format">The parsing enum format.</param>
  1932. <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
  1933. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1934. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1935. -or-
  1936. <paramref name="format"/> is an invalid value.</exception>
  1937. </member>
  1938. <member name="M:EnumsNET.Enums.GetMemberUnsafe``1(System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  1939. <summary>
  1940. Retrieves an enum member whose string representation using the specified formats is <paramref name="value"/> if defined otherwise <c>null</c>.
  1941. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  1942. </summary>
  1943. <typeparam name="TEnum">The enum type.</typeparam>
  1944. <param name="value">The enum member's string representation.</param>
  1945. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1946. <param name="format0">The first parsing enum format.</param>
  1947. <param name="format1">The second parsing enum format.</param>
  1948. <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
  1949. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1950. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1951. -or-
  1952. <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  1953. </member>
  1954. <member name="M:EnumsNET.Enums.GetMemberUnsafe``1(System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  1955. <summary>
  1956. Retrieves an enum member whose string representation using the specified formats is <paramref name="value"/> if defined otherwise <c>null</c>.
  1957. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  1958. </summary>
  1959. <typeparam name="TEnum">The enum type.</typeparam>
  1960. <param name="value">The enum member's string representation.</param>
  1961. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1962. <param name="format0">The first parsing enum format.</param>
  1963. <param name="format1">The second parsing enum format.</param>
  1964. <param name="format2">The third parsing enum format.</param>
  1965. <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
  1966. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1967. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1968. -or-
  1969. <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  1970. </member>
  1971. <member name="M:EnumsNET.Enums.GetMemberUnsafe``1(System.String,System.Boolean,EnumsNET.EnumFormat[])">
  1972. <summary>
  1973. Retrieves an enum member whose string representation using the specified <paramref name="formats"/> is <paramref name="value"/> if defined otherwise <c>null</c>.
  1974. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  1975. </summary>
  1976. <typeparam name="TEnum">The enum type.</typeparam>
  1977. <param name="value">The enum member's string representation.</param>
  1978. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1979. <param name="formats">The parsing enum formats.</param>
  1980. <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
  1981. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1982. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1983. -or-
  1984. <paramref name="formats"/> contains an invalid value.</exception>
  1985. </member>
  1986. <member name="M:EnumsNET.Enums.ParseUnsafe``1(System.String)">
  1987. <summary>
  1988. Converts the string representation of one or more member names or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value.
  1989. </summary>
  1990. <typeparam name="TEnum">The enum type.</typeparam>
  1991. <param name="value">The enum member names or values' string representation.</param>
  1992. <returns>A <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  1993. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1994. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1995. -or-
  1996. <paramref name="value"/> doesn't represent a member name or value of <typeparamref name="TEnum"/>.</exception>
  1997. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of <typeparamref name="TEnum"/>'s underlying type.</exception>
  1998. </member>
  1999. <member name="M:EnumsNET.Enums.ParseUnsafe``1(System.String,System.Boolean)">
  2000. <summary>
  2001. Converts the string representation of one or more member names or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value.
  2002. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  2003. </summary>
  2004. <typeparam name="TEnum">The enum type.</typeparam>
  2005. <param name="value">The enum member names or values' string representation.</param>
  2006. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  2007. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  2008. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  2009. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  2010. -or-
  2011. <paramref name="value"/> doesn't represent a member name or value of <typeparamref name="TEnum"/>.</exception>
  2012. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  2013. </member>
  2014. <member name="M:EnumsNET.Enums.ParseUnsafe``1(System.String,System.Boolean,EnumsNET.EnumFormat)">
  2015. <summary>
  2016. Converts the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
  2017. using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  2018. </summary>
  2019. <typeparam name="TEnum">The enum type.</typeparam>
  2020. <param name="value">The enum members or values' string representation.</param>
  2021. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  2022. <param name="format">The parsing enum format.</param>
  2023. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  2024. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  2025. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  2026. -or-
  2027. <paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
  2028. -or-
  2029. <paramref name="format"/> is an invalid value.</exception>
  2030. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  2031. </member>
  2032. <member name="M:EnumsNET.Enums.ParseUnsafe``1(System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  2033. <summary>
  2034. Converts the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
  2035. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  2036. </summary>
  2037. <typeparam name="TEnum">The enum type.</typeparam>
  2038. <param name="value">The enum members or values' string representation.</param>
  2039. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  2040. <param name="format0">The first parsing enum format.</param>
  2041. <param name="format1">The second parsing enum format.</param>
  2042. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  2043. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  2044. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  2045. -or-
  2046. <paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
  2047. -or-
  2048. <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  2049. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  2050. </member>
  2051. <member name="M:EnumsNET.Enums.ParseUnsafe``1(System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  2052. <summary>
  2053. Converts the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
  2054. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  2055. </summary>
  2056. <typeparam name="TEnum">The enum type.</typeparam>
  2057. <param name="value">The enum members or values' string representation.</param>
  2058. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  2059. <param name="format0">The first parsing enum format.</param>
  2060. <param name="format1">The second parsing enum format.</param>
  2061. <param name="format2">The third parsing enum format.</param>
  2062. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  2063. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  2064. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  2065. -or-
  2066. <paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
  2067. -or-
  2068. <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  2069. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  2070. </member>
  2071. <member name="M:EnumsNET.Enums.ParseUnsafe``1(System.String,System.Boolean,EnumsNET.EnumFormat[])">
  2072. <summary>
  2073. Converts the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
  2074. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  2075. </summary>
  2076. <typeparam name="TEnum">The enum type.</typeparam>
  2077. <param name="value">The enum members or values' string representation.</param>
  2078. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  2079. <param name="formats">The parsing enum formats.</param>
  2080. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  2081. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  2082. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  2083. -or-
  2084. <paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
  2085. -or-
  2086. <paramref name="formats"/> contains an invalid value.</exception>
  2087. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  2088. </member>
  2089. <member name="M:EnumsNET.Enums.TryParseUnsafe``1(System.String,``0@)">
  2090. <summary>
  2091. Tries to convert the string representation of one or more member names or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value.
  2092. The return value indicates whether the conversion succeeded.
  2093. </summary>
  2094. <typeparam name="TEnum">The enum type.</typeparam>
  2095. <param name="value">The enum member names or values' string representation.</param>
  2096. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  2097. <returns>Indication whether the conversion succeeded.</returns>
  2098. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  2099. </member>
  2100. <member name="M:EnumsNET.Enums.TryParseUnsafe``1(System.String,System.Boolean,``0@)">
  2101. <summary>
  2102. Tries to convert the string representation of one or more member names or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value.
  2103. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive. The return value indicates whether the conversion succeeded.
  2104. </summary>
  2105. <typeparam name="TEnum">The enum type.</typeparam>
  2106. <param name="value">The enum member names or values' string representation.</param>
  2107. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  2108. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  2109. <returns>Indication whether the conversion succeeded.</returns>
  2110. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  2111. </member>
  2112. <member name="M:EnumsNET.Enums.TryParseUnsafe``1(System.String,System.Boolean,``0@,EnumsNET.EnumFormat)">
  2113. <summary>
  2114. Tries to convert the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
  2115. using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  2116. The return value indicates whether the conversion succeeded.
  2117. </summary>
  2118. <typeparam name="TEnum">The enum type.</typeparam>
  2119. <param name="value">The enum members or values' string representation.</param>
  2120. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  2121. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  2122. <param name="format">The parsing enum format.</param>
  2123. <returns>Indication whether the conversion succeeded.</returns>
  2124. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  2125. -or-
  2126. <paramref name="format"/> is an invalid value.</exception>
  2127. </member>
  2128. <member name="M:EnumsNET.Enums.TryParseUnsafe``1(System.String,System.Boolean,``0@,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  2129. <summary>
  2130. Tries to convert the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
  2131. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  2132. The return value indicates whether the conversion succeeded.
  2133. </summary>
  2134. <typeparam name="TEnum">The enum type.</typeparam>
  2135. <param name="value">The enum members or values' string representation.</param>
  2136. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  2137. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  2138. <param name="format0">The first parsing enum format.</param>
  2139. <param name="format1">The second parsing enum format.</param>
  2140. <returns>Indication whether the conversion succeeded.</returns>
  2141. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  2142. -or-
  2143. <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  2144. </member>
  2145. <member name="M:EnumsNET.Enums.TryParseUnsafe``1(System.String,System.Boolean,``0@,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  2146. <summary>
  2147. Tries to convert the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
  2148. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  2149. The return value indicates whether the conversion succeeded.
  2150. </summary>
  2151. <typeparam name="TEnum">The enum type.</typeparam>
  2152. <param name="value">The enum members or values' string representation.</param>
  2153. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  2154. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  2155. <param name="format0">The first parsing enum format.</param>
  2156. <param name="format1">The second parsing enum format.</param>
  2157. <param name="format2">The third parsing enum format.</param>
  2158. <returns>Indication whether the conversion succeeded.</returns>
  2159. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  2160. -or-
  2161. <paramref name="format0"/>, <paramref name="format1"/>, <paramref name="format2"/> is an invalid value.</exception>
  2162. </member>
  2163. <member name="M:EnumsNET.Enums.TryParseUnsafe``1(System.String,System.Boolean,``0@,EnumsNET.EnumFormat[])">
  2164. <summary>
  2165. Tries to convert the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
  2166. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  2167. The return value indicates whether the conversion succeeded.
  2168. </summary>
  2169. <typeparam name="TEnum">The enum type.</typeparam>
  2170. <param name="value">The enum members or values' string representation.</param>
  2171. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  2172. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  2173. <param name="formats">The parsing enum formats.</param>
  2174. <returns>Indication whether the conversion succeeded.</returns>
  2175. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  2176. -or-
  2177. <paramref name="formats"/> contains an invalid value.</exception>
  2178. </member>
  2179. <member name="M:EnumsNET.Enums.GetUnderlyingType(System.Type)">
  2180. <summary>
  2181. Retrieves the underlying type of <paramref name="enumType"/>.
  2182. </summary>
  2183. <param name="enumType">The enum type.</param>
  2184. <returns>The underlying type of <paramref name="enumType"/>.</returns>
  2185. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2186. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
  2187. </member>
  2188. <member name="M:EnumsNET.Enums.GetTypeCode(System.Type)">
  2189. <summary>
  2190. Retrieves <paramref name="enumType"/>'s underlying type's <see cref="T:System.TypeCode"/>.
  2191. </summary>
  2192. <param name="enumType">The enum type.</param>
  2193. <returns><paramref name="enumType"/>'s underlying type's <see cref="T:System.TypeCode"/>.</returns>
  2194. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2195. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
  2196. </member>
  2197. <member name="M:EnumsNET.Enums.GetMemberCount(System.Type,EnumsNET.EnumMemberSelection)">
  2198. <summary>
  2199. Retrieves <paramref name="enumType"/>'s member count.
  2200. The parameter <paramref name="selection"/> indicates what members to include.
  2201. </summary>
  2202. <param name="enumType">The enum type.</param>
  2203. <param name="selection">Indicates what members to include.</param>
  2204. <returns><paramref name="enumType"/>'s member count.</returns>
  2205. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2206. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2207. -or-
  2208. <paramref name="selection"/> is an invalid value.</exception>
  2209. </member>
  2210. <member name="M:EnumsNET.Enums.GetMembers(System.Type,EnumsNET.EnumMemberSelection)">
  2211. <summary>
  2212. Retrieves <paramref name="enumType"/>'s members in increasing value order.
  2213. The parameter <paramref name="selection"/> indicates what members to include.
  2214. </summary>
  2215. <param name="enumType">The enum type.</param>
  2216. <param name="selection">Indicates what members to include.</param>
  2217. <returns><paramref name="enumType"/>'s members in increasing value order.</returns>
  2218. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2219. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2220. -or-
  2221. <paramref name="selection"/> is an invalid value.</exception>
  2222. </member>
  2223. <member name="M:EnumsNET.Enums.GetNames(System.Type,EnumsNET.EnumMemberSelection)">
  2224. <summary>
  2225. Retrieves <paramref name="enumType"/>'s members' names in increasing value order.
  2226. The parameter <paramref name="selection"/> indicates what members to include.
  2227. </summary>
  2228. <param name="enumType">The enum type.</param>
  2229. <param name="selection">Indicates what members to include.</param>
  2230. <returns><paramref name="enumType"/>'s members' names in increasing value order.</returns>
  2231. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2232. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2233. -or-
  2234. <paramref name="selection"/> is an invalid value.</exception>
  2235. </member>
  2236. <member name="M:EnumsNET.Enums.GetValues(System.Type,EnumsNET.EnumMemberSelection)">
  2237. <summary>
  2238. Retrieves <paramref name="enumType"/>'s members' values in increasing value order.
  2239. The parameter <paramref name="selection"/> indicates what members to include.
  2240. </summary>
  2241. <param name="enumType">The enum type.</param>
  2242. <param name="selection">Indicates what members to include.</param>
  2243. <returns><paramref name="enumType"/>'s members' values in increasing value order.</returns>
  2244. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2245. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2246. -or-
  2247. <paramref name="selection"/> is an invalid value.</exception>
  2248. </member>
  2249. <member name="M:EnumsNET.Enums.ToObject(System.Type,System.Object,EnumsNET.EnumValidation)">
  2250. <summary>
  2251. Converts the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2252. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2253. </summary>
  2254. <param name="enumType">The enum type.</param>
  2255. <param name="value">Value to convert. Must be an <see cref="T:System.SByte"/>, <see cref="T:System.Byte"/>, <see cref="T:System.Int16"/>, <see cref="T:System.UInt16"/>,
  2256. <see cref="T:System.Int32"/>, <see cref="T:System.UInt32"/>, <see cref="T:System.Int64"/>, <see cref="T:System.UInt64"/>, <paramref name="enumType"/>, <see cref="T:System.String"/>, or Nullable of one of these.</param>
  2257. <param name="validation">The validation to perform on the result.</param>
  2258. <returns>The specified <paramref name="value"/> converted to a <paramref name="enumType"/>.</returns>
  2259. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2260. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2261. -or-
  2262. <paramref name="value"/> is not a valid type
  2263. -or-
  2264. <paramref name="validation"/> is an invalid value
  2265. -or-
  2266. the result is invalid with the specified <paramref name="validation"/>.</exception>
  2267. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  2268. </member>
  2269. <member name="M:EnumsNET.Enums.ToObject(System.Type,System.SByte,EnumsNET.EnumValidation)">
  2270. <summary>
  2271. Converts the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2272. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2273. </summary>
  2274. <param name="enumType">The enum type.</param>
  2275. <param name="value">Value to convert.</param>
  2276. <param name="validation">The validation to perform on the result.</param>
  2277. <returns>The specified <paramref name="value"/> converted to a <paramref name="enumType"/>.</returns>
  2278. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="enumType"/> is <c>null</c>.</exception>
  2279. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2280. -or-
  2281. <paramref name="validation"/> is an invalid value
  2282. -or-
  2283. the result is invalid with the specified <paramref name="validation"/>.</exception>
  2284. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  2285. </member>
  2286. <member name="M:EnumsNET.Enums.ToObject(System.Type,System.Byte,EnumsNET.EnumValidation)">
  2287. <summary>
  2288. Converts the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2289. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2290. </summary>
  2291. <param name="enumType">The enum type.</param>
  2292. <param name="value">Value to convert.</param>
  2293. <param name="validation">The validation to perform on the result.</param>
  2294. <returns>The specified <paramref name="value"/> converted to a <paramref name="enumType"/>.</returns>
  2295. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2296. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2297. -or-
  2298. <paramref name="validation"/> is an invalid value
  2299. -or-
  2300. the result is invalid with the specified <paramref name="validation"/>.</exception>
  2301. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  2302. </member>
  2303. <member name="M:EnumsNET.Enums.ToObject(System.Type,System.Int16,EnumsNET.EnumValidation)">
  2304. <summary>
  2305. Converts the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2306. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2307. </summary>
  2308. <param name="enumType">The enum type.</param>
  2309. <param name="value">Value to convert.</param>
  2310. <param name="validation">The validation to perform on the result.</param>
  2311. <returns>The specified <paramref name="value"/> converted to a <paramref name="enumType"/>.</returns>
  2312. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2313. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2314. -or-
  2315. <paramref name="validation"/> is an invalid value
  2316. -or-
  2317. the result is invalid with the specified <paramref name="validation"/>.</exception>
  2318. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  2319. </member>
  2320. <member name="M:EnumsNET.Enums.ToObject(System.Type,System.UInt16,EnumsNET.EnumValidation)">
  2321. <summary>
  2322. Converts the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2323. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2324. </summary>
  2325. <param name="enumType">The enum type.</param>
  2326. <param name="value">Value to convert.</param>
  2327. <param name="validation">The validation to perform on the result.</param>
  2328. <returns>The specified <paramref name="value"/> converted to a <paramref name="enumType"/>.</returns>
  2329. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2330. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2331. -or-
  2332. <paramref name="validation"/> is an invalid value
  2333. -or-
  2334. the result is invalid with the specified <paramref name="validation"/>.</exception>
  2335. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  2336. </member>
  2337. <member name="M:EnumsNET.Enums.ToObject(System.Type,System.Int32,EnumsNET.EnumValidation)">
  2338. <summary>
  2339. Converts the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2340. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2341. </summary>
  2342. <param name="enumType">The enum type.</param>
  2343. <param name="value">Value to convert.</param>
  2344. <param name="validation">The validation to perform on the result.</param>
  2345. <returns>The specified <paramref name="value"/> converted to a <paramref name="enumType"/>.</returns>
  2346. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2347. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2348. -or-
  2349. <paramref name="validation"/> is an invalid value
  2350. -or-
  2351. the result is invalid with the specified <paramref name="validation"/>.</exception>
  2352. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  2353. </member>
  2354. <member name="M:EnumsNET.Enums.ToObject(System.Type,System.UInt32,EnumsNET.EnumValidation)">
  2355. <summary>
  2356. Converts the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2357. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2358. </summary>
  2359. <param name="enumType">The enum type.</param>
  2360. <param name="value">Value to convert.</param>
  2361. <param name="validation">The validation to perform on the result.</param>
  2362. <returns>The specified <paramref name="value"/> converted to a <paramref name="enumType"/>.</returns>
  2363. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2364. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2365. -or-
  2366. <paramref name="validation"/> is an invalid value
  2367. -or-
  2368. the result is invalid with the specified <paramref name="validation"/>.</exception>
  2369. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  2370. </member>
  2371. <member name="M:EnumsNET.Enums.ToObject(System.Type,System.Int64,EnumsNET.EnumValidation)">
  2372. <summary>
  2373. Converts the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2374. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2375. </summary>
  2376. <param name="enumType">The enum type.</param>
  2377. <param name="value">Value to convert.</param>
  2378. <param name="validation">The validation to perform on the result.</param>
  2379. <returns>The specified <paramref name="value"/> converted to a <paramref name="enumType"/>.</returns>
  2380. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2381. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2382. -or-
  2383. <paramref name="validation"/> is an invalid value
  2384. -or-
  2385. the result is invalid with the specified <paramref name="validation"/>.</exception>
  2386. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  2387. </member>
  2388. <member name="M:EnumsNET.Enums.ToObject(System.Type,System.UInt64,EnumsNET.EnumValidation)">
  2389. <summary>
  2390. Converts the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2391. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2392. </summary>
  2393. <param name="enumType">The enum type.</param>
  2394. <param name="value">Value to convert.</param>
  2395. <param name="validation">The validation to perform on the result.</param>
  2396. <returns>The specified <paramref name="value"/> converted to a <paramref name="enumType"/>.</returns>
  2397. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2398. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2399. -or-
  2400. <paramref name="validation"/> is an invalid value
  2401. -or-
  2402. the result is invalid with the specified <paramref name="validation"/>.</exception>
  2403. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  2404. </member>
  2405. <member name="M:EnumsNET.Enums.TryToObject(System.Type,System.Object,System.Object@,EnumsNET.EnumValidation)">
  2406. <summary>
  2407. Tries to convert the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2408. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2409. The return value indicates whether the conversion succeeded.
  2410. </summary>
  2411. <param name="enumType">The enum type.</param>
  2412. <param name="value">Value to try to convert. Must be an <see cref="T:System.SByte"/>, <see cref="T:System.Byte"/>, <see cref="T:System.Int16"/>, <see cref="T:System.UInt16"/>,
  2413. <see cref="T:System.Int32"/>, <see cref="T:System.UInt32"/>, <see cref="T:System.Int64"/>, <see cref="T:System.UInt64"/>, <paramref name="enumType"/>, <see cref="T:System.String"/>, or Nullable of one of these.</param>
  2414. <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> whose value is <paramref name="value"/>.</param>
  2415. <param name="validation">The validation to perform on the result.</param>
  2416. <returns>Indication whether the conversion succeeded.</returns>
  2417. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2418. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2419. -or-
  2420. <paramref name="validation"/> is an invalid value.</exception>
  2421. </member>
  2422. <member name="M:EnumsNET.Enums.TryToObject(System.Type,System.SByte,System.Object@,EnumsNET.EnumValidation)">
  2423. <summary>
  2424. Tries to convert the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2425. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2426. The return value indicates whether the conversion succeeded.
  2427. </summary>
  2428. <param name="enumType">The enum type.</param>
  2429. <param name="value">Value to try to convert.</param>
  2430. <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> whose value is <paramref name="value"/>.</param>
  2431. <param name="validation">The validation to perform on the result.</param>
  2432. <returns>Indication whether the conversion succeeded.</returns>
  2433. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2434. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2435. -or-
  2436. <paramref name="validation"/> is an invalid value.</exception>
  2437. </member>
  2438. <member name="M:EnumsNET.Enums.TryToObject(System.Type,System.Byte,System.Object@,EnumsNET.EnumValidation)">
  2439. <summary>
  2440. Tries to convert the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2441. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2442. The return value indicates whether the conversion succeeded.
  2443. </summary>
  2444. <param name="enumType">The enum type.</param>
  2445. <param name="value">Value to try to convert.</param>
  2446. <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> whose value is <paramref name="value"/>.</param>
  2447. <param name="validation">The validation to perform on the result.</param>
  2448. <returns>Indication whether the conversion succeeded.</returns>
  2449. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2450. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2451. -or-
  2452. <paramref name="validation"/> is an invalid value.</exception>
  2453. </member>
  2454. <member name="M:EnumsNET.Enums.TryToObject(System.Type,System.Int16,System.Object@,EnumsNET.EnumValidation)">
  2455. <summary>
  2456. Tries to convert the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2457. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2458. The return value indicates whether the conversion succeeded.
  2459. </summary>
  2460. <param name="enumType">The enum type.</param>
  2461. <param name="value">Value to try to convert.</param>
  2462. <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> whose value is <paramref name="value"/>.</param>
  2463. <param name="validation">The validation to perform on the result.</param>
  2464. <returns>Indication whether the conversion succeeded.</returns>
  2465. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2466. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2467. -or-
  2468. <paramref name="validation"/> is an invalid value.</exception>
  2469. </member>
  2470. <member name="M:EnumsNET.Enums.TryToObject(System.Type,System.UInt16,System.Object@,EnumsNET.EnumValidation)">
  2471. <summary>
  2472. Tries to convert the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2473. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2474. The return value indicates whether the conversion succeeded.
  2475. </summary>
  2476. <param name="enumType">The enum type.</param>
  2477. <param name="value">Value to try to convert.</param>
  2478. <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> whose value is <paramref name="value"/>.</param>
  2479. <param name="validation">The validation to perform on the result.</param>
  2480. <returns>Indication whether the conversion succeeded.</returns>
  2481. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2482. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2483. -or-
  2484. <paramref name="validation"/> is an invalid value.</exception>
  2485. </member>
  2486. <member name="M:EnumsNET.Enums.TryToObject(System.Type,System.Int32,System.Object@,EnumsNET.EnumValidation)">
  2487. <summary>
  2488. Tries to convert the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2489. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2490. The return value indicates whether the conversion succeeded.
  2491. </summary>
  2492. <param name="enumType">The enum type.</param>
  2493. <param name="value">Value to try to convert.</param>
  2494. <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> whose value is <paramref name="value"/>.</param>
  2495. <param name="validation">The validation to perform on the result.</param>
  2496. <returns>Indication whether the conversion succeeded.</returns>
  2497. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2498. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2499. -or-
  2500. <paramref name="validation"/> is an invalid value.</exception>
  2501. </member>
  2502. <member name="M:EnumsNET.Enums.TryToObject(System.Type,System.UInt32,System.Object@,EnumsNET.EnumValidation)">
  2503. <summary>
  2504. Tries to convert the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2505. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2506. The return value indicates whether the conversion succeeded.
  2507. </summary>
  2508. <param name="enumType">The enum type.</param>
  2509. <param name="value">Value to try to convert.</param>
  2510. <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> whose value is <paramref name="value"/>.</param>
  2511. <param name="validation">The validation to perform on the result.</param>
  2512. <returns>Indication whether the conversion succeeded.</returns>
  2513. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2514. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2515. -or-
  2516. <paramref name="validation"/> is an invalid value.</exception>
  2517. </member>
  2518. <member name="M:EnumsNET.Enums.TryToObject(System.Type,System.Int64,System.Object@,EnumsNET.EnumValidation)">
  2519. <summary>
  2520. Tries to convert the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2521. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2522. The return value indicates whether the conversion succeeded.
  2523. </summary>
  2524. <param name="enumType">The enum type.</param>
  2525. <param name="value">Value to try to convert.</param>
  2526. <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> whose value is <paramref name="value"/>.</param>
  2527. <param name="validation">The validation to perform on the result.</param>
  2528. <returns>Indication whether the conversion succeeded.</returns>
  2529. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2530. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2531. -or-
  2532. <paramref name="validation"/> is an invalid value.</exception>
  2533. </member>
  2534. <member name="M:EnumsNET.Enums.TryToObject(System.Type,System.UInt64,System.Object@,EnumsNET.EnumValidation)">
  2535. <summary>
  2536. Tries to convert the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2537. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2538. The return value indicates whether the conversion succeeded.
  2539. </summary>
  2540. <param name="enumType">The enum type.</param>
  2541. <param name="value">Value to try to convert.</param>
  2542. <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> whose value is <paramref name="value"/>.</param>
  2543. <param name="validation">The validation to perform on the result.</param>
  2544. <returns>Indication whether the conversion succeeded.</returns>
  2545. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2546. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2547. -or-
  2548. <paramref name="validation"/> is an invalid value.</exception>
  2549. </member>
  2550. <member name="M:EnumsNET.Enums.IsValid(System.Type,System.Object,EnumsNET.EnumValidation)">
  2551. <summary>
  2552. Indicates if <paramref name="value"/> is valid. If <paramref name="enumType"/> is a standard enum it returns whether the value is defined.
  2553. If <paramref name="enumType"/> is marked with <see cref="T:System.FlagsAttribute"/> it returns whether it's a valid flag combination of <paramref name="enumType"/>'s defined values
  2554. or is defined. Or if <paramref name="enumType"/> has an attribute that implements <see cref="T:EnumsNET.IEnumValidatorAttribute`1"/>
  2555. then that attribute's <see cref="M:EnumsNET.IEnumValidatorAttribute`1.IsValid(`0)"/> method is used.
  2556. </summary>
  2557. <param name="enumType">The enum type.</param>
  2558. <param name="value">The enum value.</param>
  2559. <param name="validation">The validation to perform on the value.</param>
  2560. <returns>Indication if <paramref name="value"/> is valid.</returns>
  2561. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2562. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2563. -or-
  2564. <paramref name="value"/> is of an invalid type
  2565. -or-
  2566. <paramref name="validation"/> is an invalid value.</exception>
  2567. </member>
  2568. <member name="M:EnumsNET.Enums.IsDefined(System.Type,System.Object)">
  2569. <summary>
  2570. Indicates if <paramref name="value"/> is defined.
  2571. </summary>
  2572. <param name="enumType">The enum type.</param>
  2573. <param name="value">The enum value.</param>
  2574. <returns>Indication if <paramref name="value"/> is defined.</returns>
  2575. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2576. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2577. -or-
  2578. <paramref name="value"/> is of an invalid type.</exception>
  2579. </member>
  2580. <member name="M:EnumsNET.Enums.Validate(System.Type,System.Object,System.String,EnumsNET.EnumValidation)">
  2581. <summary>
  2582. Validates that <paramref name="value"/> is valid. If it's not it throws an <see cref="T:System.ArgumentException"/> with the specified <paramref name="paramName"/>.
  2583. </summary>
  2584. <param name="enumType">The enum type.</param>
  2585. <param name="value">The enum value.</param>
  2586. <param name="paramName">The parameter name to be used if throwing an <see cref="T:System.ArgumentException"/>.</param>
  2587. <param name="validation">The validation to perform on the value.</param>
  2588. <returns><paramref name="value"/> for use in fluent API's and base constructor method calls.</returns>
  2589. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2590. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2591. -or-
  2592. <paramref name="value"/> is of an invalid type
  2593. -or-
  2594. <paramref name="validation"/> is an invalid value
  2595. -or-
  2596. <paramref name="value"/> is invalid.</exception>
  2597. </member>
  2598. <member name="M:EnumsNET.Enums.AsString(System.Type,System.Object)">
  2599. <summary>
  2600. Converts the specified <paramref name="value"/> to its string representation.
  2601. </summary>
  2602. <param name="enumType">The enum type.</param>
  2603. <param name="value">The enum value.</param>
  2604. <returns>A string representation of <paramref name="value"/>.</returns>
  2605. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2606. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2607. -or-
  2608. <paramref name="value"/> is of an invalid type.</exception>
  2609. </member>
  2610. <member name="M:EnumsNET.Enums.AsString(System.Type,System.Object,System.String)">
  2611. <summary>
  2612. Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="format"/>.
  2613. </summary>
  2614. <param name="enumType">The enum type.</param>
  2615. <param name="value">The enum value.</param>
  2616. <param name="format">The output format to use.</param>
  2617. <returns>A string representation of <paramref name="value"/>.</returns>
  2618. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2619. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2620. -or-
  2621. <paramref name="value"/> is of an invalid type.</exception>
  2622. <exception cref="T:System.FormatException"><paramref name="format"/> is an invalid value.</exception>
  2623. </member>
  2624. <member name="M:EnumsNET.Enums.AsString(System.Type,System.Object,EnumsNET.EnumFormat)">
  2625. <summary>
  2626. Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="format"/>.
  2627. </summary>
  2628. <param name="enumType">The enum type.</param>
  2629. <param name="value">The enum value.</param>
  2630. <param name="format">The output format to use.</param>
  2631. <returns>A string representation of <paramref name="value"/>.</returns>
  2632. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2633. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2634. -or-
  2635. <paramref name="format"/> is an invalid value.</exception>
  2636. </member>
  2637. <member name="M:EnumsNET.Enums.AsString(System.Type,System.Object,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  2638. <summary>
  2639. Converts the specified <paramref name="value"/> to its string representation using the specified formats.
  2640. </summary>
  2641. <param name="enumType">The enum type.</param>
  2642. <param name="value">The enum value.</param>
  2643. <param name="format0">The first output format to use.</param>
  2644. <param name="format1">The second output format to use if using the first resolves to <c>null</c>.</param>
  2645. <returns>A string representation of <paramref name="value"/>.</returns>
  2646. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2647. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2648. -or-
  2649. <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  2650. </member>
  2651. <member name="M:EnumsNET.Enums.AsString(System.Type,System.Object,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  2652. <summary>
  2653. Converts the specified <paramref name="value"/> to its string representation using the specified formats.
  2654. </summary>
  2655. <param name="enumType">The enum type.</param>
  2656. <param name="value">The enum value.</param>
  2657. <param name="format0">The first output format to use.</param>
  2658. <param name="format1">The second output format to use if using the first resolves to <c>null</c>.</param>
  2659. <param name="format2">The third output format to use if using the first and second both resolve to <c>null</c>.</param>
  2660. <returns>A string representation of <paramref name="value"/>.</returns>
  2661. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2662. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2663. -or-
  2664. <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  2665. </member>
  2666. <member name="M:EnumsNET.Enums.AsString(System.Type,System.Object,EnumsNET.EnumFormat[])">
  2667. <summary>
  2668. Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="formats"/>.
  2669. </summary>
  2670. <param name="enumType">The enum type.</param>
  2671. <param name="value">The enum value.</param>
  2672. <param name="formats">The output formats to use.</param>
  2673. <returns>A string representation of <paramref name="value"/>.</returns>
  2674. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2675. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2676. -or-
  2677. <paramref name="formats"/> contains an invalid value.</exception>
  2678. </member>
  2679. <member name="M:EnumsNET.Enums.TryFormat(System.Type,System.Object,System.Span{System.Char},System.Int32@)">
  2680. <summary>
  2681. Tries to format the value of the enum value into the provided span of characters.
  2682. </summary>
  2683. <param name="enumType">The enum type.</param>
  2684. <param name="value">The enum value.</param>
  2685. <param name="destination">When this method returns, value formatted as a span of characters.</param>
  2686. <param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination"/>.</param>
  2687. <returns><c>true</c> if the formatting was successful; otherwise, <c>false</c>.</returns>
  2688. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2689. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2690. -or-
  2691. <paramref name="value"/> is of an invalid type.</exception>
  2692. </member>
  2693. <member name="M:EnumsNET.Enums.TryFormat(System.Type,System.Object,System.Span{System.Char},System.Int32@,System.ReadOnlySpan{System.Char})">
  2694. <summary>
  2695. Tries to format the value of the enum value into the provided span of characters.
  2696. </summary>
  2697. <param name="enumType">The enum type.</param>
  2698. <param name="value">The enum value.</param>
  2699. <param name="destination">When this method returns, value formatted as a span of characters.</param>
  2700. <param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination"/>.</param>
  2701. <param name="format">The output format to use.</param>
  2702. <returns><c>true</c> if the formatting was successful; otherwise, <c>false</c>.</returns>
  2703. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2704. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2705. -or-
  2706. <paramref name="value"/> is of an invalid type.</exception>
  2707. <exception cref="T:System.FormatException"><paramref name="format"/> is an invalid value.</exception>
  2708. </member>
  2709. <member name="M:EnumsNET.Enums.TryFormat(System.Type,System.Object,System.Span{System.Char},System.Int32@,EnumsNET.EnumFormat[])">
  2710. <summary>
  2711. Tries to format the value of the enum value into the provided span of characters.
  2712. </summary>
  2713. <param name="enumType">The enum type.</param>
  2714. <param name="value">The enum value.</param>
  2715. <param name="destination">When this method returns, value formatted as a span of characters.</param>
  2716. <param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination"/>.</param>
  2717. <param name="formats">The output formats to use.</param>
  2718. <returns><c>true</c> if the formatting was successful; otherwise, <c>false</c>.</returns>
  2719. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2720. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2721. -or-
  2722. <paramref name="formats"/> contains an invalid value.</exception>
  2723. </member>
  2724. <member name="M:EnumsNET.Enums.Format(System.Type,System.Object,System.String)">
  2725. <summary>
  2726. Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="format"/>.
  2727. </summary>
  2728. <param name="enumType">The enum type.</param>
  2729. <param name="value">The enum value.</param>
  2730. <param name="format">The output format to use.</param>
  2731. <returns>A string representation of <paramref name="value"/>.</returns>
  2732. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/>, <paramref name="value"/>, or <paramref name="format"/> is <c>null</c>.</exception>
  2733. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2734. -or-
  2735. <paramref name="value"/> is of an invalid type.</exception>
  2736. <exception cref="T:System.FormatException"><paramref name="format"/> is an invalid value.</exception>
  2737. </member>
  2738. <member name="M:EnumsNET.Enums.GetUnderlyingValue(System.Type,System.Object)">
  2739. <summary>
  2740. Returns <paramref name="value"/>'s underlying integral value.
  2741. </summary>
  2742. <param name="enumType">The enum type.</param>
  2743. <param name="value">The enum value.</param>
  2744. <returns><paramref name="value"/>'s underlying integral value.</returns>
  2745. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2746. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2747. -or-
  2748. <paramref name="value"/> is of an invalid type.</exception>
  2749. </member>
  2750. <member name="M:EnumsNET.Enums.ToSByte(System.Type,System.Object)">
  2751. <summary>
  2752. Converts <paramref name="value"/> to an <see cref="T:System.SByte"/>.
  2753. </summary>
  2754. <param name="enumType">The enum type.</param>
  2755. <param name="value">The enum value.</param>
  2756. <returns><paramref name="value"/> converted to an <see cref="T:System.SByte"/>.</returns>
  2757. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2758. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2759. -or-
  2760. <paramref name="value"/> is of an invalid type.</exception>
  2761. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.SByte"/>'s value range without overflowing.</exception>
  2762. </member>
  2763. <member name="M:EnumsNET.Enums.ToByte(System.Type,System.Object)">
  2764. <summary>
  2765. Converts <paramref name="value"/> to a <see cref="T:System.Byte"/>.
  2766. </summary>
  2767. <param name="enumType">The enum type.</param>
  2768. <param name="value">The enum value.</param>
  2769. <returns><paramref name="value"/> converted to a <see cref="T:System.Byte"/>.</returns>
  2770. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2771. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2772. -or-
  2773. <paramref name="value"/> is of an invalid type.</exception>
  2774. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Byte"/>'s value range without overflowing.</exception>
  2775. </member>
  2776. <member name="M:EnumsNET.Enums.ToInt16(System.Type,System.Object)">
  2777. <summary>
  2778. Converts <paramref name="value"/> to an <see cref="T:System.Int16"/>.
  2779. </summary>
  2780. <param name="enumType">The enum type.</param>
  2781. <param name="value">The enum value.</param>
  2782. <returns><paramref name="value"/> converted to an <see cref="T:System.Int16"/>.</returns>
  2783. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2784. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2785. -or-
  2786. <paramref name="value"/> is of an invalid type.</exception>
  2787. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Int16"/>'s value range without overflowing.</exception>
  2788. </member>
  2789. <member name="M:EnumsNET.Enums.ToUInt16(System.Type,System.Object)">
  2790. <summary>
  2791. Converts <paramref name="value"/> to a <see cref="T:System.UInt16"/>.
  2792. </summary>
  2793. <param name="enumType">The enum type.</param>
  2794. <param name="value">The enum value.</param>
  2795. <returns><paramref name="value"/> converted to a <see cref="T:System.UInt16"/>.</returns>
  2796. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2797. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2798. -or-
  2799. <paramref name="value"/> is of an invalid type.</exception>
  2800. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.UInt16"/>'s value range without overflowing.</exception>
  2801. </member>
  2802. <member name="M:EnumsNET.Enums.ToInt32(System.Type,System.Object)">
  2803. <summary>
  2804. Converts <paramref name="value"/> to an <see cref="T:System.Int32"/>.
  2805. </summary>
  2806. <param name="enumType">The enum type.</param>
  2807. <param name="value">The enum value.</param>
  2808. <returns><paramref name="value"/> converted to an <see cref="T:System.Int32"/>.</returns>
  2809. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2810. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2811. -or-
  2812. <paramref name="value"/> is of an invalid type.</exception>
  2813. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Int32"/>'s value range without overflowing.</exception>
  2814. </member>
  2815. <member name="M:EnumsNET.Enums.ToUInt32(System.Type,System.Object)">
  2816. <summary>
  2817. Converts <paramref name="value"/> to a <see cref="T:System.UInt32"/>.
  2818. </summary>
  2819. <param name="enumType">The enum type.</param>
  2820. <param name="value">The enum value.</param>
  2821. <returns><paramref name="value"/> converted to a <see cref="T:System.UInt32"/>.</returns>
  2822. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2823. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2824. -or-
  2825. <paramref name="value"/> is of an invalid type.</exception>
  2826. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.UInt32"/>'s value range without overflowing.</exception>
  2827. </member>
  2828. <member name="M:EnumsNET.Enums.ToInt64(System.Type,System.Object)">
  2829. <summary>
  2830. Converts <paramref name="value"/> to an <see cref="T:System.Int64"/>.
  2831. </summary>
  2832. <param name="enumType">The enum type.</param>
  2833. <param name="value">The enum value.</param>
  2834. <returns><paramref name="value"/> converted to an <see cref="T:System.Int64"/>.</returns>
  2835. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2836. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2837. -or-
  2838. <paramref name="value"/> is of an invalid type.</exception>
  2839. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Int64"/>'s value range without overflowing.</exception>
  2840. </member>
  2841. <member name="M:EnumsNET.Enums.ToUInt64(System.Type,System.Object)">
  2842. <summary>
  2843. Converts <paramref name="value"/> to a <see cref="T:System.UInt64"/>.
  2844. </summary>
  2845. <param name="enumType">The enum type.</param>
  2846. <param name="value">The enum value.</param>
  2847. <returns><paramref name="value"/> converted to a <see cref="T:System.UInt64"/>.</returns>
  2848. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2849. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2850. -or-
  2851. <paramref name="value"/> is of an invalid type.</exception>
  2852. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.UInt64"/>'s value range without overflowing.</exception>
  2853. </member>
  2854. <member name="M:EnumsNET.Enums.Equals(System.Type,System.Object,System.Object)">
  2855. <summary>
  2856. Indicates if <paramref name="value"/> equals <paramref name="other"/>.
  2857. </summary>
  2858. <param name="enumType">The enum type.</param>
  2859. <param name="value">The enum value.</param>
  2860. <param name="other">The other enum value.</param>
  2861. <returns>Indication if <paramref name="value"/> equals <paramref name="other"/>.</returns>
  2862. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/>, <paramref name="value"/>, or <paramref name="other"/> is <c>null</c>.</exception>
  2863. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2864. -or-
  2865. <paramref name="value"/> or <paramref name="other"/> is of an invalid type.</exception>
  2866. </member>
  2867. <member name="M:EnumsNET.Enums.CompareTo(System.Type,System.Object,System.Object)">
  2868. <summary>
  2869. Compares <paramref name="value"/> to <paramref name="other"/> for ordering.
  2870. </summary>
  2871. <param name="enumType">The enum type.</param>
  2872. <param name="value">The enum value.</param>
  2873. <param name="other">The other enum value.</param>
  2874. <returns>1 if <paramref name="value"/> is greater than <paramref name="other"/>, 0 if <paramref name="value"/> equals <paramref name="other"/>,
  2875. and -1 if <paramref name="value"/> is less than <paramref name="other"/>.</returns>
  2876. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/>, <paramref name="value"/>, or <paramref name="other"/> is <c>null</c>.</exception>
  2877. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2878. -or-
  2879. <paramref name="value"/> or <paramref name="other"/> is of an invalid type.</exception>
  2880. </member>
  2881. <member name="M:EnumsNET.Enums.GetName(System.Type,System.Object)">
  2882. <summary>
  2883. Retrieves <paramref name="value"/>'s enum member name if defined otherwise <c>null</c>.
  2884. </summary>
  2885. <param name="enumType">The enum type.</param>
  2886. <param name="value">The enum value.</param>
  2887. <returns><paramref name="value"/>'s enum member name if defined otherwise <c>null</c>.</returns>
  2888. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2889. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2890. -or-
  2891. <paramref name="value"/> is of an invalid type.</exception>
  2892. </member>
  2893. <member name="M:EnumsNET.Enums.GetAttributes(System.Type,System.Object)">
  2894. <summary>
  2895. Retrieves <paramref name="value"/>'s enum member attributes if defined otherwise <c>null</c>.
  2896. </summary>
  2897. <param name="enumType">The enum type.</param>
  2898. <param name="value">The enum value.</param>
  2899. <returns><paramref name="value"/>'s enum member attributes if defined otherwise <c>null</c>.</returns>
  2900. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2901. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2902. -or-
  2903. <paramref name="value"/> is of an invalid type.</exception>
  2904. </member>
  2905. <member name="M:EnumsNET.Enums.GetMember(System.Type,System.Object)">
  2906. <summary>
  2907. Retrieves an enum member with the specified <paramref name="value"/> if defined otherwise <c>null</c>.
  2908. </summary>
  2909. <param name="enumType">The enum type.</param>
  2910. <param name="value">The enum value.</param>
  2911. <returns>Enum member with the specified <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
  2912. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2913. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2914. -or-
  2915. <paramref name="value"/> is of an invalid type.</exception>
  2916. </member>
  2917. <member name="M:EnumsNET.Enums.GetMember(System.Type,System.String)">
  2918. <summary>
  2919. Retrieves the enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.
  2920. Is case-sensitive.
  2921. </summary>
  2922. <param name="enumType">The enum type.</param>
  2923. <param name="name">The enum member name.</param>
  2924. <returns>Enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.</returns>
  2925. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="name"/> is <c>null</c>.</exception>
  2926. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
  2927. </member>
  2928. <member name="M:EnumsNET.Enums.GetMember(System.Type,System.String,System.Boolean)">
  2929. <summary>
  2930. Retrieves the enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.
  2931. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  2932. </summary>
  2933. <param name="enumType">The enum type.</param>
  2934. <param name="name">The enum member name.</param>
  2935. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  2936. <returns>Enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.</returns>
  2937. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="name"/> is <c>null</c>.</exception>
  2938. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
  2939. </member>
  2940. <member name="M:EnumsNET.Enums.GetMember(System.Type,System.String,System.Boolean,EnumsNET.EnumFormat)">
  2941. <summary>
  2942. Retrieves an enum member whose string representation using the specified <paramref name="format"/> is <paramref name="value"/> if defined otherwise <c>null</c>.
  2943. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  2944. </summary>
  2945. <param name="enumType">The enum type.</param>
  2946. <param name="value">The enum member's string representation.</param>
  2947. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  2948. <param name="format">The parsing enum format.</param>
  2949. <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
  2950. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2951. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2952. -or-
  2953. <paramref name="format"/> is an invalid value.</exception>
  2954. </member>
  2955. <member name="M:EnumsNET.Enums.GetMember(System.Type,System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  2956. <summary>
  2957. Retrieves an enum member whose string representation using the specified formats is <paramref name="value"/> if defined otherwise <c>null</c>.
  2958. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  2959. </summary>
  2960. <param name="enumType">The enum type.</param>
  2961. <param name="value">The enum member's string representation.</param>
  2962. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  2963. <param name="format0">The first parsing enum format.</param>
  2964. <param name="format1">The second parsing enum format.</param>
  2965. <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
  2966. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2967. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2968. -or-
  2969. <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  2970. </member>
  2971. <member name="M:EnumsNET.Enums.GetMember(System.Type,System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  2972. <summary>
  2973. Retrieves an enum member whose string representation using the specified formats is <paramref name="value"/> if defined otherwise <c>null</c>.
  2974. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  2975. </summary>
  2976. <param name="enumType">The enum type.</param>
  2977. <param name="value">The enum member's string representation.</param>
  2978. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  2979. <param name="format0">The first parsing enum format.</param>
  2980. <param name="format1">The second parsing enum format.</param>
  2981. <param name="format2">The third parsing enum format.</param>
  2982. <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
  2983. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2984. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2985. -or-
  2986. <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  2987. </member>
  2988. <member name="M:EnumsNET.Enums.GetMember(System.Type,System.String,System.Boolean,EnumsNET.EnumFormat[])">
  2989. <summary>
  2990. Retrieves an enum member whose string representation using the specified <paramref name="formats"/> is <paramref name="value"/> if defined otherwise <c>null</c>.
  2991. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  2992. </summary>
  2993. <param name="enumType">The enum type.</param>
  2994. <param name="value">The enum member's string representation.</param>
  2995. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  2996. <param name="formats">The parsing enum formats.</param>
  2997. <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
  2998. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2999. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  3000. -or-
  3001. <paramref name="formats"/> contains an invalid value.</exception>
  3002. </member>
  3003. <member name="M:EnumsNET.Enums.Parse(System.Type,System.String)">
  3004. <summary>
  3005. Converts the string representation of one or more member names or values of <paramref name="enumType"/> to its respective value of type <paramref name="enumType"/>.
  3006. </summary>
  3007. <param name="enumType">The enum type.</param>
  3008. <param name="value">The enum member names or values' string representation.</param>
  3009. <returns>A <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
  3010. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  3011. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  3012. -or-
  3013. <paramref name="value"/> doesn't represent a member name or value of <paramref name="enumType"/>.</exception>
  3014. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of <paramref name="enumType"/>'s underlying type.</exception>
  3015. </member>
  3016. <member name="M:EnumsNET.Enums.Parse(System.Type,System.String,System.Boolean)">
  3017. <summary>
  3018. Converts the string representation of one or more member names or values of <paramref name="enumType"/> to its respective value of type <paramref name="enumType"/>.
  3019. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  3020. </summary>
  3021. <param name="enumType">The enum type.</param>
  3022. <param name="value">The enum member names or values' string representation.</param>
  3023. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3024. <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
  3025. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  3026. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  3027. -or-
  3028. <paramref name="value"/> doesn't represent a member name or value of <paramref name="enumType"/>.</exception>
  3029. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
  3030. </member>
  3031. <member name="M:EnumsNET.Enums.Parse(System.Type,System.String,System.Boolean,EnumsNET.EnumFormat)">
  3032. <summary>
  3033. Converts the string representation of one or more members or values of <paramref name="enumType"/> to its respective value of type <paramref name="enumType"/>
  3034. using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  3035. </summary>
  3036. <param name="enumType">The enum type.</param>
  3037. <param name="value">The enum members or values' string representation.</param>
  3038. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3039. <param name="format">The parsing enum format.</param>
  3040. <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
  3041. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  3042. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  3043. -or-
  3044. <paramref name="value"/> doesn't represent a member or value of <paramref name="enumType"/>
  3045. -or-
  3046. <paramref name="format"/> is an invalid value.</exception>
  3047. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
  3048. </member>
  3049. <member name="M:EnumsNET.Enums.Parse(System.Type,System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  3050. <summary>
  3051. Converts the string representation of one or more members or values of <paramref name="enumType"/> to its respective value of type <paramref name="enumType"/>
  3052. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  3053. </summary>
  3054. <param name="enumType">The enum type.</param>
  3055. <param name="value">The enum members or values' string representation.</param>
  3056. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3057. <param name="format0">The first parsing enum format.</param>
  3058. <param name="format1">The second parsing enum format.</param>
  3059. <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
  3060. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  3061. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  3062. -or-
  3063. <paramref name="value"/> doesn't represent a member or value of <paramref name="enumType"/>
  3064. -or-
  3065. <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  3066. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
  3067. </member>
  3068. <member name="M:EnumsNET.Enums.Parse(System.Type,System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  3069. <summary>
  3070. Converts the string representation of one or more members or values of <paramref name="enumType"/> to its respective value of type <paramref name="enumType"/>
  3071. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  3072. </summary>
  3073. <param name="enumType">The enum type.</param>
  3074. <param name="value">The enum members or values' string representation.</param>
  3075. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3076. <param name="format0">The first parsing enum format.</param>
  3077. <param name="format1">The second parsing enum format.</param>
  3078. <param name="format2">The third parsing enum format.</param>
  3079. <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
  3080. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  3081. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  3082. -or-
  3083. <paramref name="value"/> doesn't represent a member or value of <paramref name="enumType"/>
  3084. -or-
  3085. <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  3086. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
  3087. </member>
  3088. <member name="M:EnumsNET.Enums.Parse(System.Type,System.String,System.Boolean,EnumsNET.EnumFormat[])">
  3089. <summary>
  3090. Converts the string representation of one or more members or values of <paramref name="enumType"/> to its respective value of type <paramref name="enumType"/>
  3091. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  3092. </summary>
  3093. <param name="enumType">The enum type.</param>
  3094. <param name="value">The enum members or values' string representation.</param>
  3095. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3096. <param name="formats">The parsing enum formats.</param>
  3097. <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
  3098. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  3099. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  3100. -or-
  3101. <paramref name="value"/> doesn't represent a member or value of <paramref name="enumType"/>
  3102. -or-
  3103. <paramref name="formats"/> contains an invalid value.</exception>
  3104. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
  3105. </member>
  3106. <member name="M:EnumsNET.Enums.TryParse(System.Type,System.String,System.Object@)">
  3107. <summary>
  3108. Tries to convert the string representation of one or more member names or values of <paramref name="enumType"/> to its respective value of type <paramref name="enumType"/>.
  3109. The return value indicates whether the conversion succeeded.
  3110. </summary>
  3111. <param name="enumType">The enum type.</param>
  3112. <param name="value">The enum member names or values' string representation.</param>
  3113. <param name="result">If the conversion succeeds this contains a <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</param>
  3114. <returns>Indication whether the conversion succeeded.</returns>
  3115. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  3116. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
  3117. </member>
  3118. <member name="M:EnumsNET.Enums.TryParse(System.Type,System.String,System.Boolean,System.Object@)">
  3119. <summary>
  3120. Tries to convert the string representation of one or more member names or values of <paramref name="enumType"/> to its respective value of type <paramref name="enumType"/>.
  3121. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive. The return value indicates whether the conversion succeeded.
  3122. </summary>
  3123. <param name="enumType">The enum type.</param>
  3124. <param name="value">The enum member names or values' string representation.</param>
  3125. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3126. <param name="result">If the conversion succeeds this contains a <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</param>
  3127. <returns>Indication whether the conversion succeeded.</returns>
  3128. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  3129. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
  3130. </member>
  3131. <member name="M:EnumsNET.Enums.TryParse(System.Type,System.String,System.Boolean,System.Object@,EnumsNET.EnumFormat)">
  3132. <summary>
  3133. Tries to convert the string representation of one or more members or values of <paramref name="enumType"/> to its respective value of type <paramref name="enumType"/>
  3134. using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  3135. The return value indicates whether the conversion succeeded.
  3136. </summary>
  3137. <param name="enumType">The enum type.</param>
  3138. <param name="value">The enum members or values' string representation.</param>
  3139. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3140. <param name="result">If the conversion succeeds this contains a <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</param>
  3141. <param name="format">The parsing enum format.</param>
  3142. <returns>Indication whether the conversion succeeded.</returns>
  3143. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  3144. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  3145. -or-
  3146. <paramref name="format"/> is an invalid value.</exception>
  3147. </member>
  3148. <member name="M:EnumsNET.Enums.TryParse(System.Type,System.String,System.Boolean,System.Object@,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  3149. <summary>
  3150. Tries to convert the string representation of one or more members or values of <paramref name="enumType"/> to its respective value of type <paramref name="enumType"/>
  3151. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  3152. The return value indicates whether the conversion succeeded.
  3153. </summary>
  3154. <param name="enumType">The enum type.</param>
  3155. <param name="value">The enum members or values' string representation.</param>
  3156. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3157. <param name="result">If the conversion succeeds this contains a <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</param>
  3158. <param name="format0">The first parsing enum format.</param>
  3159. <param name="format1">The second parsing enum format.</param>
  3160. <returns>Indication whether the conversion succeeded.</returns>
  3161. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  3162. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  3163. -or-
  3164. <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  3165. </member>
  3166. <member name="M:EnumsNET.Enums.TryParse(System.Type,System.String,System.Boolean,System.Object@,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  3167. <summary>
  3168. Tries to convert the string representation of one or more members or values of <paramref name="enumType"/> to its respective value of type <paramref name="enumType"/>
  3169. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  3170. The return value indicates whether the conversion succeeded.
  3171. </summary>
  3172. <param name="enumType">The enum type.</param>
  3173. <param name="value">The enum members or values' string representation.</param>
  3174. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3175. <param name="result">If the conversion succeeds this contains a <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</param>
  3176. <param name="format0">The first parsing enum format.</param>
  3177. <param name="format1">The second parsing enum format.</param>
  3178. <param name="format2">The third parsing enum format.</param>
  3179. <returns>Indication whether the conversion succeeded.</returns>
  3180. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  3181. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  3182. -or-
  3183. <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  3184. </member>
  3185. <member name="M:EnumsNET.Enums.TryParse(System.Type,System.String,System.Boolean,System.Object@,EnumsNET.EnumFormat[])">
  3186. <summary>
  3187. Tries to convert the string representation of one or more members or values of <paramref name="enumType"/> to its respective value of type <paramref name="enumType"/>
  3188. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  3189. The return value indicates whether the conversion succeeded.
  3190. </summary>
  3191. <param name="enumType">The enum type.</param>
  3192. <param name="value">The enum members or values' string representation.</param>
  3193. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3194. <param name="result">If the conversion succeeds this contains a <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</param>
  3195. <param name="formats">The parsing enum formats.</param>
  3196. <returns>Indication whether the conversion succeeded.</returns>
  3197. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  3198. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  3199. -or-
  3200. <paramref name="formats"/> contains an invalid value.</exception>
  3201. </member>
  3202. <member name="T:EnumsNET.EnumValidation">
  3203. <summary>
  3204. Specifies the enum validation to perform.
  3205. </summary>
  3206. </member>
  3207. <member name="F:EnumsNET.EnumValidation.None">
  3208. <summary>
  3209. No validation.
  3210. </summary>
  3211. </member>
  3212. <member name="F:EnumsNET.EnumValidation.Default">
  3213. <summary>
  3214. If the enum is a standard enum returns whether the value is defined.
  3215. If the enum is marked with the <see cref="T:System.FlagsAttribute"/> it returns whether it's a valid flag combination of the enum's defined values
  3216. or is defined. Or if the enum has an attribute that implements <see cref="T:EnumsNET.IEnumValidatorAttribute`1"/>
  3217. then that attribute's <see cref="M:EnumsNET.IEnumValidatorAttribute`1.IsValid(`0)"/> method is used.
  3218. </summary>
  3219. </member>
  3220. <member name="F:EnumsNET.EnumValidation.IsDefined">
  3221. <summary>
  3222. Returns if the value is defined.
  3223. </summary>
  3224. </member>
  3225. <member name="F:EnumsNET.EnumValidation.IsValidFlagCombination">
  3226. <summary>
  3227. Returns if the value is a valid flag combination of the enum's defined values.
  3228. </summary>
  3229. </member>
  3230. <member name="T:EnumsNET.FlagEnums">
  3231. <summary>
  3232. Static class that provides efficient type-safe flag enum operations through the use of cached enum names, values, and attributes.
  3233. Many operations are exposed as C# extension methods for convenience.
  3234. </summary>
  3235. </member>
  3236. <member name="M:EnumsNET.FlagEnums.IsFlagEnum``1">
  3237. <summary>
  3238. Indicates if <typeparamref name="TEnum"/> is marked with the <see cref="T:System.FlagsAttribute"/>.
  3239. </summary>
  3240. <typeparam name="TEnum">The enum type.</typeparam>
  3241. <returns>Indication if <typeparamref name="TEnum"/> is marked with the <see cref="T:System.FlagsAttribute"/>.</returns>
  3242. </member>
  3243. <member name="M:EnumsNET.FlagEnums.GetAllFlags``1">
  3244. <summary>
  3245. Retrieves all the flags defined by <typeparamref name="TEnum"/>.
  3246. </summary>
  3247. <typeparam name="TEnum">The enum type.</typeparam>
  3248. <returns>All the flags defined by <typeparamref name="TEnum"/>.</returns>
  3249. </member>
  3250. <member name="M:EnumsNET.FlagEnums.IsValidFlagCombination``1(``0)">
  3251. <summary>
  3252. Indicates whether <paramref name="value"/> is a valid flag combination of <typeparamref name="TEnum"/>'s defined flags.
  3253. </summary>
  3254. <typeparam name="TEnum">The enum type.</typeparam>
  3255. <param name="value">The flags enum value.</param>
  3256. <returns>Indication of whether <paramref name="value"/> is a valid flag combination of <typeparamref name="TEnum"/>'s defined flags.</returns>
  3257. </member>
  3258. <member name="M:EnumsNET.FlagEnums.FormatFlags``1(``0)">
  3259. <summary>
  3260. Retrieves the names of <paramref name="value"/>'s flags delimited with commas or if empty returns the name of the zero flag if defined otherwise "0".
  3261. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  3262. </summary>
  3263. <typeparam name="TEnum">The enum type.</typeparam>
  3264. <param name="value">The flags enum value.</param>
  3265. <returns>The names of <paramref name="value"/>'s flags delimited with commas or if empty returns the name of the zero flag if defined otherwise "0".
  3266. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  3267. </member>
  3268. <member name="M:EnumsNET.FlagEnums.FormatFlags``1(``0,System.String)">
  3269. <summary>
  3270. Retrieves the names of <paramref name="value"/>'s flags delimited with <paramref name="delimiter"/> or if empty returns the name of the zero flag if defined otherwise "0".
  3271. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  3272. </summary>
  3273. <typeparam name="TEnum">The enum type.</typeparam>
  3274. <param name="value">The flags enum value.</param>
  3275. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  3276. <returns>The names of <paramref name="value"/>'s flags delimited with <paramref name="delimiter"/> or if empty returns the name of the zero flag if defined otherwise "0".
  3277. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  3278. </member>
  3279. <member name="M:EnumsNET.FlagEnums.FormatFlags``1(``0,System.String,EnumsNET.EnumFormat)">
  3280. <summary>
  3281. Retrieves <paramref name="value"/>'s flags formatted with <paramref name="format"/> and delimited with <paramref name="delimiter"/>
  3282. or if empty returns the zero flag formatted with <paramref name="format"/>.
  3283. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  3284. </summary>
  3285. <typeparam name="TEnum">The enum type.</typeparam>
  3286. <param name="value">The flags enum value.</param>
  3287. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  3288. <param name="format">The output format to use.</param>
  3289. <returns><paramref name="value"/>'s flags formatted with <paramref name="format"/> and delimited with <paramref name="delimiter"/>
  3290. or if empty returns the zero flag formatted with <paramref name="format"/>.
  3291. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  3292. <exception cref="T:System.ArgumentException"><paramref name="format"/> is an invalid value.</exception>
  3293. </member>
  3294. <member name="M:EnumsNET.FlagEnums.FormatFlags``1(``0,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  3295. <summary>
  3296. Retrieves <paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
  3297. or if empty returns the zero flag formatted with formats.
  3298. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  3299. </summary>
  3300. <typeparam name="TEnum">The enum type.</typeparam>
  3301. <param name="value">The flags enum value.</param>
  3302. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  3303. <param name="format0">The first output format to use.</param>
  3304. <param name="format1">The second output format to use.</param>
  3305. <returns><paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
  3306. or if empty returns the zero flag formatted with formats.
  3307. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  3308. <exception cref="T:System.ArgumentException"><paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  3309. </member>
  3310. <member name="M:EnumsNET.FlagEnums.FormatFlags``1(``0,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  3311. <summary>
  3312. Retrieves <paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
  3313. or if empty returns the zero flag formatted with formats.
  3314. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  3315. </summary>
  3316. <typeparam name="TEnum">The enum type.</typeparam>
  3317. <param name="value">The flags enum value.</param>
  3318. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  3319. <param name="format0">The first output format to use.</param>
  3320. <param name="format1">The second output format to use.</param>
  3321. <param name="format2">The third output format to use.</param>
  3322. <returns><paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
  3323. or if empty returns the zero flag formatted with formats.
  3324. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  3325. <exception cref="T:System.ArgumentException"><paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  3326. </member>
  3327. <member name="M:EnumsNET.FlagEnums.FormatFlags``1(``0,System.String,EnumsNET.EnumFormat[])">
  3328. <summary>
  3329. Retrieves <paramref name="value"/>'s flags formatted with <paramref name="formats"/> and delimited with <paramref name="delimiter"/>
  3330. or if empty returns the zero flag formatted with <paramref name="formats"/>.
  3331. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  3332. </summary>
  3333. <typeparam name="TEnum">The enum type.</typeparam>
  3334. <param name="value">The flags enum value.</param>
  3335. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  3336. <param name="formats">The output formats to use.</param>
  3337. <returns><paramref name="value"/>'s flags formatted with <paramref name="formats"/> and delimited with <paramref name="delimiter"/>
  3338. or if empty returns the zero flag formatted with <paramref name="formats"/>.
  3339. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  3340. <exception cref="T:System.ArgumentException"><paramref name="formats"/> contains an invalid value.</exception>
  3341. </member>
  3342. <member name="M:EnumsNET.FlagEnums.TryFormatFlags``1(``0,System.Span{System.Char},System.Int32@,System.ReadOnlySpan{System.Char},EnumsNET.EnumFormat[])">
  3343. <summary>
  3344. Tries to format the value of the flag enum value into the provided span of characters.
  3345. </summary>
  3346. <typeparam name="TEnum">The enum type.</typeparam>
  3347. <param name="value">The flags enum value.</param>
  3348. <param name="destination">When this method returns, value formatted as a span of characters.</param>
  3349. <param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination"/>.</param>
  3350. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  3351. <param name="formats">The output formats to use.</param>
  3352. <returns><c>true</c> if the formatting was successful; otherwise, <c>false</c>.</returns>
  3353. <exception cref="T:System.ArgumentException"><paramref name="formats"/> contains an invalid value.</exception>
  3354. </member>
  3355. <member name="M:EnumsNET.FlagEnums.GetFlags``1(``0)">
  3356. <summary>
  3357. Retrieves the flags that compose <paramref name="value"/>.
  3358. </summary>
  3359. <typeparam name="TEnum">The enum type.</typeparam>
  3360. <param name="value">The flags enum value.</param>
  3361. <returns>The flags that compose <paramref name="value"/>.</returns>
  3362. </member>
  3363. <member name="M:EnumsNET.FlagEnums.GetFlagMembers``1(``0)">
  3364. <summary>
  3365. Retrieves the <see cref="T:EnumsNET.EnumMember`1"/>s of the flags that compose <paramref name="value"/>.
  3366. </summary>
  3367. <typeparam name="TEnum">The enum type.</typeparam>
  3368. <param name="value">The flags enum value.</param>
  3369. <returns>The <see cref="T:EnumsNET.EnumMember`1"/>s of the flags that compose <paramref name="value"/>.</returns>
  3370. </member>
  3371. <member name="M:EnumsNET.FlagEnums.GetFlagCount``1">
  3372. <summary>
  3373. Retrieves the flag count of <typeparamref name="TEnum"/>.
  3374. </summary>
  3375. <typeparam name="TEnum">The enum type.</typeparam>
  3376. <returns>The flag count of <typeparamref name="TEnum"/>.</returns>
  3377. </member>
  3378. <member name="M:EnumsNET.FlagEnums.GetFlagCount``1(``0)">
  3379. <summary>
  3380. Retrieves the flag count of <paramref name="value"/>.
  3381. </summary>
  3382. <typeparam name="TEnum">The enum type.</typeparam>
  3383. <param name="value">The flags enum value.</param>
  3384. <returns>The flag count of <paramref name="value"/>.</returns>
  3385. </member>
  3386. <member name="M:EnumsNET.FlagEnums.GetFlagCount``1(``0,``0)">
  3387. <summary>
  3388. Retrieves the flag count of <paramref name="otherFlags"/> that <paramref name="value"/> has.
  3389. </summary>
  3390. <typeparam name="TEnum">The enum type.</typeparam>
  3391. <param name="value">The flags enum value.</param>
  3392. <param name="otherFlags">The other flags enum value.</param>
  3393. <returns>The flag count of <paramref name="otherFlags"/> that <paramref name="value"/> has.</returns>
  3394. </member>
  3395. <member name="M:EnumsNET.FlagEnums.HasAnyFlags``1(``0)">
  3396. <summary>
  3397. Indicates if <paramref name="value"/> has any flags.
  3398. </summary>
  3399. <typeparam name="TEnum">The enum type.</typeparam>
  3400. <param name="value">The flags enum value.</param>
  3401. <returns>Indication if <paramref name="value"/> has any flags.</returns>
  3402. </member>
  3403. <member name="M:EnumsNET.FlagEnums.HasAnyFlags``1(``0,``0)">
  3404. <summary>
  3405. Indicates if <paramref name="value"/> has any flags that are in <paramref name="otherFlags"/>.
  3406. </summary>
  3407. <typeparam name="TEnum">The enum type.</typeparam>
  3408. <param name="value">The flags enum value.</param>
  3409. <param name="otherFlags">The other flags enum value.</param>
  3410. <returns>Indication if <paramref name="value"/> has any flags that are in <paramref name="otherFlags"/>.</returns>
  3411. </member>
  3412. <member name="M:EnumsNET.FlagEnums.HasAllFlags``1(``0)">
  3413. <summary>
  3414. Indicates if <paramref name="value"/> has all of the flags that are defined in <typeparamref name="TEnum"/>.
  3415. </summary>
  3416. <typeparam name="TEnum">The enum type.</typeparam>
  3417. <param name="value">The flags enum value.</param>
  3418. <returns>Indication if <paramref name="value"/> has all of the flags that are defined in <typeparamref name="TEnum"/>.</returns>
  3419. </member>
  3420. <member name="M:EnumsNET.FlagEnums.HasAllFlags``1(``0,``0)">
  3421. <summary>
  3422. Indicates if <paramref name="value"/> has all of the flags that are in <paramref name="otherFlags"/>.
  3423. </summary>
  3424. <typeparam name="TEnum">The enum type.</typeparam>
  3425. <param name="value">The flags enum value.</param>
  3426. <param name="otherFlags">The other flags enum value.</param>
  3427. <returns>Indication if <paramref name="value"/> has all of the flags that are in <paramref name="otherFlags"/>.</returns>
  3428. </member>
  3429. <member name="M:EnumsNET.FlagEnums.ToggleFlags``1(``0)">
  3430. <summary>
  3431. Returns <paramref name="value"/> with all of it's flags toggled. Equivalent to the bitwise "xor" operator with <see cref="M:EnumsNET.FlagEnums.GetAllFlags``1"/>.
  3432. </summary>
  3433. <typeparam name="TEnum">The enum type.</typeparam>
  3434. <param name="value">The flags enum value.</param>
  3435. <returns><paramref name="value"/> with all of it's flags toggled.</returns>
  3436. </member>
  3437. <member name="M:EnumsNET.FlagEnums.ToggleFlags``1(``0,``0)">
  3438. <summary>
  3439. Returns <paramref name="value"/> while toggling the flags that are in <paramref name="otherFlags"/>. Equivalent to the bitwise "xor" operator.
  3440. </summary>
  3441. <typeparam name="TEnum">The enum type.</typeparam>
  3442. <param name="value">The flags enum value.</param>
  3443. <param name="otherFlags">The other flags enum value.</param>
  3444. <returns><paramref name="value"/> while toggling the flags that are in <paramref name="otherFlags"/>.</returns>
  3445. </member>
  3446. <member name="M:EnumsNET.FlagEnums.CommonFlags``1(``0,``0)">
  3447. <summary>
  3448. Returns <paramref name="value"/> with only the flags that are also in <paramref name="otherFlags"/>. Equivalent to the bitwise "and" operation.
  3449. </summary>
  3450. <typeparam name="TEnum">The enum type.</typeparam>
  3451. <param name="value">The flags enum value.</param>
  3452. <param name="otherFlags">The other flags enum value.</param>
  3453. <returns><paramref name="value"/> with only the flags that are also in <paramref name="otherFlags"/>.</returns>
  3454. </member>
  3455. <member name="M:EnumsNET.FlagEnums.CombineFlags``1(``0,``0)">
  3456. <summary>
  3457. Combines the flags of <paramref name="value"/> and <paramref name="otherFlags"/>. Equivalent to the bitwise "or" operation.
  3458. </summary>
  3459. <typeparam name="TEnum">The enum type.</typeparam>
  3460. <param name="value">The flags enum value.</param>
  3461. <param name="otherFlags">The other flags enum value.</param>
  3462. <returns>Combination of <paramref name="value"/> with the flags in <paramref name="otherFlags"/>.</returns>
  3463. </member>
  3464. <member name="M:EnumsNET.FlagEnums.CombineFlags``1(``0,``0,``0)">
  3465. <summary>
  3466. Combines the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, and <paramref name="flag2"/>.
  3467. </summary>
  3468. <typeparam name="TEnum">The enum type.</typeparam>
  3469. <param name="flag0">The first flags enum value.</param>
  3470. <param name="flag1">The second flags enum value.</param>
  3471. <param name="flag2">The third flags enum value.</param>
  3472. <returns>Combination of the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, and <paramref name="flag2"/>.</returns>
  3473. </member>
  3474. <member name="M:EnumsNET.FlagEnums.CombineFlags``1(``0,``0,``0,``0)">
  3475. <summary>
  3476. Combines the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, <paramref name="flag2"/>, and <paramref name="flag3"/>.
  3477. </summary>
  3478. <typeparam name="TEnum">The enum type.</typeparam>
  3479. <param name="flag0">The first flags enum value.</param>
  3480. <param name="flag1">The second flags enum value.</param>
  3481. <param name="flag2">The third flags enum value.</param>
  3482. <param name="flag3">The fourth flags enum value.</param>
  3483. <returns>Combination of the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, <paramref name="flag2"/>, and <paramref name="flag3"/>.</returns>
  3484. </member>
  3485. <member name="M:EnumsNET.FlagEnums.CombineFlags``1(``0,``0,``0,``0,``0)">
  3486. <summary>
  3487. Combines the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, <paramref name="flag2"/>, <paramref name="flag3"/>, and <paramref name="flag4"/>.
  3488. </summary>
  3489. <typeparam name="TEnum">The enum type.</typeparam>
  3490. <param name="flag0">The first flags enum value.</param>
  3491. <param name="flag1">The second flags enum value.</param>
  3492. <param name="flag2">The third flags enum value.</param>
  3493. <param name="flag3">The fourth flags enum value.</param>
  3494. <param name="flag4">The fifth flags enum value.</param>
  3495. <returns>Combination of the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, <paramref name="flag2"/>, <paramref name="flag3"/>, and <paramref name="flag4"/>.</returns>
  3496. </member>
  3497. <member name="M:EnumsNET.FlagEnums.CombineFlags``1(``0[])">
  3498. <summary>
  3499. Combines all of the flags of <paramref name="flags"/>.
  3500. </summary>
  3501. <typeparam name="TEnum">The enum type.</typeparam>
  3502. <param name="flags">The flags enum values.</param>
  3503. <returns>Combination of all of the flags of <paramref name="flags"/>.</returns>
  3504. </member>
  3505. <member name="M:EnumsNET.FlagEnums.CombineFlags``1(System.Collections.Generic.IEnumerable{``0})">
  3506. <summary>
  3507. Combines all of the flags of <paramref name="flags"/>.
  3508. </summary>
  3509. <typeparam name="TEnum">The enum type.</typeparam>
  3510. <param name="flags">The flags enum values.</param>
  3511. <returns>Combination of all of the flags of <paramref name="flags"/>.</returns>
  3512. </member>
  3513. <member name="M:EnumsNET.FlagEnums.RemoveFlags``1(``0,``0)">
  3514. <summary>
  3515. Returns <paramref name="value"/> without the flags specified in <paramref name="otherFlags"/>.
  3516. </summary>
  3517. <typeparam name="TEnum">The enum type.</typeparam>
  3518. <param name="value">The flags enum value.</param>
  3519. <param name="otherFlags">The other flags enum value.</param>
  3520. <returns><paramref name="value"/> without the flags specified in <paramref name="otherFlags"/>.</returns>
  3521. </member>
  3522. <member name="M:EnumsNET.FlagEnums.ParseFlags``1(System.String)">
  3523. <summary>
  3524. Converts the string representation of one or more member names or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value.
  3525. </summary>
  3526. <typeparam name="TEnum">The enum type.</typeparam>
  3527. <param name="value">The enum member names or values' string representation.</param>
  3528. <returns>A <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  3529. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  3530. <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member name or value of <typeparamref name="TEnum"/>.</exception>
  3531. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of <typeparamref name="TEnum"/>'s underlying type.</exception>
  3532. </member>
  3533. <member name="M:EnumsNET.FlagEnums.ParseFlags``1(System.String,System.Boolean)">
  3534. <summary>
  3535. Converts the string representation of one or more member names or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value.
  3536. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  3537. </summary>
  3538. <typeparam name="TEnum">The enum type.</typeparam>
  3539. <param name="value">The enum member names or values' string representation.</param>
  3540. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3541. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  3542. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  3543. <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member name or value of <typeparamref name="TEnum"/>.</exception>
  3544. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  3545. </member>
  3546. <member name="M:EnumsNET.FlagEnums.ParseFlags``1(System.String,System.Boolean,System.String)">
  3547. <summary>
  3548. Converts the string representation of one or more member names or values of <typeparamref name="TEnum"/> delimited with <paramref name="delimiter"/> to its respective <typeparamref name="TEnum"/> value.
  3549. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  3550. </summary>
  3551. <typeparam name="TEnum">The enum type.</typeparam>
  3552. <param name="value">The enum member names or values' string representation.</param>
  3553. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3554. <param name="delimiter">The delimiter used to separate individual flags.</param>
  3555. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  3556. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  3557. <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member name or value of <typeparamref name="TEnum"/>.</exception>
  3558. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  3559. </member>
  3560. <member name="M:EnumsNET.FlagEnums.ParseFlags``1(System.String,System.Boolean,System.String,EnumsNET.EnumFormat)">
  3561. <summary>
  3562. Converts the string representation of one or more members or values of <typeparamref name="TEnum"/> delimited with <paramref name="delimiter"/> to its respective <typeparamref name="TEnum"/> value
  3563. using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  3564. </summary>
  3565. <typeparam name="TEnum">The enum type.</typeparam>
  3566. <param name="value">The enum members or values' string representation.</param>
  3567. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3568. <param name="delimiter">The delimiter used to separate individual flags.</param>
  3569. <param name="format">The parsing enum format.</param>
  3570. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  3571. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  3572. <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
  3573. -or-
  3574. <paramref name="format"/> is an invalid value.</exception>
  3575. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  3576. </member>
  3577. <member name="M:EnumsNET.FlagEnums.ParseFlags``1(System.String,System.Boolean,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  3578. <summary>
  3579. Converts the string representation of one or more members or values of <typeparamref name="TEnum"/> delimited with <paramref name="delimiter"/> to its respective <typeparamref name="TEnum"/> value
  3580. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  3581. </summary>
  3582. <typeparam name="TEnum">The enum type.</typeparam>
  3583. <param name="value">The enum members or values' string representation.</param>
  3584. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3585. <param name="delimiter">The delimiter used to separate individual flags.</param>
  3586. <param name="format0">The first parsing enum format.</param>
  3587. <param name="format1">The second parsing enum format.</param>
  3588. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  3589. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  3590. <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
  3591. -or-
  3592. <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  3593. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  3594. </member>
  3595. <member name="M:EnumsNET.FlagEnums.ParseFlags``1(System.String,System.Boolean,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  3596. <summary>
  3597. Converts the string representation of one or more members or values of <typeparamref name="TEnum"/> delimited with <paramref name="delimiter"/> to its respective <typeparamref name="TEnum"/> value
  3598. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  3599. </summary>
  3600. <typeparam name="TEnum">The enum type.</typeparam>
  3601. <param name="value">The enum members or values' string representation.</param>
  3602. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3603. <param name="delimiter">The delimiter used to separate individual flags.</param>
  3604. <param name="format0">The first parsing enum format.</param>
  3605. <param name="format1">The second parsing enum format.</param>
  3606. <param name="format2">The third parsing enum format.</param>
  3607. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  3608. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  3609. <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
  3610. -or-
  3611. <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  3612. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  3613. </member>
  3614. <member name="M:EnumsNET.FlagEnums.ParseFlags``1(System.String,System.Boolean,System.String,EnumsNET.EnumFormat[])">
  3615. <summary>
  3616. Converts the string representation of one or more members or values of <typeparamref name="TEnum"/> delimited with <paramref name="delimiter"/> to its respective <typeparamref name="TEnum"/> value
  3617. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  3618. </summary>
  3619. <typeparam name="TEnum">The enum type.</typeparam>
  3620. <param name="value">The enum members or values' string representation.</param>
  3621. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3622. <param name="delimiter">The delimiter used to separate individual flags.</param>
  3623. <param name="formats">The parsing enum formats.</param>
  3624. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  3625. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  3626. <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
  3627. -or-
  3628. <paramref name="formats"/> contains an invalid value.</exception>
  3629. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  3630. </member>
  3631. <member name="M:EnumsNET.FlagEnums.TryParseFlags``1(System.String,``0@)">
  3632. <summary>
  3633. Tries to convert the string representation of one or more member names or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value.
  3634. The return value indicates whether the conversion succeeded.
  3635. </summary>
  3636. <typeparam name="TEnum">The enum type.</typeparam>
  3637. <param name="value">The enum member names or values' string representation.</param>
  3638. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  3639. <returns>Indication whether the conversion succeeded.</returns>
  3640. </member>
  3641. <member name="M:EnumsNET.FlagEnums.TryParseFlags``1(System.String,System.Boolean,``0@)">
  3642. <summary>
  3643. Tries to convert the string representation of one or more member names or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value.
  3644. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive. The return value indicates whether the conversion succeeded.
  3645. </summary>
  3646. <typeparam name="TEnum">The enum type.</typeparam>
  3647. <param name="value">The enum member names or values' string representation.</param>
  3648. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3649. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  3650. <returns>Indication whether the conversion succeeded.</returns>
  3651. </member>
  3652. <member name="M:EnumsNET.FlagEnums.TryParseFlags``1(System.String,System.Boolean,System.String,``0@)">
  3653. <summary>
  3654. Tries to convert the string representation of one or more member names or values of <typeparamref name="TEnum"/> delimited with <paramref name="delimiter"/> to its respective <typeparamref name="TEnum"/> value.
  3655. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive. The return value indicates whether the conversion succeeded.
  3656. </summary>
  3657. <typeparam name="TEnum">The enum type.</typeparam>
  3658. <param name="value">The enum member names or values' string representation.</param>
  3659. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3660. <param name="delimiter">The delimiter used to separate individual flags.</param>
  3661. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  3662. <returns>Indication whether the conversion succeeded.</returns>
  3663. </member>
  3664. <member name="M:EnumsNET.FlagEnums.TryParseFlags``1(System.String,System.Boolean,System.String,``0@,EnumsNET.EnumFormat)">
  3665. <summary>
  3666. Tries to convert the string representation of one or more members or values of <typeparamref name="TEnum"/> delimited with <paramref name="delimiter"/> to its respective <typeparamref name="TEnum"/> value
  3667. using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  3668. The return value indicates whether the conversion succeeded.
  3669. </summary>
  3670. <typeparam name="TEnum">The enum type.</typeparam>
  3671. <param name="value">The enum members or values' string representation.</param>
  3672. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3673. <param name="delimiter">The delimiter used to separate individual flags.</param>
  3674. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  3675. <param name="format">The parsing enum format.</param>
  3676. <returns>Indication whether the conversion succeeded.</returns>
  3677. <exception cref="T:System.ArgumentException"><paramref name="format"/> is an invalid value.</exception>
  3678. </member>
  3679. <member name="M:EnumsNET.FlagEnums.TryParseFlags``1(System.String,System.Boolean,System.String,``0@,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  3680. <summary>
  3681. Tries to convert the string representation of one or more members or values of <typeparamref name="TEnum"/> delimited with <paramref name="delimiter"/> to its respective <typeparamref name="TEnum"/> value
  3682. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  3683. The return value indicates whether the conversion succeeded.
  3684. </summary>
  3685. <typeparam name="TEnum">The enum type.</typeparam>
  3686. <param name="value">The enum members or values' string representation.</param>
  3687. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3688. <param name="delimiter">The delimiter used to separate individual flags.</param>
  3689. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  3690. <param name="format0">The first parsing enum format.</param>
  3691. <param name="format1">The first parsing enum format.</param>
  3692. <returns>Indication whether the conversion succeeded.</returns>
  3693. <exception cref="T:System.ArgumentException"><paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  3694. </member>
  3695. <member name="M:EnumsNET.FlagEnums.TryParseFlags``1(System.String,System.Boolean,System.String,``0@,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  3696. <summary>
  3697. Tries to convert the string representation of one or more members or values of <typeparamref name="TEnum"/> delimited with <paramref name="delimiter"/> to its respective <typeparamref name="TEnum"/> value
  3698. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  3699. The return value indicates whether the conversion succeeded.
  3700. </summary>
  3701. <typeparam name="TEnum">The enum type.</typeparam>
  3702. <param name="value">The enum members or values' string representation.</param>
  3703. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3704. <param name="delimiter">The delimiter used to separate individual flags.</param>
  3705. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  3706. <param name="format0">The first parsing enum format.</param>
  3707. <param name="format1">The second parsing enum format.</param>
  3708. <param name="format2">The third parsing enum format.</param>
  3709. <returns>Indication whether the conversion succeeded.</returns>
  3710. <exception cref="T:System.ArgumentException"><paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  3711. </member>
  3712. <member name="M:EnumsNET.FlagEnums.TryParseFlags``1(System.String,System.Boolean,System.String,``0@,EnumsNET.EnumFormat[])">
  3713. <summary>
  3714. Tries to convert the string representation of one or more members or values of <typeparamref name="TEnum"/> delimited with <paramref name="delimiter"/> to its respective <typeparamref name="TEnum"/> value
  3715. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  3716. The return value indicates whether the conversion succeeded.
  3717. </summary>
  3718. <typeparam name="TEnum">The enum type.</typeparam>
  3719. <param name="value">The enum members or values' string representation.</param>
  3720. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3721. <param name="delimiter">The delimiter used to separate individual flags.</param>
  3722. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  3723. <param name="formats">The parsing enum formats.</param>
  3724. <returns>Indication whether the conversion succeeded.</returns>
  3725. <exception cref="T:System.ArgumentException"><paramref name="formats"/> contains an invalid value.</exception>
  3726. </member>
  3727. <member name="M:EnumsNET.FlagEnums.IsFlagEnumUnsafe``1">
  3728. <summary>
  3729. Indicates if <typeparamref name="TEnum"/> is marked with the <see cref="T:System.FlagsAttribute"/>.
  3730. </summary>
  3731. <typeparam name="TEnum">The enum type.</typeparam>
  3732. <returns>Indication if <typeparamref name="TEnum"/> is marked with the <see cref="T:System.FlagsAttribute"/>.</returns>
  3733. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3734. </member>
  3735. <member name="M:EnumsNET.FlagEnums.GetAllFlagsUnsafe``1">
  3736. <summary>
  3737. Retrieves all the flags defined by <typeparamref name="TEnum"/>.
  3738. </summary>
  3739. <typeparam name="TEnum">The enum type.</typeparam>
  3740. <returns>All the flags defined by <typeparamref name="TEnum"/>.</returns>
  3741. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3742. </member>
  3743. <member name="M:EnumsNET.FlagEnums.IsValidFlagCombinationUnsafe``1(``0)">
  3744. <summary>
  3745. Indicates whether <paramref name="value"/> is a valid flag combination of <typeparamref name="TEnum"/>'s defined flags.
  3746. </summary>
  3747. <typeparam name="TEnum">The enum type.</typeparam>
  3748. <param name="value">The flags enum value.</param>
  3749. <returns>Indication of whether <paramref name="value"/> is a valid flag combination of <typeparamref name="TEnum"/>'s defined flags.</returns>
  3750. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3751. </member>
  3752. <member name="M:EnumsNET.FlagEnums.FormatFlagsUnsafe``1(``0)">
  3753. <summary>
  3754. Retrieves the names of <paramref name="value"/>'s flags delimited with commas or if empty returns the name of the zero flag if defined otherwise "0".
  3755. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  3756. </summary>
  3757. <typeparam name="TEnum">The enum type.</typeparam>
  3758. <param name="value">The flags enum value.</param>
  3759. <returns>The names of <paramref name="value"/>'s flags delimited with commas or if empty returns the name of the zero flag if defined otherwise "0".
  3760. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  3761. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3762. </member>
  3763. <member name="M:EnumsNET.FlagEnums.FormatFlagsUnsafe``1(``0,System.String)">
  3764. <summary>
  3765. Retrieves the names of <paramref name="value"/>'s flags delimited with <paramref name="delimiter"/> or if empty returns the name of the zero flag if defined otherwise "0".
  3766. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  3767. </summary>
  3768. <typeparam name="TEnum">The enum type.</typeparam>
  3769. <param name="value">The flags enum value.</param>
  3770. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  3771. <returns>The names of <paramref name="value"/>'s flags delimited with <paramref name="delimiter"/> or if empty returns the name of the zero flag if defined otherwise "0".
  3772. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  3773. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3774. </member>
  3775. <member name="M:EnumsNET.FlagEnums.FormatFlagsUnsafe``1(``0,System.String,EnumsNET.EnumFormat)">
  3776. <summary>
  3777. Retrieves <paramref name="value"/>'s flags formatted with <paramref name="format"/> and delimited with <paramref name="delimiter"/>
  3778. or if empty returns the zero flag formatted with <paramref name="format"/>.
  3779. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  3780. </summary>
  3781. <typeparam name="TEnum">The enum type.</typeparam>
  3782. <param name="value">The flags enum value.</param>
  3783. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  3784. <param name="format">The output format to use.</param>
  3785. <returns><paramref name="value"/>'s flags formatted with <paramref name="format"/> and delimited with <paramref name="delimiter"/>
  3786. or if empty returns the zero flag formatted with <paramref name="format"/>.
  3787. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  3788. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  3789. -or-
  3790. <paramref name="format"/> is an invalid value.</exception>
  3791. </member>
  3792. <member name="M:EnumsNET.FlagEnums.FormatFlagsUnsafe``1(``0,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  3793. <summary>
  3794. Retrieves <paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
  3795. or if empty returns the zero flag formatted with formats.
  3796. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  3797. </summary>
  3798. <typeparam name="TEnum">The enum type.</typeparam>
  3799. <param name="value">The flags enum value.</param>
  3800. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  3801. <param name="format0">The first output format to use.</param>
  3802. <param name="format1">The second output format to use.</param>
  3803. <returns><paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
  3804. or if empty returns the zero flag formatted with formats.
  3805. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  3806. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  3807. -or-
  3808. <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  3809. </member>
  3810. <member name="M:EnumsNET.FlagEnums.FormatFlagsUnsafe``1(``0,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  3811. <summary>
  3812. Retrieves <paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
  3813. or if empty returns the zero flag formatted with formats.
  3814. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  3815. </summary>
  3816. <typeparam name="TEnum">The enum type.</typeparam>
  3817. <param name="value">The flags enum value.</param>
  3818. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  3819. <param name="format0">The first output format to use.</param>
  3820. <param name="format1">The second output format to use.</param>
  3821. <param name="format2">The third output format to use.</param>
  3822. <returns><paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
  3823. or if empty returns the zero flag formatted with formats.
  3824. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  3825. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  3826. -or-
  3827. <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  3828. </member>
  3829. <member name="M:EnumsNET.FlagEnums.FormatFlagsUnsafe``1(``0,System.String,EnumsNET.EnumFormat[])">
  3830. <summary>
  3831. Retrieves <paramref name="value"/>'s flags formatted with <paramref name="formats"/> and delimited with <paramref name="delimiter"/>
  3832. or if empty returns the zero flag formatted with <paramref name="formats"/>.
  3833. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  3834. </summary>
  3835. <typeparam name="TEnum">The enum type.</typeparam>
  3836. <param name="value">The flags enum value.</param>
  3837. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  3838. <param name="formats">The output formats to use.</param>
  3839. <returns><paramref name="value"/>'s flags formatted with <paramref name="formats"/> and delimited with <paramref name="delimiter"/>
  3840. or if empty returns the zero flag formatted with <paramref name="formats"/>.
  3841. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  3842. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  3843. -or-
  3844. <paramref name="formats"/> contains an invalid value.</exception>
  3845. </member>
  3846. <member name="M:EnumsNET.FlagEnums.TryFormatFlagsUnsafe``1(``0,System.Span{System.Char},System.Int32@,System.ReadOnlySpan{System.Char},EnumsNET.EnumFormat[])">
  3847. <summary>
  3848. Tries to format the value of the flag enum value into the provided span of characters.
  3849. </summary>
  3850. <typeparam name="TEnum">The enum type.</typeparam>
  3851. <param name="value">The flags enum value.</param>
  3852. <param name="destination">When this method returns, value formatted as a span of characters.</param>
  3853. <param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination"/>.</param>
  3854. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  3855. <param name="formats">The output formats to use.</param>
  3856. <returns><c>true</c> if the formatting was successful; otherwise, <c>false</c>.</returns>
  3857. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  3858. -or-
  3859. <paramref name="formats"/> contains an invalid value.</exception>
  3860. </member>
  3861. <member name="M:EnumsNET.FlagEnums.GetFlagsUnsafe``1(``0)">
  3862. <summary>
  3863. Retrieves the flags that compose <paramref name="value"/>.
  3864. </summary>
  3865. <typeparam name="TEnum">The enum type.</typeparam>
  3866. <param name="value">The flags enum value.</param>
  3867. <returns>The flags that compose <paramref name="value"/>.</returns>
  3868. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3869. </member>
  3870. <member name="M:EnumsNET.FlagEnums.GetFlagMembersUnsafe``1(``0)">
  3871. <summary>
  3872. Retrieves the <see cref="T:EnumsNET.EnumMember`1"/>s of the flags that compose <paramref name="value"/>.
  3873. </summary>
  3874. <typeparam name="TEnum">The enum type.</typeparam>
  3875. <param name="value">The flags enum value.</param>
  3876. <returns>The <see cref="T:EnumsNET.EnumMember`1"/>s of the flags that compose <paramref name="value"/>.</returns>
  3877. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3878. </member>
  3879. <member name="M:EnumsNET.FlagEnums.GetFlagCountUnsafe``1">
  3880. <summary>
  3881. Retrieves the flag count of <typeparamref name="TEnum"/>.
  3882. </summary>
  3883. <typeparam name="TEnum">The enum type.</typeparam>
  3884. <returns>The flag count of <typeparamref name="TEnum"/>.</returns>
  3885. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3886. </member>
  3887. <member name="M:EnumsNET.FlagEnums.GetFlagCountUnsafe``1(``0)">
  3888. <summary>
  3889. Retrieves the flag count of <paramref name="value"/>.
  3890. </summary>
  3891. <typeparam name="TEnum">The enum type.</typeparam>
  3892. <param name="value">The flags enum value.</param>
  3893. <returns>The flag count of <paramref name="value"/>.</returns>
  3894. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3895. </member>
  3896. <member name="M:EnumsNET.FlagEnums.GetFlagCountUnsafe``1(``0,``0)">
  3897. <summary>
  3898. Retrieves the flag count of <paramref name="otherFlags"/> that <paramref name="value"/> has.
  3899. </summary>
  3900. <typeparam name="TEnum">The enum type.</typeparam>
  3901. <param name="value">The flags enum value.</param>
  3902. <param name="otherFlags">The other flags enum value.</param>
  3903. <returns>The flag count of <paramref name="otherFlags"/> that <paramref name="value"/> has.</returns>
  3904. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3905. </member>
  3906. <member name="M:EnumsNET.FlagEnums.HasAnyFlagsUnsafe``1(``0)">
  3907. <summary>
  3908. Indicates if <paramref name="value"/> has any flags.
  3909. </summary>
  3910. <typeparam name="TEnum">The enum type.</typeparam>
  3911. <param name="value">The flags enum value.</param>
  3912. <returns>Indication if <paramref name="value"/> has any flags.</returns>
  3913. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3914. </member>
  3915. <member name="M:EnumsNET.FlagEnums.HasAnyFlagsUnsafe``1(``0,``0)">
  3916. <summary>
  3917. Indicates if <paramref name="value"/> has any flags that are in <paramref name="otherFlags"/>.
  3918. </summary>
  3919. <typeparam name="TEnum">The enum type.</typeparam>
  3920. <param name="value">The flags enum value.</param>
  3921. <param name="otherFlags">The other flags enum value.</param>
  3922. <returns>Indication if <paramref name="value"/> has any flags that are in <paramref name="otherFlags"/>.</returns>
  3923. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3924. </member>
  3925. <member name="M:EnumsNET.FlagEnums.HasAllFlagsUnsafe``1(``0)">
  3926. <summary>
  3927. Indicates if <paramref name="value"/> has all of the flags that are defined in <typeparamref name="TEnum"/>.
  3928. </summary>
  3929. <typeparam name="TEnum">The enum type.</typeparam>
  3930. <param name="value">The flags enum value.</param>
  3931. <returns>Indication if <paramref name="value"/> has all of the flags that are defined in <typeparamref name="TEnum"/>.</returns>
  3932. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3933. </member>
  3934. <member name="M:EnumsNET.FlagEnums.HasAllFlagsUnsafe``1(``0,``0)">
  3935. <summary>
  3936. Indicates if <paramref name="value"/> has all of the flags that are in <paramref name="otherFlags"/>.
  3937. </summary>
  3938. <typeparam name="TEnum">The enum type.</typeparam>
  3939. <param name="value">The flags enum value.</param>
  3940. <param name="otherFlags">The other flags enum value.</param>
  3941. <returns>Indication if <paramref name="value"/> has all of the flags that are in <paramref name="otherFlags"/>.</returns>
  3942. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3943. </member>
  3944. <member name="M:EnumsNET.FlagEnums.ToggleFlagsUnsafe``1(``0)">
  3945. <summary>
  3946. Returns <paramref name="value"/> with all of it's flags toggled. Equivalent to the bitwise "xor" operator with <see cref="M:EnumsNET.FlagEnums.GetAllFlags``1"/>.
  3947. </summary>
  3948. <typeparam name="TEnum">The enum type.</typeparam>
  3949. <param name="value">The flags enum value.</param>
  3950. <returns><paramref name="value"/> with all of it's flags toggled.</returns>
  3951. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3952. </member>
  3953. <member name="M:EnumsNET.FlagEnums.ToggleFlagsUnsafe``1(``0,``0)">
  3954. <summary>
  3955. Returns <paramref name="value"/> while toggling the flags that are in <paramref name="otherFlags"/>. Equivalent to the bitwise "xor" operator.
  3956. </summary>
  3957. <typeparam name="TEnum">The enum type.</typeparam>
  3958. <param name="value">The flags enum value.</param>
  3959. <param name="otherFlags">The other flags enum value.</param>
  3960. <returns><paramref name="value"/> while toggling the flags that are in <paramref name="otherFlags"/>.</returns>
  3961. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3962. </member>
  3963. <member name="M:EnumsNET.FlagEnums.CommonFlagsUnsafe``1(``0,``0)">
  3964. <summary>
  3965. Returns <paramref name="value"/> with only the flags that are also in <paramref name="otherFlags"/>. Equivalent to the bitwise "and" operation.
  3966. </summary>
  3967. <typeparam name="TEnum">The enum type.</typeparam>
  3968. <param name="value">The flags enum value.</param>
  3969. <param name="otherFlags">The other flags enum value.</param>
  3970. <returns><paramref name="value"/> with only the flags that are also in <paramref name="otherFlags"/>.</returns>
  3971. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3972. </member>
  3973. <member name="M:EnumsNET.FlagEnums.CombineFlagsUnsafe``1(``0,``0)">
  3974. <summary>
  3975. Combines the flags of <paramref name="value"/> and <paramref name="otherFlags"/>. Equivalent to the bitwise "or" operation.
  3976. </summary>
  3977. <typeparam name="TEnum">The enum type.</typeparam>
  3978. <param name="value">The flags enum value.</param>
  3979. <param name="otherFlags">The other flags enum value.</param>
  3980. <returns>Combination of <paramref name="value"/> with the flags in <paramref name="otherFlags"/>.</returns>
  3981. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3982. </member>
  3983. <member name="M:EnumsNET.FlagEnums.CombineFlagsUnsafe``1(``0,``0,``0)">
  3984. <summary>
  3985. Combines the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, and <paramref name="flag2"/>.
  3986. </summary>
  3987. <typeparam name="TEnum">The enum type.</typeparam>
  3988. <param name="flag0">The first flags enum value.</param>
  3989. <param name="flag1">The second flags enum value.</param>
  3990. <param name="flag2">The third flags enum value.</param>
  3991. <returns>Combination of the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, and <paramref name="flag2"/>.</returns>
  3992. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3993. </member>
  3994. <member name="M:EnumsNET.FlagEnums.CombineFlagsUnsafe``1(``0,``0,``0,``0)">
  3995. <summary>
  3996. Combines the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, <paramref name="flag2"/>, and <paramref name="flag3"/>.
  3997. </summary>
  3998. <typeparam name="TEnum">The enum type.</typeparam>
  3999. <param name="flag0">The first flags enum value.</param>
  4000. <param name="flag1">The second flags enum value.</param>
  4001. <param name="flag2">The third flags enum value.</param>
  4002. <param name="flag3">The fourth flags enum value.</param>
  4003. <returns>Combination of the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, <paramref name="flag2"/>, and <paramref name="flag3"/>.</returns>
  4004. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  4005. </member>
  4006. <member name="M:EnumsNET.FlagEnums.CombineFlagsUnsafe``1(``0,``0,``0,``0,``0)">
  4007. <summary>
  4008. Combines the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, <paramref name="flag2"/>, <paramref name="flag3"/>, and <paramref name="flag4"/>.
  4009. </summary>
  4010. <typeparam name="TEnum">The enum type.</typeparam>
  4011. <param name="flag0">The first flags enum value.</param>
  4012. <param name="flag1">The second flags enum value.</param>
  4013. <param name="flag2">The third flags enum value.</param>
  4014. <param name="flag3">The fourth flags enum value.</param>
  4015. <param name="flag4">The fifth flags enum value.</param>
  4016. <returns>Combination of the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, <paramref name="flag2"/>, <paramref name="flag3"/>, and <paramref name="flag4"/>.</returns>
  4017. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  4018. </member>
  4019. <member name="M:EnumsNET.FlagEnums.CombineFlagsUnsafe``1(``0[])">
  4020. <summary>
  4021. Combines all of the flags of <paramref name="flags"/>.
  4022. </summary>
  4023. <typeparam name="TEnum">The enum type.</typeparam>
  4024. <param name="flags">The flags enum values.</param>
  4025. <returns>Combination of all of the flags of <paramref name="flags"/>.</returns>
  4026. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  4027. </member>
  4028. <member name="M:EnumsNET.FlagEnums.CombineFlagsUnsafe``1(System.Collections.Generic.IEnumerable{``0})">
  4029. <summary>
  4030. Combines all of the flags of <paramref name="flags"/>.
  4031. </summary>
  4032. <typeparam name="TEnum">The enum type.</typeparam>
  4033. <param name="flags">The flags enum values.</param>
  4034. <returns>Combination of all of the flags of <paramref name="flags"/>.</returns>
  4035. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  4036. </member>
  4037. <member name="M:EnumsNET.FlagEnums.RemoveFlagsUnsafe``1(``0,``0)">
  4038. <summary>
  4039. Returns <paramref name="value"/> without the flags specified in <paramref name="otherFlags"/>.
  4040. </summary>
  4041. <typeparam name="TEnum">The enum type.</typeparam>
  4042. <param name="value">The flags enum value.</param>
  4043. <param name="otherFlags">The other flags enum value.</param>
  4044. <returns><paramref name="value"/> without the flags specified in <paramref name="otherFlags"/>.</returns>
  4045. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  4046. </member>
  4047. <member name="M:EnumsNET.FlagEnums.ParseFlagsUnsafe``1(System.String)">
  4048. <summary>
  4049. Converts the string representation of one or more member names or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value.
  4050. </summary>
  4051. <typeparam name="TEnum">The enum type.</typeparam>
  4052. <param name="value">The enum member names or values' string representation.</param>
  4053. <returns>A <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  4054. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  4055. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  4056. -or-
  4057. <paramref name="value"/> doesn't represent a member name or value of <typeparamref name="TEnum"/>.</exception>
  4058. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of <typeparamref name="TEnum"/>'s underlying type.</exception>
  4059. </member>
  4060. <member name="M:EnumsNET.FlagEnums.ParseFlagsUnsafe``1(System.String,System.Boolean)">
  4061. <summary>
  4062. Converts the string representation of one or more member names or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value.
  4063. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  4064. </summary>
  4065. <typeparam name="TEnum">The enum type.</typeparam>
  4066. <param name="value">The enum member names or values' string representation.</param>
  4067. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4068. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  4069. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  4070. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  4071. -or-
  4072. <paramref name="value"/> doesn't represent a member name or value of <typeparamref name="TEnum"/>.</exception>
  4073. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  4074. </member>
  4075. <member name="M:EnumsNET.FlagEnums.ParseFlagsUnsafe``1(System.String,System.Boolean,System.String)">
  4076. <summary>
  4077. Converts the string representation of one or more member names or values of <typeparamref name="TEnum"/> delimited with <paramref name="delimiter"/> to its respective <typeparamref name="TEnum"/> value.
  4078. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  4079. </summary>
  4080. <typeparam name="TEnum">The enum type.</typeparam>
  4081. <param name="value">The enum member names or values' string representation.</param>
  4082. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4083. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4084. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  4085. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  4086. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  4087. -or-
  4088. <paramref name="value"/> doesn't represent a member name or value of <typeparamref name="TEnum"/>.</exception>
  4089. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  4090. </member>
  4091. <member name="M:EnumsNET.FlagEnums.ParseFlagsUnsafe``1(System.String,System.Boolean,System.String,EnumsNET.EnumFormat)">
  4092. <summary>
  4093. Converts the string representation of one or more members or values of <typeparamref name="TEnum"/> delimited with <paramref name="delimiter"/> to its respective <typeparamref name="TEnum"/> value
  4094. using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  4095. </summary>
  4096. <typeparam name="TEnum">The enum type.</typeparam>
  4097. <param name="value">The enum members or values' string representation.</param>
  4098. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4099. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4100. <param name="format">The parsing enum format.</param>
  4101. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  4102. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  4103. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  4104. -or-
  4105. <paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
  4106. -or-
  4107. <paramref name="format"/> is an invalid value.</exception>
  4108. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  4109. </member>
  4110. <member name="M:EnumsNET.FlagEnums.ParseFlagsUnsafe``1(System.String,System.Boolean,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  4111. <summary>
  4112. Converts the string representation of one or more members or values of <typeparamref name="TEnum"/> delimited with <paramref name="delimiter"/> to its respective <typeparamref name="TEnum"/> value
  4113. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  4114. </summary>
  4115. <typeparam name="TEnum">The enum type.</typeparam>
  4116. <param name="value">The enum members or values' string representation.</param>
  4117. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4118. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4119. <param name="format0">The first parsing enum format.</param>
  4120. <param name="format1">The second parsing enum format.</param>
  4121. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  4122. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  4123. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  4124. -or-
  4125. <paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
  4126. -or-
  4127. <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  4128. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  4129. </member>
  4130. <member name="M:EnumsNET.FlagEnums.ParseFlagsUnsafe``1(System.String,System.Boolean,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  4131. <summary>
  4132. Converts the string representation of one or more members or values of <typeparamref name="TEnum"/> delimited with <paramref name="delimiter"/> to its respective <typeparamref name="TEnum"/> value
  4133. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  4134. </summary>
  4135. <typeparam name="TEnum">The enum type.</typeparam>
  4136. <param name="value">The enum members or values' string representation.</param>
  4137. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4138. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4139. <param name="format0">The first parsing enum format.</param>
  4140. <param name="format1">The second parsing enum format.</param>
  4141. <param name="format2">The third parsing enum format.</param>
  4142. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  4143. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  4144. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  4145. -or-
  4146. <paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
  4147. -or-
  4148. <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  4149. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  4150. </member>
  4151. <member name="M:EnumsNET.FlagEnums.ParseFlagsUnsafe``1(System.String,System.Boolean,System.String,EnumsNET.EnumFormat[])">
  4152. <summary>
  4153. Converts the string representation of one or more members or values of <typeparamref name="TEnum"/> delimited with <paramref name="delimiter"/> to its respective <typeparamref name="TEnum"/> value
  4154. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  4155. </summary>
  4156. <typeparam name="TEnum">The enum type.</typeparam>
  4157. <param name="value">The enum members or values' string representation.</param>
  4158. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4159. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4160. <param name="formats">The parsing enum formats.</param>
  4161. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  4162. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  4163. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  4164. -or-
  4165. <paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
  4166. -or-
  4167. <paramref name="formats"/> contains an invalid value.</exception>
  4168. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  4169. </member>
  4170. <member name="M:EnumsNET.FlagEnums.TryParseFlagsUnsafe``1(System.String,``0@)">
  4171. <summary>
  4172. Tries to convert the string representation of one or more member names or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value.
  4173. The return value indicates whether the conversion succeeded.
  4174. </summary>
  4175. <typeparam name="TEnum">The enum type.</typeparam>
  4176. <param name="value">The enum member names or values' string representation.</param>
  4177. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  4178. <returns>Indication whether the conversion succeeded.</returns>
  4179. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  4180. </member>
  4181. <member name="M:EnumsNET.FlagEnums.TryParseFlagsUnsafe``1(System.String,System.Boolean,``0@)">
  4182. <summary>
  4183. Tries to convert the string representation of one or more member names or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value.
  4184. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive. The return value indicates whether the conversion succeeded.
  4185. </summary>
  4186. <typeparam name="TEnum">The enum type.</typeparam>
  4187. <param name="value">The enum member names or values' string representation.</param>
  4188. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4189. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  4190. <returns>Indication whether the conversion succeeded.</returns>
  4191. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  4192. </member>
  4193. <member name="M:EnumsNET.FlagEnums.TryParseFlagsUnsafe``1(System.String,System.Boolean,System.String,``0@)">
  4194. <summary>
  4195. Tries to convert the string representation of one or more member names or values of <typeparamref name="TEnum"/> delimited with <paramref name="delimiter"/> to its respective <typeparamref name="TEnum"/> value.
  4196. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive. The return value indicates whether the conversion succeeded.
  4197. </summary>
  4198. <typeparam name="TEnum">The enum type.</typeparam>
  4199. <param name="value">The enum member names or values' string representation.</param>
  4200. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4201. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4202. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  4203. <returns>Indication whether the conversion succeeded.</returns>
  4204. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  4205. </member>
  4206. <member name="M:EnumsNET.FlagEnums.TryParseFlagsUnsafe``1(System.String,System.Boolean,System.String,``0@,EnumsNET.EnumFormat)">
  4207. <summary>
  4208. Tries to convert the string representation of one or more members or values of <typeparamref name="TEnum"/> delimited with <paramref name="delimiter"/> to its respective <typeparamref name="TEnum"/> value
  4209. using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  4210. The return value indicates whether the conversion succeeded.
  4211. </summary>
  4212. <typeparam name="TEnum">The enum type.</typeparam>
  4213. <param name="value">The enum members or values' string representation.</param>
  4214. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4215. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4216. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  4217. <param name="format">The parsing enum format.</param>
  4218. <returns>Indication whether the conversion succeeded.</returns>
  4219. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  4220. -or-
  4221. <paramref name="format"/> is an invalid value.</exception>
  4222. </member>
  4223. <member name="M:EnumsNET.FlagEnums.TryParseFlagsUnsafe``1(System.String,System.Boolean,System.String,``0@,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  4224. <summary>
  4225. Tries to convert the string representation of one or more members or values of <typeparamref name="TEnum"/> delimited with <paramref name="delimiter"/> to its respective <typeparamref name="TEnum"/> value
  4226. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  4227. The return value indicates whether the conversion succeeded.
  4228. </summary>
  4229. <typeparam name="TEnum">The enum type.</typeparam>
  4230. <param name="value">The enum members or values' string representation.</param>
  4231. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4232. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4233. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  4234. <param name="format0">The first parsing enum format.</param>
  4235. <param name="format1">The second parsing enum format.</param>
  4236. <returns>Indication whether the conversion succeeded.</returns>
  4237. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  4238. -or-
  4239. <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  4240. </member>
  4241. <member name="M:EnumsNET.FlagEnums.TryParseFlagsUnsafe``1(System.String,System.Boolean,System.String,``0@,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  4242. <summary>
  4243. Tries to convert the string representation of one or more members or values of <typeparamref name="TEnum"/> delimited with <paramref name="delimiter"/> to its respective <typeparamref name="TEnum"/> value
  4244. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  4245. The return value indicates whether the conversion succeeded.
  4246. </summary>
  4247. <typeparam name="TEnum">The enum type.</typeparam>
  4248. <param name="value">The enum members or values' string representation.</param>
  4249. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4250. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4251. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  4252. <param name="format0">The first parsing enum format.</param>
  4253. <param name="format1">The second parsing enum format.</param>
  4254. <param name="format2">The third parsing enum format.</param>
  4255. <returns>Indication whether the conversion succeeded.</returns>
  4256. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  4257. -or-
  4258. <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  4259. </member>
  4260. <member name="M:EnumsNET.FlagEnums.TryParseFlagsUnsafe``1(System.String,System.Boolean,System.String,``0@,EnumsNET.EnumFormat[])">
  4261. <summary>
  4262. Tries to convert the string representation of one or more members or values of <typeparamref name="TEnum"/> delimited with <paramref name="delimiter"/> to its respective <typeparamref name="TEnum"/> value
  4263. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  4264. The return value indicates whether the conversion succeeded.
  4265. </summary>
  4266. <typeparam name="TEnum">The enum type.</typeparam>
  4267. <param name="value">The enum members or values' string representation.</param>
  4268. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4269. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4270. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  4271. <param name="formats">The parsing enum formats.</param>
  4272. <returns>Indication whether the conversion succeeded.</returns>
  4273. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  4274. -or-
  4275. <paramref name="formats"/> contains an invalid value.</exception>
  4276. </member>
  4277. <member name="M:EnumsNET.FlagEnums.IsFlagEnum(System.Type)">
  4278. <summary>
  4279. Indicates if <paramref name="enumType"/> is marked with the <see cref="T:System.FlagsAttribute"/>.
  4280. </summary>
  4281. <param name="enumType">The enum type.</param>
  4282. <returns>Indication if <paramref name="enumType"/> is marked with the <see cref="T:System.FlagsAttribute"/>.</returns>
  4283. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  4284. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
  4285. </member>
  4286. <member name="M:EnumsNET.FlagEnums.GetAllFlags(System.Type)">
  4287. <summary>
  4288. Retrieves all the flags defined by <paramref name="enumType"/>.
  4289. </summary>
  4290. <param name="enumType">The enum type.</param>
  4291. <returns>All the flags defined by <paramref name="enumType"/>.</returns>
  4292. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  4293. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
  4294. </member>
  4295. <member name="M:EnumsNET.FlagEnums.IsValidFlagCombination(System.Type,System.Object)">
  4296. <summary>
  4297. Indicates whether <paramref name="value"/> is a valid flag combination of <paramref name="enumType"/>'s defined flags.
  4298. </summary>
  4299. <param name="enumType">The enum type.</param>
  4300. <param name="value">The flags enum value.</param>
  4301. <returns>Indication of whether <paramref name="value"/> is a valid flag combination of <paramref name="enumType"/>'s defined flags.</returns>
  4302. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4303. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4304. -or-
  4305. <paramref name="value"/> is of an invalid type.</exception>
  4306. </member>
  4307. <member name="M:EnumsNET.FlagEnums.FormatFlags(System.Type,System.Object)">
  4308. <summary>
  4309. Retrieves the names of <paramref name="value"/>'s flags delimited with commas or if empty returns the name of the zero flag if defined otherwise "0".
  4310. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  4311. </summary>
  4312. <param name="enumType">The enum type.</param>
  4313. <param name="value">The flags enum value.</param>
  4314. <returns>The names of <paramref name="value"/>'s flags delimited with commas or if empty returns the name of the zero flag if defined otherwise "0".
  4315. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  4316. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4317. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4318. -or-
  4319. <paramref name="value"/> is of an invalid type.</exception>
  4320. </member>
  4321. <member name="M:EnumsNET.FlagEnums.FormatFlags(System.Type,System.Object,System.String)">
  4322. <summary>
  4323. Retrieves the names of <paramref name="value"/>'s flags delimited with <paramref name="delimiter"/> or if empty returns the name of the zero flag if defined otherwise "0".
  4324. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  4325. </summary>
  4326. <param name="enumType">The enum type.</param>
  4327. <param name="value">The flags enum value.</param>
  4328. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  4329. <returns>The names of <paramref name="value"/>'s flags delimited with <paramref name="delimiter"/> or if empty returns the name of the zero flag if defined otherwise "0".
  4330. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  4331. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4332. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4333. -or-
  4334. <paramref name="value"/> is of an invalid type.</exception>
  4335. </member>
  4336. <member name="M:EnumsNET.FlagEnums.FormatFlags(System.Type,System.Object,System.String,EnumsNET.EnumFormat)">
  4337. <summary>
  4338. Retrieves <paramref name="value"/>'s flags formatted with <paramref name="format"/> and delimited with <paramref name="delimiter"/>
  4339. or if empty returns the zero flag formatted with <paramref name="format"/>.
  4340. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  4341. </summary>
  4342. <param name="enumType">The enum type.</param>
  4343. <param name="value">The flags enum value.</param>
  4344. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  4345. <param name="format">The output format to use.</param>
  4346. <returns><paramref name="value"/>'s flags formatted with <paramref name="format"/> and delimited with <paramref name="delimiter"/>
  4347. or if empty returns the zero flag formatted with <paramref name="format"/>.
  4348. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  4349. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4350. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4351. -or-
  4352. <paramref name="value"/> is of an invalid type
  4353. -or-
  4354. <paramref name="format"/> is an invalid value.</exception>
  4355. </member>
  4356. <member name="M:EnumsNET.FlagEnums.FormatFlags(System.Type,System.Object,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  4357. <summary>
  4358. Retrieves <paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
  4359. or if empty returns the zero flag formatted with formats.
  4360. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  4361. </summary>
  4362. <param name="enumType">The enum type.</param>
  4363. <param name="value">The flags enum value.</param>
  4364. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  4365. <param name="format0">The first output format to use.</param>
  4366. <param name="format1">The second output format to use.</param>
  4367. <returns><paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
  4368. or if empty returns the zero flag formatted with formats.
  4369. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  4370. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4371. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4372. -or-
  4373. <paramref name="value"/> is of an invalid type
  4374. -or-
  4375. <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  4376. </member>
  4377. <member name="M:EnumsNET.FlagEnums.FormatFlags(System.Type,System.Object,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  4378. <summary>
  4379. Retrieves <paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
  4380. or if empty returns the zero flag formatted with formats.
  4381. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  4382. </summary>
  4383. <param name="enumType">The enum type.</param>
  4384. <param name="value">The flags enum value.</param>
  4385. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  4386. <param name="format0">The first output format to use.</param>
  4387. <param name="format1">The second output format to use.</param>
  4388. <param name="format2">The third output format to use.</param>
  4389. <returns><paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
  4390. or if empty returns the zero flag formatted with formats.
  4391. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  4392. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4393. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4394. -or-
  4395. <paramref name="value"/> is of an invalid type
  4396. -or-
  4397. <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  4398. </member>
  4399. <member name="M:EnumsNET.FlagEnums.FormatFlags(System.Type,System.Object,System.String,EnumsNET.EnumFormat[])">
  4400. <summary>
  4401. Retrieves <paramref name="value"/>'s flags formatted with <paramref name="formats"/> and delimited with <paramref name="delimiter"/>
  4402. or if empty returns the zero flag formatted with <paramref name="formats"/>.
  4403. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  4404. </summary>
  4405. <param name="enumType">The enum type.</param>
  4406. <param name="value">The flags enum value.</param>
  4407. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  4408. <param name="formats">The output formats to use.</param>
  4409. <returns><paramref name="value"/>'s flags formatted with <paramref name="formats"/> and delimited with <paramref name="delimiter"/>
  4410. or if empty returns the zero flag formatted with <paramref name="formats"/>.
  4411. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  4412. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4413. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4414. -or-
  4415. <paramref name="value"/> is of an invalid type
  4416. -or-
  4417. <paramref name="formats"/> contains an invalid value.</exception>
  4418. </member>
  4419. <member name="M:EnumsNET.FlagEnums.TryFormatFlags(System.Type,System.Object,System.Span{System.Char},System.Int32@,System.ReadOnlySpan{System.Char},EnumsNET.EnumFormat[])">
  4420. <summary>
  4421. Tries to format the value of the flag enum value into the provided span of characters.
  4422. </summary>
  4423. <param name="enumType">The enum type.</param>
  4424. <param name="value">The flags enum value.</param>
  4425. <param name="destination">When this method returns, value formatted as a span of characters.</param>
  4426. <param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination"/>.</param>
  4427. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  4428. <param name="formats">The output formats to use.</param>
  4429. <returns><c>true</c> if the formatting was successful; otherwise, <c>false</c>.</returns>
  4430. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4431. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4432. -or-
  4433. <paramref name="value"/> is of an invalid type
  4434. -or-
  4435. <paramref name="formats"/> contains an invalid value.</exception>
  4436. </member>
  4437. <member name="M:EnumsNET.FlagEnums.GetFlags(System.Type,System.Object)">
  4438. <summary>
  4439. Retrieves the flags that compose <paramref name="value"/>.
  4440. </summary>
  4441. <param name="enumType">The enum type.</param>
  4442. <param name="value">The flags enum value.</param>
  4443. <returns>The flags that compose <paramref name="value"/>.</returns>
  4444. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4445. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4446. -or-
  4447. <paramref name="value"/> is of an invalid type.</exception>
  4448. </member>
  4449. <member name="M:EnumsNET.FlagEnums.GetFlagMembers(System.Type,System.Object)">
  4450. <summary>
  4451. Retrieves the <see cref="T:EnumsNET.EnumMember"/>s of the flags that compose <paramref name="value"/>.
  4452. </summary>
  4453. <param name="enumType">The enum type.</param>
  4454. <param name="value">The flags enum value.</param>
  4455. <returns>The <see cref="T:EnumsNET.EnumMember"/>s of the flags that compose <paramref name="value"/>.</returns>
  4456. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4457. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4458. -or-
  4459. <paramref name="value"/> is of an invalid type.</exception>
  4460. </member>
  4461. <member name="M:EnumsNET.FlagEnums.GetFlagCount(System.Type)">
  4462. <summary>
  4463. Retrieves the flag count of <paramref name="enumType"/>.
  4464. </summary>
  4465. <param name="enumType">The enum type.</param>
  4466. <returns>The flag count of <paramref name="enumType"/>.</returns>
  4467. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  4468. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
  4469. </member>
  4470. <member name="M:EnumsNET.FlagEnums.GetFlagCount(System.Type,System.Object)">
  4471. <summary>
  4472. Retrieves the flag count of <paramref name="value"/>.
  4473. </summary>
  4474. <param name="enumType">The enum type.</param>
  4475. <param name="value">The flags enum value.</param>
  4476. <returns>The flag count of <paramref name="value"/>.</returns>
  4477. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4478. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4479. -or-
  4480. <paramref name="value"/> is of an invalid type.</exception>
  4481. </member>
  4482. <member name="M:EnumsNET.FlagEnums.GetFlagCount(System.Type,System.Object,System.Object)">
  4483. <summary>
  4484. Retrieves the flag count of <paramref name="otherFlags"/> that <paramref name="value"/> has.
  4485. </summary>
  4486. <param name="enumType">The enum type.</param>
  4487. <param name="value">The flags enum value.</param>
  4488. <param name="otherFlags">The other flags enum value.</param>
  4489. <returns>The flag count of <paramref name="otherFlags"/> that <paramref name="value"/> has.</returns>
  4490. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/>, <paramref name="value"/>, or <paramref name="otherFlags"/> is <c>null</c>.</exception>
  4491. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4492. -or-
  4493. <paramref name="value"/> or <paramref name="otherFlags"/> is of an invalid type.</exception>
  4494. </member>
  4495. <member name="M:EnumsNET.FlagEnums.HasAnyFlags(System.Type,System.Object)">
  4496. <summary>
  4497. Indicates if <paramref name="value"/> has any flags.
  4498. </summary>
  4499. <param name="enumType">The enum type.</param>
  4500. <param name="value">The flags enum value.</param>
  4501. <returns>Indication if <paramref name="value"/> has any flags.</returns>
  4502. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4503. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4504. -or-
  4505. <paramref name="value"/> is of an invalid type.</exception>
  4506. </member>
  4507. <member name="M:EnumsNET.FlagEnums.HasAnyFlags(System.Type,System.Object,System.Object)">
  4508. <summary>
  4509. Indicates if <paramref name="value"/> has any flags that are in <paramref name="otherFlags"/>.
  4510. </summary>
  4511. <param name="enumType">The enum type.</param>
  4512. <param name="value">The flags enum value.</param>
  4513. <param name="otherFlags">The other flags enum value.</param>
  4514. <returns>Indication if <paramref name="value"/> has any flags that are in <paramref name="otherFlags"/>.</returns>
  4515. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/>, <paramref name="value"/>, or <paramref name="otherFlags"/> is <c>null</c>.</exception>
  4516. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4517. -or-
  4518. <paramref name="value"/> or <paramref name="otherFlags"/> is of an invalid type.</exception>
  4519. </member>
  4520. <member name="M:EnumsNET.FlagEnums.HasAllFlags(System.Type,System.Object)">
  4521. <summary>
  4522. Indicates if <paramref name="value"/> has all of the flags that are defined in <paramref name="enumType"/>.
  4523. </summary>
  4524. <param name="enumType">The enum type.</param>
  4525. <param name="value">The flags enum value.</param>
  4526. <returns>Indication if <paramref name="value"/> has all of the flags that are defined in <paramref name="enumType"/>.</returns>
  4527. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4528. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4529. -or-
  4530. <paramref name="value"/> is of an invalid type.</exception>
  4531. </member>
  4532. <member name="M:EnumsNET.FlagEnums.HasAllFlags(System.Type,System.Object,System.Object)">
  4533. <summary>
  4534. Indicates if <paramref name="value"/> has all of the flags that are in <paramref name="otherFlags"/>.
  4535. </summary>
  4536. <param name="enumType">The enum type.</param>
  4537. <param name="value">The flags enum value.</param>
  4538. <param name="otherFlags">The other flags enum value.</param>
  4539. <returns>Indication if <paramref name="value"/> has all of the flags that are in <paramref name="otherFlags"/>.</returns>
  4540. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/>, <paramref name="value"/>, or <paramref name="otherFlags"/> is <c>null</c>.</exception>
  4541. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4542. -or-
  4543. <paramref name="value"/> or <paramref name="otherFlags"/> is of an invalid type.</exception>
  4544. </member>
  4545. <member name="M:EnumsNET.FlagEnums.ToggleFlags(System.Type,System.Object)">
  4546. <summary>
  4547. Returns <paramref name="value"/> with all of it's flags toggled. Equivalent to the bitwise "xor" operator with <see cref="M:EnumsNET.FlagEnums.GetAllFlags(System.Type)"/>.
  4548. </summary>
  4549. <param name="enumType">The enum type.</param>
  4550. <param name="value">The flags enum value.</param>
  4551. <returns><paramref name="value"/> with all of it's flags toggled.</returns>
  4552. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4553. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4554. -or-
  4555. <paramref name="value"/> is of an invalid type.</exception>
  4556. </member>
  4557. <member name="M:EnumsNET.FlagEnums.ToggleFlags(System.Type,System.Object,System.Object)">
  4558. <summary>
  4559. Returns <paramref name="value"/> while toggling the flags that are in <paramref name="otherFlags"/>. Equivalent to the bitwise "xor" operator.
  4560. </summary>
  4561. <param name="enumType">The enum type.</param>
  4562. <param name="value">The flags enum value.</param>
  4563. <param name="otherFlags">The other flags enum value.</param>
  4564. <returns><paramref name="value"/> while toggling the flags that are in <paramref name="otherFlags"/>.</returns>
  4565. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/>, <paramref name="value"/>, or <paramref name="otherFlags"/> is <c>null</c>.</exception>
  4566. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4567. -or-
  4568. <paramref name="value"/> or <paramref name="otherFlags"/> is of an invalid type.</exception>
  4569. </member>
  4570. <member name="M:EnumsNET.FlagEnums.CommonFlags(System.Type,System.Object,System.Object)">
  4571. <summary>
  4572. Returns <paramref name="value"/> with only the flags that are also in <paramref name="otherFlags"/>. Equivalent to the bitwise "and" operation.
  4573. </summary>
  4574. <param name="enumType">The enum type.</param>
  4575. <param name="value">The flags enum value.</param>
  4576. <param name="otherFlags">The other flags enum value.</param>
  4577. <returns><paramref name="value"/> with only the flags that are also in <paramref name="otherFlags"/>.</returns>
  4578. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/>, <paramref name="value"/>, or <paramref name="otherFlags"/> is <c>null</c>.</exception>
  4579. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4580. -or-
  4581. <paramref name="value"/> or <paramref name="otherFlags"/> is of an invalid type.</exception>
  4582. </member>
  4583. <member name="M:EnumsNET.FlagEnums.CombineFlags(System.Type,System.Object,System.Object)">
  4584. <summary>
  4585. Combines the flags of <paramref name="value"/> and <paramref name="otherFlags"/>. Equivalent to the bitwise "or" operation.
  4586. </summary>
  4587. <param name="enumType">The enum type.</param>
  4588. <param name="value">The flags enum value.</param>
  4589. <param name="otherFlags">The other flags enum value.</param>
  4590. <returns>Combination of <paramref name="value"/> with the flags in <paramref name="otherFlags"/>.</returns>
  4591. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/>, <paramref name="value"/>, or <paramref name="otherFlags"/> is <c>null</c>.</exception>
  4592. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4593. -or-
  4594. <paramref name="value"/> or <paramref name="otherFlags"/> is of an invalid type.</exception>
  4595. </member>
  4596. <member name="M:EnumsNET.FlagEnums.CombineFlags(System.Type,System.Object[])">
  4597. <summary>
  4598. Combines all of the flags of <paramref name="flags"/>.
  4599. </summary>
  4600. <param name="enumType">The enum type.</param>
  4601. <param name="flags">The flags enum values.</param>
  4602. <returns>Combination of all of the flags of <paramref name="flags"/>.</returns>
  4603. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or one of the <paramref name="flags"/> is <c>null</c>.</exception>
  4604. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4605. -or-
  4606. <paramref name="flags"/> contains a value that is of an invalid type.</exception>
  4607. </member>
  4608. <member name="M:EnumsNET.FlagEnums.CombineFlags(System.Type,System.Collections.Generic.IEnumerable{System.Object})">
  4609. <summary>
  4610. Combines all of the flags of <paramref name="flags"/>.
  4611. </summary>
  4612. <param name="enumType">The enum type.</param>
  4613. <param name="flags">The flags enum values.</param>
  4614. <returns>Combination of all of the flags of <paramref name="flags"/>.</returns>
  4615. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or one of the <paramref name="flags"/> is <c>null</c>.</exception>
  4616. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4617. -or-
  4618. <paramref name="flags"/> contains a value that is of an invalid type.</exception>
  4619. </member>
  4620. <member name="M:EnumsNET.FlagEnums.RemoveFlags(System.Type,System.Object,System.Object)">
  4621. <summary>
  4622. Returns <paramref name="value"/> without the flags specified in <paramref name="otherFlags"/>.
  4623. </summary>
  4624. <param name="enumType">The enum type.</param>
  4625. <param name="value">The flags enum value.</param>
  4626. <param name="otherFlags">The other flags enum value.</param>
  4627. <returns><paramref name="value"/> without the flags specified in <paramref name="otherFlags"/>.</returns>
  4628. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/>, <paramref name="value"/>, or <paramref name="otherFlags"/> is <c>null</c>.</exception>
  4629. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4630. -or-
  4631. <paramref name="value"/> or <paramref name="otherFlags"/> is of an invalid type.</exception>
  4632. </member>
  4633. <member name="M:EnumsNET.FlagEnums.ParseFlags(System.Type,System.String)">
  4634. <summary>
  4635. Converts the string representation of one or more member names or values of <paramref name="enumType"/> to its respective value of type <paramref name="enumType"/>.
  4636. </summary>
  4637. <param name="enumType">The enum type.</param>
  4638. <param name="value">The enum member names or values' string representation.</param>
  4639. <returns>A <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
  4640. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4641. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4642. -or-
  4643. <paramref name="value"/> doesn't represent a member name or value of <paramref name="enumType"/>.</exception>
  4644. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of <paramref name="enumType"/>'s underlying type.</exception>
  4645. </member>
  4646. <member name="M:EnumsNET.FlagEnums.ParseFlags(System.Type,System.String,System.Boolean)">
  4647. <summary>
  4648. Converts the string representation of one or more member names or values of <paramref name="enumType"/> to its respective value of type <paramref name="enumType"/>.
  4649. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  4650. </summary>
  4651. <param name="enumType">The enum type.</param>
  4652. <param name="value">The enum member names or values' string representation.</param>
  4653. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4654. <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
  4655. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4656. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4657. -or-
  4658. <paramref name="value"/> doesn't represent a member name or value of <paramref name="enumType"/>.</exception>
  4659. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
  4660. </member>
  4661. <member name="M:EnumsNET.FlagEnums.ParseFlags(System.Type,System.String,System.Boolean,System.String)">
  4662. <summary>
  4663. Converts the string representation of one or more member names or values of <paramref name="enumType"/> delimited with <paramref name="delimiter"/> to its respective value of type <paramref name="enumType"/>.
  4664. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  4665. </summary>
  4666. <param name="enumType">The enum type.</param>
  4667. <param name="value">The enum member names or values' string representation.</param>
  4668. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4669. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4670. <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
  4671. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4672. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4673. -or-
  4674. <paramref name="value"/> doesn't represent a member name or value of <paramref name="enumType"/>.</exception>
  4675. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
  4676. </member>
  4677. <member name="M:EnumsNET.FlagEnums.ParseFlags(System.Type,System.String,System.Boolean,System.String,EnumsNET.EnumFormat)">
  4678. <summary>
  4679. Converts the string representation of one or more members or values of <paramref name="enumType"/> delimited with <paramref name="delimiter"/> to its respective value of type <paramref name="enumType"/>
  4680. using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  4681. </summary>
  4682. <param name="enumType">The enum type.</param>
  4683. <param name="value">The enum members or values' string representation.</param>
  4684. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4685. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4686. <param name="format">The parsing enum format.</param>
  4687. <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
  4688. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4689. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4690. -or-
  4691. <paramref name="value"/> doesn't represent a member or value of <paramref name="enumType"/>
  4692. -or-
  4693. <paramref name="format"/> is an invalid value.</exception>
  4694. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
  4695. </member>
  4696. <member name="M:EnumsNET.FlagEnums.ParseFlags(System.Type,System.String,System.Boolean,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  4697. <summary>
  4698. Converts the string representation of one or more members or values of <paramref name="enumType"/> delimited with <paramref name="delimiter"/> to its respective value of type <paramref name="enumType"/>
  4699. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  4700. </summary>
  4701. <param name="enumType">The enum type.</param>
  4702. <param name="value">The enum members or values' string representation.</param>
  4703. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4704. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4705. <param name="format0">The first parsing enum format.</param>
  4706. <param name="format1">The second parsing enum format.</param>
  4707. <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
  4708. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4709. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4710. -or-
  4711. <paramref name="value"/> doesn't represent a member or value of <paramref name="enumType"/>
  4712. -or-
  4713. <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  4714. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
  4715. </member>
  4716. <member name="M:EnumsNET.FlagEnums.ParseFlags(System.Type,System.String,System.Boolean,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  4717. <summary>
  4718. Converts the string representation of one or more members or values of <paramref name="enumType"/> delimited with <paramref name="delimiter"/> to its respective value of type <paramref name="enumType"/>
  4719. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  4720. </summary>
  4721. <param name="enumType">The enum type.</param>
  4722. <param name="value">The enum members or values' string representation.</param>
  4723. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4724. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4725. <param name="format0">The first parsing enum format.</param>
  4726. <param name="format1">The second parsing enum format.</param>
  4727. <param name="format2">The third parsing enum format.</param>
  4728. <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
  4729. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4730. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4731. -or-
  4732. <paramref name="value"/> doesn't represent a member or value of <paramref name="enumType"/>
  4733. -or-
  4734. <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  4735. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
  4736. </member>
  4737. <member name="M:EnumsNET.FlagEnums.ParseFlags(System.Type,System.String,System.Boolean,System.String,EnumsNET.EnumFormat[])">
  4738. <summary>
  4739. Converts the string representation of one or more members or values of <paramref name="enumType"/> delimited with <paramref name="delimiter"/> to its respective value of type <paramref name="enumType"/>
  4740. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  4741. </summary>
  4742. <param name="enumType">The enum type.</param>
  4743. <param name="value">The enum members or values' string representation.</param>
  4744. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4745. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4746. <param name="formats">The parsing enum formats.</param>
  4747. <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
  4748. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4749. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4750. -or-
  4751. <paramref name="value"/> doesn't represent a member or value of <paramref name="enumType"/>
  4752. -or-
  4753. <paramref name="formats"/> contains an invalid value.</exception>
  4754. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
  4755. </member>
  4756. <member name="M:EnumsNET.FlagEnums.TryParseFlags(System.Type,System.String,System.Object@)">
  4757. <summary>
  4758. Tries to convert the string representation of one or more member names or values of <paramref name="enumType"/> to its respective value of type <paramref name="enumType"/>.
  4759. The return value indicates whether the conversion succeeded.
  4760. </summary>
  4761. <param name="enumType">The enum type.</param>
  4762. <param name="value">The enum member names or values' string representation.</param>
  4763. <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> that is represented by <paramref name="value"/>.</param>
  4764. <returns>Indication whether the conversion succeeded.</returns>
  4765. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  4766. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
  4767. </member>
  4768. <member name="M:EnumsNET.FlagEnums.TryParseFlags(System.Type,System.String,System.Boolean,System.Object@)">
  4769. <summary>
  4770. Tries to convert the string representation of one or more member names or values of <paramref name="enumType"/> to its respective value of type <paramref name="enumType"/>.
  4771. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive. The return value indicates whether the conversion succeeded.
  4772. </summary>
  4773. <param name="enumType">The enum type.</param>
  4774. <param name="value">The enum member names or values' string representation.</param>
  4775. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4776. <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> that is represented by <paramref name="value"/>.</param>
  4777. <returns>Indication whether the conversion succeeded.</returns>
  4778. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  4779. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
  4780. </member>
  4781. <member name="M:EnumsNET.FlagEnums.TryParseFlags(System.Type,System.String,System.Boolean,System.String,System.Object@)">
  4782. <summary>
  4783. Tries to convert the string representation of one or more member names or values of <paramref name="enumType"/> delimited with <paramref name="delimiter"/> to its respective value of type <paramref name="enumType"/>.
  4784. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive. The return value indicates whether the conversion succeeded.
  4785. </summary>
  4786. <param name="enumType">The enum type.</param>
  4787. <param name="value">The enum member names or values' string representation.</param>
  4788. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4789. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4790. <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> that is represented by <paramref name="value"/>.</param>
  4791. <returns>Indication whether the conversion succeeded.</returns>
  4792. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  4793. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
  4794. </member>
  4795. <member name="M:EnumsNET.FlagEnums.TryParseFlags(System.Type,System.String,System.Boolean,System.String,System.Object@,EnumsNET.EnumFormat)">
  4796. <summary>
  4797. Tries to convert the string representation of one or more members or values of <paramref name="enumType"/> delimited with <paramref name="delimiter"/> to its respective value of type <paramref name="enumType"/>
  4798. using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  4799. The return value indicates whether the conversion succeeded.
  4800. </summary>
  4801. <param name="enumType">The enum type.</param>
  4802. <param name="value">The enum members or values' string representation.</param>
  4803. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4804. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4805. <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> that is represented by <paramref name="value"/>.</param>
  4806. <param name="format">The parsing enum format.</param>
  4807. <returns>Indication whether the conversion succeeded.</returns>
  4808. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  4809. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4810. -or-
  4811. <paramref name="format"/> is an invalid value.</exception>
  4812. </member>
  4813. <member name="M:EnumsNET.FlagEnums.TryParseFlags(System.Type,System.String,System.Boolean,System.String,System.Object@,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  4814. <summary>
  4815. Tries to convert the string representation of one or more members or values of <paramref name="enumType"/> delimited with <paramref name="delimiter"/> to its respective value of type <paramref name="enumType"/>
  4816. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  4817. The return value indicates whether the conversion succeeded.
  4818. </summary>
  4819. <param name="enumType">The enum type.</param>
  4820. <param name="value">The enum members or values' string representation.</param>
  4821. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4822. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4823. <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> that is represented by <paramref name="value"/>.</param>
  4824. <param name="format0">The first parsing enum format.</param>
  4825. <param name="format1">The second parsing enum format.</param>
  4826. <returns>Indication whether the conversion succeeded.</returns>
  4827. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  4828. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4829. -or-
  4830. <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  4831. </member>
  4832. <member name="M:EnumsNET.FlagEnums.TryParseFlags(System.Type,System.String,System.Boolean,System.String,System.Object@,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  4833. <summary>
  4834. Tries to convert the string representation of one or more members or values of <paramref name="enumType"/> delimited with <paramref name="delimiter"/> to its respective value of type <paramref name="enumType"/>
  4835. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  4836. The return value indicates whether the conversion succeeded.
  4837. </summary>
  4838. <param name="enumType">The enum type.</param>
  4839. <param name="value">The enum members or values' string representation.</param>
  4840. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4841. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4842. <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> that is represented by <paramref name="value"/>.</param>
  4843. <param name="format0">The first parsing enum format.</param>
  4844. <param name="format1">The second parsing enum format.</param>
  4845. <param name="format2">The third parsing enum format.</param>
  4846. <returns>Indication whether the conversion succeeded.</returns>
  4847. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  4848. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4849. -or-
  4850. <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  4851. </member>
  4852. <member name="M:EnumsNET.FlagEnums.TryParseFlags(System.Type,System.String,System.Boolean,System.String,System.Object@,EnumsNET.EnumFormat[])">
  4853. <summary>
  4854. Tries to convert the string representation of one or more members or values of <paramref name="enumType"/> delimited with <paramref name="delimiter"/> to its respective value of type <paramref name="enumType"/>
  4855. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  4856. The return value indicates whether the conversion succeeded.
  4857. </summary>
  4858. <param name="enumType">The enum type.</param>
  4859. <param name="value">The enum members or values' string representation.</param>
  4860. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4861. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4862. <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> that is represented by <paramref name="value"/>.</param>
  4863. <param name="formats">The parsing enum formats.</param>
  4864. <returns>Indication whether the conversion succeeded.</returns>
  4865. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  4866. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4867. -or-
  4868. <paramref name="formats"/> contains an invalid value.</exception>
  4869. </member>
  4870. <member name="M:EnumsNET.FlagEnums.IsValidFlagCombination(EnumsNET.EnumMember)">
  4871. <summary>
  4872. Indicates whether <paramref name="member"/>'s value is a valid flag combination of its enum's defined values.
  4873. </summary>
  4874. <param name="member">The enum member.</param>
  4875. <returns>Indication of whether <paramref name="member"/>'s value is a valid flag combination of its enum's defined values.</returns>
  4876. <exception cref="T:System.ArgumentNullException"><paramref name="member"/> is <c>null</c>.</exception>
  4877. </member>
  4878. <member name="M:EnumsNET.FlagEnums.GetFlags``1(EnumsNET.EnumMember{``0})">
  4879. <summary>
  4880. Retrieves the flags that compose <paramref name="member"/>'s value.
  4881. </summary>
  4882. <typeparam name="TEnum">The enum type.</typeparam>
  4883. <param name="member">The enum member.</param>
  4884. <returns>The flags that compose <paramref name="member"/>'s value.</returns>
  4885. <exception cref="T:System.ArgumentNullException"><paramref name="member"/> is <c>null</c>.</exception>
  4886. </member>
  4887. <member name="M:EnumsNET.FlagEnums.GetFlagMembers``1(EnumsNET.EnumMember{``0})">
  4888. <summary>
  4889. Retrieves the <see cref="T:EnumsNET.EnumMember`1"/>s of the flags that compose <paramref name="member"/>'s value.
  4890. </summary>
  4891. <typeparam name="TEnum">The enum type.</typeparam>
  4892. <param name="member">The enum member.</param>
  4893. <returns>The <see cref="T:EnumsNET.EnumMember`1"/>s of the flags that compose <paramref name="member"/>'s value.</returns>
  4894. <exception cref="T:System.ArgumentNullException"><paramref name="member"/> is <c>null</c>.</exception>
  4895. </member>
  4896. <member name="M:EnumsNET.FlagEnums.HasAnyFlags(EnumsNET.EnumMember)">
  4897. <summary>
  4898. Indicates if <paramref name="member"/>'s value has any flags.
  4899. </summary>
  4900. <param name="member">The enum member.</param>
  4901. <returns>Indication if <paramref name="member"/>'s has any flags.</returns>
  4902. <exception cref="T:System.ArgumentNullException"><paramref name="member"/> is <c>null</c>.</exception>
  4903. </member>
  4904. <member name="M:EnumsNET.FlagEnums.HasAllFlags(EnumsNET.EnumMember)">
  4905. <summary>
  4906. Indicates if <paramref name="member"/>'s value has all of the flags that are defined in its enum type.
  4907. </summary>
  4908. <param name="member">The enum member.</param>
  4909. <returns>Indication if <paramref name="member"/> has all of the flags that are defined in its enum type.</returns>
  4910. <exception cref="T:System.ArgumentNullException"><paramref name="member"/> is <c>null</c>.</exception>
  4911. </member>
  4912. <member name="M:EnumsNET.FlagEnums.GetFlagCount(EnumsNET.EnumMember)">
  4913. <summary>
  4914. Retrieves the flag count of <paramref name="member"/>.
  4915. </summary>
  4916. <param name="member">The flags enum value.</param>
  4917. <returns>The flag count of <paramref name="member"/>.</returns>
  4918. </member>
  4919. <member name="M:EnumsNET.FlagEnums.GetFlags(EnumsNET.EnumMember)">
  4920. <summary>
  4921. Retrieves the flags that compose <paramref name="member"/>'s value.
  4922. </summary>
  4923. <param name="member">The enum member.</param>
  4924. <returns>The flags that compose <paramref name="member"/>'s value.</returns>
  4925. <exception cref="T:System.ArgumentNullException"><paramref name="member"/> is <c>null</c>.</exception>
  4926. </member>
  4927. <member name="M:EnumsNET.FlagEnums.GetFlagMembers(EnumsNET.EnumMember)">
  4928. <summary>
  4929. Retrieves the <see cref="T:EnumsNET.EnumMember"/>s of the flags that compose <paramref name="member"/>'s value.
  4930. </summary>
  4931. <param name="member">The enum member.</param>
  4932. <returns>The <see cref="T:EnumsNET.EnumMember"/>s of the flags that compose <paramref name="member"/>'s value.</returns>
  4933. <exception cref="T:System.ArgumentNullException"><paramref name="member"/> is <c>null</c>.</exception>
  4934. </member>
  4935. <member name="T:EnumsNET.IEnumValidatorAttribute`1">
  4936. <summary>
  4937. Interface to be implemented on an enum validator attribute class to allow custom validation logic.
  4938. </summary>
  4939. <typeparam name="TEnum">The enum type.</typeparam>
  4940. </member>
  4941. <member name="M:EnumsNET.IEnumValidatorAttribute`1.IsValid(`0)">
  4942. <summary>
  4943. Indicates if <paramref name="value"/> is valid.
  4944. </summary>
  4945. <param name="value">The enum value.</param>
  4946. <returns>Indication if <paramref name="value"/> is valid.</returns>
  4947. </member>
  4948. <member name="T:EnumsNET.PrimaryEnumMemberAttribute">
  4949. <summary>
  4950. Indicates if the enum member should be the primary enum member when there are duplicate values.
  4951. In the case of duplicate values, extension methods will use the enum member marked with this attribute.
  4952. </summary>
  4953. </member>
  4954. </members>
  4955. </doc>