12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>Enums.NET</name>
- </assembly>
- <members>
- <member name="T:EnumsNET.AttributeCollection">
- <summary>
- An <see cref="T:System.Attribute"/> collection.
- </summary>
- </member>
- <member name="P:EnumsNET.AttributeCollection.Item(System.Int32)">
- <summary>
- The <see cref="T:EnumsNET.AttributeCollection"/> indexer.
- </summary>
- <param name="index">The index of the <see cref="T:System.Attribute"/> to retrieve.</param>
- <returns>The <see cref="T:System.Attribute"/> at the specified <paramref name="index"/></returns>
- </member>
- <member name="P:EnumsNET.AttributeCollection.Count">
- <summary>
- The number of <see cref="T:System.Attribute"/>s.
- </summary>
- </member>
- <member name="M:EnumsNET.AttributeCollection.Has``1">
- <summary>
- Indicates if the collection contains a <typeparamref name="TAttribute"/>.
- </summary>
- <typeparam name="TAttribute">The attribute type.</typeparam>
- <returns>Indication if the colleciton contains a <typeparamref name="TAttribute"/>.</returns>
- </member>
- <member name="M:EnumsNET.AttributeCollection.Has(System.Type)">
- <summary>
- Indicates if the collection contains an <see cref="T:System.Attribute"/> that is an instance of <paramref name="attributeType"/>.
- </summary>
- <param name="attributeType">The attribute type.</param>
- <returns>Indication if the colleciton contains an <see cref="T:System.Attribute"/> that is an instance of <paramref name="attributeType"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="attributeType"/> is <c>null</c>.</exception>
- </member>
- <member name="M:EnumsNET.AttributeCollection.Get``1">
- <summary>
- Retrieves the first <typeparamref name="TAttribute"/> in the collection if defined otherwise <c>null</c>.
- </summary>
- <typeparam name="TAttribute">The attribute type.</typeparam>
- <returns>The first <typeparamref name="TAttribute"/> in the collection if defined otherwise <c>null</c>.</returns>
- </member>
- <member name="M:EnumsNET.AttributeCollection.Get(System.Type)">
- <summary>
- 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>.
- </summary>
- <param name="attributeType">The attribute type.</param>
- <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>
- <exception cref="T:System.ArgumentNullException"><paramref name="attributeType"/> is <c>null</c>.</exception>
- </member>
- <member name="M:EnumsNET.AttributeCollection.GetAll``1">
- <summary>
- Retrieves all <typeparamref name="TAttribute"/>'s in the collection.
- </summary>
- <typeparam name="TAttribute">The attribute type.</typeparam>
- <returns>All <typeparamref name="TAttribute"/>'s in the collection.</returns>
- </member>
- <member name="M:EnumsNET.AttributeCollection.GetAll(System.Type)">
- <summary>
- Retrieves all <see cref="T:System.Attribute"/>s that are an instance of <paramref name="attributeType"/> in the collection.
- </summary>
- <param name="attributeType">The attribute type.</param>
- <returns>All <see cref="T:System.Attribute"/>s that are an instance of <paramref name="attributeType"/> in the collection.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="attributeType"/> is <c>null</c>.</exception>
- </member>
- <member name="M:EnumsNET.AttributeCollection.GetEnumerator">
- <summary>
- Returns an enumerator that iterates through the collection.
- </summary>
- <returns>An enumerator that iterates through the collection.</returns>
- </member>
- <member name="T:EnumsNET.EnumComparer">
- <summary>
- An efficient enum comparer.
- </summary>
- </member>
- <member name="M:EnumsNET.EnumComparer.GetInstance(System.Type)">
- <summary>
- Gets a singleton instance of <see cref="T:EnumsNET.EnumComparer"/> for the enum type provided.
- </summary>
- <param name="enumType">The enum type.</param>
- <returns>A singleton instance of <see cref="T:EnumsNET.EnumComparer"/> for the enum type provided.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.EnumComparer.Equals(System.Object,System.Object)">
- <summary>
- Indicates if <paramref name="x"/> equals <paramref name="y"/> without boxing the values.
- </summary>
- <param name="x">The first enum value.</param>
- <param name="y">The second enum value.</param>
- <returns>Indication if <paramref name="x"/> equals <paramref name="y"/> without boxing the values.</returns>
- </member>
- <member name="M:EnumsNET.EnumComparer.GetHashCode(System.Object)">
- <summary>
- Retrieves a hash code for <paramref name="obj"/> without boxing the value.
- </summary>
- <param name="obj">The enum value.</param>
- <returns>Hash code for <paramref name="obj"/> without boxing the value.</returns>
- </member>
- <member name="M:EnumsNET.EnumComparer.Compare(System.Object,System.Object)">
- <summary>
- Compares <paramref name="x"/> to <paramref name="y"/> without boxing the values.
- </summary>
- <param name="x">The first enum value.</param>
- <param name="y">The second enum value.</param>
- <returns>1 if <paramref name="x"/> is greater than <paramref name="y"/>, 0 if <paramref name="x"/> equals <paramref name="y"/>,
- and -1 if <paramref name="x"/> is less than <paramref name="y"/>.</returns>
- </member>
- <member name="T:EnumsNET.EnumComparer`1">
- <summary>
- An efficient enum comparer which doesn't box the values.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- </member>
- <member name="P:EnumsNET.EnumComparer`1.Instance">
- <summary>
- The singleton instance of <see cref="T:EnumsNET.EnumComparer`1"/>.
- </summary>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.EnumComparer`1.Equals(`0,`0)">
- <summary>
- Indicates if <paramref name="x"/> equals <paramref name="y"/> without boxing the values.
- </summary>
- <param name="x">The first enum value.</param>
- <param name="y">The second enum value.</param>
- <returns>Indication if <paramref name="x"/> equals <paramref name="y"/> without boxing the values.</returns>
- </member>
- <member name="M:EnumsNET.EnumComparer`1.GetHashCode(`0)">
- <summary>
- Retrieves a hash code for <paramref name="obj"/> without boxing the value.
- </summary>
- <param name="obj">The enum value.</param>
- <returns>Hash code for <paramref name="obj"/> without boxing the value.</returns>
- </member>
- <member name="M:EnumsNET.EnumComparer`1.Compare(`0,`0)">
- <summary>
- Compares <paramref name="x"/> to <paramref name="y"/> without boxing the values.
- </summary>
- <param name="x">The first enum value.</param>
- <param name="y">The second enum value.</param>
- <returns>1 if <paramref name="x"/> is greater than <paramref name="y"/>, 0 if <paramref name="x"/> equals <paramref name="y"/>,
- and -1 if <paramref name="x"/> is less than <paramref name="y"/>.</returns>
- </member>
- <member name="T:EnumsNET.EnumFormat">
- <summary>
- Specifies the enum string representation formats.
- </summary>
- </member>
- <member name="F:EnumsNET.EnumFormat.DecimalValue">
- <summary>
- Enum is represented by its decimal value.
- </summary>
- </member>
- <member name="F:EnumsNET.EnumFormat.HexadecimalValue">
- <summary>
- Enum is represented by its hexadecimal value.
- </summary>
- </member>
- <member name="F:EnumsNET.EnumFormat.UnderlyingValue">
- <summary>
- Enum is represented by its underlying value.
- </summary>
- </member>
- <member name="F:EnumsNET.EnumFormat.Name">
- <summary>
- Enum is represented by its name.
- </summary>
- </member>
- <member name="F:EnumsNET.EnumFormat.Description">
- <summary>
- Enum is represented by its <see cref="P:System.ComponentModel.DescriptionAttribute.Description"/>.
- </summary>
- </member>
- <member name="F:EnumsNET.EnumFormat.EnumMemberValue">
- <summary>
- Enum is represented by its <see cref="P:System.Runtime.Serialization.EnumMemberAttribute.Value"/>.
- </summary>
- </member>
- <member name="T:EnumsNET.EnumMember">
- <summary>
- An enum member which is composed of its name, value, and attributes.
- </summary>
- </member>
- <member name="P:EnumsNET.EnumMember.Value">
- <summary>
- The enum member's value.
- </summary>
- </member>
- <member name="P:EnumsNET.EnumMember.Name">
- <summary>
- The enum member's name.
- </summary>
- </member>
- <member name="P:EnumsNET.EnumMember.Attributes">
- <summary>
- The enum member's attributes.
- </summary>
- </member>
- <member name="M:EnumsNET.EnumMember.ToString">
- <summary>
- Retrieves the enum member's name.
- </summary>
- <returns>The enum member's name.</returns>
- </member>
- <member name="M:EnumsNET.EnumMember.AsString">
- <summary>
- Retrieves the enum member's name.
- </summary>
- <returns>The enum member's name.</returns>
- </member>
- <member name="M:EnumsNET.EnumMember.AsString(System.String)">
- <summary>
- Converts the enum member to its string representation using the specified <paramref name="format"/>.
- </summary>
- <param name="format">The output format to use.</param>
- <returns>A string representation of the enum member.</returns>
- <exception cref="T:System.FormatException"><paramref name="format"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.EnumMember.AsString(EnumsNET.EnumFormat)">
- <summary>
- Converts the enum member to its string representation using the specified <paramref name="format"/>.
- </summary>
- <param name="format">The output format to use.</param>
- <returns>A string representation of the enum member.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="format"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.EnumMember.AsString(EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- Converts the enum member to its string representation using the specified formats.
- </summary>
- <param name="format0">The first output format to use.</param>
- <param name="format1">The second output format to use if using the first resolves to <c>null</c>.</param>
- <returns>A string representation of the enum member.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.EnumMember.AsString(EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- Converts the enum member to its string representation using the specified formats.
- </summary>
- <param name="format0">The first output format to use.</param>
- <param name="format1">The second output format to use if using the first resolves to <c>null</c>.</param>
- <param name="format2">The third output format to use if using the first and second both resolve to <c>null</c>.</param>
- <returns>A string representation of the enum member.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.EnumMember.AsString(EnumsNET.EnumFormat[])">
- <summary>
- Converts the enum member to its string representation using the specified <paramref name="formats"/>.
- </summary>
- <param name="formats">The output formats to use.</param>
- <returns>A string representation of the enum member.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="formats"/> contains an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.EnumMember.GetUnderlyingValue">
- <summary>
- Retrieves the enum member's underlying integral value.
- </summary>
- <returns>The enum member's underlying integral value.</returns>
- </member>
- <member name="M:EnumsNET.EnumMember.ToSByte">
- <summary>
- Converts <see cref="P:EnumsNET.EnumMember.Value"/> to an <see cref="T:System.SByte"/>.
- </summary>
- <returns><see cref="P:EnumsNET.EnumMember.Value"/> converted to an <see cref="T:System.SByte"/>.</returns>
- <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>
- </member>
- <member name="M:EnumsNET.EnumMember.ToByte">
- <summary>
- Converts <see cref="P:EnumsNET.EnumMember.Value"/> to a <see cref="T:System.Byte"/>.
- </summary>
- <returns><see cref="P:EnumsNET.EnumMember.Value"/> converted to a <see cref="T:System.Byte"/>.</returns>
- <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>
- </member>
- <member name="M:EnumsNET.EnumMember.ToInt16">
- <summary>
- Converts <see cref="P:EnumsNET.EnumMember.Value"/> to an <see cref="T:System.Int16"/>.
- </summary>
- <returns><see cref="P:EnumsNET.EnumMember.Value"/> converted to an <see cref="T:System.Int16"/>.</returns>
- <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>
- </member>
- <member name="M:EnumsNET.EnumMember.ToUInt16">
- <summary>
- Converts <see cref="P:EnumsNET.EnumMember.Value"/> to a <see cref="T:System.UInt16"/>.
- </summary>
- <returns><see cref="P:EnumsNET.EnumMember.Value"/> converted to a <see cref="T:System.UInt16"/>.</returns>
- <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>
- </member>
- <member name="M:EnumsNET.EnumMember.ToInt32">
- <summary>
- Converts <see cref="P:EnumsNET.EnumMember.Value"/> to an <see cref="T:System.Int32"/>.
- </summary>
- <returns><see cref="P:EnumsNET.EnumMember.Value"/> converted to an <see cref="T:System.Int32"/>.</returns>
- <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>
- </member>
- <member name="M:EnumsNET.EnumMember.ToUInt32">
- <summary>
- Converts <see cref="P:EnumsNET.EnumMember.Value"/> to a <see cref="T:System.UInt32"/>.
- </summary>
- <returns><see cref="P:EnumsNET.EnumMember.Value"/> converted to a <see cref="T:System.UInt32"/>.</returns>
- <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>
- </member>
- <member name="M:EnumsNET.EnumMember.ToInt64">
- <summary>
- Converts <see cref="P:EnumsNET.EnumMember.Value"/> to an <see cref="T:System.Int64"/>.
- </summary>
- <returns><see cref="P:EnumsNET.EnumMember.Value"/> converted to an <see cref="T:System.Int64"/>.</returns>
- <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>
- </member>
- <member name="M:EnumsNET.EnumMember.ToUInt64">
- <summary>
- Converts <see cref="P:EnumsNET.EnumMember.Value"/> to a <see cref="T:System.UInt64"/>.
- </summary>
- <returns><see cref="P:EnumsNET.EnumMember.Value"/> converted to a <see cref="T:System.UInt64"/>.</returns>
- <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>
- </member>
- <member name="M:EnumsNET.EnumMember.GetHashCode">
- <summary>
- Retrieves the hash code of <see cref="P:EnumsNET.EnumMember.Value"/>.
- </summary>
- <returns>The hash code of <see cref="P:EnumsNET.EnumMember.Value"/>.</returns>
- </member>
- <member name="M:EnumsNET.EnumMember.Equals(EnumsNET.EnumMember)">
- <summary>
- Indicates whether the specified <see cref="T:EnumsNET.EnumMember"/> is equal to the current <see cref="T:EnumsNET.EnumMember"/>.
- </summary>
- <param name="other">The other <see cref="T:EnumsNET.EnumMember"/>.</param>
- <returns>Indication whether the specified <see cref="T:EnumsNET.EnumMember"/> is equal to the current <see cref="T:EnumsNET.EnumMember"/>.</returns>
- </member>
- <member name="M:EnumsNET.EnumMember.Equals(System.Object)">
- <summary>
- Indicates whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
- </summary>
- <param name="other">The other <see cref="T:System.Object"/>.</param>
- <returns>Indication whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.</returns>
- </member>
- <member name="T:EnumsNET.EnumMember`1">
- <summary>
- An enum member which is composed of its name, value, and attributes.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- </member>
- <member name="P:EnumsNET.EnumMember`1.Value">
- <summary>
- The enum member's value.
- </summary>
- </member>
- <member name="M:EnumsNET.EnumMember`1.Equals(EnumsNET.EnumMember{`0})">
- <summary>
- Indicates whether the specified <see cref="T:EnumsNET.EnumMember`1"/> is equal to the current <see cref="T:EnumsNET.EnumMember`1"/>.
- </summary>
- <param name="other">The other <see cref="T:EnumsNET.EnumMember`1"/>.</param>
- <returns>Indication whether the specified <see cref="T:EnumsNET.EnumMember`1"/> is equal to the current <see cref="T:EnumsNET.EnumMember`1"/>.</returns>
- </member>
- <member name="T:EnumsNET.EnumMemberSelection">
- <summary>
- Specifies what enum members to include.
- </summary>
- </member>
- <member name="F:EnumsNET.EnumMemberSelection.All">
- <summary>
- Include all enum members.
- </summary>
- </member>
- <member name="F:EnumsNET.EnumMemberSelection.Distinct">
- <summary>
- Include only distinct valued enum members.
- </summary>
- </member>
- <member name="F:EnumsNET.EnumMemberSelection.Flags">
- <summary>
- Include each flag enum member.
- </summary>
- </member>
- <member name="T:EnumsNET.Enums">
- <summary>
- Static class that provides efficient type-safe enum operations through the use of cached enum members.
- Many operations are exposed as C# extension methods for convenience.
- </summary>
- </member>
- <member name="M:EnumsNET.Enums.RegisterCustomEnumFormat(System.Func{EnumsNET.EnumMember,System.String})">
- <summary>
- Registers a custom <see cref="T:EnumsNET.EnumFormat"/> with the specified <see cref="T:EnumsNET.EnumMember"/> formatter.
- </summary>
- <param name="enumMemberFormatter">The <see cref="T:EnumsNET.EnumMember"/> formatter.</param>
- <returns>A custom <see cref="T:EnumsNET.EnumFormat"/> that is registered with the specified <see cref="T:EnumsNET.EnumMember"/> formatter.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumMemberFormatter"/> is <c>null</c>.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetUnderlyingType``1">
- <summary>
- Retrieves the underlying type of <typeparamref name="TEnum"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <returns>The underlying type of <typeparamref name="TEnum"/>.</returns>
- </member>
- <member name="M:EnumsNET.Enums.GetMemberCount``1(EnumsNET.EnumMemberSelection)">
- <summary>
- Retrieves <typeparamref name="TEnum"/>'s member count.
- The parameter <paramref name="selection"/> indicates what members to include.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="selection">Indicates what members to include.</param>
- <returns><typeparamref name="TEnum"/>'s member count.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="selection"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetMembers``1(EnumsNET.EnumMemberSelection)">
- <summary>
- Retrieves <typeparamref name="TEnum"/>'s members in increasing value order.
- The parameter <paramref name="selection"/> indicates what members to include.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="selection">Indicates what members to include.</param>
- <returns><typeparamref name="TEnum"/>'s members in increasing value order.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="selection"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetNames``1(EnumsNET.EnumMemberSelection)">
- <summary>
- Retrieves <typeparamref name="TEnum"/>'s members' names in increasing value order.
- The parameter <paramref name="selection"/> indicates what members to include.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="selection">Indicates what members to include.</param>
- <returns><typeparamref name="TEnum"/>'s members' names in increasing value order.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="selection"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetValues``1(EnumsNET.EnumMemberSelection)">
- <summary>
- Retrieves <typeparamref name="TEnum"/>'s members' values in increasing value order.
- The parameter <paramref name="selection"/> indicates what members to include.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="selection">Indicates what members to include.</param>
- <returns><typeparamref name="TEnum"/>'s members' values in increasing value order.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="selection"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToObject``1(System.Object,EnumsNET.EnumValidation)">
- <summary>
- Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <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"/>,
- <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>
- <param name="validation">The validation to perform on the result.</param>
- <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="value"/> is not a valid type
- -or-
- <paramref name="validation"/> is an invalid value
- -or-
- the result is invalid with the specified <paramref name="validation"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToObject``1(System.SByte,EnumsNET.EnumValidation)">
- <summary>
- Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">Value to convert.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value
- -or-
- the result is invalid with the specified <paramref name="validation"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToObject``1(System.Byte,EnumsNET.EnumValidation)">
- <summary>
- Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">Value to convert.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value
- -or-
- the result is invalid with the specified <paramref name="validation"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToObject``1(System.Int16,EnumsNET.EnumValidation)">
- <summary>
- Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">Value to convert.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value
- -or-
- the result is invalid with the specified <paramref name="validation"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToObject``1(System.UInt16,EnumsNET.EnumValidation)">
- <summary>
- Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">Value to convert.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value
- -or-
- the result is invalid with the specified <paramref name="validation"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToObject``1(System.Int32,EnumsNET.EnumValidation)">
- <summary>
- Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">Value to convert.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value
- -or-
- the result is invalid with the specified <paramref name="validation"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToObject``1(System.UInt32,EnumsNET.EnumValidation)">
- <summary>
- Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">Value to convert.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value
- -or-
- the result is invalid with the specified <paramref name="validation"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToObject``1(System.Int64,EnumsNET.EnumValidation)">
- <summary>
- Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">Value to convert.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value
- -or-
- the result is invalid with the specified <paramref name="validation"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToObject``1(System.UInt64,EnumsNET.EnumValidation)">
- <summary>
- Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">Value to convert.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value
- -or-
- the result is invalid with the specified <paramref name="validation"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryToObject``1(System.Object,``0@,EnumsNET.EnumValidation)">
- <summary>
- Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <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"/>,
- <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>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryToObject``1(System.SByte,``0@,EnumsNET.EnumValidation)">
- <summary>
- Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">Value to try to convert.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryToObject``1(System.Byte,``0@,EnumsNET.EnumValidation)">
- <summary>
- Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">Value to try to convert.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryToObject``1(System.Int16,``0@,EnumsNET.EnumValidation)">
- <summary>
- Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">Value to try to convert.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryToObject``1(System.UInt16,``0@,EnumsNET.EnumValidation)">
- <summary>
- Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">Value to try to convert.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryToObject``1(System.Int32,``0@,EnumsNET.EnumValidation)">
- <summary>
- Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">Value to try to convert.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryToObject``1(System.UInt32,``0@,EnumsNET.EnumValidation)">
- <summary>
- Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">Value to try to convert.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryToObject``1(System.Int64,``0@,EnumsNET.EnumValidation)">
- <summary>
- Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">Value to try to convert.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryToObject``1(System.UInt64,``0@,EnumsNET.EnumValidation)">
- <summary>
- Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">Value to try to convert.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.IsValid``1(``0,EnumsNET.EnumValidation)">
- <summary>
- Indicates if <paramref name="value"/> is valid using the specified <paramref name="validation"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <param name="validation">The validation to perform on the value.</param>
- <returns>Indication if <paramref name="value"/> is valid.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.IsDefined``1(``0)">
- <summary>
- Indicates if <paramref name="value"/> is defined.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <returns>Indication if <paramref name="value"/> is defined.</returns>
- </member>
- <member name="M:EnumsNET.Enums.Validate``1(``0,System.String,EnumsNET.EnumValidation)">
- <summary>
- Validates that <paramref name="value"/> is valid using the specified <paramref name="validation"/>.
- If it's not it throws an <see cref="T:System.ArgumentException"/> with the specified <paramref name="paramName"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <param name="paramName">The parameter name to be used if throwing an <see cref="T:System.ArgumentException"/>.</param>
- <param name="validation">The validation to perform on the value.</param>
- <returns><paramref name="value"/> for use in fluent API's and base constructor method calls.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="validation"/> is an invalid value
- -or-
- <paramref name="value"/> is invalid.</exception>
- </member>
- <member name="M:EnumsNET.Enums.AsString``1(``0)">
- <summary>
- Converts the specified <paramref name="value"/> to its string representation.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <returns>A string representation of <paramref name="value"/>.</returns>
- </member>
- <member name="M:EnumsNET.Enums.AsString``1(``0,System.String)">
- <summary>
- Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="format"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <param name="format">The output format to use.</param>
- <returns>A string representation of <paramref name="value"/>.</returns>
- <exception cref="T:System.FormatException"><paramref name="format"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.AsString``1(``0,EnumsNET.EnumFormat)">
- <summary>
- Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="format"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <param name="format">The output format to use.</param>
- <returns>A string representation of <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="format"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.AsString``1(``0,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- Converts the specified <paramref name="value"/> to its string representation using the specified formats.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <param name="format0">The first output format to use.</param>
- <param name="format1">The second output format to use if using the first resolves to <c>null</c>.</param>
- <returns>A string representation of <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.AsString``1(``0,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- Converts the specified <paramref name="value"/> to its string representation using the specified formats.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <param name="format0">The first output format to use.</param>
- <param name="format1">The second output format to use if using the first resolves to <c>null</c>.</param>
- <param name="format2">The third output format to use if using the first and second both resolve to <c>null</c>.</param>
- <returns>A string representation of <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.AsString``1(``0,EnumsNET.EnumFormat[])">
- <summary>
- Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="formats"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <param name="formats">The output formats to use.</param>
- <returns>A string representation of <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="formats"/> contains an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.Format``1(``0,System.String)">
- <summary>
- Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="format"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <param name="format">The output format to use.</param>
- <returns>A string representation of <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="format"/> is <c>null</c>.</exception>
- <exception cref="T:System.FormatException"><paramref name="format"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetUnderlyingValue``1(``0)">
- <summary>
- Returns <paramref name="value"/>'s underlying integral value.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/>'s underlying integral value.</returns>
- </member>
- <member name="M:EnumsNET.Enums.ToSByte``1(``0)">
- <summary>
- Converts <paramref name="value"/> to an <see cref="T:System.SByte"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/> converted to an <see cref="T:System.SByte"/>.</returns>
- <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.SByte"/>'s value range without overflowing.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToByte``1(``0)">
- <summary>
- Converts <paramref name="value"/> to a <see cref="T:System.Byte"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/> converted to a <see cref="T:System.Byte"/>.</returns>
- <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Byte"/>'s value range without overflowing.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToInt16``1(``0)">
- <summary>
- Converts <paramref name="value"/> to an <see cref="T:System.Int16"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/> converted to an <see cref="T:System.Int16"/>.</returns>
- <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Int16"/>'s value range without overflowing.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToUInt16``1(``0)">
- <summary>
- Converts <paramref name="value"/> to a <see cref="T:System.UInt16"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/> converted to a <see cref="T:System.UInt16"/>.</returns>
- <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.UInt16"/>'s value range without overflowing.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToInt32``1(``0)">
- <summary>
- Converts <paramref name="value"/> to an <see cref="T:System.Int32"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/> converted to an <see cref="T:System.Int32"/>.</returns>
- <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Int32"/>'s value range without overflowing.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToUInt32``1(``0)">
- <summary>
- Converts <paramref name="value"/> to a <see cref="T:System.UInt32"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/> converted to a <see cref="T:System.UInt32"/>.</returns>
- <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.UInt32"/>'s value range without overflowing.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToInt64``1(``0)">
- <summary>
- Converts <paramref name="value"/> to an <see cref="T:System.Int64"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/> converted to an <see cref="T:System.Int64"/>.</returns>
- <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Int64"/>'s value range without overflowing.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToUInt64``1(``0)">
- <summary>
- Converts <paramref name="value"/> to a <see cref="T:System.UInt64"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/> converted to a <see cref="T:System.UInt64"/>.</returns>
- <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.UInt64"/>'s value range without overflowing.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetHashCode``1(``0)">
- <summary>
- Retrieves the hash code of <paramref name="value"/>. It's more efficient as it doesn't require boxing and unboxing of <paramref name="value"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <returns>Hash code of <paramref name="value"/>.</returns>
- </member>
- <member name="M:EnumsNET.Enums.Equals``1(``0,``0)">
- <summary>
- Indicates if <paramref name="value"/> equals <paramref name="other"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <param name="other">The other enum value.</param>
- <returns>Indication if <paramref name="value"/> equals <paramref name="other"/>.</returns>
- </member>
- <member name="M:EnumsNET.Enums.CompareTo``1(``0,``0)">
- <summary>
- Compares <paramref name="value"/> to <paramref name="other"/> for ordering.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <param name="other">The other enum value.</param>
- <returns>1 if <paramref name="value"/> is greater than <paramref name="other"/>, 0 if <paramref name="value"/> equals <paramref name="other"/>,
- and -1 if <paramref name="value"/> is less than <paramref name="other"/>.</returns>
- </member>
- <member name="M:EnumsNET.Enums.GetName``1(``0)">
- <summary>
- Retrieves <paramref name="value"/>'s enum member name if defined otherwise <c>null</c>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/>'s enum member name if defined otherwise <c>null</c>.</returns>
- </member>
- <member name="M:EnumsNET.Enums.GetAttributes``1(``0)">
- <summary>
- Retrieves <paramref name="value"/>'s enum member attributes if defined otherwise <c>null</c>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/>'s enum member attributes if defined otherwise <c>null</c>.</returns>
- </member>
- <member name="M:EnumsNET.Enums.GetMember``1(``0)">
- <summary>
- Retrieves an enum member with the specified <paramref name="value"/> if defined otherwise <c>null</c>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <returns>Enum member with the specified <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
- </member>
- <member name="M:EnumsNET.Enums.GetMember``1(System.String)">
- <summary>
- Retrieves the enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="name">The enum member name.</param>
- <returns>Enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <c>null</c>.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetMember``1(System.String,System.Boolean)">
- <summary>
- Retrieves the enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.
- The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="name">The enum member name.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <returns>Enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <c>null</c>.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetMember``1(System.String,System.Boolean,EnumsNET.EnumFormat)">
- <summary>
- Retrieves an enum member whose string representation using the specified <paramref name="format"/> is <paramref name="value"/> if defined otherwise <c>null</c>.
- The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum member's string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="format">The parsing enum format.</param>
- <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="format"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetMember``1(System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- Retrieves an enum member whose string representation using the specified formats is <paramref name="value"/> if defined otherwise <c>null</c>.
- The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum member's string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="format0">The first parsing enum format.</param>
- <param name="format1">The second parsing enum format.</param>
- <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetMember``1(System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- Retrieves an enum member whose string representation using the specified formats is <paramref name="value"/> if defined otherwise <c>null</c>.
- The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum member's string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="format0">The first parsing enum format.</param>
- <param name="format1">The second parsing enum format.</param>
- <param name="format2">The third parsing enum format.</param>
- <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetMember``1(System.String,System.Boolean,EnumsNET.EnumFormat[])">
- <summary>
- Retrieves an enum member whose string representation using the specified <paramref name="formats"/> is <paramref name="value"/> if defined otherwise <c>null</c>.
- The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum member's string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="formats">The parsing enum formats.</param>
- <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="formats"/> contains an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.Parse``1(System.String)">
- <summary>
- Converts the string representation of one or more member names or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum member names or values' string representation.</param>
- <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member name or value of <typeparamref name="TEnum"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
- </member>
- <member name="M:EnumsNET.Enums.Parse``1(System.String,System.Boolean)">
- <summary>
- Converts the string representation of one or more member names or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value.
- The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum member names or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member name or value of <typeparamref name="TEnum"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
- </member>
- <member name="M:EnumsNET.Enums.Parse``1(System.String,System.Boolean,EnumsNET.EnumFormat)">
- <summary>
- Converts the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
- using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="format">The parsing enum format.</param>
- <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
- -or-
- <paramref name="format"/> is an invalid value.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
- </member>
- <member name="M:EnumsNET.Enums.Parse``1(System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- Converts the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="format0">The first parsing enum format.</param>
- <param name="format1">The second parsing enum format.</param>
- <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
- -or-
- <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
- </member>
- <member name="M:EnumsNET.Enums.Parse``1(System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- Converts the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="format0">The first parsing enum format.</param>
- <param name="format1">The second parsing enum format.</param>
- <param name="format2">The third parsing enum format.</param>
- <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
- -or-
- <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
- </member>
- <member name="M:EnumsNET.Enums.Parse``1(System.String,System.Boolean,EnumsNET.EnumFormat[])">
- <summary>
- Converts the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="formats">The parsing enum formats.</param>
- <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
- -or-
- <paramref name="formats"/> contains an invalid value.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryParse``1(System.String,``0@)">
- <summary>
- 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.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum member names or values' string representation.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- </member>
- <member name="M:EnumsNET.Enums.TryParse``1(System.String,System.Boolean,``0@)">
- <summary>
- 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.
- The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive. The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum member names or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- </member>
- <member name="M:EnumsNET.Enums.TryParse``1(System.String,System.Boolean,``0@,EnumsNET.EnumFormat)">
- <summary>
- Tries to convert the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
- using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
- <param name="format">The parsing enum format.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="format"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryParse``1(System.String,System.Boolean,``0@,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- Tries to convert the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
- <param name="format0">The first parsing enum format.</param>
- <param name="format1">The second parsing enum format.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryParse``1(System.String,System.Boolean,``0@,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- Tries to convert the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
- <param name="format0">The first parsing enum format.</param>
- <param name="format1">The second parsing enum format.</param>
- <param name="format2">The third parsing enum format.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryParse``1(System.String,System.Boolean,``0@,EnumsNET.EnumFormat[])">
- <summary>
- Tries to convert the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
- <param name="formats">The parsing enum formats.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="formats"/> contains an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetUnderlyingTypeUnsafe``1">
- <summary>
- Retrieves the underlying type of <typeparamref name="TEnum"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <returns>The underlying type of <typeparamref name="TEnum"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetMemberCountUnsafe``1(EnumsNET.EnumMemberSelection)">
- <summary>
- Retrieves <typeparamref name="TEnum"/>'s member count.
- The parameter <paramref name="selection"/> indicates what members to include.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="selection">Indicates what members to include.</param>
- <returns><typeparamref name="TEnum"/>'s member count.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="selection"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetMembersUnsafe``1(EnumsNET.EnumMemberSelection)">
- <summary>
- Retrieves <typeparamref name="TEnum"/>'s members in increasing value order.
- The parameter <paramref name="selection"/> indicates what members to include.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="selection">Indicates what members to include.</param>
- <returns><typeparamref name="TEnum"/>'s members in increasing value order.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="selection"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetNamesUnsafe``1(EnumsNET.EnumMemberSelection)">
- <summary>
- Retrieves <typeparamref name="TEnum"/>'s members' names in increasing value order.
- The parameter <paramref name="selection"/> indicates what members to include.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="selection">Indicates what members to include.</param>
- <returns><typeparamref name="TEnum"/>'s members' names in increasing value order.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="selection"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetValuesUnsafe``1(EnumsNET.EnumMemberSelection)">
- <summary>
- Retrieves <typeparamref name="TEnum"/>'s members' values in increasing value order.
- The parameter <paramref name="selection"/> indicates what members to include.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="selection">Indicates what members to include.</param>
- <returns><typeparamref name="TEnum"/>'s members' values in increasing value order.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="selection"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToObjectUnsafe``1(System.Object,EnumsNET.EnumValidation)">
- <summary>
- Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <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"/>,
- <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>
- <param name="validation">The validation to perform on the result.</param>
- <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="value"/> is not a valid type
- -or-
- <paramref name="validation"/> is an invalid value
- -or-
- the result is invalid with the specified <paramref name="validation"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToObjectUnsafe``1(System.SByte,EnumsNET.EnumValidation)">
- <summary>
- Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">Value to convert.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value
- -or-
- the result is invalid with the specified <paramref name="validation"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToObjectUnsafe``1(System.Byte,EnumsNET.EnumValidation)">
- <summary>
- Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">Value to convert.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value
- -or-
- the result is invalid with the specified <paramref name="validation"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToObjectUnsafe``1(System.Int16,EnumsNET.EnumValidation)">
- <summary>
- Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">Value to convert.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value
- -or-
- the result is invalid with the specified <paramref name="validation"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToObjectUnsafe``1(System.UInt16,EnumsNET.EnumValidation)">
- <summary>
- Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">Value to convert.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value
- -or-
- the result is invalid with the specified <paramref name="validation"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToObjectUnsafe``1(System.Int32,EnumsNET.EnumValidation)">
- <summary>
- Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">Value to convert.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value
- -or-
- the result is invalid with the specified <paramref name="validation"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToObjectUnsafe``1(System.UInt32,EnumsNET.EnumValidation)">
- <summary>
- Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">Value to convert.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value
- -or-
- the result is invalid with the specified <paramref name="validation"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToObjectUnsafe``1(System.Int64,EnumsNET.EnumValidation)">
- <summary>
- Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">Value to convert.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value
- -or-
- the result is invalid with the specified <paramref name="validation"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToObjectUnsafe``1(System.UInt64,EnumsNET.EnumValidation)">
- <summary>
- Converts the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">Value to convert.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>The specified <paramref name="value"/> converted to a <typeparamref name="TEnum"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value
- -or-
- the result is invalid with the specified <paramref name="validation"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryToObjectUnsafe``1(System.Object,``0@,EnumsNET.EnumValidation)">
- <summary>
- Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <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"/>,
- <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>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryToObjectUnsafe``1(System.SByte,``0@,EnumsNET.EnumValidation)">
- <summary>
- Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">Value to try to convert.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryToObjectUnsafe``1(System.Byte,``0@,EnumsNET.EnumValidation)">
- <summary>
- Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">Value to try to convert.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryToObjectUnsafe``1(System.Int16,``0@,EnumsNET.EnumValidation)">
- <summary>
- Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">Value to try to convert.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryToObjectUnsafe``1(System.UInt16,``0@,EnumsNET.EnumValidation)">
- <summary>
- Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">Value to try to convert.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryToObjectUnsafe``1(System.Int32,``0@,EnumsNET.EnumValidation)">
- <summary>
- Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">Value to try to convert.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryToObjectUnsafe``1(System.UInt32,``0@,EnumsNET.EnumValidation)">
- <summary>
- Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">Value to try to convert.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryToObjectUnsafe``1(System.Int64,``0@,EnumsNET.EnumValidation)">
- <summary>
- Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">Value to try to convert.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryToObjectUnsafe``1(System.UInt64,``0@,EnumsNET.EnumValidation)">
- <summary>
- Tries to convert the specified <paramref name="value"/> to a <typeparamref name="TEnum"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">Value to try to convert.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> whose value is <paramref name="value"/>.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.IsValidUnsafe``1(``0,EnumsNET.EnumValidation)">
- <summary>
- Indicates if <paramref name="value"/> is valid using the specified <paramref name="validation"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <param name="validation">The validation to perform on the value.</param>
- <returns>Indication if <paramref name="value"/> is valid.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.IsDefinedUnsafe``1(``0)">
- <summary>
- Indicates if <paramref name="value"/> is defined.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <returns>Indication if <paramref name="value"/> is defined.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ValidateUnsafe``1(``0,System.String,EnumsNET.EnumValidation)">
- <summary>
- Validates that <paramref name="value"/> is valid using the specified <paramref name="validation"/>.
- If it's not it throws an <see cref="T:System.ArgumentException"/> with the specified <paramref name="paramName"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <param name="paramName">The parameter name to be used if throwing an <see cref="T:System.ArgumentException"/>.</param>
- <param name="validation">The validation to perform on the value.</param>
- <returns><paramref name="value"/> for use in fluent API's and base constructor method calls.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value
- -or-
- <paramref name="value"/> is invalid.</exception>
- </member>
- <member name="M:EnumsNET.Enums.AsStringUnsafe``1(``0)">
- <summary>
- Converts the specified <paramref name="value"/> to its string representation.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <returns>A string representation of <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.Enums.AsStringUnsafe``1(``0,System.String)">
- <summary>
- Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="format"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <param name="format">The output format to use.</param>
- <returns>A string representation of <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- <exception cref="T:System.FormatException"><paramref name="format"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.AsStringUnsafe``1(``0,EnumsNET.EnumFormat)">
- <summary>
- Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="format"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <param name="format">The output format to use.</param>
- <returns>A string representation of <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="format"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.AsStringUnsafe``1(``0,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- Converts the specified <paramref name="value"/> to its string representation using the specified formats.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <param name="format0">The first output format to use.</param>
- <param name="format1">The second output format to use if using the first resolves to <c>null</c>.</param>
- <returns>A string representation of <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.AsStringUnsafe``1(``0,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- Converts the specified <paramref name="value"/> to its string representation using the specified formats.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <param name="format0">The first output format to use.</param>
- <param name="format1">The second output format to use if using the first resolves to <c>null</c>.</param>
- <param name="format2">The third output format to use if using the first and second both resolve to <c>null</c>.</param>
- <returns>A string representation of <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.AsStringUnsafe``1(``0,EnumsNET.EnumFormat[])">
- <summary>
- Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="formats"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <param name="formats">The output formats to use.</param>
- <returns>A string representation of <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="formats"/> contains an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.FormatUnsafe``1(``0,System.String)">
- <summary>
- Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="format"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <param name="format">The output format to use.</param>
- <returns>A string representation of <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="format"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- <exception cref="T:System.FormatException"><paramref name="format"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetUnderlyingValueUnsafe``1(``0)">
- <summary>
- Returns <paramref name="value"/>'s underlying integral value.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/>'s underlying integral value.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToSByteUnsafe``1(``0)">
- <summary>
- Converts <paramref name="value"/> to an <see cref="T:System.SByte"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/> converted to an <see cref="T:System.SByte"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.SByte"/>'s value range without overflowing.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToByteUnsafe``1(``0)">
- <summary>
- Converts <paramref name="value"/> to a <see cref="T:System.Byte"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/> converted to a <see cref="T:System.Byte"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Byte"/>'s value range without overflowing.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToInt16Unsafe``1(``0)">
- <summary>
- Converts <paramref name="value"/> to an <see cref="T:System.Int16"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/> converted to an <see cref="T:System.Int16"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Int16"/>'s value range without overflowing.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToUInt16Unsafe``1(``0)">
- <summary>
- Converts <paramref name="value"/> to a <see cref="T:System.UInt16"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/> converted to a <see cref="T:System.UInt16"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.UInt16"/>'s value range without overflowing.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToInt32Unsafe``1(``0)">
- <summary>
- Converts <paramref name="value"/> to an <see cref="T:System.Int32"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/> converted to an <see cref="T:System.Int32"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Int32"/>'s value range without overflowing.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToUInt32Unsafe``1(``0)">
- <summary>
- Converts <paramref name="value"/> to a <see cref="T:System.UInt32"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/> converted to a <see cref="T:System.UInt32"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.UInt32"/>'s value range without overflowing.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToInt64Unsafe``1(``0)">
- <summary>
- Converts <paramref name="value"/> to an <see cref="T:System.Int64"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/> converted to an <see cref="T:System.Int64"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Int64"/>'s value range without overflowing.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToUInt64Unsafe``1(``0)">
- <summary>
- Converts <paramref name="value"/> to a <see cref="T:System.UInt64"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/> converted to a <see cref="T:System.UInt64"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.UInt64"/>'s value range without overflowing.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetHashCodeUnsafe``1(``0)">
- <summary>
- Retrieves the hash code of <paramref name="value"/>. It's more efficient as it doesn't require boxing and unboxing of <paramref name="value"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <returns>Hash code of <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.Enums.EqualsUnsafe``1(``0,``0)">
- <summary>
- Indicates if <paramref name="value"/> equals <paramref name="other"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <param name="other">The other enum value.</param>
- <returns>Indication if <paramref name="value"/> equals <paramref name="other"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.Enums.CompareToUnsafe``1(``0,``0)">
- <summary>
- Compares <paramref name="value"/> to <paramref name="other"/> for ordering.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <param name="other">The other enum value.</param>
- <returns>1 if <paramref name="value"/> is greater than <paramref name="other"/>, 0 if <paramref name="value"/> equals <paramref name="other"/>,
- and -1 if <paramref name="value"/> is less than <paramref name="other"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetNameUnsafe``1(``0)">
- <summary>
- Retrieves <paramref name="value"/>'s enum member name if defined otherwise <c>null</c>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/>'s enum member name if defined otherwise <c>null</c>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetAttributesUnsafe``1(``0)">
- <summary>
- Retrieves <paramref name="value"/>'s enum member attributes if defined otherwise <c>null</c>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/>'s enum member attributes if defined otherwise <c>null</c>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetMemberUnsafe``1(``0)">
- <summary>
- Retrieves an enum member with the specified <paramref name="value"/> if defined otherwise <c>null</c>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum value.</param>
- <returns>Enum member with the specified <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetMemberUnsafe``1(System.String)">
- <summary>
- Retrieves the enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.
- Is case-sensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="name">The enum member name.</param>
- <returns>Enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetMemberUnsafe``1(System.String,System.Boolean)">
- <summary>
- Retrieves the enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.
- The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="name">The enum member name.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <returns>Enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetMemberUnsafe``1(System.String,System.Boolean,EnumsNET.EnumFormat)">
- <summary>
- Retrieves an enum member whose string representation using the specified <paramref name="format"/> is <paramref name="value"/> if defined otherwise <c>null</c>.
- The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum member's string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="format">The parsing enum format.</param>
- <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="format"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetMemberUnsafe``1(System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- Retrieves an enum member whose string representation using the specified formats is <paramref name="value"/> if defined otherwise <c>null</c>.
- The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum member's string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="format0">The first parsing enum format.</param>
- <param name="format1">The second parsing enum format.</param>
- <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetMemberUnsafe``1(System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- Retrieves an enum member whose string representation using the specified formats is <paramref name="value"/> if defined otherwise <c>null</c>.
- The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum member's string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="format0">The first parsing enum format.</param>
- <param name="format1">The second parsing enum format.</param>
- <param name="format2">The third parsing enum format.</param>
- <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetMemberUnsafe``1(System.String,System.Boolean,EnumsNET.EnumFormat[])">
- <summary>
- Retrieves an enum member whose string representation using the specified <paramref name="formats"/> is <paramref name="value"/> if defined otherwise <c>null</c>.
- The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum member's string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="formats">The parsing enum formats.</param>
- <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="formats"/> contains an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ParseUnsafe``1(System.String)">
- <summary>
- Converts the string representation of one or more member names or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum member names or values' string representation.</param>
- <returns>A <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="value"/> doesn't represent a member name or value of <typeparamref name="TEnum"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of <typeparamref name="TEnum"/>'s underlying type.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ParseUnsafe``1(System.String,System.Boolean)">
- <summary>
- Converts the string representation of one or more member names or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value.
- The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum member names or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="value"/> doesn't represent a member name or value of <typeparamref name="TEnum"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ParseUnsafe``1(System.String,System.Boolean,EnumsNET.EnumFormat)">
- <summary>
- Converts the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
- using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="format">The parsing enum format.</param>
- <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
- -or-
- <paramref name="format"/> is an invalid value.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ParseUnsafe``1(System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- Converts the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="format0">The first parsing enum format.</param>
- <param name="format1">The second parsing enum format.</param>
- <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
- -or-
- <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ParseUnsafe``1(System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- Converts the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="format0">The first parsing enum format.</param>
- <param name="format1">The second parsing enum format.</param>
- <param name="format2">The third parsing enum format.</param>
- <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
- -or-
- <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ParseUnsafe``1(System.String,System.Boolean,EnumsNET.EnumFormat[])">
- <summary>
- Converts the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="formats">The parsing enum formats.</param>
- <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
- -or-
- <paramref name="formats"/> contains an invalid value.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryParseUnsafe``1(System.String,``0@)">
- <summary>
- 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.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum member names or values' string representation.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryParseUnsafe``1(System.String,System.Boolean,``0@)">
- <summary>
- 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.
- The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive. The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum member names or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryParseUnsafe``1(System.String,System.Boolean,``0@,EnumsNET.EnumFormat)">
- <summary>
- Tries to convert the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
- using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
- <param name="format">The parsing enum format.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="format"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryParseUnsafe``1(System.String,System.Boolean,``0@,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- Tries to convert the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
- <param name="format0">The first parsing enum format.</param>
- <param name="format1">The second parsing enum format.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryParseUnsafe``1(System.String,System.Boolean,``0@,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- Tries to convert the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
- <param name="format0">The first parsing enum format.</param>
- <param name="format1">The second parsing enum format.</param>
- <param name="format2">The third parsing enum format.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="format0"/>, <paramref name="format1"/>, <paramref name="format2"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryParseUnsafe``1(System.String,System.Boolean,``0@,EnumsNET.EnumFormat[])">
- <summary>
- Tries to convert the string representation of one or more members or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
- <param name="formats">The parsing enum formats.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="formats"/> contains an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetUnderlyingType(System.Type)">
- <summary>
- Retrieves the underlying type of <paramref name="enumType"/>.
- </summary>
- <param name="enumType">The enum type.</param>
- <returns>The underlying type of <paramref name="enumType"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetMemberCount(System.Type,EnumsNET.EnumMemberSelection)">
- <summary>
- Retrieves <paramref name="enumType"/>'s member count.
- The parameter <paramref name="selection"/> indicates what members to include.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="selection">Indicates what members to include.</param>
- <returns><paramref name="enumType"/>'s member count.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="selection"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetMembers(System.Type,EnumsNET.EnumMemberSelection)">
- <summary>
- Retrieves <paramref name="enumType"/>'s members in increasing value order.
- The parameter <paramref name="selection"/> indicates what members to include.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="selection">Indicates what members to include.</param>
- <returns><paramref name="enumType"/>'s members in increasing value order.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="selection"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetNames(System.Type,EnumsNET.EnumMemberSelection)">
- <summary>
- Retrieves <paramref name="enumType"/>'s members' names in increasing value order.
- The parameter <paramref name="selection"/> indicates what members to include.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="selection">Indicates what members to include.</param>
- <returns><paramref name="enumType"/>'s members' names in increasing value order.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="selection"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetValues(System.Type,EnumsNET.EnumMemberSelection)">
- <summary>
- Retrieves <paramref name="enumType"/>'s members' values in increasing value order.
- The parameter <paramref name="selection"/> indicates what members to include.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="selection">Indicates what members to include.</param>
- <returns><paramref name="enumType"/>'s members' values in increasing value order.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="selection"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToObject(System.Type,System.Object,EnumsNET.EnumValidation)">
- <summary>
- Converts the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- </summary>
- <param name="enumType">The enum type.</param>
- <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"/>,
- <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>
- <param name="validation">The validation to perform on the result.</param>
- <returns>The specified <paramref name="value"/> converted to a <paramref name="enumType"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> is not a valid type
- -or-
- <paramref name="validation"/> is an invalid value
- -or-
- the result is invalid with the specified <paramref name="validation"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToObject(System.Type,System.SByte,EnumsNET.EnumValidation)">
- <summary>
- Converts the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">Value to convert.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>The specified <paramref name="value"/> converted to a <paramref name="enumType"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value
- -or-
- the result is invalid with the specified <paramref name="validation"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToObject(System.Type,System.Byte,EnumsNET.EnumValidation)">
- <summary>
- Converts the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">Value to convert.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>The specified <paramref name="value"/> converted to a <paramref name="enumType"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value
- -or-
- the result is invalid with the specified <paramref name="validation"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToObject(System.Type,System.Int16,EnumsNET.EnumValidation)">
- <summary>
- Converts the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">Value to convert.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>The specified <paramref name="value"/> converted to a <paramref name="enumType"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value
- -or-
- the result is invalid with the specified <paramref name="validation"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToObject(System.Type,System.UInt16,EnumsNET.EnumValidation)">
- <summary>
- Converts the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">Value to convert.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>The specified <paramref name="value"/> converted to a <paramref name="enumType"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value
- -or-
- the result is invalid with the specified <paramref name="validation"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToObject(System.Type,System.Int32,EnumsNET.EnumValidation)">
- <summary>
- Converts the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">Value to convert.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>The specified <paramref name="value"/> converted to a <paramref name="enumType"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value
- -or-
- the result is invalid with the specified <paramref name="validation"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToObject(System.Type,System.UInt32,EnumsNET.EnumValidation)">
- <summary>
- Converts the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">Value to convert.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>The specified <paramref name="value"/> converted to a <paramref name="enumType"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value
- -or-
- the result is invalid with the specified <paramref name="validation"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToObject(System.Type,System.Int64,EnumsNET.EnumValidation)">
- <summary>
- Converts the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">Value to convert.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>The specified <paramref name="value"/> converted to a <paramref name="enumType"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value
- -or-
- the result is invalid with the specified <paramref name="validation"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToObject(System.Type,System.UInt64,EnumsNET.EnumValidation)">
- <summary>
- Converts the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">Value to convert.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>The specified <paramref name="value"/> converted to a <paramref name="enumType"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value
- -or-
- the result is invalid with the specified <paramref name="validation"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the underlying type's value range.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryToObject(System.Type,System.Object,System.Object@,EnumsNET.EnumValidation)">
- <summary>
- Tries to convert the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- The return value indicates whether the conversion succeeded.
- </summary>
- <param name="enumType">The enum type.</param>
- <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"/>,
- <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>
- <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> whose value is <paramref name="value"/>.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryToObject(System.Type,System.SByte,System.Object@,EnumsNET.EnumValidation)">
- <summary>
- Tries to convert the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- The return value indicates whether the conversion succeeded.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">Value to try to convert.</param>
- <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> whose value is <paramref name="value"/>.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryToObject(System.Type,System.Byte,System.Object@,EnumsNET.EnumValidation)">
- <summary>
- Tries to convert the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- The return value indicates whether the conversion succeeded.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">Value to try to convert.</param>
- <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> whose value is <paramref name="value"/>.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryToObject(System.Type,System.Int16,System.Object@,EnumsNET.EnumValidation)">
- <summary>
- Tries to convert the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- The return value indicates whether the conversion succeeded.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">Value to try to convert.</param>
- <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> whose value is <paramref name="value"/>.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryToObject(System.Type,System.UInt16,System.Object@,EnumsNET.EnumValidation)">
- <summary>
- Tries to convert the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- The return value indicates whether the conversion succeeded.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">Value to try to convert.</param>
- <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> whose value is <paramref name="value"/>.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryToObject(System.Type,System.Int32,System.Object@,EnumsNET.EnumValidation)">
- <summary>
- Tries to convert the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- The return value indicates whether the conversion succeeded.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">Value to try to convert.</param>
- <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> whose value is <paramref name="value"/>.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryToObject(System.Type,System.UInt32,System.Object@,EnumsNET.EnumValidation)">
- <summary>
- Tries to convert the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- The return value indicates whether the conversion succeeded.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">Value to try to convert.</param>
- <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> whose value is <paramref name="value"/>.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryToObject(System.Type,System.Int64,System.Object@,EnumsNET.EnumValidation)">
- <summary>
- Tries to convert the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- The return value indicates whether the conversion succeeded.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">Value to try to convert.</param>
- <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> whose value is <paramref name="value"/>.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryToObject(System.Type,System.UInt64,System.Object@,EnumsNET.EnumValidation)">
- <summary>
- Tries to convert the specified <paramref name="value"/> to a value of type <paramref name="enumType"/> while checking that it doesn't overflow the
- underlying type. The parameter <paramref name="validation"/> specifies the validation to perform on the result.
- The return value indicates whether the conversion succeeded.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">Value to try to convert.</param>
- <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> whose value is <paramref name="value"/>.</param>
- <param name="validation">The validation to perform on the result.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="validation"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.IsValid(System.Type,System.Object,EnumsNET.EnumValidation)">
- <summary>
- Indicates if <paramref name="value"/> is valid. If <paramref name="enumType"/> is a standard enum it returns whether the value is defined.
- 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
- or is defined. Or if <paramref name="enumType"/> has an attribute that implements <see cref="T:EnumsNET.IEnumValidatorAttribute`1"/>
- then that attribute's <see cref="M:EnumsNET.IEnumValidatorAttribute`1.IsValid(`0)"/> method is used.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum value.</param>
- <param name="validation">The validation to perform on the value.</param>
- <returns>Indication if <paramref name="value"/> is valid.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> is of an invalid type
- -or-
- <paramref name="validation"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.IsDefined(System.Type,System.Object)">
- <summary>
- Indicates if <paramref name="value"/> is defined.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum value.</param>
- <returns>Indication if <paramref name="value"/> is defined.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> is of an invalid type.</exception>
- </member>
- <member name="M:EnumsNET.Enums.Validate(System.Type,System.Object,System.String,EnumsNET.EnumValidation)">
- <summary>
- 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"/>.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum value.</param>
- <param name="paramName">The parameter name to be used if throwing an <see cref="T:System.ArgumentException"/>.</param>
- <param name="validation">The validation to perform on the value.</param>
- <returns><paramref name="value"/> for use in fluent API's and base constructor method calls.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> is of an invalid type
- -or-
- <paramref name="validation"/> is an invalid value
- -or-
- <paramref name="value"/> is invalid.</exception>
- </member>
- <member name="M:EnumsNET.Enums.AsString(System.Type,System.Object)">
- <summary>
- Converts the specified <paramref name="value"/> to its string representation.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum value.</param>
- <returns>A string representation of <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> is of an invalid type.</exception>
- </member>
- <member name="M:EnumsNET.Enums.AsString(System.Type,System.Object,System.String)">
- <summary>
- Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="format"/>.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum value.</param>
- <param name="format">The output format to use.</param>
- <returns>A string representation of <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> is of an invalid type.</exception>
- <exception cref="T:System.FormatException"><paramref name="format"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.AsString(System.Type,System.Object,EnumsNET.EnumFormat)">
- <summary>
- Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="format"/>.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum value.</param>
- <param name="format">The output format to use.</param>
- <returns>A string representation of <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="format"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.AsString(System.Type,System.Object,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- Converts the specified <paramref name="value"/> to its string representation using the specified formats.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum value.</param>
- <param name="format0">The first output format to use.</param>
- <param name="format1">The second output format to use if using the first resolves to <c>null</c>.</param>
- <returns>A string representation of <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.AsString(System.Type,System.Object,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- Converts the specified <paramref name="value"/> to its string representation using the specified formats.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum value.</param>
- <param name="format0">The first output format to use.</param>
- <param name="format1">The second output format to use if using the first resolves to <c>null</c>.</param>
- <param name="format2">The third output format to use if using the first and second both resolve to <c>null</c>.</param>
- <returns>A string representation of <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.AsString(System.Type,System.Object,EnumsNET.EnumFormat[])">
- <summary>
- Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="formats"/>.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum value.</param>
- <param name="formats">The output formats to use.</param>
- <returns>A string representation of <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="formats"/> contains an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.Format(System.Type,System.Object,System.String)">
- <summary>
- Converts the specified <paramref name="value"/> to its string representation using the specified <paramref name="format"/>.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum value.</param>
- <param name="format">The output format to use.</param>
- <returns>A string representation of <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/>, <paramref name="value"/>, or <paramref name="format"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> is of an invalid type.</exception>
- <exception cref="T:System.FormatException"><paramref name="format"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetUnderlyingValue(System.Type,System.Object)">
- <summary>
- Returns <paramref name="value"/>'s underlying integral value.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/>'s underlying integral value.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> is of an invalid type.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToSByte(System.Type,System.Object)">
- <summary>
- Converts <paramref name="value"/> to an <see cref="T:System.SByte"/>.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/> converted to an <see cref="T:System.SByte"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> is of an invalid type.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.SByte"/>'s value range without overflowing.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToByte(System.Type,System.Object)">
- <summary>
- Converts <paramref name="value"/> to a <see cref="T:System.Byte"/>.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/> converted to a <see cref="T:System.Byte"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> is of an invalid type.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Byte"/>'s value range without overflowing.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToInt16(System.Type,System.Object)">
- <summary>
- Converts <paramref name="value"/> to an <see cref="T:System.Int16"/>.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/> converted to an <see cref="T:System.Int16"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> is of an invalid type.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Int16"/>'s value range without overflowing.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToUInt16(System.Type,System.Object)">
- <summary>
- Converts <paramref name="value"/> to a <see cref="T:System.UInt16"/>.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/> converted to a <see cref="T:System.UInt16"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> is of an invalid type.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.UInt16"/>'s value range without overflowing.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToInt32(System.Type,System.Object)">
- <summary>
- Converts <paramref name="value"/> to an <see cref="T:System.Int32"/>.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/> converted to an <see cref="T:System.Int32"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> is of an invalid type.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Int32"/>'s value range without overflowing.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToUInt32(System.Type,System.Object)">
- <summary>
- Converts <paramref name="value"/> to a <see cref="T:System.UInt32"/>.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/> converted to a <see cref="T:System.UInt32"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> is of an invalid type.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.UInt32"/>'s value range without overflowing.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToInt64(System.Type,System.Object)">
- <summary>
- Converts <paramref name="value"/> to an <see cref="T:System.Int64"/>.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/> converted to an <see cref="T:System.Int64"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> is of an invalid type.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.Int64"/>'s value range without overflowing.</exception>
- </member>
- <member name="M:EnumsNET.Enums.ToUInt64(System.Type,System.Object)">
- <summary>
- Converts <paramref name="value"/> to a <see cref="T:System.UInt64"/>.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/> converted to a <see cref="T:System.UInt64"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> is of an invalid type.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> cannot fit within <see cref="T:System.UInt64"/>'s value range without overflowing.</exception>
- </member>
- <member name="M:EnumsNET.Enums.Equals(System.Type,System.Object,System.Object)">
- <summary>
- Indicates if <paramref name="value"/> equals <paramref name="other"/>.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum value.</param>
- <param name="other">The other enum value.</param>
- <returns>Indication if <paramref name="value"/> equals <paramref name="other"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/>, <paramref name="value"/>, or <paramref name="other"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> or <paramref name="other"/> is of an invalid type.</exception>
- </member>
- <member name="M:EnumsNET.Enums.CompareTo(System.Type,System.Object,System.Object)">
- <summary>
- Compares <paramref name="value"/> to <paramref name="other"/> for ordering.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum value.</param>
- <param name="other">The other enum value.</param>
- <returns>1 if <paramref name="value"/> is greater than <paramref name="other"/>, 0 if <paramref name="value"/> equals <paramref name="other"/>,
- and -1 if <paramref name="value"/> is less than <paramref name="other"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/>, <paramref name="value"/>, or <paramref name="other"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> or <paramref name="other"/> is of an invalid type.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetName(System.Type,System.Object)">
- <summary>
- Retrieves <paramref name="value"/>'s enum member name if defined otherwise <c>null</c>.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/>'s enum member name if defined otherwise <c>null</c>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> is of an invalid type.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetAttributes(System.Type,System.Object)">
- <summary>
- Retrieves <paramref name="value"/>'s enum member attributes if defined otherwise <c>null</c>.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum value.</param>
- <returns><paramref name="value"/>'s enum member attributes if defined otherwise <c>null</c>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> is of an invalid type.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetMember(System.Type,System.Object)">
- <summary>
- Retrieves an enum member with the specified <paramref name="value"/> if defined otherwise <c>null</c>.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum value.</param>
- <returns>Enum member with the specified <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> is of an invalid type.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetMember(System.Type,System.String)">
- <summary>
- Retrieves the enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.
- Is case-sensitive.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="name">The enum member name.</param>
- <returns>Enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="name"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetMember(System.Type,System.String,System.Boolean)">
- <summary>
- Retrieves the enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.
- The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="name">The enum member name.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <returns>Enum member with the specified <paramref name="name"/> if defined otherwise <c>null</c>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="name"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetMember(System.Type,System.String,System.Boolean,EnumsNET.EnumFormat)">
- <summary>
- Retrieves an enum member whose string representation using the specified <paramref name="format"/> is <paramref name="value"/> if defined otherwise <c>null</c>.
- The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum member's string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="format">The parsing enum format.</param>
- <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="format"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetMember(System.Type,System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- Retrieves an enum member whose string representation using the specified formats is <paramref name="value"/> if defined otherwise <c>null</c>.
- The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum member's string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="format0">The first parsing enum format.</param>
- <param name="format1">The second parsing enum format.</param>
- <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetMember(System.Type,System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- Retrieves an enum member whose string representation using the specified formats is <paramref name="value"/> if defined otherwise <c>null</c>.
- The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum member's string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="format0">The first parsing enum format.</param>
- <param name="format1">The second parsing enum format.</param>
- <param name="format2">The third parsing enum format.</param>
- <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.GetMember(System.Type,System.String,System.Boolean,EnumsNET.EnumFormat[])">
- <summary>
- Retrieves an enum member whose string representation using the specified <paramref name="formats"/> is <paramref name="value"/> if defined otherwise <c>null</c>.
- The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum member's string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="formats">The parsing enum formats.</param>
- <returns>Enum member represented by <paramref name="value"/> if defined otherwise <c>null</c>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="formats"/> contains an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.Parse(System.Type,System.String)">
- <summary>
- 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"/>.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum member names or values' string representation.</param>
- <returns>A <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> doesn't represent a member name or value of <paramref name="enumType"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of <paramref name="enumType"/>'s underlying type.</exception>
- </member>
- <member name="M:EnumsNET.Enums.Parse(System.Type,System.String,System.Boolean)">
- <summary>
- 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"/>.
- The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum member names or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> doesn't represent a member name or value of <paramref name="enumType"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
- </member>
- <member name="M:EnumsNET.Enums.Parse(System.Type,System.String,System.Boolean,EnumsNET.EnumFormat)">
- <summary>
- Converts the string representation of one or more members or values of <paramref name="enumType"/> to its respective value of type <paramref name="enumType"/>
- using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="format">The parsing enum format.</param>
- <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> doesn't represent a member or value of <paramref name="enumType"/>
- -or-
- <paramref name="format"/> is an invalid value.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
- </member>
- <member name="M:EnumsNET.Enums.Parse(System.Type,System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- Converts the string representation of one or more members or values of <paramref name="enumType"/> to its respective value of type <paramref name="enumType"/>
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="format0">The first parsing enum format.</param>
- <param name="format1">The second parsing enum format.</param>
- <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> doesn't represent a member or value of <paramref name="enumType"/>
- -or-
- <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
- </member>
- <member name="M:EnumsNET.Enums.Parse(System.Type,System.String,System.Boolean,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- Converts the string representation of one or more members or values of <paramref name="enumType"/> to its respective value of type <paramref name="enumType"/>
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="format0">The first parsing enum format.</param>
- <param name="format1">The second parsing enum format.</param>
- <param name="format2">The third parsing enum format.</param>
- <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> doesn't represent a member or value of <paramref name="enumType"/>
- -or-
- <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
- </member>
- <member name="M:EnumsNET.Enums.Parse(System.Type,System.String,System.Boolean,EnumsNET.EnumFormat[])">
- <summary>
- Converts the string representation of one or more members or values of <paramref name="enumType"/> to its respective value of type <paramref name="enumType"/>
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="formats">The parsing enum formats.</param>
- <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> doesn't represent a member or value of <paramref name="enumType"/>
- -or-
- <paramref name="formats"/> contains an invalid value.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryParse(System.Type,System.String,System.Object@)">
- <summary>
- 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"/>.
- The return value indicates whether the conversion succeeded.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum member names or values' string representation.</param>
- <param name="result">If the conversion succeeds this contains a <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryParse(System.Type,System.String,System.Boolean,System.Object@)">
- <summary>
- 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"/>.
- The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive. The return value indicates whether the conversion succeeded.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum member names or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="result">If the conversion succeeds this contains a <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryParse(System.Type,System.String,System.Boolean,System.Object@,EnumsNET.EnumFormat)">
- <summary>
- 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"/>
- using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- The return value indicates whether the conversion succeeded.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="result">If the conversion succeeds this contains a <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</param>
- <param name="format">The parsing enum format.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="format"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryParse(System.Type,System.String,System.Boolean,System.Object@,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- 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"/>
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- The return value indicates whether the conversion succeeded.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="result">If the conversion succeeds this contains a <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</param>
- <param name="format0">The first parsing enum format.</param>
- <param name="format1">The second parsing enum format.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryParse(System.Type,System.String,System.Boolean,System.Object@,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- 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"/>
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- The return value indicates whether the conversion succeeded.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="result">If the conversion succeeds this contains a <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</param>
- <param name="format0">The first parsing enum format.</param>
- <param name="format1">The second parsing enum format.</param>
- <param name="format2">The third parsing enum format.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.Enums.TryParse(System.Type,System.String,System.Boolean,System.Object@,EnumsNET.EnumFormat[])">
- <summary>
- 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"/>
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- The return value indicates whether the conversion succeeded.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="result">If the conversion succeeds this contains a <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</param>
- <param name="formats">The parsing enum formats.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="formats"/> contains an invalid value.</exception>
- </member>
- <member name="T:EnumsNET.EnumValidation">
- <summary>
- Specifies the enum validation to perform.
- </summary>
- </member>
- <member name="F:EnumsNET.EnumValidation.None">
- <summary>
- No validation.
- </summary>
- </member>
- <member name="F:EnumsNET.EnumValidation.Default">
- <summary>
- If the enum is a standard enum returns whether the value is defined.
- 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
- or is defined. Or if the enum has an attribute that implements <see cref="T:EnumsNET.IEnumValidatorAttribute`1"/>
- then that attribute's <see cref="M:EnumsNET.IEnumValidatorAttribute`1.IsValid(`0)"/> method is used.
- </summary>
- </member>
- <member name="F:EnumsNET.EnumValidation.IsDefined">
- <summary>
- Returns if the value is defined.
- </summary>
- </member>
- <member name="F:EnumsNET.EnumValidation.IsValidFlagCombination">
- <summary>
- Returns if the value is a valid flag combination of the enum's defined values.
- </summary>
- </member>
- <member name="T:EnumsNET.FlagEnums">
- <summary>
- Static class that provides efficient type-safe flag enum operations through the use of cached enum names, values, and attributes.
- Many operations are exposed as C# extension methods for convenience.
- </summary>
- </member>
- <member name="M:EnumsNET.FlagEnums.IsFlagEnum``1">
- <summary>
- Indicates if <typeparamref name="TEnum"/> is marked with the <see cref="T:System.FlagsAttribute"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <returns>Indication if <typeparamref name="TEnum"/> is marked with the <see cref="T:System.FlagsAttribute"/>.</returns>
- </member>
- <member name="M:EnumsNET.FlagEnums.GetAllFlags``1">
- <summary>
- Retrieves all the flags defined by <typeparamref name="TEnum"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <returns>All the flags defined by <typeparamref name="TEnum"/>.</returns>
- </member>
- <member name="M:EnumsNET.FlagEnums.IsValidFlagCombination``1(``0)">
- <summary>
- Indicates whether <paramref name="value"/> is a valid flag combination of <typeparamref name="TEnum"/>'s defined flags.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <returns>Indication of whether <paramref name="value"/> is a valid flag combination of <typeparamref name="TEnum"/>'s defined flags.</returns>
- </member>
- <member name="M:EnumsNET.FlagEnums.FormatFlags``1(``0)">
- <summary>
- 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".
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <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".
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
- </member>
- <member name="M:EnumsNET.FlagEnums.FormatFlags``1(``0,System.String)">
- <summary>
- 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".
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <param name="delimiter">The delimiter to use to separate individual flags.</param>
- <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".
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
- </member>
- <member name="M:EnumsNET.FlagEnums.FormatFlags``1(``0,System.String,EnumsNET.EnumFormat)">
- <summary>
- Retrieves <paramref name="value"/>'s flags formatted with <paramref name="format"/> and delimited with <paramref name="delimiter"/>
- or if empty returns the zero flag formatted with <paramref name="format"/>.
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <param name="delimiter">The delimiter to use to separate individual flags.</param>
- <param name="format">The output format to use.</param>
- <returns><paramref name="value"/>'s flags formatted with <paramref name="format"/> and delimited with <paramref name="delimiter"/>
- or if empty returns the zero flag formatted with <paramref name="format"/>.
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="format"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.FormatFlags``1(``0,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- Retrieves <paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
- or if empty returns the zero flag formatted with formats.
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <param name="delimiter">The delimiter to use to separate individual flags.</param>
- <param name="format0">The first output format to use.</param>
- <param name="format1">The second output format to use.</param>
- <returns><paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
- or if empty returns the zero flag formatted with formats.
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.FormatFlags``1(``0,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- Retrieves <paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
- or if empty returns the zero flag formatted with formats.
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <param name="delimiter">The delimiter to use to separate individual flags.</param>
- <param name="format0">The first output format to use.</param>
- <param name="format1">The second output format to use.</param>
- <param name="format2">The third output format to use.</param>
- <returns><paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
- or if empty returns the zero flag formatted with formats.
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.FormatFlags``1(``0,System.String,EnumsNET.EnumFormat[])">
- <summary>
- Retrieves <paramref name="value"/>'s flags formatted with <paramref name="formats"/> and delimited with <paramref name="delimiter"/>
- or if empty returns the zero flag formatted with <paramref name="formats"/>.
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <param name="delimiter">The delimiter to use to separate individual flags.</param>
- <param name="formats">The output formats to use.</param>
- <returns><paramref name="value"/>'s flags formatted with <paramref name="formats"/> and delimited with <paramref name="delimiter"/>
- or if empty returns the zero flag formatted with <paramref name="formats"/>.
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="formats"/> contains an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.GetFlags``1(``0)">
- <summary>
- Retrieves the flags that compose <paramref name="value"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <returns>The flags that compose <paramref name="value"/>.</returns>
- </member>
- <member name="M:EnumsNET.FlagEnums.GetFlagMembers``1(``0)">
- <summary>
- Retrieves the <see cref="T:EnumsNET.EnumMember`1"/>s of the flags that compose <paramref name="value"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <returns>The <see cref="T:EnumsNET.EnumMember`1"/>s of the flags that compose <paramref name="value"/>.</returns>
- </member>
- <member name="M:EnumsNET.FlagEnums.GetFlagCount``1">
- <summary>
- Retrieves the flag count of <typeparamref name="TEnum"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <returns>The flag count of <typeparamref name="TEnum"/>.</returns>
- </member>
- <member name="M:EnumsNET.FlagEnums.GetFlagCount``1(``0)">
- <summary>
- Retrieves the flag count of <paramref name="value"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <returns>The flag count of <paramref name="value"/>.</returns>
- </member>
- <member name="M:EnumsNET.FlagEnums.GetFlagCount``1(``0,``0)">
- <summary>
- Retrieves the flag count of <paramref name="otherFlags"/> that <paramref name="value"/> has.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <param name="otherFlags">The other flags enum value.</param>
- <returns>The flag count of <paramref name="otherFlags"/> that <paramref name="value"/> has.</returns>
- </member>
- <member name="M:EnumsNET.FlagEnums.HasAnyFlags``1(``0)">
- <summary>
- Indicates if <paramref name="value"/> has any flags.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <returns>Indication if <paramref name="value"/> has any flags.</returns>
- </member>
- <member name="M:EnumsNET.FlagEnums.HasAnyFlags``1(``0,``0)">
- <summary>
- Indicates if <paramref name="value"/> has any flags that are in <paramref name="otherFlags"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <param name="otherFlags">The other flags enum value.</param>
- <returns>Indication if <paramref name="value"/> has any flags that are in <paramref name="otherFlags"/>.</returns>
- </member>
- <member name="M:EnumsNET.FlagEnums.HasAllFlags``1(``0)">
- <summary>
- Indicates if <paramref name="value"/> has all of the flags that are defined in <typeparamref name="TEnum"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <returns>Indication if <paramref name="value"/> has all of the flags that are defined in <typeparamref name="TEnum"/>.</returns>
- </member>
- <member name="M:EnumsNET.FlagEnums.HasAllFlags``1(``0,``0)">
- <summary>
- Indicates if <paramref name="value"/> has all of the flags that are in <paramref name="otherFlags"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <param name="otherFlags">The other flags enum value.</param>
- <returns>Indication if <paramref name="value"/> has all of the flags that are in <paramref name="otherFlags"/>.</returns>
- </member>
- <member name="M:EnumsNET.FlagEnums.ToggleFlags``1(``0)">
- <summary>
- 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"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <returns><paramref name="value"/> with all of it's flags toggled.</returns>
- </member>
- <member name="M:EnumsNET.FlagEnums.ToggleFlags``1(``0,``0)">
- <summary>
- Returns <paramref name="value"/> while toggling the flags that are in <paramref name="otherFlags"/>. Equivalent to the bitwise "xor" operator.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <param name="otherFlags">The other flags enum value.</param>
- <returns><paramref name="value"/> while toggling the flags that are in <paramref name="otherFlags"/>.</returns>
- </member>
- <member name="M:EnumsNET.FlagEnums.CommonFlags``1(``0,``0)">
- <summary>
- Returns <paramref name="value"/> with only the flags that are also in <paramref name="otherFlags"/>. Equivalent to the bitwise "and" operation.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <param name="otherFlags">The other flags enum value.</param>
- <returns><paramref name="value"/> with only the flags that are also in <paramref name="otherFlags"/>.</returns>
- </member>
- <member name="M:EnumsNET.FlagEnums.CombineFlags``1(``0,``0)">
- <summary>
- Combines the flags of <paramref name="value"/> and <paramref name="otherFlags"/>. Equivalent to the bitwise "or" operation.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <param name="otherFlags">The other flags enum value.</param>
- <returns>Combination of <paramref name="value"/> with the flags in <paramref name="otherFlags"/>.</returns>
- </member>
- <member name="M:EnumsNET.FlagEnums.CombineFlags``1(``0,``0,``0)">
- <summary>
- Combines the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, and <paramref name="flag2"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="flag0">The first flags enum value.</param>
- <param name="flag1">The second flags enum value.</param>
- <param name="flag2">The third flags enum value.</param>
- <returns>Combination of the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, and <paramref name="flag2"/>.</returns>
- </member>
- <member name="M:EnumsNET.FlagEnums.CombineFlags``1(``0,``0,``0,``0)">
- <summary>
- Combines the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, <paramref name="flag2"/>, and <paramref name="flag3"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="flag0">The first flags enum value.</param>
- <param name="flag1">The second flags enum value.</param>
- <param name="flag2">The third flags enum value.</param>
- <param name="flag3">The fourth flags enum value.</param>
- <returns>Combination of the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, <paramref name="flag2"/>, and <paramref name="flag3"/>.</returns>
- </member>
- <member name="M:EnumsNET.FlagEnums.CombineFlags``1(``0,``0,``0,``0,``0)">
- <summary>
- Combines the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, <paramref name="flag2"/>, <paramref name="flag3"/>, and <paramref name="flag4"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="flag0">The first flags enum value.</param>
- <param name="flag1">The second flags enum value.</param>
- <param name="flag2">The third flags enum value.</param>
- <param name="flag3">The fourth flags enum value.</param>
- <param name="flag4">The fifth flags enum value.</param>
- <returns>Combination of the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, <paramref name="flag2"/>, <paramref name="flag3"/>, and <paramref name="flag4"/>.</returns>
- </member>
- <member name="M:EnumsNET.FlagEnums.CombineFlags``1(``0[])">
- <summary>
- Combines all of the flags of <paramref name="flags"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="flags">The flags enum values.</param>
- <returns>Combination of all of the flags of <paramref name="flags"/>.</returns>
- </member>
- <member name="M:EnumsNET.FlagEnums.CombineFlags``1(System.Collections.Generic.IEnumerable{``0})">
- <summary>
- Combines all of the flags of <paramref name="flags"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="flags">The flags enum values.</param>
- <returns>Combination of all of the flags of <paramref name="flags"/>.</returns>
- </member>
- <member name="M:EnumsNET.FlagEnums.RemoveFlags``1(``0,``0)">
- <summary>
- Returns <paramref name="value"/> without the flags specified in <paramref name="otherFlags"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <param name="otherFlags">The other flags enum value.</param>
- <returns><paramref name="value"/> without the flags specified in <paramref name="otherFlags"/>.</returns>
- </member>
- <member name="M:EnumsNET.FlagEnums.ParseFlags``1(System.String)">
- <summary>
- Converts the string representation of one or more member names or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum member names or values' string representation.</param>
- <returns>A <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member name or value of <typeparamref name="TEnum"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of <typeparamref name="TEnum"/>'s underlying type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.ParseFlags``1(System.String,System.Boolean)">
- <summary>
- Converts the string representation of one or more member names or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value.
- The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum member names or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member name or value of <typeparamref name="TEnum"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.ParseFlags``1(System.String,System.Boolean,System.String)">
- <summary>
- 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.
- The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum member names or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="delimiter">The delimiter used to separate individual flags.</param>
- <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member name or value of <typeparamref name="TEnum"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.ParseFlags``1(System.String,System.Boolean,System.String,EnumsNET.EnumFormat)">
- <summary>
- 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
- using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="delimiter">The delimiter used to separate individual flags.</param>
- <param name="format">The parsing enum format.</param>
- <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
- -or-
- <paramref name="format"/> is an invalid value.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.ParseFlags``1(System.String,System.Boolean,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- 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
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="delimiter">The delimiter used to separate individual flags.</param>
- <param name="format0">The first parsing enum format.</param>
- <param name="format1">The second parsing enum format.</param>
- <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
- -or-
- <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.ParseFlags``1(System.String,System.Boolean,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- 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
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="delimiter">The delimiter used to separate individual flags.</param>
- <param name="format0">The first parsing enum format.</param>
- <param name="format1">The second parsing enum format.</param>
- <param name="format2">The third parsing enum format.</param>
- <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
- -or-
- <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.ParseFlags``1(System.String,System.Boolean,System.String,EnumsNET.EnumFormat[])">
- <summary>
- 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
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="delimiter">The delimiter used to separate individual flags.</param>
- <param name="formats">The parsing enum formats.</param>
- <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
- -or-
- <paramref name="formats"/> contains an invalid value.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.TryParseFlags``1(System.String,``0@)">
- <summary>
- 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.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum member names or values' string representation.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- </member>
- <member name="M:EnumsNET.FlagEnums.TryParseFlags``1(System.String,System.Boolean,``0@)">
- <summary>
- 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.
- The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive. The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum member names or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- </member>
- <member name="M:EnumsNET.FlagEnums.TryParseFlags``1(System.String,System.Boolean,System.String,``0@)">
- <summary>
- 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.
- The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive. The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum member names or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="delimiter">The delimiter used to separate individual flags.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- </member>
- <member name="M:EnumsNET.FlagEnums.TryParseFlags``1(System.String,System.Boolean,System.String,``0@,EnumsNET.EnumFormat)">
- <summary>
- 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
- using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="delimiter">The delimiter used to separate individual flags.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
- <param name="format">The parsing enum format.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="format"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.TryParseFlags``1(System.String,System.Boolean,System.String,``0@,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- 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
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="delimiter">The delimiter used to separate individual flags.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
- <param name="format0">The first parsing enum format.</param>
- <param name="format1">The first parsing enum format.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.TryParseFlags``1(System.String,System.Boolean,System.String,``0@,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- 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
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="delimiter">The delimiter used to separate individual flags.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
- <param name="format0">The first parsing enum format.</param>
- <param name="format1">The second parsing enum format.</param>
- <param name="format2">The third parsing enum format.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.TryParseFlags``1(System.String,System.Boolean,System.String,``0@,EnumsNET.EnumFormat[])">
- <summary>
- 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
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="delimiter">The delimiter used to separate individual flags.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
- <param name="formats">The parsing enum formats.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="formats"/> contains an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.IsFlagEnumUnsafe``1">
- <summary>
- Indicates if <typeparamref name="TEnum"/> is marked with the <see cref="T:System.FlagsAttribute"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <returns>Indication if <typeparamref name="TEnum"/> is marked with the <see cref="T:System.FlagsAttribute"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.GetAllFlagsUnsafe``1">
- <summary>
- Retrieves all the flags defined by <typeparamref name="TEnum"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <returns>All the flags defined by <typeparamref name="TEnum"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.IsValidFlagCombinationUnsafe``1(``0)">
- <summary>
- Indicates whether <paramref name="value"/> is a valid flag combination of <typeparamref name="TEnum"/>'s defined flags.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <returns>Indication of whether <paramref name="value"/> is a valid flag combination of <typeparamref name="TEnum"/>'s defined flags.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.FormatFlagsUnsafe``1(``0)">
- <summary>
- 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".
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <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".
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.FormatFlagsUnsafe``1(``0,System.String)">
- <summary>
- 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".
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <param name="delimiter">The delimiter to use to separate individual flags.</param>
- <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".
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.FormatFlagsUnsafe``1(``0,System.String,EnumsNET.EnumFormat)">
- <summary>
- Retrieves <paramref name="value"/>'s flags formatted with <paramref name="format"/> and delimited with <paramref name="delimiter"/>
- or if empty returns the zero flag formatted with <paramref name="format"/>.
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <param name="delimiter">The delimiter to use to separate individual flags.</param>
- <param name="format">The output format to use.</param>
- <returns><paramref name="value"/>'s flags formatted with <paramref name="format"/> and delimited with <paramref name="delimiter"/>
- or if empty returns the zero flag formatted with <paramref name="format"/>.
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="format"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.FormatFlagsUnsafe``1(``0,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- Retrieves <paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
- or if empty returns the zero flag formatted with formats.
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <param name="delimiter">The delimiter to use to separate individual flags.</param>
- <param name="format0">The first output format to use.</param>
- <param name="format1">The second output format to use.</param>
- <returns><paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
- or if empty returns the zero flag formatted with formats.
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.FormatFlagsUnsafe``1(``0,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- Retrieves <paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
- or if empty returns the zero flag formatted with formats.
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <param name="delimiter">The delimiter to use to separate individual flags.</param>
- <param name="format0">The first output format to use.</param>
- <param name="format1">The second output format to use.</param>
- <param name="format2">The third output format to use.</param>
- <returns><paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
- or if empty returns the zero flag formatted with formats.
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.FormatFlagsUnsafe``1(``0,System.String,EnumsNET.EnumFormat[])">
- <summary>
- Retrieves <paramref name="value"/>'s flags formatted with <paramref name="formats"/> and delimited with <paramref name="delimiter"/>
- or if empty returns the zero flag formatted with <paramref name="formats"/>.
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <param name="delimiter">The delimiter to use to separate individual flags.</param>
- <param name="formats">The output formats to use.</param>
- <returns><paramref name="value"/>'s flags formatted with <paramref name="formats"/> and delimited with <paramref name="delimiter"/>
- or if empty returns the zero flag formatted with <paramref name="formats"/>.
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="formats"/> contains an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.GetFlagsUnsafe``1(``0)">
- <summary>
- Retrieves the flags that compose <paramref name="value"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <returns>The flags that compose <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.GetFlagMembersUnsafe``1(``0)">
- <summary>
- Retrieves the <see cref="T:EnumsNET.EnumMember`1"/>s of the flags that compose <paramref name="value"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <returns>The <see cref="T:EnumsNET.EnumMember`1"/>s of the flags that compose <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.GetFlagCountUnsafe``1">
- <summary>
- Retrieves the flag count of <typeparamref name="TEnum"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <returns>The flag count of <typeparamref name="TEnum"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.GetFlagCountUnsafe``1(``0)">
- <summary>
- Retrieves the flag count of <paramref name="value"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <returns>The flag count of <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.GetFlagCountUnsafe``1(``0,``0)">
- <summary>
- Retrieves the flag count of <paramref name="otherFlags"/> that <paramref name="value"/> has.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <param name="otherFlags">The other flags enum value.</param>
- <returns>The flag count of <paramref name="otherFlags"/> that <paramref name="value"/> has.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.HasAnyFlagsUnsafe``1(``0)">
- <summary>
- Indicates if <paramref name="value"/> has any flags.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <returns>Indication if <paramref name="value"/> has any flags.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.HasAnyFlagsUnsafe``1(``0,``0)">
- <summary>
- Indicates if <paramref name="value"/> has any flags that are in <paramref name="otherFlags"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <param name="otherFlags">The other flags enum value.</param>
- <returns>Indication if <paramref name="value"/> has any flags that are in <paramref name="otherFlags"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.HasAllFlagsUnsafe``1(``0)">
- <summary>
- Indicates if <paramref name="value"/> has all of the flags that are defined in <typeparamref name="TEnum"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <returns>Indication if <paramref name="value"/> has all of the flags that are defined in <typeparamref name="TEnum"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.HasAllFlagsUnsafe``1(``0,``0)">
- <summary>
- Indicates if <paramref name="value"/> has all of the flags that are in <paramref name="otherFlags"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <param name="otherFlags">The other flags enum value.</param>
- <returns>Indication if <paramref name="value"/> has all of the flags that are in <paramref name="otherFlags"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.ToggleFlagsUnsafe``1(``0)">
- <summary>
- 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"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <returns><paramref name="value"/> with all of it's flags toggled.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.ToggleFlagsUnsafe``1(``0,``0)">
- <summary>
- Returns <paramref name="value"/> while toggling the flags that are in <paramref name="otherFlags"/>. Equivalent to the bitwise "xor" operator.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <param name="otherFlags">The other flags enum value.</param>
- <returns><paramref name="value"/> while toggling the flags that are in <paramref name="otherFlags"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.CommonFlagsUnsafe``1(``0,``0)">
- <summary>
- Returns <paramref name="value"/> with only the flags that are also in <paramref name="otherFlags"/>. Equivalent to the bitwise "and" operation.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <param name="otherFlags">The other flags enum value.</param>
- <returns><paramref name="value"/> with only the flags that are also in <paramref name="otherFlags"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.CombineFlagsUnsafe``1(``0,``0)">
- <summary>
- Combines the flags of <paramref name="value"/> and <paramref name="otherFlags"/>. Equivalent to the bitwise "or" operation.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <param name="otherFlags">The other flags enum value.</param>
- <returns>Combination of <paramref name="value"/> with the flags in <paramref name="otherFlags"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.CombineFlagsUnsafe``1(``0,``0,``0)">
- <summary>
- Combines the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, and <paramref name="flag2"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="flag0">The first flags enum value.</param>
- <param name="flag1">The second flags enum value.</param>
- <param name="flag2">The third flags enum value.</param>
- <returns>Combination of the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, and <paramref name="flag2"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.CombineFlagsUnsafe``1(``0,``0,``0,``0)">
- <summary>
- Combines the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, <paramref name="flag2"/>, and <paramref name="flag3"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="flag0">The first flags enum value.</param>
- <param name="flag1">The second flags enum value.</param>
- <param name="flag2">The third flags enum value.</param>
- <param name="flag3">The fourth flags enum value.</param>
- <returns>Combination of the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, <paramref name="flag2"/>, and <paramref name="flag3"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.CombineFlagsUnsafe``1(``0,``0,``0,``0,``0)">
- <summary>
- Combines the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, <paramref name="flag2"/>, <paramref name="flag3"/>, and <paramref name="flag4"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="flag0">The first flags enum value.</param>
- <param name="flag1">The second flags enum value.</param>
- <param name="flag2">The third flags enum value.</param>
- <param name="flag3">The fourth flags enum value.</param>
- <param name="flag4">The fifth flags enum value.</param>
- <returns>Combination of the flags of <paramref name="flag0"/>, <paramref name="flag1"/>, <paramref name="flag2"/>, <paramref name="flag3"/>, and <paramref name="flag4"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.CombineFlagsUnsafe``1(``0[])">
- <summary>
- Combines all of the flags of <paramref name="flags"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="flags">The flags enum values.</param>
- <returns>Combination of all of the flags of <paramref name="flags"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.CombineFlagsUnsafe``1(System.Collections.Generic.IEnumerable{``0})">
- <summary>
- Combines all of the flags of <paramref name="flags"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="flags">The flags enum values.</param>
- <returns>Combination of all of the flags of <paramref name="flags"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.RemoveFlagsUnsafe``1(``0,``0)">
- <summary>
- Returns <paramref name="value"/> without the flags specified in <paramref name="otherFlags"/>.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The flags enum value.</param>
- <param name="otherFlags">The other flags enum value.</param>
- <returns><paramref name="value"/> without the flags specified in <paramref name="otherFlags"/>.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.ParseFlagsUnsafe``1(System.String)">
- <summary>
- Converts the string representation of one or more member names or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum member names or values' string representation.</param>
- <returns>A <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="value"/> doesn't represent a member name or value of <typeparamref name="TEnum"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of <typeparamref name="TEnum"/>'s underlying type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.ParseFlagsUnsafe``1(System.String,System.Boolean)">
- <summary>
- Converts the string representation of one or more member names or values of <typeparamref name="TEnum"/> to its respective <typeparamref name="TEnum"/> value.
- The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum member names or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="value"/> doesn't represent a member name or value of <typeparamref name="TEnum"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.ParseFlagsUnsafe``1(System.String,System.Boolean,System.String)">
- <summary>
- 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.
- The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum member names or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="delimiter">The delimiter used to separate individual flags.</param>
- <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="value"/> doesn't represent a member name or value of <typeparamref name="TEnum"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.ParseFlagsUnsafe``1(System.String,System.Boolean,System.String,EnumsNET.EnumFormat)">
- <summary>
- 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
- using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="delimiter">The delimiter used to separate individual flags.</param>
- <param name="format">The parsing enum format.</param>
- <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
- -or-
- <paramref name="format"/> is an invalid value.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.ParseFlagsUnsafe``1(System.String,System.Boolean,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- 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
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="delimiter">The delimiter used to separate individual flags.</param>
- <param name="format0">The first parsing enum format.</param>
- <param name="format1">The second parsing enum format.</param>
- <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
- -or-
- <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.ParseFlagsUnsafe``1(System.String,System.Boolean,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- 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
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="delimiter">The delimiter used to separate individual flags.</param>
- <param name="format0">The first parsing enum format.</param>
- <param name="format1">The second parsing enum format.</param>
- <param name="format2">The third parsing enum format.</param>
- <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
- -or-
- <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.ParseFlagsUnsafe``1(System.String,System.Boolean,System.String,EnumsNET.EnumFormat[])">
- <summary>
- 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
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="delimiter">The delimiter used to separate individual flags.</param>
- <param name="formats">The parsing enum formats.</param>
- <returns>The <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="value"/> doesn't represent a member or value of <typeparamref name="TEnum"/>
- -or-
- <paramref name="formats"/> contains an invalid value.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <typeparamref name="TEnum"/>.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.TryParseFlagsUnsafe``1(System.String,``0@)">
- <summary>
- 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.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum member names or values' string representation.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.TryParseFlagsUnsafe``1(System.String,System.Boolean,``0@)">
- <summary>
- 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.
- The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive. The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum member names or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.TryParseFlagsUnsafe``1(System.String,System.Boolean,System.String,``0@)">
- <summary>
- 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.
- The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive. The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum member names or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="delimiter">The delimiter used to separate individual flags.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.TryParseFlagsUnsafe``1(System.String,System.Boolean,System.String,``0@,EnumsNET.EnumFormat)">
- <summary>
- 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
- using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="delimiter">The delimiter used to separate individual flags.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
- <param name="format">The parsing enum format.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="format"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.TryParseFlagsUnsafe``1(System.String,System.Boolean,System.String,``0@,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- 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
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="delimiter">The delimiter used to separate individual flags.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
- <param name="format0">The first parsing enum format.</param>
- <param name="format1">The second parsing enum format.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.TryParseFlagsUnsafe``1(System.String,System.Boolean,System.String,``0@,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- 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
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="delimiter">The delimiter used to separate individual flags.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
- <param name="format0">The first parsing enum format.</param>
- <param name="format1">The second parsing enum format.</param>
- <param name="format2">The third parsing enum format.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.TryParseFlagsUnsafe``1(System.String,System.Boolean,System.String,``0@,EnumsNET.EnumFormat[])">
- <summary>
- 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
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- The return value indicates whether the conversion succeeded.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="delimiter">The delimiter used to separate individual flags.</param>
- <param name="result">If the conversion succeeds this contains a <typeparamref name="TEnum"/> value that is represented by <paramref name="value"/>.</param>
- <param name="formats">The parsing enum formats.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentException"><typeparamref name="TEnum"/> is not an enum type
- -or-
- <paramref name="formats"/> contains an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.IsFlagEnum(System.Type)">
- <summary>
- Indicates if <paramref name="enumType"/> is marked with the <see cref="T:System.FlagsAttribute"/>.
- </summary>
- <param name="enumType">The enum type.</param>
- <returns>Indication if <paramref name="enumType"/> is marked with the <see cref="T:System.FlagsAttribute"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.GetAllFlags(System.Type)">
- <summary>
- Retrieves all the flags defined by <paramref name="enumType"/>.
- </summary>
- <param name="enumType">The enum type.</param>
- <returns>All the flags defined by <paramref name="enumType"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.IsValidFlagCombination(System.Type,System.Object)">
- <summary>
- Indicates whether <paramref name="value"/> is a valid flag combination of <paramref name="enumType"/>'s defined flags.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The flags enum value.</param>
- <returns>Indication of whether <paramref name="value"/> is a valid flag combination of <paramref name="enumType"/>'s defined flags.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> is of an invalid type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.FormatFlags(System.Type,System.Object)">
- <summary>
- 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".
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The flags enum value.</param>
- <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".
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> is of an invalid type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.FormatFlags(System.Type,System.Object,System.String)">
- <summary>
- 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".
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The flags enum value.</param>
- <param name="delimiter">The delimiter to use to separate individual flags.</param>
- <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".
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> is of an invalid type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.FormatFlags(System.Type,System.Object,System.String,EnumsNET.EnumFormat)">
- <summary>
- Retrieves <paramref name="value"/>'s flags formatted with <paramref name="format"/> and delimited with <paramref name="delimiter"/>
- or if empty returns the zero flag formatted with <paramref name="format"/>.
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The flags enum value.</param>
- <param name="delimiter">The delimiter to use to separate individual flags.</param>
- <param name="format">The output format to use.</param>
- <returns><paramref name="value"/>'s flags formatted with <paramref name="format"/> and delimited with <paramref name="delimiter"/>
- or if empty returns the zero flag formatted with <paramref name="format"/>.
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> is of an invalid type
- -or-
- <paramref name="format"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.FormatFlags(System.Type,System.Object,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- Retrieves <paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
- or if empty returns the zero flag formatted with formats.
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The flags enum value.</param>
- <param name="delimiter">The delimiter to use to separate individual flags.</param>
- <param name="format0">The first output format to use.</param>
- <param name="format1">The second output format to use.</param>
- <returns><paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
- or if empty returns the zero flag formatted with formats.
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> is of an invalid type
- -or-
- <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.FormatFlags(System.Type,System.Object,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- Retrieves <paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
- or if empty returns the zero flag formatted with formats.
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The flags enum value.</param>
- <param name="delimiter">The delimiter to use to separate individual flags.</param>
- <param name="format0">The first output format to use.</param>
- <param name="format1">The second output format to use.</param>
- <param name="format2">The third output format to use.</param>
- <returns><paramref name="value"/>'s flags formatted with formats and delimited with <paramref name="delimiter"/>
- or if empty returns the zero flag formatted with formats.
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> is of an invalid type
- -or-
- <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.FormatFlags(System.Type,System.Object,System.String,EnumsNET.EnumFormat[])">
- <summary>
- Retrieves <paramref name="value"/>'s flags formatted with <paramref name="formats"/> and delimited with <paramref name="delimiter"/>
- or if empty returns the zero flag formatted with <paramref name="formats"/>.
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The flags enum value.</param>
- <param name="delimiter">The delimiter to use to separate individual flags.</param>
- <param name="formats">The output formats to use.</param>
- <returns><paramref name="value"/>'s flags formatted with <paramref name="formats"/> and delimited with <paramref name="delimiter"/>
- or if empty returns the zero flag formatted with <paramref name="formats"/>.
- If <paramref name="value"/> is not a valid flag combination <c>null</c> is returned.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> is of an invalid type
- -or-
- <paramref name="formats"/> contains an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.GetFlags(System.Type,System.Object)">
- <summary>
- Retrieves the flags that compose <paramref name="value"/>.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The flags enum value.</param>
- <returns>The flags that compose <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> is of an invalid type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.GetFlagMembers(System.Type,System.Object)">
- <summary>
- Retrieves the <see cref="T:EnumsNET.EnumMember"/>s of the flags that compose <paramref name="value"/>.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The flags enum value.</param>
- <returns>The <see cref="T:EnumsNET.EnumMember"/>s of the flags that compose <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> is of an invalid type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.GetFlagCount(System.Type)">
- <summary>
- Retrieves the flag count of <paramref name="enumType"/>.
- </summary>
- <param name="enumType">The enum type.</param>
- <returns>The flag count of <paramref name="enumType"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.GetFlagCount(System.Type,System.Object)">
- <summary>
- Retrieves the flag count of <paramref name="value"/>.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The flags enum value.</param>
- <returns>The flag count of <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> is of an invalid type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.GetFlagCount(System.Type,System.Object,System.Object)">
- <summary>
- Retrieves the flag count of <paramref name="otherFlags"/> that <paramref name="value"/> has.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The flags enum value.</param>
- <param name="otherFlags">The other flags enum value.</param>
- <returns>The flag count of <paramref name="otherFlags"/> that <paramref name="value"/> has.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/>, <paramref name="value"/>, or <paramref name="otherFlags"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> or <paramref name="otherFlags"/> is of an invalid type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.HasAnyFlags(System.Type,System.Object)">
- <summary>
- Indicates if <paramref name="value"/> has any flags.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The flags enum value.</param>
- <returns>Indication if <paramref name="value"/> has any flags.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> is of an invalid type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.HasAnyFlags(System.Type,System.Object,System.Object)">
- <summary>
- Indicates if <paramref name="value"/> has any flags that are in <paramref name="otherFlags"/>.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The flags enum value.</param>
- <param name="otherFlags">The other flags enum value.</param>
- <returns>Indication if <paramref name="value"/> has any flags that are in <paramref name="otherFlags"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/>, <paramref name="value"/>, or <paramref name="otherFlags"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> or <paramref name="otherFlags"/> is of an invalid type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.HasAllFlags(System.Type,System.Object)">
- <summary>
- Indicates if <paramref name="value"/> has all of the flags that are defined in <paramref name="enumType"/>.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The flags enum value.</param>
- <returns>Indication if <paramref name="value"/> has all of the flags that are defined in <paramref name="enumType"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> is of an invalid type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.HasAllFlags(System.Type,System.Object,System.Object)">
- <summary>
- Indicates if <paramref name="value"/> has all of the flags that are in <paramref name="otherFlags"/>.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The flags enum value.</param>
- <param name="otherFlags">The other flags enum value.</param>
- <returns>Indication if <paramref name="value"/> has all of the flags that are in <paramref name="otherFlags"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/>, <paramref name="value"/>, or <paramref name="otherFlags"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> or <paramref name="otherFlags"/> is of an invalid type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.ToggleFlags(System.Type,System.Object)">
- <summary>
- 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)"/>.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The flags enum value.</param>
- <returns><paramref name="value"/> with all of it's flags toggled.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> is of an invalid type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.ToggleFlags(System.Type,System.Object,System.Object)">
- <summary>
- Returns <paramref name="value"/> while toggling the flags that are in <paramref name="otherFlags"/>. Equivalent to the bitwise "xor" operator.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The flags enum value.</param>
- <param name="otherFlags">The other flags enum value.</param>
- <returns><paramref name="value"/> while toggling the flags that are in <paramref name="otherFlags"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/>, <paramref name="value"/>, or <paramref name="otherFlags"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> or <paramref name="otherFlags"/> is of an invalid type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.CommonFlags(System.Type,System.Object,System.Object)">
- <summary>
- Returns <paramref name="value"/> with only the flags that are also in <paramref name="otherFlags"/>. Equivalent to the bitwise "and" operation.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The flags enum value.</param>
- <param name="otherFlags">The other flags enum value.</param>
- <returns><paramref name="value"/> with only the flags that are also in <paramref name="otherFlags"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/>, <paramref name="value"/>, or <paramref name="otherFlags"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> or <paramref name="otherFlags"/> is of an invalid type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.CombineFlags(System.Type,System.Object,System.Object)">
- <summary>
- Combines the flags of <paramref name="value"/> and <paramref name="otherFlags"/>. Equivalent to the bitwise "or" operation.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The flags enum value.</param>
- <param name="otherFlags">The other flags enum value.</param>
- <returns>Combination of <paramref name="value"/> with the flags in <paramref name="otherFlags"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/>, <paramref name="value"/>, or <paramref name="otherFlags"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> or <paramref name="otherFlags"/> is of an invalid type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.CombineFlags(System.Type,System.Object[])">
- <summary>
- Combines all of the flags of <paramref name="flags"/>.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="flags">The flags enum values.</param>
- <returns>Combination of all of the flags of <paramref name="flags"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or one of the <paramref name="flags"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="flags"/> contains a value that is of an invalid type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.CombineFlags(System.Type,System.Collections.Generic.IEnumerable{System.Object})">
- <summary>
- Combines all of the flags of <paramref name="flags"/>.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="flags">The flags enum values.</param>
- <returns>Combination of all of the flags of <paramref name="flags"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or one of the <paramref name="flags"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="flags"/> contains a value that is of an invalid type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.RemoveFlags(System.Type,System.Object,System.Object)">
- <summary>
- Returns <paramref name="value"/> without the flags specified in <paramref name="otherFlags"/>.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The flags enum value.</param>
- <param name="otherFlags">The other flags enum value.</param>
- <returns><paramref name="value"/> without the flags specified in <paramref name="otherFlags"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/>, <paramref name="value"/>, or <paramref name="otherFlags"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> or <paramref name="otherFlags"/> is of an invalid type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.ParseFlags(System.Type,System.String)">
- <summary>
- 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"/>.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum member names or values' string representation.</param>
- <returns>A <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> doesn't represent a member name or value of <paramref name="enumType"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of <paramref name="enumType"/>'s underlying type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.ParseFlags(System.Type,System.String,System.Boolean)">
- <summary>
- 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"/>.
- The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum member names or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> doesn't represent a member name or value of <paramref name="enumType"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.ParseFlags(System.Type,System.String,System.Boolean,System.String)">
- <summary>
- 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"/>.
- The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum member names or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="delimiter">The delimiter used to separate individual flags.</param>
- <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> doesn't represent a member name or value of <paramref name="enumType"/>.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.ParseFlags(System.Type,System.String,System.Boolean,System.String,EnumsNET.EnumFormat)">
- <summary>
- 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"/>
- using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="delimiter">The delimiter used to separate individual flags.</param>
- <param name="format">The parsing enum format.</param>
- <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> doesn't represent a member or value of <paramref name="enumType"/>
- -or-
- <paramref name="format"/> is an invalid value.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.ParseFlags(System.Type,System.String,System.Boolean,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- 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"/>
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="delimiter">The delimiter used to separate individual flags.</param>
- <param name="format0">The first parsing enum format.</param>
- <param name="format1">The second parsing enum format.</param>
- <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> doesn't represent a member or value of <paramref name="enumType"/>
- -or-
- <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.ParseFlags(System.Type,System.String,System.Boolean,System.String,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- 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"/>
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="delimiter">The delimiter used to separate individual flags.</param>
- <param name="format0">The first parsing enum format.</param>
- <param name="format1">The second parsing enum format.</param>
- <param name="format2">The third parsing enum format.</param>
- <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> doesn't represent a member or value of <paramref name="enumType"/>
- -or-
- <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.ParseFlags(System.Type,System.String,System.Boolean,System.String,EnumsNET.EnumFormat[])">
- <summary>
- 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"/>
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies if the operation is case-insensitive.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="delimiter">The delimiter used to separate individual flags.</param>
- <param name="formats">The parsing enum formats.</param>
- <returns>The <paramref name="enumType"/> value that is represented by <paramref name="value"/>.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> or <paramref name="value"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="value"/> doesn't represent a member or value of <paramref name="enumType"/>
- -or-
- <paramref name="formats"/> contains an invalid value.</exception>
- <exception cref="T:System.OverflowException"><paramref name="value"/> is outside the range of the underlying type of <paramref name="enumType"/>.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.TryParseFlags(System.Type,System.String,System.Object@)">
- <summary>
- 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"/>.
- The return value indicates whether the conversion succeeded.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum member names or values' string representation.</param>
- <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> that is represented by <paramref name="value"/>.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.TryParseFlags(System.Type,System.String,System.Boolean,System.Object@)">
- <summary>
- 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"/>.
- The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive. The return value indicates whether the conversion succeeded.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum member names or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> that is represented by <paramref name="value"/>.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.TryParseFlags(System.Type,System.String,System.Boolean,System.String,System.Object@)">
- <summary>
- 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"/>.
- The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive. The return value indicates whether the conversion succeeded.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum member names or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="delimiter">The delimiter used to separate individual flags.</param>
- <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> that is represented by <paramref name="value"/>.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.TryParseFlags(System.Type,System.String,System.Boolean,System.String,System.Object@,EnumsNET.EnumFormat)">
- <summary>
- 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"/>
- using the specified parsing enum format. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- The return value indicates whether the conversion succeeded.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="delimiter">The delimiter used to separate individual flags.</param>
- <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> that is represented by <paramref name="value"/>.</param>
- <param name="format">The parsing enum format.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="format"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.TryParseFlags(System.Type,System.String,System.Boolean,System.String,System.Object@,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- 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"/>
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- The return value indicates whether the conversion succeeded.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="delimiter">The delimiter used to separate individual flags.</param>
- <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> that is represented by <paramref name="value"/>.</param>
- <param name="format0">The first parsing enum format.</param>
- <param name="format1">The second parsing enum format.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="format0"/> or <paramref name="format1"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.TryParseFlags(System.Type,System.String,System.Boolean,System.String,System.Object@,EnumsNET.EnumFormat,EnumsNET.EnumFormat,EnumsNET.EnumFormat)">
- <summary>
- 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"/>
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- The return value indicates whether the conversion succeeded.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="delimiter">The delimiter used to separate individual flags.</param>
- <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> that is represented by <paramref name="value"/>.</param>
- <param name="format0">The first parsing enum format.</param>
- <param name="format1">The second parsing enum format.</param>
- <param name="format2">The third parsing enum format.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="format0"/>, <paramref name="format1"/>, or <paramref name="format2"/> is an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.TryParseFlags(System.Type,System.String,System.Boolean,System.String,System.Object@,EnumsNET.EnumFormat[])">
- <summary>
- 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"/>
- using the specified parsing enum formats. The parameter <paramref name="ignoreCase"/> specifies whether the operation is case-insensitive.
- The return value indicates whether the conversion succeeded.
- </summary>
- <param name="enumType">The enum type.</param>
- <param name="value">The enum members or values' string representation.</param>
- <param name="ignoreCase">Indicates if the operation is case-insensitive.</param>
- <param name="delimiter">The delimiter used to separate individual flags.</param>
- <param name="result">If the conversion succeeds this contains a value of type <paramref name="enumType"/> that is represented by <paramref name="value"/>.</param>
- <param name="formats">The parsing enum formats.</param>
- <returns>Indication whether the conversion succeeded.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="enumType"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="enumType"/> is not an enum type
- -or-
- <paramref name="formats"/> contains an invalid value.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.IsValidFlagCombination(EnumsNET.EnumMember)">
- <summary>
- Indicates whether <paramref name="member"/>'s value is a valid flag combination of its enum's defined values.
- </summary>
- <param name="member">The enum member.</param>
- <returns>Indication of whether <paramref name="member"/>'s value is a valid flag combination of its enum's defined values.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="member"/> is <c>null</c>.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.GetFlags``1(EnumsNET.EnumMember{``0})">
- <summary>
- Retrieves the flags that compose <paramref name="member"/>'s value.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="member">The enum member.</param>
- <returns>The flags that compose <paramref name="member"/>'s value.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="member"/> is <c>null</c>.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.GetFlagMembers``1(EnumsNET.EnumMember{``0})">
- <summary>
- Retrieves the <see cref="T:EnumsNET.EnumMember`1"/>s of the flags that compose <paramref name="member"/>'s value.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- <param name="member">The enum member.</param>
- <returns>The <see cref="T:EnumsNET.EnumMember`1"/>s of the flags that compose <paramref name="member"/>'s value.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="member"/> is <c>null</c>.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.HasAnyFlags(EnumsNET.EnumMember)">
- <summary>
- Indicates if <paramref name="member"/>'s value has any flags.
- </summary>
- <param name="member">The enum member.</param>
- <returns>Indication if <paramref name="member"/>'s has any flags.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="member"/> is <c>null</c>.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.HasAllFlags(EnumsNET.EnumMember)">
- <summary>
- Indicates if <paramref name="member"/>'s value has all of the flags that are defined in its enum type.
- </summary>
- <param name="member">The enum member.</param>
- <returns>Indication if <paramref name="member"/> has all of the flags that are defined in its enum type.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="member"/> is <c>null</c>.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.GetFlagCount(EnumsNET.EnumMember)">
- <summary>
- Retrieves the flag count of <paramref name="member"/>.
- </summary>
- <param name="member">The flags enum value.</param>
- <returns>The flag count of <paramref name="member"/>.</returns>
- </member>
- <member name="M:EnumsNET.FlagEnums.GetFlags(EnumsNET.EnumMember)">
- <summary>
- Retrieves the flags that compose <paramref name="member"/>'s value.
- </summary>
- <param name="member">The enum member.</param>
- <returns>The flags that compose <paramref name="member"/>'s value.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="member"/> is <c>null</c>.</exception>
- </member>
- <member name="M:EnumsNET.FlagEnums.GetFlagMembers(EnumsNET.EnumMember)">
- <summary>
- Retrieves the <see cref="T:EnumsNET.EnumMember"/>s of the flags that compose <paramref name="member"/>'s value.
- </summary>
- <param name="member">The enum member.</param>
- <returns>The <see cref="T:EnumsNET.EnumMember"/>s of the flags that compose <paramref name="member"/>'s value.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="member"/> is <c>null</c>.</exception>
- </member>
- <member name="T:EnumsNET.IEnumValidatorAttribute`1">
- <summary>
- Interface to be implemented on an enum validator attribute class to allow custom validation logic.
- </summary>
- <typeparam name="TEnum">The enum type.</typeparam>
- </member>
- <member name="M:EnumsNET.IEnumValidatorAttribute`1.IsValid(`0)">
- <summary>
- Indicates if <paramref name="value"/> is valid.
- </summary>
- <param name="value">The enum value.</param>
- <returns>Indication if <paramref name="value"/> is valid.</returns>
- </member>
- <member name="T:EnumsNET.PrimaryEnumMemberAttribute">
- <summary>
- Indicates if the enum member should be the primary enum member when there are duplicate values.
- In the case of duplicate values, extension methods will use the enum member marked with this attribute.
- </summary>
- </member>
- <member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
- <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>
- </member>
- <member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
- <summary>Initializes the attribute with the specified return value condition.</summary>
- <param name="returnValue">
- The return value condition. If the method returns this value, the associated parameter will not be null.
- </param>
- </member>
- <member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
- <summary>Gets the return value condition.</summary>
- </member>
- <member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
- <summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
- </member>
- <member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
- <summary>Initializes the attribute with the associated parameter name.</summary>
- <param name="parameterName">
- The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
- </param>
- </member>
- <member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
- <summary>Gets the associated parameter name.</summary>
- </member>
- </members>
- </doc>
|