1
0

Mono.Addins.xml 242 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Mono.Addins</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Mono.Addins.Localization.IAddinLocalizer">
  8. <summary>
  9. An add-in localizer.
  10. </summary>
  11. <remarks>
  12. Add-in localizers which want to provide support for localization of plural forms
  13. can additionally implement <see cref="T:Mono.Addins.Localization.IPluralAddinLocalizer"/>.
  14. </remarks>
  15. </member>
  16. <member name="M:Mono.Addins.Localization.IAddinLocalizer.GetString(System.String)">
  17. <summary>
  18. Gets a localized message.
  19. </summary>
  20. <returns>
  21. The localized message.
  22. </returns>
  23. <param name='msgid'>
  24. The message identifier.
  25. </param>
  26. </member>
  27. <member name="T:Mono.Addins.Description.ExtensionNodeDescriptionCollection">
  28. <summary>
  29. A collection of extension nodes
  30. </summary>
  31. </member>
  32. <member name="T:Mono.Addins.Description.ObjectDescriptionCollection`1">
  33. <summary>
  34. Base class for add-in description collections.
  35. </summary>
  36. </member>
  37. <member name="T:Mono.Addins.Description.ObjectDescriptionCollection">
  38. <summary>
  39. Base class for add-in description collections.
  40. </summary>
  41. </member>
  42. <member name="M:Mono.Addins.Description.ObjectDescriptionCollection.#ctor">
  43. <summary>
  44. Initializes a new instance of the <see cref="T:Mono.Addins.Description.ObjectDescriptionCollection"/> class.
  45. </summary>
  46. </member>
  47. <member name="M:Mono.Addins.Description.ObjectDescriptionCollection.Add(Mono.Addins.Description.ObjectDescription)">
  48. <summary>
  49. Add an object.
  50. </summary>
  51. <param name='ep'>
  52. The object.
  53. </param>
  54. </member>
  55. <member name="M:Mono.Addins.Description.ObjectDescriptionCollection.AddRange(Mono.Addins.Description.ObjectDescriptionCollection)">
  56. <summary>
  57. Adds a collection of objects.
  58. </summary>
  59. <param name='collection'>
  60. The objects to add.
  61. </param>
  62. </member>
  63. <member name="M:Mono.Addins.Description.ObjectDescriptionCollection.Insert(System.Int32,Mono.Addins.Description.ObjectDescription)">
  64. <summary>
  65. Insert an object.
  66. </summary>
  67. <param name='index'>
  68. Insertion index.
  69. </param>
  70. <param name='ep'>
  71. The object.
  72. </param>
  73. </member>
  74. <member name="M:Mono.Addins.Description.ObjectDescriptionCollection.Remove(Mono.Addins.Description.ObjectDescription)">
  75. <summary>
  76. Removes an object.
  77. </summary>
  78. <param name='ep'>
  79. Object to remove.
  80. </param>
  81. </member>
  82. <member name="M:Mono.Addins.Description.ObjectDescriptionCollection.Contains(Mono.Addins.Description.ObjectDescription)">
  83. <summary>
  84. Checks if an object is present in the collection.
  85. </summary>
  86. <param name='ob'>
  87. Objecect to check.
  88. </param>
  89. </member>
  90. <member name="T:Mono.Addins.NodeElementCollection">
  91. <summary>
  92. A collection of NodeElement objects
  93. </summary>
  94. </member>
  95. <member name="P:Mono.Addins.NodeElementCollection.Item(System.Int32)">
  96. <summary>
  97. Gets the <see cref="T:Mono.Addins.NodeElement"/> at the specified index
  98. </summary>
  99. <param name="n">
  100. Index
  101. </param>
  102. </member>
  103. <member name="M:Mono.Addins.Description.ExtensionNodeDescriptionCollection.#ctor">
  104. <summary>
  105. Initializes a new instance of the <see cref="T:Mono.Addins.Description.ExtensionNodeDescriptionCollection"/> class.
  106. </summary>
  107. </member>
  108. <member name="P:Mono.Addins.Description.ExtensionNodeDescriptionCollection.Item(System.Int32)">
  109. <summary>
  110. Gets the <see cref="T:Mono.Addins.Description.ExtensionNodeDescription"/> at the specified index.
  111. </summary>
  112. <param name="n">
  113. The index.
  114. </param>
  115. </member>
  116. <member name="P:Mono.Addins.Description.ExtensionNodeDescriptionCollection.Item(System.String)">
  117. <summary>
  118. Gets the <see cref="T:Mono.Addins.Description.ExtensionNodeDescription"/> with the specified identifier.
  119. </summary>
  120. <param name="id">
  121. Identifier.
  122. </param>
  123. </member>
  124. <member name="T:Mono.Addins.ExtensionPointAttribute">
  125. <summary>
  126. Declares an extension point.
  127. </summary>
  128. </member>
  129. <member name="M:Mono.Addins.ExtensionPointAttribute.#ctor">
  130. <summary>
  131. Initializes a new instance
  132. </summary>
  133. </member>
  134. <member name="M:Mono.Addins.ExtensionPointAttribute.#ctor(System.String)">
  135. <summary>
  136. Initializes a new instance
  137. </summary>
  138. <param name="path">
  139. Extension path that identifies the extension point
  140. </param>
  141. </member>
  142. <member name="M:Mono.Addins.ExtensionPointAttribute.#ctor(System.String,System.Type)">
  143. <summary>
  144. Initializes a new instance
  145. </summary>
  146. <param name="path">
  147. Extension path that identifies the extension point
  148. </param>
  149. <param name="nodeType">
  150. Type of the extension node to be created for extensions
  151. </param>
  152. </member>
  153. <member name="M:Mono.Addins.ExtensionPointAttribute.#ctor(System.String,System.String,System.Type)">
  154. <summary>
  155. Initializes a new instance
  156. </summary>
  157. <param name="path">
  158. Extension path that identifies the extension point
  159. </param>
  160. <param name="nodeName">
  161. Element name to be used when defining an extension in an XML manifest.
  162. </param>
  163. <param name="nodeType">
  164. Type of the extension node to be created for extensions
  165. </param>
  166. </member>
  167. <member name="P:Mono.Addins.ExtensionPointAttribute.Path">
  168. <summary>
  169. Extension path that identifies the extension point
  170. </summary>
  171. </member>
  172. <member name="P:Mono.Addins.ExtensionPointAttribute.Description">
  173. <summary>
  174. Long description of the extension point.
  175. </summary>
  176. </member>
  177. <member name="P:Mono.Addins.ExtensionPointAttribute.NodeType">
  178. <summary>
  179. Type of the extension node to be created for extensions
  180. </summary>
  181. </member>
  182. <member name="P:Mono.Addins.ExtensionPointAttribute.ObjectType">
  183. <summary>
  184. Expected extension object type (when nodes are of type TypeExtensionNode)
  185. </summary>
  186. </member>
  187. <member name="P:Mono.Addins.ExtensionPointAttribute.NodeName">
  188. <summary>
  189. Element name to be used when defining an extension in an XML manifest. The default name is "Type".
  190. </summary>
  191. </member>
  192. <member name="P:Mono.Addins.ExtensionPointAttribute.Name">
  193. <summary>
  194. Display name of the extension point.
  195. </summary>
  196. </member>
  197. <member name="P:Mono.Addins.ExtensionPointAttribute.ExtensionAttributeType">
  198. <summary>
  199. Type of the custom attribute to be used to specify metadata for the extension point
  200. </summary>
  201. </member>
  202. <member name="T:Mono.Addins.AddinUrlAttribute">
  203. <summary>
  204. Addin URL attribute.
  205. </summary>
  206. </member>
  207. <member name="M:Mono.Addins.AddinUrlAttribute.#ctor(System.String)">
  208. <summary>
  209. Initializes the attribute
  210. </summary>
  211. <param name="url">
  212. Url of the add-in
  213. </param>
  214. </member>
  215. <member name="P:Mono.Addins.AddinUrlAttribute.Url">
  216. <summary>
  217. Url of the add-in
  218. </summary>
  219. </member>
  220. <member name="T:Mono.Addins.ExtensionNodeChildAttribute">
  221. <summary>
  222. Declares allowed children of an extension node type.
  223. </summary>
  224. <remarks>
  225. This attribute allows declaring the type of children that an extension node can have.
  226. </remarks>
  227. </member>
  228. <member name="M:Mono.Addins.ExtensionNodeChildAttribute.#ctor(System.String)">
  229. <summary>
  230. Initializes a new instance
  231. </summary>
  232. <param name="nodeName">
  233. Name of the allowed child extension node.
  234. </param>
  235. </member>
  236. <member name="M:Mono.Addins.ExtensionNodeChildAttribute.#ctor(System.Type)">
  237. <summary>
  238. Initializes a new instance
  239. </summary>
  240. <param name="extensionNodeType">
  241. Type of the allowed child extension node.
  242. </param>
  243. </member>
  244. <member name="M:Mono.Addins.ExtensionNodeChildAttribute.#ctor(System.Type,System.String)">
  245. <summary>
  246. Initializes a new instance
  247. </summary>
  248. <param name="extensionNodeType">
  249. Type of the allowed child extension node.
  250. </param>
  251. <param name="nodeName">
  252. Name of the allowed child extension node.
  253. </param>
  254. </member>
  255. <member name="P:Mono.Addins.ExtensionNodeChildAttribute.NodeName">
  256. <summary>
  257. Name of the allowed child extension node.
  258. </summary>
  259. </member>
  260. <member name="P:Mono.Addins.ExtensionNodeChildAttribute.ExtensionNodeType">
  261. <summary>
  262. Type of the allowed child extension node.
  263. </summary>
  264. </member>
  265. <member name="T:Mono.Addins.AddinManager">
  266. <summary>
  267. Provides access to add-in and extension model management operations.
  268. </summary>
  269. </member>
  270. <member name="M:Mono.Addins.AddinManager.Initialize">
  271. <summary>
  272. Initializes the add-in engine.
  273. </summary>
  274. <remarks>
  275. The add-in engine needs to be initialized before doing any add-in operation.
  276. When initialized with this method, it will look for add-ins in the global add-in registry.
  277. </remarks>
  278. </member>
  279. <member name="M:Mono.Addins.AddinManager.Initialize(System.String)">
  280. <summary>
  281. Initializes the add-in engine.
  282. </summary>
  283. <param name="configDir">
  284. Location of the add-in registry.
  285. </param>
  286. <remarks>
  287. The add-in engine needs to be initialized before doing any add-in operation.
  288. Configuration information about the add-in registry will be stored in the
  289. provided location. The add-in engine will look for add-ins in an 'addins'
  290. subdirectory of the provided directory.
  291. When specifying a path, it is possible to use a special folder name as root.
  292. For example: [Personal]/.config/MyApp. In this case, [Personal] will be replaced
  293. by the location of the Environment.SpecialFolder.Personal folder. Any value
  294. of the Environment.SpecialFolder enumeration can be used (always between square
  295. brackets)
  296. </remarks>
  297. </member>
  298. <member name="M:Mono.Addins.AddinManager.Initialize(System.String,System.String)">
  299. <summary>
  300. Initializes the add-in engine.
  301. </summary>
  302. <param name='configDir'>
  303. Location of the add-in registry.
  304. </param>
  305. <param name='addinsDir'>
  306. Add-ins directory. If the path is relative, it is considered to be relative
  307. to the configDir directory.
  308. </param>
  309. <remarks>
  310. The add-in engine needs to be initialized before doing any add-in operation.
  311. Configuration information about the add-in registry will be stored in the
  312. provided location. The add-in engine will look for add-ins in the provided
  313. 'addinsDir' directory.
  314. When specifying a path, it is possible to use a special folder name as root.
  315. For example: [Personal]/.config/MyApp. In this case, [Personal] will be replaced
  316. by the location of the Environment.SpecialFolder.Personal folder. Any value
  317. of the Environment.SpecialFolder enumeration can be used (always between square
  318. brackets)
  319. </remarks>
  320. </member>
  321. <member name="M:Mono.Addins.AddinManager.Initialize(System.String,System.String,System.String)">
  322. <summary>
  323. Initializes the add-in engine.
  324. </summary>
  325. <param name='configDir'>
  326. Location of the add-in registry.
  327. </param>
  328. <param name='addinsDir'>
  329. Add-ins directory. If the path is relative, it is considered to be relative
  330. to the configDir directory.
  331. </param>
  332. <param name='databaseDir'>
  333. Location of the add-in database. If the path is relative, it is considered to be relative
  334. to the configDir directory.
  335. </param>
  336. <remarks>
  337. The add-in engine needs to be initialized before doing any add-in operation.
  338. Configuration information about the add-in registry will be stored in the
  339. provided location. The add-in engine will look for add-ins in the provided
  340. 'addinsDir' directory. Cached information about add-ins will be stored in
  341. the 'databaseDir' directory.
  342. When specifying a path, it is possible to use a special folder name as root.
  343. For example: [Personal]/.config/MyApp. In this case, [Personal] will be replaced
  344. by the location of the Environment.SpecialFolder.Personal folder. Any value
  345. of the Environment.SpecialFolder enumeration can be used (always between square
  346. brackets)
  347. </remarks>
  348. </member>
  349. <member name="M:Mono.Addins.AddinManager.Shutdown">
  350. <summary>
  351. Finalizes an add-in engine.
  352. </summary>
  353. </member>
  354. <member name="M:Mono.Addins.AddinManager.InitializeDefaultLocalizer(Mono.Addins.Localization.IAddinLocalizer)">
  355. <summary>
  356. Sets the default localizer to be used for this add-in engine
  357. </summary>
  358. <param name="localizer">
  359. The add-in localizer
  360. </param>
  361. </member>
  362. <member name="M:Mono.Addins.AddinManager.CheckInstalled(System.String,System.String[])">
  363. <summary>
  364. Checks if the provided add-ins are installed, and requests the installation of those
  365. which aren't.
  366. </summary>
  367. <param name="message">
  368. Message to show to the user when new add-ins have to be installed.
  369. </param>
  370. <param name="addinIds">
  371. List of IDs of the add-ins to be checked.
  372. </param>
  373. <remarks>
  374. This method checks if the specified add-ins are installed.
  375. If some of the add-ins are not installed, it will use
  376. the installer assigned to the DefaultAddinInstaller property
  377. to install them. If the installation fails, or if DefaultAddinInstaller
  378. is not set, an exception will be thrown.
  379. </remarks>
  380. </member>
  381. <member name="M:Mono.Addins.AddinManager.IsAddinLoaded(System.String)">
  382. <summary>
  383. Checks if an add-in has been loaded.
  384. </summary>
  385. <param name="id">
  386. Full identifier of the add-in.
  387. </param>
  388. <returns>
  389. True if the add-in is loaded.
  390. </returns>
  391. </member>
  392. <member name="M:Mono.Addins.AddinManager.LoadAddin(Mono.Addins.IProgressStatus,System.String)">
  393. <summary>
  394. Forces the loading of an add-in.
  395. </summary>
  396. <param name="statusMonitor">
  397. Status monitor to keep track of the loading process.
  398. </param>
  399. <param name="id">
  400. Full identifier of the add-in to load.
  401. </param>
  402. <remarks>
  403. This method loads all assemblies that belong to an add-in in memory.
  404. All add-ins on which the specified add-in depends will also be loaded.
  405. Notice that in general add-ins don't need to be explicitely loaded using
  406. this method, since the add-in engine will load them on demand.
  407. </remarks>
  408. </member>
  409. <member name="M:Mono.Addins.AddinManager.CreateExtensionContext">
  410. <summary>
  411. Creates a new extension context.
  412. </summary>
  413. <returns>
  414. The new extension context.
  415. </returns>
  416. <remarks>
  417. Extension contexts can be used to query the extension model using particular condition values.
  418. </remarks>
  419. </member>
  420. <member name="M:Mono.Addins.AddinManager.GetExtensionNode(System.String)">
  421. <summary>
  422. Returns the extension node in a path
  423. </summary>
  424. <param name="path">
  425. Location of the node.
  426. </param>
  427. <returns>
  428. The node, or null if not found.
  429. </returns>
  430. </member>
  431. <member name="M:Mono.Addins.AddinManager.GetExtensionNode``1(System.String)">
  432. <summary>
  433. Returns the extension node in a path
  434. </summary>
  435. <param name="path">
  436. Location of the node.
  437. </param>
  438. <returns>
  439. The node, or null if not found.
  440. </returns>
  441. </member>
  442. <member name="M:Mono.Addins.AddinManager.GetExtensionNodes(System.String)">
  443. <summary>
  444. Gets extension nodes registered in a path.
  445. </summary>
  446. <param name="path">
  447. An extension path.>
  448. </param>
  449. <returns>
  450. All nodes registered in the provided path.
  451. </returns>
  452. </member>
  453. <member name="M:Mono.Addins.AddinManager.GetExtensionNodes(System.String,System.Type)">
  454. <summary>
  455. Gets extension nodes registered in a path.
  456. </summary>
  457. <param name="path">
  458. An extension path.
  459. </param>
  460. <param name="expectedNodeType">
  461. Expected node type.
  462. </param>
  463. <returns>
  464. A list of nodes
  465. </returns>
  466. <remarks>
  467. This method returns all nodes registered under the provided path.
  468. It will throw a InvalidOperationException if the type of one of
  469. the registered nodes is not assignable to the provided type.
  470. </remarks>
  471. </member>
  472. <member name="M:Mono.Addins.AddinManager.GetExtensionNodes``1(System.String)">
  473. <summary>
  474. Gets extension nodes registered in a path.
  475. </summary>
  476. <param name="path">
  477. An extension path.
  478. </param>
  479. <returns>
  480. A list of nodes
  481. </returns>
  482. <remarks>
  483. This method returns all nodes registered under the provided path.
  484. It will throw a InvalidOperationException if the type of one of
  485. the registered nodes is not assignable to the provided type.
  486. </remarks>
  487. </member>
  488. <member name="M:Mono.Addins.AddinManager.GetExtensionNodes(System.Type)">
  489. <summary>
  490. Gets extension nodes for a type extension point
  491. </summary>
  492. <param name="instanceType">
  493. Type defining the extension point
  494. </param>
  495. <returns>
  496. A list of nodes
  497. </returns>
  498. <remarks>
  499. This method returns all extension nodes bound to the provided type.
  500. </remarks>
  501. </member>
  502. <member name="M:Mono.Addins.AddinManager.GetExtensionNodes(System.Type,System.Type)">
  503. <summary>
  504. Gets extension nodes for a type extension point
  505. </summary>
  506. <param name="instanceType">
  507. Type defining the extension point
  508. </param>
  509. <param name="expectedNodeType">
  510. Expected extension node type
  511. </param>
  512. <returns>
  513. A list of nodes
  514. </returns>
  515. <remarks>
  516. This method returns all nodes registered for the provided type.
  517. It will throw a InvalidOperationException if the type of one of
  518. the registered nodes is not assignable to the provided node type.
  519. </remarks>
  520. </member>
  521. <member name="M:Mono.Addins.AddinManager.GetExtensionNodes``1(System.Type)">
  522. <summary>
  523. Gets extension nodes for a type extension point
  524. </summary>
  525. <param name="instanceType">
  526. Type defining the extension point
  527. </param>
  528. <returns>
  529. A list of nodes
  530. </returns>
  531. <remarks>
  532. This method returns all nodes registered for the provided type.
  533. It will throw a InvalidOperationException if the type of one of
  534. the registered nodes is not assignable to the specified node type argument.
  535. </remarks>
  536. </member>
  537. <member name="M:Mono.Addins.AddinManager.GetExtensionObjects(System.Type)">
  538. <summary>
  539. Gets extension objects registered for a type extension point.
  540. </summary>
  541. <param name="instanceType">
  542. Type defining the extension point
  543. </param>
  544. <returns>
  545. A list of objects
  546. </returns>
  547. </member>
  548. <member name="M:Mono.Addins.AddinManager.GetExtensionObjects``1">
  549. <summary>
  550. Gets extension objects registered for a type extension point.
  551. </summary>
  552. <returns>
  553. A list of objects
  554. </returns>
  555. <remarks>
  556. The type argument of this generic method is the type that defines
  557. the extension point.
  558. </remarks>
  559. </member>
  560. <member name="M:Mono.Addins.AddinManager.GetExtensionObjects(System.Type,System.Boolean)">
  561. <summary>
  562. Gets extension objects registered for a type extension point.
  563. </summary>
  564. <param name="instanceType">
  565. Type defining the extension point
  566. </param>
  567. <param name="reuseCachedInstance">
  568. When set to True, it will return instances created in previous calls.
  569. </param>
  570. <returns>
  571. A list of extension objects.
  572. </returns>
  573. </member>
  574. <member name="M:Mono.Addins.AddinManager.GetExtensionObjects``1(System.Boolean)">
  575. <summary>
  576. Gets extension objects registered for a type extension point.
  577. </summary>
  578. <param name="reuseCachedInstance">
  579. When set to True, it will return instances created in previous calls.
  580. </param>
  581. <returns>
  582. A list of extension objects.
  583. </returns>
  584. <remarks>
  585. The type argument of this generic method is the type that defines
  586. the extension point.
  587. </remarks>
  588. </member>
  589. <member name="M:Mono.Addins.AddinManager.GetExtensionObjects(System.String)">
  590. <summary>
  591. Gets extension objects registered in a path
  592. </summary>
  593. <param name="path">
  594. An extension path.
  595. </param>
  596. <returns>
  597. An array of objects registered in the path.
  598. </returns>
  599. <remarks>
  600. This method can only be used if all nodes in the provided extension path
  601. are of type Mono.Addins.TypeExtensionNode. The returned array is composed
  602. by all objects created by calling the TypeExtensionNode.CreateInstance()
  603. method for each node.
  604. </remarks>
  605. </member>
  606. <member name="M:Mono.Addins.AddinManager.GetExtensionObjects(System.String,System.Boolean)">
  607. <summary>
  608. Gets extension objects registered in a path.
  609. </summary>
  610. <param name="path">
  611. An extension path.
  612. </param>
  613. <param name="reuseCachedInstance">
  614. When set to True, it will return instances created in previous calls.
  615. </param>
  616. <returns>
  617. An array of objects registered in the path.
  618. </returns>
  619. <remarks>
  620. This method can only be used if all nodes in the provided extension path
  621. are of type Mono.Addins.TypeExtensionNode. The returned array is composed
  622. by all objects created by calling the TypeExtensionNode.CreateInstance()
  623. method for each node (or TypeExtensionNode.GetInstance() if
  624. reuseCachedInstance is set to true)
  625. </remarks>
  626. </member>
  627. <member name="M:Mono.Addins.AddinManager.GetExtensionObjects(System.String,System.Type)">
  628. <summary>
  629. Gets extension objects registered in a path.
  630. </summary>
  631. <param name="path">
  632. An extension path.
  633. </param>
  634. <param name="arrayElementType">
  635. Type of the return array elements.
  636. </param>
  637. <returns>
  638. An array of objects registered in the path.
  639. </returns>
  640. <remarks>
  641. This method can only be used if all nodes in the provided extension path
  642. are of type Mono.Addins.TypeExtensionNode. The returned array is composed
  643. by all objects created by calling the TypeExtensionNode.CreateInstance()
  644. method for each node.
  645. An InvalidOperationException exception is thrown if one of the found
  646. objects is not a subclass of the provided type.
  647. </remarks>
  648. </member>
  649. <member name="M:Mono.Addins.AddinManager.GetExtensionObjects``1(System.String)">
  650. <summary>
  651. Gets extension objects registered in a path.
  652. </summary>
  653. <param name="path">
  654. An extension path.
  655. </param>
  656. <returns>
  657. An array of objects registered in the path.
  658. </returns>
  659. <remarks>
  660. This method can only be used if all nodes in the provided extension path
  661. are of type Mono.Addins.TypeExtensionNode. The returned array is composed
  662. by all objects created by calling the TypeExtensionNode.CreateInstance()
  663. method for each node.
  664. An InvalidOperationException exception is thrown if one of the found
  665. objects is not a subclass of the provided type.
  666. </remarks>
  667. </member>
  668. <member name="M:Mono.Addins.AddinManager.GetExtensionObjects(System.String,System.Type,System.Boolean)">
  669. <summary>
  670. Gets extension objects registered in a path.
  671. </summary>
  672. <param name="path">
  673. An extension path.
  674. </param>
  675. <param name="arrayElementType">
  676. Type of the return array elements.
  677. </param>
  678. <param name="reuseCachedInstance">
  679. When set to True, it will return instances created in previous calls.
  680. </param>
  681. <returns>
  682. An array of objects registered in the path.
  683. </returns>
  684. <remarks>
  685. This method can only be used if all nodes in the provided extension path
  686. are of type Mono.Addins.TypeExtensionNode. The returned array is composed
  687. by all objects created by calling the TypeExtensionNode.CreateInstance()
  688. method for each node (or TypeExtensionNode.GetInstance() if
  689. reuseCachedInstance is set to true).
  690. An InvalidOperationException exception is thrown if one of the found
  691. objects is not a subclass of the provided type.
  692. </remarks>
  693. </member>
  694. <member name="M:Mono.Addins.AddinManager.GetExtensionObjects``1(System.String,System.Boolean)">
  695. <summary>
  696. Gets extension objects registered in a path.
  697. </summary>
  698. <param name="path">
  699. An extension path.
  700. </param>
  701. <param name="reuseCachedInstance">
  702. When set to True, it will return instances created in previous calls.
  703. </param>
  704. <returns>
  705. An array of objects registered in the path.
  706. </returns>
  707. <remarks>
  708. This method can only be used if all nodes in the provided extension path
  709. are of type Mono.Addins.TypeExtensionNode. The returned array is composed
  710. by all objects created by calling the TypeExtensionNode.CreateInstance()
  711. method for each node (or TypeExtensionNode.GetInstance() if
  712. reuseCachedInstance is set to true).
  713. An InvalidOperationException exception is thrown if one of the found
  714. objects is not a subclass of the provided type.
  715. </remarks>
  716. </member>
  717. <member name="M:Mono.Addins.AddinManager.AddExtensionNodeHandler(System.String,Mono.Addins.ExtensionNodeEventHandler)">
  718. <summary>
  719. Register a listener of extension node changes.
  720. </summary>
  721. <param name="path">
  722. Path of the node.
  723. </param>
  724. <param name="handler">
  725. A handler method.
  726. </param>
  727. <remarks>
  728. Hosts can call this method to be subscribed to an extension change
  729. event for a specific path. The event will be fired once for every
  730. individual node change. The event arguments include the change type
  731. (Add or Remove) and the extension node added or removed.
  732. NOTE: The handler will be called for all nodes existing in the path at the moment of registration.
  733. </remarks>
  734. </member>
  735. <member name="M:Mono.Addins.AddinManager.RemoveExtensionNodeHandler(System.String,Mono.Addins.ExtensionNodeEventHandler)">
  736. <summary>
  737. Unregister a listener of extension node changes.
  738. </summary>
  739. <param name="path">
  740. Path of the node.
  741. </param>
  742. <param name="handler">
  743. A handler method.
  744. </param>
  745. <remarks>
  746. This method unregisters a delegate from the node change event of a path.
  747. </remarks>
  748. </member>
  749. <member name="M:Mono.Addins.AddinManager.AddExtensionNodeHandler(System.Type,Mono.Addins.ExtensionNodeEventHandler)">
  750. <summary>
  751. Register a listener of extension node changes.
  752. </summary>
  753. <param name="instanceType">
  754. Type defining the extension point
  755. </param>
  756. <param name="handler">
  757. A handler method.
  758. </param>
  759. <remarks>
  760. Hosts can call this method to be subscribed to an extension change
  761. event for a specific type extension point. The event will be fired once for every
  762. individual node change. The event arguments include the change type
  763. (Add or Remove) and the extension node added or removed.
  764. NOTE: The handler will be called for all nodes existing in the path at the moment of registration.
  765. </remarks>
  766. </member>
  767. <member name="M:Mono.Addins.AddinManager.RemoveExtensionNodeHandler(System.Type,Mono.Addins.ExtensionNodeEventHandler)">
  768. <summary>
  769. Unregister a listener of extension node changes.
  770. </summary>
  771. <param name="instanceType">
  772. Type defining the extension point
  773. </param>
  774. <param name="handler">
  775. A handler method.
  776. </param>
  777. </member>
  778. <member name="P:Mono.Addins.AddinManager.IsInitialized">
  779. <summary>
  780. Gets whether the add-in engine has been initialized.
  781. </summary>
  782. </member>
  783. <member name="P:Mono.Addins.AddinManager.DefaultInstaller">
  784. <summary>
  785. Gets the default add-in installer
  786. </summary>
  787. <remarks>
  788. The default installer is used by the CheckInstalled method to request
  789. the installation of missing add-ins.
  790. </remarks>
  791. </member>
  792. <member name="P:Mono.Addins.AddinManager.DefaultLocalizer">
  793. <summary>
  794. Gets the default localizer for this add-in engine
  795. </summary>
  796. </member>
  797. <member name="P:Mono.Addins.AddinManager.CurrentLocalizer">
  798. <summary>
  799. Gets the localizer for the add-in that is invoking this property
  800. </summary>
  801. </member>
  802. <member name="P:Mono.Addins.AddinManager.CurrentAddin">
  803. <summary>
  804. Gets a reference to the RuntimeAddin object for the add-in that is invoking this property
  805. </summary>
  806. </member>
  807. <member name="P:Mono.Addins.AddinManager.AddinEngine">
  808. <summary>
  809. Gets the default add-in engine
  810. </summary>
  811. </member>
  812. <member name="P:Mono.Addins.AddinManager.Registry">
  813. <summary>
  814. Gets the add-in registry bound to the default add-in engine
  815. </summary>
  816. </member>
  817. <member name="E:Mono.Addins.AddinManager.ExtensionChanged">
  818. <summary>
  819. Extension change event.
  820. </summary>
  821. <remarks>
  822. This event is fired when any extension point in the add-in system changes.
  823. The event args object provides the path of the changed extension, although
  824. it does not provide information about what changed. Hosts subscribing to
  825. this event should get the new list of nodes using a query method such as
  826. AddinManager.GetExtensionNodes() and then update whatever needs to be updated.
  827. </remarks>
  828. </member>
  829. <member name="E:Mono.Addins.AddinManager.AddinLoadError">
  830. <summary>
  831. Add-in loading error event.
  832. </summary>
  833. <remarks>
  834. This event is fired when there is an error when loading the extension
  835. of an add-in, or any other kind of error that may happen when querying extension points.
  836. </remarks>
  837. </member>
  838. <member name="E:Mono.Addins.AddinManager.AddinLoaded">
  839. <summary>
  840. Add-in loaded event.
  841. </summary>
  842. <remarks>
  843. Fired after loading an add-in in memory.
  844. </remarks>
  845. </member>
  846. <member name="E:Mono.Addins.AddinManager.AddinUnloaded">
  847. <summary>
  848. Add-in unload event.
  849. </summary>
  850. <remarks>
  851. Fired when an add-in is unloaded from memory. It may happen an add-in is disabled or uninstalled.
  852. </remarks>
  853. </member>
  854. <member name="T:Mono.Addins.Description.ExtensionNodeDescription">
  855. <summary>
  856. An extension node definition.
  857. </summary>
  858. </member>
  859. <member name="T:Mono.Addins.Description.ObjectDescription">
  860. <summary>
  861. Base class for add-in description definitions.
  862. </summary>
  863. </member>
  864. <member name="P:Mono.Addins.Description.ObjectDescription.Parent">
  865. <summary>
  866. Gets the parent object.
  867. </summary>
  868. <value>
  869. The parent object.
  870. </value>
  871. </member>
  872. <member name="P:Mono.Addins.Description.ObjectDescription.ParentAddinDescription">
  873. <summary>
  874. Gets the parent add-in description.
  875. </summary>
  876. <value>
  877. The parent add-in description.
  878. </value>
  879. </member>
  880. <member name="T:Mono.Addins.NodeElement">
  881. <summary>
  882. An extension node element.
  883. </summary>
  884. <remarks>
  885. A raw representation of an extension node. Contains the basic information
  886. needed to create ExtensionNode instances.
  887. </remarks>
  888. </member>
  889. <member name="M:Mono.Addins.NodeElement.GetAttribute(System.String)">
  890. <summary>
  891. Gets element attributes.
  892. </summary>
  893. <param name="key">
  894. Name of the attribute
  895. </param>
  896. <returns>
  897. The value of the attribute
  898. </returns>
  899. </member>
  900. <member name="P:Mono.Addins.NodeElement.NodeName">
  901. <summary>
  902. Name of the node element.
  903. </summary>
  904. </member>
  905. <member name="P:Mono.Addins.NodeElement.Attributes">
  906. <summary>
  907. Gets all attributes defined in the element.
  908. </summary>
  909. </member>
  910. <member name="P:Mono.Addins.NodeElement.ChildNodes">
  911. <summary>
  912. Gets child nodes of this node
  913. </summary>
  914. </member>
  915. <member name="M:Mono.Addins.Description.ExtensionNodeDescription.#ctor(System.String)">
  916. <summary>
  917. Initializes a new instance of the <see cref="T:Mono.Addins.Description.ExtensionNodeDescription"/> class.
  918. </summary>
  919. <param name="nodeName">
  920. Node name.
  921. </param>
  922. </member>
  923. <member name="M:Mono.Addins.Description.ExtensionNodeDescription.GetNodeType">
  924. <summary>
  925. Gets the type of the node.
  926. </summary>
  927. <returns>
  928. The node type.
  929. </returns>
  930. <remarks>
  931. This method only works when the add-in description to which the node belongs has been
  932. loaded from an add-in registry.
  933. </remarks>
  934. </member>
  935. <member name="M:Mono.Addins.Description.ExtensionNodeDescription.GetParentPath">
  936. <summary>
  937. Gets the extension path under which this node is registered
  938. </summary>
  939. <returns>
  940. The parent path.
  941. </returns>
  942. <remarks>
  943. For example, if the id of the node is 'ThisNode', and the node is a child of another node with id 'ParentNode', and
  944. that parent node is defined in an extension with the path '/Core/MainExtension', then the parent path is 'Core/MainExtension/ParentNode'.
  945. </remarks>
  946. </member>
  947. <member name="M:Mono.Addins.Description.ExtensionNodeDescription.GetAttribute(System.String)">
  948. <summary>
  949. Gets the value of an attribute.
  950. </summary>
  951. <returns>
  952. The value of the attribute, or an empty string if the attribute is not defined.
  953. </returns>
  954. <param name='key'>
  955. Name of the attribute.
  956. </param>
  957. </member>
  958. <member name="M:Mono.Addins.Description.ExtensionNodeDescription.SetAttribute(System.String,System.String)">
  959. <summary>
  960. Sets the value of an attribute.
  961. </summary>
  962. <param name='key'>
  963. Name of the attribute
  964. </param>
  965. <param name='value'>
  966. The value.
  967. </param>
  968. </member>
  969. <member name="M:Mono.Addins.Description.ExtensionNodeDescription.RemoveAttribute(System.String)">
  970. <summary>
  971. Removes an attribute.
  972. </summary>
  973. <param name='name'>
  974. Name of the attribute to remove.
  975. </param>
  976. </member>
  977. <member name="P:Mono.Addins.Description.ExtensionNodeDescription.NodeName">
  978. <summary>
  979. Gets or sets the name of the node.
  980. </summary>
  981. <value>
  982. The name of the node.
  983. </value>
  984. </member>
  985. <member name="P:Mono.Addins.Description.ExtensionNodeDescription.Id">
  986. <summary>
  987. Gets or sets the identifier of the node.
  988. </summary>
  989. <value>
  990. The identifier.
  991. </value>
  992. </member>
  993. <member name="P:Mono.Addins.Description.ExtensionNodeDescription.InsertAfter">
  994. <summary>
  995. Gets or sets the identifier of the node after which this node has to be inserted
  996. </summary>
  997. <value>
  998. The identifier of the reference node
  999. </value>
  1000. </member>
  1001. <member name="P:Mono.Addins.Description.ExtensionNodeDescription.InsertBefore">
  1002. <summary>
  1003. Gets or sets the identifier of the node before which this node has to be inserted
  1004. </summary>
  1005. <value>
  1006. The identifier of the reference node
  1007. </value>
  1008. </member>
  1009. <member name="P:Mono.Addins.Description.ExtensionNodeDescription.IsCondition">
  1010. <summary>
  1011. Gets a value indicating whether this node is a condition.
  1012. </summary>
  1013. <value>
  1014. <c>true</c> if this node is a condition; otherwise, <c>false</c>.
  1015. </value>
  1016. </member>
  1017. <member name="P:Mono.Addins.Description.ExtensionNodeDescription.Attributes">
  1018. <summary>
  1019. Gets the attributes of the node.
  1020. </summary>
  1021. <value>
  1022. The attributes.
  1023. </value>
  1024. </member>
  1025. <member name="P:Mono.Addins.Description.ExtensionNodeDescription.ChildNodes">
  1026. <summary>
  1027. Gets the child nodes.
  1028. </summary>
  1029. <value>
  1030. The child nodes.
  1031. </value>
  1032. </member>
  1033. <member name="T:Mono.Addins.Description.ExtensionNodeType">
  1034. <summary>
  1035. An extension node type definition.
  1036. </summary>
  1037. </member>
  1038. <member name="T:Mono.Addins.Description.ExtensionNodeSet">
  1039. <summary>
  1040. An extension node set definition.
  1041. </summary>
  1042. <remarks>
  1043. Node sets allow grouping a set of extension node declarations and give an identifier to that group
  1044. (the node set). Once a node set is declared, it can be referenced from several extension points
  1045. which use the same extension node structure. Extension node sets also allow declaring recursive
  1046. extension nodes, that is, extension nodes with a tree structure.
  1047. </remarks>
  1048. </member>
  1049. <member name="M:Mono.Addins.Description.ExtensionNodeSet.CopyFrom(Mono.Addins.Description.ExtensionNodeSet)">
  1050. <summary>
  1051. Copies data from another node set
  1052. </summary>
  1053. <param name='nset'>
  1054. Node set from which to copy
  1055. </param>
  1056. </member>
  1057. <member name="M:Mono.Addins.Description.ExtensionNodeSet.#ctor">
  1058. <summary>
  1059. Initializes a new instance of the <see cref="T:Mono.Addins.Description.ExtensionNodeSet"/> class.
  1060. </summary>
  1061. </member>
  1062. <member name="M:Mono.Addins.Description.ExtensionNodeSet.GetAllowedNodeTypes">
  1063. <summary>
  1064. Gets all the allowed node types.
  1065. </summary>
  1066. <returns>
  1067. The allowed node types.
  1068. </returns>
  1069. <remarks>
  1070. Gets all allowed node types, including those defined in included node sets.
  1071. This method only works for descriptions loaded from a registry.
  1072. </remarks>
  1073. </member>
  1074. <member name="P:Mono.Addins.Description.ExtensionNodeSet.Id">
  1075. <summary>
  1076. Gets or sets the identifier of the node set.
  1077. </summary>
  1078. <value>
  1079. The identifier.
  1080. </value>
  1081. </member>
  1082. <member name="P:Mono.Addins.Description.ExtensionNodeSet.NodeTypes">
  1083. <summary>
  1084. Gets the node types allowed in this node set.
  1085. </summary>
  1086. <value>
  1087. The node types.
  1088. </value>
  1089. </member>
  1090. <member name="P:Mono.Addins.Description.ExtensionNodeSet.NodeSets">
  1091. <summary>
  1092. Gets a list of other node sets included in this node set.
  1093. </summary>
  1094. <value>
  1095. The node sets.
  1096. </value>
  1097. </member>
  1098. <member name="M:Mono.Addins.Description.ExtensionNodeType.#ctor">
  1099. <summary>
  1100. Initializes a new instance of the <see cref="T:Mono.Addins.Description.ExtensionNodeType"/> class.
  1101. </summary>
  1102. </member>
  1103. <member name="M:Mono.Addins.Description.ExtensionNodeType.CopyFrom(Mono.Addins.Description.ExtensionNodeType)">
  1104. <summary>
  1105. Copies data from another node set
  1106. </summary>
  1107. </member>
  1108. <member name="P:Mono.Addins.Description.ExtensionNodeType.TypeName">
  1109. <summary>
  1110. Type that implements the extension node.
  1111. </summary>
  1112. <value>
  1113. The full name of the type.
  1114. </value>
  1115. </member>
  1116. <member name="P:Mono.Addins.Description.ExtensionNodeType.NodeName">
  1117. <summary>
  1118. Element name to be used when defining an extension in an XML manifest. The default name is "Type".
  1119. </summary>
  1120. <value>
  1121. The name of the node.
  1122. </value>
  1123. </member>
  1124. <member name="P:Mono.Addins.Description.ExtensionNodeType.ObjectTypeName">
  1125. <summary>
  1126. Type of the object that the extension creates (only valid for TypeNodeExtension).
  1127. </summary>
  1128. </member>
  1129. <member name="P:Mono.Addins.Description.ExtensionNodeType.ExtensionAttributeTypeName">
  1130. <summary>
  1131. Name of the custom attribute that can be used to declare nodes of this type
  1132. </summary>
  1133. </member>
  1134. <member name="P:Mono.Addins.Description.ExtensionNodeType.Description">
  1135. <summary>
  1136. Long description of the node type
  1137. </summary>
  1138. </member>
  1139. <member name="P:Mono.Addins.Description.ExtensionNodeType.Attributes">
  1140. <summary>
  1141. Attributes supported by the extension node type.
  1142. </summary>
  1143. </member>
  1144. <member name="T:Mono.Addins.Description.AddinDescription">
  1145. <summary>
  1146. An add-in description
  1147. </summary>
  1148. <remarks>
  1149. This class represent an add-in manifest. It has properties for getting
  1150. all information, and methods for loading and saving files.
  1151. </remarks>
  1152. </member>
  1153. <member name="M:Mono.Addins.Description.AddinDescription.AddExtensionPoint(System.String)">
  1154. <summary>
  1155. Adds an extension point.
  1156. </summary>
  1157. <returns>
  1158. The extension point.
  1159. </returns>
  1160. <param name='path'>
  1161. Path that identifies the new extension point.
  1162. </param>
  1163. </member>
  1164. <member name="M:Mono.Addins.Description.AddinDescription.Save(System.String)">
  1165. <summary>
  1166. Saves the add-in description.
  1167. </summary>
  1168. <param name='fileName'>
  1169. File name where to save this instance
  1170. </param>
  1171. <remarks>
  1172. Saves the add-in description to the specified file and sets the FileName property.
  1173. </remarks>
  1174. </member>
  1175. <member name="M:Mono.Addins.Description.AddinDescription.Save">
  1176. <summary>
  1177. Saves the add-in description.
  1178. </summary>
  1179. <exception cref="T:System.InvalidOperationException">
  1180. It is thrown if FileName is not set
  1181. </exception>
  1182. <remarks>
  1183. The description is saved to the file specified in the FileName property.
  1184. </remarks>
  1185. </member>
  1186. <member name="M:Mono.Addins.Description.AddinDescription.SaveToXml">
  1187. <summary>
  1188. Generates an XML representation of the add-in description
  1189. </summary>
  1190. <returns>
  1191. An XML manifest.
  1192. </returns>
  1193. </member>
  1194. <member name="M:Mono.Addins.Description.AddinDescription.Read(System.String)">
  1195. <summary>
  1196. Load an add-in description from a file
  1197. </summary>
  1198. <param name='configFile'>
  1199. The file.
  1200. </param>
  1201. </member>
  1202. <member name="M:Mono.Addins.Description.AddinDescription.Read(System.IO.Stream,System.String)">
  1203. <summary>
  1204. Load an add-in description from a stream
  1205. </summary>
  1206. <param name='stream'>
  1207. The stream
  1208. </param>
  1209. <param name='basePath'>
  1210. The path to be used to resolve relative file paths.
  1211. </param>
  1212. </member>
  1213. <member name="M:Mono.Addins.Description.AddinDescription.Read(System.IO.TextReader,System.String)">
  1214. <summary>
  1215. Load an add-in description from a text reader
  1216. </summary>
  1217. <param name='reader'>
  1218. The text reader
  1219. </param>
  1220. <param name='basePath'>
  1221. The path to be used to resolve relative file paths.
  1222. </param>
  1223. </member>
  1224. <member name="M:Mono.Addins.Description.AddinDescription.Verify">
  1225. <summary>
  1226. Verify this instance.
  1227. </summary>
  1228. <remarks>
  1229. This method checks all the definitions in the description and returns a list of errors.
  1230. If the returned list is empty, it means that the description is valid.
  1231. </remarks>
  1232. </member>
  1233. <member name="P:Mono.Addins.Description.AddinDescription.AddinFile">
  1234. <summary>
  1235. Gets or sets the path to the main addin file.
  1236. </summary>
  1237. <value>
  1238. The addin file.
  1239. </value>
  1240. <remarks>
  1241. The add-in file can be either the main assembly of an add-in or an xml manifest.
  1242. </remarks>
  1243. </member>
  1244. <member name="P:Mono.Addins.Description.AddinDescription.AddinId">
  1245. <summary>
  1246. Gets the addin identifier.
  1247. </summary>
  1248. <value>
  1249. The addin identifier.
  1250. </value>
  1251. </member>
  1252. <member name="P:Mono.Addins.Description.AddinDescription.LocalId">
  1253. <summary>
  1254. Gets or sets the local identifier.
  1255. </summary>
  1256. <value>
  1257. The local identifier.
  1258. </value>
  1259. </member>
  1260. <member name="P:Mono.Addins.Description.AddinDescription.Namespace">
  1261. <summary>
  1262. Gets or sets the namespace.
  1263. </summary>
  1264. <value>
  1265. The namespace.
  1266. </value>
  1267. </member>
  1268. <member name="P:Mono.Addins.Description.AddinDescription.Name">
  1269. <summary>
  1270. Gets or sets the display name of the add-in.
  1271. </summary>
  1272. <value>
  1273. The name.
  1274. </value>
  1275. </member>
  1276. <member name="P:Mono.Addins.Description.AddinDescription.Version">
  1277. <summary>
  1278. Gets or sets the version.
  1279. </summary>
  1280. <value>
  1281. The version.
  1282. </value>
  1283. </member>
  1284. <member name="P:Mono.Addins.Description.AddinDescription.CompatVersion">
  1285. <summary>
  1286. Gets or sets the version of the add-in with which this add-in is backwards compatible.
  1287. </summary>
  1288. <value>
  1289. The compat version.
  1290. </value>
  1291. </member>
  1292. <member name="P:Mono.Addins.Description.AddinDescription.Author">
  1293. <summary>
  1294. Gets or sets the author.
  1295. </summary>
  1296. <value>
  1297. The author.
  1298. </value>
  1299. </member>
  1300. <member name="P:Mono.Addins.Description.AddinDescription.Url">
  1301. <summary>
  1302. Gets or sets the Url where more information about the add-in can be found.
  1303. </summary>
  1304. <value>
  1305. The URL.
  1306. </value>
  1307. </member>
  1308. <member name="P:Mono.Addins.Description.AddinDescription.Copyright">
  1309. <summary>
  1310. Gets or sets the copyright.
  1311. </summary>
  1312. <value>
  1313. The copyright.
  1314. </value>
  1315. </member>
  1316. <member name="P:Mono.Addins.Description.AddinDescription.Description">
  1317. <summary>
  1318. Gets or sets the description of the add-in.
  1319. </summary>
  1320. <value>
  1321. The description.
  1322. </value>
  1323. </member>
  1324. <member name="P:Mono.Addins.Description.AddinDescription.Category">
  1325. <summary>
  1326. Gets or sets the category of the add-in.
  1327. </summary>
  1328. <value>
  1329. The category.
  1330. </value>
  1331. </member>
  1332. <member name="P:Mono.Addins.Description.AddinDescription.BasePath">
  1333. <summary>
  1334. Gets the base path for locating external files relative to the add-in.
  1335. </summary>
  1336. <value>
  1337. The base path.
  1338. </value>
  1339. </member>
  1340. <member name="P:Mono.Addins.Description.AddinDescription.IsRoot">
  1341. <summary>
  1342. Gets or sets a value indicating whether this instance is an add-in root.
  1343. </summary>
  1344. <value>
  1345. <c>true</c> if this instance is an add-in root; otherwise, <c>false</c>.
  1346. </value>
  1347. </member>
  1348. <member name="P:Mono.Addins.Description.AddinDescription.EnabledByDefault">
  1349. <summary>
  1350. Gets or sets a value indicating whether this add-in is enabled by default.
  1351. </summary>
  1352. <value>
  1353. <c>true</c> if enabled by default; otherwise, <c>false</c>.
  1354. </value>
  1355. </member>
  1356. <member name="P:Mono.Addins.Description.AddinDescription.Flags">
  1357. <summary>
  1358. Gets or sets the add-in flags.
  1359. </summary>
  1360. <value>
  1361. The flags.
  1362. </value>
  1363. </member>
  1364. <member name="P:Mono.Addins.Description.AddinDescription.CanDisable">
  1365. <summary>
  1366. Gets a value indicating whether this add-in can be disabled.
  1367. </summary>
  1368. <value>
  1369. <c>true</c> if this add-in can be disabled; otherwise, <c>false</c>.
  1370. </value>
  1371. </member>
  1372. <member name="P:Mono.Addins.Description.AddinDescription.CanUninstall">
  1373. <summary>
  1374. Gets a value indicating whether this add-in can be uninstalled.
  1375. </summary>
  1376. <value>
  1377. <c>true</c> if this instance can be uninstalled; otherwise, <c>false</c>.
  1378. </value>
  1379. </member>
  1380. <member name="P:Mono.Addins.Description.AddinDescription.IsHidden">
  1381. <summary>
  1382. Gets a value indicating whether this add-in is hidden.
  1383. </summary>
  1384. <value>
  1385. <c>true</c> if this add-in is hidden; otherwise, <c>false</c>.
  1386. </value>
  1387. </member>
  1388. <member name="P:Mono.Addins.Description.AddinDescription.AllFiles">
  1389. <summary>
  1390. Gets all external files
  1391. </summary>
  1392. <value>
  1393. All files.
  1394. </value>
  1395. <remarks>
  1396. External files are data files and assemblies explicitly referenced in the Runtime section of the add-in manifest.
  1397. </remarks>
  1398. </member>
  1399. <member name="P:Mono.Addins.Description.AddinDescription.AllIgnorePaths">
  1400. <summary>
  1401. Gets all paths to be ignored by the add-in scanner.
  1402. </summary>
  1403. <value>
  1404. All paths to be ignored.
  1405. </value>
  1406. </member>
  1407. <member name="P:Mono.Addins.Description.AddinDescription.MainModule">
  1408. <summary>
  1409. Gets the main module.
  1410. </summary>
  1411. <value>
  1412. The main module.
  1413. </value>
  1414. </member>
  1415. <member name="P:Mono.Addins.Description.AddinDescription.OptionalModules">
  1416. <summary>
  1417. Gets the optional modules.
  1418. </summary>
  1419. <value>
  1420. The optional modules.
  1421. </value>
  1422. <remarks>
  1423. Optional modules can be used to declare extensions which will be registered only if some specified
  1424. add-in dependencies can be satisfied. Dependencies specified in optional modules are 'soft dependencies',
  1425. which means that they don't need to be satisfied in order to load the add-in.
  1426. </remarks>
  1427. </member>
  1428. <member name="P:Mono.Addins.Description.AddinDescription.AllModules">
  1429. <summary>
  1430. Gets all modules (including the main module and all optional modules)
  1431. </summary>
  1432. <value>
  1433. All modules.
  1434. </value>
  1435. </member>
  1436. <member name="P:Mono.Addins.Description.AddinDescription.ExtensionNodeSets">
  1437. <summary>
  1438. Gets the extension node sets.
  1439. </summary>
  1440. <value>
  1441. The extension node sets.
  1442. </value>
  1443. </member>
  1444. <member name="P:Mono.Addins.Description.AddinDescription.ExtensionPoints">
  1445. <summary>
  1446. Gets the extension points.
  1447. </summary>
  1448. <value>
  1449. The extension points.
  1450. </value>
  1451. </member>
  1452. <member name="P:Mono.Addins.Description.AddinDescription.ConditionTypes">
  1453. <summary>
  1454. Gets the condition types.
  1455. </summary>
  1456. <value>
  1457. The condition types.
  1458. </value>
  1459. </member>
  1460. <member name="P:Mono.Addins.Description.AddinDescription.Localizer">
  1461. <summary>
  1462. Gets or sets the add-in localizer.
  1463. </summary>
  1464. <value>
  1465. The description of the add-in localizer for this add-in.
  1466. </value>
  1467. </member>
  1468. <member name="P:Mono.Addins.Description.AddinDescription.Properties">
  1469. <summary>
  1470. Custom properties specified in the add-in header
  1471. </summary>
  1472. </member>
  1473. <member name="P:Mono.Addins.Description.AddinDescription.FileName">
  1474. <summary>
  1475. Gets or sets file where this description is stored
  1476. </summary>
  1477. <value>
  1478. The file path.
  1479. </value>
  1480. </member>
  1481. <member name="T:Mono.Addins.AddinFlagsAttribute">
  1482. <summary>
  1483. Addin flags attribute.
  1484. </summary>
  1485. </member>
  1486. <member name="M:Mono.Addins.AddinFlagsAttribute.#ctor(Mono.Addins.Description.AddinFlags)">
  1487. <summary>
  1488. Initializes the attribute
  1489. </summary>
  1490. <param name="flags">
  1491. Add-in flags
  1492. </param>
  1493. </member>
  1494. <member name="P:Mono.Addins.AddinFlagsAttribute.Flags">
  1495. <summary>
  1496. Add-in flags
  1497. </summary>
  1498. </member>
  1499. <member name="T:Mono.Addins.AddinEventHandler">
  1500. <summary>
  1501. Delegate to be used in add-in engine events
  1502. </summary>
  1503. </member>
  1504. <member name="T:Mono.Addins.AddinEventArgs">
  1505. <summary>
  1506. Provides information about an add-in engine event.
  1507. </summary>
  1508. </member>
  1509. <member name="M:Mono.Addins.AddinEventArgs.#ctor(System.String)">
  1510. <summary>
  1511. Initializes a new instance of the <see cref="T:Mono.Addins.AddinEventArgs"/> class.
  1512. </summary>
  1513. <param name="addinId">
  1514. Add-in identifier.
  1515. </param>
  1516. </member>
  1517. <member name="P:Mono.Addins.AddinEventArgs.AddinId">
  1518. <summary>
  1519. Identifier of the add-in that generated the event.
  1520. </summary>
  1521. </member>
  1522. <member name="T:Mono.Addins.NodeAttribute">
  1523. <summary>
  1524. Attribute of a NodeElement.
  1525. </summary>
  1526. </member>
  1527. <member name="P:Mono.Addins.NodeAttribute.Name">
  1528. <summary>
  1529. Name of the attribute.
  1530. </summary>
  1531. </member>
  1532. <member name="P:Mono.Addins.NodeAttribute.Value">
  1533. <summary>
  1534. Value of the attribute.
  1535. </summary>
  1536. </member>
  1537. <member name="T:Mono.Addins.Database.IAssemblyLocator">
  1538. <summary>
  1539. Allows finding assemblies in the file system
  1540. </summary>
  1541. </member>
  1542. <member name="M:Mono.Addins.Database.IAssemblyLocator.GetAssemblyLocation(System.String)">
  1543. <summary>
  1544. Locates an assembly
  1545. </summary>
  1546. <returns>
  1547. The full path to the assembly, or null if not found
  1548. </returns>
  1549. <param name='fullName'>
  1550. Full name of the assembly
  1551. </param>
  1552. </member>
  1553. <member name="T:Mono.Addins.Description.AddinProperty">
  1554. <summary>
  1555. An add-in property.
  1556. </summary>
  1557. </member>
  1558. <member name="P:Mono.Addins.Description.AddinProperty.Name">
  1559. <summary>
  1560. Name of the property
  1561. </summary>
  1562. </member>
  1563. <member name="P:Mono.Addins.Description.AddinProperty.Locale">
  1564. <summary>
  1565. Locale of the property. It is null if the property is not localized.
  1566. </summary>
  1567. </member>
  1568. <member name="P:Mono.Addins.Description.AddinProperty.Value">
  1569. <summary>
  1570. Value of the property.
  1571. </summary>
  1572. </member>
  1573. <member name="T:Mono.Addins.Localization.IAddinLocalizerFactory">
  1574. <summary>
  1575. A localizer factory.
  1576. </summary>
  1577. </member>
  1578. <member name="M:Mono.Addins.Localization.IAddinLocalizerFactory.CreateLocalizer(Mono.Addins.RuntimeAddin,Mono.Addins.NodeElement)">
  1579. <summary>
  1580. Creates a localizer for an add-in.
  1581. </summary>
  1582. <returns>
  1583. The localizer.
  1584. </returns>
  1585. <param name='addin'>
  1586. The add-in for which to create the localizer.
  1587. </param>
  1588. <param name='element'>
  1589. Localizer parameters.
  1590. </param>
  1591. </member>
  1592. <member name="T:Mono.Addins.Description.Dependency">
  1593. <summary>
  1594. Definition of an add-in dependency.
  1595. </summary>
  1596. </member>
  1597. <member name="P:Mono.Addins.Description.Dependency.Name">
  1598. <summary>
  1599. Gets the display name of the dependency.
  1600. </summary>
  1601. <value>
  1602. The name.
  1603. </value>
  1604. </member>
  1605. <member name="T:Mono.Addins.Description.ExtensionNodeSetCollection">
  1606. <summary>
  1607. A collection of node sets.
  1608. </summary>
  1609. </member>
  1610. <member name="M:Mono.Addins.Description.ExtensionNodeSetCollection.#ctor">
  1611. <summary>
  1612. Initializes a new instance of the <see cref="T:Mono.Addins.Description.ExtensionNodeSetCollection"/> class.
  1613. </summary>
  1614. </member>
  1615. <member name="P:Mono.Addins.Description.ExtensionNodeSetCollection.Item(System.Int32)">
  1616. <summary>
  1617. Gets the <see cref="T:Mono.Addins.Description.ExtensionNodeSet"/> at the specified index.
  1618. </summary>
  1619. <param name="n">
  1620. The index.
  1621. </param>
  1622. </member>
  1623. <member name="P:Mono.Addins.Description.ExtensionNodeSetCollection.Item(System.String)">
  1624. <summary>
  1625. Gets the <see cref="T:Mono.Addins.Description.ExtensionNodeSet"/> with the specified id.
  1626. </summary>
  1627. <param name="id">
  1628. Identifier.
  1629. </param>
  1630. </member>
  1631. <member name="T:Mono.Addins.AddinEngine">
  1632. <summary>
  1633. An add-in engine.
  1634. </summary>
  1635. <remarks>
  1636. This class allows hosting several independent add-in engines in a single application domain.
  1637. In general, applications use the AddinManager class to query and manage extensions. This class is static,
  1638. so the API is easily accessible. However, some kind applications may need to use several isolated
  1639. add-in engines, and in this case the AddinManager class can't be used, because it is bound to a single
  1640. add-in engine. Those applications can instead create several instances of the AddinEngine class. Each
  1641. add-in engine can be independently initialized with different add-in registries and extension models.
  1642. </remarks>
  1643. </member>
  1644. <member name="T:Mono.Addins.ExtensionContext">
  1645. <summary>
  1646. An extension context.
  1647. </summary>
  1648. <remarks>
  1649. Extension contexts can be used to query the extension tree
  1650. using particular condition values. Extension points which
  1651. declare the availability of a condition type can only be
  1652. queryed using an extension context which provides an
  1653. evaluator for that condition.
  1654. </remarks>
  1655. </member>
  1656. <member name="M:Mono.Addins.ExtensionContext.RegisterCondition(System.String,Mono.Addins.ConditionType)">
  1657. <summary>
  1658. Registers a new condition in the extension context.
  1659. </summary>
  1660. <param name="id">
  1661. Identifier of the condition.
  1662. </param>
  1663. <param name="type">
  1664. Condition evaluator.
  1665. </param>
  1666. <remarks>
  1667. The registered condition will be particular to this extension context.
  1668. Any event that might be fired as a result of changes in the condition will
  1669. only be fired in this context.
  1670. </remarks>
  1671. </member>
  1672. <member name="M:Mono.Addins.ExtensionContext.RegisterCondition(System.String,System.Type)">
  1673. <summary>
  1674. Registers a new condition in the extension context.
  1675. </summary>
  1676. <param name="id">
  1677. Identifier of the condition.
  1678. </param>
  1679. <param name="type">
  1680. Type of the condition evaluator. Must be a subclass of Mono.Addins.ConditionType.
  1681. </param>
  1682. <remarks>
  1683. The registered condition will be particular to this extension context. Any event
  1684. that might be fired as a result of changes in the condition will only be fired in this context.
  1685. </remarks>
  1686. </member>
  1687. <member name="M:Mono.Addins.ExtensionContext.GetExtensionNode(System.String)">
  1688. <summary>
  1689. Returns the extension node in a path
  1690. </summary>
  1691. <param name="path">
  1692. Location of the node.
  1693. </param>
  1694. <returns>
  1695. The node, or null if not found.
  1696. </returns>
  1697. </member>
  1698. <member name="M:Mono.Addins.ExtensionContext.GetExtensionNode``1(System.String)">
  1699. <summary>
  1700. Returns the extension node in a path
  1701. </summary>
  1702. <param name="path">
  1703. Location of the node.
  1704. </param>
  1705. <returns>
  1706. The node, or null if not found.
  1707. </returns>
  1708. </member>
  1709. <member name="M:Mono.Addins.ExtensionContext.GetExtensionNodes(System.String)">
  1710. <summary>
  1711. Gets extension nodes registered in a path.
  1712. </summary>
  1713. <param name="path">
  1714. An extension path.>
  1715. </param>
  1716. <returns>
  1717. All nodes registered in the provided path.
  1718. </returns>
  1719. </member>
  1720. <member name="M:Mono.Addins.ExtensionContext.GetExtensionNodes``1(System.String)">
  1721. <summary>
  1722. Gets extension nodes registered in a path.
  1723. </summary>
  1724. <param name="path">
  1725. An extension path.
  1726. </param>
  1727. <returns>
  1728. A list of nodes
  1729. </returns>
  1730. <remarks>
  1731. This method returns all nodes registered under the provided path.
  1732. It will throw a InvalidOperationException if the type of one of
  1733. the registered nodes is not assignable to the provided type.
  1734. </remarks>
  1735. </member>
  1736. <member name="M:Mono.Addins.ExtensionContext.GetExtensionNodes(System.Type)">
  1737. <summary>
  1738. Gets extension nodes for a type extension point
  1739. </summary>
  1740. <param name="instanceType">
  1741. Type defining the extension point
  1742. </param>
  1743. <returns>
  1744. A list of nodes
  1745. </returns>
  1746. <remarks>
  1747. This method returns all extension nodes bound to the provided type.
  1748. </remarks>
  1749. </member>
  1750. <member name="M:Mono.Addins.ExtensionContext.GetExtensionNodes(System.Type,System.Type)">
  1751. <summary>
  1752. Gets extension nodes for a type extension point
  1753. </summary>
  1754. <param name="instanceType">
  1755. Type defining the extension point
  1756. </param>
  1757. <param name="expectedNodeType">
  1758. Expected extension node type
  1759. </param>
  1760. <returns>
  1761. A list of nodes
  1762. </returns>
  1763. <remarks>
  1764. This method returns all nodes registered for the provided type.
  1765. It will throw a InvalidOperationException if the type of one of
  1766. the registered nodes is not assignable to the provided node type.
  1767. </remarks>
  1768. </member>
  1769. <member name="M:Mono.Addins.ExtensionContext.GetExtensionNodes``1(System.Type)">
  1770. <summary>
  1771. Gets extension nodes for a type extension point
  1772. </summary>
  1773. <param name="instanceType">
  1774. Type defining the extension point
  1775. </param>
  1776. <returns>
  1777. A list of nodes
  1778. </returns>
  1779. <remarks>
  1780. This method returns all nodes registered for the provided type.
  1781. It will throw a InvalidOperationException if the type of one of
  1782. the registered nodes is not assignable to the specified node type argument.
  1783. </remarks>
  1784. </member>
  1785. <member name="M:Mono.Addins.ExtensionContext.GetExtensionNodes(System.String,System.Type)">
  1786. <summary>
  1787. Gets extension nodes registered in a path.
  1788. </summary>
  1789. <param name="path">
  1790. An extension path.
  1791. </param>
  1792. <param name="expectedNodeType">
  1793. Expected node type.
  1794. </param>
  1795. <returns>
  1796. A list of nodes
  1797. </returns>
  1798. <remarks>
  1799. This method returns all nodes registered under the provided path.
  1800. It will throw a InvalidOperationException if the type of one of
  1801. the registered nodes is not assignable to the provided type.
  1802. </remarks>
  1803. </member>
  1804. <member name="M:Mono.Addins.ExtensionContext.GetExtensionObjects(System.Type)">
  1805. <summary>
  1806. Gets extension objects registered for a type extension point.
  1807. </summary>
  1808. <param name="instanceType">
  1809. Type defining the extension point
  1810. </param>
  1811. <returns>
  1812. A list of objects
  1813. </returns>
  1814. </member>
  1815. <member name="M:Mono.Addins.ExtensionContext.GetExtensionObjects``1">
  1816. <summary>
  1817. Gets extension objects registered for a type extension point.
  1818. </summary>
  1819. <returns>
  1820. A list of objects
  1821. </returns>
  1822. <remarks>
  1823. The type argument of this generic method is the type that defines
  1824. the extension point.
  1825. </remarks>
  1826. </member>
  1827. <member name="M:Mono.Addins.ExtensionContext.GetExtensionObjects(System.Type,System.Boolean)">
  1828. <summary>
  1829. Gets extension objects registered for a type extension point.
  1830. </summary>
  1831. <param name="instanceType">
  1832. Type defining the extension point
  1833. </param>
  1834. <param name="reuseCachedInstance">
  1835. When set to True, it will return instances created in previous calls.
  1836. </param>
  1837. <returns>
  1838. A list of extension objects.
  1839. </returns>
  1840. </member>
  1841. <member name="M:Mono.Addins.ExtensionContext.GetExtensionObjects``1(System.Boolean)">
  1842. <summary>
  1843. Gets extension objects registered for a type extension point.
  1844. </summary>
  1845. <param name="reuseCachedInstance">
  1846. When set to True, it will return instances created in previous calls.
  1847. </param>
  1848. <returns>
  1849. A list of extension objects.
  1850. </returns>
  1851. <remarks>
  1852. The type argument of this generic method is the type that defines
  1853. the extension point.
  1854. </remarks>
  1855. </member>
  1856. <member name="M:Mono.Addins.ExtensionContext.GetExtensionObjects(System.String)">
  1857. <summary>
  1858. Gets extension objects registered in a path
  1859. </summary>
  1860. <param name="path">
  1861. An extension path.
  1862. </param>
  1863. <returns>
  1864. An array of objects registered in the path.
  1865. </returns>
  1866. <remarks>
  1867. This method can only be used if all nodes in the provided extension path
  1868. are of type Mono.Addins.TypeExtensionNode. The returned array is composed
  1869. by all objects created by calling the TypeExtensionNode.CreateInstance()
  1870. method for each node.
  1871. </remarks>
  1872. </member>
  1873. <member name="M:Mono.Addins.ExtensionContext.GetExtensionObjects(System.String,System.Boolean)">
  1874. <summary>
  1875. Gets extension objects registered in a path.
  1876. </summary>
  1877. <param name="path">
  1878. An extension path.
  1879. </param>
  1880. <param name="reuseCachedInstance">
  1881. When set to True, it will return instances created in previous calls.
  1882. </param>
  1883. <returns>
  1884. An array of objects registered in the path.
  1885. </returns>
  1886. <remarks>
  1887. This method can only be used if all nodes in the provided extension path
  1888. are of type Mono.Addins.TypeExtensionNode. The returned array is composed
  1889. by all objects created by calling the TypeExtensionNode.CreateInstance()
  1890. method for each node (or TypeExtensionNode.GetInstance() if
  1891. reuseCachedInstance is set to true)
  1892. </remarks>
  1893. </member>
  1894. <member name="M:Mono.Addins.ExtensionContext.GetExtensionObjects(System.String,System.Type)">
  1895. <summary>
  1896. Gets extension objects registered in a path.
  1897. </summary>
  1898. <param name="path">
  1899. An extension path.
  1900. </param>
  1901. <param name="arrayElementType">
  1902. Type of the return array elements.
  1903. </param>
  1904. <returns>
  1905. An array of objects registered in the path.
  1906. </returns>
  1907. <remarks>
  1908. This method can only be used if all nodes in the provided extension path
  1909. are of type Mono.Addins.TypeExtensionNode. The returned array is composed
  1910. by all objects created by calling the TypeExtensionNode.CreateInstance()
  1911. method for each node.
  1912. An InvalidOperationException exception is thrown if one of the found
  1913. objects is not a subclass of the provided type.
  1914. </remarks>
  1915. </member>
  1916. <member name="M:Mono.Addins.ExtensionContext.GetExtensionObjects``1(System.String)">
  1917. <summary>
  1918. Gets extension objects registered in a path.
  1919. </summary>
  1920. <param name="path">
  1921. An extension path.
  1922. </param>
  1923. <returns>
  1924. An array of objects registered in the path.
  1925. </returns>
  1926. <remarks>
  1927. This method can only be used if all nodes in the provided extension path
  1928. are of type Mono.Addins.TypeExtensionNode. The returned array is composed
  1929. by all objects created by calling the TypeExtensionNode.CreateInstance()
  1930. method for each node.
  1931. An InvalidOperationException exception is thrown if one of the found
  1932. objects is not a subclass of the provided type.
  1933. </remarks>
  1934. </member>
  1935. <member name="M:Mono.Addins.ExtensionContext.GetExtensionObjects``1(System.String,System.Boolean)">
  1936. <summary>
  1937. Gets extension objects registered in a path.
  1938. </summary>
  1939. <param name="path">
  1940. An extension path.
  1941. </param>
  1942. <param name="reuseCachedInstance">
  1943. When set to True, it will return instances created in previous calls.
  1944. </param>
  1945. <returns>
  1946. An array of objects registered in the path.
  1947. </returns>
  1948. <remarks>
  1949. This method can only be used if all nodes in the provided extension path
  1950. are of type Mono.Addins.TypeExtensionNode. The returned array is composed
  1951. by all objects created by calling the TypeExtensionNode.CreateInstance()
  1952. method for each node (or TypeExtensionNode.GetInstance() if
  1953. reuseCachedInstance is set to true).
  1954. An InvalidOperationException exception is thrown if one of the found
  1955. objects is not a subclass of the provided type.
  1956. </remarks>
  1957. </member>
  1958. <member name="M:Mono.Addins.ExtensionContext.GetExtensionObjects(System.String,System.Type,System.Boolean)">
  1959. <summary>
  1960. Gets extension objects registered in a path.
  1961. </summary>
  1962. <param name="path">
  1963. An extension path.
  1964. </param>
  1965. <param name="arrayElementType">
  1966. Type of the return array elements.
  1967. </param>
  1968. <param name="reuseCachedInstance">
  1969. When set to True, it will return instances created in previous calls.
  1970. </param>
  1971. <returns>
  1972. An array of objects registered in the path.
  1973. </returns>
  1974. <remarks>
  1975. This method can only be used if all nodes in the provided extension path
  1976. are of type Mono.Addins.TypeExtensionNode. The returned array is composed
  1977. by all objects created by calling the TypeExtensionNode.CreateInstance()
  1978. method for each node (or TypeExtensionNode.GetInstance() if
  1979. reuseCachedInstance is set to true).
  1980. An InvalidOperationException exception is thrown if one of the found
  1981. objects is not a subclass of the provided type.
  1982. </remarks>
  1983. </member>
  1984. <member name="M:Mono.Addins.ExtensionContext.AddExtensionNodeHandler(System.String,Mono.Addins.ExtensionNodeEventHandler)">
  1985. <summary>
  1986. Register a listener of extension node changes.
  1987. </summary>
  1988. <param name="path">
  1989. Path of the node.
  1990. </param>
  1991. <param name="handler">
  1992. A handler method.
  1993. </param>
  1994. <remarks>
  1995. Hosts can call this method to be subscribed to an extension change
  1996. event for a specific path. The event will be fired once for every
  1997. individual node change. The event arguments include the change type
  1998. (Add or Remove) and the extension node added or removed.
  1999. NOTE: The handler will be called for all nodes existing in the path at the moment of registration.
  2000. </remarks>
  2001. </member>
  2002. <member name="M:Mono.Addins.ExtensionContext.RemoveExtensionNodeHandler(System.String,Mono.Addins.ExtensionNodeEventHandler)">
  2003. <summary>
  2004. Unregister a listener of extension node changes.
  2005. </summary>
  2006. <param name="path">
  2007. Path of the node.
  2008. </param>
  2009. <param name="handler">
  2010. A handler method.
  2011. </param>
  2012. <remarks>
  2013. This method unregisters a delegate from the node change event of a path.
  2014. </remarks>
  2015. </member>
  2016. <member name="M:Mono.Addins.ExtensionContext.AddExtensionNodeHandler(System.Type,Mono.Addins.ExtensionNodeEventHandler)">
  2017. <summary>
  2018. Register a listener of extension node changes.
  2019. </summary>
  2020. <param name="instanceType">
  2021. Type defining the extension point
  2022. </param>
  2023. <param name="handler">
  2024. A handler method.
  2025. </param>
  2026. <remarks>
  2027. Hosts can call this method to be subscribed to an extension change
  2028. event for a specific type extension point. The event will be fired once for every
  2029. individual node change. The event arguments include the change type
  2030. (Add or Remove) and the extension node added or removed.
  2031. NOTE: The handler will be called for all nodes existing in the path at the moment of registration.
  2032. </remarks>
  2033. </member>
  2034. <member name="M:Mono.Addins.ExtensionContext.RemoveExtensionNodeHandler(System.Type,Mono.Addins.ExtensionNodeEventHandler)">
  2035. <summary>
  2036. Unregister a listener of extension node changes.
  2037. </summary>
  2038. <param name="instanceType">
  2039. Type defining the extension point
  2040. </param>
  2041. <param name="handler">
  2042. A handler method.
  2043. </param>
  2044. </member>
  2045. <member name="E:Mono.Addins.ExtensionContext.ExtensionChanged">
  2046. <summary>
  2047. Extension change event.
  2048. </summary>
  2049. <remarks>
  2050. This event is fired when any extension point in the add-in system changes.
  2051. The event args object provides the path of the changed extension, although
  2052. it does not provide information about what changed. Hosts subscribing to
  2053. this event should get the new list of nodes using a query method such as
  2054. AddinManager.GetExtensionNodes() and then update whatever needs to be updated.
  2055. </remarks>
  2056. </member>
  2057. <member name="M:Mono.Addins.AddinEngine.#ctor">
  2058. <summary>
  2059. Initializes a new instance of the <see cref="T:Mono.Addins.AddinEngine"/> class.
  2060. </summary>
  2061. </member>
  2062. <member name="M:Mono.Addins.AddinEngine.Initialize(System.String)">
  2063. <summary>
  2064. Initializes the add-in engine
  2065. </summary>
  2066. <param name="configDir">
  2067. Location of the add-in registry.
  2068. </param>
  2069. <remarks>The add-in engine needs to be initialized before doing any add-in operation.
  2070. When initialized with this method, it will look for add-in in the add-in registry
  2071. located in the specified path.
  2072. </remarks>
  2073. </member>
  2074. <member name="M:Mono.Addins.AddinEngine.Initialize(System.String,System.String)">
  2075. <summary>
  2076. Initializes the add-in engine.
  2077. </summary>
  2078. <param name='configDir'>
  2079. Location of the add-in registry.
  2080. </param>
  2081. <param name='addinsDir'>
  2082. Add-ins directory. If the path is relative, it is considered to be relative
  2083. to the configDir directory.
  2084. </param>
  2085. <remarks>
  2086. The add-in engine needs to be initialized before doing any add-in operation.
  2087. Configuration information about the add-in registry will be stored in the
  2088. provided location. The add-in engine will look for add-ins in the provided
  2089. 'addinsDir' directory.
  2090. When specifying a path, it is possible to use a special folder name as root.
  2091. For example: [Personal]/.config/MyApp. In this case, [Personal] will be replaced
  2092. by the location of the Environment.SpecialFolder.Personal folder. Any value
  2093. of the Environment.SpecialFolder enumeration can be used (always between square
  2094. brackets)
  2095. </remarks>
  2096. </member>
  2097. <member name="M:Mono.Addins.AddinEngine.Initialize(System.String,System.String,System.String)">
  2098. <summary>
  2099. Initializes the add-in engine.
  2100. </summary>
  2101. <param name='configDir'>
  2102. Location of the add-in registry.
  2103. </param>
  2104. <param name='addinsDir'>
  2105. Add-ins directory. If the path is relative, it is considered to be relative
  2106. to the configDir directory.
  2107. </param>
  2108. <param name='databaseDir'>
  2109. Location of the add-in database. If the path is relative, it is considered to be relative
  2110. to the configDir directory.
  2111. </param>
  2112. <remarks>
  2113. The add-in engine needs to be initialized before doing any add-in operation.
  2114. Configuration information about the add-in registry will be stored in the
  2115. provided location. The add-in engine will look for add-ins in the provided
  2116. 'addinsDir' directory. Cached information about add-ins will be stored in
  2117. the 'databaseDir' directory.
  2118. When specifying a path, it is possible to use a special folder name as root.
  2119. For example: [Personal]/.config/MyApp. In this case, [Personal] will be replaced
  2120. by the location of the Environment.SpecialFolder.Personal folder. Any value
  2121. of the Environment.SpecialFolder enumeration can be used (always between square
  2122. brackets)
  2123. </remarks>
  2124. </member>
  2125. <member name="M:Mono.Addins.AddinEngine.Shutdown">
  2126. <summary>
  2127. Finalizes the add-in engine.
  2128. </summary>
  2129. </member>
  2130. <member name="M:Mono.Addins.AddinEngine.InitializeDefaultLocalizer(Mono.Addins.Localization.IAddinLocalizer)">
  2131. <summary>
  2132. Sets the default localizer to be used for this add-in engine
  2133. </summary>
  2134. <param name="localizer">
  2135. The add-in localizer
  2136. </param>
  2137. </member>
  2138. <member name="M:Mono.Addins.AddinEngine.CheckInstalled(System.String,System.String[])">
  2139. <summary>
  2140. Checks if the provided add-ins are installed, and requests the installation of those
  2141. which aren't.
  2142. </summary>
  2143. <param name="message">
  2144. Message to show to the user when new add-ins have to be installed.
  2145. </param>
  2146. <param name="addinIds">
  2147. List of IDs of the add-ins to be checked.
  2148. </param>
  2149. <remarks>
  2150. This method checks if the specified add-ins are installed.
  2151. If some of the add-ins are not installed, it will use
  2152. the installer assigned to the DefaultAddinInstaller property
  2153. to install them. If the installation fails, or if DefaultAddinInstaller
  2154. is not set, an exception will be thrown.
  2155. </remarks>
  2156. </member>
  2157. <member name="M:Mono.Addins.AddinEngine.IsAddinLoaded(System.String)">
  2158. <summary>
  2159. Checks if an add-in has been loaded.
  2160. </summary>
  2161. <param name="id">
  2162. Full identifier of the add-in.
  2163. </param>
  2164. <returns>
  2165. True if the add-in is loaded.
  2166. </returns>
  2167. </member>
  2168. <member name="M:Mono.Addins.AddinEngine.LoadAddin(Mono.Addins.IProgressStatus,System.String)">
  2169. <summary>
  2170. Forces the loading of an add-in.
  2171. </summary>
  2172. <param name="statusMonitor">
  2173. Status monitor to keep track of the loading process.
  2174. </param>
  2175. <param name="id">
  2176. Full identifier of the add-in to load.
  2177. </param>
  2178. <remarks>
  2179. This method loads all assemblies that belong to an add-in in memory.
  2180. All add-ins on which the specified add-in depends will also be loaded.
  2181. Notice that in general add-ins don't need to be explicitely loaded using
  2182. this method, since the add-in engine will load them on demand.
  2183. </remarks>
  2184. </member>
  2185. <member name="M:Mono.Addins.AddinEngine.CreateExtensionContext">
  2186. <summary>
  2187. Creates a new extension context.
  2188. </summary>
  2189. <returns>
  2190. The new extension context.
  2191. </returns>
  2192. <remarks>
  2193. Extension contexts can be used to query the extension model using particular condition values.
  2194. </remarks>
  2195. </member>
  2196. <member name="E:Mono.Addins.AddinEngine.AddinLoadError">
  2197. <summary>
  2198. Raised when there is an error while loading an add-in
  2199. </summary>
  2200. </member>
  2201. <member name="E:Mono.Addins.AddinEngine.AddinLoaded">
  2202. <summary>
  2203. Raised when an add-in is loaded
  2204. </summary>
  2205. </member>
  2206. <member name="E:Mono.Addins.AddinEngine.AddinUnloaded">
  2207. <summary>
  2208. Raised when an add-in is unloaded
  2209. </summary>
  2210. </member>
  2211. <member name="P:Mono.Addins.AddinEngine.IsInitialized">
  2212. <summary>
  2213. Gets whether the add-in engine has been initialized.
  2214. </summary>
  2215. </member>
  2216. <member name="P:Mono.Addins.AddinEngine.DefaultInstaller">
  2217. <summary>
  2218. Gets the default add-in installer
  2219. </summary>
  2220. <remarks>
  2221. The default installer is used by the CheckInstalled method to request
  2222. the installation of missing add-ins.
  2223. </remarks>
  2224. </member>
  2225. <member name="P:Mono.Addins.AddinEngine.DefaultLocalizer">
  2226. <summary>
  2227. Gets the default localizer for this add-in engine
  2228. </summary>
  2229. </member>
  2230. <member name="P:Mono.Addins.AddinEngine.CurrentLocalizer">
  2231. <summary>
  2232. Gets the localizer for the add-in that is invoking this property
  2233. </summary>
  2234. </member>
  2235. <member name="P:Mono.Addins.AddinEngine.CurrentAddin">
  2236. <summary>
  2237. Gets a reference to the RuntimeAddin object for the add-in that is invoking this property
  2238. </summary>
  2239. </member>
  2240. <member name="P:Mono.Addins.AddinEngine.Registry">
  2241. <summary>
  2242. Gets the add-in registry bound to this add-in engine
  2243. </summary>
  2244. </member>
  2245. <member name="T:Mono.Addins.Database.IAssemblyReflector">
  2246. <summary>
  2247. An assembly reflector
  2248. </summary>
  2249. <remarks>
  2250. This interface can be implemented to provide a custom method for getting information about assemblies.
  2251. </remarks>
  2252. </member>
  2253. <member name="M:Mono.Addins.Database.IAssemblyReflector.Initialize(Mono.Addins.Database.IAssemblyLocator)">
  2254. <summary>
  2255. Called to initialize the assembly reflector
  2256. </summary>
  2257. <param name='locator'>
  2258. IAssemblyLocator instance which can be used to locate referenced assemblies.
  2259. </param>
  2260. </member>
  2261. <member name="M:Mono.Addins.Database.IAssemblyReflector.GetCustomAttributes(System.Object,System.Type,System.Boolean)">
  2262. <summary>
  2263. Gets a list of custom attributes
  2264. </summary>
  2265. <returns>
  2266. The custom attributes.
  2267. </returns>
  2268. <param name='obj'>
  2269. An assembly, class or class member
  2270. </param>
  2271. <param name='type'>
  2272. Type of the attribute to be returned. It will always be one of the attribute types
  2273. defined in Mono.Addins.
  2274. </param>
  2275. <param name='inherit'>
  2276. 'true' if inherited attributes must be returned
  2277. </param>
  2278. </member>
  2279. <member name="M:Mono.Addins.Database.IAssemblyReflector.GetRawCustomAttributes(System.Object,System.Type,System.Boolean)">
  2280. <summary>
  2281. Gets a list of custom attributes
  2282. </summary>
  2283. <returns>
  2284. The attributes.
  2285. </returns>
  2286. <param name='obj'>
  2287. An assembly, class or class member
  2288. </param>
  2289. <param name='type'>
  2290. Base type of the attribute to be returned
  2291. </param>
  2292. <param name='inherit'>
  2293. 'true' if inherited attributes must be returned
  2294. </param>
  2295. </member>
  2296. <member name="M:Mono.Addins.Database.IAssemblyReflector.LoadAssembly(System.String)">
  2297. <summary>
  2298. Loads an assembly.
  2299. </summary>
  2300. <returns>
  2301. The loaded assembly
  2302. </returns>
  2303. <param name='file'>
  2304. Path of the assembly.
  2305. </param>
  2306. </member>
  2307. <member name="M:Mono.Addins.Database.IAssemblyReflector.LoadAssemblyFromReference(System.Object)">
  2308. <summary>
  2309. Loads the assembly specified in an assembly reference
  2310. </summary>
  2311. <returns>
  2312. The assembly
  2313. </returns>
  2314. <param name='asmReference'>
  2315. An assembly reference
  2316. </param>
  2317. </member>
  2318. <member name="M:Mono.Addins.Database.IAssemblyReflector.GetResourceNames(System.Object)">
  2319. <summary>
  2320. Gets the names of all resources embedded in an assembly
  2321. </summary>
  2322. <returns>
  2323. The names of the resources
  2324. </returns>
  2325. <param name='asm'>
  2326. An assembly
  2327. </param>
  2328. </member>
  2329. <member name="M:Mono.Addins.Database.IAssemblyReflector.GetResourceStream(System.Object,System.String)">
  2330. <summary>
  2331. Gets the data stream of a resource
  2332. </summary>
  2333. <returns>
  2334. The stream.
  2335. </returns>
  2336. <param name='asm'>
  2337. An assembly
  2338. </param>
  2339. <param name='resourceName'>
  2340. The name of a resource
  2341. </param>
  2342. </member>
  2343. <member name="M:Mono.Addins.Database.IAssemblyReflector.GetAssemblyTypes(System.Object)">
  2344. <summary>
  2345. Gets all types defined in an assembly
  2346. </summary>
  2347. <returns>
  2348. The types
  2349. </returns>
  2350. <param name='asm'>
  2351. An assembly
  2352. </param>
  2353. </member>
  2354. <member name="M:Mono.Addins.Database.IAssemblyReflector.GetAssemblyReferences(System.Object)">
  2355. <summary>
  2356. Gets all assembly references of an assembly
  2357. </summary>
  2358. <returns>
  2359. A list of assembly references
  2360. </returns>
  2361. <param name='asm'>
  2362. An assembly
  2363. </param>
  2364. </member>
  2365. <member name="M:Mono.Addins.Database.IAssemblyReflector.GetType(System.Object,System.String)">
  2366. <summary>
  2367. Looks for a type in an assembly
  2368. </summary>
  2369. <returns>
  2370. The type.
  2371. </returns>
  2372. <param name='asm'>
  2373. An assembly
  2374. </param>
  2375. <param name='typeName'>
  2376. Name of the type
  2377. </param>
  2378. </member>
  2379. <member name="M:Mono.Addins.Database.IAssemblyReflector.GetCustomAttribute(System.Object,System.Type,System.Boolean)">
  2380. <summary>
  2381. Gets a custom attribute
  2382. </summary>
  2383. <returns>
  2384. The custom attribute.
  2385. </returns>
  2386. <param name='obj'>
  2387. An assembly, class or class member
  2388. </param>
  2389. <param name='type'>
  2390. Base type of the attribute to be returned. It will always be one of the attribute types
  2391. defined in Mono.Addins.
  2392. </param>
  2393. <param name='inherit'>
  2394. 'true' if inherited attributes must be returned
  2395. </param>
  2396. </member>
  2397. <member name="M:Mono.Addins.Database.IAssemblyReflector.GetTypeName(System.Object)">
  2398. <summary>
  2399. Gets the name of a type (not including namespace)
  2400. </summary>
  2401. <returns>
  2402. The type name.
  2403. </returns>
  2404. <param name='type'>
  2405. A type
  2406. </param>
  2407. </member>
  2408. <member name="M:Mono.Addins.Database.IAssemblyReflector.GetTypeFullName(System.Object)">
  2409. <summary>
  2410. Gets the full name of a type (including namespace)
  2411. </summary>
  2412. <returns>
  2413. The full name of the type
  2414. </returns>
  2415. <param name='type'>
  2416. A type
  2417. </param>
  2418. </member>
  2419. <member name="M:Mono.Addins.Database.IAssemblyReflector.GetTypeAssemblyQualifiedName(System.Object)">
  2420. <summary>
  2421. Gets the assembly qualified name of a type
  2422. </summary>
  2423. <returns>
  2424. The assembly qualified type name
  2425. </returns>
  2426. <param name='type'>
  2427. A type
  2428. </param>
  2429. </member>
  2430. <member name="M:Mono.Addins.Database.IAssemblyReflector.GetBaseTypeFullNameList(System.Object)">
  2431. <summary>
  2432. Gets a list of all base types (including interfaces) of a type
  2433. </summary>
  2434. <returns>
  2435. An enumeration of the full name of all base types of the type
  2436. </returns>
  2437. <param name='type'>
  2438. A type
  2439. </param>
  2440. </member>
  2441. <member name="M:Mono.Addins.Database.IAssemblyReflector.TypeIsAssignableFrom(System.Object,System.Object)">
  2442. <summary>
  2443. Checks if a type is assignable to another type
  2444. </summary>
  2445. <returns>
  2446. 'true' if the type is assignable
  2447. </returns>
  2448. <param name='baseType'>
  2449. Expected base type.
  2450. </param>
  2451. <param name='type'>
  2452. A type.
  2453. </param>
  2454. </member>
  2455. <member name="M:Mono.Addins.Database.IAssemblyReflector.GetFields(System.Object)">
  2456. <summary>
  2457. Gets the fields of a type
  2458. </summary>
  2459. <returns>
  2460. The fields.
  2461. </returns>
  2462. <param name='type'>
  2463. A type
  2464. </param>
  2465. </member>
  2466. <member name="M:Mono.Addins.Database.IAssemblyReflector.GetFieldName(System.Object)">
  2467. <summary>
  2468. Gets the name of a field.
  2469. </summary>
  2470. <returns>
  2471. The field name.
  2472. </returns>
  2473. <param name='field'>
  2474. A field.
  2475. </param>
  2476. </member>
  2477. <member name="M:Mono.Addins.Database.IAssemblyReflector.GetFieldTypeFullName(System.Object)">
  2478. <summary>
  2479. Gets the full name of the type of a field
  2480. </summary>
  2481. <returns>
  2482. The full type name
  2483. </returns>
  2484. <param name='field'>
  2485. A field.
  2486. </param>
  2487. </member>
  2488. <member name="T:Mono.Addins.Database.CustomAttribute">
  2489. <summary>
  2490. A custom attribute
  2491. </summary>
  2492. </member>
  2493. <member name="P:Mono.Addins.Database.CustomAttribute.TypeName">
  2494. <summary>
  2495. Full name of the type of the custom attribute
  2496. </summary>
  2497. </member>
  2498. <member name="T:Mono.Addins.TypeExtensionPointAttribute">
  2499. <summary>
  2500. Declares an extension point bound to a type
  2501. </summary>
  2502. </member>
  2503. <member name="M:Mono.Addins.TypeExtensionPointAttribute.#ctor">
  2504. <summary>
  2505. Initializes a new instance
  2506. </summary>
  2507. </member>
  2508. <member name="M:Mono.Addins.TypeExtensionPointAttribute.#ctor(System.String)">
  2509. <summary>
  2510. Initializes a new instance
  2511. </summary>
  2512. <param name="path">
  2513. Path that identifies the extension point
  2514. </param>
  2515. </member>
  2516. <member name="P:Mono.Addins.TypeExtensionPointAttribute.Path">
  2517. <summary>
  2518. Path that identifies the extension point
  2519. </summary>
  2520. </member>
  2521. <member name="P:Mono.Addins.TypeExtensionPointAttribute.Description">
  2522. <summary>
  2523. Description of the extension point.
  2524. </summary>
  2525. </member>
  2526. <member name="P:Mono.Addins.TypeExtensionPointAttribute.NodeName">
  2527. <summary>
  2528. Element name to be used when defining an extension in an XML manifest. The default name is "Type".
  2529. </summary>
  2530. </member>
  2531. <member name="P:Mono.Addins.TypeExtensionPointAttribute.Name">
  2532. <summary>
  2533. Display name of the extension point.
  2534. </summary>
  2535. </member>
  2536. <member name="P:Mono.Addins.TypeExtensionPointAttribute.NodeType">
  2537. <summary>
  2538. Type of the extension node to be created for extensions
  2539. </summary>
  2540. </member>
  2541. <member name="P:Mono.Addins.TypeExtensionPointAttribute.ExtensionAttributeType">
  2542. <summary>
  2543. Type of the custom attribute to be used to specify metadata for the extension point
  2544. </summary>
  2545. </member>
  2546. <member name="T:Mono.Addins.Description.AddinFlags">
  2547. <summary>
  2548. Add-in flags
  2549. </summary>
  2550. </member>
  2551. <member name="F:Mono.Addins.Description.AddinFlags.None">
  2552. <summary>
  2553. No flags
  2554. </summary>
  2555. </member>
  2556. <member name="F:Mono.Addins.Description.AddinFlags.CantUninstall">
  2557. <summary>
  2558. The add-in can't be uninstalled
  2559. </summary>
  2560. </member>
  2561. <member name="F:Mono.Addins.Description.AddinFlags.CantDisable">
  2562. <summary>
  2563. The add-in can't be disabled
  2564. </summary>
  2565. </member>
  2566. <member name="F:Mono.Addins.Description.AddinFlags.Hidden">
  2567. <summary>
  2568. The add-in is not visible to end users
  2569. </summary>
  2570. </member>
  2571. <member name="T:Mono.Addins.Description.ExtensionCollection">
  2572. <summary>
  2573. A collection of extensions
  2574. </summary>
  2575. </member>
  2576. <member name="M:Mono.Addins.Description.ExtensionCollection.#ctor">
  2577. <summary>
  2578. Initializes a new instance of the <see cref="T:Mono.Addins.Description.ExtensionCollection"/> class.
  2579. </summary>
  2580. </member>
  2581. <member name="P:Mono.Addins.Description.ExtensionCollection.Item(System.Int32)">
  2582. <summary>
  2583. Gets the <see cref="T:Mono.Addins.Description.Extension"/> at the specified index.
  2584. </summary>
  2585. <param name="n">
  2586. The index.
  2587. </param>
  2588. </member>
  2589. <member name="T:Mono.Addins.InstanceExtensionNode">
  2590. <summary>
  2591. Base class for extension nodes which create extension objects
  2592. </summary>
  2593. </member>
  2594. <member name="T:Mono.Addins.ExtensionNode">
  2595. <summary>
  2596. A node of the extension model.
  2597. </summary>
  2598. <remarks>
  2599. An extension node is an element registered by an add-in in an extension point.
  2600. A host can get nodes registered in an extension point using methods such as
  2601. AddinManager.GetExtensionNodes(string), which returns a collection of ExtensionNode objects.
  2602. ExtensionNode will normally be used as a base class of more complex extension point types.
  2603. The most common subclass is Mono.Addins.TypeExtensionNode, which allows registering a class
  2604. implemented in an add-in.
  2605. </remarks>
  2606. </member>
  2607. <member name="M:Mono.Addins.ExtensionNode.GetChildObjects">
  2608. <summary>
  2609. Returns the child objects of a node.
  2610. </summary>
  2611. <returns>
  2612. An array of child objects.
  2613. </returns>
  2614. <remarks>
  2615. This method only works if all children of this node are of type Mono.Addins.TypeExtensionNode.
  2616. The returned array is composed by all objects created by calling the
  2617. TypeExtensionNode.GetInstance() method for each node.
  2618. </remarks>
  2619. </member>
  2620. <member name="M:Mono.Addins.ExtensionNode.GetChildObjects(System.Boolean)">
  2621. <summary>
  2622. Returns the child objects of a node.
  2623. </summary>
  2624. <param name="reuseCachedInstance">
  2625. True if the method can reuse instances created in previous calls.
  2626. </param>
  2627. <returns>
  2628. An array of child objects.
  2629. </returns>
  2630. <remarks>
  2631. This method only works if all children of this node are of type Mono.Addins.TypeExtensionNode.
  2632. The returned array is composed by all objects created by calling the TypeExtensionNode.CreateInstance()
  2633. method for each node (or TypeExtensionNode.GetInstance() if reuseCachedInstance is set to true).
  2634. </remarks>
  2635. </member>
  2636. <member name="M:Mono.Addins.ExtensionNode.GetChildObjects(System.Type)">
  2637. <summary>
  2638. Returns the child objects of a node (with type check).
  2639. </summary>
  2640. <param name="arrayElementType">
  2641. Type of the return array elements.
  2642. </param>
  2643. <returns>
  2644. An array of child objects.
  2645. </returns>
  2646. <remarks>
  2647. This method only works if all children of this node are of type Mono.Addins.TypeExtensionNode.
  2648. The returned array is composed by all objects created by calling the
  2649. TypeExtensionNode.GetInstance(Type) method for each node.
  2650. An InvalidOperationException exception is thrown if one of the found child objects is not a
  2651. subclass of the provided type.
  2652. </remarks>
  2653. </member>
  2654. <member name="M:Mono.Addins.ExtensionNode.GetChildObjects``1">
  2655. <summary>
  2656. Returns the child objects of a node (casting to the specified type)
  2657. </summary>
  2658. <returns>
  2659. An array of child objects.
  2660. </returns>
  2661. <remarks>
  2662. This method only works if all children of this node are of type Mono.Addins.TypeExtensionNode.
  2663. The returned array is composed by all objects created by calling the
  2664. TypeExtensionNode.GetInstance() method for each node.
  2665. </remarks>
  2666. </member>
  2667. <member name="M:Mono.Addins.ExtensionNode.GetChildObjects(System.Type,System.Boolean)">
  2668. <summary>
  2669. Returns the child objects of a node (with type check).
  2670. </summary>
  2671. <param name="arrayElementType">
  2672. Type of the return array elements.
  2673. </param>
  2674. <param name="reuseCachedInstance">
  2675. True if the method can reuse instances created in previous calls.
  2676. </param>
  2677. <returns>
  2678. An array of child objects.
  2679. </returns>
  2680. <remarks>
  2681. This method only works if all children of this node are of type Mono.Addins.TypeExtensionNode.
  2682. The returned array is composed by all objects created by calling the TypeExtensionNode.CreateInstance(Type)
  2683. method for each node (or TypeExtensionNode.GetInstance(Type) if reuseCachedInstance is set to true).
  2684. An InvalidOperationException exception will be thrown if one of the found child objects is not a subclass
  2685. of the provided type.
  2686. </remarks>
  2687. </member>
  2688. <member name="M:Mono.Addins.ExtensionNode.GetChildObjects``1(System.Boolean)">
  2689. <summary>
  2690. Returns the child objects of a node (casting to the specified type).
  2691. </summary>
  2692. <param name="reuseCachedInstance">
  2693. True if the method can reuse instances created in previous calls.
  2694. </param>
  2695. <returns>
  2696. An array of child objects.
  2697. </returns>
  2698. <remarks>
  2699. This method only works if all children of this node are of type Mono.Addins.TypeExtensionNode.
  2700. The returned array is composed by all objects created by calling the TypeExtensionNode.CreateInstance()
  2701. method for each node (or TypeExtensionNode.GetInstance() if reuseCachedInstance is set to true).
  2702. </remarks>
  2703. </member>
  2704. <member name="M:Mono.Addins.ExtensionNode.Read(Mono.Addins.NodeElement)">
  2705. <summary>
  2706. Reads the extension node data
  2707. </summary>
  2708. <param name='elem'>
  2709. The element containing the extension data
  2710. </param>
  2711. <remarks>
  2712. This method can be overriden to provide a custom method for reading extension node data from an element.
  2713. The default implementation reads the attributes if the element and assigns the values to the fields
  2714. and properties of the extension node that have the corresponding [NodeAttribute] decoration.
  2715. </remarks>
  2716. </member>
  2717. <member name="M:Mono.Addins.ExtensionNode.OnAddinLoaded">
  2718. <summary>
  2719. Called when the add-in that defined this extension node is actually loaded in memory.
  2720. </summary>
  2721. </member>
  2722. <member name="M:Mono.Addins.ExtensionNode.OnAddinUnloaded">
  2723. <summary>
  2724. Called when the add-in that defined this extension node is being
  2725. unloaded from memory.
  2726. </summary>
  2727. </member>
  2728. <member name="M:Mono.Addins.ExtensionNode.OnChildrenChanged">
  2729. <summary>
  2730. Called when the children list of this node has changed. It may be due to add-ins
  2731. being loaded/unloaded, or to conditions being changed.
  2732. </summary>
  2733. </member>
  2734. <member name="M:Mono.Addins.ExtensionNode.OnChildNodeAdded(Mono.Addins.ExtensionNode)">
  2735. <summary>
  2736. Called when a child node is added
  2737. </summary>
  2738. <param name="node">
  2739. Added node.
  2740. </param>
  2741. </member>
  2742. <member name="M:Mono.Addins.ExtensionNode.OnChildNodeRemoved(Mono.Addins.ExtensionNode)">
  2743. <summary>
  2744. Called when a child node is removed
  2745. </summary>
  2746. <param name="node">
  2747. Removed node.
  2748. </param>
  2749. </member>
  2750. <member name="P:Mono.Addins.ExtensionNode.Id">
  2751. <summary>
  2752. Identifier of the node.
  2753. </summary>
  2754. <remarks>
  2755. It is not mandatory to specify an 'id' for a node. When none is provided,
  2756. the add-in manager will automatically generate an unique id for the node.
  2757. The ExtensionNode.HasId property can be used to know if the 'id' has been
  2758. specified by the developer or not.
  2759. </remarks>
  2760. </member>
  2761. <member name="P:Mono.Addins.ExtensionNode.Path">
  2762. <summary>
  2763. Location of this node in the extension tree.
  2764. </summary>
  2765. <remarks>
  2766. The node path is composed by the path of the extension point where it is defined,
  2767. the identifiers of its parent nodes, and its own identifier.
  2768. </remarks>
  2769. </member>
  2770. <member name="P:Mono.Addins.ExtensionNode.Parent">
  2771. <summary>
  2772. Parent node of this node.
  2773. </summary>
  2774. </member>
  2775. <member name="P:Mono.Addins.ExtensionNode.ExtensionContext">
  2776. <summary>
  2777. Extension context to which this node belongs
  2778. </summary>
  2779. </member>
  2780. <member name="P:Mono.Addins.ExtensionNode.HasId">
  2781. <summary>
  2782. Specifies whether the extension node has as an Id or not.
  2783. </summary>
  2784. <remarks>
  2785. It is not mandatory to specify an 'id' for a node. When none is provided,
  2786. the add-in manager will automatically generate an unique id for the node.
  2787. This property will return true if an 'id' was provided for the node, and
  2788. false if the id was assigned by the add-in manager.
  2789. </remarks>
  2790. </member>
  2791. <member name="P:Mono.Addins.ExtensionNode.Addin">
  2792. <summary>
  2793. The add-in that registered this extension node.
  2794. </summary>
  2795. <remarks>
  2796. This property provides access to the resources and types of the add-in that created this extension node.
  2797. </remarks>
  2798. </member>
  2799. <member name="E:Mono.Addins.ExtensionNode.ExtensionNodeChanged">
  2800. <summary>
  2801. Notifies that a child node of this node has been added or removed.
  2802. </summary>
  2803. <remarks>
  2804. The first time the event is subscribed, the handler will be called for each existing node.
  2805. </remarks>
  2806. </member>
  2807. <member name="P:Mono.Addins.ExtensionNode.ChildNodes">
  2808. <summary>
  2809. Child nodes of this extension node.
  2810. </summary>
  2811. </member>
  2812. <member name="M:Mono.Addins.InstanceExtensionNode.GetInstance(System.Type)">
  2813. <summary>
  2814. Gets the extension object declared by this node
  2815. </summary>
  2816. <param name="expectedType">
  2817. Expected object type. An exception will be thrown if the object is not an instance of the specified type.
  2818. </param>
  2819. <returns>
  2820. The extension object
  2821. </returns>
  2822. <remarks>
  2823. The extension object is cached and the same instance will be returned at every call.
  2824. </remarks>
  2825. </member>
  2826. <member name="M:Mono.Addins.InstanceExtensionNode.GetInstance">
  2827. <summary>
  2828. Gets the extension object declared by this node
  2829. </summary>
  2830. <returns>
  2831. The extension object
  2832. </returns>
  2833. <remarks>
  2834. The extension object is cached and the same instance will be returned at every call.
  2835. </remarks>
  2836. </member>
  2837. <member name="M:Mono.Addins.InstanceExtensionNode.CreateInstance(System.Type)">
  2838. <summary>
  2839. Creates a new extension object
  2840. </summary>
  2841. <param name="expectedType">
  2842. Expected object type. An exception will be thrown if the object is not an instance of the specified type.
  2843. </param>
  2844. <returns>
  2845. The extension object
  2846. </returns>
  2847. </member>
  2848. <member name="M:Mono.Addins.InstanceExtensionNode.CreateInstance">
  2849. <summary>
  2850. Creates a new extension object
  2851. </summary>
  2852. <returns>
  2853. The extension object
  2854. </returns>
  2855. </member>
  2856. <member name="T:Mono.Addins.AddinDependencyAttribute">
  2857. <summary>
  2858. Declares a dependency on an add-in or add-in host
  2859. </summary>
  2860. </member>
  2861. <member name="M:Mono.Addins.AddinDependencyAttribute.#ctor(System.String,System.String)">
  2862. <summary>
  2863. Initializes the attribute
  2864. </summary>
  2865. <param name="id">
  2866. Identifier of the add-in
  2867. </param>
  2868. <param name="version">
  2869. Version of the add-in
  2870. </param>
  2871. </member>
  2872. <member name="P:Mono.Addins.AddinDependencyAttribute.Id">
  2873. <summary>
  2874. Identifier of the add-in
  2875. </summary>
  2876. </member>
  2877. <member name="P:Mono.Addins.AddinDependencyAttribute.Version">
  2878. <summary>
  2879. Version of the add-in
  2880. </summary>
  2881. </member>
  2882. <member name="T:Mono.Addins.ExtensionNode`1">
  2883. <summary>
  2884. An extension node with custom metadata
  2885. </summary>
  2886. <remarks>
  2887. This is the default type for extension nodes bound to a custom extension attribute.
  2888. </remarks>
  2889. </member>
  2890. <member name="T:Mono.Addins.IAttributedExtensionNode">
  2891. <summary>
  2892. An extension node with custom metadata provided by an attribute
  2893. </summary>
  2894. <remarks>
  2895. This interface is implemented by ExtensionNode&lt;T&gt; to provide non-generic access to the attribute instance.
  2896. </remarks>
  2897. </member>
  2898. <member name="P:Mono.Addins.IAttributedExtensionNode.Attribute">
  2899. <summary>
  2900. The custom attribute containing the extension metadata
  2901. </summary>
  2902. </member>
  2903. <member name="P:Mono.Addins.ExtensionNode`1.Data">
  2904. <summary>
  2905. The custom attribute containing the extension metadata
  2906. </summary>
  2907. </member>
  2908. <member name="T:Mono.Addins.AddinPropertyAttribute">
  2909. <summary>
  2910. Defines an add-in property
  2911. </summary>
  2912. </member>
  2913. <member name="M:Mono.Addins.AddinPropertyAttribute.#ctor(System.String,System.String)">
  2914. <summary>
  2915. Initializes a new instance of the <see cref="T:Mono.Addins.AddinPropertyAttribute"/> class.
  2916. </summary>
  2917. <param name="name">
  2918. Name of the property
  2919. </param>
  2920. <param name="value">
  2921. Value of the property
  2922. </param>
  2923. </member>
  2924. <member name="M:Mono.Addins.AddinPropertyAttribute.#ctor(System.String,System.String,System.String)">
  2925. <summary>
  2926. Initializes a new instance of the <see cref="T:Mono.Addins.AddinPropertyAttribute"/> class.
  2927. </summary>
  2928. <param name="name">
  2929. Name of the property
  2930. </param>
  2931. <param name="locale">
  2932. Locale of the property. It can be null if the property is not bound to a locale.
  2933. </param>
  2934. <param name="value">
  2935. Value of the property
  2936. </param>
  2937. </member>
  2938. <member name="P:Mono.Addins.AddinPropertyAttribute.Name">
  2939. <summary>
  2940. Name of the property
  2941. </summary>
  2942. </member>
  2943. <member name="P:Mono.Addins.AddinPropertyAttribute.Locale">
  2944. <summary>
  2945. Locale of the property. It can be null if the property is not bound to a locale.
  2946. </summary>
  2947. </member>
  2948. <member name="P:Mono.Addins.AddinPropertyAttribute.Value">
  2949. <summary>
  2950. Value of the property
  2951. </summary>
  2952. </member>
  2953. <member name="T:Mono.Addins.CustomExtensionAttribute">
  2954. <summary>
  2955. Base class for custon extension attributes.
  2956. </summary>
  2957. <remarks>
  2958. Custom extension attributes can be used to declare extensions with custom metadata.
  2959. All custom extension attributes must subclass CustomExtensionAttribute.
  2960. </remarks>
  2961. </member>
  2962. <member name="P:Mono.Addins.CustomExtensionAttribute.Id">
  2963. <summary>
  2964. Identifier of the node
  2965. </summary>
  2966. </member>
  2967. <member name="P:Mono.Addins.CustomExtensionAttribute.InsertBefore">
  2968. <summary>
  2969. Identifier of the node before which this node has to be placed
  2970. </summary>
  2971. </member>
  2972. <member name="P:Mono.Addins.CustomExtensionAttribute.InsertAfter">
  2973. <summary>
  2974. Identifier of the node after which this node has to be placed
  2975. </summary>
  2976. </member>
  2977. <member name="P:Mono.Addins.CustomExtensionAttribute.Path">
  2978. <summary>
  2979. Path of the extension point being extended.
  2980. </summary>
  2981. <remarks>
  2982. This property is optional and useful only when there are several extension points which allow
  2983. using this custom attribute to define extensions.
  2984. </remarks>
  2985. </member>
  2986. <member name="P:Mono.Addins.CustomExtensionAttribute.ExtensionNode">
  2987. <summary>
  2988. The extension node bound to this attribute
  2989. </summary>
  2990. </member>
  2991. <member name="P:Mono.Addins.CustomExtensionAttribute.Addin">
  2992. <summary>
  2993. The add-in that registered this extension node.
  2994. </summary>
  2995. <remarks>
  2996. This property provides access to the resources and types of the add-in that created this extension node.
  2997. </remarks>
  2998. </member>
  2999. <member name="T:Mono.Addins.Localization.IPluralAddinLocalizer">
  3000. <summary>
  3001. A localizer that supports localization of plural forms.
  3002. </summary>
  3003. <remarks>
  3004. This interface can be implemented by add-in localizers which want to provide
  3005. support plural forms.
  3006. </remarks>
  3007. </member>
  3008. <member name="M:Mono.Addins.Localization.IPluralAddinLocalizer.GetPluralString(System.String,System.String,System.Int32)">
  3009. <summary>
  3010. Gets a localized message which may contain plural forms.
  3011. </summary>
  3012. <returns>
  3013. The localized message.
  3014. </returns>
  3015. <param name='singular'>
  3016. Message identifier to use when the specified count is 1.
  3017. </param>
  3018. <param name='defaultPlural'>
  3019. Default message identifier to use when the specified count is not 1.
  3020. </param>
  3021. <param name='n'>
  3022. The count that determines which plural form to use.
  3023. </param>
  3024. </member>
  3025. <member name="T:Mono.Addins.AddinLocalizer">
  3026. <summary>
  3027. Converts message identifiers to localized messages.
  3028. </summary>
  3029. </member>
  3030. <member name="M:Mono.Addins.AddinLocalizer.GetString(System.String)">
  3031. <summary>
  3032. Gets a localized message
  3033. </summary>
  3034. <param name="msgid">
  3035. Message identifier
  3036. </param>
  3037. <returns>
  3038. The localized message
  3039. </returns>
  3040. </member>
  3041. <member name="M:Mono.Addins.AddinLocalizer.GetString(System.String,System.String[])">
  3042. <summary>
  3043. Gets a formatted and localized message
  3044. </summary>
  3045. <param name="msgid">
  3046. Message identifier (can contain string format placeholders)
  3047. </param>
  3048. <param name="args">
  3049. Arguments for the string format operation
  3050. </param>
  3051. <returns>
  3052. The formatted and localized string
  3053. </returns>
  3054. </member>
  3055. <member name="M:Mono.Addins.AddinLocalizer.GetString(System.String,System.Object[])">
  3056. <summary>
  3057. Gets a formatted and localized message
  3058. </summary>
  3059. <param name="msgid">
  3060. Message identifier (can contain string format placeholders)
  3061. </param>
  3062. <param name="args">
  3063. Arguments for the string format operation
  3064. </param>
  3065. <returns>
  3066. The formatted and localized string
  3067. </returns>
  3068. </member>
  3069. <member name="M:Mono.Addins.AddinLocalizer.GetPluralString(System.String,System.String,System.Int32)">
  3070. <summary>
  3071. Gets a localized plural form for a message identifier
  3072. </summary>
  3073. <param name="msgid">
  3074. Message identifier for the singular form
  3075. </param>
  3076. <param name="defaultPlural">
  3077. Default result message for the plural form
  3078. </param>
  3079. <param name="n">
  3080. Value count. Determines wether to use singular or plural form.
  3081. </param>
  3082. <returns>
  3083. The localized message
  3084. </returns>
  3085. </member>
  3086. <member name="M:Mono.Addins.AddinLocalizer.GetPluralString(System.String,System.String,System.Int32,System.String[])">
  3087. <summary>
  3088. Gets a localized and formatted plural form for a message identifier
  3089. </summary>
  3090. <param name="singular">
  3091. Message identifier for the singular form (can contain string format placeholders)
  3092. </param>
  3093. <param name="defaultPlural">
  3094. Default result message for the plural form (can contain string format placeholders)
  3095. </param>
  3096. <param name="n">
  3097. Value count. Determines whether to use singular or plural form.
  3098. </param>
  3099. <param name="args">
  3100. Arguments for the string format operation
  3101. </param>
  3102. <returns>
  3103. The localized message
  3104. </returns>
  3105. </member>
  3106. <member name="M:Mono.Addins.AddinLocalizer.GetPluralString(System.String,System.String,System.Int32,System.Object[])">
  3107. <summary>
  3108. Gets a localized and formatted plural form for a message identifier
  3109. </summary>
  3110. <param name="singular">
  3111. Message identifier for the singular form (can contain string format placeholders)
  3112. </param>
  3113. <param name="defaultPlural">
  3114. Default result message for the plural form (can contain string format placeholders)
  3115. </param>
  3116. <param name="n">
  3117. Value count. Determines whether to use singular or plural form.
  3118. </param>
  3119. <param name="args">
  3120. Arguments for the string format operation
  3121. </param>
  3122. <returns>
  3123. The localized message
  3124. </returns>
  3125. </member>
  3126. <member name="T:Mono.Addins.Description.ExtensionPointCollection">
  3127. <summary>
  3128. A collection of extension point definitions.
  3129. </summary>
  3130. </member>
  3131. <member name="M:Mono.Addins.Description.ExtensionPointCollection.#ctor">
  3132. <summary>
  3133. Initializes a new instance of the <see cref="T:Mono.Addins.Description.ExtensionPointCollection"/> class.
  3134. </summary>
  3135. </member>
  3136. <member name="P:Mono.Addins.Description.ExtensionPointCollection.Item(System.Int32)">
  3137. <summary>
  3138. Gets the <see cref="T:Mono.Addins.Description.ExtensionPoint"/> at the specified index.
  3139. </summary>
  3140. <param name="n">
  3141. The index.
  3142. </param>
  3143. </member>
  3144. <member name="P:Mono.Addins.Description.ExtensionPointCollection.Item(System.String)">
  3145. <summary>
  3146. Gets the <see cref="T:Mono.Addins.Description.ExtensionPoint"/> with the specified path.
  3147. </summary>
  3148. <param name="path">
  3149. Path.
  3150. </param>
  3151. </member>
  3152. <member name="T:Mono.Addins.AddinLocalizerGettextAttribute">
  3153. <summary>
  3154. Declares a Gettext-based localizer for an add-in
  3155. </summary>
  3156. </member>
  3157. <member name="M:Mono.Addins.AddinLocalizerGettextAttribute.#ctor">
  3158. <summary>
  3159. Initializes a new instance of the <see cref="T:Mono.Addins.AddinLocalizerGettextAttribute"/> class.
  3160. </summary>
  3161. </member>
  3162. <member name="M:Mono.Addins.AddinLocalizerGettextAttribute.#ctor(System.String)">
  3163. <summary>
  3164. Initializes a new instance of the <see cref="T:Mono.Addins.AddinLocalizerGettextAttribute"/> class.
  3165. </summary>
  3166. <param name="catalog">
  3167. Name of the catalog which contains the strings.
  3168. </param>
  3169. </member>
  3170. <member name="M:Mono.Addins.AddinLocalizerGettextAttribute.#ctor(System.String,System.String)">
  3171. <summary>
  3172. Initializes a new instance of the <see cref="T:Mono.Addins.AddinLocalizerGettextAttribute"/> class.
  3173. </summary>
  3174. <param name="catalog">
  3175. Name of the catalog which contains the strings.
  3176. </param>
  3177. <param name="location">
  3178. Relative path to the location of the catalog. This path must be relative to the add-in location.
  3179. </param>
  3180. <remarks>
  3181. The location path must contain a directory structure like this:
  3182. {language-id}/LC_MESSAGES/{Catalog}.mo
  3183. For example, the catalog for spanish strings would be located at:
  3184. locale/es/LC_MESSAGES/some-addin.mo
  3185. </remarks>
  3186. </member>
  3187. <member name="P:Mono.Addins.AddinLocalizerGettextAttribute.Catalog">
  3188. <summary>
  3189. Name of the catalog which contains the strings.
  3190. </summary>
  3191. </member>
  3192. <member name="P:Mono.Addins.AddinLocalizerGettextAttribute.Location">
  3193. <summary>
  3194. Relative path to the location of the catalog. This path must be relative to the add-in location.
  3195. </summary>
  3196. <remarks>
  3197. When not specified, the default value of this property is 'locale'.
  3198. The location path must contain a directory structure like this:
  3199. {language-id}/LC_MESSAGES/{Catalog}.mo
  3200. For example, the catalog for spanish strings would be located at:
  3201. locale/es/LC_MESSAGES/some-addin.mo
  3202. </remarks>
  3203. </member>
  3204. <member name="T:Mono.Addins.AddinAuthorAttribute">
  3205. <summary>
  3206. Declares an author of the add-in
  3207. </summary>
  3208. </member>
  3209. <member name="M:Mono.Addins.AddinAuthorAttribute.#ctor(System.String)">
  3210. <summary>
  3211. Initializes the attribute
  3212. </summary>
  3213. <param name="name">
  3214. Name of the author
  3215. </param>
  3216. </member>
  3217. <member name="P:Mono.Addins.AddinAuthorAttribute.Name">
  3218. <summary>
  3219. Author name
  3220. </summary>
  3221. </member>
  3222. <member name="T:Mono.Addins.Description.ConditionTypeDescription">
  3223. <summary>
  3224. A condition type definition.
  3225. </summary>
  3226. </member>
  3227. <member name="M:Mono.Addins.Description.ConditionTypeDescription.#ctor">
  3228. <summary>
  3229. Initializes a new instance of the <see cref="T:Mono.Addins.Description.ConditionTypeDescription"/> class.
  3230. </summary>
  3231. </member>
  3232. <member name="M:Mono.Addins.Description.ConditionTypeDescription.CopyFrom(Mono.Addins.Description.ConditionTypeDescription)">
  3233. <summary>
  3234. Copies data from another condition type definition
  3235. </summary>
  3236. <param name='cond'>
  3237. Condition from which to copy
  3238. </param>
  3239. </member>
  3240. <member name="P:Mono.Addins.Description.ConditionTypeDescription.Id">
  3241. <summary>
  3242. Gets or sets the identifier of the condition type
  3243. </summary>
  3244. <value>
  3245. The identifier.
  3246. </value>
  3247. </member>
  3248. <member name="P:Mono.Addins.Description.ConditionTypeDescription.TypeName">
  3249. <summary>
  3250. Gets or sets the name of the type that implements the condition
  3251. </summary>
  3252. <value>
  3253. The name of the type.
  3254. </value>
  3255. </member>
  3256. <member name="P:Mono.Addins.Description.ConditionTypeDescription.Description">
  3257. <summary>
  3258. Gets or sets the description of the condition.
  3259. </summary>
  3260. <value>
  3261. The description.
  3262. </value>
  3263. </member>
  3264. <member name="T:Mono.Addins.Description.ExtensionPoint">
  3265. <summary>
  3266. An extension point definition.
  3267. </summary>
  3268. </member>
  3269. <member name="M:Mono.Addins.Description.ExtensionPoint.#ctor">
  3270. <summary>
  3271. Initializes a new instance of the <see cref="T:Mono.Addins.Description.ExtensionPoint"/> class.
  3272. </summary>
  3273. </member>
  3274. <member name="M:Mono.Addins.Description.ExtensionPoint.CopyFrom(Mono.Addins.Description.ExtensionPoint)">
  3275. <summary>
  3276. Copies another extension point.
  3277. </summary>
  3278. <param name='ep'>
  3279. Extension point from which to copy.
  3280. </param>
  3281. </member>
  3282. <member name="M:Mono.Addins.Description.ExtensionPoint.AddExtensionNode(System.String,System.String)">
  3283. <summary>
  3284. Adds an extension node type.
  3285. </summary>
  3286. <returns>
  3287. The extension node type.
  3288. </returns>
  3289. <param name='name'>
  3290. Name of the node
  3291. </param>
  3292. <param name='typeName'>
  3293. Name of the type that implements the extension node.
  3294. </param>
  3295. <remarks>
  3296. This method can be used to register a new allowed node type for the extension point.
  3297. </remarks>
  3298. </member>
  3299. <member name="P:Mono.Addins.Description.ExtensionPoint.Path">
  3300. <summary>
  3301. Gets or sets the path that identifies the extension point.
  3302. </summary>
  3303. <value>
  3304. The path.
  3305. </value>
  3306. </member>
  3307. <member name="P:Mono.Addins.Description.ExtensionPoint.Name">
  3308. <summary>
  3309. Gets or sets the display name of the extension point.
  3310. </summary>
  3311. <value>
  3312. The name.
  3313. </value>
  3314. </member>
  3315. <member name="P:Mono.Addins.Description.ExtensionPoint.Description">
  3316. <summary>
  3317. Gets or sets the description of the extension point.
  3318. </summary>
  3319. <value>
  3320. The description.
  3321. </value>
  3322. </member>
  3323. <member name="P:Mono.Addins.Description.ExtensionPoint.ExtenderAddins">
  3324. <summary>
  3325. Gets a list of add-ins that extend this extension point.
  3326. </summary>
  3327. <remarks>
  3328. This value is only available when the add-in description is loaded from an add-in registry.
  3329. </remarks>
  3330. </member>
  3331. <member name="P:Mono.Addins.Description.ExtensionPoint.NodeSet">
  3332. <summary>
  3333. A node set which specifies the node types allowed in this extension point.
  3334. </summary>
  3335. <value>
  3336. The node set.
  3337. </value>
  3338. </member>
  3339. <member name="P:Mono.Addins.Description.ExtensionPoint.Conditions">
  3340. <summary>
  3341. Gets the conditions available in this node set.
  3342. </summary>
  3343. <value>
  3344. The conditions.
  3345. </value>
  3346. </member>
  3347. <member name="T:Mono.Addins.ConditionType">
  3348. <summary>
  3349. A condition evaluator.
  3350. </summary>
  3351. <remarks>
  3352. Add-ins may use conditions to register nodes in an extension point which
  3353. are only visible under some contexts. For example, an add-in registering
  3354. a custom menu option to the main menu of a sample text editor might want
  3355. to make that option visible only for some kind of files. To allow add-ins
  3356. to do this kind of check, the host application needs to define a new condition.
  3357. </remarks>
  3358. </member>
  3359. <member name="M:Mono.Addins.ConditionType.Evaluate(Mono.Addins.NodeElement)">
  3360. <summary>
  3361. Evaluates the condition.
  3362. </summary>
  3363. <param name="conditionNode">
  3364. Condition node information.
  3365. </param>
  3366. <returns>
  3367. 'true' if the condition is satisfied.
  3368. </returns>
  3369. </member>
  3370. <member name="M:Mono.Addins.ConditionType.NotifyChanged">
  3371. <summary>
  3372. Notifies that the condition has changed, and that it has to be re-evaluated.
  3373. </summary>
  3374. This method must be called when there is a change in the state that determines
  3375. the result of the evaluation. When this method is called, all node conditions
  3376. depending on it are reevaluated and the corresponding events for adding or
  3377. removing extension nodes are fired.
  3378. <remarks>
  3379. </remarks>
  3380. </member>
  3381. <member name="T:Mono.Addins.ExtensionNodeList">
  3382. <summary>
  3383. A list of extension nodes.
  3384. </summary>
  3385. </member>
  3386. <member name="M:Mono.Addins.ExtensionNodeList.GetEnumerator">
  3387. <summary>
  3388. Gets an enumerator which enumerates all nodes in the list
  3389. </summary>
  3390. </member>
  3391. <member name="M:Mono.Addins.ExtensionNodeList.CopyTo(Mono.Addins.ExtensionNode[],System.Int32)">
  3392. <summary>
  3393. Copies all nodes to an array
  3394. </summary>
  3395. <param name='array'>
  3396. The target array
  3397. </param>
  3398. <param name='index'>
  3399. Initial index where to copy to
  3400. </param>
  3401. </member>
  3402. <member name="P:Mono.Addins.ExtensionNodeList.Item(System.Int32)">
  3403. <summary>
  3404. Returns the node in the specified index.
  3405. </summary>
  3406. <param name="n">
  3407. The index.
  3408. </param>
  3409. </member>
  3410. <member name="P:Mono.Addins.ExtensionNodeList.Item(System.String)">
  3411. <summary>
  3412. Returns the node with the specified ID.
  3413. </summary>
  3414. <param name="id">
  3415. An id.
  3416. </param>
  3417. </member>
  3418. <member name="P:Mono.Addins.ExtensionNodeList.Count">
  3419. <summary>
  3420. Number of nodes of the collection.
  3421. </summary>
  3422. </member>
  3423. <member name="T:Mono.Addins.ExtensionNodeList`1">
  3424. <summary>
  3425. A list of extension nodes.
  3426. </summary>
  3427. </member>
  3428. <member name="M:Mono.Addins.ExtensionNodeList`1.GetEnumerator">
  3429. <summary>
  3430. Gets an enumerator which enumerates all nodes in the list
  3431. </summary>
  3432. </member>
  3433. <member name="M:Mono.Addins.ExtensionNodeList`1.CopyTo(`0[],System.Int32)">
  3434. <summary>
  3435. Copies all nodes to an array
  3436. </summary>
  3437. <param name='array'>
  3438. The target array
  3439. </param>
  3440. <param name='index'>
  3441. Initial index where to copy to
  3442. </param>
  3443. </member>
  3444. <member name="P:Mono.Addins.ExtensionNodeList`1.Item(System.Int32)">
  3445. <summary>
  3446. Returns the node in the specified index.
  3447. </summary>
  3448. <param name="n">
  3449. The index.
  3450. </param>
  3451. </member>
  3452. <member name="P:Mono.Addins.ExtensionNodeList`1.Item(System.String)">
  3453. <summary>
  3454. Returns the node with the specified ID.
  3455. </summary>
  3456. <param name="id">
  3457. An id.
  3458. </param>
  3459. </member>
  3460. <member name="P:Mono.Addins.ExtensionNodeList`1.Count">
  3461. <summary>
  3462. Number of nodes of the collection.
  3463. </summary>
  3464. </member>
  3465. <member name="T:Mono.Addins.MissingDependencyException">
  3466. <summary>
  3467. Exception thrown when the add-in engine can't find a required add-in dependency
  3468. </summary>
  3469. </member>
  3470. <member name="T:Mono.Addins.TypeExtensionNode">
  3471. <summary>
  3472. An extension node which specifies a type.
  3473. </summary>
  3474. <remarks>
  3475. This class is a kind of Mono.Addins.ExtensionNode which can be used to register
  3476. types in an extension point. This is a very common case: a host application
  3477. defines an interface, and add-ins create classes that implement that interface.
  3478. The host will define an extension point which will use TypeExtensionNode as nodetext
  3479. type. Add-ins will register the classes they implement in that extension point.
  3480. When the nodes of an extension point are of type TypeExtensionNode it is then
  3481. possible to use query methods such as AddinManager.GetExtensionObjects(string),
  3482. which will get all nodes in the provided extension path and will create an object
  3483. for each node.
  3484. When declaring extension nodes in an add-in manifest, the class names can be
  3485. specified using the 'class' or 'type' attribute. If none of those attributes is
  3486. provided, the class name will be taken from the 'id' attribute.
  3487. TypeExtensionNode is the default extension type used when no type is provided
  3488. in the definition of an extension point.
  3489. </remarks>
  3490. </member>
  3491. <member name="M:Mono.Addins.TypeExtensionNode.Read(Mono.Addins.NodeElement)">
  3492. <summary>
  3493. Reads the extension node data
  3494. </summary>
  3495. <param name='elem'>
  3496. The element containing the extension data
  3497. </param>
  3498. <remarks>
  3499. This method can be overriden to provide a custom method for reading extension node data from an element.
  3500. The default implementation reads the attributes if the element and assigns the values to the fields
  3501. and properties of the extension node that have the corresponding [NodeAttribute] decoration.
  3502. </remarks>
  3503. </member>
  3504. <member name="M:Mono.Addins.TypeExtensionNode.CreateInstance">
  3505. <summary>
  3506. Creates a new extension object
  3507. </summary>
  3508. <returns>
  3509. The extension object
  3510. </returns>
  3511. </member>
  3512. <member name="P:Mono.Addins.TypeExtensionNode.Type">
  3513. <summary>
  3514. Type of the object that this node creates
  3515. </summary>
  3516. </member>
  3517. <member name="P:Mono.Addins.TypeExtensionNode.TypeName">
  3518. <summary>
  3519. Name of the type of the object that this node creates
  3520. </summary>
  3521. <value>The name of the type.</value>
  3522. </member>
  3523. <member name="T:Mono.Addins.TypeExtensionNode`1">
  3524. <summary>
  3525. An extension node which specifies a type with custom extension metadata
  3526. </summary>
  3527. <remarks>
  3528. This is the default type for type extension nodes bound to a custom extension attribute.
  3529. </remarks>
  3530. </member>
  3531. <member name="P:Mono.Addins.TypeExtensionNode`1.Data">
  3532. <summary>
  3533. The custom attribute containing the extension metadata
  3534. </summary>
  3535. </member>
  3536. <member name="T:Mono.Addins.AddinDescriptionAttribute">
  3537. <summary>
  3538. Describes the purpose of an add-in or add-in root
  3539. </summary>
  3540. </member>
  3541. <member name="M:Mono.Addins.AddinDescriptionAttribute.#ctor(System.String)">
  3542. <summary>
  3543. Initializes a new instance of the <see cref="T:Mono.Addins.AddinDescriptionAttribute"/> class.
  3544. </summary>
  3545. <param name="description">
  3546. Description of the add-in
  3547. </param>
  3548. </member>
  3549. <member name="M:Mono.Addins.AddinDescriptionAttribute.#ctor(System.String,System.String)">
  3550. <summary>
  3551. Initializes a new instance of the <see cref="T:Mono.Addins.AddinDescriptionAttribute"/> class.
  3552. </summary>
  3553. <param name="description">
  3554. Description of the add-in
  3555. </param>
  3556. <param name="locale">
  3557. Locale of the description (for example, 'en-US', or 'en')
  3558. </param>
  3559. </member>
  3560. <member name="P:Mono.Addins.AddinDescriptionAttribute.Description">
  3561. <value>
  3562. Description of the add-in
  3563. </value>
  3564. </member>
  3565. <member name="P:Mono.Addins.AddinDescriptionAttribute.Locale">
  3566. <summary>
  3567. Locale of the description (for example, 'en-US', or 'en')
  3568. </summary>
  3569. </member>
  3570. <member name="T:Mono.Addins.AddinRootAttribute">
  3571. <summary>
  3572. Marks an assembly as being an add-in root.
  3573. </summary>
  3574. <remarks>
  3575. An add-in root is an assemly which can be extended by add-ins.
  3576. </remarks>
  3577. </member>
  3578. <member name="T:Mono.Addins.AddinAttribute">
  3579. <summary>
  3580. Marks an assembly as being an add-in.
  3581. </summary>
  3582. </member>
  3583. <member name="M:Mono.Addins.AddinAttribute.#ctor">
  3584. <summary>
  3585. Initializes an add-in marker attribute
  3586. </summary>
  3587. </member>
  3588. <member name="M:Mono.Addins.AddinAttribute.#ctor(System.String)">
  3589. <summary>
  3590. Initializes an add-in marker attribute
  3591. </summary>
  3592. <param name="id">
  3593. Identifier of the add-in
  3594. </param>
  3595. </member>
  3596. <member name="M:Mono.Addins.AddinAttribute.#ctor(System.String,System.String)">
  3597. <summary>
  3598. Initializes an add-in marker attribute
  3599. </summary>
  3600. <param name="id">
  3601. Identifier of the add-in
  3602. </param>
  3603. <param name="version">
  3604. Version of the add-in
  3605. </param>
  3606. </member>
  3607. <member name="P:Mono.Addins.AddinAttribute.Id">
  3608. <summary>
  3609. Identifier of the add-in.
  3610. </summary>
  3611. </member>
  3612. <member name="P:Mono.Addins.AddinAttribute.Version">
  3613. <summary>
  3614. Version of the add-in.
  3615. </summary>
  3616. </member>
  3617. <member name="P:Mono.Addins.AddinAttribute.CompatVersion">
  3618. <summary>
  3619. Version of the add-in with which this add-in is backwards compatible.
  3620. </summary>
  3621. </member>
  3622. <member name="P:Mono.Addins.AddinAttribute.Namespace">
  3623. <summary>
  3624. Namespace of the add-in
  3625. </summary>
  3626. </member>
  3627. <member name="P:Mono.Addins.AddinAttribute.Category">
  3628. <summary>
  3629. Category of the add-in
  3630. </summary>
  3631. </member>
  3632. <member name="P:Mono.Addins.AddinAttribute.Url">
  3633. <summary>
  3634. Url to a web page with more information about the add-in
  3635. </summary>
  3636. </member>
  3637. <member name="P:Mono.Addins.AddinAttribute.EnabledByDefault">
  3638. <summary>
  3639. When set to True, the add-in will be automatically enabled after installing.
  3640. It's True by default.
  3641. </summary>
  3642. </member>
  3643. <member name="P:Mono.Addins.AddinAttribute.Flags">
  3644. <summary>
  3645. Add-in flags
  3646. </summary>
  3647. </member>
  3648. <member name="M:Mono.Addins.AddinRootAttribute.#ctor">
  3649. <summary>
  3650. Initializes a new instance
  3651. </summary>
  3652. </member>
  3653. <member name="M:Mono.Addins.AddinRootAttribute.#ctor(System.String)">
  3654. <summary>
  3655. Initializes a new instance
  3656. </summary>
  3657. <param name="id">
  3658. Identifier of the add-in root
  3659. </param>
  3660. </member>
  3661. <member name="M:Mono.Addins.AddinRootAttribute.#ctor(System.String,System.String)">
  3662. <summary>
  3663. Initializes a new instance
  3664. </summary>
  3665. <param name="id">
  3666. Identifier of the add-in root
  3667. </param>
  3668. <param name="version">
  3669. Version of the add-in root
  3670. </param>
  3671. </member>
  3672. <member name="T:Mono.Addins.Description.Extension">
  3673. <summary>
  3674. An extension definition.
  3675. </summary>
  3676. <remarks>
  3677. An Extension is a collection of nodes which have to be registered in an extension point.
  3678. The target extension point is specified in the <see cref="T:Mono.Addins.Description.Extension"/>.Path property.
  3679. </remarks>
  3680. </member>
  3681. <member name="M:Mono.Addins.Description.Extension.#ctor">
  3682. <summary>
  3683. Initializes a new instance of the <see cref="T:Mono.Addins.Description.Extension"/> class.
  3684. </summary>
  3685. </member>
  3686. <member name="M:Mono.Addins.Description.Extension.#ctor(System.String)">
  3687. <summary>
  3688. Initializes a new instance of the <see cref="T:Mono.Addins.Description.Extension"/> class.
  3689. </summary>
  3690. <param name="path">
  3691. Path that identifies the extension point being extended
  3692. </param>
  3693. </member>
  3694. <member name="M:Mono.Addins.Description.Extension.GetExtendedObject">
  3695. <summary>
  3696. Gets the object extended by this extension
  3697. </summary>
  3698. <returns>
  3699. The extended object can be an <see cref="T:Mono.Addins.Description.ExtensionPoint"/> or
  3700. an <see cref="T:Mono.Addins.Description.ExtensionNodeDescription"/>.
  3701. </returns>
  3702. <remarks>
  3703. This method only works when the add-in description to which the extension belongs has been
  3704. loaded from an add-in registry.
  3705. </remarks>
  3706. </member>
  3707. <member name="M:Mono.Addins.Description.Extension.GetAllowedNodeTypes">
  3708. <summary>
  3709. Gets the node types allowed in this extension.
  3710. </summary>
  3711. <returns>
  3712. The allowed node types.
  3713. </returns>
  3714. <remarks>
  3715. This method only works when the add-in description to which the extension belongs has been
  3716. loaded from an add-in registry.
  3717. </remarks>
  3718. </member>
  3719. <member name="M:Mono.Addins.Description.Extension.#ctor(System.Xml.XmlElement)">
  3720. <summary>
  3721. Initializes a new instance of the <see cref="T:Mono.Addins.Description.Extension"/> class.
  3722. </summary>
  3723. <param name="element">
  3724. XML that describes the extension.
  3725. </param>
  3726. </member>
  3727. <member name="P:Mono.Addins.Description.Extension.Path">
  3728. <summary>
  3729. Gets or sets the path that identifies the extension point being extended.
  3730. </summary>
  3731. <value>
  3732. The path.
  3733. </value>
  3734. </member>
  3735. <member name="P:Mono.Addins.Description.Extension.ExtensionNodes">
  3736. <summary>
  3737. Gets the extension nodes.
  3738. </summary>
  3739. <value>
  3740. The extension nodes.
  3741. </value>
  3742. </member>
  3743. <member name="T:Mono.Addins.ExtensionEventHandler">
  3744. <summary>
  3745. Delegate to be used in extension point subscriptions
  3746. </summary>
  3747. </member>
  3748. <member name="T:Mono.Addins.ExtensionNodeEventHandler">
  3749. <summary>
  3750. Delegate to be used in extension point subscriptions
  3751. </summary>
  3752. </member>
  3753. <member name="T:Mono.Addins.ExtensionEventArgs">
  3754. <summary>
  3755. Arguments for extension events.
  3756. </summary>
  3757. </member>
  3758. <member name="M:Mono.Addins.ExtensionEventArgs.#ctor(System.String)">
  3759. <summary>
  3760. Creates a new instance.
  3761. </summary>
  3762. <param name="path">
  3763. Path of the extension node that has changed.
  3764. </param>
  3765. </member>
  3766. <member name="M:Mono.Addins.ExtensionEventArgs.PathChanged(System.String)">
  3767. <summary>
  3768. Checks if a path has changed.
  3769. </summary>
  3770. <param name="pathToCheck">
  3771. An extension path.
  3772. </param>
  3773. <returns>
  3774. 'true' if the path is affected by the extension change event.
  3775. </returns>
  3776. <remarks>
  3777. Checks if the specified path or any of its children paths is affected by the extension change event.
  3778. </remarks>
  3779. </member>
  3780. <member name="P:Mono.Addins.ExtensionEventArgs.Path">
  3781. <summary>
  3782. Path of the extension node that has changed.
  3783. </summary>
  3784. </member>
  3785. <member name="T:Mono.Addins.ExtensionNodeEventArgs">
  3786. <summary>
  3787. Arguments for extension node events.
  3788. </summary>
  3789. </member>
  3790. <member name="M:Mono.Addins.ExtensionNodeEventArgs.#ctor(Mono.Addins.ExtensionChange,Mono.Addins.ExtensionNode)">
  3791. <summary>
  3792. Creates a new instance
  3793. </summary>
  3794. <param name="change">
  3795. Type of change.
  3796. </param>
  3797. <param name="node">
  3798. Node that has been added or removed.
  3799. </param>
  3800. </member>
  3801. <member name="P:Mono.Addins.ExtensionNodeEventArgs.Path">
  3802. <summary>
  3803. Path of the extension that changed.
  3804. </summary>
  3805. </member>
  3806. <member name="P:Mono.Addins.ExtensionNodeEventArgs.Change">
  3807. <summary>
  3808. Type of change.
  3809. </summary>
  3810. </member>
  3811. <member name="P:Mono.Addins.ExtensionNodeEventArgs.ExtensionNode">
  3812. <summary>
  3813. Node that has been added or removed.
  3814. </summary>
  3815. </member>
  3816. <member name="P:Mono.Addins.ExtensionNodeEventArgs.ExtensionObject">
  3817. <summary>
  3818. Extension object that has been added or removed.
  3819. </summary>
  3820. </member>
  3821. <member name="T:Mono.Addins.ExtensionChange">
  3822. <summary>
  3823. Type of change in an extension change event.
  3824. </summary>
  3825. </member>
  3826. <member name="F:Mono.Addins.ExtensionChange.Add">
  3827. <summary>
  3828. An extension node has been added.
  3829. </summary>
  3830. </member>
  3831. <member name="F:Mono.Addins.ExtensionChange.Remove">
  3832. <summary>
  3833. An extension node has been removed.
  3834. </summary>
  3835. </member>
  3836. <member name="T:Mono.Addins.AddinNameAttribute">
  3837. <summary>
  3838. Sets the display name of an add-in
  3839. </summary>
  3840. </member>
  3841. <member name="M:Mono.Addins.AddinNameAttribute.#ctor(System.String)">
  3842. <summary>
  3843. Initializes a new instance of the <see cref="T:Mono.Addins.AddinNameAttribute"/> class.
  3844. </summary>
  3845. <param name="name">
  3846. Name of the add-in
  3847. </param>
  3848. </member>
  3849. <member name="M:Mono.Addins.AddinNameAttribute.#ctor(System.String,System.String)">
  3850. <summary>
  3851. Initializes a new instance of the <see cref="T:Mono.Addins.AddinNameAttribute"/> class.
  3852. </summary>
  3853. <param name="name">
  3854. Name of the add-in
  3855. </param>
  3856. <param name="locale">
  3857. Locale of the name (for example, 'en-US', or 'en')
  3858. </param>
  3859. </member>
  3860. <member name="P:Mono.Addins.AddinNameAttribute.Name">
  3861. <value>
  3862. Name of the add-in
  3863. </value>
  3864. </member>
  3865. <member name="P:Mono.Addins.AddinNameAttribute.Locale">
  3866. <summary>
  3867. Locale of the name (for example, 'en-US', or 'en')
  3868. </summary>
  3869. </member>
  3870. <member name="T:Mono.Addins.ContentType">
  3871. <summary>
  3872. Type of the content of a string extension node attribute
  3873. </summary>
  3874. </member>
  3875. <member name="F:Mono.Addins.ContentType.Text">
  3876. <summary>
  3877. Plain text
  3878. </summary>
  3879. </member>
  3880. <member name="F:Mono.Addins.ContentType.Class">
  3881. <summary>
  3882. A class name
  3883. </summary>
  3884. </member>
  3885. <member name="F:Mono.Addins.ContentType.Resource">
  3886. <summary>
  3887. A resource name
  3888. </summary>
  3889. </member>
  3890. <member name="F:Mono.Addins.ContentType.File">
  3891. <summary>
  3892. A file name
  3893. </summary>
  3894. </member>
  3895. <member name="T:Mono.Addins.Database.AddinFileSystemExtension">
  3896. <summary>
  3897. An add-in file system extension.
  3898. </summary>
  3899. <remarks>
  3900. File system extensions can override the behavior of the add-in scanner and provide custom rules for
  3901. locating and scanning assemblies.
  3902. </remarks>
  3903. </member>
  3904. <member name="M:Mono.Addins.Database.AddinFileSystemExtension.ScanStarted">
  3905. <summary>
  3906. Called when the add-in scan is about to start
  3907. </summary>
  3908. </member>
  3909. <member name="M:Mono.Addins.Database.AddinFileSystemExtension.ScanFinished">
  3910. <summary>
  3911. Called when the add-in scan has finished
  3912. </summary>
  3913. </member>
  3914. <member name="M:Mono.Addins.Database.AddinFileSystemExtension.DirectoryExists(System.String)">
  3915. <summary>
  3916. Checks if a directory exists
  3917. </summary>
  3918. <returns>
  3919. 'true' if the directory exists
  3920. </returns>
  3921. <param name='path'>
  3922. Directory path
  3923. </param>
  3924. </member>
  3925. <member name="M:Mono.Addins.Database.AddinFileSystemExtension.FileExists(System.String)">
  3926. <summary>
  3927. Checks if a file exists
  3928. </summary>
  3929. <returns>
  3930. 'true' if the file exists
  3931. </returns>
  3932. <param name='path'>
  3933. Path to the file
  3934. </param>
  3935. </member>
  3936. <member name="M:Mono.Addins.Database.AddinFileSystemExtension.GetFiles(System.String)">
  3937. <summary>
  3938. Gets the files in a directory
  3939. </summary>
  3940. <returns>
  3941. The full path of the files in the directory
  3942. </returns>
  3943. <param name='path'>
  3944. Directory path
  3945. </param>
  3946. </member>
  3947. <member name="M:Mono.Addins.Database.AddinFileSystemExtension.GetDirectories(System.String)">
  3948. <summary>
  3949. Gets the subdirectories of a directory
  3950. </summary>
  3951. <returns>
  3952. The subdirectories.
  3953. </returns>
  3954. <param name='path'>
  3955. The directory
  3956. </param>
  3957. </member>
  3958. <member name="M:Mono.Addins.Database.AddinFileSystemExtension.GetLastWriteTime(System.String)">
  3959. <summary>
  3960. Gets the last write time of a file
  3961. </summary>
  3962. <returns>
  3963. The last write time.
  3964. </returns>
  3965. <param name='filePath'>
  3966. File path.
  3967. </param>
  3968. </member>
  3969. <member name="M:Mono.Addins.Database.AddinFileSystemExtension.OpenTextFile(System.String)">
  3970. <summary>
  3971. Opens a text file
  3972. </summary>
  3973. <returns>
  3974. The text file stream
  3975. </returns>
  3976. <param name='path'>
  3977. File path.
  3978. </param>
  3979. </member>
  3980. <member name="M:Mono.Addins.Database.AddinFileSystemExtension.OpenFile(System.String)">
  3981. <summary>
  3982. Opens a file.
  3983. </summary>
  3984. <returns>
  3985. The file stream.
  3986. </returns>
  3987. <param name='path'>
  3988. The file path.
  3989. </param>
  3990. </member>
  3991. <member name="M:Mono.Addins.Database.AddinFileSystemExtension.GetReflectorForFile(Mono.Addins.Database.IAssemblyLocator,System.String)">
  3992. <summary>
  3993. Gets an assembly reflector for a file.
  3994. </summary>
  3995. <returns>
  3996. The reflector for the file.
  3997. </returns>
  3998. <param name='locator'>
  3999. An assembly locator
  4000. </param>
  4001. <param name='path'>
  4002. A file path
  4003. </param>
  4004. </member>
  4005. <member name="P:Mono.Addins.Database.AddinFileSystemExtension.RequiresIsolation">
  4006. <summary>
  4007. Gets a value indicating whether this <see cref="T:Mono.Addins.Database.AddinFileSystemExtension"/> needs to be isolated from the main execution process
  4008. </summary>
  4009. <value>
  4010. <c>true</c> if requires isolation; otherwise, <c>false</c>.
  4011. </value>
  4012. </member>
  4013. <member name="T:Mono.Addins.ExtensionAttributeAttribute">
  4014. <summary>
  4015. Assigns an attribute value to an extension
  4016. </summary>
  4017. <remarks>
  4018. This attribute can be used together with the [Extenion] attribute to specify
  4019. a value for an attribute of the extension.
  4020. </remarks>
  4021. </member>
  4022. <member name="M:Mono.Addins.ExtensionAttributeAttribute.#ctor(System.String,System.String)">
  4023. <summary>
  4024. Initializes a new instance of the <see cref="T:Mono.Addins.ExtensionAttributeAttribute"/> class.
  4025. </summary>
  4026. <param name="name">
  4027. Name of the attribute
  4028. </param>
  4029. <param name="value">
  4030. Value of the attribute
  4031. </param>
  4032. </member>
  4033. <member name="M:Mono.Addins.ExtensionAttributeAttribute.#ctor(System.Type,System.String,System.String)">
  4034. <summary>
  4035. Initializes a new instance of the <see cref="T:Mono.Addins.ExtensionAttributeAttribute"/> class.
  4036. </summary>
  4037. <param name="type">
  4038. Type of the extension for which the attribute value is being set
  4039. </param>
  4040. <param name="name">
  4041. Name of the attribute
  4042. </param>
  4043. <param name="value">
  4044. Value of the attribute
  4045. </param>
  4046. </member>
  4047. <member name="M:Mono.Addins.ExtensionAttributeAttribute.#ctor(System.String,System.String,System.String)">
  4048. <summary>
  4049. Initializes a new instance of the <see cref="T:Mono.Addins.ExtensionAttributeAttribute"/> class.
  4050. </summary>
  4051. <param name="path">
  4052. Path of the extension for which the attribute value is being set
  4053. </param>
  4054. <param name="name">
  4055. Name of the attribute
  4056. </param>
  4057. <param name="value">
  4058. Value of the attribute
  4059. </param>
  4060. </member>
  4061. <member name="P:Mono.Addins.ExtensionAttributeAttribute.Name">
  4062. <summary>
  4063. Name of the attribute
  4064. </summary>
  4065. </member>
  4066. <member name="P:Mono.Addins.ExtensionAttributeAttribute.Value">
  4067. <summary>
  4068. Value of the attribute
  4069. </summary>
  4070. </member>
  4071. <member name="P:Mono.Addins.ExtensionAttributeAttribute.Path">
  4072. <summary>
  4073. Path of the extension for which the attribute value is being set
  4074. </summary>
  4075. </member>
  4076. <member name="P:Mono.Addins.ExtensionAttributeAttribute.Type">
  4077. <summary>
  4078. Type of the extension for which the attribute value is being set
  4079. </summary>
  4080. </member>
  4081. <member name="T:Mono.Addins.IAddinInstaller">
  4082. <summary>
  4083. An add-in installation handler
  4084. </summary>
  4085. </member>
  4086. <member name="M:Mono.Addins.IAddinInstaller.InstallAddins(Mono.Addins.AddinRegistry,System.String,System.String[])">
  4087. <summary>
  4088. Installs a set of add-ins
  4089. </summary>
  4090. <param name="reg">
  4091. Registry where to install
  4092. </param>
  4093. <param name="message">
  4094. Message to show to the user when new add-ins have to be installed.
  4095. </param>
  4096. <param name="addinIds">
  4097. List of IDs of the add-ins to be installed.
  4098. </param>
  4099. </member>
  4100. <member name="T:Mono.Addins.ExtensionNodeAttribute">
  4101. <summary>
  4102. This attribute can be applied to an ExtensionNode subclass to specify the default name and description.
  4103. </summary>
  4104. <remarks>
  4105. This information will be used when an extension point does not define a name or description for a node type.
  4106. </remarks>
  4107. </member>
  4108. <member name="M:Mono.Addins.ExtensionNodeAttribute.#ctor">
  4109. <summary>
  4110. Initializes the attribute
  4111. </summary>
  4112. </member>
  4113. <member name="M:Mono.Addins.ExtensionNodeAttribute.#ctor(System.String)">
  4114. <summary>
  4115. Initializes the attribute
  4116. </summary>
  4117. <param name="nodeName">
  4118. Name of the node
  4119. </param>
  4120. </member>
  4121. <member name="M:Mono.Addins.ExtensionNodeAttribute.#ctor(System.String,System.String)">
  4122. <summary>
  4123. Initializes the attribute
  4124. </summary>
  4125. <param name="nodeName">
  4126. Name of the node
  4127. </param>
  4128. <param name="description">
  4129. Description of the node
  4130. </param>
  4131. </member>
  4132. <member name="P:Mono.Addins.ExtensionNodeAttribute.NodeName">
  4133. <summary>
  4134. Default name of the extension node
  4135. </summary>
  4136. </member>
  4137. <member name="P:Mono.Addins.ExtensionNodeAttribute.Description">
  4138. <summary>
  4139. Default description of the extension node type
  4140. </summary>
  4141. </member>
  4142. <member name="P:Mono.Addins.ExtensionNodeAttribute.ExtensionAttributeType">
  4143. <summary>
  4144. Type of a custom attribute which can be used to specify metadata for this extension node type
  4145. </summary>
  4146. </member>
  4147. <member name="T:Mono.Addins.Description.DependencyCollection">
  4148. <summary>
  4149. A collection of dependency definitions.
  4150. </summary>
  4151. </member>
  4152. <member name="M:Mono.Addins.Description.DependencyCollection.#ctor">
  4153. <summary>
  4154. Initializes a new instance of the <see cref="T:Mono.Addins.Description.DependencyCollection"/> class.
  4155. </summary>
  4156. </member>
  4157. <member name="M:Mono.Addins.Description.DependencyCollection.Add(Mono.Addins.Description.Dependency)">
  4158. <summary>
  4159. Adds a dependency to the collection
  4160. </summary>
  4161. <param name='dep'>
  4162. The dependency to add.
  4163. </param>
  4164. </member>
  4165. <member name="M:Mono.Addins.Description.DependencyCollection.Remove(Mono.Addins.Description.Dependency)">
  4166. <summary>
  4167. Remove the specified dependency.
  4168. </summary>
  4169. <param name='dep'>
  4170. Dependency to remove.
  4171. </param>
  4172. </member>
  4173. <member name="P:Mono.Addins.Description.DependencyCollection.Item(System.Int32)">
  4174. <summary>
  4175. Gets the <see cref="T:Mono.Addins.Description.Dependency"/> at the specified index.
  4176. </summary>
  4177. <param name="n">
  4178. The idnex.
  4179. </param>
  4180. </member>
  4181. <member name="T:Mono.Addins.ExtensionAttribute">
  4182. <summary>
  4183. Declares a type extension.
  4184. </summary>
  4185. <remarks>
  4186. When applied to a class, specifies that the class is an extension
  4187. class to be registered in a matching extension point.
  4188. </remarks>
  4189. </member>
  4190. <member name="M:Mono.Addins.ExtensionAttribute.#ctor">
  4191. <summary>
  4192. Initializes a new instance of the ExtensionAttribute class.
  4193. </summary>
  4194. </member>
  4195. <member name="M:Mono.Addins.ExtensionAttribute.#ctor(System.String)">
  4196. <summary>
  4197. Initializes a new instance
  4198. </summary>
  4199. <param name="path">
  4200. Path of the extension point.
  4201. </param>
  4202. <remarks>The path is only required if there are several extension points defined for the same type.</remarks>
  4203. </member>
  4204. <member name="M:Mono.Addins.ExtensionAttribute.#ctor(System.Type)">
  4205. <summary>
  4206. Initializes a new instance
  4207. </summary>
  4208. <param name="type">
  4209. Type defining the extension point being extended
  4210. </param>
  4211. <remarks>
  4212. This constructor can be used to explicitly specify the type that defines the extension point
  4213. to be extended. By default, Mono.Addins will try to find any extension point defined in any
  4214. of the base classes or interfaces. The type parameter can be used when there is more than one
  4215. base type providing an extension point.
  4216. </remarks>
  4217. </member>
  4218. <member name="P:Mono.Addins.ExtensionAttribute.Path">
  4219. <summary>
  4220. Path of the extension point being extended
  4221. </summary>
  4222. <remarks>
  4223. The path is only required if there are several extension points defined for the same type.
  4224. </remarks>
  4225. </member>
  4226. <member name="P:Mono.Addins.ExtensionAttribute.NodeName">
  4227. <summary>
  4228. Name of the extension node
  4229. </summary>
  4230. <remarks>
  4231. Extension points may require extensions to use a specific node name.
  4232. This is needed when an extension point may contain several different types of nodes.
  4233. </remarks>
  4234. </member>
  4235. <member name="P:Mono.Addins.ExtensionAttribute.Id">
  4236. <summary>
  4237. Identifier of the extension node.
  4238. </summary>
  4239. <remarks>
  4240. The ExtensionAttribute.InsertAfter and ExtensionAttribute.InsertBefore
  4241. properties can be used to specify the relative location of a node. The nodes
  4242. referenced in those properties must be defined either in the add-in host
  4243. being extended, or in any add-in on which this add-in depends.
  4244. </remarks>
  4245. </member>
  4246. <member name="P:Mono.Addins.ExtensionAttribute.InsertBefore">
  4247. <summary>
  4248. Identifier of the extension node before which this node has to be added in the extension point.
  4249. </summary>
  4250. <remarks>
  4251. The ExtensionAttribute.InsertAfter and ExtensionAttribute.InsertBefore
  4252. properties can be used to specify the relative location of a node. The nodes
  4253. referenced in those properties must be defined either in the add-in host
  4254. being extended, or in any add-in on which this add-in depends.
  4255. </remarks>
  4256. </member>
  4257. <member name="P:Mono.Addins.ExtensionAttribute.InsertAfter">
  4258. <summary>
  4259. Identifier of the extension node after which this node has to be added in the extension point.
  4260. </summary>
  4261. </member>
  4262. <member name="P:Mono.Addins.ExtensionAttribute.Type">
  4263. <summary>
  4264. Type defining the extension point being extended
  4265. </summary>
  4266. <remarks>
  4267. This property can be used to explicitly specify the type that defines the extension point
  4268. to be extended. By default, Mono.Addins will try to find any extension point defined in any
  4269. of the base classes or interfaces. This property can be used when there is more than one
  4270. base type providing an extension point.
  4271. </remarks>
  4272. </member>
  4273. <member name="T:Mono.Addins.RuntimeAddin">
  4274. <summary>
  4275. Run-time representation of an add-in.
  4276. </summary>
  4277. </member>
  4278. <member name="M:Mono.Addins.RuntimeAddin.ToString">
  4279. <summary>
  4280. Returns a string that represents the current RuntimeAddin.
  4281. </summary>
  4282. <returns>
  4283. A string that represents the current RuntimeAddin.
  4284. </returns>
  4285. </member>
  4286. <member name="M:Mono.Addins.RuntimeAddin.GetResourceString(System.String)">
  4287. <summary>
  4288. Gets a resource string
  4289. </summary>
  4290. <param name="name">
  4291. Name of the resource
  4292. </param>
  4293. <returns>
  4294. The value of the resource string, or null if the resource can't be found.
  4295. </returns>
  4296. <remarks>
  4297. The add-in engine will look for resources in the main add-in assembly and in all included add-in assemblies.
  4298. </remarks>
  4299. </member>
  4300. <member name="M:Mono.Addins.RuntimeAddin.GetResourceString(System.String,System.Boolean)">
  4301. <summary>
  4302. Gets a resource string
  4303. </summary>
  4304. <param name="name">
  4305. Name of the resource
  4306. </param>
  4307. <param name="throwIfNotFound">
  4308. When set to true, an exception will be thrown if the resource is not found.
  4309. </param>
  4310. <returns>
  4311. The value of the resource string
  4312. </returns>
  4313. <remarks>
  4314. The add-in engine will look for resources in the main add-in assembly and in all included add-in assemblies.
  4315. </remarks>
  4316. </member>
  4317. <member name="M:Mono.Addins.RuntimeAddin.GetResourceString(System.String,System.Boolean,System.Globalization.CultureInfo)">
  4318. <summary>
  4319. Gets a resource string
  4320. </summary>
  4321. <param name="name">
  4322. Name of the resource
  4323. </param>
  4324. <param name="throwIfNotFound">
  4325. When set to true, an exception will be thrown if the resource is not found.
  4326. </param>
  4327. <param name="culture">
  4328. Culture of the resource
  4329. </param>
  4330. <returns>
  4331. The value of the resource string
  4332. </returns>
  4333. <remarks>
  4334. The add-in engine will look for resources in the main add-in assembly and in all included add-in assemblies.
  4335. </remarks>
  4336. </member>
  4337. <member name="M:Mono.Addins.RuntimeAddin.GetResourceObject(System.String)">
  4338. <summary>
  4339. Gets a resource object
  4340. </summary>
  4341. <param name="name">
  4342. Name of the resource
  4343. </param>
  4344. <returns>
  4345. Value of the resource
  4346. </returns>
  4347. <remarks>
  4348. The add-in engine will look for resources in the main add-in assembly and in all included add-in assemblies.
  4349. </remarks>
  4350. </member>
  4351. <member name="M:Mono.Addins.RuntimeAddin.GetResourceObject(System.String,System.Boolean)">
  4352. <summary>
  4353. Gets a resource object
  4354. </summary>
  4355. <param name="name">
  4356. Name of the resource
  4357. </param>
  4358. <param name="throwIfNotFound">
  4359. When set to true, an exception will be thrown if the resource is not found.
  4360. </param>
  4361. <returns>
  4362. Value of the resource
  4363. </returns>
  4364. <remarks>
  4365. The add-in engine will look for resources in the main add-in assembly and in all included add-in assemblies.
  4366. </remarks>
  4367. </member>
  4368. <member name="M:Mono.Addins.RuntimeAddin.GetResourceObject(System.String,System.Boolean,System.Globalization.CultureInfo)">
  4369. <summary>
  4370. Gets a resource object
  4371. </summary>
  4372. <param name="name">
  4373. Name of the resource
  4374. </param>
  4375. <param name="throwIfNotFound">
  4376. When set to true, an exception will be thrown if the resource is not found.
  4377. </param>
  4378. <param name="culture">
  4379. Culture of the resource
  4380. </param>
  4381. <returns>
  4382. Value of the resource
  4383. </returns>
  4384. <remarks>
  4385. The add-in engine will look for resources in the main add-in assembly and in all included add-in assemblies.
  4386. </remarks>
  4387. </member>
  4388. <member name="M:Mono.Addins.RuntimeAddin.GetType(System.String)">
  4389. <summary>
  4390. Gets a type defined in the add-in
  4391. </summary>
  4392. <param name="typeName">
  4393. Full name of the type
  4394. </param>
  4395. <returns>
  4396. A type.
  4397. </returns>
  4398. <remarks>
  4399. The type will be looked up in the assemblies that implement the add-in,
  4400. and recursivelly in all add-ins on which it depends.
  4401. This method throws an InvalidOperationException if the type can't be found.
  4402. </remarks>
  4403. </member>
  4404. <member name="M:Mono.Addins.RuntimeAddin.GetType(System.String,System.Boolean)">
  4405. <summary>
  4406. Gets a type defined in the add-in
  4407. </summary>
  4408. <param name="typeName">
  4409. Full name of the type
  4410. </param>
  4411. <param name="throwIfNotFound">
  4412. Indicates whether the method should throw an exception if the type can't be found.
  4413. </param>
  4414. <returns>
  4415. A <see cref="T:System.Type"/>
  4416. </returns>
  4417. <remarks>
  4418. The type will be looked up in the assemblies that implement the add-in,
  4419. and recursivelly in all add-ins on which it depends.
  4420. If the type can't be found, this method throw a InvalidOperationException if
  4421. 'throwIfNotFound' is 'true', or 'null' otherwise.
  4422. </remarks>
  4423. </member>
  4424. <member name="M:Mono.Addins.RuntimeAddin.CreateInstance(System.String)">
  4425. <summary>
  4426. Creates an instance of a type defined in the add-in
  4427. </summary>
  4428. <param name="typeName">
  4429. Name of the type.
  4430. </param>
  4431. <returns>
  4432. A new instance of the type
  4433. </returns>
  4434. <remarks>
  4435. The type will be looked up in the assemblies that implement the add-in,
  4436. and recursivelly in all add-ins on which it depends.
  4437. This method throws an InvalidOperationException if the type can't be found.
  4438. The specified type must have a default constructor.
  4439. </remarks>
  4440. </member>
  4441. <member name="M:Mono.Addins.RuntimeAddin.CreateInstance(System.String,System.Boolean)">
  4442. <summary>
  4443. Creates an instance of a type defined in the add-in
  4444. </summary>
  4445. <param name="typeName">
  4446. Name of the type.
  4447. </param>
  4448. <param name="throwIfNotFound">
  4449. Indicates whether the method should throw an exception if the type can't be found.
  4450. </param>
  4451. <returns>
  4452. A new instance of the type
  4453. </returns>
  4454. <remarks>
  4455. The type will be looked up in the assemblies that implement the add-in,
  4456. and recursivelly in all add-ins on which it depends.
  4457. If the type can't be found, this method throw a InvalidOperationException if
  4458. 'throwIfNotFound' is 'true', or 'null' otherwise.
  4459. The specified type must have a default constructor.
  4460. </remarks>
  4461. </member>
  4462. <member name="M:Mono.Addins.RuntimeAddin.GetFilePath(System.String)">
  4463. <summary>
  4464. Gets the path of an add-in file
  4465. </summary>
  4466. <param name="fileName">
  4467. Relative path of the file
  4468. </param>
  4469. <returns>
  4470. Full path of the file
  4471. </returns>
  4472. <remarks>
  4473. This method can be used to get the full path of a data file deployed together with the add-in.
  4474. </remarks>
  4475. </member>
  4476. <member name="M:Mono.Addins.RuntimeAddin.GetFilePath(System.String[])">
  4477. <summary>
  4478. Gets the path of an add-in file
  4479. </summary>
  4480. <param name="filePath">
  4481. Components of the file path
  4482. </param>
  4483. <returns>
  4484. Full path of the file
  4485. </returns>
  4486. <remarks>
  4487. This method can be used to get the full path of a data file deployed together with the add-in.
  4488. </remarks>
  4489. </member>
  4490. <member name="M:Mono.Addins.RuntimeAddin.GetResource(System.String)">
  4491. <summary>
  4492. Gets the content of a resource
  4493. </summary>
  4494. <param name="resourceName">
  4495. Name of the resource
  4496. </param>
  4497. <returns>
  4498. Content of the resource, or null if not found
  4499. </returns>
  4500. <remarks>
  4501. The add-in engine will look for resources in the main add-in assembly and in all included add-in assemblies.
  4502. </remarks>
  4503. </member>
  4504. <member name="M:Mono.Addins.RuntimeAddin.GetResource(System.String,System.Boolean)">
  4505. <summary>
  4506. Gets the content of a resource
  4507. </summary>
  4508. <param name="resourceName">
  4509. Name of the resource
  4510. </param>
  4511. <param name="throwIfNotFound">
  4512. When set to true, an exception will be thrown if the resource is not found.
  4513. </param>
  4514. <returns>
  4515. Content of the resource.
  4516. </returns>
  4517. <remarks>
  4518. The add-in engine will look for resources in the main add-in assembly and in all included add-in assemblies.
  4519. </remarks>
  4520. </member>
  4521. <member name="P:Mono.Addins.RuntimeAddin.Id">
  4522. <summary>
  4523. Identifier of the add-in.
  4524. </summary>
  4525. </member>
  4526. <member name="P:Mono.Addins.RuntimeAddin.Version">
  4527. <summary>
  4528. Version of the add-in.
  4529. </summary>
  4530. </member>
  4531. <member name="P:Mono.Addins.RuntimeAddin.PrivateDataPath">
  4532. <summary>
  4533. Path to a directory where add-ins can store private configuration or status data
  4534. </summary>
  4535. </member>
  4536. <member name="P:Mono.Addins.RuntimeAddin.Localizer">
  4537. <summary>
  4538. Localizer which can be used to localize strings defined in this add-in
  4539. </summary>
  4540. </member>
  4541. <member name="T:Mono.Addins.ImportAddinAssemblyAttribute">
  4542. <summary>
  4543. Declares an add-in assembly import
  4544. </summary>
  4545. <remarks>
  4546. An add-in may be composed by several assemblies and data files.
  4547. Assemblies must be declared in the main assembly using this attribute, or in the XML manifest.
  4548. It is important to properly declare all files used by an add-in.
  4549. For example, when a type from the add-in is required (e.g. an ICommand implementation),
  4550. only properly declared assemblies will be checked.
  4551. This information is also used by setup tools to know exactly what needs to be packaged when creating
  4552. an add-in package, or to know what needs to be deleted when removing an add-in.
  4553. </remarks>
  4554. </member>
  4555. <member name="M:Mono.Addins.ImportAddinAssemblyAttribute.#ctor(System.String)">
  4556. <summary>
  4557. Initializes a new instance
  4558. </summary>
  4559. <param name="filePath">
  4560. Path to the assembly. Must be relative to the assembly declaring this attribute.
  4561. </param>
  4562. </member>
  4563. <member name="P:Mono.Addins.ImportAddinAssemblyAttribute.FilePath">
  4564. <summary>
  4565. Path to the assembly. Must be relative to the assembly declaring this attribute.
  4566. </summary>
  4567. </member>
  4568. <member name="P:Mono.Addins.ImportAddinAssemblyAttribute.Scan">
  4569. <summary>
  4570. When set to true (the default), the included assembly will be scanned
  4571. looking for extension point declarations.
  4572. </summary>
  4573. </member>
  4574. <member name="T:Mono.Addins.AddinErrorEventHandler">
  4575. <summary>
  4576. Delegate to be used in add-in error subscriptions
  4577. </summary>
  4578. </member>
  4579. <member name="T:Mono.Addins.AddinErrorEventArgs">
  4580. <summary>
  4581. Provides information about an add-in loading error.
  4582. </summary>
  4583. </member>
  4584. <member name="M:Mono.Addins.AddinErrorEventArgs.#ctor(System.String,System.String,System.Exception)">
  4585. <summary>
  4586. Initializes a new instance of the <see cref="T:Mono.Addins.AddinErrorEventArgs"/> class.
  4587. </summary>
  4588. <param name="message">
  4589. Error message
  4590. </param>
  4591. <param name="addinId">
  4592. Add-in identifier.
  4593. </param>
  4594. <param name="exception">
  4595. Exception that caused the error.
  4596. </param>
  4597. </member>
  4598. <member name="P:Mono.Addins.AddinErrorEventArgs.Exception">
  4599. <summary>
  4600. Exception that caused the error.
  4601. </summary>
  4602. </member>
  4603. <member name="P:Mono.Addins.AddinErrorEventArgs.Message">
  4604. <summary>
  4605. Error message
  4606. </summary>
  4607. </member>
  4608. <member name="T:Mono.Addins.Addin">
  4609. <summary>
  4610. An add-in.
  4611. </summary>
  4612. </member>
  4613. <member name="M:Mono.Addins.Addin.SupportsVersion(System.String)">
  4614. <summary>
  4615. Checks version compatibility.
  4616. </summary>
  4617. <param name="version">
  4618. An add-in version.
  4619. </param>
  4620. <returns>
  4621. True if the provided version is compatible with this add-in.
  4622. </returns>
  4623. <remarks>
  4624. This method checks the CompatVersion property to know if the provided version is compatible with the version of this add-in.
  4625. </remarks>
  4626. </member>
  4627. <member name="M:Mono.Addins.Addin.ToString">
  4628. <summary>
  4629. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:Mono.Addins.Addin"/>.
  4630. </summary>
  4631. <returns>
  4632. A <see cref="T:System.String"/> that represents the current <see cref="T:Mono.Addins.Addin"/>.
  4633. </returns>
  4634. </member>
  4635. <member name="M:Mono.Addins.Addin.CompareVersions(System.String,System.String)">
  4636. <summary>
  4637. Compares two add-in versions
  4638. </summary>
  4639. <returns>
  4640. -1 if v1 is greater than v2, 0 if v1 == v2, 1 if v1 less than v2
  4641. </returns>
  4642. <param name='v1'>
  4643. A version
  4644. </param>
  4645. <param name='v2'>
  4646. A version
  4647. </param>
  4648. </member>
  4649. <member name="M:Mono.Addins.Addin.GetFullId(System.String,System.String,System.String)">
  4650. <summary>
  4651. Returns the identifier of an add-in
  4652. </summary>
  4653. <returns>
  4654. The full identifier.
  4655. </returns>
  4656. <param name='ns'>
  4657. Namespace of the add-in
  4658. </param>
  4659. <param name='id'>
  4660. Name of the add-in
  4661. </param>
  4662. <param name='version'>
  4663. Version of the add-in
  4664. </param>
  4665. </member>
  4666. <member name="M:Mono.Addins.Addin.GetIdName(System.String)">
  4667. <summary>
  4668. Given a full add-in identifier, returns the namespace and name of the add-in (it removes the version number)
  4669. </summary>
  4670. <param name='addinId'>
  4671. Add-in identifier.
  4672. </param>
  4673. </member>
  4674. <member name="M:Mono.Addins.Addin.GetIdVersion(System.String)">
  4675. <summary>
  4676. Given a full add-in identifier, returns the version the add-in
  4677. </summary>
  4678. <returns>
  4679. The version.
  4680. </returns>
  4681. </member>
  4682. <member name="M:Mono.Addins.Addin.GetIdParts(System.String,System.String@,System.String@)">
  4683. <summary>
  4684. Splits a full add-in identifier in name and version
  4685. </summary>
  4686. <param name='addinId'>
  4687. Add-in identifier.
  4688. </param>
  4689. <param name='name'>
  4690. The resulting name
  4691. </param>
  4692. <param name='version'>
  4693. The resulting version
  4694. </param>
  4695. </member>
  4696. <member name="P:Mono.Addins.Addin.Id">
  4697. <summary>
  4698. Full identifier of the add-in, including namespace and version.
  4699. </summary>
  4700. </member>
  4701. <member name="P:Mono.Addins.Addin.Namespace">
  4702. <summary>
  4703. Namespace of the add-in.
  4704. </summary>
  4705. </member>
  4706. <member name="P:Mono.Addins.Addin.LocalId">
  4707. <summary>
  4708. Identifier of the add-in (without namespace)
  4709. </summary>
  4710. </member>
  4711. <member name="P:Mono.Addins.Addin.Version">
  4712. <summary>
  4713. Version of the add-in
  4714. </summary>
  4715. </member>
  4716. <member name="P:Mono.Addins.Addin.Name">
  4717. <summary>
  4718. Display name of the add-in
  4719. </summary>
  4720. </member>
  4721. <member name="P:Mono.Addins.Addin.Properties">
  4722. <summary>
  4723. Custom properties specified in the add-in header
  4724. </summary>
  4725. </member>
  4726. <member name="P:Mono.Addins.Addin.Enabled">
  4727. <summary>
  4728. Gets or sets the enabled status of the add-in.
  4729. </summary>
  4730. <remarks>
  4731. This property can be used to enable or disable an add-in.
  4732. The enabled status of an add-in is stored in the add-in registry,
  4733. so when an add-in is disabled, it will be disabled for all applications
  4734. sharing the same registry.
  4735. When an add-in is enabled or disabled, the extension points currently loaded
  4736. in memory will be properly updated to include or exclude extensions from the add-in.
  4737. </remarks>
  4738. </member>
  4739. <member name="P:Mono.Addins.Addin.IsUserAddin">
  4740. <summary>
  4741. Returns 'true' if the add-in is installed in the user's personal folder
  4742. </summary>
  4743. </member>
  4744. <member name="P:Mono.Addins.Addin.AddinFile">
  4745. <summary>
  4746. Path to the add-in file (it can be an assembly or a standalone XML manifest)
  4747. </summary>
  4748. </member>
  4749. <member name="P:Mono.Addins.Addin.Description">
  4750. <summary>
  4751. Description of the add-in
  4752. </summary>
  4753. </member>
  4754. <member name="T:Mono.Addins.Description.ConditionTypeDescriptionCollection">
  4755. <summary>
  4756. A collection of condition types
  4757. </summary>
  4758. </member>
  4759. <member name="M:Mono.Addins.Description.ConditionTypeDescriptionCollection.#ctor">
  4760. <summary>
  4761. Initializes a new instance of the <see cref="T:Mono.Addins.Description.ConditionTypeDescriptionCollection"/> class.
  4762. </summary>
  4763. </member>
  4764. <member name="P:Mono.Addins.Description.ConditionTypeDescriptionCollection.Item(System.Int32)">
  4765. <summary>
  4766. Gets the <see cref="T:Mono.Addins.Description.ConditionTypeDescription"/> at the specified index.
  4767. </summary>
  4768. <param name="n">
  4769. Index.
  4770. </param>
  4771. <returns>
  4772. The condition.
  4773. </returns>
  4774. </member>
  4775. <member name="T:Mono.Addins.Description.ModuleCollection">
  4776. <summary>
  4777. A collection of module descriptions
  4778. </summary>
  4779. </member>
  4780. <member name="M:Mono.Addins.Description.ModuleCollection.#ctor">
  4781. <summary>
  4782. Initializes a new instance of the <see cref="T:Mono.Addins.Description.ModuleCollection"/> class.
  4783. </summary>
  4784. </member>
  4785. <member name="P:Mono.Addins.Description.ModuleCollection.Item(System.Int32)">
  4786. <summary>
  4787. Gets the <see cref="T:Mono.Addins.Description.ModuleDescription"/> at the specified index.
  4788. </summary>
  4789. <param name="n">
  4790. The index.
  4791. </param>
  4792. </member>
  4793. <member name="T:Mono.Addins.Description.NodeTypeAttributeCollection">
  4794. <summary>
  4795. A collection of node attributes
  4796. </summary>
  4797. </member>
  4798. <member name="M:Mono.Addins.Description.NodeTypeAttributeCollection.#ctor">
  4799. <summary>
  4800. Initializes a new instance of the <see cref="T:Mono.Addins.Description.NodeTypeAttributeCollection"/> class.
  4801. </summary>
  4802. </member>
  4803. <member name="P:Mono.Addins.Description.NodeTypeAttributeCollection.Item(System.Int32)">
  4804. <summary>
  4805. Gets the <see cref="T:Mono.Addins.Description.NodeTypeAttribute"/> at the specified index.
  4806. </summary>
  4807. <param name="n">
  4808. The index.
  4809. </param>
  4810. </member>
  4811. <member name="T:Mono.Addins.Description.AssemblyDependency">
  4812. <summary>
  4813. Definition of a dependency of an add-in on an assembly.
  4814. </summary>
  4815. </member>
  4816. <member name="M:Mono.Addins.Description.AssemblyDependency.#ctor">
  4817. <summary>
  4818. Initializes a new instance of the <see cref="T:Mono.Addins.Description.AssemblyDependency"/> class.
  4819. </summary>
  4820. </member>
  4821. <member name="P:Mono.Addins.Description.AssemblyDependency.FullName">
  4822. <summary>
  4823. Gets or sets the full name of the assembly
  4824. </summary>
  4825. <value>
  4826. The full name of the assembly.
  4827. </value>
  4828. </member>
  4829. <member name="P:Mono.Addins.Description.AssemblyDependency.Package">
  4830. <summary>
  4831. Gets or sets the name of the package that provides the assembly.
  4832. </summary>
  4833. <value>
  4834. The name of the package that provides the assembly.
  4835. </value>
  4836. </member>
  4837. <member name="P:Mono.Addins.Description.AssemblyDependency.Name">
  4838. <summary>
  4839. Display name of the dependency
  4840. </summary>
  4841. <value>
  4842. The name.
  4843. </value>
  4844. </member>
  4845. <member name="T:Mono.Addins.AddinModuleAttribute">
  4846. <summary>
  4847. Declares an optional add-in module
  4848. </summary>
  4849. </member>
  4850. <member name="M:Mono.Addins.AddinModuleAttribute.#ctor(System.String)">
  4851. <summary>
  4852. Initializes the instance.
  4853. </summary>
  4854. <param name="assemblyFile">
  4855. Relative path to the assembly that implements the optional module
  4856. </param>
  4857. </member>
  4858. <member name="P:Mono.Addins.AddinModuleAttribute.AssemblyFile">
  4859. <summary>
  4860. Relative path to the assembly that implements the optional module
  4861. </summary>
  4862. </member>
  4863. <member name="T:Mono.Addins.AddinRegistry">
  4864. <summary>
  4865. An add-in registry.
  4866. </summary>
  4867. <remarks>
  4868. An add-in registry is a data structure used by the add-in engine to locate add-ins to load.
  4869. A registry can be configured to look for add-ins in several directories. However, add-ins
  4870. copied to those directories won't be detected until an explicit add-in scan is requested.
  4871. The registry can be updated by an application by calling Registry.Update(), or by a user by
  4872. running the 'mautil' add-in setup tool.
  4873. The registry has information about the location of every add-in and a timestamp of the last
  4874. check, so the Update method will only scan new or modified add-ins. An application can
  4875. add a call to Registry.Update() in the Main method to detect all new add-ins every time the
  4876. app is started.
  4877. Every add-in added to the registry is parsed and validated, and if there is any error it
  4878. will be rejected. The registry is also in charge of scanning the add-in assemblies and look
  4879. for extensions and other information declared using custom attributes. That information is
  4880. merged with the manifest information (if there is one) to create a complete add-in
  4881. description ready to be used at run-time.
  4882. Mono.Addins allows sharing an add-in registry among several applications. In this context,
  4883. all applications sharing the registry share the same extension point model, and it is
  4884. possible to implement add-ins which extend several hosts.
  4885. </remarks>
  4886. </member>
  4887. <member name="M:Mono.Addins.AddinRegistry.#ctor(System.String)">
  4888. <summary>
  4889. Initializes a new instance.
  4890. </summary>
  4891. <param name="registryPath">
  4892. Location of the add-in registry.
  4893. </param>
  4894. <remarks>
  4895. Creates a new add-in registry located in the provided path.
  4896. The add-in registry will look for add-ins in an 'addins'
  4897. subdirectory of the provided registryPath.
  4898. When specifying a path, it is possible to use a special folder name as root.
  4899. For example: [Personal]/.config/MyApp. In this case, [Personal] will be replaced
  4900. by the location of the Environment.SpecialFolder.Personal folder. Any value
  4901. of the Environment.SpecialFolder enumeration can be used (always between square
  4902. brackets)
  4903. </remarks>
  4904. </member>
  4905. <member name="M:Mono.Addins.AddinRegistry.#ctor(System.String,System.String)">
  4906. <summary>
  4907. Initializes a new instance.
  4908. </summary>
  4909. <param name="registryPath">
  4910. Location of the add-in registry.
  4911. </param>
  4912. <param name="startupDirectory">
  4913. Location of the application.
  4914. </param>
  4915. <remarks>
  4916. Creates a new add-in registry located in the provided path.
  4917. The add-in registry will look for add-ins in an 'addins'
  4918. subdirectory of the provided registryPath.
  4919. When specifying a path, it is possible to use a special folder name as root.
  4920. For example: [Personal]/.config/MyApp. In this case, [Personal] will be replaced
  4921. by the location of the Environment.SpecialFolder.Personal folder. Any value
  4922. of the Environment.SpecialFolder enumeration can be used (always between square
  4923. brackets)
  4924. </remarks>
  4925. </member>
  4926. <member name="M:Mono.Addins.AddinRegistry.#ctor(System.String,System.String,System.String)">
  4927. <summary>
  4928. Initializes a new instance of the <see cref="T:Mono.Addins.AddinRegistry"/> class.
  4929. </summary>
  4930. <param name="registryPath">
  4931. Location of the add-in registry.
  4932. </param>
  4933. <param name="startupDirectory">
  4934. Location of the application.
  4935. </param>
  4936. <param name="addinsDir">
  4937. Add-ins directory. If the path is relative, it is considered to be relative
  4938. to the configDir directory.
  4939. </param>
  4940. <remarks>
  4941. Creates a new add-in registry located in the provided path.
  4942. Configuration information about the add-in registry will be stored in
  4943. 'registryPath'. The add-in registry will look for add-ins in the provided
  4944. 'addinsDir' directory.
  4945. When specifying a path, it is possible to use a special folder name as root.
  4946. For example: [Personal]/.config/MyApp. In this case, [Personal] will be replaced
  4947. by the location of the Environment.SpecialFolder.Personal folder. Any value
  4948. of the Environment.SpecialFolder enumeration can be used (always between square
  4949. brackets)
  4950. </remarks>
  4951. </member>
  4952. <member name="M:Mono.Addins.AddinRegistry.#ctor(System.String,System.String,System.String,System.String)">
  4953. <summary>
  4954. Initializes a new instance of the <see cref="T:Mono.Addins.AddinRegistry"/> class.
  4955. </summary>
  4956. <param name="registryPath">
  4957. Location of the add-in registry.
  4958. </param>
  4959. <param name="startupDirectory">
  4960. Location of the application.
  4961. </param>
  4962. <param name="addinsDir">
  4963. Add-ins directory. If the path is relative, it is considered to be relative
  4964. to the configDir directory.
  4965. </param>
  4966. <param name="databaseDir">
  4967. Location of the add-in database. If the path is relative, it is considered to be relative
  4968. to the configDir directory.
  4969. </param>
  4970. <remarks>
  4971. Creates a new add-in registry located in the provided path.
  4972. Configuration information about the add-in registry will be stored in
  4973. 'registryPath'. The add-in registry will look for add-ins in the provided
  4974. 'addinsDir' directory. Cached information about add-ins will be stored in
  4975. the 'databaseDir' directory.
  4976. When specifying a path, it is possible to use a special folder name as root.
  4977. For example: [Personal]/.config/MyApp. In this case, [Personal] will be replaced
  4978. by the location of the Environment.SpecialFolder.Personal folder. Any value
  4979. of the Environment.SpecialFolder enumeration can be used (always between square
  4980. brackets)
  4981. </remarks>
  4982. </member>
  4983. <member name="M:Mono.Addins.AddinRegistry.GetGlobalRegistry">
  4984. <summary>
  4985. Gets the global registry.
  4986. </summary>
  4987. <returns>
  4988. The global registry
  4989. </returns>
  4990. <remarks>
  4991. The global add-in registry is created in "~/.config/mono.addins",
  4992. and it is the default registry used when none is specified.
  4993. </remarks>
  4994. </member>
  4995. <member name="M:Mono.Addins.AddinRegistry.Dispose">
  4996. <summary>
  4997. Disposes the add-in engine.
  4998. </summary>
  4999. </member>
  5000. <member name="M:Mono.Addins.AddinRegistry.GetAddin(System.String)">
  5001. <summary>
  5002. Returns an add-in from the registry.
  5003. </summary>
  5004. <param name="id">
  5005. Identifier of the add-in.
  5006. </param>
  5007. <returns>
  5008. The add-in, or 'null' if not found.
  5009. </returns>
  5010. <remarks>
  5011. The add-in identifier may optionally include a version number, for example: "TextEditor.Xml,1.2"
  5012. </remarks>
  5013. </member>
  5014. <member name="M:Mono.Addins.AddinRegistry.GetAddin(System.String,System.Boolean)">
  5015. <summary>
  5016. Returns an add-in from the registry.
  5017. </summary>
  5018. <param name="id">
  5019. Identifier of the add-in.
  5020. </param>
  5021. <param name="exactVersionMatch">
  5022. 'true' if the exact add-in version must be found.
  5023. </param>
  5024. <returns>
  5025. The add-in, or 'null' if not found.
  5026. </returns>
  5027. <remarks>
  5028. The add-in identifier may optionally include a version number, for example: "TextEditor.Xml,1.2".
  5029. In this case, if the exact version is not found and exactVersionMatch is 'false', it will
  5030. return one than is compatible with the required version.
  5031. </remarks>
  5032. </member>
  5033. <member name="M:Mono.Addins.AddinRegistry.GetModules(Mono.Addins.AddinSearchFlags)">
  5034. <summary>
  5035. Gets all add-ins or add-in roots registered in the registry.
  5036. </summary>
  5037. <returns>
  5038. The addins.
  5039. </returns>
  5040. <param name='flags'>
  5041. Flags.
  5042. </param>
  5043. </member>
  5044. <member name="M:Mono.Addins.AddinRegistry.GetAddins">
  5045. <summary>
  5046. Gets all add-ins registered in the registry.
  5047. </summary>
  5048. <returns>
  5049. Add-ins registered in the registry.
  5050. </returns>
  5051. </member>
  5052. <member name="M:Mono.Addins.AddinRegistry.GetAddinRoots">
  5053. <summary>
  5054. Gets all add-in roots registered in the registry.
  5055. </summary>
  5056. <returns>
  5057. Descriptions of all add-in roots.
  5058. </returns>
  5059. </member>
  5060. <member name="M:Mono.Addins.AddinRegistry.GetAddinDescription(Mono.Addins.IProgressStatus,System.String)">
  5061. <summary>
  5062. Loads an add-in description
  5063. </summary>
  5064. <param name="progressStatus">
  5065. Progress tracker.
  5066. </param>
  5067. <param name="file">
  5068. Name of the file to load
  5069. </param>
  5070. <returns>
  5071. An add-in description
  5072. </returns>
  5073. <remarks>
  5074. This method loads an add-in description from a file. The file can be an XML manifest or an
  5075. assembly that implements an add-in.
  5076. </remarks>
  5077. </member>
  5078. <member name="M:Mono.Addins.AddinRegistry.ReadAddinManifestFile(System.String)">
  5079. <summary>
  5080. Reads an XML add-in manifest
  5081. </summary>
  5082. <param name="file">
  5083. Path to the XML file
  5084. </param>
  5085. <returns>
  5086. An add-in description
  5087. </returns>
  5088. </member>
  5089. <member name="M:Mono.Addins.AddinRegistry.ReadAddinManifestFile(System.IO.TextReader,System.String)">
  5090. <summary>
  5091. Reads an XML add-in manifest
  5092. </summary>
  5093. <param name="reader">
  5094. Reader that contains the XML
  5095. </param>
  5096. <param name="baseFile">
  5097. Base path to use to discover add-in files
  5098. </param>
  5099. <returns>
  5100. An add-in description
  5101. </returns>
  5102. </member>
  5103. <member name="M:Mono.Addins.AddinRegistry.IsAddinEnabled(System.String)">
  5104. <summary>
  5105. Checks whether an add-in is enabled.
  5106. </summary>
  5107. <param name="id">
  5108. Identifier of the add-in.
  5109. </param>
  5110. <returns>
  5111. 'true' if the add-in is enabled.
  5112. </returns>
  5113. </member>
  5114. <member name="M:Mono.Addins.AddinRegistry.EnableAddin(System.String)">
  5115. <summary>
  5116. Enables an add-in.
  5117. </summary>
  5118. <param name="id">
  5119. Identifier of the add-in
  5120. </param>
  5121. <remarks>
  5122. If the enabled add-in depends on other add-ins which are disabled,
  5123. those will automatically be enabled too.
  5124. </remarks>
  5125. </member>
  5126. <member name="M:Mono.Addins.AddinRegistry.DisableAddin(System.String)">
  5127. <summary>
  5128. Disables an add-in.
  5129. </summary>
  5130. <param name="id">
  5131. Identifier of the add-in.
  5132. </param>
  5133. <remarks>
  5134. When an add-in is disabled, all extension points it defines will be ignored
  5135. by the add-in engine. Other add-ins which depend on the disabled add-in will
  5136. also automatically be disabled.
  5137. </remarks>
  5138. </member>
  5139. <member name="M:Mono.Addins.AddinRegistry.RegisterForUninstall(System.String,System.Collections.Generic.IEnumerable{System.String})">
  5140. <summary>
  5141. Registers a set of add-ins for uninstallation.
  5142. </summary>
  5143. <param name='id'>
  5144. Identifier of the add-in
  5145. </param>
  5146. <param name='files'>
  5147. Files to be uninstalled
  5148. </param>
  5149. <remarks>
  5150. This method can be used to instruct the add-in manager to uninstall
  5151. an add-in the next time the registry is updated. This is useful
  5152. when an add-in manager can't delete an add-in because if it is
  5153. loaded.
  5154. </remarks>
  5155. </member>
  5156. <member name="M:Mono.Addins.AddinRegistry.IsRegisteredForUninstall(System.String)">
  5157. <summary>
  5158. Determines whether an add-in is registered for uninstallation
  5159. </summary>
  5160. <returns>
  5161. <c>true</c> if the add-in is registered for uninstallation
  5162. </returns>
  5163. <param name='addinId'>
  5164. Identifier of the add-in
  5165. </param>
  5166. </member>
  5167. <member name="M:Mono.Addins.AddinRegistry.DumpFile(System.String)">
  5168. <summary>
  5169. Internal use only
  5170. </summary>
  5171. </member>
  5172. <member name="M:Mono.Addins.AddinRegistry.ResetConfiguration">
  5173. <summary>
  5174. Resets the configuration files of the registry
  5175. </summary>
  5176. </member>
  5177. <member name="M:Mono.Addins.AddinRegistry.Update">
  5178. <summary>
  5179. Updates the add-in registry.
  5180. </summary>
  5181. <remarks>
  5182. This method must be called after modifying, installing or uninstalling add-ins.
  5183. When calling Update, every add-in added to the registry is parsed and validated,
  5184. and if there is any error it will be rejected. It will also cache add-in information
  5185. needed at run-time.
  5186. If during the update operation the registry finds new add-ins or detects that some
  5187. add-ins have been deleted, the loaded extension points will be updated to include
  5188. or exclude extension nodes from those add-ins.
  5189. </remarks>
  5190. </member>
  5191. <member name="M:Mono.Addins.AddinRegistry.Update(Mono.Addins.IProgressStatus)">
  5192. <summary>
  5193. Updates the add-in registry.
  5194. </summary>
  5195. <param name="monitor">
  5196. Progress monitor to keep track of the update operation.
  5197. </param>
  5198. <remarks>
  5199. This method must be called after modifying, installing or uninstalling add-ins.
  5200. When calling Update, every add-in added to the registry is parsed and validated,
  5201. and if there is any error it will be rejected. It will also cache add-in information
  5202. needed at run-time.
  5203. If during the update operation the registry finds new add-ins or detects that some
  5204. add-ins have been deleted, the loaded extension points will be updated to include
  5205. or exclude extension nodes from those add-ins.
  5206. </remarks>
  5207. </member>
  5208. <member name="M:Mono.Addins.AddinRegistry.Rebuild(Mono.Addins.IProgressStatus)">
  5209. <summary>
  5210. Regenerates the cached data of the add-in registry.
  5211. </summary>
  5212. <param name="monitor">
  5213. Progress monitor to keep track of the rebuild operation.
  5214. </param>
  5215. </member>
  5216. <member name="M:Mono.Addins.AddinRegistry.RegisterExtension(System.Object)">
  5217. <summary>
  5218. Registers an extension. Only AddinFileSystemExtension extensions are supported right now.
  5219. </summary>
  5220. <param name='extension'>
  5221. The extension to register
  5222. </param>
  5223. </member>
  5224. <member name="M:Mono.Addins.AddinRegistry.UnregisterExtension(System.Object)">
  5225. <summary>
  5226. Unregisters an extension.
  5227. </summary>
  5228. <param name='extension'>
  5229. The extension to unregister
  5230. </param>
  5231. </member>
  5232. <member name="P:Mono.Addins.AddinRegistry.RegistryPath">
  5233. <summary>
  5234. Location of the add-in registry.
  5235. </summary>
  5236. </member>
  5237. <member name="P:Mono.Addins.AddinRegistry.HasPendingUninstalls">
  5238. <summary>
  5239. Gets a value indicating whether there are pending add-ins to be uninstalled installed
  5240. </summary>
  5241. </member>
  5242. <member name="P:Mono.Addins.AddinRegistry.DefaultAddinsFolder">
  5243. <summary>
  5244. Gets the default add-ins folder of the registry.
  5245. </summary>
  5246. <remarks>
  5247. For every add-in registry there is an add-in folder where the registry will look for add-ins by default.
  5248. This folder is an "addins" subdirectory of the directory where the repository is located. In most cases,
  5249. this folder will only contain .addins files referencing other more convenient locations for add-ins.
  5250. </remarks>
  5251. </member>
  5252. <member name="T:Mono.Addins.AddinSearchFlags">
  5253. <summary>
  5254. Addin search flags.
  5255. </summary>
  5256. </member>
  5257. <member name="F:Mono.Addins.AddinSearchFlags.IncludeAddins">
  5258. <summary>
  5259. Add-ins are included in the search
  5260. </summary>
  5261. </member>
  5262. <member name="F:Mono.Addins.AddinSearchFlags.IncludeRoots">
  5263. <summary>
  5264. Add-in roots are included in the search
  5265. </summary>
  5266. </member>
  5267. <member name="F:Mono.Addins.AddinSearchFlags.IncludeAll">
  5268. <summary>
  5269. Both add-in and add-in roots are included in the search
  5270. </summary>
  5271. </member>
  5272. <member name="F:Mono.Addins.AddinSearchFlags.LatestVersionsOnly">
  5273. <summary>
  5274. Only the latest version of every add-in or add-in root is included in the search
  5275. </summary>
  5276. </member>
  5277. <member name="T:Mono.Addins.ConsoleProgressStatus">
  5278. <summary>
  5279. An IProgressStatus class which writes output to the console.
  5280. </summary>
  5281. </member>
  5282. <member name="T:Mono.Addins.IProgressStatus">
  5283. <summary>
  5284. Progress status listener.
  5285. </summary>
  5286. </member>
  5287. <member name="M:Mono.Addins.IProgressStatus.SetMessage(System.String)">
  5288. <summary>
  5289. Sets the description of the current operation.
  5290. </summary>
  5291. <param name="msg">
  5292. A message
  5293. </param>
  5294. <remarks>
  5295. This method is called by the add-in engine to show a description of the operation being monitorized.
  5296. </remarks>
  5297. </member>
  5298. <member name="M:Mono.Addins.IProgressStatus.SetProgress(System.Double)">
  5299. <summary>
  5300. Sets the progress of the operation.
  5301. </summary>
  5302. <param name="progress">
  5303. A number between 0 and 1. 0 means no progress, 1 means operation completed.
  5304. </param>
  5305. <remarks>
  5306. This method is called by the add-in engine to show the progress of the operation being monitorized.
  5307. </remarks>
  5308. </member>
  5309. <member name="M:Mono.Addins.IProgressStatus.Log(System.String)">
  5310. <summary>
  5311. Writes text to the log.
  5312. </summary>
  5313. <param name="msg">
  5314. Message to write
  5315. </param>
  5316. </member>
  5317. <member name="M:Mono.Addins.IProgressStatus.ReportWarning(System.String)">
  5318. <summary>
  5319. Reports a warning.
  5320. </summary>
  5321. <param name="message">
  5322. Warning message
  5323. </param>
  5324. <remarks>
  5325. This method is called by the add-in engine to report a warning in the operation being monitorized.
  5326. </remarks>
  5327. </member>
  5328. <member name="M:Mono.Addins.IProgressStatus.ReportError(System.String,System.Exception)">
  5329. <summary>
  5330. Reports an error.
  5331. </summary>
  5332. <param name="message">
  5333. Error message
  5334. </param>
  5335. <param name="exception">
  5336. Exception that caused the error. It can be null.
  5337. </param>
  5338. <remarks>
  5339. This method is called by the add-in engine to report an error occurred while executing the operation being monitorized.
  5340. </remarks>
  5341. </member>
  5342. <member name="M:Mono.Addins.IProgressStatus.Cancel">
  5343. <summary>
  5344. Cancels the operation being montorized.
  5345. </summary>
  5346. </member>
  5347. <member name="P:Mono.Addins.IProgressStatus.LogLevel">
  5348. <summary>
  5349. Log level requested by the user: 0: no log, 1: normal log, >1 verbose log
  5350. </summary>
  5351. </member>
  5352. <member name="P:Mono.Addins.IProgressStatus.IsCanceled">
  5353. <summary>
  5354. Returns True when the user requested to cancel this operation
  5355. </summary>
  5356. </member>
  5357. <member name="M:Mono.Addins.ConsoleProgressStatus.#ctor(System.Boolean)">
  5358. <summary>
  5359. Initializes a new instance
  5360. </summary>
  5361. <param name="verboseLog">
  5362. Set to true to enabled verbose log
  5363. </param>
  5364. </member>
  5365. <member name="M:Mono.Addins.ConsoleProgressStatus.#ctor(System.Int32)">
  5366. <summary>
  5367. Initializes a new instance
  5368. </summary>
  5369. <param name="logLevel">
  5370. Verbosity level. 0: not verbose, 1: normal, >1 extra verbose
  5371. </param>
  5372. </member>
  5373. <member name="M:Mono.Addins.ConsoleProgressStatus.SetMessage(System.String)">
  5374. <summary>
  5375. Sets the description of the current operation.
  5376. </summary>
  5377. <param name="msg">
  5378. A message
  5379. </param>
  5380. <remarks>
  5381. This method is called by the add-in engine to show a description of the operation being monitorized.
  5382. </remarks>
  5383. </member>
  5384. <member name="M:Mono.Addins.ConsoleProgressStatus.SetProgress(System.Double)">
  5385. <summary>
  5386. Sets the progress of the operation.
  5387. </summary>
  5388. <param name="progress">
  5389. A number between 0 and 1. 0 means no progress, 1 means operation completed.
  5390. </param>
  5391. <remarks>
  5392. This method is called by the add-in engine to show the progress of the operation being monitorized.
  5393. </remarks>
  5394. </member>
  5395. <member name="M:Mono.Addins.ConsoleProgressStatus.Log(System.String)">
  5396. <summary>
  5397. Writes text to the log.
  5398. </summary>
  5399. <param name="msg">
  5400. Message to write
  5401. </param>
  5402. </member>
  5403. <member name="M:Mono.Addins.ConsoleProgressStatus.ReportWarning(System.String)">
  5404. <summary>
  5405. Reports a warning.
  5406. </summary>
  5407. <param name="message">
  5408. Warning message
  5409. </param>
  5410. <remarks>
  5411. This method is called by the add-in engine to report a warning in the operation being monitorized.
  5412. </remarks>
  5413. </member>
  5414. <member name="M:Mono.Addins.ConsoleProgressStatus.ReportError(System.String,System.Exception)">
  5415. <summary>
  5416. Reports an error.
  5417. </summary>
  5418. <param name="message">
  5419. Error message
  5420. </param>
  5421. <param name="exception">
  5422. Exception that caused the error. It can be null.
  5423. </param>
  5424. <remarks>
  5425. This method is called by the add-in engine to report an error occurred while executing the operation being monitorized.
  5426. </remarks>
  5427. </member>
  5428. <member name="M:Mono.Addins.ConsoleProgressStatus.Cancel">
  5429. <summary>
  5430. Cancels the operation being montorized.
  5431. </summary>
  5432. </member>
  5433. <member name="P:Mono.Addins.ConsoleProgressStatus.IsCanceled">
  5434. <summary>
  5435. Returns True when the user requested to cancel this operation
  5436. </summary>
  5437. </member>
  5438. <member name="P:Mono.Addins.ConsoleProgressStatus.LogLevel">
  5439. <summary>
  5440. Log level requested by the user: 0: no log, 1: normal log, >1 verbose log
  5441. </summary>
  5442. </member>
  5443. <member name="T:Mono.Addins.Description.AddinDependency">
  5444. <summary>
  5445. Definition of a dependency of an add-in on another add-in.
  5446. </summary>
  5447. </member>
  5448. <member name="M:Mono.Addins.Description.AddinDependency.#ctor">
  5449. <summary>
  5450. Initializes a new instance of the <see cref="T:Mono.Addins.Description.AddinDependency"/> class.
  5451. </summary>
  5452. </member>
  5453. <member name="M:Mono.Addins.Description.AddinDependency.#ctor(System.String)">
  5454. <summary>
  5455. Initializes a new instance of the <see cref="T:Mono.Addins.Description.AddinDependency"/> class.
  5456. </summary>
  5457. <param name="fullId">
  5458. Full identifier of the add-in (includes version)
  5459. </param>
  5460. </member>
  5461. <member name="M:Mono.Addins.Description.AddinDependency.#ctor(System.String,System.String)">
  5462. <summary>
  5463. Initializes a new instance of the <see cref="T:Mono.Addins.Description.AddinDependency"/> class.
  5464. </summary>
  5465. <param name="id">
  5466. Identifier of the add-in.
  5467. </param>
  5468. <param name="version">
  5469. Version of the add-in.
  5470. </param>
  5471. </member>
  5472. <member name="P:Mono.Addins.Description.AddinDependency.FullAddinId">
  5473. <summary>
  5474. Gets the full addin identifier.
  5475. </summary>
  5476. <value>
  5477. The full addin identifier.
  5478. </value>
  5479. <remarks>
  5480. Includes namespace and version number. For example: MonoDevelop.TextEditor,1.0
  5481. </remarks>
  5482. </member>
  5483. <member name="P:Mono.Addins.Description.AddinDependency.AddinId">
  5484. <summary>
  5485. Gets or sets the addin identifier.
  5486. </summary>
  5487. <value>
  5488. The addin identifier.
  5489. </value>
  5490. </member>
  5491. <member name="P:Mono.Addins.Description.AddinDependency.Version">
  5492. <summary>
  5493. Gets or sets the version.
  5494. </summary>
  5495. <value>
  5496. The version.
  5497. </value>
  5498. </member>
  5499. <member name="P:Mono.Addins.Description.AddinDependency.Name">
  5500. <summary>
  5501. Display name of the dependency.
  5502. </summary>
  5503. <value>
  5504. The name.
  5505. </value>
  5506. </member>
  5507. <member name="T:Mono.Addins.NodeAttributeAttribute">
  5508. <summary>
  5509. Indicates that a field or property is bound to a node attribute
  5510. </summary>
  5511. </member>
  5512. <member name="M:Mono.Addins.NodeAttributeAttribute.#ctor">
  5513. <summary>
  5514. Initializes a new instance
  5515. </summary>
  5516. </member>
  5517. <member name="M:Mono.Addins.NodeAttributeAttribute.#ctor(System.String)">
  5518. <summary>
  5519. Initializes a new instance
  5520. </summary>
  5521. <param name="name">
  5522. XML name of the attribute.
  5523. </param>
  5524. </member>
  5525. <member name="M:Mono.Addins.NodeAttributeAttribute.#ctor(System.String,System.String)">
  5526. <summary>
  5527. Initializes a new instance
  5528. </summary>
  5529. <param name="name">
  5530. XML name of the attribute.
  5531. </param>
  5532. <param name="description">
  5533. Description of the attribute.
  5534. </param>
  5535. </member>
  5536. <member name="M:Mono.Addins.NodeAttributeAttribute.#ctor(System.String,System.Boolean)">
  5537. <summary>
  5538. Initializes a new instance
  5539. </summary>
  5540. <param name="name">
  5541. XML name of the attribute.
  5542. </param>
  5543. <param name="required">
  5544. Indicates whether the attribute is required or not.
  5545. </param>
  5546. </member>
  5547. <member name="M:Mono.Addins.NodeAttributeAttribute.#ctor(System.String,System.Boolean,System.String)">
  5548. <summary>
  5549. Initializes a new instance
  5550. </summary>
  5551. <param name="name">
  5552. XML name of the attribute.
  5553. </param>
  5554. <param name="required">
  5555. Indicates whether the attribute is required or not.
  5556. </param>
  5557. <param name="description">
  5558. Description of the attribute.
  5559. </param>
  5560. </member>
  5561. <member name="M:Mono.Addins.NodeAttributeAttribute.#ctor(System.String,System.Type)">
  5562. <summary>
  5563. Initializes a new instance
  5564. </summary>
  5565. <param name="name">
  5566. XML name of the attribute.
  5567. </param>
  5568. <param name="type">
  5569. Type of the extension node attribute.
  5570. </param>
  5571. <remarks>
  5572. The type of the attribute is only required when applying this attribute at class level.
  5573. It is not required when it is applied to a field, since the attribute type will be the type of the field.
  5574. </remarks>
  5575. </member>
  5576. <member name="M:Mono.Addins.NodeAttributeAttribute.#ctor(System.String,System.Type,System.String)">
  5577. <summary>
  5578. Initializes a new instance
  5579. </summary>
  5580. <param name="name">
  5581. XML name of the attribute.
  5582. </param>
  5583. <param name="type">
  5584. Type of the extension node attribute.
  5585. </param>
  5586. <param name="description">
  5587. Description of the attribute.
  5588. </param>
  5589. <remarks>
  5590. The type of the attribute is only required when applying this attribute at class level.
  5591. It is not required when it is applied to a field, since the attribute type will be the type of the field.
  5592. </remarks>
  5593. </member>
  5594. <member name="M:Mono.Addins.NodeAttributeAttribute.#ctor(System.String,System.Type,System.Boolean)">
  5595. <summary>
  5596. Initializes a new instance
  5597. </summary>
  5598. <param name="name">
  5599. XML name of the attribute.
  5600. </param>
  5601. <param name="type">
  5602. Type of the extension node attribute.
  5603. </param>
  5604. <param name="required">
  5605. Indicates whether the attribute is required or not.
  5606. </param>
  5607. <remarks>
  5608. The type of the attribute is only required when applying this attribute at class level.
  5609. It is not required when it is applied to a field, since the attribute type will be the type of the field.
  5610. </remarks>
  5611. </member>
  5612. <member name="M:Mono.Addins.NodeAttributeAttribute.#ctor(System.String,System.Type,System.Boolean,System.String)">
  5613. <summary>
  5614. Initializes a new instance
  5615. </summary>
  5616. <param name="name">
  5617. XML name of the attribute.
  5618. </param>
  5619. <param name="type">
  5620. Type of the extension node attribute.
  5621. </param>
  5622. <param name="required">
  5623. Indicates whether the attribute is required or not.
  5624. </param>
  5625. <param name="description">
  5626. Description of the attribute.
  5627. </param>
  5628. <remarks>
  5629. The type of the attribute is only required when applying this attribute at class level.
  5630. It is not required when it is applied to a field, since the attribute type will be the type of the field.
  5631. </remarks>
  5632. </member>
  5633. <member name="P:Mono.Addins.NodeAttributeAttribute.Name">
  5634. <summary>
  5635. XML name of the attribute.
  5636. </summary>
  5637. <remarks>
  5638. If the name is not specified, the field name to which the [NodeAttribute]
  5639. is applied will be used as name. Providing a name is mandatory when applying
  5640. [NodeAttribute] at class level.
  5641. </remarks>
  5642. </member>
  5643. <member name="P:Mono.Addins.NodeAttributeAttribute.Required">
  5644. <summary>
  5645. Indicates whether the attribute is required or not.
  5646. </summary>
  5647. </member>
  5648. <member name="P:Mono.Addins.NodeAttributeAttribute.Type">
  5649. <summary>
  5650. Type of the extension node attribute.
  5651. </summary>
  5652. <remarks>
  5653. To be used only when applying [NodeAttribute] at class level. It is not required when it
  5654. is applied to a field, since the attribute type will be the type of the field.
  5655. </remarks>
  5656. </member>
  5657. <member name="P:Mono.Addins.NodeAttributeAttribute.Description">
  5658. <summary>
  5659. Description of the attribute.
  5660. </summary>
  5661. <remarks>
  5662. To be used in the extension point documentation.
  5663. </remarks>
  5664. </member>
  5665. <member name="P:Mono.Addins.NodeAttributeAttribute.Localizable">
  5666. <summary>
  5667. When set to True, the value of the field or property is expected to be a string id which
  5668. will be localized by the add-in engine
  5669. </summary>
  5670. </member>
  5671. <member name="P:Mono.Addins.NodeAttributeAttribute.ContentType">
  5672. <summary>
  5673. Gets or sets the type of the content.
  5674. </summary>
  5675. <remarks>
  5676. Allows specifying the type of the content of a string attribute.
  5677. This value is for documentation purposes only.
  5678. </remarks>
  5679. </member>
  5680. <member name="T:Mono.Addins.Description.AddinPropertyCollection">
  5681. <summary>
  5682. A collection of add-in properties
  5683. </summary>
  5684. </member>
  5685. <member name="M:Mono.Addins.Description.AddinPropertyCollection.GetPropertyValue(System.String)">
  5686. <summary>
  5687. Gets the value of a property
  5688. </summary>
  5689. <returns>
  5690. The property value.
  5691. </returns>
  5692. <param name='name'>
  5693. Name of the property.
  5694. </param>
  5695. <remarks>
  5696. If the property is localized, it will return the value for the current language if exists, or the
  5697. default value if it doesn't.
  5698. </remarks>
  5699. </member>
  5700. <member name="M:Mono.Addins.Description.AddinPropertyCollection.GetPropertyValue(System.String,System.String)">
  5701. <summary>
  5702. Gets the value of a property
  5703. </summary>
  5704. <returns>
  5705. The property value.
  5706. </returns>
  5707. <param name='name'>
  5708. Name of the property.
  5709. </param>
  5710. <param name='locale'>
  5711. Locale for which the value must be returned.
  5712. </param>
  5713. </member>
  5714. <member name="M:Mono.Addins.Description.AddinPropertyCollection.SetPropertyValue(System.String,System.String)">
  5715. <summary>
  5716. Sets the value of a property
  5717. </summary>
  5718. <param name='name'>
  5719. Name of the property
  5720. </param>
  5721. <param name='value'>
  5722. New value.
  5723. </param>
  5724. </member>
  5725. <member name="M:Mono.Addins.Description.AddinPropertyCollection.SetPropertyValue(System.String,System.String,System.String)">
  5726. <summary>
  5727. Sets the value of a property for a specific locale
  5728. </summary>
  5729. <param name='name'>
  5730. Name of the property.
  5731. </param>
  5732. <param name='value'>
  5733. New value.
  5734. </param>
  5735. <param name='locale'>
  5736. Locale of the property to be set.
  5737. </param>
  5738. </member>
  5739. <member name="M:Mono.Addins.Description.AddinPropertyCollection.RemoveProperty(System.String)">
  5740. <summary>
  5741. Removes a property.
  5742. </summary>
  5743. <param name='name'>
  5744. Name of the property.
  5745. </param>
  5746. <remarks>
  5747. This method only removes properties which have no locale set.
  5748. </remarks>
  5749. </member>
  5750. <member name="M:Mono.Addins.Description.AddinPropertyCollection.RemoveProperty(System.String,System.String)">
  5751. <summary>
  5752. Removes a property with a specified locale
  5753. </summary>
  5754. <param name='name'>
  5755. Name of the property
  5756. </param>
  5757. <param name='locale'>
  5758. Locale of the property
  5759. </param>
  5760. </member>
  5761. <member name="T:Mono.Addins.ImportAddinFileAttribute">
  5762. <summary>
  5763. Declares an add-in file import
  5764. </summary>
  5765. <remarks>
  5766. An add-in may be composed by several assemblies and data files.
  5767. Data files must be declared in the main assembly using this attribute, or in the XML manifest.
  5768. It is important to properly declare all files used by an add-in.
  5769. This information is used by setup tools to know exactly what needs to be packaged when creating
  5770. an add-in package, or to know what needs to be deleted when removing an add-in.
  5771. </remarks>
  5772. </member>
  5773. <member name="M:Mono.Addins.ImportAddinFileAttribute.#ctor(System.String)">
  5774. <summary>
  5775. Initializes a new instance
  5776. </summary>
  5777. <param name="filePath">
  5778. Path to the file. Must be relative to the assembly declaring this attribute.
  5779. </param>
  5780. </member>
  5781. <member name="P:Mono.Addins.ImportAddinFileAttribute.FilePath">
  5782. <summary>
  5783. Path to the file. Must be relative to the assembly declaring this attribute.
  5784. </summary>
  5785. </member>
  5786. <member name="T:Mono.Addins.Description.NodeSetIdCollection">
  5787. <summary>
  5788. A collection of node set identifiers
  5789. </summary>
  5790. </member>
  5791. <member name="M:Mono.Addins.Description.NodeSetIdCollection.GetEnumerator">
  5792. <summary>
  5793. Gets the collection enumerator.
  5794. </summary>
  5795. <returns>
  5796. The enumerator.
  5797. </returns>
  5798. </member>
  5799. <member name="M:Mono.Addins.Description.NodeSetIdCollection.Add(System.String)">
  5800. <summary>
  5801. Add the specified node set identifier.
  5802. </summary>
  5803. <param name='nodeSetId'>
  5804. Node set identifier.
  5805. </param>
  5806. </member>
  5807. <member name="M:Mono.Addins.Description.NodeSetIdCollection.Remove(System.String)">
  5808. <summary>
  5809. Remove a node set identifier
  5810. </summary>
  5811. <param name='nodeSetId'>
  5812. Node set identifier.
  5813. </param>
  5814. </member>
  5815. <member name="M:Mono.Addins.Description.NodeSetIdCollection.Clear">
  5816. <summary>
  5817. Clears the collection
  5818. </summary>
  5819. </member>
  5820. <member name="M:Mono.Addins.Description.NodeSetIdCollection.Contains(System.String)">
  5821. <summary>
  5822. Checks if the specified identifier is present in the collection
  5823. </summary>
  5824. <param name='nodeSetId'>
  5825. <c>true</c> if the node set identifier is present.
  5826. </param>
  5827. </member>
  5828. <member name="M:Mono.Addins.Description.NodeSetIdCollection.IndexOf(System.String)">
  5829. <summary>
  5830. Returns the index of the specified node set identifier
  5831. </summary>
  5832. <returns>
  5833. The index.
  5834. </returns>
  5835. <param name='nodeSetId'>
  5836. A node set identifier.
  5837. </param>
  5838. </member>
  5839. <member name="P:Mono.Addins.Description.NodeSetIdCollection.Item(System.Int32)">
  5840. <summary>
  5841. Gets the node set identifier at the specified index.
  5842. </summary>
  5843. <param name='n'>
  5844. An index.
  5845. </param>
  5846. </member>
  5847. <member name="P:Mono.Addins.Description.NodeSetIdCollection.Count">
  5848. <summary>
  5849. Gets the item count.
  5850. </summary>
  5851. <value>
  5852. The count.
  5853. </value>
  5854. </member>
  5855. <member name="T:Mono.Addins.Description.ModuleDescription">
  5856. <summary>
  5857. A module definition.
  5858. </summary>
  5859. <remarks>
  5860. Optional modules can be used to declare extensions which will be registered only if some
  5861. specified add-in dependencies can be satisfied.
  5862. </remarks>
  5863. </member>
  5864. <member name="M:Mono.Addins.Description.ModuleDescription.#ctor">
  5865. <summary>
  5866. Initializes a new instance of the <see cref="T:Mono.Addins.Description.ModuleDescription"/> class.
  5867. </summary>
  5868. </member>
  5869. <member name="M:Mono.Addins.Description.ModuleDescription.DependsOnAddin(System.String)">
  5870. <summary>
  5871. Checks if this module depends on the specified add-in.
  5872. </summary>
  5873. <returns>
  5874. <c>true</c> if there is a dependency.
  5875. </returns>
  5876. <param name='addinId'>
  5877. Identifier of the add-in
  5878. </param>
  5879. </member>
  5880. <member name="M:Mono.Addins.Description.ModuleDescription.AddExtensionNode(System.String,System.String)">
  5881. <summary>
  5882. Adds an extension node to the module.
  5883. </summary>
  5884. <returns>
  5885. The extension node.
  5886. </returns>
  5887. <param name='path'>
  5888. Path that identifies the extension point.
  5889. </param>
  5890. <param name='nodeName'>
  5891. Node name.
  5892. </param>
  5893. <remarks>
  5894. This method creates a new Extension object for the provided path if none exist.
  5895. </remarks>
  5896. </member>
  5897. <member name="M:Mono.Addins.Description.ModuleDescription.GetExtension(System.String)">
  5898. <summary>
  5899. Gets an extension instance.
  5900. </summary>
  5901. <returns>
  5902. The extension instance.
  5903. </returns>
  5904. <param name='path'>
  5905. Path that identifies the extension point that the extension extends.
  5906. </param>
  5907. <remarks>
  5908. This method creates a new Extension object for the provided path if none exist.
  5909. </remarks>
  5910. </member>
  5911. <member name="M:Mono.Addins.Description.ModuleDescription.AddAssemblyReference(System.String,System.String)">
  5912. <summary>
  5913. Adds an add-in reference (there is a typo in the method name)
  5914. </summary>
  5915. <param name='id'>
  5916. Identifier of the add-in.
  5917. </param>
  5918. <param name='version'>
  5919. Version of the add-in.
  5920. </param>
  5921. </member>
  5922. <member name="P:Mono.Addins.Description.ModuleDescription.IgnorePaths">
  5923. <summary>
  5924. Gets the list of paths to be ignored by the add-in scanner.
  5925. </summary>
  5926. </member>
  5927. <member name="P:Mono.Addins.Description.ModuleDescription.AllFiles">
  5928. <summary>
  5929. Gets all external files
  5930. </summary>
  5931. <value>
  5932. All files.
  5933. </value>
  5934. <remarks>
  5935. External files are data files and assemblies explicitly referenced in the Runtime section of the add-in manifest.
  5936. </remarks>
  5937. </member>
  5938. <member name="P:Mono.Addins.Description.ModuleDescription.Assemblies">
  5939. <summary>
  5940. Gets the list of external assemblies used by this module.
  5941. </summary>
  5942. </member>
  5943. <member name="P:Mono.Addins.Description.ModuleDescription.DataFiles">
  5944. <summary>
  5945. Gets the list of external data files used by this module
  5946. </summary>
  5947. </member>
  5948. <member name="P:Mono.Addins.Description.ModuleDescription.Dependencies">
  5949. <summary>
  5950. Gets the dependencies of this module
  5951. </summary>
  5952. </member>
  5953. <member name="P:Mono.Addins.Description.ModuleDescription.Extensions">
  5954. <summary>
  5955. Gets the extensions of this module
  5956. </summary>
  5957. </member>
  5958. <member name="T:Mono.Addins.AddinCategoryAttribute">
  5959. <summary>
  5960. Addin category attribute.
  5961. </summary>
  5962. </member>
  5963. <member name="M:Mono.Addins.AddinCategoryAttribute.#ctor(System.String)">
  5964. <summary>
  5965. Initializes the attribute
  5966. </summary>
  5967. <param name="category">
  5968. The category to which the add-in belongs
  5969. </param>
  5970. </member>
  5971. <member name="P:Mono.Addins.AddinCategoryAttribute.Category">
  5972. <summary>
  5973. The category to which the add-in belongs
  5974. </summary>
  5975. </member>
  5976. <member name="T:Mono.Addins.Description.ExtensionNodeTypeCollection">
  5977. <summary>
  5978. A collection of node types.
  5979. </summary>
  5980. </member>
  5981. <member name="M:Mono.Addins.Description.ExtensionNodeTypeCollection.#ctor">
  5982. <summary>
  5983. Initializes a new instance of the <see cref="T:Mono.Addins.Description.ExtensionNodeTypeCollection"/> class.
  5984. </summary>
  5985. </member>
  5986. <member name="P:Mono.Addins.Description.ExtensionNodeTypeCollection.Item(System.Int32)">
  5987. <summary>
  5988. Gets the <see cref="T:Mono.Addins.Description.ExtensionNodeType"/> at the specified index.
  5989. </summary>
  5990. <param name="n">
  5991. The index.
  5992. </param>
  5993. </member>
  5994. <member name="P:Mono.Addins.Description.ExtensionNodeTypeCollection.Item(System.String)">
  5995. <summary>
  5996. Gets the <see cref="T:Mono.Addins.Description.ExtensionNodeType"/> with the specified id.
  5997. </summary>
  5998. <param name="id">
  5999. Identifier.
  6000. </param>
  6001. </member>
  6002. <member name="T:Mono.Addins.Description.NodeTypeAttribute">
  6003. <summary>
  6004. Description of the attribute of a node type.
  6005. </summary>
  6006. </member>
  6007. <member name="M:Mono.Addins.Description.NodeTypeAttribute.#ctor">
  6008. <summary>
  6009. Initializes a new instance of the <see cref="T:Mono.Addins.Description.NodeTypeAttribute"/> class.
  6010. </summary>
  6011. </member>
  6012. <member name="M:Mono.Addins.Description.NodeTypeAttribute.CopyFrom(Mono.Addins.Description.NodeTypeAttribute)">
  6013. <summary>
  6014. Copies data from another node attribute.
  6015. </summary>
  6016. <param name='att'>
  6017. The attribute from which to copy.
  6018. </param>
  6019. </member>
  6020. <member name="P:Mono.Addins.Description.NodeTypeAttribute.Name">
  6021. <summary>
  6022. Gets or sets the name of the attribute.
  6023. </summary>
  6024. <value>
  6025. The name.
  6026. </value>
  6027. </member>
  6028. <member name="P:Mono.Addins.Description.NodeTypeAttribute.Required">
  6029. <summary>
  6030. Gets or sets a value indicating whether this <see cref="T:Mono.Addins.Description.NodeTypeAttribute"/> is required.
  6031. </summary>
  6032. <value>
  6033. <c>true</c> if required; otherwise, <c>false</c>.
  6034. </value>
  6035. </member>
  6036. <member name="P:Mono.Addins.Description.NodeTypeAttribute.Localizable">
  6037. <summary>
  6038. Gets or sets a value indicating whether this <see cref="T:Mono.Addins.Description.NodeTypeAttribute"/> is localizable.
  6039. </summary>
  6040. <value>
  6041. <c>true</c> if localizable; otherwise, <c>false</c>.
  6042. </value>
  6043. </member>
  6044. <member name="P:Mono.Addins.Description.NodeTypeAttribute.Type">
  6045. <summary>
  6046. Gets or sets the type of the attribute.
  6047. </summary>
  6048. <value>
  6049. The type.
  6050. </value>
  6051. </member>
  6052. <member name="P:Mono.Addins.Description.NodeTypeAttribute.Description">
  6053. <summary>
  6054. Gets or sets the description of the attribute.
  6055. </summary>
  6056. <value>
  6057. The description.
  6058. </value>
  6059. </member>
  6060. <member name="P:Mono.Addins.Description.NodeTypeAttribute.ContentType">
  6061. <summary>
  6062. Gets or sets the type of the content.
  6063. </summary>
  6064. <remarks>
  6065. Allows specifying the type of the content of a string attribute.
  6066. The value of this property is only informative, and it doesn't
  6067. have any effect on how add-ins are packaged or loaded.
  6068. </remarks>
  6069. </member>
  6070. </members>
  6071. </doc>