123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>Microsoft.AspNetCore.Mvc.Abstractions</name>
- </assembly>
- <members>
- <member name="M:Microsoft.Extensions.Internal.PropertyHelper.#ctor(System.Reflection.PropertyInfo)">
- <summary>
- Initializes a fast <see cref="T:Microsoft.Extensions.Internal.PropertyHelper"/>.
- This constructor does not cache the helper. For caching, use <see cref="M:Microsoft.Extensions.Internal.PropertyHelper.GetProperties(System.Type)"/>.
- </summary>
- </member>
- <member name="P:Microsoft.Extensions.Internal.PropertyHelper.Property">
- <summary>
- Gets the backing <see cref="T:System.Reflection.PropertyInfo"/>.
- </summary>
- </member>
- <member name="P:Microsoft.Extensions.Internal.PropertyHelper.Name">
- <summary>
- Gets (or sets in derived types) the property name.
- </summary>
- </member>
- <member name="P:Microsoft.Extensions.Internal.PropertyHelper.ValueGetter">
- <summary>
- Gets the property value getter.
- </summary>
- </member>
- <member name="P:Microsoft.Extensions.Internal.PropertyHelper.ValueSetter">
- <summary>
- Gets the property value setter.
- </summary>
- </member>
- <member name="M:Microsoft.Extensions.Internal.PropertyHelper.GetValue(System.Object)">
- <summary>
- Returns the property value for the specified <paramref name="instance"/>.
- </summary>
- <param name="instance">The object whose property value will be returned.</param>
- <returns>The property value.</returns>
- </member>
- <member name="M:Microsoft.Extensions.Internal.PropertyHelper.SetValue(System.Object,System.Object)">
- <summary>
- Sets the property value for the specified <paramref name="instance" />.
- </summary>
- <param name="instance">The object whose property value will be set.</param>
- <param name="value">The property value.</param>
- </member>
- <member name="M:Microsoft.Extensions.Internal.PropertyHelper.GetProperties(System.Reflection.TypeInfo)">
- <summary>
- Creates and caches fast property helpers that expose getters for every public get property on the
- underlying type.
- </summary>
- <param name="typeInfo">The type info to extract property accessors for.</param>
- <returns>A cached array of all public properties of the specified type.
- </returns>
- </member>
- <member name="M:Microsoft.Extensions.Internal.PropertyHelper.GetProperties(System.Type)">
- <summary>
- Creates and caches fast property helpers that expose getters for every public get property on the
- specified type.
- </summary>
- <param name="type">The type to extract property accessors for.</param>
- <returns>A cached array of all public properties of the specified type.
- </returns>
- </member>
- <member name="M:Microsoft.Extensions.Internal.PropertyHelper.GetVisibleProperties(System.Reflection.TypeInfo)">
- <summary>
- <para>
- Creates and caches fast property helpers that expose getters for every non-hidden get property
- on the specified type.
- </para>
- <para>
- <see cref="M:GetVisibleProperties"/> excludes properties defined on base types that have been
- hidden by definitions using the <c>new</c> keyword.
- </para>
- </summary>
- <param name="typeInfo">The type info to extract property accessors for.</param>
- <returns>
- A cached array of all public properties of the specified type.
- </returns>
- </member>
- <member name="M:Microsoft.Extensions.Internal.PropertyHelper.GetVisibleProperties(System.Type)">
- <summary>
- <para>
- Creates and caches fast property helpers that expose getters for every non-hidden get property
- on the specified type.
- </para>
- <para>
- <see cref="M:GetVisibleProperties"/> excludes properties defined on base types that have been
- hidden by definitions using the <c>new</c> keyword.
- </para>
- </summary>
- <param name="type">The type to extract property accessors for.</param>
- <returns>
- A cached array of all public properties of the specified type.
- </returns>
- </member>
- <member name="M:Microsoft.Extensions.Internal.PropertyHelper.MakeFastPropertyGetter(System.Reflection.PropertyInfo)">
- <summary>
- Creates a single fast property getter. The result is not cached.
- </summary>
- <param name="propertyInfo">propertyInfo to extract the getter for.</param>
- <returns>a fast getter.</returns>
- <remarks>
- This method is more memory efficient than a dynamically compiled lambda, and about the
- same speed.
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.Internal.PropertyHelper.MakeNullSafeFastPropertyGetter(System.Reflection.PropertyInfo)">
- <summary>
- Creates a single fast property getter which is safe for a null input object. The result is not cached.
- </summary>
- <param name="propertyInfo">propertyInfo to extract the getter for.</param>
- <returns>a fast getter.</returns>
- <remarks>
- This method is more memory efficient than a dynamically compiled lambda, and about the
- same speed.
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.Internal.PropertyHelper.MakeFastPropertySetter(System.Reflection.PropertyInfo)">
- <summary>
- Creates a single fast property setter for reference types. The result is not cached.
- </summary>
- <param name="propertyInfo">propertyInfo to extract the setter for.</param>
- <returns>a fast getter.</returns>
- <remarks>
- This method is more memory efficient than a dynamically compiled lambda, and about the
- same speed. This only works for reference types.
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.Internal.PropertyHelper.ObjectToDictionary(System.Object)">
- <summary>
- Given an object, adds each instance property with a public get method as a key and its
- associated value to a dictionary.
-
- If the object is already an <see cref="T:System.Collections.Generic.IDictionary`2"/> instance, then a copy
- is returned.
- </summary>
- <remarks>
- The implementation of PropertyHelper will cache the property accessors per-type. This is
- faster when the same type is used multiple times with ObjectToDictionary.
- </remarks>
- </member>
- <member name="T:Microsoft.Extensions.Internal.ClosedGenericMatcher">
- <summary>
- Helper related to generic interface definitions and implementing classes.
- </summary>
- </member>
- <member name="M:Microsoft.Extensions.Internal.ClosedGenericMatcher.ExtractGenericInterface(System.Type,System.Type)">
- <summary>
- Determine whether <paramref name="queryType"/> is or implements a closed generic <see cref="T:System.Type"/>
- created from <paramref name="interfaceType"/>.
- </summary>
- <param name="queryType">The <see cref="T:System.Type"/> of interest.</param>
- <param name="interfaceType">The open generic <see cref="T:System.Type"/> to match. Usually an interface.</param>
- <returns>
- The closed generic <see cref="T:System.Type"/> created from <paramref name="interfaceType"/> that
- <paramref name="queryType"/> is or implements. <c>null</c> if the two <see cref="T:System.Type"/>s have no such
- relationship.
- </returns>
- <remarks>
- This method will return <paramref name="queryType"/> if <paramref name="interfaceType"/> is
- <c>typeof(KeyValuePair{,})</c>, and <paramref name="queryType"/> is
- <c>typeof(KeyValuePair{string, object})</c>.
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor.Id">
- <summary>
- Gets an id which uniquely identifies the action.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor.RouteValues">
- <summary>
- Gets or sets the collection of route values that must be provided by routing
- for the action to be selected.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor.ActionConstraints">
- <summary>
- The set of constraints for this action. Must all be satisfied for the action to be selected.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor.Parameters">
- <summary>
- The set of parameters associated with this action.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor.BoundProperties">
- <summary>
- The set of properties which are model bound.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor.FilterDescriptors">
- <summary>
- The set of filters associated with this action.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor.DisplayName">
- <summary>
- A friendly name for this action.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor.Properties">
- <summary>
- Stores arbitrary metadata properties associated with the <see cref="T:Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor"/>.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptorExtensions">
- <summary>
- Extension methods for <see cref="T:Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor"/>.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptorExtensions.GetProperty``1(Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor)">
- <summary>
- Gets the value of a property from the <see cref="P:Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor.Properties"/> collection
- using the provided value of <typeparamref name="T"/> as the key.
- </summary>
- <typeparam name="T">The type of the property.</typeparam>
- <param name="actionDescriptor">The action descriptor.</param>
- <returns>The property or the default value of <typeparamref name="T"/>.</returns>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptorExtensions.SetProperty``1(Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor,``0)">
- <summary>
- Sets the value of an property in the <see cref="P:Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor.Properties"/> collection using
- the provided value of <typeparamref name="T"/> as the key.
- </summary>
- <typeparam name="T">The type of the property.</typeparam>
- <param name="actionDescriptor">The action descriptor.</param>
- <param name="value">The value of the property.</param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Abstractions.IActionDescriptorProvider.Order">
- <summary>
- Gets the order value for determining the order of execution of providers. Providers execute in
- ascending numeric value of the <see cref="P:Microsoft.AspNetCore.Mvc.Abstractions.IActionDescriptorProvider.Order"/> property.
- </summary>
- <remarks>
- <para>
- Providers are executed in an ordering determined by an ascending sort of the <see cref="P:Microsoft.AspNetCore.Mvc.Abstractions.IActionDescriptorProvider.Order"/> property.
- A provider with a lower numeric value of <see cref="P:Microsoft.AspNetCore.Mvc.Abstractions.IActionDescriptorProvider.Order"/> will have its
- <see cref="M:Microsoft.AspNetCore.Mvc.Abstractions.IActionDescriptorProvider.OnProvidersExecuting(Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptorProviderContext)"/> called before that of a provider with a higher numeric value of
- <see cref="P:Microsoft.AspNetCore.Mvc.Abstractions.IActionDescriptorProvider.Order"/>. The <see cref="M:Microsoft.AspNetCore.Mvc.Abstractions.IActionDescriptorProvider.OnProvidersExecuted(Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptorProviderContext)"/> method is called in the reverse ordering after
- all calls to <see cref="M:Microsoft.AspNetCore.Mvc.Abstractions.IActionDescriptorProvider.OnProvidersExecuting(Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptorProviderContext)"/>. A provider with a lower numeric value of
- <see cref="P:Microsoft.AspNetCore.Mvc.Abstractions.IActionDescriptorProvider.Order"/> will have its <see cref="M:Microsoft.AspNetCore.Mvc.Abstractions.IActionDescriptorProvider.OnProvidersExecuted(Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptorProviderContext)"/> method called after that of a provider
- with a higher numeric value of <see cref="P:Microsoft.AspNetCore.Mvc.Abstractions.IActionDescriptorProvider.Order"/>.
- </para>
- <para>
- If two providers have the same numeric value of <see cref="P:Microsoft.AspNetCore.Mvc.Abstractions.IActionDescriptorProvider.Order"/>, then their relative execution order
- is undefined.
- </para>
- </remarks>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Abstractions.IActionInvoker">
- <summary>
- Defines an interface for invoking an MVC action.
- </summary>
- <remarks>
- An <see cref="T:Microsoft.AspNetCore.Mvc.Abstractions.IActionInvoker"/> is created for each request the MVC handles by querying the set of
- <see cref="T:Microsoft.AspNetCore.Mvc.Abstractions.IActionInvokerProvider"/> instances. See <see cref="T:Microsoft.AspNetCore.Mvc.Abstractions.IActionInvokerProvider"/> for more information.
- </remarks>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Abstractions.IActionInvoker.InvokeAsync">
- <summary>
- Invokes an MVC action.
- </summary>
- <returns>A <see cref="T:System.Threading.Tasks.Task"/> which will complete when action processing has completed.</returns>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Abstractions.IActionInvokerProvider">
- <summary>
- Defines an interface for components that can create an <see cref="T:Microsoft.AspNetCore.Mvc.Abstractions.IActionInvoker"/> for the
- current request.
- </summary>
- <remarks>
- <para>
- <see cref="T:Microsoft.AspNetCore.Mvc.Abstractions.IActionInvokerProvider"/> instances form a pipeline that results in the creation of an
- <see cref="T:Microsoft.AspNetCore.Mvc.Abstractions.IActionInvoker"/>. The <see cref="T:Microsoft.AspNetCore.Mvc.Abstractions.IActionInvokerProvider"/> instances are ordered by
- an ascending sort of the <see cref="P:Microsoft.AspNetCore.Mvc.Abstractions.IActionInvokerProvider.Order"/>.
- </para>
- <para>
- To create an <see cref="T:Microsoft.AspNetCore.Mvc.Abstractions.IActionInvoker"/>, each provider has its <see cref="M:Microsoft.AspNetCore.Mvc.Abstractions.IActionInvokerProvider.OnProvidersExecuting(Microsoft.AspNetCore.Mvc.Abstractions.ActionInvokerProviderContext)"/> method
- called in sequence and given the same instance of <see cref="T:Microsoft.AspNetCore.Mvc.Abstractions.ActionInvokerProviderContext"/>. Then each
- provider has its <see cref="M:Microsoft.AspNetCore.Mvc.Abstractions.IActionInvokerProvider.OnProvidersExecuted(Microsoft.AspNetCore.Mvc.Abstractions.ActionInvokerProviderContext)"/> method called in the reverse order. The result is
- the value of <see cref="P:Microsoft.AspNetCore.Mvc.Abstractions.ActionInvokerProviderContext.Result"/>.
- </para>
- <para>
- As providers are called in a predefined sequence, each provider has a chance to observe and decorate the
- result of the providers that have already run.
- </para>
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Abstractions.IActionInvokerProvider.Order">
- <summary>
- Gets the order value for determining the order of execution of providers. Providers execute in
- ascending numeric value of the <see cref="P:Microsoft.AspNetCore.Mvc.Abstractions.IActionInvokerProvider.Order"/> property.
- </summary>
- <remarks>
- <para>
- Providers are executed in an ordering determined by an ascending sort of the <see cref="P:Microsoft.AspNetCore.Mvc.Abstractions.IActionInvokerProvider.Order"/> property.
- A provider with a lower numeric value of <see cref="P:Microsoft.AspNetCore.Mvc.Abstractions.IActionInvokerProvider.Order"/> will have its
- <see cref="M:Microsoft.AspNetCore.Mvc.Abstractions.IActionInvokerProvider.OnProvidersExecuting(Microsoft.AspNetCore.Mvc.Abstractions.ActionInvokerProviderContext)"/> called before that of a provider with a higher numeric value of
- <see cref="P:Microsoft.AspNetCore.Mvc.Abstractions.IActionInvokerProvider.Order"/>. The <see cref="M:Microsoft.AspNetCore.Mvc.Abstractions.IActionInvokerProvider.OnProvidersExecuted(Microsoft.AspNetCore.Mvc.Abstractions.ActionInvokerProviderContext)"/> method is called in the reverse ordering after
- all calls to <see cref="M:Microsoft.AspNetCore.Mvc.Abstractions.IActionInvokerProvider.OnProvidersExecuting(Microsoft.AspNetCore.Mvc.Abstractions.ActionInvokerProviderContext)"/>. A provider with a lower numeric value of
- <see cref="P:Microsoft.AspNetCore.Mvc.Abstractions.IActionInvokerProvider.Order"/> will have its <see cref="M:Microsoft.AspNetCore.Mvc.Abstractions.IActionInvokerProvider.OnProvidersExecuted(Microsoft.AspNetCore.Mvc.Abstractions.ActionInvokerProviderContext)"/> method called after that of a provider
- with a higher numeric value of <see cref="P:Microsoft.AspNetCore.Mvc.Abstractions.IActionInvokerProvider.Order"/>.
- </para>
- <para>
- If two providers have the same numeric value of <see cref="P:Microsoft.AspNetCore.Mvc.Abstractions.IActionInvokerProvider.Order"/>, then their relative execution order
- is undefined.
- </para>
- </remarks>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Abstractions.IActionInvokerProvider.OnProvidersExecuting(Microsoft.AspNetCore.Mvc.Abstractions.ActionInvokerProviderContext)">
- <summary>
- Called to execute the provider.
- </summary>
- <param name="context">The <see cref="T:Microsoft.AspNetCore.Mvc.Abstractions.ActionInvokerProviderContext"/>.</param>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Abstractions.IActionInvokerProvider.OnProvidersExecuted(Microsoft.AspNetCore.Mvc.Abstractions.ActionInvokerProviderContext)">
- <summary>
- Called to execute the provider, after the <see cref="M:Microsoft.AspNetCore.Mvc.Abstractions.IActionInvokerProvider.OnProvidersExecuting(Microsoft.AspNetCore.Mvc.Abstractions.ActionInvokerProviderContext)"/> methods of all providers,
- have been called.
- </summary>
- <param name="context">The <see cref="T:Microsoft.AspNetCore.Mvc.Abstractions.ActionInvokerProviderContext"/>.</param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Abstractions.Resources.ArgumentCannotBeNullOrEmpty">
- <summary>
- Value cannot be null or empty.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Abstractions.Resources.FormatArgumentCannotBeNullOrEmpty">
- <summary>
- Value cannot be null or empty.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Abstractions.Resources.ModelBindingContext_ModelMetadataMustBeSet">
- <summary>
- The ModelMetadata property must be set before accessing this property.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Abstractions.Resources.FormatModelBindingContext_ModelMetadataMustBeSet">
- <summary>
- The ModelMetadata property must be set before accessing this property.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Abstractions.Resources.Validation_InvalidFieldCannotBeReset">
- <summary>
- A field previously marked invalid should not be marked valid.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Abstractions.Resources.FormatValidation_InvalidFieldCannotBeReset">
- <summary>
- A field previously marked invalid should not be marked valid.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Abstractions.Resources.Validation_InvalidFieldCannotBeReset_ToSkipped">
- <summary>
- A field previously marked invalid should not be marked skipped.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Abstractions.Resources.FormatValidation_InvalidFieldCannotBeReset_ToSkipped">
- <summary>
- A field previously marked invalid should not be marked skipped.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Abstractions.Resources.ModelStateDictionary_MaxModelStateErrors">
- <summary>
- The maximum number of allowed model errors has been reached.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Abstractions.Resources.FormatModelStateDictionary_MaxModelStateErrors">
- <summary>
- The maximum number of allowed model errors has been reached.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Abstractions.Resources.BindingSource_Body">
- <summary>
- Body
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Abstractions.Resources.FormatBindingSource_Body">
- <summary>
- Body
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Abstractions.Resources.BindingSource_Custom">
- <summary>
- Custom
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Abstractions.Resources.FormatBindingSource_Custom">
- <summary>
- Custom
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Abstractions.Resources.BindingSource_Form">
- <summary>
- Form
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Abstractions.Resources.FormatBindingSource_Form">
- <summary>
- Form
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Abstractions.Resources.BindingSource_Header">
- <summary>
- Header
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Abstractions.Resources.FormatBindingSource_Header">
- <summary>
- Header
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Abstractions.Resources.BindingSource_Services">
- <summary>
- Services
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Abstractions.Resources.FormatBindingSource_Services">
- <summary>
- Services
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Abstractions.Resources.BindingSource_ModelBinding">
- <summary>
- ModelBinding
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Abstractions.Resources.FormatBindingSource_ModelBinding">
- <summary>
- ModelBinding
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Abstractions.Resources.BindingSource_Path">
- <summary>
- Path
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Abstractions.Resources.FormatBindingSource_Path">
- <summary>
- Path
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Abstractions.Resources.BindingSource_Query">
- <summary>
- Query
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Abstractions.Resources.FormatBindingSource_Query">
- <summary>
- Query
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Abstractions.Resources.BindingSource_CannotBeComposite">
- <summary>
- The provided binding source '{0}' is a composite. '{1}' requires that the source must represent a single type of input.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Abstractions.Resources.FormatBindingSource_CannotBeComposite(System.Object,System.Object)">
- <summary>
- The provided binding source '{0}' is a composite. '{1}' requires that the source must represent a single type of input.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Abstractions.Resources.BindingSource_MustBeFromRequest">
- <summary>
- The provided binding source '{0}' is not a request-based binding source. '{1}' requires that the source must represent data from an HTTP request.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Abstractions.Resources.FormatBindingSource_MustBeFromRequest(System.Object,System.Object)">
- <summary>
- The provided binding source '{0}' is not a request-based binding source. '{1}' requires that the source must represent data from an HTTP request.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Abstractions.Resources.BindingSource_CannotBeGreedy">
- <summary>
- The provided binding source '{0}' is a greedy data source. '{1}' does not support greedy data sources.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Abstractions.Resources.FormatBindingSource_CannotBeGreedy(System.Object,System.Object)">
- <summary>
- The provided binding source '{0}' is a greedy data source. '{1}' does not support greedy data sources.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Abstractions.Resources.BindingSource_MustBeGreedy">
- <summary>
- The provided binding source '{0}' is not a greedy data source. '{1}' only supports greedy data sources.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Abstractions.Resources.FormatBindingSource_MustBeGreedy(System.Object,System.Object)">
- <summary>
- The provided binding source '{0}' is not a greedy data source. '{1}' only supports greedy data sources.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Abstractions.Resources.BindingSource_Special">
- <summary>
- Special
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Abstractions.Resources.FormatBindingSource_Special">
- <summary>
- Special
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Abstractions.Resources.BindingSource_FormFile">
- <summary>
- FormFile
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Abstractions.Resources.FormatBindingSource_FormFile">
- <summary>
- FormFile
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ActionConstraints.ActionConstraintContext">
- <summary>
- Context for <see cref="T:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraint"/> execution.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ActionConstraints.ActionConstraintContext.Candidates">
- <summary>
- The list of <see cref="T:Microsoft.AspNetCore.Mvc.ActionConstraints.ActionSelectorCandidate"/>. This includes all actions that are valid for the current
- request, as well as their constraints.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ActionConstraints.ActionConstraintContext.CurrentCandidate">
- <summary>
- The current <see cref="T:Microsoft.AspNetCore.Mvc.ActionConstraints.ActionSelectorCandidate"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ActionConstraints.ActionConstraintContext.RouteContext">
- <summary>
- The <see cref="P:Microsoft.AspNetCore.Mvc.ActionConstraints.ActionConstraintContext.RouteContext"/>.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ActionConstraints.ActionConstraintItem">
- <summary>
- Represents an <see cref="T:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraintMetadata"/> with or without a corresponding
- <see cref="T:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraint"/>.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ActionConstraints.ActionConstraintItem.#ctor(Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraintMetadata)">
- <summary>
- Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.ActionConstraints.ActionConstraintItem"/>.
- </summary>
- <param name="metadata">The <see cref="T:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraintMetadata"/> instance.</param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ActionConstraints.ActionConstraintItem.Constraint">
- <summary>
- The <see cref="T:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraint"/> associated with <see cref="P:Microsoft.AspNetCore.Mvc.ActionConstraints.ActionConstraintItem.Metadata"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ActionConstraints.ActionConstraintItem.Metadata">
- <summary>
- The <see cref="T:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraintMetadata"/> instance.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ActionConstraints.ActionConstraintItem.IsReusable">
- <summary>
- Gets or sets a value indicating whether or not <see cref="P:Microsoft.AspNetCore.Mvc.ActionConstraints.ActionConstraintItem.Constraint"/> can be reused across requests.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ActionConstraints.ActionConstraintProviderContext">
- <summary>
- Context for an action constraint provider.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ActionConstraints.ActionConstraintProviderContext.#ctor(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor,System.Collections.Generic.IList{Microsoft.AspNetCore.Mvc.ActionConstraints.ActionConstraintItem})">
- <summary>
- Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.ActionConstraints.ActionConstraintProviderContext"/>.
- </summary>
- <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> associated with the request.</param>
- <param name="action">The <see cref="T:Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor"/> for which constraints are being created.</param>
- <param name="items">The list of <see cref="T:Microsoft.AspNetCore.Mvc.ActionConstraints.ActionConstraintItem"/> objects.</param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ActionConstraints.ActionConstraintProviderContext.HttpContext">
- <summary>
- The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> associated with the request.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ActionConstraints.ActionConstraintProviderContext.Action">
- <summary>
- The <see cref="T:Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor"/> for which constraints are being created.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ActionConstraints.ActionConstraintProviderContext.Results">
- <summary>
- The list of <see cref="T:Microsoft.AspNetCore.Mvc.ActionConstraints.ActionConstraintItem"/> objects.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ActionConstraints.ActionSelectorCandidate">
- <summary>
- A candidate action for action selection.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ActionConstraints.ActionSelectorCandidate.#ctor(Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor,System.Collections.Generic.IReadOnlyList{Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraint})">
- <summary>
- Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.ActionConstraints.ActionSelectorCandidate"/>.
- </summary>
- <param name="action">The <see cref="T:Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor"/> representing a candidate for selection.</param>
- <param name="constraints">
- The list of <see cref="T:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraint"/> instances associated with <paramref name="action"/>.
- </param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ActionConstraints.ActionSelectorCandidate.Action">
- <summary>
- The <see cref="T:Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor"/> representing a candidate for selection.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ActionConstraints.ActionSelectorCandidate.Constraints">
- <summary>
- The list of <see cref="T:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraint"/> instances associated with <see name="Action"/>.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraint">
- <summary>
- Supports conditional logic to determine whether or not an associated action is valid to be selected
- for the given request.
- </summary>
- <remarks>
- Action constraints have the secondary effect of making an action with a constraint applied a better
- match than one without.
-
- Consider two actions, 'A' and 'B' with the same action and controller name. Action 'A' only allows the
- HTTP POST method (via a constraint) and action 'B' has no constraints.
-
- If an incoming request is a POST, then 'A' is considered the best match because it both matches and
- has a constraint. If an incoming request uses any other verb, 'A' will not be valid for selection
- due to it's constraint, so 'B' is the best match.
-
-
- Action constraints are also grouped according to their order value. Any constraints with the same
- group value are considered to be part of the same application policy, and will be executed in the
- same stage.
-
- Stages run in ascending order based on the value of <see cref="P:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraint.Order"/>. Given a set of actions which
- are candidates for selection, the next stage to run is the lowest value of <see cref="P:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraint.Order"/> for any
- constraint of any candidate which is greater than the order of the last stage.
-
- Once the stage order is identified, each action has all of its constraints in that stage executed.
- If any constraint does not match, then that action is not a candidate for selection. If any actions
- with constraints in the current state are still candidates, then those are the 'best' actions and this
- process will repeat with the next stage on the set of 'best' actions. If after processing the
- subsequent stages of the 'best' actions no candidates remain, this process will repeat on the set of
- 'other' candidate actions from this stage (those without a constraint).
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraint.Order">
- <summary>
- The constraint order.
- </summary>
- <remarks>
- Constraints are grouped into stages by the value of <see cref="P:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraint.Order"/>. See remarks on
- <see cref="T:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraint"/>.
- </remarks>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraint.Accept(Microsoft.AspNetCore.Mvc.ActionConstraints.ActionConstraintContext)">
- <summary>
- Determines whether an action is a valid candidate for selection.
- </summary>
- <param name="context">The <see cref="T:Microsoft.AspNetCore.Mvc.ActionConstraints.ActionConstraintContext"/>.</param>
- <returns>True if the action is valid for selection, otherwise false.</returns>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraintFactory">
- <summary>
- A factory for <see cref="T:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraint"/>.
- </summary>
- <remarks>
- <see cref="T:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraintFactory"/> will be invoked during action selection
- to create constraint instances for an action.
-
- Place an attribute implementing this interface on a controller or action to insert an action
- constraint created by a factory.
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraintFactory.IsReusable">
- <summary>
- Gets a value that indicates if the result of <see cref="M:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraintFactory.CreateInstance(System.IServiceProvider)"/>
- can be reused across requests.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraintFactory.CreateInstance(System.IServiceProvider)">
- <summary>
- Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraint"/>.
- </summary>
- <param name="services">The per-request services.</param>
- <returns>An <see cref="T:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraint"/>.</returns>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraintMetadata">
- <summary>
- A marker interface that identifies a type as metadata for an <see cref="T:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraint"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraintProvider.Order">
- <summary>
- Gets the order value for determining the order of execution of providers. Providers execute in
- ascending numeric value of the <see cref="P:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraintProvider.Order"/> property.
- </summary>
- <remarks>
- <para>
- Providers are executed in an ordering determined by an ascending sort of the <see cref="P:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraintProvider.Order"/> property.
- A provider with a lower numeric value of <see cref="P:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraintProvider.Order"/> will have its
- <see cref="M:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraintProvider.OnProvidersExecuting(Microsoft.AspNetCore.Mvc.ActionConstraints.ActionConstraintProviderContext)"/> called before that of a provider with a higher numeric value of
- <see cref="P:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraintProvider.Order"/>. The <see cref="M:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraintProvider.OnProvidersExecuted(Microsoft.AspNetCore.Mvc.ActionConstraints.ActionConstraintProviderContext)"/> method is called in the reverse ordering after
- all calls to <see cref="M:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraintProvider.OnProvidersExecuting(Microsoft.AspNetCore.Mvc.ActionConstraints.ActionConstraintProviderContext)"/>. A provider with a lower numeric value of
- <see cref="P:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraintProvider.Order"/> will have its <see cref="M:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraintProvider.OnProvidersExecuted(Microsoft.AspNetCore.Mvc.ActionConstraints.ActionConstraintProviderContext)"/> method called after that of a provider
- with a higher numeric value of <see cref="P:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraintProvider.Order"/>.
- </para>
- <para>
- If two providers have the same numeric value of <see cref="P:Microsoft.AspNetCore.Mvc.ActionConstraints.IActionConstraintProvider.Order"/>, then their relative execution order
- is undefined.
- </para>
- </remarks>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ActionContext">
- <summary>
- Context object for execution of action which has been selected as part of an HTTP request.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ActionContext.#ctor">
- <summary>
- Creates an empty <see cref="T:Microsoft.AspNetCore.Mvc.ActionContext"/>.
- </summary>
- <remarks>
- The default constructor is provided for unit test purposes only.
- </remarks>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ActionContext.#ctor(Microsoft.AspNetCore.Mvc.ActionContext)">
- <summary>
- Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.ActionContext"/>.
- </summary>
- <param name="actionContext">The <see cref="T:Microsoft.AspNetCore.Mvc.ActionContext"/> to copy.</param>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ActionContext.#ctor(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Routing.RouteData,Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor)">
- <summary>
- Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.ActionContext"/>.
- </summary>
- <param name="httpContext">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> for the current request.</param>
- <param name="routeData">The <see cref="T:Microsoft.AspNetCore.Routing.RouteData"/> for the current request.</param>
- <param name="actionDescriptor">The <see cref="T:Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor"/> for the selected action.</param>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ActionContext.#ctor(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Routing.RouteData,Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor,Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary)">
- <summary>
- Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.ActionContext"/>.
- </summary>
- <param name="httpContext">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> for the current request.</param>
- <param name="routeData">The <see cref="T:Microsoft.AspNetCore.Routing.RouteData"/> for the current request.</param>
- <param name="actionDescriptor">The <see cref="T:Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor"/> for the selected action.</param>
- <param name="modelState">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/>.</param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ActionContext.ActionDescriptor">
- <summary>
- Gets or sets the <see cref="T:Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor"/> for the selected action.
- </summary>
- <remarks>
- The property setter is provided for unit test purposes only.
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ActionContext.HttpContext">
- <summary>
- Gets or sets the <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> for the current request.
- </summary>
- <remarks>
- The property setter is provided for unit test purposes only.
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ActionContext.ModelState">
- <summary>
- Gets the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ActionContext.RouteData">
- <summary>
- Gets or sets the <see cref="T:Microsoft.AspNetCore.Routing.RouteData"/> for the current request.
- </summary>
- <remarks>
- The property setter is provided for unit test purposes only.
- </remarks>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription">
- <summary>
- Represents an API exposed by this application.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription.ActionDescriptor">
- <summary>
- Gets or sets <see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription.ActionDescriptor"/> for this api.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription.GroupName">
- <summary>
- Gets or sets group name for this api.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription.HttpMethod">
- <summary>
- Gets or sets the supported HTTP method for this api, or null if all HTTP methods are supported.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription.ParameterDescriptions">
- <summary>
- Gets a list of <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterDescription"/> for this api.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription.Properties">
- <summary>
- Gets arbitrary metadata properties associated with the <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription.RelativePath">
- <summary>
- Gets or sets relative url path template (relative to application root) for this api.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription.SupportedRequestFormats">
- <summary>
- Gets the list of possible formats for a request.
- </summary>
- <remarks>
- Will be empty if the action does not accept a parameter decorated with the <c>[FromBody]</c> attribute.
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription.SupportedResponseTypes">
- <summary>
- Gets the list of possible formats for a response.
- </summary>
- <remarks>
- Will be empty if the action returns no response, or if the response type is unclear. Use
- <c>ProducesAttribute</c> on an action method to specify a response type.
- </remarks>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext">
- <summary>
- A context object for <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription"/> providers.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext.#ctor(System.Collections.Generic.IReadOnlyList{Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor})">
- <summary>
- Creates a new instance of <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext"/>.
- </summary>
- <param name="actions">The list of actions.</param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext.Actions">
- <summary>
- The list of actions.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext.Results">
- <summary>
- The list of resulting <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription"/>.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterDescription">
- <summary>
- A metadata description of an input to an API.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterDescription.ModelMetadata">
- <summary>
- Gets or sets the <see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterDescription.ModelMetadata"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterDescription.Name">
- <summary>
- Gets or sets the name.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterDescription.RouteInfo">
- <summary>
- Gets or sets the <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterRouteInfo"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterDescription.Source">
- <summary>
- Gets or sets the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterDescription.Type">
- <summary>
- Gets or sets the parameter type.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterDescription.ParameterDescriptor">
- <summary>
- Gets or sets the parameter descriptor.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterRouteInfo">
- <summary>
- A metadata description of routing information for an <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterDescription"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterRouteInfo.Constraints">
- <summary>
- Gets or sets the set of <see cref="T:Microsoft.AspNetCore.Routing.IRouteConstraint"/> objects for the parameter.
- </summary>
- <remarks>
- Route constraints are only applied when a value is bound from a URL's path. See
- <see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterDescription.Source"/> for the data source considered.
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterRouteInfo.DefaultValue">
- <summary>
- Gets or sets the default value for the parameter.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterRouteInfo.IsOptional">
- <summary>
- Gets a value indicating whether not a parameter is considered optional by routing.
- </summary>
- <remarks>
- An optional parameter is considered optional by the routing system. This does not imply
- that the parameter is considered optional by the action.
-
- If the parameter uses <see cref="F:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource.ModelBinding"/> for the value of
- <see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterDescription.Source"/> then the value may also come from the
- URL query string or form data.
- </remarks>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiRequestFormat">
- <summary>
- A possible format for the body of a request.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiRequestFormat.Formatter">
- <summary>
- The formatter used to read this request.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiRequestFormat.MediaType">
- <summary>
- The media type of the request.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseFormat">
- <summary>
- Possible format for an <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseType"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseFormat.Formatter">
- <summary>
- Gets or sets the formatter used to output this response.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseFormat.MediaType">
- <summary>
- Gets or sets the media type of the response.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseType">
- <summary>
- Possible type of the response body which is formatted by <see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseType.ApiResponseFormats"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseType.ApiResponseFormats">
- <summary>
- Gets or sets the response formats supported by this type.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseType.ModelMetadata">
- <summary>
- Gets or sets <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> for the <see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseType.Type"/> or null.
- </summary>
- <remarks>
- Will be null if <see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseType.Type"/> is null or void.
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseType.Type">
- <summary>
- Gets or sets the CLR data type of the response or null.
- </summary>
- <remarks>
- Will be null if the action returns no response, or if the response type is unclear. Use
- <c>Microsoft.AspNetCore.Mvc.ProducesAttribute</c> or <c>Microsoft.AspNetCore.Mvc.ProducesResponseTypeAttribute</c> on an action method
- to specify a response type.
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseType.StatusCode">
- <summary>
- Gets or sets the HTTP response status code.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseType.IsDefaultResponse">
- <summary>
- Gets or sets a value indicating whether the response type represents a default response.
- </summary>
- <remarks>
- If an <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription"/> has a default response, then the <see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiResponseType.StatusCode"/> property should be ignored. This response
- will be used when a more specific response format does not apply. The common use of a default response is to specify the format
- for communicating error conditions.
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.Order">
- <summary>
- Gets the order value for determining the order of execution of providers. Providers execute in
- ascending numeric value of the <see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.Order"/> property.
- </summary>
- <remarks>
- <para>
- Providers are executed in an ordering determined by an ascending sort of the <see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.Order"/> property.
- A provider with a lower numeric value of <see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.Order"/> will have its
- <see cref="M:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.OnProvidersExecuting(Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext)"/> called before that of a provider with a higher numeric value of
- <see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.Order"/>. The <see cref="M:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.OnProvidersExecuted(Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext)"/> method is called in the reverse ordering after
- all calls to <see cref="M:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.OnProvidersExecuting(Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext)"/>. A provider with a lower numeric value of
- <see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.Order"/> will have its <see cref="M:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.OnProvidersExecuted(Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext)"/> method called after that of a provider
- with a higher numeric value of <see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.Order"/>.
- </para>
- <para>
- If two providers have the same numeric value of <see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.Order"/>, then their relative execution order
- is undefined.
- </para>
- </remarks>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.OnProvidersExecuting(Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext)">
- <summary>
- Creates or modifies <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription"/>s.
- </summary>
- <param name="context">The <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext"/>.</param>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.OnProvidersExecuted(Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext)">
- <summary>
- Called after <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider"/> implementations with higher <see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider.Order"/> values have been called.
- </summary>
- <param name="context">The <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext"/>.</param>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Authorization.IAllowAnonymousFilter">
- <summary>
- A filter that allows anonymous requests, disabling some <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IAuthorizationFilter"/>s.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Filters.ActionExecutedContext">
- <summary>
- A context for action filters, specifically <see cref="M:Microsoft.AspNetCore.Mvc.Filters.IActionFilter.OnActionExecuted(Microsoft.AspNetCore.Mvc.Filters.ActionExecutedContext)"/> calls.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Filters.ActionExecutedContext.#ctor(Microsoft.AspNetCore.Mvc.ActionContext,System.Collections.Generic.IList{Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata},System.Object)">
- <summary>
- Instantiates a new <see cref="T:Microsoft.AspNetCore.Mvc.Filters.ActionExecutingContext"/> instance.
- </summary>
- <param name="actionContext">The <see cref="T:Microsoft.AspNetCore.Mvc.ActionContext"/>.</param>
- <param name="filters">All applicable <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata"/> implementations.</param>
- <param name="controller">The controller instance containing the action.</param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.ActionExecutedContext.Canceled">
- <summary>
- Gets or sets an indication that an action filter short-circuited the action and the action filter pipeline.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.ActionExecutedContext.Controller">
- <summary>
- Gets the controller instance containing the action.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.ActionExecutedContext.Exception">
- <summary>
- Gets or sets the <see cref="T:System.Exception"/> caught while executing the action or action filters, if
- any.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.ActionExecutedContext.ExceptionDispatchInfo">
- <summary>
- Gets or sets the <see cref="T:System.Runtime.ExceptionServices.ExceptionDispatchInfo"/> for the
- <see cref="P:Microsoft.AspNetCore.Mvc.Filters.ActionExecutedContext.Exception"/>, if an <see cref="T:System.Exception"/> was caught and this information captured.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.ActionExecutedContext.ExceptionHandled">
- <summary>
- Gets or sets an indication that the <see cref="P:Microsoft.AspNetCore.Mvc.Filters.ActionExecutedContext.Exception"/> has been handled.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.ActionExecutedContext.Result">
- <summary>
- Gets or sets the <see cref="T:Microsoft.AspNetCore.Mvc.IActionResult"/>.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Filters.ActionExecutingContext">
- <summary>
- A context for action filters, specifically <see cref="M:Microsoft.AspNetCore.Mvc.Filters.IActionFilter.OnActionExecuted(Microsoft.AspNetCore.Mvc.Filters.ActionExecutedContext)"/> and
- <see cref="M:Microsoft.AspNetCore.Mvc.Filters.IAsyncActionFilter.OnActionExecutionAsync(Microsoft.AspNetCore.Mvc.Filters.ActionExecutingContext,Microsoft.AspNetCore.Mvc.Filters.ActionExecutionDelegate)"/> calls.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Filters.ActionExecutingContext.#ctor(Microsoft.AspNetCore.Mvc.ActionContext,System.Collections.Generic.IList{Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata},System.Collections.Generic.IDictionary{System.String,System.Object},System.Object)">
- <summary>
- Instantiates a new <see cref="T:Microsoft.AspNetCore.Mvc.Filters.ActionExecutingContext"/> instance.
- </summary>
- <param name="actionContext">The <see cref="T:Microsoft.AspNetCore.Mvc.ActionContext"/>.</param>
- <param name="filters">All applicable <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata"/> implementations.</param>
- <param name="actionArguments">
- The arguments to pass when invoking the action. Keys are parameter names.
- </param>
- <param name="controller">The controller instance containing the action.</param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.ActionExecutingContext.Result">
- <summary>
- Gets or sets the <see cref="T:Microsoft.AspNetCore.Mvc.IActionResult"/> to execute. Setting <see cref="P:Microsoft.AspNetCore.Mvc.Filters.ActionExecutingContext.Result"/> to a non-<c>null</c>
- value inside an action filter will short-circuit the action and any remaining action filters.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.ActionExecutingContext.ActionArguments">
- <summary>
- Gets the arguments to pass when invoking the action. Keys are parameter names.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.ActionExecutingContext.Controller">
- <summary>
- Gets the controller instance containing the action.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Filters.ActionExecutionDelegate">
- <summary>
- A delegate that asynchronously returns an <see cref="T:Microsoft.AspNetCore.Mvc.Filters.ActionExecutedContext"/> indicating the action or the next
- action filter has executed.
- </summary>
- <returns>
- A <see cref="T:System.Threading.Tasks.Task"/> that on completion returns an <see cref="T:Microsoft.AspNetCore.Mvc.Filters.ActionExecutedContext"/>.
- </returns>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Filters.AuthorizationFilterContext">
- <summary>
- A context for authorization filters i.e. <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IAuthorizationFilter"/> and
- <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IAsyncAuthorizationFilter"/> implementations.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Filters.AuthorizationFilterContext.#ctor(Microsoft.AspNetCore.Mvc.ActionContext,System.Collections.Generic.IList{Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata})">
- <summary>
- Instantiates a new <see cref="T:Microsoft.AspNetCore.Mvc.Filters.AuthorizationFilterContext"/> instance.
- </summary>
- <param name="actionContext">The <see cref="T:Microsoft.AspNetCore.Mvc.ActionContext"/>.</param>
- <param name="filters">All applicable <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata"/> implementations.</param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.AuthorizationFilterContext.Result">
- <summary>
- Gets or sets the result of the request. Setting <see cref="P:Microsoft.AspNetCore.Mvc.Filters.AuthorizationFilterContext.Result"/> to a non-<c>null</c> value inside
- an authorization filter will short-circuit the remainder of the filter pipeline.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Filters.ExceptionContext">
- <summary>
- A context for exception filters i.e. <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IExceptionFilter"/> and
- <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IAsyncExceptionFilter"/> implementations.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Filters.ExceptionContext.#ctor(Microsoft.AspNetCore.Mvc.ActionContext,System.Collections.Generic.IList{Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata})">
- <summary>
- Instantiates a new <see cref="T:Microsoft.AspNetCore.Mvc.Filters.ExceptionContext"/> instance.
- </summary>
- <param name="actionContext">The <see cref="T:Microsoft.AspNetCore.Mvc.ActionContext"/>.</param>
- <param name="filters">All applicable <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata"/> implementations.</param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.ExceptionContext.Exception">
- <summary>
- Gets or sets the <see cref="T:System.Exception"/> caught while executing the action.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.ExceptionContext.ExceptionDispatchInfo">
- <summary>
- Gets or sets the <see cref="T:System.Runtime.ExceptionServices.ExceptionDispatchInfo"/> for the
- <see cref="P:Microsoft.AspNetCore.Mvc.Filters.ExceptionContext.Exception"/>, if this information was captured.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.ExceptionContext.ExceptionHandled">
- <summary>
- Gets or sets an indication that the <see cref="P:Microsoft.AspNetCore.Mvc.Filters.ExceptionContext.Exception"/> has been handled.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.ExceptionContext.Result">
- <summary>
- Gets or sets the <see cref="T:Microsoft.AspNetCore.Mvc.IActionResult"/>.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Filters.FilterContext">
- <summary>
- An abstract context for filters.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Filters.FilterContext.#ctor(Microsoft.AspNetCore.Mvc.ActionContext,System.Collections.Generic.IList{Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata})">
- <summary>
- Instantiates a new <see cref="T:Microsoft.AspNetCore.Mvc.Filters.FilterContext"/> instance.
- </summary>
- <param name="actionContext">The <see cref="T:Microsoft.AspNetCore.Mvc.ActionContext"/>.</param>
- <param name="filters">All applicable <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata"/> implementations.</param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.FilterContext.Filters">
- <summary>
- Gets all applicable <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata"/> implementations.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Filters.FilterContext.IsEffectivePolicy``1(``0)">
- <summary>
- Returns a value indicating whether the provided <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata"/> is the most effective
- policy (most specific) applied to the action associated with the <see cref="T:Microsoft.AspNetCore.Mvc.Filters.FilterContext"/>.
- </summary>
- <typeparam name="TMetadata">The type of the filter policy.</typeparam>
- <param name="policy">The filter policy instance.</param>
- <returns>
- <c>true</c> if the provided <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata"/> is the most effective policy, otherwise <c>false</c>.
- </returns>
- <remarks>
- <para>
- The <see cref="M:Microsoft.AspNetCore.Mvc.Filters.FilterContext.IsEffectivePolicy``1(``0)"/> method is used to implement a common convention
- for filters that define an overriding behavior. When multiple filters may apply to the same
- cross-cutting concern, define a common interface for the filters (<typeparamref name="TMetadata"/>) and
- implement the filters such that all of the implementations call this method to determine if they should
- take action.
- </para>
- <para>
- For instance, a global filter might be overridden by placing a filter attribute on an action method.
- The policy applied directly to the action method could be considered more specific.
- </para>
- <para>
- This mechanism for overriding relies on the rules of order and scope that the filter system
- provides to control ordering of filters. It is up to the implementor of filters to implement this
- protocol cooperatively. The filter system has no innate notion of overrides, this is a recommended
- convention.
- </para>
- </remarks>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Filters.FilterContext.FindEffectivePolicy``1">
- <summary>
- Returns the most effective (most specific) policy of type <typeparamref name="TMetadata"/> applied to
- the action associated with the <see cref="T:Microsoft.AspNetCore.Mvc.Filters.FilterContext"/>.
- </summary>
- <typeparam name="TMetadata">The type of the filter policy.</typeparam>
- <returns>The implementation of <typeparamref name="TMetadata"/> applied to the action associated with
- the <see cref="T:Microsoft.AspNetCore.Mvc.Filters.FilterContext"/>
- </returns>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Filters.FilterDescriptor">
- <summary>
- Descriptor for an <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata"/>.
- </summary>
- <remarks>
- <see cref="T:Microsoft.AspNetCore.Mvc.Filters.FilterDescriptor"/> describes an <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata"/> with an order and scope.
-
- Order and scope control the execution order of filters. Filters with a higher value of Order execute
- later in the pipeline.
-
- When filters have the same Order, the Scope value is used to determine the order of execution. Filters
- with a higher value of Scope execute later in the pipeline. See <c>Microsoft.AspNetCore.Mvc.FilterScope</c>
- for commonly used scopes.
-
- For <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IExceptionFilter"/> implementations, the filter runs only after an exception has occurred,
- and so the observed order of execution will be opposite that of other filters.
- </remarks>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Filters.FilterDescriptor.#ctor(Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata,System.Int32)">
- <summary>
- Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.Filters.FilterDescriptor"/>.
- </summary>
- <param name="filter">The <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata"/>.</param>
- <param name="filterScope">The filter scope.</param>
- <remarks>
- If the <paramref name="filter"/> implements <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IOrderedFilter"/>, then the value of
- <see cref="P:Microsoft.AspNetCore.Mvc.Filters.FilterDescriptor.Order"/> will be taken from <see cref="P:Microsoft.AspNetCore.Mvc.Filters.IOrderedFilter.Order"/>. Otherwise the value
- of <see cref="P:Microsoft.AspNetCore.Mvc.Filters.FilterDescriptor.Order"/> will default to <c>0</c>.
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.FilterDescriptor.Filter">
- <summary>
- The <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata"/> instance.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.FilterDescriptor.Order">
- <summary>
- The filter order.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.FilterDescriptor.Scope">
- <summary>
- The filter scope.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Filters.FilterItem">
- <summary>
- Used to associate executable filters with <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata"/> instances
- as part of <see cref="T:Microsoft.AspNetCore.Mvc.Filters.FilterProviderContext"/>. An <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IFilterProvider"/> should
- inspect <see cref="P:Microsoft.AspNetCore.Mvc.Filters.FilterProviderContext.Results"/> and set <see cref="P:Microsoft.AspNetCore.Mvc.Filters.FilterItem.Filter"/> and
- <see cref="P:Microsoft.AspNetCore.Mvc.Filters.FilterItem.IsReusable"/> as appropriate.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Filters.FilterItem.#ctor(Microsoft.AspNetCore.Mvc.Filters.FilterDescriptor)">
- <summary>
- Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.Filters.FilterItem"/>.
- </summary>
- <param name="descriptor">The <see cref="T:Microsoft.AspNetCore.Mvc.Filters.FilterDescriptor"/>.</param>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Filters.FilterItem.#ctor(Microsoft.AspNetCore.Mvc.Filters.FilterDescriptor,Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata)">
- <summary>
- Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.Filters.FilterItem"/>.
- </summary>
- <param name="descriptor">The <see cref="T:Microsoft.AspNetCore.Mvc.Filters.FilterDescriptor"/>.</param>
- <param name="filter"></param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.FilterItem.Descriptor">
- <summary>
- Gets the <see cref="T:Microsoft.AspNetCore.Mvc.Filters.FilterDescriptor"/> containing the filter metadata.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.FilterItem.Filter">
- <summary>
- Gets or sets the executable <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata"/> associated with <see cref="P:Microsoft.AspNetCore.Mvc.Filters.FilterItem.Descriptor"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.FilterItem.IsReusable">
- <summary>
- Gets or sets a value indicating whether or not <see cref="P:Microsoft.AspNetCore.Mvc.Filters.FilterItem.Filter"/> can be reused across requests.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Filters.FilterProviderContext">
- <summary>
- A context for filter providers i.e. <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IFilterProvider"/> implementations.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Filters.FilterProviderContext.#ctor(Microsoft.AspNetCore.Mvc.ActionContext,System.Collections.Generic.IList{Microsoft.AspNetCore.Mvc.Filters.FilterItem})">
- <summary>
- Instantiates a new <see cref="T:Microsoft.AspNetCore.Mvc.Filters.FilterProviderContext"/> instance.
- </summary>
- <param name="actionContext">The <see cref="P:Microsoft.AspNetCore.Mvc.Filters.FilterProviderContext.ActionContext"/>.</param>
- <param name="items">
- The <see cref="T:Microsoft.AspNetCore.Mvc.Filters.FilterItem"/>s, initially created from <see cref="T:Microsoft.AspNetCore.Mvc.Filters.FilterDescriptor"/>s or a cache entry.
- </param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.FilterProviderContext.ActionContext">
- <summary>
- Gets or sets the <see cref="P:Microsoft.AspNetCore.Mvc.Filters.FilterProviderContext.ActionContext"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.FilterProviderContext.Results">
- <summary>
- Gets or sets the <see cref="T:Microsoft.AspNetCore.Mvc.Filters.FilterItem"/>s, initially created from <see cref="T:Microsoft.AspNetCore.Mvc.Filters.FilterDescriptor"/>s or a
- cache entry. <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IFilterProvider"/>s should set <see cref="P:Microsoft.AspNetCore.Mvc.Filters.FilterItem.Filter"/> on existing items or
- add new <see cref="T:Microsoft.AspNetCore.Mvc.Filters.FilterItem"/>s to make executable filters available.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Filters.IActionFilter">
- <summary>
- A filter that surrounds execution of the action.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Filters.IActionFilter.OnActionExecuting(Microsoft.AspNetCore.Mvc.Filters.ActionExecutingContext)">
- <summary>
- Called before the action executes, after model binding is complete.
- </summary>
- <param name="context">The <see cref="T:Microsoft.AspNetCore.Mvc.Filters.ActionExecutingContext"/>.</param>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Filters.IActionFilter.OnActionExecuted(Microsoft.AspNetCore.Mvc.Filters.ActionExecutedContext)">
- <summary>
- Called after the action executes, before the action result.
- </summary>
- <param name="context">The <see cref="T:Microsoft.AspNetCore.Mvc.Filters.ActionExecutedContext"/>.</param>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Filters.IAlwaysRunResultFilter">
- <summary>
- A filter that surrounds execution of all action results.
- </summary>
- <remarks>
- <para>
- The <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IAlwaysRunResultFilter"/> interface declares an <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IResultFilter"/> implementation
- that should run for all action results. <seealso cref="T:Microsoft.AspNetCore.Mvc.Filters.IAsyncAlwaysRunResultFilter"/>.
- </para>
- <para>
- <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IResultFilter"/> and <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IAsyncResultFilter"/> instances are not executed in cases where
- an authorization filter or resource filter short-circuits the request to prevent execution of the action.
- <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IResultFilter"/> and <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IAsyncResultFilter"/> implementations
- are also not executed in cases where an exception filter handles an exception by producing an action result.
- </para>
- </remarks>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Filters.IAsyncActionFilter">
- <summary>
- A filter that asynchronously surrounds execution of the action, after model binding is complete.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Filters.IAsyncActionFilter.OnActionExecutionAsync(Microsoft.AspNetCore.Mvc.Filters.ActionExecutingContext,Microsoft.AspNetCore.Mvc.Filters.ActionExecutionDelegate)">
- <summary>
- Called asynchronously before the action, after model binding is complete.
- </summary>
- <param name="context">The <see cref="T:Microsoft.AspNetCore.Mvc.Filters.ActionExecutingContext"/>.</param>
- <param name="next">
- The <see cref="T:Microsoft.AspNetCore.Mvc.Filters.ActionExecutionDelegate"/>. Invoked to execute the next action filter or the action itself.
- </param>
- <returns>A <see cref="T:System.Threading.Tasks.Task"/> that on completion indicates the filter has executed.</returns>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Filters.IAsyncAlwaysRunResultFilter">
- <summary>
- A filter that asynchronously surrounds execution of all action results.
- </summary>
- <remarks>
- <para>
- The <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IAsyncAlwaysRunResultFilter"/> interface declares an <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IAsyncResultFilter"/> implementation
- that should run for all action results. <seealso cref="T:Microsoft.AspNetCore.Mvc.Filters.IAsyncAlwaysRunResultFilter"/>.
- </para>
- <para>
- <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IResultFilter"/> and <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IAsyncResultFilter"/> instances are not executed in cases where
- an authorization filter or resource filter short-circuits the request to prevent execution of the action.
- <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IResultFilter"/> and <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IAsyncResultFilter"/> implementations
- are also not executed in cases where an exception filter handles an exception by producing an action result.
- </para>
- </remarks>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Filters.IAsyncAuthorizationFilter">
- <summary>
- A filter that asynchronously confirms request authorization.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Filters.IAsyncAuthorizationFilter.OnAuthorizationAsync(Microsoft.AspNetCore.Mvc.Filters.AuthorizationFilterContext)">
- <summary>
- Called early in the filter pipeline to confirm request is authorized.
- </summary>
- <param name="context">The <see cref="T:Microsoft.AspNetCore.Mvc.Filters.AuthorizationFilterContext"/>.</param>
- <returns>
- A <see cref="T:System.Threading.Tasks.Task"/> that on completion indicates the filter has executed.
- </returns>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Filters.IAsyncExceptionFilter">
- <summary>
- A filter that runs asynchronously after an action has thrown an <see cref="T:System.Exception"/>.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Filters.IAsyncExceptionFilter.OnExceptionAsync(Microsoft.AspNetCore.Mvc.Filters.ExceptionContext)">
- <summary>
- Called after an action has thrown an <see cref="T:System.Exception"/>.
- </summary>
- <param name="context">The <see cref="T:Microsoft.AspNetCore.Mvc.Filters.ExceptionContext"/>.</param>
- <returns>A <see cref="T:System.Threading.Tasks.Task"/> that on completion indicates the filter has executed.</returns>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Filters.IAsyncResourceFilter">
- <summary>
- A filter that asynchronously surrounds execution of model binding, the action (and filters) and the action
- result (and filters).
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Filters.IAsyncResourceFilter.OnResourceExecutionAsync(Microsoft.AspNetCore.Mvc.Filters.ResourceExecutingContext,Microsoft.AspNetCore.Mvc.Filters.ResourceExecutionDelegate)">
- <summary>
- Called asynchronously before the rest of the pipeline.
- </summary>
- <param name="context">The <see cref="T:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutingContext"/>.</param>
- <param name="next">
- The <see cref="T:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutionDelegate"/>. Invoked to execute the next resource filter or the remainder
- of the pipeline.
- </param>
- <returns>
- A <see cref="T:System.Threading.Tasks.Task"/> which will complete when the remainder of the pipeline completes.
- </returns>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Filters.IAsyncResultFilter">
- <summary>
- A filter that asynchronously surrounds execution of action results successfully returned from an action.
- </summary>
- <remarks>
- <para>
- <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IResultFilter"/> and <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IAsyncResultFilter"/> implementations are executed around the action
- result only when the action method (or action filters) complete successfully.
- </para>
- <para>
- <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IResultFilter"/> and <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IAsyncResultFilter"/> instances are not executed in cases where
- an authorization filter or resource filter short-circuits the request to prevent execution of the action.
- <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IResultFilter"/>. <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IResultFilter"/> and <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IAsyncResultFilter"/> implementations
- are also not executed in cases where an exception filter handles an exception by producing an action result.
- </para>
- <para>
- To create a result filter that surrounds the execution of all action results, implement
- either the <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IAlwaysRunResultFilter"/> or the <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IAsyncAlwaysRunResultFilter"/> interface.
- </para>
- </remarks>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Filters.IAsyncResultFilter.OnResultExecutionAsync(Microsoft.AspNetCore.Mvc.Filters.ResultExecutingContext,Microsoft.AspNetCore.Mvc.Filters.ResultExecutionDelegate)">
- <summary>
- Called asynchronously before the action result.
- </summary>
- <param name="context">The <see cref="T:Microsoft.AspNetCore.Mvc.Filters.ResultExecutingContext"/>.</param>
- <param name="next">
- The <see cref="T:Microsoft.AspNetCore.Mvc.Filters.ResultExecutionDelegate"/>. Invoked to execute the next result filter or the result itself.
- </param>
- <returns>A <see cref="T:System.Threading.Tasks.Task"/> that on completion indicates the filter has executed.</returns>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Filters.IAuthorizationFilter">
- <summary>
- A filter that confirms request authorization.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Filters.IAuthorizationFilter.OnAuthorization(Microsoft.AspNetCore.Mvc.Filters.AuthorizationFilterContext)">
- <summary>
- Called early in the filter pipeline to confirm request is authorized.
- </summary>
- <param name="context">The <see cref="T:Microsoft.AspNetCore.Mvc.Filters.AuthorizationFilterContext"/>.</param>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Filters.IExceptionFilter">
- <summary>
- A filter that runs after an action has thrown an <see cref="T:System.Exception"/>.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Filters.IExceptionFilter.OnException(Microsoft.AspNetCore.Mvc.Filters.ExceptionContext)">
- <summary>
- Called after an action has thrown an <see cref="T:System.Exception"/>.
- </summary>
- <param name="context">The <see cref="T:Microsoft.AspNetCore.Mvc.Filters.ExceptionContext"/>.</param>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Filters.IFilterContainer">
- <summary>
- A filter that requires a reference back to the <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IFilterFactory"/> that created it.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.IFilterContainer.FilterDefinition">
- <summary>
- The <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IFilterFactory"/> that created this filter instance.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Filters.IFilterFactory">
- <summary>
- An interface for filter metadata which can create an instance of an executable filter.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.IFilterFactory.IsReusable">
- <summary>
- Gets a value that indicates if the result of <see cref="M:Microsoft.AspNetCore.Mvc.Filters.IFilterFactory.CreateInstance(System.IServiceProvider)"/>
- can be reused across requests.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Filters.IFilterFactory.CreateInstance(System.IServiceProvider)">
- <summary>
- Creates an instance of the executable filter.
- </summary>
- <param name="serviceProvider">The request <see cref="T:System.IServiceProvider"/>.</param>
- <returns>An instance of the executable filter.</returns>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata">
- <summary>
- Marker interface for filters handled in the MVC request pipeline.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Filters.IFilterProvider">
- <summary>
- A <see cref="T:Microsoft.AspNetCore.Mvc.Filters.FilterItem"/> provider. Implementations should update <see cref="P:Microsoft.AspNetCore.Mvc.Filters.FilterProviderContext.Results"/>
- to make executable filters available.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.IFilterProvider.Order">
- <summary>
- Gets the order value for determining the order of execution of providers. Providers execute in
- ascending numeric value of the <see cref="P:Microsoft.AspNetCore.Mvc.Filters.IFilterProvider.Order"/> property.
- </summary>
- <remarks>
- <para>
- Providers are executed in an ordering determined by an ascending sort of the <see cref="P:Microsoft.AspNetCore.Mvc.Filters.IFilterProvider.Order"/> property.
- A provider with a lower numeric value of <see cref="P:Microsoft.AspNetCore.Mvc.Filters.IFilterProvider.Order"/> will have its
- <see cref="M:Microsoft.AspNetCore.Mvc.Filters.IFilterProvider.OnProvidersExecuting(Microsoft.AspNetCore.Mvc.Filters.FilterProviderContext)"/> called before that of a provider with a higher numeric value of
- <see cref="P:Microsoft.AspNetCore.Mvc.Filters.IFilterProvider.Order"/>. The <see cref="M:Microsoft.AspNetCore.Mvc.Filters.IFilterProvider.OnProvidersExecuted(Microsoft.AspNetCore.Mvc.Filters.FilterProviderContext)"/> method is called in the reverse ordering after
- all calls to <see cref="M:Microsoft.AspNetCore.Mvc.Filters.IFilterProvider.OnProvidersExecuting(Microsoft.AspNetCore.Mvc.Filters.FilterProviderContext)"/>. A provider with a lower numeric value of
- <see cref="P:Microsoft.AspNetCore.Mvc.Filters.IFilterProvider.Order"/> will have its <see cref="M:Microsoft.AspNetCore.Mvc.Filters.IFilterProvider.OnProvidersExecuted(Microsoft.AspNetCore.Mvc.Filters.FilterProviderContext)"/> method called after that of a provider
- with a higher numeric value of <see cref="P:Microsoft.AspNetCore.Mvc.Filters.IFilterProvider.Order"/>.
- </para>
- <para>
- If two providers have the same numeric value of <see cref="P:Microsoft.AspNetCore.Mvc.Filters.IFilterProvider.Order"/>, then their relative execution order
- is undefined.
- </para>
- </remarks>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Filters.IFilterProvider.OnProvidersExecuting(Microsoft.AspNetCore.Mvc.Filters.FilterProviderContext)">
- <summary>
- Called in increasing <see cref="P:Microsoft.AspNetCore.Mvc.Filters.IFilterProvider.Order"/>.
- </summary>
- <param name="context">The <see cref="T:Microsoft.AspNetCore.Mvc.Filters.FilterProviderContext"/>.</param>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Filters.IFilterProvider.OnProvidersExecuted(Microsoft.AspNetCore.Mvc.Filters.FilterProviderContext)">
- <summary>
- Called in decreasing <see cref="P:Microsoft.AspNetCore.Mvc.Filters.IFilterProvider.Order"/>, after all <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IFilterProvider"/>s have executed once.
- </summary>
- <param name="context">The <see cref="T:Microsoft.AspNetCore.Mvc.Filters.FilterProviderContext"/>.</param>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Filters.IOrderedFilter">
- <summary>
- A filter that specifies the relative order it should run.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.IOrderedFilter.Order">
- <summary>
- Gets the order value for determining the order of execution of filters. Filters execute in
- ascending numeric value of the <see cref="P:Microsoft.AspNetCore.Mvc.Filters.IOrderedFilter.Order"/> property.
- </summary>
- <remarks>
- <para>
- Filters are executed in an ordering determined by an ascending sort of the <see cref="P:Microsoft.AspNetCore.Mvc.Filters.IOrderedFilter.Order"/> property.
- </para>
- <para>
- Asynchronous filters, such as <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IAsyncActionFilter"/>, surround the execution of subsequent
- filters of the same filter kind. An asynchronous filter with a lower numeric <see cref="P:Microsoft.AspNetCore.Mvc.Filters.IOrderedFilter.Order"/>
- value will have its filter method, such as <see cref="M:Microsoft.AspNetCore.Mvc.Filters.IAsyncActionFilter.OnActionExecutionAsync(Microsoft.AspNetCore.Mvc.Filters.ActionExecutingContext,Microsoft.AspNetCore.Mvc.Filters.ActionExecutionDelegate)"/>,
- executed before that of a filter with a higher value of <see cref="P:Microsoft.AspNetCore.Mvc.Filters.IOrderedFilter.Order"/>.
- </para>
- <para>
- Synchronous filters, such as <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IActionFilter"/>, have a before-method, such as
- <see cref="M:Microsoft.AspNetCore.Mvc.Filters.IActionFilter.OnActionExecuting(Microsoft.AspNetCore.Mvc.Filters.ActionExecutingContext)"/>, and an after-method, such as
- <see cref="M:Microsoft.AspNetCore.Mvc.Filters.IActionFilter.OnActionExecuted(Microsoft.AspNetCore.Mvc.Filters.ActionExecutedContext)"/>. A synchronous filter with a lower numeric <see cref="P:Microsoft.AspNetCore.Mvc.Filters.IOrderedFilter.Order"/>
- value will have its before-method executed before that of a filter with a higher value of
- <see cref="P:Microsoft.AspNetCore.Mvc.Filters.IOrderedFilter.Order"/>. During the after-stage of the filter, a synchronous filter with a lower
- numeric <see cref="P:Microsoft.AspNetCore.Mvc.Filters.IOrderedFilter.Order"/> value will have its after-method executed after that of a filter with a higher
- value of <see cref="P:Microsoft.AspNetCore.Mvc.Filters.IOrderedFilter.Order"/>.
- </para>
- <para>
- If two filters have the same numeric value of <see cref="P:Microsoft.AspNetCore.Mvc.Filters.IOrderedFilter.Order"/>, then their relative execution order
- is determined by the filter scope.
- </para>
- </remarks>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Filters.IResourceFilter">
- <summary>
- A filter that surrounds execution of model binding, the action (and filters) and the action result
- (and filters).
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Filters.IResourceFilter.OnResourceExecuting(Microsoft.AspNetCore.Mvc.Filters.ResourceExecutingContext)">
- <summary>
- Executes the resource filter. Called before execution of the remainder of the pipeline.
- </summary>
- <param name="context">The <see cref="T:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutingContext"/>.</param>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Filters.IResourceFilter.OnResourceExecuted(Microsoft.AspNetCore.Mvc.Filters.ResourceExecutedContext)">
- <summary>
- Executes the resource filter. Called after execution of the remainder of the pipeline.
- </summary>
- <param name="context">The <see cref="T:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutedContext"/>.</param>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Filters.IResultFilter">
- <summary>
- A filter that surrounds execution of action results successfully returned from an action.
- </summary>
- <remarks>
- <para>
- <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IResultFilter"/> and <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IAsyncResultFilter"/> implementations are executed around the action
- result only when the action method (or action filters) complete successfully.
- </para>
- <para>
- <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IResultFilter"/> and <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IAsyncResultFilter"/> instances are not executed in cases where
- an authorization filter or resource filter short-circuits the request to prevent execution of the action.
- <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IResultFilter"/>. <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IResultFilter"/> and <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IAsyncResultFilter"/> implementations
- are also not executed in cases where an exception filter handles an exception by producing an action result.
- </para>
- <para>
- To create a result filter that surrounds the execution of all action results, implement
- either the <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IAlwaysRunResultFilter"/> or the <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IAsyncAlwaysRunResultFilter"/> interface.
- </para>
- </remarks>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Filters.IResultFilter.OnResultExecuting(Microsoft.AspNetCore.Mvc.Filters.ResultExecutingContext)">
- <summary>
- Called before the action result executes.
- </summary>
- <param name="context">The <see cref="T:Microsoft.AspNetCore.Mvc.Filters.ResultExecutingContext"/>.</param>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Filters.IResultFilter.OnResultExecuted(Microsoft.AspNetCore.Mvc.Filters.ResultExecutedContext)">
- <summary>
- Called after the action result executes.
- </summary>
- <param name="context">The <see cref="T:Microsoft.AspNetCore.Mvc.Filters.ResultExecutedContext"/>.</param>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutedContext">
- <summary>
- A context for resource filters, specifically <see cref="M:Microsoft.AspNetCore.Mvc.Filters.IResourceFilter.OnResourceExecuted(Microsoft.AspNetCore.Mvc.Filters.ResourceExecutedContext)"/> calls.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutedContext.#ctor(Microsoft.AspNetCore.Mvc.ActionContext,System.Collections.Generic.IList{Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata})">
- <summary>
- Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutedContext"/>.
- </summary>
- <param name="actionContext">The <see cref="T:Microsoft.AspNetCore.Mvc.ActionContext"/>.</param>
- <param name="filters">The list of <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata"/> instances.</param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutedContext.Canceled">
- <summary>
- Gets or sets a value which indicates whether or not execution was canceled by a resource filter.
- If true, then a resource filter short-circuited execution by setting
- <see cref="P:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutingContext.Result"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutedContext.Exception">
- <summary>
- Gets or set the current <see cref="P:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutedContext.Exception"/>.
- </summary>
- <remarks>
- <para>
- Setting <see cref="P:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutedContext.Exception"/> or <see cref="P:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutedContext.ExceptionDispatchInfo"/> to <c>null</c> will treat
- the exception as handled, and it will not be rethrown by the runtime.
- </para>
- <para>
- Setting <see cref="P:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutedContext.ExceptionHandled"/> to <c>true</c> will also mark the exception as handled.
- </para>
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutedContext.ExceptionDispatchInfo">
- <summary>
- Gets or set the current <see cref="P:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutedContext.Exception"/>.
- </summary>
- <remarks>
- <para>
- Setting <see cref="P:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutedContext.Exception"/> or <see cref="P:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutedContext.ExceptionDispatchInfo"/> to <c>null</c> will treat
- the exception as handled, and it will not be rethrown by the runtime.
- </para>
- <para>
- Setting <see cref="P:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutedContext.ExceptionHandled"/> to <c>true</c> will also mark the exception as handled.
- </para>
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutedContext.ExceptionHandled">
- <summary>
- <para>
- Gets or sets a value indicating whether or not the current <see cref="P:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutedContext.Exception"/> has been handled.
- </para>
- <para>
- If <c>false</c> the <see cref="P:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutedContext.Exception"/> will be rethrown by the runtime after resource filters
- have executed.
- </para>
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutedContext.Result">
- <summary>
- Gets or sets the result.
- </summary>
- <remarks>
- <para>
- The <see cref="P:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutedContext.Result"/> may be provided by execution of the action itself or by another
- filter.
- </para>
- <para>
- The <see cref="P:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutedContext.Result"/> has already been written to the response before being made available
- to resource filters.
- </para>
- </remarks>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutingContext">
- <summary>
- A context for resource filters, specifically <see cref="M:Microsoft.AspNetCore.Mvc.Filters.IResourceFilter.OnResourceExecuting(Microsoft.AspNetCore.Mvc.Filters.ResourceExecutingContext)"/> and
- <see cref="M:Microsoft.AspNetCore.Mvc.Filters.IAsyncResourceFilter.OnResourceExecutionAsync(Microsoft.AspNetCore.Mvc.Filters.ResourceExecutingContext,Microsoft.AspNetCore.Mvc.Filters.ResourceExecutionDelegate)"/> calls.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutingContext.#ctor(Microsoft.AspNetCore.Mvc.ActionContext,System.Collections.Generic.IList{Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata},System.Collections.Generic.IList{Microsoft.AspNetCore.Mvc.ModelBinding.IValueProviderFactory})">
- <summary>
- Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutingContext"/>.
- </summary>
- <param name="actionContext">The <see cref="T:Microsoft.AspNetCore.Mvc.ActionContext"/>.</param>
- <param name="filters">The list of <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata"/> instances.</param>
- <param name="valueProviderFactories">The list of <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IValueProviderFactory"/> instances.</param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutingContext.Result">
- <summary>
- Gets or sets the result of the action to be executed.
- </summary>
- <remarks>
- Setting <see cref="P:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutingContext.Result"/> to a non-<c>null</c> value inside a resource filter will
- short-circuit execution of additional resource filters and the action itself.
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutingContext.ValueProviderFactories">
- <summary>
- Gets the list of <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IValueProviderFactory"/> instances used by model binding.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutionDelegate">
- <summary>
- A delegate that asynchronously returns a <see cref="T:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutedContext"/> indicating model binding, the
- action, the action's result, result filters, and exception filters have executed.
- </summary>
- <returns>A <see cref="T:System.Threading.Tasks.Task"/> that on completion returns a <see cref="T:Microsoft.AspNetCore.Mvc.Filters.ResourceExecutedContext"/>.</returns>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Filters.ResultExecutedContext">
- <summary>
- A context for result filters, specifically <see cref="M:Microsoft.AspNetCore.Mvc.Filters.IResultFilter.OnResultExecuted(Microsoft.AspNetCore.Mvc.Filters.ResultExecutedContext)"/> calls.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Filters.ResultExecutedContext.#ctor(Microsoft.AspNetCore.Mvc.ActionContext,System.Collections.Generic.IList{Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata},Microsoft.AspNetCore.Mvc.IActionResult,System.Object)">
- <summary>
- Instantiates a new <see cref="T:Microsoft.AspNetCore.Mvc.Filters.ResultExecutedContext"/> instance.
- </summary>
- <param name="actionContext">The <see cref="T:Microsoft.AspNetCore.Mvc.ActionContext"/>.</param>
- <param name="filters">All applicable <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata"/> implementations.</param>
- <param name="result">
- The <see cref="T:Microsoft.AspNetCore.Mvc.IActionResult"/> copied from <see cref="P:Microsoft.AspNetCore.Mvc.Filters.ResultExecutingContext.Result"/>.
- </param>
- <param name="controller">The controller instance containing the action.</param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.ResultExecutedContext.Canceled">
- <summary>
- Gets or sets an indication that a result filter set <see cref="P:Microsoft.AspNetCore.Mvc.Filters.ResultExecutingContext.Cancel"/> to
- <c>true</c> and short-circuited the filter pipeline.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.ResultExecutedContext.Controller">
- <summary>
- Gets the controller instance containing the action.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.ResultExecutedContext.Exception">
- <summary>
- Gets or sets the <see cref="T:System.Exception"/> caught while executing the result or result filters, if
- any.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.ResultExecutedContext.ExceptionDispatchInfo">
- <summary>
- Gets or sets the <see cref="T:System.Runtime.ExceptionServices.ExceptionDispatchInfo"/> for the
- <see cref="P:Microsoft.AspNetCore.Mvc.Filters.ResultExecutedContext.Exception"/>, if an <see cref="T:System.Exception"/> was caught and this information captured.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.ResultExecutedContext.ExceptionHandled">
- <summary>
- Gets or sets an indication that the <see cref="P:Microsoft.AspNetCore.Mvc.Filters.ResultExecutedContext.Exception"/> has been handled.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.ResultExecutedContext.Result">
- <summary>
- Gets the <see cref="T:Microsoft.AspNetCore.Mvc.IActionResult"/> copied from <see cref="P:Microsoft.AspNetCore.Mvc.Filters.ResultExecutingContext.Result"/>.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Filters.ResultExecutingContext">
- <summary>
- A context for result filters, specifically <see cref="M:Microsoft.AspNetCore.Mvc.Filters.IResultFilter.OnResultExecuting(Microsoft.AspNetCore.Mvc.Filters.ResultExecutingContext)"/> and
- <see cref="M:Microsoft.AspNetCore.Mvc.Filters.IAsyncResultFilter.OnResultExecutionAsync(Microsoft.AspNetCore.Mvc.Filters.ResultExecutingContext,Microsoft.AspNetCore.Mvc.Filters.ResultExecutionDelegate)"/> calls.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Filters.ResultExecutingContext.#ctor(Microsoft.AspNetCore.Mvc.ActionContext,System.Collections.Generic.IList{Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata},Microsoft.AspNetCore.Mvc.IActionResult,System.Object)">
- <summary>
- Instantiates a new <see cref="T:Microsoft.AspNetCore.Mvc.Filters.ResultExecutingContext"/> instance.
- </summary>
- <param name="actionContext">The <see cref="T:Microsoft.AspNetCore.Mvc.ActionContext"/>.</param>
- <param name="filters">All applicable <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata"/> implementations.</param>
- <param name="result">The <see cref="T:Microsoft.AspNetCore.Mvc.IActionResult"/> of the action and action filters.</param>
- <param name="controller">The controller instance containing the action.</param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.ResultExecutingContext.Controller">
- <summary>
- Gets the controller instance containing the action.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.ResultExecutingContext.Result">
- <summary>
- Gets or sets the <see cref="T:Microsoft.AspNetCore.Mvc.IActionResult"/> to execute. Setting <see cref="P:Microsoft.AspNetCore.Mvc.Filters.ResultExecutingContext.Result"/> to a non-<c>null</c>
- value inside a result filter will short-circuit the result and any remaining result filters.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Filters.ResultExecutingContext.Cancel">
- <summary>
- Gets or sets an indication the result filter pipeline should be short-circuited.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Filters.ResultExecutionDelegate">
- <summary>
- A delegate that asynchronously returns an <see cref="T:Microsoft.AspNetCore.Mvc.Filters.ResultExecutedContext"/> indicating the action result or
- the next result filter has executed.
- </summary>
- <returns>A <see cref="T:System.Threading.Tasks.Task"/> that on completion returns an <see cref="T:Microsoft.AspNetCore.Mvc.Filters.ResultExecutedContext"/>.</returns>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Formatters.FormatterCollection`1">
- <summary>
- Represents a collection of formatters.
- </summary>
- <typeparam name="TFormatter">The type of formatters in the collection.</typeparam>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Formatters.FormatterCollection`1.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.FormatterCollection`1"/> class that is empty.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Formatters.FormatterCollection`1.#ctor(System.Collections.Generic.IList{`0})">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.FormatterCollection`1"/> class
- as a wrapper for the specified list.
- </summary>
- <param name="list">The list that is wrapped by the new collection.</param>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Formatters.FormatterCollection`1.RemoveType``1">
- <summary>
- Removes all formatters of the specified type.
- </summary>
- <typeparam name="T">The type to remove.</typeparam>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Formatters.FormatterCollection`1.RemoveType(System.Type)">
- <summary>
- Removes all formatters of the specified type.
- </summary>
- <param name="formatterType">The type to remove.</param>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Formatters.IInputFormatter">
- <summary>
- Reads an object from the request body.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Formatters.IInputFormatter.CanRead(Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext)">
- <summary>
- Determines whether this <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.IInputFormatter"/> can deserialize an object of the
- <paramref name="context"/>'s <see cref="P:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext.ModelType"/>.
- </summary>
- <param name="context">The <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext"/>.</param>
- <returns>
- <c>true</c> if this <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.IInputFormatter"/> can deserialize an object of the
- <paramref name="context"/>'s <see cref="P:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext.ModelType"/>. <c>false</c> otherwise.
- </returns>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Formatters.IInputFormatter.ReadAsync(Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext)">
- <summary>
- Reads an object from the request body.
- </summary>
- <param name="context">The <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext"/>.</param>
- <returns>A <see cref="T:System.Threading.Tasks.Task"/> that on completion deserializes the request body.</returns>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Formatters.IInputFormatterExceptionPolicy">
- <summary>
- A policy which <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.IInputFormatter"/>s can implement to indicate if they want the body model binder
- to handle all exceptions. By default, all default <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.IInputFormatter"/>s implement this interface and
- have a default value of <see cref="F:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterExceptionPolicy.MalformedInputExceptions"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Formatters.IInputFormatterExceptionPolicy.ExceptionPolicy">
- <summary>
- Gets the flag to indicate if the body model binder should handle all exceptions. If an exception is handled,
- the body model binder converts the exception into model state errors, else the exception is allowed to propagate.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext">
- <summary>
- A context object used by an input formatter for deserializing the request body into an object.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext.#ctor(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary,Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata,System.Func{System.IO.Stream,System.Text.Encoding,System.IO.TextReader})">
- <summary>
- Creates a new instance of <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext"/>.
- </summary>
- <param name="httpContext">
- The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> for the current operation.
- </param>
- <param name="modelName">The name of the model.</param>
- <param name="modelState">
- The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> for recording errors.
- </param>
- <param name="metadata">
- The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> of the model to deserialize.
- </param>
- <param name="readerFactory">
- A delegate which can create a <see cref="T:System.IO.TextReader"/> for the request body.
- </param>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext.#ctor(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary,Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata,System.Func{System.IO.Stream,System.Text.Encoding,System.IO.TextReader},System.Boolean)">
- <summary>
- Creates a new instance of <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext"/>.
- </summary>
- <param name="httpContext">
- The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> for the current operation.
- </param>
- <param name="modelName">The name of the model.</param>
- <param name="modelState">
- The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> for recording errors.
- </param>
- <param name="metadata">
- The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> of the model to deserialize.
- </param>
- <param name="readerFactory">
- A delegate which can create a <see cref="T:System.IO.TextReader"/> for the request body.
- </param>
- <param name="treatEmptyInputAsDefaultValue">
- A value for the <see cref="P:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext.TreatEmptyInputAsDefaultValue"/> property.
- </param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext.TreatEmptyInputAsDefaultValue">
- <summary>
- Gets a flag to indicate whether the input formatter should allow no value to be provided.
- If <see langword="false"/>, the input formatter should handle empty input by returning
- <see cref="M:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterResult.NoValueAsync"/>. If <see langword="true"/>, the input
- formatter should handle empty input by returning the default value for the type
- <see cref="P:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext.ModelType"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext.HttpContext">
- <summary>
- Gets the <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> associated with the current operation.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext.ModelName">
- <summary>
- Gets the name of the model. Used as the key or key prefix for errors added to <see cref="P:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext.ModelState"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext.ModelState">
- <summary>
- Gets the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> associated with the current operation.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext.Metadata">
- <summary>
- Gets the requested <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> of the request body deserialization.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext.ModelType">
- <summary>
- Gets the requested <see cref="T:System.Type"/> of the request body deserialization.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext.ReaderFactory">
- <summary>
- Gets a delegate which can create a <see cref="T:System.IO.TextReader"/> for the request body.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterException">
- <summary>
- Exception thrown by <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.IInputFormatter"/> when the input is not in an expected format.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterExceptionPolicy">
- <summary>
- Defines the set of policies that determine how the model binding system interprets exceptions
- thrown by an <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.IInputFormatter"/>. Applications should set
- <c>MvcOptions.InputFormatterExceptionPolicy</c> to configure this setting.
- </summary>
- <remarks>
- <para>
- An <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.IInputFormatter"/> could throw an exception for several reasons, including:
- <list type="bullet">
- <item><description>malformed input</description></item>
- <item><description>client disconnect or other I/O problem</description></item>
- <item><description>
- application configuration problems such as <see cref="T:System.TypeLoadException"/>
- </description></item>
- </list>
- </para>
- <para>
- The policy associated with <see cref="F:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterExceptionPolicy.AllExceptions"/> treats
- all such categories of problems as model state errors, and usually will be reported to the client as
- an HTTP 400. This was the only policy supported by model binding in ASP.NET Core MVC 1.0, 1.1, and 2.0
- and is still the default for historical reasons.
- </para>
- <para>
- The policy associated with <see cref="F:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterExceptionPolicy.MalformedInputExceptions"/>
- treats only <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterException"/> and its subclasses as model state errors. This means that
- exceptions that are not related to the content of the HTTP request (such as a disconnect) will be rethrown,
- which by default would cause an HTTP 500 response, unless there is exception-handling middleware enabled.
- </para>
- </remarks>
- </member>
- <member name="F:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterExceptionPolicy.AllExceptions">
- <summary>
- This value indicates that all exceptions thrown by an <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.IInputFormatter"/> will be treated
- as model state errors.
- </summary>
- </member>
- <member name="F:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterExceptionPolicy.MalformedInputExceptions">
- <summary>
- This value indicates that only <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterException"/> and subclasses will be treated
- as model state errors. All other exceptions types will be rethrown and can be handled by a higher
- level exception handler, such as exception-handling middleware.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterResult">
- <summary>
- Result of a <see cref="M:Microsoft.AspNetCore.Mvc.Formatters.IInputFormatter.ReadAsync(Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext)"/> operation.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterResult.HasError">
- <summary>
- Gets an indication whether the <see cref="M:Microsoft.AspNetCore.Mvc.Formatters.IInputFormatter.ReadAsync(Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext)"/> operation had an error.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterResult.IsModelSet">
- <summary>
- Gets an indication whether a value for the <see cref="P:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterResult.Model"/> property was supplied.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterResult.Model">
- <summary>
- Gets the deserialized <see cref="T:System.Object"/>.
- </summary>
- <value>
- <c>null</c> if <see cref="P:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterResult.HasError"/> is <c>true</c>.
- </value>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterResult.Failure">
- <summary>
- Returns an <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterResult"/> indicating the <see cref="M:Microsoft.AspNetCore.Mvc.Formatters.IInputFormatter.ReadAsync(Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext)"/>
- operation failed.
- </summary>
- <returns>
- An <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterResult"/> indicating the <see cref="M:Microsoft.AspNetCore.Mvc.Formatters.IInputFormatter.ReadAsync(Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext)"/>
- operation failed i.e. with <see cref="P:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterResult.HasError"/> <c>true</c>.
- </returns>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterResult.FailureAsync">
- <summary>
- Returns a <see cref="T:System.Threading.Tasks.Task"/> that on completion provides an <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterResult"/> indicating
- the <see cref="M:Microsoft.AspNetCore.Mvc.Formatters.IInputFormatter.ReadAsync(Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext)"/> operation failed.
- </summary>
- <returns>
- A <see cref="T:System.Threading.Tasks.Task"/> that on completion provides an <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterResult"/> indicating the
- <see cref="M:Microsoft.AspNetCore.Mvc.Formatters.IInputFormatter.ReadAsync(Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext)"/> operation failed i.e. with <see cref="P:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterResult.HasError"/> <c>true</c>.
- </returns>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterResult.Success(System.Object)">
- <summary>
- Returns an <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterResult"/> indicating the <see cref="M:Microsoft.AspNetCore.Mvc.Formatters.IInputFormatter.ReadAsync(Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext)"/>
- operation was successful.
- </summary>
- <param name="model">The deserialized <see cref="T:System.Object"/>.</param>
- <returns>
- An <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterResult"/> indicating the <see cref="M:Microsoft.AspNetCore.Mvc.Formatters.IInputFormatter.ReadAsync(Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext)"/>
- operation succeeded i.e. with <see cref="P:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterResult.HasError"/> <c>false</c>.
- </returns>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterResult.SuccessAsync(System.Object)">
- <summary>
- Returns a <see cref="T:System.Threading.Tasks.Task"/> that on completion provides an <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterResult"/> indicating
- the <see cref="M:Microsoft.AspNetCore.Mvc.Formatters.IInputFormatter.ReadAsync(Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext)"/> operation was successful.
- </summary>
- <param name="model">The deserialized <see cref="T:System.Object"/>.</param>
- <returns>
- A <see cref="T:System.Threading.Tasks.Task"/> that on completion provides an <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterResult"/> indicating the
- <see cref="M:Microsoft.AspNetCore.Mvc.Formatters.IInputFormatter.ReadAsync(Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext)"/> operation succeeded i.e. with <see cref="P:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterResult.HasError"/> <c>false</c>.
- </returns>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterResult.NoValue">
- <summary>
- Returns an <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterResult"/> indicating the <see cref="M:Microsoft.AspNetCore.Mvc.Formatters.IInputFormatter.ReadAsync(Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext)"/>
- operation produced no value.
- </summary>
- <returns>
- An <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterResult"/> indicating the <see cref="M:Microsoft.AspNetCore.Mvc.Formatters.IInputFormatter.ReadAsync(Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext)"/>
- operation produced no value.
- </returns>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterResult.NoValueAsync">
- <summary>
- Returns a <see cref="T:System.Threading.Tasks.Task"/> that on completion provides an <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterResult"/> indicating
- the <see cref="M:Microsoft.AspNetCore.Mvc.Formatters.IInputFormatter.ReadAsync(Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext)"/> operation produced no value.
- </summary>
- <returns>
- A <see cref="T:System.Threading.Tasks.Task"/> that on completion provides an <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.InputFormatterResult"/> indicating the
- <see cref="M:Microsoft.AspNetCore.Mvc.Formatters.IInputFormatter.ReadAsync(Microsoft.AspNetCore.Mvc.Formatters.InputFormatterContext)"/> operation produced no value.
- </returns>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Formatters.IOutputFormatter">
- <summary>
- Writes an object to the output stream.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Formatters.IOutputFormatter.CanWriteResult(Microsoft.AspNetCore.Mvc.Formatters.OutputFormatterCanWriteContext)">
- <summary>
- Determines whether this <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.IOutputFormatter"/> can serialize
- an object of the specified type.
- </summary>
- <param name="context">The formatter context associated with the call.</param>
- <returns>Returns <c>true</c> if the formatter can write the response; <c>false</c> otherwise.</returns>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Formatters.IOutputFormatter.WriteAsync(Microsoft.AspNetCore.Mvc.Formatters.OutputFormatterWriteContext)">
- <summary>
- Writes the object represented by <paramref name="context"/>'s Object property.
- </summary>
- <param name="context">The formatter context associated with the call.</param>
- <returns>A Task that serializes the value to the <paramref name="context"/>'s response message.</returns>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Formatters.OutputFormatterCanWriteContext">
- <summary>
- A context object for <see cref="M:Microsoft.AspNetCore.Mvc.Formatters.IOutputFormatter.CanWriteResult(Microsoft.AspNetCore.Mvc.Formatters.OutputFormatterCanWriteContext)"/>.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Formatters.OutputFormatterCanWriteContext.#ctor">
- <summary>
- <para>
- This constructor is obsolete and will be removed in a future version.
- Please use <see cref="M:Microsoft.AspNetCore.Mvc.Formatters.OutputFormatterCanWriteContext.#ctor(Microsoft.AspNetCore.Http.HttpContext)"/> instead.
- </para>
- <para>
- Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.OutputFormatterCanWriteContext"/>.
- </para>
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Formatters.OutputFormatterCanWriteContext.#ctor(Microsoft.AspNetCore.Http.HttpContext)">
- <summary>
- Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.OutputFormatterCanWriteContext"/>.
- </summary>
- <param name="httpContext">The <see cref="P:Microsoft.AspNetCore.Mvc.Formatters.OutputFormatterCanWriteContext.HttpContext"/> for the current request.</param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Formatters.OutputFormatterCanWriteContext.HttpContext">
- <summary>
- Gets or sets the <see cref="P:Microsoft.AspNetCore.Mvc.Formatters.OutputFormatterCanWriteContext.HttpContext"/> context associated with the current operation.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Formatters.OutputFormatterCanWriteContext.ContentType">
- <summary>
- Gets or sets the content type to write to the response.
- </summary>
- <remarks>
- An <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.IOutputFormatter"/> can set this value when its
- <see cref="M:Microsoft.AspNetCore.Mvc.Formatters.IOutputFormatter.CanWriteResult(Microsoft.AspNetCore.Mvc.Formatters.OutputFormatterCanWriteContext)"/> method is called,
- and expect to see the same value provided in
- <see cref="M:Microsoft.AspNetCore.Mvc.Formatters.IOutputFormatter.WriteAsync(Microsoft.AspNetCore.Mvc.Formatters.OutputFormatterWriteContext)"/>
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Formatters.OutputFormatterCanWriteContext.ContentTypeIsServerDefined">
- <summary>
- Gets or sets a value to indicate whether the content type was specified by server-side code.
- This allows <see cref="M:Microsoft.AspNetCore.Mvc.Formatters.IOutputFormatter.CanWriteResult(Microsoft.AspNetCore.Mvc.Formatters.OutputFormatterCanWriteContext)"/> to
- implement stricter filtering on content types that, for example, are being considered purely
- because of an incoming Accept header.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Formatters.OutputFormatterCanWriteContext.Object">
- <summary>
- Gets or sets the object to write to the response.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Formatters.OutputFormatterCanWriteContext.ObjectType">
- <summary>
- Gets or sets the <see cref="T:System.Type"/> of the object to write to the response.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Formatters.OutputFormatterWriteContext">
- <summary>
- A context object for <see cref="M:Microsoft.AspNetCore.Mvc.Formatters.IOutputFormatter.WriteAsync(Microsoft.AspNetCore.Mvc.Formatters.OutputFormatterWriteContext)"/>.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.Formatters.OutputFormatterWriteContext.#ctor(Microsoft.AspNetCore.Http.HttpContext,System.Func{System.IO.Stream,System.Text.Encoding,System.IO.TextWriter},System.Type,System.Object)">
- <summary>
- Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.Formatters.OutputFormatterWriteContext"/>.
- </summary>
- <param name="httpContext">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> for the current request.</param>
- <param name="writerFactory">The delegate used to create a <see cref="T:System.IO.TextWriter"/> for writing the response.</param>
- <param name="objectType">The <see cref="T:System.Type"/> of the object to write to the response.</param>
- <param name="object">The object to write to the response.</param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Formatters.OutputFormatterWriteContext.WriterFactory">
- <summary>
- <para>
- Gets or sets a delegate used to create a <see cref="T:System.IO.TextWriter"/> for writing text to the response.
- </para>
- <para>
- Write to <see cref="P:Microsoft.AspNetCore.Http.HttpResponse.Body"/> directly to write binary data to the response.
- </para>
- </summary>
- <remarks>
- <para>
- The <see cref="T:System.IO.TextWriter"/> created by this delegate will encode text and write to the
- <see cref="P:Microsoft.AspNetCore.Http.HttpResponse.Body"/> stream. Call this delegate to create a <see cref="T:System.IO.TextWriter"/>
- for writing text output to the response stream.
- </para>
- <para>
- To implement a formatter that writes binary data to the response stream, do not use the
- <see cref="P:Microsoft.AspNetCore.Mvc.Formatters.OutputFormatterWriteContext.WriterFactory"/> delegate, and use <see cref="P:Microsoft.AspNetCore.Http.HttpResponse.Body"/> instead.
- </para>
- </remarks>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.IActionResult">
- <summary>
- Defines a contract that represents the result of an action method.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.IActionResult.ExecuteResultAsync(Microsoft.AspNetCore.Mvc.ActionContext)">
- <summary>
- Executes the result operation of the action method asynchronously. This method is called by MVC to process
- the result of an action method.
- </summary>
- <param name="context">The context in which the result is executed. The context information includes
- information about the action that was executed and request information.</param>
- <returns>A task that represents the asynchronous execute operation.</returns>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.IUrlHelper">
- <summary>
- Defines the contract for the helper to build URLs for ASP.NET MVC within an application.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.IUrlHelper.ActionContext">
- <summary>
- Gets the <see cref="P:Microsoft.AspNetCore.Mvc.IUrlHelper.ActionContext"/> for the current request.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.IUrlHelper.Action(Microsoft.AspNetCore.Mvc.Routing.UrlActionContext)">
- <summary>
- Generates a URL with an absolute path for an action method, which contains the action
- name, controller name, route values, protocol to use, host name, and fragment specified by
- <see cref="T:Microsoft.AspNetCore.Mvc.Routing.UrlActionContext"/>. Generates an absolute URL if <see cref="P:Microsoft.AspNetCore.Mvc.Routing.UrlActionContext.Protocol"/> and
- <see cref="P:Microsoft.AspNetCore.Mvc.Routing.UrlActionContext.Host"/> are non-<c>null</c>.
- </summary>
- <param name="actionContext">The context object for the generated URLs for an action method.</param>
- <returns>The generated URL.</returns>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.IUrlHelper.Content(System.String)">
- <summary>
- Converts a virtual (relative) path to an application absolute path.
- </summary>
- <remarks>
- If the specified content path does not start with the tilde (~) character,
- this method returns <paramref name="contentPath"/> unchanged.
- </remarks>
- <param name="contentPath">The virtual path of the content.</param>
- <returns>The application absolute path.</returns>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.IUrlHelper.IsLocalUrl(System.String)">
- <summary>
- Returns a value that indicates whether the URL is local. A URL is considered local if it does not have a
- host / authority part and it has an absolute path. URLs using virtual paths ('~/') are also local.
- </summary>
- <param name="url">The URL.</param>
- <returns><c>true</c> if the URL is local; otherwise, <c>false</c>.</returns>
- <example>
- <para>
- For example, the following URLs are considered local:
- <code>
- /Views/Default/Index.html
- ~/Index.html
- </code>
- </para>
- <para>
- The following URLs are non-local:
- <code>
- ../Index.html
- http://www.contoso.com/
- http://localhost/Index.html
- </code>
- </para>
- </example>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.IUrlHelper.RouteUrl(Microsoft.AspNetCore.Mvc.Routing.UrlRouteContext)">
- <summary>
- Generates a URL with an absolute path, which contains the route name, route values, protocol to use, host
- name, and fragment specified by <see cref="T:Microsoft.AspNetCore.Mvc.Routing.UrlRouteContext"/>. Generates an absolute URL if
- <see cref="P:Microsoft.AspNetCore.Mvc.Routing.UrlActionContext.Protocol"/> and <see cref="P:Microsoft.AspNetCore.Mvc.Routing.UrlActionContext.Host"/> are non-<c>null</c>.
- </summary>
- <param name="routeContext">The context object for the generated URLs for a route.</param>
- <returns>The generated URL.</returns>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.IUrlHelper.Link(System.String,System.Object)">
- <summary>
- Generates an absolute URL for the specified <paramref name="routeName"/> and route
- <paramref name="values"/>, which contains the protocol (such as "http" or "https") and host name from the
- current request.
- </summary>
- <param name="routeName">The name of the route that is used to generate URL.</param>
- <param name="values">An object that contains route values.</param>
- <returns>The generated absolute URL.</returns>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.BindingInfo">
- <summary>
- Binding info which represents metadata associated to an action parameter.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.BindingInfo.#ctor">
- <summary>
- Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.BindingInfo"/>.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.BindingInfo.#ctor(Microsoft.AspNetCore.Mvc.ModelBinding.BindingInfo)">
- <summary>
- Creates a copy of a <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.BindingInfo"/>.
- </summary>
- <param name="other">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.BindingInfo"/> to copy.</param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.BindingInfo.BindingSource">
- <summary>
- Gets or sets the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.BindingInfo.BinderModelName">
- <summary>
- Gets or sets the binder model name.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.BindingInfo.BinderType">
- <summary>
- Gets or sets the <see cref="T:System.Type"/> of the model binder used to bind the model.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.BindingInfo.PropertyFilterProvider">
- <summary>
- Gets or sets the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IPropertyFilterProvider"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.BindingInfo.RequestPredicate">
- <summary>
- Gets or sets a predicate which determines whether or not the model should be bound based on state
- from the current request.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.BindingInfo.GetBindingInfo(System.Collections.Generic.IEnumerable{System.Object})">
- <summary>
- Constructs a new instance of <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.BindingInfo"/> from the given <paramref name="attributes"/>.
- <para>
- This overload does not account for <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.BindingInfo"/> specified via <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/>. Consider using
- <see cref="M:Microsoft.AspNetCore.Mvc.ModelBinding.BindingInfo.GetBindingInfo(System.Collections.Generic.IEnumerable{System.Object},Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata)"/> overload, or <see cref="M:Microsoft.AspNetCore.Mvc.ModelBinding.BindingInfo.TryApplyBindingInfo(Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata)"/>
- on the result of this method to get a more accurate <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.BindingInfo"/> instance.
- </para>
- </summary>
- <param name="attributes">A collection of attributes which are used to construct <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.BindingInfo"/>
- </param>
- <returns>A new instance of <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.BindingInfo"/>.</returns>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.BindingInfo.GetBindingInfo(System.Collections.Generic.IEnumerable{System.Object},Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata)">
- <summary>
- Constructs a new instance of <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.BindingInfo"/> from the given <paramref name="attributes"/> and <paramref name="modelMetadata"/>.
- </summary>
- <param name="attributes">A collection of attributes which are used to construct <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.BindingInfo"/>.</param>
- <param name="modelMetadata">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/>.</param>
- <returns>A new instance of <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.BindingInfo"/> if any binding metadata was discovered; otherwise or <see langword="null"/>.</returns>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.BindingInfo.TryApplyBindingInfo(Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata)">
- <summary>
- Applies binding metadata from the specified <paramref name="modelMetadata"/>.
- <para>
- Uses values from <paramref name="modelMetadata"/> if no value is already available.
- </para>
- </summary>
- <param name="modelMetadata">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/>.</param>
- <returns><see langword="true"/> if any binding metadata from <paramref name="modelMetadata"/> was applied;
- <see langword="false"/> otherwise.</returns>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource">
- <summary>
- A metadata object representing a source of data for model binding.
- </summary>
- </member>
- <member name="F:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource.Body">
- <summary>
- A <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource"/> for the request body.
- </summary>
- </member>
- <member name="F:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource.Custom">
- <summary>
- A <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource"/> for a custom model binder (unknown data source).
- </summary>
- </member>
- <member name="F:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource.Form">
- <summary>
- A <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource"/> for the request form-data.
- </summary>
- </member>
- <member name="F:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource.Header">
- <summary>
- A <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource"/> for the request headers.
- </summary>
- </member>
- <member name="F:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource.ModelBinding">
- <summary>
- A <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource"/> for model binding. Includes form-data, query-string
- and route data from the request.
- </summary>
- </member>
- <member name="F:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource.Path">
- <summary>
- A <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource"/> for the request url path.
- </summary>
- </member>
- <member name="F:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource.Query">
- <summary>
- A <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource"/> for the request query-string.
- </summary>
- </member>
- <member name="F:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource.Services">
- <summary>
- A <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource"/> for request services.
- </summary>
- </member>
- <member name="F:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource.Special">
- <summary>
- A <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource"/> for special parameter types that are not user input.
- </summary>
- </member>
- <member name="F:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource.FormFile">
- <summary>
- A <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource"/> for <see cref="T:Microsoft.AspNetCore.Http.IFormFile"/>, <see cref="T:Microsoft.AspNetCore.Http.IFormCollection"/>, and <see cref="T:Microsoft.AspNetCore.Http.IFormFileCollection"/>.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource.#ctor(System.String,System.String,System.Boolean,System.Boolean)">
- <summary>
- Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource"/>.
- </summary>
- <param name="id">The id, a unique identifier.</param>
- <param name="displayName">The display name.</param>
- <param name="isGreedy">A value indicating whether or not the source is greedy.</param>
- <param name="isFromRequest">
- A value indicating whether or not the data comes from the HTTP request.
- </param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource.DisplayName">
- <summary>
- Gets the display name for the source.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource.Id">
- <summary>
- Gets the unique identifier for the source. Sources are compared based on their Id.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource.IsGreedy">
- <summary>
- Gets a value indicating whether or not a source is greedy. A greedy source will bind a model in
- a single operation, and will not decompose the model into sub-properties.
- </summary>
- <remarks>
- <para>
- For sources based on a <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IValueProvider"/>, setting <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource.IsGreedy"/> to <c>false</c>
- will most closely describe the behavior. This value is used inside the default model binders to
- determine whether or not to attempt to bind properties of a model.
- </para>
- <para>
- Set <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource.IsGreedy"/> to <c>true</c> for most custom <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinder"/> implementations.
- </para>
- <para>
- If a source represents an <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinder"/> which will recursively traverse a model's properties
- and bind them individually using <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IValueProvider"/>, then set <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource.IsGreedy"/> to
- <c>true</c>.
- </para>
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource.IsFromRequest">
- <summary>
- Gets a value indicating whether or not the binding source uses input from the current HTTP request.
- </summary>
- <remarks>
- Some sources (like <see cref="F:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource.Services"/>) are based on application state and not user
- input. These are excluded by default from ApiExplorer diagnostics.
- </remarks>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource.CanAcceptDataFrom(Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource)">
- <summary>
- Gets a value indicating whether or not the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource"/> can accept
- data from <paramref name="bindingSource"/>.
- </summary>
- <param name="bindingSource">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource"/> to consider as input.</param>
- <returns><c>True</c> if the source is compatible, otherwise <c>false</c>.</returns>
- <remarks>
- When using this method, it is expected that the left-hand-side is metadata specified
- on a property or parameter for model binding, and the right hand side is a source of
- data used by a model binder or value provider.
-
- This distinction is important as the left-hand-side may be a composite, but the right
- may not.
- </remarks>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource.Equals(Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource)">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource.Equals(System.Object)">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource.GetHashCode">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource.op_Equality(Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource,Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource)">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource.op_Inequality(Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource,Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource)">
- <inheritdoc />
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.CompositeBindingSource">
- <summary>
- A <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.CompositeBindingSource.BindingSources"/> which can represent multiple value-provider data sources.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.CompositeBindingSource.Create(System.Collections.Generic.IEnumerable{Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource},System.String)">
- <summary>
- Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.CompositeBindingSource"/>.
- </summary>
- <param name="bindingSources">
- The set of <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource"/> entries.
- Must be value-provider sources and user input.
- </param>
- <param name="displayName">The display name for the composite source.</param>
- <returns>A <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.CompositeBindingSource"/>.</returns>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.CompositeBindingSource.BindingSources">
- <summary>
- Gets the set of <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource"/> entries.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.CompositeBindingSource.CanAcceptDataFrom(Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource)">
- <inheritdoc />
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.EnumGroupAndName">
- <summary>
- An abstraction used when grouping enum values for <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.EnumGroupedDisplayNamesAndValues"/>.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.EnumGroupAndName.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.EnumGroupAndName"/> structure. This constructor should
- not be used in any site where localization is important.
- </summary>
- <param name="group">The group name.</param>
- <param name="name">The name.</param>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.EnumGroupAndName.#ctor(System.String,System.Func{System.String})">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.EnumGroupAndName"/> structure.
- </summary>
- <param name="group">The group name.</param>
- <param name="name">A <see cref="T:System.Func`1"/> which will return the name.</param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.EnumGroupAndName.Group">
- <summary>
- Gets the Group name.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.EnumGroupAndName.Name">
- <summary>
- Gets the name.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.IBinderTypeProviderMetadata">
- <summary>
- Provides a <see cref="T:System.Type"/> which implements <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinder"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.IBinderTypeProviderMetadata.BinderType">
- <summary>
- A <see cref="T:System.Type"/> which implements either <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinder"/>.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.IBindingSourceMetadata">
- <summary>
- Metadata which specifies the data source for model binding.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.IBindingSourceMetadata.BindingSource">
- <summary>
- Gets the <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.IBindingSourceMetadata.BindingSource"/>.
- </summary>
- <remarks>
- The <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.IBindingSourceMetadata.BindingSource"/> is metadata which can be used to determine which data
- sources are valid for model binding of a property or parameter.
- </remarks>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinder">
- <summary>
- Defines an interface for model binders.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinder.BindModelAsync(Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext)">
- <summary>
- Attempts to bind a model.
- </summary>
- <param name="bindingContext">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext"/>.</param>
- <returns>
- <para>
- A <see cref="T:System.Threading.Tasks.Task"/> which will complete when the model binding process completes.
- </para>
- <para>
- If model binding was successful, the <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.Result"/> should have
- <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult.IsModelSet"/> set to <c>true</c>.
- </para>
- <para>
- A model binder that completes successfully should set <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.Result"/> to
- a value returned from <see cref="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult.Success(System.Object)"/>.
- </para>
- </returns>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinderProvider">
- <summary>
- Creates <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinder"/> instances. Register <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinderProvider"/>
- instances in <c>MvcOptions</c>.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinderProvider.GetBinder(Microsoft.AspNetCore.Mvc.ModelBinding.ModelBinderProviderContext)">
- <summary>
- Creates a <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinder"/> based on <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBinderProviderContext"/>.
- </summary>
- <param name="context">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBinderProviderContext"/>.</param>
- <returns>An <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinder"/>.</returns>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.IModelNameProvider">
- <summary>
- Represents an entity which can provide model name as metadata.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.IModelNameProvider.Name">
- <summary>
- Model name.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.IPropertyFilterProvider">
- <summary>
- Provides a predicate which can determines which model properties should be bound by model binding.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.IPropertyFilterProvider.PropertyFilter">
- <summary>
- Gets a predicate which can determines which model properties should be bound by model binding.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.IRequestPredicateProvider">
- <summary>
- An interface that allows a top-level model to be bound or not bound based on state associated
- with the current request.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.IRequestPredicateProvider.RequestPredicate">
- <summary>
- Gets a function which determines whether or not the model object should be bound based
- on the current request.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.IValueProvider">
- <summary>
- Defines the methods that are required for a value provider.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.IValueProvider.ContainsPrefix(System.String)">
- <summary>
- Determines whether the collection contains the specified prefix.
- </summary>
- <param name="prefix">The prefix to search for.</param>
- <returns>true if the collection contains the specified prefix; otherwise, false.</returns>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.IValueProvider.GetValue(System.String)">
- <summary>
- Retrieves a value object using the specified key.
- </summary>
- <param name="key">The key of the value object to retrieve.</param>
- <returns>The value object for the specified key. If the exact key is not found, null.</returns>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.IValueProviderFactory">
- <summary>
- A factory for creating <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IValueProvider"/> instances.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.IValueProviderFactory.CreateValueProviderAsync(Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderFactoryContext)">
- <summary>
- Creates a <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IValueProvider"/> with values from the current request
- and adds it to <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderFactoryContext.ValueProviders"/> list.
- </summary>
- <param name="context">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderFactoryContext"/>.</param>
- <returns>A <see cref="T:System.Threading.Tasks.Task"/> that when completed will add an <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IValueProvider"/> instance
- to <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderFactoryContext.ValueProviders"/> list if applicable.</returns>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelBindingMessageProvider">
- <summary>
- Provider for error messages the model binding system detects.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelBindingMessageProvider.MissingBindRequiredValueAccessor">
- <summary>
- Error message the model binding system adds when a property with an associated
- <c>BindRequiredAttribute</c> is not bound.
- </summary>
- <value>Default <see cref="T:System.String"/> is "A value for the '{0}' property was not provided.".</value>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelBindingMessageProvider.MissingKeyOrValueAccessor">
- <summary>
- Error message the model binding system adds when either the key or the value of a
- <see cref="T:System.Collections.Generic.KeyValuePair`2"/> is bound but not both.
- </summary>
- <value>Default <see cref="T:System.String"/> is "A value is required.".</value>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelBindingMessageProvider.MissingRequestBodyRequiredValueAccessor">
- <summary>
- Error message the model binding system adds when no value is provided for the request body,
- but a value is required.
- </summary>
- <value>Default <see cref="T:System.String"/> is "A non-empty request body is required.".</value>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelBindingMessageProvider.ValueMustNotBeNullAccessor">
- <summary>
- Error message the model binding system adds when a <c>null</c> value is bound to a
- non-<see cref="T:System.Nullable"/> property.
- </summary>
- <value>Default <see cref="T:System.String"/> is "The value '{0}' is invalid.".</value>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelBindingMessageProvider.AttemptedValueIsInvalidAccessor">
- <summary>
- Error message the model binding system adds when <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelError.Exception"/> is of type
- <see cref="T:System.FormatException"/> or <see cref="T:System.OverflowException"/>, value is known, and error is associated
- with a property.
- </summary>
- <value>Default <see cref="T:System.String"/> is "The value '{0}' is not valid for {1}.".</value>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelBindingMessageProvider.NonPropertyAttemptedValueIsInvalidAccessor">
- <summary>
- Error message the model binding system adds when <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelError.Exception"/> is of type
- <see cref="T:System.FormatException"/> or <see cref="T:System.OverflowException"/>, value is known, and error is associated
- with a collection element or action parameter.
- </summary>
- <value>Default <see cref="T:System.String"/> is "The value '{0}' is not valid.".</value>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelBindingMessageProvider.UnknownValueIsInvalidAccessor">
- <summary>
- Error message the model binding system adds when <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelError.Exception"/> is of type
- <see cref="T:System.FormatException"/> or <see cref="T:System.OverflowException"/>, value is unknown, and error is associated
- with a property.
- </summary>
- <value>Default <see cref="T:System.String"/> is "The supplied value is invalid for {0}.".</value>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelBindingMessageProvider.NonPropertyUnknownValueIsInvalidAccessor">
- <summary>
- Error message the model binding system adds when <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelError.Exception"/> is of type
- <see cref="T:System.FormatException"/> or <see cref="T:System.OverflowException"/>, value is unknown, and error is associated
- with a collection element or action parameter.
- </summary>
- <value>Default <see cref="T:System.String"/> is "The supplied value is invalid.".</value>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelBindingMessageProvider.ValueIsInvalidAccessor">
- <summary>
- Fallback error message HTML and tag helpers display when a property is invalid but the
- <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelError"/>s have <c>null</c> <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelError.ErrorMessage"/>s.
- </summary>
- <value>Default <see cref="T:System.String"/> is "The value '{0}' is invalid.".</value>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelBindingMessageProvider.ValueMustBeANumberAccessor">
- <summary>
- Error message HTML and tag helpers add for client-side validation of numeric formats. Visible in the
- browser if the field for a <c>float</c> (for example) property does not have a correctly-formatted value.
- </summary>
- <value>Default <see cref="T:System.String"/> is "The field {0} must be a number.".</value>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelBindingMessageProvider.NonPropertyValueMustBeANumberAccessor">
- <summary>
- Error message HTML and tag helpers add for client-side validation of numeric formats. Visible in the
- browser if the field for a <c>float</c> (for example) collection element or action parameter does not have a
- correctly-formatted value.
- </summary>
- <value>Default <see cref="T:System.String"/> is "The field must be a number.".</value>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelMetadataIdentity">
- <summary>
- A key type which identifies a <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/>.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelMetadataIdentity.ForType(System.Type)">
- <summary>
- Creates a <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelMetadataIdentity"/> for the provided model <see cref="T:System.Type"/>.
- </summary>
- <param name="modelType">The model <see cref="T:System.Type"/>.</param>
- <returns>A <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelMetadataIdentity"/>.</returns>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelMetadataIdentity.ForProperty(System.Type,System.String,System.Type)">
- <summary>
- Creates a <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelMetadataIdentity"/> for the provided property.
- </summary>
- <param name="modelType">The model type.</param>
- <param name="name">The name of the property.</param>
- <param name="containerType">The container type of the model property.</param>
- <returns>A <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelMetadataIdentity"/>.</returns>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelMetadataIdentity.ContainerType">
- <summary>
- Gets the <see cref="T:System.Type"/> defining the model property represented by the current
- instance, or <c>null</c> if the current instance does not represent a property.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelMetadataIdentity.ModelType">
- <summary>
- Gets the <see cref="T:System.Type"/> represented by the current instance.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelMetadataIdentity.MetadataKind">
- <summary>
- Gets a value indicating the kind of metadata represented by the current instance.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelMetadataIdentity.Name">
- <summary>
- Gets the name of the current instance if it represents a parameter or property, or <c>null</c> if
- the current instance represents a type.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelMetadataIdentity.ParameterInfo">
- <summary>
- Gets a descriptor for the parameter, or <c>null</c> if this instance
- does not represent a parameter.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelMetadataIdentity.Equals(Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelMetadataIdentity)">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelMetadataIdentity.Equals(System.Object)">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelMetadataIdentity.GetHashCode">
- <inheritdoc />
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelMetadataKind">
- <summary>
- Enumeration for the kinds of <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/>
- </summary>
- </member>
- <member name="F:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelMetadataKind.Type">
- <summary>
- Used for <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> for a <see cref="T:System.Type"/>.
- </summary>
- </member>
- <member name="F:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelMetadataKind.Property">
- <summary>
- Used for <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> for a property.
- </summary>
- </member>
- <member name="F:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelMetadataKind.Parameter">
- <summary>
- Used for <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> for a parameter.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBinderProviderContext">
- <summary>
- A context object for <see cref="M:Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinderProvider.GetBinder(Microsoft.AspNetCore.Mvc.ModelBinding.ModelBinderProviderContext)"/>.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBinderProviderContext.CreateBinder(Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata)">
- <summary>
- Creates an <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinder"/> for the given <paramref name="metadata"/>.
- </summary>
- <param name="metadata">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> for the model.</param>
- <returns>An <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinder"/>.</returns>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBinderProviderContext.CreateBinder(Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata,Microsoft.AspNetCore.Mvc.ModelBinding.BindingInfo)">
- <summary>
- Creates an <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinder"/> for the given <paramref name="metadata"/>
- and <paramref name="bindingInfo"/>.
- </summary>
- <param name="metadata">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> for the model.</param>
- <param name="bindingInfo">The <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBinderProviderContext.BindingInfo"/> that should be used
- for creating the binder.</param>
- <returns>An <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinder"/>.</returns>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBinderProviderContext.BindingInfo">
- <summary>
- Gets the <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBinderProviderContext.BindingInfo"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBinderProviderContext.Metadata">
- <summary>
- Gets the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBinderProviderContext.MetadataProvider">
- <summary>
- Gets the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IModelMetadataProvider"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBinderProviderContext.Services">
- <summary>
- Gets the <see cref="T:System.IServiceProvider"/>.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext">
- <summary>
- A context that contains operating information for model binding and validation.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.ActionContext">
- <summary>
- Represents the <see cref="T:Microsoft.AspNetCore.Mvc.ActionContext"/> associated with this context.
- </summary>
- <remarks>
- The property setter is provided for unit testing purposes only.
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.BinderModelName">
- <summary>
- Gets or sets a model name which is explicitly set using an <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IModelNameProvider"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.BindingSource">
- <summary>
- Gets or sets a value which represents the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource"/> associated with the
- <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.Model"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.FieldName">
- <summary>
- Gets or sets the name of the current field being bound.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.HttpContext">
- <summary>
- Gets the <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> associated with this context.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.IsTopLevelObject">
- <summary>
- Gets or sets an indication that the current binder is handling the top-level object.
- </summary>
- <remarks>Passed into the model binding system.</remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.Model">
- <summary>
- Gets or sets the model value for the current operation.
- </summary>
- <remarks>
- The <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.Model"/> will typically be set for a binding operation that works
- against a pre-existing model object to update certain properties.
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.ModelMetadata">
- <summary>
- Gets or sets the metadata for the model associated with this context.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.ModelName">
- <summary>
- Gets or sets the name of the model. This property is used as a key for looking up values in
- <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IValueProvider"/> during model binding.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.ModelState">
- <summary>
- Gets or sets the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> used to capture <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry"/> values
- for properties in the object graph of the model when binding.
- </summary>
- <remarks>
- The property setter is provided for unit testing purposes only.
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.ModelType">
- <summary>
- Gets the type of the model.
- </summary>
- <remarks>
- The <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.ModelMetadata"/> property must be set to access this property.
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.PropertyFilter">
- <summary>
- Gets or sets a predicate which will be evaluated for each property to determine if the property
- is eligible for model binding.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.ValidationState">
- <summary>
- Gets or sets the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateDictionary"/>. Used for tracking validation state to
- customize validation behavior for a model object.
- </summary>
- <remarks>
- The property setter is provided for unit testing purposes only.
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.ValueProvider">
- <summary>
- Gets or sets the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IValueProvider"/> associated with this context.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.Result">
- <summary>
- <para>
- Gets or sets a <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult"/> which represents the result of the model binding process.
- </para>
- <para>
- Before an <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinder"/> is called, <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.Result"/> will be set to a value indicating
- failure. The binder should set <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.Result"/> to a value created with
- <see cref="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult.Success(System.Object)"/> if model binding succeeded.
- </para>
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.EnterNestedScope(Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata,System.String,System.String,System.Object)">
- <summary>
- Pushes a layer of state onto this context. Model binders will call this as part of recursion when binding
- properties or collection items.
- </summary>
- <param name="modelMetadata">
- <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> to assign to the <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.ModelMetadata"/> property.
- </param>
- <param name="fieldName">Name to assign to the <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.FieldName"/> property.</param>
- <param name="modelName">Name to assign to the <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.ModelName"/> property.</param>
- <param name="model">Instance to assign to the <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.Model"/> property.</param>
- <returns>
- A <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.NestedScope"/> scope object which should be used in a <c>using</c> statement where
- <see cref="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.EnterNestedScope(Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata,System.String,System.String,System.Object)"/> is called.
- </returns>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.EnterNestedScope">
- <summary>
- Pushes a layer of state onto this context. Model binders will call this as part of recursion when binding
- properties or collection items.
- </summary>
- <returns>
- A <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.NestedScope"/> scope object which should be used in a <c>using</c> statement where
- <see cref="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.EnterNestedScope"/> is called.
- </returns>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.ExitNestedScope">
- <summary>
- Removes a layer of state pushed by calling <see cref="M:EnterNestedScope"/>.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.NestedScope">
- <summary>
- Return value of <see cref="M:EnterNestedScope"/>. Should be disposed
- by caller when child binding context state should be popped off of
- the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext"/>.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.NestedScope.#ctor(Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext)">
- <summary>
- Initializes the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.NestedScope"/> for a <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext"/>.
- </summary>
- <param name="context"></param>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.NestedScope.Dispose">
- <summary>
- Exits the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext.NestedScope"/> created by calling <see cref="M:EnterNestedScope"/>.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult">
- <summary>
- Contains the result of model binding.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult.Failed">
- <summary>
- Creates a <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult"/> representing a failed model binding operation.
- </summary>
- <returns>A <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult"/> representing a failed model binding operation.</returns>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult.Success(System.Object)">
- <summary>
- Creates a <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult"/> representing a successful model binding operation.
- </summary>
- <param name="model">The model value. May be <c>null.</c></param>
- <returns>A <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult"/> representing a successful model bind.</returns>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult.Model">
- <summary>
- Gets the model associated with this context.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult.IsModelSet">
- <summary>
- <para>
- Gets a value indicating whether or not the <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult.Model"/> value has been set.
- </para>
- <para>
- This property can be used to distinguish between a model binder which does not find a value and
- the case where a model binder sets the <c>null</c> value.
- </para>
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult.Equals(System.Object)">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult.GetHashCode">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult.Equals(Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult)">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult.ToString">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult.op_Equality(Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult,Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult)">
- <summary>
- Compares <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult"/> objects for equality.
- </summary>
- <param name="x">A <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult"/>.</param>
- <param name="y">A <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult"/>.</param>
- <returns><c>true</c> if the objects are equal, otherwise <c>false</c>.</returns>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult.op_Inequality(Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult,Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult)">
- <summary>
- Compares <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult"/> objects for inequality.
- </summary>
- <param name="x">A <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult"/>.</param>
- <param name="y">A <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult"/>.</param>
- <returns><c>true</c> if the objects are not equal, otherwise <c>false</c>.</returns>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata">
- <summary>
- A metadata representation of a model type, property or parameter.
- </summary>
- </member>
- <member name="F:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.DefaultOrder">
- <summary>
- The default value of <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.Order"/>.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.#ctor(Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelMetadataIdentity)">
- <summary>
- Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/>.
- </summary>
- <param name="identity">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelMetadataIdentity"/>.</param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.ContainerType">
- <summary>
- Gets the type containing the property if this metadata is for a property; <see langword="null"/> otherwise.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.ContainerMetadata">
- <summary>
- Gets the metadata for <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.ContainerType"/> if this metadata is for a property;
- <see langword="null"/> otherwise.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.MetadataKind">
- <summary>
- Gets a value indicating the kind of metadata element represented by the current instance.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.ModelType">
- <summary>
- Gets the model type represented by the current instance.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.Name">
- <summary>
- Gets the name of the parameter or property if this metadata is for a parameter or property;
- <see langword="null"/> otherwise i.e. if this is the metadata for a type.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.ParameterName">
- <summary>
- Gets the name of the parameter if this metadata is for a parameter; <see langword="null"/> otherwise.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.PropertyName">
- <summary>
- Gets the name of the property if this metadata is for a property; <see langword="null"/> otherwise.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.Identity">
- <summary>
- Gets the key for the current instance.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.AdditionalValues">
- <summary>
- Gets a collection of additional information about the model.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.Properties">
- <summary>
- Gets the collection of <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> instances for the model's properties.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.BinderModelName">
- <summary>
- Gets the name of a model if specified explicitly using <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IModelNameProvider"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.BinderType">
- <summary>
- Gets the <see cref="T:System.Type"/> of an <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinder"/> of a model if specified explicitly using
- <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IBinderTypeProviderMetadata"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.BindingSource">
- <summary>
- Gets a binder metadata for this model.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.ConvertEmptyStringToNull">
- <summary>
- Gets a value indicating whether or not to convert an empty string value or one containing only whitespace
- characters to <c>null</c> when representing a model as text.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.DataTypeName">
- <summary>
- Gets the name of the model's datatype. Overrides <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.ModelType"/> in some
- display scenarios.
- </summary>
- <value><c>null</c> unless set manually or through additional metadata e.g. attributes.</value>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.Description">
- <summary>
- Gets the description of the model.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.DisplayFormatString">
- <summary>
- Gets the format string (see https://msdn.microsoft.com/en-us/library/txafckwd.aspx) used to display the
- model.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.DisplayName">
- <summary>
- Gets the display name of the model.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.EditFormatString">
- <summary>
- Gets the format string (see https://msdn.microsoft.com/en-us/library/txafckwd.aspx) used to edit the model.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.ElementMetadata">
- <summary>
- Gets the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> for elements of <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.ModelType"/> if that <see cref="T:System.Type"/>
- implements <see cref="T:System.Collections.IEnumerable"/>.
- </summary>
- <value>
- <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> for <c>T</c> if <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.ModelType"/> implements
- <see cref="T:System.Collections.Generic.IEnumerable`1"/>. <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> for <c>object</c> if <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.ModelType"/>
- implements <see cref="T:System.Collections.IEnumerable"/> but not <see cref="T:System.Collections.Generic.IEnumerable`1"/>. <c>null</c> otherwise i.e. when
- <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.IsEnumerableType"/> is <c>false</c>.
- </value>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.EnumGroupedDisplayNamesAndValues">
- <summary>
- Gets the ordered and grouped display names and values of all <see cref="T:System.Enum"/> values in
- <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.UnderlyingOrModelType"/>.
- </summary>
- <value>
- An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:System.Collections.Generic.KeyValuePair`2"/> of mappings between
- <see cref="T:System.Enum"/> field groups, names and values. <c>null</c> if <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.IsEnum"/> is <c>false</c>.
- </value>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.EnumNamesAndValues">
- <summary>
- Gets the names and values of all <see cref="T:System.Enum"/> values in <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.UnderlyingOrModelType"/>.
- </summary>
- <value>
- An <see cref="T:System.Collections.Generic.IReadOnlyDictionary`2"/> of mappings between <see cref="T:System.Enum"/> field names
- and values. <c>null</c> if <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.IsEnum"/> is <c>false</c>.
- </value>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.HasNonDefaultEditFormat">
- <summary>
- Gets a value indicating whether <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.EditFormatString"/> has a non-<c>null</c>, non-empty
- value different from the default for the datatype.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.HtmlEncode">
- <summary>
- Gets a value indicating whether the value should be HTML-encoded.
- </summary>
- <value>If <c>true</c>, value should be HTML-encoded. Default is <c>true</c>.</value>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.HideSurroundingHtml">
- <summary>
- Gets a value indicating whether the "HiddenInput" display template should return
- <c>string.Empty</c> (not the expression value) and whether the "HiddenInput" editor template should not
- also return the expression value (together with the hidden <input> element).
- </summary>
- <remarks>
- If <c>true</c>, also causes the default <see cref="T:System.Object"/> display and editor templates to return HTML
- lacking the usual per-property <div> wrapper around the associated property. Thus the default
- <see cref="T:System.Object"/> display template effectively skips the property and the default <see cref="T:System.Object"/>
- editor template returns only the hidden <input> element for the property.
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.IsBindingAllowed">
- <summary>
- Gets a value indicating whether or not the model value can be bound by model binding. This is only
- applicable when the current instance represents a property.
- </summary>
- <remarks>
- If <c>true</c> then the model value is considered supported by model binding and can be set
- based on provided input in the request.
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.IsBindingRequired">
- <summary>
- Gets a value indicating whether or not the model value is required by model binding. This is only
- applicable when the current instance represents a property.
- </summary>
- <remarks>
- If <c>true</c> then the model value is considered required by model binding and must have a value
- supplied in the request to be considered valid.
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.IsEnum">
- <summary>
- Gets a value indicating whether <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.UnderlyingOrModelType"/> is for an <see cref="T:System.Enum"/>.
- </summary>
- <value>
- <c>true</c> if <c>type.IsEnum</c> (<c>type.GetTypeInfo().IsEnum</c> for DNX Core 5.0) is <c>true</c> for
- <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.UnderlyingOrModelType"/>; <c>false</c> otherwise.
- </value>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.IsFlagsEnum">
- <summary>
- Gets a value indicating whether <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.UnderlyingOrModelType"/> is for an <see cref="T:System.Enum"/> with an
- associated <see cref="T:System.FlagsAttribute"/>.
- </summary>
- <value>
- <c>true</c> if <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.IsEnum"/> is <c>true</c> and <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.UnderlyingOrModelType"/> has an
- associated <see cref="T:System.FlagsAttribute"/>; <c>false</c> otherwise.
- </value>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.IsReadOnly">
- <summary>
- Gets a value indicating whether or not the model value is read-only. This is only applicable when
- the current instance represents a property.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.IsRequired">
- <summary>
- Gets a value indicating whether or not the model value is required. This is only applicable when
- the current instance represents a property.
- </summary>
- <remarks>
- <para>
- If <c>true</c> then the model value is considered required by validators.
- </para>
- <para>
- By default an implicit <c>System.ComponentModel.DataAnnotations.RequiredAttribute</c> will be added
- if not present when <c>true.</c>.
- </para>
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.ModelBindingMessageProvider">
- <summary>
- Gets the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Metadata.ModelBindingMessageProvider"/> instance.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.Order">
- <summary>
- Gets a value indicating where the current metadata should be ordered relative to other properties
- in its containing type.
- </summary>
- <remarks>
- <para>For example this property is used to order items in <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.Properties"/>.</para>
- <para>The default order is <c>10000</c>.</para>
- </remarks>
- <value>The order value of the current metadata.</value>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.Placeholder">
- <summary>
- Gets the text to display as a placeholder value for an editor.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.NullDisplayText">
- <summary>
- Gets the text to display when the model is <c>null</c>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.PropertyFilterProvider">
- <summary>
- Gets the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IPropertyFilterProvider"/>, which can determine which properties
- should be model bound.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.ShowForDisplay">
- <summary>
- Gets a value that indicates whether the property should be displayed in read-only views.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.ShowForEdit">
- <summary>
- Gets a value that indicates whether the property should be displayed in editable views.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.SimpleDisplayProperty">
- <summary>
- Gets a value which is the name of the property used to display the model.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.TemplateHint">
- <summary>
- Gets a string used by the templating system to discover display-templates and editor-templates.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.PropertyValidationFilter">
- <summary>
- Gets an <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.IPropertyValidationFilter"/> implementation that indicates whether this model should be
- validated. If <c>null</c>, properties with this <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> are validated.
- </summary>
- <value>Defaults to <c>null</c>.</value>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.ValidateChildren">
- <summary>
- Gets a value that indicates whether properties or elements of the model should be validated.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.ValidatorMetadata">
- <summary>
- Gets a collection of metadata items for validators.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.ElementType">
- <summary>
- Gets the <see cref="T:System.Type"/> for elements of <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.ModelType"/> if that <see cref="T:System.Type"/>
- implements <see cref="T:System.Collections.IEnumerable"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.IsComplexType">
- <summary>
- Gets a value indicating whether <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.ModelType"/> is a complex type.
- </summary>
- <remarks>
- A complex type is defined as a <see cref="T:System.Type"/> which has a
- <see cref="T:System.ComponentModel.TypeConverter"/> that can convert from <see cref="T:System.String"/>.
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.IsNullableValueType">
- <summary>
- Gets a value indicating whether or not <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.ModelType"/> is a <see cref="T:System.Nullable`1"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.IsCollectionType">
- <summary>
- Gets a value indicating whether or not <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.ModelType"/> is a collection type.
- </summary>
- <remarks>
- A collection type is defined as a <see cref="T:System.Type"/> which is assignable to <see cref="T:System.Collections.Generic.ICollection`1"/>.
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.IsEnumerableType">
- <summary>
- Gets a value indicating whether or not <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.ModelType"/> is an enumerable type.
- </summary>
- <remarks>
- An enumerable type is defined as a <see cref="T:System.Type"/> which is assignable to
- <see cref="T:System.Collections.IEnumerable"/>, and is not a <see cref="T:System.String"/>.
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.IsReferenceOrNullableType">
- <summary>
- Gets a value indicating whether or not <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.ModelType"/> allows <c>null</c> values.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.UnderlyingOrModelType">
- <summary>
- Gets the underlying type argument if <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.ModelType"/> inherits from <see cref="T:System.Nullable`1"/>.
- Otherwise gets <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.ModelType"/>.
- </summary>
- <remarks>
- Identical to <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.ModelType"/> unless <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.IsNullableValueType"/> is <c>true</c>.
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.PropertyGetter">
- <summary>
- Gets a property getter delegate to get the property value from a model object.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.PropertySetter">
- <summary>
- Gets a property setter delegate to set the property value on a model object.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.GetDisplayName">
- <summary>
- Gets a display name for the model.
- </summary>
- <remarks>
- <see cref="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.GetDisplayName"/> will return the first of the following expressions which has a
- non-<see langword="null"/> value: <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.DisplayName"/>, <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.Name"/>, or <c>ModelType.Name</c>.
- </remarks>
- <returns>The display name.</returns>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.Equals(Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata)">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.Equals(System.Object)">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.GetHashCode">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.GetMetadataForType(System.Type)">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.GetMetadataForProperties(System.Type)">
- <inheritdoc />
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadataProvider">
- <summary>
- A provider that can supply instances of <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/>.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadataProvider.GetMetadataForProperties(System.Type)">
- <summary>
- Supplies metadata describing the properties of a <see cref="T:System.Type"/>.
- </summary>
- <param name="modelType">The <see cref="T:System.Type"/>.</param>
- <returns>A set of <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> instances describing properties of the <see cref="T:System.Type"/>.</returns>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadataProvider.GetMetadataForType(System.Type)">
- <summary>
- Supplies metadata describing a <see cref="T:System.Type"/>.
- </summary>
- <param name="modelType">The <see cref="T:System.Type"/>.</param>
- <returns>A <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> instance describing the <see cref="T:System.Type"/>.</returns>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadataProvider.GetMetadataForParameter(System.Reflection.ParameterInfo)">
- <summary>
- Supplies metadata describing a parameter.
- </summary>
- <param name="parameter">The <see cref="T:System.Reflection.ParameterInfo"/>.</param>
- <returns>A <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> instance describing the <paramref name="parameter"/>.</returns>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelPropertyCollection">
- <summary>
- A read-only collection of <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> objects which represent model properties.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelPropertyCollection.#ctor(System.Collections.Generic.IEnumerable{Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata})">
- <summary>
- Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelPropertyCollection"/>.
- </summary>
- <param name="properties">The properties.</param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelPropertyCollection.Item(System.String)">
- <summary>
- Gets a <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> instance for the property corresponding to <paramref name="propertyName"/>.
- </summary>
- <param name="propertyName">
- The property name. Property names are compared using <see cref="F:System.StringComparison.Ordinal"/>.
- </param>
- <returns>
- The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> instance for the property specified by <paramref name="propertyName"/>, or
- <c>null</c> if no match can be found.
- </returns>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary">
- <summary>
- Represents the state of an attempt to bind values from an HTTP Request to an action method, which includes
- validation information.
- </summary>
- </member>
- <member name="F:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.DefaultMaxAllowedErrors">
- <summary>
- The default value for <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.MaxAllowedErrors"/> of <c>200</c>.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> class.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> class.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.#ctor(Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> class by using values that are copied
- from the specified <paramref name="dictionary"/>.
- </summary>
- <param name="dictionary">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> to copy values from.</param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.Root">
- <summary>
- Root entry for the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.MaxAllowedErrors">
- <summary>
- Gets or sets the maximum allowed model state errors in this instance of <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/>.
- Defaults to <c>200</c>.
- </summary>
- <remarks>
- <para>
- <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> tracks the number of model errors added by calls to
- <see cref="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.AddModelError(System.String,System.Exception,Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata)"/> or
- <see cref="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.TryAddModelError(System.String,System.Exception,Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata)"/>.
- Once the value of <code>MaxAllowedErrors - 1</code> is reached, if another attempt is made to add an error,
- the error message will be ignored and a <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.TooManyModelErrorsException"/> will be added.
- </para>
- <para>
- Errors added via modifying <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry"/> directly do not count towards this limit.
- </para>
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.HasReachedMaxErrors">
- <summary>
- Gets a value indicating whether or not the maximum number of errors have been
- recorded.
- </summary>
- <remarks>
- Returns <c>true</c> if a <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.TooManyModelErrorsException"/> has been recorded;
- otherwise <c>false</c>.
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.ErrorCount">
- <summary>
- Gets the number of errors added to this instance of <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> via
- <see cref="M:AddModelError"/> or <see cref="M:TryAddModelError"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.Count">
- <inheritdoc />
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.Keys">
- <summary>
- Gets the key sequence.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.System#Collections#Generic#IReadOnlyDictionary{System#String,Microsoft#AspNetCore#Mvc#ModelBinding#ModelStateEntry}#Keys">
- <inheritdoc />
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.Values">
- <summary>
- Gets the value sequence.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.System#Collections#Generic#IReadOnlyDictionary{System#String,Microsoft#AspNetCore#Mvc#ModelBinding#ModelStateEntry}#Values">
- <inheritdoc />
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.IsValid">
- <summary>
- Gets a value that indicates whether any model state values in this model state dictionary is invalid or not validated.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.ValidationState">
- <inheritdoc />
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.Item(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.TryAddModelException(System.String,System.Exception)">
- <summary>
- Adds the specified <paramref name="exception"/> to the <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry.Errors"/> instance
- that is associated with the specified <paramref name="key"/>. If the maximum number of allowed
- errors has already been recorded, ensures that a <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.TooManyModelErrorsException"/> exception is
- recorded instead.
- </summary>
- <remarks>
- This method allows adding the <paramref name="exception"/> to the current <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/>
- when <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> is not available or the exact <paramref name="exception"/>
- must be maintained for later use (even if it is for example a <see cref="T:System.FormatException"/>).
- Where <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> is available, use <see cref="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.AddModelError(System.String,System.Exception,Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata)"/> instead.
- </remarks>
- <param name="key">The key of the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry"/> to add errors to.</param>
- <param name="exception">The <see cref="T:System.Exception"/> to add.</param>
- <returns>
- <c>True</c> if the given error was added, <c>false</c> if the error was ignored.
- See <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.MaxAllowedErrors"/>.
- </returns>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.AddModelError(System.String,System.Exception,Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata)">
- <summary>
- Adds the specified <paramref name="exception"/> to the <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry.Errors"/> instance
- that is associated with the specified <paramref name="key"/>. If the maximum number of allowed
- errors has already been recorded, ensures that a <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.TooManyModelErrorsException"/> exception is
- recorded instead.
- </summary>
- <param name="key">The key of the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry"/> to add errors to.</param>
- <param name="exception">The <see cref="T:System.Exception"/> to add. Some exception types will be replaced with
- a descriptive error message.</param>
- <param name="metadata">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> associated with the model.</param>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.TryAddModelError(System.String,System.Exception,Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata)">
- <summary>
- Attempts to add the specified <paramref name="exception"/> to the <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry.Errors"/>
- instance that is associated with the specified <paramref name="key"/>. If the maximum number of allowed
- errors has already been recorded, ensures that a <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.TooManyModelErrorsException"/> exception is
- recorded instead.
- </summary>
- <param name="key">The key of the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry"/> to add errors to.</param>
- <param name="exception">The <see cref="T:System.Exception"/> to add. Some exception types will be replaced with
- a descriptive error message.</param>
- <param name="metadata">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> associated with the model.</param>
- <returns>
- <c>True</c> if the given error was added, <c>false</c> if the error was ignored.
- See <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.MaxAllowedErrors"/>.
- </returns>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.AddModelError(System.String,System.String)">
- <summary>
- Adds the specified <paramref name="errorMessage"/> to the <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry.Errors"/> instance
- that is associated with the specified <paramref name="key"/>. If the maximum number of allowed
- errors has already been recorded, ensures that a <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.TooManyModelErrorsException"/> exception is
- recorded instead.
- </summary>
- <param name="key">The key of the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry"/> to add errors to.</param>
- <param name="errorMessage">The error message to add.</param>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.TryAddModelError(System.String,System.String)">
- <summary>
- Attempts to add the specified <paramref name="errorMessage"/> to the <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry.Errors"/>
- instance that is associated with the specified <paramref name="key"/>. If the maximum number of allowed
- errors has already been recorded, ensures that a <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.TooManyModelErrorsException"/> exception is
- recorded instead.
- </summary>
- <param name="key">The key of the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry"/> to add errors to.</param>
- <param name="errorMessage">The error message to add.</param>
- <returns>
- <c>True</c> if the given error was added, <c>false</c> if the error was ignored.
- See <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.MaxAllowedErrors"/>.
- </returns>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.GetFieldValidationState(System.String)">
- <summary>
- Returns the aggregate <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelValidationState"/> for items starting with the
- specified <paramref name="key"/>.
- </summary>
- <param name="key">The key to look up model state errors for.</param>
- <returns>Returns <see cref="F:Microsoft.AspNetCore.Mvc.ModelBinding.ModelValidationState.Unvalidated"/> if no entries are found for the specified
- key, <see cref="F:Microsoft.AspNetCore.Mvc.ModelBinding.ModelValidationState.Invalid"/> if at least one instance is found with one or more model
- state errors; <see cref="F:Microsoft.AspNetCore.Mvc.ModelBinding.ModelValidationState.Valid"/> otherwise.</returns>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.GetValidationState(System.String)">
- <summary>
- Returns <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelValidationState"/> for the <paramref name="key"/>.
- </summary>
- <param name="key">The key to look up model state errors for.</param>
- <returns>Returns <see cref="F:Microsoft.AspNetCore.Mvc.ModelBinding.ModelValidationState.Unvalidated"/> if no entry is found for the specified
- key, <see cref="F:Microsoft.AspNetCore.Mvc.ModelBinding.ModelValidationState.Invalid"/> if an instance is found with one or more model
- state errors; <see cref="F:Microsoft.AspNetCore.Mvc.ModelBinding.ModelValidationState.Valid"/> otherwise.</returns>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.MarkFieldValid(System.String)">
- <summary>
- Marks the <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry.ValidationState"/> for the entry with the specified
- <paramref name="key"/> as <see cref="F:Microsoft.AspNetCore.Mvc.ModelBinding.ModelValidationState.Valid"/>.
- </summary>
- <param name="key">The key of the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry"/> to mark as valid.</param>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.MarkFieldSkipped(System.String)">
- <summary>
- Marks the <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry.ValidationState"/> for the entry with the specified <paramref name="key"/>
- as <see cref="F:Microsoft.AspNetCore.Mvc.ModelBinding.ModelValidationState.Skipped"/>.
- </summary>
- <param name="key">The key of the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry"/> to mark as skipped.</param>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.Merge(Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary)">
- <summary>
- Copies the values from the specified <paramref name="dictionary"/> into this instance, overwriting
- existing values if keys are the same.
- </summary>
- <param name="dictionary">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> to copy values from.</param>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.SetModelValue(System.String,System.Object,System.String)">
- <summary>
- Sets the of <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry.RawValue"/> and <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry.AttemptedValue"/> for
- the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry"/> with the specified <paramref name="key"/>.
- </summary>
- <param name="key">The key for the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry"/> entry.</param>
- <param name="rawValue">The raw value for the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry"/> entry.</param>
- <param name="attemptedValue">
- The values of <paramref name="rawValue"/> in a comma-separated <see cref="T:System.String"/>.
- </param>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.SetModelValue(System.String,Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult)">
- <summary>
- Sets the value for the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry"/> with the specified <paramref name="key"/>.
- </summary>
- <param name="key">The key for the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry"/> entry</param>
- <param name="valueProviderResult">
- A <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult"/> with data for the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry"/> entry.
- </param>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.ClearValidationState(System.String)">
- <summary>
- Clears <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> entries that match the key that is passed as parameter.
- </summary>
- <param name="key">The key of <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> to clear.</param>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.Clear">
- <summary>
- Removes all keys and values from this instance of <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/>.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.ContainsKey(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.Remove(System.String)">
- <summary>
- Removes the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry"/> with the specified <paramref name="key"/>.
- </summary>
- <param name="key">The key.</param>
- <returns><c>true</c> if the element is successfully removed; otherwise <c>false</c>. This method also
- returns <c>false</c> if key was not found.</returns>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.TryGetValue(System.String,Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry@)">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.GetEnumerator">
- <summary>
- Returns an enumerator that iterates through this instance of <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/>.
- </summary>
- <returns>An <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.Enumerator"/>.</returns>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.System#Collections#Generic#IEnumerable{System#Collections#Generic#KeyValuePair{System#String,Microsoft#AspNetCore#Mvc#ModelBinding#ModelStateEntry}}#GetEnumerator">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary.System#Collections#IEnumerable#GetEnumerator">
- <inheritdoc />
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry">
- <summary>
- An entry in a <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry.RawValue">
- <summary>
- Gets the raw value from the request associated with this entry.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry.AttemptedValue">
- <summary>
- Gets the set of values contained in <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry.RawValue"/>, joined into a comma-separated string.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry.Errors">
- <summary>
- Gets the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelErrorCollection"/> for this entry.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry.ValidationState">
- <summary>
- Gets or sets the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelValidationState"/> for this entry.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry.IsContainerNode">
- <summary>
- Gets a value that determines if the current instance of <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry"/> is a container node.
- Container nodes represent prefix nodes that aren't explicitly added to the
- <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/>.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry.GetModelStateForProperty(System.String)">
- <summary>
- Gets the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry"/> for a sub-property with the specified
- <paramref name="propertyName"/>.
- </summary>
- <param name="propertyName">The property name to lookup.</param>
- <returns>
- The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry"/> if a sub-property was found; otherwise <see langword="null"/>.
- </returns>
- <remarks>
- This method returns any existing entry, even those with <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry.IsContainerNode"/> with value
- <see langword="true"/>.
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry.Children">
- <summary>
- Gets the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry"/> values for sub-properties.
- </summary>
- <remarks>
- This property returns all existing entries, even those with <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateEntry.IsContainerNode"/> with value
- <see langword="true"/>.
- </remarks>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.TooManyModelErrorsException">
- <summary>
- The <see cref="T:System.Exception"/> that is thrown when too many model errors are encountered.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.TooManyModelErrorsException.#ctor(System.String)">
- <summary>
- Creates a new instance of <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.TooManyModelErrorsException"/> with the specified
- exception <paramref name="message"/>.
- </summary>
- <param name="message">The message that describes the error.</param>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientModelValidationContext">
- <summary>
- The context for client-side model validation.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientModelValidationContext.#ctor(Microsoft.AspNetCore.Mvc.ActionContext,Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata,Microsoft.AspNetCore.Mvc.ModelBinding.IModelMetadataProvider,System.Collections.Generic.IDictionary{System.String,System.String})">
- <summary>
- Create a new instance of <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientModelValidationContext"/>.
- </summary>
- <param name="actionContext">The <see cref="T:Microsoft.AspNetCore.Mvc.ActionContext"/> for validation.</param>
- <param name="metadata">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> for validation.</param>
- <param name="metadataProvider">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IModelMetadataProvider"/> to be used in validation.</param>
- <param name="attributes">The attributes dictionary for the HTML tag being rendered.</param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientModelValidationContext.Attributes">
- <summary>
- Gets the attributes dictionary for the HTML tag being rendered.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientValidatorItem">
- <summary>
- Used to associate validators with <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientValidatorItem.ValidatorMetadata"/> instances
- as part of <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientValidatorProviderContext"/>. An <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.IClientModelValidator"/> should
- inspect <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientValidatorProviderContext.Results"/> and set <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientValidatorItem.Validator"/> and
- <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientValidatorItem.IsReusable"/> as appropriate.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientValidatorItem.#ctor">
- <summary>
- Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientValidatorItem"/>.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientValidatorItem.#ctor(System.Object)">
- <summary>
- Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientValidatorItem"/>.
- </summary>
- <param name="validatorMetadata">The <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientValidatorItem.ValidatorMetadata"/>.</param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientValidatorItem.ValidatorMetadata">
- <summary>
- Gets the metadata associated with the <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientValidatorItem.Validator"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientValidatorItem.Validator">
- <summary>
- Gets or sets the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.IClientModelValidator"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientValidatorItem.IsReusable">
- <summary>
- Gets or sets a value indicating whether or not <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientValidatorItem.Validator"/> can be reused across requests.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientValidatorProviderContext">
- <summary>
- A context for <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.IClientModelValidatorProvider"/>.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientValidatorProviderContext.#ctor(Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata,System.Collections.Generic.IList{Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientValidatorItem})">
- <summary>
- Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientValidatorProviderContext"/>.
- </summary>
- <param name="modelMetadata">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> for the model being validated.
- </param>
- <param name="items">The list of <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientValidatorItem"/>s.</param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientValidatorProviderContext.ModelMetadata">
- <summary>
- Gets the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientValidatorProviderContext.ValidatorMetadata">
- <summary>
- Gets the validator metadata.
- </summary>
- <remarks>
- This property provides convenience access to <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.ValidatorMetadata"/>.
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientValidatorProviderContext.Results">
- <summary>
- Gets the list of <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientValidatorItem"/> instances. <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.IClientModelValidatorProvider"/>
- instances should add the appropriate <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientValidatorItem.Validator"/> properties when
- <see cref="M:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.IClientModelValidatorProvider.CreateValidators(Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientValidatorProviderContext)"/>
- is called.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.IClientModelValidatorProvider">
- <summary>
- Provides a collection of <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.IClientModelValidator"/>s.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.IClientModelValidatorProvider.CreateValidators(Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientValidatorProviderContext)">
- <summary>
- Creates set of <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.IClientModelValidator"/>s by updating
- <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientValidatorItem.Validator"/> in <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientValidatorProviderContext.Results"/>.
- </summary>
- <param name="context">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientModelValidationContext"/> associated with this call.</param>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.IModelValidator">
- <summary>
- Validates a model value.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.IModelValidator.Validate(Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ModelValidationContext)">
- <summary>
- Validates the model value.
- </summary>
- <param name="context">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ModelValidationContext"/>.</param>
- <returns>
- A list of <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ModelValidationResult"/> indicating the results of validating the model value.
- </returns>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.IModelValidatorProvider">
- <summary>
- Provides validators for a model value.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.IModelValidatorProvider.CreateValidators(Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ModelValidatorProviderContext)">
- <summary>
- Creates the validators for <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ModelValidatorProviderContext.ModelMetadata"/>.
- </summary>
- <param name="context">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ModelValidatorProviderContext"/>.</param>
- <remarks>
- Implementations should add the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.IModelValidator"/> instances to the appropriate
- <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidatorItem"/> instance which should be added to
- <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ModelValidatorProviderContext.Results"/>.
- </remarks>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.IPropertyValidationFilter">
- <summary>
- Contract for attributes that determine whether associated properties should be validated. When the attribute is
- applied to a property, the validation system calls <see cref="M:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.IPropertyValidationFilter.ShouldValidateEntry(Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationEntry,Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationEntry)"/> to determine whether to
- validate that property. When applied to a type, the validation system calls <see cref="M:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.IPropertyValidationFilter.ShouldValidateEntry(Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationEntry,Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationEntry)"/>
- for each property that type defines to determine whether to validate it.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.IPropertyValidationFilter.ShouldValidateEntry(Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationEntry,Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationEntry)">
- <summary>
- Gets an indication whether the <paramref name="entry"/> should be validated.
- </summary>
- <param name="entry"><see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationEntry"/> to check.</param>
- <param name="parentEntry"><see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationEntry"/> containing <paramref name="entry"/>.</param>
- <returns><c>true</c> if <paramref name="entry"/> should be validated; <c>false</c> otherwise.</returns>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.IValidationStrategy">
- <summary>
- Defines a strategy for enumerating the child entries of a model object which should be validated.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.IValidationStrategy.GetChildren(Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata,System.String,System.Object)">
- <summary>
- Gets an <see cref="T:System.Collections.Generic.IEnumerator`1"/> containing a <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationEntry"/> for
- each child entry of the model object to be validated.
- </summary>
- <param name="metadata">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> associated with <paramref name="model"/>.</param>
- <param name="key">The model prefix associated with <paramref name="model"/>.</param>
- <param name="model">The model object.</param>
- <returns>An <see cref="T:System.Collections.Generic.IEnumerator`1"/>.</returns>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ModelValidationContext">
- <summary>
- A context object for <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.IModelValidator"/>.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ModelValidationContext.#ctor(Microsoft.AspNetCore.Mvc.ActionContext,Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata,Microsoft.AspNetCore.Mvc.ModelBinding.IModelMetadataProvider,System.Object,System.Object)">
- <summary>
- Create a new instance of <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ModelValidationContext"/>.
- </summary>
- <param name="actionContext">The <see cref="T:Microsoft.AspNetCore.Mvc.ActionContext"/> for validation.</param>
- <param name="modelMetadata">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> for validation.</param>
- <param name="metadataProvider">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IModelMetadataProvider"/> to be used in validation.</param>
- <param name="container">The model container.</param>
- <param name="model">The model to be validated.</param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ModelValidationContext.Model">
- <summary>
- Gets the model object.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ModelValidationContext.Container">
- <summary>
- Gets the model container object.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ModelValidationContextBase">
- <summary>
- A common base class for <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ModelValidationContext"/> and <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ClientModelValidationContext"/>.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ModelValidationContextBase.#ctor(Microsoft.AspNetCore.Mvc.ActionContext,Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata,Microsoft.AspNetCore.Mvc.ModelBinding.IModelMetadataProvider)">
- <summary>
- Instantiates a new <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ModelValidationContextBase"/>.
- </summary>
- <param name="actionContext">The <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ModelValidationContextBase.ActionContext"/> for this context.</param>
- <param name="modelMetadata">The <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ModelValidationContextBase.ModelMetadata"/> for this model.</param>
- <param name="metadataProvider">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IModelMetadataProvider"/> to be used by this context.</param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ModelValidationContextBase.ActionContext">
- <summary>
- Gets the <see cref="T:Microsoft.AspNetCore.Mvc.ActionContext"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ModelValidationContextBase.ModelMetadata">
- <summary>
- Gets the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ModelValidationContextBase.MetadataProvider">
- <summary>
- Gets the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IModelMetadataProvider"/>.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ModelValidatorProviderContext">
- <summary>
- A context for <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.IModelValidatorProvider"/>.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ModelValidatorProviderContext.#ctor(Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata,System.Collections.Generic.IList{Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidatorItem})">
- <summary>
- Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ModelValidatorProviderContext"/>.
- </summary>
- <param name="modelMetadata">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/>.</param>
- <param name="items">The list of <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidatorItem"/>s.</param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ModelValidatorProviderContext.ModelMetadata">
- <summary>
- Gets the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ModelValidatorProviderContext.ValidatorMetadata">
- <summary>
- Gets the validator metadata.
- </summary>
- <remarks>
- This property provides convenience access to <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.ValidatorMetadata"/>.
- </remarks>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ModelValidatorProviderContext.Results">
- <summary>
- Gets the list of <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidatorItem"/> instances. <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.IModelValidatorProvider"/> instances
- should add the appropriate <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidatorItem.Validator"/> properties when
- <see cref="M:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.IModelValidatorProvider.CreateValidators(Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ModelValidatorProviderContext)"/>
- is called.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationEntry">
- <summary>
- Contains data needed for validating a child entry of a model object. See <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.IValidationStrategy"/>.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationEntry.#ctor(Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata,System.String,System.Object)">
- <summary>
- Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationEntry"/>.
- </summary>
- <param name="metadata">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> associated with <paramref name="model"/>.</param>
- <param name="key">The model prefix associated with <paramref name="model"/>.</param>
- <param name="model">The model object.</param>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationEntry.#ctor(Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata,System.String,System.Func{System.Object})">
- <summary>
- Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationEntry"/>.
- </summary>
- <param name="metadata">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> associated with the <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationEntry.Model"/>.</param>
- <param name="key">The model prefix associated with the <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationEntry.Model"/>.</param>
- <param name="modelAccessor">A delegate that will return the <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationEntry.Model"/>.</param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationEntry.Key">
- <summary>
- The model prefix associated with <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationEntry.Model"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationEntry.Metadata">
- <summary>
- The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> associated with <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationEntry.Model"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationEntry.Model">
- <summary>
- The model object.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateDictionary">
- <summary>
- Used for tracking validation state to customize validation behavior for a model object.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateDictionary.#ctor">
- <summary>
- Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateDictionary"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateDictionary.Item(System.Object)">
- <inheritdoc />
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateDictionary.Count">
- <inheritdoc />
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateDictionary.IsReadOnly">
- <inheritdoc />
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateDictionary.Keys">
- <inheritdoc />
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateDictionary.Values">
- <inheritdoc />
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateDictionary.System#Collections#Generic#IReadOnlyDictionary{System#Object,Microsoft#AspNetCore#Mvc#ModelBinding#Validation#ValidationStateEntry}#Keys">
- <inheritdoc />
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateDictionary.System#Collections#Generic#IReadOnlyDictionary{System#Object,Microsoft#AspNetCore#Mvc#ModelBinding#Validation#ValidationStateEntry}#Values">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateDictionary.Add(System.Collections.Generic.KeyValuePair{System.Object,Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateEntry})">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateDictionary.Add(System.Object,Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateEntry)">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateDictionary.Clear">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateDictionary.Contains(System.Collections.Generic.KeyValuePair{System.Object,Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateEntry})">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateDictionary.ContainsKey(System.Object)">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateDictionary.CopyTo(System.Collections.Generic.KeyValuePair{System.Object,Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateEntry}[],System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateDictionary.GetEnumerator">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateDictionary.Remove(System.Collections.Generic.KeyValuePair{System.Object,Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateEntry})">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateDictionary.Remove(System.Object)">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateDictionary.TryGetValue(System.Object,Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateEntry@)">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateDictionary.System#Collections#IEnumerable#GetEnumerator">
- <inheritdoc />
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateEntry">
- <summary>
- An entry in a <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateDictionary"/>. Records state information to override the default
- behavior of validation for an object.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateEntry.Key">
- <summary>
- Gets or sets the model prefix associated with the entry.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateEntry.Metadata">
- <summary>
- Gets or sets the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata"/> associated with the entry.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateEntry.SuppressValidation">
- <summary>
- Gets or sets a value indicating whether the associated model object should be validated.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationStateEntry.Strategy">
- <summary>
- Gets or sets an <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.IValidationStrategy"/> for enumerating child entries of the associated
- model object.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidatorItem">
- <summary>
- Used to associate validators with <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidatorItem.ValidatorMetadata"/> instances
- as part of <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ModelValidatorProviderContext"/>. An <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.IModelValidator"/> should
- inspect <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ModelValidatorProviderContext.Results"/> and set <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidatorItem.Validator"/> and
- <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidatorItem.IsReusable"/> as appropriate.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidatorItem.#ctor">
- <summary>
- Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidatorItem"/>.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidatorItem.#ctor(System.Object)">
- <summary>
- Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidatorItem"/>.
- </summary>
- <param name="validatorMetadata">The <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidatorItem.ValidatorMetadata"/>.</param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidatorItem.ValidatorMetadata">
- <summary>
- Gets the metadata associated with the <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidatorItem.Validator"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidatorItem.Validator">
- <summary>
- Gets or sets the <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.IModelValidator"/>.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidatorItem.IsReusable">
- <summary>
- Gets or sets a value indicating whether or not <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidatorItem.Validator"/> can be reused across requests.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderFactoryContext">
- <summary>
- A context for <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IValueProviderFactory"/>.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderFactoryContext.#ctor(Microsoft.AspNetCore.Mvc.ActionContext)">
- <summary>
- Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderFactoryContext"/>.
- </summary>
- <param name="context">The <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderFactoryContext.ActionContext"/>.</param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderFactoryContext.ActionContext">
- <summary>
- Gets the <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderFactoryContext.ActionContext"/> associated with this context.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderFactoryContext.ValueProviders">
- <summary>
- Gets the list of <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IValueProvider"/> instances.
- <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IValueProviderFactory"/> instances should add the appropriate
- <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IValueProvider"/> instances to this list.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult">
- <summary>
- Result of an <see cref="M:Microsoft.AspNetCore.Mvc.ModelBinding.IValueProvider.GetValue(System.String)"/> operation.
- </summary>
- <remarks>
- <para>
- <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult"/> can represent a single submitted value or multiple submitted values.
- </para>
- <para>
- Use <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult.FirstValue"/> to consume only a single value, regardless of whether a single value or
- multiple values were submitted.
- </para>
- <para>
- Treat <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult"/> as an <see cref="T:System.Collections.Generic.IEnumerable`1"/> to consume all values,
- regardless of whether a single value or multiple values were submitted.
- </para>
- </remarks>
- </member>
- <member name="F:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult.None">
- <summary>
- A <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult"/> that represents a lack of data.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult.#ctor(Microsoft.Extensions.Primitives.StringValues)">
- <summary>
- Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult"/> using <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>.
- </summary>
- <param name="values">The submitted values.</param>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult.#ctor(Microsoft.Extensions.Primitives.StringValues,System.Globalization.CultureInfo)">
- <summary>
- Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult"/>.
- </summary>
- <param name="values">The submitted values.</param>
- <param name="culture">The <see cref="T:System.Globalization.CultureInfo"/> associated with this value.</param>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult.Culture">
- <summary>
- Gets or sets the <see cref="T:System.Globalization.CultureInfo"/> associated with the values.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult.Values">
- <summary>
- Gets or sets the values.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult.FirstValue">
- <summary>
- Gets the first value based on the order values were provided in the request. Use <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult.FirstValue"/>
- to get a single value for processing regardless of whether a single or multiple values were provided
- in the request.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult.Length">
- <summary>
- Gets the number of submitted values.
- </summary>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult.Equals(System.Object)">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult.Equals(Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult)">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult.GetHashCode">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult.ToString">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult.GetEnumerator">
- <summary>
- Gets an <see cref="T:System.Collections.Generic.IEnumerator`1"/> for this <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult"/>.
- </summary>
- <returns>An <see cref="T:System.Collections.Generic.IEnumerator`1"/>.</returns>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult.System#Collections#IEnumerable#GetEnumerator">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult.op_Explicit(Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult)~System.String">
- <summary>
- Converts the provided <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult"/> into a comma-separated string containing all
- submitted values.
- </summary>
- <param name="result">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult"/>.</param>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult.op_Explicit(Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult)~System.String[]">
- <summary>
- Converts the provided <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult"/> into a an array of <see cref="T:System.String"/> containing
- all submitted values.
- </summary>
- <param name="result">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult"/>.</param>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult.op_Equality(Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult,Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult)">
- <summary>
- Compares two <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult"/> objects for equality.
- </summary>
- <param name="x">A <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult"/>.</param>
- <param name="y">A <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult"/>.</param>
- <returns><c>true</c> if the values are equal, otherwise <c>false</c>.</returns>
- </member>
- <member name="M:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult.op_Inequality(Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult,Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult)">
- <summary>
- Compares two <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult"/> objects for inequality.
- </summary>
- <param name="x">A <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult"/>.</param>
- <param name="y">A <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ValueProviderResult"/>.</param>
- <returns><c>false</c> if the values are equal, otherwise <c>true</c>.</returns>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Routing.AttributeRouteInfo">
- <summary>
- Represents the routing information for an action that is attribute routed.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Routing.AttributeRouteInfo.Template">
- <summary>
- The route template. May be null if the action has no attribute routes.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Routing.AttributeRouteInfo.Order">
- <summary>
- Gets the order of the route associated with a given action. This property determines
- the order in which routes get executed. Routes with a lower order value are tried first. In case a route
- doesn't specify a value, it gets a default order of 0.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Routing.AttributeRouteInfo.Name">
- <summary>
- Gets the name of the route associated with a given action. This property can be used
- to generate a link by referring to the route by name instead of attempting to match a
- route by provided route data.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Routing.AttributeRouteInfo.SuppressLinkGeneration">
- <summary>
- Gets or sets a value that determines if the route entry associated with this model participates in link generation.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Routing.AttributeRouteInfo.SuppressPathMatching">
- <summary>
- Gets or sets a value that determines if the route entry associated with this model participates in path matching (inbound routing).
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Routing.UrlActionContext">
- <summary>
- Context object to be used for the URLs that <see cref="M:Microsoft.AspNetCore.Mvc.IUrlHelper.Action(Microsoft.AspNetCore.Mvc.Routing.UrlActionContext)"/> generates.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Routing.UrlActionContext.Action">
- <summary>
- The name of the action method that <see cref="M:Microsoft.AspNetCore.Mvc.IUrlHelper.Action(Microsoft.AspNetCore.Mvc.Routing.UrlActionContext)"/> uses to generate URLs.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Routing.UrlActionContext.Controller">
- <summary>
- The name of the controller that <see cref="M:Microsoft.AspNetCore.Mvc.IUrlHelper.Action(Microsoft.AspNetCore.Mvc.Routing.UrlActionContext)"/> uses to generate URLs.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Routing.UrlActionContext.Values">
- <summary>
- The object that contains the route values that <see cref="M:Microsoft.AspNetCore.Mvc.IUrlHelper.Action(Microsoft.AspNetCore.Mvc.Routing.UrlActionContext)"/>
- uses to generate URLs.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Routing.UrlActionContext.Protocol">
- <summary>
- The protocol for the URLs that <see cref="M:Microsoft.AspNetCore.Mvc.IUrlHelper.Action(Microsoft.AspNetCore.Mvc.Routing.UrlActionContext)"/> generates,
- such as "http" or "https"
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Routing.UrlActionContext.Host">
- <summary>
- The host name for the URLs that <see cref="M:Microsoft.AspNetCore.Mvc.IUrlHelper.Action(Microsoft.AspNetCore.Mvc.Routing.UrlActionContext)"/> generates.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Routing.UrlActionContext.Fragment">
- <summary>
- The fragment for the URLs that <see cref="M:Microsoft.AspNetCore.Mvc.IUrlHelper.Action(Microsoft.AspNetCore.Mvc.Routing.UrlActionContext)"/> generates.
- </summary>
- </member>
- <member name="T:Microsoft.AspNetCore.Mvc.Routing.UrlRouteContext">
- <summary>
- Context object to be used for the URLs that <see cref="M:Microsoft.AspNetCore.Mvc.IUrlHelper.RouteUrl(Microsoft.AspNetCore.Mvc.Routing.UrlRouteContext)"/> generates.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Routing.UrlRouteContext.RouteName">
- <summary>
- The name of the route that <see cref="M:Microsoft.AspNetCore.Mvc.IUrlHelper.RouteUrl(Microsoft.AspNetCore.Mvc.Routing.UrlRouteContext)"/> uses to generate URLs.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Routing.UrlRouteContext.Values">
- <summary>
- The object that contains the route values that <see cref="M:Microsoft.AspNetCore.Mvc.IUrlHelper.RouteUrl(Microsoft.AspNetCore.Mvc.Routing.UrlRouteContext)"/>
- uses to generate URLs.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Routing.UrlRouteContext.Protocol">
- <summary>
- The protocol for the URLs that <see cref="M:Microsoft.AspNetCore.Mvc.IUrlHelper.RouteUrl(Microsoft.AspNetCore.Mvc.Routing.UrlRouteContext)"/> generates,
- such as "http" or "https"
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Routing.UrlRouteContext.Host">
- <summary>
- The host name for the URLs that <see cref="M:Microsoft.AspNetCore.Mvc.IUrlHelper.RouteUrl(Microsoft.AspNetCore.Mvc.Routing.UrlRouteContext)"/> generates.
- </summary>
- </member>
- <member name="P:Microsoft.AspNetCore.Mvc.Routing.UrlRouteContext.Fragment">
- <summary>
- The fragment for the URLs that <see cref="M:Microsoft.AspNetCore.Mvc.IUrlHelper.RouteUrl(Microsoft.AspNetCore.Mvc.Routing.UrlRouteContext)"/> generates.
- </summary>
- </member>
- </members>
- </doc>
|