설명 없음
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

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