| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>Infragistics2.Win.UltraWinSpellChecker.v9.2</name>
- </assembly>
- <members>
- <member name="M:Infragistics.Shared.LocalizedCategoryAttribute.GetLocalizedString(System.String)">
- <summary>
- Returns the localized category name
- </summary>
- <param name="value">Name of the category to retreive</param>
- <returns>The localized string value</returns>
- </member>
- <member name="M:Infragistics.Shared.UltraLicenseAttribute.GetLicensedWithProducts">
- <summary>
- Return the list of products that this control can be licensed with
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.UltraSpellCheckerRole">
- <summary>
- Role class for the <see cref="T:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker"/> derived controls.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellCheckerRole.#ctor(Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker)">
- <summary>
- Creates a new <see cref="T:Infragistics.Win.UltraWinSpellChecker.UltraSpellCheckerRole"/> instance.
- </summary>
- <param name="spellChecker">The spell checker associated with the component role.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellCheckerRole.GetRoleNames">
- <summary>
- Used by the associated <see cref="T:Infragistics.Win.AppStyling.ComponentRole"/> to determine which <see cref="T:Infragistics.Win.AppStyling.UIRole"/> instances should be cached.
- </summary>
- <returns>An array of strings containing the names of the role names that should be cached.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellCheckerRole.OnStyleChanged">
- <summary>
- Invoked when the style information for the component has changed.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellCheckerRole.SpellChecker">
- <summary>
- Returns the associated UltraSpellChecker instance.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellCheckerRole.SynchronizingObject">
- <summary>
- Gets an object used for threading synchronization
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.UltraWinSpellCheckerAssemblyStyleInfo">
- <summary>
- Class used by the app styling infrastructure that provides the role and
- component role defitions used by the assembly.
- </summary>
- <remarks>
- <p class="note"><b>Note:</b> A parameterless constructor is required for all derived classes.</p>
- </remarks>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraWinSpellCheckerAssemblyStyleInfo.GetRoles">
- <summary>
- Returns an array of objects that define the roles provided by an assembly.
- </summary>
- <returns></returns>
- <seealso cref="T:Infragistics.Win.AppStyling.Definitions.UIRoleDefinition"/>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraWinSpellCheckerAssemblyStyleInfo.GetComponents">
- <summary>
- Returns an array of objects that define the component roles provided by an assembly.
- </summary>
- <returns></returns>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.AsYouTypeManager">
- <summary>
- Handles the painting of underlines under misspelled words in a control being spell checked
- </summary>
- <remarks>
- This class can be derived from for custom painting of other controls.
- </remarks>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.AsYouTypeManager.#ctor(Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker,System.Object)">
- <summary>
- Creates a new <see cref="T:Infragistics.Win.UltraWinSpellChecker.AsYouTypeManager"/> instance.
- </summary>
- <param name="spellChecker">The spell checker assocated with the manager.</param>
- <param name="spellCheckTarget">The target object being "as you type" spell checked.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.AsYouTypeManager.AddUnderlinedError(Infragistics.Win.UltraWinSpellChecker.Error)">
- <summary>
- Underlines a misspelled word described by the specified <see cref="T:Infragistics.Win.UltraWinSpellChecker.Error"/>.
- Returns an <see cref="T:Infragistics.Win.UltraWinSpellChecker.UnderlinedError"/> instance describing the new underlined error.
- </summary>
- <param name="error">The error information describing the misspelled word.</param>
- <returns>An <see cref="T:Infragistics.Win.UltraWinSpellChecker.UnderlinedError"/> instance</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.AsYouTypeManager.AddUnderlinedError(Infragistics.Win.UltraWinSpellChecker.UnderlinedError)">
- <summary>
- Underlines the text using the specified <see cref="T:Infragistics.Win.UltraWinSpellChecker.UnderlinedError"/> instance.
- </summary>
- <param name="underlinedError">The underline to add to the text.</param>
- <exception cref="T:System.ArgumentNullException">
- The specified underline is null.
- </exception>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.AsYouTypeManager.BeginUpdate">
- <summary>
- Begins an update operation on the manager.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.AsYouTypeManager.ClearUnderlinedErrors">
- <summary>
- Removes all underlined errors.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.AsYouTypeManager.Dispose">
- <summary>
- Disposes the underline manager
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.AsYouTypeManager.EndUpdate">
- <summary>
- Ends an update on the manager and refreshes the underlines.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.AsYouTypeManager.GetErrorAtCharIndex(System.Int32)">
- <summary>
- Gets the error at the specified character index (null if no underline exists at the index).
- </summary>
- <param name="index">The character index at which to get the error.</param>
- <returns>The error at the specified character index or null if no error exists at the index.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.AsYouTypeManager.GetErrorAtPoint(System.Drawing.Point)">
- <summary>
- Gets the <see cref="T:Infragistics.Win.UltraWinSpellChecker.UnderlinedError"/> describing a misspelled word and its suggestions.
- This word is displayed in the spell checked control at the specified client coordinates.
- Null is returned if the word at the location is spelled correctly or if there is no word
- at the location.
- </summary>
- <param name="location">
- The client coordinates in the spell checked control where the word is.
- </param>
- <returns>
- An <see cref="T:Infragistics.Win.UltraWinSpellChecker.UnderlinedError"/> instance describing the error.
- Null if there is no misspelled word at the location.
- </returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.AsYouTypeManager.IgnoreError(Infragistics.Win.UltraWinSpellChecker.Error)">
- <summary>
- Ignores the specified error.
- </summary>
- <param name="error">The error which should be ignored.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.AsYouTypeManager.PostSpellCheckRequest">
- <summary>
- Notifies the manager that a spell check is requested.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.AsYouTypeManager.Refresh">
- <summary>
- Refreshes the display.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.AsYouTypeManager.RecheckAllText">
- <summary>
- Spell checks the entire text of the control it manages.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.AsYouTypeManager.RemoveUnderlinedError(Infragistics.Win.UltraWinSpellChecker.UnderlinedError)">
- <summary>
- Removes an underline from the control.
- </summary>
- <param name="underlinedError">The underline to remove.</param>
- <returns>True if the <see cref="T:Infragistics.Win.UltraWinSpellChecker.UnderlinedError"/> has been found and removed successfully; False otherwise.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.AsYouTypeManager.Dispose(System.Boolean)">
- <summary>
- Disposes the underline manager.
- </summary>
- <param name="cleanManagedResources">True specifies to clean onlt native reosurces; False to clean native and managed resources.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.AsYouTypeManager.FullPaint(System.Drawing.Graphics)">
- <summary>
- Fully repaints the underlines on the control.
- </summary>
- <param name="grfx">The graphics object into which to paint the underlines.</param>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.AsYouTypeManager.Enabled">
- <summary>
- Gets or sets whether this as you type manager is enabled.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.AsYouTypeManager.IsDipsosed">
- <summary>
- Whether this object has been disposed.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.AsYouTypeManager.UnderlinedErrors">
- <summary>
- Gets the collection of underlined errors on the spell checked control.
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.Design.DictionaryEditor">
- <summary>
- Type editor for selecting the user dictionary file
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.Design.DictionaryEditor.InitializeDialog(System.Windows.Forms.OpenFileDialog)">
- <summary>
- Initializes the members of the file dialog.
- </summary>
- <param name="openFileDialog">Open file dialog used to select the file.</param>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.Error">
- <summary>
- Defines an error in text.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.Error.#ctor(System.String,System.Int32,Infragistics.Win.UltraWinSpellChecker.SuggestionCollection,Infragistics.Win.UltraWinSpellChecker.ErrorType)">
- <summary>
- Creates a new <see cref="T:Infragistics.Win.UltraWinSpellChecker.Error"/> instance.
- </summary>
- <param name="checkedWord">The orginial word that was spell checked.</param>
- <param name="startIndex">The character index of the first character of the checked word in the full checked text.</param>
- <param name="suggestions">A list of suggestions for the error.</param>
- <param name="type">A value indicating the type of error.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.Error.ContainsIndex(System.Int32)">
- <summary>
- Determines whether the specified index is contained in the error.
- </summary>
- <param name="index">The character index into the text in which the error exists</param>
- <returns>True if the specifed character index is contained in the error; False otherwise.</returns>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.Error.CheckedWord">
- <summary>
- Gets the word that was spell checked.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.Error.EndIndex">
- <summary>
- Gets the 0-based character index of the end of the underline.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.Error.StartIndex">
- <summary>
- Gets or sets the 0-based character index of the start of the underline.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.Error.Suggestions">
- <summary>
- Gets a collection of suggestions for the misspelled word.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.Error.Type">
- <summary>
- Gets the type of error this is.
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.ErrorCollection">
- <summary>
- Read-only collection which contains a list of underlines.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.ErrorCollection.#ctor">
- <summary>
- Constructor
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.ErrorCollection.CopyTo(Infragistics.Win.UltraWinSpellChecker.Error[],System.Int32)">
- <summary>
- Copies the elements of the <see cref="T:Infragistics.Win.UltraWinSpellChecker.ErrorCollection"/> to an <see cref="T:Infragistics.Win.UltraWinSpellChecker.Error"/> array, starting at a particular index.
- </summary>
- <param name="array">The one-dimensional array where all errors in the collection should be copied.</param>
- <param name="index">The zero-based index into the array at which to start copying errors.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.ErrorCollection.Add(Infragistics.Win.UltraWinSpellChecker.Error)">
- <summary>
- Adds an <see cref="T:Infragistics.Win.UltraWinSpellChecker.Error"/> to the errors collection.
- </summary>
- <param name="error">The error to add to the collection.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.ErrorCollection.Clear">
- <summary>
- Clears the collection of all errors
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.ErrorCollection.Remove(Infragistics.Win.UltraWinSpellChecker.Error)">
- <summary>
- Removes the specified <see cref="T:Infragistics.Win.UltraWinSpellChecker.Error"/> from the collection.
- </summary>
- <param name="error">The <see cref="T:Infragistics.Win.UltraWinSpellChecker.Error"/> to remove from the colleciton.</param>
- <returns>True if the <see cref="T:Infragistics.Win.UltraWinSpellChecker.Error"/> has been found and removed successfully; False otherwise.</returns>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.ErrorCollection.Item(System.Int32)">
- <summary>
- Gets the error at the specified index.
- </summary>
- <param name="index">The 0-based index into the collection at which to get an error.</param>
- <returns></returns>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.IgnoredWordsCollection">
- <summary>
- Collection of word ignored by the spell checker
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.IgnoredWordsCollection.#ctor">
- <summary>
- Constructor
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.IgnoredWordsCollection.Add(System.String)">
- <summary>
- Adds an ignored word to the collection.
- </summary>
- <param name="word">The word to add to the collection.</param>
- <returns>True if the word was added; False if the word already existed in the collection.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.IgnoredWordsCollection.Clear">
- <summary>
- Clears the collection of words.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.IgnoredWordsCollection.Contains(System.String)">
- <summary>
- Returns the boolean indicating whether the specified word is in the collection.
- </summary>
- <param name="word">The word to look for in the collection.</param>
- <returns>True if the word is in the collection; False otherwise.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.IgnoredWordsCollection.Remove(System.String)">
- <summary>
- Removes a word from the collection.
- </summary>
- <param name="word">The word to remove from the collection.</param>
- <returns>True if the word was successfully removed; False otherwise.</returns>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.IgnoredWordsCollection.Count">
- <summary>
- Gets the number of words contianed in the collection
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.TextBoxBaseWrapper">
- <summary>
- Abstract base class which wraps a <see cref="T:System.Windows.Forms.TextBoxBase"/> instance and provides spell checking
- support for it.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.TextBoxBaseWrapper.OnHandleChange">
- <summary>
- Specifies a notification method that is called when the handle for a window is changed.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.RichTextBoxWrapper.#ctor">
- <summary>
- Constructor
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.FrameWorkSpecific.AdvancedTextBoundary">
- <summary>Extends SimpleTextBoundary to included more advanced parsing.</summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.FrameWorkSpecific.SimpleTextBoundary">
- <summary>A simple implementation of Java's word BreakIterator</summary>
- <note>does not treat punctuation the same, Java's one treats ! and \s differently
- this treats anything that isnt a letter the same.</note>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.FrameWorkSpecific.SimpleTextBoundary.theText">
- <summary>The text being parsed.</summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.FrameWorkSpecific.SimpleTextBoundary.shw">
- <summary>Whether to simply treat hyphens as breaking chars.</summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.FrameWorkSpecific.SimpleTextBoundary.lp">
- <summary>Language rules to use when parsing.</summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.FrameWorkSpecific.SimpleTextBoundary.ENGLISH">
- <summary>English text parsing.</summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.FrameWorkSpecific.SimpleTextBoundary.FRENCH">
- <summary>French text parsing.</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.FrameWorkSpecific.SimpleTextBoundary.Last">
- <summary>Return the last boundary. The iterator's current position is set to the last boundary.</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.FrameWorkSpecific.SimpleTextBoundary.SetText(System.String)">
- <summary>Sets the text to be analysed.</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.FrameWorkSpecific.SimpleTextBoundary.Following(System.Int32)">
- <summary>Return the first boundary after the specified offset</summary>
- <param name="offset">the offset to start</param>
- <returns>int the first boundary after offset</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.FrameWorkSpecific.SimpleTextBoundary.Preceding(System.Int32)">
- <summary>Return the first boundary before the specified offset</summary>
- <param name="offset">the offset to start</param>
- <returns>int the first boundary after offset</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.FrameWorkSpecific.SimpleTextBoundary.IsBoundaryRight(System.Int32)">
- <summary>Whether <c>offset</c> is one place after the last character in a word.</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.FrameWorkSpecific.SimpleTextBoundary.IsBoundaryLeft(System.Int32)">
- <summary>Whether <c>offset</c> is a boundary to the left of text</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.FrameWorkSpecific.SimpleTextBoundary.IsBoundary(System.Int32)">
- <summary>Determines if character at <c>offset</c> is a boundary</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.FrameWorkSpecific.SimpleTextBoundary.isAtNonWhiteSpace(System.Int32)">
- <summary> Returns whether the character at position is whitespace, this is contextually relevant.</summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.FrameWorkSpecific.SimpleTextBoundary.SeparateHyphenWords">
- <summary> Whether to treat hyphenated (-) words as separate words, default is false. </summary>
- <remarks> For eg. if this is true text like "cheap-deals" will be treated as two words "cheap" and "deals",
- otherwise this will be treated as one word "cheap-deals".</remarks>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.FrameWorkSpecific.SimpleTextBoundary.LanguageParsing">
- <summary>The language parsing to be used.</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.FrameWorkSpecific.AdvancedTextBoundary.Following(System.Int32)">
- <summary>this ignores xml tags butted between text.</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.FrameWorkSpecific.AdvancedTextBoundary.Preceding(System.Int32)">
- <summary>this ignores xml tags butted between text.</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.FrameWorkSpecific.AdvancedTextBoundary.isAtNonWhiteSpace(System.Int32)">
- <summary>Whether the character at position is between at non whitespace.</summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.FrameWorkSpecific.AdvancedTextBoundary.AllowXML">
- <summary>Whether to ignore XML/HTML tags, should be set true for RichTextBox support, false by default.</summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.BadWord">
- <summary>Represents a mis-spelt word in the text.</summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.WordOccurrence">
- <summary>Represents a word in the text.</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.WordOccurrence.GetStartPosition">
- <summary>Gets the position of the start of this word in the main text.</summary>
- <returns>int position in the text where this word starts.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.WordOccurrence.GetEndPosition">
- <summary>Gets the position of the end of this word in the main text.</summary>
- <returns>int position in the text where this word ends</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.WordOccurrence.#ctor(System.String,System.Int32,System.Int32)">
- <summary>Constructs a BadWord instance.</summary>
- <param name="word">the word String that is misspelt</param>
- <param name="caretStart">the position in the original text</param>
- <param name="caretEnd">the end position in the text</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.WordOccurrence.GetWord">
- <summary>Gets the String of this bad word.</summary>
- <returns>String in this BadWord</returns>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.WordOccurrence.StartPosition">
- <summary>Gets the position of the start of this word in the main text.</summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.WordOccurrence.EndPosition">
- <summary>Gets the position of the end of this word in the main text.</summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.WordOccurrence.Word">
- <summary>Gets the string of this bad word.</summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.BadWord.REASON_SPELLING">
- <summary>BadWord reason, incorrect spelling.</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.BadWord.GetReason">
- <summary>Gets the reason that this is a bad word.</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.BadWord.#ctor(System.String,System.Int32,System.Int32)">
- <summary>Constructs a BadWord (REASON_SPELLING) instance.</summary>
- <param name="word">the word String that is misspelt</param>
- <param name="caretStart">the position in the original text</param>
- <param name="caretEnd">the end position in the text</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.BadWord.#ctor(System.String,System.Int32,System.Int32,System.Int32)">
- <summary>Constructs a BadWord instance.</summary>
- <param name="word">the word String that is misspelt</param>
- <param name="caretStart">the position in the original text</param>
- <param name="caretEnd">the end position in the text</param>
- <param name="reason">the reason this is a bad word, REASON_SPELLING</param>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.BadWord.Reason">
- <summary>Gets the reason that this is a bad word.</summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.Event.ChangeWordEventArgs">
- <summary>Holds data for the ChangeWord event.</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.Event.ChangeWordEventArgs.#ctor(System.String,System.String,System.Int32)">
- <summary>Creates a new ChangeWordEventArgs</summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.Event.ChangeWordEventArgs.OldWord">
- <summary>The word being replaced</summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.Event.ChangeWordEventArgs.NewWord">
- <summary>The new word</summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.Event.ChangeWordEventArgs.Index">
- <summary>The index of the word in the text</summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.DictFile.WordList">
- <summary>WordList or ReverseList</summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.DictFile.ReverseList">
- <summary>WordList or ReverseList</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.DictFile.#ctor(System.String)">
- <summary>Creates a new DictFile object, working on file in dictFilePath</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.DictFile.ReadList(System.Int32)">
- <summary>Returns a byte array of the words in the list of specified type.</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.DictFile.GetDecodedFileStream">
- <summary>Return decoded file stream</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.DictFile.GetStreamDimensions(System.Int32)">
- <summary>Gets the start of the wordlist and length of list.</summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine">
- <summary>Defines the interface required for a class to be used as a checker engine</summary>
- <remarks>This is the interface which any checker engine must have, by implementing this interface any object can be
- used to parse text and identify 'bad words'.
- It is not necessary to functionally implement all members, for this reason an abstract empty implementation class is provided (CheckerEngineAdapter) which can be extended and overridden for desired functionality.
- </remarks>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.Check(System.String)">
- <summary>Checks the text for errors.</summary>
- <exception cref="T:System.ArgumentNullException">if text parameter is null.</exception>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.LookUp(System.String)">
- <summary>Looks up <c>word</c> in the dictionary, returns true if it is in there.</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.NextBadWord">
- <summary>Gets the next bad word in the list that was identified by Check.</summary>
- <remarks>Check must be called before this method.</remarks>
- <returns>The next BadWord object from the text, must return null (C#) or nothing (VB.NET) when no more bad words exist.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.FindSuggestions">
- <summary>Returns an ArrayList of Strings that are suitable suggestions for the current bad word (that is, the one last returned by NextBadWord()).</summary>
- <remarks>If no suggestions can be found, this should return an empty ArrayList.This method should be thread safe if operating with RapidSpell Desktop.</remarks>
- <exception cref="T:Infragistics.Win.UltraWinSpellChecker.NoCurrentBadWordException">If NextBadWord() hasn't been run first AND found an erroneous word.</exception>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.SetIncludeUserDictionaryInSuggestions(System.Boolean)">
- <summary>Sets whether to include the user dictionary in suggestions taken from this engine.</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.SetUserDictionary(Infragistics.Win.UltraWinSpellChecker.UserDictionary)">
- <summary>Sets the UserDictionary object to be used as a user dictionary source.</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.SetUserDictionary(System.String)">
- <summary>Sets the UserDictionary file path to be used as a user dictionary source.</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.AddWord(System.String)">
- <summary>Adds a word to the user dictionary, if it exists.</summary>
- <remarks>Should return true if the word was added successfully, false otherwise.</remarks>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.RemoveWord(System.String)">
- <summary>
- Removes a word from the user dictionary, if it exists.
- </summary>
- <remarks>Should return true if the word was successfully removed, false otherise.</remarks>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.SetSuggestionsMethod(Infragistics.Win.UltraWinSpellChecker.SuggestionsMethod)">
- <summary>Sets the suggestions method, where method is an integer identifier.</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.SetAllowCapitalizedWords(System.Boolean)">
- <summary>Sets whether to ignore capitalized words.</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.SetConsiderationRange(System.Int32)">
- <summary>Sets the breadth of the suggestions search.</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.SetSeparateHyphenWords(System.Boolean)">
- <summary>Sets whether to separate words with hyphens in them into separate words.</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.SetPosition(System.Int32)">
- <summary>Sets the pointer position for the <c>NextBadWord</c> iterator.</summary>
- <remarks>Further calls to <c>NextBadWord</c> will look for the next bad word from position <c>pos</c>.
- If position > the text length it is set to the text length.
- If position < 0, it is set to zero.</remarks>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.GetIncludeUserDictionaryInSuggestions">
- <summary> Gets whether the user dictionary should be used in finding suggestions for misspelt words.</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.GetAllowCapitalizedWords">
- <summary> Gets whether to ignore words that start with capital letters. </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.GetConsiderationRange">
- <summary> Gets the factor for words to consider for suggestions.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.ChangeBadWord(System.String)">
- <summary>Changes the current bad word to <c>newWord</c> in the text.</summary>
- <param name="newWord">replaces the current misspelt word.</param>
- <returns>void</returns>
- <exception cref="T:Infragistics.Win.UltraWinSpellChecker.NoCurrentBadWordException">if nextBadWord() hasn't been run first AND found an erroneous word.</exception>
- <exception cref="T:System.ArgumentNullException">if newWord parameter is null.</exception>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.IgnoreAll(System.String)">
- <summary>Marks <c>word</c> to be ignored in rest of the text.</summary>
- <param name="word">to ignore</param>
- <returns>void</returns>
- <exception cref="T:System.ArgumentNullException">if word parameter is null.</exception>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.TextBoundary">
- <summary>The AdvancedTextBoundary class to use to parse words.</summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.AllowXML">
- <summary>Whether to ignore XML tags in the text.</summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.userDictionary">
- <summary>The user dictionary, this should be null (C#) or nothing (VB.NET) if no user dictionary is being used.</summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.DictFile">
- <summary>
- The Dictionary to be used. If none is specified, then the English Dictionary will be used.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.LanguageParser">
- <summary>The type of language parsing to use.</summary>
- <remarks>Eg. If the dictionary is set to French, you should use the French parser.</remarks>
- <returns>This implementation always returns ENGLISH.</returns>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.CheckHyphenatedText">
- <summary>Whether to 'look into' text with hyphens (-), if the word has hyphens in it and
- CheckHyphenatedText is set true (default), the parts of the text around the hyphens will be checked individually.</summary>
- <remarks>Eg. "socio-economic" will be checked as "socio" and "economic".</remarks>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.CheckCompoundWords">
- <summary>Whether to check for compound words, setting this to true is essential for languages such as German which
- allow for compound words.</summary>
- <remarks>If this=false then LookUp("thesewordsarejoined") = false
- <p>If this=true then LookUp("thesewordsarejoined") = true</p>
- <p>If this=false then LookUp("abcdef") = false</p>
- <p>If this=true then LookUp("abcdef") = false</p>
- <p>Setting this to true will degrade lookup performance</p>
- </remarks>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.SuggestSplitWords">
- <summary>Whether to look for connected words in suggestions.</summary>
- <remarks>if this=true then suggestions may include joined words.
- <p>Eg; suggestions for "myhouse" will include "my house"</p>
- </remarks>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.AllowWordsWithDigits">
- <summary>Whether to ignore words with numbers in them (eg. A10 or 7-11).</summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.CurrentBadWord">
- <summary>Gets the current bad word (last returned by NextBadWord).</summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.AllowMixedCase">
- <summary>Whether to allow words spelt with mixed case, eg. "MIxEd"</summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.AllowCaseInsensitiveSuggestions">
- <summary>Whether to allow suggestions for correctly spelled words with mix case.</summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.AllowAnyCase">
- <summary>Whether to allow words spelt with any case, eg. "africa" instead of "Africa", this is more relaxed than AllowMixedCase.</summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.ICheckerEngine.SplitWordThreshold">
- <summary>The property coincides with SuggestSplitWords. The value of the property determines the minimum size of each word in order for it to become a suggestion. For example, "myhouse" has two words "my" and "house" in order for "my house" to be a suggestion, the SplitWordThreshold must be set to 2 or smaller. A lower threshold results in worse performance.</summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.NoCurrentBadWordException">
- <summary>Thrown if <c>NextBadWord</c> has not been run first and found a mis-spelt word.</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.NoCurrentBadWordException.#ctor">
- <summary>Create a new instance with no message.</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.NoCurrentBadWordException.#ctor(System.String)">
- <summary>Create a new instance with <paramref name="mesg"/> as a message.</summary>
- <para name="mesg">Useful text string describing the exception.</para>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.Permuter">
- <summary>Gets permutations (stores small n=1,2,3,4,5 for quick access), this is used to find anagrams for suggestions</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.Permuter.#ctor(System.Int32)">
- <summary>Generates all permutations of NN numbers.</summary>
- <remarks>Eg. if NN = 3 this will generate 123,132,213,231,312,321 (not in typographic order, but transposition order)</remarks>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.Permuter.GetPermutation(System.Int32)">
- <summary>Returns a permutation of zero based index p, if p> number of permutations stored this will return last permutation in set.</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.Permuter.GetNumberOfPermutations">
- <summary>Gets total number of permutations</summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.PhoneticsProcessor">
- Generates the phonetic (sounds like) code for a word.
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.PhoneticsProcessor.MetaPhone(System.String)">
- @param txt the word to find the phonetic code for
- @return String the phonetic code for the txt
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.PhoneticsProcessor.HasSameMetaPhone(System.String,System.String)">
- @param txt word to check if has same metaphone as
- @param metaphone the meta phone to compare with
- @return boolean true if txt has same metaphone
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.SpellChecker">
- <summary>Spell checker engine, checks a text string for spelling errors and makes suggested corrections.</summary>
- <remarks> This is a non-GUI component, suitable for the business/logic layer of your application.
- You would use this component in web server based applications.
- This component can be used in 2 different ways. The most common usage, in an iterative fashion is detailed below, but
- it may also be used on a query by query basis.
- To use this component in an iterative way you must first call <c>Check</c> to set the text to check and
- then iterate through
- <c>NextBadWord()</c> to identify misspelt words. <c>NextBadWord</c> will return
- a BadWord object and internally locate the
- the misspelt word in the text, then you can call <c>FindSuggestions</c>
- which will return a ArrayList of suggestions as String objects. You may also call <c>ChangeBadWord(replacement)</c>
- to replace that current misspelt word in the text.
- <c>NextBadWord()</c> will return null when the text has been checked. <c>GetAmendedText</c> returns the current
- state of the text with corrections.
-
- Calling <c>ChangeBadWord</c> or <c>FindSuggestions</c> before <c>NextBadWord</c> has been called
- and returned a BadWord (i.e. not null) will result in a <see cref="T:Infragistics.Win.UltraWinSpellChecker.NoCurrentBadWordException"/>.
- </remarks>
- <example>
- Check some text, find suggestions and replace mis-spelt words with "replacement".
-
- <code>
- webSpellChecker c = new webSpellChecker();
- BadWord badWord;
- ArrayList suggestions;
-
- //check some text.
- c.Check("This is sume text.");
-
- //iterate through all bad words in the text.
- while((badWord = c.NextBadWord())!=null){
-
- Console.WriteLine(badWord.GetWord() + "- is not spelt correctly. Suggestions:");
-
- try{
- //get suggestions for the current bad word.
- suggestions = c.FindSuggestions();
-
- //display all suggestions.
- for(int i=0; i<suggestions.Count; i++){
- Console.WriteLine(suggestions[i]);
- }
-
- //change the bad word in the text with "replacement".
- c.ChangeBadWord("replacement");
-
- } catch (NoCurrentBadWordException e){
- Console.WriteLine(e);
- }
-
- }
- Console.WriteLine(c.GetAmendedText());
- </code>
- </example>
-
- <remarks><para>
- The second way to use this component is simply to query words yourself using <c>LookUp(word)</c> to check if <c>word</c>
- is in the lexicon/dictionary and <c>FindSuggestions(word)</c> to find spelling suggestions for <c>word</c>.
- </para>
- </remarks>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SpellChecker.wordStart">
- <summary>The start index of the current word being checked/parsed.</summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SpellChecker.wordEnd">
- <summary>The end index of the current word being checked/parsed.</summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SpellChecker.ignoreList">
- ArrayList of words to be ignored.
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SpellChecker.badWordList">
- ArrayList of mis-spelt words in the text.
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SpellChecker.theText">
- a copy of the text being checked.
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SpellChecker.wordIterator">
- word iterator
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SpellChecker.dontSuggest">
- <summary>Don't suggest words in this array (swear words).</summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SpellChecker._userDictionary">
- <summary>The UserDictionary being used.</summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SpellChecker.compare">
- The compare object, used to sort suggestions by closeness to query word
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SpellChecker.OPTIMIZE_FOR_SPEED">
- <summary>Indicator for optimization (OPTIMIZE_FOR_SPEED only works with PHONETIC_SUGGESTIONS method).</summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SpellChecker.OPTIMIZE_FOR_MEMORY">
- <summary>Indicator for optimization (OPTIMIZE_FOR_SPEED only works with PHONETIC_SUGGESTIONS method).</summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SpellChecker.overrideEval">
- used by GUI to override the change word disability
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.Dispose(System.Boolean)">
- <summary>
- Disposes of resources.
- </summary>
- <param name="disposing"></param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.Dispose">
- <summary>
- Clean up any resources being used.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.SetSuggestionsMethod(Infragistics.Win.UltraWinSpellChecker.SuggestionsMethod)">
- <summary>Sets the suggestions method to use. Either PHONETIC_SUGGESTIONS or HASHING_SUGGESTIONS
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.GetSuggestionsMethod">
- <summary>Gets the suggestions method to use. Either PHONETIC_SUGGESTIONS or HASHING_SUGGESTIONS
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.SetIncludeUserDictionaryInSuggestions(System.Boolean)">
- <summary> Sets whether the user dictionary should be used in finding suggestions for misspelt words.</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.GetIncludeUserDictionaryInSuggestions">
- <summary> Gets whether the user dictionary should be used in finding suggestions for misspelt words.</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.SetAllowCapitalizedWords(System.Boolean)">
- <summary> Sets whether to ignore words with capital letters. </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.GetAllowCapitalizedWords">
- <summary> Gets whether to ignore words with capital letters. </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.SetConsiderationRange(System.Int32)">
- <summary> Sets the factor for words to consider for suggestions,
- lower values are faster but consider less words for suggestions. Default is 80.
- If w <= 1 this method won't do anything.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.GetConsiderationRange">
- <summary> Gets the factor for words to consider for suggestions.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.SetSeparateHyphenWords(System.Boolean)">
- <summary> Sets whether to treat hyphenated (-) words as separate words, default is false. </summary>
- <remarks> For eg. if this is true text like "cheap-deals" will be treated as two words "cheap" and "deals",
- otherwise this will be treated as one word "cheap-deals".
- Also see CheckHyphenatedText.</remarks>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.GetSeparateHyphenWords">
- <summary> Gets whether to treat hyphenated (-) words as separate words, default is false. </summary>
- <remarks> For eg. if this is true text like "cheap-deals" will be treated as two words "cheap" and "deals",
- otherwise this will be treated as one word "cheap-deals".</remarks>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.ReadWordListStream(System.Collections.Generic.List{System.String},System.Int32,Infragistics.Win.UltraWinSpellChecker.DictFile,System.String)">
- <summary>Reads list from stream</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.AddWord(System.String)">
- <summary>Adds <c>word</c> to the user dictionary (if it has been specified).</summary>
- <param name="word">String to add to user dictionary, if it is being used.</param>
- <returns>boolean true if the word was is now in the user dictionary, false if the word could not be added to the user dictionary.</returns>
- <exception cref="T:System.ArgumentNullException">If word parameter is null.</exception>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.NextBadWord">
- <summary>Returns the next mis-spelt word in the text, as a BadWord object.</summary>
- <returns>Keyoti.RapidSpell.BadWord or null if there are no more bad words.</returns>
- @see Keyoti.rapidSpell.BadWord
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.ChangeBadWord(System.String)">
- <summary>Changes the current bad word to <c>newWord</c> in the text.</summary>
- <param name="newWord">replaces the current misspelt word.</param>
- <returns>void</returns>
- <exception cref="T:Infragistics.Win.UltraWinSpellChecker.NoCurrentBadWordException">if nextBadWord() hasn't been run first AND found an erroneous word.</exception>
- <exception cref="T:System.ArgumentNullException">if newWord parameter is null.</exception>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.Check(System.String,System.Int32)">
- <summary>Checks text for spelling correctness, from startPosition in text, mis-spelt words can be accessed through <c>nextBadWord</c>.</summary>
- <remarks>startPosition should be >=0 but if it is < 0 it is set = 0.</remarks>
- <param name="text">the text to be checked</param>
- <param name="startPosition">the position in the text to begin checking from</param>
- <returns>void</returns>
- <exception cref="T:System.ArgumentNullException">if text parameter is null.</exception>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.convertHtmlEntities(System.String)">
- <summary>Converts HTML entity codes to their Unicode characters</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.Check(System.String)">
- <summary>Checks text for spelling correctness, from beginning of text, mis-spelt words can be accessed through <c>nextBadWord</c>.</summary>
- <param name="text">to spell check.</param>
- <returns>void</returns>
- <exception cref="T:System.ArgumentNullException">if text parameter is null.</exception>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.FindSuggestions">
- <summary>Gets an enumeration of String suggestions for spelling of current bad word.</summary>
- <returns>ArrayList of String suggestions for current bad word.</returns>
- <exception cref="T:Infragistics.Win.UltraWinSpellChecker.NoCurrentBadWordException">If NextBadWord() hasn't been run first AND found an erroneous word.</exception>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.FindSuggestions(System.String)">
- <summary>Gets an enumeration of String suggestions for word.</summary>
- <param name="word">the word to check the spelling of.</param>
- <returns>ArrayList of String suggestions for word.</returns>
- <exception cref="T:System.ArgumentNullException">if word parameter is null.</exception>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.FindSuggestions(System.String,System.Boolean)">
- <summary>Gets an enumeration of String suggestions for word.</summary>
- <param name="word">the word to check the spelling of.</param>
- <param name="searchLowerCase">whether to return suggestions for word in a lower case form (if it's capitalized).</param>
- <returns>ArrayList of String suggestions for word.</returns>
- <exception cref="T:System.ArgumentNullException">if word parameter is null.</exception>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.GetAmendedText">
- <summary>Returns the original text sent to check() but with any alterations made through <c>change</c></summary>
- <returns>String the text after corrections, null if there is no text.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.IgnoreAll(System.String)">
- <summary>Marks <c>word</c> to be ignored in rest of the text.</summary>
- <param name="word">to ignore</param>
- <returns>void</returns>
- <exception cref="T:System.ArgumentNullException">if word parameter is null.</exception>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.LookUp(System.String)">
- <summary>Checks if query is in the main dictionary or user.</summary>
- <remarks>This method is inconsiderate of the words in IgnoreList. </remarks>
- <param name="query">the word to check spelling of</param>
- <returns>true if spelt correctly, false if not in dictionary</returns>
- <exception cref="T:System.ArgumentNullException"> if query parameter is null.</exception>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.FindCompoundWords(System.String,System.Collections.IList)">
- <summary>Finds the compound words in <c>text</c> and puts them in <c>subwords</c>, set <c>subwords</c> to null/nothing to just find if <c>text</c> has compound word formation.</summary>
- <remarks>Only adds words to list if all are valid. In other words, this will not find all words that
- are part of <c>text</c>, but only the words that all make up <c>text</c>.
- <p>Eg. "catchmentarea" has words "catchment" and "area" but not "cat", "me" etc.</p>
- The order of the words in the list is the reverse of their order in <c>text</c>.
- </remarks>
- <param name="text">The text to find compound words in</param>
- <param name="subwords">A list that formative sub-words will be added to, can be null/nothing.</param>
- <returns>True if <c>text</c> is entirely formed from compound words, False if not.</returns>
- <exception cref="T:System.ArgumentNullException">if text is null</exception>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.FindSplitWords(System.String,System.Collections.IList)">
- <summary>Finds correctly spelled words in <c>text</c> and puts them in <c>subwords</c>, set <c>subwords</c> to null/nothing to just find if <c>text</c> has compound word formation.</summary>
- <remarks>Only adds words to list if all are valid. In other words, this will not find all words that
- are part of <c>text</c>, but only the words that all make up <c>text</c>.
- <p>Eg. "catchmentarea" has words "catchment" and "area" but not "cat", "me" etc.</p>
- The order of the words in the list is the reverse of their order in <c>text</c>.
- </remarks>
- <param name="text">The text to find compound words in</param>
- <param name="subwords">A list that formative sub-words will be added to, can be null/nothing.</param>
- <returns>True if <c>text</c> is entirely formed from compound words, False if not.</returns>
- <exception cref="T:System.ArgumentNullException">if text is null</exception>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.FindAnagrams(System.String,System.Collections.IList)">
- <summary>Finds anagrams of <c>word</c> and puts them in <c>anagrams</c> if not already present.</summary>
- <remarks></remarks>
- <param name="word">The word to find anagrams of</param>
- <param name="anagrams">A list that anagrams will be added to.</param>
- <exception cref="T:System.ArgumentNullException">if word is null/nothing</exception>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.SetUserDictionary(System.String)">
- <summary>Set the user dictionary to use.</summary>
- <remarks>If the userDictionary can not be created/read it will be ignored</remarks>
- <param name="userDictionaryFile">a file to be used as a user dictionary</param>
- <exception cref="T:System.ArgumentNullException">if userDictionaryFile is null</exception>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.SetUserDictionary(Infragistics.Win.UltraWinSpellChecker.UserDictionary)">
- <summary>Set the user dictionary to use.</summary>
- <remarks>If the userDictionary can not be created/read it will be ignored</remarks>
- <param name="userDictionary">a UserDictionary object representing a user dictionary</param>
- <exception cref="T:System.ArgumentNullException">if userDictionary is null.</exception>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.MakeCap(System.String)">
- Capitalises first letter of word
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.LookUpMainDictionary(System.String)">
- <summary>Checks if query is in the word dictionary. Returns true if doesnt start with a letter or apostrophe</summary>
- <param name="query">the word to check spelling of</param>
- <returns>boolean true if spelt correctly, false if not in dictionary</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.LookUpUserDictionary(System.String)">
- Look up the query in the user dictionary if it exists
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.GetPreviousWord">
- Returns the previous word in the text, and moves word pointers in process.
- <returns>String the next word in the text</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.GetNextWord">
- <summary>Returns the next word in the text.</summary>
- <returns>String the next word in the text</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.Flagged(System.String)">
- Checks if word has been flagged as mis-spelt by the check() method
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.PreCheck">
- Scan theText and record all mis-spelt words in badWordList and return the word pointers to the start.
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.SetPosition(System.Int32)">
- <summary>Sets the pointer position for the <c>NextBadWord</c> iterator.</summary>
- <remarks>Further calls to <c>NextBadWord</c> will look for the next bad word from position <c>pos</c>.
- If position > the text length it is set to the text length.
- If position < 0, it is set to zero.</remarks>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.GeneratePhoneticList">
- Generate a big array of phonetic codes for the dictionary, this will save reprocessing redundently,
- at the expense of memory.
- </member>
- <member name="E:Infragistics.Win.UltraWinSpellChecker.SpellChecker.ChangeWord">
- <summary>Change word event, fired when a word is changed.</summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellChecker.SplitWordThreshold">
- <summary>
- The property coincides with SuggestSplitWords. The value of the property determines the minimum size of each word in order for it to become a suggestion. For example, "myhouse" has two words "my" and "house" in order for "my house" to be a suggestion, the SplitWordThreshold must be set to 2 or smaller. A lower threshold results in worse performance.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellChecker.TextBoundary">
- <summary>The AdvancedTextBoundary class to use to parse words.</summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellChecker.CheckCompoundWords">
- <summary>Whether to check for compound words, setting this to true is essential for languages such as German which
- allow for compound words.</summary>
- <remarks>If this=false then LookUp("thesewordsarejoined") = false
- <p>If this=true then LookUp("thesewordsarejoined") = true</p>
- <p>If this=false then LookUp("abcdef") = false</p>
- <p>If this=true then LookUp("abcdef") = false</p>
- <p>Setting this to true will degrade lookup performance by a maximum of approx. 100[1-1/n] percent (where n is the number of letters in the word) for misspelt words.
- There is no preformance degredation for correctly spelt words. On average for texts with mostly correctly spelt words the performance degredation for the Check method is
- roughly 25%.</p>
- </remarks>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellChecker.SuggestSplitWords">
- <summary>Whether to look for connected words in suggestions.</summary>
- <remarks>if this=true then suggestions may include joined words.
- <p>Eg; suggestions for "myhouse" will include "my house"</p>
- Setting this to true (default) has a slight performance impact.</remarks>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellChecker.AllowXML">
- <summary>Whether to ignore XML/HTML tags, should be set true for RichTextBox support, false by default.</summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellChecker.CheckHyphenatedText">
- <summary>Whether to 'look into' text with hyphens (-), if the word has hyphens in it and
- CheckHyphenatedText is set true (default), the parts of the text around the hyphens will be checked individually.</summary>
- <remarks>Eg. "socio-economic" will be checked as "socio" and "economic".</remarks>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellChecker.LanguageParser">
- <summary>The type of language parsing to use.</summary>
- <remarks>Eg. If the dictionary is set to French, you should use the French parser.</remarks>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellChecker.AllowMixedCase">
- <summary>Whether to allow words spelt with mixed case, eg. "MIxEd" - also see AllowAnyCase.</summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellChecker.AllowCaseInsensitiveSuggestions">
- <summary>Whether to allow suggestions for correctly spelled words with mix case.</summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellChecker.AllowAnyCase">
- <summary>Whether to allow words spelt with incorrect case, eg. "africa", instead of "Africa", this is more relaxed than AllowMixedCase</summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellChecker.userDictionary">
- <summary>The UserDictionary being used, may be null if no user dictionary is being used.</summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellChecker.IgnoreList">
- <summary>The words to ignore, note this list is changed by IgnoreAll.</summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellChecker.AllowWordsWithDigits">
- <summary>Whether to ignore words with numbers in them (eg. A10 or 7-11).</summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellChecker.CurrentBadWord">
- <summary>Gets the current bad word (last returned by NextBadWord).</summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellChecker.IgnoreRtfCodes">
- <summary>Sets whether this should ignore Rtf (or any escaped) codes in the text.</summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.SpellChecker.ChangeWordEventHandler">
- <summary>Change word event handler delegate.</summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SpellChecker.CompareL.topWord">
- The word the would go first on the list
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.SpellChecker.SizeSorter">
- Sort by length of string.
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.SpellChecker.ReverseSorter">
- Sort by length of string.
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.SpellChecker.ResourceDecoder">
- The resource decoder, which takes the byte array from wordlist and decodes it.
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.ResourceDecoder.DecodeWordList(System.Collections.ArrayList,System.Byte[])">
- Decode byte array in to list, returns number of words in list, is thread safe
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellChecker.ResourceDecoder.DecodeWordList(System.Collections.ArrayList,System.Byte[],System.String)">
- Decode byte array in to list, returns number of words in list, is thread safe
- encoding is either "UTF8" or "Unicode"
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.UserDictionary">
- <summary>Represents the UserDictionary</summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.UserDictionary.dictFile">
- <summary>The file containing the dictionary</summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.UserDictionary.valid">
- Whether the file is valid
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.UserDictionary.wordList">
- array holding all lines in dict.
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UserDictionary.#ctor">
- <summary>Constructs an invalid UserDictionary</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UserDictionary.#ctor(System.String)">
- <summary>Construct a UserDictionary based on the <c>userDictionaryFile</c>, which does not have to exist.</summary>
- <param name="userDictionaryFile">the file used for a user dictionary.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UserDictionary.IsValid">
- <summary>Returns whether the dictionary file is valid.</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UserDictionary.AddWord(System.String)">
- <summary>Tries to add <c>word</c> to this dictionary</summary>
- <param name="word">String containing the new word</param>
- <returns>true if added successfully, false otherwise.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UserDictionary.RemoveWord(System.String)">
- <summary>
- Tries to remove a word from this dictionary.
- </summary>
- <param name="word">String contianing the word to remove.</param>
- <returns>True if the word was removed successfully; False otherwise</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UserDictionary.ReadDict">
- <summary>Read dictionary file</summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UserDictionary.WriteDict">
- Write dictionary file ////
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogBase">
- <summary>
- Abstract base class for the spell check dialog
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogBase.#ctor(System.Object,Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker)">
- <summary>
- Constructor
- </summary>
- <param name="spellCheckTarget">The object being spell checked.</param>
- <param name="spellChecker">The <see cref="T:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker"/> to which this spell check dialog applies.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogBase.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">True if this instance is being disposed, False if it is being finialized.</param>
- <remarks>
- <p class="body">
- If <paramref name="disposing"/> is True, both managed and unmanaged resources should be cleaned up,
- otherwise only unmanaged resources should be cleaned up.
- </p>
- </remarks>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogBase.OnLoad(System.EventArgs)">
- <summary>
- Raises the <see cref="E:System.Windows.Forms.Form.Load"/> event.
- </summary>
- <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogBase.AddCurrentErrorToUserDictionary">
- <summary>
- Adds the current error to the user dictionary and continues on to the next error.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogBase.ChangeAllMatchingCurrentError(System.String,System.Boolean)">
- <summary>
- Changes the current error and all errors matching the current error to the newly specified word.
- Word matching the current error that have already been ignored will not be changed.
- </summary>
- <param name="changedWord">The word to change the erroneous word and all its metches to.</param>
- <param name="isNewWordKnownToBeCorrect">True if the new word is spelled correctly; False otherwise.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogBase.ChangeCurrentError(System.String,System.Boolean)">
- <summary>
- Changes the current error to the newly specified word.
- Word matching the current error that have already been ignored will not be changed.
- </summary>
- <param name="changedWord">The word to change the erroneous word and all its metches to.</param>
- <param name="isNewWordKnownToBeCorrect">True if the new word is spelled correctly; False otherwise.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogBase.EnterActiveState">
- <summary>
- Causes the spell check dialog to enter an active state and being spell checking words.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogBase.EnterDeactiveState">
- <summary>
- Causes the spell check dialog to enter a deactive state (usually gets called
- when changes are being made to the spell check target).
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogBase.IgnoreAllMatchingCurrentError">
- <summary>
- Ignores the current error and all errors matching the current error
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogBase.IgnoreCurrentError">
- <summary>
- Ignores the current error
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogBase.OnCurrentErrorIndexChanged">
- <summary>
- Occurs when the current error index changes, override this to do something useful when it happens
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogBase.OnWordCorrected(Infragistics.Win.UltraWinSpellChecker.WordCorrectedEventArgs)">
- <summary>
- Fires the WordCorrected event.
- </summary>
- </member>
- <member name="E:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogBase.WordCorrected">
- <summary>
- Occurs when a word is corrected with the spell check dialog.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogBase.CurrentErrorIndex">
- <summary>
- Gets the current error index
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogBase.Errors">
- <summary>
- Gets the collection of errors the dialog must spell check.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogBase.IgnoredErrors">
- <summary>
- Gets an array of values determining if errors are ignored
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogBase.IsActive">
- <summary>
- Gets a value indicating whether this spell check dialog is active and spell checking text.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogBase.SpellCheckTargetImplementation">
- <summary>
- Gets the <see cref="T:Infragistics.Win.UltraWinSpellChecker.ISpellCheckTarget"/> to which this spell check dialog applies.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogBase.SpellCheckedText">
- <summary>
- Gets the full text being spell checked by this spell check dialog
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogBase.UndoContext">
- <summary>
- Gets the undo context which provides undo information about this spell check dialog
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogBase.SpellChecker">
- <summary>
- Gets the <see cref="T:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker"/> to which this spell check dialog applies.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogBase.SpellCheckTarget">
- <summary>
- Gets the object being spell checked.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogBase.StyleLibraryName">
- <summary>
- Returns or sets the name of the style library that should be used to obtain the style information for use by the dialog.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogBase.StyleSetName">
- <summary>
- Returns or sets the name of the styleset in the <see cref="T:Infragistics.Win.AppStyling.StyleManager"/> that should be used by the dialog.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogBase.UseAppStyling">
- <summary>
- Returns or sets whether the control should use application styling.
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogUndoContext">
- <summary>
- An undo context which provides undo information about a spell check dialog
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogUndoContext.#ctor">
- <summary>
- Constructor
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogUndoContext.Undo">
- <summary>
- Undoes an action in the spell check dialog
- </summary>
- </member>
- <member name="E:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogUndoContext.UndoActionCompleted">
- <summary>
- Occurs when an undo-able action has completed in the spell check dialog
- </summary>
- </member>
- <member name="E:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogUndoContext.Undone">
- <summary>
- Occurs when an action has been undone in the spell check dialog
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogUndoContext.CanUndo">
- <summary>
- Gets the value indicating whether an action can be undone in the spell check dialog
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettings">
- <summary>
- Represents a control to the <see cref="T:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker"/> component.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettings.#ctor">
- <summary>
- Constructor
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettings.#ctor(System.Boolean)">
- <summary>
- Constructor
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettings.ToString">
- <summary>
- Gets the string representation of the settings object.
- </summary>
- <returns>The string representation of the settings object.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettings.ShouldSerialize">
- <summary>
- Returns whether the SpellCheckerSettings object should be serialized
- </summary>
- <returns>Returns true if any property of the SpellCheckerSettings differs from the default.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettings.Reset">
- <summary>
- Resets all SpellCheckerSettings properties to their defaults.
- </summary>
- <remarks>
- <p class="body">This method will reset all properties of the <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettings"/> to their default values.</p>
- </remarks>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettings.Enabled">
- <summary>
- Gets or sets whether the spell checker is enabled for this control.
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettingsConverter">
- <summary>
- Type converter for the <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettings"/> class.
- </summary>
- <remarks>
- <p class="body">This is used to convert a <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettings"/> object to and from an InstanceDescriptor for the purposes of serialization / deserialization.</p>
- <p class="body">It also allows expanding the properties of the object in the PropertyGrid.</p>
- </remarks>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettingsConverter.CanConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Type)">
- <summary>
- Gets a value indicating whether this converter can convert an object to the given destination type using the context.
- </summary>
- <remarks></remarks>
- <param name="context">An ITypeDescriptorContext that provides a format context.</param>
- <param name="destinationType">A <see cref="T:System.Type"/> that represents the type you want to convert to.</param>
- <returns>This method returns true if this converter can perform the conversion; otherwise, false.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettingsConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
- <summary>
- Converts the specified object to the specified type.
- </summary>
- <param name="context">A formatter context. This object can be used to get additional information about the environment this converter is being called from. This may be null, so you should always check. Also, properties on the context object may also return null.</param>
- <param name="culture">An object that contains culture specific information, such as the language, calendar, and cultural conventions associated with a specific culture. It is based on the RFC 1766 standard.</param>
- <param name="destinationType">The type to convert the object to.</param>
- <param name="value">The object to convert.</param>
- <returns>The converted object.</returns>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.ErrorType">
- <summary>
- The types of errors that can be made in text.
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.ErrorType.Spelling">
- <summary>
- A spelling error.
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.LanguageType">
- <summary>
- Enumeration of language types.
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.LanguageType.English">
- <summary>English.</summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.LanguageType.Dutch">
- <summary>Dutch.</summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.LanguageType.French">
- <summary>French.</summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.LanguageType.German">
- <summary>German.</summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.LanguageType.Italian">
- <summary>Italian.</summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.LanguageType.Portuguese">
- <summary>Portuguese.</summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.LanguageType.Spanish">
- <summary>Spanish.</summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckingMode">
- <summary>
- The mode in which the <see cref="T:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker"/> component will spell check objects.
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SpellCheckingMode.None">
- <summary>
- Perform no spell checking.
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SpellCheckingMode.AsYouType">
- <summary>
- Performs spell checking on each word as the user spaces out of it. Causes an <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellError"/>
- event to be fired when the user spaces out of a misspelled word.
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SpellCheckingMode.DialogOnValidating">
- <summary>
- Shows a spell checking dialog when a spell checked <see cref="T:System.Windows.Forms.Control">Control</see> fires its Validating event.
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SpellCheckingMode.DialogOnValidatingAndAsYouType">
- <summary>
- A combination of <B>AsYouType</B> and <B>DialogOnValidating</B> functionality.
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.SpellErrorAction">
- <summary>
- The action to take when a word is misspelled in a spell checked object.
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SpellErrorAction.None">
- <summary>
- Perform no action (ignore the error).
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SpellErrorAction.Replace">
- <summary>
- Replace the word in the object being spell checked with the value from the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellErrorEventArgs.ReplaceWord"/>
- property after the <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellError"/> event has fired.
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SpellErrorAction.Ignore">
- <summary>
- Ignore this instance of the word and do not mark it as an error.
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SpellErrorAction.MarkAsError">
- <summary>
- Underline this word to indicate it is an error.
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.SuggestionsMethod">
- <summary>
- The type of Suggestions that will be returned.
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SuggestionsMethod.HashingSuggestions">
- <summary>
- Suggestions will be determined by hashing the word.
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SuggestionsMethod.PhoneticSuggestions">
- <summary>
- Suggestions will be determined phonetically.
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.UnderlineErrorsStyle">
- <summary>
- Indicates how the UltraSpellChecker should underline misspelled words.
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.UnderlineErrorsStyle.Default">
- <summary>
- The default value.
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.UnderlineErrorsStyle.None">
- <summary>
- No underline will be drawn under misspelled words.
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.UnderlineErrorsStyle.SingleLine">
- <summary>
- A single line will be drawn under misspelled words.
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.UnderlineErrorsStyle.DoubleLine">
- <summary>
- A double line will be drawn under misspelled words.
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.UnderlineErrorsStyle.Squiggle">
- <summary>
- A squiggle line will be drawn under misspelled words.
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.WordCorrectionSource">
- <summary>
- The ways in which a word can be corrected.
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.WordCorrectionSource.SpellCheckDialog">
- <summary>
- The user has replaced a word in the spell check dialog.
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.WordCorrectionSource.SpellErrorEvent">
- <summary>
- The developer has chosen to automatically replace the word in the SpellError event.
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.WordCorrectionSource.ContextMenu">
- <summary>
- The user has replaced a word via context menu showing a list of suggested words.
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.PropertyIds">
- <summary>
- Unique identifier for each property.
- </summary>
- <remarks>
- <p class="body">This enumeration lists all of the possible properties of the objects in the UltraWinSpellChecker namespace. These are used in the <see cref="E:Infragistics.Win.UltraComponentBase.PropertyChanged"/> event.</p>
- </remarks>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.PropertyIds.Dictionary">
- <summary>
- <see cref="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.Dictionary"/> property
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.PropertyIds.Mode">
- <summary>
- <see cref="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.Mode"/> property
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.PropertyIds.ShowDialogsModal">
- <summary>
- <see cref="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.ShowDialogsModal"/> property
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.PropertyIds.UnderlineSpellingErrorColor">
- <summary>
- <see cref="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.UnderlineSpellingErrorColor"/> property
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.PropertyIds.UnderlineSpellingErrorStyle">
- <summary>
- <see cref="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.UnderlineSpellingErrorStyle"/> property
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.PropertyIds.UserDictionary">
- <summary>
- <see cref="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.UserDictionary"/> property
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.PropertyIds.AllowCapitalizedWords">
- <summary>
- <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.AllowCapitalizedWords"/> property
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.PropertyIds.AllowCaseInsensitiveSuggestions">
- <summary>
- <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.AllowCaseInsensitiveSuggestions"/> property
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.PropertyIds.AllowMixedCase">
- <summary>
- <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.AllowMixedCase"/> property
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.PropertyIds.AllowWordsWithDigits">
- <summary>
- <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.AllowWordsWithDigits"/> property
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.PropertyIds.AllowXml">
- <summary>
- <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.AllowXml"/> property
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.PropertyIds.CheckCompoundWords">
- <summary>
- <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.CheckCompoundWords"/> property
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.PropertyIds.CheckHyphenatedText">
- <summary>
- <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.CheckHyphenatedText"/> property
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.PropertyIds.ConsiderationRange">
- <summary>
- <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ConsiderationRange"/> property
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.PropertyIds.IncludeUserDictionaryInSuggestions">
- <summary>
- <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.IncludeUserDictionaryInSuggestions"/> property
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.PropertyIds.LanguageParser">
- <summary>
- <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.LanguageParser"/> property
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.PropertyIds.SeparateHyphenWords">
- <summary>
- <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.SeparateHyphenWords"/> property
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.PropertyIds.SplitWordThreshold">
- <summary>
- <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.SplitWordThreshold"/> property
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.PropertyIds.SuggestionMethod">
- <summary>
- <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.SuggestionMethod"/> property
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.PropertyIds.SuggestSplitWords">
- <summary>
- <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.SuggestSplitWords"/> property
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventIds">
- <summary>
- Uniquely identifies each UltraSpellChecker event.
- </summary>
- <remarks>
- <p class="body">This enumeration is used to specify an event when calling the <see cref="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventManager.SetEnabled(Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventIds,System.Boolean)"/> method.</p>
- </remarks>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventIds.NoErrorsFound">
- <summary>
- Event is that identifies <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.NoErrorsFound"/> event.
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventIds.SpellCheckDialogClosed">
- <summary>
- Event is that identifies <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellCheckDialogClosed"/> event.
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventIds.SpellCheckDialogOpening">
- <summary>
- Event is that identifies <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellCheckDialogOpening"/> event.
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventIds.SpellChecked">
- <summary>
- Event is that identifies <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellChecked"/> event.
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventIds.SpellChecking">
- <summary>
- Event is that identifies <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellChecking"/> event.
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventIds.SpellError">
- <summary>
- Event is that identifies <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellError"/> event.
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventIds.WordCorrected">
- <summary>
- Event is that identifies <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.WordCorrected"/> event.
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventIds.LastEventId">
- <summary>
- Keep the last event id used.
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventGroups">
- <summary>
- Identifies groups of UltraSpellChecker specific events.
- </summary>
- <remarks>
- <p class="body">This enumeration is used to specify a group of events when calling the <see cref="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventManager.SetEnabled(Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventGroups,System.Boolean)"/> method.</p>
- </remarks>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventGroups.AllEvents">
- <summary>
- All events
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventGroups.ErrorEvents">
- <summary>
- FormulaSyntaxError, FormulaReferenceError, FormulaCalculationError and FormulaCircularityError events.
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventManager">
- <summary>
- Class for managing an <see cref="T:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker"/>'s events. It maintains an
- enabled flag for each event as well as a nested 'in progress'
- count and it exposes methods for firing each event.
- </summary>
- <remarks>
- <p class="body">For internal use only.</p>
- </remarks>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventManager.#ctor(Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker)">
- <summary>
- Initializes a new <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventManager"/>.
- </summary>
- <param name="ultraSpellChecker">UltraSpellChecker that this event manager will be asociated with.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventManager.InProgress(Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventIds)">
- <summary>
- Returns true if the event is in progress (in progress count > 0).
- </summary>
- <param name="eventid">A SpellCheckerEventIds value which indicates which event is being examined.</param>
- <remarks>
- <p class="body">Determines if the specified event is currently in progress.</p>
- </remarks>
- <returns>True if the event is currently in progress. False if it is not.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventManager.IsEnabled(Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventIds)">
- <summary>
- Returns true if the event is enabled.
- </summary>
- <remarks>
- <p class="body">Returns whether a particular event is enabled.</p>
- </remarks>
- <param name="eventid">A <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventIds"/> value which indicates which event is being examined.</param>
- <returns>True if the event is currently enabled. False if it is not enabled.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventManager.SetEnabled(Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventIds,System.Boolean)">
- <summary>
- Sets a specific event to enabled or disabled.
- </summary>
- <remarks>
- <p class="body">This method can be used to enable or disable the firing of a specific event.</p>
- <p class="body">Note that disabling an event does not prevent any internal processing by the component. It merely prevents the event handler from being called.</p>
- </remarks>
- <param name="enabled">A boolean indicating whether the event is to be enabled (true) or disabled (false).</param>
- <param name="eventid">A <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventIds"/> value which specifies the event to be enabled or disabled.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventManager.IsEnabled(Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventGroups)">
- <summary>
- Returns true if all events in the group are enabled.
- </summary>
- <remarks>
- <p class="body">Returns whether a group of events is enabled.</p>
- </remarks>
- <param name="group">A <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventGroups"/> value which indicates which group of events being examined.</param>
- <returns>True if the event group is currently enabled. False if it is not enabled.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventManager.SetEnabled(Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventGroups,System.Boolean)">
- <summary>
- Sets all events in the group to enabled or disabled.
- </summary>
- <remarks>
- <p class="body">This method can be used to enable or disable the firing of a group of events.</p>
- <p class="body">Note that disabling an event does not prevent any internal processing by the component. It merely prevents the event handler from being called.</p>
- </remarks>
- <param name="enabled">A boolean indicating whether the event group is to be enabled (true) or disabled (false).</param>
- <param name="group">A <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventGroups"/> value which specifies the group of events to be enabled or disabled.</param>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.NoErrorsFoundEventHandler">
- <summary>
- Delegate for <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.NoErrorsFound"/> event.
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogClosedEventHandler">
- <summary>
- Delegate for <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellCheckDialogClosed"/> event.
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogOpeningEventHandler">
- <summary>
- Delegate for <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellCheckDialogOpening"/> event.
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckedEventHandler">
- <summary>
- Delegate for <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellChecked"/> event.
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckingEventHandler">
- <summary>
- Delegate for <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellChecking"/> event.
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.SpellErrorEventHandler">
- <summary>
- Delegate for <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellError"/> event.
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.WordCorrectedEventHandler">
- <summary>
- Delegate for <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.WordCorrected"/> event.
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.NoErrorsFoundEventArgs">
- <summary>
- Event args for the <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.NoErrorsFound"/> event.
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckTargetEventArgs">
- <summary>
- Base class for event args relating to spell checked objects
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckTargetEventArgs.#ctor(System.Object)">
- <summary>
- Creates a new <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckTargetEventArgs"/> instance.
- </summary>
- <param name="spellCheckTarget">The object which was spell checked.</param>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellCheckTargetEventArgs.SpellCheckTarget">
- <summary>
- Gets the object which was spell checked.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.NoErrorsFoundEventArgs.#ctor(System.Object)">
- <summary>
- Constructor
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogClosedEventArgs">
- <summary>
- Event args for the <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellCheckDialogClosed"/> event.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogClosedEventArgs.#ctor(System.Windows.Forms.DialogResult,Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogBase,System.Object)">
- <summary>
- Creates a new <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogClosedEventArgs"/> instance.
- </summary>
- <param name="dialogResult">The dialog result of the closed dialog.</param>
- <param name="spellCheckDialog">The dialog which was closed.</param>
- <param name="spellCheckTarget">The object which was being spell checked with the dialog.</param>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogClosedEventArgs.DialogResult">
- <summary>
- Gets the dialog result for the form.
- </summary>
- <remarks><see cref="T:DialogResult.Cancel"/> indicates the spell check dialog was closed before all words were checked</remarks>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogClosedEventArgs.SpellCheckDialog">
- <summary>
- Gets the spell check dialog which closed.
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogOpeningEventArgs">
- <summary>
- Event args for the <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellCheckDialogOpening"/> event.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogOpeningEventArgs.#ctor(Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker,System.Object)">
- <summary>
- Creates a new <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogOpeningEventArgs"/> instance.
- </summary>
- <param name="spellChecker">The spell checker which is checking the target object.</param>
- <param name="spellCheckTarget">The object which will be spell checked</param>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogOpeningEventArgs.Cancel">
- <summary>
- Gets or sets whether or not to cancel the showing of the default spell check dialog.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogOpeningEventArgs.SpellCheckDialog">
- <summary>
- Gets or sets the spell check dialog to display to the user.
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckedEventArgs">
- <summary>
- Event args for the <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellChecked"/> event.
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckTextEventArgs">
- <summary>
- Base event args for the <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellChecking"/> and <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellChecked"/> events.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckTextEventArgs.#ctor(System.String,System.Int32,System.Int32,System.Object)">
- <summary>
- Creates a new <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckTextEventArgs"/> instance.
- </summary>
- <param name="text">The text which was spell checked.</param>
- <param name="offset">The offset in the text where the spell checked text portion begins.</param>
- <param name="length">The length of the spell checked text portion.</param>
- <param name="spellCheckTarget">The object which was spell checked.</param>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellCheckTextEventArgs.Length">
- <summary>
- Gets the length of the spell checked text portion.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellCheckTextEventArgs.Offset">
- <summary>
- Gets the offset in the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellCheckTextEventArgs.Text"/> where the spell checked text portion begins.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellCheckTextEventArgs.Text">
- <summary>
- Gets the full text of the target being spell checked.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckedEventArgs.#ctor(System.String,System.Int32,System.Int32,Infragistics.Win.UltraWinSpellChecker.ErrorCollection,System.Object)">
- <summary>
- Creates a new <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckedEventArgs"/> instance.
- </summary>
- <param name="text">The text which was spell checked.</param>
- <param name="offset">The offset in the text where the spell checked text portion begins.</param>
- <param name="length">The length of the spell checked text portion.</param>
- <param name="errors">The collection of errors found in the spell checked text.</param>
- <param name="spellCheckTarget">The object which was spell checked.</param>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellCheckedEventArgs.Errors">
- <summary>
- Gets the collection of errors found in the spell checked text.
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckingEventArgs">
- <summary>
- Event args for the <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellChecking"/> event.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckingEventArgs.#ctor(System.String,System.Int32,System.Int32,System.Object)">
- <summary>
- Creates a new <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckingEventArgs"/> instance.
- </summary>
- <param name="text">The text which was spell checked.</param>
- <param name="offset">The offset in the text where the spell checked text portion begins.</param>
- <param name="length">The length of the spell checked text portion.</param>
- <param name="spellCheckTarget">The object which was spell checked.</param>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellCheckingEventArgs.Cancel">
- <summary>
- Gets or sets whether or not to cancel the spell checking of an object.
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.SpellErrorEventArgs">
- <summary>
- Event args for the <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellError"/> event.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellErrorEventArgs.#ctor(Infragistics.Win.UltraWinSpellChecker.Error,Infragistics.Win.UltraWinSpellChecker.SpellErrorAction,System.Object)">
- <summary>
- Creates a new <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellErrorEventArgs"/> instance.
- </summary>
- <param name="spellingError">The <see cref="T:Infragistics.Win.UltraWinSpellChecker.Error"/> instance which describes the new error.</param>
- <param name="action">The default action to be taken with the word in error.</param>
- <param name="spellCheckTarget">The object which was spell checked.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="spellingError"/> is null.
- </exception>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellErrorEventArgs.Action">
- <summary>
- Gets or sets the action to be taken with the word in error.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellErrorEventArgs.ReplaceWord">
- <summary>
- Gets the sets the word that will replace the incorrectly spelled text if <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellErrorEventArgs.Action"/> is set to <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellErrorAction"/>.<B>Replace</B>.
- </summary>
- <remarks>
- Setting this property to a new string value as well as setting the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellErrorEventArgs.Action"/> property to
- <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellErrorAction"/>.<B>Replace</B> will cause the word to be replaced in the spell checked object.
- </remarks>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellErrorEventArgs.SpellingError">
- <summary>
- Gets the <see cref="T:Infragistics.Win.UltraWinSpellChecker.Error"/> instance which describes the new error.
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.WordCorrectedEventArgs">
- <summary>
- Event args for the <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.WordCorrected"/> event.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.WordCorrectedEventArgs.#ctor(System.String,System.String,Infragistics.Win.UltraWinSpellChecker.WordCorrectionSource,System.Object)">
- <summary>
- Creates a new <see cref="T:Infragistics.Win.UltraWinSpellChecker.WordCorrectedEventArgs"/> instance.
- </summary>
- <param name="originalWord">The original word before it was corrected.</param>
- <param name="correctedWord">The new word after the user has corrected it.</param>
- <param name="source">The reason why the word was corrected.</param>
- <param name="spellCheckTarget">The object which was spell checked.</param>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.WordCorrectedEventArgs.CorrectedWord">
- <summary>
- Gets the new word after the user has corrected it.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.WordCorrectedEventArgs.OriginalWord">
- <summary>
- Gets the original word before it was corrected.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.WordCorrectedEventArgs.Source">
- <summary>
- Gets the reason why the word was corrected.
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.Resources">
- <summary>
- Exposes a <see cref="T:Infragistics.Shared.ResourceCustomizer"/> instance for this assembly.
- </summary>
- <seealso cref="P:Infragistics.Win.UltraWinSpellChecker.Resources.Customizer"/>
- <seealso cref="T:Infragistics.Shared.ResourceCustomizer"/>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.Resources.GetString(System.String,System.Object[])">
- <summary>
- Returns the resource string using the specified name and default culture.
- </summary>
- <param name="name">Name of the string resource to return.</param>
- <param name="args">Arguments supplied to the string.Format method when formatting the string.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.Resources.GetString(System.String)">
- <summary>
- Returns the resource string using the specified resource name and default culture. The string is then formatted using the arguments specified.
- </summary>
- <param name="name">Name of the string resource to return.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.Resources.GetObject(System.String)">
- <summary>
- Returns the resource object using the specified name.
- </summary>
- <param name="name">Name of the resource item</param>
- <returns>An object containing the specified resource</returns>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.Resources.Customizer">
- <summary>
- Returns the <see cref="T:Infragistics.Shared.ResourceCustomizer"/> for this assembly.
- </summary>
- <seealso cref="T:Infragistics.Shared.ResourceCustomizer"/>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckForm">
- <summary>
- The default spell check form to show for spell checkable controls
- </summary>
- </member>
- <member name="F:Infragistics.Win.UltraWinSpellChecker.SpellCheckForm.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckForm.#ctor(Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker,System.Object)">
- <summary>
- Constructor
- </summary>
- <param name="spellChecker">The spell checker to which this form belongs.</param>
- <param name="spellCheckTarget">The object being spell checked.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckForm.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">True if this instance is being disposed, False if it is being finialized.</param>
- <remarks>
- <p class="body">
- If <paramref name="disposing"/> is True, both managed and unmanaged resources should be cleaned up,
- otherwise only unmanaged resources should be cleaned up.
- </p>
- </remarks>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckForm.OnClosed(System.EventArgs)">
- <summary>
- Raises the <see cref="E:System.Windows.Forms.Form.Closed"/> event.
- </summary>
- <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckForm.OnLoad(System.EventArgs)">
- <summary>
- Raises the <see cref="E:System.Windows.Forms.Form.Load"/> event.
- </summary>
- <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckForm.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.SpellOptions">
- <summary>
- Class which contains the options available for showing the spell checker dialog from the <see cref="T:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker"/>
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellOptions.#ctor">
- <summary>
- Constructor
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellOptions.Reset">
- <summary>
- Resets all properties of the <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellOptions"/> object to their default values.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ShouldSerialize">
- <summary>
- Returns true if any property is not the default
- </summary>
- <returns>True is the options object should be serialized because it is not default; False otherwise.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ToString">
- <summary>
- Provides a string representation of the <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellOptions"/> class.
- </summary>
- <returns></returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ShouldSerializeAllowCapitalizedWords">
- <summary>
- Returns whether or not the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.AllowCapitalizedWords"/> is set to the default.
- </summary>
- <returns>Returns false if the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.AllowCapitalizedWords"/> is set to the default.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ResetAllowCapitalizedWords">
- <summary>
- Resets the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.AllowCapitalizedWords"/> property to its default value.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ShouldSerializeAllowCaseInsensitiveSuggestions">
- <summary>
- Returns whether or not the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.AllowCaseInsensitiveSuggestions"/> is set to the default.
- </summary>
- <returns>Returns false if the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.AllowCaseInsensitiveSuggestions"/> is set to the default.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ResetAllowCaseInsensitiveSuggestions">
- <summary>
- Resets the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.AllowCaseInsensitiveSuggestions"/> property to its default value.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ShouldSerializeAllowMixedCase">
- <summary>
- Returns whether or not the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.AllowMixedCase"/> is set to the default.
- </summary>
- <returns>Returns false if the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.AllowMixedCase"/> is set to the default.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ResetAllowMixedCase">
- <summary>
- Resets the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.AllowMixedCase"/> property to its default value.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ShouldSerializeAllowWordsWithDigits">
- <summary>
- Returns whether or not the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.AllowWordsWithDigits"/> is set to the default.
- </summary>
- <returns>Returns false if the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.AllowWordsWithDigits"/> is set to the default.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ResetAllowWordsWithDigits">
- <summary>
- Resets the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.AllowWordsWithDigits"/> property to its default value.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ShouldSerializeAllowXml">
- <summary>
- Returns whether or not the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.AllowXml"/> is set to the default.
- </summary>
- <returns>Returns false if the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.AllowXml"/> is set to the default.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ResetAllowXml">
- <summary>
- Resets the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.AllowXml"/> property to its default value.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ShouldSerializeCheckCompoundWords">
- <summary>
- Returns whether or not the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.CheckCompoundWords"/> is set to the default.
- </summary>
- <returns>Returns false if the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.CheckCompoundWords"/> is set to the default.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ResetCheckCompoundWords">
- <summary>
- Resets the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.CheckCompoundWords"/> property to its default value.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ShouldSerializeCheckHyphenatedText">
- <summary>
- Returns whether or not the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.CheckHyphenatedText"/> is set to the default.
- </summary>
- <returns>Returns false if the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.CheckHyphenatedText"/> is set to the default.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ResetCheckHyphenatedText">
- <summary>
- Resets the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.CheckHyphenatedText"/> property to its default value.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ShouldSerializeConsiderationRange">
- <summary>
- Returns whether or not the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ConsiderationRange"/> is set to the default.
- </summary>
- <returns>Returns false if the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ConsiderationRange"/> is set to the default.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ResetConsiderationRange">
- <summary>
- Resets the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ConsiderationRange"/> property to its default value.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ShouldSerializeIncludeUserDictionaryInSuggestions">
- <summary>
- Returns whether or not the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.IncludeUserDictionaryInSuggestions"/> is set to the default.
- </summary>
- <returns>Returns false if the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.IncludeUserDictionaryInSuggestions"/> is set to the default.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ResetIncludeUserDictionaryInSuggestions">
- <summary>
- Resets the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.IncludeUserDictionaryInSuggestions"/> property to its default value.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ShouldSerializeLanguageParser">
- <summary>
- Returns whether or not the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.LanguageParser"/> is set to the default.
- </summary>
- <returns>Returns false if the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.LanguageParser"/> is set to the default.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ResetLanguageParser">
- <summary>
- Resets the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.LanguageParser"/> property to its default value.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ShouldSerializeSeparateHyphenWords">
- <summary>
- Returns whether or not the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.SeparateHyphenWords"/> is set to the default.
- </summary>
- <returns>Returns false if the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.SeparateHyphenWords"/> is set to the default.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ResetSeparateHyphenWords">
- <summary>
- Resets the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.SeparateHyphenWords"/> property to its default value.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ShouldSerializeSplitWordThreshold">
- <summary>
- Returns whether or not the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.SplitWordThreshold"/> is set to the default.
- </summary>
- <returns>Returns false if the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.SplitWordThreshold"/> is set to the default.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ResetSplitWordThreshold">
- <summary>
- Resets the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.SplitWordThreshold"/> property to its default value.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ShouldSerializeSuggestionMethod">
- <summary>
- Returns whether or not the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.SuggestionMethod"/> is set to the default.
- </summary>
- <returns>Returns false if the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.SuggestionMethod"/> is set to the default.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ResetSuggestionMethod">
- <summary>
- Resets the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.SuggestionMethod"/> property to its default value.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ShouldSerializeSuggestSplitWords">
- <summary>
- Returns whether or not the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.SuggestSplitWords"/> is set to the default.
- </summary>
- <returns>Returns false if the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.SuggestSplitWords"/> is set to the default.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ResetSuggestSplitWords">
- <summary>
- Resets the <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.SuggestSplitWords"/> property to its default value.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.AllowCapitalizedWords">
- <summary>
- Gets or sets whether to ignore words with all capital letters.
- If set to true, misspelled words in all capitals will not be marked misspelled.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.AllowCaseInsensitiveSuggestions">
- <summary>
- Gets or sets whether misspelled words are converted to all lower case before looking for suggestions.
- If set to true, “tHE” and “tHe” will have the same suggestions.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.AllowMixedCase">
- <summary>
- Gets or sets whether to allow the mixing of cases within a word.
- If set to true, “hELLo” will be correct. Otherwise it is marked misspelled.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.AllowWordsWithDigits">
- <summary>
- Gets or sets whether to ignore the spelling of words with digits in them.
- If set to true, “hel123lo” will not be marked misspelled.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.AllowXml">
- <summary>
- Gets or sets whether to allow XML/HTML tags in the text.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.CheckCompoundWords">
- <summary>
- Gets or sets whether to check for words that are combined (“helloworld” would be correct when this is true).
- </summary>
- <remarks>
- This is needed for languages such as German where words can be combined to form compound words.
- Setting this property to true can have a a big impact on performance.
- </remarks>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.CheckHyphenatedText">
- <summary>
- Gets or sets whether to look for each part of a hyphenated word in the dictionary, or to look for the hyphenated word as a whole in the dictionary.
- If set to true, “hello-world” would be spelled correctly, otherwise it would be incorrect.
- </summary>
- <remarks>
- This seems very similar to <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.SeparateHyphenWords"/>, but when this property is either true or false,
- the entire hyphenated word is marked in error if any part is in error. This is not the case with <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.SeparateHyphenWords"/>.
- </remarks>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.ConsiderationRange">
- <summary>
- Gets or sets the size factor for words to consider for suggestions. Increasing this value can have a large impact on performance.
- </summary>
- <remarks>
- Lower values are faster but consider fewer words for suggestions. When the property is set to less than 0, it will default to 80.
- </remarks>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.IncludeUserDictionaryInSuggestions">
- <summary>
- Gets or sets whether words from the user dictionary file should be included in the suggestion list.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.LanguageParser">
- <summary>
- Gets or sets the language parser to use. This should match the language of the dictionary file.
- </summary>
- <remarks>This is used to give hints to the spell checker engine about punctuation usage.</remarks>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.SeparateHyphenWords">
- <summary>
- Gets or sets whether to treat a word with a hyphen in it as two separate words when checking for errors.
- If set to true, only the first word of “heelo-world” would be marked misspelled. Otherwise, the entire text is misspelled.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.SplitWordThreshold">
- <summary>
- Gets or sets the minimum size a word needs to be in a combined word to become a suggestion.
- If set to a value greater than 2, “myhouse” would not have “my house” as a suggestion.
- </summary>
- <remarks>
- This property is only used when <see cref="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.SuggestSplitWords"/> is set to True.
- </remarks>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.SuggestionMethod">
- <summary>
- Gets or sets the value which tells the spell checker engine how to find suggestions.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SpellOptions.SuggestSplitWords">
- <summary>
- Gets or sets whether to look for connecting words in words with errors.
- If set to true, “helloworld” would have “hello world” as one of its suggestions.
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.SuggestionCollection">
- <summary>
- Read-only collection which contains a list of suggestions for a misspelled word.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SuggestionCollection.#ctor(System.Collections.ICollection)">
- <summary>
- Constructor
- </summary>
- <param name="suggestions">The collection of suggestions for a misspelled word.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.SuggestionCollection.CopyTo(System.String[],System.Int32)">
- <summary>
- Copies the elements of the <see cref="T:Infragistics.Win.UltraWinSpellChecker.SuggestionCollection"/> to a string array, starting at a particular index.
- </summary>
- <param name="array">The one-dimensional array where all suggestions in the collection should be copied.</param>
- <param name="index">The zero-based index into the array at which to start copying suggestions.</param>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.SuggestionCollection.Item(System.Int32)">
- <summary>
- Gets the suggestion at the specified index.
- </summary>
- <param name="index">The 0-based index into the collection at which to get a suggestion.</param>
- <returns></returns>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.TextChangeInfo">
- <summary>
- Class which provides information about how a block of text has changed
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.TextChangeInfo.GetChange(System.String,System.String)">
- <summary>
- Gets the <see cref="T:Infragistics.Win.UltraWinSpellChecker.TextChangeInfo"/> which describes how the text has changed
- </summary>
- <param name="newText">The new text after the change</param>
- <param name="oldText">The old text before the change</param>
- <exception cref="T:System.ArgumentNullException">
- Either of the strings passed is null.
- </exception>
- <returns>A <see cref="T:Infragistics.Win.UltraWinSpellChecker.TextChangeInfo"/> instance describing the changes that have occurred between the two strings.</returns>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.TextChangeInfo.EndChangeIndex">
- <summary>
- Gets the character index of the end of the change in the new text
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.TextChangeInfo.Magnitude">
- <summary>
- Gets the magnitude of the change (newText.Lenght - oldText.Lenght)
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.TextChangeInfo.StartChangeIndex">
- <summary>
- Gets the character index of the start of the change in the new text
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker">
- <summary>
- Performs spell checking on one or more controls.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.#ctor">
- <summary>
- Initializes a new <see cref="T:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker"/>
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.#ctor(System.ComponentModel.IContainer)">
- <summary>
- Initializes a new <see cref="T:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker"/>
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.ShouldSerializeContainingControl">
- <summary>
- Returns true if the ContainingControl property should be serialized
- </summary>
- <returns></returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.ShouldSerializeSpellOptions">
- <summary>
- Returns whether or not the <see cref="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellOptions"/> are set to the default.
- </summary>
- <returns>Returns false if the <see cref="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellOptions"/> are set to the default.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.ResetSpellOptions">
- <summary>
- Resets the <see cref="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellOptions"/> property to its default value.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.ShouldSerializeUnderlineSpellingErrorColor">
- <summary>
- Returns whether or not the <see cref="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.UnderlineSpellingErrorColor"/> is set to the default.
- </summary>
- <returns>Returns false if the <see cref="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.UnderlineSpellingErrorColor"/> is set to the default.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.ResetUnderlineSpellingErrorColor">
- <summary>
- Resets the <see cref="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.UnderlineSpellingErrorColor"/> property to the default underline color.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.AddWordToUserDictionary(System.String)">
- <summary>
- Adds a word to the current <see cref="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.UserDictionary"/>.
- </summary>
- <param name="word">The word to add to the user dictionary.</param>
- <exception cref="T:System.InvalidOperationException">
- The user dictionary has not been set.
- </exception>
- <returns>True if the word was added to the user dictionary; False otherwise.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.CheckText(System.String)">
- <summary>
- Spell checks the specified text and returns a collection of errors in the text.
- </summary>
- <param name="text">The text to spell check.</param>
- <returns>An <see cref="T:Infragistics.Win.UltraWinSpellChecker.ErrorCollection"/> containing the errors in the text.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.CheckWord(System.String)">
- <summary>
- Spell checks a word, and returns a <see cref="T:Infragistics.Win.UltraWinSpellChecker.WordCheckResult"/> instance with the results from the check.
- </summary>
- <param name="word">The word to spell check</param>
- <exception cref="T:System.ArgumentException">
- The word specified is not a single word.
- </exception>
- <returns></returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.GetErrorAtPoint(System.Object,System.Drawing.Point)">
- <summary>
- Gets the <see cref="T:Infragistics.Win.UltraWinSpellChecker.Error"/> describing a misspelled word and its suggestions.
- This word is displayed in the spell checked control at the specified client coordinates.
- Null is returned if the word at the location is spelled correctly or if there is no word
- at the location.
- </summary>
- <param name="spellCheckTarget">
- The spell checked control where the word is displayed.
- </param>
- <param name="location">
- The client coordinates in the spell checked control where the word is.
- </param>
- <returns>
- A <see cref="T:Infragistics.Win.UltraWinSpellChecker.Error"/> instance describing the error.
- Null if there is no misspelled word at the location.
- </returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.IgnoreAll(System.String)">
- <summary>
- Ignores all instances of a misspelled word when spell checking.
- </summary>
- <param name="word">The word to ignore.</param>
- <returns>True if the word was added to the ignore list; False if the word was already in the ignore list.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.IgnoreError(System.Object,Infragistics.Win.UltraWinSpellChecker.Error)">
- <summary>
- Ignores the specified error in the spell check target.
- </summary>
- <param name="spellCheckTarget">
- The spell checked control where the error exists.
- </param>
- <param name="error">
- The error to be ignored. If it does not exist in the control's text, nothing will happen.
- </param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.RemoveWordFromUserDictionary(System.String)">
- <summary>
- Removes a word from the current <see cref="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.UserDictionary"/>.
- </summary>
- <param name="word">The word to be removed from the user dictionary.</param>
- <exception cref="T:System.InvalidOperationException">
- The user dictionary has not been set.
- </exception>
- <returns>True if the word was removed from the user dictionary; False otherwise.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.ShowSpellCheck(System.Object)">
- <summary>
- Shows the spell checking dialog non-modally for the specified object and returns a reference to the spell check dialog shown.
- </summary>
- <param name="spellCheckTarget">The object being spell checked. This must be of a type supported by the spell checker.</param>
- <returns>A reference to the spell check dialog or null if the <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellCheckDialogOpening"/> event was cancelled.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.ShowSpellCheck(System.Windows.Forms.Form,System.Object)">
- <summary>
- Shows the spell checking dialog non-modally for the specified object and returns a reference to the spell check dialog shown.
- </summary>
- <param name="owner">The form which will own the spell check dialog.</param>
- <param name="spellCheckTarget">The object being spell checked. This must be of a type supported by the spell checker.</param>
- <returns>A reference to the spell check dialog or null if the <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellCheckDialogOpening"/> event was cancelled.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.ShowSpellCheckDialog(System.Object)">
- <summary>
- Shows the spell checking dialog for the specified object and returns the <see cref="T:System.Windows.Forms.DialogResult"/> of the dialog box.
- </summary>
- <param name="spellCheckTarget">The object being spell checked. This must be of a type supported by the spell checker.</param>
- <returns>
- The dialog result of dialog box, or <see cref="F:System.Windows.Forms.DialogResult.None"/> if the <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellCheckDialogOpening"/> event was cancelled.
- <see cref="F:System.Windows.Forms.DialogResult.Cancel"/> indicates the spell check dialog was closed before all words were checked
- </returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.ShowSpellCheckDialog(System.Windows.Forms.IWin32Window,System.Object)">
- <summary>
- Shows the spell checking dialog for the specified object and returns the <see cref="T:System.Windows.Forms.DialogResult"/> of the dialog box.
- </summary>
- <param name="owner">The top-level object that will own the dialog box.</param>
- <param name="spellCheckTarget">The object being spell checked. This must be of a type supported by the spell checker.</param>
- <returns>
- The dialog result of dialog box, or <see cref="F:System.Windows.Forms.DialogResult.None"/> if the <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellCheckDialogOpening"/> event was cancelled.
- <see cref="F:System.Windows.Forms.DialogResult.Cancel"/> indicates the spell check dialog was closed before all words were checked
- </returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.CreateSpellCheckDialog(System.Object)">
- <summary>
- Creates a spell check dialog to spell checked the specified object.
- </summary>
- <param name="spellCheckTarget">The object to be spell checked by the dialog.</param>
- <returns>A <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogBase"/> instance</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.CreateSpellCheckerEngine">
- <summary>
- Returns a new instance of the spell checker engine that this component will use in its internal implementation.
- </summary>
- <remarks>
- Override this method is a base-class to provide a different spell checker for the component to use.
- </remarks>
- <returns>A new spell checker engine.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.CreateSpellCheckTargetImplementation(System.Object)">
- <summary>
- Creates an <see cref="T:Infragistics.Win.UltraWinSpellChecker.ISpellCheckTarget"/> instance which provides spell checking support for the specified object.
- </summary>
- <remarks>
- Override this in a base class to provide different <see cref="T:Infragistics.Win.UltraWinSpellChecker.ISpellCheckTarget"/> instances for objects.
- </remarks>
- <param name="spellCheckTarget">The object of which to get the spell check target.</param>
- <returns>An <see cref="T:Infragistics.Win.UltraWinSpellChecker.ISpellCheckTarget"/> instance which provides spell checking support for the specified object.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.CreateAsYouTypeManager(System.Object)">
- <summary>
- Creates an as you type manager which applies to the specified object. Override in a derived class to make this
- <see cref="T:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker"/> use a custom as you type error manager.
- </summary>
- <remarks>
- As you type managers created in an override of this method should be disposed when they are no longer being used.
- </remarks>
- <param name="spellCheckTarget">The spell checked object to which the underline manager applies.</param>
- <returns>An <see cref="T:Infragistics.Win.UltraWinSpellChecker.AsYouTypeManager"/> instance</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.OnBeginInit">
- <summary>
- Begins the initialization of the component.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.OnEndInit">
- <summary>
- Ends the initialization of the component.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.OnEnterEditMode(Infragistics.Win.EmbeddableEditorBase)">
- <summary>
- Should be called when a spell checked <see cref="T:Infragistics.Win.EmbeddableEditorBase"/> goes into edit mode.
- </summary>
- <param name="editor">The <see cref="T:Infragistics.Win.EmbeddableEditorBase"/> which has gone into edit mode.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.OnExitEditMode(Infragistics.Win.EmbeddableEditorBase,System.Boolean,System.Boolean)">
- <summary>
- Should be called when a spell checked <see cref="T:Infragistics.Win.EmbeddableEditorBase"/> is about to exit edit mode.
- </summary>
- <param name="editor">The <see cref="T:Infragistics.Win.EmbeddableEditorBase"/> which is exiting edit mode.</param>
- <param name="forceExit">If true will force an exit even if exit event is cancelled.</param>
- <param name="applyChanges">If true any changes made while in edit mode will be applied.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.OnNoErrorsFound(Infragistics.Win.UltraWinSpellChecker.NoErrorsFoundEventArgs)">
- <summary>
- Fires the <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.NoErrorsFound"/> event.
- </summary>
- <param name="e">The event arguments.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.OnSpellCheckDialogClosed(Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogClosedEventArgs)">
- <summary>
- Fires the <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellCheckDialogClosed"/> event.
- </summary>
- <param name="e">The event arguments.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.OnSpellCheckDialogOpening(Infragistics.Win.UltraWinSpellChecker.SpellCheckDialogOpeningEventArgs)">
- <summary>
- Fires the <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellCheckDialogOpening"/> event.
- </summary>
- <param name="e">The event arguments.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.OnSpellChecked(Infragistics.Win.UltraWinSpellChecker.SpellCheckedEventArgs)">
- <summary>
- Fires the <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellChecked"/> event.
- </summary>
- <param name="e">The event arguments.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.OnSpellChecking(Infragistics.Win.UltraWinSpellChecker.SpellCheckingEventArgs)">
- <summary>
- Fires the <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellChecking"/> event.
- </summary>
- <param name="e">The event arguments.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.OnSpellError(Infragistics.Win.UltraWinSpellChecker.SpellErrorEventArgs)">
- <summary>
- Fires the <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellError"/> event.
- </summary>
- <param name="e">The event arguments.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.OnWordCorrected(Infragistics.Win.UltraWinSpellChecker.WordCorrectedEventArgs)">
- <summary>
- Fires the <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.WordCorrected"/> event.
- </summary>
- <param name="e">The event arguments.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.OnSubObjectPropChanged(Infragistics.Shared.PropChangeInfo)">
- <summary>
- Invoked when a property on a sub object has changed.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.CreateComponentRole">
- <summary>
- Factory method used to create the component role that provides the style information for the component.
- </summary>
- <returns></returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.Dispose(System.Boolean)">
- <summary>
- Dispose any resources used by the component
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.System#ComponentModel#IExtenderProvider#CanExtend(System.Object)">
- <summary>
- Indicates which controls can have a SpellCheckerSettings extender property.
- </summary>
- <param name="extendee">Object to check if it can be extended.</param>
- <returns>True if the control can have a SpellCheckerSettings property.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.GetSpellCheckerSettings(System.Windows.Forms.Control)">
- <summary>
- Gets the <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettings"/> for the specified control.
- </summary>
- <remarks>
- <p class="body">Use this method to get the <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettings"/> for a particular control. If a <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettings"/> for the control already exists with this component, then it will be returned. If it does not exist, a new <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettings"/> object will be created for the control and added to this component.</p>
- </remarks>
- <param name="control">The control for which to obtain the <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettings"/> setting.</param>
- <returns>The <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettings"/> object for the specified control.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SetSpellCheckerSettings(System.Windows.Forms.Control,Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettings)">
- <summary>
- Sets the <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettings"/> extender property for the specified control.
- </summary>
- <remarks>
- <p class="body">This method associates a <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettings"/> object with a particular control. If there is already an existing <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettings"/> associated with the specified control, then the existing <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettings"/> is removed and replaced with the new <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettings"/>.</p>
- </remarks>
- <param name="control">The control whose <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettings"/> property is being set.</param>
- <param name="spellCheckerSettings">A <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettings"/> object which will be associated with the control.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.ShouldSerializeSpellCheckerSettings(System.Windows.Forms.Control)">
- <summary>
- Indicates whether the <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettings"/> property contains data that needs to be serialized.
- </summary>
- <returns>Returns true if the <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettings"/> property needs to be serialized.</returns>
- <remarks>
- <p class="body">Use this method to determine if a <b>SpellCheckerSettings</b> object has been created and contains data that needs to be serialized.</p>
- </remarks>
- <param name="control">The control whose <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettings"/> are being queried.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.ResetSpellCheckerSettings(System.Windows.Forms.Control)">
- <summary>
- Resets the <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettings"/> of the passed in control.
- </summary>
- <remarks>
- <p class="body">This method resets the <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettings"/> of a particular control. If the control does not have a <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettings"/> object in the calculation network, then this method does nothing.</p>
- </remarks>
- <param name="control">The control whose <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckerSettings"/> will be reset.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.BeginInit">
- <summary>
- Signals the object that initialization is starting.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.EndInit">
- <summary>
- Signals the object that initialization is complete.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.Infragistics#Win#UltraWinSpellChecker#IUltraSpellChecker#GetContextMenuItemsAt(System.Object,System.Drawing.Point)">
- <summary>
- Gets the spellchecker related context menu items to be displayed at the specified location
- in the specified target.
- </summary>
- <param name="spellCheckTarget">The spell checker target object.</param>
- <param name="location">Location of the context menu click.</param>
- <remarks>
- If there is a misspelled word at the location, this will return menu items that represent
- suggestions for correcting the misspelled words. It may also contain items for other
- spellchecker related actions. This method will return null if there are no spellchecker
- related actions (for example there are no misspelled words) at the specified location.
- </remarks>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.EventManager">
- <summary>
- The object that enables, disables and controls firing of specific control events.
- </summary>
- <remarks>
- <p class="body">The <b>EventManager</b> gives you a high degree of control over how the component invokes event procedures. You can use it to selectively enable and disable event procedures depending on the context of your application. You can also use the event manager to return information about the state of the component's events.</p>
- <p class="body">The event manager's methods are used to determine the enabled state of an event (<see cref="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventManager.IsEnabled(Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventIds)"/>), to selectively enable or disable events (<see cref="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventManager.SetEnabled(Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventIds,System.Boolean)"/>), and to tell whether an event procedure is currently being processed (<see cref="M:Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventManager.InProgress(Infragistics.Win.UltraWinSpellChecker.SpellCheckerEventIds)"/>). There is also an <seealso cref="P:Infragistics.Shared.EventManagerBase.AllEventsEnabled"/> property that you can check to quickly determine whether any events have been disabled by the event manager.</p>
- </remarks>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.ContainingControl">
- <summary>
- Gets or sets the <see cref="T:System.Windows.Forms.Form"/> or <see cref="T:System.Windows.Forms.UserControl"/> that this <see cref="T:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker"/> component is servicing.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.Dictionary">
- <summary>
- Gets or sets a path to the dictionary file.
- </summary>
- <remarks>
- This dictionary contains all default correctly spelled words of a language.
- If this property is not set, the English dictionary will be used by default.
- </remarks>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.Mode">
- <summary>
- Gets or sets the type of spell checking that will be performed (none, dialog, as you type, or both).
- </summary>
- <remarks>
- <p class="body">The Mode property determines how objects are spell checked. They can be spell checked as the user types, spell checked with a dialog after the user is done editting the text, neither, or both.</p>
- <p class="body">When the mode is set to <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckingMode"/>.<B>AsYouType</B>, each time the user spaces out of a word, that word will be spell checked. If that word contains a spelling error, the <see cref="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellError"/> event will be fired.</p>
- <p class="body">When the mode is set to <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckingMode"/>.<B>DialogOnValidating</B>, and the user leaves the control or object being editted, the text is spell checked in a spell checking dialog.</p>
- <p class="body">Setting the mode to <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckingMode"/>.<B>DialogOnValidatingAndAsYouType</B> uses a combination of both behaviors mentioned above.</p>
- </remarks>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.ShowDialogsModal">
- <summary>
- Gets or sets whether to show spell checking dialogs as modal or non-modal.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.Site">
- <summary>
- The component's site (set at design time only).
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellOptions">
- <summary>
- Gets the options available for the spell checker engine.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.UnderlineSpellingErrorColor">
- <summary>
- Gets or sets the color to use when underlining misspelled words in the controls bring spell checked.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.UnderlineSpellingErrorColorResolved">
- <summary>
- Gets the resolved value of the <see cref="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.UnderlineSpellingErrorColor"/>.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.UnderlineSpellingErrorStyle">
- <summary>
- Gets or sets the way misspelled words will be underlined in their editors.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.UnderlineSpellingErrorStyleResolved">
- <summary>
- Gets the resolved value of the <see cref="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.UnderlineSpellingErrorStyle"/>.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.UserDictionary">
- <summary>
- Gets or sets a path to the user dictionary.
- </summary>
- <remarks>
- This dictionary contains words the user chooses to add to the dictionary by choosing the “Add to Dictionary” option when a spelling error is found.
- </remarks>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.IgnoredWords">
- <summary>
- Gets the collection of words ignored by the spell checker.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SubObjectPropChangeHandler">
- <summary>
- Handler for a SubObjectPropChange event
- </summary>
- </member>
- <member name="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.NoErrorsFound">
- <summary>
- Fired when the spell check dialog is called to check errors and there are no errors.
- </summary>
- </member>
- <member name="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellCheckDialogClosed">
- <summary>
- Fired when a spell check dialog has closed.
- </summary>
- </member>
- <member name="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellCheckDialogOpening">
- <summary>
- Fired when the spell checking dialog is about to display.
- </summary>
- <remarks>
- In the event handler for this event, the showing of the default dialog can be cancelled.
- </remarks>
- </member>
- <member name="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellChecked">
- <summary>
- Fired after all or a part of text is about to be spell checked.
- </summary>
- </member>
- <member name="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellChecking">
- <summary>
- Fired when all or a part of text is about to be spell checked.
- </summary>
- <remarks>
- <p class="body">This event fires any time the <see cref="T:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker"/> attempts to spell check the text of a spell checked object.</p>
- </remarks>
- </member>
- <member name="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.SpellError">
- <summary>
- Fired when a word typed by the user is misspelled and this component is in <see cref="T:Infragistics.Win.UltraWinSpellChecker.SpellCheckingMode"/>.<B>AsYouType</B> mode.
- </summary>
- </member>
- <member name="E:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.WordCorrected">
- <summary>
- Fired when the user picks a new word to replace a misspelled word.
- </summary>
- <remarks>This occus if a word is corrected while the user is typing or through the spell checking dialog.</remarks>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker.About">
- <summary>
- Display the about dialog
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.Design.UltraSpellCheckerDesigner">
- <summary>
- Disgner class for the <see cref="T:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker"/> component.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.Design.UltraSpellCheckerDesigner.ActionLists">
- <summary>
- Gets the <see cref="T:System.ComponentModel.Design.DesignerActionListCollection"/> for this designer's control/component.
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.Design.UltraSpellCheckerDesigner.UltraSpellCheckerActionList">
- <summary>
- Provides DesignerActionItems for the SmartTag associated with the <see cref="T:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker"/>.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.Design.UltraSpellCheckerDesigner.UltraSpellCheckerActionList.#ctor(Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker)">
- <summary>
- Constructor
- </summary>
- <param name="product"></param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.Design.UltraSpellCheckerDesigner.UltraSpellCheckerActionList.CreateActionItems(System.ComponentModel.Design.DesignerActionItemCollection)">
- <summary>
- Overrides CreateActionItems.
- </summary>
- <param name="actionItems">The list to populate.</param>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.Design.UltraSpellCheckerDesigner.UltraSpellCheckerActionList.Mode">
- <summary>
- Used by SmartTag Panel.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.Design.UltraSpellCheckerDesigner.UltraSpellCheckerActionList.ShowDialogsModal">
- <summary>
- Used by SmartTag Panel.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.Design.UltraSpellCheckerDesigner.UltraSpellCheckerActionList.UnderlineSpellingErrorColor">
- <summary>
- Used by SmartTag Panel.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.Design.UltraSpellCheckerDesigner.UltraSpellCheckerActionList.UnderlineSpellingErrorStyle">
- <summary>
- Used by SmartTag Panel.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.Design.UltraSpellCheckerDesigner.UltraSpellCheckerActionList.UserDictionary">
- <summary>
- Used by SmartTag Panel.
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.UnderlinedError">
- <summary>
- Class which represents an underline for errors
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UnderlinedError.#ctor(Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker,Infragistics.Win.UltraWinSpellChecker.Error)">
- <summary>
- Constructor
- </summary>
- <param name="spellChecker">The <see cref="T:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker"/> which created this underline.</param>
- <param name="error">The error information describing the misspelled word.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UnderlinedError.#ctor(Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker,Infragistics.Win.UltraWinSpellChecker.Error,Infragistics.Win.UltraWinSpellChecker.AsYouTypeManager)">
- <summary>
- Constructor
- </summary>
- <param name="spellChecker">The <see cref="T:Infragistics.Win.UltraWinSpellChecker.UltraSpellChecker"/> which created this underline.</param>
- <param name="error">The error information describing the misspelled word.</param>
- <param name="owningManager">The AsYouTypeManager which owns this underline.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UnderlinedError.Paint(System.Drawing.Graphics,System.Drawing.Point,System.Drawing.Point)">
- <summary>
- Draws this underline at the specified client coordinates.
- </summary>
- <param name="grfx">The <see cref="T:System.Drawing.Graphics"/> object on which to draw the underline.</param>
- <param name="start">The client coordinates of the staring point of the underline.</param>
- <param name="end">The client coordinates of the ending point of the underline.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UnderlinedError.ToString">
- <summary>
- Provides a string representation of the underlined error.
- </summary>
- <returns></returns>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.UnderlinedError.Color">
- <summary>
- Gets or sets the color of the underline.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.UnderlinedError.ColorResolved">
- <summary>
- Gets the resolved color of the underline.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.UnderlinedError.Error">
- <summary>
- Gets the error information for the underlined error.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.UnderlinedError.Style">
- <summary>
- Gets or sets the style of the underline.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.UnderlinedError.StyleResolved">
- <summary>
- Gets the resolved style of the underline.
- </summary>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.UnderlinedErrorCollection">
- <summary>
- Read-only collection which contains a list of underlines.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UnderlinedErrorCollection.#ctor">
- <summary>
- Constructor
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UnderlinedErrorCollection.CopyTo(Infragistics.Win.UltraWinSpellChecker.UnderlinedError[],System.Int32)">
- <summary>
- Copies the elements of the <see cref="T:Infragistics.Win.UltraWinSpellChecker.UnderlinedErrorCollection"/> to an <see cref="T:Infragistics.Win.UltraWinSpellChecker.UnderlinedError"/> array, starting at a particular index.
- </summary>
- <param name="array">The one-dimensional array where all errors in the collection should be copied.</param>
- <param name="index">The zero-based index into the array at which to start copying errors.</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UnderlinedErrorCollection.GetUnderlinedErrorStartingAt(System.Int32)">
- <summary>
- Gets the index of the <see cref="T:Infragistics.Win.UltraWinSpellChecker.UnderlinedError"/> in this collection with the specified start index.
- </summary>
- <param name="index">The start index of the underline to look for in the collection.</param>
- <returns>
- The zero-based index of value in this collection if value is found;
- otherwise, a negative number, which is the bitwise complement
- of the index of the next element that is larger than value or, if there is
- no larger element, the bitwise complement of collection's count.
- </returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UnderlinedErrorCollection.Add(Infragistics.Win.UltraWinSpellChecker.UnderlinedError)">
- <summary>
- Adds an <see cref="T:Infragistics.Win.UltraWinSpellChecker.UnderlinedError"/> to the underlines collection
- </summary>
- <param name="underlinedError">The underline to add to the collection</param>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UnderlinedErrorCollection.Clear">
- <summary>
- Clears the collection of all underlines
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UnderlinedErrorCollection.Remove(Infragistics.Win.UltraWinSpellChecker.UnderlinedError)">
- <summary>
- Removes the specified <see cref="T:Infragistics.Win.UltraWinSpellChecker.UnderlinedError"/> from the collection.
- </summary>
- <param name="underlinedError">The <see cref="T:Infragistics.Win.UltraWinSpellChecker.UnderlinedError"/> to remove from the colleciton.</param>
- <returns>True if the <see cref="T:Infragistics.Win.UltraWinSpellChecker.UnderlinedError"/> has been found and removed successfully; False otherwise.</returns>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.UnderlinedErrorCollection.RemoveAt(System.Int32)">
- <summary>
- Removes the <see cref="T:Infragistics.Win.UltraWinSpellChecker.UnderlinedError"/> at the specified index from the collection.
- </summary>
- <param name="index">The index at which to remove the <see cref="T:Infragistics.Win.UltraWinSpellChecker.UnderlinedError"/>.</param>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.UnderlinedErrorCollection.Item(System.Int32)">
- <summary>
- Gets the underline at the specified index.
- </summary>
- <param name="index">The 0-based index into the collection at which to get an underline.</param>
- <returns></returns>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.Design.UserDictionaryEditor">
- <summary>
- Type editor for selecting the user dictionary file
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.Design.UserDictionaryEditor.InitializeDialog(System.Windows.Forms.OpenFileDialog)">
- <summary>
- Initializes the members of the file dialog.
- </summary>
- <param name="openFileDialog">Open file dialog used to select the file.</param>
- </member>
- <member name="T:Infragistics.Win.UltraWinSpellChecker.WordCheckResult">
- <summary>
- Class containing all information needed when checking a word for spelling erros.
- </summary>
- </member>
- <member name="M:Infragistics.Win.UltraWinSpellChecker.WordCheckResult.#ctor(System.Boolean,Infragistics.Win.UltraWinSpellChecker.Error)">
- <summary>
- Creates a new <see cref="T:Infragistics.Win.UltraWinSpellChecker.WordCheckResult"/> instance.
- </summary>
- <param name="spelledCorrectly">A value indicating whether the word was spelled correctly.</param>
- <param name="spellingError">The error information about the misspelled word, or null if <paramref name="spelledCorrectly"/> is False.</param>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.WordCheckResult.SpelledCorrectly">
- <summary>
- Gets a value indicating whether the word was spelled correctly.
- </summary>
- </member>
- <member name="P:Infragistics.Win.UltraWinSpellChecker.WordCheckResult.SpellingError">
- <summary>
- Gets the error information about the misspelled word. If <see cref="P:Infragistics.Win.UltraWinSpellChecker.WordCheckResult.SpelledCorrectly"/> is False, this will be null.
- </summary>
- </member>
- </members>
- </doc>
|