Nessuna descrizione
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 354KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754
  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="T:EnumsNET.EnumMember">
  185. <summary>
  186. An enum member which is composed of its name, value, and attributes.
  187. </summary>
  188. </member>
  189. <member name="P:EnumsNET.EnumMember.Value">
  190. <summary>
  191. The enum member's value.
  192. </summary>
  193. </member>
  194. <member name="P:EnumsNET.EnumMember.Name">
  195. <summary>
  196. The enum member's name.
  197. </summary>
  198. </member>
  199. <member name="P:EnumsNET.EnumMember.Attributes">
  200. <summary>
  201. The enum member's attributes.
  202. </summary>
  203. </member>
  204. <member name="M:EnumsNET.EnumMember.ToString">
  205. <summary>
  206. Retrieves the enum member's name.
  207. </summary>
  208. <returns>The enum member's name.</returns>
  209. </member>
  210. <member name="M:EnumsNET.EnumMember.AsString">
  211. <summary>
  212. Retrieves the enum member's name.
  213. </summary>
  214. <returns>The enum member's name.</returns>
  215. </member>
  216. <member name="M:EnumsNET.EnumMember.AsString(System.String)">
  217. <summary>
  218. Converts the enum member to its string representation using the specified <paramref name="format"/>.
  219. </summary>
  220. <param name="format">The output format to use.</param>
  221. <returns>A string representation of the enum member.</returns>
  222. <exception cref="T:System.FormatException"><paramref name="format"/> is an invalid value.</exception>
  223. </member>
  224. <member name="M:EnumsNET.EnumMember.AsString(EnumsNET.EnumFormat)">
  225. <summary>
  226. Converts the enum member to its string representation using the specified <paramref name="format"/>.
  227. </summary>
  228. <param name="format">The output format to use.</param>
  229. <returns>A string representation of the enum member.</returns>
  230. <exception cref="T:System.ArgumentException"><paramref name="format"/> is an invalid value.</exception>
  231. </member>
  232. <member name="M:EnumsNET.EnumMember.AsString(EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  233. <summary>
  234. Converts the enum member to its string representation using the specified formats.
  235. </summary>
  236. <param name="format0">The first output format to use.</param>
  237. <param name="format1">The second output format to use if using the first resolves to <c>null</c>.</param>
  238. <returns>A string representation of the enum member.</returns>
  239. <exception cref="T:System.ArgumentException"><paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  240. </member>
  241. <member name="M:EnumsNET.EnumMember.AsString(EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  242. <summary>
  243. Converts the enum member to its string representation using the specified formats.
  244. </summary>
  245. <param name="format0">The first output format to use.</param>
  246. <param name="format1">The second output format to use if using the first resolves to <c>null</c>.</param>
  247. <param name="format2">The third output format to use if using the first and second both resolve to <c>null</c>.</param>
  248. <returns>A string representation of the enum member.</returns>
  249. <exception cref="T:System.ArgumentException"><paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  250. </member>
  251. <member name="M:EnumsNET.EnumMember.AsString(EnumsNET.EnumFormat[])">
  252. <summary>
  253. Converts the enum member to its string representation using the specified <paramref name="formats"/>.
  254. </summary>
  255. <param name="formats">The output formats to use.</param>
  256. <returns>A string representation of the enum member.</returns>
  257. <exception cref="T:System.ArgumentException"><paramref name="formats"/> contains an invalid value.</exception>
  258. </member>
  259. <member name="M:EnumsNET.EnumMember.GetUnderlyingValue">
  260. <summary>
  261. Retrieves the enum member's underlying integral value.
  262. </summary>
  263. <returns>The enum member's underlying integral value.</returns>
  264. </member>
  265. <member name="M:EnumsNET.EnumMember.ToSByte">
  266. <summary>
  267. Converts <see cref="P:EnumsNET.EnumMember.Value"/> to an <see cref="T:System.SByte"/>.
  268. </summary>
  269. <returns><see cref="P:EnumsNET.EnumMember.Value"/> converted to an <see cref="T:System.SByte"/>.</returns>
  270. <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>
  271. </member>
  272. <member name="M:EnumsNET.EnumMember.ToByte">
  273. <summary>
  274. Converts <see cref="P:EnumsNET.EnumMember.Value"/> to a <see cref="T:System.Byte"/>.
  275. </summary>
  276. <returns><see cref="P:EnumsNET.EnumMember.Value"/> converted to a <see cref="T:System.Byte"/>.</returns>
  277. <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>
  278. </member>
  279. <member name="M:EnumsNET.EnumMember.ToInt16">
  280. <summary>
  281. Converts <see cref="P:EnumsNET.EnumMember.Value"/> to an <see cref="T:System.Int16"/>.
  282. </summary>
  283. <returns><see cref="P:EnumsNET.EnumMember.Value"/> converted to an <see cref="T:System.Int16"/>.</returns>
  284. <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>
  285. </member>
  286. <member name="M:EnumsNET.EnumMember.ToUInt16">
  287. <summary>
  288. Converts <see cref="P:EnumsNET.EnumMember.Value"/> to a <see cref="T:System.UInt16"/>.
  289. </summary>
  290. <returns><see cref="P:EnumsNET.EnumMember.Value"/> converted to a <see cref="T:System.UInt16"/>.</returns>
  291. <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>
  292. </member>
  293. <member name="M:EnumsNET.EnumMember.ToInt32">
  294. <summary>
  295. Converts <see cref="P:EnumsNET.EnumMember.Value"/> to an <see cref="T:System.Int32"/>.
  296. </summary>
  297. <returns><see cref="P:EnumsNET.EnumMember.Value"/> converted to an <see cref="T:System.Int32"/>.</returns>
  298. <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>
  299. </member>
  300. <member name="M:EnumsNET.EnumMember.ToUInt32">
  301. <summary>
  302. Converts <see cref="P:EnumsNET.EnumMember.Value"/> to a <see cref="T:System.UInt32"/>.
  303. </summary>
  304. <returns><see cref="P:EnumsNET.EnumMember.Value"/> converted to a <see cref="T:System.UInt32"/>.</returns>
  305. <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>
  306. </member>
  307. <member name="M:EnumsNET.EnumMember.ToInt64">
  308. <summary>
  309. Converts <see cref="P:EnumsNET.EnumMember.Value"/> to an <see cref="T:System.Int64"/>.
  310. </summary>
  311. <returns><see cref="P:EnumsNET.EnumMember.Value"/> converted to an <see cref="T:System.Int64"/>.</returns>
  312. <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>
  313. </member>
  314. <member name="M:EnumsNET.EnumMember.ToUInt64">
  315. <summary>
  316. Converts <see cref="P:EnumsNET.EnumMember.Value"/> to a <see cref="T:System.UInt64"/>.
  317. </summary>
  318. <returns><see cref="P:EnumsNET.EnumMember.Value"/> converted to a <see cref="T:System.UInt64"/>.</returns>
  319. <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>
  320. </member>
  321. <member name="M:EnumsNET.EnumMember.GetHashCode">
  322. <summary>
  323. Retrieves the hash code of <see cref="P:EnumsNET.EnumMember.Value"/>.
  324. </summary>
  325. <returns>The hash code of <see cref="P:EnumsNET.EnumMember.Value"/>.</returns>
  326. </member>
  327. <member name="M:EnumsNET.EnumMember.Equals(EnumsNET.EnumMember)">
  328. <summary>
  329. Indicates whether the specified <see cref="T:EnumsNET.EnumMember"/> is equal to the current <see cref="T:EnumsNET.EnumMember"/>.
  330. </summary>
  331. <param name="other">The other <see cref="T:EnumsNET.EnumMember"/>.</param>
  332. <returns>Indication whether the specified <see cref="T:EnumsNET.EnumMember"/> is equal to the current <see cref="T:EnumsNET.EnumMember"/>.</returns>
  333. </member>
  334. <member name="M:EnumsNET.EnumMember.Equals(System.Object)">
  335. <summary>
  336. Indicates whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
  337. </summary>
  338. <param name="other">The other <see cref="T:System.Object"/>.</param>
  339. <returns>Indication whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.</returns>
  340. </member>
  341. <member name="T:EnumsNET.EnumMember`1">
  342. <summary>
  343. An enum member which is composed of its name, value, and attributes.
  344. </summary>
  345. <typeparam name="TEnum">The enum type.</typeparam>
  346. </member>
  347. <member name="P:EnumsNET.EnumMember`1.Value">
  348. <summary>
  349. The enum member's value.
  350. </summary>
  351. </member>
  352. <member name="M:EnumsNET.EnumMember`1.Equals(EnumsNET.EnumMember{`0})">
  353. <summary>
  354. Indicates whether the specified <see cref="T:EnumsNET.EnumMember`1"/> is equal to the current <see cref="T:EnumsNET.EnumMember`1"/>.
  355. </summary>
  356. <param name="other">The other <see cref="T:EnumsNET.EnumMember`1"/>.</param>
  357. <returns>Indication whether the specified <see cref="T:EnumsNET.EnumMember`1"/> is equal to the current <see cref="T:EnumsNET.EnumMember`1"/>.</returns>
  358. </member>
  359. <member name="T:EnumsNET.EnumMemberSelection">
  360. <summary>
  361. Specifies what enum members to include.
  362. </summary>
  363. </member>
  364. <member name="F:EnumsNET.EnumMemberSelection.All">
  365. <summary>
  366. Include all enum members.
  367. </summary>
  368. </member>
  369. <member name="F:EnumsNET.EnumMemberSelection.Distinct">
  370. <summary>
  371. Include only distinct valued enum members.
  372. </summary>
  373. </member>
  374. <member name="F:EnumsNET.EnumMemberSelection.Flags">
  375. <summary>
  376. Include each flag enum member.
  377. </summary>
  378. </member>
  379. <member name="T:EnumsNET.Enums">
  380. <summary>
  381. Static class that provides efficient type-safe enum operations through the use of cached enum members.
  382. Many operations are exposed as C# extension methods for convenience.
  383. </summary>
  384. </member>
  385. <member name="M:EnumsNET.Enums.RegisterCustomEnumFormat(System.Func{EnumsNET.EnumMember,System.String})">
  386. <summary>
  387. Registers a custom <see cref="T:EnumsNET.EnumFormat"/> with the specified <see cref="T:EnumsNET.EnumMember"/> formatter.
  388. </summary>
  389. <param name="enumMemberFormatter">The <see cref="T:EnumsNET.EnumMember"/> formatter.</param>
  390. <returns>A custom <see cref="T:EnumsNET.EnumFormat"/> that is registered with the specified <see cref="T:EnumsNET.EnumMember"/> formatter.</returns>
  391. <exception cref="T:System.ArgumentNullException"><paramref name="enumMemberFormatter"/> is <c>null</c>.</exception>
  392. </member>
  393. <member name="M:EnumsNET.Enums.GetUnderlyingType``1">
  394. <summary>
  395. Retrieves the underlying type of <typeparamref name="TEnum"/>.
  396. </summary>
  397. <typeparam name="TEnum">The enum type.</typeparam>
  398. <returns>The underlying type of <typeparamref name="TEnum"/>.</returns>
  399. </member>
  400. <member name="M:EnumsNET.Enums.GetMemberCount``1(EnumsNET.EnumMemberSelection)">
  401. <summary>
  402. Retrieves <typeparamref name="TEnum"/>'s member count.
  403. The parameter <paramref name="selection"/> indicates what members to include.
  404. </summary>
  405. <typeparam name="TEnum">The enum type.</typeparam>
  406. <param name="selection">Indicates what members to include.</param>
  407. <returns><typeparamref name="TEnum"/>'s member count.</returns>
  408. <exception cref="T:System.ArgumentException"><paramref name="selection"/> is an invalid value.</exception>
  409. </member>
  410. <member name="M:EnumsNET.Enums.GetMembers``1(EnumsNET.EnumMemberSelection)">
  411. <summary>
  412. Retrieves <typeparamref name="TEnum"/>'s members in increasing value order.
  413. The parameter <paramref name="selection"/> indicates what members to include.
  414. </summary>
  415. <typeparam name="TEnum">The enum type.</typeparam>
  416. <param name="selection">Indicates what members to include.</param>
  417. <returns><typeparamref name="TEnum"/>'s members in increasing value order.</returns>
  418. <exception cref="T:System.ArgumentException"><paramref name="selection"/> is an invalid value.</exception>
  419. </member>
  420. <member name="M:EnumsNET.Enums.GetNames``1(EnumsNET.EnumMemberSelection)">
  421. <summary>
  422. Retrieves <typeparamref name="TEnum"/>'s members' names in increasing value order.
  423. The parameter <paramref name="selection"/> indicates what members to include.
  424. </summary>
  425. <typeparam name="TEnum">The enum type.</typeparam>
  426. <param name="selection">Indicates what members to include.</param>
  427. <returns><typeparamref name="TEnum"/>'s members' names in increasing value order.</returns>
  428. <exception cref="T:System.ArgumentException"><paramref name="selection"/> is an invalid value.</exception>
  429. </member>
  430. <member name="M:EnumsNET.Enums.GetValues``1(EnumsNET.EnumMemberSelection)">
  431. <summary>
  432. Retrieves <typeparamref name="TEnum"/>'s members' values in increasing value order.
  433. The parameter <paramref name="selection"/> indicates what members to include.
  434. </summary>
  435. <typeparam name="TEnum">The enum type.</typeparam>
  436. <param name="selection">Indicates what members to include.</param>
  437. <returns><typeparamref name="TEnum"/>'s members' values in increasing value order.</returns>
  438. <exception cref="T:System.ArgumentException"><paramref name="selection"/> is an invalid value.</exception>
  439. </member>
  440. <member name="M:EnumsNET.Enums.ToObject``1(System.Object,EnumsNET.EnumValidation)">
  441. <summary>
  442. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  443. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  444. </summary>
  445. <typeparam name="TEnum">The enum type.</typeparam>
  446. <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"/>,
  447. <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>
  448. <param name="validation">The validation to perform on the result.</param>
  449. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  450. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  451. <exception cref="T:System.ArgumentException"><paramref name="value"/> is not a valid type
  452. -or-
  453. <paramref name="validation"/> is an invalid value
  454. -or-
  455. the result is invalid with the specified <paramref name="validation"/>.</exception>
  456. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  457. </member>
  458. <member name="M:EnumsNET.Enums.ToObject``1(System.SByte,EnumsNET.EnumValidation)">
  459. <summary>
  460. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  461. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  462. </summary>
  463. <typeparam name="TEnum">The enum type.</typeparam>
  464. <param name="value">Value to convert.</param>
  465. <param name="validation">The validation to perform on the result.</param>
  466. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  467. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value
  468. -or-
  469. the result is invalid with the specified <paramref name="validation"/>.</exception>
  470. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  471. </member>
  472. <member name="M:EnumsNET.Enums.ToObject``1(System.Byte,EnumsNET.EnumValidation)">
  473. <summary>
  474. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  475. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  476. </summary>
  477. <typeparam name="TEnum">The enum type.</typeparam>
  478. <param name="value">Value to convert.</param>
  479. <param name="validation">The validation to perform on the result.</param>
  480. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  481. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value
  482. -or-
  483. the result is invalid with the specified <paramref name="validation"/>.</exception>
  484. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  485. </member>
  486. <member name="M:EnumsNET.Enums.ToObject``1(System.Int16,EnumsNET.EnumValidation)">
  487. <summary>
  488. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  489. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  490. </summary>
  491. <typeparam name="TEnum">The enum type.</typeparam>
  492. <param name="value">Value to convert.</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.ArgumentException"><paramref name="validation"/> is an invalid value
  496. -or-
  497. the result is invalid with the specified <paramref name="validation"/>.</exception>
  498. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  499. </member>
  500. <member name="M:EnumsNET.Enums.ToObject``1(System.UInt16,EnumsNET.EnumValidation)">
  501. <summary>
  502. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  503. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  504. </summary>
  505. <typeparam name="TEnum">The enum type.</typeparam>
  506. <param name="value">Value to convert.</param>
  507. <param name="validation">The validation to perform on the result.</param>
  508. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  509. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value
  510. -or-
  511. the result is invalid with the specified <paramref name="validation"/>.</exception>
  512. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  513. </member>
  514. <member name="M:EnumsNET.Enums.ToObject``1(System.Int32,EnumsNET.EnumValidation)">
  515. <summary>
  516. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  517. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  518. </summary>
  519. <typeparam name="TEnum">The enum type.</typeparam>
  520. <param name="value">Value to convert.</param>
  521. <param name="validation">The validation to perform on the result.</param>
  522. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  523. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value
  524. -or-
  525. the result is invalid with the specified <paramref name="validation"/>.</exception>
  526. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  527. </member>
  528. <member name="M:EnumsNET.Enums.ToObject``1(System.UInt32,EnumsNET.EnumValidation)">
  529. <summary>
  530. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  531. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  532. </summary>
  533. <typeparam name="TEnum">The enum type.</typeparam>
  534. <param name="value">Value to convert.</param>
  535. <param name="validation">The validation to perform on the result.</param>
  536. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  537. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value
  538. -or-
  539. the result is invalid with the specified <paramref name="validation"/>.</exception>
  540. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  541. </member>
  542. <member name="M:EnumsNET.Enums.ToObject``1(System.Int64,EnumsNET.EnumValidation)">
  543. <summary>
  544. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  545. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  546. </summary>
  547. <typeparam name="TEnum">The enum type.</typeparam>
  548. <param name="value">Value to convert.</param>
  549. <param name="validation">The validation to perform on the result.</param>
  550. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  551. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value
  552. -or-
  553. the result is invalid with the specified <paramref name="validation"/>.</exception>
  554. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  555. </member>
  556. <member name="M:EnumsNET.Enums.ToObject``1(System.UInt64,EnumsNET.EnumValidation)">
  557. <summary>
  558. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  559. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  560. </summary>
  561. <typeparam name="TEnum">The enum type.</typeparam>
  562. <param name="value">Value to convert.</param>
  563. <param name="validation">The validation to perform on the result.</param>
  564. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  565. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value
  566. -or-
  567. the result is invalid with the specified <paramref name="validation"/>.</exception>
  568. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  569. </member>
  570. <member name="M:EnumsNET.Enums.TryToObject``1(System.Object,``0@,EnumsNET.EnumValidation)">
  571. <summary>
  572. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  573. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  574. The return value indicates whether the conversion succeeded.
  575. </summary>
  576. <typeparam name="TEnum">The enum type.</typeparam>
  577. <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"/>,
  578. <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>
  579. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  580. <param name="validation">The validation to perform on the result.</param>
  581. <returns>Indication whether the conversion succeeded.</returns>
  582. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value.</exception>
  583. </member>
  584. <member name="M:EnumsNET.Enums.TryToObject``1(System.SByte,``0@,EnumsNET.EnumValidation)">
  585. <summary>
  586. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  587. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  588. The return value indicates whether the conversion succeeded.
  589. </summary>
  590. <typeparam name="TEnum">The enum type.</typeparam>
  591. <param name="value">Value to try to convert.</param>
  592. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  593. <param name="validation">The validation to perform on the result.</param>
  594. <returns>Indication whether the conversion succeeded.</returns>
  595. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value.</exception>
  596. </member>
  597. <member name="M:EnumsNET.Enums.TryToObject``1(System.Byte,``0@,EnumsNET.EnumValidation)">
  598. <summary>
  599. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  600. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  601. The return value indicates whether the conversion succeeded.
  602. </summary>
  603. <typeparam name="TEnum">The enum type.</typeparam>
  604. <param name="value">Value to try to convert.</param>
  605. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  606. <param name="validation">The validation to perform on the result.</param>
  607. <returns>Indication whether the conversion succeeded.</returns>
  608. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value.</exception>
  609. </member>
  610. <member name="M:EnumsNET.Enums.TryToObject``1(System.Int16,``0@,EnumsNET.EnumValidation)">
  611. <summary>
  612. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  613. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  614. The return value indicates whether the conversion succeeded.
  615. </summary>
  616. <typeparam name="TEnum">The enum type.</typeparam>
  617. <param name="value">Value to try to convert.</param>
  618. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  619. <param name="validation">The validation to perform on the result.</param>
  620. <returns>Indication whether the conversion succeeded.</returns>
  621. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value.</exception>
  622. </member>
  623. <member name="M:EnumsNET.Enums.TryToObject``1(System.UInt16,``0@,EnumsNET.EnumValidation)">
  624. <summary>
  625. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  626. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  627. The return value indicates whether the conversion succeeded.
  628. </summary>
  629. <typeparam name="TEnum">The enum type.</typeparam>
  630. <param name="value">Value to try to convert.</param>
  631. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  632. <param name="validation">The validation to perform on the result.</param>
  633. <returns>Indication whether the conversion succeeded.</returns>
  634. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value.</exception>
  635. </member>
  636. <member name="M:EnumsNET.Enums.TryToObject``1(System.Int32,``0@,EnumsNET.EnumValidation)">
  637. <summary>
  638. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  639. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  640. The return value indicates whether the conversion succeeded.
  641. </summary>
  642. <typeparam name="TEnum">The enum type.</typeparam>
  643. <param name="value">Value to try to convert.</param>
  644. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  645. <param name="validation">The validation to perform on the result.</param>
  646. <returns>Indication whether the conversion succeeded.</returns>
  647. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value.</exception>
  648. </member>
  649. <member name="M:EnumsNET.Enums.TryToObject``1(System.UInt32,``0@,EnumsNET.EnumValidation)">
  650. <summary>
  651. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  652. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  653. The return value indicates whether the conversion succeeded.
  654. </summary>
  655. <typeparam name="TEnum">The enum type.</typeparam>
  656. <param name="value">Value to try to convert.</param>
  657. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  658. <param name="validation">The validation to perform on the result.</param>
  659. <returns>Indication whether the conversion succeeded.</returns>
  660. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value.</exception>
  661. </member>
  662. <member name="M:EnumsNET.Enums.TryToObject``1(System.Int64,``0@,EnumsNET.EnumValidation)">
  663. <summary>
  664. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  665. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  666. The return value indicates whether the conversion succeeded.
  667. </summary>
  668. <typeparam name="TEnum">The enum type.</typeparam>
  669. <param name="value">Value to try to convert.</param>
  670. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  671. <param name="validation">The validation to perform on the result.</param>
  672. <returns>Indication whether the conversion succeeded.</returns>
  673. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value.</exception>
  674. </member>
  675. <member name="M:EnumsNET.Enums.TryToObject``1(System.UInt64,``0@,EnumsNET.EnumValidation)">
  676. <summary>
  677. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  678. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  679. The return value indicates whether the conversion succeeded.
  680. </summary>
  681. <typeparam name="TEnum">The enum type.</typeparam>
  682. <param name="value">Value to try to convert.</param>
  683. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  684. <param name="validation">The validation to perform on the result.</param>
  685. <returns>Indication whether the conversion succeeded.</returns>
  686. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value.</exception>
  687. </member>
  688. <member name="M:EnumsNET.Enums.IsValid``1(``0,EnumsNET.EnumValidation)">
  689. <summary>
  690. Indicates if <paramref name="value"/> is valid using the specified <paramref name="validation"/>.
  691. </summary>
  692. <typeparam name="TEnum">The enum type.</typeparam>
  693. <param name="value">The enum value.</param>
  694. <param name="validation">The validation to perform on the value.</param>
  695. <returns>Indication if <paramref name="value"/> is valid.</returns>
  696. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value.</exception>
  697. </member>
  698. <member name="M:EnumsNET.Enums.IsDefined``1(``0)">
  699. <summary>
  700. Indicates if <paramref name="value"/> is defined.
  701. </summary>
  702. <typeparam name="TEnum">The enum type.</typeparam>
  703. <param name="value">The enum value.</param>
  704. <returns>Indication if <paramref name="value"/> is defined.</returns>
  705. </member>
  706. <member name="M:EnumsNET.Enums.Validate``1(``0,System.String,EnumsNET.EnumValidation)">
  707. <summary>
  708. Validates that <paramref name="value"/> is valid using the specified <paramref name="validation"/>.
  709. If it's not it throws an <see cref="T:System.ArgumentException"/> with the specified <paramref name="paramName"/>.
  710. </summary>
  711. <typeparam name="TEnum">The enum type.</typeparam>
  712. <param name="value">The enum value.</param>
  713. <param name="paramName">The parameter name to be used if throwing an <see cref="T:System.ArgumentException"/>.</param>
  714. <param name="validation">The validation to perform on the value.</param>
  715. <returns><paramref name="value"/> for use in fluent API's and base constructor method calls.</returns>
  716. <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value
  717. -or-
  718. <paramref name="value"/> is invalid.</exception>
  719. </member>
  720. <member name="M:EnumsNET.Enums.AsString``1(``0)">
  721. <summary>
  722. Converts the specified <paramref name="value"/> to its string representation.
  723. </summary>
  724. <typeparam name="TEnum">The enum type.</typeparam>
  725. <param name="value">The enum value.</param>
  726. <returns>A string representation of <paramref name="value"/>.</returns>
  727. </member>
  728. <member name="M:EnumsNET.Enums.AsString``1(``0,System.String)">
  729. <summary>
  730. Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="format"/>.
  731. </summary>
  732. <typeparam name="TEnum">The enum type.</typeparam>
  733. <param name="value">The enum value.</param>
  734. <param name="format">The output format to use.</param>
  735. <returns>A string representation of <paramref name="value"/>.</returns>
  736. <exception cref="T:System.FormatException"><paramref name="format"/> is an invalid value.</exception>
  737. </member>
  738. <member name="M:EnumsNET.Enums.AsString``1(``0,EnumsNET.EnumFormat)">
  739. <summary>
  740. Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="format"/>.
  741. </summary>
  742. <typeparam name="TEnum">The enum type.</typeparam>
  743. <param name="value">The enum value.</param>
  744. <param name="format">The output format to use.</param>
  745. <returns>A string representation of <paramref name="value"/>.</returns>
  746. <exception cref="T:System.ArgumentException"><paramref name="format"/> is an invalid value.</exception>
  747. </member>
  748. <member name="M:EnumsNET.Enums.AsString``1(``0,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  749. <summary>
  750. Converts the specified <paramref name="value"/> to its string representation using the specified formats.
  751. </summary>
  752. <typeparam name="TEnum">The enum type.</typeparam>
  753. <param name="value">The enum value.</param>
  754. <param name="format0">The first output format to use.</param>
  755. <param name="format1">The second output format to use if using the first resolves to <c>null</c>.</param>
  756. <returns>A string representation of <paramref name="value"/>.</returns>
  757. <exception cref="T:System.ArgumentException"><paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  758. </member>
  759. <member name="M:EnumsNET.Enums.AsString``1(``0,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  760. <summary>
  761. Converts the specified <paramref name="value"/> to its string representation using the specified formats.
  762. </summary>
  763. <typeparam name="TEnum">The enum type.</typeparam>
  764. <param name="value">The enum value.</param>
  765. <param name="format0">The first output format to use.</param>
  766. <param name="format1">The second output format to use if using the first resolves to <c>null</c>.</param>
  767. <param name="format2">The third output format to use if using the first and second both resolve to <c>null</c>.</param>
  768. <returns>A string representation of <paramref name="value"/>.</returns>
  769. <exception cref="T:System.ArgumentException"><paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  770. </member>
  771. <member name="M:EnumsNET.Enums.AsString``1(``0,EnumsNET.EnumFormat[])">
  772. <summary>
  773. Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="formats"/>.
  774. </summary>
  775. <typeparam name="TEnum">The enum type.</typeparam>
  776. <param name="value">The enum value.</param>
  777. <param name="formats">The output formats to use.</param>
  778. <returns>A string representation of <paramref name="value"/>.</returns>
  779. <exception cref="T:System.ArgumentException"><paramref name="formats"/> contains an invalid value.</exception>
  780. </member>
  781. <member name="M:EnumsNET.Enums.Format``1(``0,System.String)">
  782. <summary>
  783. Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="format"/>.
  784. </summary>
  785. <typeparam name="TEnum">The enum type.</typeparam>
  786. <param name="value">The enum value.</param>
  787. <param name="format">The output format to use.</param>
  788. <returns>A string representation of <paramref name="value"/>.</returns>
  789. <exception cref="T:System.ArgumentNullException"><paramref name="format"/> is <c>null</c>.</exception>
  790. <exception cref="T:System.FormatException"><paramref name="format"/> is an invalid value.</exception>
  791. </member>
  792. <member name="M:EnumsNET.Enums.GetUnderlyingValue``1(``0)">
  793. <summary>
  794. Returns <paramref name="value"/>'s underlying integral value.
  795. </summary>
  796. <typeparam name="TEnum">The enum type.</typeparam>
  797. <param name="value">The enum value.</param>
  798. <returns><paramref name="value"/>'s underlying integral value.</returns>
  799. </member>
  800. <member name="M:EnumsNET.Enums.ToSByte``1(``0)">
  801. <summary>
  802. Converts <paramref name="value"/> to an <see cref="T:System.SByte"/>.
  803. </summary>
  804. <typeparam name="TEnum">The enum type.</typeparam>
  805. <param name="value">The enum value.</param>
  806. <returns><paramref name="value"/> converted to an <see cref="T:System.SByte"/>.</returns>
  807. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.SByte"/>'s value range without overflowing.</exception>
  808. </member>
  809. <member name="M:EnumsNET.Enums.ToByte``1(``0)">
  810. <summary>
  811. Converts <paramref name="value"/> to a <see cref="T:System.Byte"/>.
  812. </summary>
  813. <typeparam name="TEnum">The enum type.</typeparam>
  814. <param name="value">The enum value.</param>
  815. <returns><paramref name="value"/> converted to a <see cref="T:System.Byte"/>.</returns>
  816. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Byte"/>'s value range without overflowing.</exception>
  817. </member>
  818. <member name="M:EnumsNET.Enums.ToInt16``1(``0)">
  819. <summary>
  820. Converts <paramref name="value"/> to an <see cref="T:System.Int16"/>.
  821. </summary>
  822. <typeparam name="TEnum">The enum type.</typeparam>
  823. <param name="value">The enum value.</param>
  824. <returns><paramref name="value"/> converted to an <see cref="T:System.Int16"/>.</returns>
  825. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Int16"/>'s value range without overflowing.</exception>
  826. </member>
  827. <member name="M:EnumsNET.Enums.ToUInt16``1(``0)">
  828. <summary>
  829. Converts <paramref name="value"/> to a <see cref="T:System.UInt16"/>.
  830. </summary>
  831. <typeparam name="TEnum">The enum type.</typeparam>
  832. <param name="value">The enum value.</param>
  833. <returns><paramref name="value"/> converted to a <see cref="T:System.UInt16"/>.</returns>
  834. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.UInt16"/>'s value range without overflowing.</exception>
  835. </member>
  836. <member name="M:EnumsNET.Enums.ToInt32``1(``0)">
  837. <summary>
  838. Converts <paramref name="value"/> to an <see cref="T:System.Int32"/>.
  839. </summary>
  840. <typeparam name="TEnum">The enum type.</typeparam>
  841. <param name="value">The enum value.</param>
  842. <returns><paramref name="value"/> converted to an <see cref="T:System.Int32"/>.</returns>
  843. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Int32"/>'s value range without overflowing.</exception>
  844. </member>
  845. <member name="M:EnumsNET.Enums.ToUInt32``1(``0)">
  846. <summary>
  847. Converts <paramref name="value"/> to a <see cref="T:System.UInt32"/>.
  848. </summary>
  849. <typeparam name="TEnum">The enum type.</typeparam>
  850. <param name="value">The enum value.</param>
  851. <returns><paramref name="value"/> converted to a <see cref="T:System.UInt32"/>.</returns>
  852. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.UInt32"/>'s value range without overflowing.</exception>
  853. </member>
  854. <member name="M:EnumsNET.Enums.ToInt64``1(``0)">
  855. <summary>
  856. Converts <paramref name="value"/> to an <see cref="T:System.Int64"/>.
  857. </summary>
  858. <typeparam name="TEnum">The enum type.</typeparam>
  859. <param name="value">The enum value.</param>
  860. <returns><paramref name="value"/> converted to an <see cref="T:System.Int64"/>.</returns>
  861. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Int64"/>'s value range without overflowing.</exception>
  862. </member>
  863. <member name="M:EnumsNET.Enums.ToUInt64``1(``0)">
  864. <summary>
  865. Converts <paramref name="value"/> to a <see cref="T:System.UInt64"/>.
  866. </summary>
  867. <typeparam name="TEnum">The enum type.</typeparam>
  868. <param name="value">The enum value.</param>
  869. <returns><paramref name="value"/> converted to a <see cref="T:System.UInt64"/>.</returns>
  870. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.UInt64"/>'s value range without overflowing.</exception>
  871. </member>
  872. <member name="M:EnumsNET.Enums.GetHashCode``1(``0)">
  873. <summary>
  874. Retrieves the hash code of <paramref name="value"/>. It's more efficient as it doesn't require boxing and unboxing of <paramref name="value"/>.
  875. </summary>
  876. <typeparam name="TEnum">The enum type.</typeparam>
  877. <param name="value">The enum value.</param>
  878. <returns>Hash code of <paramref name="value"/>.</returns>
  879. </member>
  880. <member name="M:EnumsNET.Enums.Equals``1(``0,``0)">
  881. <summary>
  882. Indicates if <paramref name="value"/> equals <paramref name="other"/>.
  883. </summary>
  884. <typeparam name="TEnum">The enum type.</typeparam>
  885. <param name="value">The enum value.</param>
  886. <param name="other">The other enum value.</param>
  887. <returns>Indication if <paramref name="value"/> equals <paramref name="other"/>.</returns>
  888. </member>
  889. <member name="M:EnumsNET.Enums.CompareTo``1(``0,``0)">
  890. <summary>
  891. Compares <paramref name="value"/> to <paramref name="other"/> for ordering.
  892. </summary>
  893. <typeparam name="TEnum">The enum type.</typeparam>
  894. <param name="value">The enum value.</param>
  895. <param name="other">The other enum value.</param>
  896. <returns>1 if <paramref name="value"/> is greater than <paramref name="other"/>, 0 if <paramref name="value"/> equals <paramref name="other"/>,
  897. and -1 if <paramref name="value"/> is less than <paramref name="other"/>.</returns>
  898. </member>
  899. <member name="M:EnumsNET.Enums.GetName``1(``0)">
  900. <summary>
  901. Retrieves <paramref name="value"/>'s enum member name if defined otherwise <c>null</c>.
  902. </summary>
  903. <typeparam name="TEnum">The enum type.</typeparam>
  904. <param name="value">The enum value.</param>
  905. <returns><paramref name="value"/>'s enum member name if defined otherwise <c>null</c>.</returns>
  906. </member>
  907. <member name="M:EnumsNET.Enums.GetAttributes``1(``0)">
  908. <summary>
  909. Retrieves <paramref name="value"/>'s enum member attributes if defined otherwise <c>null</c>.
  910. </summary>
  911. <typeparam name="TEnum">The enum type.</typeparam>
  912. <param name="value">The enum value.</param>
  913. <returns><paramref name="value"/>'s enum member attributes if defined otherwise <c>null</c>.</returns>
  914. </member>
  915. <member name="M:EnumsNET.Enums.GetMember``1(``0)">
  916. <summary>
  917. Retrieves an enum member with the specified <paramref name="value"/> if defined otherwise <c>null</c>.
  918. </summary>
  919. <typeparam name="TEnum">The enum type.</typeparam>
  920. <param name="value">The enum value.</param>
  921. <returns>Enum member with the specified <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
  922. </member>
  923. <member name="M:EnumsNET.Enums.GetMember``1(System.String)">
  924. <summary>
  925. Retrieves the enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.
  926. </summary>
  927. <typeparam name="TEnum">The enum type.</typeparam>
  928. <param name="name">The enum member name.</param>
  929. <returns>Enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.</returns>
  930. <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <c>null</c>.</exception>
  931. </member>
  932. <member name="M:EnumsNET.Enums.GetMember``1(System.String,System.Boolean)">
  933. <summary>
  934. Retrieves the enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.
  935. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  936. </summary>
  937. <typeparam name="TEnum">The enum type.</typeparam>
  938. <param name="name">The enum member name.</param>
  939. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  940. <returns>Enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.</returns>
  941. <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <c>null</c>.</exception>
  942. </member>
  943. <member name="M:EnumsNET.Enums.GetMember``1(System.String,System.Boolean,EnumsNET.EnumFormat)">
  944. <summary>
  945. Retrieves an enum member whose string representation using the specified <paramref name="format"/> is <paramref name="value"/> if defined otherwise <c>null</c>.
  946. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  947. </summary>
  948. <typeparam name="TEnum">The enum type.</typeparam>
  949. <param name="value">The enum member's string representation.</param>
  950. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  951. <param name="format">The parsing enum format.</param>
  952. <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
  953. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  954. <exception cref="T:System.ArgumentException"><paramref name="format"/> is an invalid value.</exception>
  955. </member>
  956. <member name="M:EnumsNET.Enums.GetMember``1(System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  957. <summary>
  958. Retrieves an enum member whose string representation using the specified formats is <paramref name="value"/> if defined otherwise <c>null</c>.
  959. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  960. </summary>
  961. <typeparam name="TEnum">The enum type.</typeparam>
  962. <param name="value">The enum member's string representation.</param>
  963. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  964. <param name="format0">The first parsing enum format.</param>
  965. <param name="format1">The second parsing enum format.</param>
  966. <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
  967. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  968. <exception cref="T:System.ArgumentException"><paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  969. </member>
  970. <member name="M:EnumsNET.Enums.GetMember``1(System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  971. <summary>
  972. Retrieves an enum member whose string representation using the specified formats is <paramref name="value"/> if defined otherwise <c>null</c>.
  973. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  974. </summary>
  975. <typeparam name="TEnum">The enum type.</typeparam>
  976. <param name="value">The enum member's string representation.</param>
  977. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  978. <param name="format0">The first parsing enum format.</param>
  979. <param name="format1">The second parsing enum format.</param>
  980. <param name="format2">The third parsing enum format.</param>
  981. <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
  982. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  983. <exception cref="T:System.ArgumentException"><paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  984. </member>
  985. <member name="M:EnumsNET.Enums.GetMember``1(System.String,System.Boolean,EnumsNET.EnumFormat[])">
  986. <summary>
  987. Retrieves an enum member whose string representation using the specified <paramref name="formats"/> is <paramref name="value"/> if defined otherwise <c>null</c>.
  988. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  989. </summary>
  990. <typeparam name="TEnum">The enum type.</typeparam>
  991. <param name="value">The enum member's string representation.</param>
  992. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  993. <param name="formats">The parsing enum formats.</param>
  994. <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
  995. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  996. <exception cref="T:System.ArgumentException"><paramref name="formats"/> contains an invalid value.</exception>
  997. </member>
  998. <member name="M:EnumsNET.Enums.Parse``1(System.String)">
  999. <summary>
  1000. Converts the string representation of one or more member names or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value.
  1001. </summary>
  1002. <typeparam name="TEnum">The enum type.</typeparam>
  1003. <param name="value">The enum member names or values' string representation.</param>
  1004. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  1005. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1006. <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member name or value of <typeparamref name="TEnum"/>.</exception>
  1007. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  1008. </member>
  1009. <member name="M:EnumsNET.Enums.Parse``1(System.String,System.Boolean)">
  1010. <summary>
  1011. Converts the string representation of one or more member names or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value.
  1012. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  1013. </summary>
  1014. <typeparam name="TEnum">The enum type.</typeparam>
  1015. <param name="value">The enum member names or values' string representation.</param>
  1016. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1017. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  1018. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1019. <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member name or value of <typeparamref name="TEnum"/>.</exception>
  1020. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  1021. </member>
  1022. <member name="M:EnumsNET.Enums.Parse``1(System.String,System.Boolean,EnumsNET.EnumFormat)">
  1023. <summary>
  1024. Converts the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
  1025. using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  1026. </summary>
  1027. <typeparam name="TEnum">The enum type.</typeparam>
  1028. <param name="value">The enum members or values' 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>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  1032. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1033. <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
  1034. -or-
  1035. <paramref name="format"/> is an invalid value.</exception>
  1036. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  1037. </member>
  1038. <member name="M:EnumsNET.Enums.Parse``1(System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  1039. <summary>
  1040. Converts the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
  1041. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  1042. </summary>
  1043. <typeparam name="TEnum">The enum type.</typeparam>
  1044. <param name="value">The enum members or values' string representation.</param>
  1045. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1046. <param name="format0">The first parsing enum format.</param>
  1047. <param name="format1">The second parsing enum format.</param>
  1048. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  1049. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1050. <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
  1051. -or-
  1052. <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  1053. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  1054. </member>
  1055. <member name="M:EnumsNET.Enums.Parse``1(System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  1056. <summary>
  1057. Converts the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
  1058. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  1059. </summary>
  1060. <typeparam name="TEnum">The enum type.</typeparam>
  1061. <param name="value">The enum members or values' string representation.</param>
  1062. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1063. <param name="format0">The first parsing enum format.</param>
  1064. <param name="format1">The second parsing enum format.</param>
  1065. <param name="format2">The third parsing enum format.</param>
  1066. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  1067. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1068. <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
  1069. -or-
  1070. <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  1071. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  1072. </member>
  1073. <member name="M:EnumsNET.Enums.Parse``1(System.String,System.Boolean,EnumsNET.EnumFormat[])">
  1074. <summary>
  1075. Converts the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
  1076. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  1077. </summary>
  1078. <typeparam name="TEnum">The enum type.</typeparam>
  1079. <param name="value">The enum members or values' string representation.</param>
  1080. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1081. <param name="formats">The parsing enum formats.</param>
  1082. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  1083. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1084. <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
  1085. -or-
  1086. <paramref name="formats"/> contains an invalid value.</exception>
  1087. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  1088. </member>
  1089. <member name="M:EnumsNET.Enums.TryParse``1(System.String,``0@)">
  1090. <summary>
  1091. 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.
  1092. The return value indicates whether the conversion succeeded.
  1093. </summary>
  1094. <typeparam name="TEnum">The enum type.</typeparam>
  1095. <param name="value">The enum member names or values' string representation.</param>
  1096. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  1097. <returns>Indication whether the conversion succeeded.</returns>
  1098. </member>
  1099. <member name="M:EnumsNET.Enums.TryParse``1(System.String,System.Boolean,``0@)">
  1100. <summary>
  1101. 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.
  1102. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive. The return value indicates whether the conversion succeeded.
  1103. </summary>
  1104. <typeparam name="TEnum">The enum type.</typeparam>
  1105. <param name="value">The enum member names or values' string representation.</param>
  1106. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1107. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  1108. <returns>Indication whether the conversion succeeded.</returns>
  1109. </member>
  1110. <member name="M:EnumsNET.Enums.TryParse``1(System.String,System.Boolean,``0@,EnumsNET.EnumFormat)">
  1111. <summary>
  1112. Tries to convert the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
  1113. using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  1114. The return value indicates whether the conversion succeeded.
  1115. </summary>
  1116. <typeparam name="TEnum">The enum type.</typeparam>
  1117. <param name="value">The enum members or values' string representation.</param>
  1118. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1119. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  1120. <param name="format">The parsing enum format.</param>
  1121. <returns>Indication whether the conversion succeeded.</returns>
  1122. <exception cref="T:System.ArgumentException"><paramref name="format"/> is an invalid value.</exception>
  1123. </member>
  1124. <member name="M:EnumsNET.Enums.TryParse``1(System.String,System.Boolean,``0@,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  1125. <summary>
  1126. Tries to convert the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
  1127. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  1128. The return value indicates whether the conversion succeeded.
  1129. </summary>
  1130. <typeparam name="TEnum">The enum type.</typeparam>
  1131. <param name="value">The enum members or values' string representation.</param>
  1132. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1133. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  1134. <param name="format0">The first parsing enum format.</param>
  1135. <param name="format1">The second parsing enum format.</param>
  1136. <returns>Indication whether the conversion succeeded.</returns>
  1137. <exception cref="T:System.ArgumentException"><paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  1138. </member>
  1139. <member name="M:EnumsNET.Enums.TryParse``1(System.String,System.Boolean,``0@,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  1140. <summary>
  1141. Tries to convert the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
  1142. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  1143. The return value indicates whether the conversion succeeded.
  1144. </summary>
  1145. <typeparam name="TEnum">The enum type.</typeparam>
  1146. <param name="value">The enum members or values' string representation.</param>
  1147. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1148. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  1149. <param name="format0">The first parsing enum format.</param>
  1150. <param name="format1">The second parsing enum format.</param>
  1151. <param name="format2">The third parsing enum format.</param>
  1152. <returns>Indication whether the conversion succeeded.</returns>
  1153. <exception cref="T:System.ArgumentException"><paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  1154. </member>
  1155. <member name="M:EnumsNET.Enums.TryParse``1(System.String,System.Boolean,``0@,EnumsNET.EnumFormat[])">
  1156. <summary>
  1157. Tries to convert the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
  1158. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  1159. The return value indicates whether the conversion succeeded.
  1160. </summary>
  1161. <typeparam name="TEnum">The enum type.</typeparam>
  1162. <param name="value">The enum members or values' string representation.</param>
  1163. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1164. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  1165. <param name="formats">The parsing enum formats.</param>
  1166. <returns>Indication whether the conversion succeeded.</returns>
  1167. <exception cref="T:System.ArgumentException"><paramref name="formats"/> contains an invalid value.</exception>
  1168. </member>
  1169. <member name="M:EnumsNET.Enums.GetUnderlyingTypeUnsafe``1">
  1170. <summary>
  1171. Retrieves the underlying type of <typeparamref name="TEnum"/>.
  1172. </summary>
  1173. <typeparam name="TEnum">The enum type.</typeparam>
  1174. <returns>The underlying type of <typeparamref name="TEnum"/>.</returns>
  1175. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1176. </member>
  1177. <member name="M:EnumsNET.Enums.GetMemberCountUnsafe``1(EnumsNET.EnumMemberSelection)">
  1178. <summary>
  1179. Retrieves <typeparamref name="TEnum"/>'s member count.
  1180. The parameter <paramref name="selection"/> indicates what members to include.
  1181. </summary>
  1182. <typeparam name="TEnum">The enum type.</typeparam>
  1183. <param name="selection">Indicates what members to include.</param>
  1184. <returns><typeparamref name="TEnum"/>'s member count.</returns>
  1185. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1186. -or-
  1187. <paramref name="selection"/> is an invalid value.</exception>
  1188. </member>
  1189. <member name="M:EnumsNET.Enums.GetMembersUnsafe``1(EnumsNET.EnumMemberSelection)">
  1190. <summary>
  1191. Retrieves <typeparamref name="TEnum"/>'s members in increasing value order.
  1192. The parameter <paramref name="selection"/> indicates what members to include.
  1193. </summary>
  1194. <typeparam name="TEnum">The enum type.</typeparam>
  1195. <param name="selection">Indicates what members to include.</param>
  1196. <returns><typeparamref name="TEnum"/>'s members in increasing value order.</returns>
  1197. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1198. -or-
  1199. <paramref name="selection"/> is an invalid value.</exception>
  1200. </member>
  1201. <member name="M:EnumsNET.Enums.GetNamesUnsafe``1(EnumsNET.EnumMemberSelection)">
  1202. <summary>
  1203. Retrieves <typeparamref name="TEnum"/>'s members' names in increasing value order.
  1204. The parameter <paramref name="selection"/> indicates what members to include.
  1205. </summary>
  1206. <typeparam name="TEnum">The enum type.</typeparam>
  1207. <param name="selection">Indicates what members to include.</param>
  1208. <returns><typeparamref name="TEnum"/>'s members' names in increasing value order.</returns>
  1209. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1210. -or-
  1211. <paramref name="selection"/> is an invalid value.</exception>
  1212. </member>
  1213. <member name="M:EnumsNET.Enums.GetValuesUnsafe``1(EnumsNET.EnumMemberSelection)">
  1214. <summary>
  1215. Retrieves <typeparamref name="TEnum"/>'s members' values in increasing value order.
  1216. The parameter <paramref name="selection"/> indicates what members to include.
  1217. </summary>
  1218. <typeparam name="TEnum">The enum type.</typeparam>
  1219. <param name="selection">Indicates what members to include.</param>
  1220. <returns><typeparamref name="TEnum"/>'s members' values in increasing value order.</returns>
  1221. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1222. -or-
  1223. <paramref name="selection"/> is an invalid value.</exception>
  1224. </member>
  1225. <member name="M:EnumsNET.Enums.ToObjectUnsafe``1(System.Object,EnumsNET.EnumValidation)">
  1226. <summary>
  1227. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1228. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1229. </summary>
  1230. <typeparam name="TEnum">The enum type.</typeparam>
  1231. <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"/>,
  1232. <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>
  1233. <param name="validation">The validation to perform on the result.</param>
  1234. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  1235. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1236. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1237. -or-
  1238. <paramref name="value"/> is not a valid type
  1239. -or-
  1240. <paramref name="validation"/> is an invalid value
  1241. -or-
  1242. the result is invalid with the specified <paramref name="validation"/>.</exception>
  1243. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  1244. </member>
  1245. <member name="M:EnumsNET.Enums.ToObjectUnsafe``1(System.SByte,EnumsNET.EnumValidation)">
  1246. <summary>
  1247. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1248. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1249. </summary>
  1250. <typeparam name="TEnum">The enum type.</typeparam>
  1251. <param name="value">Value to convert.</param>
  1252. <param name="validation">The validation to perform on the result.</param>
  1253. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  1254. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1255. -or-
  1256. <paramref name="validation"/> is an invalid value
  1257. -or-
  1258. the result is invalid with the specified <paramref name="validation"/>.</exception>
  1259. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  1260. </member>
  1261. <member name="M:EnumsNET.Enums.ToObjectUnsafe``1(System.Byte,EnumsNET.EnumValidation)">
  1262. <summary>
  1263. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1264. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1265. </summary>
  1266. <typeparam name="TEnum">The enum type.</typeparam>
  1267. <param name="value">Value to convert.</param>
  1268. <param name="validation">The validation to perform on the result.</param>
  1269. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  1270. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1271. -or-
  1272. <paramref name="validation"/> is an invalid value
  1273. -or-
  1274. the result is invalid with the specified <paramref name="validation"/>.</exception>
  1275. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  1276. </member>
  1277. <member name="M:EnumsNET.Enums.ToObjectUnsafe``1(System.Int16,EnumsNET.EnumValidation)">
  1278. <summary>
  1279. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1280. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1281. </summary>
  1282. <typeparam name="TEnum">The enum type.</typeparam>
  1283. <param name="value">Value to convert.</param>
  1284. <param name="validation">The validation to perform on the result.</param>
  1285. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  1286. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1287. -or-
  1288. <paramref name="validation"/> is an invalid value
  1289. -or-
  1290. the result is invalid with the specified <paramref name="validation"/>.</exception>
  1291. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  1292. </member>
  1293. <member name="M:EnumsNET.Enums.ToObjectUnsafe``1(System.UInt16,EnumsNET.EnumValidation)">
  1294. <summary>
  1295. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1296. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1297. </summary>
  1298. <typeparam name="TEnum">The enum type.</typeparam>
  1299. <param name="value">Value to convert.</param>
  1300. <param name="validation">The validation to perform on the result.</param>
  1301. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  1302. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1303. -or-
  1304. <paramref name="validation"/> is an invalid value
  1305. -or-
  1306. the result is invalid with the specified <paramref name="validation"/>.</exception>
  1307. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  1308. </member>
  1309. <member name="M:EnumsNET.Enums.ToObjectUnsafe``1(System.Int32,EnumsNET.EnumValidation)">
  1310. <summary>
  1311. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1312. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1313. </summary>
  1314. <typeparam name="TEnum">The enum type.</typeparam>
  1315. <param name="value">Value to convert.</param>
  1316. <param name="validation">The validation to perform on the result.</param>
  1317. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  1318. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1319. -or-
  1320. <paramref name="validation"/> is an invalid value
  1321. -or-
  1322. the result is invalid with the specified <paramref name="validation"/>.</exception>
  1323. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  1324. </member>
  1325. <member name="M:EnumsNET.Enums.ToObjectUnsafe``1(System.UInt32,EnumsNET.EnumValidation)">
  1326. <summary>
  1327. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1328. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1329. </summary>
  1330. <typeparam name="TEnum">The enum type.</typeparam>
  1331. <param name="value">Value to convert.</param>
  1332. <param name="validation">The validation to perform on the result.</param>
  1333. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  1334. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1335. -or-
  1336. <paramref name="validation"/> is an invalid value
  1337. -or-
  1338. the result is invalid with the specified <paramref name="validation"/>.</exception>
  1339. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  1340. </member>
  1341. <member name="M:EnumsNET.Enums.ToObjectUnsafe``1(System.Int64,EnumsNET.EnumValidation)">
  1342. <summary>
  1343. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1344. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1345. </summary>
  1346. <typeparam name="TEnum">The enum type.</typeparam>
  1347. <param name="value">Value to convert.</param>
  1348. <param name="validation">The validation to perform on the result.</param>
  1349. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  1350. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1351. -or-
  1352. <paramref name="validation"/> is an invalid value
  1353. -or-
  1354. the result is invalid with the specified <paramref name="validation"/>.</exception>
  1355. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  1356. </member>
  1357. <member name="M:EnumsNET.Enums.ToObjectUnsafe``1(System.UInt64,EnumsNET.EnumValidation)">
  1358. <summary>
  1359. Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1360. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1361. </summary>
  1362. <typeparam name="TEnum">The enum type.</typeparam>
  1363. <param name="value">Value to convert.</param>
  1364. <param name="validation">The validation to perform on the result.</param>
  1365. <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
  1366. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1367. -or-
  1368. <paramref name="validation"/> is an invalid value
  1369. -or-
  1370. the result is invalid with the specified <paramref name="validation"/>.</exception>
  1371. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  1372. </member>
  1373. <member name="M:EnumsNET.Enums.TryToObjectUnsafe``1(System.Object,``0@,EnumsNET.EnumValidation)">
  1374. <summary>
  1375. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1376. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1377. The return value indicates whether the conversion succeeded.
  1378. </summary>
  1379. <typeparam name="TEnum">The enum type.</typeparam>
  1380. <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"/>,
  1381. <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>
  1382. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  1383. <param name="validation">The validation to perform on the result.</param>
  1384. <returns>Indication whether the conversion succeeded.</returns>
  1385. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1386. -or-
  1387. <paramref name="validation"/> is an invalid value.</exception>
  1388. </member>
  1389. <member name="M:EnumsNET.Enums.TryToObjectUnsafe``1(System.SByte,``0@,EnumsNET.EnumValidation)">
  1390. <summary>
  1391. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1392. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1393. The return value indicates whether the conversion succeeded.
  1394. </summary>
  1395. <typeparam name="TEnum">The enum type.</typeparam>
  1396. <param name="value">Value to try to convert.</param>
  1397. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  1398. <param name="validation">The validation to perform on the result.</param>
  1399. <returns>Indication whether the conversion succeeded.</returns>
  1400. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1401. -or-
  1402. <paramref name="validation"/> is an invalid value.</exception>
  1403. </member>
  1404. <member name="M:EnumsNET.Enums.TryToObjectUnsafe``1(System.Byte,``0@,EnumsNET.EnumValidation)">
  1405. <summary>
  1406. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1407. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1408. The return value indicates whether the conversion succeeded.
  1409. </summary>
  1410. <typeparam name="TEnum">The enum type.</typeparam>
  1411. <param name="value">Value to try to convert.</param>
  1412. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  1413. <param name="validation">The validation to perform on the result.</param>
  1414. <returns>Indication whether the conversion succeeded.</returns>
  1415. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1416. -or-
  1417. <paramref name="validation"/> is an invalid value.</exception>
  1418. </member>
  1419. <member name="M:EnumsNET.Enums.TryToObjectUnsafe``1(System.Int16,``0@,EnumsNET.EnumValidation)">
  1420. <summary>
  1421. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1422. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1423. The return value indicates whether the conversion succeeded.
  1424. </summary>
  1425. <typeparam name="TEnum">The enum type.</typeparam>
  1426. <param name="value">Value to try to convert.</param>
  1427. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  1428. <param name="validation">The validation to perform on the result.</param>
  1429. <returns>Indication whether the conversion succeeded.</returns>
  1430. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1431. -or-
  1432. <paramref name="validation"/> is an invalid value.</exception>
  1433. </member>
  1434. <member name="M:EnumsNET.Enums.TryToObjectUnsafe``1(System.UInt16,``0@,EnumsNET.EnumValidation)">
  1435. <summary>
  1436. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1437. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1438. The return value indicates whether the conversion succeeded.
  1439. </summary>
  1440. <typeparam name="TEnum">The enum type.</typeparam>
  1441. <param name="value">Value to try to convert.</param>
  1442. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  1443. <param name="validation">The validation to perform on the result.</param>
  1444. <returns>Indication whether the conversion succeeded.</returns>
  1445. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1446. -or-
  1447. <paramref name="validation"/> is an invalid value.</exception>
  1448. </member>
  1449. <member name="M:EnumsNET.Enums.TryToObjectUnsafe``1(System.Int32,``0@,EnumsNET.EnumValidation)">
  1450. <summary>
  1451. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1452. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1453. The return value indicates whether the conversion succeeded.
  1454. </summary>
  1455. <typeparam name="TEnum">The enum type.</typeparam>
  1456. <param name="value">Value to try to convert.</param>
  1457. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  1458. <param name="validation">The validation to perform on the result.</param>
  1459. <returns>Indication whether the conversion succeeded.</returns>
  1460. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1461. -or-
  1462. <paramref name="validation"/> is an invalid value.</exception>
  1463. </member>
  1464. <member name="M:EnumsNET.Enums.TryToObjectUnsafe``1(System.UInt32,``0@,EnumsNET.EnumValidation)">
  1465. <summary>
  1466. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1467. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1468. The return value indicates whether the conversion succeeded.
  1469. </summary>
  1470. <typeparam name="TEnum">The enum type.</typeparam>
  1471. <param name="value">Value to try to convert.</param>
  1472. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  1473. <param name="validation">The validation to perform on the result.</param>
  1474. <returns>Indication whether the conversion succeeded.</returns>
  1475. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1476. -or-
  1477. <paramref name="validation"/> is an invalid value.</exception>
  1478. </member>
  1479. <member name="M:EnumsNET.Enums.TryToObjectUnsafe``1(System.Int64,``0@,EnumsNET.EnumValidation)">
  1480. <summary>
  1481. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1482. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1483. The return value indicates whether the conversion succeeded.
  1484. </summary>
  1485. <typeparam name="TEnum">The enum type.</typeparam>
  1486. <param name="value">Value to try to convert.</param>
  1487. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  1488. <param name="validation">The validation to perform on the result.</param>
  1489. <returns>Indication whether the conversion succeeded.</returns>
  1490. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1491. -or-
  1492. <paramref name="validation"/> is an invalid value.</exception>
  1493. </member>
  1494. <member name="M:EnumsNET.Enums.TryToObjectUnsafe``1(System.UInt64,``0@,EnumsNET.EnumValidation)">
  1495. <summary>
  1496. Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
  1497. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  1498. The return value indicates whether the conversion succeeded.
  1499. </summary>
  1500. <typeparam name="TEnum">The enum type.</typeparam>
  1501. <param name="value">Value to try to convert.</param>
  1502. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
  1503. <param name="validation">The validation to perform on the result.</param>
  1504. <returns>Indication whether the conversion succeeded.</returns>
  1505. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1506. -or-
  1507. <paramref name="validation"/> is an invalid value.</exception>
  1508. </member>
  1509. <member name="M:EnumsNET.Enums.IsValidUnsafe``1(``0,EnumsNET.EnumValidation)">
  1510. <summary>
  1511. Indicates if <paramref name="value"/> is valid using the specified <paramref name="validation"/>.
  1512. </summary>
  1513. <typeparam name="TEnum">The enum type.</typeparam>
  1514. <param name="value">The enum value.</param>
  1515. <param name="validation">The validation to perform on the value.</param>
  1516. <returns>Indication if <paramref name="value"/> is valid.</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.IsDefinedUnsafe``1(``0)">
  1522. <summary>
  1523. Indicates if <paramref name="value"/> is defined.
  1524. </summary>
  1525. <typeparam name="TEnum">The enum type.</typeparam>
  1526. <param name="value">The enum value.</param>
  1527. <returns>Indication if <paramref name="value"/> is defined.</returns>
  1528. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1529. </member>
  1530. <member name="M:EnumsNET.Enums.ValidateUnsafe``1(``0,System.String,EnumsNET.EnumValidation)">
  1531. <summary>
  1532. Validates that <paramref name="value"/> is valid using the specified <paramref name="validation"/>.
  1533. If it's not it throws an <see cref="T:System.ArgumentException"/> with the specified <paramref name="paramName"/>.
  1534. </summary>
  1535. <typeparam name="TEnum">The enum type.</typeparam>
  1536. <param name="value">The enum value.</param>
  1537. <param name="paramName">The parameter name to be used if throwing an <see cref="T:System.ArgumentException"/>.</param>
  1538. <param name="validation">The validation to perform on the value.</param>
  1539. <returns><paramref name="value"/> for use in fluent API's and base constructor method calls.</returns>
  1540. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1541. -or-
  1542. <paramref name="validation"/> is an invalid value
  1543. -or-
  1544. <paramref name="value"/> is invalid.</exception>
  1545. </member>
  1546. <member name="M:EnumsNET.Enums.AsStringUnsafe``1(``0)">
  1547. <summary>
  1548. Converts the specified <paramref name="value"/> to its string representation.
  1549. </summary>
  1550. <typeparam name="TEnum">The enum type.</typeparam>
  1551. <param name="value">The enum value.</param>
  1552. <returns>A string representation of <paramref name="value"/>.</returns>
  1553. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1554. </member>
  1555. <member name="M:EnumsNET.Enums.AsStringUnsafe``1(``0,System.String)">
  1556. <summary>
  1557. Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="format"/>.
  1558. </summary>
  1559. <typeparam name="TEnum">The enum type.</typeparam>
  1560. <param name="value">The enum value.</param>
  1561. <param name="format">The output format to use.</param>
  1562. <returns>A string representation of <paramref name="value"/>.</returns>
  1563. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1564. <exception cref="T:System.FormatException"><paramref name="format"/> is an invalid value.</exception>
  1565. </member>
  1566. <member name="M:EnumsNET.Enums.AsStringUnsafe``1(``0,EnumsNET.EnumFormat)">
  1567. <summary>
  1568. Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="format"/>.
  1569. </summary>
  1570. <typeparam name="TEnum">The enum type.</typeparam>
  1571. <param name="value">The enum value.</param>
  1572. <param name="format">The output format to use.</param>
  1573. <returns>A string representation of <paramref name="value"/>.</returns>
  1574. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1575. -or-
  1576. <paramref name="format"/> is an invalid value.</exception>
  1577. </member>
  1578. <member name="M:EnumsNET.Enums.AsStringUnsafe``1(``0,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  1579. <summary>
  1580. Converts the specified <paramref name="value"/> to its string representation using the specified formats.
  1581. </summary>
  1582. <typeparam name="TEnum">The enum type.</typeparam>
  1583. <param name="value">The enum value.</param>
  1584. <param name="format0">The first output format to use.</param>
  1585. <param name="format1">The second output format to use if using the first resolves to <c>null</c>.</param>
  1586. <returns>A string representation of <paramref name="value"/>.</returns>
  1587. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1588. -or-
  1589. <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  1590. </member>
  1591. <member name="M:EnumsNET.Enums.AsStringUnsafe``1(``0,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  1592. <summary>
  1593. Converts the specified <paramref name="value"/> to its string representation using the specified formats.
  1594. </summary>
  1595. <typeparam name="TEnum">The enum type.</typeparam>
  1596. <param name="value">The enum value.</param>
  1597. <param name="format0">The first output format to use.</param>
  1598. <param name="format1">The second output format to use if using the first resolves to <c>null</c>.</param>
  1599. <param name="format2">The third output format to use if using the first and second both resolve to <c>null</c>.</param>
  1600. <returns>A string representation of <paramref name="value"/>.</returns>
  1601. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1602. -or-
  1603. <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  1604. </member>
  1605. <member name="M:EnumsNET.Enums.AsStringUnsafe``1(``0,EnumsNET.EnumFormat[])">
  1606. <summary>
  1607. Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="formats"/>.
  1608. </summary>
  1609. <typeparam name="TEnum">The enum type.</typeparam>
  1610. <param name="value">The enum value.</param>
  1611. <param name="formats">The output formats to use.</param>
  1612. <returns>A string representation of <paramref name="value"/>.</returns>
  1613. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1614. -or-
  1615. <paramref name="formats"/> contains an invalid value.</exception>
  1616. </member>
  1617. <member name="M:EnumsNET.Enums.FormatUnsafe``1(``0,System.String)">
  1618. <summary>
  1619. Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="format"/>.
  1620. </summary>
  1621. <typeparam name="TEnum">The enum type.</typeparam>
  1622. <param name="value">The enum value.</param>
  1623. <param name="format">The output format to use.</param>
  1624. <returns>A string representation of <paramref name="value"/>.</returns>
  1625. <exception cref="T:System.ArgumentNullException"><paramref name="format"/> is <c>null</c>.</exception>
  1626. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1627. <exception cref="T:System.FormatException"><paramref name="format"/> is an invalid value.</exception>
  1628. </member>
  1629. <member name="M:EnumsNET.Enums.GetUnderlyingValueUnsafe``1(``0)">
  1630. <summary>
  1631. Returns <paramref name="value"/>'s underlying integral value.
  1632. </summary>
  1633. <typeparam name="TEnum">The enum type.</typeparam>
  1634. <param name="value">The enum value.</param>
  1635. <returns><paramref name="value"/>'s underlying integral value.</returns>
  1636. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1637. </member>
  1638. <member name="M:EnumsNET.Enums.ToSByteUnsafe``1(``0)">
  1639. <summary>
  1640. Converts <paramref name="value"/> to an <see cref="T:System.SByte"/>.
  1641. </summary>
  1642. <typeparam name="TEnum">The enum type.</typeparam>
  1643. <param name="value">The enum value.</param>
  1644. <returns><paramref name="value"/> converted to an <see cref="T:System.SByte"/>.</returns>
  1645. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1646. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.SByte"/>'s value range without overflowing.</exception>
  1647. </member>
  1648. <member name="M:EnumsNET.Enums.ToByteUnsafe``1(``0)">
  1649. <summary>
  1650. Converts <paramref name="value"/> to a <see cref="T:System.Byte"/>.
  1651. </summary>
  1652. <typeparam name="TEnum">The enum type.</typeparam>
  1653. <param name="value">The enum value.</param>
  1654. <returns><paramref name="value"/> converted to a <see cref="T:System.Byte"/>.</returns>
  1655. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1656. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Byte"/>'s value range without overflowing.</exception>
  1657. </member>
  1658. <member name="M:EnumsNET.Enums.ToInt16Unsafe``1(``0)">
  1659. <summary>
  1660. Converts <paramref name="value"/> to an <see cref="T:System.Int16"/>.
  1661. </summary>
  1662. <typeparam name="TEnum">The enum type.</typeparam>
  1663. <param name="value">The enum value.</param>
  1664. <returns><paramref name="value"/> converted to an <see cref="T:System.Int16"/>.</returns>
  1665. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1666. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Int16"/>'s value range without overflowing.</exception>
  1667. </member>
  1668. <member name="M:EnumsNET.Enums.ToUInt16Unsafe``1(``0)">
  1669. <summary>
  1670. Converts <paramref name="value"/> to a <see cref="T:System.UInt16"/>.
  1671. </summary>
  1672. <typeparam name="TEnum">The enum type.</typeparam>
  1673. <param name="value">The enum value.</param>
  1674. <returns><paramref name="value"/> converted to a <see cref="T:System.UInt16"/>.</returns>
  1675. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1676. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.UInt16"/>'s value range without overflowing.</exception>
  1677. </member>
  1678. <member name="M:EnumsNET.Enums.ToInt32Unsafe``1(``0)">
  1679. <summary>
  1680. Converts <paramref name="value"/> to an <see cref="T:System.Int32"/>.
  1681. </summary>
  1682. <typeparam name="TEnum">The enum type.</typeparam>
  1683. <param name="value">The enum value.</param>
  1684. <returns><paramref name="value"/> converted to an <see cref="T:System.Int32"/>.</returns>
  1685. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1686. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Int32"/>'s value range without overflowing.</exception>
  1687. </member>
  1688. <member name="M:EnumsNET.Enums.ToUInt32Unsafe``1(``0)">
  1689. <summary>
  1690. Converts <paramref name="value"/> to a <see cref="T:System.UInt32"/>.
  1691. </summary>
  1692. <typeparam name="TEnum">The enum type.</typeparam>
  1693. <param name="value">The enum value.</param>
  1694. <returns><paramref name="value"/> converted to a <see cref="T:System.UInt32"/>.</returns>
  1695. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1696. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.UInt32"/>'s value range without overflowing.</exception>
  1697. </member>
  1698. <member name="M:EnumsNET.Enums.ToInt64Unsafe``1(``0)">
  1699. <summary>
  1700. Converts <paramref name="value"/> to an <see cref="T:System.Int64"/>.
  1701. </summary>
  1702. <typeparam name="TEnum">The enum type.</typeparam>
  1703. <param name="value">The enum value.</param>
  1704. <returns><paramref name="value"/> converted to an <see cref="T:System.Int64"/>.</returns>
  1705. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1706. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Int64"/>'s value range without overflowing.</exception>
  1707. </member>
  1708. <member name="M:EnumsNET.Enums.ToUInt64Unsafe``1(``0)">
  1709. <summary>
  1710. Converts <paramref name="value"/> to a <see cref="T:System.UInt64"/>.
  1711. </summary>
  1712. <typeparam name="TEnum">The enum type.</typeparam>
  1713. <param name="value">The enum value.</param>
  1714. <returns><paramref name="value"/> converted to a <see cref="T:System.UInt64"/>.</returns>
  1715. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1716. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.UInt64"/>'s value range without overflowing.</exception>
  1717. </member>
  1718. <member name="M:EnumsNET.Enums.GetHashCodeUnsafe``1(``0)">
  1719. <summary>
  1720. Retrieves the hash code of <paramref name="value"/>. It's more efficient as it doesn't require boxing and unboxing of <paramref name="value"/>.
  1721. </summary>
  1722. <typeparam name="TEnum">The enum type.</typeparam>
  1723. <param name="value">The enum value.</param>
  1724. <returns>Hash code of <paramref name="value"/>.</returns>
  1725. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1726. </member>
  1727. <member name="M:EnumsNET.Enums.EqualsUnsafe``1(``0,``0)">
  1728. <summary>
  1729. Indicates if <paramref name="value"/> equals <paramref name="other"/>.
  1730. </summary>
  1731. <typeparam name="TEnum">The enum type.</typeparam>
  1732. <param name="value">The enum value.</param>
  1733. <param name="other">The other enum value.</param>
  1734. <returns>Indication if <paramref name="value"/> equals <paramref name="other"/>.</returns>
  1735. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1736. </member>
  1737. <member name="M:EnumsNET.Enums.CompareToUnsafe``1(``0,``0)">
  1738. <summary>
  1739. Compares <paramref name="value"/> to <paramref name="other"/> for ordering.
  1740. </summary>
  1741. <typeparam name="TEnum">The enum type.</typeparam>
  1742. <param name="value">The enum value.</param>
  1743. <param name="other">The other enum value.</param>
  1744. <returns>1 if <paramref name="value"/> is greater than <paramref name="other"/>, 0 if <paramref name="value"/> equals <paramref name="other"/>,
  1745. and -1 if <paramref name="value"/> is less than <paramref name="other"/>.</returns>
  1746. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1747. </member>
  1748. <member name="M:EnumsNET.Enums.GetNameUnsafe``1(``0)">
  1749. <summary>
  1750. Retrieves <paramref name="value"/>'s enum member name if defined otherwise <c>null</c>.
  1751. </summary>
  1752. <typeparam name="TEnum">The enum type.</typeparam>
  1753. <param name="value">The enum value.</param>
  1754. <returns><paramref name="value"/>'s enum member name if defined otherwise <c>null</c>.</returns>
  1755. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1756. </member>
  1757. <member name="M:EnumsNET.Enums.GetAttributesUnsafe``1(``0)">
  1758. <summary>
  1759. Retrieves <paramref name="value"/>'s enum member attributes if defined otherwise <c>null</c>.
  1760. </summary>
  1761. <typeparam name="TEnum">The enum type.</typeparam>
  1762. <param name="value">The enum value.</param>
  1763. <returns><paramref name="value"/>'s enum member attributes if defined otherwise <c>null</c>.</returns>
  1764. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1765. </member>
  1766. <member name="M:EnumsNET.Enums.GetMemberUnsafe``1(``0)">
  1767. <summary>
  1768. Retrieves an enum member with the specified <paramref name="value"/> if defined otherwise <c>null</c>.
  1769. </summary>
  1770. <typeparam name="TEnum">The enum type.</typeparam>
  1771. <param name="value">The enum value.</param>
  1772. <returns>Enum member with the specified <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
  1773. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1774. </member>
  1775. <member name="M:EnumsNET.Enums.GetMemberUnsafe``1(System.String)">
  1776. <summary>
  1777. Retrieves the enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.
  1778. Is case-sensitive.
  1779. </summary>
  1780. <typeparam name="TEnum">The enum type.</typeparam>
  1781. <param name="name">The enum member name.</param>
  1782. <returns>Enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.</returns>
  1783. <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <c>null</c>.</exception>
  1784. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1785. </member>
  1786. <member name="M:EnumsNET.Enums.GetMemberUnsafe``1(System.String,System.Boolean)">
  1787. <summary>
  1788. Retrieves the enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.
  1789. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  1790. </summary>
  1791. <typeparam name="TEnum">The enum type.</typeparam>
  1792. <param name="name">The enum member name.</param>
  1793. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1794. <returns>Enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.</returns>
  1795. <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <c>null</c>.</exception>
  1796. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1797. </member>
  1798. <member name="M:EnumsNET.Enums.GetMemberUnsafe``1(System.String,System.Boolean,EnumsNET.EnumFormat)">
  1799. <summary>
  1800. Retrieves an enum member whose string representation using the specified <paramref name="format"/> is <paramref name="value"/> if defined otherwise <c>null</c>.
  1801. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  1802. </summary>
  1803. <typeparam name="TEnum">The enum type.</typeparam>
  1804. <param name="value">The enum member's string representation.</param>
  1805. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1806. <param name="format">The parsing enum format.</param>
  1807. <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
  1808. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1809. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1810. -or-
  1811. <paramref name="format"/> is an invalid value.</exception>
  1812. </member>
  1813. <member name="M:EnumsNET.Enums.GetMemberUnsafe``1(System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  1814. <summary>
  1815. Retrieves an enum member whose string representation using the specified formats is <paramref name="value"/> if defined otherwise <c>null</c>.
  1816. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  1817. </summary>
  1818. <typeparam name="TEnum">The enum type.</typeparam>
  1819. <param name="value">The enum member's string representation.</param>
  1820. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1821. <param name="format0">The first parsing enum format.</param>
  1822. <param name="format1">The second parsing enum format.</param>
  1823. <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
  1824. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1825. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1826. -or-
  1827. <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  1828. </member>
  1829. <member name="M:EnumsNET.Enums.GetMemberUnsafe``1(System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  1830. <summary>
  1831. Retrieves an enum member whose string representation using the specified formats is <paramref name="value"/> if defined otherwise <c>null</c>.
  1832. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  1833. </summary>
  1834. <typeparam name="TEnum">The enum type.</typeparam>
  1835. <param name="value">The enum member's string representation.</param>
  1836. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1837. <param name="format0">The first parsing enum format.</param>
  1838. <param name="format1">The second parsing enum format.</param>
  1839. <param name="format2">The third parsing enum format.</param>
  1840. <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
  1841. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1842. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1843. -or-
  1844. <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  1845. </member>
  1846. <member name="M:EnumsNET.Enums.GetMemberUnsafe``1(System.String,System.Boolean,EnumsNET.EnumFormat[])">
  1847. <summary>
  1848. Retrieves an enum member whose string representation using the specified <paramref name="formats"/> is <paramref name="value"/> if defined otherwise <c>null</c>.
  1849. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  1850. </summary>
  1851. <typeparam name="TEnum">The enum type.</typeparam>
  1852. <param name="value">The enum member's string representation.</param>
  1853. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1854. <param name="formats">The parsing enum formats.</param>
  1855. <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
  1856. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1857. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1858. -or-
  1859. <paramref name="formats"/> contains an invalid value.</exception>
  1860. </member>
  1861. <member name="M:EnumsNET.Enums.ParseUnsafe``1(System.String)">
  1862. <summary>
  1863. Converts the string representation of one or more member names or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value.
  1864. </summary>
  1865. <typeparam name="TEnum">The enum type.</typeparam>
  1866. <param name="value">The enum member names or values' string representation.</param>
  1867. <returns>A <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  1868. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1869. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1870. -or-
  1871. <paramref name="value"/> doesn't represent a member name or value of <typeparamref name="TEnum"/>.</exception>
  1872. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of <typeparamref name="TEnum"/>'s underlying type.</exception>
  1873. </member>
  1874. <member name="M:EnumsNET.Enums.ParseUnsafe``1(System.String,System.Boolean)">
  1875. <summary>
  1876. Converts the string representation of one or more member names or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value.
  1877. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  1878. </summary>
  1879. <typeparam name="TEnum">The enum type.</typeparam>
  1880. <param name="value">The enum member names or values' string representation.</param>
  1881. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1882. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  1883. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1884. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1885. -or-
  1886. <paramref name="value"/> doesn't represent a member name or value of <typeparamref name="TEnum"/>.</exception>
  1887. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  1888. </member>
  1889. <member name="M:EnumsNET.Enums.ParseUnsafe``1(System.String,System.Boolean,EnumsNET.EnumFormat)">
  1890. <summary>
  1891. Converts the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
  1892. using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  1893. </summary>
  1894. <typeparam name="TEnum">The enum type.</typeparam>
  1895. <param name="value">The enum members or values' string representation.</param>
  1896. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1897. <param name="format">The parsing enum format.</param>
  1898. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  1899. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1900. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1901. -or-
  1902. <paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
  1903. -or-
  1904. <paramref name="format"/> is an invalid value.</exception>
  1905. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  1906. </member>
  1907. <member name="M:EnumsNET.Enums.ParseUnsafe``1(System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  1908. <summary>
  1909. Converts the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
  1910. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  1911. </summary>
  1912. <typeparam name="TEnum">The enum type.</typeparam>
  1913. <param name="value">The enum members or values' string representation.</param>
  1914. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1915. <param name="format0">The first parsing enum format.</param>
  1916. <param name="format1">The second parsing enum format.</param>
  1917. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  1918. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1919. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1920. -or-
  1921. <paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
  1922. -or-
  1923. <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  1924. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  1925. </member>
  1926. <member name="M:EnumsNET.Enums.ParseUnsafe``1(System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  1927. <summary>
  1928. Converts the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
  1929. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  1930. </summary>
  1931. <typeparam name="TEnum">The enum type.</typeparam>
  1932. <param name="value">The enum members or values' string representation.</param>
  1933. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1934. <param name="format0">The first parsing enum format.</param>
  1935. <param name="format1">The second parsing enum format.</param>
  1936. <param name="format2">The third parsing enum format.</param>
  1937. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  1938. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1939. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1940. -or-
  1941. <paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
  1942. -or-
  1943. <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  1944. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  1945. </member>
  1946. <member name="M:EnumsNET.Enums.ParseUnsafe``1(System.String,System.Boolean,EnumsNET.EnumFormat[])">
  1947. <summary>
  1948. Converts the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
  1949. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  1950. </summary>
  1951. <typeparam name="TEnum">The enum type.</typeparam>
  1952. <param name="value">The enum members or values' string representation.</param>
  1953. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1954. <param name="formats">The parsing enum formats.</param>
  1955. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  1956. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  1957. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  1958. -or-
  1959. <paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
  1960. -or-
  1961. <paramref name="formats"/> contains an invalid value.</exception>
  1962. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  1963. </member>
  1964. <member name="M:EnumsNET.Enums.TryParseUnsafe``1(System.String,``0@)">
  1965. <summary>
  1966. 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.
  1967. The return value indicates whether the conversion succeeded.
  1968. </summary>
  1969. <typeparam name="TEnum">The enum type.</typeparam>
  1970. <param name="value">The enum member names or values' string representation.</param>
  1971. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  1972. <returns>Indication whether the conversion succeeded.</returns>
  1973. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1974. </member>
  1975. <member name="M:EnumsNET.Enums.TryParseUnsafe``1(System.String,System.Boolean,``0@)">
  1976. <summary>
  1977. 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.
  1978. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive. The return value indicates whether the conversion succeeded.
  1979. </summary>
  1980. <typeparam name="TEnum">The enum type.</typeparam>
  1981. <param name="value">The enum member names or values' string representation.</param>
  1982. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1983. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  1984. <returns>Indication whether the conversion succeeded.</returns>
  1985. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  1986. </member>
  1987. <member name="M:EnumsNET.Enums.TryParseUnsafe``1(System.String,System.Boolean,``0@,EnumsNET.EnumFormat)">
  1988. <summary>
  1989. Tries to convert the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
  1990. using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  1991. The return value indicates whether the conversion succeeded.
  1992. </summary>
  1993. <typeparam name="TEnum">The enum type.</typeparam>
  1994. <param name="value">The enum members or values' string representation.</param>
  1995. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  1996. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  1997. <param name="format">The parsing enum format.</param>
  1998. <returns>Indication whether the conversion succeeded.</returns>
  1999. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  2000. -or-
  2001. <paramref name="format"/> is an invalid value.</exception>
  2002. </member>
  2003. <member name="M:EnumsNET.Enums.TryParseUnsafe``1(System.String,System.Boolean,``0@,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  2004. <summary>
  2005. Tries to convert the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
  2006. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  2007. The return value indicates whether the conversion succeeded.
  2008. </summary>
  2009. <typeparam name="TEnum">The enum type.</typeparam>
  2010. <param name="value">The enum members or values' string representation.</param>
  2011. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  2012. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  2013. <param name="format0">The first parsing enum format.</param>
  2014. <param name="format1">The second parsing enum format.</param>
  2015. <returns>Indication whether the conversion succeeded.</returns>
  2016. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  2017. -or-
  2018. <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  2019. </member>
  2020. <member name="M:EnumsNET.Enums.TryParseUnsafe``1(System.String,System.Boolean,``0@,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  2021. <summary>
  2022. Tries to convert the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
  2023. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  2024. The return value indicates whether the conversion succeeded.
  2025. </summary>
  2026. <typeparam name="TEnum">The enum type.</typeparam>
  2027. <param name="value">The enum members or values' string representation.</param>
  2028. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  2029. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  2030. <param name="format0">The first parsing enum format.</param>
  2031. <param name="format1">The second parsing enum format.</param>
  2032. <param name="format2">The third parsing enum format.</param>
  2033. <returns>Indication whether the conversion succeeded.</returns>
  2034. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  2035. -or-
  2036. <paramref name="format0"/>, <paramref name="format1"/>, <paramref name="format2"/> is an invalid value.</exception>
  2037. </member>
  2038. <member name="M:EnumsNET.Enums.TryParseUnsafe``1(System.String,System.Boolean,``0@,EnumsNET.EnumFormat[])">
  2039. <summary>
  2040. Tries to convert the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
  2041. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  2042. The return value indicates whether the conversion succeeded.
  2043. </summary>
  2044. <typeparam name="TEnum">The enum type.</typeparam>
  2045. <param name="value">The enum members or values' string representation.</param>
  2046. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  2047. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  2048. <param name="formats">The parsing enum formats.</param>
  2049. <returns>Indication whether the conversion succeeded.</returns>
  2050. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  2051. -or-
  2052. <paramref name="formats"/> contains an invalid value.</exception>
  2053. </member>
  2054. <member name="M:EnumsNET.Enums.GetUnderlyingType(System.Type)">
  2055. <summary>
  2056. Retrieves the underlying type of <paramref name="enumType"/>.
  2057. </summary>
  2058. <param name="enumType">The enum type.</param>
  2059. <returns>The underlying type of <paramref name="enumType"/>.</returns>
  2060. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2061. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
  2062. </member>
  2063. <member name="M:EnumsNET.Enums.GetMemberCount(System.Type,EnumsNET.EnumMemberSelection)">
  2064. <summary>
  2065. Retrieves <paramref name="enumType"/>'s member count.
  2066. The parameter <paramref name="selection"/> indicates what members to include.
  2067. </summary>
  2068. <param name="enumType">The enum type.</param>
  2069. <param name="selection">Indicates what members to include.</param>
  2070. <returns><paramref name="enumType"/>'s member count.</returns>
  2071. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2072. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2073. -or-
  2074. <paramref name="selection"/> is an invalid value.</exception>
  2075. </member>
  2076. <member name="M:EnumsNET.Enums.GetMembers(System.Type,EnumsNET.EnumMemberSelection)">
  2077. <summary>
  2078. Retrieves <paramref name="enumType"/>'s members in increasing value order.
  2079. The parameter <paramref name="selection"/> indicates what members to include.
  2080. </summary>
  2081. <param name="enumType">The enum type.</param>
  2082. <param name="selection">Indicates what members to include.</param>
  2083. <returns><paramref name="enumType"/>'s members in increasing value order.</returns>
  2084. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2085. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2086. -or-
  2087. <paramref name="selection"/> is an invalid value.</exception>
  2088. </member>
  2089. <member name="M:EnumsNET.Enums.GetNames(System.Type,EnumsNET.EnumMemberSelection)">
  2090. <summary>
  2091. Retrieves <paramref name="enumType"/>'s members' names in increasing value order.
  2092. The parameter <paramref name="selection"/> indicates what members to include.
  2093. </summary>
  2094. <param name="enumType">The enum type.</param>
  2095. <param name="selection">Indicates what members to include.</param>
  2096. <returns><paramref name="enumType"/>'s members' names in increasing value order.</returns>
  2097. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2098. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2099. -or-
  2100. <paramref name="selection"/> is an invalid value.</exception>
  2101. </member>
  2102. <member name="M:EnumsNET.Enums.GetValues(System.Type,EnumsNET.EnumMemberSelection)">
  2103. <summary>
  2104. Retrieves <paramref name="enumType"/>'s members' values in increasing value order.
  2105. The parameter <paramref name="selection"/> indicates what members to include.
  2106. </summary>
  2107. <param name="enumType">The enum type.</param>
  2108. <param name="selection">Indicates what members to include.</param>
  2109. <returns><paramref name="enumType"/>'s members' values in increasing value order.</returns>
  2110. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2111. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2112. -or-
  2113. <paramref name="selection"/> is an invalid value.</exception>
  2114. </member>
  2115. <member name="M:EnumsNET.Enums.ToObject(System.Type,System.Object,EnumsNET.EnumValidation)">
  2116. <summary>
  2117. Converts the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2118. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2119. </summary>
  2120. <param name="enumType">The enum type.</param>
  2121. <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"/>,
  2122. <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>
  2123. <param name="validation">The validation to perform on the result.</param>
  2124. <returns>The specified <paramref name="value"/> converted to a <paramref name="enumType"/>.</returns>
  2125. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2126. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2127. -or-
  2128. <paramref name="value"/> is not a valid type
  2129. -or-
  2130. <paramref name="validation"/> is an invalid value
  2131. -or-
  2132. the result is invalid with the specified <paramref name="validation"/>.</exception>
  2133. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  2134. </member>
  2135. <member name="M:EnumsNET.Enums.ToObject(System.Type,System.SByte,EnumsNET.EnumValidation)">
  2136. <summary>
  2137. Converts the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2138. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2139. </summary>
  2140. <param name="enumType">The enum type.</param>
  2141. <param name="value">Value to convert.</param>
  2142. <param name="validation">The validation to perform on the result.</param>
  2143. <returns>The specified <paramref name="value"/> converted to a <paramref name="enumType"/>.</returns>
  2144. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="enumType"/> is <c>null</c>.</exception>
  2145. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2146. -or-
  2147. <paramref name="validation"/> is an invalid value
  2148. -or-
  2149. the result is invalid with the specified <paramref name="validation"/>.</exception>
  2150. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  2151. </member>
  2152. <member name="M:EnumsNET.Enums.ToObject(System.Type,System.Byte,EnumsNET.EnumValidation)">
  2153. <summary>
  2154. Converts the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2155. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2156. </summary>
  2157. <param name="enumType">The enum type.</param>
  2158. <param name="value">Value to convert.</param>
  2159. <param name="validation">The validation to perform on the result.</param>
  2160. <returns>The specified <paramref name="value"/> converted to a <paramref name="enumType"/>.</returns>
  2161. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2162. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2163. -or-
  2164. <paramref name="validation"/> is an invalid value
  2165. -or-
  2166. the result is invalid with the specified <paramref name="validation"/>.</exception>
  2167. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  2168. </member>
  2169. <member name="M:EnumsNET.Enums.ToObject(System.Type,System.Int16,EnumsNET.EnumValidation)">
  2170. <summary>
  2171. Converts the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2172. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2173. </summary>
  2174. <param name="enumType">The enum type.</param>
  2175. <param name="value">Value to convert.</param>
  2176. <param name="validation">The validation to perform on the result.</param>
  2177. <returns>The specified <paramref name="value"/> converted to a <paramref name="enumType"/>.</returns>
  2178. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2179. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2180. -or-
  2181. <paramref name="validation"/> is an invalid value
  2182. -or-
  2183. the result is invalid with the specified <paramref name="validation"/>.</exception>
  2184. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  2185. </member>
  2186. <member name="M:EnumsNET.Enums.ToObject(System.Type,System.UInt16,EnumsNET.EnumValidation)">
  2187. <summary>
  2188. Converts the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2189. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2190. </summary>
  2191. <param name="enumType">The enum type.</param>
  2192. <param name="value">Value to convert.</param>
  2193. <param name="validation">The validation to perform on the result.</param>
  2194. <returns>The specified <paramref name="value"/> converted to a <paramref name="enumType"/>.</returns>
  2195. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2196. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2197. -or-
  2198. <paramref name="validation"/> is an invalid value
  2199. -or-
  2200. the result is invalid with the specified <paramref name="validation"/>.</exception>
  2201. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  2202. </member>
  2203. <member name="M:EnumsNET.Enums.ToObject(System.Type,System.Int32,EnumsNET.EnumValidation)">
  2204. <summary>
  2205. Converts the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2206. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2207. </summary>
  2208. <param name="enumType">The enum type.</param>
  2209. <param name="value">Value to convert.</param>
  2210. <param name="validation">The validation to perform on the result.</param>
  2211. <returns>The specified <paramref name="value"/> converted to a <paramref name="enumType"/>.</returns>
  2212. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2213. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2214. -or-
  2215. <paramref name="validation"/> is an invalid value
  2216. -or-
  2217. the result is invalid with the specified <paramref name="validation"/>.</exception>
  2218. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  2219. </member>
  2220. <member name="M:EnumsNET.Enums.ToObject(System.Type,System.UInt32,EnumsNET.EnumValidation)">
  2221. <summary>
  2222. Converts the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2223. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2224. </summary>
  2225. <param name="enumType">The enum type.</param>
  2226. <param name="value">Value to convert.</param>
  2227. <param name="validation">The validation to perform on the result.</param>
  2228. <returns>The specified <paramref name="value"/> converted to a <paramref name="enumType"/>.</returns>
  2229. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2230. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2231. -or-
  2232. <paramref name="validation"/> is an invalid value
  2233. -or-
  2234. the result is invalid with the specified <paramref name="validation"/>.</exception>
  2235. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  2236. </member>
  2237. <member name="M:EnumsNET.Enums.ToObject(System.Type,System.Int64,EnumsNET.EnumValidation)">
  2238. <summary>
  2239. Converts the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2240. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2241. </summary>
  2242. <param name="enumType">The enum type.</param>
  2243. <param name="value">Value to convert.</param>
  2244. <param name="validation">The validation to perform on the result.</param>
  2245. <returns>The specified <paramref name="value"/> converted to a <paramref name="enumType"/>.</returns>
  2246. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2247. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2248. -or-
  2249. <paramref name="validation"/> is an invalid value
  2250. -or-
  2251. the result is invalid with the specified <paramref name="validation"/>.</exception>
  2252. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  2253. </member>
  2254. <member name="M:EnumsNET.Enums.ToObject(System.Type,System.UInt64,EnumsNET.EnumValidation)">
  2255. <summary>
  2256. Converts the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2257. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2258. </summary>
  2259. <param name="enumType">The enum type.</param>
  2260. <param name="value">Value to convert.</param>
  2261. <param name="validation">The validation to perform on the result.</param>
  2262. <returns>The specified <paramref name="value"/> converted to a <paramref name="enumType"/>.</returns>
  2263. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2264. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2265. -or-
  2266. <paramref name="validation"/> is an invalid value
  2267. -or-
  2268. the result is invalid with the specified <paramref name="validation"/>.</exception>
  2269. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
  2270. </member>
  2271. <member name="M:EnumsNET.Enums.TryToObject(System.Type,System.Object,System.Object@,EnumsNET.EnumValidation)">
  2272. <summary>
  2273. Tries to convert the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2274. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2275. The return value indicates whether the conversion succeeded.
  2276. </summary>
  2277. <param name="enumType">The enum type.</param>
  2278. <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"/>,
  2279. <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>
  2280. <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> whose value is <paramref name="value"/>.</param>
  2281. <param name="validation">The validation to perform on the result.</param>
  2282. <returns>Indication whether the conversion succeeded.</returns>
  2283. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2284. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2285. -or-
  2286. <paramref name="validation"/> is an invalid value.</exception>
  2287. </member>
  2288. <member name="M:EnumsNET.Enums.TryToObject(System.Type,System.SByte,System.Object@,EnumsNET.EnumValidation)">
  2289. <summary>
  2290. Tries to convert the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2291. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2292. The return value indicates whether the conversion succeeded.
  2293. </summary>
  2294. <param name="enumType">The enum type.</param>
  2295. <param name="value">Value to try to convert.</param>
  2296. <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> whose value is <paramref name="value"/>.</param>
  2297. <param name="validation">The validation to perform on the result.</param>
  2298. <returns>Indication whether the conversion succeeded.</returns>
  2299. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2300. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2301. -or-
  2302. <paramref name="validation"/> is an invalid value.</exception>
  2303. </member>
  2304. <member name="M:EnumsNET.Enums.TryToObject(System.Type,System.Byte,System.Object@,EnumsNET.EnumValidation)">
  2305. <summary>
  2306. Tries to convert the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2307. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2308. The return value indicates whether the conversion succeeded.
  2309. </summary>
  2310. <param name="enumType">The enum type.</param>
  2311. <param name="value">Value to try to convert.</param>
  2312. <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> whose value is <paramref name="value"/>.</param>
  2313. <param name="validation">The validation to perform on the result.</param>
  2314. <returns>Indication whether the conversion succeeded.</returns>
  2315. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2316. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2317. -or-
  2318. <paramref name="validation"/> is an invalid value.</exception>
  2319. </member>
  2320. <member name="M:EnumsNET.Enums.TryToObject(System.Type,System.Int16,System.Object@,EnumsNET.EnumValidation)">
  2321. <summary>
  2322. Tries to convert 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. The return value indicates whether the conversion succeeded.
  2325. </summary>
  2326. <param name="enumType">The enum type.</param>
  2327. <param name="value">Value to try to convert.</param>
  2328. <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> whose value is <paramref name="value"/>.</param>
  2329. <param name="validation">The validation to perform on the result.</param>
  2330. <returns>Indication whether the conversion succeeded.</returns>
  2331. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2332. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2333. -or-
  2334. <paramref name="validation"/> is an invalid value.</exception>
  2335. </member>
  2336. <member name="M:EnumsNET.Enums.TryToObject(System.Type,System.UInt16,System.Object@,EnumsNET.EnumValidation)">
  2337. <summary>
  2338. Tries to convert the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2339. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2340. The return value indicates whether the conversion succeeded.
  2341. </summary>
  2342. <param name="enumType">The enum type.</param>
  2343. <param name="value">Value to try to convert.</param>
  2344. <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> whose value is <paramref name="value"/>.</param>
  2345. <param name="validation">The validation to perform on the result.</param>
  2346. <returns>Indication whether the conversion succeeded.</returns>
  2347. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2348. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2349. -or-
  2350. <paramref name="validation"/> is an invalid value.</exception>
  2351. </member>
  2352. <member name="M:EnumsNET.Enums.TryToObject(System.Type,System.Int32,System.Object@,EnumsNET.EnumValidation)">
  2353. <summary>
  2354. Tries to convert the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2355. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2356. The return value indicates whether the conversion succeeded.
  2357. </summary>
  2358. <param name="enumType">The enum type.</param>
  2359. <param name="value">Value to try to convert.</param>
  2360. <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> whose value is <paramref name="value"/>.</param>
  2361. <param name="validation">The validation to perform on the result.</param>
  2362. <returns>Indication whether the conversion succeeded.</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.</exception>
  2367. </member>
  2368. <member name="M:EnumsNET.Enums.TryToObject(System.Type,System.UInt32,System.Object@,EnumsNET.EnumValidation)">
  2369. <summary>
  2370. Tries to convert the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2371. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2372. The return value indicates whether the conversion succeeded.
  2373. </summary>
  2374. <param name="enumType">The enum type.</param>
  2375. <param name="value">Value to try to convert.</param>
  2376. <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> whose value is <paramref name="value"/>.</param>
  2377. <param name="validation">The validation to perform on the result.</param>
  2378. <returns>Indication whether the conversion succeeded.</returns>
  2379. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2380. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2381. -or-
  2382. <paramref name="validation"/> is an invalid value.</exception>
  2383. </member>
  2384. <member name="M:EnumsNET.Enums.TryToObject(System.Type,System.Int64,System.Object@,EnumsNET.EnumValidation)">
  2385. <summary>
  2386. Tries to convert the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2387. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2388. The return value indicates whether the conversion succeeded.
  2389. </summary>
  2390. <param name="enumType">The enum type.</param>
  2391. <param name="value">Value to try to convert.</param>
  2392. <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> whose value is <paramref name="value"/>.</param>
  2393. <param name="validation">The validation to perform on the result.</param>
  2394. <returns>Indication whether the conversion succeeded.</returns>
  2395. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2396. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2397. -or-
  2398. <paramref name="validation"/> is an invalid value.</exception>
  2399. </member>
  2400. <member name="M:EnumsNET.Enums.TryToObject(System.Type,System.UInt64,System.Object@,EnumsNET.EnumValidation)">
  2401. <summary>
  2402. Tries to convert the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
  2403. underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
  2404. The return value indicates whether the conversion succeeded.
  2405. </summary>
  2406. <param name="enumType">The enum type.</param>
  2407. <param name="value">Value to try to convert.</param>
  2408. <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> whose value is <paramref name="value"/>.</param>
  2409. <param name="validation">The validation to perform on the result.</param>
  2410. <returns>Indication whether the conversion succeeded.</returns>
  2411. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2412. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2413. -or-
  2414. <paramref name="validation"/> is an invalid value.</exception>
  2415. </member>
  2416. <member name="M:EnumsNET.Enums.IsValid(System.Type,System.Object,EnumsNET.EnumValidation)">
  2417. <summary>
  2418. Indicates if <paramref name="value"/> is valid. If <paramref name="enumType"/> is a standard enum it returns whether the value is defined.
  2419. 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
  2420. or is defined. Or if <paramref name="enumType"/> has an attribute that implements <see cref="T:EnumsNET.IEnumValidatorAttribute`1"/>
  2421. then that attribute's <see cref="M:EnumsNET.IEnumValidatorAttribute`1.IsValid(`0)"/> method is used.
  2422. </summary>
  2423. <param name="enumType">The enum type.</param>
  2424. <param name="value">The enum value.</param>
  2425. <param name="validation">The validation to perform on the value.</param>
  2426. <returns>Indication if <paramref name="value"/> is valid.</returns>
  2427. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2428. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2429. -or-
  2430. <paramref name="value"/> is of an invalid type
  2431. -or-
  2432. <paramref name="validation"/> is an invalid value.</exception>
  2433. </member>
  2434. <member name="M:EnumsNET.Enums.IsDefined(System.Type,System.Object)">
  2435. <summary>
  2436. Indicates if <paramref name="value"/> is defined.
  2437. </summary>
  2438. <param name="enumType">The enum type.</param>
  2439. <param name="value">The enum value.</param>
  2440. <returns>Indication if <paramref name="value"/> is defined.</returns>
  2441. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2442. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2443. -or-
  2444. <paramref name="value"/> is of an invalid type.</exception>
  2445. </member>
  2446. <member name="M:EnumsNET.Enums.Validate(System.Type,System.Object,System.String,EnumsNET.EnumValidation)">
  2447. <summary>
  2448. 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"/>.
  2449. </summary>
  2450. <param name="enumType">The enum type.</param>
  2451. <param name="value">The enum value.</param>
  2452. <param name="paramName">The parameter name to be used if throwing an <see cref="T:System.ArgumentException"/>.</param>
  2453. <param name="validation">The validation to perform on the value.</param>
  2454. <returns><paramref name="value"/> for use in fluent API's and base constructor method calls.</returns>
  2455. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2456. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2457. -or-
  2458. <paramref name="value"/> is of an invalid type
  2459. -or-
  2460. <paramref name="validation"/> is an invalid value
  2461. -or-
  2462. <paramref name="value"/> is invalid.</exception>
  2463. </member>
  2464. <member name="M:EnumsNET.Enums.AsString(System.Type,System.Object)">
  2465. <summary>
  2466. Converts the specified <paramref name="value"/> to its string representation.
  2467. </summary>
  2468. <param name="enumType">The enum type.</param>
  2469. <param name="value">The enum value.</param>
  2470. <returns>A string representation of <paramref name="value"/>.</returns>
  2471. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2472. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2473. -or-
  2474. <paramref name="value"/> is of an invalid type.</exception>
  2475. </member>
  2476. <member name="M:EnumsNET.Enums.AsString(System.Type,System.Object,System.String)">
  2477. <summary>
  2478. Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="format"/>.
  2479. </summary>
  2480. <param name="enumType">The enum type.</param>
  2481. <param name="value">The enum value.</param>
  2482. <param name="format">The output format to use.</param>
  2483. <returns>A string representation of <paramref name="value"/>.</returns>
  2484. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2485. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2486. -or-
  2487. <paramref name="value"/> is of an invalid type.</exception>
  2488. <exception cref="T:System.FormatException"><paramref name="format"/> is an invalid value.</exception>
  2489. </member>
  2490. <member name="M:EnumsNET.Enums.AsString(System.Type,System.Object,EnumsNET.EnumFormat)">
  2491. <summary>
  2492. Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="format"/>.
  2493. </summary>
  2494. <param name="enumType">The enum type.</param>
  2495. <param name="value">The enum value.</param>
  2496. <param name="format">The output format to use.</param>
  2497. <returns>A string representation of <paramref name="value"/>.</returns>
  2498. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2499. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2500. -or-
  2501. <paramref name="format"/> is an invalid value.</exception>
  2502. </member>
  2503. <member name="M:EnumsNET.Enums.AsString(System.Type,System.Object,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  2504. <summary>
  2505. Converts the specified <paramref name="value"/> to its string representation using the specified formats.
  2506. </summary>
  2507. <param name="enumType">The enum type.</param>
  2508. <param name="value">The enum value.</param>
  2509. <param name="format0">The first output format to use.</param>
  2510. <param name="format1">The second output format to use if using the first resolves to <c>null</c>.</param>
  2511. <returns>A string representation of <paramref name="value"/>.</returns>
  2512. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2513. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2514. -or-
  2515. <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  2516. </member>
  2517. <member name="M:EnumsNET.Enums.AsString(System.Type,System.Object,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  2518. <summary>
  2519. Converts the specified <paramref name="value"/> to its string representation using the specified formats.
  2520. </summary>
  2521. <param name="enumType">The enum type.</param>
  2522. <param name="value">The enum value.</param>
  2523. <param name="format0">The first output format to use.</param>
  2524. <param name="format1">The second output format to use if using the first resolves to <c>null</c>.</param>
  2525. <param name="format2">The third output format to use if using the first and second both resolve to <c>null</c>.</param>
  2526. <returns>A string representation of <paramref name="value"/>.</returns>
  2527. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2528. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2529. -or-
  2530. <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  2531. </member>
  2532. <member name="M:EnumsNET.Enums.AsString(System.Type,System.Object,EnumsNET.EnumFormat[])">
  2533. <summary>
  2534. Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="formats"/>.
  2535. </summary>
  2536. <param name="enumType">The enum type.</param>
  2537. <param name="value">The enum value.</param>
  2538. <param name="formats">The output formats to use.</param>
  2539. <returns>A string representation of <paramref name="value"/>.</returns>
  2540. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2541. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2542. -or-
  2543. <paramref name="formats"/> contains an invalid value.</exception>
  2544. </member>
  2545. <member name="M:EnumsNET.Enums.Format(System.Type,System.Object,System.String)">
  2546. <summary>
  2547. Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="format"/>.
  2548. </summary>
  2549. <param name="enumType">The enum type.</param>
  2550. <param name="value">The enum value.</param>
  2551. <param name="format">The output format to use.</param>
  2552. <returns>A string representation of <paramref name="value"/>.</returns>
  2553. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/>, <paramref name="value"/>, or <paramref name="format"/> is <c>null</c>.</exception>
  2554. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2555. -or-
  2556. <paramref name="value"/> is of an invalid type.</exception>
  2557. <exception cref="T:System.FormatException"><paramref name="format"/> is an invalid value.</exception>
  2558. </member>
  2559. <member name="M:EnumsNET.Enums.GetUnderlyingValue(System.Type,System.Object)">
  2560. <summary>
  2561. Returns <paramref name="value"/>'s underlying integral value.
  2562. </summary>
  2563. <param name="enumType">The enum type.</param>
  2564. <param name="value">The enum value.</param>
  2565. <returns><paramref name="value"/>'s underlying integral value.</returns>
  2566. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2567. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2568. -or-
  2569. <paramref name="value"/> is of an invalid type.</exception>
  2570. </member>
  2571. <member name="M:EnumsNET.Enums.ToSByte(System.Type,System.Object)">
  2572. <summary>
  2573. Converts <paramref name="value"/> to an <see cref="T:System.SByte"/>.
  2574. </summary>
  2575. <param name="enumType">The enum type.</param>
  2576. <param name="value">The enum value.</param>
  2577. <returns><paramref name="value"/> converted to an <see cref="T:System.SByte"/>.</returns>
  2578. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2579. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2580. -or-
  2581. <paramref name="value"/> is of an invalid type.</exception>
  2582. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.SByte"/>'s value range without overflowing.</exception>
  2583. </member>
  2584. <member name="M:EnumsNET.Enums.ToByte(System.Type,System.Object)">
  2585. <summary>
  2586. Converts <paramref name="value"/> to a <see cref="T:System.Byte"/>.
  2587. </summary>
  2588. <param name="enumType">The enum type.</param>
  2589. <param name="value">The enum value.</param>
  2590. <returns><paramref name="value"/> converted to a <see cref="T:System.Byte"/>.</returns>
  2591. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2592. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2593. -or-
  2594. <paramref name="value"/> is of an invalid type.</exception>
  2595. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Byte"/>'s value range without overflowing.</exception>
  2596. </member>
  2597. <member name="M:EnumsNET.Enums.ToInt16(System.Type,System.Object)">
  2598. <summary>
  2599. Converts <paramref name="value"/> to an <see cref="T:System.Int16"/>.
  2600. </summary>
  2601. <param name="enumType">The enum type.</param>
  2602. <param name="value">The enum value.</param>
  2603. <returns><paramref name="value"/> converted to an <see cref="T:System.Int16"/>.</returns>
  2604. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2605. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2606. -or-
  2607. <paramref name="value"/> is of an invalid type.</exception>
  2608. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Int16"/>'s value range without overflowing.</exception>
  2609. </member>
  2610. <member name="M:EnumsNET.Enums.ToUInt16(System.Type,System.Object)">
  2611. <summary>
  2612. Converts <paramref name="value"/> to a <see cref="T:System.UInt16"/>.
  2613. </summary>
  2614. <param name="enumType">The enum type.</param>
  2615. <param name="value">The enum value.</param>
  2616. <returns><paramref name="value"/> converted to a <see cref="T:System.UInt16"/>.</returns>
  2617. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2618. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2619. -or-
  2620. <paramref name="value"/> is of an invalid type.</exception>
  2621. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.UInt16"/>'s value range without overflowing.</exception>
  2622. </member>
  2623. <member name="M:EnumsNET.Enums.ToInt32(System.Type,System.Object)">
  2624. <summary>
  2625. Converts <paramref name="value"/> to an <see cref="T:System.Int32"/>.
  2626. </summary>
  2627. <param name="enumType">The enum type.</param>
  2628. <param name="value">The enum value.</param>
  2629. <returns><paramref name="value"/> converted to an <see cref="T:System.Int32"/>.</returns>
  2630. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2631. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2632. -or-
  2633. <paramref name="value"/> is of an invalid type.</exception>
  2634. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Int32"/>'s value range without overflowing.</exception>
  2635. </member>
  2636. <member name="M:EnumsNET.Enums.ToUInt32(System.Type,System.Object)">
  2637. <summary>
  2638. Converts <paramref name="value"/> to a <see cref="T:System.UInt32"/>.
  2639. </summary>
  2640. <param name="enumType">The enum type.</param>
  2641. <param name="value">The enum value.</param>
  2642. <returns><paramref name="value"/> converted to a <see cref="T:System.UInt32"/>.</returns>
  2643. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2644. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2645. -or-
  2646. <paramref name="value"/> is of an invalid type.</exception>
  2647. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.UInt32"/>'s value range without overflowing.</exception>
  2648. </member>
  2649. <member name="M:EnumsNET.Enums.ToInt64(System.Type,System.Object)">
  2650. <summary>
  2651. Converts <paramref name="value"/> to an <see cref="T:System.Int64"/>.
  2652. </summary>
  2653. <param name="enumType">The enum type.</param>
  2654. <param name="value">The enum value.</param>
  2655. <returns><paramref name="value"/> converted to an <see cref="T:System.Int64"/>.</returns>
  2656. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2657. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2658. -or-
  2659. <paramref name="value"/> is of an invalid type.</exception>
  2660. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Int64"/>'s value range without overflowing.</exception>
  2661. </member>
  2662. <member name="M:EnumsNET.Enums.ToUInt64(System.Type,System.Object)">
  2663. <summary>
  2664. Converts <paramref name="value"/> to a <see cref="T:System.UInt64"/>.
  2665. </summary>
  2666. <param name="enumType">The enum type.</param>
  2667. <param name="value">The enum value.</param>
  2668. <returns><paramref name="value"/> converted to a <see cref="T:System.UInt64"/>.</returns>
  2669. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2670. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2671. -or-
  2672. <paramref name="value"/> is of an invalid type.</exception>
  2673. <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.UInt64"/>'s value range without overflowing.</exception>
  2674. </member>
  2675. <member name="M:EnumsNET.Enums.Equals(System.Type,System.Object,System.Object)">
  2676. <summary>
  2677. Indicates if <paramref name="value"/> equals <paramref name="other"/>.
  2678. </summary>
  2679. <param name="enumType">The enum type.</param>
  2680. <param name="value">The enum value.</param>
  2681. <param name="other">The other enum value.</param>
  2682. <returns>Indication if <paramref name="value"/> equals <paramref name="other"/>.</returns>
  2683. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/>, <paramref name="value"/>, or <paramref name="other"/> is <c>null</c>.</exception>
  2684. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2685. -or-
  2686. <paramref name="value"/> or <paramref name="other"/> is of an invalid type.</exception>
  2687. </member>
  2688. <member name="M:EnumsNET.Enums.CompareTo(System.Type,System.Object,System.Object)">
  2689. <summary>
  2690. Compares <paramref name="value"/> to <paramref name="other"/> for ordering.
  2691. </summary>
  2692. <param name="enumType">The enum type.</param>
  2693. <param name="value">The enum value.</param>
  2694. <param name="other">The other enum value.</param>
  2695. <returns>1 if <paramref name="value"/> is greater than <paramref name="other"/>, 0 if <paramref name="value"/> equals <paramref name="other"/>,
  2696. and -1 if <paramref name="value"/> is less than <paramref name="other"/>.</returns>
  2697. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/>, <paramref name="value"/>, or <paramref name="other"/> is <c>null</c>.</exception>
  2698. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2699. -or-
  2700. <paramref name="value"/> or <paramref name="other"/> is of an invalid type.</exception>
  2701. </member>
  2702. <member name="M:EnumsNET.Enums.GetName(System.Type,System.Object)">
  2703. <summary>
  2704. Retrieves <paramref name="value"/>'s enum member name if defined otherwise <c>null</c>.
  2705. </summary>
  2706. <param name="enumType">The enum type.</param>
  2707. <param name="value">The enum value.</param>
  2708. <returns><paramref name="value"/>'s enum member name if defined otherwise <c>null</c>.</returns>
  2709. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2710. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2711. -or-
  2712. <paramref name="value"/> is of an invalid type.</exception>
  2713. </member>
  2714. <member name="M:EnumsNET.Enums.GetAttributes(System.Type,System.Object)">
  2715. <summary>
  2716. Retrieves <paramref name="value"/>'s enum member attributes if defined otherwise <c>null</c>.
  2717. </summary>
  2718. <param name="enumType">The enum type.</param>
  2719. <param name="value">The enum value.</param>
  2720. <returns><paramref name="value"/>'s enum member attributes if defined otherwise <c>null</c>.</returns>
  2721. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2722. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2723. -or-
  2724. <paramref name="value"/> is of an invalid type.</exception>
  2725. </member>
  2726. <member name="M:EnumsNET.Enums.GetMember(System.Type,System.Object)">
  2727. <summary>
  2728. Retrieves an enum member with the specified <paramref name="value"/> if defined otherwise <c>null</c>.
  2729. </summary>
  2730. <param name="enumType">The enum type.</param>
  2731. <param name="value">The enum value.</param>
  2732. <returns>Enum member with the specified <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
  2733. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2734. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2735. -or-
  2736. <paramref name="value"/> is of an invalid type.</exception>
  2737. </member>
  2738. <member name="M:EnumsNET.Enums.GetMember(System.Type,System.String)">
  2739. <summary>
  2740. Retrieves the enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.
  2741. Is case-sensitive.
  2742. </summary>
  2743. <param name="enumType">The enum type.</param>
  2744. <param name="name">The enum member name.</param>
  2745. <returns>Enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.</returns>
  2746. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="name"/> is <c>null</c>.</exception>
  2747. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
  2748. </member>
  2749. <member name="M:EnumsNET.Enums.GetMember(System.Type,System.String,System.Boolean)">
  2750. <summary>
  2751. Retrieves the enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.
  2752. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  2753. </summary>
  2754. <param name="enumType">The enum type.</param>
  2755. <param name="name">The enum member name.</param>
  2756. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  2757. <returns>Enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.</returns>
  2758. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="name"/> is <c>null</c>.</exception>
  2759. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
  2760. </member>
  2761. <member name="M:EnumsNET.Enums.GetMember(System.Type,System.String,System.Boolean,EnumsNET.EnumFormat)">
  2762. <summary>
  2763. Retrieves an enum member whose string representation using the specified <paramref name="format"/> is <paramref name="value"/> if defined otherwise <c>null</c>.
  2764. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  2765. </summary>
  2766. <param name="enumType">The enum type.</param>
  2767. <param name="value">The enum member's string representation.</param>
  2768. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  2769. <param name="format">The parsing enum format.</param>
  2770. <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
  2771. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2772. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2773. -or-
  2774. <paramref name="format"/> is an invalid value.</exception>
  2775. </member>
  2776. <member name="M:EnumsNET.Enums.GetMember(System.Type,System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  2777. <summary>
  2778. Retrieves an enum member whose string representation using the specified formats is <paramref name="value"/> if defined otherwise <c>null</c>.
  2779. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  2780. </summary>
  2781. <param name="enumType">The enum type.</param>
  2782. <param name="value">The enum member's string representation.</param>
  2783. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  2784. <param name="format0">The first parsing enum format.</param>
  2785. <param name="format1">The second parsing enum format.</param>
  2786. <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
  2787. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2788. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2789. -or-
  2790. <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  2791. </member>
  2792. <member name="M:EnumsNET.Enums.GetMember(System.Type,System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  2793. <summary>
  2794. Retrieves an enum member whose string representation using the specified formats is <paramref name="value"/> if defined otherwise <c>null</c>.
  2795. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  2796. </summary>
  2797. <param name="enumType">The enum type.</param>
  2798. <param name="value">The enum member's string representation.</param>
  2799. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  2800. <param name="format0">The first parsing enum format.</param>
  2801. <param name="format1">The second parsing enum format.</param>
  2802. <param name="format2">The third parsing enum format.</param>
  2803. <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
  2804. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2805. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2806. -or-
  2807. <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  2808. </member>
  2809. <member name="M:EnumsNET.Enums.GetMember(System.Type,System.String,System.Boolean,EnumsNET.EnumFormat[])">
  2810. <summary>
  2811. Retrieves an enum member whose string representation using the specified <paramref name="formats"/> is <paramref name="value"/> if defined otherwise <c>null</c>.
  2812. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  2813. </summary>
  2814. <param name="enumType">The enum type.</param>
  2815. <param name="value">The enum member's string representation.</param>
  2816. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  2817. <param name="formats">The parsing enum formats.</param>
  2818. <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
  2819. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2820. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2821. -or-
  2822. <paramref name="formats"/> contains an invalid value.</exception>
  2823. </member>
  2824. <member name="M:EnumsNET.Enums.Parse(System.Type,System.String)">
  2825. <summary>
  2826. 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"/>.
  2827. </summary>
  2828. <param name="enumType">The enum type.</param>
  2829. <param name="value">The enum member names or values' string representation.</param>
  2830. <returns>A <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
  2831. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2832. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2833. -or-
  2834. <paramref name="value"/> doesn't represent a member name or value of <paramref name="enumType"/>.</exception>
  2835. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of <paramref name="enumType"/>'s underlying type.</exception>
  2836. </member>
  2837. <member name="M:EnumsNET.Enums.Parse(System.Type,System.String,System.Boolean)">
  2838. <summary>
  2839. 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"/>.
  2840. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  2841. </summary>
  2842. <param name="enumType">The enum type.</param>
  2843. <param name="value">The enum member names or values' string representation.</param>
  2844. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  2845. <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
  2846. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2847. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2848. -or-
  2849. <paramref name="value"/> doesn't represent a member name or value of <paramref name="enumType"/>.</exception>
  2850. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
  2851. </member>
  2852. <member name="M:EnumsNET.Enums.Parse(System.Type,System.String,System.Boolean,EnumsNET.EnumFormat)">
  2853. <summary>
  2854. Converts the string representation of one or more members or values of <paramref name="enumType"/> to its respective value of type <paramref name="enumType"/>
  2855. using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  2856. </summary>
  2857. <param name="enumType">The enum type.</param>
  2858. <param name="value">The enum members or values' string representation.</param>
  2859. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  2860. <param name="format">The parsing enum format.</param>
  2861. <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
  2862. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> 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"/> doesn't represent a member or value of <paramref name="enumType"/>
  2866. -or-
  2867. <paramref name="format"/> is an invalid value.</exception>
  2868. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
  2869. </member>
  2870. <member name="M:EnumsNET.Enums.Parse(System.Type,System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  2871. <summary>
  2872. Converts the string representation of one or more members or values of <paramref name="enumType"/> to its respective value of type <paramref name="enumType"/>
  2873. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  2874. </summary>
  2875. <param name="enumType">The enum type.</param>
  2876. <param name="value">The enum members or values' string representation.</param>
  2877. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  2878. <param name="format0">The first parsing enum format.</param>
  2879. <param name="format1">The second parsing enum format.</param>
  2880. <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
  2881. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2882. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2883. -or-
  2884. <paramref name="value"/> doesn't represent a member or value of <paramref name="enumType"/>
  2885. -or-
  2886. <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  2887. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
  2888. </member>
  2889. <member name="M:EnumsNET.Enums.Parse(System.Type,System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  2890. <summary>
  2891. Converts the string representation of one or more members or values of <paramref name="enumType"/> to its respective value of type <paramref name="enumType"/>
  2892. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  2893. </summary>
  2894. <param name="enumType">The enum type.</param>
  2895. <param name="value">The enum members or values' string representation.</param>
  2896. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  2897. <param name="format0">The first parsing enum format.</param>
  2898. <param name="format1">The second parsing enum format.</param>
  2899. <param name="format2">The third parsing enum format.</param>
  2900. <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
  2901. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2902. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2903. -or-
  2904. <paramref name="value"/> doesn't represent a member or value of <paramref name="enumType"/>
  2905. -or-
  2906. <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  2907. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
  2908. </member>
  2909. <member name="M:EnumsNET.Enums.Parse(System.Type,System.String,System.Boolean,EnumsNET.EnumFormat[])">
  2910. <summary>
  2911. Converts the string representation of one or more members or values of <paramref name="enumType"/> to its respective value of type <paramref name="enumType"/>
  2912. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  2913. </summary>
  2914. <param name="enumType">The enum type.</param>
  2915. <param name="value">The enum members or values' string representation.</param>
  2916. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  2917. <param name="formats">The parsing enum formats.</param>
  2918. <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
  2919. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  2920. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2921. -or-
  2922. <paramref name="value"/> doesn't represent a member or value of <paramref name="enumType"/>
  2923. -or-
  2924. <paramref name="formats"/> contains an invalid value.</exception>
  2925. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
  2926. </member>
  2927. <member name="M:EnumsNET.Enums.TryParse(System.Type,System.String,System.Object@)">
  2928. <summary>
  2929. 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"/>.
  2930. The return value indicates whether the conversion succeeded.
  2931. </summary>
  2932. <param name="enumType">The enum type.</param>
  2933. <param name="value">The enum member names or values' string representation.</param>
  2934. <param name="result">If the conversion succeeds this contains a <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</param>
  2935. <returns>Indication whether the conversion succeeded.</returns>
  2936. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2937. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
  2938. </member>
  2939. <member name="M:EnumsNET.Enums.TryParse(System.Type,System.String,System.Boolean,System.Object@)">
  2940. <summary>
  2941. 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"/>.
  2942. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive. The return value indicates whether the conversion succeeded.
  2943. </summary>
  2944. <param name="enumType">The enum type.</param>
  2945. <param name="value">The enum member names or values' string representation.</param>
  2946. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  2947. <param name="result">If the conversion succeeds this contains a <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</param>
  2948. <returns>Indication whether the conversion succeeded.</returns>
  2949. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2950. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
  2951. </member>
  2952. <member name="M:EnumsNET.Enums.TryParse(System.Type,System.String,System.Boolean,System.Object@,EnumsNET.EnumFormat)">
  2953. <summary>
  2954. 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"/>
  2955. using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  2956. The return value indicates whether the conversion succeeded.
  2957. </summary>
  2958. <param name="enumType">The enum type.</param>
  2959. <param name="value">The enum members or values' string representation.</param>
  2960. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  2961. <param name="result">If the conversion succeeds this contains a <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</param>
  2962. <param name="format">The parsing enum format.</param>
  2963. <returns>Indication whether the conversion succeeded.</returns>
  2964. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2965. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2966. -or-
  2967. <paramref name="format"/> is an invalid value.</exception>
  2968. </member>
  2969. <member name="M:EnumsNET.Enums.TryParse(System.Type,System.String,System.Boolean,System.Object@,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  2970. <summary>
  2971. 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"/>
  2972. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  2973. The return value indicates whether the conversion succeeded.
  2974. </summary>
  2975. <param name="enumType">The enum type.</param>
  2976. <param name="value">The enum members or values' string representation.</param>
  2977. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  2978. <param name="result">If the conversion succeeds this contains a <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</param>
  2979. <param name="format0">The first parsing enum format.</param>
  2980. <param name="format1">The second parsing enum format.</param>
  2981. <returns>Indication whether the conversion succeeded.</returns>
  2982. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  2983. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  2984. -or-
  2985. <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  2986. </member>
  2987. <member name="M:EnumsNET.Enums.TryParse(System.Type,System.String,System.Boolean,System.Object@,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  2988. <summary>
  2989. 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"/>
  2990. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  2991. The return value indicates whether the conversion succeeded.
  2992. </summary>
  2993. <param name="enumType">The enum type.</param>
  2994. <param name="value">The enum members or values' string representation.</param>
  2995. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  2996. <param name="result">If the conversion succeeds this contains a <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</param>
  2997. <param name="format0">The first parsing enum format.</param>
  2998. <param name="format1">The second parsing enum format.</param>
  2999. <param name="format2">The third parsing enum format.</param>
  3000. <returns>Indication whether the conversion succeeded.</returns>
  3001. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  3002. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  3003. -or-
  3004. <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  3005. </member>
  3006. <member name="M:EnumsNET.Enums.TryParse(System.Type,System.String,System.Boolean,System.Object@,EnumsNET.EnumFormat[])">
  3007. <summary>
  3008. 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"/>
  3009. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  3010. The return value indicates whether the conversion succeeded.
  3011. </summary>
  3012. <param name="enumType">The enum type.</param>
  3013. <param name="value">The enum members or values' string representation.</param>
  3014. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3015. <param name="result">If the conversion succeeds this contains a <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</param>
  3016. <param name="formats">The parsing enum formats.</param>
  3017. <returns>Indication whether the conversion succeeded.</returns>
  3018. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  3019. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  3020. -or-
  3021. <paramref name="formats"/> contains an invalid value.</exception>
  3022. </member>
  3023. <member name="T:EnumsNET.EnumValidation">
  3024. <summary>
  3025. Specifies the enum validation to perform.
  3026. </summary>
  3027. </member>
  3028. <member name="F:EnumsNET.EnumValidation.None">
  3029. <summary>
  3030. No validation.
  3031. </summary>
  3032. </member>
  3033. <member name="F:EnumsNET.EnumValidation.Default">
  3034. <summary>
  3035. If the enum is a standard enum returns whether the value is defined.
  3036. 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
  3037. or is defined. Or if the enum has an attribute that implements <see cref="T:EnumsNET.IEnumValidatorAttribute`1"/>
  3038. then that attribute's <see cref="M:EnumsNET.IEnumValidatorAttribute`1.IsValid(`0)"/> method is used.
  3039. </summary>
  3040. </member>
  3041. <member name="F:EnumsNET.EnumValidation.IsDefined">
  3042. <summary>
  3043. Returns if the value is defined.
  3044. </summary>
  3045. </member>
  3046. <member name="F:EnumsNET.EnumValidation.IsValidFlagCombination">
  3047. <summary>
  3048. Returns if the value is a valid flag combination of the enum's defined values.
  3049. </summary>
  3050. </member>
  3051. <member name="T:EnumsNET.FlagEnums">
  3052. <summary>
  3053. Static class that provides efficient type-safe flag enum operations through the use of cached enum names, values, and attributes.
  3054. Many operations are exposed as C# extension methods for convenience.
  3055. </summary>
  3056. </member>
  3057. <member name="M:EnumsNET.FlagEnums.IsFlagEnum``1">
  3058. <summary>
  3059. Indicates if <typeparamref name="TEnum"/> is marked with the <see cref="T:System.FlagsAttribute"/>.
  3060. </summary>
  3061. <typeparam name="TEnum">The enum type.</typeparam>
  3062. <returns>Indication if <typeparamref name="TEnum"/> is marked with the <see cref="T:System.FlagsAttribute"/>.</returns>
  3063. </member>
  3064. <member name="M:EnumsNET.FlagEnums.GetAllFlags``1">
  3065. <summary>
  3066. Retrieves all the flags defined by <typeparamref name="TEnum"/>.
  3067. </summary>
  3068. <typeparam name="TEnum">The enum type.</typeparam>
  3069. <returns>All the flags defined by <typeparamref name="TEnum"/>.</returns>
  3070. </member>
  3071. <member name="M:EnumsNET.FlagEnums.IsValidFlagCombination``1(``0)">
  3072. <summary>
  3073. Indicates whether <paramref name="value"/> is a valid flag combination of <typeparamref name="TEnum"/>'s defined flags.
  3074. </summary>
  3075. <typeparam name="TEnum">The enum type.</typeparam>
  3076. <param name="value">The flags enum value.</param>
  3077. <returns>Indication of whether <paramref name="value"/> is a valid flag combination of <typeparamref name="TEnum"/>'s defined flags.</returns>
  3078. </member>
  3079. <member name="M:EnumsNET.FlagEnums.FormatFlags``1(``0)">
  3080. <summary>
  3081. 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".
  3082. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  3083. </summary>
  3084. <typeparam name="TEnum">The enum type.</typeparam>
  3085. <param name="value">The flags enum value.</param>
  3086. <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".
  3087. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  3088. </member>
  3089. <member name="M:EnumsNET.FlagEnums.FormatFlags``1(``0,System.String)">
  3090. <summary>
  3091. 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".
  3092. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  3093. </summary>
  3094. <typeparam name="TEnum">The enum type.</typeparam>
  3095. <param name="value">The flags enum value.</param>
  3096. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  3097. <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".
  3098. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  3099. </member>
  3100. <member name="M:EnumsNET.FlagEnums.FormatFlags``1(``0,System.String,EnumsNET.EnumFormat)">
  3101. <summary>
  3102. Retrieves <paramref name="value"/>'s flags formatted with <paramref name="format"/> and delimited with <paramref name="delimiter"/>
  3103. or if empty returns the zero flag formatted with <paramref name="format"/>.
  3104. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  3105. </summary>
  3106. <typeparam name="TEnum">The enum type.</typeparam>
  3107. <param name="value">The flags enum value.</param>
  3108. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  3109. <param name="format">The output format to use.</param>
  3110. <returns><paramref name="value"/>'s flags formatted with <paramref name="format"/> and delimited with <paramref name="delimiter"/>
  3111. or if empty returns the zero flag formatted with <paramref name="format"/>.
  3112. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  3113. <exception cref="T:System.ArgumentException"><paramref name="format"/> is an invalid value.</exception>
  3114. </member>
  3115. <member name="M:EnumsNET.FlagEnums.FormatFlags``1(``0,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  3116. <summary>
  3117. Retrieves <paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
  3118. or if empty returns the zero flag formatted with formats.
  3119. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  3120. </summary>
  3121. <typeparam name="TEnum">The enum type.</typeparam>
  3122. <param name="value">The flags enum value.</param>
  3123. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  3124. <param name="format0">The first output format to use.</param>
  3125. <param name="format1">The second output format to use.</param>
  3126. <returns><paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
  3127. or if empty returns the zero flag formatted with formats.
  3128. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  3129. <exception cref="T:System.ArgumentException"><paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  3130. </member>
  3131. <member name="M:EnumsNET.FlagEnums.FormatFlags``1(``0,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  3132. <summary>
  3133. Retrieves <paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
  3134. or if empty returns the zero flag formatted with formats.
  3135. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  3136. </summary>
  3137. <typeparam name="TEnum">The enum type.</typeparam>
  3138. <param name="value">The flags enum value.</param>
  3139. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  3140. <param name="format0">The first output format to use.</param>
  3141. <param name="format1">The second output format to use.</param>
  3142. <param name="format2">The third output format to use.</param>
  3143. <returns><paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
  3144. or if empty returns the zero flag formatted with formats.
  3145. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  3146. <exception cref="T:System.ArgumentException"><paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  3147. </member>
  3148. <member name="M:EnumsNET.FlagEnums.FormatFlags``1(``0,System.String,EnumsNET.EnumFormat[])">
  3149. <summary>
  3150. Retrieves <paramref name="value"/>'s flags formatted with <paramref name="formats"/> and delimited with <paramref name="delimiter"/>
  3151. or if empty returns the zero flag formatted with <paramref name="formats"/>.
  3152. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  3153. </summary>
  3154. <typeparam name="TEnum">The enum type.</typeparam>
  3155. <param name="value">The flags enum value.</param>
  3156. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  3157. <param name="formats">The output formats to use.</param>
  3158. <returns><paramref name="value"/>'s flags formatted with <paramref name="formats"/> and delimited with <paramref name="delimiter"/>
  3159. or if empty returns the zero flag formatted with <paramref name="formats"/>.
  3160. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  3161. <exception cref="T:System.ArgumentException"><paramref name="formats"/> contains an invalid value.</exception>
  3162. </member>
  3163. <member name="M:EnumsNET.FlagEnums.GetFlags``1(``0)">
  3164. <summary>
  3165. Retrieves the flags that compose <paramref name="value"/>.
  3166. </summary>
  3167. <typeparam name="TEnum">The enum type.</typeparam>
  3168. <param name="value">The flags enum value.</param>
  3169. <returns>The flags that compose <paramref name="value"/>.</returns>
  3170. </member>
  3171. <member name="M:EnumsNET.FlagEnums.GetFlagMembers``1(``0)">
  3172. <summary>
  3173. Retrieves the <see cref="T:EnumsNET.EnumMember`1"/>s of the flags that compose <paramref name="value"/>.
  3174. </summary>
  3175. <typeparam name="TEnum">The enum type.</typeparam>
  3176. <param name="value">The flags enum value.</param>
  3177. <returns>The <see cref="T:EnumsNET.EnumMember`1"/>s of the flags that compose <paramref name="value"/>.</returns>
  3178. </member>
  3179. <member name="M:EnumsNET.FlagEnums.GetFlagCount``1">
  3180. <summary>
  3181. Retrieves the flag count of <typeparamref name="TEnum"/>.
  3182. </summary>
  3183. <typeparam name="TEnum">The enum type.</typeparam>
  3184. <returns>The flag count of <typeparamref name="TEnum"/>.</returns>
  3185. </member>
  3186. <member name="M:EnumsNET.FlagEnums.GetFlagCount``1(``0)">
  3187. <summary>
  3188. Retrieves the flag count of <paramref name="value"/>.
  3189. </summary>
  3190. <typeparam name="TEnum">The enum type.</typeparam>
  3191. <param name="value">The flags enum value.</param>
  3192. <returns>The flag count of <paramref name="value"/>.</returns>
  3193. </member>
  3194. <member name="M:EnumsNET.FlagEnums.GetFlagCount``1(``0,``0)">
  3195. <summary>
  3196. Retrieves the flag count of <paramref name="otherFlags"/> that <paramref name="value"/> has.
  3197. </summary>
  3198. <typeparam name="TEnum">The enum type.</typeparam>
  3199. <param name="value">The flags enum value.</param>
  3200. <param name="otherFlags">The other flags enum value.</param>
  3201. <returns>The flag count of <paramref name="otherFlags"/> that <paramref name="value"/> has.</returns>
  3202. </member>
  3203. <member name="M:EnumsNET.FlagEnums.HasAnyFlags``1(``0)">
  3204. <summary>
  3205. Indicates if <paramref name="value"/> has any flags.
  3206. </summary>
  3207. <typeparam name="TEnum">The enum type.</typeparam>
  3208. <param name="value">The flags enum value.</param>
  3209. <returns>Indication if <paramref name="value"/> has any flags.</returns>
  3210. </member>
  3211. <member name="M:EnumsNET.FlagEnums.HasAnyFlags``1(``0,``0)">
  3212. <summary>
  3213. Indicates if <paramref name="value"/> has any flags that are in <paramref name="otherFlags"/>.
  3214. </summary>
  3215. <typeparam name="TEnum">The enum type.</typeparam>
  3216. <param name="value">The flags enum value.</param>
  3217. <param name="otherFlags">The other flags enum value.</param>
  3218. <returns>Indication if <paramref name="value"/> has any flags that are in <paramref name="otherFlags"/>.</returns>
  3219. </member>
  3220. <member name="M:EnumsNET.FlagEnums.HasAllFlags``1(``0)">
  3221. <summary>
  3222. Indicates if <paramref name="value"/> has all of the flags that are defined in <typeparamref name="TEnum"/>.
  3223. </summary>
  3224. <typeparam name="TEnum">The enum type.</typeparam>
  3225. <param name="value">The flags enum value.</param>
  3226. <returns>Indication if <paramref name="value"/> has all of the flags that are defined in <typeparamref name="TEnum"/>.</returns>
  3227. </member>
  3228. <member name="M:EnumsNET.FlagEnums.HasAllFlags``1(``0,``0)">
  3229. <summary>
  3230. Indicates if <paramref name="value"/> has all of the flags that are in <paramref name="otherFlags"/>.
  3231. </summary>
  3232. <typeparam name="TEnum">The enum type.</typeparam>
  3233. <param name="value">The flags enum value.</param>
  3234. <param name="otherFlags">The other flags enum value.</param>
  3235. <returns>Indication if <paramref name="value"/> has all of the flags that are in <paramref name="otherFlags"/>.</returns>
  3236. </member>
  3237. <member name="M:EnumsNET.FlagEnums.ToggleFlags``1(``0)">
  3238. <summary>
  3239. 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"/>.
  3240. </summary>
  3241. <typeparam name="TEnum">The enum type.</typeparam>
  3242. <param name="value">The flags enum value.</param>
  3243. <returns><paramref name="value"/> with all of it's flags toggled.</returns>
  3244. </member>
  3245. <member name="M:EnumsNET.FlagEnums.ToggleFlags``1(``0,``0)">
  3246. <summary>
  3247. Returns <paramref name="value"/> while toggling the flags that are in <paramref name="otherFlags"/>. Equivalent to the bitwise "xor" operator.
  3248. </summary>
  3249. <typeparam name="TEnum">The enum type.</typeparam>
  3250. <param name="value">The flags enum value.</param>
  3251. <param name="otherFlags">The other flags enum value.</param>
  3252. <returns><paramref name="value"/> while toggling the flags that are in <paramref name="otherFlags"/>.</returns>
  3253. </member>
  3254. <member name="M:EnumsNET.FlagEnums.CommonFlags``1(``0,``0)">
  3255. <summary>
  3256. Returns <paramref name="value"/> with only the flags that are also in <paramref name="otherFlags"/>. Equivalent to the bitwise "and" operation.
  3257. </summary>
  3258. <typeparam name="TEnum">The enum type.</typeparam>
  3259. <param name="value">The flags enum value.</param>
  3260. <param name="otherFlags">The other flags enum value.</param>
  3261. <returns><paramref name="value"/> with only the flags that are also in <paramref name="otherFlags"/>.</returns>
  3262. </member>
  3263. <member name="M:EnumsNET.FlagEnums.CombineFlags``1(``0,``0)">
  3264. <summary>
  3265. Combines the flags of <paramref name="value"/> and <paramref name="otherFlags"/>. Equivalent to the bitwise "or" operation.
  3266. </summary>
  3267. <typeparam name="TEnum">The enum type.</typeparam>
  3268. <param name="value">The flags enum value.</param>
  3269. <param name="otherFlags">The other flags enum value.</param>
  3270. <returns>Combination of <paramref name="value"/> with the flags in <paramref name="otherFlags"/>.</returns>
  3271. </member>
  3272. <member name="M:EnumsNET.FlagEnums.CombineFlags``1(``0,``0,``0)">
  3273. <summary>
  3274. Combines the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, and <paramref name="flag2"/>.
  3275. </summary>
  3276. <typeparam name="TEnum">The enum type.</typeparam>
  3277. <param name="flag0">The first flags enum value.</param>
  3278. <param name="flag1">The second flags enum value.</param>
  3279. <param name="flag2">The third flags enum value.</param>
  3280. <returns>Combination of the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, and <paramref name="flag2"/>.</returns>
  3281. </member>
  3282. <member name="M:EnumsNET.FlagEnums.CombineFlags``1(``0,``0,``0,``0)">
  3283. <summary>
  3284. Combines the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, <paramref name="flag2"/>, and <paramref name="flag3"/>.
  3285. </summary>
  3286. <typeparam name="TEnum">The enum type.</typeparam>
  3287. <param name="flag0">The first flags enum value.</param>
  3288. <param name="flag1">The second flags enum value.</param>
  3289. <param name="flag2">The third flags enum value.</param>
  3290. <param name="flag3">The fourth flags enum value.</param>
  3291. <returns>Combination of the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, <paramref name="flag2"/>, and <paramref name="flag3"/>.</returns>
  3292. </member>
  3293. <member name="M:EnumsNET.FlagEnums.CombineFlags``1(``0,``0,``0,``0,``0)">
  3294. <summary>
  3295. Combines the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, <paramref name="flag2"/>, <paramref name="flag3"/>, and <paramref name="flag4"/>.
  3296. </summary>
  3297. <typeparam name="TEnum">The enum type.</typeparam>
  3298. <param name="flag0">The first flags enum value.</param>
  3299. <param name="flag1">The second flags enum value.</param>
  3300. <param name="flag2">The third flags enum value.</param>
  3301. <param name="flag3">The fourth flags enum value.</param>
  3302. <param name="flag4">The fifth flags enum value.</param>
  3303. <returns>Combination of the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, <paramref name="flag2"/>, <paramref name="flag3"/>, and <paramref name="flag4"/>.</returns>
  3304. </member>
  3305. <member name="M:EnumsNET.FlagEnums.CombineFlags``1(``0[])">
  3306. <summary>
  3307. Combines all of the flags of <paramref name="flags"/>.
  3308. </summary>
  3309. <typeparam name="TEnum">The enum type.</typeparam>
  3310. <param name="flags">The flags enum values.</param>
  3311. <returns>Combination of all of the flags of <paramref name="flags"/>.</returns>
  3312. </member>
  3313. <member name="M:EnumsNET.FlagEnums.CombineFlags``1(System.Collections.Generic.IEnumerable{``0})">
  3314. <summary>
  3315. Combines all of the flags of <paramref name="flags"/>.
  3316. </summary>
  3317. <typeparam name="TEnum">The enum type.</typeparam>
  3318. <param name="flags">The flags enum values.</param>
  3319. <returns>Combination of all of the flags of <paramref name="flags"/>.</returns>
  3320. </member>
  3321. <member name="M:EnumsNET.FlagEnums.RemoveFlags``1(``0,``0)">
  3322. <summary>
  3323. Returns <paramref name="value"/> without the flags specified in <paramref name="otherFlags"/>.
  3324. </summary>
  3325. <typeparam name="TEnum">The enum type.</typeparam>
  3326. <param name="value">The flags enum value.</param>
  3327. <param name="otherFlags">The other flags enum value.</param>
  3328. <returns><paramref name="value"/> without the flags specified in <paramref name="otherFlags"/>.</returns>
  3329. </member>
  3330. <member name="M:EnumsNET.FlagEnums.ParseFlags``1(System.String)">
  3331. <summary>
  3332. Converts the string representation of one or more member names or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value.
  3333. </summary>
  3334. <typeparam name="TEnum">The enum type.</typeparam>
  3335. <param name="value">The enum member names or values' string representation.</param>
  3336. <returns>A <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  3337. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  3338. <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member name or value of <typeparamref name="TEnum"/>.</exception>
  3339. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of <typeparamref name="TEnum"/>'s underlying type.</exception>
  3340. </member>
  3341. <member name="M:EnumsNET.FlagEnums.ParseFlags``1(System.String,System.Boolean)">
  3342. <summary>
  3343. Converts the string representation of one or more member names or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value.
  3344. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  3345. </summary>
  3346. <typeparam name="TEnum">The enum type.</typeparam>
  3347. <param name="value">The enum member names or values' string representation.</param>
  3348. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3349. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  3350. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  3351. <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member name or value of <typeparamref name="TEnum"/>.</exception>
  3352. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  3353. </member>
  3354. <member name="M:EnumsNET.FlagEnums.ParseFlags``1(System.String,System.Boolean,System.String)">
  3355. <summary>
  3356. 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.
  3357. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  3358. </summary>
  3359. <typeparam name="TEnum">The enum type.</typeparam>
  3360. <param name="value">The enum member names or values' string representation.</param>
  3361. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3362. <param name="delimiter">The delimiter used to separate individual flags.</param>
  3363. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  3364. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  3365. <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member name or value of <typeparamref name="TEnum"/>.</exception>
  3366. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  3367. </member>
  3368. <member name="M:EnumsNET.FlagEnums.ParseFlags``1(System.String,System.Boolean,System.String,EnumsNET.EnumFormat)">
  3369. <summary>
  3370. 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
  3371. using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  3372. </summary>
  3373. <typeparam name="TEnum">The enum type.</typeparam>
  3374. <param name="value">The enum members or values' string representation.</param>
  3375. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3376. <param name="delimiter">The delimiter used to separate individual flags.</param>
  3377. <param name="format">The parsing enum format.</param>
  3378. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  3379. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  3380. <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
  3381. -or-
  3382. <paramref name="format"/> is an invalid value.</exception>
  3383. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  3384. </member>
  3385. <member name="M:EnumsNET.FlagEnums.ParseFlags``1(System.String,System.Boolean,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  3386. <summary>
  3387. 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
  3388. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  3389. </summary>
  3390. <typeparam name="TEnum">The enum type.</typeparam>
  3391. <param name="value">The enum members or values' string representation.</param>
  3392. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3393. <param name="delimiter">The delimiter used to separate individual flags.</param>
  3394. <param name="format0">The first parsing enum format.</param>
  3395. <param name="format1">The second parsing enum format.</param>
  3396. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  3397. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  3398. <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
  3399. -or-
  3400. <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  3401. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  3402. </member>
  3403. <member name="M:EnumsNET.FlagEnums.ParseFlags``1(System.String,System.Boolean,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  3404. <summary>
  3405. 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
  3406. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  3407. </summary>
  3408. <typeparam name="TEnum">The enum type.</typeparam>
  3409. <param name="value">The enum members or values' string representation.</param>
  3410. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3411. <param name="delimiter">The delimiter used to separate individual flags.</param>
  3412. <param name="format0">The first parsing enum format.</param>
  3413. <param name="format1">The second parsing enum format.</param>
  3414. <param name="format2">The third parsing enum format.</param>
  3415. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  3416. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  3417. <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
  3418. -or-
  3419. <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  3420. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  3421. </member>
  3422. <member name="M:EnumsNET.FlagEnums.ParseFlags``1(System.String,System.Boolean,System.String,EnumsNET.EnumFormat[])">
  3423. <summary>
  3424. 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
  3425. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  3426. </summary>
  3427. <typeparam name="TEnum">The enum type.</typeparam>
  3428. <param name="value">The enum members or values' string representation.</param>
  3429. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3430. <param name="delimiter">The delimiter used to separate individual flags.</param>
  3431. <param name="formats">The parsing enum formats.</param>
  3432. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  3433. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  3434. <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
  3435. -or-
  3436. <paramref name="formats"/> contains an invalid value.</exception>
  3437. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  3438. </member>
  3439. <member name="M:EnumsNET.FlagEnums.TryParseFlags``1(System.String,``0@)">
  3440. <summary>
  3441. 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.
  3442. The return value indicates whether the conversion succeeded.
  3443. </summary>
  3444. <typeparam name="TEnum">The enum type.</typeparam>
  3445. <param name="value">The enum member names or values' string representation.</param>
  3446. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  3447. <returns>Indication whether the conversion succeeded.</returns>
  3448. </member>
  3449. <member name="M:EnumsNET.FlagEnums.TryParseFlags``1(System.String,System.Boolean,``0@)">
  3450. <summary>
  3451. 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.
  3452. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive. The return value indicates whether the conversion succeeded.
  3453. </summary>
  3454. <typeparam name="TEnum">The enum type.</typeparam>
  3455. <param name="value">The enum member names or values' string representation.</param>
  3456. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3457. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  3458. <returns>Indication whether the conversion succeeded.</returns>
  3459. </member>
  3460. <member name="M:EnumsNET.FlagEnums.TryParseFlags``1(System.String,System.Boolean,System.String,``0@)">
  3461. <summary>
  3462. 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.
  3463. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive. The return value indicates whether the conversion succeeded.
  3464. </summary>
  3465. <typeparam name="TEnum">The enum type.</typeparam>
  3466. <param name="value">The enum member names or values' string representation.</param>
  3467. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3468. <param name="delimiter">The delimiter used to separate individual flags.</param>
  3469. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  3470. <returns>Indication whether the conversion succeeded.</returns>
  3471. </member>
  3472. <member name="M:EnumsNET.FlagEnums.TryParseFlags``1(System.String,System.Boolean,System.String,``0@,EnumsNET.EnumFormat)">
  3473. <summary>
  3474. 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
  3475. using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  3476. The return value indicates whether the conversion succeeded.
  3477. </summary>
  3478. <typeparam name="TEnum">The enum type.</typeparam>
  3479. <param name="value">The enum members or values' string representation.</param>
  3480. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3481. <param name="delimiter">The delimiter used to separate individual flags.</param>
  3482. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  3483. <param name="format">The parsing enum format.</param>
  3484. <returns>Indication whether the conversion succeeded.</returns>
  3485. <exception cref="T:System.ArgumentException"><paramref name="format"/> is an invalid value.</exception>
  3486. </member>
  3487. <member name="M:EnumsNET.FlagEnums.TryParseFlags``1(System.String,System.Boolean,System.String,``0@,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  3488. <summary>
  3489. 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
  3490. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  3491. The return value indicates whether the conversion succeeded.
  3492. </summary>
  3493. <typeparam name="TEnum">The enum type.</typeparam>
  3494. <param name="value">The enum members or values' string representation.</param>
  3495. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3496. <param name="delimiter">The delimiter used to separate individual flags.</param>
  3497. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  3498. <param name="format0">The first parsing enum format.</param>
  3499. <param name="format1">The first parsing enum format.</param>
  3500. <returns>Indication whether the conversion succeeded.</returns>
  3501. <exception cref="T:System.ArgumentException"><paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  3502. </member>
  3503. <member name="M:EnumsNET.FlagEnums.TryParseFlags``1(System.String,System.Boolean,System.String,``0@,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  3504. <summary>
  3505. 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
  3506. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  3507. The return value indicates whether the conversion succeeded.
  3508. </summary>
  3509. <typeparam name="TEnum">The enum type.</typeparam>
  3510. <param name="value">The enum members or values' string representation.</param>
  3511. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3512. <param name="delimiter">The delimiter used to separate individual flags.</param>
  3513. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  3514. <param name="format0">The first parsing enum format.</param>
  3515. <param name="format1">The second parsing enum format.</param>
  3516. <param name="format2">The third parsing enum format.</param>
  3517. <returns>Indication whether the conversion succeeded.</returns>
  3518. <exception cref="T:System.ArgumentException"><paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  3519. </member>
  3520. <member name="M:EnumsNET.FlagEnums.TryParseFlags``1(System.String,System.Boolean,System.String,``0@,EnumsNET.EnumFormat[])">
  3521. <summary>
  3522. 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
  3523. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  3524. The return value indicates whether the conversion succeeded.
  3525. </summary>
  3526. <typeparam name="TEnum">The enum type.</typeparam>
  3527. <param name="value">The enum members or values' string representation.</param>
  3528. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3529. <param name="delimiter">The delimiter used to separate individual flags.</param>
  3530. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  3531. <param name="formats">The parsing enum formats.</param>
  3532. <returns>Indication whether the conversion succeeded.</returns>
  3533. <exception cref="T:System.ArgumentException"><paramref name="formats"/> contains an invalid value.</exception>
  3534. </member>
  3535. <member name="M:EnumsNET.FlagEnums.IsFlagEnumUnsafe``1">
  3536. <summary>
  3537. Indicates if <typeparamref name="TEnum"/> is marked with the <see cref="T:System.FlagsAttribute"/>.
  3538. </summary>
  3539. <typeparam name="TEnum">The enum type.</typeparam>
  3540. <returns>Indication if <typeparamref name="TEnum"/> is marked with the <see cref="T:System.FlagsAttribute"/>.</returns>
  3541. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3542. </member>
  3543. <member name="M:EnumsNET.FlagEnums.GetAllFlagsUnsafe``1">
  3544. <summary>
  3545. Retrieves all the flags defined by <typeparamref name="TEnum"/>.
  3546. </summary>
  3547. <typeparam name="TEnum">The enum type.</typeparam>
  3548. <returns>All the flags defined by <typeparamref name="TEnum"/>.</returns>
  3549. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3550. </member>
  3551. <member name="M:EnumsNET.FlagEnums.IsValidFlagCombinationUnsafe``1(``0)">
  3552. <summary>
  3553. Indicates whether <paramref name="value"/> is a valid flag combination of <typeparamref name="TEnum"/>'s defined flags.
  3554. </summary>
  3555. <typeparam name="TEnum">The enum type.</typeparam>
  3556. <param name="value">The flags enum value.</param>
  3557. <returns>Indication of whether <paramref name="value"/> is a valid flag combination of <typeparamref name="TEnum"/>'s defined flags.</returns>
  3558. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3559. </member>
  3560. <member name="M:EnumsNET.FlagEnums.FormatFlagsUnsafe``1(``0)">
  3561. <summary>
  3562. 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".
  3563. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  3564. </summary>
  3565. <typeparam name="TEnum">The enum type.</typeparam>
  3566. <param name="value">The flags enum value.</param>
  3567. <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".
  3568. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  3569. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3570. </member>
  3571. <member name="M:EnumsNET.FlagEnums.FormatFlagsUnsafe``1(``0,System.String)">
  3572. <summary>
  3573. 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".
  3574. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  3575. </summary>
  3576. <typeparam name="TEnum">The enum type.</typeparam>
  3577. <param name="value">The flags enum value.</param>
  3578. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  3579. <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".
  3580. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  3581. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3582. </member>
  3583. <member name="M:EnumsNET.FlagEnums.FormatFlagsUnsafe``1(``0,System.String,EnumsNET.EnumFormat)">
  3584. <summary>
  3585. Retrieves <paramref name="value"/>'s flags formatted with <paramref name="format"/> and delimited with <paramref name="delimiter"/>
  3586. or if empty returns the zero flag formatted with <paramref name="format"/>.
  3587. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  3588. </summary>
  3589. <typeparam name="TEnum">The enum type.</typeparam>
  3590. <param name="value">The flags enum value.</param>
  3591. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  3592. <param name="format">The output format to use.</param>
  3593. <returns><paramref name="value"/>'s flags formatted with <paramref name="format"/> and delimited with <paramref name="delimiter"/>
  3594. or if empty returns the zero flag formatted with <paramref name="format"/>.
  3595. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  3596. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  3597. -or-
  3598. <paramref name="format"/> is an invalid value.</exception>
  3599. </member>
  3600. <member name="M:EnumsNET.FlagEnums.FormatFlagsUnsafe``1(``0,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  3601. <summary>
  3602. Retrieves <paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
  3603. or if empty returns the zero flag formatted with formats.
  3604. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  3605. </summary>
  3606. <typeparam name="TEnum">The enum type.</typeparam>
  3607. <param name="value">The flags enum value.</param>
  3608. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  3609. <param name="format0">The first output format to use.</param>
  3610. <param name="format1">The second output format to use.</param>
  3611. <returns><paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
  3612. or if empty returns the zero flag formatted with formats.
  3613. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  3614. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  3615. -or-
  3616. <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  3617. </member>
  3618. <member name="M:EnumsNET.FlagEnums.FormatFlagsUnsafe``1(``0,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  3619. <summary>
  3620. Retrieves <paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
  3621. or if empty returns the zero flag formatted with formats.
  3622. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  3623. </summary>
  3624. <typeparam name="TEnum">The enum type.</typeparam>
  3625. <param name="value">The flags enum value.</param>
  3626. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  3627. <param name="format0">The first output format to use.</param>
  3628. <param name="format1">The second output format to use.</param>
  3629. <param name="format2">The third output format to use.</param>
  3630. <returns><paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
  3631. or if empty returns the zero flag formatted with formats.
  3632. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  3633. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  3634. -or-
  3635. <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  3636. </member>
  3637. <member name="M:EnumsNET.FlagEnums.FormatFlagsUnsafe``1(``0,System.String,EnumsNET.EnumFormat[])">
  3638. <summary>
  3639. Retrieves <paramref name="value"/>'s flags formatted with <paramref name="formats"/> and delimited with <paramref name="delimiter"/>
  3640. or if empty returns the zero flag formatted with <paramref name="formats"/>.
  3641. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  3642. </summary>
  3643. <typeparam name="TEnum">The enum type.</typeparam>
  3644. <param name="value">The flags enum value.</param>
  3645. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  3646. <param name="formats">The output formats to use.</param>
  3647. <returns><paramref name="value"/>'s flags formatted with <paramref name="formats"/> and delimited with <paramref name="delimiter"/>
  3648. or if empty returns the zero flag formatted with <paramref name="formats"/>.
  3649. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  3650. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  3651. -or-
  3652. <paramref name="formats"/> contains an invalid value.</exception>
  3653. </member>
  3654. <member name="M:EnumsNET.FlagEnums.GetFlagsUnsafe``1(``0)">
  3655. <summary>
  3656. Retrieves the flags that compose <paramref name="value"/>.
  3657. </summary>
  3658. <typeparam name="TEnum">The enum type.</typeparam>
  3659. <param name="value">The flags enum value.</param>
  3660. <returns>The flags that compose <paramref name="value"/>.</returns>
  3661. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3662. </member>
  3663. <member name="M:EnumsNET.FlagEnums.GetFlagMembersUnsafe``1(``0)">
  3664. <summary>
  3665. Retrieves the <see cref="T:EnumsNET.EnumMember`1"/>s of the flags that compose <paramref name="value"/>.
  3666. </summary>
  3667. <typeparam name="TEnum">The enum type.</typeparam>
  3668. <param name="value">The flags enum value.</param>
  3669. <returns>The <see cref="T:EnumsNET.EnumMember`1"/>s of the flags that compose <paramref name="value"/>.</returns>
  3670. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3671. </member>
  3672. <member name="M:EnumsNET.FlagEnums.GetFlagCountUnsafe``1">
  3673. <summary>
  3674. Retrieves the flag count of <typeparamref name="TEnum"/>.
  3675. </summary>
  3676. <typeparam name="TEnum">The enum type.</typeparam>
  3677. <returns>The flag count of <typeparamref name="TEnum"/>.</returns>
  3678. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3679. </member>
  3680. <member name="M:EnumsNET.FlagEnums.GetFlagCountUnsafe``1(``0)">
  3681. <summary>
  3682. Retrieves the flag count of <paramref name="value"/>.
  3683. </summary>
  3684. <typeparam name="TEnum">The enum type.</typeparam>
  3685. <param name="value">The flags enum value.</param>
  3686. <returns>The flag count of <paramref name="value"/>.</returns>
  3687. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3688. </member>
  3689. <member name="M:EnumsNET.FlagEnums.GetFlagCountUnsafe``1(``0,``0)">
  3690. <summary>
  3691. Retrieves the flag count of <paramref name="otherFlags"/> that <paramref name="value"/> has.
  3692. </summary>
  3693. <typeparam name="TEnum">The enum type.</typeparam>
  3694. <param name="value">The flags enum value.</param>
  3695. <param name="otherFlags">The other flags enum value.</param>
  3696. <returns>The flag count of <paramref name="otherFlags"/> that <paramref name="value"/> has.</returns>
  3697. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3698. </member>
  3699. <member name="M:EnumsNET.FlagEnums.HasAnyFlagsUnsafe``1(``0)">
  3700. <summary>
  3701. Indicates if <paramref name="value"/> has any flags.
  3702. </summary>
  3703. <typeparam name="TEnum">The enum type.</typeparam>
  3704. <param name="value">The flags enum value.</param>
  3705. <returns>Indication if <paramref name="value"/> has any flags.</returns>
  3706. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3707. </member>
  3708. <member name="M:EnumsNET.FlagEnums.HasAnyFlagsUnsafe``1(``0,``0)">
  3709. <summary>
  3710. Indicates if <paramref name="value"/> has any flags that are in <paramref name="otherFlags"/>.
  3711. </summary>
  3712. <typeparam name="TEnum">The enum type.</typeparam>
  3713. <param name="value">The flags enum value.</param>
  3714. <param name="otherFlags">The other flags enum value.</param>
  3715. <returns>Indication if <paramref name="value"/> has any flags that are in <paramref name="otherFlags"/>.</returns>
  3716. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3717. </member>
  3718. <member name="M:EnumsNET.FlagEnums.HasAllFlagsUnsafe``1(``0)">
  3719. <summary>
  3720. Indicates if <paramref name="value"/> has all of the flags that are defined in <typeparamref name="TEnum"/>.
  3721. </summary>
  3722. <typeparam name="TEnum">The enum type.</typeparam>
  3723. <param name="value">The flags enum value.</param>
  3724. <returns>Indication if <paramref name="value"/> has all of the flags that are defined in <typeparamref name="TEnum"/>.</returns>
  3725. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3726. </member>
  3727. <member name="M:EnumsNET.FlagEnums.HasAllFlagsUnsafe``1(``0,``0)">
  3728. <summary>
  3729. Indicates if <paramref name="value"/> has all of the flags that are in <paramref name="otherFlags"/>.
  3730. </summary>
  3731. <typeparam name="TEnum">The enum type.</typeparam>
  3732. <param name="value">The flags enum value.</param>
  3733. <param name="otherFlags">The other flags enum value.</param>
  3734. <returns>Indication if <paramref name="value"/> has all of the flags that are in <paramref name="otherFlags"/>.</returns>
  3735. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3736. </member>
  3737. <member name="M:EnumsNET.FlagEnums.ToggleFlagsUnsafe``1(``0)">
  3738. <summary>
  3739. 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"/>.
  3740. </summary>
  3741. <typeparam name="TEnum">The enum type.</typeparam>
  3742. <param name="value">The flags enum value.</param>
  3743. <returns><paramref name="value"/> with all of it's flags toggled.</returns>
  3744. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3745. </member>
  3746. <member name="M:EnumsNET.FlagEnums.ToggleFlagsUnsafe``1(``0,``0)">
  3747. <summary>
  3748. Returns <paramref name="value"/> while toggling the flags that are in <paramref name="otherFlags"/>. Equivalent to the bitwise "xor" operator.
  3749. </summary>
  3750. <typeparam name="TEnum">The enum type.</typeparam>
  3751. <param name="value">The flags enum value.</param>
  3752. <param name="otherFlags">The other flags enum value.</param>
  3753. <returns><paramref name="value"/> while toggling the flags that are in <paramref name="otherFlags"/>.</returns>
  3754. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3755. </member>
  3756. <member name="M:EnumsNET.FlagEnums.CommonFlagsUnsafe``1(``0,``0)">
  3757. <summary>
  3758. Returns <paramref name="value"/> with only the flags that are also in <paramref name="otherFlags"/>. Equivalent to the bitwise "and" operation.
  3759. </summary>
  3760. <typeparam name="TEnum">The enum type.</typeparam>
  3761. <param name="value">The flags enum value.</param>
  3762. <param name="otherFlags">The other flags enum value.</param>
  3763. <returns><paramref name="value"/> with only the flags that are also in <paramref name="otherFlags"/>.</returns>
  3764. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3765. </member>
  3766. <member name="M:EnumsNET.FlagEnums.CombineFlagsUnsafe``1(``0,``0)">
  3767. <summary>
  3768. Combines the flags of <paramref name="value"/> and <paramref name="otherFlags"/>. Equivalent to the bitwise "or" operation.
  3769. </summary>
  3770. <typeparam name="TEnum">The enum type.</typeparam>
  3771. <param name="value">The flags enum value.</param>
  3772. <param name="otherFlags">The other flags enum value.</param>
  3773. <returns>Combination of <paramref name="value"/> with the flags in <paramref name="otherFlags"/>.</returns>
  3774. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3775. </member>
  3776. <member name="M:EnumsNET.FlagEnums.CombineFlagsUnsafe``1(``0,``0,``0)">
  3777. <summary>
  3778. Combines the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, and <paramref name="flag2"/>.
  3779. </summary>
  3780. <typeparam name="TEnum">The enum type.</typeparam>
  3781. <param name="flag0">The first flags enum value.</param>
  3782. <param name="flag1">The second flags enum value.</param>
  3783. <param name="flag2">The third flags enum value.</param>
  3784. <returns>Combination of the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, and <paramref name="flag2"/>.</returns>
  3785. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3786. </member>
  3787. <member name="M:EnumsNET.FlagEnums.CombineFlagsUnsafe``1(``0,``0,``0,``0)">
  3788. <summary>
  3789. Combines the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, <paramref name="flag2"/>, and <paramref name="flag3"/>.
  3790. </summary>
  3791. <typeparam name="TEnum">The enum type.</typeparam>
  3792. <param name="flag0">The first flags enum value.</param>
  3793. <param name="flag1">The second flags enum value.</param>
  3794. <param name="flag2">The third flags enum value.</param>
  3795. <param name="flag3">The fourth flags enum value.</param>
  3796. <returns>Combination of the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, <paramref name="flag2"/>, and <paramref name="flag3"/>.</returns>
  3797. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3798. </member>
  3799. <member name="M:EnumsNET.FlagEnums.CombineFlagsUnsafe``1(``0,``0,``0,``0,``0)">
  3800. <summary>
  3801. Combines the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, <paramref name="flag2"/>, <paramref name="flag3"/>, and <paramref name="flag4"/>.
  3802. </summary>
  3803. <typeparam name="TEnum">The enum type.</typeparam>
  3804. <param name="flag0">The first flags enum value.</param>
  3805. <param name="flag1">The second flags enum value.</param>
  3806. <param name="flag2">The third flags enum value.</param>
  3807. <param name="flag3">The fourth flags enum value.</param>
  3808. <param name="flag4">The fifth flags enum value.</param>
  3809. <returns>Combination of the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, <paramref name="flag2"/>, <paramref name="flag3"/>, and <paramref name="flag4"/>.</returns>
  3810. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3811. </member>
  3812. <member name="M:EnumsNET.FlagEnums.CombineFlagsUnsafe``1(``0[])">
  3813. <summary>
  3814. Combines all of the flags of <paramref name="flags"/>.
  3815. </summary>
  3816. <typeparam name="TEnum">The enum type.</typeparam>
  3817. <param name="flags">The flags enum values.</param>
  3818. <returns>Combination of all of the flags of <paramref name="flags"/>.</returns>
  3819. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3820. </member>
  3821. <member name="M:EnumsNET.FlagEnums.CombineFlagsUnsafe``1(System.Collections.Generic.IEnumerable{``0})">
  3822. <summary>
  3823. Combines all of the flags of <paramref name="flags"/>.
  3824. </summary>
  3825. <typeparam name="TEnum">The enum type.</typeparam>
  3826. <param name="flags">The flags enum values.</param>
  3827. <returns>Combination of all of the flags of <paramref name="flags"/>.</returns>
  3828. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3829. </member>
  3830. <member name="M:EnumsNET.FlagEnums.RemoveFlagsUnsafe``1(``0,``0)">
  3831. <summary>
  3832. Returns <paramref name="value"/> without the flags specified in <paramref name="otherFlags"/>.
  3833. </summary>
  3834. <typeparam name="TEnum">The enum type.</typeparam>
  3835. <param name="value">The flags enum value.</param>
  3836. <param name="otherFlags">The other flags enum value.</param>
  3837. <returns><paramref name="value"/> without the flags specified in <paramref name="otherFlags"/>.</returns>
  3838. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3839. </member>
  3840. <member name="M:EnumsNET.FlagEnums.ParseFlagsUnsafe``1(System.String)">
  3841. <summary>
  3842. Converts the string representation of one or more member names or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value.
  3843. </summary>
  3844. <typeparam name="TEnum">The enum type.</typeparam>
  3845. <param name="value">The enum member names or values' string representation.</param>
  3846. <returns>A <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  3847. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  3848. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  3849. -or-
  3850. <paramref name="value"/> doesn't represent a member name or value of <typeparamref name="TEnum"/>.</exception>
  3851. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of <typeparamref name="TEnum"/>'s underlying type.</exception>
  3852. </member>
  3853. <member name="M:EnumsNET.FlagEnums.ParseFlagsUnsafe``1(System.String,System.Boolean)">
  3854. <summary>
  3855. Converts the string representation of one or more member names or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value.
  3856. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  3857. </summary>
  3858. <typeparam name="TEnum">The enum type.</typeparam>
  3859. <param name="value">The enum member names or values' string representation.</param>
  3860. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3861. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  3862. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  3863. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  3864. -or-
  3865. <paramref name="value"/> doesn't represent a member name or value of <typeparamref name="TEnum"/>.</exception>
  3866. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  3867. </member>
  3868. <member name="M:EnumsNET.FlagEnums.ParseFlagsUnsafe``1(System.String,System.Boolean,System.String)">
  3869. <summary>
  3870. 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.
  3871. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  3872. </summary>
  3873. <typeparam name="TEnum">The enum type.</typeparam>
  3874. <param name="value">The enum member names or values' string representation.</param>
  3875. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3876. <param name="delimiter">The delimiter used to separate individual flags.</param>
  3877. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  3878. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  3879. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  3880. -or-
  3881. <paramref name="value"/> doesn't represent a member name or value of <typeparamref name="TEnum"/>.</exception>
  3882. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  3883. </member>
  3884. <member name="M:EnumsNET.FlagEnums.ParseFlagsUnsafe``1(System.String,System.Boolean,System.String,EnumsNET.EnumFormat)">
  3885. <summary>
  3886. 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
  3887. using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  3888. </summary>
  3889. <typeparam name="TEnum">The enum type.</typeparam>
  3890. <param name="value">The enum members or values' string representation.</param>
  3891. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3892. <param name="delimiter">The delimiter used to separate individual flags.</param>
  3893. <param name="format">The parsing enum format.</param>
  3894. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  3895. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  3896. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  3897. -or-
  3898. <paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
  3899. -or-
  3900. <paramref name="format"/> is an invalid value.</exception>
  3901. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  3902. </member>
  3903. <member name="M:EnumsNET.FlagEnums.ParseFlagsUnsafe``1(System.String,System.Boolean,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  3904. <summary>
  3905. 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
  3906. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  3907. </summary>
  3908. <typeparam name="TEnum">The enum type.</typeparam>
  3909. <param name="value">The enum members or values' string representation.</param>
  3910. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3911. <param name="delimiter">The delimiter used to separate individual flags.</param>
  3912. <param name="format0">The first parsing enum format.</param>
  3913. <param name="format1">The second parsing enum format.</param>
  3914. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  3915. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  3916. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  3917. -or-
  3918. <paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
  3919. -or-
  3920. <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  3921. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  3922. </member>
  3923. <member name="M:EnumsNET.FlagEnums.ParseFlagsUnsafe``1(System.String,System.Boolean,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  3924. <summary>
  3925. 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
  3926. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  3927. </summary>
  3928. <typeparam name="TEnum">The enum type.</typeparam>
  3929. <param name="value">The enum members or values' string representation.</param>
  3930. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3931. <param name="delimiter">The delimiter used to separate individual flags.</param>
  3932. <param name="format0">The first parsing enum format.</param>
  3933. <param name="format1">The second parsing enum format.</param>
  3934. <param name="format2">The third parsing enum format.</param>
  3935. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  3936. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  3937. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  3938. -or-
  3939. <paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
  3940. -or-
  3941. <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  3942. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  3943. </member>
  3944. <member name="M:EnumsNET.FlagEnums.ParseFlagsUnsafe``1(System.String,System.Boolean,System.String,EnumsNET.EnumFormat[])">
  3945. <summary>
  3946. 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
  3947. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  3948. </summary>
  3949. <typeparam name="TEnum">The enum type.</typeparam>
  3950. <param name="value">The enum members or values' string representation.</param>
  3951. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3952. <param name="delimiter">The delimiter used to separate individual flags.</param>
  3953. <param name="formats">The parsing enum formats.</param>
  3954. <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
  3955. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
  3956. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  3957. -or-
  3958. <paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
  3959. -or-
  3960. <paramref name="formats"/> contains an invalid value.</exception>
  3961. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
  3962. </member>
  3963. <member name="M:EnumsNET.FlagEnums.TryParseFlagsUnsafe``1(System.String,``0@)">
  3964. <summary>
  3965. 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.
  3966. The return value indicates whether the conversion succeeded.
  3967. </summary>
  3968. <typeparam name="TEnum">The enum type.</typeparam>
  3969. <param name="value">The enum member names or values' string representation.</param>
  3970. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  3971. <returns>Indication whether the conversion succeeded.</returns>
  3972. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3973. </member>
  3974. <member name="M:EnumsNET.FlagEnums.TryParseFlagsUnsafe``1(System.String,System.Boolean,``0@)">
  3975. <summary>
  3976. 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.
  3977. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive. The return value indicates whether the conversion succeeded.
  3978. </summary>
  3979. <typeparam name="TEnum">The enum type.</typeparam>
  3980. <param name="value">The enum member names or values' string representation.</param>
  3981. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3982. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  3983. <returns>Indication whether the conversion succeeded.</returns>
  3984. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3985. </member>
  3986. <member name="M:EnumsNET.FlagEnums.TryParseFlagsUnsafe``1(System.String,System.Boolean,System.String,``0@)">
  3987. <summary>
  3988. 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.
  3989. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive. The return value indicates whether the conversion succeeded.
  3990. </summary>
  3991. <typeparam name="TEnum">The enum type.</typeparam>
  3992. <param name="value">The enum member names or values' string representation.</param>
  3993. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  3994. <param name="delimiter">The delimiter used to separate individual flags.</param>
  3995. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  3996. <returns>Indication whether the conversion succeeded.</returns>
  3997. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
  3998. </member>
  3999. <member name="M:EnumsNET.FlagEnums.TryParseFlagsUnsafe``1(System.String,System.Boolean,System.String,``0@,EnumsNET.EnumFormat)">
  4000. <summary>
  4001. 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
  4002. using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  4003. The return value indicates whether the conversion succeeded.
  4004. </summary>
  4005. <typeparam name="TEnum">The enum type.</typeparam>
  4006. <param name="value">The enum members or values' string representation.</param>
  4007. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4008. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4009. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  4010. <param name="format">The parsing enum format.</param>
  4011. <returns>Indication whether the conversion succeeded.</returns>
  4012. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  4013. -or-
  4014. <paramref name="format"/> is an invalid value.</exception>
  4015. </member>
  4016. <member name="M:EnumsNET.FlagEnums.TryParseFlagsUnsafe``1(System.String,System.Boolean,System.String,``0@,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  4017. <summary>
  4018. 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
  4019. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  4020. The return value indicates whether the conversion succeeded.
  4021. </summary>
  4022. <typeparam name="TEnum">The enum type.</typeparam>
  4023. <param name="value">The enum members or values' string representation.</param>
  4024. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4025. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4026. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  4027. <param name="format0">The first parsing enum format.</param>
  4028. <param name="format1">The second parsing enum format.</param>
  4029. <returns>Indication whether the conversion succeeded.</returns>
  4030. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  4031. -or-
  4032. <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  4033. </member>
  4034. <member name="M:EnumsNET.FlagEnums.TryParseFlagsUnsafe``1(System.String,System.Boolean,System.String,``0@,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  4035. <summary>
  4036. 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
  4037. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  4038. The return value indicates whether the conversion succeeded.
  4039. </summary>
  4040. <typeparam name="TEnum">The enum type.</typeparam>
  4041. <param name="value">The enum members or values' string representation.</param>
  4042. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4043. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4044. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  4045. <param name="format0">The first parsing enum format.</param>
  4046. <param name="format1">The second parsing enum format.</param>
  4047. <param name="format2">The third parsing enum format.</param>
  4048. <returns>Indication whether the conversion succeeded.</returns>
  4049. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  4050. -or-
  4051. <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  4052. </member>
  4053. <member name="M:EnumsNET.FlagEnums.TryParseFlagsUnsafe``1(System.String,System.Boolean,System.String,``0@,EnumsNET.EnumFormat[])">
  4054. <summary>
  4055. 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
  4056. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  4057. The return value indicates whether the conversion succeeded.
  4058. </summary>
  4059. <typeparam name="TEnum">The enum type.</typeparam>
  4060. <param name="value">The enum members or values' string representation.</param>
  4061. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4062. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4063. <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
  4064. <param name="formats">The parsing enum formats.</param>
  4065. <returns>Indication whether the conversion succeeded.</returns>
  4066. <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
  4067. -or-
  4068. <paramref name="formats"/> contains an invalid value.</exception>
  4069. </member>
  4070. <member name="M:EnumsNET.FlagEnums.IsFlagEnum(System.Type)">
  4071. <summary>
  4072. Indicates if <paramref name="enumType"/> is marked with the <see cref="T:System.FlagsAttribute"/>.
  4073. </summary>
  4074. <param name="enumType">The enum type.</param>
  4075. <returns>Indication if <paramref name="enumType"/> is marked with the <see cref="T:System.FlagsAttribute"/>.</returns>
  4076. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  4077. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
  4078. </member>
  4079. <member name="M:EnumsNET.FlagEnums.GetAllFlags(System.Type)">
  4080. <summary>
  4081. Retrieves all the flags defined by <paramref name="enumType"/>.
  4082. </summary>
  4083. <param name="enumType">The enum type.</param>
  4084. <returns>All the flags defined by <paramref name="enumType"/>.</returns>
  4085. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  4086. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
  4087. </member>
  4088. <member name="M:EnumsNET.FlagEnums.IsValidFlagCombination(System.Type,System.Object)">
  4089. <summary>
  4090. Indicates whether <paramref name="value"/> is a valid flag combination of <paramref name="enumType"/>'s defined flags.
  4091. </summary>
  4092. <param name="enumType">The enum type.</param>
  4093. <param name="value">The flags enum value.</param>
  4094. <returns>Indication of whether <paramref name="value"/> is a valid flag combination of <paramref name="enumType"/>'s defined flags.</returns>
  4095. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4096. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4097. -or-
  4098. <paramref name="value"/> is of an invalid type.</exception>
  4099. </member>
  4100. <member name="M:EnumsNET.FlagEnums.FormatFlags(System.Type,System.Object)">
  4101. <summary>
  4102. 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".
  4103. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  4104. </summary>
  4105. <param name="enumType">The enum type.</param>
  4106. <param name="value">The flags enum value.</param>
  4107. <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".
  4108. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  4109. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4110. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4111. -or-
  4112. <paramref name="value"/> is of an invalid type.</exception>
  4113. </member>
  4114. <member name="M:EnumsNET.FlagEnums.FormatFlags(System.Type,System.Object,System.String)">
  4115. <summary>
  4116. 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".
  4117. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  4118. </summary>
  4119. <param name="enumType">The enum type.</param>
  4120. <param name="value">The flags enum value.</param>
  4121. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  4122. <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".
  4123. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  4124. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4125. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4126. -or-
  4127. <paramref name="value"/> is of an invalid type.</exception>
  4128. </member>
  4129. <member name="M:EnumsNET.FlagEnums.FormatFlags(System.Type,System.Object,System.String,EnumsNET.EnumFormat)">
  4130. <summary>
  4131. Retrieves <paramref name="value"/>'s flags formatted with <paramref name="format"/> and delimited with <paramref name="delimiter"/>
  4132. or if empty returns the zero flag formatted with <paramref name="format"/>.
  4133. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  4134. </summary>
  4135. <param name="enumType">The enum type.</param>
  4136. <param name="value">The flags enum value.</param>
  4137. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  4138. <param name="format">The output format to use.</param>
  4139. <returns><paramref name="value"/>'s flags formatted with <paramref name="format"/> and delimited with <paramref name="delimiter"/>
  4140. or if empty returns the zero flag formatted with <paramref name="format"/>.
  4141. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  4142. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4143. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4144. -or-
  4145. <paramref name="value"/> is of an invalid type
  4146. -or-
  4147. <paramref name="format"/> is an invalid value.</exception>
  4148. </member>
  4149. <member name="M:EnumsNET.FlagEnums.FormatFlags(System.Type,System.Object,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  4150. <summary>
  4151. Retrieves <paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
  4152. or if empty returns the zero flag formatted with formats.
  4153. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  4154. </summary>
  4155. <param name="enumType">The enum type.</param>
  4156. <param name="value">The flags enum value.</param>
  4157. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  4158. <param name="format0">The first output format to use.</param>
  4159. <param name="format1">The second output format to use.</param>
  4160. <returns><paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
  4161. or if empty returns the zero flag formatted with formats.
  4162. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  4163. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4164. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4165. -or-
  4166. <paramref name="value"/> is of an invalid type
  4167. -or-
  4168. <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  4169. </member>
  4170. <member name="M:EnumsNET.FlagEnums.FormatFlags(System.Type,System.Object,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  4171. <summary>
  4172. Retrieves <paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
  4173. or if empty returns the zero flag formatted with formats.
  4174. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  4175. </summary>
  4176. <param name="enumType">The enum type.</param>
  4177. <param name="value">The flags enum value.</param>
  4178. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  4179. <param name="format0">The first output format to use.</param>
  4180. <param name="format1">The second output format to use.</param>
  4181. <param name="format2">The third output format to use.</param>
  4182. <returns><paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
  4183. or if empty returns the zero flag formatted with formats.
  4184. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  4185. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4186. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4187. -or-
  4188. <paramref name="value"/> is of an invalid type
  4189. -or-
  4190. <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  4191. </member>
  4192. <member name="M:EnumsNET.FlagEnums.FormatFlags(System.Type,System.Object,System.String,EnumsNET.EnumFormat[])">
  4193. <summary>
  4194. Retrieves <paramref name="value"/>'s flags formatted with <paramref name="formats"/> and delimited with <paramref name="delimiter"/>
  4195. or if empty returns the zero flag formatted with <paramref name="formats"/>.
  4196. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
  4197. </summary>
  4198. <param name="enumType">The enum type.</param>
  4199. <param name="value">The flags enum value.</param>
  4200. <param name="delimiter">The delimiter to use to separate individual flags.</param>
  4201. <param name="formats">The output formats to use.</param>
  4202. <returns><paramref name="value"/>'s flags formatted with <paramref name="formats"/> and delimited with <paramref name="delimiter"/>
  4203. or if empty returns the zero flag formatted with <paramref name="formats"/>.
  4204. If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
  4205. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4206. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4207. -or-
  4208. <paramref name="value"/> is of an invalid type
  4209. -or-
  4210. <paramref name="formats"/> contains an invalid value.</exception>
  4211. </member>
  4212. <member name="M:EnumsNET.FlagEnums.GetFlags(System.Type,System.Object)">
  4213. <summary>
  4214. Retrieves the flags that compose <paramref name="value"/>.
  4215. </summary>
  4216. <param name="enumType">The enum type.</param>
  4217. <param name="value">The flags enum value.</param>
  4218. <returns>The flags that compose <paramref name="value"/>.</returns>
  4219. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4220. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4221. -or-
  4222. <paramref name="value"/> is of an invalid type.</exception>
  4223. </member>
  4224. <member name="M:EnumsNET.FlagEnums.GetFlagMembers(System.Type,System.Object)">
  4225. <summary>
  4226. Retrieves the <see cref="T:EnumsNET.EnumMember"/>s of the flags that compose <paramref name="value"/>.
  4227. </summary>
  4228. <param name="enumType">The enum type.</param>
  4229. <param name="value">The flags enum value.</param>
  4230. <returns>The <see cref="T:EnumsNET.EnumMember"/>s of the flags that compose <paramref name="value"/>.</returns>
  4231. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4232. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4233. -or-
  4234. <paramref name="value"/> is of an invalid type.</exception>
  4235. </member>
  4236. <member name="M:EnumsNET.FlagEnums.GetFlagCount(System.Type)">
  4237. <summary>
  4238. Retrieves the flag count of <paramref name="enumType"/>.
  4239. </summary>
  4240. <param name="enumType">The enum type.</param>
  4241. <returns>The flag count of <paramref name="enumType"/>.</returns>
  4242. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  4243. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
  4244. </member>
  4245. <member name="M:EnumsNET.FlagEnums.GetFlagCount(System.Type,System.Object)">
  4246. <summary>
  4247. Retrieves the flag count of <paramref name="value"/>.
  4248. </summary>
  4249. <param name="enumType">The enum type.</param>
  4250. <param name="value">The flags enum value.</param>
  4251. <returns>The flag count of <paramref name="value"/>.</returns>
  4252. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4253. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4254. -or-
  4255. <paramref name="value"/> is of an invalid type.</exception>
  4256. </member>
  4257. <member name="M:EnumsNET.FlagEnums.GetFlagCount(System.Type,System.Object,System.Object)">
  4258. <summary>
  4259. Retrieves the flag count of <paramref name="otherFlags"/> that <paramref name="value"/> has.
  4260. </summary>
  4261. <param name="enumType">The enum type.</param>
  4262. <param name="value">The flags enum value.</param>
  4263. <param name="otherFlags">The other flags enum value.</param>
  4264. <returns>The flag count of <paramref name="otherFlags"/> that <paramref name="value"/> has.</returns>
  4265. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/>, <paramref name="value"/>, or <paramref name="otherFlags"/> is <c>null</c>.</exception>
  4266. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4267. -or-
  4268. <paramref name="value"/> or <paramref name="otherFlags"/> is of an invalid type.</exception>
  4269. </member>
  4270. <member name="M:EnumsNET.FlagEnums.HasAnyFlags(System.Type,System.Object)">
  4271. <summary>
  4272. Indicates if <paramref name="value"/> has any flags.
  4273. </summary>
  4274. <param name="enumType">The enum type.</param>
  4275. <param name="value">The flags enum value.</param>
  4276. <returns>Indication if <paramref name="value"/> has any flags.</returns>
  4277. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4278. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4279. -or-
  4280. <paramref name="value"/> is of an invalid type.</exception>
  4281. </member>
  4282. <member name="M:EnumsNET.FlagEnums.HasAnyFlags(System.Type,System.Object,System.Object)">
  4283. <summary>
  4284. Indicates if <paramref name="value"/> has any flags that are in <paramref name="otherFlags"/>.
  4285. </summary>
  4286. <param name="enumType">The enum type.</param>
  4287. <param name="value">The flags enum value.</param>
  4288. <param name="otherFlags">The other flags enum value.</param>
  4289. <returns>Indication if <paramref name="value"/> has any flags that are in <paramref name="otherFlags"/>.</returns>
  4290. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/>, <paramref name="value"/>, or <paramref name="otherFlags"/> is <c>null</c>.</exception>
  4291. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4292. -or-
  4293. <paramref name="value"/> or <paramref name="otherFlags"/> is of an invalid type.</exception>
  4294. </member>
  4295. <member name="M:EnumsNET.FlagEnums.HasAllFlags(System.Type,System.Object)">
  4296. <summary>
  4297. Indicates if <paramref name="value"/> has all of the flags that are defined in <paramref name="enumType"/>.
  4298. </summary>
  4299. <param name="enumType">The enum type.</param>
  4300. <param name="value">The flags enum value.</param>
  4301. <returns>Indication if <paramref name="value"/> has all of the flags that are defined in <paramref name="enumType"/>.</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.HasAllFlags(System.Type,System.Object,System.Object)">
  4308. <summary>
  4309. Indicates if <paramref name="value"/> has all of the flags that are in <paramref name="otherFlags"/>.
  4310. </summary>
  4311. <param name="enumType">The enum type.</param>
  4312. <param name="value">The flags enum value.</param>
  4313. <param name="otherFlags">The other flags enum value.</param>
  4314. <returns>Indication if <paramref name="value"/> has all of the flags that are in <paramref name="otherFlags"/>.</returns>
  4315. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/>, <paramref name="value"/>, or <paramref name="otherFlags"/> is <c>null</c>.</exception>
  4316. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4317. -or-
  4318. <paramref name="value"/> or <paramref name="otherFlags"/> is of an invalid type.</exception>
  4319. </member>
  4320. <member name="M:EnumsNET.FlagEnums.ToggleFlags(System.Type,System.Object)">
  4321. <summary>
  4322. 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)"/>.
  4323. </summary>
  4324. <param name="enumType">The enum type.</param>
  4325. <param name="value">The flags enum value.</param>
  4326. <returns><paramref name="value"/> with all of it's flags toggled.</returns>
  4327. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4328. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4329. -or-
  4330. <paramref name="value"/> is of an invalid type.</exception>
  4331. </member>
  4332. <member name="M:EnumsNET.FlagEnums.ToggleFlags(System.Type,System.Object,System.Object)">
  4333. <summary>
  4334. Returns <paramref name="value"/> while toggling the flags that are in <paramref name="otherFlags"/>. Equivalent to the bitwise "xor" operator.
  4335. </summary>
  4336. <param name="enumType">The enum type.</param>
  4337. <param name="value">The flags enum value.</param>
  4338. <param name="otherFlags">The other flags enum value.</param>
  4339. <returns><paramref name="value"/> while toggling the flags that are in <paramref name="otherFlags"/>.</returns>
  4340. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/>, <paramref name="value"/>, or <paramref name="otherFlags"/> is <c>null</c>.</exception>
  4341. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4342. -or-
  4343. <paramref name="value"/> or <paramref name="otherFlags"/> is of an invalid type.</exception>
  4344. </member>
  4345. <member name="M:EnumsNET.FlagEnums.CommonFlags(System.Type,System.Object,System.Object)">
  4346. <summary>
  4347. Returns <paramref name="value"/> with only the flags that are also in <paramref name="otherFlags"/>. Equivalent to the bitwise "and" operation.
  4348. </summary>
  4349. <param name="enumType">The enum type.</param>
  4350. <param name="value">The flags enum value.</param>
  4351. <param name="otherFlags">The other flags enum value.</param>
  4352. <returns><paramref name="value"/> with only the flags that are also in <paramref name="otherFlags"/>.</returns>
  4353. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/>, <paramref name="value"/>, or <paramref name="otherFlags"/> is <c>null</c>.</exception>
  4354. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4355. -or-
  4356. <paramref name="value"/> or <paramref name="otherFlags"/> is of an invalid type.</exception>
  4357. </member>
  4358. <member name="M:EnumsNET.FlagEnums.CombineFlags(System.Type,System.Object,System.Object)">
  4359. <summary>
  4360. Combines the flags of <paramref name="value"/> and <paramref name="otherFlags"/>. Equivalent to the bitwise "or" operation.
  4361. </summary>
  4362. <param name="enumType">The enum type.</param>
  4363. <param name="value">The flags enum value.</param>
  4364. <param name="otherFlags">The other flags enum value.</param>
  4365. <returns>Combination of <paramref name="value"/> with the flags in <paramref name="otherFlags"/>.</returns>
  4366. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/>, <paramref name="value"/>, or <paramref name="otherFlags"/> is <c>null</c>.</exception>
  4367. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4368. -or-
  4369. <paramref name="value"/> or <paramref name="otherFlags"/> is of an invalid type.</exception>
  4370. </member>
  4371. <member name="M:EnumsNET.FlagEnums.CombineFlags(System.Type,System.Object[])">
  4372. <summary>
  4373. Combines all of the flags of <paramref name="flags"/>.
  4374. </summary>
  4375. <param name="enumType">The enum type.</param>
  4376. <param name="flags">The flags enum values.</param>
  4377. <returns>Combination of all of the flags of <paramref name="flags"/>.</returns>
  4378. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or one of the <paramref name="flags"/> is <c>null</c>.</exception>
  4379. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4380. -or-
  4381. <paramref name="flags"/> contains a value that is of an invalid type.</exception>
  4382. </member>
  4383. <member name="M:EnumsNET.FlagEnums.CombineFlags(System.Type,System.Collections.Generic.IEnumerable{System.Object})">
  4384. <summary>
  4385. Combines all of the flags of <paramref name="flags"/>.
  4386. </summary>
  4387. <param name="enumType">The enum type.</param>
  4388. <param name="flags">The flags enum values.</param>
  4389. <returns>Combination of all of the flags of <paramref name="flags"/>.</returns>
  4390. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or one of the <paramref name="flags"/> is <c>null</c>.</exception>
  4391. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4392. -or-
  4393. <paramref name="flags"/> contains a value that is of an invalid type.</exception>
  4394. </member>
  4395. <member name="M:EnumsNET.FlagEnums.RemoveFlags(System.Type,System.Object,System.Object)">
  4396. <summary>
  4397. Returns <paramref name="value"/> without the flags specified in <paramref name="otherFlags"/>.
  4398. </summary>
  4399. <param name="enumType">The enum type.</param>
  4400. <param name="value">The flags enum value.</param>
  4401. <param name="otherFlags">The other flags enum value.</param>
  4402. <returns><paramref name="value"/> without the flags specified in <paramref name="otherFlags"/>.</returns>
  4403. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/>, <paramref name="value"/>, or <paramref name="otherFlags"/> is <c>null</c>.</exception>
  4404. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4405. -or-
  4406. <paramref name="value"/> or <paramref name="otherFlags"/> is of an invalid type.</exception>
  4407. </member>
  4408. <member name="M:EnumsNET.FlagEnums.ParseFlags(System.Type,System.String)">
  4409. <summary>
  4410. 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"/>.
  4411. </summary>
  4412. <param name="enumType">The enum type.</param>
  4413. <param name="value">The enum member names or values' string representation.</param>
  4414. <returns>A <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
  4415. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4416. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4417. -or-
  4418. <paramref name="value"/> doesn't represent a member name or value of <paramref name="enumType"/>.</exception>
  4419. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of <paramref name="enumType"/>'s underlying type.</exception>
  4420. </member>
  4421. <member name="M:EnumsNET.FlagEnums.ParseFlags(System.Type,System.String,System.Boolean)">
  4422. <summary>
  4423. 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"/>.
  4424. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  4425. </summary>
  4426. <param name="enumType">The enum type.</param>
  4427. <param name="value">The enum member names or values' string representation.</param>
  4428. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4429. <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</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"/> doesn't represent a member name or value of <paramref name="enumType"/>.</exception>
  4434. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
  4435. </member>
  4436. <member name="M:EnumsNET.FlagEnums.ParseFlags(System.Type,System.String,System.Boolean,System.String)">
  4437. <summary>
  4438. 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"/>.
  4439. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  4440. </summary>
  4441. <param name="enumType">The enum type.</param>
  4442. <param name="value">The enum member names or values' string representation.</param>
  4443. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4444. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4445. <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
  4446. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4447. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4448. -or-
  4449. <paramref name="value"/> doesn't represent a member name or value of <paramref name="enumType"/>.</exception>
  4450. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
  4451. </member>
  4452. <member name="M:EnumsNET.FlagEnums.ParseFlags(System.Type,System.String,System.Boolean,System.String,EnumsNET.EnumFormat)">
  4453. <summary>
  4454. 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"/>
  4455. using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  4456. </summary>
  4457. <param name="enumType">The enum type.</param>
  4458. <param name="value">The enum members or values' string representation.</param>
  4459. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4460. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4461. <param name="format">The parsing enum format.</param>
  4462. <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
  4463. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4464. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4465. -or-
  4466. <paramref name="value"/> doesn't represent a member or value of <paramref name="enumType"/>
  4467. -or-
  4468. <paramref name="format"/> is an invalid value.</exception>
  4469. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
  4470. </member>
  4471. <member name="M:EnumsNET.FlagEnums.ParseFlags(System.Type,System.String,System.Boolean,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  4472. <summary>
  4473. 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"/>
  4474. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  4475. </summary>
  4476. <param name="enumType">The enum type.</param>
  4477. <param name="value">The enum members or values' string representation.</param>
  4478. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4479. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4480. <param name="format0">The first parsing enum format.</param>
  4481. <param name="format1">The second parsing enum format.</param>
  4482. <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
  4483. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4484. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4485. -or-
  4486. <paramref name="value"/> doesn't represent a member or value of <paramref name="enumType"/>
  4487. -or-
  4488. <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  4489. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
  4490. </member>
  4491. <member name="M:EnumsNET.FlagEnums.ParseFlags(System.Type,System.String,System.Boolean,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  4492. <summary>
  4493. 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"/>
  4494. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  4495. </summary>
  4496. <param name="enumType">The enum type.</param>
  4497. <param name="value">The enum members or values' string representation.</param>
  4498. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4499. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4500. <param name="format0">The first parsing enum format.</param>
  4501. <param name="format1">The second parsing enum format.</param>
  4502. <param name="format2">The third parsing enum format.</param>
  4503. <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
  4504. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4505. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4506. -or-
  4507. <paramref name="value"/> doesn't represent a member or value of <paramref name="enumType"/>
  4508. -or-
  4509. <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  4510. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
  4511. </member>
  4512. <member name="M:EnumsNET.FlagEnums.ParseFlags(System.Type,System.String,System.Boolean,System.String,EnumsNET.EnumFormat[])">
  4513. <summary>
  4514. 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"/>
  4515. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
  4516. </summary>
  4517. <param name="enumType">The enum type.</param>
  4518. <param name="value">The enum members or values' string representation.</param>
  4519. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4520. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4521. <param name="formats">The parsing enum formats.</param>
  4522. <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
  4523. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
  4524. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4525. -or-
  4526. <paramref name="value"/> doesn't represent a member or value of <paramref name="enumType"/>
  4527. -or-
  4528. <paramref name="formats"/> contains an invalid value.</exception>
  4529. <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
  4530. </member>
  4531. <member name="M:EnumsNET.FlagEnums.TryParseFlags(System.Type,System.String,System.Object@)">
  4532. <summary>
  4533. 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"/>.
  4534. The return value indicates whether the conversion succeeded.
  4535. </summary>
  4536. <param name="enumType">The enum type.</param>
  4537. <param name="value">The enum member names or values' string representation.</param>
  4538. <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> that is represented by <paramref name="value"/>.</param>
  4539. <returns>Indication whether the conversion succeeded.</returns>
  4540. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  4541. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
  4542. </member>
  4543. <member name="M:EnumsNET.FlagEnums.TryParseFlags(System.Type,System.String,System.Boolean,System.Object@)">
  4544. <summary>
  4545. 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"/>.
  4546. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive. The return value indicates whether the conversion succeeded.
  4547. </summary>
  4548. <param name="enumType">The enum type.</param>
  4549. <param name="value">The enum member names or values' string representation.</param>
  4550. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4551. <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> that is represented by <paramref name="value"/>.</param>
  4552. <returns>Indication whether the conversion succeeded.</returns>
  4553. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  4554. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
  4555. </member>
  4556. <member name="M:EnumsNET.FlagEnums.TryParseFlags(System.Type,System.String,System.Boolean,System.String,System.Object@)">
  4557. <summary>
  4558. 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"/>.
  4559. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive. The return value indicates whether the conversion succeeded.
  4560. </summary>
  4561. <param name="enumType">The enum type.</param>
  4562. <param name="value">The enum member names or values' string representation.</param>
  4563. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4564. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4565. <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> that is represented by <paramref name="value"/>.</param>
  4566. <returns>Indication whether the conversion succeeded.</returns>
  4567. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  4568. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
  4569. </member>
  4570. <member name="M:EnumsNET.FlagEnums.TryParseFlags(System.Type,System.String,System.Boolean,System.String,System.Object@,EnumsNET.EnumFormat)">
  4571. <summary>
  4572. 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"/>
  4573. using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  4574. The return value indicates whether the conversion succeeded.
  4575. </summary>
  4576. <param name="enumType">The enum type.</param>
  4577. <param name="value">The enum members or values' string representation.</param>
  4578. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4579. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4580. <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> that is represented by <paramref name="value"/>.</param>
  4581. <param name="format">The parsing enum format.</param>
  4582. <returns>Indication whether the conversion succeeded.</returns>
  4583. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  4584. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4585. -or-
  4586. <paramref name="format"/> is an invalid value.</exception>
  4587. </member>
  4588. <member name="M:EnumsNET.FlagEnums.TryParseFlags(System.Type,System.String,System.Boolean,System.String,System.Object@,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  4589. <summary>
  4590. 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"/>
  4591. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  4592. The return value indicates whether the conversion succeeded.
  4593. </summary>
  4594. <param name="enumType">The enum type.</param>
  4595. <param name="value">The enum members or values' string representation.</param>
  4596. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4597. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4598. <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> that is represented by <paramref name="value"/>.</param>
  4599. <param name="format0">The first parsing enum format.</param>
  4600. <param name="format1">The second parsing enum format.</param>
  4601. <returns>Indication whether the conversion succeeded.</returns>
  4602. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  4603. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4604. -or-
  4605. <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
  4606. </member>
  4607. <member name="M:EnumsNET.FlagEnums.TryParseFlags(System.Type,System.String,System.Boolean,System.String,System.Object@,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
  4608. <summary>
  4609. 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"/>
  4610. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  4611. The return value indicates whether the conversion succeeded.
  4612. </summary>
  4613. <param name="enumType">The enum type.</param>
  4614. <param name="value">The enum members or values' string representation.</param>
  4615. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4616. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4617. <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> that is represented by <paramref name="value"/>.</param>
  4618. <param name="format0">The first parsing enum format.</param>
  4619. <param name="format1">The second parsing enum format.</param>
  4620. <param name="format2">The third parsing enum format.</param>
  4621. <returns>Indication whether the conversion succeeded.</returns>
  4622. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  4623. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4624. -or-
  4625. <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
  4626. </member>
  4627. <member name="M:EnumsNET.FlagEnums.TryParseFlags(System.Type,System.String,System.Boolean,System.String,System.Object@,EnumsNET.EnumFormat[])">
  4628. <summary>
  4629. 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"/>
  4630. using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
  4631. The return value indicates whether the conversion succeeded.
  4632. </summary>
  4633. <param name="enumType">The enum type.</param>
  4634. <param name="value">The enum members or values' string representation.</param>
  4635. <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
  4636. <param name="delimiter">The delimiter used to separate individual flags.</param>
  4637. <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> that is represented by <paramref name="value"/>.</param>
  4638. <param name="formats">The parsing enum formats.</param>
  4639. <returns>Indication whether the conversion succeeded.</returns>
  4640. <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
  4641. <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
  4642. -or-
  4643. <paramref name="formats"/> contains an invalid value.</exception>
  4644. </member>
  4645. <member name="M:EnumsNET.FlagEnums.IsValidFlagCombination(EnumsNET.EnumMember)">
  4646. <summary>
  4647. Indicates whether <paramref name="member"/>'s value is a valid flag combination of its enum's defined values.
  4648. </summary>
  4649. <param name="member">The enum member.</param>
  4650. <returns>Indication of whether <paramref name="member"/>'s value is a valid flag combination of its enum's defined values.</returns>
  4651. <exception cref="T:System.ArgumentNullException"><paramref name="member"/> is <c>null</c>.</exception>
  4652. </member>
  4653. <member name="M:EnumsNET.FlagEnums.GetFlags``1(EnumsNET.EnumMember{``0})">
  4654. <summary>
  4655. Retrieves the flags that compose <paramref name="member"/>'s value.
  4656. </summary>
  4657. <typeparam name="TEnum">The enum type.</typeparam>
  4658. <param name="member">The enum member.</param>
  4659. <returns>The flags that compose <paramref name="member"/>'s value.</returns>
  4660. <exception cref="T:System.ArgumentNullException"><paramref name="member"/> is <c>null</c>.</exception>
  4661. </member>
  4662. <member name="M:EnumsNET.FlagEnums.GetFlagMembers``1(EnumsNET.EnumMember{``0})">
  4663. <summary>
  4664. Retrieves the <see cref="T:EnumsNET.EnumMember`1"/>s of the flags that compose <paramref name="member"/>'s value.
  4665. </summary>
  4666. <typeparam name="TEnum">The enum type.</typeparam>
  4667. <param name="member">The enum member.</param>
  4668. <returns>The <see cref="T:EnumsNET.EnumMember`1"/>s of the flags that compose <paramref name="member"/>'s value.</returns>
  4669. <exception cref="T:System.ArgumentNullException"><paramref name="member"/> is <c>null</c>.</exception>
  4670. </member>
  4671. <member name="M:EnumsNET.FlagEnums.HasAnyFlags(EnumsNET.EnumMember)">
  4672. <summary>
  4673. Indicates if <paramref name="member"/>'s value has any flags.
  4674. </summary>
  4675. <param name="member">The enum member.</param>
  4676. <returns>Indication if <paramref name="member"/>'s has any flags.</returns>
  4677. <exception cref="T:System.ArgumentNullException"><paramref name="member"/> is <c>null</c>.</exception>
  4678. </member>
  4679. <member name="M:EnumsNET.FlagEnums.HasAllFlags(EnumsNET.EnumMember)">
  4680. <summary>
  4681. Indicates if <paramref name="member"/>'s value has all of the flags that are defined in its enum type.
  4682. </summary>
  4683. <param name="member">The enum member.</param>
  4684. <returns>Indication if <paramref name="member"/> has all of the flags that are defined in its enum type.</returns>
  4685. <exception cref="T:System.ArgumentNullException"><paramref name="member"/> is <c>null</c>.</exception>
  4686. </member>
  4687. <member name="M:EnumsNET.FlagEnums.GetFlagCount(EnumsNET.EnumMember)">
  4688. <summary>
  4689. Retrieves the flag count of <paramref name="member"/>.
  4690. </summary>
  4691. <param name="member">The flags enum value.</param>
  4692. <returns>The flag count of <paramref name="member"/>.</returns>
  4693. </member>
  4694. <member name="M:EnumsNET.FlagEnums.GetFlags(EnumsNET.EnumMember)">
  4695. <summary>
  4696. Retrieves the flags that compose <paramref name="member"/>'s value.
  4697. </summary>
  4698. <param name="member">The enum member.</param>
  4699. <returns>The flags that compose <paramref name="member"/>'s value.</returns>
  4700. <exception cref="T:System.ArgumentNullException"><paramref name="member"/> is <c>null</c>.</exception>
  4701. </member>
  4702. <member name="M:EnumsNET.FlagEnums.GetFlagMembers(EnumsNET.EnumMember)">
  4703. <summary>
  4704. Retrieves the <see cref="T:EnumsNET.EnumMember"/>s of the flags that compose <paramref name="member"/>'s value.
  4705. </summary>
  4706. <param name="member">The enum member.</param>
  4707. <returns>The <see cref="T:EnumsNET.EnumMember"/>s of the flags that compose <paramref name="member"/>'s value.</returns>
  4708. <exception cref="T:System.ArgumentNullException"><paramref name="member"/> is <c>null</c>.</exception>
  4709. </member>
  4710. <member name="T:EnumsNET.IEnumValidatorAttribute`1">
  4711. <summary>
  4712. Interface to be implemented on an enum validator attribute class to allow custom validation logic.
  4713. </summary>
  4714. <typeparam name="TEnum">The enum type.</typeparam>
  4715. </member>
  4716. <member name="M:EnumsNET.IEnumValidatorAttribute`1.IsValid(`0)">
  4717. <summary>
  4718. Indicates if <paramref name="value"/> is valid.
  4719. </summary>
  4720. <param name="value">The enum value.</param>
  4721. <returns>Indication if <paramref name="value"/> is valid.</returns>
  4722. </member>
  4723. <member name="T:EnumsNET.PrimaryEnumMemberAttribute">
  4724. <summary>
  4725. Indicates if the enum member should be the primary enum member when there are duplicate values.
  4726. In the case of duplicate values, extension methods will use the enum member marked with this attribute.
  4727. </summary>
  4728. </member>
  4729. <member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
  4730. <summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
  4731. </member>
  4732. <member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
  4733. <summary>Initializes the attribute with the specified return value condition.</summary>
  4734. <param name="returnValue">
  4735. The return value condition. If the method returns this value, the associated parameter will not be null.
  4736. </param>
  4737. </member>
  4738. <member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
  4739. <summary>Gets the return value condition.</summary>
  4740. </member>
  4741. <member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
  4742. <summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
  4743. </member>
  4744. <member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
  4745. <summary>Initializes the attribute with the associated parameter name.</summary>
  4746. <param name="parameterName">
  4747. The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
  4748. </param>
  4749. </member>
  4750. <member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
  4751. <summary>Gets the associated parameter name.</summary>
  4752. </member>
  4753. </members>
  4754. </doc>