CefSharp.XML 345 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>CefSharp</name>
  5. </assembly>
  6. <members>
  7. <member name="T:CefSharp.CefExtension">
  8. <summary>
  9. Represents a new V8 extension to be registered.
  10. </summary>
  11. </member>
  12. <member name="M:CefSharp.CefExtension.#ctor(System.String,System.String)">
  13. <summary>
  14. Creates a new CwefExtension instance with a given name.
  15. </summary>
  16. <param name="name">Name of the CefExtension</param>
  17. <param name="javascriptCode">The javascript extension code.</param>
  18. </member>
  19. <member name="P:CefSharp.CefExtension.Name">
  20. <summary>
  21. Gets the name of the extension.
  22. </summary>
  23. </member>
  24. <member name="P:CefSharp.CefExtension.JavascriptCode">
  25. <summary>
  26. Gets the javascript extension code
  27. </summary>
  28. </member>
  29. <member name="T:CefSharp.CefFileDialogMode">
  30. <summary>
  31. CefFileDialogMode (Based on cef_file_dialog_mode_t)
  32. </summary>
  33. </member>
  34. <member name="F:CefSharp.CefFileDialogMode.Open">
  35. <summary>
  36. Requires that the file exists before allowing the user to pick it.
  37. </summary>
  38. </member>
  39. <member name="F:CefSharp.CefFileDialogMode.OpenMultiple">
  40. <summary>
  41. Like Open, but allows picking multiple files to open.
  42. </summary>
  43. </member>
  44. <member name="F:CefSharp.CefFileDialogMode.OpenFolder">
  45. <summary>
  46. Like Open, but selects a folder to open.
  47. </summary>
  48. </member>
  49. <member name="F:CefSharp.CefFileDialogMode.Save">
  50. <summary>
  51. Allows picking a nonexistent file, and prompts to overwrite if the file already exists.
  52. </summary>
  53. </member>
  54. <member name="F:CefSharp.CefFileDialogMode.TypeMask">
  55. <summary>
  56. General mask defining the bits used for the type values.
  57. </summary>
  58. </member>
  59. <member name="F:CefSharp.CefFileDialogMode.OverwritePrompt">
  60. <summary>
  61. Prompt to overwrite if the user selects an existing file with the Save dialog.
  62. </summary>
  63. </member>
  64. <member name="F:CefSharp.CefFileDialogMode.HideReadOnly">
  65. <summary>
  66. Do not display read-only files.
  67. </summary>
  68. </member>
  69. <member name="T:CefSharp.CefGeoPositionErrorCode">
  70. <summary>
  71. Geoposition error codes.
  72. </summary>
  73. </member>
  74. <member name="T:CefSharp.CefJsDialogType">
  75. <summary>
  76. Supported JavaScript dialog types.
  77. </summary>
  78. </member>
  79. <member name="T:CefSharp.CefLibraryHandle">
  80. <summary>
  81. CefLibraryHandle is a SafeHandle that Loads libcef.dll and relesases it when disposed/finalized
  82. Calls LoadLibraryEx with LoadLibraryFlags.LOAD_WITH_ALTERED_SEARCH_PATH
  83. Make sure to set settings.BrowserSubprocessPath and settings.LocalesDirPath
  84. </summary>
  85. <remarks>Adapted from http://www.pinvoke.net/default.aspx/kernel32.loadlibraryex</remarks>
  86. </member>
  87. <member name="T:CefSharp.CefLibraryHandle.LoadLibraryFlags">
  88. <summary>
  89. In general not a fan of having inline classes/enums
  90. In this case it's not something that I'd like to see exposed
  91. as it's just a helper and outside the scope of the project
  92. </summary>
  93. </member>
  94. <member name="F:CefSharp.CefMenuCommand.CustomFirst">
  95. <summary>
  96. Custom menu items originating from the renderer process. For example, plugin placeholder menu items or Flash menu items.
  97. This is the first entry
  98. </summary>
  99. </member>
  100. <member name="F:CefSharp.CefMenuCommand.CustomLast">
  101. <summary>
  102. Custom menu items originating from the renderer process. For example, plugin placeholder menu items or Flash menu items.
  103. This is the last entry
  104. </summary>
  105. </member>
  106. <member name="T:CefSharp.CefPdfPrintMarginType">
  107. <summary>
  108. Margin type for PDF printing.
  109. </summary>
  110. </member>
  111. <member name="F:CefSharp.CefPdfPrintMarginType.Default">
  112. <summary>
  113. Default margins.
  114. </summary>
  115. </member>
  116. <member name="F:CefSharp.CefPdfPrintMarginType.None">
  117. <summary>
  118. No margins.
  119. </summary>
  120. </member>
  121. <member name="F:CefSharp.CefPdfPrintMarginType.Minimum">
  122. <summary>
  123. Minimum margins
  124. </summary>
  125. </member>
  126. <member name="F:CefSharp.CefPdfPrintMarginType.Custom">
  127. <summary>
  128. Custom margins.
  129. </summary>
  130. </member>
  131. <member name="T:CefSharp.ContextMenuEditState">
  132. <summary>
  133. Supported context menu edit state bit flags.
  134. </summary>
  135. </member>
  136. <member name="T:CefSharp.ContextMenuMediaState">
  137. <summary>
  138. Supported context menu media state bit flags.
  139. </summary>
  140. </member>
  141. <member name="T:CefSharp.ContextMenuMediaType">
  142. <summary>
  143. Supported context menu media types.
  144. </summary>
  145. </member>
  146. <member name="F:CefSharp.ContextMenuMediaType.None">
  147. <summary>
  148. No special node is in context.
  149. </summary>
  150. </member>
  151. <member name="F:CefSharp.ContextMenuMediaType.Image">
  152. <summary>
  153. An image node is selected.
  154. </summary>
  155. </member>
  156. <member name="F:CefSharp.ContextMenuMediaType.Video">
  157. <summary>
  158. A video node is selected.
  159. </summary>
  160. </member>
  161. <member name="F:CefSharp.ContextMenuMediaType.Audio">
  162. <summary>
  163. An audio node is selected.
  164. </summary>
  165. </member>
  166. <member name="F:CefSharp.ContextMenuMediaType.File">
  167. <summary>
  168. A file node is selected.
  169. </summary>
  170. </member>
  171. <member name="F:CefSharp.ContextMenuMediaType.Plugin">
  172. <summary>
  173. A plugin node is selected.
  174. </summary>
  175. </member>
  176. <member name="F:CefSharp.ContextMenuType.None">
  177. <summary>
  178. No node is selected.
  179. </summary>
  180. </member>
  181. <member name="F:CefSharp.ContextMenuType.Page">
  182. <summary>
  183. The top page is selected.
  184. </summary>
  185. </member>
  186. <member name="F:CefSharp.ContextMenuType.Frame">
  187. <summary>
  188. A subframe page is selected.
  189. </summary>
  190. </member>
  191. <member name="F:CefSharp.ContextMenuType.Link">
  192. <summary>
  193. A link is selected.
  194. </summary>
  195. </member>
  196. <member name="F:CefSharp.ContextMenuType.Media">
  197. <summary>
  198. A media node is selected.
  199. </summary>
  200. </member>
  201. <member name="F:CefSharp.ContextMenuType.Selection">
  202. <summary>
  203. There is a textual or mixed selection that is selected.
  204. </summary>
  205. </member>
  206. <member name="F:CefSharp.ContextMenuType.Editable">
  207. <summary>
  208. An editable element is selected.
  209. </summary>
  210. </member>
  211. <member name="T:CefSharp.DomNode">
  212. <summary>
  213. Represents a node in the browser's DOM.
  214. </summary>
  215. </member>
  216. <member name="T:CefSharp.IDomNode">
  217. <summary>
  218. Represents the tag name and attribute data belonging to a node in the
  219. browser's DOM.
  220. </summary>
  221. </member>
  222. <member name="M:CefSharp.IDomNode.HasAttribute(System.String)">
  223. <summary>
  224. Determine if the DomNode has the requested attribute.
  225. </summary>
  226. <param name="attributeName">
  227. The name of the attribute value.
  228. </param>
  229. <returns>
  230. True if the attribute exists in the DomNode, false if it does not.
  231. </returns>
  232. </member>
  233. <member name="P:CefSharp.IDomNode.Item(System.String)">
  234. <summary>
  235. Get the value of an attribute.
  236. </summary>
  237. <param name="attributeName">
  238. The name of the attribute value to get.
  239. </param>
  240. <returns>
  241. The attribute value if the name exists in the DomNode's attributes.
  242. Null if the name does not exist.
  243. </returns>
  244. </member>
  245. <member name="P:CefSharp.IDomNode.TagName">
  246. <summary>
  247. The name of the HTML element.
  248. </summary>
  249. </member>
  250. <member name="P:CefSharp.IDomNode.AttributeNames">
  251. <summary>
  252. Get a read only list of the attribute names.
  253. </summary>
  254. </member>
  255. <member name="T:CefSharp.DraggableRegion">
  256. <summary>
  257. Representing a draggable region.
  258. </summary>
  259. </member>
  260. <member name="M:CefSharp.DraggableRegion.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean)">
  261. <summary>
  262. Creates a new DraggableRegion
  263. </summary>
  264. <param name="width">width</param>
  265. <param name="height">height</param>
  266. <param name="x">x coordinate</param>
  267. <param name="y">y coordinate</param>
  268. <param name="draggable">is draggable?</param>
  269. </member>
  270. <member name="P:CefSharp.DraggableRegion.Width">
  271. <summary>
  272. Width
  273. </summary>
  274. </member>
  275. <member name="P:CefSharp.DraggableRegion.Height">
  276. <summary>
  277. Height
  278. </summary>
  279. </member>
  280. <member name="P:CefSharp.DraggableRegion.X">
  281. <summary>
  282. X coordinate
  283. </summary>
  284. </member>
  285. <member name="P:CefSharp.DraggableRegion.Y">
  286. <summary>
  287. Y coordinate
  288. </summary>
  289. </member>
  290. <member name="P:CefSharp.DraggableRegion.Draggable">
  291. <summary>
  292. Is this region draggable
  293. </summary>
  294. </member>
  295. <member name="T:CefSharp.FilterStatus">
  296. <summary>
  297. Return values for IResponseFilter
  298. </summary>
  299. </member>
  300. <member name="F:CefSharp.FilterStatus.NeedMoreData">
  301. <summary>
  302. Some or all of the pre-filter data was read successfully but more data is
  303. needed in order to continue filtering (filtered output is pending).
  304. </summary>
  305. </member>
  306. <member name="F:CefSharp.FilterStatus.Done">
  307. <summary>
  308. Some or all of the pre-filter data was read successfully and all available filtered output has been written.
  309. </summary>
  310. </member>
  311. <member name="F:CefSharp.FilterStatus.Error">
  312. <summary>
  313. An error occurred during filtering.
  314. </summary>
  315. </member>
  316. <member name="T:CefSharp.Geoposition">
  317. <summary>
  318. Structure representing geoposition information. The properties of this
  319. structure correspond to those of the JavaScript Position object although
  320. their types may differ.
  321. </summary>
  322. </member>
  323. <member name="P:CefSharp.Geoposition.Latitude">
  324. <summary>
  325. Latitude in decimal degrees north (WGS84 coordinate frame).
  326. </summary>
  327. </member>
  328. <member name="P:CefSharp.Geoposition.Longitude">
  329. <summary>
  330. Longitude in decimal degrees west (WGS84 coordinate frame).
  331. </summary>
  332. </member>
  333. <member name="P:CefSharp.Geoposition.Altitude">
  334. <summary>
  335. Altitude in meters (above WGS84 datum).
  336. </summary>
  337. </member>
  338. <member name="P:CefSharp.Geoposition.AltitudeAccuracy">
  339. <summary>
  340. Accuracy of altitude in meters.
  341. </summary>
  342. </member>
  343. <member name="P:CefSharp.Geoposition.Heading">
  344. <summary>
  345. Heading in decimal degrees clockwise from true north.
  346. </summary>
  347. </member>
  348. <member name="P:CefSharp.Geoposition.Speed">
  349. <summary>
  350. Horizontal component of device velocity in meters per second.
  351. </summary>
  352. </member>
  353. <member name="P:CefSharp.Geoposition.Timestamp">
  354. <summary>
  355. Time of position measurement in miliseconds since Epoch in UTC time. This
  356. is taken from the host computer's system clock.
  357. </summary>
  358. </member>
  359. <member name="P:CefSharp.Geoposition.ErrorCode">
  360. <summary>
  361. Error code, see enum above.
  362. </summary>
  363. </member>
  364. <member name="P:CefSharp.Geoposition.ErrorMessage">
  365. <summary>
  366. Human-readable error message.
  367. </summary>
  368. </member>
  369. <member name="T:CefSharp.IBrowserSettings">
  370. <summary>
  371. Interface representing browser initialization settings.
  372. </summary>
  373. </member>
  374. <member name="P:CefSharp.IBrowserSettings.StandardFontFamily">
  375. <summary>
  376. StandardFontFamily
  377. </summary>
  378. </member>
  379. <member name="P:CefSharp.IBrowserSettings.FixedFontFamily">
  380. <summary>
  381. FixedFontFamily
  382. </summary>
  383. </member>
  384. <member name="P:CefSharp.IBrowserSettings.SerifFontFamily">
  385. <summary>
  386. SerifFontFamily
  387. </summary>
  388. </member>
  389. <member name="P:CefSharp.IBrowserSettings.SansSerifFontFamily">
  390. <summary>
  391. SansSerifFontFamily
  392. </summary>
  393. </member>
  394. <member name="P:CefSharp.IBrowserSettings.CursiveFontFamily">
  395. <summary>
  396. CursiveFontFamily
  397. </summary>
  398. </member>
  399. <member name="P:CefSharp.IBrowserSettings.FantasyFontFamily">
  400. <summary>
  401. FantasyFontFamily
  402. </summary>
  403. </member>
  404. <member name="P:CefSharp.IBrowserSettings.DefaultFontSize">
  405. <summary>
  406. DefaultFontSize
  407. </summary>
  408. </member>
  409. <member name="P:CefSharp.IBrowserSettings.DefaultFixedFontSize">
  410. <summary>
  411. DefaultFixedFontSize
  412. </summary>
  413. </member>
  414. <member name="P:CefSharp.IBrowserSettings.MinimumFontSize">
  415. <summary>
  416. MinimumFontSize
  417. </summary>
  418. </member>
  419. <member name="P:CefSharp.IBrowserSettings.MinimumLogicalFontSize">
  420. <summary>
  421. MinimumLogicalFontSize
  422. </summary>
  423. </member>
  424. <member name="P:CefSharp.IBrowserSettings.DefaultEncoding">
  425. <summary>
  426. Default encoding for Web content. If empty "ISO-8859-1" will be used. Also
  427. configurable using the "default-encoding" command-line switch.
  428. </summary>
  429. </member>
  430. <member name="P:CefSharp.IBrowserSettings.RemoteFonts">
  431. <summary>
  432. Controls the loading of fonts from remote sources. Also configurable using
  433. the "disable-remote-fonts" command-line switch.
  434. </summary>
  435. </member>
  436. <member name="P:CefSharp.IBrowserSettings.Javascript">
  437. <summary>
  438. Controls whether JavaScript can be executed.
  439. (Disable javascript)
  440. </summary>
  441. </member>
  442. <member name="P:CefSharp.IBrowserSettings.JavascriptOpenWindows">
  443. <summary>
  444. Controls whether JavaScript can be used for opening windows. Also
  445. configurable using the "disable-javascript-open-windows" command-line
  446. switch.
  447. </summary>
  448. </member>
  449. <member name="P:CefSharp.IBrowserSettings.JavascriptCloseWindows">
  450. <summary>
  451. Controls whether JavaScript can be used to close windows that were not
  452. opened via JavaScript. JavaScript can still be used to close windows that
  453. were opened via JavaScript. Also configurable using the
  454. "disable-javascript-close-windows" command-line switch.
  455. </summary>
  456. </member>
  457. <member name="P:CefSharp.IBrowserSettings.JavascriptAccessClipboard">
  458. <summary>
  459. Controls whether JavaScript can access the clipboard. Also configurable
  460. using the "disable-javascript-access-clipboard" command-line switch.
  461. </summary>
  462. </member>
  463. <member name="P:CefSharp.IBrowserSettings.JavascriptDomPaste">
  464. <summary>
  465. Controls whether DOM pasting is supported in the editor via
  466. execCommand("paste"). The |javascript_access_clipboard| setting must also
  467. be enabled. Also configurable using the "disable-javascript-dom-paste"
  468. command-line switch.
  469. </summary>
  470. </member>
  471. <member name="P:CefSharp.IBrowserSettings.CaretBrowsing">
  472. <summary>
  473. Controls whether the caret position will be drawn. Also configurable using
  474. the "enable-caret-browsing" command-line switch.
  475. </summary>
  476. </member>
  477. <member name="P:CefSharp.IBrowserSettings.Plugins">
  478. <summary>
  479. Controls whether any plugins will be loaded. Also configurable using the
  480. "disable-plugins" command-line switch.
  481. </summary>
  482. </member>
  483. <member name="P:CefSharp.IBrowserSettings.UniversalAccessFromFileUrls">
  484. <summary>
  485. Controls whether file URLs will have access to all URLs. Also configurable
  486. using the "allow-universal-access-from-files" command-line switch.
  487. </summary>
  488. </member>
  489. <member name="P:CefSharp.IBrowserSettings.FileAccessFromFileUrls">
  490. <summary>
  491. Controls whether file URLs will have access to other file URLs. Also
  492. configurable using the "allow-access-from-files" command-line switch.
  493. </summary>
  494. </member>
  495. <member name="P:CefSharp.IBrowserSettings.WebSecurity">
  496. <summary>
  497. Controls whether web security restrictions (same-origin policy) will be
  498. enforced. Disabling this setting is not recommend as it will allow risky
  499. security behavior such as cross-site scripting (XSS). Also configurable
  500. using the "disable-web-security" command-line switch.
  501. </summary>
  502. </member>
  503. <member name="P:CefSharp.IBrowserSettings.ImageLoading">
  504. <summary>
  505. Controls whether image URLs will be loaded from the network. A cached image
  506. will still be rendered if requested. Also configurable using the
  507. "disable-image-loading" command-line switch.
  508. </summary>
  509. </member>
  510. <member name="P:CefSharp.IBrowserSettings.ImageShrinkStandaloneToFit">
  511. <summary>
  512. Controls whether standalone images will be shrunk to fit the page. Also
  513. configurable using the "image-shrink-standalone-to-fit" command-line
  514. switch.
  515. </summary>
  516. </member>
  517. <member name="P:CefSharp.IBrowserSettings.TextAreaResize">
  518. <summary>
  519. Controls whether text areas can be resized. Also configurable using the
  520. "disable-text-area-resize" command-line switch.
  521. </summary>
  522. </member>
  523. <member name="P:CefSharp.IBrowserSettings.TabToLinks">
  524. <summary>
  525. Controls whether the tab key can advance focus to links. Also configurable
  526. using the "disable-tab-to-links" command-line switch.
  527. </summary>
  528. </member>
  529. <member name="P:CefSharp.IBrowserSettings.LocalStorage">
  530. <summary>
  531. Controls whether local storage can be used. Also configurable using the
  532. "disable-local-storage" command-line switch.
  533. </summary>
  534. </member>
  535. <member name="P:CefSharp.IBrowserSettings.Databases">
  536. <summary>
  537. Controls whether databases can be used. Also configurable using the
  538. "disable-databases" command-line switch.
  539. </summary>
  540. </member>
  541. <member name="P:CefSharp.IBrowserSettings.ApplicationCache">
  542. <summary>
  543. Controls whether the application cache can be used. Also configurable using
  544. the "disable-application-cache" command-line switch.
  545. </summary>
  546. </member>
  547. <member name="P:CefSharp.IBrowserSettings.WebGl">
  548. <summary>
  549. Controls whether WebGL can be used. Note that WebGL requires hardware
  550. support and may not work on all systems even when enabled. Also
  551. configurable using the "disable-webgl" command-line switch.
  552. </summary>
  553. </member>
  554. <member name="P:CefSharp.IBrowserSettings.BackgroundColor">
  555. <summary>
  556. Opaque background color used for the browser before a document is loaded
  557. and when no document color is specified. By default the background color
  558. will be the same as CefSettings.background_color. Only the RGB compontents
  559. of the specified value will be used. The alpha component must greater than
  560. 0 to enable use of the background color but will be otherwise ignored.
  561. </summary>
  562. </member>
  563. <member name="P:CefSharp.IBrowserSettings.AcceptLanguageList">
  564. <summary>
  565. Comma delimited ordered list of language codes without any whitespace that
  566. will be used in the "Accept-Language" HTTP header. May be overridden on a
  567. per-browser basis using the CefBrowserSettings.AcceptLanguageList value.
  568. If both values are empty then "en-US,en" will be used. Can be overridden
  569. for individual RequestContext instances via the
  570. RequestContextSettings.AcceptLanguageList value.
  571. </summary>
  572. </member>
  573. <member name="P:CefSharp.IBrowserSettings.WindowlessFrameRate">
  574. <summary>
  575. The maximum rate in frames per second (fps) that CefRenderHandler::OnPaint
  576. will be called for a windowless browser. The actual fps may be lower if
  577. the browser cannot generate frames at the requested rate. The minimum
  578. value is 1 and the maximum value is 60 (default 30). This value can also be
  579. changed dynamically via IBrowserHost.SetWindowlessFrameRate.
  580. </summary>
  581. </member>
  582. <member name="T:CefSharp.IFindHandler">
  583. <summary>
  584. Implement this interface to handle events related to find results.
  585. The methods of this class will be called on the CEF UI thread.
  586. </summary>
  587. </member>
  588. <member name="M:CefSharp.IFindHandler.OnFindResult(CefSharp.IWebBrowser,CefSharp.IBrowser,System.Int32,System.Int32,CefSharp.Rect,System.Int32,System.Boolean)">
  589. <summary>
  590. Called to report find results returned by <see cref="M:CefSharp.IBrowserHost.Find(System.Int32,System.String,System.Boolean,System.Boolean,System.Boolean)"/>
  591. </summary>
  592. <param name="browserControl">the browser control</param>
  593. <param name="browser">the browser object</param>
  594. <param name="identifier">is the identifier passed to Find()</param>
  595. <param name="count">is the number of matches currently identified</param>
  596. <param name="selectionRect">is the location of where the match was found (in window coordinates)</param>
  597. <param name="activeMatchOrdinal">is the current position in the search results</param>
  598. <param name="finalUpdate">is true if this is the last find notification.</param>
  599. </member>
  600. <member name="T:CefSharp.INavigationEntryVisitor">
  601. <summary>
  602. Callback interface for IBrowserHost.GetNavigationEntries.
  603. The methods of this class will be called on the CEF UI thread.
  604. </summary>
  605. </member>
  606. <member name="M:CefSharp.INavigationEntryVisitor.Visit(CefSharp.NavigationEntry,System.Boolean,System.Int32,System.Int32)">
  607. <summary>
  608. Method that will be executed.
  609. </summary>
  610. <param name="entry">if the navigationEntry will be invalid then </param>
  611. <param name="current">is true if this entry is the currently loaded navigation entry</param>
  612. <param name="index">is the 0-based index of this entry</param>
  613. <param name="total">is the total number of entries.</param>
  614. <returns>Return true to continue visiting entries or false to stop.</returns>
  615. </member>
  616. <member name="T:CefSharp.Internals.CommandLineArgsParser">
  617. <summary>
  618. Simple helper class used for checking/parsing command line arguments
  619. </summary>
  620. </member>
  621. <member name="T:CefSharp.IPluginHandler">
  622. <summary>
  623. Implement this interface to cancel loading of specific plugins
  624. </summary>
  625. </member>
  626. <member name="M:CefSharp.IPluginHandler.OnBeforePluginLoad(System.String,System.String,System.String,CefSharp.WebPluginInfo,CefSharp.PluginPolicy@)">
  627. <summary>
  628. Called on the CEF IO thread before a plugin instance is loaded.
  629. The default plugin policy can be set at runtime using the `--plugin-policy=[allow|detect|block]` command-line flag.
  630. </summary>
  631. <param name="mimeType">is the mime type of the plugin that will be loaded</param>
  632. <param name="url">is the content URL that the plugin will load and may be empty</param>
  633. <param name="topOriginUrl">is the URL for the top-level frame that contains the plugin</param>
  634. <param name="pluginInfo">includes additional information about the plugin that will be loaded</param>
  635. <param name="pluginPolicy">Modify and return true to change the policy.</param>
  636. <returns>Return false to use the recommended policy. Modify and return true to change the policy.</returns>
  637. </member>
  638. <member name="T:CefSharp.IRenderProcessMessageHandler">
  639. <summary>
  640. Messages sent by the render process can be handled by implementing this
  641. interface.
  642. </summary>
  643. </member>
  644. <member name="M:CefSharp.IRenderProcessMessageHandler.OnContextCreated(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame)">
  645. <summary>
  646. OnContextCreated is called in the Render process immediately after a CefV8Context is created.
  647. An IPC message is immediately sent to notify the context has been created
  648. (should be safe to execute javascript). If the page has no javascript then on context will be created
  649. and as a result this method will not be called. Currently only called for the Main frame <see cref="P:CefSharp.IFrame.IsMain"/>
  650. </summary>
  651. <param name="browserControl">The ChromiumWebBrowser control</param>
  652. <param name="browser">the browser object</param>
  653. <param name="frame">The frame.</param>
  654. </member>
  655. <member name="M:CefSharp.IRenderProcessMessageHandler.OnFocusedNodeChanged(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IDomNode)">
  656. <summary>
  657. Invoked when an element in the UI gains focus (or possibly no
  658. element gains focus; i.e. an element lost focus).
  659. </summary>
  660. <param name="browserControl">The ChromiumWebBrowser control</param>
  661. <param name="browser">the browser object</param>
  662. <param name="frame">The frame object</param>
  663. <param name="node">An object with information about the node (if any) that has focus.</param>
  664. </member>
  665. <member name="T:CefSharp.IRequestContext">
  666. <summary>
  667. A request context provides request handling for a set of related browser or URL request objects.
  668. A request context can be specified when creating a new browser by setting the
  669. <see cref="!:IWebBrowser.RequestContext"/> property (Passing in via the constructor for the OffScreen
  670. control is preferred).
  671. Browser objects with different request contexts will never be hosted in the same render process.
  672. Browser objects with the same request context may or may not be hosted in the same render process
  673. depending on the process model.Browser objects created indirectly via the JavaScript window.open
  674. function or targeted links will share the same render process and the same request context as
  675. the source browser.
  676. </summary>
  677. </member>
  678. <member name="M:CefSharp.IRequestContext.IsSame(CefSharp.IRequestContext)">
  679. <summary>
  680. Returns true if this object is pointing to the same context object.
  681. </summary>
  682. <param name="context">context to compare</param>
  683. <returns>Returns true if the same</returns>
  684. </member>
  685. <member name="M:CefSharp.IRequestContext.IsSharingWith(CefSharp.IRequestContext)">
  686. <summary>
  687. Returns true if this object is sharing the same storage as the specified context.
  688. </summary>
  689. <param name="context">context to compare</param>
  690. <returns>Returns true if same storage</returns>
  691. </member>
  692. <member name="M:CefSharp.IRequestContext.GetDefaultCookieManager(CefSharp.ICompletionCallback)">
  693. <summary>
  694. Returns the default cookie manager for this object. This will be the global
  695. cookie manager if this object is the global request context. Otherwise,
  696. this will be the default cookie manager used when this request context does
  697. not receive a value via IRequestContextHandler.GetCookieManager().
  698. </summary>
  699. <param name="callback">If callback is non-NULL it will be executed asnychronously on the CEF IO thread
  700. after the manager's storage has been initialized.</param>
  701. <returns>Returns the default cookie manager for this object</returns>
  702. </member>
  703. <member name="M:CefSharp.IRequestContext.RegisterSchemeHandlerFactory(System.String,System.String,CefSharp.ISchemeHandlerFactory)">
  704. <summary>
  705. Register a scheme handler factory for the specified schemeName and optional domainName.
  706. An empty domainName value for a standard scheme will cause the factory to match all domain
  707. names. The domainName value will be ignored for non-standard schemes. If schemeName is
  708. a built-in scheme and no handler is returned by factory then the built-in scheme handler
  709. factory will be called. If schemeName is a custom scheme then you must also implement the
  710. CefApp::OnRegisterCustomSchemes() method in all processes. This function may be called multiple
  711. times to change or remove the factory that matches the specified schemeName and optional
  712. domainName.
  713. </summary>
  714. <param name="schemeName">Scheme Name</param>
  715. <param name="domainName">Optional domain name</param>
  716. <param name="factory">Scheme handler factory</param>
  717. <returns>Returns false if an error occurs.</returns>
  718. </member>
  719. <member name="M:CefSharp.IRequestContext.ClearSchemeHandlerFactories">
  720. <summary>
  721. Clear all registered scheme handler factories.
  722. </summary>
  723. <returns>Returns false on error.</returns>
  724. </member>
  725. <member name="M:CefSharp.IRequestContext.PurgePluginListCache(System.Boolean)">
  726. <summary>
  727. Tells all renderer processes associated with this context to throw away
  728. their plugin list cache. If reloadPages is true they will also reload
  729. all pages with plugins. RequestContextHandler.OnBeforePluginLoad may
  730. be called to rebuild the plugin list cache.
  731. </summary>
  732. <param name="reloadPages">reload any pages with pluginst</param>
  733. </member>
  734. <member name="M:CefSharp.IRequestContext.HasPreference(System.String)">
  735. <summary>
  736. Returns true if a preference with the specified name exists. This method
  737. must be called on the CEF UI thread.
  738. </summary>
  739. <param name="name">name of preference</param>
  740. <returns>bool if the preference exists</returns>
  741. <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
  742. Cef.OnContextInitialized and ChromiumWebBrowser.IsBrowserInitializedChanged are both
  743. executed on the CEF UI thread, so can be called directly.
  744. When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
  745. application thread will be the CEF UI thread.</remarks>
  746. </member>
  747. <member name="M:CefSharp.IRequestContext.GetPreference(System.String)">
  748. <summary>
  749. Returns the value for the preference with the specified name. Returns
  750. NULL if the preference does not exist. The returned object contains a copy
  751. of the underlying preference value and modifications to the returned object
  752. will not modify the underlying preference value. This method must be called
  753. on the CEF UI thread.
  754. </summary>
  755. <param name="name">preference name</param>
  756. <returns>Returns the value for the preference with the specified name</returns>
  757. <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
  758. Cef.OnContextInitialized and ChromiumWebBrowser.IsBrowserInitializedChanged are both
  759. executed on the CEF UI thread, so can be called directly.
  760. When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
  761. application thread will be the CEF UI thread.</remarks>
  762. </member>
  763. <member name="M:CefSharp.IRequestContext.GetAllPreferences(System.Boolean)">
  764. <summary>
  765. Returns all preferences as a dictionary. The returned
  766. object contains a copy of the underlying preference values and
  767. modifications to the returned object will not modify the underlying
  768. preference values. This method must be called on the browser process UI
  769. thread.
  770. </summary>
  771. <param name="includeDefaults">If true then
  772. preferences currently at their default value will be included.</param>
  773. <returns>Preferences (dictionary can have sub dictionaries)</returns>
  774. </member>
  775. <member name="M:CefSharp.IRequestContext.CanSetPreference(System.String)">
  776. <summary>
  777. Returns true if the preference with the specified name can be modified
  778. using SetPreference. As one example preferences set via the command-line
  779. usually cannot be modified. This method must be called on the CEF UI thread.
  780. </summary>
  781. <param name="name">preference key</param>
  782. <returns>Returns true if the preference with the specified name can be modified
  783. using SetPreference</returns>
  784. <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
  785. Cef.OnContextInitialized and ChromiumWebBrowser.IsBrowserInitializedChanged are both
  786. executed on the CEF UI thread, so can be called directly.
  787. When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
  788. application thread will be the CEF UI thread.</remarks>
  789. </member>
  790. <member name="M:CefSharp.IRequestContext.SetPreference(System.String,System.Object,System.String@)">
  791. <summary>
  792. Set the value associated with preference name. If value is null the
  793. preference will be restored to its default value. If setting the preference
  794. fails then error will be populated with a detailed description of the
  795. problem. This method must be called on the CEF UI thread.
  796. Preferences set via the command-line usually cannot be modified.
  797. </summary>
  798. <param name="name">preference key</param>
  799. <param name="value">preference value</param>
  800. <param name="error">out error</param>
  801. <returns>Returns true if the value is set successfully and false otherwise.</returns>
  802. /// <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
  803. Cef.OnContextInitialized and ChromiumWebBrowser.IsBrowserInitializedChanged are both
  804. executed on the CEF UI thread, so can be called directly.
  805. When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
  806. application thread will be the CEF UI thread.</remarks>
  807. </member>
  808. <member name="M:CefSharp.IRequestContext.ClearCertificateExceptions(CefSharp.ICompletionCallback)">
  809. <summary>
  810. Clears all certificate exceptions that were added as part of handling
  811. <see cref="M:CefSharp.IRequestHandler.OnCertificateError(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.CefErrorCode,System.String,CefSharp.ISslInfo,CefSharp.IRequestCallback)"/>. If you call this it is
  812. recommended that you also call <see cref="M:CefSharp.IRequestContext.CloseAllConnections(CefSharp.ICompletionCallback)"/> or you risk not
  813. being prompted again for server certificates if you reconnect quickly.
  814. </summary>
  815. <param name="callback">If is non-NULL it will be executed on the CEF UI thread after
  816. completion. This param is optional</param>
  817. </member>
  818. <member name="M:CefSharp.IRequestContext.CloseAllConnections(CefSharp.ICompletionCallback)">
  819. <summary>
  820. Clears all active and idle connections that Chromium currently has.
  821. This is only recommended if you have released all other CEF objects but
  822. don't yet want to call Cef.Shutdown().
  823. </summary>
  824. <param name="callback">If is non-NULL it will be executed on the CEF UI thread after
  825. completion. This param is optional</param>
  826. </member>
  827. <member name="M:CefSharp.IRequestContext.ResolveHostAsync(System.Uri)">
  828. <summary>
  829. Attempts to resolve origin to a list of associated IP addresses.
  830. </summary>
  831. <param name="origin">host name to resolve</param>
  832. <return>A task that represents the Resoolve Host operation. The value of the TResult parameter contains ResolveCallbackResult.</return>
  833. </member>
  834. <member name="M:CefSharp.IRequestContext.ResolveHostCached(System.Uri,System.Collections.Generic.IList{System.String}@)">
  835. <summary>
  836. Attempts to resolve origin to a list of associated IP addresses using
  837. cached data. This method must be called on the CEF IO thread. Use
  838. Cef.IOThreadTaskFactory to execute on that thread.
  839. </summary>
  840. <param name="origin">host name to resolve</param>
  841. <param name="resolvedIpAddresses">list of resolved IP
  842. addresses or empty list if no cached data is available.</param>
  843. <returns> Returns <see cref="F:CefSharp.CefErrorCode.None"/> on success</returns>
  844. </member>
  845. <member name="P:CefSharp.IRequestContext.IsGlobal">
  846. <summary>
  847. Returns true if this object is the global context. The global context is
  848. used by default when creating a browser or URL request with a NULL context
  849. argument.
  850. </summary>
  851. </member>
  852. <member name="P:CefSharp.IRequestContext.CachePath">
  853. <summary>
  854. Returns the cache path for this object. If empty an "incognito mode"
  855. in-memory cache is being used.
  856. </summary>
  857. </member>
  858. <member name="M:CefSharp.IResolveCallback.OnResolveCompleted(CefSharp.CefErrorCode,System.Collections.Generic.IList{System.String})">
  859. <summary>
  860. Called after the ResolveHost request has completed.
  861. </summary>
  862. <param name="result">The result code</param>
  863. <param name="resolvedIpAddresses">will be the list of resolved IP addresses or
  864. empty if the resolution failed.</param>
  865. </member>
  866. <member name="M:CefSharp.IResponseFilter.InitFilter">
  867. <summary>
  868. Initialize the response filter. Will only be called a single time.
  869. The filter will not be installed if this method returns false.
  870. </summary>
  871. <returns>The filter will not be installed if this method returns false.</returns>
  872. </member>
  873. <member name="M:CefSharp.IResponseFilter.Filter(System.IO.Stream,System.Int64@,System.IO.Stream,System.Int64@)">
  874. <summary>
  875. Called to filter a chunk of data.
  876. This method will be called repeatedly until there is no more data to filter (resource response is complete),
  877. dataInRead matches dataIn.Length (all available pre-filter bytes have been read), and the method
  878. returns FilterStatus.Done or FilterStatus.Error.
  879. </summary>
  880. <param name="dataIn">is a Stream wrapping the underlying input buffer containing pre-filter data. Can be null.</param>
  881. <param name="dataInRead">Set to the number of bytes that were read from dataIn</param>
  882. <param name="dataOut">is a Stream wrapping the underlying output buffer that can accept filtered output data.
  883. Check dataOut.Length for maximum buffer size</param>
  884. <param name="dataOutWritten">Set to the number of bytes that were written into dataOut</param>
  885. <returns>If some or all of the pre-filter data was read successfully but more data is needed in order
  886. to continue filtering (filtered output is pending) return FilterStatus.NeedMoreData. If some or all of the pre-filter
  887. data was read successfully and all available filtered output has been written return FilterStatus.Done. If an error
  888. occurs during filtering return FilterStatus.Error. </returns>
  889. <remarks>Do not keep a reference to the buffers(Streams) passed to this method.</remarks>
  890. </member>
  891. <member name="M:CefSharp.IRunContextMenuCallback.Continue(CefSharp.CefMenuCommand,CefSharp.CefEventFlags)">
  892. <summary>
  893. Complete context menu display by selecting the specified commandId and eventFlags;
  894. </summary>
  895. <param name="commandId">the command Id</param>
  896. <param name="eventFlags">the event flags</param>
  897. </member>
  898. <member name="M:CefSharp.IRunContextMenuCallback.Cancel">
  899. <summary>
  900. Cancel context menu display.
  901. </summary>
  902. </member>
  903. <member name="P:CefSharp.IRunContextMenuCallback.IsDisposed">
  904. <summary>
  905. Gets a value indicating whether the callback has been disposed of.
  906. </summary>
  907. </member>
  908. <member name="T:CefSharp.NavigationEntry">
  909. <summary>
  910. Represents an entry in navigation history.
  911. </summary>
  912. </member>
  913. <member name="M:CefSharp.NavigationEntry.#ctor(System.Boolean,System.DateTime,System.String,System.Int32,System.String,System.String,CefSharp.TransitionType,System.String,System.Boolean,System.Boolean)">
  914. <summary>
  915. NavigationEntry
  916. </summary>
  917. <param name="completionTime">completionTime</param>
  918. <param name="displayUrl">displayUrl</param>
  919. <param name="httpStatusCode">httpStatusCode</param>
  920. <param name="originalUrl">originalUrl</param>
  921. <param name="title">title</param>
  922. <param name="transitionType">transitionType</param>
  923. <param name="url">url</param>
  924. <param name="hasPostData">hasPostData</param>
  925. <param name="isValid">isValid</param>
  926. <param name="isCurrent">is the current entry</param>
  927. </member>
  928. <member name="P:CefSharp.NavigationEntry.CompletionTime">
  929. <summary>
  930. Returns the time for the last known successful navigation completion.
  931. </summary>
  932. </member>
  933. <member name="P:CefSharp.NavigationEntry.DisplayUrl">
  934. <summary>
  935. Returns a display-friendly version of the URL.
  936. </summary>
  937. </member>
  938. <member name="P:CefSharp.NavigationEntry.HttpStatusCode">
  939. <summary>
  940. Returns the HTTP status code for the last known successful navigation response.
  941. </summary>
  942. </member>
  943. <member name="P:CefSharp.NavigationEntry.OriginalUrl">
  944. <summary>
  945. Returns the original URL that was entered by the user before any redirects.
  946. </summary>
  947. </member>
  948. <member name="P:CefSharp.NavigationEntry.Title">
  949. <summary>
  950. Returns the title set by the page.
  951. </summary>
  952. </member>
  953. <member name="P:CefSharp.NavigationEntry.TransitionType">
  954. <summary>
  955. Returns the transition type which indicates what the user did to move to this page from the previous page.
  956. </summary>
  957. </member>
  958. <member name="P:CefSharp.NavigationEntry.Url">
  959. <summary>
  960. Returns the actual URL of the page.
  961. </summary>
  962. </member>
  963. <member name="P:CefSharp.NavigationEntry.HasPostData">
  964. <summary>
  965. Returns true if this navigation includes post data.
  966. </summary>
  967. </member>
  968. <member name="P:CefSharp.NavigationEntry.IsValid">
  969. <summary>
  970. Returns true if this object is valid.
  971. </summary>
  972. </member>
  973. <member name="P:CefSharp.NavigationEntry.IsCurrent">
  974. <summary>
  975. If true if this entry is the currently loaded navigation entry
  976. </summary>
  977. </member>
  978. <member name="T:CefSharp.PdfPrintSettings">
  979. <summary>
  980. Print to Pdf Settings
  981. </summary>
  982. </member>
  983. <member name="P:CefSharp.PdfPrintSettings.HeaderFooterTitle">
  984. <summary>
  985. Page title to display in the header. Only used if <see cref="P:CefSharp.PdfPrintSettings.HeaderFooterEnabled"/>
  986. is set to true.
  987. </summary>
  988. </member>
  989. <member name="P:CefSharp.PdfPrintSettings.HeaderFooterUrl">
  990. <summary>
  991. URL to display in the footer. Only used if <see cref="P:CefSharp.PdfPrintSettings.HeaderFooterEnabled"/> is set
  992. to true.
  993. </summary>
  994. </member>
  995. <member name="P:CefSharp.PdfPrintSettings.PageWidth">
  996. <summary>
  997. Output page size in microns. If either of these values is less than or
  998. equal to zero then the default paper size (A4) will be used.
  999. </summary>
  1000. </member>
  1001. <member name="P:CefSharp.PdfPrintSettings.PageHeight">
  1002. <summary>
  1003. Output page size in microns. If either of these values is less than or
  1004. equal to zero then the default paper size (A4) will be used.
  1005. </summary>
  1006. </member>
  1007. <member name="P:CefSharp.PdfPrintSettings.MarginLeft">
  1008. <summary>
  1009. Margin in millimeters. Only used if MarginType is set to Custom.
  1010. </summary>
  1011. </member>
  1012. <member name="P:CefSharp.PdfPrintSettings.MarginTop">
  1013. <summary>
  1014. Margin in millimeters. Only used if MarginType is set to Custom.
  1015. </summary>
  1016. </member>
  1017. <member name="P:CefSharp.PdfPrintSettings.MarginRight">
  1018. <summary>
  1019. Margin in millimeters. Only used if MarginType is set to Custom.
  1020. </summary>
  1021. </member>
  1022. <member name="P:CefSharp.PdfPrintSettings.MarginBottom">
  1023. <summary>
  1024. Margin in millimeters. Only used if MarginType is set to Custom.
  1025. </summary>
  1026. </member>
  1027. <member name="P:CefSharp.PdfPrintSettings.MarginType">
  1028. <summary>
  1029. Margin type.
  1030. </summary>
  1031. </member>
  1032. <member name="P:CefSharp.PdfPrintSettings.HeaderFooterEnabled">
  1033. <summary>
  1034. Set to true to print headers and footers or false to not print
  1035. headers and footers.
  1036. </summary>
  1037. </member>
  1038. <member name="P:CefSharp.PdfPrintSettings.SelectionOnly">
  1039. <summary>
  1040. Set to true to print the selection only or false to print all.
  1041. </summary>
  1042. </member>
  1043. <member name="P:CefSharp.PdfPrintSettings.Landscape">
  1044. <summary>
  1045. Set to true for landscape mode or false for portrait mode.
  1046. </summary>
  1047. </member>
  1048. <member name="P:CefSharp.PdfPrintSettings.BackgroundsEnabled">
  1049. <summary>
  1050. Set to true to print background graphics or false to not print
  1051. background graphics.
  1052. </summary>
  1053. </member>
  1054. <member name="T:CefSharp.ICookieManager">
  1055. <summary>
  1056. Used for managing cookies. The methods may be called on any thread unless otherwise indicated.
  1057. </summary>
  1058. </member>
  1059. <member name="M:CefSharp.ICookieManager.DeleteCookiesAsync(System.String,System.String)">
  1060. <summary>
  1061. Deletes all cookies that matches all the provided parameters asynchronously. If both <paramref name="url"/> and <paramref name="name"/> are empty, all cookies will be deleted.
  1062. </summary>
  1063. <param name="url">The cookie URL. If an empty string is provided, any URL will be matched.</param>
  1064. <param name="name">The name of the cookie. If an empty string is provided, any URL will be matched.</param>
  1065. <return>A task that represents the delete operation. The value of the TResult parameter contains false if a non-empty invalid URL is specified, or if cookies cannot be accessed; otherwise, true.</return>
  1066. </member>
  1067. <member name="M:CefSharp.ICookieManager.SetCookieAsync(System.String,CefSharp.Cookie)">
  1068. <summary>
  1069. Sets a cookie given a valid URL and explicit user-provided cookie attributes. This function expects each attribute to be well-formed. It will check for disallowed
  1070. characters (e.g. the ';' character is disallowed within the cookie value attribute) and will return false without setting
  1071. the cookie if such characters are found.
  1072. </summary>
  1073. <param name="url">The cookie URL</param>
  1074. <param name="cookie">The cookie</param>
  1075. <return>A task that represents the cookie set operation. The value of the TResult parameter contains false if the cookie cannot be set (e.g. if illegal charecters such as ';' are used); otherwise true.</return>
  1076. </member>
  1077. <member name="M:CefSharp.ICookieManager.SetStoragePath(System.String,System.Boolean)">
  1078. <summary>
  1079. Sets the directory path that will be used for storing cookie data. If <paramref name="path"/> is empty data will be stored in
  1080. memory only. Otherwise, data will be stored at the specified path. To persist session cookies (cookies without an expiry
  1081. date or validity interval) set <paramref name="persistSessionCookies"/> to true. Session cookies are generally intended to be transient and
  1082. most Web browsers do not persist them.
  1083. </summary>
  1084. <param name="path">The file path to write cookies to.</param>
  1085. <param name="persistSessionCookies">A flag that determines whether session cookies will be persisted or not.</param>
  1086. <return> false if a non-empty invalid URL is specified; otherwise, true.</return>
  1087. </member>
  1088. <member name="M:CefSharp.ICookieManager.SetSupportedSchemes(System.String[])">
  1089. <summary>
  1090. Set the schemes supported by this manager. By default only "http" and "https" schemes are supported. Must be called before any cookies are accessed.
  1091. </summary>
  1092. <param name="schemes">The list of supported schemes.</param>
  1093. </member>
  1094. <member name="M:CefSharp.ICookieManager.VisitAllCookiesAsync">
  1095. <summary>
  1096. Visits all cookies. The returned cookies are sorted by longest path, then by earliest creation date.
  1097. </summary>
  1098. <return>A task that represents the VisitAllCookies operation. The value of the TResult parameter contains a List of cookies.</return>
  1099. </member>
  1100. <member name="M:CefSharp.ICookieManager.VisitAllCookies(CefSharp.ICookieVisitor)">
  1101. <summary>
  1102. Visits all cookies using the provided Cookie Visitor. The returned cookies are sorted by longest path, then by earliest creation date.
  1103. </summary>
  1104. <param name="visitor">A user-provided Cookie Visitor implementation.</param>
  1105. <return>Returns false if cookies cannot be accessed; otherwise, true.</return>
  1106. </member>
  1107. <member name="M:CefSharp.ICookieManager.VisitUrlCookiesAsync(System.String,System.Boolean)">
  1108. <summary>
  1109. Visits a subset of the cookies. The results are filtered by the given url scheme, host, domain and path.
  1110. If <paramref name="includeHttpOnly"/> is true, HTTP-only cookies will also be included in the results. The returned cookies
  1111. are sorted by longest path, then by earliest creation date.
  1112. </summary>
  1113. <param name="url">The URL to use for filtering a subset of the cookies available.</param>
  1114. <param name="includeHttpOnly">A flag that determines whether HTTP-only cookies will be shown in results.</param>
  1115. <return>A task that represents the VisitUrlCookies operation. The value of the TResult parameter contains a List of cookies.</return>
  1116. </member>
  1117. <member name="M:CefSharp.ICookieManager.VisitUrlCookies(System.String,System.Boolean,CefSharp.ICookieVisitor)">
  1118. <summary>
  1119. Visits a subset of the cookies. The results are filtered by the given url scheme, host, domain and path.
  1120. If <paramref name="includeHttpOnly"/> is true, HTTP-only cookies will also be included in the results. The returned cookies
  1121. are sorted by longest path, then by earliest creation date.
  1122. </summary>
  1123. <param name="url">The URL to use for filtering a subset of the cookies available.</param>
  1124. <param name="includeHttpOnly">A flag that determines whether HTTP-only cookies will be shown in results.</param>
  1125. <param name="visitor">A user-provided Cookie Visitor implementation.</param>
  1126. <return>Returns false if cookies cannot be accessed; otherwise, true.</return>
  1127. </member>
  1128. <member name="M:CefSharp.ICookieManager.FlushStoreAsync">
  1129. <summary>
  1130. Flush the backing store (if any) to disk
  1131. </summary>
  1132. <return>A task that represents the Flush operation. The value of the TResult parameter contains false if cookies cannot be accessed; otherwise, true.</return>
  1133. </member>
  1134. <member name="T:CefSharp.ILoadHandler">
  1135. <summary>
  1136. Implement this interface to handle events related to browser load status.
  1137. The methods of this interface will be called on the CEF UI thread. Blocking in these methods
  1138. will likely cause your UI to become unresponsive and/or hang.
  1139. </summary>
  1140. </member>
  1141. <member name="M:CefSharp.ILoadHandler.OnLoadingStateChange(CefSharp.IWebBrowser,CefSharp.LoadingStateChangedEventArgs)">
  1142. <summary>
  1143. Called when the loading state has changed. This callback will be executed twice
  1144. once when loading is initiated either programmatically or by user action,
  1145. and once when loading is terminated due to completion, cancellation of failure.
  1146. This method will be called on the CEF UI thread.
  1147. Blocking this thread will likely cause your UI to become unresponsive and/or hang.
  1148. </summary>
  1149. <param name="browserControl">The <see cref="T:CefSharp.IWebBrowser"/> control this popup is related to.</param>
  1150. <param name="loadingStateChangedArgs">args</param>
  1151. </member>
  1152. <member name="M:CefSharp.ILoadHandler.OnFrameLoadStart(CefSharp.IWebBrowser,CefSharp.FrameLoadStartEventArgs)">
  1153. <summary>
  1154. Called when the browser begins loading a frame.
  1155. The <see cref="P:CefSharp.FrameLoadEndEventArgs.Frame"/> value will never be empty
  1156. Check the <see cref="P:CefSharp.IFrame.IsMain"/> method to see if this frame is the main frame.
  1157. Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended.
  1158. This method may not be called for a particular frame if the load request for that frame fails.
  1159. For notification of overall browser load status use <see cref="M:CefSharp.ILoadHandler.OnLoadingStateChange(CefSharp.IWebBrowser,CefSharp.LoadingStateChangedEventArgs)"/> instead.
  1160. This method will be called on the CEF UI thread.
  1161. Blocking this thread will likely cause your UI to become unresponsive and/or hang.
  1162. </summary>
  1163. <param name="browserControl">The <see cref="T:CefSharp.IWebBrowser"/> control this popup is related to.</param>
  1164. <param name="frameLoadStartArgs">args</param>
  1165. <remarks>Whilst thist may seem like a logical place to execute js, it's called before the DOM has been loaded, implement
  1166. <see cref="M:CefSharp.IRenderProcessMessageHandler.OnContextCreated(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame)"/> as it's called when the underlying V8Context is created
  1167. (Only called for the main frame at this stage)</remarks>
  1168. </member>
  1169. <member name="M:CefSharp.ILoadHandler.OnFrameLoadEnd(CefSharp.IWebBrowser,CefSharp.FrameLoadEndEventArgs)">
  1170. <summary>
  1171. Called when the browser is done loading a frame.
  1172. The <see cref="P:CefSharp.FrameLoadEndEventArgs.Frame"/> value will never be empty
  1173. Check the <see cref="P:CefSharp.IFrame.IsMain"/> method to see if this frame is the main frame.
  1174. Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended.
  1175. This method will always be called for all frames irrespective of whether the request completes successfully.
  1176. This method will be called on the CEF UI thread.
  1177. Blocking this thread will likely cause your UI to become unresponsive and/or hang.
  1178. </summary>
  1179. <param name="browserControl">The <see cref="T:CefSharp.IWebBrowser"/> control this popup is related to.</param>
  1180. <param name="frameLoadEndArgs">args</param>
  1181. </member>
  1182. <member name="M:CefSharp.ILoadHandler.OnLoadError(CefSharp.IWebBrowser,CefSharp.LoadErrorEventArgs)">
  1183. <summary>
  1184. Called when the resource load for a navigation fails or is canceled.
  1185. <see cref="P:CefSharp.LoadErrorEventArgs.ErrorCode"/> is the error code number, <see cref="P:CefSharp.LoadErrorEventArgs.ErrorText"/> is the error text and
  1186. <see cref="P:CefSharp.LoadErrorEventArgs.FailedUrl"/> is the URL that failed to load. See net\base\net_error_list.h
  1187. for complete descriptions of the error codes.
  1188. This method will be called on the CEF UI thread.
  1189. Blocking this thread will likely cause your UI to become unresponsive and/or hang.
  1190. </summary>
  1191. <param name="browserControl">The <see cref="T:CefSharp.IWebBrowser"/> control this popup is related to.</param>
  1192. <param name="loadErrorArgs">args</param>
  1193. </member>
  1194. <member name="M:CefSharp.IMenuModel.Clear">
  1195. <summary>
  1196. Remove all menu items. Can be used to disable the context menu. Returns true on success.
  1197. </summary>
  1198. <returns>Returns true on success</returns>
  1199. </member>
  1200. <member name="M:CefSharp.IMenuModel.GetLabelAt(System.Int32)">
  1201. <summary>
  1202. Returns the label at the specified index or empty if not found due to
  1203. invalid range or the index being a separator.
  1204. </summary>
  1205. <param name="index">specified index</param>
  1206. <returns>Label or empty if not found due to invalid range or the index being a separator.</returns>
  1207. </member>
  1208. <member name="M:CefSharp.IMenuModel.GetCommandIdAt(System.Int32)">
  1209. <summary>
  1210. Returns the command id at the specified index or -1 if not found due to invalid range or the index being a separator.
  1211. </summary>
  1212. <param name="index">the index</param>
  1213. <returns>Command or -1 if not found due to invalid range or the index being a separator.</returns>
  1214. </member>
  1215. <member name="M:CefSharp.IMenuModel.Remove(CefSharp.CefMenuCommand)">
  1216. <summary>
  1217. Removes the item with the specified commandId.
  1218. </summary>
  1219. <param name="commandId">the command Id</param>
  1220. <returns>Returns true on success</returns>
  1221. </member>
  1222. <member name="M:CefSharp.IMenuModel.AddItem(CefSharp.CefMenuCommand,System.String)">
  1223. <summary>
  1224. Add an item to the menu.
  1225. </summary>
  1226. <param name="commandId">the command Id</param>
  1227. <param name="label">the label of the item</param>
  1228. <returns>Returns true on success.</returns>
  1229. </member>
  1230. <member name="M:CefSharp.IMenuModel.AddSeparator">
  1231. <summary>
  1232. Add a separator to the menu.
  1233. </summary>
  1234. <returns>Returns true on success.</returns>
  1235. </member>
  1236. <member name="M:CefSharp.IMenuModel.AddCheckItem(CefSharp.CefMenuCommand,System.String)">
  1237. <summary>
  1238. Add a check item to the menu.
  1239. </summary>
  1240. <param name="commandId">the command Id</param>
  1241. <param name="label">the label of the item</param>
  1242. <returns>Returns true on success.</returns>
  1243. </member>
  1244. <member name="M:CefSharp.IMenuModel.AddRadioItem(CefSharp.CefMenuCommand,System.String,System.Int32)">
  1245. <summary>
  1246. Add a radio item to the menu. Only a single item with the specified groupId can be checked at a time.
  1247. </summary>
  1248. <param name="commandId">the command Id</param>
  1249. <param name="label">the label of the item</param>
  1250. <param name="groupId">the group id</param>
  1251. <returns>Returns true on success.</returns>
  1252. </member>
  1253. <member name="M:CefSharp.IMenuModel.AddSubMenu(CefSharp.CefMenuCommand,System.String)">
  1254. <summary>
  1255. Add a sub-menu to the menu. The new sub-menu is returned.
  1256. </summary>
  1257. <param name="commandId">the command Id</param>
  1258. <param name="label">the label of the item</param>
  1259. <returns>Returns the newly created <see cref="T:CefSharp.IMenuModel"/>.</returns>
  1260. </member>
  1261. <member name="M:CefSharp.IMenuModel.InsertSeparatorAt(System.Int32)">
  1262. <summary>
  1263. Insert a separator in the menu at the specified index.
  1264. </summary>
  1265. <param name="index">index</param>
  1266. <returns>Returns true on success.</returns>
  1267. </member>
  1268. <member name="M:CefSharp.IMenuModel.InsertItemAt(System.Int32,CefSharp.CefMenuCommand,System.String)">
  1269. <summary>
  1270. Insert an item in the menu at the specified index.
  1271. </summary>
  1272. <param name="index">index</param>
  1273. <param name="commandId">the command Id</param>
  1274. <param name="label">the label of the item</param>
  1275. <returns>Returns true on success.</returns>
  1276. </member>
  1277. <member name="M:CefSharp.IMenuModel.InsertCheckItemAt(System.Int32,CefSharp.CefMenuCommand,System.String)">
  1278. <summary>
  1279. Insert a check item in the menu at the specified index.
  1280. </summary>
  1281. <param name="index">index</param>
  1282. <param name="commandId">the command Id</param>
  1283. <param name="label">the label of the item</param>
  1284. <returns>Returns true on success.</returns>
  1285. </member>
  1286. <member name="M:CefSharp.IMenuModel.InsertRadioItemAt(System.Int32,CefSharp.CefMenuCommand,System.String,System.Int32)">
  1287. <summary>
  1288. Insert a radio item in the menu at the specified index.
  1289. Only a single item with the specified groupId can be checked at a time.
  1290. </summary>
  1291. <param name="index">index</param>
  1292. <param name="commandId">the command Id</param>
  1293. <param name="label">the label of the item</param>
  1294. <param name="groupId">the group id</param>
  1295. <returns>Returns true on success.</returns>
  1296. </member>
  1297. <member name="M:CefSharp.IMenuModel.InsertSubMenuAt(System.Int32,CefSharp.CefMenuCommand,System.String)">
  1298. <summary>
  1299. Insert a sub-menu in the menu at the specified index.
  1300. </summary>
  1301. <param name="index">index</param>
  1302. <param name="commandId">the command Id</param>
  1303. <param name="label">the label of the item</param>
  1304. <returns>Returns the newly created <see cref="T:CefSharp.IMenuModel"/>.</returns>
  1305. </member>
  1306. <member name="M:CefSharp.IMenuModel.RemoveAt(System.Int32)">
  1307. <summary>
  1308. Removes the item at the specified index.
  1309. </summary>
  1310. <param name="index">index</param>
  1311. <returns>Returns true on success.</returns>
  1312. </member>
  1313. <member name="M:CefSharp.IMenuModel.GetIndexOf(CefSharp.CefMenuCommand)">
  1314. <summary>
  1315. Returns the index associated with the specified commandId or -1 if not found due to the command id not existing in the menu.
  1316. </summary>
  1317. <param name="commandId">the command Id</param>
  1318. <returns>Returns the index associated with the specified commandId or -1 if not found due to the command id not existing in the menu.</returns>
  1319. </member>
  1320. <member name="M:CefSharp.IMenuModel.SetCommandIdAt(System.Int32,CefSharp.CefMenuCommand)">
  1321. <summary>
  1322. Sets the command id at the specified index.
  1323. </summary>
  1324. <param name="index">index</param>
  1325. <param name="commandId">the command Id</param>
  1326. <returns>Returns true on success.</returns>
  1327. </member>
  1328. <member name="M:CefSharp.IMenuModel.GetLabel(CefSharp.CefMenuCommand)">
  1329. <summary>
  1330. Returns the label for the specified commandId or empty if not found.
  1331. </summary>
  1332. <param name="commandId">the command Id</param>
  1333. <returns>Returns the label for the specified commandId or empty if not found.</returns>
  1334. </member>
  1335. <member name="M:CefSharp.IMenuModel.SetLabel(CefSharp.CefMenuCommand,System.String)">
  1336. <summary>
  1337. Sets the label for the specified commandId.
  1338. </summary>
  1339. <param name="commandId">the command Id</param>
  1340. <param name="label">the label</param>
  1341. <returns>Returns true on success.</returns>
  1342. </member>
  1343. <member name="M:CefSharp.IMenuModel.SetLabelAt(System.Int32,System.String)">
  1344. <summary>
  1345. Set the label at the specified index.
  1346. </summary>
  1347. <param name="index">index</param>
  1348. <param name="label">the label</param>
  1349. <returns>Returns true on success.</returns>
  1350. </member>
  1351. <member name="M:CefSharp.IMenuModel.GetType(CefSharp.CefMenuCommand)">
  1352. <summary>
  1353. Returns the item type for the specified commandId.
  1354. </summary>
  1355. <param name="commandId">the command Id</param>
  1356. <returns>Returns the item type for the specified commandId.</returns>
  1357. </member>
  1358. <member name="M:CefSharp.IMenuModel.GetTypeAt(System.Int32)">
  1359. <summary>
  1360. Returns the item type at the specified index.
  1361. </summary>
  1362. <param name="index">index</param>
  1363. <returns>Returns the item type at the specified index.</returns>
  1364. </member>
  1365. <member name="M:CefSharp.IMenuModel.GetGroupId(CefSharp.CefMenuCommand)">
  1366. <summary>
  1367. Returns the group id for the specified commandId or -1 if invalid.
  1368. </summary>
  1369. <param name="commandId">the command Id</param>
  1370. <returns>Returns the group id for the specified commandId or -1 if invalid.</returns>
  1371. </member>
  1372. <member name="M:CefSharp.IMenuModel.GetGroupIdAt(System.Int32)">
  1373. <summary>
  1374. Returns the group id at the specified index or -1 if invalid.
  1375. </summary>
  1376. <param name="index">index</param>
  1377. <returns>Returns the group id at the specified index or -1 if invalid.</returns>
  1378. </member>
  1379. <member name="M:CefSharp.IMenuModel.SetGroupId(CefSharp.CefMenuCommand,System.Int32)">
  1380. <summary>
  1381. Sets the group id for the specified commandId.
  1382. </summary>
  1383. <param name="commandId">the command Id</param>
  1384. <param name="groupId">the group id</param>
  1385. <returns>Returns true on success.</returns>
  1386. </member>
  1387. <member name="M:CefSharp.IMenuModel.SetGroupIdAt(System.Int32,System.Int32)">
  1388. <summary>
  1389. Sets the group id at the specified index.
  1390. </summary>
  1391. <param name="index">index</param>
  1392. <param name="groupId">the group id</param>
  1393. <returns>Returns true on success.</returns>
  1394. </member>
  1395. <member name="M:CefSharp.IMenuModel.GetSubMenu(CefSharp.CefMenuCommand)">
  1396. <summary>
  1397. Returns the <see cref="T:CefSharp.IMenuModel"/> for the specified commandId or null if invalid.
  1398. </summary>
  1399. <param name="commandId">the command Id</param>
  1400. <returns>Returns the <see cref="T:CefSharp.IMenuModel"/> for the specified commandId or null if invalid.</returns>
  1401. </member>
  1402. <member name="M:CefSharp.IMenuModel.GetSubMenuAt(System.Int32)">
  1403. <summary>
  1404. Returns the <see cref="T:CefSharp.IMenuModel"/> at the specified index or empty if invalid.
  1405. </summary>
  1406. <param name="index">index</param>
  1407. <returns>Returns the <see cref="T:CefSharp.IMenuModel"/> for the specified commandId or null if invalid.</returns>
  1408. </member>
  1409. <member name="M:CefSharp.IMenuModel.IsVisible(CefSharp.CefMenuCommand)">
  1410. <summary>
  1411. Returns true if the specified commandId is visible.
  1412. </summary>
  1413. <param name="commandId">the command Id</param>
  1414. <returns>Returns true if the specified commandId is visible.</returns>
  1415. </member>
  1416. <member name="M:CefSharp.IMenuModel.IsVisibleAt(System.Int32)">
  1417. <summary>
  1418. Returns true if the specified index is visible.
  1419. </summary>
  1420. <param name="index">index</param>
  1421. <returns>Returns true if the specified index is visible.</returns>
  1422. </member>
  1423. <member name="M:CefSharp.IMenuModel.SetVisible(CefSharp.CefMenuCommand,System.Boolean)">
  1424. <summary>
  1425. Change the visibility of the specified commandId.
  1426. </summary>
  1427. <param name="commandId">the command Id</param>
  1428. <param name="visible">visible</param>
  1429. <returns>Returns true on success.</returns>
  1430. </member>
  1431. <member name="M:CefSharp.IMenuModel.SetVisibleAt(System.Int32,System.Boolean)">
  1432. <summary>
  1433. Change the visibility at the specified index.
  1434. </summary>
  1435. <param name="index">index</param>
  1436. <param name="visible">visible</param>
  1437. <returns>Returns true on success.</returns>
  1438. </member>
  1439. <member name="M:CefSharp.IMenuModel.IsEnabled(CefSharp.CefMenuCommand)">
  1440. <summary>
  1441. Returns true if the specified commandId is enabled.
  1442. </summary>
  1443. <param name="commandId">the command Id</param>
  1444. <returns>Returns true if the specified commandId is enabled.</returns>
  1445. </member>
  1446. <member name="M:CefSharp.IMenuModel.IsEnabledAt(System.Int32)">
  1447. <summary>
  1448. Returns true if the specified index is enabled.
  1449. </summary>
  1450. <param name="index">index</param>
  1451. <returns>Returns true if the specified index is enabled.</returns>
  1452. </member>
  1453. <member name="M:CefSharp.IMenuModel.SetEnabled(CefSharp.CefMenuCommand,System.Boolean)">
  1454. <summary>
  1455. Change the enabled status of the specified commandId.
  1456. </summary>
  1457. <param name="commandId">the command Id</param>
  1458. <param name="enabled">is enabled</param>
  1459. <returns>Returns true on success.</returns>
  1460. </member>
  1461. <member name="M:CefSharp.IMenuModel.SetEnabledAt(System.Int32,System.Boolean)">
  1462. <summary>
  1463. Change the enabled status at the specified index.
  1464. </summary>
  1465. <param name="index">index</param>
  1466. <param name="enabled">is enabled</param>
  1467. <returns>Returns true on success.</returns>
  1468. </member>
  1469. <member name="M:CefSharp.IMenuModel.IsChecked(CefSharp.CefMenuCommand)">
  1470. <summary>
  1471. Returns true if the specified commandId is checked. Only applies to check and radio items.
  1472. </summary>
  1473. <param name="commandId">the command Id</param>
  1474. <returns>Returns true if the specified commandId is checked. Only applies to check and radio items.</returns>
  1475. </member>
  1476. <member name="M:CefSharp.IMenuModel.IsCheckedAt(System.Int32)">
  1477. <summary>
  1478. Returns true if the specified index is checked. Only applies to check and radio items.
  1479. </summary>
  1480. <param name="index">index</param>
  1481. <returns>Returns true if the specified index is checked. Only applies to check and radio items.</returns>
  1482. </member>
  1483. <member name="M:CefSharp.IMenuModel.SetChecked(CefSharp.CefMenuCommand,System.Boolean)">
  1484. <summary>
  1485. Check the specified commandId. Only applies to check and radio items.
  1486. </summary>
  1487. <param name="commandId">the command Id</param>
  1488. <param name="isChecked">set checked</param>
  1489. <returns>Returns true on success.</returns>
  1490. </member>
  1491. <member name="M:CefSharp.IMenuModel.SetCheckedAt(System.Int32,System.Boolean)">
  1492. <summary>
  1493. Check the specified index. Only applies to check and radio items.
  1494. </summary>
  1495. <param name="index">index</param>
  1496. <param name="isChecked">set checked</param>
  1497. <returns>Returns true on success.</returns>
  1498. </member>
  1499. <member name="M:CefSharp.IMenuModel.HasAccelerator(CefSharp.CefMenuCommand)">
  1500. <summary>
  1501. Returns true if the specified commandId has a keyboard accelerator assigned.
  1502. </summary>
  1503. <param name="commandId">the command Id</param>
  1504. <returns>Returns true if the specified commandId has a keyboard accelerator assigned.</returns>
  1505. </member>
  1506. <member name="M:CefSharp.IMenuModel.HasAcceleratorAt(System.Int32)">
  1507. <summary>
  1508. Returns true if the specified index has a keyboard accelerator assigned.
  1509. </summary>
  1510. <param name="index">index</param>
  1511. <returns>Returns true if the specified index has a keyboard accelerator assigned.</returns>
  1512. </member>
  1513. <member name="M:CefSharp.IMenuModel.SetAccelerator(CefSharp.CefMenuCommand,System.Int32,System.Boolean,System.Boolean,System.Boolean)">
  1514. <summary>
  1515. Set the keyboard accelerator for the specified commandId.
  1516. </summary>
  1517. <param name="commandId">the command Id</param>
  1518. <param name="keyCode">keyCode can be any key or character value. </param>
  1519. <param name="shiftPressed">shift key pressed</param>
  1520. <param name="ctrlPressed">ctrl key pressed</param>
  1521. <param name="altPressed">alt key pressed</param>
  1522. <returns>Returns true on success.</returns>
  1523. </member>
  1524. <member name="M:CefSharp.IMenuModel.SetAcceleratorAt(System.Int32,System.Int32,System.Boolean,System.Boolean,System.Boolean)">
  1525. <summary>
  1526. Set the keyboard accelerator at the specified index. keyCode can be any key or character value.
  1527. </summary>
  1528. <param name="index">index</param>
  1529. <param name="keyCode">keyCode can be any key or character value. </param>
  1530. <param name="shiftPressed">shift key pressed</param>
  1531. <param name="ctrlPressed">ctrl key pressed</param>
  1532. <param name="altPressed">alt key pressed</param>
  1533. <returns>Returns true on success.</returns>
  1534. </member>
  1535. <member name="M:CefSharp.IMenuModel.RemoveAccelerator(CefSharp.CefMenuCommand)">
  1536. <summary>
  1537. Remove the keyboard accelerator for the specified commandId.
  1538. </summary>
  1539. <param name="commandId">the command Id</param>
  1540. <returns>Returns true on success.</returns>
  1541. </member>
  1542. <member name="M:CefSharp.IMenuModel.RemoveAcceleratorAt(System.Int32)">
  1543. <summary>
  1544. Remove the keyboard accelerator at the specified index.
  1545. </summary>
  1546. <param name="index">index</param>
  1547. <returns>Returns true on success.</returns>
  1548. </member>
  1549. <member name="M:CefSharp.IMenuModel.GetAccelerator(CefSharp.CefMenuCommand,System.Int32@,System.Boolean@,System.Boolean@,System.Boolean@)">
  1550. <summary>
  1551. Retrieves the keyboard accelerator for the specified commandId.
  1552. </summary>
  1553. <param name="commandId">the command Id</param>
  1554. <param name="keyCode">keyCode can be any key or character value. </param>
  1555. <param name="shiftPressed">shift key pressed</param>
  1556. <param name="ctrlPressed">ctrl key pressed</param>
  1557. <param name="altPressed">alt key pressed</param>
  1558. <returns>Returns true on success.</returns>
  1559. </member>
  1560. <member name="M:CefSharp.IMenuModel.GetAcceleratorAt(System.Int32,System.Int32@,System.Boolean@,System.Boolean@,System.Boolean@)">
  1561. <summary>
  1562. Retrieves the keyboard accelerator for the specified index.
  1563. </summary>
  1564. <param name="index">index</param>
  1565. <param name="keyCode">keyCode can be any key or character value. </param>
  1566. <param name="shiftPressed">shift key pressed</param>
  1567. <param name="ctrlPressed">ctrl key pressed</param>
  1568. <param name="altPressed">alt key pressed</param>
  1569. <returns>Returns true on success.</returns>
  1570. </member>
  1571. <member name="P:CefSharp.IMenuModel.Count">
  1572. <summary>
  1573. Returns the number of items in this menu.
  1574. </summary>
  1575. </member>
  1576. <member name="T:CefSharp.IPrintToPdfCallback">
  1577. <summary>
  1578. Callback interface for <see cref="M:CefSharp.IBrowserHost.PrintToPdf(System.String,CefSharp.PdfPrintSettings,CefSharp.IPrintToPdfCallback)"/>. The methods of this interface
  1579. will be called on the CEF UI thread.
  1580. </summary>
  1581. </member>
  1582. <member name="M:CefSharp.IPrintToPdfCallback.OnPdfPrintFinished(System.String,System.Boolean)">
  1583. <summary>
  1584. Method that will be executed when the PDF printing has completed.
  1585. </summary>
  1586. <param name="path">The output path.</param>
  1587. <param name="ok">Will be true if the printing completed
  1588. successfully or false otherwise.</param>
  1589. </member>
  1590. <member name="P:CefSharp.ISslInfo.SerialNumber">
  1591. <summary>
  1592. Returns the DER encoded serial number for the X.509 certificate. The value
  1593. possibly includes a leading 00 byte.
  1594. </summary>
  1595. </member>
  1596. <member name="P:CefSharp.ISslInfo.ValidStart">
  1597. <summary>
  1598. Returns the date before which the X.509 certificate is invalid.
  1599. will return null if no date was specified.
  1600. </summary>
  1601. </member>
  1602. <member name="P:CefSharp.ISslInfo.ValidExpiry">
  1603. <summary>
  1604. Returns the date after which the X.509 certificate is invalid.
  1605. will return null if no date was specified.
  1606. </summary>
  1607. </member>
  1608. <member name="P:CefSharp.ISslInfo.DerEncoded">
  1609. <summary>
  1610. Returns the DER encoded data for the X.509 certificate.
  1611. </summary>
  1612. </member>
  1613. <member name="P:CefSharp.ISslInfo.PemEncoded">
  1614. <summary>
  1615. Returns the PEM encoded data for the X.509 certificate.
  1616. </summary>
  1617. </member>
  1618. <member name="T:CefSharp.KeyEvent">
  1619. <summary>
  1620. Class representing a a keyboard event.
  1621. </summary>
  1622. </member>
  1623. <member name="P:CefSharp.KeyEvent.Type">
  1624. <summary>
  1625. The type of keyboard event.
  1626. </summary>
  1627. </member>
  1628. <member name="P:CefSharp.KeyEvent.Modifiers">
  1629. <summary>
  1630. Bit flags describing any pressed modifier keys. See
  1631. cef_event_flags_t for values.
  1632. </summary>
  1633. </member>
  1634. <member name="P:CefSharp.KeyEvent.WindowsKeyCode">
  1635. <summary>
  1636. The Windows key code for the key event. This value is used by the DOM
  1637. specification. Sometimes it comes directly from the event (i.e. on
  1638. Windows) and sometimes it's determined using a mapping function. See
  1639. WebCore/platform/chromium/KeyboardCodes.h for the list of values.
  1640. </summary>
  1641. </member>
  1642. <member name="P:CefSharp.KeyEvent.NativeKeyCode">
  1643. <summary>
  1644. The actual key code genenerated by the platform.
  1645. </summary>
  1646. </member>
  1647. <member name="P:CefSharp.KeyEvent.IsSystemKey">
  1648. <summary>
  1649. Indicates whether the event is considered a "system key" event (see
  1650. http://msdn.microsoft.com/en-us/library/ms646286(VS.85).aspx for details).
  1651. This value will always be false on non-Windows platforms.
  1652. </summary>
  1653. </member>
  1654. <member name="P:CefSharp.KeyEvent.FocusOnEditableField">
  1655. <summary>
  1656. True if the focus is currently on an editable field on the page. This is useful for determining if standard key events should be intercepted.
  1657. </summary>
  1658. </member>
  1659. <member name="F:CefSharp.KeyEventType.RawKeyDown">
  1660. <summary>
  1661. Notification that a key transitioned from "up" to "down".
  1662. </summary>
  1663. </member>
  1664. <member name="F:CefSharp.KeyEventType.KeyDown">
  1665. <summary>
  1666. Notification that a key was pressed. This does not necessarily correspond
  1667. to a character depending on the key and language. Use KEYEVENT_CHAR for
  1668. character input.
  1669. </summary>
  1670. </member>
  1671. <member name="F:CefSharp.KeyEventType.KeyUp">
  1672. <summary>
  1673. Notification that a key was released.
  1674. </summary>
  1675. </member>
  1676. <member name="F:CefSharp.KeyEventType.Char">
  1677. <summary>
  1678. Notification that a character was typed. Use this for text input. Key
  1679. down events may generate 0, 1, or more than one character event depending
  1680. on the key, locale, and operating system.
  1681. </summary>
  1682. </member>
  1683. <member name="M:CefSharp.IPostData.AddElement(CefSharp.IPostDataElement)">
  1684. <summary>
  1685. Add the specified <see cref="T:CefSharp.IPostDataElement"/>.
  1686. </summary>
  1687. <param name="element">element to be added.</param>
  1688. <returns> Returns true if the add succeeds.</returns>
  1689. </member>
  1690. <member name="M:CefSharp.IPostData.RemoveElement(CefSharp.IPostDataElement)">
  1691. <summary>
  1692. Remove the specified <see cref="T:CefSharp.IPostDataElement"/>.
  1693. </summary>
  1694. <param name="element">element to be removed.</param>
  1695. <returns> Returns true if the add succeeds.</returns>
  1696. </member>
  1697. <member name="M:CefSharp.IPostData.RemoveElements">
  1698. <summary>
  1699. Remove all existing post data elements.
  1700. </summary>
  1701. </member>
  1702. <member name="M:CefSharp.IPostData.CreatePostDataElement">
  1703. <summary>
  1704. Create a new <see cref="T:CefSharp.IPostDataElement"/> instance
  1705. </summary>
  1706. <returns></returns>
  1707. </member>
  1708. <member name="P:CefSharp.IPostData.Elements">
  1709. <summary>
  1710. Retrieve the post data elements.
  1711. </summary>
  1712. </member>
  1713. <member name="P:CefSharp.IPostData.IsReadOnly">
  1714. <summary>
  1715. Returns true if this object is read-only.
  1716. </summary>
  1717. </member>
  1718. <member name="P:CefSharp.IPostData.IsDisposed">
  1719. <summary>
  1720. Gets a value indicating whether the object has been disposed of.
  1721. </summary>
  1722. </member>
  1723. <member name="P:CefSharp.IPostData.HasExcludedElements">
  1724. <summary>
  1725. Returns true if the underlying POST data includes elements that are not
  1726. represented by this IPostData object (for example, multi-part file upload
  1727. data). Modifying IPostData objects with excluded elements may result in
  1728. the request failing.
  1729. </summary>
  1730. </member>
  1731. <member name="M:CefSharp.IPostDataElement.SetToEmpty">
  1732. <summary>
  1733. Remove all contents from the post data element.
  1734. </summary>
  1735. </member>
  1736. <member name="P:CefSharp.IPostDataElement.File">
  1737. <summary>
  1738. Gets or sets the file name.
  1739. </summary>
  1740. </member>
  1741. <member name="P:CefSharp.IPostDataElement.IsReadOnly">
  1742. <summary>
  1743. Gets if the object is read-only.
  1744. </summary>
  1745. </member>
  1746. <member name="P:CefSharp.IPostDataElement.Type">
  1747. <summary>
  1748. Gets the type of this <see cref="T:CefSharp.IPostDataElement"/>.
  1749. </summary>
  1750. </member>
  1751. <member name="P:CefSharp.IPostDataElement.Bytes">
  1752. <summary>
  1753. Gets or sets the bytes of this <see cref="T:CefSharp.IPostDataElement"/>.
  1754. </summary>
  1755. </member>
  1756. <member name="T:CefSharp.CefReturnValue">
  1757. <summary>
  1758. Return value types.
  1759. </summary>
  1760. </member>
  1761. <member name="F:CefSharp.CefReturnValue.Cancel">
  1762. <summary>
  1763. Cancel immediately.
  1764. </summary>
  1765. </member>
  1766. <member name="F:CefSharp.CefReturnValue.Continue">
  1767. <summary>
  1768. Continue immediately.
  1769. </summary>
  1770. </member>
  1771. <member name="F:CefSharp.CefReturnValue.ContinueAsync">
  1772. <summary>
  1773. Continue asynchronously (usually via a callback).
  1774. </summary>
  1775. </member>
  1776. <member name="T:CefSharp.CefSharpSettings">
  1777. <summary>
  1778. Use this static class to configure some CefSharp specific settings like WcfTimeout
  1779. </summary>
  1780. </member>
  1781. <member name="M:CefSharp.CefSharpSettings.#cctor">
  1782. <summary>
  1783. Set default values for CefSharpSettings
  1784. </summary>
  1785. </member>
  1786. <member name="P:CefSharp.CefSharpSettings.WcfEnabled">
  1787. <summary>
  1788. WCF is used by JavascriptBinding
  1789. Disabling effectively disables both of these features.
  1790. Defaults to true
  1791. </summary>
  1792. </member>
  1793. <member name="P:CefSharp.CefSharpSettings.WcfTimeout">
  1794. <summary>
  1795. Change the Close timeout for the WCF channel used by the sync JSB binding.
  1796. The default value is currently 10 seconds. Chaning this to <see cref="F:System.TimeSpan.Zero"/>
  1797. will result on Abort() being called on the WCF Channel Host
  1798. </summary>
  1799. </member>
  1800. <member name="P:CefSharp.CefSharpSettings.ShutdownOnExit">
  1801. <summary>
  1802. For the WinForms and WPF instances of ChromiumWebBrowser the relevant Application Exit event
  1803. is hooked and Cef.Shutdown() called by default. Set this to false to disable this behaviour.
  1804. This value needs to be set before the first instance of ChromiumWebBrowser is created as
  1805. the event handlers are hooked in the static constructor for the ChromiumWebBrowser class
  1806. </summary>
  1807. </member>
  1808. <member name="T:CefSharp.CefState">
  1809. <summary>
  1810. Represents the state of a setting.
  1811. </summary>
  1812. </member>
  1813. <member name="F:CefSharp.CefState.Default">
  1814. <summary>
  1815. Use the default state for the setting.
  1816. </summary>
  1817. </member>
  1818. <member name="F:CefSharp.CefState.Enabled">
  1819. <summary>
  1820. Enable or allow the setting.
  1821. </summary>
  1822. </member>
  1823. <member name="F:CefSharp.CefState.Disabled">
  1824. <summary>
  1825. Disable or disallow the setting.
  1826. </summary>
  1827. </member>
  1828. <member name="T:CefSharp.CefThreadIds">
  1829. <summary>
  1830. Managed enum for cef_thread_id_t/CefThreadId
  1831. </summary>
  1832. </member>
  1833. <member name="F:CefSharp.CefThreadIds.TID_UI">
  1834. <summary>
  1835. The CEF UI thread in the browser. In CefSharp this is ALWAYS
  1836. separate from the application's main thread (and thus the main
  1837. WinForm UI thread).
  1838. </summary>
  1839. </member>
  1840. <member name="F:CefSharp.CefThreadIds.TID_DB">
  1841. <summary>
  1842. Used to interact with the database.
  1843. </summary>
  1844. </member>
  1845. <member name="F:CefSharp.CefThreadIds.TID_FILE">
  1846. <summary>
  1847. Used to interact with the file system.
  1848. </summary>
  1849. </member>
  1850. <member name="F:CefSharp.CefThreadIds.TID_FILE_USER_BLOCKING">
  1851. <summary>
  1852. Used for file system operations that block user interactions.
  1853. Responsiveness of this thread affects users.
  1854. </summary>
  1855. </member>
  1856. <member name="F:CefSharp.CefThreadIds.TID_PROCESS_LAUNCHER">
  1857. <summary>
  1858. Used to launch and terminate browser processes.
  1859. </summary>
  1860. </member>
  1861. <member name="F:CefSharp.CefThreadIds.TID_CACHE">
  1862. <summary>
  1863. Used to handle slow HTTP cache operations.
  1864. </summary>
  1865. </member>
  1866. <member name="F:CefSharp.CefThreadIds.TID_IO">
  1867. <summary>
  1868. Used to process IPC and network messages.
  1869. </summary>
  1870. </member>
  1871. <member name="F:CefSharp.CefThreadIds.TID_RENDERER">
  1872. <summary>
  1873. The main thread in the renderer. Used for all WebKit and V8 interaction.
  1874. </summary>
  1875. </member>
  1876. <member name="T:CefSharp.Cookie">
  1877. <summary>
  1878. Class used to Represent a cookie the built in .Net Cookie
  1879. class isn't used as some of it's properties have internal setters
  1880. </summary>
  1881. </member>
  1882. <member name="T:CefSharp.IAuthCallback">
  1883. <summary>
  1884. Callback interface used for asynchronous continuation of authentication requests.
  1885. </summary>
  1886. </member>
  1887. <member name="M:CefSharp.IAuthCallback.Continue(System.String,System.String)">
  1888. <summary>
  1889. Continue the authentication request.
  1890. </summary>
  1891. <param name="username">requested username</param>
  1892. <param name="password">requested password</param>
  1893. </member>
  1894. <member name="M:CefSharp.IAuthCallback.Cancel">
  1895. <summary>
  1896. Cancel the authentication request.
  1897. </summary>
  1898. </member>
  1899. <member name="P:CefSharp.IAuthCallback.IsDisposed">
  1900. <summary>
  1901. Gets a value indicating whether the callback has been disposed of.
  1902. </summary>
  1903. </member>
  1904. <member name="T:CefSharp.IBeforeDownloadCallback">
  1905. <summary>
  1906. Callback interface used to asynchronously continue a download.
  1907. </summary>
  1908. </member>
  1909. <member name="M:CefSharp.IBeforeDownloadCallback.Continue(System.String,System.Boolean)">
  1910. <summary>
  1911. Call to continue the download.
  1912. </summary>
  1913. <param name="downloadPath">full file path for the download including the file name
  1914. or leave blank to use the suggested name and the default temp directory</param>
  1915. <param name="showDialog">Set to true if you do wish to show the default "Save As" dialog</param>
  1916. </member>
  1917. <member name="P:CefSharp.IBeforeDownloadCallback.IsDisposed">
  1918. <summary>
  1919. Gets a value indicating whether the callback has been disposed of.
  1920. </summary>
  1921. </member>
  1922. <member name="T:CefSharp.DefaultResourceHandlerFactory">
  1923. <summary>
  1924. Default implementation of <see cref="T:CefSharp.IResourceHandlerFactory"/> it's used
  1925. internally for the LoadHtml implementation - basically a resource handler is
  1926. registered for a specific Url.
  1927. </summary>
  1928. </member>
  1929. <member name="T:CefSharp.IResourceHandlerFactory">
  1930. <summary>
  1931. Class that creates <see cref="T:CefSharp.IResourceHandler"/> instances for handling custom requests.
  1932. The methods of this class will always be called on the CEF IO thread. This interface
  1933. maps to the CefRequestHandler::GetResourceHandler method. It was split out to allow for
  1934. the <see cref="T:CefSharp.DefaultResourceHandlerFactory"/> implementation that provides support
  1935. for the LoadHtml extension method.
  1936. </summary>
  1937. </member>
  1938. <member name="M:CefSharp.IResourceHandlerFactory.GetResourceHandler(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest)">
  1939. <summary>
  1940. Called before a resource is loaded. To specify a handler for the resource return a <see cref="T:CefSharp.ResourceHandler"/> object
  1941. </summary>
  1942. <param name="browserControl">The browser UI control</param>
  1943. <param name="browser">the browser object</param>
  1944. <param name="frame">the frame object</param>
  1945. <param name="request">the request object - cannot be modified in this callback</param>
  1946. <returns>To allow the resource to load normally return NULL otherwise return an instance of ResourceHandler with a valid stream</returns>
  1947. </member>
  1948. <member name="P:CefSharp.IResourceHandlerFactory.HasHandlers">
  1949. <summary>
  1950. Are there any <see cref="T:CefSharp.ResourceHandler"/>'s registered?
  1951. </summary>
  1952. </member>
  1953. <member name="M:CefSharp.DefaultResourceHandlerFactory.#ctor(System.Collections.Generic.IEqualityComparer{System.String})">
  1954. <summary>
  1955. Create a new instance of DefaultResourceHandlerFactory
  1956. </summary>
  1957. <param name="comparer">string equality comparer</param>
  1958. </member>
  1959. <member name="M:CefSharp.DefaultResourceHandlerFactory.RegisterHandler(System.String,CefSharp.IResourceHandler)">
  1960. <summary>
  1961. Register handler with the specified Url
  1962. </summary>
  1963. <param name="url">url</param>
  1964. <param name="handler">handler</param>
  1965. <returns>returns true if the Url was successfully parsed into a Uri otherwise false</returns>
  1966. </member>
  1967. <member name="M:CefSharp.DefaultResourceHandlerFactory.UnregisterHandler(System.String)">
  1968. <summary>
  1969. Unregister a handler for the specified Url
  1970. </summary>
  1971. <param name="url">Url</param>
  1972. <returns>returns true if successfully removed</returns>
  1973. </member>
  1974. <member name="M:CefSharp.DefaultResourceHandlerFactory.GetResourceHandler(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest)">
  1975. <summary>
  1976. Called before a resource is loaded. To specify a handler for the resource return a <see cref="T:CefSharp.ResourceHandler"/> object
  1977. </summary>
  1978. <param name="browserControl">The browser UI control</param>
  1979. <param name="browser">the browser object</param>
  1980. <param name="frame">the frame object</param>
  1981. <param name="request">the request object - cannot be modified in this callback</param>
  1982. <returns>To allow the resource to load normally return NULL otherwise return an instance of ResourceHandler with a valid stream</returns>
  1983. </member>
  1984. <member name="P:CefSharp.DefaultResourceHandlerFactory.Handlers">
  1985. <summary>
  1986. Resource handler thread safe dictionary
  1987. </summary>
  1988. </member>
  1989. <member name="P:CefSharp.DefaultResourceHandlerFactory.HasHandlers">
  1990. <summary>
  1991. Are there any <see cref="T:CefSharp.ResourceHandler"/>'s registered?
  1992. </summary>
  1993. </member>
  1994. <member name="T:CefSharp.DependencyChecker">
  1995. <summary>
  1996. DependencyChecker provides a known list of Cef/CefSharp dependencies and
  1997. provides helper methods to check for their existance.
  1998. </summary>
  1999. </member>
  2000. <member name="F:CefSharp.DependencyChecker.LocalesPackFile">
  2001. <summary>
  2002. en-US Locales pak file location
  2003. </summary>
  2004. </member>
  2005. <member name="F:CefSharp.DependencyChecker.CefDependencies">
  2006. <summary>
  2007. List of Cef Dependencies
  2008. </summary>
  2009. </member>
  2010. <member name="F:CefSharp.DependencyChecker.CefResources">
  2011. <summary>
  2012. List of Cef Resources (pack files)
  2013. </summary>
  2014. </member>
  2015. <member name="F:CefSharp.DependencyChecker.CefSharpDependencies">
  2016. <summary>
  2017. List of CefSharp Dependencies
  2018. </summary>
  2019. </member>
  2020. <member name="F:CefSharp.DependencyChecker.BrowserSubprocessDependencies">
  2021. <summary>
  2022. List of CefSharp.BrowserSubprocess.exe dependencies.
  2023. </summary>
  2024. </member>
  2025. <member name="M:CefSharp.DependencyChecker.CheckDependencies(System.Boolean,System.Boolean,System.String,System.String,System.String,System.String)">
  2026. <summary>
  2027. CheckDependencies iterates through the list of Cef and CefSharp dependencines
  2028. relative to the path provided and returns a list of missing ones
  2029. </summary>
  2030. <param name="checkOptional">check to see if optional dependencies are present</param>
  2031. <param name="packLoadingDisabled">Is loading of pack files disabled?</param>
  2032. <param name="path">path to check for dependencies</param>
  2033. <param name="resourcesDirPath">The path to the resources directory, if empty the Executing Assembly path is used.</param>
  2034. <param name="browserSubProcessPath">The path to a separate executable that will be launched for sub-processes.</param>
  2035. <param name="localePackFile">The locale pack file e.g. <see cref="F:CefSharp.DependencyChecker.LocalesPackFile"/> </param>
  2036. <returns>List of missing dependencies, if all present an empty List will be returned</returns>
  2037. </member>
  2038. <member name="M:CefSharp.DependencyChecker.CheckDependencyList(System.String,System.Collections.Generic.IEnumerable{System.String})">
  2039. <summary>
  2040. Loop through dependencies and add to the returned missing dependency list if not found.
  2041. </summary>
  2042. <param name="dir">The directory of the dependencies, or the current directory if null.</param>
  2043. <param name="files">The dependencies to check.</param>
  2044. <returns>List of missing dependencies, if all present an empty List will be returned</returns>
  2045. </member>
  2046. <member name="M:CefSharp.DependencyChecker.AssertAllDependenciesPresent(System.String,System.String,System.String,System.Boolean,System.String)">
  2047. <summary>
  2048. Checks if all Cef and CefSharp dependencies were found relative to the Executing Assembly.
  2049. Shortcut method that calls <see cref="M:CefSharp.DependencyChecker.CheckDependencies(System.Boolean,System.Boolean,System.String,System.String,System.String,System.String)"/>, throws an Exception if not files are missing.
  2050. </summary>
  2051. <param name="locale">The locale, if empty then en-US will be used.</param>
  2052. <param name="localesDirPath">The path to the locales directory, if empty locales\ will be used.</param>
  2053. <param name="resourcesDirPath">The path to the resources directory, if empty the Executing Assembly path is used.</param>
  2054. <param name="packLoadingDisabled">Is loading of pack files disabled?</param>
  2055. <param name="browserSubProcessPath">The path to a separate executable that will be launched for sub-processes.</param>
  2056. <exception cref="T:System.Exception">Throw when not all dependencies are present</exception>
  2057. </member>
  2058. <member name="T:CefSharp.IBrowser">
  2059. <summary>
  2060. CefSharp interface for CefBrowser.
  2061. </summary>
  2062. </member>
  2063. <member name="M:CefSharp.IBrowser.GetHost">
  2064. <summary>
  2065. Returns the browser host object. This method can only be called in the browser process.
  2066. </summary>
  2067. <returns>the browser host object</returns>
  2068. </member>
  2069. <member name="M:CefSharp.IBrowser.GoBack">
  2070. <summary>
  2071. Navigate backwards.
  2072. </summary>
  2073. </member>
  2074. <member name="M:CefSharp.IBrowser.GoForward">
  2075. <summary>
  2076. Navigate forwards.
  2077. </summary>
  2078. </member>
  2079. <member name="M:CefSharp.IBrowser.CloseBrowser(System.Boolean)">
  2080. <summary>
  2081. Request that the browser close. The JavaScript 'onbeforeunload' event will
  2082. be fired. If |forceClose| is false the event handler, if any, will be
  2083. allowed to prompt the user and the user can optionally cancel the close.
  2084. If |force_close| is true the prompt will not be displayed and the close
  2085. will proceed. Results in a call to CefLifeSpanHandler::DoClose() if the
  2086. event handler allows the close or if |force_close| is true. See
  2087. CefLifeSpanHandler::DoClose() documentation for additional usage
  2088. information.
  2089. </summary>
  2090. </member>
  2091. <member name="M:CefSharp.IBrowser.Reload(System.Boolean)">
  2092. <summary>
  2093. Reload the current page.
  2094. </summary>
  2095. <param name="ignoreCache">
  2096. <c>true</c> a reload is performed ignoring browser cache; <c>false</c> a reload is
  2097. performed using files from the browser cache, if available.
  2098. </param>
  2099. </member>
  2100. <member name="M:CefSharp.IBrowser.StopLoad">
  2101. <summary>
  2102. Stop loading the page.
  2103. </summary>
  2104. </member>
  2105. <member name="M:CefSharp.IBrowser.IsSame(CefSharp.IBrowser)">
  2106. <summary>
  2107. Returns true if this object is pointing to the same handle as that object.
  2108. </summary>
  2109. <param name="that">compare browser instances</param>
  2110. <returns>returns true if the same instance</returns>
  2111. </member>
  2112. <member name="M:CefSharp.IBrowser.GetFrame(System.Int64)">
  2113. <summary>
  2114. Returns the frame with the specified identifier, or NULL if not found.
  2115. </summary>
  2116. <param name="identifier">identifier</param>
  2117. <returns>frame or null</returns>
  2118. </member>
  2119. <member name="M:CefSharp.IBrowser.GetFrame(System.String)">
  2120. <summary>
  2121. Returns the frame with the specified name, or NULL if not found.
  2122. </summary>
  2123. <param name="name">name of frame</param>
  2124. <returns>frame or null</returns>
  2125. </member>
  2126. <member name="M:CefSharp.IBrowser.GetFrameCount">
  2127. <summary>
  2128. Returns the number of frames that currently exist.
  2129. </summary>
  2130. <returns>the number of frames</returns>
  2131. </member>
  2132. <member name="M:CefSharp.IBrowser.GetFrameIdentifiers">
  2133. <summary>
  2134. Returns the identifiers of all existing frames.
  2135. </summary>
  2136. <returns>list of frame identifiers</returns>
  2137. </member>
  2138. <member name="M:CefSharp.IBrowser.GetFrameNames">
  2139. <summary>
  2140. Returns the names of all existing frames.
  2141. </summary>
  2142. <returns>frame names</returns>
  2143. </member>
  2144. <member name="P:CefSharp.IBrowser.CanGoBack">
  2145. <summary>
  2146. Returns true if the browser can navigate backwards.
  2147. </summary>
  2148. </member>
  2149. <member name="P:CefSharp.IBrowser.CanGoForward">
  2150. <summary>
  2151. Returns true if the browser can navigate forwards.
  2152. </summary>
  2153. </member>
  2154. <member name="P:CefSharp.IBrowser.IsLoading">
  2155. <summary>
  2156. Returns true if the browser is currently loading.
  2157. </summary>
  2158. </member>
  2159. <member name="P:CefSharp.IBrowser.Identifier">
  2160. <summary>
  2161. Returns the globally unique identifier for this browser.
  2162. </summary>
  2163. </member>
  2164. <member name="P:CefSharp.IBrowser.IsPopup">
  2165. <summary>
  2166. Returns true if the window is a popup window.
  2167. </summary>
  2168. </member>
  2169. <member name="P:CefSharp.IBrowser.HasDocument">
  2170. <summary>
  2171. Returns true if a document has been loaded in the browser.
  2172. </summary>
  2173. </member>
  2174. <member name="P:CefSharp.IBrowser.MainFrame">
  2175. <summary>
  2176. Returns the main (top-level) frame for the browser window.
  2177. </summary>
  2178. </member>
  2179. <member name="P:CefSharp.IBrowser.FocusedFrame">
  2180. <summary>
  2181. Returns the focused frame for the browser window.
  2182. </summary>
  2183. </member>
  2184. <member name="P:CefSharp.IBrowser.IsDisposed">
  2185. <summary>
  2186. Gets a value indicating whether the browser has been disposed of.
  2187. </summary>
  2188. </member>
  2189. <member name="T:CefSharp.IBrowserHost">
  2190. <summary>
  2191. Interface used to represent the browser process aspects of a browser window.
  2192. They may be called on any thread in that process unless otherwise indicated in the comments.
  2193. </summary>
  2194. </member>
  2195. <member name="M:CefSharp.IBrowserHost.AddWordToDictionary(System.String)">
  2196. <summary>
  2197. Add the specified word to the spelling dictionary.
  2198. </summary>
  2199. <param name="word"></param>
  2200. </member>
  2201. <member name="M:CefSharp.IBrowserHost.CloseBrowser(System.Boolean)">
  2202. <summary>
  2203. Request that the browser close. The JavaScript 'onbeforeunload' event will be fired.
  2204. </summary>
  2205. <param name="forceClose">
  2206. If forceClose is false the event handler, if any, will be allowed to prompt the user and the
  2207. user can optionally cancel the close. If forceClose is true the prompt will not be displayed
  2208. and the close will proceed. Results in a call to <see cref="M:CefSharp.ILifeSpanHandler.DoClose(CefSharp.IWebBrowser,CefSharp.IBrowser)"/> if
  2209. the event handler allows the close or if forceClose is true
  2210. See <see cref="M:CefSharp.ILifeSpanHandler.DoClose(CefSharp.IWebBrowser,CefSharp.IBrowser)"/> documentation for additional usage information.
  2211. </param>
  2212. </member>
  2213. <member name="M:CefSharp.IBrowserHost.CloseDevTools">
  2214. <summary>
  2215. Explicitly close the developer tools window if one exists for this browser instance.
  2216. </summary>
  2217. </member>
  2218. <member name="M:CefSharp.IBrowserHost.DragTargetDragEnter(CefSharp.IDragData,CefSharp.MouseEvent,CefSharp.DragOperationsMask)">
  2219. <summary>
  2220. Call this method when the user drags the mouse into the web view (before calling <see cref="M:CefSharp.IBrowserHost.DragTargetDragOver(CefSharp.MouseEvent,CefSharp.DragOperationsMask)"/>/<see cref="M:CefSharp.IBrowserHost.DragTargetDragLeave"/>/<see cref="M:CefSharp.IBrowserHost.DragTargetDragDrop(CefSharp.MouseEvent)"/>).
  2221. </summary>
  2222. </member>
  2223. <member name="M:CefSharp.IBrowserHost.DragTargetDragOver(CefSharp.MouseEvent,CefSharp.DragOperationsMask)">
  2224. <summary>
  2225. Call this method each time the mouse is moved across the web view during a drag operation (after calling <see cref="M:CefSharp.IBrowserHost.DragTargetDragEnter(CefSharp.IDragData,CefSharp.MouseEvent,CefSharp.DragOperationsMask)"/> and before calling <see cref="M:CefSharp.IBrowserHost.DragTargetDragLeave"/>/<see cref="M:CefSharp.IBrowserHost.DragTargetDragDrop(CefSharp.MouseEvent)"/>).
  2226. This method is only used when window rendering is disabled.
  2227. </summary>
  2228. </member>
  2229. <member name="M:CefSharp.IBrowserHost.DragTargetDragDrop(CefSharp.MouseEvent)">
  2230. <summary>
  2231. Call this method when the user completes the drag operation by dropping the object onto the web view (after calling <see cref="M:CefSharp.IBrowserHost.DragTargetDragEnter(CefSharp.IDragData,CefSharp.MouseEvent,CefSharp.DragOperationsMask)"/>).
  2232. The object being dropped is <see cref="T:CefSharp.IDragData"/>, given as an argument to the previous <see cref="M:CefSharp.IBrowserHost.DragTargetDragEnter(CefSharp.IDragData,CefSharp.MouseEvent,CefSharp.DragOperationsMask)"/> call.
  2233. This method is only used when window rendering is disabled.
  2234. </summary>
  2235. </member>
  2236. <member name="M:CefSharp.IBrowserHost.DragSourceEndedAt(System.Int32,System.Int32,CefSharp.DragOperationsMask)">
  2237. <summary>
  2238. Call this method when the drag operation started by a <see cref="!:IRenderWebBrowser.StartDragging"/> call has ended either in a drop or by being cancelled.
  2239. If the web view is both the drag source and the drag target then all DragTarget* methods should be called before DragSource* methods.
  2240. This method is only used when window rendering is disabled.
  2241. </summary>
  2242. <param name="x">x mouse coordinate relative to the upper-left corner of the view.</param>
  2243. <param name="y">y mouse coordinate relative to the upper-left corner of the view.</param>
  2244. <param name="op">Drag Operations mask</param>
  2245. </member>
  2246. <member name="M:CefSharp.IBrowserHost.DragTargetDragLeave">
  2247. <summary>
  2248. Call this method when the user drags the mouse out of the web view (after calling <see cref="M:CefSharp.IBrowserHost.DragTargetDragEnter(CefSharp.IDragData,CefSharp.MouseEvent,CefSharp.DragOperationsMask)"/>).
  2249. This method is only used when window rendering is disabled.
  2250. </summary>
  2251. </member>
  2252. <member name="M:CefSharp.IBrowserHost.DragSourceSystemDragEnded">
  2253. <summary>
  2254. Call this method when the drag operation started by a <see cref="!:IRenderWebBrowser.StartDragging"/> call has completed.
  2255. This method may be called immediately without first calling DragSourceEndedAt to cancel a drag operation.
  2256. If the web view is both the drag source and the drag target then all DragTarget* methods should be called before DragSource* mthods.
  2257. This method is only used when window rendering is disabled.
  2258. </summary>
  2259. </member>
  2260. <member name="M:CefSharp.IBrowserHost.Find(System.Int32,System.String,System.Boolean,System.Boolean,System.Boolean)">
  2261. <summary>
  2262. Search for text
  2263. </summary>
  2264. <param name="identifier">can be used to have multiple searches running simultaniously</param>
  2265. <param name="searchText">text to search for</param>
  2266. <param name="forward">indicates whether to search forward or backward within the page</param>
  2267. <param name="matchCase">indicates whether the search should be case-sensitive</param>
  2268. <param name="findNext">indicates whether this is the first request or a follow-up</param>
  2269. <remarks>The IFindHandler instance, if any, will be called to report find results. </remarks>
  2270. </member>
  2271. <member name="M:CefSharp.IBrowserHost.GetOpenerWindowHandle">
  2272. <summary>
  2273. Retrieve the window handle of the browser that opened this browser.
  2274. </summary>
  2275. <returns>The handler</returns>
  2276. </member>
  2277. <member name="M:CefSharp.IBrowserHost.GetWindowHandle">
  2278. <summary>
  2279. Retrieve the window handle for this browser.
  2280. </summary>
  2281. <returns>The handler</returns>
  2282. </member>
  2283. <member name="M:CefSharp.IBrowserHost.GetZoomLevelAsync">
  2284. <summary>
  2285. Get the current zoom level. The default zoom level is 0.0. This method can only be called on the CEF UI thread.
  2286. </summary>
  2287. <returns> a <see cref="T:System.Threading.Tasks.Task`1"/> that when executed returns the zoom level as a double.</returns>
  2288. </member>
  2289. <member name="M:CefSharp.IBrowserHost.Invalidate(CefSharp.PaintElementType)">
  2290. <summary>
  2291. Invalidate the view. The browser will call CefRenderHandler::OnPaint asynchronously.
  2292. This method is only used when window rendering is disabled (OSR).
  2293. </summary>
  2294. <param name="type">indicates which surface to re-paint either View or Popup.</param>
  2295. </member>
  2296. <member name="M:CefSharp.IBrowserHost.NotifyMoveOrResizeStarted">
  2297. <summary>
  2298. Notify the browser that the window hosting it is about to be moved or resized.
  2299. </summary>
  2300. </member>
  2301. <member name="M:CefSharp.IBrowserHost.NotifyScreenInfoChanged">
  2302. <summary>
  2303. Send a notification to the browser that the screen info has changed.
  2304. The browser will then call CefRenderHandler::GetScreenInfo to update the screen information with the new values.
  2305. This simulates moving the webview window from one display to another, or changing the properties of the current display.
  2306. This method is only used when window rendering is disabled.
  2307. </summary>
  2308. </member>
  2309. <member name="M:CefSharp.IBrowserHost.Print">
  2310. <summary>
  2311. Print the current browser contents.
  2312. </summary>
  2313. </member>
  2314. <member name="M:CefSharp.IBrowserHost.PrintToPdfAsync(System.String,CefSharp.PdfPrintSettings)">
  2315. <summary>
  2316. Asynchronously prints the current browser contents to the Pdf file specified.
  2317. The caller is responsible for deleting the file when done.
  2318. </summary>
  2319. <param name="path">Output file location.</param>
  2320. <param name="settings">Print Settings.</param>
  2321. <returns>A task that represents the asynchronous print operation.
  2322. The result is true on success or false on failure to generate the Pdf.</returns>
  2323. </member>
  2324. <member name="M:CefSharp.IBrowserHost.PrintToPdf(System.String,CefSharp.PdfPrintSettings,CefSharp.IPrintToPdfCallback)">
  2325. <summary>
  2326. Asynchronously prints the current browser contents to the Pdf file specified.
  2327. The caller is responsible for deleting the file when done.
  2328. </summary>
  2329. <param name="path">Output file location.</param>
  2330. <param name="settings">Print Settings, can be null</param>
  2331. <param name="callback">Callback executed when printing complete</param>
  2332. </member>
  2333. <member name="M:CefSharp.IBrowserHost.ReplaceMisspelling(System.String)">
  2334. <summary>
  2335. If a misspelled word is currently selected in an editable node calling this method will replace it with the specified word.
  2336. </summary>
  2337. <param name="word">word to be replaced</param>
  2338. </member>
  2339. <member name="M:CefSharp.IBrowserHost.SendCaptureLostEvent">
  2340. <summary>
  2341. Send a capture lost event to the browser.
  2342. </summary>
  2343. </member>
  2344. <member name="M:CefSharp.IBrowserHost.SendFocusEvent(System.Boolean)">
  2345. <summary>
  2346. Send a focus event to the browser. . (Used for OSR Rendering e.g. WPF or OffScreen)
  2347. </summary>
  2348. <param name="setFocus">set focus</param>
  2349. </member>
  2350. <member name="M:CefSharp.IBrowserHost.SendKeyEvent(CefSharp.KeyEvent)">
  2351. <summary>
  2352. Send a key event to the browser.
  2353. </summary>
  2354. <param name="keyEvent">represents keyboard event</param>
  2355. </member>
  2356. <member name="M:CefSharp.IBrowserHost.SendKeyEvent(System.Int32,System.Int32,System.Int32)">
  2357. <summary>
  2358. Send key event to browser based on operating system message
  2359. </summary>
  2360. <param name="message">message</param>
  2361. <param name="wParam">wParam</param>
  2362. <param name="lParam">lParam</param>
  2363. </member>
  2364. <member name="M:CefSharp.IBrowserHost.SendMouseClickEvent(System.Int32,System.Int32,CefSharp.MouseButtonType,System.Boolean,System.Int32,CefSharp.CefEventFlags)">
  2365. <summary>
  2366. Send a mouse click event to the browser.
  2367. </summary>
  2368. <param name="x">x coordinate - relative to upper-left corner of view</param>
  2369. <param name="y">y coordinate - relative to upper-left corner of view</param>
  2370. <param name="mouseButtonType">Mouse ButtonType</param>
  2371. <param name="mouseUp">mouse up</param>
  2372. <param name="clickCount">click count</param>
  2373. <param name="modifiers">click modifiers e.g. Ctrl</param>
  2374. </member>
  2375. <member name="M:CefSharp.IBrowserHost.SendMouseWheelEvent(System.Int32,System.Int32,System.Int32,System.Int32,CefSharp.CefEventFlags)">
  2376. <summary>
  2377. Send a mouse wheel event to the browser.
  2378. </summary>
  2379. <param name="x">X-Axis coordinate relative to the upper-left corner of the view.</param>
  2380. <param name="y">Y-Axis coordinate relative to the upper-left corner of the view.</param>
  2381. <param name="deltaX">Movement delta for X direction.</param>
  2382. <param name="deltaY">movement delta for Y direction.</param>
  2383. /// <param name="modifiers">click modifiers e.g. Ctrl</param>
  2384. </member>
  2385. <member name="M:CefSharp.IBrowserHost.SetFocus(System.Boolean)">
  2386. <summary>
  2387. Set whether the browser is focused. (Used for Normal Rendering e.g. WinForms)
  2388. </summary>
  2389. <param name="focus">set focus</param>
  2390. </member>
  2391. <member name="M:CefSharp.IBrowserHost.SetZoomLevel(System.Double)">
  2392. <summary>
  2393. Change the zoom level to the specified value. Specify 0.0 to reset the zoom level.
  2394. If called on the CEF UI thread the change will be applied immediately.
  2395. Otherwise, the change will be applied asynchronously on the UI thread.
  2396. </summary>
  2397. <param name="zoomLevel">zoom level</param>
  2398. </member>
  2399. <member name="M:CefSharp.IBrowserHost.ShowDevTools(CefSharp.IWindowInfo,System.Int32,System.Int32)">
  2400. <summary>
  2401. Open developer tools in its own window. If inspectElementAtX and/or inspectElementAtY are specified then
  2402. the element at the specified (x,y) location will be inspected.
  2403. </summary>
  2404. <param name="windowInfo">window info used for showing dev tools</param>
  2405. <param name="inspectElementAtX">x coordinate (used for inspectElement)</param>
  2406. <param name="inspectElementAtY">y coordinate (used for inspectElement)</param>
  2407. </member>
  2408. <member name="M:CefSharp.IBrowserHost.StartDownload(System.String)">
  2409. <summary>
  2410. Download the file at url using IDownloadHandler.
  2411. </summary>
  2412. <param name="url">url to download</param>
  2413. </member>
  2414. <member name="M:CefSharp.IBrowserHost.StopFinding(System.Boolean)">
  2415. <summary>
  2416. Cancel all searches that are currently going on.
  2417. </summary>
  2418. <param name="clearSelection">clear the selection</param>
  2419. </member>
  2420. <member name="M:CefSharp.IBrowserHost.SendMouseMoveEvent(System.Int32,System.Int32,System.Boolean,CefSharp.CefEventFlags)">
  2421. <summary>
  2422. Send a mouse move event to the browser
  2423. </summary>
  2424. <param name="x">x coordinate - relative to upper-left corner of view</param>
  2425. <param name="y">y coordinate - relative to upper-left corner of view</param>
  2426. <param name="mouseLeave">mouse leave</param>
  2427. <param name="modifiers">click modifiers .e.g Ctrl</param>
  2428. </member>
  2429. <member name="M:CefSharp.IBrowserHost.WasHidden(System.Boolean)">
  2430. <summary>
  2431. Notify the browser that it has been hidden or shown.
  2432. Layouting and rendering notification will stop when the browser is hidden.
  2433. This method is only used when window rendering is disabled (WPF/OffScreen).
  2434. </summary>
  2435. <param name="hidden"></param>
  2436. </member>
  2437. <member name="M:CefSharp.IBrowserHost.WasResized">
  2438. <summary>
  2439. Notify the browser that the widget has been resized.
  2440. The browser will first call CefRenderHandler::GetViewRect to get the new size and then call CefRenderHandler::OnPaint asynchronously with the updated regions.
  2441. This method is only used when window rendering is disabled.
  2442. </summary>
  2443. </member>
  2444. <member name="M:CefSharp.IBrowserHost.GetNavigationEntries(CefSharp.INavigationEntryVisitor,System.Boolean)">
  2445. <summary>
  2446. Retrieve a snapshot of current navigation entries as values sent to the
  2447. specified visitor.
  2448. </summary>
  2449. <param name="visitor">visitor</param>
  2450. <param name="currentOnly">If true only the current navigation
  2451. entry will be sent, otherwise all navigation entries will be sent.</param>
  2452. </member>
  2453. <member name="P:CefSharp.IBrowserHost.HasDevTools">
  2454. <summary>
  2455. Returns true if this browser currently has an associated DevTools browser.
  2456. Must be called on the CEF UI thread.
  2457. </summary>
  2458. </member>
  2459. <member name="P:CefSharp.IBrowserHost.MouseCursorChangeDisabled">
  2460. <summary>
  2461. Get/Set Mouse cursor change disabled
  2462. </summary>
  2463. </member>
  2464. <member name="P:CefSharp.IBrowserHost.RequestContext">
  2465. <summary>
  2466. Returns the request context for this browser.
  2467. </summary>
  2468. </member>
  2469. <member name="P:CefSharp.IBrowserHost.WindowlessFrameRate">
  2470. <summary>
  2471. Gets/sets the maximum rate in frames per second (fps) that CefRenderHandler::
  2472. OnPaint will be called for a windowless browser. The actual fps may be
  2473. lower if the browser cannot generate frames at the requested rate. The
  2474. minimum value is 1 and the maximum value is 60 (default 30). This method
  2475. can only be called on the UI thread. Can also be set at browser creation
  2476. via BrowserSettings.WindowlessFrameRate.
  2477. </summary>
  2478. </member>
  2479. <member name="P:CefSharp.IBrowserHost.WindowRenderingDisabled">
  2480. <summary>
  2481. Returns true if window rendering is disabled.
  2482. </summary>
  2483. </member>
  2484. <member name="P:CefSharp.IBrowserHost.IsDisposed">
  2485. <summary>
  2486. Gets a value indicating whether the browserHost has been disposed of.
  2487. </summary>
  2488. </member>
  2489. <member name="T:CefSharp.ICallback">
  2490. <summary>
  2491. Generic callback interface used for asynchronous continuation.
  2492. </summary>
  2493. </member>
  2494. <member name="M:CefSharp.ICallback.Continue">
  2495. <summary>
  2496. Continue processing.
  2497. </summary>
  2498. </member>
  2499. <member name="M:CefSharp.ICallback.Cancel">
  2500. <summary>
  2501. Cancel processing.
  2502. </summary>
  2503. </member>
  2504. <member name="P:CefSharp.ICallback.IsDisposed">
  2505. <summary>
  2506. Gets a value indicating whether the callback has been disposed of.
  2507. </summary>
  2508. </member>
  2509. <member name="T:CefSharp.IDownloadItemCallback">
  2510. <summary>
  2511. Callback interface used to asynchronously cancel a download.
  2512. </summary>
  2513. </member>
  2514. <member name="M:CefSharp.IDownloadItemCallback.Cancel">
  2515. <summary>
  2516. Call to cancel the download.
  2517. </summary>
  2518. </member>
  2519. <member name="M:CefSharp.IDownloadItemCallback.Pause">
  2520. <summary>
  2521. Call to pause the download.
  2522. </summary>
  2523. </member>
  2524. <member name="M:CefSharp.IDownloadItemCallback.Resume">
  2525. <summary>
  2526. Call to resume the download.
  2527. </summary>
  2528. </member>
  2529. <member name="P:CefSharp.IDownloadItemCallback.IsDisposed">
  2530. <summary>
  2531. Gets a value indicating whether the callback has been disposed of.
  2532. </summary>
  2533. </member>
  2534. <member name="T:CefSharp.IFileDialogCallback">
  2535. <summary>
  2536. Callback interface for asynchronous continuation of file dialog requests.
  2537. </summary>
  2538. </member>
  2539. <member name="M:CefSharp.IFileDialogCallback.Continue(System.Int32,System.Collections.Generic.List{System.String})">
  2540. <summary>
  2541. Continue the file selection.
  2542. </summary>
  2543. <param name="selectedAcceptFilter">should be the 0-based index of the value selected from the accept filters
  2544. array passed to <see cref="M:CefSharp.IDialogHandler.OnFileDialog(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.CefFileDialogMode,System.String,System.String,System.Collections.Generic.List{System.String},System.Int32,CefSharp.IFileDialogCallback)"/></param>
  2545. <param name="filePaths">should be a single value or a list of values depending on the dialog mode.
  2546. An empty value is treated the same as calling Cancel().</param>
  2547. </member>
  2548. <member name="M:CefSharp.IFileDialogCallback.Cancel">
  2549. <summary>
  2550. Cancel the file selection.
  2551. </summary>
  2552. </member>
  2553. <member name="P:CefSharp.IFileDialogCallback.IsDisposed">
  2554. <summary>
  2555. Gets a value indicating whether the callback has been disposed of.
  2556. </summary>
  2557. </member>
  2558. <member name="T:CefSharp.IFrame">
  2559. <summary>
  2560. This interface represents a CefFrame object (i.e. a HTML frame)
  2561. </summary>
  2562. </member>
  2563. <member name="M:CefSharp.IFrame.Undo">
  2564. <summary>
  2565. Execute undo in this frame.
  2566. </summary>
  2567. </member>
  2568. <member name="M:CefSharp.IFrame.Redo">
  2569. <summary>
  2570. Execute redo in this frame.
  2571. </summary>
  2572. </member>
  2573. <member name="M:CefSharp.IFrame.Cut">
  2574. <summary>
  2575. Execute cut in this frame.
  2576. </summary>
  2577. </member>
  2578. <member name="M:CefSharp.IFrame.Copy">
  2579. <summary>
  2580. Execute copy in this frame.
  2581. </summary>
  2582. </member>
  2583. <member name="M:CefSharp.IFrame.Paste">
  2584. <summary>
  2585. Execute paste in this frame.
  2586. </summary>
  2587. </member>
  2588. <member name="M:CefSharp.IFrame.Delete">
  2589. <summary>
  2590. Execute delete in this frame.
  2591. </summary>
  2592. </member>
  2593. <member name="M:CefSharp.IFrame.SelectAll">
  2594. <summary>
  2595. Execute select all in this frame.
  2596. </summary>
  2597. </member>
  2598. <member name="M:CefSharp.IFrame.ViewSource">
  2599. <summary>
  2600. Save this frame's HTML source to a temporary file and open it in the
  2601. default text viewing application. This method can only be called from the
  2602. browser process.
  2603. </summary>
  2604. </member>
  2605. <member name="M:CefSharp.IFrame.GetSourceAsync">
  2606. <summary>
  2607. Retrieve this frame's HTML source as a string sent to the specified visitor.
  2608. </summary>
  2609. <returns>
  2610. a <see cref="T:System.Threading.Tasks.Task`1"/> that when executed returns this frame's HTML source as a string.
  2611. </returns>
  2612. </member>
  2613. <member name="M:CefSharp.IFrame.GetSource(CefSharp.IStringVisitor)">
  2614. <summary>
  2615. Retrieve this frame's HTML source as a string sent to the specified visitor.
  2616. Use the <see cref="M:CefSharp.IFrame.GetSourceAsync"/> method for a Task based async wrapper
  2617. </summary>
  2618. <param name="visitor">visitor will recieve string values asynchronously</param>
  2619. </member>
  2620. <member name="M:CefSharp.IFrame.GetTextAsync">
  2621. <summary>
  2622. Retrieve this frame's display text as a string sent to the specified visitor.
  2623. </summary>
  2624. <returns>
  2625. a <see cref="T:System.Threading.Tasks.Task`1"/> that when executed returns the frame's display text as a string.
  2626. </returns>
  2627. </member>
  2628. <member name="M:CefSharp.IFrame.GetText(CefSharp.IStringVisitor)">
  2629. <summary>
  2630. Retrieve this frame's display text as a string sent to the specified visitor.
  2631. Use the <see cref="M:CefSharp.IFrame.GetTextAsync"/> method for a Task based async wrapper
  2632. </summary>
  2633. <param name="visitor">visitor will recieve string values asynchronously</param>
  2634. </member>
  2635. <member name="M:CefSharp.IFrame.LoadRequest(CefSharp.IRequest)">
  2636. <summary>
  2637. Load the custom request.
  2638. </summary>
  2639. <param name="request">request to be loaded in the frame</param>
  2640. </member>
  2641. <member name="M:CefSharp.IFrame.LoadUrl(System.String)">
  2642. <summary>
  2643. Load the specified url.
  2644. </summary>
  2645. <param name="url">url to be loaded in the frame</param>
  2646. </member>
  2647. <member name="M:CefSharp.IFrame.LoadStringForUrl(System.String,System.String)">
  2648. <summary>
  2649. Load the contents of html with the specified dummy url.
  2650. </summary>
  2651. <param name="html">html to be loaded</param>
  2652. <param name="url"> should have a standard scheme (for example, http scheme) or behaviors like
  2653. link clicks and web security restrictions may not behave as expected.</param>
  2654. </member>
  2655. <member name="M:CefSharp.IFrame.ExecuteJavaScriptAsync(System.String,System.String,System.Int32)">
  2656. <summary>
  2657. Execute a string of JavaScript code in this frame.
  2658. </summary>
  2659. <param name="code">Javascript to execute</param>
  2660. <param name="scriptUrl">is the URL where the script in question can be found, if any.
  2661. The renderer may request this URL to show the developer the source of the error.</param>
  2662. <param name="startLine">is the base line number to use for error reporting.</param>
  2663. </member>
  2664. <member name="M:CefSharp.IFrame.EvaluateScriptAsync(System.String,System.Nullable{System.TimeSpan})">
  2665. <summary>
  2666. Execute some Javascript code in the context of this WebBrowser, and return the result of the evaluation
  2667. in an Async fashion
  2668. </summary>
  2669. <param name="script">The Javascript code that should be executed.</param>
  2670. <param name="timeout">The timeout after which the Javascript code execution should be aborted.</param>
  2671. <returns>A Task that can be awaited to perform the script execution</returns>
  2672. </member>
  2673. <member name="M:CefSharp.IFrame.CreateRequest(System.Boolean)">
  2674. <summary>
  2675. Create a custom request for use with <see cref="M:CefSharp.IFrame.LoadRequest(CefSharp.IRequest)"/>
  2676. </summary>
  2677. <param name="initializePostData">Initialize the PostData object when creating this request</param>
  2678. <returns>A new instance of the request</returns>
  2679. </member>
  2680. <member name="P:CefSharp.IFrame.IsValid">
  2681. <summary>
  2682. True if this object is currently attached to a valid frame.
  2683. </summary>
  2684. </member>
  2685. <member name="P:CefSharp.IFrame.IsMain">
  2686. <summary>
  2687. Returns true if this is the main (top-level) frame.
  2688. </summary>
  2689. </member>
  2690. <member name="P:CefSharp.IFrame.IsFocused">
  2691. <summary>
  2692. Returns true if this is the focused frame.
  2693. </summary>
  2694. </member>
  2695. <member name="P:CefSharp.IFrame.Name">
  2696. <summary>
  2697. Returns the name for this frame. If the frame has an assigned name (for
  2698. example, set via the iframe "name" attribute) then that value will be
  2699. returned. Otherwise a unique name will be constructed based on the frame
  2700. parent hierarchy. The main (top-level) frame will always have an empty name
  2701. value.
  2702. </summary>
  2703. </member>
  2704. <member name="P:CefSharp.IFrame.Identifier">
  2705. <summary>
  2706. Returns the globally unique identifier for this frame.
  2707. </summary>
  2708. </member>
  2709. <member name="P:CefSharp.IFrame.Parent">
  2710. <summary>
  2711. Returns the parent of this frame or NULL if this is the main (top-level) frame.
  2712. </summary>
  2713. </member>
  2714. <member name="P:CefSharp.IFrame.Url">
  2715. <summary>
  2716. Returns the URL currently loaded in this frame.
  2717. </summary>
  2718. </member>
  2719. <member name="P:CefSharp.IFrame.Browser">
  2720. <summary>
  2721. Returns the browser that this frame belongs to.
  2722. </summary>
  2723. </member>
  2724. <member name="P:CefSharp.IFrame.IsDisposed">
  2725. <summary>
  2726. Gets a value indicating whether the frame has been disposed of.
  2727. </summary>
  2728. </member>
  2729. <member name="T:CefSharp.IGeolocationCallback">
  2730. <summary>
  2731. Callback interface used for asynchronous continuation of geolocation permission requests.
  2732. </summary>
  2733. </member>
  2734. <member name="M:CefSharp.IGeolocationCallback.Continue(System.Boolean)">
  2735. <summary>
  2736. Call to allow or deny geolocation access.
  2737. </summary>
  2738. <param name="allow">true to allow</param>
  2739. </member>
  2740. <member name="P:CefSharp.IGeolocationCallback.IsDisposed">
  2741. <summary>
  2742. Gets a value indicating whether the callback has been disposed of.
  2743. </summary>
  2744. </member>
  2745. <member name="P:CefSharp.IJavascriptCallback.CanExecute">
  2746. <summary>
  2747. Check to see if the underlying resource are still available to execute the callback
  2748. </summary>
  2749. </member>
  2750. <member name="P:CefSharp.IJavascriptCallback.IsDisposed">
  2751. <summary>
  2752. Gets a value indicating whether the callback has been disposed of.
  2753. </summary>
  2754. </member>
  2755. <member name="M:CefSharp.IJsDialogCallback.Continue(System.Boolean,System.String)">
  2756. <summary>
  2757. Continue the Javascript dialog request.
  2758. </summary>
  2759. <param name="success">Set to true if the OK button was pressed.</param>
  2760. <param name="userInput">value should be specified for prompt dialogs.</param>
  2761. </member>
  2762. <member name="M:CefSharp.IJsDialogCallback.Continue(System.Boolean)">
  2763. <summary>
  2764. Continue the Javascript dialog request.
  2765. </summary>
  2766. <param name="success">Set to true if the OK button was pressed.</param>
  2767. </member>
  2768. <member name="P:CefSharp.IJsDialogCallback.IsDisposed">
  2769. <summary>
  2770. Gets a value indicating whether the callback has been disposed of.
  2771. </summary>
  2772. </member>
  2773. <member name="T:CefSharp.Internals.IBrowserAdapter">
  2774. <summary>
  2775. Interface used to break reference cycles in CefSharp.Core C++ code.
  2776. This will ALWAYS be a ManagedCefBrowserAdapter instance.
  2777. </summary>
  2778. </member>
  2779. <member name="T:CefSharp.CefCursorType">
  2780. <summary>
  2781. Cursor type values.
  2782. </summary>
  2783. </member>
  2784. <member name="T:CefSharp.Internals.IJavascriptCallbackFactory">
  2785. <summary>
  2786. Interface to convert a JavascriptCallback dto to a callable implementation.
  2787. </summary>
  2788. </member>
  2789. <member name="M:CefSharp.Internals.IntPtrExtensions.CastToInt32(System.IntPtr)">
  2790. <summary>
  2791. Do an unchecked conversion from IntPtr to int
  2792. so overflow exceptions don't get thrown.
  2793. </summary>
  2794. <param name="intPtr">the IntPtr to cast</param>
  2795. <returns>a 32-bit signed integer</returns>
  2796. </member>
  2797. <member name="T:CefSharp.Internals.PendingTaskRepository`1">
  2798. <summary>
  2799. Class to store TaskCompletionSources indexed by a unique id.
  2800. </summary>
  2801. <typeparam name="TResult">The type of the result produced by the tasks held.</typeparam>
  2802. </member>
  2803. <member name="M:CefSharp.Internals.PendingTaskRepository`1.CreatePendingTask(System.Nullable{System.TimeSpan})">
  2804. <summary>
  2805. Creates a new pending task with a timeout.
  2806. </summary>
  2807. <param name="timeout">The maximum running time of the task.</param>
  2808. <returns>The unique id of the newly created pending task and the newly created <see cref="T:System.Threading.Tasks.TaskCompletionSource`1"/>.</returns>
  2809. </member>
  2810. <member name="M:CefSharp.Internals.PendingTaskRepository`1.RemovePendingTask(System.Int64)">
  2811. <summary>
  2812. Gets and removed pending task by id.
  2813. </summary>
  2814. <param name="id">Unique id of the pending task.</param>
  2815. <returns>
  2816. The <see cref="T:System.Threading.Tasks.TaskCompletionSource`1"/> associated with the given id.
  2817. </returns>
  2818. </member>
  2819. <member name="T:CefSharp.IDisplayHandler">
  2820. <summary>
  2821. Handle events related to browser display state.
  2822. </summary>
  2823. </member>
  2824. <member name="M:CefSharp.IDisplayHandler.OnAddressChanged(CefSharp.IWebBrowser,CefSharp.AddressChangedEventArgs)">
  2825. <summary>
  2826. Called when a frame's address has changed.
  2827. </summary>
  2828. <param name="browserControl">The <see cref="T:CefSharp.IWebBrowser"/> control this popup is related to.</param>
  2829. <param name="addressChangedArgs">args</param>
  2830. </member>
  2831. <member name="M:CefSharp.IDisplayHandler.OnTitleChanged(CefSharp.IWebBrowser,CefSharp.TitleChangedEventArgs)">
  2832. <summary>
  2833. Called when the page title changes.
  2834. </summary>
  2835. <param name="browserControl">The <see cref="T:CefSharp.IWebBrowser"/> control this popup is related to.</param>
  2836. <param name="titleChangedArgs">args</param>
  2837. </member>
  2838. <member name="M:CefSharp.IDisplayHandler.OnFaviconUrlChange(CefSharp.IWebBrowser,CefSharp.IBrowser,System.Collections.Generic.IList{System.String})">
  2839. <summary>
  2840. Called when the page icon changes.
  2841. </summary>
  2842. <param name="browserControl">The ChromiumWebBrowser control</param>
  2843. <param name="browser">the browser object</param>
  2844. <param name="urls">list of urls where the favicons can be downloaded</param>
  2845. </member>
  2846. <member name="M:CefSharp.IDisplayHandler.OnFullscreenModeChange(CefSharp.IWebBrowser,CefSharp.IBrowser,System.Boolean)">
  2847. <summary>
  2848. Called when web content in the page has toggled fullscreen mode. The client is
  2849. responsible for resizing the browser if desired.
  2850. </summary>
  2851. <param name="browserControl">The ChromiumWebBrowser control</param>
  2852. <param name="browser">the browser object</param>
  2853. <param name="fullscreen">If true the content will automatically be sized to fill the browser content area.
  2854. If false the content will automatically return to its original size and position.</param>
  2855. </member>
  2856. <member name="M:CefSharp.IDisplayHandler.OnTooltipChanged(CefSharp.IWebBrowser,System.String)">
  2857. <summary>
  2858. Called when the browser is about to display a tooltip. text contains the
  2859. text that will be displayed in the tooltip. You can optionally modify text
  2860. and then return false to allow the browser to display the tooltip.
  2861. When window rendering is disabled the application is responsible for
  2862. drawing tooltips and the return value is ignored.
  2863. </summary>
  2864. <param name="browserControl">The ChromiumWebBrowser control</param>
  2865. <param name="text">the text that will be displayed in the tooltip</param>
  2866. <returns>To handle the display of the tooltip yourself return true otherwise return false
  2867. to allow the browser to display the tooltip.</returns>
  2868. <remarks>Option to modify tooltip is not currently implemented.</remarks>
  2869. </member>
  2870. <member name="M:CefSharp.IDisplayHandler.OnStatusMessage(CefSharp.IWebBrowser,CefSharp.StatusMessageEventArgs)">
  2871. <summary>
  2872. Called when the browser receives a status message.
  2873. </summary>
  2874. <param name="browserControl">The <see cref="T:CefSharp.IWebBrowser"/> control this popup is related to.</param>
  2875. <param name="statusMessageArgs">args</param>
  2876. </member>
  2877. <member name="M:CefSharp.IDisplayHandler.OnConsoleMessage(CefSharp.IWebBrowser,CefSharp.ConsoleMessageEventArgs)">
  2878. <summary>
  2879. Called to display a console message.
  2880. </summary>
  2881. <param name="browserControl">The ChromiumWebBrowser control</param>
  2882. <param name="consoleMessageArgs">args</param>
  2883. <returns>Return true to stop the message from being output to the console.</returns>
  2884. </member>
  2885. <member name="M:CefSharp.IRequestCallback.Continue(System.Boolean)">
  2886. <summary>
  2887. Continue the url request.
  2888. </summary>
  2889. <param name="allow">If is true the request will be continued, otherwise, the request will be canceled.</param>
  2890. </member>
  2891. <member name="M:CefSharp.IRequestCallback.Cancel">
  2892. <summary>
  2893. Cancel the url request.
  2894. </summary>
  2895. </member>
  2896. <member name="P:CefSharp.IRequestCallback.IsDisposed">
  2897. <summary>
  2898. Gets a value indicating whether the callback has been disposed of.
  2899. </summary>
  2900. </member>
  2901. <member name="T:CefSharp.IResourceHandler">
  2902. <summary>
  2903. Class used to implement a custom resource handler. The methods of this class will always be called on the CEF IO thread.
  2904. Blocking the CEF IO thread will adversely affect browser performance. We suggest you execute your code in a Task (or similar).
  2905. To implement async handling, spawn a new Task (or similar), keep a reference to the callback. When you have a
  2906. fully populated stream, execute the callback. Once the callback Executes, GetResponseHeaders will be called where you
  2907. can modify the response including headers, or even redirect to a new Url. Set your responseLength and headers
  2908. Populate the dataOut stream in ReadResponse. For those looking for a sample implementation or upgrading from
  2909. a previous version <see cref="T:CefSharp.ResourceHandler"/>. For those upgrading, inherit from ResourceHandler instead of IResourceHandler
  2910. add the override keywoard to existing methods e.g. ProcessRequestAsync.
  2911. </summary>
  2912. </member>
  2913. <member name="M:CefSharp.IResourceHandler.ProcessRequest(CefSharp.IRequest,CefSharp.ICallback)">
  2914. <summary>
  2915. Begin processing the request.
  2916. </summary>
  2917. <param name="request">The request object.</param>
  2918. <param name="callback">The callback used to Continue or Cancel the request (async).</param>
  2919. <returns>To handle the request return true and call
  2920. <see cref="M:CefSharp.ICallback.Continue"/> once the response header information is available
  2921. <see cref="M:CefSharp.ICallback.Continue"/> can also be called from inside this method if
  2922. header information is available immediately).
  2923. To cancel the request return false.</returns>
  2924. </member>
  2925. <member name="M:CefSharp.IResourceHandler.GetResponseHeaders(CefSharp.IResponse,System.Int64@,System.String@)">
  2926. <summary>
  2927. Retrieve response header information. If the response length is not known
  2928. set responseLength to -1 and ReadResponse() will be called until it
  2929. returns false. If the response length is known set responseLength
  2930. to a positive value and ReadResponse() will be called until it returns
  2931. false or the specified number of bytes have been read.
  2932. If an error occured while setting up the request you can set <see cref="P:CefSharp.IResponse.ErrorCode"/>
  2933. to indicate the error condition.
  2934. </summary>
  2935. <param name="response">Use the response object to set the mime type, http status code and other optional header values.</param>
  2936. <param name="responseLength">If the response length is not known set responseLength to -1</param>
  2937. <param name="redirectUrl">To redirect the request to a new URL set redirectUrl to the new Url.</param>
  2938. </member>
  2939. <member name="M:CefSharp.IResourceHandler.ReadResponse(System.IO.Stream,System.Int32@,CefSharp.ICallback)">
  2940. <summary>
  2941. Read response data. If data is available immediately copy to
  2942. dataOut, set bytesRead to the number of bytes copied, and return true.
  2943. To read the data at a later time set bytesRead to 0, return true and call ICallback.Continue() when the
  2944. data is available. To indicate response completion return false.
  2945. </summary>
  2946. <param name="dataOut">Stream to write to</param>
  2947. <param name="bytesRead">Number of bytes copied to the stream</param>
  2948. <param name="callback">The callback used to Continue or Cancel the request (async).</param>
  2949. <returns>If data is available immediately copy to dataOut, set bytesRead to the number of bytes copied,
  2950. and return true.To indicate response completion return false.</returns>
  2951. <remarks>Depending on this size of your response this method may be called multiple times</remarks>
  2952. </member>
  2953. <member name="M:CefSharp.IResourceHandler.CanGetCookie(CefSharp.Cookie)">
  2954. <summary>
  2955. Return true if the specified cookie can be sent with the request or false
  2956. otherwise. If false is returned for any cookie then no cookies will be sent
  2957. with the request.
  2958. </summary>
  2959. <param name="cookie">cookie</param>
  2960. <returns>Return true if the specified cookie can be sent with the request or false
  2961. otherwise. If false is returned for any cookie then no cookies will be sent
  2962. with the request.</returns>
  2963. </member>
  2964. <member name="M:CefSharp.IResourceHandler.CanSetCookie(CefSharp.Cookie)">
  2965. <summary>
  2966. Return true if the specified cookie returned with the response can be set or false otherwise.
  2967. </summary>
  2968. <param name="cookie">cookie</param>
  2969. <returns>Return true if the specified cookie returned with the response can be set or false otherwise.</returns>
  2970. </member>
  2971. <member name="M:CefSharp.IResourceHandler.Cancel">
  2972. <summary>
  2973. Request processing has been canceled.
  2974. </summary>
  2975. </member>
  2976. <member name="P:CefSharp.IResponse.MimeType">
  2977. <summary>
  2978. MimeType
  2979. </summary>
  2980. </member>
  2981. <member name="P:CefSharp.IResponse.ResponseHeaders">
  2982. <summary>
  2983. Response Headers
  2984. </summary>
  2985. </member>
  2986. <member name="P:CefSharp.IResponse.IsReadOnly">
  2987. <summary>
  2988. Returns true if this object is read-only.
  2989. </summary>
  2990. </member>
  2991. <member name="P:CefSharp.IResponse.ErrorCode">
  2992. <summary>
  2993. Get/set the response error code.
  2994. </summary>
  2995. </member>
  2996. <member name="P:CefSharp.IResponse.StatusCode">
  2997. <summary>
  2998. The status code of the response. Unless set, the default value used is 200
  2999. (corresponding to HTTP status OK).
  3000. </summary>
  3001. </member>
  3002. <member name="P:CefSharp.IResponse.StatusText">
  3003. <summary>
  3004. Status Text
  3005. </summary>
  3006. </member>
  3007. <member name="M:CefSharp.IWindowInfo.SetAsWindowless(System.IntPtr,System.Boolean)">
  3008. <summary>
  3009. Create the browser using windowless (off-screen) rendering.
  3010. No window will be created for the browser and all rendering will occur via the CefRenderHandler interface.
  3011. </summary>
  3012. <param name="parentHandle">Value will be used to identify monitor info and to act as the parent window for dialogs, context menus, etc.
  3013. If not provided then the main screen monitor will be used and some functionality that requires a parent window may not function correctly.</param>
  3014. <param name="transparent">If is true a transparent background color will be used (RGBA=0x00000000).
  3015. If is false the background will be white and opaque.
  3016. In order to create windowless browsers the CefSettings.windowless_rendering_enabled value must be set to true.</param>
  3017. </member>
  3018. <member name="T:CefSharp.MouseEvent">
  3019. <summary>
  3020. Class representing a mouse event.
  3021. </summary>
  3022. </member>
  3023. <member name="P:CefSharp.MouseEvent.X">
  3024. <summary>
  3025. X coordinate relative to the left side of the view.
  3026. </summary>
  3027. </member>
  3028. <member name="P:CefSharp.MouseEvent.Y">
  3029. <summary>
  3030. Y coordinate relative to the top side of the view.
  3031. </summary>
  3032. </member>
  3033. <member name="P:CefSharp.MouseEvent.Modifiers">
  3034. <summary>
  3035. Bit flags describing any pressed modifier keys.
  3036. </summary>
  3037. </member>
  3038. <member name="T:CefSharp.DragOperationsMask">
  3039. <summary>
  3040. "Verb" of a drag-and-drop operation as negotiated between the source and destination.
  3041. </summary>
  3042. </member>
  3043. <member name="T:CefSharp.IBitmapFactory">
  3044. <summary>
  3045. Factory class used to generate a BitmapInfo object for OSR rendering (WPF and OffScreen projects)
  3046. Implement this interface if you wish to render the underlying Bitmap to a custom type
  3047. e.g. a GDI Bitmap in the WPF Control
  3048. </summary>
  3049. </member>
  3050. <member name="M:CefSharp.IBitmapFactory.CreateBitmap(System.Boolean,System.Double)">
  3051. <summary>
  3052. Create an instance of BitmapInfo based on the params
  3053. </summary>
  3054. <param name="isPopup">create bitmap info for a popup (typically just a bool flag used internally)</param>
  3055. <param name="dpiScale">DPI scale</param>
  3056. <returns>newly created BitmapInfo</returns>
  3057. </member>
  3058. <member name="T:CefSharp.IDragData">
  3059. <summary>
  3060. Used to represent drag data.
  3061. </summary>
  3062. </member>
  3063. <member name="M:CefSharp.IDragData.AddFile(System.String,System.String)">
  3064. <summary>
  3065. Add a file that is being dragged into the webview.
  3066. </summary>
  3067. <param name="path">File Path</param>
  3068. <param name="displayName">Optional Display Name</param>
  3069. </member>
  3070. <member name="M:CefSharp.IDragData.ResetFileContents">
  3071. <summary>
  3072. Reset the file contents. You should do this before calling
  3073. CefBrowserHost::DragTargetDragEnter as the web view does not allow us to
  3074. drag in this kind of data.
  3075. </summary>
  3076. </member>
  3077. <member name="M:CefSharp.IDragData.GetFileContents">
  3078. <summary>
  3079. Gets the contents of the File as a <see cref="T:System.IO.Stream"/>
  3080. For a suggested filename check the <see cref="P:CefSharp.IDragData.FileName"/> property
  3081. </summary>
  3082. <returns>the contents of the file</returns>
  3083. </member>
  3084. <member name="P:CefSharp.IDragData.IsReadOnly">
  3085. <summary>
  3086. Returns true if this object is read-only.
  3087. </summary>
  3088. </member>
  3089. <member name="P:CefSharp.IDragData.FileName">
  3090. <summary>
  3091. Return the name of the file being dragged out of the browser window.
  3092. </summary>
  3093. </member>
  3094. <member name="P:CefSharp.IDragData.FileNames">
  3095. <summary>
  3096. Retrieve the list of file names that are being dragged into the browser window
  3097. </summary>
  3098. </member>
  3099. <member name="P:CefSharp.IDragData.FragmentBaseUrl">
  3100. <summary>
  3101. Return the base URL that the fragment came from. This value is used for resolving relative URLs and may be empty.
  3102. </summary>
  3103. </member>
  3104. <member name="P:CefSharp.IDragData.FragmentHtml">
  3105. <summary>
  3106. Return the text/html fragment that is being dragged.
  3107. </summary>
  3108. </member>
  3109. <member name="P:CefSharp.IDragData.FragmentText">
  3110. <summary>
  3111. Return the plain text fragment that is being dragged.
  3112. </summary>
  3113. </member>
  3114. <member name="P:CefSharp.IDragData.LinkMetaData">
  3115. <summary>
  3116. Return the metadata, if any, associated with the link being dragged.
  3117. </summary>
  3118. </member>
  3119. <member name="P:CefSharp.IDragData.LinkTitle">
  3120. <summary>
  3121. Return the title associated with the link being dragged.
  3122. </summary>
  3123. </member>
  3124. <member name="P:CefSharp.IDragData.LinkUrl">
  3125. <summary>
  3126. Return the link URL that is being dragged.
  3127. </summary>
  3128. </member>
  3129. <member name="P:CefSharp.IDragData.IsFile">
  3130. <summary>
  3131. Returns true if the drag data is a file.
  3132. </summary>
  3133. </member>
  3134. <member name="P:CefSharp.IDragData.IsFragment">
  3135. <summary>
  3136. Returns true if the drag data is a text or html fragment.
  3137. </summary>
  3138. </member>
  3139. <member name="P:CefSharp.IDragData.IsLink">
  3140. <summary>
  3141. Returns true if the drag data is a link
  3142. </summary>
  3143. </member>
  3144. <member name="P:CefSharp.IDragData.IsDisposed">
  3145. <summary>
  3146. Gets a value indicating whether the object has been disposed of.
  3147. </summary>
  3148. </member>
  3149. <member name="T:CefSharp.IFocusHandler">
  3150. <summary>
  3151. Implement this interface to handle events related to focus.
  3152. The methods of this class will be called on the CEF UI thread.
  3153. </summary>
  3154. </member>
  3155. <member name="M:CefSharp.IFocusHandler.OnGotFocus">
  3156. <summary>
  3157. Called when the browser component has received focus.
  3158. </summary>
  3159. </member>
  3160. <member name="M:CefSharp.IFocusHandler.OnSetFocus(CefSharp.CefFocusSource)">
  3161. <summary>
  3162. Called when the browser component is requesting focus.
  3163. </summary>
  3164. <param name="source">Indicates where the focus request is originating from.</param>
  3165. <returns>Return false to allow the focus to be set or true to cancel setting the focus.</returns>
  3166. </member>
  3167. <member name="M:CefSharp.IFocusHandler.OnTakeFocus(System.Boolean)">
  3168. <summary>
  3169. Called when the browser component is about to lose focus.
  3170. For instance, if focus was on the last HTML element and the user pressed the TAB key.
  3171. </summary>
  3172. <param name="next">Will be true if the browser is giving focus to the next component
  3173. and false if the browser is giving focus to the previous component.</param>
  3174. </member>
  3175. <member name="T:CefSharp.IDragHandler">
  3176. <summary>
  3177. Implement this interface to handle events related to dragging.
  3178. The methods of this class will be called on the UI thread.
  3179. </summary>
  3180. </member>
  3181. <member name="M:CefSharp.IDragHandler.OnDragEnter(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IDragData,CefSharp.DragOperationsMask)">
  3182. <summary>
  3183. Called when an external drag event enters the browser window.
  3184. </summary>
  3185. <param name="browserControl">the ChromiumWebBrowser control</param>
  3186. <param name="browser">the browser object</param>
  3187. <param name="dragData">contains the drag event data</param>
  3188. <param name="mask">represents the type of drag operation</param>
  3189. <returns>Return false for default drag handling behavior or true to cancel the drag event. </returns>
  3190. </member>
  3191. <member name="M:CefSharp.IDragHandler.OnDraggableRegionsChanged(CefSharp.IWebBrowser,CefSharp.IBrowser,System.Collections.Generic.IList{CefSharp.DraggableRegion})">
  3192. <summary>
  3193. Called whenever draggable regions for the browser window change.
  3194. These can be specified using the '-webkit-app-region: drag/no-drag' CSS-property.
  3195. If draggable regions are never defined in a document this method will also never be called.
  3196. If the last draggable region is removed from a document this method will be called with an empty IList.
  3197. </summary>
  3198. <param name="browserControl">the ChromiumWebBrowser control</param>
  3199. <param name="browser">the browser object</param>
  3200. <param name="regions">List of <see cref="T:CefSharp.DraggableRegion"/> objects or null if last region was removed.</param>
  3201. </member>
  3202. <member name="T:CefSharp.IGeolocationHandler">
  3203. <summary>
  3204. Implement this interface to handle events related to geolocation permission requests.
  3205. The methods of this class will be called on the CEF UI thread.
  3206. </summary>
  3207. </member>
  3208. <member name="M:CefSharp.IGeolocationHandler.OnRequestGeolocationPermission(CefSharp.IWebBrowser,CefSharp.IBrowser,System.String,System.Int32,CefSharp.IGeolocationCallback)">
  3209. <summary>
  3210. Called when a page requests permission to access geolocation information.
  3211. </summary>
  3212. <param name="browserControl">the browser control</param>
  3213. <param name="browser">the browser object</param>
  3214. <param name="requestingUrl">the URL requesting permission</param>
  3215. <param name="requestId">the unique ID for the permission request</param>
  3216. <param name="callback">Callback interface used for asynchronous continuation of geolocation permission requests.</param>
  3217. <returns>true to allow the request and false to deny</returns>
  3218. </member>
  3219. <member name="M:CefSharp.IGeolocationHandler.OnCancelGeolocationPermission(CefSharp.IWebBrowser,CefSharp.IBrowser,System.Int32)">
  3220. <summary>
  3221. Called when a geolocation access request is canceled.
  3222. </summary>
  3223. <param name="browserControl">the browser control</param>
  3224. <param name="browser">the browser object</param>
  3225. <param name="requestId">the unique ID for the permission request, as seen in <see cref="M:CefSharp.IGeolocationHandler.OnRequestGeolocationPermission(CefSharp.IWebBrowser,CefSharp.IBrowser,System.String,System.Int32,CefSharp.IGeolocationCallback)"/></param>
  3226. </member>
  3227. <member name="T:CefSharp.IsBrowserInitializedChangedEventArgs">
  3228. <summary>
  3229. Event arguments to the IsBrowserInitializedChanged event handler.
  3230. </summary>
  3231. </member>
  3232. <member name="T:CefSharp.CefTerminationStatus">
  3233. <summary>
  3234. Process termination status values.
  3235. </summary>
  3236. </member>
  3237. <member name="F:CefSharp.CefTerminationStatus.AbnormalTermination">
  3238. <summary>
  3239. Non-zero exit status.
  3240. </summary>
  3241. </member>
  3242. <member name="F:CefSharp.CefTerminationStatus.ProcessWasKilled">
  3243. <summary>
  3244. SIGKILL or task manager kill.
  3245. </summary>
  3246. </member>
  3247. <member name="F:CefSharp.CefTerminationStatus.ProcessCrashed">
  3248. <summary>
  3249. Segmentation fault.
  3250. </summary>
  3251. </member>
  3252. <member name="T:CefSharp.IDialogHandler">
  3253. <summary>
  3254. Implement this interface to handle dialog events. The methods of this class will be called on the CEF UI thread.
  3255. </summary>
  3256. </member>
  3257. <member name="M:CefSharp.IDialogHandler.OnFileDialog(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.CefFileDialogMode,System.String,System.String,System.Collections.Generic.List{System.String},System.Int32,CefSharp.IFileDialogCallback)">
  3258. <summary>
  3259. Runs a file chooser dialog.
  3260. </summary>
  3261. <example>
  3262. To test assign something like TempFileDialogHandler (from CefSharp.Example) to DialogHandler e.g.
  3263. <code>
  3264. browser.DialogHandler = new TempFileDialogHandler();
  3265. </code>
  3266. Example URL to use for file browsing http://www.cs.tut.fi/~jkorpela/forms/file.html#example
  3267. Simply click browse, the space next to the browse button should be populated with a randomly generated filename.
  3268. </example>
  3269. <param name="browserControl">the browser control</param>
  3270. <param name="browser">the browser object</param>
  3271. <param name="mode">represents the type of dialog to display</param>
  3272. <param name="title">the title to be used for the dialog. It may be empty to show the default title ("Open" or "Save"
  3273. depending on the mode).</param>
  3274. <param name="defaultFilePath">is the path with optional directory and/or file name component that
  3275. should be initially selected in the dialog.</param>
  3276. <param name="acceptFilters">are used to restrict the selectable file types and may any combination of
  3277. (a) valid lower-cased MIME types (e.g. "text/*" or "image/*"),
  3278. (b) individual file extensions (e.g. ".txt" or ".png"),
  3279. (c) combined description and file extension delimited using "|" and ";" (e.g. "Image Types|.png;.gif;.jpg").</param>
  3280. <param name="selectedAcceptFilter">is the 0-based index of the filter that should be selected by default.</param>
  3281. <param name="callback">Callback interface for asynchronous continuation of file dialog requests.</param>
  3282. <returns>To display a custom dialog return true. To display the default dialog return false.</returns>
  3283. </member>
  3284. <member name="T:CefSharp.AddressChangedEventArgs">
  3285. <summary>
  3286. Event arguments for the AddressChanged event handler.
  3287. </summary>
  3288. </member>
  3289. <member name="M:CefSharp.AddressChangedEventArgs.#ctor(CefSharp.IBrowser,System.String)">
  3290. <summary>
  3291. Creates a new AddressChangedEventArgs event argument.
  3292. </summary>
  3293. <param name="browser">the browser object</param>
  3294. <param name="address">the address</param>
  3295. </member>
  3296. <member name="P:CefSharp.AddressChangedEventArgs.Browser">
  3297. <summary>
  3298. Access to the underlying <see cref="T:CefSharp.IBrowser"/> object
  3299. </summary>
  3300. </member>
  3301. <member name="P:CefSharp.AddressChangedEventArgs.Address">
  3302. <summary>
  3303. The new address
  3304. </summary>
  3305. </member>
  3306. <member name="T:CefSharp.DownloadItem">
  3307. <summary>
  3308. Class used to represent a download item.
  3309. </summary>
  3310. </member>
  3311. <member name="P:CefSharp.DownloadItem.IsValid">
  3312. <summary>
  3313. Returns true if this object is valid. Do not call any other methods if this function returns false.
  3314. </summary>
  3315. </member>
  3316. <member name="P:CefSharp.DownloadItem.IsInProgress">
  3317. <summary>
  3318. Returns true if the download is in progress.
  3319. </summary>
  3320. </member>
  3321. <member name="P:CefSharp.DownloadItem.IsComplete">
  3322. <summary>
  3323. Returns true if the download is complete.
  3324. </summary>
  3325. </member>
  3326. <member name="P:CefSharp.DownloadItem.IsCancelled">
  3327. <summary>
  3328. Returns true if the download has been canceled or interrupted.
  3329. </summary>
  3330. </member>
  3331. <member name="P:CefSharp.DownloadItem.CurrentSpeed">
  3332. <summary>
  3333. Returns a simple speed estimate in bytes/s.
  3334. </summary>
  3335. </member>
  3336. <member name="P:CefSharp.DownloadItem.PercentComplete">
  3337. <summary>
  3338. Returns the rough percent complete or -1 if the receive total size is unknown.
  3339. </summary>
  3340. </member>
  3341. <member name="P:CefSharp.DownloadItem.TotalBytes">
  3342. <summary>
  3343. Returns the total number of bytes.
  3344. </summary>
  3345. </member>
  3346. <member name="P:CefSharp.DownloadItem.ReceivedBytes">
  3347. <summary>
  3348. Returns the number of received bytes.
  3349. </summary>
  3350. </member>
  3351. <member name="P:CefSharp.DownloadItem.StartTime">
  3352. <summary>
  3353. Returns the time that the download started
  3354. </summary>
  3355. </member>
  3356. <member name="P:CefSharp.DownloadItem.EndTime">
  3357. <summary>
  3358. Returns the time that the download ended
  3359. </summary>
  3360. </member>
  3361. <member name="P:CefSharp.DownloadItem.FullPath">
  3362. <summary>
  3363. Returns the full path to the downloaded or downloading file.
  3364. </summary>
  3365. </member>
  3366. <member name="P:CefSharp.DownloadItem.Id">
  3367. <summary>
  3368. Returns the unique identifier for this download.
  3369. </summary>
  3370. </member>
  3371. <member name="P:CefSharp.DownloadItem.Url">
  3372. <summary>
  3373. Returns the URL.
  3374. </summary>
  3375. </member>
  3376. <member name="P:CefSharp.DownloadItem.SuggestedFileName">
  3377. <summary>
  3378. Returns the suggested file name.
  3379. </summary>
  3380. </member>
  3381. <member name="P:CefSharp.DownloadItem.ContentDisposition">
  3382. <summary>
  3383. Returns the content disposition.
  3384. </summary>
  3385. </member>
  3386. <member name="P:CefSharp.DownloadItem.MimeType">
  3387. <summary>
  3388. Returns the mime type.
  3389. </summary>
  3390. </member>
  3391. <member name="T:CefSharp.CefEventFlags">
  3392. <summary>
  3393. Supported event bit flags.
  3394. </summary>
  3395. </member>
  3396. <member name="F:CefSharp.CefEventFlags.CommandDown">
  3397. <summary>
  3398. Mac OS-X command key.
  3399. </summary>
  3400. </member>
  3401. <member name="T:CefSharp.Internals.TaskExtensions">
  3402. <summary>
  3403. TaskExtension based on the following
  3404. https://github.com/ChadBurggraf/parallel-extensions-extras/blob/master/Extensions/TaskExtrasExtensions.cs
  3405. https://github.com/ChadBurggraf/parallel-extensions-extras/blob/ec803e58eee28c698e44f55f49c5ad6671b1aa58/Extensions/TaskCompletionSourceExtensions.cs
  3406. </summary>
  3407. </member>
  3408. <member name="M:CefSharp.Internals.TaskExtensions.WithTimeout``1(System.Threading.Tasks.Task{``0},System.TimeSpan)">
  3409. <summary>Creates a new Task that mirrors the supplied task but that will be canceled after the specified timeout.</summary>
  3410. <typeparam name="TResult">Specifies the type of data contained in the task.</typeparam>
  3411. <param name="task">The task.</param>
  3412. <param name="timeout">The timeout.</param>
  3413. <returns>The new Task that may time out.</returns>
  3414. </member>
  3415. <member name="M:CefSharp.Internals.TaskExtensions.TrySetFromTask``1(System.Threading.Tasks.TaskCompletionSource{``0},System.Threading.Tasks.Task)">
  3416. <summary>Attempts to transfer the result of a Task to the TaskCompletionSource.</summary>
  3417. <typeparam name="TResult">Specifies the type of the result.</typeparam>
  3418. <param name="resultSetter">The TaskCompletionSource.</param>
  3419. <param name="task">The task whose completion results should be transfered.</param>
  3420. <returns>Whether the transfer could be completed.</returns>
  3421. </member>
  3422. <member name="M:CefSharp.Internals.TaskExtensions.TrySetFromTask``1(System.Threading.Tasks.TaskCompletionSource{``0},System.Threading.Tasks.Task{``0})">
  3423. <summary>Attempts to transfer the result of a Task to the TaskCompletionSource.</summary>
  3424. <typeparam name="TResult">Specifies the type of the result.</typeparam>
  3425. <param name="resultSetter">The TaskCompletionSource.</param>
  3426. <param name="task">The task whose completion results should be transfered.</param>
  3427. <returns>Whether the transfer could be completed.</returns>
  3428. </member>
  3429. <member name="M:CefSharp.Internals.TaskExtensions.TrySetResultAsync``1(System.Threading.Tasks.TaskCompletionSource{``0},``0)">
  3430. <summary>
  3431. Set the TaskCompletionSource in an async fashion. This prevents the Task Continuation being executed sync on the same thread
  3432. This is required otherwise contintinuations will happen on CEF UI threads
  3433. </summary>
  3434. <typeparam name="TResult">Generic param</typeparam>
  3435. <param name="taskCompletionSource">tcs</param>
  3436. <param name="result">result</param>
  3437. </member>
  3438. <member name="T:CefSharp.IStringVisitor">
  3439. <summary>
  3440. Implement this interface to receive string values asynchronously.
  3441. </summary>
  3442. </member>
  3443. <member name="M:CefSharp.IStringVisitor.Visit(System.String)">
  3444. <summary>
  3445. Method that will be executed.
  3446. </summary>
  3447. <param name="str">string (result of async execution)</param>
  3448. </member>
  3449. <member name="T:CefSharp.IContextMenuParams">
  3450. <summary>
  3451. Wrapper for the CefContextMenuParams
  3452. </summary>
  3453. </member>
  3454. <member name="P:CefSharp.IContextMenuParams.YCoord">
  3455. <summary>
  3456. Returns the Y coordinate of the mouse where the context menu was invoked.
  3457. Coords are relative to the associated RenderView's origin.
  3458. </summary>
  3459. </member>
  3460. <member name="P:CefSharp.IContextMenuParams.XCoord">
  3461. <summary>
  3462. Returns the X coordinate of the mouse where the context menu was invoked.
  3463. Coords are relative to the associated RenderView's origin.
  3464. </summary>
  3465. </member>
  3466. <member name="P:CefSharp.IContextMenuParams.TypeFlags">
  3467. <summary>
  3468. Returns flags representing the type of node that the context menu was invoked on.
  3469. </summary>
  3470. </member>
  3471. <member name="P:CefSharp.IContextMenuParams.LinkUrl">
  3472. <summary>
  3473. Returns the URL of the link, if any, that encloses the node that the
  3474. context menu was invoked on.
  3475. </summary>
  3476. </member>
  3477. <member name="P:CefSharp.IContextMenuParams.UnfilteredLinkUrl">
  3478. <summary>
  3479. Returns the link URL, if any, to be used ONLY for "copy link address". We
  3480. don't validate this field in the frontend process.
  3481. </summary>
  3482. </member>
  3483. <member name="P:CefSharp.IContextMenuParams.SourceUrl">
  3484. <summary>
  3485. Returns the source URL, if any, for the element that the context menu was
  3486. invoked on. Example of elements with source URLs are img, audio, and video.
  3487. </summary>
  3488. </member>
  3489. <member name="P:CefSharp.IContextMenuParams.HasImageContents">
  3490. <summary>
  3491. Returns true if the context menu was invoked on an image which has
  3492. non-empty contents.
  3493. </summary>
  3494. </member>
  3495. <member name="P:CefSharp.IContextMenuParams.PageUrl">
  3496. <summary>
  3497. Returns the URL of the top level page that the context menu was invoked on.
  3498. </summary>
  3499. </member>
  3500. <member name="P:CefSharp.IContextMenuParams.FrameUrl">
  3501. <summary>
  3502. Returns the URL of the subframe that the context menu was invoked on.
  3503. </summary>
  3504. </member>
  3505. <member name="P:CefSharp.IContextMenuParams.FrameCharset">
  3506. <summary>
  3507. Returns the character encoding of the subframe that the context menu was
  3508. invoked on.
  3509. </summary>
  3510. </member>
  3511. <member name="P:CefSharp.IContextMenuParams.MediaType">
  3512. <summary>
  3513. Returns the type of context node that the context menu was invoked on.
  3514. </summary>
  3515. </member>
  3516. <member name="P:CefSharp.IContextMenuParams.MediaStateFlags">
  3517. <summary>
  3518. Returns flags representing the actions supported by the media element, if
  3519. any, that the context menu was invoked on.
  3520. </summary>
  3521. </member>
  3522. <member name="P:CefSharp.IContextMenuParams.SelectionText">
  3523. <summary>
  3524. Returns the text of the selection, if any, that the context menu was
  3525. invoked on.
  3526. </summary>
  3527. </member>
  3528. <member name="P:CefSharp.IContextMenuParams.MisspelledWord">
  3529. <summary>
  3530. Returns the text of the misspelled word, if any, that the context menu was
  3531. invoked on.
  3532. </summary>
  3533. </member>
  3534. <member name="P:CefSharp.IContextMenuParams.DictionarySuggestions">
  3535. <summary>
  3536. Returns a list of strings from the spell check service for the misspelled word if there is one.
  3537. </summary>
  3538. </member>
  3539. <member name="P:CefSharp.IContextMenuParams.IsEditable">
  3540. <summary>
  3541. Returns true if the context menu was invoked on an editable node.
  3542. </summary>
  3543. </member>
  3544. <member name="P:CefSharp.IContextMenuParams.IsSpellCheckEnabled">
  3545. <summary>
  3546. Returns true if the context menu was invoked on an editable node where
  3547. spell-check is enabled.
  3548. </summary>
  3549. </member>
  3550. <member name="P:CefSharp.IContextMenuParams.EditStateFlags">
  3551. <summary>
  3552. Returns flags representing the actions supported by the editable node, if
  3553. any, that the context menu was invoked on.
  3554. </summary>
  3555. <returns>Returns ContextMenuEditState as flags</returns>
  3556. </member>
  3557. <member name="P:CefSharp.IContextMenuParams.IsCustomMenu">
  3558. <summary>
  3559. Returns true if the context menu contains items specified by the renderer
  3560. process (for example, plugin placeholder or pepper plugin menu items).
  3561. </summary>
  3562. </member>
  3563. <member name="P:CefSharp.IContextMenuParams.IsPepperMenu">
  3564. <summary>
  3565. Returns true if the context menu was invoked from a pepper plugin.
  3566. </summary>
  3567. </member>
  3568. <member name="P:CefSharp.IContextMenuParams.IsDisposed">
  3569. <summary>
  3570. Gets a value indicating whether the object has been disposed of.
  3571. </summary>
  3572. </member>
  3573. <member name="T:CefSharp.JavascriptIgnoreAttribute">
  3574. <summary>
  3575. JavascriptIgnoreAttribute - Methods and Properties marked with this attribute
  3576. will be excluded from Javascript Binding
  3577. </summary>
  3578. </member>
  3579. <member name="T:CefSharp.LoadErrorEventArgs">
  3580. <summary>
  3581. Event arguments to the LoadError event handler set up in IWebBrowser.
  3582. </summary>
  3583. </member>
  3584. <member name="P:CefSharp.LoadErrorEventArgs.Browser">
  3585. <summary>
  3586. The browser object
  3587. </summary>
  3588. </member>
  3589. <member name="P:CefSharp.LoadErrorEventArgs.Frame">
  3590. <summary>
  3591. The frame that failed to load.
  3592. </summary>
  3593. </member>
  3594. <member name="P:CefSharp.LoadErrorEventArgs.FailedUrl">
  3595. <summary>
  3596. The URL that failed to load.
  3597. </summary>
  3598. </member>
  3599. <member name="P:CefSharp.LoadErrorEventArgs.ErrorCode">
  3600. <summary>
  3601. The error code.
  3602. </summary>
  3603. </member>
  3604. <member name="P:CefSharp.LoadErrorEventArgs.ErrorText">
  3605. <summary>
  3606. The error text.
  3607. </summary>
  3608. </member>
  3609. <member name="T:CefSharp.FrameLoadStartEventArgs">
  3610. <summary>
  3611. Event arguments to the FrameLoadStart event handler set up in IWebBrowser.
  3612. </summary>
  3613. </member>
  3614. <member name="M:CefSharp.FrameLoadStartEventArgs.#ctor(CefSharp.IBrowser,CefSharp.IFrame)">
  3615. <summary>
  3616. Creates a new FrameLoadStart event args
  3617. </summary>
  3618. <param name="browser">browser</param>
  3619. <param name="frame">frame</param>
  3620. </member>
  3621. <member name="P:CefSharp.FrameLoadStartEventArgs.Browser">
  3622. <summary>
  3623. The browser object
  3624. </summary>
  3625. </member>
  3626. <member name="P:CefSharp.FrameLoadStartEventArgs.Frame">
  3627. <summary>
  3628. The frame that just started loading.
  3629. </summary>
  3630. </member>
  3631. <member name="P:CefSharp.FrameLoadStartEventArgs.Url">
  3632. <summary>
  3633. The URL that was loaded.
  3634. </summary>
  3635. </member>
  3636. <member name="T:CefSharp.PaintElementType">
  3637. <summary>
  3638. Paint element types.
  3639. </summary>
  3640. </member>
  3641. <member name="T:CefSharp.PluginPolicy">
  3642. <summary>
  3643. Plugin policies supported by IPluginHandler.OnBeforePluginLoad.
  3644. </summary>
  3645. </member>
  3646. <member name="F:CefSharp.PluginPolicy.Allow">
  3647. <summary>
  3648. Allow the content
  3649. </summary>
  3650. </member>
  3651. <member name="F:CefSharp.PluginPolicy.DetectImportant">
  3652. <summary>
  3653. Allow important content and block unimportant content based on heuristics. The user can manually load blocked content.
  3654. </summary>
  3655. </member>
  3656. <member name="F:CefSharp.PluginPolicy.Block">
  3657. <summary>
  3658. Block the content. The user can manually load blocked content.
  3659. </summary>
  3660. </member>
  3661. <member name="F:CefSharp.PluginPolicy.Disable">
  3662. <summary>
  3663. Disable the content. The user cannot load disabled content.
  3664. </summary>
  3665. </member>
  3666. <member name="T:CefSharp.PostDataElementType">
  3667. <summary>
  3668. Post data elements may represent either bytes or files.
  3669. </summary>
  3670. </member>
  3671. <member name="M:CefSharp.PostDataExtensions.GetCharSet(CefSharp.IRequest)">
  3672. <summary>
  3673. A convenience extension method that extracts the Character set from
  3674. the content-type header. Can be used in conjuncation with <see cref="M:CefSharp.PostDataExtensions.GetBody(CefSharp.IPostDataElement,System.String)"/>
  3675. </summary>
  3676. <param name="request">the request</param>
  3677. <returns>character set e.g. UTF-8</returns>
  3678. </member>
  3679. <member name="M:CefSharp.PostDataExtensions.GetBody(CefSharp.IPostDataElement,System.String)">
  3680. <summary>
  3681. Converts the <see cref="P:CefSharp.IPostDataElement.Bytes"/> property into a string
  3682. using the specified charset (Encoding) or if unable to parse then uses
  3683. the <see cref="P:System.Text.Encoding.Default"/>
  3684. </summary>
  3685. <param name="postDataElement">post data</param>
  3686. <param name="charSet">character set</param>
  3687. <returns>encoded string</returns>
  3688. </member>
  3689. <member name="M:CefSharp.PostDataExtensions.AddFile(CefSharp.IPostData,System.String)">
  3690. <summary>
  3691. Add a new <see cref="T:CefSharp.IPostDataElement"/> that represents the specified file
  3692. </summary>
  3693. <param name="postData">post data instance</param>
  3694. <param name="fileName">file name</param>
  3695. </member>
  3696. <member name="M:CefSharp.PostDataExtensions.AddData(CefSharp.IPostData,System.String,System.Text.Encoding)">
  3697. <summary>
  3698. Add a new <see cref="T:CefSharp.IPostDataElement"/> that represents the key and value
  3699. The data is encoded using
  3700. </summary>
  3701. <param name="postData">Post Data</param>
  3702. <param name="data">Data to be encoded for the post data element</param>
  3703. <param name="encoding">Specified Encoding. If null then <see cref="P:System.Text.Encoding.Default"/> will be used</param>
  3704. </member>
  3705. <member name="T:CefSharp.Rect">
  3706. <summary>
  3707. Represents a rectangle
  3708. </summary>
  3709. </member>
  3710. <member name="F:CefSharp.ReferrerPolicy.Always">
  3711. <summary>
  3712. Always send the complete Referrer value.
  3713. </summary>
  3714. </member>
  3715. <member name="F:CefSharp.ReferrerPolicy.Default">
  3716. <summary>
  3717. Use the default policy. This is OriginWhenCrossOrigin
  3718. when the `--reduced-referrer-granularity` command-line flag is specified
  3719. and NoReferrerWhenDowngrade otherwise.
  3720. </summary>
  3721. </member>
  3722. <member name="F:CefSharp.ReferrerPolicy.NoReferrerWhenDowngrade">
  3723. <summary>
  3724. When navigating from HTTPS to HTTP do not send the Referrer value.
  3725. Otherwise, send the complete Referrer value.
  3726. </summary>
  3727. </member>
  3728. <member name="F:CefSharp.ReferrerPolicy.Never">
  3729. <summary>
  3730. Never send the Referrer value.
  3731. </summary>
  3732. </member>
  3733. <member name="F:CefSharp.ReferrerPolicy.Origin">
  3734. <summary>
  3735. Only send the origin component of the Referrer value.
  3736. </summary>
  3737. </member>
  3738. <member name="F:CefSharp.ReferrerPolicy.OriginWhenCrossOrigin">
  3739. <summary>
  3740. When navigating cross-origin only send the origin component of the Referrer value. Otherwise, send the complete Referrer value.
  3741. </summary>
  3742. </member>
  3743. <member name="P:CefSharp.ResolveCallbackResult.Result">
  3744. <summary>
  3745. The result code - <see cref="F:CefSharp.CefErrorCode.None"/> on success
  3746. </summary>
  3747. </member>
  3748. <member name="P:CefSharp.ResolveCallbackResult.ResolvedIpAddresses">
  3749. <summary>
  3750. List of resolved IP addresses or empty if the resolution failed.
  3751. </summary>
  3752. </member>
  3753. <member name="T:CefSharp.ResourceHandler">
  3754. <summary>
  3755. Default implementation of <see cref="T:CefSharp.IResourceHandler"/>. This latest implementation provides some simplification, at
  3756. a minimum you only need to override ProcessRequestAsync. See the project source on GitHub for working examples.
  3757. used to implement a custom request handler interface. The methods of this class will always be called on the IO thread.
  3758. Static helper methods are included like FromStream and FromString that make dealing with fixed resources easy.
  3759. </summary>
  3760. </member>
  3761. <member name="F:CefSharp.ResourceHandler.DefaultMimeType">
  3762. <summary>
  3763. MimeType to be used if none provided
  3764. </summary>
  3765. </member>
  3766. <member name="M:CefSharp.ResourceHandler.#ctor">
  3767. <summary>
  3768. Default Constructor
  3769. </summary>
  3770. </member>
  3771. <member name="M:CefSharp.ResourceHandler.#ctor(System.String,CefSharp.ResourceHandlerType)">
  3772. <summary>
  3773. Initializes a new instance of the <see cref="T:CefSharp.ResourceHandler"/> class.
  3774. </summary>
  3775. </member>
  3776. <member name="M:CefSharp.ResourceHandler.ProcessRequestAsync(CefSharp.IRequest,CefSharp.ICallback)">
  3777. <summary>
  3778. Begin processing the request. If you have the data in memory you can execute the callback
  3779. immediately and return true. For Async processing you would typically spawn a Task to perform processing,
  3780. then return true. When the processing is complete execute callback.Continue(); In your processing Task, simply set
  3781. the StatusCode, StatusText, MimeType, ResponseLength and Stream
  3782. </summary>
  3783. <param name="request">The request object.</param>
  3784. <param name="callback">The callback used to Continue or Cancel the request (async).</param>
  3785. <returns>To handle the request return true and call
  3786. <see cref="M:CefSharp.ICallback.Continue"/> once the response header information is available
  3787. <see cref="M:CefSharp.ICallback.Continue"/> can also be called from inside this method if
  3788. header information is available immediately).
  3789. To cancel the request return false.</returns>
  3790. </member>
  3791. <member name="M:CefSharp.ResourceHandler.GetResponse(CefSharp.IResponse,System.Int64@,System.String@)">
  3792. <summary>
  3793. Populate the response stream, response length. When this method is called
  3794. the response should be fully populated with data.
  3795. It is possible to redirect to another url at this point in time.
  3796. NOTE: It's no longer manditory to implement this method, you can simply populate the
  3797. properties of this instance and they will be set by the default implementation.
  3798. </summary>
  3799. <param name="response">The response object used to set Headers, StatusCode, etc</param>
  3800. <param name="responseLength">length of the response</param>
  3801. <param name="redirectUrl">If set the request will be redirect to specified Url</param>
  3802. <returns>The response stream</returns>
  3803. </member>
  3804. <member name="M:CefSharp.ResourceHandler.Cancel">
  3805. <summary>
  3806. Called if the request is cancelled
  3807. </summary>
  3808. </member>
  3809. <member name="M:CefSharp.ResourceHandler.FromFileName(System.String,System.String)">
  3810. <summary>
  3811. Gets the resource from the file.
  3812. </summary>
  3813. <param name="filePath">Location of the file.</param>
  3814. <param name="fileExtension">The file extension.</param>
  3815. <returns>ResourceHandler.</returns>
  3816. </member>
  3817. <member name="M:CefSharp.ResourceHandler.FromFilePath(System.String,System.String)">
  3818. <summary>
  3819. Gets the resource from the file path specified. Use the <see cref="M:CefSharp.ResourceHandler.GetMimeType(System.String)"/>
  3820. helper method to lookup the mimeType if required.
  3821. </summary>
  3822. <param name="fileName">Location of the file.</param>
  3823. <param name="mimeType">The mimeType if null then text/html is used.</param>
  3824. <returns>ResourceHandler.</returns>
  3825. </member>
  3826. <member name="M:CefSharp.ResourceHandler.FromString(System.String,System.String)">
  3827. <summary>
  3828. Gets the resource from the string.
  3829. </summary>
  3830. <param name="text">The text.</param>
  3831. <param name="fileExtension">The file extension.</param>
  3832. <returns>ResourceHandler.</returns>
  3833. </member>
  3834. <member name="M:CefSharp.ResourceHandler.FromString(System.String,System.Text.Encoding,System.Boolean,System.String)">
  3835. <summary>
  3836. Gets a <see cref="T:CefSharp.ResourceHandler"/> that represents a string.
  3837. Without a Preamble, Cef will use BrowserSettings.DefaultEncoding to load the html.
  3838. </summary>
  3839. <param name="text">The html string</param>
  3840. <param name="encoding">Character Encoding</param>
  3841. <param name="includePreamble">Include encoding preamble</param>
  3842. <param name="mimeType">Mime Type</param>
  3843. <returns>ResourceHandler</returns>
  3844. </member>
  3845. <member name="M:CefSharp.ResourceHandler.FromStream(System.IO.Stream,System.String)">
  3846. <summary>
  3847. Gets the resource from a stream.
  3848. </summary>
  3849. <param name="stream">A stream of the resource.</param>
  3850. <param name="mimeType">Type of MIME.</param>
  3851. <returns>ResourceHandler.</returns>
  3852. </member>
  3853. <member name="M:CefSharp.ResourceHandler.GetMimeType(System.String)">
  3854. <summary>
  3855. Gets the MIME type of the content.
  3856. </summary>
  3857. <param name="extension">The extension.</param>
  3858. <returns>System.String.</returns>
  3859. <exception cref="T:System.ArgumentNullException">extension</exception>
  3860. </member>
  3861. <member name="M:CefSharp.ResourceHandler.Dispose">
  3862. <summary>
  3863. Dispose of resources here
  3864. </summary>
  3865. </member>
  3866. <member name="P:CefSharp.ResourceHandler.FilePath">
  3867. <summary>
  3868. Path of the underlying file
  3869. </summary>
  3870. </member>
  3871. <member name="P:CefSharp.ResourceHandler.MimeType">
  3872. <summary>
  3873. Gets or sets the Mime Type.
  3874. </summary>
  3875. </member>
  3876. <member name="P:CefSharp.ResourceHandler.Stream">
  3877. <summary>
  3878. Gets or sets the resource stream.
  3879. </summary>
  3880. </member>
  3881. <member name="P:CefSharp.ResourceHandler.StatusCode">
  3882. <summary>
  3883. Gets or sets the http status code.
  3884. </summary>
  3885. </member>
  3886. <member name="P:CefSharp.ResourceHandler.StatusText">
  3887. <summary>
  3888. Gets or sets the status text.
  3889. </summary>
  3890. </member>
  3891. <member name="P:CefSharp.ResourceHandler.ResponseLength">
  3892. <summary>
  3893. Gets or sets ResponseLength, when you know the size of your
  3894. Stream (Response) set this property. This is optional.
  3895. If you use a MemoryStream and don't provide a value
  3896. here then it will be cast and it's size used
  3897. </summary>
  3898. </member>
  3899. <member name="P:CefSharp.ResourceHandler.Headers">
  3900. <summary>
  3901. Gets or sets the headers.
  3902. </summary>
  3903. <value>The headers.</value>
  3904. </member>
  3905. <member name="P:CefSharp.ResourceHandler.Type">
  3906. <summary>
  3907. Specify which type of resource handle represnets
  3908. </summary>
  3909. </member>
  3910. <member name="P:CefSharp.ResourceHandler.AutoDisposeStream">
  3911. <summary>
  3912. When true the Stream will be Disposed when
  3913. this instance is Disposed. The default value for
  3914. this property is false.
  3915. </summary>
  3916. </member>
  3917. <member name="P:CefSharp.ResourceHandler.ErrorCode">
  3918. <summary>
  3919. If the ErrorCode is set then the response will be ignored and
  3920. the errorCode returned.
  3921. </summary>
  3922. </member>
  3923. <member name="F:CefSharp.ResourceHandlerType.Stream">
  3924. <summary>
  3925. Resource is read from a Stream (Default)
  3926. </summary>
  3927. </member>
  3928. <member name="F:CefSharp.ResourceHandlerType.File">
  3929. <summary>
  3930. Resource is read from a file on disk
  3931. </summary>
  3932. </member>
  3933. <member name="T:CefSharp.ResourceType">
  3934. <summary>
  3935. Resource type for a request.
  3936. </summary>
  3937. </member>
  3938. <member name="F:CefSharp.ResourceType.MainFrame">
  3939. <summary>
  3940. Top level page.
  3941. </summary>
  3942. </member>
  3943. <member name="F:CefSharp.ResourceType.SubFrame">
  3944. <summary>
  3945. Frame or iframe.
  3946. </summary>
  3947. </member>
  3948. <member name="F:CefSharp.ResourceType.Stylesheet">
  3949. <summary>
  3950. CSS stylesheet.
  3951. </summary>
  3952. </member>
  3953. <member name="F:CefSharp.ResourceType.Script">
  3954. <summary>
  3955. External script.
  3956. </summary>
  3957. </member>
  3958. <member name="F:CefSharp.ResourceType.Image">
  3959. <summary>
  3960. Image (jpg/gif/png/etc).
  3961. </summary>
  3962. </member>
  3963. <member name="F:CefSharp.ResourceType.FontResource">
  3964. <summary>
  3965. Font.
  3966. </summary>
  3967. </member>
  3968. <member name="F:CefSharp.ResourceType.SubResource">
  3969. <summary>
  3970. Some other subresource. This is the default type if the actual type is unknown.
  3971. </summary>
  3972. </member>
  3973. <member name="F:CefSharp.ResourceType.Object">
  3974. <summary>
  3975. Object (or embed) tag for a plugin, or a resource that a plugin requested.
  3976. </summary>
  3977. </member>
  3978. <member name="F:CefSharp.ResourceType.Media">
  3979. <summary>
  3980. Media resource.
  3981. </summary>
  3982. </member>
  3983. <member name="F:CefSharp.ResourceType.Worker">
  3984. <summary>
  3985. Main resource of a dedicated worker.
  3986. </summary>
  3987. </member>
  3988. <member name="F:CefSharp.ResourceType.SharedWorker">
  3989. <summary>
  3990. Main resource of a shared worker.
  3991. </summary>
  3992. </member>
  3993. <member name="F:CefSharp.ResourceType.Prefetch">
  3994. <summary>
  3995. Explicitly requested prefetch.
  3996. </summary>
  3997. </member>
  3998. <member name="F:CefSharp.ResourceType.Favicon">
  3999. <summary>
  4000. Favicon.
  4001. </summary>
  4002. </member>
  4003. <member name="F:CefSharp.ResourceType.Xhr">
  4004. <summary>
  4005. XMLHttpRequest.
  4006. </summary>
  4007. </member>
  4008. <member name="F:CefSharp.ResourceType.Ping">
  4009. <summary>
  4010. A request for a ping
  4011. </summary>
  4012. </member>
  4013. <member name="F:CefSharp.ResourceType.ServiceWorker">
  4014. <summary>
  4015. Main resource of a service worker.
  4016. </summary>
  4017. </member>
  4018. <member name="F:CefSharp.ResourceType.CspReport">
  4019. <summary>
  4020. A report of Content Security Policy violations.
  4021. </summary>
  4022. </member>
  4023. <member name="F:CefSharp.ResourceType.PluginResource">
  4024. <summary>
  4025. A resource that a plugin requested.
  4026. </summary>
  4027. </member>
  4028. <member name="T:CefSharp.SchemeHandler.FolderSchemeHandlerFactory">
  4029. <summary>
  4030. FolderSchemeHandlerFactory is a very simple scheme handler that allows you
  4031. to map requests for urls to a folder on your file system. For example
  4032. creating a setting the rootFolder to c:\projects\CefSharp\CefSharp.Example\Resources
  4033. registering the scheme handler
  4034. </summary>
  4035. </member>
  4036. <member name="T:CefSharp.ISchemeHandlerFactory">
  4037. <summary>
  4038. Class that creates <see cref="T:CefSharp.IResourceHandler"/> instances for handling scheme requests.
  4039. The methods of this class will always be called on the CEF IO thread.
  4040. </summary>
  4041. </member>
  4042. <member name="M:CefSharp.ISchemeHandlerFactory.Create(CefSharp.IBrowser,CefSharp.IFrame,System.String,CefSharp.IRequest)">
  4043. <summary>
  4044. Return a new <see cref="T:CefSharp.IResourceHandler"/> instance to handle the request or an empty
  4045. reference to allow default handling of the request.
  4046. </summary>
  4047. <param name="browser">the browser window that originated the
  4048. request or null if the request did not originate from a browser window
  4049. (for example, if the request came from CefURLRequest).</param>
  4050. <param name="frame">frame that originated the request
  4051. or null if the request did not originate from a browser window
  4052. (for example, if the request came from CefURLRequest).</param>
  4053. <param name="schemeName">the scheme name</param>
  4054. <param name="request">The request. (will not contain cookie data)</param>
  4055. <returns>
  4056. Return a new <see cref="T:CefSharp.IResourceHandler"/> instance to handle the request or an empty
  4057. reference to allow default handling of the request
  4058. </returns>
  4059. </member>
  4060. <member name="M:CefSharp.SchemeHandler.FolderSchemeHandlerFactory.#ctor(System.String,System.String,System.String,System.String)">
  4061. <summary>
  4062. Initialize a new instance of FolderSchemeHandlerFactory
  4063. </summary>
  4064. <param name="rootFolder">Root Folder where all your files exist, requests cannot be made outside of this folder</param>
  4065. <param name="schemeName">if not null then schemeName checking will be implemented</param>
  4066. <param name="hostName">if not null then hostName checking will be implemented</param>
  4067. <param name="defaultPage">default page if no page specified, defaults to index.html</param>
  4068. </member>
  4069. <member name="M:CefSharp.SchemeHandler.FolderSchemeHandlerFactory.CefSharp#ISchemeHandlerFactory#Create(CefSharp.IBrowser,CefSharp.IFrame,System.String,CefSharp.IRequest)">
  4070. <summary>
  4071. If the file requested is within the rootFolder then a IResourceHandler reference to the file requested will be returned
  4072. otherwise a 404 ResourceHandler will be returned.
  4073. </summary>
  4074. <param name="browser">the browser window that originated the
  4075. request or null if the request did not originate from a browser window
  4076. (for example, if the request came from CefURLRequest).</param>
  4077. <param name="frame">frame that originated the request
  4078. or null if the request did not originate from a browser window
  4079. (for example, if the request came from CefURLRequest).</param>
  4080. <param name="schemeName">the scheme name</param>
  4081. <param name="request">The request. (will not contain cookie data)</param>
  4082. <returns>
  4083. A IResourceHandler
  4084. </returns>
  4085. </member>
  4086. <member name="T:CefSharp.ICompletionCallback">
  4087. <summary>
  4088. Generic callback interface used for asynchronous completion.
  4089. </summary>
  4090. </member>
  4091. <member name="M:CefSharp.ICompletionCallback.OnComplete">
  4092. <summary>
  4093. Method that will be called once the task is complete.
  4094. </summary>
  4095. </member>
  4096. <member name="T:CefSharp.TaskCookieVisitor">
  4097. <summary>
  4098. Cookie Visitor implementation that uses a TaskCompletionSource
  4099. to return a List of cookies
  4100. </summary>
  4101. </member>
  4102. <member name="T:CefSharp.ICookieVisitor">
  4103. <summary>
  4104. Interface to implement for visiting cookie values.
  4105. The methods of this class will always be called on the IO thread.
  4106. If there are no cookies then Visit will never be called, you must implement
  4107. Dispose to handle this scenario.
  4108. </summary>
  4109. </member>
  4110. <member name="M:CefSharp.ICookieVisitor.Visit(CefSharp.Cookie,System.Int32,System.Int32,System.Boolean@)">
  4111. <summary>
  4112. Method that will be called once for each cookie. This method may never be called if no cookies are found.
  4113. </summary>
  4114. <param name="cookie">cookie</param>
  4115. <param name="count">is the 0-based index for the current cookie.</param>
  4116. <param name="total">is the total number of cookies.</param>
  4117. <param name="deleteCookie">Set to true to delete the cookie currently being visited.</param>
  4118. <returns>Return false to stop visiting cookies otherwise true</returns>
  4119. </member>
  4120. <member name="M:CefSharp.TaskCookieVisitor.#ctor">
  4121. <summary>
  4122. Default constructor
  4123. </summary>
  4124. </member>
  4125. <member name="P:CefSharp.TaskCookieVisitor.Task">
  4126. <summary>
  4127. Task that can be awaited for the result to be retrieved async
  4128. </summary>
  4129. </member>
  4130. <member name="T:CefSharp.TaskNavigationEntryVisitor">
  4131. <summary>
  4132. A <see cref="T:CefSharp.INavigationEntryVisitor"/> that uses a TaskCompletionSource
  4133. to simplify things
  4134. </summary>
  4135. </member>
  4136. <member name="M:CefSharp.TaskNavigationEntryVisitor.#ctor">
  4137. <summary>
  4138. Default constructor
  4139. </summary>
  4140. </member>
  4141. <member name="P:CefSharp.TaskNavigationEntryVisitor.Task">
  4142. <summary>
  4143. Task that can be awaited for the result to be retrieved async
  4144. </summary>
  4145. </member>
  4146. <member name="T:CefSharp.TransitionType">
  4147. <summary>
  4148. Transition type for a request. Made up of one source value and 0 or more qualifiers.
  4149. </summary>
  4150. </member>
  4151. <member name="F:CefSharp.TransitionType.LinkClicked">
  4152. <summary>
  4153. Source is a link click or the JavaScript window.open function. This is
  4154. also the default value for requests like sub-resource loads that are not navigations.
  4155. </summary>
  4156. </member>
  4157. <member name="F:CefSharp.TransitionType.Explicit">
  4158. <summary>
  4159. Source is some other "explicit" navigation action such as creating a new
  4160. browser or using the LoadURL function. This is also the default value
  4161. for navigations where the actual type is unknown.
  4162. </summary>
  4163. </member>
  4164. <member name="F:CefSharp.TransitionType.AutoSubFrame">
  4165. <summary>
  4166. Source is a subframe navigation. This is any content that is automatically
  4167. loaded in a non-toplevel frame. For example, if a page consists of several
  4168. frames containing ads, those ad URLs will have this transition type.
  4169. The user may not even realize the content in these pages is a separate
  4170. frame, so may not care about the URL.
  4171. </summary>
  4172. </member>
  4173. <member name="F:CefSharp.TransitionType.ManualSubFrame">
  4174. <summary>
  4175. Source is a subframe navigation explicitly requested by the user that will
  4176. generate new navigation entries in the back/forward list. These are
  4177. probably more important than frames that were automatically loaded in
  4178. the background because the user probably cares about the fact that this
  4179. link was loaded.
  4180. </summary>
  4181. </member>
  4182. <member name="F:CefSharp.TransitionType.FormSubmit">
  4183. <summary>
  4184. Source is a form submission by the user. NOTE: In some situations
  4185. submitting a form does not result in this transition type. This can happen
  4186. if the form uses a script to submit the contents.
  4187. </summary>
  4188. </member>
  4189. <member name="F:CefSharp.TransitionType.Reload">
  4190. <summary>
  4191. Source is a "reload" of the page via the Reload function or by re-visiting
  4192. the same URL. NOTE: This is distinct from the concept of whether a
  4193. particular load uses "reload semantics" (i.e. bypasses cached data).
  4194. </summary>
  4195. </member>
  4196. <member name="F:CefSharp.TransitionType.SourceMask">
  4197. <summary>
  4198. General mask defining the bits used for the source values.
  4199. </summary>
  4200. </member>
  4201. <member name="F:CefSharp.TransitionType.Blocked">
  4202. <summary>
  4203. Attempted to visit a URL but was blocked.
  4204. </summary>
  4205. </member>
  4206. <member name="F:CefSharp.TransitionType.ForwardBack">
  4207. <summary>
  4208. Used the Forward or Back function to navigate among browsing history.
  4209. </summary>
  4210. </member>
  4211. <member name="F:CefSharp.TransitionType.ChainStart">
  4212. <summary>
  4213. The beginning of a navigation chain.
  4214. </summary>
  4215. </member>
  4216. <member name="F:CefSharp.TransitionType.ChainEnd">
  4217. <summary>
  4218. The last transition in a redirect chain.
  4219. </summary>
  4220. </member>
  4221. <member name="F:CefSharp.TransitionType.CliendRedirect">
  4222. <summary>
  4223. Redirects caused by JavaScript or a meta refresh tag on the page.
  4224. </summary>
  4225. </member>
  4226. <member name="F:CefSharp.TransitionType.ServerRedirect">
  4227. <summary>
  4228. Redirects sent from the server by HTTP headers.
  4229. </summary>
  4230. </member>
  4231. <member name="F:CefSharp.TransitionType.IsRedirect">
  4232. <summary>
  4233. Used to test whether a transition involves a redirect.
  4234. </summary>
  4235. </member>
  4236. <member name="F:CefSharp.TransitionType.QualifierMask">
  4237. <summary>
  4238. General mask defining the bits used for the qualifiers.
  4239. </summary>
  4240. </member>
  4241. <member name="T:CefSharp.LoadingStateChangedEventArgs">
  4242. <summary>
  4243. Event arguments to the LoadingStateChanged event handler set up in IWebBrowser.
  4244. </summary>
  4245. </member>
  4246. <member name="T:CefSharp.CefFocusSource">
  4247. <summary>
  4248. Focus Source
  4249. </summary>
  4250. </member>
  4251. <member name="F:CefSharp.CefFocusSource.FocusSourceNavigation">
  4252. <summary>
  4253. The source is explicit navigation via the API (LoadURL(), etc).
  4254. </summary>
  4255. </member>
  4256. <member name="F:CefSharp.CefFocusSource.FocusSourceSystem">
  4257. <summary>
  4258. The source is a system-generated focus event.
  4259. </summary>
  4260. </member>
  4261. <member name="P:CefSharp.Internals.JavascriptMethod.Function">
  4262. <summary>
  4263. Gets or sets a delegate which is used to invoke the method if the member is a method.
  4264. </summary>
  4265. </member>
  4266. <member name="P:CefSharp.Internals.JavascriptMethod.Id">
  4267. <summary>
  4268. Identifies the <see cref="T:CefSharp.Internals.JavascriptMethod"/> for BrowserProcess to RenderProcess communication
  4269. </summary>
  4270. </member>
  4271. <member name="P:CefSharp.Internals.JavascriptMethod.ManagedName">
  4272. <summary>
  4273. Gets or sets the name of the managed property.
  4274. </summary>
  4275. </member>
  4276. <member name="P:CefSharp.Internals.JavascriptMethod.JavascriptName">
  4277. <summary>
  4278. Gets or sets the name of the property in the JavaScript runtime.
  4279. </summary>
  4280. </member>
  4281. <member name="P:CefSharp.Internals.JavascriptMethod.Parameters">
  4282. <summary>
  4283. Params this method expects
  4284. </summary>
  4285. </member>
  4286. <member name="P:CefSharp.Internals.JavascriptMethod.ParameterCount">
  4287. <summary>
  4288. Number of Params this function exepects
  4289. </summary>
  4290. </member>
  4291. <member name="T:CefSharp.Internals.JavascriptObject">
  4292. <summary>
  4293. This maps the registered objects in the browser process
  4294. to the reflection data necessary to update the objects,
  4295. and mapping information to how the object/method/proprerty
  4296. will be exposed to JavaScript.
  4297. </summary>
  4298. </member>
  4299. <member name="P:CefSharp.Internals.JavascriptObject.Id">
  4300. <summary>
  4301. Identifies the <see cref="T:CefSharp.Internals.JavascriptObject"/> for BrowserProcess to RenderProcess communication
  4302. </summary>
  4303. </member>
  4304. <member name="P:CefSharp.Internals.JavascriptObject.CamelCaseJavascriptNames">
  4305. <summary>
  4306. Indicate if JavascriptName is camel case or not
  4307. </summary>
  4308. </member>
  4309. <member name="P:CefSharp.Internals.JavascriptObject.Methods">
  4310. <summary>
  4311. Gets the methods of the <see cref="T:CefSharp.Internals.JavascriptObject"/>.
  4312. </summary>
  4313. </member>
  4314. <member name="P:CefSharp.Internals.JavascriptObject.Properties">
  4315. <summary>
  4316. Gets the properties of the <see cref="T:CefSharp.Internals.JavascriptObject"/>.
  4317. </summary>
  4318. </member>
  4319. <member name="P:CefSharp.Internals.JavascriptObject.Value">
  4320. <summary>
  4321. Gets or sets the value.
  4322. </summary>
  4323. </member>
  4324. <member name="T:CefSharp.Internals.JavascriptObjectRepository">
  4325. <summary>
  4326. This class manages the registration of objects in the browser
  4327. process to be exposed to JavaScript in the renderer process.
  4328. Registration performs method, parameter, property type analysis
  4329. of the registered objects into meta-data tied to reflection data
  4330. for later use.
  4331. This class also is the adaptation layer between the BrowserProcessService
  4332. and the registered objects. This means when the renderer wants to call an
  4333. exposed method, get a property of an object, or
  4334. set a property of an object in the browser process, that this
  4335. class does deals with the previously created meta-data and invokes the correct
  4336. behavior via reflection APIs.
  4337. All of the registered objects are tracked via meta-data for the objects
  4338. expressed starting with the JavaScriptObject type.
  4339. </summary>
  4340. </member>
  4341. <member name="F:CefSharp.Internals.JavascriptObjectRepository.objects">
  4342. <summary>
  4343. A hash from assigned object ids to the objects,
  4344. this is done to speed up finding the object in O(1) time
  4345. instead of traversing the JavaScriptRootObject tree.
  4346. </summary>
  4347. </member>
  4348. <member name="M:CefSharp.Internals.JavascriptObjectRepository.AnalyseObjectForBinding(CefSharp.Internals.JavascriptObject,System.Boolean,System.Boolean,System.Boolean,System.Boolean)">
  4349. <summary>
  4350. Analyse the object and generate metadata which will
  4351. be used by the browser subprocess to interact with Cef.
  4352. Method is called recursively
  4353. </summary>
  4354. <param name="obj">Javascript object</param>
  4355. <param name="analyseMethods">Analyse methods for inclusion in metadata model</param>
  4356. <param name="readPropertyValue">When analysis is done on a property, if true then get it's value for transmission over WCF</param>
  4357. <param name="camelCaseJavascriptNames">camel case the javascript names of properties/methods</param>
  4358. <param name="analyseProperties">Analyse properties for binding</param>
  4359. </member>
  4360. <member name="P:CefSharp.Internals.JavascriptObjectRepository.RootObject">
  4361. <summary>
  4362. This is the root of the objects that get serialized to the child process.
  4363. </summary>
  4364. </member>
  4365. <member name="P:CefSharp.Internals.JavascriptObjectRepository.AsyncRootObject">
  4366. <summary>
  4367. This is the root of the objects that get serialized to the child
  4368. process with cef ipc serialization (wcf not required).
  4369. </summary>
  4370. </member>
  4371. <member name="P:CefSharp.Internals.JavascriptProperty.SetValue">
  4372. <summary>
  4373. Gets or sets a delegate which is used to set the property / field value in the managed object.
  4374. </summary>
  4375. </member>
  4376. <member name="P:CefSharp.Internals.JavascriptProperty.GetValue">
  4377. <summary>
  4378. Gets or sets a delegate which is used to get the property / field value from the managed object.
  4379. </summary>
  4380. </member>
  4381. <member name="P:CefSharp.Internals.JavascriptProperty.Id">
  4382. <summary>
  4383. Identifies the <see cref="T:CefSharp.Internals.JavascriptProperty"/> for BrowserProcess to RenderProcess communication
  4384. </summary>
  4385. </member>
  4386. <member name="P:CefSharp.Internals.JavascriptProperty.ManagedName">
  4387. <summary>
  4388. Gets or sets the name of the managed property.
  4389. </summary>
  4390. </member>
  4391. <member name="P:CefSharp.Internals.JavascriptProperty.JavascriptName">
  4392. <summary>
  4393. Gets or sets the name of the property in the JavaScript runtime.
  4394. </summary>
  4395. </member>
  4396. <member name="P:CefSharp.Internals.JavascriptProperty.IsComplexType">
  4397. <summary>
  4398. Gets or sets if this property represents a complex type
  4399. </summary>
  4400. </member>
  4401. <member name="P:CefSharp.Internals.JavascriptProperty.IsReadOnly">
  4402. <summary>
  4403. Gets or sets if this property is read-only
  4404. </summary>
  4405. </member>
  4406. <member name="P:CefSharp.Internals.JavascriptProperty.PropertyValue">
  4407. <summary>
  4408. Gets or sets the property value
  4409. Only primative types can be stored in this property
  4410. </summary>
  4411. </member>
  4412. <member name="T:CefSharp.CefCustomScheme">
  4413. <summary>
  4414. Used in conjunction with CefSettings.RegisterScheme to register a scheme.
  4415. You can register your own custom scheme e.g. custom:// or use an existing
  4416. scheme e.g. http://
  4417. </summary>
  4418. </member>
  4419. <member name="M:CefSharp.CefCustomScheme.#ctor">
  4420. <summary>
  4421. Creates a new CefCustomScheme.
  4422. </summary>
  4423. </member>
  4424. <member name="M:CefSharp.CefCustomScheme.ParseCommandLineArguments(System.Collections.Generic.IEnumerable{System.String})">
  4425. <summary>
  4426. Method used internally
  4427. </summary>
  4428. <param name="args">command line arguments</param>
  4429. <returns>list of scheme objects</returns>
  4430. </member>
  4431. <member name="P:CefSharp.CefCustomScheme.SchemeName">
  4432. <summary>
  4433. Schema Name e.g. custom
  4434. </summary>
  4435. </member>
  4436. <member name="P:CefSharp.CefCustomScheme.DomainName">
  4437. <summary>
  4438. Optional Domain Name. An empty value for a standard scheme
  4439. will cause the factory to match all domain names. The |domain_name| value
  4440. will be ignored for non-standard schemes.
  4441. </summary>
  4442. </member>
  4443. <member name="P:CefSharp.CefCustomScheme.IsStandard">
  4444. <summary>
  4445. If true the scheme will be treated as a standard scheme.
  4446. Standard schemes are subject to URL canonicalization and parsing rules as
  4447. defined in the Common Internet Scheme Syntax RFC 1738 Section 3.1 available
  4448. at http://www.ietf.org/rfc/rfc1738.txt
  4449. In particular, the syntax for standard scheme URLs must be of the form:
  4450. <pre>
  4451. [scheme]://[username]:[password]@[host]:[port]/[url-path]
  4452. </pre>
  4453. Standard scheme URLs must have a host component that is a fully qualified
  4454. domain name as defined in Section 3.5 of RFC 1034 [13] and Section 2.1 of
  4455. RFC 1123. These URLs will be canonicalized to "scheme://host/path" in the
  4456. simplest case and "scheme://username:password@host:port/path" in the most
  4457. explicit case. For example, "scheme:host/path" and "scheme:///host/path"
  4458. will both be canonicalized to "scheme://host/path". The origin of a
  4459. standard scheme URL is the combination of scheme, host and port (i.e.,
  4460. "scheme://host:port" in the most explicit case).
  4461. For non-standard scheme URLs only the "scheme:" component is parsed and
  4462. canonicalized. The remainder of the URL will be passed to the handler
  4463. as-is. For example, "scheme:///some%20text" will remain the same.
  4464. Non-standard scheme URLs cannot be used as a target for form submission.
  4465. </summary>
  4466. </member>
  4467. <member name="P:CefSharp.CefCustomScheme.IsLocal">
  4468. <summary>
  4469. If true the scheme will be treated as local (i.e. with the
  4470. same security rules as those applied to "file" URLs). Normal pages cannot
  4471. link to or access local URLs. Also, by default, local URLs can only perform
  4472. XMLHttpRequest calls to the same URL (origin + path) that originated the
  4473. request. To allow XMLHttpRequest calls from a local URL to other URLs with
  4474. the same origin set the CefSettings.file_access_from_file_urls_allowed
  4475. value to true. To allow XMLHttpRequest calls from a local URL to all
  4476. origins set the CefSettings.universal_access_from_file_urls_allowed value
  4477. to true.
  4478. </summary>
  4479. </member>
  4480. <member name="P:CefSharp.CefCustomScheme.IsDisplayIsolated">
  4481. <summary>
  4482. If true the scheme will be treated as display-isolated.
  4483. This means that pages cannot display these URLs unless they are
  4484. from the same scheme. For example, pages in another origin cannot create
  4485. iframes or hyperlinks to URLs with this scheme.
  4486. </summary>
  4487. </member>
  4488. <member name="P:CefSharp.CefCustomScheme.SchemeHandlerFactory">
  4489. <summary>
  4490. Factory Class that creates <see cref="T:CefSharp.IResourceHandler"/> instances
  4491. for handling scheme requests.
  4492. </summary>
  4493. </member>
  4494. <member name="T:CefSharp.CefErrorCode">
  4495. <summary>
  4496. Lists some of the error codes that can be reported by CEF.
  4497. For a complete up-to-date list, see the CEF source code
  4498. (cef_errorcode_t in include/internal/cef_types.h)
  4499. and the Chromium source code (net/base/net_error_list.h).
  4500. </summary>
  4501. </member>
  4502. <member name="F:CefSharp.CefErrorCode.None">
  4503. <summary>
  4504. No error occurred.
  4505. </summary>
  4506. </member>
  4507. <member name="F:CefSharp.CefErrorCode.IoPending">
  4508. <summary>
  4509. An asynchronous IO operation is not yet complete. This usually does not
  4510. indicate a fatal error. Typically this error will be generated as a
  4511. notification to wait for some external notification that the IO operation
  4512. finally completed.
  4513. </summary>
  4514. </member>
  4515. <member name="F:CefSharp.CefErrorCode.Failed">
  4516. <summary>
  4517. A generic failure occurred.
  4518. </summary>
  4519. </member>
  4520. <member name="F:CefSharp.CefErrorCode.Aborted">
  4521. <summary>
  4522. A request was aborted, possibly by the user.
  4523. </summary>
  4524. </member>
  4525. <member name="F:CefSharp.CefErrorCode.InvalidArgument">
  4526. <summary>
  4527. An argument to the function is incorrect.
  4528. </summary>
  4529. </member>
  4530. <member name="F:CefSharp.CefErrorCode.InvalidHandle">
  4531. <summary>
  4532. The handle or file descriptor is invalid.
  4533. </summary>
  4534. </member>
  4535. <member name="F:CefSharp.CefErrorCode.FileNotFound">
  4536. <summary>
  4537. The file or directory cannot be found.
  4538. </summary>
  4539. </member>
  4540. <member name="F:CefSharp.CefErrorCode.TimedOut">
  4541. <summary>
  4542. An operation timed out.
  4543. </summary>
  4544. </member>
  4545. <member name="F:CefSharp.CefErrorCode.FileTooBig">
  4546. <summary>
  4547. The file is too large.
  4548. </summary>
  4549. </member>
  4550. <member name="F:CefSharp.CefErrorCode.Unexpected">
  4551. <summary>
  4552. An unexpected error. This may be caused by a programming mistake or an invalid assumption
  4553. </summary>
  4554. </member>
  4555. <member name="F:CefSharp.CefErrorCode.AccessDenied">
  4556. <summary>
  4557. Permission to access a resource, other than the network, was denied.
  4558. </summary>
  4559. </member>
  4560. <member name="F:CefSharp.CefErrorCode.NotImplemented">
  4561. <summary>
  4562. The operation failed because of unimplemented functionality.
  4563. </summary>
  4564. </member>
  4565. <member name="F:CefSharp.CefErrorCode.InsufficientResources">
  4566. <summary>
  4567. There were not enough resources to complete the operation.
  4568. </summary>
  4569. </member>
  4570. <member name="F:CefSharp.CefErrorCode.OutOfMemory">
  4571. <summary>
  4572. Memory allocation failed.
  4573. </summary>
  4574. </member>
  4575. <member name="F:CefSharp.CefErrorCode.UploadFileChanged">
  4576. <summary>
  4577. The file upload failed because the file's modification time was different
  4578. from the expectation.
  4579. </summary>
  4580. </member>
  4581. <member name="F:CefSharp.CefErrorCode.SocketNotConnected">
  4582. <summary>
  4583. The socket is not connected.
  4584. </summary>
  4585. </member>
  4586. <member name="F:CefSharp.CefErrorCode.FileExists">
  4587. <summary>
  4588. The file already exists.
  4589. </summary>
  4590. </member>
  4591. <member name="F:CefSharp.CefErrorCode.FilePathTooLong">
  4592. <summary>
  4593. The path or file name is too long.
  4594. </summary>
  4595. </member>
  4596. <member name="F:CefSharp.CefErrorCode.FileNoSpace">
  4597. <summary>
  4598. Not enough room left on the disk.
  4599. </summary>
  4600. </member>
  4601. <member name="F:CefSharp.CefErrorCode.FileVirusInfected">
  4602. <summary>
  4603. The file has a virus.
  4604. </summary>
  4605. </member>
  4606. <member name="F:CefSharp.CefErrorCode.BlockedByClient">
  4607. <summary>
  4608. The client chose to block the request.
  4609. </summary>
  4610. </member>
  4611. <member name="F:CefSharp.CefErrorCode.NetworkChanged">
  4612. <summary>
  4613. The network changed.
  4614. </summary>
  4615. </member>
  4616. <member name="F:CefSharp.CefErrorCode.BlockedByAdministrator">
  4617. <summary>
  4618. The request was blocked by the URL blacklist configured by the domain
  4619. administrator.
  4620. </summary>
  4621. </member>
  4622. <member name="F:CefSharp.CefErrorCode.SocketIsConnected">
  4623. <summary>
  4624. The socket is already connected.
  4625. </summary>
  4626. </member>
  4627. <member name="F:CefSharp.CefErrorCode.BlockedEnrollmentCheckPending">
  4628. <summary>
  4629. The request was blocked because the forced reenrollment check is still
  4630. pending. This error can only occur on ChromeOS.
  4631. The error can be emitted by code in chrome/browser/policy/policy_helpers.cc.
  4632. </summary>
  4633. </member>
  4634. <member name="F:CefSharp.CefErrorCode.ConnectionClosed">
  4635. <summary>
  4636. A connection was closed (corresponding to a TCP FIN).
  4637. </summary>
  4638. </member>
  4639. <member name="F:CefSharp.CefErrorCode.ConnectionReset">
  4640. <summary>
  4641. A connection was reset (corresponding to a TCP RST).
  4642. </summary>
  4643. </member>
  4644. <member name="F:CefSharp.CefErrorCode.ConnectionRefused">
  4645. <summary>
  4646. A connection attempt was refused.
  4647. </summary>
  4648. </member>
  4649. <member name="F:CefSharp.CefErrorCode.ConnectionAborted">
  4650. <summary>
  4651. A connection timed out as a result of not receiving an ACK for data sent.
  4652. This can include a FIN packet that did not get ACK'd.
  4653. </summary>
  4654. </member>
  4655. <member name="F:CefSharp.CefErrorCode.ConnectionFailed">
  4656. <summary>
  4657. A connection attempt failed.
  4658. </summary>
  4659. </member>
  4660. <member name="F:CefSharp.CefErrorCode.NameNotResolved">
  4661. <summary>
  4662. The host name could not be resolved.
  4663. </summary>
  4664. </member>
  4665. <member name="F:CefSharp.CefErrorCode.InternetDisconnected">
  4666. <summary>
  4667. The Internet connection has been lost.
  4668. </summary>
  4669. </member>
  4670. <member name="F:CefSharp.CefErrorCode.SslProtocolError">
  4671. <summary>
  4672. An SSL protocol error occurred.
  4673. </summary>
  4674. </member>
  4675. <member name="F:CefSharp.CefErrorCode.AddressInvalid">
  4676. <summary>
  4677. The IP address or port number is invalid (e.g., cannot connect to the IP address 0 or the port 0).
  4678. </summary>
  4679. </member>
  4680. <member name="F:CefSharp.CefErrorCode.AddressUnreachable">
  4681. <summary>
  4682. The IP address is unreachable. This usually means that there is no route to the specified host or network.
  4683. </summary>
  4684. </member>
  4685. <member name="F:CefSharp.CefErrorCode.SslClientAuthCertNeeded">
  4686. <summary>
  4687. The server requested a client certificate for SSL client authentication.
  4688. </summary>
  4689. </member>
  4690. <member name="F:CefSharp.CefErrorCode.TunnelConnectionFailed">
  4691. <summary>
  4692. A tunnel connection through the proxy could not be established.
  4693. </summary>
  4694. </member>
  4695. <member name="F:CefSharp.CefErrorCode.NoSslVersionsEnabled">
  4696. <summary>
  4697. No SSL protocol versions are enabled.
  4698. </summary>
  4699. </member>
  4700. <member name="F:CefSharp.CefErrorCode.SslVersionOrCipherMismatch">
  4701. <summary>
  4702. The client and server don't support a common SSL protocol version or cipher suite.
  4703. </summary>
  4704. </member>
  4705. <member name="F:CefSharp.CefErrorCode.SslRenegotiationRequested">
  4706. <summary>
  4707. The server requested a renegotiation (rehandshake).
  4708. </summary>
  4709. </member>
  4710. <member name="F:CefSharp.CefErrorCode.ProxyAuthUnsupported">
  4711. <summary>
  4712. The proxy requested authentication (for tunnel establishment) with an
  4713. unsupported method.
  4714. </summary>
  4715. </member>
  4716. <member name="F:CefSharp.CefErrorCode.CertErrorInSslRenegotiation">
  4717. <summary>
  4718. During SSL renegotiation (rehandshake), the server sent a certificate with
  4719. an error.
  4720. Note: this error is not in the -2xx range so that it won't be handled as a
  4721. certificate error.
  4722. </summary>
  4723. </member>
  4724. <member name="F:CefSharp.CefErrorCode.BadSslClientAuthCert">
  4725. <summary>
  4726. The SSL handshake failed because of a bad or missing client certificate.
  4727. </summary>
  4728. </member>
  4729. <member name="F:CefSharp.CefErrorCode.ConnectionTimedOut">
  4730. <summary>
  4731. A connection attempt timed out.
  4732. </summary>
  4733. </member>
  4734. <member name="F:CefSharp.CefErrorCode.HostResolverQueueTooLarge">
  4735. <summary>
  4736. There are too many pending DNS resolves, so a request in the queue was
  4737. aborted.
  4738. </summary>
  4739. </member>
  4740. <member name="F:CefSharp.CefErrorCode.SocksConnectionFailed">
  4741. <summary>
  4742. Failed establishing a connection to the SOCKS proxy server for a target host.
  4743. </summary>
  4744. </member>
  4745. <member name="F:CefSharp.CefErrorCode.SocksConnectionHostUnreachable">
  4746. <summary>
  4747. The SOCKS proxy server failed establishing connection to the target host
  4748. because that host is unreachable.
  4749. </summary>
  4750. </member>
  4751. <member name="F:CefSharp.CefErrorCode.NpnNegotiationFailed">
  4752. <summary>
  4753. The request to negotiate an alternate protocol failed.
  4754. </summary>
  4755. </member>
  4756. <member name="F:CefSharp.CefErrorCode.SslNoRenegotiation">
  4757. <summary>
  4758. The peer sent an SSL no_renegotiation alert message.
  4759. </summary>
  4760. </member>
  4761. <member name="F:CefSharp.CefErrorCode.WinsockUnexpectedWrittenBytes">
  4762. <summary>
  4763. Winsock sometimes reports more data written than passed. This is probably
  4764. due to a broken LSP.
  4765. </summary>
  4766. </member>
  4767. <member name="F:CefSharp.CefErrorCode.SslDecompressionFailureAlert">
  4768. <summary>
  4769. An SSL peer sent us a fatal decompression_failure alert. This typically
  4770. occurs when a peer selects DEFLATE compression in the mistaken belief that
  4771. it supports it.
  4772. </summary>
  4773. </member>
  4774. <member name="F:CefSharp.CefErrorCode.SslBadRecordMacAlert">
  4775. <summary>
  4776. An SSL peer sent us a fatal bad_record_mac alert. This has been observed
  4777. from servers with buggy DEFLATE support.
  4778. </summary>
  4779. </member>
  4780. <member name="F:CefSharp.CefErrorCode.ProxyAuthRequested">
  4781. <summary>
  4782. The proxy requested authentication (for tunnel establishment).
  4783. </summary>
  4784. </member>
  4785. <member name="F:CefSharp.CefErrorCode.SslUnsafeNegotiation">
  4786. <summary>
  4787. A known TLS strict server didn't offer the renegotiation extension.
  4788. </summary>
  4789. </member>
  4790. <member name="F:CefSharp.CefErrorCode.SslWeakServerEphemeralDhKey">
  4791. <summary>
  4792. The SSL server attempted to use a weak ephemeral Diffie-Hellman key.
  4793. </summary>
  4794. </member>
  4795. <member name="F:CefSharp.CefErrorCode.ProxyConnectionFailed">
  4796. <summary>
  4797. Could not create a connection to the proxy server. An error occurred
  4798. either in resolving its name, or in connecting a socket to it.
  4799. Note that this does NOT include failures during the actual "CONNECT" method
  4800. of an HTTP proxy.
  4801. </summary>
  4802. </member>
  4803. <member name="F:CefSharp.CefErrorCode.MandatoryProxyConfigurationFailed">
  4804. <summary>
  4805. A mandatory proxy configuration could not be used. Currently this means
  4806. that a mandatory PAC script could not be fetched, parsed or executed.
  4807. </summary>
  4808. </member>
  4809. <member name="F:CefSharp.CefErrorCode.PreconnectMaxSocketLimit">
  4810. <summary>
  4811. We've hit the max socket limit for the socket pool while preconnecting. We
  4812. don't bother trying to preconnect more sockets.
  4813. </summary>
  4814. </member>
  4815. <member name="F:CefSharp.CefErrorCode.SslClientAuthPrivateKeyAccessDenied">
  4816. <summary>
  4817. The permission to use the SSL client certificate's private key was denied.
  4818. </summary>
  4819. </member>
  4820. <member name="F:CefSharp.CefErrorCode.SslClientAuthCertNoPrivateKey">
  4821. <summary>
  4822. The SSL client certificate has no private key.
  4823. </summary>
  4824. </member>
  4825. <member name="F:CefSharp.CefErrorCode.ProxyCertificateInvalid">
  4826. <summary>
  4827. The certificate presented by the HTTPS Proxy was invalid.
  4828. </summary>
  4829. </member>
  4830. <member name="F:CefSharp.CefErrorCode.NameResolutionFailed">
  4831. <summary>
  4832. An error occurred when trying to do a name resolution (DNS).
  4833. </summary>
  4834. </member>
  4835. <member name="F:CefSharp.CefErrorCode.NetworkAccessDenied">
  4836. <summary>
  4837. Permission to access the network was denied. This is used to distinguish
  4838. errors that were most likely caused by a firewall from other access denied
  4839. errors. See also ERR_ACCESS_DENIED.
  4840. </summary>
  4841. </member>
  4842. <member name="F:CefSharp.CefErrorCode.TemporarilyThrottled">
  4843. <summary>
  4844. The request throttler module cancelled this request to avoid DDOS.
  4845. </summary>
  4846. </member>
  4847. <member name="F:CefSharp.CefErrorCode.HttpsProxyTunnelResponse">
  4848. <summary>
  4849. A request to create an SSL tunnel connection through the HTTPS proxy
  4850. received a non-200 (OK) and non-407 (Proxy Auth) response. The response
  4851. body might include a description of why the request failed.
  4852. </summary>
  4853. </member>
  4854. <member name="F:CefSharp.CefErrorCode.SslClientAuthSignatureFailed">
  4855. <summary>
  4856. We were unable to sign the CertificateVerify data of an SSL client auth
  4857. handshake with the client certificate's private key.
  4858. Possible causes for this include the user implicitly or explicitly
  4859. denying access to the private key, the private key may not be valid for
  4860. signing, the key may be relying on a cached handle which is no longer
  4861. valid, or the CSP won't allow arbitrary data to be signed.
  4862. </summary>
  4863. </member>
  4864. <member name="F:CefSharp.CefErrorCode.MsgTooBig">
  4865. <summary>
  4866. The message was too large for the transport. (for example a UDP message
  4867. which exceeds size threshold).
  4868. </summary>
  4869. </member>
  4870. <member name="F:CefSharp.CefErrorCode.SpdySessionAlreadyExists">
  4871. <summary>
  4872. A SPDY session already exists, and should be used instead of this connection.
  4873. </summary>
  4874. </member>
  4875. <member name="F:CefSharp.CefErrorCode.WsProtocolError">
  4876. <summary>
  4877. Websocket protocol error. Indicates that we are terminating the connection
  4878. due to a malformed frame or other protocol violation.
  4879. </summary>
  4880. </member>
  4881. <member name="F:CefSharp.CefErrorCode.ProtocolSwitched">
  4882. <summary>
  4883. Connection was aborted for switching to another ptotocol.
  4884. WebSocket abort SocketStream connection when alternate protocol is found.
  4885. </summary>
  4886. </member>
  4887. <member name="F:CefSharp.CefErrorCode.AddressInUse">
  4888. <summary>
  4889. Returned when attempting to bind an address that is already in use.
  4890. </summary>
  4891. </member>
  4892. <member name="F:CefSharp.CefErrorCode.SslHandshakeNotCompleted">
  4893. <summary>
  4894. An operation failed because the SSL handshake has not completed.
  4895. </summary>
  4896. </member>
  4897. <member name="F:CefSharp.CefErrorCode.SslBadPeerPublicKey">
  4898. <summary>
  4899. SSL peer's public key is invalid.
  4900. </summary>
  4901. </member>
  4902. <member name="F:CefSharp.CefErrorCode.SslPinnedKeyNotInCertChain">
  4903. <summary>
  4904. The certificate didn't match the built-in public key pins for the host name.
  4905. The pins are set in net/http/transport_security_state.cc and require that
  4906. one of a set of public keys exist on the path from the leaf to the root.
  4907. </summary>
  4908. </member>
  4909. <member name="F:CefSharp.CefErrorCode.ClientAuthCertTypeUnsupported">
  4910. <summary>
  4911. Server request for client certificate did not contain any types we support.
  4912. </summary>
  4913. </member>
  4914. <member name="F:CefSharp.CefErrorCode.OriginBoundCertGenerationTypeMismatch">
  4915. <summary>
  4916. Server requested one type of cert, then requested a different type while the
  4917. first was still being generated.
  4918. </summary>
  4919. </member>
  4920. <member name="F:CefSharp.CefErrorCode.SslDecryptErrorAlert">
  4921. <summary>
  4922. An SSL peer sent us a fatal decrypt_error alert. This typically occurs when
  4923. a peer could not correctly verify a signature (in CertificateVerify or
  4924. ServerKeyExchange) or validate a Finished message.
  4925. </summary>
  4926. </member>
  4927. <member name="F:CefSharp.CefErrorCode.WsThrottleQueueTooLarge">
  4928. <summary>
  4929. There are too many pending WebSocketJob instances, so the new job was not
  4930. pushed to the queue.
  4931. </summary>
  4932. </member>
  4933. <member name="F:CefSharp.CefErrorCode.TooManySocketStreams">
  4934. <summary>
  4935. There are too many active SocketStream instances, so the new connect request
  4936. was rejected.
  4937. </summary>
  4938. </member>
  4939. <member name="F:CefSharp.CefErrorCode.SslServerCertChanged">
  4940. <summary>
  4941. The SSL server certificate changed in a renegotiation.
  4942. </summary>
  4943. </member>
  4944. <member name="F:CefSharp.CefErrorCode.SslInappropriateFallback">
  4945. <summary>
  4946. The SSL server indicated that an unnecessary TLS version fallback was
  4947. performed.
  4948. </summary>
  4949. </member>
  4950. <member name="F:CefSharp.CefErrorCode.CtNoSctsVerifiedOk">
  4951. <summary>
  4952. Certificate Transparency: All Signed Certificate Timestamps failed to verify.
  4953. </summary>
  4954. </member>
  4955. <member name="F:CefSharp.CefErrorCode.SslUnrecognizedNameAlert">
  4956. <summary>
  4957. The SSL server sent us a fatal unrecognized_name alert.
  4958. </summary>
  4959. </member>
  4960. <member name="F:CefSharp.CefErrorCode.SocketSetReceiveBufferSizeError">
  4961. <summary>
  4962. Failed to set the socket's receive buffer size as requested.
  4963. </summary>
  4964. </member>
  4965. <member name="F:CefSharp.CefErrorCode.SocketSetSendBufferSizeError">
  4966. <summary>
  4967. Failed to set the socket's send buffer size as requested.
  4968. </summary>
  4969. </member>
  4970. <member name="F:CefSharp.CefErrorCode.SocketReceiveBufferSizeUnchangeable">
  4971. <summary>
  4972. Failed to set the socket's receive buffer size as requested, despite success
  4973. return code from setsockopt.
  4974. </summary>
  4975. </member>
  4976. <member name="F:CefSharp.CefErrorCode.SocketSendBufferSizeUnchangeable">
  4977. <summary>
  4978. Failed to set the socket's send buffer size as requested, despite success
  4979. return code from setsockopt.
  4980. </summary>
  4981. </member>
  4982. <member name="F:CefSharp.CefErrorCode.SslClientAuthCertBadFormat">
  4983. <summary>
  4984. Failed to import a client certificate from the platform store into the SSL
  4985. library.
  4986. </summary>
  4987. </member>
  4988. <member name="F:CefSharp.CefErrorCode.CertCommonNameInvalid">
  4989. <summary>
  4990. The server responded with a certificate whose common name did not match the host name.
  4991. This could mean:
  4992. 1. An attacker has redirected our traffic to his server and is presenting a certificate
  4993. for which he knows the private key.
  4994. 2. The server is misconfigured and responding with the wrong cert.
  4995. 3. The user is on a wireless network and is being redirected to the network's login page.
  4996. 4. The OS has used a DNS search suffix and the server doesn't have a certificate for the
  4997. abbreviated name in the address bar.
  4998. </summary>
  4999. </member>
  5000. <member name="F:CefSharp.CefErrorCode.CertDateInvalid">
  5001. <summary>
  5002. The server responded with a certificate that, by our clock, appears to either not yet be valid or to have expired.
  5003. This could mean:
  5004. 1. An attacker is presenting an old certificate for which he has managed to obtain the private key
  5005. 2. The server is misconfigured and is not presenting a valid cert.
  5006. 3. Our clock is wrong.
  5007. </summary>
  5008. </member>
  5009. <member name="F:CefSharp.CefErrorCode.CertAuthorityInvalid">
  5010. <summary>
  5011. The server responded with a certificate that is signed by an authority we don't trust.
  5012. The could mean:
  5013. 1. An attacker has substituted the real certificate for a cert that
  5014. contains his public key and is signed by his cousin.
  5015. 2. The server operator has a legitimate certificate from a CA we don't know about, but should trust.
  5016. 3. The server is presenting a self-signed certificate, providing no defense against active attackers (but foiling passive attackers).
  5017. </summary>
  5018. </member>
  5019. <member name="F:CefSharp.CefErrorCode.CertContainsErrors">
  5020. <summary>
  5021. The server responded with a certificate that contains errors. This error is not recoverable.
  5022. MSDN describes this error as follows:
  5023. "The SSL certificate contains errors."
  5024. NOTE: It's unclear how this differs from ERR_CERT_INVALID. For consistency,
  5025. use that code instead of this one from now on.
  5026. </summary>
  5027. </member>
  5028. <member name="F:CefSharp.CefErrorCode.CertNoRevocationMechanism">
  5029. <summary>
  5030. The certificate has no mechanism for determining if it is revoked. In effect, this certificate cannot be revoked.
  5031. </summary>
  5032. </member>
  5033. <member name="F:CefSharp.CefErrorCode.CertUnableToCheckRevocation">
  5034. <summary>
  5035. Revocation information for the security certificate for this site is not available.
  5036. This could mean:
  5037. 1. An attacker has compromised the private key in the certificate and is blocking our attempt to
  5038. find out that the cert was revoked.
  5039. 2. The certificate is unrevoked, but the revocation server is busy or unavailable.
  5040. </summary>
  5041. </member>
  5042. <member name="F:CefSharp.CefErrorCode.CertRevoked">
  5043. <summary>
  5044. The server responded with a certificate has been revoked.
  5045. We have the capability to ignore this error, but it is probably not the thing to do.
  5046. </summary>
  5047. </member>
  5048. <member name="F:CefSharp.CefErrorCode.CertInvalid">
  5049. <summary>
  5050. The server responded with a certificate that is invalid. This error is not recoverable.
  5051. </summary>
  5052. </member>
  5053. <member name="F:CefSharp.CefErrorCode.CertWeakSignatureAlgorithm">
  5054. <summary>
  5055. The server responded with a certificate that is signed using a weak
  5056. signature algorithm.
  5057. </summary>
  5058. </member>
  5059. <member name="F:CefSharp.CefErrorCode.CertNonUniqueName">
  5060. <summary>
  5061. The host name specified in the certificate is not unique.
  5062. </summary>
  5063. </member>
  5064. <member name="F:CefSharp.CefErrorCode.CertWeakKey">
  5065. <summary>
  5066. The server responded with a certificate that contains a weak key (e.g.
  5067. a too-small RSA key).
  5068. </summary>
  5069. </member>
  5070. <member name="F:CefSharp.CefErrorCode.CertNameConstraintViolation">
  5071. <summary>
  5072. The certificate claimed DNS names that are in violation of name constraints.
  5073. </summary>
  5074. </member>
  5075. <member name="F:CefSharp.CefErrorCode.CertEnd">
  5076. <summary>
  5077. Add new certificate error codes here.
  5078. Update the value of CERT_END whenever you add a new certificate error
  5079. code.
  5080. The value immediately past the last certificate error code.
  5081. </summary>
  5082. </member>
  5083. <member name="F:CefSharp.CefErrorCode.InvalidUrl">
  5084. <summary>
  5085. The URL is invalid.
  5086. </summary>
  5087. </member>
  5088. <member name="F:CefSharp.CefErrorCode.DisallowedUrlScheme">
  5089. <summary>
  5090. The scheme of the URL is disallowed.
  5091. </summary>
  5092. </member>
  5093. <member name="F:CefSharp.CefErrorCode.UnknownUrlScheme">
  5094. <summary>
  5095. The scheme of the URL is unknown.
  5096. </summary>
  5097. </member>
  5098. <member name="F:CefSharp.CefErrorCode.TooManyRedirects">
  5099. <summary>
  5100. Attempting to load an URL resulted in too many redirects.
  5101. </summary>
  5102. </member>
  5103. <member name="F:CefSharp.CefErrorCode.UnsafeRedirect">
  5104. <summary>
  5105. Attempting to load an URL resulted in an unsafe redirect (e.g., a redirect to file:// is considered unsafe).
  5106. </summary>
  5107. </member>
  5108. <member name="F:CefSharp.CefErrorCode.UnsafePort">
  5109. <summary>
  5110. Attempting to load an URL with an unsafe port number. These are port
  5111. numbers that correspond to services, which are not robust to spurious input
  5112. that may be constructed as a result of an allowed web construct (e.g., HTTP
  5113. looks a lot like SMTP, so form submission to port 25 is denied).
  5114. </summary>
  5115. </member>
  5116. <member name="F:CefSharp.CefErrorCode.InvalidResponse">
  5117. <summary>
  5118. The server's response was invalid.
  5119. </summary>
  5120. </member>
  5121. <member name="F:CefSharp.CefErrorCode.InvalidChunkedEncoding">
  5122. <summary>
  5123. Error in chunked transfer encoding.
  5124. </summary>
  5125. </member>
  5126. <member name="F:CefSharp.CefErrorCode.MethodNotSupported">
  5127. <summary>
  5128. The server did not support the request method.
  5129. </summary>
  5130. </member>
  5131. <member name="F:CefSharp.CefErrorCode.UnexpectedProxyAuth">
  5132. <summary>
  5133. The response was 407 (Proxy Authentication Required), yet we did not send the request to a proxy.
  5134. </summary>
  5135. </member>
  5136. <member name="F:CefSharp.CefErrorCode.EmptyResponse">
  5137. <summary>
  5138. The server closed the connection without sending any data.
  5139. </summary>
  5140. </member>
  5141. <member name="F:CefSharp.CefErrorCode.ResponseHeadersTooBig">
  5142. <summary>
  5143. The headers section of the response is too large.
  5144. </summary>
  5145. </member>
  5146. <member name="F:CefSharp.CefErrorCode.PacStatusNotOk">
  5147. <summary>
  5148. The PAC requested by HTTP did not have a valid status code (non-200).
  5149. </summary>
  5150. </member>
  5151. <member name="F:CefSharp.CefErrorCode.PacScriptFailed">
  5152. <summary>
  5153. The evaluation of the PAC script failed.
  5154. </summary>
  5155. </member>
  5156. <member name="F:CefSharp.CefErrorCode.RequestRangeNotSatisfiable">
  5157. <summary>
  5158. The response was 416 (Requested range not satisfiable) and the server cannot
  5159. satisfy the range requested.
  5160. </summary>
  5161. </member>
  5162. <member name="F:CefSharp.CefErrorCode.MalformedIdentity">
  5163. <summary>
  5164. The identity used for authentication is invalid.
  5165. </summary>
  5166. </member>
  5167. <member name="F:CefSharp.CefErrorCode.ContentDecodingFailed">
  5168. <summary>
  5169. Content decoding of the response body failed.
  5170. </summary>
  5171. </member>
  5172. <member name="F:CefSharp.CefErrorCode.NetworkIoSuspended">
  5173. <summary>
  5174. An operation could not be completed because all network IO
  5175. is suspended.
  5176. </summary>
  5177. </member>
  5178. <member name="F:CefSharp.CefErrorCode.SynReplyNotReceived">
  5179. <summary>
  5180. FLIP data received without receiving a SYN_REPLY on the stream.
  5181. </summary>
  5182. </member>
  5183. <member name="F:CefSharp.CefErrorCode.EncodingConversionFailed">
  5184. <summary>
  5185. Converting the response to target encoding failed.
  5186. </summary>
  5187. </member>
  5188. <member name="F:CefSharp.CefErrorCode.UnrecognizedFtpDirectoryListingFormat">
  5189. <summary>
  5190. The server sent an FTP directory listing in a format we do not understand.
  5191. </summary>
  5192. </member>
  5193. <member name="F:CefSharp.CefErrorCode.InvalidSpdyStream">
  5194. <summary>
  5195. Attempted use of an unknown SPDY stream id.
  5196. </summary>
  5197. </member>
  5198. <member name="F:CefSharp.CefErrorCode.NoSupportedProxies">
  5199. <summary>
  5200. There are no supported proxies in the provided list.
  5201. </summary>
  5202. </member>
  5203. <member name="F:CefSharp.CefErrorCode.SpdyProtocolError">
  5204. <summary>
  5205. There is a SPDY protocol error.
  5206. </summary>
  5207. </member>
  5208. <member name="F:CefSharp.CefErrorCode.InvalidAuthCredentials">
  5209. <summary>
  5210. Credentials could not be established during HTTP Authentication.
  5211. </summary>
  5212. </member>
  5213. <member name="F:CefSharp.CefErrorCode.UnsupportedAuthScheme">
  5214. <summary>
  5215. An HTTP Authentication scheme was tried which is not supported on this
  5216. machine.
  5217. </summary>
  5218. </member>
  5219. <member name="F:CefSharp.CefErrorCode.EncodingDetectionFailed">
  5220. <summary>
  5221. Detecting the encoding of the response failed.
  5222. </summary>
  5223. </member>
  5224. <member name="F:CefSharp.CefErrorCode.MissingAuthCredentials">
  5225. <summary>
  5226. (GSSAPI) No Kerberos credentials were available during HTTP Authentication.
  5227. </summary>
  5228. </member>
  5229. <member name="F:CefSharp.CefErrorCode.UnexpectedSecurityLibraryStatus">
  5230. <summary>
  5231. An unexpected, but documented, SSPI or GSSAPI status code was returned.
  5232. </summary>
  5233. </member>
  5234. <member name="F:CefSharp.CefErrorCode.MisconfiguredAuthEnvironment">
  5235. <summary>
  5236. The environment was not set up correctly for authentication (for
  5237. example, no KDC could be found or the principal is unknown.
  5238. </summary>
  5239. </member>
  5240. <member name="F:CefSharp.CefErrorCode.UndocumentedSecurityLibraryStatus">
  5241. <summary>
  5242. An undocumented SSPI or GSSAPI status code was returned.
  5243. </summary>
  5244. </member>
  5245. <member name="F:CefSharp.CefErrorCode.ResponseBodyTooBigToDrain">
  5246. <summary>
  5247. The HTTP response was too big to drain.
  5248. </summary>
  5249. </member>
  5250. <member name="F:CefSharp.CefErrorCode.ResponseHeadersMultipleContentLength">
  5251. <summary>
  5252. The HTTP response contained multiple distinct Content-Length headers.
  5253. </summary>
  5254. </member>
  5255. <member name="F:CefSharp.CefErrorCode.IncompleteSpdyHeaders">
  5256. <summary>
  5257. SPDY Headers have been received, but not all of them - status or version
  5258. headers are missing, so we're expecting additional frames to complete them.
  5259. </summary>
  5260. </member>
  5261. <member name="F:CefSharp.CefErrorCode.PacNotInDhcp">
  5262. <summary>
  5263. No PAC URL configuration could be retrieved from DHCP. This can indicate
  5264. either a failure to retrieve the DHCP configuration, or that there was no
  5265. PAC URL configured in DHCP.
  5266. </summary>
  5267. </member>
  5268. <member name="F:CefSharp.CefErrorCode.ResponseHeadersMultipleContentDisposition">
  5269. <summary>
  5270. The HTTP response contained multiple Content-Disposition headers.
  5271. </summary>
  5272. </member>
  5273. <member name="F:CefSharp.CefErrorCode.ResponseHeadersMultipleLocation">
  5274. <summary>
  5275. The HTTP response contained multiple Location headers.
  5276. </summary>
  5277. </member>
  5278. <member name="F:CefSharp.CefErrorCode.SpdyServerRefusedStream">
  5279. <summary>
  5280. SPDY server refused the stream. Client should retry. This should never be a
  5281. user-visible error.
  5282. </summary>
  5283. </member>
  5284. <member name="F:CefSharp.CefErrorCode.SpdyPingFailed">
  5285. <summary>
  5286. SPDY server didn't respond to the PING message.
  5287. </summary>
  5288. </member>
  5289. <member name="F:CefSharp.CefErrorCode.ContentLengthMismatch">
  5290. <summary>
  5291. The HTTP response body transferred fewer bytes than were advertised by the
  5292. Content-Length header when the connection is closed.
  5293. </summary>
  5294. </member>
  5295. <member name="F:CefSharp.CefErrorCode.IncompleteChunkedEncoding">
  5296. <summary>
  5297. The HTTP response body is transferred with Chunked-Encoding, but the
  5298. terminating zero-length chunk was never sent when the connection is closed.
  5299. </summary>
  5300. </member>
  5301. <member name="F:CefSharp.CefErrorCode.QuicProtocolError">
  5302. <summary>
  5303. There is a QUIC protocol error.
  5304. </summary>
  5305. </member>
  5306. <member name="F:CefSharp.CefErrorCode.ResponseHeadersTruncated">
  5307. <summary>
  5308. The HTTP headers were truncated by an EOF.
  5309. </summary>
  5310. </member>
  5311. <member name="F:CefSharp.CefErrorCode.QuicHandshakeFailed">
  5312. <summary>
  5313. The QUIC crytpo handshake failed. This means that the server was unable
  5314. to read any requests sent, so they may be resent.
  5315. </summary>
  5316. </member>
  5317. <member name="F:CefSharp.CefErrorCode.RequestForSecureResourceOverInsecureQuic">
  5318. <summary>
  5319. An https resource was requested over an insecure QUIC connection.
  5320. </summary>
  5321. </member>
  5322. <member name="F:CefSharp.CefErrorCode.SpdyInadequateTransportSecurity">
  5323. <summary>
  5324. Transport security is inadequate for the SPDY version.
  5325. </summary>
  5326. </member>
  5327. <member name="F:CefSharp.CefErrorCode.SpdyFlowControlError">
  5328. <summary>
  5329. The peer violated SPDY flow control.
  5330. </summary>
  5331. </member>
  5332. <member name="F:CefSharp.CefErrorCode.SpdyFrameSizeError">
  5333. <summary>
  5334. The peer sent an improperly sized SPDY frame.
  5335. </summary>
  5336. </member>
  5337. <member name="F:CefSharp.CefErrorCode.SpdyCompressionError">
  5338. <summary>
  5339. Decoding or encoding of compressed SPDY headers failed.
  5340. </summary>
  5341. </member>
  5342. <member name="F:CefSharp.CefErrorCode.ProxyAuthRequestedWithNoConnection">
  5343. <summary>
  5344. Proxy Auth Requested without a valid Client Socket Handle.
  5345. </summary>
  5346. </member>
  5347. <member name="F:CefSharp.CefErrorCode.CacheMiss">
  5348. <summary>
  5349. The cache does not have the requested entry.
  5350. </summary>
  5351. </member>
  5352. <member name="F:CefSharp.CefErrorCode.CacheReadFailure">
  5353. <summary>
  5354. Unable to read from the disk cache.
  5355. </summary>
  5356. </member>
  5357. <member name="F:CefSharp.CefErrorCode.CacheWriteFailure">
  5358. <summary>
  5359. Unable to write to the disk cache.
  5360. </summary>
  5361. </member>
  5362. <member name="F:CefSharp.CefErrorCode.CacheOperationNotSupported">
  5363. <summary>
  5364. The operation is not supported for this entry.
  5365. </summary>
  5366. </member>
  5367. <member name="F:CefSharp.CefErrorCode.CacheOpenFailure">
  5368. <summary>
  5369. The disk cache is unable to open this entry.
  5370. </summary>
  5371. </member>
  5372. <member name="F:CefSharp.CefErrorCode.CacheCreateFailure">
  5373. <summary>
  5374. The disk cache is unable to create this entry.
  5375. </summary>
  5376. </member>
  5377. <member name="F:CefSharp.CefErrorCode.CacheRace">
  5378. <summary>
  5379. Multiple transactions are racing to create disk cache entries. This is an
  5380. internal error returned from the HttpCache to the HttpCacheTransaction that
  5381. tells the transaction to restart the entry-creation logic because the state
  5382. of the cache has changed.
  5383. </summary>
  5384. </member>
  5385. <member name="F:CefSharp.CefErrorCode.CacheChecksumReadFailure">
  5386. <summary>
  5387. The cache was unable to read a checksum record on an entry. This can be
  5388. returned from attempts to read from the cache. It is an internal error,
  5389. returned by the SimpleCache backend, but not by any URLRequest methods
  5390. or members.
  5391. </summary>
  5392. </member>
  5393. <member name="F:CefSharp.CefErrorCode.CacheChecksumMismatch">
  5394. <summary>
  5395. The cache found an entry with an invalid checksum. This can be returned from
  5396. attempts to read from the cache. It is an internal error, returned by the
  5397. SimpleCache backend, but not by any URLRequest methods or members.
  5398. </summary>
  5399. </member>
  5400. <member name="F:CefSharp.CefErrorCode.CacheLockTimeout">
  5401. <summary>
  5402. Internal error code for the HTTP cache. The cache lock timeout has fired.
  5403. </summary>
  5404. </member>
  5405. <member name="F:CefSharp.CefErrorCode.InsecureResponse">
  5406. <summary>
  5407. The server's response was insecure (e.g. there was a cert error).
  5408. </summary>
  5409. </member>
  5410. <member name="F:CefSharp.CefErrorCode.NoPrivateKeyForCert">
  5411. <summary>
  5412. The server responded to a &lt;keygen&gt; with a generated client cert that we
  5413. don't have the matching private key for.
  5414. </summary>
  5415. </member>
  5416. <member name="F:CefSharp.CefErrorCode.AddUserCertFailed">
  5417. <summary>
  5418. An error adding to the OS certificate database (e.g. OS X Keychain).
  5419. </summary>
  5420. </member>
  5421. <member name="F:CefSharp.CefErrorCode.FtpFailed">
  5422. <summary>
  5423. A generic error for failed FTP control connection command.
  5424. If possible, please use or add a more specific error code.
  5425. </summary>
  5426. </member>
  5427. <member name="F:CefSharp.CefErrorCode.FtpServiceUnavailable">
  5428. <summary>
  5429. The server cannot fulfill the request at this point. This is a temporary
  5430. error.
  5431. FTP response code 421.
  5432. </summary>
  5433. </member>
  5434. <member name="F:CefSharp.CefErrorCode.FtpTransferAborted">
  5435. <summary>
  5436. The server has aborted the transfer.
  5437. FTP response code 426.
  5438. </summary>
  5439. </member>
  5440. <member name="F:CefSharp.CefErrorCode.FtpFileBusy">
  5441. <summary>
  5442. The file is busy, or some other temporary error condition on opening
  5443. the file.
  5444. FTP response code 450.
  5445. </summary>
  5446. </member>
  5447. <member name="F:CefSharp.CefErrorCode.FtpSyntaxError">
  5448. <summary>
  5449. Server rejected our command because of syntax errors.
  5450. FTP response codes 500, 501.
  5451. </summary>
  5452. </member>
  5453. <member name="F:CefSharp.CefErrorCode.FtpCommandNotSupported">
  5454. <summary>
  5455. Server does not support the command we issued.
  5456. FTP response codes 502, 504.
  5457. </summary>
  5458. </member>
  5459. <member name="F:CefSharp.CefErrorCode.FtpBadCommandSequence">
  5460. <summary>
  5461. Server rejected our command because we didn't issue the commands in right
  5462. order.
  5463. FTP response code 503.
  5464. </summary>
  5465. </member>
  5466. <member name="F:CefSharp.CefErrorCode.Pkcs12ImportBadPassword">
  5467. <summary>
  5468. PKCS #12 import failed due to incorrect password.
  5469. </summary>
  5470. </member>
  5471. <member name="F:CefSharp.CefErrorCode.Pkcs12ImportFailed">
  5472. <summary>
  5473. PKCS #12 import failed due to other error.
  5474. </summary>
  5475. </member>
  5476. <member name="F:CefSharp.CefErrorCode.ImportCaCertNotCa">
  5477. <summary>
  5478. CA import failed - not a CA cert.
  5479. </summary>
  5480. </member>
  5481. <member name="F:CefSharp.CefErrorCode.ImportCertAlreadyExists">
  5482. <summary>
  5483. Import failed - certificate already exists in database.
  5484. Note it's a little weird this is an error but reimporting a PKCS12 is ok
  5485. (no-op). That's how Mozilla does it, though.
  5486. </summary>
  5487. </member>
  5488. <member name="F:CefSharp.CefErrorCode.ImportCaCertFailed">
  5489. <summary>
  5490. CA import failed due to some other error.
  5491. </summary>
  5492. </member>
  5493. <member name="F:CefSharp.CefErrorCode.ImportServerCertFailed">
  5494. <summary>
  5495. Server certificate import failed due to some internal error.
  5496. </summary>
  5497. </member>
  5498. <member name="F:CefSharp.CefErrorCode.Pkcs12ImportInvalidMac">
  5499. <summary>
  5500. PKCS #12 import failed due to invalid MAC.
  5501. </summary>
  5502. </member>
  5503. <member name="F:CefSharp.CefErrorCode.Pkcs12ImportInvalidFile">
  5504. <summary>
  5505. PKCS #12 import failed due to invalid/corrupt file.
  5506. </summary>
  5507. </member>
  5508. <member name="F:CefSharp.CefErrorCode.Pkcs12ImportUnsupported">
  5509. <summary>
  5510. PKCS #12 import failed due to unsupported features.
  5511. </summary>
  5512. </member>
  5513. <member name="F:CefSharp.CefErrorCode.KeyGenerationFailed">
  5514. <summary>
  5515. Key generation failed.
  5516. </summary>
  5517. </member>
  5518. <member name="F:CefSharp.CefErrorCode.OriginBoundCertGenerationFailed">
  5519. <summary>
  5520. Server-bound certificate generation failed.
  5521. </summary>
  5522. </member>
  5523. <member name="F:CefSharp.CefErrorCode.PrivateKeyExportFailed">
  5524. <summary>
  5525. Failure to export private key.
  5526. </summary>
  5527. </member>
  5528. <member name="F:CefSharp.CefErrorCode.SelfSignedCertGenerationFailed">
  5529. <summary>
  5530. Self-signed certificate generation failed.
  5531. </summary>
  5532. </member>
  5533. <member name="F:CefSharp.CefErrorCode.CertDatabaseChanged">
  5534. <summary>
  5535. The certificate database changed in some way.
  5536. </summary>
  5537. </member>
  5538. <member name="F:CefSharp.CefErrorCode.ChannelIdImportFailed">
  5539. <summary>
  5540. Failure to import Channel ID.
  5541. </summary>
  5542. </member>
  5543. <member name="F:CefSharp.CefErrorCode.DnsMalformedResponse">
  5544. <summary>
  5545. DNS resolver received a malformed response.
  5546. </summary>
  5547. </member>
  5548. <member name="F:CefSharp.CefErrorCode.DnsServerRequiresTcp">
  5549. <summary>
  5550. DNS server requires TCP
  5551. </summary>
  5552. </member>
  5553. <member name="F:CefSharp.CefErrorCode.DnsServerFailed">
  5554. <summary>
  5555. DNS server failed. This error is returned for all of the following
  5556. error conditions:
  5557. 1 - Format error - The name server was unable to interpret the query.
  5558. 2 - Server failure - The name server was unable to process this query
  5559. due to a problem with the name server.
  5560. 4 - Not Implemented - The name server does not support the requested
  5561. kind of query.
  5562. 5 - Refused - The name server refuses to perform the specified
  5563. operation for policy reasons.
  5564. </summary>
  5565. </member>
  5566. <member name="F:CefSharp.CefErrorCode.DnsTimedOut">
  5567. <summary>
  5568. DNS transaction timed out.
  5569. </summary>
  5570. </member>
  5571. <member name="F:CefSharp.CefErrorCode.DnsCacheMiss">
  5572. <summary>
  5573. The entry was not found in cache, for cache-only lookups.
  5574. </summary>
  5575. </member>
  5576. <member name="F:CefSharp.CefErrorCode.DnsSearchEmpty">
  5577. <summary>
  5578. Suffix search list rules prevent resolution of the given host name.
  5579. </summary>
  5580. </member>
  5581. <member name="F:CefSharp.CefErrorCode.DnsSortError">
  5582. <summary>
  5583. Failed to sort addresses according to RFC3484.
  5584. </summary>
  5585. </member>
  5586. <member name="T:CefSharp.ConsoleMessageEventArgs">
  5587. <summary>
  5588. Event arguments to the ConsoleMessage event handler set up in IWebBrowser.
  5589. </summary>
  5590. </member>
  5591. <member name="M:CefSharp.ConsoleMessageEventArgs.#ctor(System.String,System.String,System.Int32)">
  5592. <summary>
  5593. Creates a new ConsoleMessageEventArgs event argument.
  5594. </summary>
  5595. <param name="message">message</param>
  5596. <param name="source">source</param>
  5597. <param name="line">line number</param>
  5598. </member>
  5599. <member name="P:CefSharp.ConsoleMessageEventArgs.Message">
  5600. <summary>
  5601. The message text of the console message.
  5602. </summary>
  5603. </member>
  5604. <member name="P:CefSharp.ConsoleMessageEventArgs.Source">
  5605. <summary>
  5606. The source of the console message.
  5607. </summary>
  5608. </member>
  5609. <member name="P:CefSharp.ConsoleMessageEventArgs.Line">
  5610. <summary>
  5611. The line number that generated the console message.
  5612. </summary>
  5613. </member>
  5614. <member name="T:CefSharp.IDownloadHandler">
  5615. <summary>
  5616. Class used to handle file downloads.
  5617. The methods of this class will called on the CEF UI thread.
  5618. </summary>
  5619. </member>
  5620. <member name="M:CefSharp.IDownloadHandler.OnBeforeDownload(CefSharp.IBrowser,CefSharp.DownloadItem,CefSharp.IBeforeDownloadCallback)">
  5621. <summary>
  5622. Called before a download begins.
  5623. </summary>
  5624. <param name="browser">The browser instance</param>
  5625. <param name="downloadItem">Represents the file being downloaded.</param>
  5626. <param name="callback">Callback interface used to asynchronously continue a download.</param>
  5627. </member>
  5628. <member name="M:CefSharp.IDownloadHandler.OnDownloadUpdated(CefSharp.IBrowser,CefSharp.DownloadItem,CefSharp.IDownloadItemCallback)">
  5629. <summary>
  5630. Called when a download's status or progress information has been updated. This may be called multiple times before and after <see cref="M:CefSharp.IDownloadHandler.OnBeforeDownload(CefSharp.IBrowser,CefSharp.DownloadItem,CefSharp.IBeforeDownloadCallback)"/>.
  5631. </summary>
  5632. <param name="browser">The browser instance</param>
  5633. <param name="downloadItem">Represents the file being downloaded.</param>
  5634. <param name="callback">The callback used to Cancel/Pause/Resume the process</param>
  5635. </member>
  5636. <member name="T:CefSharp.IJsDialogHandler">
  5637. <summary>
  5638. Implement this interface to handle events related to JavaScript dialogs.
  5639. The methods of this class will be called on the CEF UI thread.
  5640. </summary>
  5641. </member>
  5642. <member name="M:CefSharp.IJsDialogHandler.OnJSDialog(CefSharp.IWebBrowser,CefSharp.IBrowser,System.String,CefSharp.CefJsDialogType,System.String,System.String,CefSharp.IJsDialogCallback,System.Boolean@)">
  5643. <summary>
  5644. Called to run a JavaScript dialog.
  5645. </summary>
  5646. <param name="browserControl">the browser control</param>
  5647. <param name="browser">the browser object</param>
  5648. <param name="originUrl">originating url</param>
  5649. <param name="dialogType">Dialog Type</param>
  5650. <param name="messageText">Message Text</param>
  5651. <param name="defaultPromptText">value will be specified for prompt dialogs only</param>
  5652. <param name="callback">Callback can be executed inline or in an async fashion</param>
  5653. <param name="suppressMessage">Set suppressMessage to true and return false to suppress the message (suppressing messages is preferable to immediately executing the callback as this is used to detect presumably malicious behavior like spamming alert messages in onbeforeunload). Set suppressMessage to false and return false to use the default implementation (the default implementation will show one modal dialog at a time and suppress any additional dialog requests until the displayed dialog is dismissed).</param>
  5654. <returns>Return true if the application will use a custom dialog or if the callback has been executed immediately. Custom dialogs may be either modal or modeless. If a custom dialog is used the application must execute |callback| once the custom dialog is dismissed.</returns>
  5655. </member>
  5656. <member name="M:CefSharp.IJsDialogHandler.OnJSBeforeUnload(CefSharp.IWebBrowser,CefSharp.IBrowser,System.String,System.Boolean,CefSharp.IJsDialogCallback)">
  5657. <summary>
  5658. When leaving the page a Javascript dialog is displayed asking for user confirmation.
  5659. Returning True allows you to implement a custom dialog or programatically handle.
  5660. To cancel the unload return True and set allowUnload to False.
  5661. </summary>
  5662. <param name="browserControl">the browser control</param>
  5663. <param name="browser">the browser object</param>
  5664. <param name="message">message (optional)</param>
  5665. <param name="isReload">indicates a page reload</param>
  5666. <param name="callback">Callback can be executed inline or in an async fashion</param>
  5667. <returns>Return false to use the default dialog implementation otherwise return true to handle</returns>
  5668. </member>
  5669. <member name="M:CefSharp.IJsDialogHandler.OnResetDialogState(CefSharp.IWebBrowser,CefSharp.IBrowser)">
  5670. <summary>
  5671. Called to cancel any pending dialogs and reset any saved dialog state. Will
  5672. be called due to events like page navigation irregardless of whether any
  5673. dialogs are currently pending.
  5674. </summary>
  5675. <param name="browserControl">the browser control</param>
  5676. <param name="browser">the browser object</param>
  5677. </member>
  5678. <member name="M:CefSharp.IJsDialogHandler.OnDialogClosed(CefSharp.IWebBrowser,CefSharp.IBrowser)">
  5679. <summary>
  5680. Called when the default implementation dialog is closed.
  5681. </summary>
  5682. <param name="browserControl">the browser control</param>
  5683. <param name="browser">the browser object</param>
  5684. </member>
  5685. <member name="T:CefSharp.IKeyboardHandler">
  5686. <summary>
  5687. Implement this interface to handle events related to keyboard input.
  5688. </summary>
  5689. </member>
  5690. <member name="M:CefSharp.IKeyboardHandler.OnPreKeyEvent(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.KeyType,System.Int32,System.Int32,CefSharp.CefEventFlags,System.Boolean,System.Boolean@)">
  5691. <summary>
  5692. Called before a keyboard event is sent to the renderer.
  5693. Return true if the event was handled or false
  5694. otherwise. If the event will be handled in <see cref="M:CefSharp.IKeyboardHandler.OnKeyEvent(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.KeyType,System.Int32,System.Int32,CefSharp.CefEventFlags,System.Boolean)"/> as a keyboard
  5695. shortcut set isKeyboardShortcut to true and return false.
  5696. </summary>
  5697. <param name="browserControl">The <see cref="T:CefSharp.IWebBrowser"/> control this request is for.</param>
  5698. <param name="browser">The browser instance.</param>
  5699. <param name="type">Whether this was a key up/down/raw/etc...</param>
  5700. <param name="windowsKeyCode">
  5701. The Windows key code for the key event. This value is used by the DOM
  5702. specification. Sometimes it comes directly from the event (i.e. on
  5703. Windows) and sometimes it's determined using a mapping function. See
  5704. WebCore/platform/chromium/KeyboardCodes.h for the list of values.
  5705. </param>
  5706. <param name="nativeKeyCode">The native key code. On Windows this appears to be in the format of WM_KEYDOWN/WM_KEYUP/etc... lParam data.</param>
  5707. <param name="modifiers">What other modifier keys are currently down: Shift/Control/Alt/OS X Command/etc...</param>
  5708. <param name="isSystemKey">
  5709. Indicates whether the event is considered a "system key" event (see
  5710. http://msdn.microsoft.com/en-us/library/ms646286(VS.85).aspx for details).
  5711. </param>
  5712. <param name="isKeyboardShortcut">See the summary for an explanation of when to set this to true.</param>
  5713. <returns>Returns true if the event was handled or false otherwise.</returns>
  5714. </member>
  5715. <member name="M:CefSharp.IKeyboardHandler.OnKeyEvent(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.KeyType,System.Int32,System.Int32,CefSharp.CefEventFlags,System.Boolean)">
  5716. <summary>
  5717. Called after the renderer and JavaScript in the page has had a chance to
  5718. handle the event. Return true if the keyboard event was handled or false otherwise.
  5719. </summary>
  5720. <param name="browserControl">The <see cref="T:CefSharp.IWebBrowser"/> control this request is for.</param>
  5721. <param name="browser">The browser instance.</param>
  5722. <param name="type">Whether this was a key up/down/raw/etc...</param>
  5723. <param name="windowsKeyCode">
  5724. The Windows key code for the key event. This value is used by the DOM
  5725. specification. Sometimes it comes directly from the event (i.e. on
  5726. Windows) and sometimes it's determined using a mapping function. See
  5727. WebCore/platform/chromium/KeyboardCodes.h for the list of values.
  5728. </param>
  5729. <param name="nativeKeyCode">The native key code. On Windows this appears to be in the format of WM_KEYDOWN/WM_KEYUP/etc... lParam data.</param>
  5730. <param name="modifiers">What other modifier keys are currently down: Shift/Control/Alt/OS X Command/etc...</param>
  5731. <param name="isSystemKey">
  5732. Indicates whether the event is considered a "system key" event (see
  5733. http://msdn.microsoft.com/en-us/library/ms646286(VS.85).aspx for details).
  5734. </param>
  5735. <returns>Return true if the keyboard event was handled or false otherwise.</returns>
  5736. </member>
  5737. <member name="T:CefSharp.ILifeSpanHandler">
  5738. <summary>
  5739. Implement this interface to handle events related to browser life span.
  5740. The methods of this class will be called on the CEF UI thread unless otherwise indicated.
  5741. </summary>
  5742. </member>
  5743. <member name="M:CefSharp.ILifeSpanHandler.OnBeforePopup(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,System.String,System.String,CefSharp.WindowOpenDisposition,System.Boolean,CefSharp.IPopupFeatures,CefSharp.IWindowInfo,CefSharp.IBrowserSettings,System.Boolean@,CefSharp.IWebBrowser@)">
  5744. <summary>
  5745. Called before a popup window is created.
  5746. </summary>
  5747. <param name="browserControl">The <see cref="T:CefSharp.IWebBrowser"/> control this request is for.</param>
  5748. <param name="browser">The browser instance that launched this popup.</param>
  5749. <param name="frame">The HTML frame that launched this popup.</param>
  5750. <param name="targetUrl">The URL of the popup content. (This may be empty/null)</param>
  5751. <param name="targetFrameName">The name of the popup. (This may be empty/null)</param>
  5752. <param name="targetDisposition">The value indicates where the user intended to
  5753. open the popup (e.g. current tab, new tab, etc)</param>
  5754. <param name="userGesture">The value will be true if the popup was opened via explicit user gesture
  5755. (e.g. clicking a link) or false if the popup opened automatically (e.g. via the DomContentLoaded event).</param>
  5756. <param name="popupFeatures"> structure contains additional information about the requested popup window</param>
  5757. <param name="windowInfo">window information</param>
  5758. <param name="browserSettings">browser settings, defaults to source browsers</param>
  5759. <param name="noJavascriptAccess">value indicates whether the new browser window should be scriptable
  5760. and in the same process as the source browser.</param>
  5761. <param name="newBrowser">EXPERIMENTAL - A newly created browser that will host the popup</param>
  5762. <returns>To cancel creation of the popup window return true otherwise return false.</returns>
  5763. <remarks>
  5764. CEF documentation:
  5765. Called on the IO thread before a new popup window is created. The |browser|
  5766. and |frame| parameters represent the source of the popup request. The
  5767. |target_url| and |target_frame_name| values may be empty if none were
  5768. specified with the request. The |popupFeatures| structure contains
  5769. information about the requested popup window. To allow creation of the
  5770. popup window optionally modify |windowInfo|, |client|, |settings| and
  5771. |no_javascript_access| and return false. To cancel creation of the popup
  5772. window return true. The |client| and |settings| values will default to the
  5773. source browser's values. The |no_javascript_access| value indicates whether
  5774. the new browser window should be scriptable and in the same process as the
  5775. source browser.
  5776. </remarks>
  5777. </member>
  5778. <member name="M:CefSharp.ILifeSpanHandler.OnAfterCreated(CefSharp.IWebBrowser,CefSharp.IBrowser)">
  5779. <summary>
  5780. Called after a new browser is created.
  5781. </summary>
  5782. <param name="browserControl">The <see cref="T:CefSharp.IWebBrowser"/> control that is realted to the window is closing.</param>
  5783. <param name="browser">The browser instance</param>
  5784. </member>
  5785. <member name="M:CefSharp.ILifeSpanHandler.DoClose(CefSharp.IWebBrowser,CefSharp.IBrowser)">
  5786. <summary>
  5787. Called when a browser has recieved a request to close. This may result
  5788. directly from a call to CefBrowserHost::CloseBrowser() or indirectly if the
  5789. browser is a top-level OS window created by CEF and the user attempts to
  5790. close the window. This method will be called after the JavaScript
  5791. 'onunload' event has been fired. It will not be called for browsers after
  5792. the associated OS window has been destroyed (for those browsers it is no
  5793. longer possible to cancel the close).
  5794. If CEF created an OS window for the browser returning false will send an OS
  5795. close notification to the browser window's top-level owner (e.g. WM_CLOSE
  5796. on Windows, performClose: on OS-X and "delete_event" on Linux). If no OS
  5797. window exists (window rendering disabled) returning false will cause the
  5798. browser object to be destroyed immediately. Return true if the browser is
  5799. parented to another window and that other window needs to receive close
  5800. notification via some non-standard technique.
  5801. If an application provides its own top-level window it should handle OS
  5802. close notifications by calling CefBrowserHost::CloseBrowser(false) instead
  5803. of immediately closing (see the example below). This gives CEF an
  5804. opportunity to process the 'onbeforeunload' event and optionally cancel the
  5805. close before DoClose() is called.
  5806. The CefLifeSpanHandler::OnBeforeClose() method will be called immediately
  5807. before the browser object is destroyed. The application should only exit
  5808. after OnBeforeClose() has been called for all existing browsers.
  5809. If the browser represents a modal window and a custom modal loop
  5810. implementation was provided in CefLifeSpanHandler::RunModal() this callback
  5811. should be used to restore the opener window to a usable state.
  5812. By way of example consider what should happen during window close when the
  5813. browser is parented to an application-provided top-level OS window.
  5814. 1. User clicks the window close button which sends an OS close
  5815. notification (e.g. WM_CLOSE on Windows, performClose: on OS-X and
  5816. "delete_event" on Linux).
  5817. 2. Application's top-level window receives the close notification and:
  5818. A. Calls CefBrowserHost::CloseBrowser(false).
  5819. B. Cancels the window close.
  5820. 3. JavaScript 'onbeforeunload' handler executes and shows the close
  5821. confirmation dialog (which can be overridden via
  5822. CefJSDialogHandler::OnBeforeUnloadDialog()).
  5823. 4. User approves the close.
  5824. 5. JavaScript 'onunload' handler executes.
  5825. 6. Application's DoClose() handler is called. Application will:
  5826. A. Set a flag to indicate that the next close attempt will be allowed.
  5827. B. Return false.
  5828. 7. CEF sends an OS close notification.
  5829. 8. Application's top-level window receives the OS close notification and
  5830. allows the window to close based on the flag from #6B.
  5831. 9. Browser OS window is destroyed.
  5832. 10. Application's CefLifeSpanHandler::OnBeforeClose() handler is called and
  5833. the browser object is destroyed.
  5834. 11. Application exits by calling CefQuitMessageLoop() if no other browsers
  5835. exist.
  5836. </summary>
  5837. <param name="browserControl">The <see cref="T:CefSharp.IWebBrowser"/> control that is realted to the window is closing.</param>
  5838. <param name="browser">The browser instance</param>
  5839. <returns>For default behaviour return false</returns>
  5840. </member>
  5841. <member name="M:CefSharp.ILifeSpanHandler.OnBeforeClose(CefSharp.IWebBrowser,CefSharp.IBrowser)">
  5842. <summary>
  5843. Called before a CefBrowser window (either the main browser for <see cref="T:CefSharp.IWebBrowser"/>,
  5844. or one of its children)
  5845. </summary>
  5846. <param name="browserControl">The <see cref="T:CefSharp.IWebBrowser"/> control that is realted to the window is closing.</param>
  5847. <param name="browser">The browser instance</param>
  5848. </member>
  5849. <member name="T:CefSharp.IContextMenuHandler">
  5850. <summary>
  5851. Implement this interface to handle context menu events.
  5852. </summary>
  5853. </member>
  5854. <member name="M:CefSharp.IContextMenuHandler.OnBeforeContextMenu(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IContextMenuParams,CefSharp.IMenuModel)">
  5855. <summary>
  5856. Called before a context menu is displayed. The model can be cleared to show no context menu or
  5857. modified to show a custom menu.
  5858. </summary>
  5859. <param name="browserControl">the ChromiumWebBrowser control</param>
  5860. <param name="browser">the browser object</param>
  5861. <param name="frame">The frame the request is coming from</param>
  5862. <param name="parameters">provides information about the context menu state</param>
  5863. <param name="model">initially contains the default context menu</param>
  5864. </member>
  5865. <member name="M:CefSharp.IContextMenuHandler.OnContextMenuCommand(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IContextMenuParams,CefSharp.CefMenuCommand,CefSharp.CefEventFlags)">
  5866. <summary>
  5867. Called to execute a command selected from the context menu. See
  5868. cef_menu_id_t for the command ids that have default implementations. All
  5869. user-defined command ids should be between MENU_ID_USER_FIRST and
  5870. MENU_ID_USER_LAST.
  5871. </summary>
  5872. <param name="browserControl">the ChromiumWebBrowser control</param>
  5873. <param name="browser">the browser object</param>
  5874. <param name="frame">The frame the request is coming from</param>
  5875. <param name="parameters">will have the same values as what was passed to</param>
  5876. <param name="commandId">menu command id</param>
  5877. <param name="eventFlags">event flags</param>
  5878. <returns>Return true if the command was handled or false for the default implementation.</returns>
  5879. </member>
  5880. <member name="M:CefSharp.IContextMenuHandler.OnContextMenuDismissed(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame)">
  5881. <summary>
  5882. Called when the context menu is dismissed irregardless of whether the menu
  5883. was empty or a command was selected.
  5884. </summary>
  5885. <param name="browserControl">the ChromiumWebBrowser control</param>
  5886. <param name="browser">the browser object</param>
  5887. <param name="frame">The frame the request is coming from</param>
  5888. </member>
  5889. <member name="M:CefSharp.IContextMenuHandler.RunContextMenu(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IContextMenuParams,CefSharp.IMenuModel,CefSharp.IRunContextMenuCallback)">
  5890. <summary>
  5891. Called to allow custom display of the context menu.
  5892. For custom display return true and execute callback either synchronously or asynchronously with the selected command Id.
  5893. For default display return false. Do not keep references to parameters or model outside of this callback.
  5894. </summary>
  5895. <param name="browserControl">the ChromiumWebBrowser control</param>
  5896. <param name="browser">the browser object</param>
  5897. <param name="frame">The frame the request is coming from</param>
  5898. <param name="parameters">provides information about the context menu state</param>
  5899. <param name="model">contains the context menu model resulting from OnBeforeContextMenu</param>
  5900. <param name="callback">the callback to execute for custom display</param>
  5901. <returns>For custom display return true and execute callback either synchronously or asynchronously with the selected command ID.</returns>
  5902. </member>
  5903. <member name="T:CefSharp.Internals.IWebBrowserInternal">
  5904. <summary>
  5905. Interface implemented by UI control that contains
  5906. a ManagedCefBrowserAdapter instance.
  5907. </summary>
  5908. </member>
  5909. <member name="T:CefSharp.IWebBrowser">
  5910. <summary>
  5911. ChromiumWebBrowser implementations implement this interface. Can be cast to
  5912. the concrete implementation to access UI specific features.
  5913. </summary>
  5914. <seealso cref="T:System.IDisposable"/>
  5915. </member>
  5916. <member name="M:CefSharp.IWebBrowser.Load(System.String)">
  5917. <summary>
  5918. Loads the specified URL.
  5919. </summary>
  5920. <param name="url">The URL to be loaded.</param>
  5921. </member>
  5922. <member name="M:CefSharp.IWebBrowser.RegisterJsObject(System.String,System.Object,System.Boolean)">
  5923. <summary>
  5924. Registers a Javascript object in this specific browser instance.
  5925. </summary>
  5926. <param name="name">The name of the object. (e.g. "foo", if you want the object to be accessible as window.foo).</param>
  5927. <param name="objectToBind">The object to be made accessible to Javascript.</param>
  5928. <param name="camelCaseJavascriptNames">camel case the javascript names of properties/methods, defaults to true</param>
  5929. </member>
  5930. <member name="M:CefSharp.IWebBrowser.RegisterAsyncJsObject(System.String,System.Object,System.Boolean)">
  5931. <summary>
  5932. <para>Asynchronously registers a Javascript object in this specific browser instance.</para>
  5933. <para>Only methods of the object will be availabe.</para>
  5934. </summary>
  5935. <param name="name">The name of the object. (e.g. "foo", if you want the object to be accessible as window.foo).</param>
  5936. <param name="objectToBind">The object to be made accessible to Javascript.</param>
  5937. <param name="camelCaseJavascriptNames">camel case the javascript names of methods, defaults to true</param>
  5938. <remarks>The registered methods can only be called in an async way, they will all return immeditaly and the resulting
  5939. object will be a standard javascript Promise object which is usable to wait for completion or failure.</remarks>
  5940. </member>
  5941. <member name="M:CefSharp.IWebBrowser.Focus">
  5942. <summary>
  5943. Attempts to give focus to the IWpfWebBrowser control.
  5944. </summary>
  5945. <returns><c>true</c> if keyboard focus and logical focus were set to this element; <c>false</c> if only logical focus
  5946. was set to this element, or if the call to this method did not force the focus to change.</returns>
  5947. </member>
  5948. <member name="M:CefSharp.IWebBrowser.GetBrowser">
  5949. <summary>
  5950. Returns the current CEF Browser Instance
  5951. </summary>
  5952. <returns>browser instance or null</returns>
  5953. </member>
  5954. <member name="E:CefSharp.IWebBrowser.ConsoleMessage">
  5955. <summary>
  5956. Event handler for receiving Javascript console messages being sent from web pages.
  5957. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
  5958. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  5959. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  5960. (The exception to this is when your running with settings.MultiThreadedMessageLoop = false, then they'll be the same thread).
  5961. </summary>
  5962. </member>
  5963. <member name="E:CefSharp.IWebBrowser.StatusMessage">
  5964. <summary>
  5965. Event handler for changes to the status message.
  5966. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
  5967. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang.
  5968. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  5969. (The exception to this is when your running with settings.MultiThreadedMessageLoop = false, then they'll be the same thread).
  5970. </summary>
  5971. </member>
  5972. <member name="E:CefSharp.IWebBrowser.FrameLoadStart">
  5973. <summary>
  5974. Event handler that will get called when the browser begins loading a frame. Multiple frames may be loading at the same
  5975. time. Sub-frames may start or continue loading after the main frame load has ended. This method may not be called for a
  5976. particular frame if the load request for that frame fails. For notification of overall browser load status use
  5977. OnLoadingStateChange instead.
  5978. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
  5979. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  5980. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  5981. </summary>
  5982. <remarks>Whilst this may seem like a logical place to execute js, it's called before the DOM has been loaded, implement
  5983. <see cref="M:CefSharp.IRenderProcessMessageHandler.OnContextCreated(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame)"/> as it's called when the underlying V8Context is created
  5984. (Only called for the main frame at this stage)</remarks>
  5985. </member>
  5986. <member name="E:CefSharp.IWebBrowser.FrameLoadEnd">
  5987. <summary>
  5988. Event handler that will get called when the browser is done loading a frame. Multiple frames may be loading at the same
  5989. time. Sub-frames may start or continue loading after the main frame load has ended. This method will always be called
  5990. for all frames irrespective of whether the request completes successfully.
  5991. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
  5992. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  5993. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  5994. </summary>
  5995. </member>
  5996. <member name="E:CefSharp.IWebBrowser.LoadError">
  5997. <summary>
  5998. Event handler that will get called when the resource load for a navigation fails or is canceled.
  5999. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
  6000. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  6001. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  6002. </summary>
  6003. </member>
  6004. <member name="E:CefSharp.IWebBrowser.LoadingStateChanged">
  6005. <summary>
  6006. Event handler that will get called when the Loading state has changed.
  6007. This event will be fired twice. Once when loading is initiated either programmatically or
  6008. by user action, and once when loading is terminated due to completion, cancellation of failure.
  6009. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
  6010. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  6011. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  6012. </summary>
  6013. </member>
  6014. <member name="P:CefSharp.IWebBrowser.DialogHandler">
  6015. <summary>
  6016. Implement <see cref="T:CefSharp.IDialogHandler"/> and assign to handle dialog events.
  6017. </summary>
  6018. <value>The dialog handler.</value>
  6019. </member>
  6020. <member name="P:CefSharp.IWebBrowser.RequestHandler">
  6021. <summary>
  6022. Implement <see cref="T:CefSharp.IRequestHandler"/> and assign to handle events related to browser requests.
  6023. </summary>
  6024. <value>The request handler.</value>
  6025. </member>
  6026. <member name="P:CefSharp.IWebBrowser.DisplayHandler">
  6027. <summary>
  6028. Implement <see cref="T:CefSharp.IDisplayHandler"/> and assign to handle events related to browser display state.
  6029. </summary>
  6030. <value>The display handler.</value>
  6031. </member>
  6032. <member name="P:CefSharp.IWebBrowser.LoadHandler">
  6033. <summary>
  6034. Implement <see cref="T:CefSharp.ILoadHandler"/> and assign to handle events related to browser load status.
  6035. </summary>
  6036. <value>The load handler.</value>
  6037. </member>
  6038. <member name="P:CefSharp.IWebBrowser.LifeSpanHandler">
  6039. <summary>
  6040. Implement <see cref="T:CefSharp.ILifeSpanHandler"/> and assign to handle events related to popups.
  6041. </summary>
  6042. <value>The life span handler.</value>
  6043. </member>
  6044. <member name="P:CefSharp.IWebBrowser.KeyboardHandler">
  6045. <summary>
  6046. Implement <see cref="T:CefSharp.IKeyboardHandler"/> and assign to handle events related to key press.
  6047. </summary>
  6048. <value>The keyboard handler.</value>
  6049. </member>
  6050. <member name="P:CefSharp.IWebBrowser.JsDialogHandler">
  6051. <summary>
  6052. Implement <see cref="T:CefSharp.IJsDialogHandler"/> and assign to handle events related to JavaScript Dialogs.
  6053. </summary>
  6054. <value>The js dialog handler.</value>
  6055. </member>
  6056. <member name="P:CefSharp.IWebBrowser.DragHandler">
  6057. <summary>
  6058. Implement <see cref="T:CefSharp.IDragHandler"/> and assign to handle events related to dragging.
  6059. </summary>
  6060. <value>The drag handler.</value>
  6061. </member>
  6062. <member name="P:CefSharp.IWebBrowser.DownloadHandler">
  6063. <summary>
  6064. Implement <see cref="T:CefSharp.IDownloadHandler"/> and assign to handle events related to downloading files.
  6065. </summary>
  6066. <value>The download handler.</value>
  6067. </member>
  6068. <member name="P:CefSharp.IWebBrowser.MenuHandler">
  6069. <summary>
  6070. Implement <see cref="T:CefSharp.IContextMenuHandler"/> and assign to handle events related to the browser context menu
  6071. </summary>
  6072. <value>The menu handler.</value>
  6073. </member>
  6074. <member name="P:CefSharp.IWebBrowser.FocusHandler">
  6075. <summary>
  6076. Implement <see cref="T:CefSharp.IFocusHandler"/> and assign to handle events related to the browser component's focus
  6077. </summary>
  6078. <value>The focus handler.</value>
  6079. </member>
  6080. <member name="P:CefSharp.IWebBrowser.ResourceHandlerFactory">
  6081. <summary>
  6082. Implement <see cref="T:CefSharp.IResourceHandlerFactory"/> and control the loading of resources
  6083. </summary>
  6084. <value>The resource handler factory.</value>
  6085. </member>
  6086. <member name="P:CefSharp.IWebBrowser.GeolocationHandler">
  6087. <summary>
  6088. Implement <see cref="T:CefSharp.IGeolocationHandler"/> and assign to handle requests for permission to use geolocation.
  6089. </summary>
  6090. <value>The geolocation handler.</value>
  6091. </member>
  6092. <member name="P:CefSharp.IWebBrowser.RenderProcessMessageHandler">
  6093. <summary>
  6094. Implement <see cref="T:CefSharp.IRenderProcessMessageHandler"/> and assign to handle messages from the render process.
  6095. </summary>
  6096. <value>The render process message handler.</value>
  6097. </member>
  6098. <member name="P:CefSharp.IWebBrowser.FindHandler">
  6099. <summary>
  6100. Implement <see cref="T:CefSharp.IFindHandler"/> to handle events related to find results.
  6101. </summary>
  6102. <value>The find handler.</value>
  6103. </member>
  6104. <member name="P:CefSharp.IWebBrowser.IsBrowserInitialized">
  6105. <summary>
  6106. A flag that indicates whether the WebBrowser is initialized (true) or not (false).
  6107. </summary>
  6108. <value><c>true</c> if this instance is browser initialized; otherwise, <c>false</c>.</value>
  6109. <remarks>In the WPF control, this property is implemented as a Dependency Property and fully supports data
  6110. binding.</remarks>
  6111. </member>
  6112. <member name="P:CefSharp.IWebBrowser.IsLoading">
  6113. <summary>
  6114. A flag that indicates whether the control is currently loading one or more web pages (true) or not (false).
  6115. </summary>
  6116. <value><c>true</c> if this instance is loading; otherwise, <c>false</c>.</value>
  6117. <remarks>In the WPF control, this property is implemented as a Dependency Property and fully supports data
  6118. binding.</remarks>
  6119. </member>
  6120. <member name="P:CefSharp.IWebBrowser.CanGoBack">
  6121. <summary>
  6122. A flag that indicates whether the state of the control current supports the GoBack action (true) or not (false).
  6123. </summary>
  6124. <value><c>true</c> if this instance can go back; otherwise, <c>false</c>.</value>
  6125. <remarks>In the WPF control, this property is implemented as a Dependency Property and fully supports data
  6126. binding.</remarks>
  6127. </member>
  6128. <member name="P:CefSharp.IWebBrowser.CanGoForward">
  6129. <summary>
  6130. A flag that indicates whether the state of the control currently supports the GoForward action (true) or not (false).
  6131. </summary>
  6132. <value><c>true</c> if this instance can go forward; otherwise, <c>false</c>.</value>
  6133. <remarks>In the WPF control, this property is implemented as a Dependency Property and fully supports data
  6134. binding.</remarks>
  6135. </member>
  6136. <member name="P:CefSharp.IWebBrowser.Address">
  6137. <summary>
  6138. The address (URL) which the browser control is currently displaying.
  6139. Will automatically be updated as the user navigates to another page (e.g. by clicking on a link).
  6140. </summary>
  6141. <value>The address.</value>
  6142. <remarks>In the WPF control, this property is implemented as a Dependency Property and fully supports data
  6143. binding.</remarks>
  6144. </member>
  6145. <member name="P:CefSharp.IWebBrowser.TooltipText">
  6146. <summary>
  6147. The text that will be displayed as a ToolTip
  6148. </summary>
  6149. <value>The tooltip text.</value>
  6150. </member>
  6151. <member name="T:CefSharp.UrlRequestStatus">
  6152. <summary>
  6153. Flags that represent CefURLRequest status.
  6154. </summary>
  6155. </member>
  6156. <member name="F:CefSharp.UrlRequestStatus.Unknown">
  6157. <summary>
  6158. Unknown status.
  6159. </summary>
  6160. </member>
  6161. <member name="F:CefSharp.UrlRequestStatus.Success">
  6162. <summary>
  6163. Request succeeded.
  6164. </summary>
  6165. </member>
  6166. <member name="F:CefSharp.UrlRequestStatus.IoPending">
  6167. <summary>
  6168. An IO request is pending, and the caller will be informed when it is completed.
  6169. </summary>
  6170. </member>
  6171. <member name="F:CefSharp.UrlRequestStatus.Canceled">
  6172. <summary>
  6173. Request was canceled programatically.
  6174. </summary>
  6175. </member>
  6176. <member name="F:CefSharp.UrlRequestStatus.Failed">
  6177. <summary>
  6178. Request failed for some reason.
  6179. </summary>
  6180. </member>
  6181. <member name="M:CefSharp.WebBrowserExtensions.GetMainFrame(CefSharp.IWebBrowser)">
  6182. <summary>
  6183. Returns the main (top-level) frame for the browser window.
  6184. </summary>
  6185. <returns>Frame</returns>
  6186. </member>
  6187. <member name="M:CefSharp.WebBrowserExtensions.GetFocusedFrame(CefSharp.IWebBrowser)">
  6188. <summary>
  6189. Returns the focused frame for the browser window.
  6190. </summary>
  6191. <returns>Frame</returns>
  6192. </member>
  6193. <member name="M:CefSharp.WebBrowserExtensions.Undo(CefSharp.IWebBrowser)">
  6194. <summary>
  6195. Execute Undo on the focused frame
  6196. </summary>
  6197. <param name="browser">The ChromiumWebBrowser instance this method extends</param>
  6198. </member>
  6199. <member name="M:CefSharp.WebBrowserExtensions.Redo(CefSharp.IWebBrowser)">
  6200. <summary>
  6201. Execute Redo on the focused frame
  6202. </summary>
  6203. <param name="browser">The ChromiumWebBrowser instance this method extends</param>
  6204. </member>
  6205. <member name="M:CefSharp.WebBrowserExtensions.Cut(CefSharp.IWebBrowser)">
  6206. <summary>
  6207. Execute Cut on the focused frame
  6208. </summary>
  6209. <param name="browser">The ChromiumWebBrowser instance this method extends</param>
  6210. </member>
  6211. <member name="M:CefSharp.WebBrowserExtensions.Copy(CefSharp.IWebBrowser)">
  6212. <summary>
  6213. Execute Copy on the focused frame
  6214. </summary>
  6215. <param name="browser">The ChromiumWebBrowser instance this method extends</param>
  6216. </member>
  6217. <member name="M:CefSharp.WebBrowserExtensions.Paste(CefSharp.IWebBrowser)">
  6218. <summary>
  6219. Execute Paste on the focused frame
  6220. </summary>
  6221. <param name="browser">The ChromiumWebBrowser instance this method extends</param>
  6222. </member>
  6223. <member name="M:CefSharp.WebBrowserExtensions.Delete(CefSharp.IWebBrowser)">
  6224. <summary>
  6225. Execute Delete on the focused frame
  6226. </summary>
  6227. <param name="browser">The ChromiumWebBrowser instance this method extends</param>
  6228. </member>
  6229. <member name="M:CefSharp.WebBrowserExtensions.SelectAll(CefSharp.IWebBrowser)">
  6230. <summary>
  6231. Execute SelectAll on the focused frame
  6232. </summary>
  6233. <param name="browser">The ChromiumWebBrowser instance this method extends</param>
  6234. </member>
  6235. <member name="M:CefSharp.WebBrowserExtensions.ViewSource(CefSharp.IWebBrowser)">
  6236. <summary>
  6237. Opens up a new program window (using the default text editor) where the source code of the currently displayed web
  6238. page is shown.
  6239. </summary>
  6240. <param name="browser">The ChromiumWebBrowser instance this method extends</param>
  6241. </member>
  6242. <member name="M:CefSharp.WebBrowserExtensions.GetSourceAsync(CefSharp.IWebBrowser)">
  6243. <summary>
  6244. Retrieve the main frame's HTML source using a <see cref="T:System.Threading.Tasks.Task`1"/>.
  6245. </summary>
  6246. <param name="browser">The ChromiumWebBrowser instance this method extends</param>
  6247. <returns><see cref="T:System.Threading.Tasks.Task`1"/> that when executed returns the frame source as a string</returns>
  6248. </member>
  6249. <member name="M:CefSharp.WebBrowserExtensions.GetTextAsync(CefSharp.IWebBrowser)">
  6250. <summary>
  6251. Retrieve the main frame's display text using a <see cref="T:System.Threading.Tasks.Task`1"/>.
  6252. </summary>
  6253. <param name="browser">The ChromiumWebBrowser instance this method extends</param>
  6254. <returns><see cref="T:System.Threading.Tasks.Task`1"/> that when executed returns the frame display text as a string.</returns>
  6255. </member>
  6256. <member name="M:CefSharp.WebBrowserExtensions.ExecuteScriptAsync(CefSharp.IWebBrowser,System.String,System.Object[])">
  6257. <summary>
  6258. Execute some Javascript code in the context of this WebBrowser. As the method name implies, the script will be
  6259. executed asynchronously, and the method therefore returns before the script has actually been executed.
  6260. This simple helper extension will encapsulate params in single quotes (unless int, uint, etc)
  6261. </summary>
  6262. <param name="browser">The ChromiumWebBrowser instance this method extends</param>
  6263. <param name="methodName">The javascript method name to execute</param>
  6264. <param name="args">the arguments to be passed as params to the method</param>
  6265. </member>
  6266. <member name="M:CefSharp.WebBrowserExtensions.ExecuteScriptAsync(CefSharp.IWebBrowser,System.String)">
  6267. <summary>
  6268. Execute some Javascript code in the context of this WebBrowser. As the method name implies, the script will be
  6269. executed asynchronously, and the method therefore returns before the script has actually been executed.
  6270. </summary>
  6271. <param name="browser">The ChromiumWebBrowser instance this method extends</param>
  6272. <param name="script">The Javascript code that should be executed.</param>
  6273. </member>
  6274. <member name="M:CefSharp.WebBrowserExtensions.LoadString(CefSharp.IWebBrowser,System.String,System.String)">
  6275. <summary>
  6276. Load the string contents with the specified dummy url. Web security restrictions may not behave as expected.
  6277. </summary>
  6278. <param name="browser">The ChromiumWebBrowser instance this method extends</param>
  6279. <param name="html">html string to load</param>
  6280. <param name="url">the url should have a standard scheme (for example, http scheme) or behaviors like link clicks</param>
  6281. </member>
  6282. <member name="M:CefSharp.WebBrowserExtensions.LoadHtml(CefSharp.IWebBrowser,System.String,System.String)">
  6283. <summary>
  6284. Registers and loads a <see cref="T:CefSharp.ResourceHandler"/> that represents the HTML content.
  6285. </summary>
  6286. <remarks>
  6287. `Cef` Native `LoadHtml` is unpredictable and only works sometimes, this method wraps
  6288. the provided HTML in a <see cref="T:CefSharp.ResourceHandler"/> and loads the provided url using
  6289. the <see cref="M:CefSharp.IWebBrowser.Load(System.String)"/> method.
  6290. Defaults to using <see cref="P:System.Text.Encoding.UTF8"/> for character encoding
  6291. The url must start with a valid schema, other uri's such as about:blank are invalid
  6292. A valid example looks like http://test/page
  6293. </remarks>
  6294. <param name="browser">The ChromiumWebBrowser instance this method extends</param>
  6295. <param name="html">The HTML content.</param>
  6296. <param name="url">The URL that will be treated as the address of the content.</param>
  6297. </member>
  6298. <member name="M:CefSharp.WebBrowserExtensions.LoadHtml(CefSharp.IWebBrowser,System.String,System.String,System.Text.Encoding)">
  6299. <summary>
  6300. Registers and loads a <see cref="T:CefSharp.ResourceHandler"/> that represents the HTML content.
  6301. </summary>
  6302. <remarks>
  6303. `Cef` Native `LoadHtml` is unpredictable and only works sometimes, this method wraps
  6304. the provided HTML in a <see cref="T:CefSharp.ResourceHandler"/> and loads the provided url using
  6305. the <see cref="M:CefSharp.IWebBrowser.Load(System.String)"/> method.
  6306. </remarks>
  6307. <param name="browser">The ChromiumWebBrowser instance this method extends</param>
  6308. <param name="html">The HTML content.</param>
  6309. <param name="url">The URL that will be treated as the address of the content.</param>
  6310. <param name="encoding">Character Encoding</param>
  6311. </member>
  6312. <member name="M:CefSharp.WebBrowserExtensions.Stop(CefSharp.IWebBrowser)">
  6313. <summary>
  6314. Stops loading the current page.
  6315. </summary>
  6316. </member>
  6317. <member name="M:CefSharp.WebBrowserExtensions.Back(CefSharp.IWebBrowser)">
  6318. <summary>
  6319. Navigates back, must check <see cref="P:CefSharp.IWebBrowser.CanGoBack"/> before calling this method.
  6320. </summary>
  6321. </member>
  6322. <member name="M:CefSharp.WebBrowserExtensions.Forward(CefSharp.IWebBrowser)">
  6323. <summary>
  6324. Navigates forward, must check <see cref="P:CefSharp.IWebBrowser.CanGoForward"/> before calling this method.
  6325. </summary>
  6326. </member>
  6327. <member name="M:CefSharp.WebBrowserExtensions.Reload(CefSharp.IWebBrowser)">
  6328. <summary>
  6329. Reloads the page being displayed. This method will use data from the browser's cache, if available.
  6330. </summary>
  6331. </member>
  6332. <member name="M:CefSharp.WebBrowserExtensions.Reload(CefSharp.IWebBrowser,System.Boolean)">
  6333. <summary>
  6334. Reloads the page being displayed, optionally ignoring the cache (which means the whole page including all .css, .js
  6335. etc. resources will be re-fetched).
  6336. </summary>
  6337. <param name="browser">The ChromiumWebBrowser instance this method extends</param>
  6338. <param name="ignoreCache"><c>true</c> A reload is performed ignoring browser cache; <c>false</c> A reload is
  6339. performed using files from the browser cache, if available.</param>
  6340. </member>
  6341. <member name="M:CefSharp.WebBrowserExtensions.GetZoomLevelAsync(CefSharp.IBrowser)">
  6342. <summary>
  6343. Asynchronously gets the current Zoom Level.
  6344. </summary>
  6345. </member>
  6346. <member name="M:CefSharp.WebBrowserExtensions.GetZoomLevelAsync(CefSharp.IWebBrowser)">
  6347. <summary>
  6348. Asynchronously gets the current Zoom Level.
  6349. </summary>
  6350. </member>
  6351. <member name="M:CefSharp.WebBrowserExtensions.SetZoomLevel(CefSharp.IBrowser,System.Double)">
  6352. <summary>
  6353. Change the ZoomLevel to the specified value. Can be set to 0.0 to clear the zoom level.
  6354. </summary>
  6355. <remarks>
  6356. If called on the CEF UI thread the change will be applied immediately.
  6357. Otherwise, the change will be applied asynchronously on the CEF UI thread.
  6358. The CEF UI thread is different to the WPF/WinForms UI Thread
  6359. </remarks>
  6360. <param name="cefBrowser">The ChromiumWebBrowser instance this method extends</param>
  6361. <param name="zoomLevel">zoom level</param>
  6362. </member>
  6363. <member name="M:CefSharp.WebBrowserExtensions.SetZoomLevel(CefSharp.IWebBrowser,System.Double)">
  6364. <summary>
  6365. Change the ZoomLevel to the specified value. Can be set to 0.0 to clear the zoom level.
  6366. </summary>
  6367. <remarks>
  6368. If called on the CEF UI thread the change will be applied immediately.
  6369. Otherwise, the change will be applied asynchronously on the CEF UI thread.
  6370. The CEF UI thread is different to the WPF/WinForms UI Thread
  6371. </remarks>
  6372. <param name="browser">The ChromiumWebBrowser instance this method extends</param>
  6373. <param name="zoomLevel">zoom level</param>
  6374. </member>
  6375. <member name="M:CefSharp.WebBrowserExtensions.Find(CefSharp.IBrowser,System.Int32,System.String,System.Boolean,System.Boolean,System.Boolean)">
  6376. <summary>
  6377. Search for text within the current page.
  6378. </summary>
  6379. <param name="cefBrowser">The ChromiumWebBrowser instance this method extends</param>
  6380. <param name="identifier">Can be used in can conjunction with searchText to have multiple
  6381. searches running simultaneously.</param>
  6382. <param name="searchText">search text</param>
  6383. <param name="forward">indicates whether to search forward or backward within the page.</param>
  6384. <param name="matchCase">indicates whether the search should be case-sensitive. </param>
  6385. <param name="findNext">indicates whether this is the first request or a follow-up.</param>
  6386. </member>
  6387. <member name="M:CefSharp.WebBrowserExtensions.Find(CefSharp.IWebBrowser,System.Int32,System.String,System.Boolean,System.Boolean,System.Boolean)">
  6388. <summary>
  6389. Search for text within the current page.
  6390. </summary>
  6391. <param name="browser">The ChromiumWebBrowser instance this method extends</param>
  6392. <param name="identifier">Can be used in can conjunction with searchText to have multiple
  6393. searches running simultaneously.</param>
  6394. <param name="searchText">search text</param>
  6395. <param name="forward">indicates whether to search forward or backward within the page.</param>
  6396. <param name="matchCase">indicates whether the search should be case-sensitive. </param>
  6397. <param name="findNext">indicates whether this is the first request or a follow-up.</param>
  6398. </member>
  6399. <member name="M:CefSharp.WebBrowserExtensions.StopFinding(CefSharp.IBrowser,System.Boolean)">
  6400. <summary>
  6401. Cancel all searches that are currently going on.
  6402. </summary>
  6403. <param name="cefBrowser">The ChromiumWebBrowser instance this method extends</param>
  6404. <param name="clearSelection">clear the current search selection</param>
  6405. </member>
  6406. <member name="M:CefSharp.WebBrowserExtensions.StopFinding(CefSharp.IWebBrowser,System.Boolean)">
  6407. <summary>
  6408. Cancel all searches that are currently going on.
  6409. </summary>
  6410. <param name="browser">The ChromiumWebBrowser instance this method extends</param>
  6411. <param name="clearSelection">clear the current search selection</param>
  6412. </member>
  6413. <member name="M:CefSharp.WebBrowserExtensions.Print(CefSharp.IBrowser)">
  6414. <summary>
  6415. Opens a Print Dialog which if used (can be user cancelled) will print the browser contents.
  6416. </summary>
  6417. <param name="cefBrowser">The ChromiumWebBrowser instance this method extends</param>
  6418. </member>
  6419. <member name="M:CefSharp.WebBrowserExtensions.PrintToPdfAsync(CefSharp.IBrowser,System.String,CefSharp.PdfPrintSettings)">
  6420. <summary>
  6421. Asynchronously prints the current browser contents to the PDF file specified.
  6422. The caller is responsible for deleting the file when done.
  6423. </summary>
  6424. <param name="cefBrowser">The <see cref="T:CefSharp.IBrowser"/> object this method extends.</param>
  6425. <param name="path">Output file location.</param>
  6426. <param name="settings">Print Settings.</param>
  6427. <returns>A task that represents the asynchronous print operation.
  6428. The result is true on success or false on failure to generate the Pdf.</returns>
  6429. </member>
  6430. <member name="M:CefSharp.WebBrowserExtensions.Print(CefSharp.IWebBrowser)">
  6431. <summary>
  6432. Opens a Print Dialog which if used (can be user cancelled) will print the browser contents.
  6433. </summary>
  6434. <param name="browser">The ChromiumWebBrowser instance this method extends</param>
  6435. </member>
  6436. <member name="M:CefSharp.WebBrowserExtensions.PrintToPdfAsync(CefSharp.IWebBrowser,System.String,CefSharp.PdfPrintSettings)">
  6437. <summary>
  6438. Asynchronously prints the current browser contents to the PDF file specified.
  6439. The caller is responsible for deleting the file when done.
  6440. </summary>
  6441. <param name="browser">The ChromiumWebBrowser instance this method extends</param>
  6442. <param name="path">Output file location.</param>
  6443. <param name="settings">Print Settings.</param>
  6444. <returns>A task that represents the asynchronous print operation.
  6445. The result is true on success or false on failure to generate the Pdf.</returns>
  6446. </member>
  6447. <member name="M:CefSharp.WebBrowserExtensions.ShowDevTools(CefSharp.IBrowser)">
  6448. <summary>
  6449. Open developer tools in its own window.
  6450. </summary>
  6451. <param name="cefBrowser">The ChromiumWebBrowser instance this method extends</param>
  6452. </member>
  6453. <member name="M:CefSharp.WebBrowserExtensions.ShowDevTools(CefSharp.IWebBrowser)">
  6454. <summary>
  6455. Open developer tools in its own window.
  6456. </summary>
  6457. <param name="browser">The ChromiumWebBrowser instance this method extends</param>
  6458. </member>
  6459. <member name="M:CefSharp.WebBrowserExtensions.CloseDevTools(CefSharp.IBrowser)">
  6460. <summary>
  6461. Explicitly close the developer tools window if one exists for this browser instance.
  6462. </summary>
  6463. <param name="cefBrowser">The ChromiumWebBrowser instance this method extends</param>
  6464. </member>
  6465. <member name="M:CefSharp.WebBrowserExtensions.CloseDevTools(CefSharp.IWebBrowser)">
  6466. <summary>
  6467. Explicitly close the developer tools window if one exists for this browser instance.
  6468. </summary>
  6469. <param name="browser">The ChromiumWebBrowser instance this method extends</param>
  6470. </member>
  6471. <member name="M:CefSharp.WebBrowserExtensions.ReplaceMisspelling(CefSharp.IBrowser,System.String)">
  6472. <summary>
  6473. If a misspelled word is currently selected in an editable node calling
  6474. this method will replace it with the specified word.
  6475. </summary>
  6476. <param name="cefBrowser">The ChromiumWebBrowser instance this method extends</param>
  6477. <param name="word">The new word that will replace the currently selected word.</param>
  6478. </member>
  6479. <member name="M:CefSharp.WebBrowserExtensions.ReplaceMisspelling(CefSharp.IWebBrowser,System.String)">
  6480. <summary>
  6481. If a misspelled word is currently selected in an editable node calling
  6482. this method will replace it with the specified word.
  6483. </summary>
  6484. <param name="browser">The ChromiumWebBrowser instance this method extends</param>
  6485. <param name="word">The new word that will replace the currently selected word.</param>
  6486. </member>
  6487. <member name="M:CefSharp.WebBrowserExtensions.AddWordToDictionary(CefSharp.IBrowser,System.String)">
  6488. <summary>
  6489. Add the specified word to the spelling dictionary.
  6490. </summary>
  6491. <param name="cefBrowser">The ChromiumWebBrowser instance this method extends</param>
  6492. <param name="word">The new word that will be added to the dictionary.</param>
  6493. </member>
  6494. <member name="M:CefSharp.WebBrowserExtensions.AddWordToDictionary(CefSharp.IWebBrowser,System.String)">
  6495. <summary>
  6496. Add the specified word to the spelling dictionary.
  6497. </summary>
  6498. <param name="browser">The ChromiumWebBrowser instance this method extends</param>
  6499. <param name="word">The new word that will be added to the dictionary.</param>
  6500. </member>
  6501. <member name="M:CefSharp.WebBrowserExtensions.EvaluateScriptAsync(CefSharp.IWebBrowser,System.String,System.Object[])">
  6502. <summary>
  6503. Evaluate some Javascript code in the context of this WebBrowser. The script will be executed asynchronously and the
  6504. method returns a Task encapsulating the response from the Javascript
  6505. This simple helper extension will encapsulate params in single quotes (unless int, uint, etc)
  6506. </summary>
  6507. <param name="browser">The ChromiumWebBrowser instance this method extends</param>
  6508. <param name="methodName">The javascript method name to execute</param>
  6509. <param name="args">the arguments to be passed as params to the method</param>
  6510. <returns><see cref="T:System.Threading.Tasks.Task`1"/> that can be awaited to perform the script execution</returns>
  6511. </member>
  6512. <member name="M:CefSharp.WebBrowserExtensions.EvaluateScriptAsync(CefSharp.IWebBrowser,System.Nullable{System.TimeSpan},System.String,System.Object[])">
  6513. <summary>
  6514. Evaluate some Javascript code in the context of this WebBrowser using the specified timeout. The script will be executed asynchronously and the
  6515. method returns a Task encapsulating the response from the Javascript
  6516. This simple helper extension will encapsulate params in single quotes (unless int, uint, etc)
  6517. </summary>
  6518. <param name="browser">The ChromiumWebBrowser instance this method extends</param>
  6519. <param name="timeout">The timeout after which the Javascript code execution should be aborted.</param>
  6520. <param name="methodName">The javascript method name to execute</param>
  6521. <param name="args">the arguments to be passed as params to the method</param>
  6522. <returns><see cref="T:System.Threading.Tasks.Task`1"/> that can be awaited to perform the script execution</returns>
  6523. </member>
  6524. <member name="M:CefSharp.WebBrowserExtensions.GetScript(System.String,System.Object[])">
  6525. <summary>
  6526. Transforms the methodName and arguments into valid Javascript code. Will encapsulate params in single quotes (unless int, uint, etc)
  6527. </summary>
  6528. <param name="methodName">The javascript method name to execute</param>
  6529. <param name="args">the arguments to be passed as params to the method</param>
  6530. <returns>The Javascript code</returns>
  6531. </member>
  6532. <member name="T:CefSharp.WebPluginInfo">
  6533. <summary>
  6534. Information about a specific web plugin.
  6535. </summary>
  6536. </member>
  6537. <member name="P:CefSharp.WebPluginInfo.Name">
  6538. <summary>
  6539. Gets or sets the plugin name (i.e. Flash).
  6540. </summary>
  6541. </member>
  6542. <member name="P:CefSharp.WebPluginInfo.Description">
  6543. <summary>
  6544. Gets or sets tge description of the plugin from the version information.
  6545. </summary>
  6546. </member>
  6547. <member name="P:CefSharp.WebPluginInfo.Path">
  6548. <summary>
  6549. Gets or sets the plugin file path (DLL/bundle/library).
  6550. </summary>
  6551. </member>
  6552. <member name="P:CefSharp.WebPluginInfo.Version">
  6553. <summary>
  6554. Gets or sets the version of the plugin (may be OS-specific).
  6555. </summary>
  6556. </member>
  6557. <member name="M:CefSharp.IRequest.SetReferrer(System.String,CefSharp.ReferrerPolicy)">
  6558. <summary>
  6559. Set the referrer URL and policy. If non-empty the referrer URL must be
  6560. fully qualified with an HTTP or HTTPS scheme component. Any username,
  6561. password or ref component will be removed.
  6562. </summary>
  6563. <param name="referrerUrl">the referrer url</param>
  6564. <param name="policy">referrer policy</param>
  6565. </member>
  6566. <member name="M:CefSharp.IRequest.InitializePostData">
  6567. <summary>
  6568. Initialize a new instance of <see cref="T:CefSharp.IPostData"/>.
  6569. Make sure to check if the <see cref="P:CefSharp.IRequest.PostData"/> is null
  6570. before calling otherwise the existing data will be overridden.
  6571. </summary>
  6572. </member>
  6573. <member name="P:CefSharp.IRequest.Url">
  6574. <summary>
  6575. Request Url
  6576. </summary>
  6577. </member>
  6578. <member name="P:CefSharp.IRequest.Identifier">
  6579. <summary>
  6580. Returns the globally unique identifier for this request or 0 if not specified.
  6581. Can be used by <see cref="T:CefSharp.IRequestHandler"/> implementations in the browser process to track a
  6582. single request across multiple callbacks.
  6583. </summary>
  6584. </member>
  6585. <member name="P:CefSharp.IRequest.Method">
  6586. <summary>
  6587. Request Method GET/POST etc
  6588. </summary>
  6589. </member>
  6590. <member name="P:CefSharp.IRequest.ReferrerUrl">
  6591. <summary>
  6592. Get the referrer URL.
  6593. </summary>
  6594. </member>
  6595. <member name="P:CefSharp.IRequest.ResourceType">
  6596. <summary>
  6597. Get the resource type for this request.
  6598. </summary>
  6599. </member>
  6600. <member name="P:CefSharp.IRequest.ReferrerPolicy">
  6601. <summary>
  6602. Get the referrer policy.
  6603. </summary>
  6604. </member>
  6605. <member name="P:CefSharp.IRequest.Headers">
  6606. <summary>
  6607. Header Collection
  6608. NOTE: This collection is a copy of the underlying type, to make changes, take a reference to the collection,
  6609. make your changes, then reassign the collection. At some point this will be replaced with a proper wrapper.
  6610. </summary>
  6611. </member>
  6612. <member name="P:CefSharp.IRequest.PostData">
  6613. <summary>
  6614. Post data
  6615. </summary>
  6616. </member>
  6617. <member name="P:CefSharp.IRequest.TransitionType">
  6618. <summary>
  6619. Get the transition type for this request.
  6620. Applies to requests that represent a main frame or sub-frame navigation.
  6621. </summary>
  6622. </member>
  6623. <member name="P:CefSharp.IRequest.IsDisposed">
  6624. <summary>
  6625. Gets a value indicating whether the request has been disposed of.
  6626. </summary>
  6627. </member>
  6628. <member name="P:CefSharp.IRequest.IsReadOnly">
  6629. <summary>
  6630. Returns true if this object is read-only.
  6631. </summary>
  6632. </member>
  6633. <member name="T:CefSharp.IRequestHandler">
  6634. <summary>
  6635. Implement this interface to handle events related to browser requests.
  6636. The methods of this class will be called on the thread indicated.
  6637. </summary>
  6638. </member>
  6639. <member name="M:CefSharp.IRequestHandler.OnBeforeBrowse(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,System.Boolean)">
  6640. <summary>
  6641. Called before browser navigation.
  6642. If the navigation is allowed <see cref="E:CefSharp.IWebBrowser.FrameLoadStart"/> and <see cref="E:CefSharp.IWebBrowser.FrameLoadEnd"/>
  6643. will be called. If the navigation is canceled <see cref="E:CefSharp.IWebBrowser.LoadError"/> will be called with an ErrorCode
  6644. value of <see cref="F:CefSharp.CefErrorCode.Aborted"/>.
  6645. </summary>
  6646. <param name="browserControl">the ChromiumWebBrowser control</param>
  6647. <param name="browser">the browser object</param>
  6648. <param name="frame">The frame the request is coming from</param>
  6649. <param name="request">the request object - cannot be modified in this callback</param>
  6650. <param name="isRedirect">has the request been redirected</param>
  6651. <returns>Return true to cancel the navigation or false to allow the navigation to proceed.</returns>
  6652. </member>
  6653. <member name="M:CefSharp.IRequestHandler.OnOpenUrlFromTab(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,System.String,CefSharp.WindowOpenDisposition,System.Boolean)">
  6654. <summary>
  6655. Called on the UI thread before OnBeforeBrowse in certain limited cases
  6656. where navigating a new or different browser might be desirable. This
  6657. includes user-initiated navigation that might open in a special way (e.g.
  6658. links clicked via middle-click or ctrl + left-click) and certain types of
  6659. cross-origin navigation initiated from the renderer process (e.g.
  6660. navigating the top-level frame to/from a file URL).
  6661. </summary>
  6662. <param name="browserControl">the ChromiumWebBrowser control</param>
  6663. <param name="browser">the browser object</param>
  6664. <param name="frame">The frame object</param>
  6665. <param name="targetUrl">target url</param>
  6666. <param name="targetDisposition">The value indicates where the user intended to navigate the browser based
  6667. on standard Chromium behaviors (e.g. current tab, new tab, etc). </param>
  6668. <param name="userGesture">The value will be true if the browser navigated via explicit user gesture
  6669. (e.g. clicking a link) or false if it navigated automatically (e.g. via the DomContentLoaded event).</param>
  6670. <returns>Return true to cancel the navigation or false to allow the navigation
  6671. to proceed in the source browser's top-level frame.</returns>
  6672. </member>
  6673. <member name="M:CefSharp.IRequestHandler.OnCertificateError(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.CefErrorCode,System.String,CefSharp.ISslInfo,CefSharp.IRequestCallback)">
  6674. <summary>
  6675. Called to handle requests for URLs with an invalid SSL certificate.
  6676. Return true and call <see cref="M:CefSharp.IRequestCallback.Continue(System.Boolean)"/> either
  6677. in this method or at a later time to continue or cancel the request.
  6678. If <see cref="!:CefSettings.IgnoreCertificateErrors"/> is set all invalid certificates
  6679. will be accepted without calling this method.
  6680. </summary>
  6681. <param name="browserControl">the ChromiumWebBrowser control</param>
  6682. <param name="browser">the browser object</param>
  6683. <param name="errorCode">the error code for this invalid certificate</param>
  6684. <param name="requestUrl">the url of the request for the invalid certificate</param>
  6685. <param name="sslInfo">ssl certificate information</param>
  6686. <param name="callback">Callback interface used for asynchronous continuation of url requests.
  6687. If empty the error cannot be recovered from and the request will be canceled automatically.</param>
  6688. <returns>Return false to cancel the request immediately. Return true and use <see cref="T:CefSharp.IRequestCallback"/> to
  6689. execute in an async fashion.</returns>
  6690. </member>
  6691. <member name="M:CefSharp.IRequestHandler.OnPluginCrashed(CefSharp.IWebBrowser,CefSharp.IBrowser,System.String)">
  6692. <summary>
  6693. Called when a plugin has crashed
  6694. </summary>
  6695. <param name="browserControl">the ChromiumWebBrowser control</param>
  6696. <param name="browser">the browser object</param>
  6697. <param name="pluginPath">path of the plugin that crashed</param>
  6698. </member>
  6699. <member name="M:CefSharp.IRequestHandler.OnBeforeResourceLoad(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,CefSharp.IRequestCallback)">
  6700. <summary>
  6701. Called before a resource request is loaded. For async processing return <see cref="F:CefSharp.CefReturnValue.ContinueAsync"/>
  6702. and execute <see cref="M:CefSharp.IRequestCallback.Continue(System.Boolean)"/> or <see cref="M:CefSharp.IRequestCallback.Cancel"/>
  6703. </summary>
  6704. <param name="browserControl">The ChromiumWebBrowser control</param>
  6705. <param name="browser">the browser object</param>
  6706. <param name="frame">The frame object</param>
  6707. <param name="request">the request object - can be modified in this callback.</param>
  6708. <param name="callback">Callback interface used for asynchronous continuation of url requests.</param>
  6709. <returns>To cancel loading of the resource return <see cref="F:CefSharp.CefReturnValue.Cancel"/>
  6710. or <see cref="F:CefSharp.CefReturnValue.Continue"/> to allow the resource to load normally. For async
  6711. return <see cref="F:CefSharp.CefReturnValue.ContinueAsync"/></returns>
  6712. </member>
  6713. <member name="M:CefSharp.IRequestHandler.GetAuthCredentials(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,System.Boolean,System.String,System.Int32,System.String,System.String,CefSharp.IAuthCallback)">
  6714. <summary>
  6715. Called when the browser needs credentials from the user.
  6716. </summary>
  6717. <param name="browserControl">The ChromiumWebBrowser control</param>
  6718. <param name="browser">the browser object</param>
  6719. <param name="frame">The frame object that needs credentials (This will contain the URL that is being requested.)</param>
  6720. <param name="isProxy">indicates whether the host is a proxy server</param>
  6721. <param name="host">hostname</param>
  6722. <param name="port">port number</param>
  6723. <param name="realm">realm</param>
  6724. <param name="scheme">scheme</param>
  6725. <param name="callback">Callback interface used for asynchronous continuation of authentication requests.</param>
  6726. <returns>Return true to continue the request and call CefAuthCallback::Continue() when the authentication information is available. Return false to cancel the request. </returns>
  6727. </member>
  6728. <member name="M:CefSharp.IRequestHandler.OnRenderProcessTerminated(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.CefTerminationStatus)">
  6729. <summary>
  6730. Called when the render process terminates unexpectedly.
  6731. </summary>
  6732. <param name="browserControl">The ChromiumWebBrowser control</param>
  6733. <param name="browser">the browser object</param>
  6734. <param name="status">indicates how the process terminated.</param>
  6735. </member>
  6736. <member name="M:CefSharp.IRequestHandler.OnQuotaRequest(CefSharp.IWebBrowser,CefSharp.IBrowser,System.String,System.Int64,CefSharp.IRequestCallback)">
  6737. <summary>
  6738. Called when JavaScript requests a specific storage quota size via the webkitStorageInfo.requestQuota function.
  6739. For async processing return true and execute <see cref="M:CefSharp.IRequestCallback.Continue(System.Boolean)"/> at a later time to
  6740. grant or deny the request or <see cref="M:CefSharp.IRequestCallback.Cancel"/> to cancel.
  6741. </summary>
  6742. <param name="browserControl">The ChromiumWebBrowser control</param>
  6743. <param name="browser">the browser object</param>
  6744. <param name="originUrl">the origin of the page making the request</param>
  6745. <param name="newSize">is the requested quota size in bytes</param>
  6746. <param name="callback">Callback interface used for asynchronous continuation of url requests.</param>
  6747. <returns>Return false to cancel the request immediately. Return true to continue the request
  6748. and call <see cref="M:CefSharp.IRequestCallback.Continue(System.Boolean)"/> either in this method or at a later time to
  6749. grant or deny the request.</returns>
  6750. </member>
  6751. <member name="M:CefSharp.IRequestHandler.OnResourceRedirect(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,System.String@)">
  6752. <summary>
  6753. Called on the IO thread when a resource load is redirected. The <see cref="P:CefSharp.IRequest.Url"/>
  6754. parameter will contain the old URL and other request-related information.
  6755. </summary>
  6756. <param name="browserControl">The ChromiumWebBrowser control</param>
  6757. <param name="browser">the browser object</param>
  6758. <param name="frame">The frame that is being redirected.</param>
  6759. <param name="request">the request object - cannot be modified in this callback</param>
  6760. <param name="newUrl">the new URL and can be changed if desired</param>
  6761. </member>
  6762. <member name="M:CefSharp.IRequestHandler.OnProtocolExecution(CefSharp.IWebBrowser,CefSharp.IBrowser,System.String)">
  6763. <summary>
  6764. Called on the UI thread to handle requests for URLs with an unknown protocol component.
  6765. SECURITY WARNING: YOU SHOULD USE THIS METHOD TO ENFORCE RESTRICTIONS BASED ON SCHEME, HOST OR OTHER URL ANALYSIS BEFORE ALLOWING OS EXECUTION.
  6766. </summary>
  6767. <param name="browserControl">The ChromiumWebBrowser control</param>
  6768. <param name="browser">the browser object</param>
  6769. <param name="url">the request url</param>
  6770. <returns>return to true to attempt execution via the registered OS protocol handler, if any. Otherwise return false.</returns>
  6771. </member>
  6772. <member name="M:CefSharp.IRequestHandler.OnRenderViewReady(CefSharp.IWebBrowser,CefSharp.IBrowser)">
  6773. <summary>
  6774. Called on the CEF UI thread when the render view associated
  6775. with browser is ready to receive/handle IPC messages in the render
  6776. process.
  6777. </summary>
  6778. <param name="browserControl">The ChromiumWebBrowser control</param>
  6779. <param name="browser">the browser object</param>
  6780. </member>
  6781. <member name="M:CefSharp.IRequestHandler.OnResourceResponse(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,CefSharp.IResponse)">
  6782. <summary>
  6783. Called on the CEF IO thread when a resource response is received.
  6784. To allow the resource to load normally return false.
  6785. To redirect or retry the resource modify request (url, headers or post body) and return true.
  6786. The response object cannot be modified in this callback.
  6787. </summary>
  6788. <param name="browserControl">The ChromiumWebBrowser control</param>
  6789. <param name="browser">the browser object</param>
  6790. <param name="frame">The frame that is being redirected.</param>
  6791. <param name="request">the request object</param>
  6792. <param name="response">the response object - cannot be modified in this callback</param>
  6793. <returns>
  6794. To allow the resource to load normally return false.
  6795. To redirect or retry the resource modify request (url, headers or post body) and return true.
  6796. </returns>
  6797. </member>
  6798. <member name="M:CefSharp.IRequestHandler.GetResourceResponseFilter(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,CefSharp.IResponse)">
  6799. <summary>
  6800. Called on the CEF IO thread to optionally filter resource response content.
  6801. </summary>
  6802. <param name="browserControl">The ChromiumWebBrowser control</param>
  6803. <param name="browser">the browser object</param>
  6804. <param name="frame">The frame that is being redirected.</param>
  6805. <param name="request">the request object - cannot be modified in this callback</param>
  6806. <param name="response">the response object - cannot be modified in this callback</param>
  6807. <returns>Return an IResponseFilter to intercept this response, otherwise return null</returns>
  6808. </member>
  6809. <member name="M:CefSharp.IRequestHandler.OnResourceLoadComplete(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,CefSharp.IResponse,CefSharp.UrlRequestStatus,System.Int64)">
  6810. <summary>
  6811. Called on the CEF IO thread when a resource load has completed.
  6812. </summary>
  6813. <param name="browserControl">The ChromiumWebBrowser control</param>
  6814. <param name="browser">the browser object</param>
  6815. <param name="frame">The frame that is being redirected.</param>
  6816. <param name="request">the request object - cannot be modified in this callback</param>
  6817. <param name="response">the response object - cannot be modified in this callback</param>
  6818. <param name="status">indicates the load completion status</param>
  6819. <param name="receivedContentLength">is the number of response bytes actually read.</param>
  6820. </member>
  6821. <member name="T:CefSharp.FrameLoadEndEventArgs">
  6822. <summary>
  6823. Event arguments to the FrameLoadEnd event handler set up in IWebBrowser.
  6824. </summary>
  6825. </member>
  6826. <member name="M:CefSharp.FrameLoadEndEventArgs.#ctor(CefSharp.IBrowser,CefSharp.IFrame,System.Int32)">
  6827. <summary>
  6828. Creates a new FrameLoadEnd event args
  6829. </summary>
  6830. <param name="browser">browser</param>
  6831. <param name="frame">frame</param>
  6832. <param name="httpStatusCode">http statusCode</param>
  6833. </member>
  6834. <member name="P:CefSharp.FrameLoadEndEventArgs.Browser">
  6835. <summary>
  6836. The browser that contains the frame that finished loading.
  6837. </summary>
  6838. </member>
  6839. <member name="P:CefSharp.FrameLoadEndEventArgs.Frame">
  6840. <summary>
  6841. The frame that finished loading.
  6842. </summary>
  6843. </member>
  6844. <member name="P:CefSharp.FrameLoadEndEventArgs.Url">
  6845. <summary>
  6846. The URL that was loaded.
  6847. </summary>
  6848. </member>
  6849. <member name="P:CefSharp.FrameLoadEndEventArgs.HttpStatusCode">
  6850. <summary>
  6851. Http Status Code
  6852. </summary>
  6853. </member>
  6854. <member name="F:CefSharp.LogSeverity.Default">
  6855. <summary>
  6856. Default logging (currently Info logging)
  6857. </summary>
  6858. </member>
  6859. <member name="F:CefSharp.LogSeverity.Verbose">
  6860. <summary>
  6861. Verbose logging.
  6862. </summary>
  6863. </member>
  6864. <member name="F:CefSharp.LogSeverity.Info">
  6865. <summary>
  6866. Info logging
  6867. </summary>
  6868. </member>
  6869. <member name="F:CefSharp.LogSeverity.Warning">
  6870. <summary>
  6871. Warning logging
  6872. </summary>
  6873. </member>
  6874. <member name="F:CefSharp.LogSeverity.Error">
  6875. <summary>
  6876. Error logging
  6877. </summary>
  6878. </member>
  6879. <member name="F:CefSharp.LogSeverity.Disable">
  6880. <summary>
  6881. Completely disable logging
  6882. </summary>
  6883. </member>
  6884. <member name="T:CefSharp.StatusMessageEventArgs">
  6885. <summary>
  6886. Event arguments to the StatusMessage event handler set up in IWebBrowser.
  6887. </summary>
  6888. </member>
  6889. <member name="P:CefSharp.StatusMessageEventArgs.Browser">
  6890. <summary>
  6891. The browser object
  6892. </summary>
  6893. </member>
  6894. <member name="P:CefSharp.StatusMessageEventArgs.Value">
  6895. <summary>
  6896. The value of the status message.
  6897. </summary>
  6898. </member>
  6899. <member name="T:CefSharp.TaskStringVisitor">
  6900. <summary>
  6901. A <see cref="T:CefSharp.IStringVisitor"/> that uses a TaskCompletionSource
  6902. to simplify things
  6903. </summary>
  6904. </member>
  6905. <member name="M:CefSharp.TaskStringVisitor.#ctor">
  6906. <summary>
  6907. Default constructor
  6908. </summary>
  6909. </member>
  6910. <member name="M:CefSharp.TaskStringVisitor.CefSharp#IStringVisitor#Visit(System.String)">
  6911. <summary>
  6912. Method that will be executed.
  6913. </summary>
  6914. <param name="str">string (result of async execution)</param>
  6915. </member>
  6916. <member name="P:CefSharp.TaskStringVisitor.Task">
  6917. <summary>
  6918. Task that can be awaited for the result to be retrieved async
  6919. </summary>
  6920. </member>
  6921. <member name="T:CefSharp.TitleChangedEventArgs">
  6922. <summary>
  6923. Event arguments to the TitleChanged event handler.
  6924. </summary>
  6925. </member>
  6926. <member name="M:CefSharp.TitleChangedEventArgs.#ctor(System.String)">
  6927. <summary>
  6928. Creates a new TitleChanged event arg
  6929. </summary>
  6930. <param name="title">the new title</param>
  6931. </member>
  6932. <member name="P:CefSharp.TitleChangedEventArgs.Title">
  6933. <summary>
  6934. The new title
  6935. </summary>
  6936. </member>
  6937. <member name="T:CefSharp.WindowOpenDisposition">
  6938. <summary>
  6939. The manner in which a link click should be opened.
  6940. </summary>
  6941. </member>
  6942. </members>
  6943. </doc>