暂无描述
您最多选择25个主题 主题必须以字母或数字开头,可以包含连字符 (-),并且长度不得超过35个字符

Enums.NET.xml 356KB

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